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 #ifdef HAVE_WINDOW_SYSTEM
68 #endif /* HAVE_WINDOW_SYSTEM */
70 /* Variables for blockinput.h: */
72 /* Non-zero if interrupt input is blocked right now. */
73 volatile int interrupt_input_blocked
;
75 /* Nonzero means an input interrupt has arrived
76 during the current critical section. */
77 int interrupt_input_pending
;
79 /* This var should be (interrupt_input_pending || pending_atimers).
80 The QUIT macro checks this instead of interrupt_input_pending and
81 pending_atimers separately, to reduce code size. So, any code that
82 changes interrupt_input_pending or pending_atimers should update
88 #define KBD_BUFFER_SIZE 4096
90 KBOARD
*initial_kboard
;
91 KBOARD
*current_kboard
;
94 /* Nonzero in the single-kboard state, 0 in the any-kboard state. */
95 static int single_kboard
;
97 /* Non-nil disable property on a command means
98 do not execute it; call disabled-command-function's value instead. */
99 Lisp_Object Qdisabled
;
100 static Lisp_Object Qdisabled_command_function
;
102 #define NUM_RECENT_KEYS (300)
104 /* Index for storing next element into recent_keys. */
105 static int recent_keys_index
;
107 /* Total number of elements stored into recent_keys. */
108 static int total_keys
;
110 /* This vector holds the last NUM_RECENT_KEYS keystrokes. */
111 static Lisp_Object recent_keys
;
113 /* Vector holding the key sequence that invoked the current command.
114 It is reused for each command, and it may be longer than the current
115 sequence; this_command_key_count indicates how many elements
116 actually mean something.
117 It's easier to staticpro a single Lisp_Object than an array. */
118 Lisp_Object this_command_keys
;
119 ptrdiff_t this_command_key_count
;
121 /* 1 after calling Freset_this_command_lengths.
123 static int this_command_key_count_reset
;
125 /* This vector is used as a buffer to record the events that were actually read
126 by read_key_sequence. */
127 static Lisp_Object raw_keybuf
;
128 static int raw_keybuf_count
;
130 #define GROW_RAW_KEYBUF \
131 if (raw_keybuf_count == ASIZE (raw_keybuf)) \
132 raw_keybuf = larger_vector (raw_keybuf, 1, -1)
134 /* Number of elements of this_command_keys
135 that precede this key sequence. */
136 static ptrdiff_t this_single_command_key_start
;
138 /* Record values of this_command_key_count and echo_length ()
139 before this command was read. */
140 static ptrdiff_t before_command_key_count
;
141 static ptrdiff_t before_command_echo_length
;
143 /* For longjmp to where kbd input is being done. */
145 static jmp_buf getcjmp
;
147 /* True while doing kbd input. */
148 int waiting_for_input
;
150 /* True while displaying for echoing. Delays C-g throwing. */
154 /* Non-null means we can start echoing at the next input pause even
155 though there is something in the echo area. */
157 static struct kboard
*ok_to_echo_at_next_pause
;
159 /* The kboard last echoing, or null for none. Reset to 0 in
160 cancel_echoing. If non-null, and a current echo area message
161 exists, and echo_message_buffer is eq to the current message
162 buffer, we know that the message comes from echo_kboard. */
164 struct kboard
*echo_kboard
;
166 /* The buffer used for echoing. Set in echo_now, reset in
169 Lisp_Object echo_message_buffer
;
171 /* Nonzero means C-g should cause immediate error-signal. */
174 /* Character that causes a quit. Normally C-g.
176 If we are running on an ordinary terminal, this must be an ordinary
177 ASCII char, since we want to make it our interrupt character.
179 If we are not running on an ordinary terminal, it still needs to be
180 an ordinary ASCII char. This character needs to be recognized in
181 the input interrupt handler. At this point, the keystroke is
182 represented as a struct input_event, while the desired quit
183 character is specified as a lispy event. The mapping from struct
184 input_events to lispy events cannot run in an interrupt handler,
185 and the reverse mapping is difficult for anything but ASCII
188 FOR THESE ELABORATE AND UNSATISFYING REASONS, quit_char must be an
192 /* Current depth in recursive edits. */
193 EMACS_INT command_loop_level
;
195 /* If not Qnil, this is a switch-frame event which we decided to put
196 off until the end of a key sequence. This should be read as the
197 next command input, after any unread_command_events.
199 read_key_sequence uses this to delay switch-frame events until the
200 end of the key sequence; Fread_char uses it to put off switch-frame
201 events until a non-ASCII event is acceptable as input. */
202 Lisp_Object unread_switch_frame
;
204 /* Last size recorded for a current buffer which is not a minibuffer. */
205 static ptrdiff_t last_non_minibuf_size
;
207 /* Total number of times read_char has returned, modulo UINTMAX_MAX + 1. */
208 uintmax_t num_input_events
;
210 /* Value of num_nonmacro_input_events as of last auto save. */
212 static EMACS_INT last_auto_save
;
214 /* The value of point when the last command was started. */
215 static ptrdiff_t last_point_position
;
217 /* The buffer that was current when the last command was started. */
218 static Lisp_Object last_point_position_buffer
;
220 /* The window that was selected when the last command was started. */
221 static Lisp_Object last_point_position_window
;
223 /* The frame in which the last input event occurred, or Qmacro if the
224 last event came from a macro. We use this to determine when to
225 generate switch-frame events. This may be cleared by functions
226 like Fselect_frame, to make sure that a switch-frame event is
227 generated by the next character. */
228 Lisp_Object internal_last_event_frame
;
230 /* The timestamp of the last input event we received from the X server.
231 X Windows wants this for selection ownership. */
232 Time last_event_timestamp
;
234 static Lisp_Object Qx_set_selection
, Qhandle_switch_frame
;
235 static Lisp_Object Qhandle_select_window
;
236 Lisp_Object QPRIMARY
;
238 static Lisp_Object Qself_insert_command
;
239 static Lisp_Object Qforward_char
;
240 static Lisp_Object Qbackward_char
;
241 Lisp_Object Qundefined
;
242 static Lisp_Object Qtimer_event_handler
;
244 /* read_key_sequence stores here the command definition of the
245 key sequence that it reads. */
246 static Lisp_Object read_key_sequence_cmd
;
247 static Lisp_Object read_key_sequence_remapped
;
249 static Lisp_Object Qinput_method_function
;
251 static Lisp_Object Qdeactivate_mark
;
253 Lisp_Object Qrecompute_lucid_menubar
, Qactivate_menubar_hook
;
255 static Lisp_Object Qecho_area_clear_hook
;
257 /* Hooks to run before and after each command. */
258 static Lisp_Object Qpre_command_hook
;
259 static Lisp_Object Qpost_command_hook
;
261 static Lisp_Object Qdeferred_action_function
;
263 static Lisp_Object Qdelayed_warnings_hook
;
265 static Lisp_Object Qinput_method_exit_on_first_char
;
266 static Lisp_Object Qinput_method_use_echo_area
;
268 static Lisp_Object Qhelp_form_show
;
270 /* File in which we write all commands we read. */
271 static FILE *dribble
;
273 /* Nonzero if input is available. */
276 /* Circular buffer for pre-read keyboard input. */
278 static struct input_event kbd_buffer
[KBD_BUFFER_SIZE
];
280 /* Pointer to next available character in kbd_buffer.
281 If kbd_fetch_ptr == kbd_store_ptr, the buffer is empty.
282 This may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the
283 next available char is in kbd_buffer[0]. */
284 static struct input_event
*kbd_fetch_ptr
;
286 /* Pointer to next place to store character in kbd_buffer. This
287 may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the next
288 character should go in kbd_buffer[0]. */
289 static struct input_event
* volatile kbd_store_ptr
;
291 /* The above pair of variables forms a "queue empty" flag. When we
292 enqueue a non-hook event, we increment kbd_store_ptr. When we
293 dequeue a non-hook event, we increment kbd_fetch_ptr. We say that
294 there is input available if the two pointers are not equal.
296 Why not just have a flag set and cleared by the enqueuing and
297 dequeuing functions? Such a flag could be screwed up by interrupts
298 at inopportune times. */
300 /* Symbols to head events. */
301 static Lisp_Object Qmouse_movement
;
302 static Lisp_Object Qscroll_bar_movement
;
303 Lisp_Object Qswitch_frame
;
304 static Lisp_Object Qdelete_frame
;
305 static Lisp_Object Qiconify_frame
;
306 static Lisp_Object Qmake_frame_visible
;
307 static Lisp_Object Qselect_window
;
308 Lisp_Object Qhelp_echo
;
310 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
311 static Lisp_Object Qmouse_fixup_help_message
;
314 /* Symbols to denote kinds of events. */
315 static Lisp_Object Qfunction_key
;
316 Lisp_Object Qmouse_click
;
317 #if defined (WINDOWSNT)
318 Lisp_Object Qlanguage_change
;
320 static Lisp_Object Qdrag_n_drop
;
321 static Lisp_Object Qsave_session
;
323 static Lisp_Object Qdbus_event
;
325 static Lisp_Object Qconfig_changed_event
;
327 /* Lisp_Object Qmouse_movement; - also an event header */
329 /* Properties of event headers. */
330 Lisp_Object Qevent_kind
;
331 static Lisp_Object Qevent_symbol_elements
;
333 /* Menu and tool bar item parts. */
334 static Lisp_Object Qmenu_enable
;
335 static Lisp_Object QCenable
, QCvisible
, QChelp
, QCkeys
, QCkey_sequence
;
336 Lisp_Object QCfilter
;
338 /* Non-nil disable property on a command means
339 do not execute it; call disabled-command-function's value instead. */
340 Lisp_Object QCtoggle
, QCradio
;
341 static Lisp_Object QCbutton
, QClabel
;
343 static Lisp_Object QCvert_only
;
345 /* An event header symbol HEAD may have a property named
346 Qevent_symbol_element_mask, which is of the form (BASE MODIFIERS);
347 BASE is the base, unmodified version of HEAD, and MODIFIERS is the
348 mask of modifiers applied to it. If present, this is used to help
349 speed up parse_modifiers. */
350 Lisp_Object Qevent_symbol_element_mask
;
352 /* An unmodified event header BASE may have a property named
353 Qmodifier_cache, which is an alist mapping modifier masks onto
354 modified versions of BASE. If present, this helps speed up
356 static Lisp_Object Qmodifier_cache
;
358 /* Symbols to use for parts of windows. */
359 Lisp_Object Qmode_line
;
360 Lisp_Object Qvertical_line
;
361 static Lisp_Object Qvertical_scroll_bar
;
362 Lisp_Object Qmenu_bar
;
364 static Lisp_Object
recursive_edit_unwind (Lisp_Object buffer
);
365 static Lisp_Object
command_loop (void);
366 static Lisp_Object Qextended_command_history
;
367 EMACS_TIME
timer_check (void);
369 static void record_menu_key (Lisp_Object c
);
370 static void echo_now (void);
371 static ptrdiff_t echo_length (void);
373 static Lisp_Object Qpolling_period
;
375 /* Incremented whenever a timer is run. */
378 /* Address (if not 0) of EMACS_TIME to zero out if a SIGIO interrupt
380 EMACS_TIME
*input_available_clear_time
;
382 /* Nonzero means use SIGIO interrupts; zero means use CBREAK mode.
383 Default is 1 if INTERRUPT_INPUT is defined. */
386 /* Nonzero while interrupts are temporarily deferred during redisplay. */
387 int interrupts_deferred
;
389 /* Allow configure to inhibit use of FIONREAD. */
390 #ifdef BROKEN_FIONREAD
394 /* We are unable to use interrupts if FIONREAD is not available,
395 so flush SIGIO so we won't try. */
396 #if !defined (FIONREAD)
402 /* If we support a window system, turn on the code to poll periodically
403 to detect C-g. It isn't actually used when doing interrupt input. */
404 #if defined (HAVE_WINDOW_SYSTEM) && !defined (USE_ASYNC_EVENTS)
405 #define POLL_FOR_INPUT
408 /* The time when Emacs started being idle. */
410 static EMACS_TIME timer_idleness_start_time
;
412 /* After Emacs stops being idle, this saves the last value
413 of timer_idleness_start_time from when it was idle. */
415 static EMACS_TIME timer_last_idleness_start_time
;
418 /* Global variable declarations. */
420 /* Flags for readable_events. */
421 #define READABLE_EVENTS_DO_TIMERS_NOW (1 << 0)
422 #define READABLE_EVENTS_FILTER_EVENTS (1 << 1)
423 #define READABLE_EVENTS_IGNORE_SQUEEZABLES (1 << 2)
425 /* Function for init_keyboard to call with no args (if nonzero). */
426 static void (*keyboard_init_hook
) (void);
428 static int read_avail_input (int);
429 static void get_input_pending (int *, int);
430 static int readable_events (int);
431 static Lisp_Object
read_char_x_menu_prompt (ptrdiff_t, Lisp_Object
*,
433 static Lisp_Object
read_char_minibuf_menu_prompt (int, ptrdiff_t,
435 static Lisp_Object
make_lispy_event (struct input_event
*);
436 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
437 static Lisp_Object
make_lispy_movement (struct frame
*, Lisp_Object
,
438 enum scroll_bar_part
,
439 Lisp_Object
, Lisp_Object
,
442 static Lisp_Object
modify_event_symbol (ptrdiff_t, int, Lisp_Object
,
443 Lisp_Object
, const char *const *,
444 Lisp_Object
*, ptrdiff_t);
445 static Lisp_Object
make_lispy_switch_frame (Lisp_Object
);
446 static int help_char_p (Lisp_Object
);
447 static void save_getcjmp (jmp_buf);
448 static void restore_getcjmp (jmp_buf);
449 static Lisp_Object
apply_modifiers (int, Lisp_Object
);
450 static void clear_event (struct input_event
*);
451 static Lisp_Object
restore_kboard_configuration (Lisp_Object
);
453 static void deliver_input_available_signal (int signo
);
455 static void handle_interrupt (void);
456 static _Noreturn
void quit_throw_to_read_char (int);
457 static void process_special_events (void);
458 static void timer_start_idle (void);
459 static void timer_stop_idle (void);
460 static void timer_resume_idle (void);
461 static void deliver_user_signal (int);
462 static char *find_user_signal_name (int);
463 static int store_user_signal_events (void);
465 /* These setters are used only in this file, so they can be private. */
467 kset_echo_string (struct kboard
*kb
, Lisp_Object val
)
469 kb
->INTERNAL_FIELD (echo_string
) = val
;
472 kset_kbd_queue (struct kboard
*kb
, Lisp_Object val
)
474 kb
->INTERNAL_FIELD (kbd_queue
) = val
;
477 kset_keyboard_translate_table (struct kboard
*kb
, Lisp_Object val
)
479 kb
->INTERNAL_FIELD (Vkeyboard_translate_table
) = val
;
482 kset_last_prefix_arg (struct kboard
*kb
, Lisp_Object val
)
484 kb
->INTERNAL_FIELD (Vlast_prefix_arg
) = val
;
487 kset_last_repeatable_command (struct kboard
*kb
, Lisp_Object val
)
489 kb
->INTERNAL_FIELD (Vlast_repeatable_command
) = val
;
492 kset_local_function_key_map (struct kboard
*kb
, Lisp_Object val
)
494 kb
->INTERNAL_FIELD (Vlocal_function_key_map
) = val
;
497 kset_overriding_terminal_local_map (struct kboard
*kb
, Lisp_Object val
)
499 kb
->INTERNAL_FIELD (Voverriding_terminal_local_map
) = val
;
502 kset_real_last_command (struct kboard
*kb
, Lisp_Object val
)
504 kb
->INTERNAL_FIELD (Vreal_last_command
) = val
;
507 kset_system_key_syms (struct kboard
*kb
, Lisp_Object val
)
509 kb
->INTERNAL_FIELD (system_key_syms
) = val
;
513 /* Add C to the echo string, if echoing is going on.
514 C can be a character, which is printed prettily ("M-C-x" and all that
515 jazz), or a symbol, whose name is printed. */
518 echo_char (Lisp_Object c
)
520 if (current_kboard
->immediate_echo
)
522 int size
= KEY_DESCRIPTION_SIZE
+ 100;
523 char *buffer
= alloca (size
);
525 Lisp_Object echo_string
;
527 echo_string
= KVAR (current_kboard
, echo_string
);
529 /* If someone has passed us a composite event, use its head symbol. */
534 ptr
= push_key_description (XINT (c
), ptr
, 1);
536 else if (SYMBOLP (c
))
538 Lisp_Object name
= SYMBOL_NAME (c
);
539 int nbytes
= SBYTES (name
);
541 if (size
- (ptr
- buffer
) < nbytes
)
543 int offset
= ptr
- buffer
;
544 size
= max (2 * size
, size
+ nbytes
);
545 buffer
= alloca (size
);
546 ptr
= buffer
+ offset
;
549 ptr
+= copy_text (SDATA (name
), (unsigned char *) ptr
, nbytes
,
550 STRING_MULTIBYTE (name
), 1);
553 if ((NILP (echo_string
) || SCHARS (echo_string
) == 0)
556 const char *text
= " (Type ? for further options)";
557 int len
= strlen (text
);
559 if (size
- (ptr
- buffer
) < len
)
561 int offset
= ptr
- buffer
;
563 buffer
= alloca (size
);
564 ptr
= buffer
+ offset
;
567 memcpy (ptr
, text
, len
);
571 /* Replace a dash from echo_dash with a space, otherwise
572 add a space at the end as a separator between keys. */
573 if (STRINGP (echo_string
)
574 && SCHARS (echo_string
) > 1)
576 Lisp_Object last_char
, prev_char
, idx
;
578 idx
= make_number (SCHARS (echo_string
) - 2);
579 prev_char
= Faref (echo_string
, idx
);
581 idx
= make_number (SCHARS (echo_string
) - 1);
582 last_char
= Faref (echo_string
, idx
);
584 /* We test PREV_CHAR to make sure this isn't the echoing
586 if (XINT (last_char
) == '-' && XINT (prev_char
) != ' ')
587 Faset (echo_string
, idx
, make_number (' '));
589 echo_string
= concat2 (echo_string
, build_string (" "));
591 else if (STRINGP (echo_string
))
592 echo_string
= concat2 (echo_string
, build_string (" "));
596 concat2 (echo_string
, make_string (buffer
, ptr
- buffer
)));
602 /* Temporarily add a dash to the end of the echo string if it's not
603 empty, so that it serves as a mini-prompt for the very next character. */
608 /* Do nothing if not echoing at all. */
609 if (NILP (KVAR (current_kboard
, echo_string
)))
612 if (this_command_key_count
== 0)
615 if (!current_kboard
->immediate_echo
616 && SCHARS (KVAR (current_kboard
, echo_string
)) == 0)
619 /* Do nothing if we just printed a prompt. */
620 if (current_kboard
->echo_after_prompt
621 == SCHARS (KVAR (current_kboard
, echo_string
)))
624 /* Do nothing if we have already put a dash at the end. */
625 if (SCHARS (KVAR (current_kboard
, echo_string
)) > 1)
627 Lisp_Object last_char
, prev_char
, idx
;
629 idx
= make_number (SCHARS (KVAR (current_kboard
, echo_string
)) - 2);
630 prev_char
= Faref (KVAR (current_kboard
, echo_string
), idx
);
632 idx
= make_number (SCHARS (KVAR (current_kboard
, echo_string
)) - 1);
633 last_char
= Faref (KVAR (current_kboard
, echo_string
), idx
);
635 if (XINT (last_char
) == '-' && XINT (prev_char
) != ' ')
639 /* Put a dash at the end of the buffer temporarily,
640 but make it go away when the next character is added. */
643 concat2 (KVAR (current_kboard
, echo_string
), build_string ("-")));
647 /* Display the current echo string, and begin echoing if not already
653 if (!current_kboard
->immediate_echo
)
656 current_kboard
->immediate_echo
= 1;
658 for (i
= 0; i
< this_command_key_count
; i
++)
662 /* Set before_command_echo_length to the value that would
663 have been saved before the start of this subcommand in
664 command_loop_1, if we had already been echoing then. */
665 if (i
== this_single_command_key_start
)
666 before_command_echo_length
= echo_length ();
668 c
= AREF (this_command_keys
, i
);
669 if (! (EVENT_HAS_PARAMETERS (c
)
670 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
674 /* Set before_command_echo_length to the value that would
675 have been saved before the start of this subcommand in
676 command_loop_1, if we had already been echoing then. */
677 if (this_command_key_count
== this_single_command_key_start
)
678 before_command_echo_length
= echo_length ();
680 /* Put a dash at the end to invite the user to type more. */
685 message3_nolog (KVAR (current_kboard
, echo_string
),
686 SBYTES (KVAR (current_kboard
, echo_string
)),
687 STRING_MULTIBYTE (KVAR (current_kboard
, echo_string
)));
690 /* Record in what buffer we echoed, and from which kboard. */
691 echo_message_buffer
= echo_area_buffer
[0];
692 echo_kboard
= current_kboard
;
694 if (waiting_for_input
&& !NILP (Vquit_flag
))
695 quit_throw_to_read_char (0);
698 /* Turn off echoing, for the start of a new command. */
701 cancel_echoing (void)
703 current_kboard
->immediate_echo
= 0;
704 current_kboard
->echo_after_prompt
= -1;
705 kset_echo_string (current_kboard
, Qnil
);
706 ok_to_echo_at_next_pause
= NULL
;
708 echo_message_buffer
= Qnil
;
711 /* Return the length of the current echo string. */
716 return (STRINGP (KVAR (current_kboard
, echo_string
))
717 ? SCHARS (KVAR (current_kboard
, echo_string
))
721 /* Truncate the current echo message to its first LEN chars.
722 This and echo_char get used by read_key_sequence when the user
723 switches frames while entering a key sequence. */
726 echo_truncate (ptrdiff_t nchars
)
728 if (STRINGP (KVAR (current_kboard
, echo_string
)))
729 kset_echo_string (current_kboard
,
730 Fsubstring (KVAR (current_kboard
, echo_string
),
731 make_number (0), make_number (nchars
)));
732 truncate_echo_area (nchars
);
736 /* Functions for manipulating this_command_keys. */
738 add_command_key (Lisp_Object key
)
740 #if 0 /* Not needed after we made Freset_this_command_lengths
741 do the job immediately. */
742 /* If reset-this-command-length was called recently, obey it now.
743 See the doc string of that function for an explanation of why. */
744 if (before_command_restore_flag
)
746 this_command_key_count
= before_command_key_count_1
;
747 if (this_command_key_count
< this_single_command_key_start
)
748 this_single_command_key_start
= this_command_key_count
;
749 echo_truncate (before_command_echo_length_1
);
750 before_command_restore_flag
= 0;
754 if (this_command_key_count
>= ASIZE (this_command_keys
))
755 this_command_keys
= larger_vector (this_command_keys
, 1, -1);
757 ASET (this_command_keys
, this_command_key_count
, key
);
758 ++this_command_key_count
;
763 recursive_edit_1 (void)
765 ptrdiff_t count
= SPECPDL_INDEX ();
768 if (command_loop_level
> 0)
770 specbind (Qstandard_output
, Qt
);
771 specbind (Qstandard_input
, Qt
);
774 #ifdef HAVE_WINDOW_SYSTEM
775 /* The command loop has started an hourglass timer, so we have to
776 cancel it here, otherwise it will fire because the recursive edit
777 can take some time. Do not check for display_hourglass_p here,
778 because it could already be nil. */
782 /* This function may have been called from a debugger called from
783 within redisplay, for instance by Edebugging a function called
784 from fontification-functions. We want to allow redisplay in
785 the debugging session.
787 The recursive edit is left with a `(throw exit ...)'. The `exit'
788 tag is not caught anywhere in redisplay, i.e. when we leave the
789 recursive edit, the original redisplay leading to the recursive
790 edit will be unwound. The outcome should therefore be safe. */
791 specbind (Qinhibit_redisplay
, Qnil
);
794 val
= command_loop ();
796 Fsignal (Qquit
, Qnil
);
797 /* Handle throw from read_minibuf when using minibuffer
798 while it's active but we're in another window. */
800 xsignal1 (Qerror
, val
);
802 return unbind_to (count
, Qnil
);
805 /* When an auto-save happens, record the "time", and don't do again soon. */
808 record_auto_save (void)
810 last_auto_save
= num_nonmacro_input_events
;
813 /* Make an auto save happen as soon as possible at command level. */
817 force_auto_save_soon (void)
819 last_auto_save
= - auto_save_interval
- 1;
821 record_asynch_buffer_change ();
825 DEFUN ("recursive-edit", Frecursive_edit
, Srecursive_edit
, 0, 0, "",
826 doc
: /* Invoke the editor command loop recursively.
827 To get out of the recursive edit, a command can do `(throw 'exit nil)';
828 that tells this function to return.
829 Alternatively, `(throw 'exit t)' makes this function signal an error.
830 This function is called by the editor initialization to begin editing. */)
833 ptrdiff_t count
= SPECPDL_INDEX ();
836 /* If we enter while input is blocked, don't lock up here.
837 This may happen through the debugger during redisplay. */
841 command_loop_level
++;
842 update_mode_lines
= 1;
844 if (command_loop_level
845 && current_buffer
!= XBUFFER (XWINDOW (selected_window
)->buffer
))
846 buffer
= Fcurrent_buffer ();
850 /* If we leave recursive_edit_1 below with a `throw' for instance,
851 like it is done in the splash screen display, we have to
852 make sure that we restore single_kboard as command_loop_1
853 would have done if it were left normally. */
854 if (command_loop_level
> 0)
855 temporarily_switch_to_single_kboard (SELECTED_FRAME ());
856 record_unwind_protect (recursive_edit_unwind
, buffer
);
859 return unbind_to (count
, Qnil
);
863 recursive_edit_unwind (Lisp_Object buffer
)
865 if (BUFFERP (buffer
))
866 Fset_buffer (buffer
);
868 command_loop_level
--;
869 update_mode_lines
= 1;
874 #if 0 /* These two functions are now replaced with
875 temporarily_switch_to_single_kboard. */
879 #if 0 /* Theory: if there's anything in Vunread_command_events,
880 it will right away be read by read_key_sequence,
881 and then if we do switch KBOARDS, it will go into the side
882 queue then. So we don't need to do anything special here -- rms. */
883 if (CONSP (Vunread_command_events
))
885 current_kboard
->kbd_queue
886 = nconc2 (Vunread_command_events
, current_kboard
->kbd_queue
);
887 current_kboard
->kbd_queue_has_data
= 1;
889 Vunread_command_events
= Qnil
;
894 /* Switch to the single-kboard state, making current_kboard
895 the only KBOARD from which further input is accepted. */
898 single_kboard_state ()
904 /* If we're in single_kboard state for kboard KBOARD,
908 not_single_kboard_state (KBOARD
*kboard
)
910 if (kboard
== current_kboard
)
914 /* Maintain a stack of kboards, so other parts of Emacs
915 can switch temporarily to the kboard of a given frame
916 and then revert to the previous status. */
921 struct kboard_stack
*next
;
924 static struct kboard_stack
*kboard_stack
;
927 push_kboard (struct kboard
*k
)
929 struct kboard_stack
*p
= xmalloc (sizeof *p
);
931 p
->next
= kboard_stack
;
932 p
->kboard
= current_kboard
;
942 struct kboard_stack
*p
= kboard_stack
;
944 for (t
= terminal_list
; t
; t
= t
->next_terminal
)
946 if (t
->kboard
== p
->kboard
)
948 current_kboard
= p
->kboard
;
955 /* The terminal we remembered has been deleted. */
956 current_kboard
= FRAME_KBOARD (SELECTED_FRAME ());
959 kboard_stack
= p
->next
;
963 /* Switch to single_kboard mode, making current_kboard the only KBOARD
964 from which further input is accepted. If F is non-nil, set its
965 KBOARD as the current keyboard.
967 This function uses record_unwind_protect to return to the previous
970 If Emacs is already in single_kboard mode, and F's keyboard is
971 locked, then this function will throw an error. */
974 temporarily_switch_to_single_kboard (struct frame
*f
)
976 int was_locked
= single_kboard
;
979 if (f
!= NULL
&& FRAME_KBOARD (f
) != current_kboard
)
980 /* We can not switch keyboards while in single_kboard mode.
981 In rare cases, Lisp code may call `recursive-edit' (or
982 `read-minibuffer' or `y-or-n-p') after it switched to a
983 locked frame. For example, this is likely to happen
984 when server.el connects to a new terminal while Emacs is in
985 single_kboard mode. It is best to throw an error instead
986 of presenting the user with a frozen screen. */
987 error ("Terminal %d is locked, cannot read from it",
988 FRAME_TERMINAL (f
)->id
);
990 /* This call is unnecessary, but helps
991 `restore_kboard_configuration' discover if somebody changed
992 `current_kboard' behind our back. */
993 push_kboard (current_kboard
);
996 current_kboard
= FRAME_KBOARD (f
);
998 record_unwind_protect (restore_kboard_configuration
,
999 (was_locked
? Qt
: Qnil
));
1002 #if 0 /* This function is not needed anymore. */
1004 record_single_kboard_state ()
1007 push_kboard (current_kboard
);
1008 record_unwind_protect (restore_kboard_configuration
,
1009 (single_kboard
? Qt
: Qnil
));
1014 restore_kboard_configuration (Lisp_Object was_locked
)
1016 if (NILP (was_locked
))
1020 struct kboard
*prev
= current_kboard
;
1023 /* The pop should not change the kboard. */
1024 if (single_kboard
&& current_kboard
!= prev
)
1031 /* Handle errors that are not handled at inner levels
1032 by printing an error message and returning to the editor command loop. */
1035 cmd_error (Lisp_Object data
)
1037 Lisp_Object old_level
, old_length
;
1038 char macroerror
[sizeof "After..kbd macro iterations: "
1039 + INT_STRLEN_BOUND (EMACS_INT
)];
1041 #ifdef HAVE_WINDOW_SYSTEM
1042 if (display_hourglass_p
)
1043 cancel_hourglass ();
1046 if (!NILP (executing_kbd_macro
))
1048 if (executing_kbd_macro_iterations
== 1)
1049 sprintf (macroerror
, "After 1 kbd macro iteration: ");
1051 sprintf (macroerror
, "After %"pI
"d kbd macro iterations: ",
1052 executing_kbd_macro_iterations
);
1057 Vstandard_output
= Qt
;
1058 Vstandard_input
= Qt
;
1059 Vexecuting_kbd_macro
= Qnil
;
1060 executing_kbd_macro
= Qnil
;
1061 kset_prefix_arg (current_kboard
, Qnil
);
1062 kset_last_prefix_arg (current_kboard
, Qnil
);
1065 /* Avoid unquittable loop if data contains a circular list. */
1066 old_level
= Vprint_level
;
1067 old_length
= Vprint_length
;
1068 XSETFASTINT (Vprint_level
, 10);
1069 XSETFASTINT (Vprint_length
, 10);
1070 cmd_error_internal (data
, macroerror
);
1071 Vprint_level
= old_level
;
1072 Vprint_length
= old_length
;
1076 Vinhibit_quit
= Qnil
;
1077 #if 0 /* This shouldn't be necessary anymore. --lorentey */
1078 if (command_loop_level
== 0 && minibuf_level
== 0)
1079 any_kboard_state ();
1082 return make_number (0);
1085 /* Take actions on handling an error. DATA is the data that describes
1088 CONTEXT is a C-string containing ASCII characters only which
1089 describes the context in which the error happened. If we need to
1090 generalize CONTEXT to allow multibyte characters, make it a Lisp
1094 cmd_error_internal (Lisp_Object data
, const char *context
)
1096 struct frame
*sf
= SELECTED_FRAME ();
1098 /* The immediate context is not interesting for Quits,
1099 since they are asynchronous. */
1100 if (EQ (XCAR (data
), Qquit
))
1101 Vsignaling_function
= Qnil
;
1106 /* Use user's specified output function if any. */
1107 if (!NILP (Vcommand_error_function
))
1108 call3 (Vcommand_error_function
, data
,
1109 context
? build_string (context
) : empty_unibyte_string
,
1110 Vsignaling_function
);
1111 /* If the window system or terminal frame hasn't been initialized
1112 yet, or we're not interactive, write the message to stderr and exit. */
1113 else if (!sf
->glyphs_initialized_p
1114 /* The initial frame is a special non-displaying frame. It
1115 will be current in daemon mode when there are no frames
1116 to display, and in non-daemon mode before the real frame
1117 has finished initializing. If an error is thrown in the
1118 latter case while creating the frame, then the frame
1119 will never be displayed, so the safest thing to do is
1120 write to stderr and quit. In daemon mode, there are
1121 many other potential errors that do not prevent frames
1122 from being created, so continuing as normal is better in
1124 || (!IS_DAEMON
&& FRAME_INITIAL_P (sf
))
1127 print_error_message (data
, Qexternal_debugging_output
,
1128 context
, Vsignaling_function
);
1129 Fterpri (Qexternal_debugging_output
);
1130 Fkill_emacs (make_number (-1));
1134 clear_message (1, 0);
1136 message_log_maybe_newline ();
1139 print_error_message (data
, Qt
, context
, Vsignaling_function
);
1142 Vsignaling_function
= Qnil
;
1145 Lisp_Object
command_loop_1 (void);
1146 static Lisp_Object
command_loop_2 (Lisp_Object
);
1147 static Lisp_Object
top_level_1 (Lisp_Object
);
1149 /* Entry to editor-command-loop.
1150 This level has the catches for exiting/returning to editor command loop.
1151 It returns nil to exit recursive edit, t to abort it. */
1156 if (command_loop_level
> 0 || minibuf_level
> 0)
1159 val
= internal_catch (Qexit
, command_loop_2
, Qnil
);
1160 executing_kbd_macro
= Qnil
;
1166 internal_catch (Qtop_level
, top_level_1
, Qnil
);
1167 #if 0 /* This shouldn't be necessary anymore. --lorentey */
1168 /* Reset single_kboard in case top-level set it while
1169 evaluating an -f option, or we are stuck there for some
1171 any_kboard_state ();
1173 internal_catch (Qtop_level
, command_loop_2
, Qnil
);
1174 executing_kbd_macro
= Qnil
;
1176 /* End of file in -batch run causes exit here. */
1182 /* Here we catch errors in execution of commands within the
1183 editing loop, and reenter the editing loop.
1184 When there is an error, cmd_error runs and returns a non-nil
1185 value to us. A value of nil means that command_loop_1 itself
1186 returned due to end of file (or end of kbd macro). */
1189 command_loop_2 (Lisp_Object ignore
)
1191 register Lisp_Object val
;
1194 val
= internal_condition_case (command_loop_1
, Qerror
, cmd_error
);
1195 while (!NILP (val
));
1203 return Feval (Vtop_level
, Qnil
);
1207 top_level_1 (Lisp_Object ignore
)
1209 /* On entry to the outer level, run the startup file */
1210 if (!NILP (Vtop_level
))
1211 internal_condition_case (top_level_2
, Qerror
, cmd_error
);
1212 else if (!NILP (Vpurify_flag
))
1213 message ("Bare impure Emacs (standard Lisp code not loaded)");
1215 message ("Bare Emacs (standard Lisp code not loaded)");
1219 DEFUN ("top-level", Ftop_level
, Stop_level
, 0, 0, "",
1220 doc
: /* Exit all recursive editing levels.
1221 This also exits all active minibuffers. */)
1224 #ifdef HAVE_WINDOW_SYSTEM
1225 if (display_hourglass_p
)
1226 cancel_hourglass ();
1229 /* Unblock input if we enter with input blocked. This may happen if
1230 redisplay traps e.g. during tool-bar update with input blocked. */
1231 while (INPUT_BLOCKED_P
)
1234 Fthrow (Qtop_level
, Qnil
);
1237 static _Noreturn
void
1238 user_error (const char *msg
)
1240 xsignal1 (Quser_error
, build_string (msg
));
1244 DEFUN ("exit-recursive-edit", Fexit_recursive_edit
, Sexit_recursive_edit
, 0, 0, "",
1245 doc
: /* Exit from the innermost recursive edit or minibuffer. */)
1248 if (command_loop_level
> 0 || minibuf_level
> 0)
1249 Fthrow (Qexit
, Qnil
);
1251 user_error ("No recursive edit is in progress");
1255 DEFUN ("abort-recursive-edit", Fabort_recursive_edit
, Sabort_recursive_edit
, 0, 0, "",
1256 doc
: /* Abort the command that requested this recursive edit or minibuffer input. */)
1259 if (command_loop_level
> 0 || minibuf_level
> 0)
1262 user_error ("No recursive edit is in progress");
1265 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
1267 /* Restore mouse tracking enablement. See Ftrack_mouse for the only use
1268 of this function. */
1271 tracking_off (Lisp_Object old_value
)
1273 do_mouse_tracking
= old_value
;
1274 if (NILP (old_value
))
1276 /* Redisplay may have been preempted because there was input
1277 available, and it assumes it will be called again after the
1278 input has been processed. If the only input available was
1279 the sort that we have just disabled, then we need to call
1281 if (!readable_events (READABLE_EVENTS_DO_TIMERS_NOW
))
1283 redisplay_preserve_echo_area (6);
1284 get_input_pending (&input_pending
,
1285 READABLE_EVENTS_DO_TIMERS_NOW
);
1291 DEFUN ("track-mouse", Ftrack_mouse
, Strack_mouse
, 0, UNEVALLED
, 0,
1292 doc
: /* Evaluate BODY with mouse movement events enabled.
1293 Within a `track-mouse' form, mouse motion generates input events that
1294 you can read with `read-event'.
1295 Normally, mouse motion is ignored.
1296 usage: (track-mouse BODY...) */)
1299 ptrdiff_t count
= SPECPDL_INDEX ();
1302 record_unwind_protect (tracking_off
, do_mouse_tracking
);
1304 do_mouse_tracking
= Qt
;
1306 val
= Fprogn (args
);
1307 return unbind_to (count
, val
);
1310 /* If mouse has moved on some frame, return one of those frames.
1314 If ignore_mouse_drag_p is non-zero, ignore (implicit) mouse movement
1315 after resizing the tool-bar window. */
1317 #if !defined HAVE_WINDOW_SYSTEM || defined USE_GTK || defined HAVE_NS
1320 int ignore_mouse_drag_p
;
1323 some_mouse_moved (void)
1325 Lisp_Object tail
, frame
;
1327 if (ignore_mouse_drag_p
)
1329 /* ignore_mouse_drag_p = 0; */
1333 FOR_EACH_FRAME (tail
, frame
)
1335 if (XFRAME (frame
)->mouse_moved
)
1336 return XFRAME (frame
);
1342 #endif /* HAVE_MOUSE || HAVE_GPM */
1344 /* This is the actual command reading loop,
1345 sans error-handling encapsulation. */
1347 static int read_key_sequence (Lisp_Object
*, int, Lisp_Object
,
1349 void safe_run_hooks (Lisp_Object
);
1350 static void adjust_point_for_property (ptrdiff_t, int);
1352 /* Cancel hourglass from protect_unwind.
1354 #ifdef HAVE_WINDOW_SYSTEM
1356 cancel_hourglass_unwind (Lisp_Object arg
)
1358 cancel_hourglass ();
1363 /* The last boundary auto-added to buffer-undo-list. */
1364 Lisp_Object last_undo_boundary
;
1366 /* FIXME: This is wrong rather than test window-system, we should call
1367 a new set-selection, which will then dispatch to x-set-selection, or
1368 tty-set-selection, or w32-set-selection, ... */
1371 command_loop_1 (void)
1374 Lisp_Object keybuf
[30];
1376 EMACS_INT prev_modiff
= 0;
1377 struct buffer
*prev_buffer
= NULL
;
1378 #if 0 /* This shouldn't be necessary anymore. --lorentey */
1379 int was_locked
= single_kboard
;
1381 int already_adjusted
= 0;
1383 kset_prefix_arg (current_kboard
, Qnil
);
1384 kset_last_prefix_arg (current_kboard
, Qnil
);
1385 Vdeactivate_mark
= Qnil
;
1386 waiting_for_input
= 0;
1389 this_command_key_count
= 0;
1390 this_command_key_count_reset
= 0;
1391 this_single_command_key_start
= 0;
1393 if (NILP (Vmemory_full
))
1395 /* Make sure this hook runs after commands that get errors and
1396 throw to top level. */
1397 /* Note that the value cell will never directly contain nil
1398 if the symbol is a local variable. */
1399 if (!NILP (Vpost_command_hook
) && !NILP (Vrun_hooks
))
1400 safe_run_hooks (Qpost_command_hook
);
1402 /* If displaying a message, resize the echo area window to fit
1403 that message's size exactly. */
1404 if (!NILP (echo_area_buffer
[0]))
1405 resize_echo_area_exactly ();
1407 /* If there are warnings waiting, process them. */
1408 if (!NILP (Vdelayed_warnings_list
))
1409 safe_run_hooks (Qdelayed_warnings_hook
);
1411 if (!NILP (Vdeferred_action_list
))
1412 safe_run_hooks (Qdeferred_action_function
);
1415 /* Do this after running Vpost_command_hook, for consistency. */
1416 kset_last_command (current_kboard
, Vthis_command
);
1417 kset_real_last_command (current_kboard
, Vreal_this_command
);
1418 if (!CONSP (last_command_event
))
1419 kset_last_repeatable_command (current_kboard
, Vreal_this_command
);
1423 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1426 /* Make sure the current window's buffer is selected. */
1427 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->buffer
));
1429 /* Display any malloc warning that just came out. Use while because
1430 displaying one warning can cause another. */
1432 while (pending_malloc_warning
)
1433 display_malloc_warning ();
1435 Vdeactivate_mark
= Qnil
;
1437 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
1439 /* Don't ignore mouse movements for more than a single command
1440 loop. (This flag is set in xdisp.c whenever the tool bar is
1441 resized, because the resize moves text up or down, and would
1442 generate false mouse drag events if we don't ignore them.) */
1443 ignore_mouse_drag_p
= 0;
1446 /* If minibuffer on and echo area in use,
1447 wait a short time and redraw minibuffer. */
1450 && !NILP (echo_area_buffer
[0])
1451 && EQ (minibuf_window
, echo_area_window
)
1452 && NUMBERP (Vminibuffer_message_timeout
))
1454 /* Bind inhibit-quit to t so that C-g gets read in
1455 rather than quitting back to the minibuffer. */
1456 ptrdiff_t count
= SPECPDL_INDEX ();
1457 specbind (Qinhibit_quit
, Qt
);
1459 sit_for (Vminibuffer_message_timeout
, 0, 2);
1461 /* Clear the echo area. */
1463 safe_run_hooks (Qecho_area_clear_hook
);
1465 unbind_to (count
, Qnil
);
1467 /* If a C-g came in before, treat it as input now. */
1468 if (!NILP (Vquit_flag
))
1471 Vunread_command_events
= Fcons (make_number (quit_char
), Qnil
);
1476 /* Select the frame that the last event came from. Usually,
1477 switch-frame events will take care of this, but if some lisp
1478 code swallows a switch-frame event, we'll fix things up here.
1479 Is this a good idea? */
1480 if (FRAMEP (internal_last_event_frame
)
1481 && !EQ (internal_last_event_frame
, selected_frame
))
1482 Fselect_frame (internal_last_event_frame
, Qnil
);
1484 /* If it has changed current-menubar from previous value,
1485 really recompute the menubar from the value. */
1486 if (! NILP (Vlucid_menu_bar_dirty_flag
)
1487 && !NILP (Ffboundp (Qrecompute_lucid_menubar
)))
1488 call0 (Qrecompute_lucid_menubar
);
1490 before_command_key_count
= this_command_key_count
;
1491 before_command_echo_length
= echo_length ();
1493 Vthis_command
= Qnil
;
1494 Vreal_this_command
= Qnil
;
1495 Vthis_original_command
= Qnil
;
1496 Vthis_command_keys_shift_translated
= Qnil
;
1498 /* Read next key sequence; i gets its length. */
1499 i
= read_key_sequence (keybuf
, sizeof keybuf
/ sizeof keybuf
[0],
1502 /* A filter may have run while we were reading the input. */
1503 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1505 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->buffer
));
1509 /* Now we have read a key sequence of length I,
1510 or else I is 0 and we found end of file. */
1512 if (i
== 0) /* End of file -- happens only in */
1513 return Qnil
; /* a kbd macro, at the end. */
1514 /* -1 means read_key_sequence got a menu that was rejected.
1515 Just loop around and read another command. */
1519 this_command_key_count
= 0;
1520 this_command_key_count_reset
= 0;
1521 this_single_command_key_start
= 0;
1525 last_command_event
= keybuf
[i
- 1];
1527 /* If the previous command tried to force a specific window-start,
1528 forget about that, in case this command moves point far away
1529 from that position. But also throw away beg_unchanged and
1530 end_unchanged information in that case, so that redisplay will
1531 update the whole window properly. */
1532 if (XWINDOW (selected_window
)->force_start
)
1535 XWINDOW (selected_window
)->force_start
= 0;
1536 b
= XBUFFER (XWINDOW (selected_window
)->buffer
);
1537 BUF_BEG_UNCHANGED (b
) = BUF_END_UNCHANGED (b
) = 0;
1540 cmd
= read_key_sequence_cmd
;
1541 if (!NILP (Vexecuting_kbd_macro
))
1543 if (!NILP (Vquit_flag
))
1545 Vexecuting_kbd_macro
= Qt
;
1546 QUIT
; /* Make some noise. */
1547 /* Will return since macro now empty. */
1551 /* Do redisplay processing after this command except in special
1552 cases identified below. */
1553 prev_buffer
= current_buffer
;
1554 prev_modiff
= MODIFF
;
1555 last_point_position
= PT
;
1556 last_point_position_window
= selected_window
;
1557 XSETBUFFER (last_point_position_buffer
, prev_buffer
);
1559 /* By default, we adjust point to a boundary of a region that
1560 has such a property that should be treated intangible
1561 (e.g. composition, display). But, some commands will set
1562 this variable differently. */
1563 Vdisable_point_adjustment
= Qnil
;
1565 /* Process filters and timers may have messed with deactivate-mark.
1566 reset it before we execute the command. */
1567 Vdeactivate_mark
= Qnil
;
1569 /* Remap command through active keymaps. */
1570 Vthis_original_command
= cmd
;
1571 if (!NILP (read_key_sequence_remapped
))
1572 cmd
= read_key_sequence_remapped
;
1574 /* Execute the command. */
1576 Vthis_command
= cmd
;
1577 Vreal_this_command
= cmd
;
1578 safe_run_hooks (Qpre_command_hook
);
1580 already_adjusted
= 0;
1582 if (NILP (Vthis_command
))
1584 /* nil means key is undefined. */
1585 Lisp_Object keys
= Fvector (i
, keybuf
);
1586 keys
= Fkey_description (keys
, Qnil
);
1588 message_with_string ("%s is undefined", keys
, 0);
1589 kset_defining_kbd_macro (current_kboard
, Qnil
);
1590 update_mode_lines
= 1;
1591 /* If this is a down-mouse event, don't reset prefix-arg;
1592 pass it to the command run by the up event. */
1593 if (EVENT_HAS_PARAMETERS (last_command_event
))
1595 Lisp_Object breakdown
1596 = parse_modifiers (EVENT_HEAD (last_command_event
));
1597 int modifiers
= XINT (XCAR (XCDR (breakdown
)));
1598 if (!(modifiers
& down_modifier
))
1599 kset_prefix_arg (current_kboard
, Qnil
);
1602 kset_prefix_arg (current_kboard
, Qnil
);
1606 /* Here for a command that isn't executed directly. */
1608 #ifdef HAVE_WINDOW_SYSTEM
1609 ptrdiff_t scount
= SPECPDL_INDEX ();
1611 if (display_hourglass_p
1612 && NILP (Vexecuting_kbd_macro
))
1614 record_unwind_protect (cancel_hourglass_unwind
, Qnil
);
1619 if (NILP (KVAR (current_kboard
, Vprefix_arg
))) /* FIXME: Why? --Stef */
1621 Lisp_Object undo
= BVAR (current_buffer
, undo_list
);
1624 = (EQ (undo
, BVAR (current_buffer
, undo_list
))
1625 ? Qnil
: BVAR (current_buffer
, undo_list
));
1627 Fcommand_execute (Vthis_command
, Qnil
, Qnil
, Qnil
);
1629 #ifdef HAVE_WINDOW_SYSTEM
1630 /* Do not check display_hourglass_p here, because
1631 Fcommand_execute could change it, but we should cancel
1632 hourglass cursor anyway.
1633 But don't cancel the hourglass within a macro
1634 just because a command in the macro finishes. */
1635 if (NILP (Vexecuting_kbd_macro
))
1636 unbind_to (scount
, Qnil
);
1639 kset_last_prefix_arg (current_kboard
, Vcurrent_prefix_arg
);
1641 safe_run_hooks (Qpost_command_hook
);
1643 /* If displaying a message, resize the echo area window to fit
1644 that message's size exactly. */
1645 if (!NILP (echo_area_buffer
[0]))
1646 resize_echo_area_exactly ();
1648 /* If there are warnings waiting, process them. */
1649 if (!NILP (Vdelayed_warnings_list
))
1650 safe_run_hooks (Qdelayed_warnings_hook
);
1652 safe_run_hooks (Qdeferred_action_function
);
1654 /* If there is a prefix argument,
1655 1) We don't want Vlast_command to be ``universal-argument''
1656 (that would be dumb), so don't set Vlast_command,
1657 2) we want to leave echoing on so that the prefix will be
1658 echoed as part of this key sequence, so don't call
1660 3) we want to leave this_command_key_count non-zero, so that
1661 read_char will realize that it is re-reading a character, and
1662 not echo it a second time.
1664 If the command didn't actually create a prefix arg,
1665 but is merely a frame event that is transparent to prefix args,
1666 then the above doesn't apply. */
1667 if (NILP (KVAR (current_kboard
, Vprefix_arg
))
1668 || CONSP (last_command_event
))
1670 kset_last_command (current_kboard
, Vthis_command
);
1671 kset_real_last_command (current_kboard
, Vreal_this_command
);
1672 if (!CONSP (last_command_event
))
1673 kset_last_repeatable_command (current_kboard
, Vreal_this_command
);
1675 this_command_key_count
= 0;
1676 this_command_key_count_reset
= 0;
1677 this_single_command_key_start
= 0;
1680 if (!NILP (BVAR (current_buffer
, mark_active
))
1681 && !NILP (Vrun_hooks
))
1683 /* In Emacs 22, setting transient-mark-mode to `only' was a
1684 way of turning it on for just one command. This usage is
1685 obsolete, but support it anyway. */
1686 if (EQ (Vtransient_mark_mode
, Qidentity
))
1687 Vtransient_mark_mode
= Qnil
;
1688 else if (EQ (Vtransient_mark_mode
, Qonly
))
1689 Vtransient_mark_mode
= Qidentity
;
1691 if (!NILP (Vdeactivate_mark
))
1692 /* If `select-active-regions' is non-nil, this call to
1693 `deactivate-mark' also sets the PRIMARY selection. */
1694 call0 (Qdeactivate_mark
);
1697 /* Even if not deactivating the mark, set PRIMARY if
1698 `select-active-regions' is non-nil. */
1699 if (!NILP (Fwindow_system (Qnil
))
1700 /* Even if mark_active is non-nil, the actual buffer
1701 marker may not have been set yet (Bug#7044). */
1702 && XMARKER (BVAR (current_buffer
, mark
))->buffer
1703 && (EQ (Vselect_active_regions
, Qonly
)
1704 ? EQ (CAR_SAFE (Vtransient_mark_mode
), Qonly
)
1705 : (!NILP (Vselect_active_regions
)
1706 && !NILP (Vtransient_mark_mode
)))
1707 && NILP (Fmemq (Vthis_command
,
1708 Vselection_inhibit_update_commands
)))
1711 XINT (Fmarker_position (BVAR (current_buffer
, mark
)));
1714 call2 (Qx_set_selection
, QPRIMARY
,
1715 make_buffer_string (beg
, end
, 0));
1717 call2 (Qx_set_selection
, QPRIMARY
,
1718 make_buffer_string (end
, beg
, 0));
1719 /* Don't set empty selections. */
1722 if (current_buffer
!= prev_buffer
|| MODIFF
!= prev_modiff
)
1724 Lisp_Object hook
= intern ("activate-mark-hook");
1725 Frun_hooks (1, &hook
);
1729 Vsaved_region_selection
= Qnil
;
1734 if (current_buffer
== prev_buffer
1735 && last_point_position
!= PT
1736 && NILP (Vdisable_point_adjustment
)
1737 && NILP (Vglobal_disable_point_adjustment
))
1739 if (last_point_position
> BEGV
1740 && last_point_position
< ZV
1741 && (composition_adjust_point (last_point_position
,
1742 last_point_position
)
1743 != last_point_position
))
1744 /* The last point was temporarily set within a grapheme
1745 cluster to prevent automatic composition. To recover
1746 the automatic composition, we must update the
1748 windows_or_buffers_changed
++;
1749 if (!already_adjusted
)
1750 adjust_point_for_property (last_point_position
,
1751 MODIFF
!= prev_modiff
);
1754 /* Install chars successfully executed in kbd macro. */
1756 if (!NILP (KVAR (current_kboard
, defining_kbd_macro
))
1757 && NILP (KVAR (current_kboard
, Vprefix_arg
)))
1758 finalize_kbd_macro_chars ();
1759 #if 0 /* This shouldn't be necessary anymore. --lorentey */
1761 any_kboard_state ();
1766 /* Adjust point to a boundary of a region that has such a property
1767 that should be treated intangible. For the moment, we check
1768 `composition', `display' and `invisible' properties.
1769 LAST_PT is the last position of point. */
1772 adjust_point_for_property (ptrdiff_t last_pt
, int modified
)
1775 Lisp_Object val
, overlay
, tmp
;
1776 /* When called after buffer modification, we should temporarily
1777 suppress the point adjustment for automatic composition so that a
1778 user can keep inserting another character at point or keep
1779 deleting characters around point. */
1780 int check_composition
= ! modified
, check_display
= 1, check_invisible
= 1;
1781 ptrdiff_t orig_pt
= PT
;
1783 /* FIXME: cycling is probably not necessary because these properties
1784 can't be usefully combined anyway. */
1785 while (check_composition
|| check_display
|| check_invisible
)
1787 /* FIXME: check `intangible'. */
1788 if (check_composition
1789 && PT
> BEGV
&& PT
< ZV
1790 && (beg
= composition_adjust_point (last_pt
, PT
)) != PT
)
1793 check_display
= check_invisible
= 1;
1795 check_composition
= 0;
1797 && PT
> BEGV
&& PT
< ZV
1798 && !NILP (val
= get_char_property_and_overlay
1799 (make_number (PT
), Qdisplay
, Qnil
, &overlay
))
1800 && display_prop_intangible_p (val
, overlay
, PT
, PT_BYTE
)
1801 && (!OVERLAYP (overlay
)
1802 ? get_property_and_range (PT
, Qdisplay
, &val
, &beg
, &end
, Qnil
)
1803 : (beg
= OVERLAY_POSITION (OVERLAY_START (overlay
)),
1804 end
= OVERLAY_POSITION (OVERLAY_END (overlay
))))
1805 && (beg
< PT
/* && end > PT <- It's always the case. */
1806 || (beg
<= PT
&& STRINGP (val
) && SCHARS (val
) == 0)))
1809 SET_PT (PT
< last_pt
1810 ? (STRINGP (val
) && SCHARS (val
) == 0
1811 ? max (beg
- 1, BEGV
)
1814 check_composition
= check_invisible
= 1;
1817 if (check_invisible
&& PT
> BEGV
&& PT
< ZV
)
1819 int inv
, ellipsis
= 0;
1822 /* Find boundaries `beg' and `end' of the invisible area, if any. */
1825 /* FIXME: We should stop if we find a spot between
1826 two runs of `invisible' where inserted text would
1827 be visible. This is important when we have two
1828 invisible boundaries that enclose an area: if the
1829 area is empty, we need this test in order to make
1830 it possible to place point in the middle rather
1831 than skip both boundaries. However, this code
1832 also stops anywhere in a non-sticky text-property,
1833 which breaks (e.g.) Org mode. */
1834 && (val
= get_pos_property (make_number (end
),
1836 TEXT_PROP_MEANS_INVISIBLE (val
))
1838 && !NILP (val
= get_char_property_and_overlay
1839 (make_number (end
), Qinvisible
, Qnil
, &overlay
))
1840 && (inv
= TEXT_PROP_MEANS_INVISIBLE (val
)))
1842 ellipsis
= ellipsis
|| inv
> 1
1843 || (OVERLAYP (overlay
)
1844 && (!NILP (Foverlay_get (overlay
, Qafter_string
))
1845 || !NILP (Foverlay_get (overlay
, Qbefore_string
))));
1846 tmp
= Fnext_single_char_property_change
1847 (make_number (end
), Qinvisible
, Qnil
, Qnil
);
1848 end
= NATNUMP (tmp
) ? XFASTINT (tmp
) : ZV
;
1852 && (val
= get_pos_property (make_number (beg
),
1854 TEXT_PROP_MEANS_INVISIBLE (val
))
1856 && !NILP (val
= get_char_property_and_overlay
1857 (make_number (beg
- 1), Qinvisible
, Qnil
, &overlay
))
1858 && (inv
= TEXT_PROP_MEANS_INVISIBLE (val
)))
1860 ellipsis
= ellipsis
|| inv
> 1
1861 || (OVERLAYP (overlay
)
1862 && (!NILP (Foverlay_get (overlay
, Qafter_string
))
1863 || !NILP (Foverlay_get (overlay
, Qbefore_string
))));
1864 tmp
= Fprevious_single_char_property_change
1865 (make_number (beg
), Qinvisible
, Qnil
, Qnil
);
1866 beg
= NATNUMP (tmp
) ? XFASTINT (tmp
) : BEGV
;
1869 /* Move away from the inside area. */
1870 if (beg
< PT
&& end
> PT
)
1872 SET_PT ((orig_pt
== PT
&& (last_pt
< beg
|| last_pt
> end
))
1873 /* We haven't moved yet (so we don't need to fear
1874 infinite-looping) and we were outside the range
1875 before (so either end of the range still corresponds
1876 to a move in the right direction): pretend we moved
1877 less than we actually did, so that we still have
1878 more freedom below in choosing which end of the range
1880 ? (orig_pt
= -1, PT
< last_pt
? end
: beg
)
1881 /* We either have moved already or the last point
1882 was already in the range: we don't get to choose
1883 which end of the range we have to go to. */
1884 : (PT
< last_pt
? beg
: end
));
1885 check_composition
= check_display
= 1;
1887 #if 0 /* This assertion isn't correct, because SET_PT may end up setting
1888 the point to something other than its argument, due to
1889 point-motion hooks, intangibility, etc. */
1890 eassert (PT
== beg
|| PT
== end
);
1893 /* Pretend the area doesn't exist if the buffer is not
1895 if (!modified
&& !ellipsis
&& beg
< end
)
1897 if (last_pt
== beg
&& PT
== end
&& end
< ZV
)
1898 (check_composition
= check_display
= 1, SET_PT (end
+ 1));
1899 else if (last_pt
== end
&& PT
== beg
&& beg
> BEGV
)
1900 (check_composition
= check_display
= 1, SET_PT (beg
- 1));
1901 else if (PT
== ((PT
< last_pt
) ? beg
: end
))
1902 /* We've already moved as far as we can. Trying to go
1903 to the other end would mean moving backwards and thus
1904 could lead to an infinite loop. */
1906 else if (val
= get_pos_property (make_number (PT
),
1908 TEXT_PROP_MEANS_INVISIBLE (val
)
1909 && (val
= get_pos_property
1910 (make_number (PT
== beg
? end
: beg
),
1912 !TEXT_PROP_MEANS_INVISIBLE (val
)))
1913 (check_composition
= check_display
= 1,
1914 SET_PT (PT
== beg
? end
: beg
));
1917 check_invisible
= 0;
1921 /* Subroutine for safe_run_hooks: run the hook HOOK. */
1924 safe_run_hooks_1 (void)
1926 eassert (CONSP (Vinhibit_quit
));
1927 return call0 (XCDR (Vinhibit_quit
));
1930 /* Subroutine for safe_run_hooks: handle an error by clearing out the function
1934 safe_run_hooks_error (Lisp_Object error_data
)
1937 = CONSP (Vinhibit_quit
) ? XCAR (Vinhibit_quit
) : Vinhibit_quit
;
1938 Lisp_Object fun
= CONSP (Vinhibit_quit
) ? XCDR (Vinhibit_quit
) : Qnil
;
1939 Lisp_Object args
[4];
1940 args
[0] = build_string ("Error in %s (%s): %S");
1943 args
[3] = error_data
;
1949 Lisp_Object newval
= Qnil
;
1950 for (val
= find_symbol_value (hook
); CONSP (val
); val
= XCDR (val
))
1951 if (EQ (fun
, XCAR (val
)))
1954 newval
= Fcons (XCAR (val
), newval
);
1956 return Fset (hook
, Fnreverse (newval
));
1957 /* Not found in the local part of the hook. Let's look at the global
1960 for (val
= (NILP (Fdefault_boundp (hook
)) ? Qnil
1961 : Fdefault_value (hook
));
1962 CONSP (val
); val
= XCDR (val
))
1963 if (EQ (fun
, XCAR (val
)))
1966 newval
= Fcons (XCAR (val
), newval
);
1968 return Fset_default (hook
, Fnreverse (newval
));
1974 safe_run_hook_funcall (ptrdiff_t nargs
, Lisp_Object
*args
)
1976 eassert (nargs
== 1);
1977 if (CONSP (Vinhibit_quit
))
1978 XSETCDR (Vinhibit_quit
, args
[0]);
1980 Vinhibit_quit
= Fcons (Vinhibit_quit
, args
[0]);
1982 internal_condition_case (safe_run_hooks_1
, Qt
, safe_run_hooks_error
);
1986 /* If we get an error while running the hook, cause the hook variable
1987 to be nil. Also inhibit quits, so that C-g won't cause the hook
1988 to mysteriously evaporate. */
1991 safe_run_hooks (Lisp_Object hook
)
1993 /* FIXME: our `internal_condition_case' does not provide any way to pass data
1994 to its body or to its handlers other than via globals such as
1995 dynamically-bound variables ;-) */
1996 ptrdiff_t count
= SPECPDL_INDEX ();
1997 specbind (Qinhibit_quit
, hook
);
1999 run_hook_with_args (1, &hook
, safe_run_hook_funcall
);
2001 unbind_to (count
, Qnil
);
2005 /* Nonzero means polling for input is temporarily suppressed. */
2007 int poll_suppress_count
;
2009 /* Asynchronous timer for polling. */
2011 static struct atimer
*poll_timer
;
2014 #ifdef POLL_FOR_INPUT
2016 /* Poll for input, so that we catch a C-g if it comes in. This
2017 function is called from x_make_frame_visible, see comment
2021 poll_for_input_1 (void)
2023 /* Tell ns_read_socket() it is being called asynchronously so it can avoid
2024 doing anything dangerous. */
2028 if (interrupt_input_blocked
== 0
2029 && !waiting_for_input
)
2030 read_avail_input (0);
2036 /* Timer callback function for poll_timer. TIMER is equal to
2040 poll_for_input (struct atimer
*timer
)
2042 if (poll_suppress_count
== 0)
2045 interrupt_input_pending
= 1;
2046 pending_signals
= 1;
2048 poll_for_input_1 ();
2053 #endif /* POLL_FOR_INPUT */
2055 /* Begin signals to poll for input, if they are appropriate.
2056 This function is called unconditionally from various places. */
2059 start_polling (void)
2061 #ifdef POLL_FOR_INPUT
2062 /* XXX This condition was (read_socket_hook && !interrupt_input),
2063 but read_socket_hook is not global anymore. Let's pretend that
2065 if (!interrupt_input
)
2067 /* Turn alarm handling on unconditionally. It might have
2068 been turned off in process.c. */
2069 turn_on_atimers (1);
2071 /* If poll timer doesn't exist, are we need one with
2072 a different interval, start a new one. */
2073 if (poll_timer
== NULL
2074 || EMACS_SECS (poll_timer
->interval
) != polling_period
)
2076 time_t period
= max (1, min (polling_period
, TYPE_MAXIMUM (time_t)));
2077 EMACS_TIME interval
= make_emacs_time (period
, 0);
2080 cancel_atimer (poll_timer
);
2082 poll_timer
= start_atimer (ATIMER_CONTINUOUS
, interval
,
2083 poll_for_input
, NULL
);
2086 /* Let the timer's callback function poll for input
2087 if this becomes zero. */
2088 --poll_suppress_count
;
2093 /* Nonzero if we are using polling to handle input asynchronously. */
2096 input_polling_used (void)
2098 #ifdef POLL_FOR_INPUT
2099 /* XXX This condition was (read_socket_hook && !interrupt_input),
2100 but read_socket_hook is not global anymore. Let's pretend that
2102 return !interrupt_input
;
2108 /* Turn off polling. */
2113 #ifdef POLL_FOR_INPUT
2114 /* XXX This condition was (read_socket_hook && !interrupt_input),
2115 but read_socket_hook is not global anymore. Let's pretend that
2117 if (!interrupt_input
)
2118 ++poll_suppress_count
;
2122 /* Set the value of poll_suppress_count to COUNT
2123 and start or stop polling accordingly. */
2126 set_poll_suppress_count (int count
)
2128 #ifdef POLL_FOR_INPUT
2129 if (count
== 0 && poll_suppress_count
!= 0)
2131 poll_suppress_count
= 1;
2134 else if (count
!= 0 && poll_suppress_count
== 0)
2138 poll_suppress_count
= count
;
2142 /* Bind polling_period to a value at least N.
2143 But don't decrease it. */
2146 bind_polling_period (int n
)
2148 #ifdef POLL_FOR_INPUT
2149 EMACS_INT
new = polling_period
;
2154 stop_other_atimers (poll_timer
);
2156 specbind (Qpolling_period
, make_number (new));
2157 /* Start a new alarm with the new period. */
2162 /* Apply the control modifier to CHARACTER. */
2165 make_ctrl_char (int c
)
2167 /* Save the upper bits here. */
2168 int upper
= c
& ~0177;
2170 if (! ASCII_BYTE_P (c
))
2171 return c
|= ctrl_modifier
;
2175 /* Everything in the columns containing the upper-case letters
2176 denotes a control character. */
2177 if (c
>= 0100 && c
< 0140)
2181 /* Set the shift modifier for a control char
2182 made from a shifted letter. But only for letters! */
2183 if (oc
>= 'A' && oc
<= 'Z')
2184 c
|= shift_modifier
;
2187 /* The lower-case letters denote control characters too. */
2188 else if (c
>= 'a' && c
<= 'z')
2191 /* Include the bits for control and shift
2192 only if the basic ASCII code can't indicate them. */
2196 /* Replace the high bits. */
2197 c
|= (upper
& ~ctrl_modifier
);
2202 /* Display the help-echo property of the character after the mouse pointer.
2203 Either show it in the echo area, or call show-help-function to display
2204 it by other means (maybe in a tooltip).
2206 If HELP is nil, that means clear the previous help echo.
2208 If HELP is a string, display that string. If HELP is a function,
2209 call it with OBJECT and POS as arguments; the function should
2210 return a help string or nil for none. For all other types of HELP,
2211 evaluate it to obtain a string.
2213 WINDOW is the window in which the help was generated, if any.
2214 It is nil if not in a window.
2216 If OBJECT is a buffer, POS is the position in the buffer where the
2217 `help-echo' text property was found.
2219 If OBJECT is an overlay, that overlay has a `help-echo' property,
2220 and POS is the position in the overlay's buffer under the mouse.
2222 If OBJECT is a string (an overlay string or a string displayed with
2223 the `display' property). POS is the position in that string under
2226 Note: this function may only be called with HELP nil or a string
2227 from X code running asynchronously. */
2230 show_help_echo (Lisp_Object help
, Lisp_Object window
, Lisp_Object object
,
2233 if (!NILP (help
) && !STRINGP (help
))
2235 if (FUNCTIONP (help
))
2236 help
= safe_call (4, help
, window
, object
, pos
);
2238 help
= safe_eval (help
);
2240 if (!STRINGP (help
))
2244 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
2245 if (!noninteractive
&& STRINGP (help
))
2247 /* The mouse-fixup-help-message Lisp function can call
2248 mouse_position_hook, which resets the mouse_moved flags.
2249 This causes trouble if we are trying to read a mouse motion
2250 event (i.e., if we are inside a `track-mouse' form), so we
2251 restore the mouse_moved flag. */
2252 FRAME_PTR f
= NILP (do_mouse_tracking
) ? NULL
: some_mouse_moved ();
2253 help
= call1 (Qmouse_fixup_help_message
, help
);
2259 if (STRINGP (help
) || NILP (help
))
2261 if (!NILP (Vshow_help_function
))
2262 call1 (Vshow_help_function
, help
);
2263 help_echo_showing_p
= STRINGP (help
);
2269 /* Input of single characters from keyboard */
2271 static Lisp_Object
kbd_buffer_get_event (KBOARD
**kbp
, int *used_mouse_menu
,
2272 EMACS_TIME
*end_time
);
2273 static void record_char (Lisp_Object c
);
2275 static Lisp_Object help_form_saved_window_configs
;
2277 read_char_help_form_unwind (Lisp_Object arg
)
2279 Lisp_Object window_config
= XCAR (help_form_saved_window_configs
);
2280 help_form_saved_window_configs
= XCDR (help_form_saved_window_configs
);
2281 if (!NILP (window_config
))
2282 Fset_window_configuration (window_config
);
2286 #define STOP_POLLING \
2287 do { if (! polling_stopped_here) stop_polling (); \
2288 polling_stopped_here = 1; } while (0)
2290 #define RESUME_POLLING \
2291 do { if (polling_stopped_here) start_polling (); \
2292 polling_stopped_here = 0; } while (0)
2294 /* read a character from the keyboard; call the redisplay if needed */
2295 /* commandflag 0 means do not autosave, but do redisplay.
2296 -1 means do not redisplay, but do autosave.
2299 /* The arguments MAPS and NMAPS are for menu prompting.
2300 MAPS is an array of keymaps; NMAPS is the length of MAPS.
2302 PREV_EVENT is the previous input event, or nil if we are reading
2303 the first event of a key sequence (or not reading a key sequence).
2304 If PREV_EVENT is t, that is a "magic" value that says
2305 not to run input methods, but in other respects to act as if
2306 not reading a key sequence.
2308 If USED_MOUSE_MENU is non-null, then we set *USED_MOUSE_MENU to 1
2309 if we used a mouse menu to read the input, or zero otherwise. If
2310 USED_MOUSE_MENU is null, we don't dereference it.
2312 Value is -2 when we find input on another keyboard. A second call
2313 to read_char will read it.
2315 If END_TIME is non-null, it is a pointer to an EMACS_TIME
2316 specifying the maximum time to wait until. If no input arrives by
2317 that time, stop waiting and return nil.
2319 Value is t if we showed a menu and the user rejected it. */
2322 read_char (int commandflag
, ptrdiff_t nmaps
, Lisp_Object
*maps
,
2323 Lisp_Object prev_event
,
2324 int *used_mouse_menu
, EMACS_TIME
*end_time
)
2326 volatile Lisp_Object c
;
2328 jmp_buf local_getcjmp
;
2330 volatile int key_already_recorded
= 0;
2331 Lisp_Object tem
, save
;
2332 volatile Lisp_Object previous_echo_area_message
;
2333 volatile Lisp_Object also_record
;
2334 volatile int reread
;
2335 struct gcpro gcpro1
, gcpro2
;
2336 int volatile polling_stopped_here
= 0;
2337 struct kboard
*orig_kboard
= current_kboard
;
2341 #if 0 /* This was commented out as part of fixing echo for C-u left. */
2342 before_command_key_count
= this_command_key_count
;
2343 before_command_echo_length
= echo_length ();
2346 previous_echo_area_message
= Qnil
;
2348 GCPRO2 (c
, previous_echo_area_message
);
2353 if (CONSP (Vunread_post_input_method_events
))
2355 c
= XCAR (Vunread_post_input_method_events
);
2356 Vunread_post_input_method_events
2357 = XCDR (Vunread_post_input_method_events
);
2359 /* Undo what read_char_x_menu_prompt did when it unread
2360 additional keys returned by Fx_popup_menu. */
2362 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2370 if (unread_command_char
!= -1)
2372 XSETINT (c
, unread_command_char
);
2373 unread_command_char
= -1;
2379 if (CONSP (Vunread_command_events
))
2381 int was_disabled
= 0;
2383 c
= XCAR (Vunread_command_events
);
2384 Vunread_command_events
= XCDR (Vunread_command_events
);
2388 /* Undo what sit-for did when it unread additional keys
2389 inside universal-argument. */
2392 && EQ (XCAR (c
), Qt
))
2398 /* Undo what read_char_x_menu_prompt did when it unread
2399 additional keys returned by Fx_popup_menu. */
2401 && EQ (XCDR (c
), Qdisabled
)
2402 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
))))
2408 /* If the queued event is something that used the mouse,
2409 set used_mouse_menu accordingly. */
2411 /* Also check was_disabled so last-nonmenu-event won't return
2412 a bad value when submenus are involved. (Bug#447) */
2413 && (EQ (c
, Qtool_bar
) || EQ (c
, Qmenu_bar
) || was_disabled
))
2414 *used_mouse_menu
= 1;
2416 goto reread_for_input_method
;
2419 if (CONSP (Vunread_input_method_events
))
2421 c
= XCAR (Vunread_input_method_events
);
2422 Vunread_input_method_events
= XCDR (Vunread_input_method_events
);
2424 /* Undo what read_char_x_menu_prompt did when it unread
2425 additional keys returned by Fx_popup_menu. */
2427 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2431 goto reread_for_input_method
;
2434 this_command_key_count_reset
= 0;
2436 if (!NILP (Vexecuting_kbd_macro
))
2438 /* We set this to Qmacro; since that's not a frame, nobody will
2439 try to switch frames on us, and the selected window will
2442 Since this event came from a macro, it would be misleading to
2443 leave internal_last_event_frame set to wherever the last
2444 real event came from. Normally, a switch-frame event selects
2445 internal_last_event_frame after each command is read, but
2446 events read from a macro should never cause a new frame to be
2448 Vlast_event_frame
= internal_last_event_frame
= Qmacro
;
2450 /* Exit the macro if we are at the end.
2451 Also, some things replace the macro with t
2452 to force an early exit. */
2453 if (EQ (Vexecuting_kbd_macro
, Qt
)
2454 || executing_kbd_macro_index
>= XFASTINT (Flength (Vexecuting_kbd_macro
)))
2460 c
= Faref (Vexecuting_kbd_macro
, make_number (executing_kbd_macro_index
));
2461 if (STRINGP (Vexecuting_kbd_macro
)
2462 && (XFASTINT (c
) & 0x80) && (XFASTINT (c
) <= 0xff))
2463 XSETFASTINT (c
, CHAR_META
| (XFASTINT (c
) & ~0x80));
2465 executing_kbd_macro_index
++;
2470 if (!NILP (unread_switch_frame
))
2472 c
= unread_switch_frame
;
2473 unread_switch_frame
= Qnil
;
2475 /* This event should make it into this_command_keys, and get echoed
2476 again, so we do not set `reread'. */
2480 /* if redisplay was requested */
2481 if (commandflag
>= 0)
2483 int echo_current
= EQ (echo_message_buffer
, echo_area_buffer
[0]);
2485 /* If there is pending input, process any events which are not
2486 user-visible, such as X selection_request events. */
2488 || detect_input_pending_run_timers (0))
2489 swallow_events (0); /* may clear input_pending */
2491 /* Redisplay if no pending input. */
2492 while (!input_pending
)
2494 if (help_echo_showing_p
&& !EQ (selected_window
, minibuf_window
))
2495 redisplay_preserve_echo_area (5);
2500 /* Normal case: no input arrived during redisplay. */
2503 /* Input arrived and pre-empted redisplay.
2504 Process any events which are not user-visible. */
2506 /* If that cleared input_pending, try again to redisplay. */
2509 /* Prevent the redisplay we just did
2510 from messing up echoing of the input after the prompt. */
2511 if (commandflag
== 0 && echo_current
)
2512 echo_message_buffer
= echo_area_buffer
[0];
2516 /* Message turns off echoing unless more keystrokes turn it on again.
2518 The code in 20.x for the condition was
2520 1. echo_area_glyphs && *echo_area_glyphs
2521 2. && echo_area_glyphs != current_kboard->echobuf
2522 3. && ok_to_echo_at_next_pause != echo_area_glyphs
2524 (1) means there's a current message displayed
2526 (2) means it's not the message from echoing from the current
2529 (3) There's only one place in 20.x where ok_to_echo_at_next_pause
2530 is set to a non-null value. This is done in read_char and it is
2531 set to echo_area_glyphs after a call to echo_char. That means
2532 ok_to_echo_at_next_pause is either null or
2533 current_kboard->echobuf with the appropriate current_kboard at
2536 So, condition (3) means in clear text ok_to_echo_at_next_pause
2537 must be either null, or the current message isn't from echoing at
2538 all, or it's from echoing from a different kboard than the
2541 if (/* There currently is something in the echo area. */
2542 !NILP (echo_area_buffer
[0])
2543 && (/* And it's either not from echoing. */
2544 !EQ (echo_area_buffer
[0], echo_message_buffer
)
2545 /* Or it's an echo from a different kboard. */
2546 || echo_kboard
!= current_kboard
2547 /* Or we explicitly allow overwriting whatever there is. */
2548 || ok_to_echo_at_next_pause
== NULL
))
2553 /* Try reading a character via menu prompting in the minibuf.
2554 Try this before the sit-for, because the sit-for
2555 would do the wrong thing if we are supposed to do
2556 menu prompting. If EVENT_HAS_PARAMETERS then we are reading
2557 after a mouse event so don't try a minibuf menu. */
2559 if (nmaps
> 0 && INTERACTIVE
2560 && !NILP (prev_event
) && ! EVENT_HAS_PARAMETERS (prev_event
)
2561 /* Don't bring up a menu if we already have another event. */
2562 && NILP (Vunread_command_events
)
2563 && unread_command_char
< 0
2564 && !detect_input_pending_run_timers (0))
2566 c
= read_char_minibuf_menu_prompt (commandflag
, nmaps
, maps
);
2568 if (INTEGERP (c
) && XINT (c
) == -2)
2569 return c
; /* wrong_kboard_jmpbuf */
2573 key_already_recorded
= 1;
2578 /* Make a longjmp point for quits to use, but don't alter getcjmp just yet.
2579 We will do that below, temporarily for short sections of code,
2580 when appropriate. local_getcjmp must be in effect
2581 around any call to sit_for or kbd_buffer_get_event;
2582 it *must not* be in effect when we call redisplay. */
2584 jmpcount
= SPECPDL_INDEX ();
2585 if (_setjmp (local_getcjmp
))
2587 /* Handle quits while reading the keyboard. */
2588 /* We must have saved the outer value of getcjmp here,
2589 so restore it now. */
2590 restore_getcjmp (save_jump
);
2591 unbind_to (jmpcount
, Qnil
);
2592 XSETINT (c
, quit_char
);
2593 internal_last_event_frame
= selected_frame
;
2594 Vlast_event_frame
= internal_last_event_frame
;
2595 /* If we report the quit char as an event,
2596 don't do so more than once. */
2597 if (!NILP (Vinhibit_quit
))
2601 KBOARD
*kb
= FRAME_KBOARD (XFRAME (selected_frame
));
2602 if (kb
!= current_kboard
)
2604 Lisp_Object last
= KVAR (kb
, kbd_queue
);
2605 /* We shouldn't get here if we were in single-kboard mode! */
2610 while (CONSP (XCDR (last
)))
2612 if (!NILP (XCDR (last
)))
2616 kset_kbd_queue (kb
, Fcons (c
, Qnil
));
2618 XSETCDR (last
, Fcons (c
, Qnil
));
2619 kb
->kbd_queue_has_data
= 1;
2620 current_kboard
= kb
;
2621 /* This is going to exit from read_char
2622 so we had better get rid of this frame's stuff. */
2624 return make_number (-2); /* wrong_kboard_jmpbuf */
2630 /* Start idle timers if no time limit is supplied. We don't do it
2631 if a time limit is supplied to avoid an infinite recursion in the
2632 situation where an idle timer calls `sit-for'. */
2635 timer_start_idle ();
2637 /* If in middle of key sequence and minibuffer not active,
2638 start echoing if enough time elapses. */
2640 if (minibuf_level
== 0
2642 && !current_kboard
->immediate_echo
2643 && this_command_key_count
> 0
2645 && (FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
2646 && NILP (Fzerop (Vecho_keystrokes
))
2647 && (/* No message. */
2648 NILP (echo_area_buffer
[0])
2649 /* Or empty message. */
2650 || (BUF_BEG (XBUFFER (echo_area_buffer
[0]))
2651 == BUF_Z (XBUFFER (echo_area_buffer
[0])))
2652 /* Or already echoing from same kboard. */
2653 || (echo_kboard
&& ok_to_echo_at_next_pause
== echo_kboard
)
2654 /* Or not echoing before and echoing allowed. */
2655 || (!echo_kboard
&& ok_to_echo_at_next_pause
)))
2657 /* After a mouse event, start echoing right away.
2658 This is because we are probably about to display a menu,
2659 and we don't want to delay before doing so. */
2660 if (EVENT_HAS_PARAMETERS (prev_event
))
2666 save_getcjmp (save_jump
);
2667 restore_getcjmp (local_getcjmp
);
2668 tem0
= sit_for (Vecho_keystrokes
, 1, 1);
2669 restore_getcjmp (save_jump
);
2671 && ! CONSP (Vunread_command_events
))
2676 /* Maybe auto save due to number of keystrokes. */
2678 if (commandflag
!= 0
2679 && auto_save_interval
> 0
2680 && num_nonmacro_input_events
- last_auto_save
> max (auto_save_interval
, 20)
2681 && !detect_input_pending_run_timers (0))
2683 Fdo_auto_save (Qnil
, Qnil
);
2684 /* Hooks can actually change some buffers in auto save. */
2688 /* Try reading using an X menu.
2689 This is never confused with reading using the minibuf
2690 because the recursive call of read_char in read_char_minibuf_menu_prompt
2691 does not pass on any keymaps. */
2693 if (nmaps
> 0 && INTERACTIVE
2694 && !NILP (prev_event
)
2695 && EVENT_HAS_PARAMETERS (prev_event
)
2696 && !EQ (XCAR (prev_event
), Qmenu_bar
)
2697 && !EQ (XCAR (prev_event
), Qtool_bar
)
2698 /* Don't bring up a menu if we already have another event. */
2699 && NILP (Vunread_command_events
)
2700 && unread_command_char
< 0)
2702 c
= read_char_x_menu_prompt (nmaps
, maps
, prev_event
, used_mouse_menu
);
2704 /* Now that we have read an event, Emacs is not idle. */
2711 /* Maybe autosave and/or garbage collect due to idleness. */
2713 if (INTERACTIVE
&& NILP (c
))
2716 ptrdiff_t buffer_size
;
2718 /* Slow down auto saves logarithmically in size of current buffer,
2719 and garbage collect while we're at it. */
2720 if (! MINI_WINDOW_P (XWINDOW (selected_window
)))
2721 last_non_minibuf_size
= Z
- BEG
;
2722 buffer_size
= (last_non_minibuf_size
>> 8) + 1;
2724 while (buffer_size
> 64)
2725 delay_level
++, buffer_size
-= buffer_size
>> 2;
2726 if (delay_level
< 4) delay_level
= 4;
2727 /* delay_level is 4 for files under around 50k, 7 at 100k,
2728 9 at 200k, 11 at 300k, and 12 at 500k. It is 15 at 1 meg. */
2730 /* Auto save if enough time goes by without input. */
2731 if (commandflag
!= 0
2732 && num_nonmacro_input_events
> last_auto_save
2733 && INTEGERP (Vauto_save_timeout
)
2734 && XINT (Vauto_save_timeout
) > 0)
2737 EMACS_INT timeout
= (delay_level
2738 * min (XFASTINT (Vauto_save_timeout
) / 4,
2739 MOST_POSITIVE_FIXNUM
/ delay_level
));
2740 save_getcjmp (save_jump
);
2741 restore_getcjmp (local_getcjmp
);
2742 tem0
= sit_for (make_number (timeout
), 1, 1);
2743 restore_getcjmp (save_jump
);
2746 && ! CONSP (Vunread_command_events
))
2748 Fdo_auto_save (Qnil
, Qnil
);
2753 /* If there is still no input available, ask for GC. */
2754 if (!detect_input_pending_run_timers (0))
2758 /* Notify the caller if an autosave hook, or a timer, sentinel or
2759 filter in the sit_for calls above have changed the current
2760 kboard. This could happen if they use the minibuffer or start a
2761 recursive edit, like the fancy splash screen in server.el's
2762 filter. If this longjmp wasn't here, read_key_sequence would
2763 interpret the next key sequence using the wrong translation
2764 tables and function keymaps. */
2765 if (NILP (c
) && current_kboard
!= orig_kboard
)
2768 return make_number (-2); /* wrong_kboard_jmpbuf */
2771 /* If this has become non-nil here, it has been set by a timer
2772 or sentinel or filter. */
2773 if (CONSP (Vunread_command_events
))
2775 c
= XCAR (Vunread_command_events
);
2776 Vunread_command_events
= XCDR (Vunread_command_events
);
2779 /* Read something from current KBOARD's side queue, if possible. */
2783 if (current_kboard
->kbd_queue_has_data
)
2785 if (!CONSP (KVAR (current_kboard
, kbd_queue
)))
2787 c
= XCAR (KVAR (current_kboard
, kbd_queue
));
2788 kset_kbd_queue (current_kboard
,
2789 XCDR (KVAR (current_kboard
, kbd_queue
)));
2790 if (NILP (KVAR (current_kboard
, kbd_queue
)))
2791 current_kboard
->kbd_queue_has_data
= 0;
2792 input_pending
= readable_events (0);
2793 if (EVENT_HAS_PARAMETERS (c
)
2794 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qswitch_frame
))
2795 internal_last_event_frame
= XCAR (XCDR (c
));
2796 Vlast_event_frame
= internal_last_event_frame
;
2800 /* If current_kboard's side queue is empty check the other kboards.
2801 If one of them has data that we have not yet seen here,
2802 switch to it and process the data waiting for it.
2804 Note: if the events queued up for another kboard
2805 have already been seen here, and therefore are not a complete command,
2806 the kbd_queue_has_data field is 0, so we skip that kboard here.
2807 That's to avoid an infinite loop switching between kboards here. */
2808 if (NILP (c
) && !single_kboard
)
2811 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
2812 if (kb
->kbd_queue_has_data
)
2814 current_kboard
= kb
;
2815 /* This is going to exit from read_char
2816 so we had better get rid of this frame's stuff. */
2818 return make_number (-2); /* wrong_kboard_jmpbuf */
2826 /* Finally, we read from the main queue,
2827 and if that gives us something we can't use yet, we put it on the
2828 appropriate side queue and try again. */
2832 KBOARD
*kb
IF_LINT (= NULL
);
2834 if (end_time
&& EMACS_TIME_LE (*end_time
, current_emacs_time ()))
2837 /* Actually read a character, waiting if necessary. */
2838 save_getcjmp (save_jump
);
2839 restore_getcjmp (local_getcjmp
);
2841 timer_start_idle ();
2842 c
= kbd_buffer_get_event (&kb
, used_mouse_menu
, end_time
);
2843 restore_getcjmp (save_jump
);
2845 if (! NILP (c
) && (kb
!= current_kboard
))
2847 Lisp_Object last
= KVAR (kb
, kbd_queue
);
2850 while (CONSP (XCDR (last
)))
2852 if (!NILP (XCDR (last
)))
2856 kset_kbd_queue (kb
, Fcons (c
, Qnil
));
2858 XSETCDR (last
, Fcons (c
, Qnil
));
2859 kb
->kbd_queue_has_data
= 1;
2863 current_kboard
= kb
;
2864 /* This is going to exit from read_char
2865 so we had better get rid of this frame's stuff. */
2867 return make_number (-2);
2871 /* Terminate Emacs in batch mode if at eof. */
2872 if (noninteractive
&& INTEGERP (c
) && XINT (c
) < 0)
2873 Fkill_emacs (make_number (1));
2877 /* Add in any extra modifiers, where appropriate. */
2878 if ((extra_keyboard_modifiers
& CHAR_CTL
)
2879 || ((extra_keyboard_modifiers
& 0177) < ' '
2880 && (extra_keyboard_modifiers
& 0177) != 0))
2881 XSETINT (c
, make_ctrl_char (XINT (c
)));
2883 /* Transfer any other modifier bits directly from
2884 extra_keyboard_modifiers to c. Ignore the actual character code
2885 in the low 16 bits of extra_keyboard_modifiers. */
2886 XSETINT (c
, XINT (c
) | (extra_keyboard_modifiers
& ~0xff7f & ~CHAR_CTL
));
2897 if (commandflag
>= 0
2898 && !input_pending
&& !detect_input_pending_run_timers (0))
2906 /* Buffer switch events are only for internal wakeups
2907 so don't show them to the user.
2908 Also, don't record a key if we already did. */
2909 if (BUFFERP (c
) || key_already_recorded
)
2912 /* Process special events within read_char
2913 and loop around to read another event. */
2916 tem
= access_keymap (get_keymap (Vspecial_event_map
, 0, 1), c
, 0, 0, 1);
2921 struct buffer
*prev_buffer
= current_buffer
;
2922 #if 0 /* This shouldn't be necessary anymore. --lorentey */
2923 int was_locked
= single_kboard
;
2924 ptrdiff_t count
= SPECPDL_INDEX ();
2925 record_single_kboard_state ();
2928 last_input_event
= c
;
2929 Fcommand_execute (tem
, Qnil
, Fvector (1, &last_input_event
), Qt
);
2931 if (CONSP (c
) && EQ (XCAR (c
), Qselect_window
) && !end_time
)
2932 /* We stopped being idle for this event; undo that. This
2933 prevents automatic window selection (under
2934 mouse_autoselect_window from acting as a real input event, for
2935 example banishing the mouse under mouse-avoidance-mode. */
2936 timer_resume_idle ();
2938 #if 0 /* This shouldn't be necessary anymore. --lorentey */
2939 /* Resume allowing input from any kboard, if that was true before. */
2941 any_kboard_state ();
2942 unbind_to (count
, Qnil
);
2945 if (current_buffer
!= prev_buffer
)
2947 /* The command may have changed the keymaps. Pretend there
2948 is input in another keyboard and return. This will
2949 recalculate keymaps. */
2950 c
= make_number (-2);
2957 /* Handle things that only apply to characters. */
2960 /* If kbd_buffer_get_event gave us an EOF, return that. */
2964 if ((STRINGP (KVAR (current_kboard
, Vkeyboard_translate_table
))
2965 && UNSIGNED_CMP (XFASTINT (c
), <,
2966 SCHARS (KVAR (current_kboard
,
2967 Vkeyboard_translate_table
))))
2968 || (VECTORP (KVAR (current_kboard
, Vkeyboard_translate_table
))
2969 && UNSIGNED_CMP (XFASTINT (c
), <,
2970 ASIZE (KVAR (current_kboard
,
2971 Vkeyboard_translate_table
))))
2972 || (CHAR_TABLE_P (KVAR (current_kboard
, Vkeyboard_translate_table
))
2976 d
= Faref (KVAR (current_kboard
, Vkeyboard_translate_table
), c
);
2977 /* nil in keyboard-translate-table means no translation. */
2983 /* If this event is a mouse click in the menu bar,
2984 return just menu-bar for now. Modify the mouse click event
2985 so we won't do this twice, then queue it up. */
2986 if (EVENT_HAS_PARAMETERS (c
)
2988 && CONSP (EVENT_START (c
))
2989 && CONSP (XCDR (EVENT_START (c
))))
2993 posn
= POSN_POSN (EVENT_START (c
));
2994 /* Handle menu-bar events:
2995 insert the dummy prefix event `menu-bar'. */
2996 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
2998 /* Change menu-bar to (menu-bar) as the event "position". */
2999 POSN_SET_POSN (EVENT_START (c
), Fcons (posn
, Qnil
));
3002 Vunread_command_events
= Fcons (c
, Vunread_command_events
);
3007 /* Store these characters into recent_keys, the dribble file if any,
3008 and the keyboard macro being defined, if any. */
3010 if (! NILP (also_record
))
3011 record_char (also_record
);
3013 /* Wipe the echo area.
3014 But first, if we are about to use an input method,
3015 save the echo area contents for it to refer to. */
3017 && ! NILP (Vinput_method_function
)
3018 && ' ' <= XINT (c
) && XINT (c
) < 256 && XINT (c
) != 127)
3020 previous_echo_area_message
= Fcurrent_message ();
3021 Vinput_method_previous_message
= previous_echo_area_message
;
3024 /* Now wipe the echo area, except for help events which do their
3025 own stuff with the echo area. */
3027 || (!(EQ (Qhelp_echo
, XCAR (c
)))
3028 && !(EQ (Qswitch_frame
, XCAR (c
)))
3029 /* Don't wipe echo area for select window events: These might
3030 get delayed via `mouse-autoselect-window' (Bug#11304). */
3031 && !(EQ (Qselect_window
, XCAR (c
)))))
3033 if (!NILP (echo_area_buffer
[0]))
3035 safe_run_hooks (Qecho_area_clear_hook
);
3036 clear_message (1, 0);
3040 reread_for_input_method
:
3042 /* Pass this to the input method, if appropriate. */
3044 && ! NILP (Vinput_method_function
)
3045 /* Don't run the input method within a key sequence,
3046 after the first event of the key sequence. */
3047 && NILP (prev_event
)
3048 && ' ' <= XINT (c
) && XINT (c
) < 256 && XINT (c
) != 127)
3051 ptrdiff_t key_count
;
3052 int key_count_reset
;
3053 struct gcpro gcpro1
;
3054 ptrdiff_t count
= SPECPDL_INDEX ();
3056 /* Save the echo status. */
3057 int saved_immediate_echo
= current_kboard
->immediate_echo
;
3058 struct kboard
*saved_ok_to_echo
= ok_to_echo_at_next_pause
;
3059 Lisp_Object saved_echo_string
= KVAR (current_kboard
, echo_string
);
3060 int saved_echo_after_prompt
= current_kboard
->echo_after_prompt
;
3063 if (before_command_restore_flag
)
3065 this_command_key_count
= before_command_key_count_1
;
3066 if (this_command_key_count
< this_single_command_key_start
)
3067 this_single_command_key_start
= this_command_key_count
;
3068 echo_truncate (before_command_echo_length_1
);
3069 before_command_restore_flag
= 0;
3073 /* Save the this_command_keys status. */
3074 key_count
= this_command_key_count
;
3075 key_count_reset
= this_command_key_count_reset
;
3078 keys
= Fcopy_sequence (this_command_keys
);
3083 /* Clear out this_command_keys. */
3084 this_command_key_count
= 0;
3085 this_command_key_count_reset
= 0;
3087 /* Now wipe the echo area. */
3088 if (!NILP (echo_area_buffer
[0]))
3089 safe_run_hooks (Qecho_area_clear_hook
);
3090 clear_message (1, 0);
3093 /* If we are not reading a key sequence,
3094 never use the echo area. */
3097 specbind (Qinput_method_use_echo_area
, Qt
);
3100 /* Call the input method. */
3101 tem
= call1 (Vinput_method_function
, c
);
3103 tem
= unbind_to (count
, tem
);
3105 /* Restore the saved echoing state
3106 and this_command_keys state. */
3107 this_command_key_count
= key_count
;
3108 this_command_key_count_reset
= key_count_reset
;
3110 this_command_keys
= keys
;
3113 ok_to_echo_at_next_pause
= saved_ok_to_echo
;
3114 kset_echo_string (current_kboard
, saved_echo_string
);
3115 current_kboard
->echo_after_prompt
= saved_echo_after_prompt
;
3116 if (saved_immediate_echo
)
3121 /* The input method can return no events. */
3124 /* Bring back the previous message, if any. */
3125 if (! NILP (previous_echo_area_message
))
3126 message_with_string ("%s", previous_echo_area_message
, 0);
3129 /* It returned one event or more. */
3131 Vunread_post_input_method_events
3132 = nconc2 (XCDR (tem
), Vunread_post_input_method_events
);
3137 /* Display help if not echoing. */
3138 if (CONSP (c
) && EQ (XCAR (c
), Qhelp_echo
))
3140 /* (help-echo FRAME HELP WINDOW OBJECT POS). */
3141 Lisp_Object help
, object
, position
, window
, htem
;
3143 htem
= Fcdr (XCDR (c
));
3146 window
= Fcar (htem
);
3148 object
= Fcar (htem
);
3150 position
= Fcar (htem
);
3152 show_help_echo (help
, window
, object
, position
);
3154 /* We stopped being idle for this event; undo that. */
3156 timer_resume_idle ();
3160 if ((! reread
|| this_command_key_count
== 0
3161 || this_command_key_count_reset
)
3165 /* Don't echo mouse motion events. */
3166 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
3167 && NILP (Fzerop (Vecho_keystrokes
))
3168 && ! (EVENT_HAS_PARAMETERS (c
)
3169 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
3172 if (! NILP (also_record
))
3173 echo_char (also_record
);
3174 /* Once we reread a character, echoing can happen
3175 the next time we pause to read a new one. */
3176 ok_to_echo_at_next_pause
= current_kboard
;
3179 /* Record this character as part of the current key. */
3180 add_command_key (c
);
3181 if (! NILP (also_record
))
3182 add_command_key (also_record
);
3185 last_input_event
= c
;
3188 /* Process the help character specially if enabled */
3189 if (!NILP (Vhelp_form
) && help_char_p (c
))
3191 ptrdiff_t count
= SPECPDL_INDEX ();
3193 help_form_saved_window_configs
3194 = Fcons (Fcurrent_window_configuration (Qnil
),
3195 help_form_saved_window_configs
);
3196 record_unwind_protect (read_char_help_form_unwind
, Qnil
);
3197 call0 (Qhelp_form_show
);
3202 c
= read_char (0, 0, 0, Qnil
, 0, NULL
);
3203 if (EVENT_HAS_PARAMETERS (c
)
3204 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_click
))
3205 XSETCAR (help_form_saved_window_configs
, Qnil
);
3207 while (BUFFERP (c
));
3208 /* Remove the help from the frame */
3209 unbind_to (count
, Qnil
);
3212 if (EQ (c
, make_number (040)))
3216 c
= read_char (0, 0, 0, Qnil
, 0, NULL
);
3217 while (BUFFERP (c
));
3226 /* Record a key that came from a mouse menu.
3227 Record it for echoing, for this-command-keys, and so on. */
3230 record_menu_key (Lisp_Object c
)
3232 /* Wipe the echo area. */
3233 clear_message (1, 0);
3238 before_command_key_count
= this_command_key_count
;
3239 before_command_echo_length
= echo_length ();
3242 /* Don't echo mouse motion events. */
3243 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
3244 && NILP (Fzerop (Vecho_keystrokes
)))
3248 /* Once we reread a character, echoing can happen
3249 the next time we pause to read a new one. */
3250 ok_to_echo_at_next_pause
= 0;
3253 /* Record this character as part of the current key. */
3254 add_command_key (c
);
3256 /* Re-reading in the middle of a command */
3257 last_input_event
= c
;
3261 /* Return 1 if should recognize C as "the help character". */
3264 help_char_p (Lisp_Object c
)
3268 if (EQ (c
, Vhelp_char
))
3270 for (tail
= Vhelp_event_list
; CONSP (tail
); tail
= XCDR (tail
))
3271 if (EQ (c
, XCAR (tail
)))
3276 /* Record the input event C in various ways. */
3279 record_char (Lisp_Object c
)
3283 if (CONSP (c
) && (EQ (XCAR (c
), Qhelp_echo
) || EQ (XCAR (c
), Qmouse_movement
)))
3285 /* To avoid filling recent_keys with help-echo and mouse-movement
3286 events, we filter out repeated help-echo events, only store the
3287 first and last in a series of mouse-movement events, and don't
3288 store repeated help-echo events which are only separated by
3289 mouse-movement events. */
3291 Lisp_Object ev1
, ev2
, ev3
;
3294 if ((ix1
= recent_keys_index
- 1) < 0)
3295 ix1
= NUM_RECENT_KEYS
- 1;
3296 ev1
= AREF (recent_keys
, ix1
);
3298 if ((ix2
= ix1
- 1) < 0)
3299 ix2
= NUM_RECENT_KEYS
- 1;
3300 ev2
= AREF (recent_keys
, ix2
);
3302 if ((ix3
= ix2
- 1) < 0)
3303 ix3
= NUM_RECENT_KEYS
- 1;
3304 ev3
= AREF (recent_keys
, ix3
);
3306 if (EQ (XCAR (c
), Qhelp_echo
))
3308 /* Don't record `help-echo' in recent_keys unless it shows some help
3309 message, and a different help than the previously recorded
3311 Lisp_Object help
, last_help
;
3313 help
= Fcar_safe (Fcdr_safe (XCDR (c
)));
3314 if (!STRINGP (help
))
3316 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qhelp_echo
)
3317 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev1
))), EQ (last_help
, help
)))
3319 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3320 && CONSP (ev2
) && EQ (XCAR (ev2
), Qhelp_echo
)
3321 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev2
))), EQ (last_help
, help
)))
3323 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3324 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3325 && CONSP (ev3
) && EQ (XCAR (ev3
), Qhelp_echo
)
3326 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev3
))), EQ (last_help
, help
)))
3329 else if (EQ (XCAR (c
), Qmouse_movement
))
3331 /* Only record one pair of `mouse-movement' on a window in recent_keys.
3332 So additional mouse movement events replace the last element. */
3333 Lisp_Object last_window
, window
;
3335 window
= Fcar_safe (Fcar_safe (XCDR (c
)));
3336 if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3337 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev1
))), EQ (last_window
, window
))
3338 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3339 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev2
))), EQ (last_window
, window
)))
3341 ASET (recent_keys
, ix1
, c
);
3347 store_kbd_macro_char (c
);
3351 total_keys
+= total_keys
< NUM_RECENT_KEYS
;
3352 ASET (recent_keys
, recent_keys_index
, c
);
3353 if (++recent_keys_index
>= NUM_RECENT_KEYS
)
3354 recent_keys_index
= 0;
3356 else if (recorded
< 0)
3358 /* We need to remove one or two events from recent_keys.
3359 To do this, we simply put nil at those events and move the
3360 recent_keys_index backwards over those events. Usually,
3361 users will never see those nil events, as they will be
3362 overwritten by the command keys entered to see recent_keys
3365 while (recorded
++ < 0 && total_keys
> 0)
3367 if (total_keys
< NUM_RECENT_KEYS
)
3369 if (--recent_keys_index
< 0)
3370 recent_keys_index
= NUM_RECENT_KEYS
- 1;
3371 ASET (recent_keys
, recent_keys_index
, Qnil
);
3375 num_nonmacro_input_events
++;
3377 /* Write c to the dribble file. If c is a lispy event, write
3378 the event's symbol to the dribble file, in <brackets>. Bleaugh.
3379 If you, dear reader, have a better idea, you've got the source. :-) */
3385 if (XUINT (c
) < 0x100)
3386 putc (XUINT (c
), dribble
);
3388 fprintf (dribble
, " 0x%"pI
"x", XUINT (c
));
3392 Lisp_Object dribblee
;
3394 /* If it's a structured event, take the event header. */
3395 dribblee
= EVENT_HEAD (c
);
3397 if (SYMBOLP (dribblee
))
3399 putc ('<', dribble
);
3400 fwrite (SDATA (SYMBOL_NAME (dribblee
)), sizeof (char),
3401 SBYTES (SYMBOL_NAME (dribblee
)),
3403 putc ('>', dribble
);
3412 /* Copy out or in the info on where C-g should throw to.
3413 This is used when running Lisp code from within get_char,
3414 in case get_char is called recursively.
3415 See read_process_output. */
3418 save_getcjmp (jmp_buf temp
)
3420 memcpy (temp
, getcjmp
, sizeof getcjmp
);
3424 restore_getcjmp (jmp_buf temp
)
3426 memcpy (getcjmp
, temp
, sizeof getcjmp
);
3429 /* Low level keyboard/mouse input.
3430 kbd_buffer_store_event places events in kbd_buffer, and
3431 kbd_buffer_get_event retrieves them. */
3433 /* Return true if there are any events in the queue that read-char
3434 would return. If this returns false, a read-char would block. */
3436 readable_events (int flags
)
3438 if (flags
& READABLE_EVENTS_DO_TIMERS_NOW
)
3441 /* If the buffer contains only FOCUS_IN_EVENT events, and
3442 READABLE_EVENTS_FILTER_EVENTS is set, report it as empty. */
3443 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3445 if (flags
& (READABLE_EVENTS_FILTER_EVENTS
3446 #ifdef USE_TOOLKIT_SCROLL_BARS
3447 | READABLE_EVENTS_IGNORE_SQUEEZABLES
3451 struct input_event
*event
;
3453 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
3460 #ifdef USE_TOOLKIT_SCROLL_BARS
3461 (flags
& READABLE_EVENTS_FILTER_EVENTS
) &&
3463 event
->kind
== FOCUS_IN_EVENT
)
3464 #ifdef USE_TOOLKIT_SCROLL_BARS
3465 && !((flags
& READABLE_EVENTS_IGNORE_SQUEEZABLES
)
3466 && event
->kind
== SCROLL_BAR_CLICK_EVENT
3467 && event
->part
== scroll_bar_handle
3468 && event
->modifiers
== 0)
3473 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3476 while (event
!= kbd_store_ptr
);
3482 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
3483 if (!(flags
& READABLE_EVENTS_IGNORE_SQUEEZABLES
)
3484 && !NILP (do_mouse_tracking
) && some_mouse_moved ())
3489 if (current_kboard
->kbd_queue_has_data
)
3495 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
3496 if (kb
->kbd_queue_has_data
)
3502 /* Set this for debugging, to have a way to get out */
3503 int stop_character EXTERNALLY_VISIBLE
;
3506 event_to_kboard (struct input_event
*event
)
3509 frame
= event
->frame_or_window
;
3511 frame
= XCAR (frame
);
3512 else if (WINDOWP (frame
))
3513 frame
= WINDOW_FRAME (XWINDOW (frame
));
3515 /* There are still some events that don't set this field.
3516 For now, just ignore the problem.
3517 Also ignore dead frames here. */
3518 if (!FRAMEP (frame
) || !FRAME_LIVE_P (XFRAME (frame
)))
3521 return FRAME_KBOARD (XFRAME (frame
));
3525 /* Return the number of slots occupied in kbd_buffer. */
3528 kbd_buffer_nr_stored (void)
3530 return kbd_fetch_ptr
== kbd_store_ptr
3532 : (kbd_fetch_ptr
< kbd_store_ptr
3533 ? kbd_store_ptr
- kbd_fetch_ptr
3534 : ((kbd_buffer
+ KBD_BUFFER_SIZE
) - kbd_fetch_ptr
3535 + (kbd_store_ptr
- kbd_buffer
)));
3537 #endif /* Store an event obtained at interrupt level into kbd_buffer, fifo */
3540 kbd_buffer_store_event (register struct input_event
*event
)
3542 kbd_buffer_store_event_hold (event
, 0);
3545 /* Store EVENT obtained at interrupt level into kbd_buffer, fifo.
3547 If HOLD_QUIT is 0, just stuff EVENT into the fifo.
3548 Else, if HOLD_QUIT.kind != NO_EVENT, discard EVENT.
3549 Else, if EVENT is a quit event, store the quit event
3550 in HOLD_QUIT, and return (thus ignoring further events).
3552 This is used in read_avail_input to postpone the processing
3553 of the quit event until all subsequent input events have been
3554 parsed (and discarded).
3558 kbd_buffer_store_event_hold (register struct input_event
*event
,
3559 struct input_event
*hold_quit
)
3561 if (event
->kind
== NO_EVENT
)
3564 if (hold_quit
&& hold_quit
->kind
!= NO_EVENT
)
3567 if (event
->kind
== ASCII_KEYSTROKE_EVENT
)
3569 register int c
= event
->code
& 0377;
3571 if (event
->modifiers
& ctrl_modifier
)
3572 c
= make_ctrl_char (c
);
3574 c
|= (event
->modifiers
3575 & (meta_modifier
| alt_modifier
3576 | hyper_modifier
| super_modifier
));
3580 KBOARD
*kb
= FRAME_KBOARD (XFRAME (event
->frame_or_window
));
3581 struct input_event
*sp
;
3583 if (single_kboard
&& kb
!= current_kboard
)
3586 (kb
, Fcons (make_lispy_switch_frame (event
->frame_or_window
),
3587 Fcons (make_number (c
), Qnil
)));
3588 kb
->kbd_queue_has_data
= 1;
3589 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3591 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3594 if (event_to_kboard (sp
) == kb
)
3596 sp
->kind
= NO_EVENT
;
3597 sp
->frame_or_window
= Qnil
;
3606 memcpy (hold_quit
, event
, sizeof (*event
));
3610 /* If this results in a quit_char being returned to Emacs as
3611 input, set Vlast_event_frame properly. If this doesn't
3612 get returned to Emacs as an event, the next event read
3613 will set Vlast_event_frame again, so this is safe to do. */
3617 focus
= FRAME_FOCUS_FRAME (XFRAME (event
->frame_or_window
));
3619 focus
= event
->frame_or_window
;
3620 internal_last_event_frame
= focus
;
3621 Vlast_event_frame
= focus
;
3624 last_event_timestamp
= event
->timestamp
;
3625 handle_interrupt ();
3629 if (c
&& c
== stop_character
)
3635 /* Don't insert two BUFFER_SWITCH_EVENT's in a row.
3636 Just ignore the second one. */
3637 else if (event
->kind
== BUFFER_SWITCH_EVENT
3638 && kbd_fetch_ptr
!= kbd_store_ptr
3639 && ((kbd_store_ptr
== kbd_buffer
3640 ? kbd_buffer
+ KBD_BUFFER_SIZE
- 1
3641 : kbd_store_ptr
- 1)->kind
) == BUFFER_SWITCH_EVENT
)
3644 if (kbd_store_ptr
- kbd_buffer
== KBD_BUFFER_SIZE
)
3645 kbd_store_ptr
= kbd_buffer
;
3647 /* Don't let the very last slot in the buffer become full,
3648 since that would make the two pointers equal,
3649 and that is indistinguishable from an empty buffer.
3650 Discard the event if it would fill the last slot. */
3651 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
3653 *kbd_store_ptr
= *event
;
3656 if (kbd_buffer_nr_stored () > KBD_BUFFER_SIZE
/2 && ! kbd_on_hold_p ())
3658 /* Don't read keyboard input until we have processed kbd_buffer.
3659 This happens when pasting text longer than KBD_BUFFER_SIZE/2. */
3660 hold_keyboard_input ();
3662 if (!noninteractive
)
3663 signal (SIGIO
, SIG_IGN
);
3667 #endif /* subprocesses */
3670 /* If we're inside while-no-input, and this event qualifies
3671 as input, set quit-flag to cause an interrupt. */
3672 if (!NILP (Vthrow_on_input
)
3673 && event
->kind
!= FOCUS_IN_EVENT
3674 && event
->kind
!= HELP_EVENT
3675 && event
->kind
!= DEICONIFY_EVENT
)
3677 Vquit_flag
= Vthrow_on_input
;
3678 /* If we're inside a function that wants immediate quits,
3680 if (immediate_quit
&& NILP (Vinhibit_quit
))
3690 /* Put an input event back in the head of the event queue. */
3693 kbd_buffer_unget_event (register struct input_event
*event
)
3695 if (kbd_fetch_ptr
== kbd_buffer
)
3696 kbd_fetch_ptr
= kbd_buffer
+ KBD_BUFFER_SIZE
;
3698 /* Don't let the very last slot in the buffer become full, */
3699 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
3702 *kbd_fetch_ptr
= *event
;
3707 /* Generate a HELP_EVENT input_event and store it in the keyboard
3710 HELP is the help form.
3712 FRAME and WINDOW are the frame and window where the help is
3713 generated. OBJECT is the Lisp object where the help was found (a
3714 buffer, a string, an overlay, or nil if neither from a string nor
3715 from a buffer). POS is the position within OBJECT where the help
3719 gen_help_event (Lisp_Object help
, Lisp_Object frame
, Lisp_Object window
,
3720 Lisp_Object object
, ptrdiff_t pos
)
3722 struct input_event event
;
3726 event
.kind
= HELP_EVENT
;
3727 event
.frame_or_window
= frame
;
3729 event
.x
= WINDOWP (window
) ? window
: frame
;
3732 kbd_buffer_store_event (&event
);
3736 /* Store HELP_EVENTs for HELP on FRAME in the input queue. */
3739 kbd_buffer_store_help_event (Lisp_Object frame
, Lisp_Object help
)
3741 struct input_event event
;
3743 event
.kind
= HELP_EVENT
;
3744 event
.frame_or_window
= frame
;
3749 kbd_buffer_store_event (&event
);
3753 /* Discard any mouse events in the event buffer by setting them to
3756 discard_mouse_events (void)
3758 struct input_event
*sp
;
3759 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3761 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3764 if (sp
->kind
== MOUSE_CLICK_EVENT
3765 || sp
->kind
== WHEEL_EVENT
3766 || sp
->kind
== HORIZ_WHEEL_EVENT
3768 || sp
->kind
== GPM_CLICK_EVENT
3770 || sp
->kind
== SCROLL_BAR_CLICK_EVENT
)
3772 sp
->kind
= NO_EVENT
;
3778 /* Return non-zero if there are any real events waiting in the event
3779 buffer, not counting `NO_EVENT's.
3781 If DISCARD is non-zero, discard NO_EVENT events at the front of
3782 the input queue, possibly leaving the input queue empty if there
3783 are no real input events. */
3786 kbd_buffer_events_waiting (int discard
)
3788 struct input_event
*sp
;
3790 for (sp
= kbd_fetch_ptr
;
3791 sp
!= kbd_store_ptr
&& sp
->kind
== NO_EVENT
;
3794 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3801 return sp
!= kbd_store_ptr
&& sp
->kind
!= NO_EVENT
;
3805 /* Clear input event EVENT. */
3808 clear_event (struct input_event
*event
)
3810 event
->kind
= NO_EVENT
;
3814 /* Read one event from the event buffer, waiting if necessary.
3815 The value is a Lisp object representing the event.
3816 The value is nil for an event that should be ignored,
3817 or that was handled here.
3818 We always read and discard one event. */
3821 kbd_buffer_get_event (KBOARD
**kbp
,
3822 int *used_mouse_menu
,
3823 EMACS_TIME
*end_time
)
3828 if (kbd_on_hold_p () && kbd_buffer_nr_stored () < KBD_BUFFER_SIZE
/4)
3830 /* Start reading input again, we have processed enough so we can
3831 accept new events again. */
3832 unhold_keyboard_input ();
3834 if (!noninteractive
)
3835 signal (SIGIO
, deliver_input_available_signal
);
3839 #endif /* subprocesses */
3841 #ifndef HAVE_DBUS /* We want to read D-Bus events in batch mode. */
3843 /* In case we are running as a daemon, only do this before
3844 detaching from the terminal. */
3845 || (IS_DAEMON
&& daemon_pipe
[1] >= 0))
3849 *kbp
= current_kboard
;
3852 #endif /* ! HAVE_DBUS */
3854 /* Wait until there is input available. */
3857 /* Break loop if there's an unread command event. Needed in
3858 moused window autoselection which uses a timer to insert such
3860 if (CONSP (Vunread_command_events
))
3863 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3865 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
3866 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3870 /* If the quit flag is set, then read_char will return
3871 quit_char, so that counts as "available input." */
3872 if (!NILP (Vquit_flag
))
3873 quit_throw_to_read_char (0);
3875 /* One way or another, wait until input is available; then, if
3876 interrupt handlers have not read it, read it now. */
3878 /* Note SIGIO has been undef'd if FIONREAD is missing. */
3882 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3884 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
3885 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3890 EMACS_TIME now
= current_emacs_time ();
3891 if (EMACS_TIME_LE (*end_time
, now
))
3892 return Qnil
; /* Finished waiting. */
3895 EMACS_TIME duration
= sub_emacs_time (*end_time
, now
);
3896 wait_reading_process_output (min (EMACS_SECS (duration
),
3898 EMACS_NSECS (duration
),
3899 -1, 1, Qnil
, NULL
, 0);
3903 wait_reading_process_output (0, 0, -1, 1, Qnil
, NULL
, 0);
3905 if (!interrupt_input
&& kbd_fetch_ptr
== kbd_store_ptr
)
3906 /* Pass 1 for EXPECT since we just waited to have input. */
3907 read_avail_input (1);
3910 if (CONSP (Vunread_command_events
))
3913 first
= XCAR (Vunread_command_events
);
3914 Vunread_command_events
= XCDR (Vunread_command_events
);
3915 *kbp
= current_kboard
;
3919 /* At this point, we know that there is a readable event available
3920 somewhere. If the event queue is empty, then there must be a
3921 mouse movement enabled and available. */
3922 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3924 struct input_event
*event
;
3926 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
3930 last_event_timestamp
= event
->timestamp
;
3932 *kbp
= event_to_kboard (event
);
3934 *kbp
= current_kboard
; /* Better than returning null ptr? */
3938 /* These two kinds of events get special handling
3939 and don't actually appear to the command loop.
3940 We return nil for them. */
3941 if (event
->kind
== SELECTION_REQUEST_EVENT
3942 || event
->kind
== SELECTION_CLEAR_EVENT
)
3945 struct input_event copy
;
3947 /* Remove it from the buffer before processing it,
3948 since otherwise swallow_events will see it
3949 and process it again. */
3951 kbd_fetch_ptr
= event
+ 1;
3952 input_pending
= readable_events (0);
3953 x_handle_selection_event (©
);
3955 /* We're getting selection request events, but we don't have
3961 #if defined (HAVE_NS)
3962 else if (event
->kind
== NS_TEXT_EVENT
)
3964 if (event
->code
== KEY_NS_PUT_WORKING_TEXT
)
3965 obj
= Fcons (intern ("ns-put-working-text"), Qnil
);
3967 obj
= Fcons (intern ("ns-unput-working-text"), Qnil
);
3968 kbd_fetch_ptr
= event
+ 1;
3969 if (used_mouse_menu
)
3970 *used_mouse_menu
= 1;
3974 #if defined (HAVE_X11) || defined (HAVE_NTGUI) \
3975 || defined (HAVE_NS)
3976 else if (event
->kind
== DELETE_WINDOW_EVENT
)
3978 /* Make an event (delete-frame (FRAME)). */
3979 obj
= Fcons (event
->frame_or_window
, Qnil
);
3980 obj
= Fcons (Qdelete_frame
, Fcons (obj
, Qnil
));
3981 kbd_fetch_ptr
= event
+ 1;
3984 #if defined (HAVE_X11) || defined (HAVE_NTGUI) \
3985 || defined (HAVE_NS)
3986 else if (event
->kind
== ICONIFY_EVENT
)
3988 /* Make an event (iconify-frame (FRAME)). */
3989 obj
= Fcons (event
->frame_or_window
, Qnil
);
3990 obj
= Fcons (Qiconify_frame
, Fcons (obj
, Qnil
));
3991 kbd_fetch_ptr
= event
+ 1;
3993 else if (event
->kind
== DEICONIFY_EVENT
)
3995 /* Make an event (make-frame-visible (FRAME)). */
3996 obj
= Fcons (event
->frame_or_window
, Qnil
);
3997 obj
= Fcons (Qmake_frame_visible
, Fcons (obj
, Qnil
));
3998 kbd_fetch_ptr
= event
+ 1;
4001 else if (event
->kind
== BUFFER_SWITCH_EVENT
)
4003 /* The value doesn't matter here; only the type is tested. */
4004 XSETBUFFER (obj
, current_buffer
);
4005 kbd_fetch_ptr
= event
+ 1;
4007 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
4008 || defined (HAVE_NS) || defined (USE_GTK)
4009 else if (event
->kind
== MENU_BAR_ACTIVATE_EVENT
)
4011 kbd_fetch_ptr
= event
+ 1;
4012 input_pending
= readable_events (0);
4013 if (FRAME_LIVE_P (XFRAME (event
->frame_or_window
)))
4014 x_activate_menubar (XFRAME (event
->frame_or_window
));
4017 #if defined (WINDOWSNT)
4018 else if (event
->kind
== LANGUAGE_CHANGE_EVENT
)
4020 /* Make an event (language-change (FRAME CODEPAGE LANGUAGE-ID)). */
4021 obj
= Fcons (Qlanguage_change
,
4022 list3 (event
->frame_or_window
,
4023 make_number (event
->code
),
4024 make_number (event
->modifiers
)));
4025 kbd_fetch_ptr
= event
+ 1;
4028 else if (event
->kind
== SAVE_SESSION_EVENT
)
4030 obj
= Fcons (Qsave_session
, Fcons (event
->arg
, Qnil
));
4031 kbd_fetch_ptr
= event
+ 1;
4033 /* Just discard these, by returning nil.
4034 With MULTI_KBOARD, these events are used as placeholders
4035 when we need to randomly delete events from the queue.
4036 (They shouldn't otherwise be found in the buffer,
4037 but on some machines it appears they do show up
4038 even without MULTI_KBOARD.) */
4039 /* On Windows NT/9X, NO_EVENT is used to delete extraneous
4040 mouse events during a popup-menu call. */
4041 else if (event
->kind
== NO_EVENT
)
4042 kbd_fetch_ptr
= event
+ 1;
4043 else if (event
->kind
== HELP_EVENT
)
4045 Lisp_Object object
, position
, help
, frame
, window
;
4047 frame
= event
->frame_or_window
;
4048 object
= event
->arg
;
4049 position
= make_number (event
->code
);
4052 clear_event (event
);
4054 kbd_fetch_ptr
= event
+ 1;
4055 if (!WINDOWP (window
))
4057 obj
= Fcons (Qhelp_echo
,
4058 list5 (frame
, help
, window
, object
, position
));
4060 else if (event
->kind
== FOCUS_IN_EVENT
)
4062 /* Notification of a FocusIn event. The frame receiving the
4063 focus is in event->frame_or_window. Generate a
4064 switch-frame event if necessary. */
4065 Lisp_Object frame
, focus
;
4067 frame
= event
->frame_or_window
;
4068 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
4072 if (!EQ (frame
, internal_last_event_frame
)
4073 && !EQ (frame
, selected_frame
))
4074 obj
= make_lispy_switch_frame (frame
);
4075 internal_last_event_frame
= frame
;
4076 kbd_fetch_ptr
= event
+ 1;
4079 else if (event
->kind
== DBUS_EVENT
)
4081 obj
= make_lispy_event (event
);
4082 kbd_fetch_ptr
= event
+ 1;
4085 else if (event
->kind
== CONFIG_CHANGED_EVENT
)
4087 obj
= make_lispy_event (event
);
4088 kbd_fetch_ptr
= event
+ 1;
4092 /* If this event is on a different frame, return a switch-frame this
4093 time, and leave the event in the queue for next time. */
4097 frame
= event
->frame_or_window
;
4099 frame
= XCAR (frame
);
4100 else if (WINDOWP (frame
))
4101 frame
= WINDOW_FRAME (XWINDOW (frame
));
4103 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
4107 if (! EQ (frame
, internal_last_event_frame
)
4108 && !EQ (frame
, selected_frame
))
4109 obj
= make_lispy_switch_frame (frame
);
4110 internal_last_event_frame
= frame
;
4112 /* If we didn't decide to make a switch-frame event, go ahead
4113 and build a real event from the queue entry. */
4117 obj
= make_lispy_event (event
);
4119 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
4120 || defined (HAVE_NS) || defined (USE_GTK)
4121 /* If this was a menu selection, then set the flag to inhibit
4122 writing to last_nonmenu_event. Don't do this if the event
4123 we're returning is (menu-bar), though; that indicates the
4124 beginning of the menu sequence, and we might as well leave
4125 that as the `event with parameters' for this selection. */
4127 && !EQ (event
->frame_or_window
, event
->arg
)
4128 && (event
->kind
== MENU_BAR_EVENT
4129 || event
->kind
== TOOL_BAR_EVENT
))
4130 *used_mouse_menu
= 1;
4133 /* certain system events are non-key events */
4135 && event
->kind
== NS_NONKEY_EVENT
)
4136 *used_mouse_menu
= 1;
4139 /* Wipe out this event, to catch bugs. */
4140 clear_event (event
);
4141 kbd_fetch_ptr
= event
+ 1;
4145 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
4146 /* Try generating a mouse motion event. */
4147 else if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
4149 FRAME_PTR f
= some_mouse_moved ();
4150 Lisp_Object bar_window
;
4151 enum scroll_bar_part part
;
4155 *kbp
= current_kboard
;
4156 /* Note that this uses F to determine which terminal to look at.
4157 If there is no valid info, it does not store anything
4158 so x remains nil. */
4161 /* XXX Can f or mouse_position_hook be NULL here? */
4162 if (f
&& FRAME_TERMINAL (f
)->mouse_position_hook
)
4163 (*FRAME_TERMINAL (f
)->mouse_position_hook
) (&f
, 0, &bar_window
,
4168 /* Decide if we should generate a switch-frame event. Don't
4169 generate switch-frame events for motion outside of all Emacs
4175 frame
= FRAME_FOCUS_FRAME (f
);
4177 XSETFRAME (frame
, f
);
4179 if (! EQ (frame
, internal_last_event_frame
)
4180 && !EQ (frame
, selected_frame
))
4181 obj
= make_lispy_switch_frame (frame
);
4182 internal_last_event_frame
= frame
;
4185 /* If we didn't decide to make a switch-frame event, go ahead and
4186 return a mouse-motion event. */
4187 if (!NILP (x
) && NILP (obj
))
4188 obj
= make_lispy_movement (f
, bar_window
, part
, x
, y
, t
);
4190 #endif /* HAVE_MOUSE || HAVE GPM */
4192 /* We were promised by the above while loop that there was
4193 something for us to read! */
4196 input_pending
= readable_events (0);
4198 Vlast_event_frame
= internal_last_event_frame
;
4203 /* Process any non-user-visible events (currently X selection events),
4204 without reading any user-visible events. */
4207 process_special_events (void)
4209 struct input_event
*event
;
4211 for (event
= kbd_fetch_ptr
; event
!= kbd_store_ptr
; ++event
)
4213 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
4216 if (event
== kbd_store_ptr
)
4220 /* If we find a stored X selection request, handle it now. */
4221 if (event
->kind
== SELECTION_REQUEST_EVENT
4222 || event
->kind
== SELECTION_CLEAR_EVENT
)
4226 /* Remove the event from the fifo buffer before processing;
4227 otherwise swallow_events called recursively could see it
4228 and process it again. To do this, we move the events
4229 between kbd_fetch_ptr and EVENT one slot to the right,
4232 struct input_event copy
= *event
;
4233 struct input_event
*beg
4234 = (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
4235 ? kbd_buffer
: kbd_fetch_ptr
;
4238 memmove (beg
+ 1, beg
, (event
- beg
) * sizeof (struct input_event
));
4239 else if (event
< beg
)
4241 if (event
> kbd_buffer
)
4242 memmove (kbd_buffer
+ 1, kbd_buffer
,
4243 (event
- kbd_buffer
) * sizeof (struct input_event
));
4244 *kbd_buffer
= *(kbd_buffer
+ KBD_BUFFER_SIZE
- 1);
4245 if (beg
< kbd_buffer
+ KBD_BUFFER_SIZE
- 1)
4246 memmove (beg
+ 1, beg
,
4247 (kbd_buffer
+ KBD_BUFFER_SIZE
- 1 - beg
)
4248 * sizeof (struct input_event
));
4251 if (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
4252 kbd_fetch_ptr
= kbd_buffer
+ 1;
4256 /* X wants last_event_timestamp for selection ownership. */
4257 last_event_timestamp
= copy
.timestamp
;
4258 input_pending
= readable_events (0);
4259 x_handle_selection_event (©
);
4261 /* We're getting selection request events, but we don't have
4269 /* Process any events that are not user-visible, run timer events that
4270 are ripe, and return, without reading any user-visible events. */
4273 swallow_events (int do_display
)
4277 process_special_events ();
4279 old_timers_run
= timers_run
;
4280 get_input_pending (&input_pending
, READABLE_EVENTS_DO_TIMERS_NOW
);
4282 if (timers_run
!= old_timers_run
&& do_display
)
4283 redisplay_preserve_echo_area (7);
4286 /* Record the start of when Emacs is idle,
4287 for the sake of running idle-time timers. */
4290 timer_start_idle (void)
4294 /* If we are already in the idle state, do nothing. */
4295 if (EMACS_TIME_VALID_P (timer_idleness_start_time
))
4298 timer_idleness_start_time
= current_emacs_time ();
4299 timer_last_idleness_start_time
= timer_idleness_start_time
;
4301 /* Mark all idle-time timers as once again candidates for running. */
4302 for (timers
= Vtimer_idle_list
; CONSP (timers
); timers
= XCDR (timers
))
4306 timer
= XCAR (timers
);
4308 if (!VECTORP (timer
) || ASIZE (timer
) != 9)
4310 ASET (timer
, 0, Qnil
);
4314 /* Record that Emacs is no longer idle, so stop running idle-time timers. */
4317 timer_stop_idle (void)
4319 timer_idleness_start_time
= invalid_emacs_time ();
4322 /* Resume idle timer from last idle start time. */
4325 timer_resume_idle (void)
4327 if (EMACS_TIME_VALID_P (timer_idleness_start_time
))
4330 timer_idleness_start_time
= timer_last_idleness_start_time
;
4333 /* This is only for debugging. */
4334 struct input_event last_timer_event EXTERNALLY_VISIBLE
;
4336 /* List of elisp functions to call, delayed because they were generated in
4337 a context where Elisp could not be safely run (e.g. redisplay, signal,
4338 ...). Each element has the form (FUN . ARGS). */
4339 Lisp_Object pending_funcalls
;
4341 /* Return true if TIMER is a valid timer, placing its value into *RESULT. */
4343 decode_timer (Lisp_Object timer
, EMACS_TIME
*result
)
4345 Lisp_Object
*vector
;
4347 if (! (VECTORP (timer
) && ASIZE (timer
) == 9))
4349 vector
= XVECTOR (timer
)->contents
;
4350 if (! NILP (vector
[0]))
4353 return decode_time_components (vector
[1], vector
[2], vector
[3], vector
[4],
4358 /* Check whether a timer has fired. To prevent larger problems we simply
4359 disregard elements that are not proper timers. Do not make a circular
4360 timer list for the time being.
4362 Returns the time to wait until the next timer fires. If a
4363 timer is triggering now, return zero.
4364 If no timer is active, return -1.
4366 If a timer is ripe, we run it, with quitting turned off.
4367 In that case we return 0 to indicate that a new timer_check_2 call
4371 timer_check_2 (void)
4373 EMACS_TIME nexttime
;
4375 EMACS_TIME idleness_now
;
4376 Lisp_Object timers
, idle_timers
, chosen_timer
;
4377 struct gcpro gcpro1
, gcpro2
, gcpro3
;
4379 nexttime
= invalid_emacs_time ();
4381 /* Always consider the ordinary timers. */
4382 timers
= Vtimer_list
;
4383 /* Consider the idle timers only if Emacs is idle. */
4384 if (EMACS_TIME_VALID_P (timer_idleness_start_time
))
4385 idle_timers
= Vtimer_idle_list
;
4388 chosen_timer
= Qnil
;
4389 GCPRO3 (timers
, idle_timers
, chosen_timer
);
4391 /* First run the code that was delayed. */
4392 while (CONSP (pending_funcalls
))
4394 Lisp_Object funcall
= XCAR (pending_funcalls
);
4395 pending_funcalls
= XCDR (pending_funcalls
);
4396 safe_call2 (Qapply
, XCAR (funcall
), XCDR (funcall
));
4399 if (CONSP (timers
) || CONSP (idle_timers
))
4401 now
= current_emacs_time ();
4402 idleness_now
= (EMACS_TIME_VALID_P (timer_idleness_start_time
)
4403 ? sub_emacs_time (now
, timer_idleness_start_time
)
4404 : make_emacs_time (0, 0));
4407 while (CONSP (timers
) || CONSP (idle_timers
))
4409 Lisp_Object timer
= Qnil
, idle_timer
= Qnil
;
4410 EMACS_TIME timer_time
, idle_timer_time
;
4411 EMACS_TIME difference
;
4412 EMACS_TIME timer_difference
= invalid_emacs_time ();
4413 EMACS_TIME idle_timer_difference
= invalid_emacs_time ();
4414 int ripe
, timer_ripe
= 0, idle_timer_ripe
= 0;
4416 /* Set TIMER and TIMER_DIFFERENCE
4417 based on the next ordinary timer.
4418 TIMER_DIFFERENCE is the distance in time from NOW to when
4419 this timer becomes ripe (negative if it's already ripe).
4420 Skip past invalid timers and timers already handled. */
4423 timer
= XCAR (timers
);
4424 if (! decode_timer (timer
, &timer_time
))
4426 timers
= XCDR (timers
);
4430 timer_ripe
= EMACS_TIME_LE (timer_time
, now
);
4431 timer_difference
= (timer_ripe
4432 ? sub_emacs_time (now
, timer_time
)
4433 : sub_emacs_time (timer_time
, now
));
4436 /* Likewise for IDLE_TIMER and IDLE_TIMER_DIFFERENCE
4437 based on the next idle timer. */
4438 if (CONSP (idle_timers
))
4440 idle_timer
= XCAR (idle_timers
);
4441 if (! decode_timer (idle_timer
, &idle_timer_time
))
4443 idle_timers
= XCDR (idle_timers
);
4447 idle_timer_ripe
= EMACS_TIME_LE (idle_timer_time
, idleness_now
);
4448 idle_timer_difference
=
4450 ? sub_emacs_time (idleness_now
, idle_timer_time
)
4451 : sub_emacs_time (idle_timer_time
, idleness_now
));
4454 /* Decide which timer is the next timer,
4455 and set CHOSEN_TIMER, DIFFERENCE, and RIPE accordingly.
4456 Also step down the list where we found that timer. */
4458 if (EMACS_TIME_VALID_P (timer_difference
)
4459 && (! EMACS_TIME_VALID_P (idle_timer_difference
)
4460 || idle_timer_ripe
< timer_ripe
4461 || (idle_timer_ripe
== timer_ripe
4463 ? EMACS_TIME_LT (idle_timer_difference
,
4465 : EMACS_TIME_LT (timer_difference
,
4466 idle_timer_difference
)))))
4468 chosen_timer
= timer
;
4469 timers
= XCDR (timers
);
4470 difference
= timer_difference
;
4475 chosen_timer
= idle_timer
;
4476 idle_timers
= XCDR (idle_timers
);
4477 difference
= idle_timer_difference
;
4478 ripe
= idle_timer_ripe
;
4481 /* If timer is ripe, run it if it hasn't been run. */
4484 if (NILP (AREF (chosen_timer
, 0)))
4486 ptrdiff_t count
= SPECPDL_INDEX ();
4487 Lisp_Object old_deactivate_mark
= Vdeactivate_mark
;
4489 /* Mark the timer as triggered to prevent problems if the lisp
4490 code fails to reschedule it right. */
4491 ASET (chosen_timer
, 0, Qt
);
4493 specbind (Qinhibit_quit
, Qt
);
4495 call1 (Qtimer_event_handler
, chosen_timer
);
4496 Vdeactivate_mark
= old_deactivate_mark
;
4498 unbind_to (count
, Qnil
);
4500 /* Since we have handled the event,
4501 we don't need to tell the caller to wake up and do it. */
4502 /* But the caller must still wait for the next timer, so
4503 return 0 to indicate that. */
4506 nexttime
= make_emacs_time (0, 0);
4510 /* When we encounter a timer that is still waiting,
4511 return the amount of time to wait before it is ripe. */
4518 /* No timers are pending in the future. */
4519 /* Return 0 if we generated an event, and -1 if not. */
4525 /* Check whether a timer has fired. To prevent larger problems we simply
4526 disregard elements that are not proper timers. Do not make a circular
4527 timer list for the time being.
4529 Returns the time to wait until the next timer fires.
4530 If no timer is active, return an invalid value.
4532 As long as any timer is ripe, we run it. */
4537 EMACS_TIME nexttime
;
4541 nexttime
= timer_check_2 ();
4543 while (EMACS_SECS (nexttime
) == 0 && EMACS_NSECS (nexttime
) == 0);
4548 DEFUN ("current-idle-time", Fcurrent_idle_time
, Scurrent_idle_time
, 0, 0, 0,
4549 doc
: /* Return the current length of Emacs idleness, or nil.
4550 The value when Emacs is idle is a list of four integers (HIGH LOW USEC PSEC)
4551 in the same style as (current-time).
4553 The value when Emacs is not idle is nil.
4555 NSEC is a multiple of the system clock resolution. */)
4558 if (EMACS_TIME_VALID_P (timer_idleness_start_time
))
4559 return make_lisp_time (sub_emacs_time (current_emacs_time (),
4560 timer_idleness_start_time
));
4565 /* Caches for modify_event_symbol. */
4566 static Lisp_Object accent_key_syms
;
4567 static Lisp_Object func_key_syms
;
4568 static Lisp_Object mouse_syms
;
4569 static Lisp_Object wheel_syms
;
4570 static Lisp_Object drag_n_drop_syms
;
4572 /* This is a list of keysym codes for special "accent" characters.
4573 It parallels lispy_accent_keys. */
4575 static const int lispy_accent_codes
[] =
4577 #ifdef XK_dead_circumflex
4582 #ifdef XK_dead_grave
4587 #ifdef XK_dead_tilde
4592 #ifdef XK_dead_diaeresis
4597 #ifdef XK_dead_macron
4602 #ifdef XK_dead_degree
4607 #ifdef XK_dead_acute
4612 #ifdef XK_dead_cedilla
4617 #ifdef XK_dead_breve
4622 #ifdef XK_dead_ogonek
4627 #ifdef XK_dead_caron
4632 #ifdef XK_dead_doubleacute
4633 XK_dead_doubleacute
,
4637 #ifdef XK_dead_abovedot
4642 #ifdef XK_dead_abovering
4652 #ifdef XK_dead_belowdot
4657 #ifdef XK_dead_voiced_sound
4658 XK_dead_voiced_sound
,
4662 #ifdef XK_dead_semivoiced_sound
4663 XK_dead_semivoiced_sound
,
4679 /* This is a list of Lisp names for special "accent" characters.
4680 It parallels lispy_accent_codes. */
4682 static const char *const lispy_accent_keys
[] =
4700 "dead-voiced-sound",
4701 "dead-semivoiced-sound",
4707 #define FUNCTION_KEY_OFFSET 0x0
4709 const char *const lispy_function_keys
[] =
4713 0, /* VK_LBUTTON 0x01 */
4714 0, /* VK_RBUTTON 0x02 */
4715 "cancel", /* VK_CANCEL 0x03 */
4716 0, /* VK_MBUTTON 0x04 */
4718 0, 0, 0, /* 0x05 .. 0x07 */
4720 "backspace", /* VK_BACK 0x08 */
4721 "tab", /* VK_TAB 0x09 */
4723 0, 0, /* 0x0A .. 0x0B */
4725 "clear", /* VK_CLEAR 0x0C */
4726 "return", /* VK_RETURN 0x0D */
4728 0, 0, /* 0x0E .. 0x0F */
4730 0, /* VK_SHIFT 0x10 */
4731 0, /* VK_CONTROL 0x11 */
4732 0, /* VK_MENU 0x12 */
4733 "pause", /* VK_PAUSE 0x13 */
4734 "capslock", /* VK_CAPITAL 0x14 */
4735 "kana", /* VK_KANA/VK_HANGUL 0x15 */
4737 "junja", /* VK_JUNJA 0x17 */
4738 "final", /* VK_FINAL 0x18 */
4739 "kanji", /* VK_KANJI/VK_HANJA 0x19 */
4741 "escape", /* VK_ESCAPE 0x1B */
4742 "convert", /* VK_CONVERT 0x1C */
4743 "non-convert", /* VK_NONCONVERT 0x1D */
4744 "accept", /* VK_ACCEPT 0x1E */
4745 "mode-change", /* VK_MODECHANGE 0x1F */
4746 0, /* VK_SPACE 0x20 */
4747 "prior", /* VK_PRIOR 0x21 */
4748 "next", /* VK_NEXT 0x22 */
4749 "end", /* VK_END 0x23 */
4750 "home", /* VK_HOME 0x24 */
4751 "left", /* VK_LEFT 0x25 */
4752 "up", /* VK_UP 0x26 */
4753 "right", /* VK_RIGHT 0x27 */
4754 "down", /* VK_DOWN 0x28 */
4755 "select", /* VK_SELECT 0x29 */
4756 "print", /* VK_PRINT 0x2A */
4757 "execute", /* VK_EXECUTE 0x2B */
4758 "snapshot", /* VK_SNAPSHOT 0x2C */
4759 "insert", /* VK_INSERT 0x2D */
4760 "delete", /* VK_DELETE 0x2E */
4761 "help", /* VK_HELP 0x2F */
4763 /* VK_0 thru VK_9 are the same as ASCII '0' thru '9' (0x30 - 0x39) */
4765 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4767 0, 0, 0, 0, 0, 0, 0, /* 0x3A .. 0x40 */
4769 /* VK_A thru VK_Z are the same as ASCII 'A' thru 'Z' (0x41 - 0x5A) */
4771 0, 0, 0, 0, 0, 0, 0, 0, 0,
4772 0, 0, 0, 0, 0, 0, 0, 0, 0,
4773 0, 0, 0, 0, 0, 0, 0, 0,
4775 "lwindow", /* VK_LWIN 0x5B */
4776 "rwindow", /* VK_RWIN 0x5C */
4777 "apps", /* VK_APPS 0x5D */
4780 "kp-0", /* VK_NUMPAD0 0x60 */
4781 "kp-1", /* VK_NUMPAD1 0x61 */
4782 "kp-2", /* VK_NUMPAD2 0x62 */
4783 "kp-3", /* VK_NUMPAD3 0x63 */
4784 "kp-4", /* VK_NUMPAD4 0x64 */
4785 "kp-5", /* VK_NUMPAD5 0x65 */
4786 "kp-6", /* VK_NUMPAD6 0x66 */
4787 "kp-7", /* VK_NUMPAD7 0x67 */
4788 "kp-8", /* VK_NUMPAD8 0x68 */
4789 "kp-9", /* VK_NUMPAD9 0x69 */
4790 "kp-multiply", /* VK_MULTIPLY 0x6A */
4791 "kp-add", /* VK_ADD 0x6B */
4792 "kp-separator", /* VK_SEPARATOR 0x6C */
4793 "kp-subtract", /* VK_SUBTRACT 0x6D */
4794 "kp-decimal", /* VK_DECIMAL 0x6E */
4795 "kp-divide", /* VK_DIVIDE 0x6F */
4796 "f1", /* VK_F1 0x70 */
4797 "f2", /* VK_F2 0x71 */
4798 "f3", /* VK_F3 0x72 */
4799 "f4", /* VK_F4 0x73 */
4800 "f5", /* VK_F5 0x74 */
4801 "f6", /* VK_F6 0x75 */
4802 "f7", /* VK_F7 0x76 */
4803 "f8", /* VK_F8 0x77 */
4804 "f9", /* VK_F9 0x78 */
4805 "f10", /* VK_F10 0x79 */
4806 "f11", /* VK_F11 0x7A */
4807 "f12", /* VK_F12 0x7B */
4808 "f13", /* VK_F13 0x7C */
4809 "f14", /* VK_F14 0x7D */
4810 "f15", /* VK_F15 0x7E */
4811 "f16", /* VK_F16 0x7F */
4812 "f17", /* VK_F17 0x80 */
4813 "f18", /* VK_F18 0x81 */
4814 "f19", /* VK_F19 0x82 */
4815 "f20", /* VK_F20 0x83 */
4816 "f21", /* VK_F21 0x84 */
4817 "f22", /* VK_F22 0x85 */
4818 "f23", /* VK_F23 0x86 */
4819 "f24", /* VK_F24 0x87 */
4821 0, 0, 0, 0, /* 0x88 .. 0x8B */
4822 0, 0, 0, 0, /* 0x8C .. 0x8F */
4824 "kp-numlock", /* VK_NUMLOCK 0x90 */
4825 "scroll", /* VK_SCROLL 0x91 */
4826 /* Not sure where the following block comes from.
4827 Windows headers have NEC and Fujitsu specific keys in
4828 this block, but nothing generic. */
4829 "kp-space", /* VK_NUMPAD_CLEAR 0x92 */
4830 "kp-enter", /* VK_NUMPAD_ENTER 0x93 */
4831 "kp-prior", /* VK_NUMPAD_PRIOR 0x94 */
4832 "kp-next", /* VK_NUMPAD_NEXT 0x95 */
4833 "kp-end", /* VK_NUMPAD_END 0x96 */
4834 "kp-home", /* VK_NUMPAD_HOME 0x97 */
4835 "kp-left", /* VK_NUMPAD_LEFT 0x98 */
4836 "kp-up", /* VK_NUMPAD_UP 0x99 */
4837 "kp-right", /* VK_NUMPAD_RIGHT 0x9A */
4838 "kp-down", /* VK_NUMPAD_DOWN 0x9B */
4839 "kp-insert", /* VK_NUMPAD_INSERT 0x9C */
4840 "kp-delete", /* VK_NUMPAD_DELETE 0x9D */
4842 0, 0, /* 0x9E .. 0x9F */
4845 * VK_L* & VK_R* - left and right Alt, Ctrl and Shift virtual keys.
4846 * Used only as parameters to GetAsyncKeyState and GetKeyState.
4847 * No other API or message will distinguish left and right keys this way.
4852 /* Multimedia keys. These are handled as WM_APPCOMMAND, which allows us
4853 to enable them selectively, and gives access to a few more functions.
4854 See lispy_multimedia_keys below. */
4855 0, 0, 0, 0, 0, 0, 0, /* 0xA6 .. 0xAC Browser */
4856 0, 0, 0, /* 0xAD .. 0xAF Volume */
4857 0, 0, 0, 0, /* 0xB0 .. 0xB3 Media */
4858 0, 0, 0, 0, /* 0xB4 .. 0xB7 Apps */
4860 /* 0xB8 .. 0xC0 "OEM" keys - all seem to be punctuation. */
4861 0, 0, 0, 0, 0, 0, 0, 0, 0,
4863 /* 0xC1 - 0xDA unallocated, 0xDB-0xDF more OEM keys */
4864 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4865 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4868 "ax", /* VK_OEM_AX 0xE1 */
4869 0, /* VK_OEM_102 0xE2 */
4870 "ico-help", /* VK_ICO_HELP 0xE3 */
4871 "ico-00", /* VK_ICO_00 0xE4 */
4872 0, /* VK_PROCESSKEY 0xE5 - used by IME */
4873 "ico-clear", /* VK_ICO_CLEAR 0xE6 */
4874 0, /* VK_PACKET 0xE7 - used to pass Unicode chars */
4876 "reset", /* VK_OEM_RESET 0xE9 */
4877 "jump", /* VK_OEM_JUMP 0xEA */
4878 "oem-pa1", /* VK_OEM_PA1 0xEB */
4879 "oem-pa2", /* VK_OEM_PA2 0xEC */
4880 "oem-pa3", /* VK_OEM_PA3 0xED */
4881 "wsctrl", /* VK_OEM_WSCTRL 0xEE */
4882 "cusel", /* VK_OEM_CUSEL 0xEF */
4883 "oem-attn", /* VK_OEM_ATTN 0xF0 */
4884 "finish", /* VK_OEM_FINISH 0xF1 */
4885 "copy", /* VK_OEM_COPY 0xF2 */
4886 "auto", /* VK_OEM_AUTO 0xF3 */
4887 "enlw", /* VK_OEM_ENLW 0xF4 */
4888 "backtab", /* VK_OEM_BACKTAB 0xF5 */
4889 "attn", /* VK_ATTN 0xF6 */
4890 "crsel", /* VK_CRSEL 0xF7 */
4891 "exsel", /* VK_EXSEL 0xF8 */
4892 "ereof", /* VK_EREOF 0xF9 */
4893 "play", /* VK_PLAY 0xFA */
4894 "zoom", /* VK_ZOOM 0xFB */
4895 "noname", /* VK_NONAME 0xFC */
4896 "pa1", /* VK_PA1 0xFD */
4897 "oem_clear", /* VK_OEM_CLEAR 0xFE */
4901 /* Some of these duplicate the "Media keys" on newer keyboards,
4902 but they are delivered to the application in a different way. */
4903 static const char *const lispy_multimedia_keys
[] =
4911 "browser-favorites",
4948 "toggle-dictate-command",
4954 "media-fast-forward",
4957 "media-channel-down"
4960 #else /* not HAVE_NTGUI */
4962 /* This should be dealt with in XTread_socket now, and that doesn't
4963 depend on the client system having the Kana syms defined. See also
4964 the XK_kana_A case below. */
4967 static const char *const lispy_kana_keys
[] =
4969 /* X Keysym value */
4970 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x400 .. 0x40f */
4971 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x410 .. 0x41f */
4972 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x420 .. 0x42f */
4973 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x430 .. 0x43f */
4974 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x440 .. 0x44f */
4975 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x450 .. 0x45f */
4976 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x460 .. 0x46f */
4977 0,0,0,0,0,0,0,0,0,0,0,0,0,0,"overline",0,
4978 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x480 .. 0x48f */
4979 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x490 .. 0x49f */
4980 0, "kana-fullstop", "kana-openingbracket", "kana-closingbracket",
4981 "kana-comma", "kana-conjunctive", "kana-WO", "kana-a",
4982 "kana-i", "kana-u", "kana-e", "kana-o",
4983 "kana-ya", "kana-yu", "kana-yo", "kana-tsu",
4984 "prolongedsound", "kana-A", "kana-I", "kana-U",
4985 "kana-E", "kana-O", "kana-KA", "kana-KI",
4986 "kana-KU", "kana-KE", "kana-KO", "kana-SA",
4987 "kana-SHI", "kana-SU", "kana-SE", "kana-SO",
4988 "kana-TA", "kana-CHI", "kana-TSU", "kana-TE",
4989 "kana-TO", "kana-NA", "kana-NI", "kana-NU",
4990 "kana-NE", "kana-NO", "kana-HA", "kana-HI",
4991 "kana-FU", "kana-HE", "kana-HO", "kana-MA",
4992 "kana-MI", "kana-MU", "kana-ME", "kana-MO",
4993 "kana-YA", "kana-YU", "kana-YO", "kana-RA",
4994 "kana-RI", "kana-RU", "kana-RE", "kana-RO",
4995 "kana-WA", "kana-N", "voicedsound", "semivoicedsound",
4996 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4e0 .. 0x4ef */
4997 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4f0 .. 0x4ff */
4999 #endif /* XK_kana_A */
5002 #define FUNCTION_KEY_OFFSET 0xff00
5004 /* You'll notice that this table is arranged to be conveniently
5005 indexed by X Windows keysym values. */
5006 static const char *const lispy_function_keys
[] =
5008 /* X Keysym value */
5010 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff00...0f */
5011 "backspace", "tab", "linefeed", "clear",
5013 0, 0, 0, "pause", /* 0xff10...1f */
5014 0, 0, 0, 0, 0, 0, 0, "escape",
5016 0, "kanji", "muhenkan", "henkan", /* 0xff20...2f */
5017 "romaji", "hiragana", "katakana", "hiragana-katakana",
5018 "zenkaku", "hankaku", "zenkaku-hankaku", "touroku",
5019 "massyo", "kana-lock", "kana-shift", "eisu-shift",
5020 "eisu-toggle", /* 0xff30...3f */
5021 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
5022 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff40...4f */
5024 "home", "left", "up", "right", /* 0xff50 */ /* IsCursorKey */
5025 "down", "prior", "next", "end",
5026 "begin", 0, 0, 0, 0, 0, 0, 0,
5027 "select", /* 0xff60 */ /* IsMiscFunctionKey */
5038 "break", /* 0xff6b */
5041 0, 0, 0, 0, "backtab", 0, 0, 0, /* 0xff70... */
5042 0, 0, 0, 0, 0, 0, 0, "kp-numlock", /* 0xff78... */
5043 "kp-space", /* 0xff80 */ /* IsKeypadKey */
5044 0, 0, 0, 0, 0, 0, 0, 0,
5045 "kp-tab", /* 0xff89 */
5047 "kp-enter", /* 0xff8d */
5049 "kp-f1", /* 0xff91 */
5053 "kp-home", /* 0xff95 */
5058 "kp-prior", /* kp-page-up */
5059 "kp-next", /* kp-page-down */
5065 0, 0, 0, 0, 0, 0, 0, 0, 0,
5066 "kp-multiply", /* 0xffaa */
5071 "kp-divide", /* 0xffaf */
5072 "kp-0", /* 0xffb0 */
5073 "kp-1", "kp-2", "kp-3", "kp-4", "kp-5", "kp-6", "kp-7", "kp-8", "kp-9",
5076 "kp-equal", /* 0xffbd */
5077 "f1", /* 0xffbe */ /* IsFunctionKey */
5079 "f3", "f4", "f5", "f6", "f7", "f8", "f9", "f10", /* 0xffc0 */
5080 "f11", "f12", "f13", "f14", "f15", "f16", "f17", "f18",
5081 "f19", "f20", "f21", "f22", "f23", "f24", "f25", "f26", /* 0xffd0 */
5082 "f27", "f28", "f29", "f30", "f31", "f32", "f33", "f34",
5083 "f35", 0, 0, 0, 0, 0, 0, 0, /* 0xffe0 */
5084 0, 0, 0, 0, 0, 0, 0, 0,
5085 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfff0 */
5086 0, 0, 0, 0, 0, 0, 0, "delete"
5089 /* ISO 9995 Function and Modifier Keys; the first byte is 0xFE. */
5090 #define ISO_FUNCTION_KEY_OFFSET 0xfe00
5092 static const char *const iso_lispy_function_keys
[] =
5094 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe00 */
5095 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe08 */
5096 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe10 */
5097 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe18 */
5098 "iso-lefttab", /* 0xfe20 */
5099 "iso-move-line-up", "iso-move-line-down",
5100 "iso-partial-line-up", "iso-partial-line-down",
5101 "iso-partial-space-left", "iso-partial-space-right",
5102 "iso-set-margin-left", "iso-set-margin-right", /* 0xffe27, 28 */
5103 "iso-release-margin-left", "iso-release-margin-right",
5104 "iso-release-both-margins",
5105 "iso-fast-cursor-left", "iso-fast-cursor-right",
5106 "iso-fast-cursor-up", "iso-fast-cursor-down",
5107 "iso-continuous-underline", "iso-discontinuous-underline", /* 0xfe30, 31 */
5108 "iso-emphasize", "iso-center-object", "iso-enter", /* ... 0xfe34 */
5111 #endif /* not HAVE_NTGUI */
5113 static Lisp_Object Vlispy_mouse_stem
;
5115 static const char *const lispy_wheel_names
[] =
5117 "wheel-up", "wheel-down", "wheel-left", "wheel-right"
5120 /* drag-n-drop events are generated when a set of selected files are
5121 dragged from another application and dropped onto an Emacs window. */
5122 static const char *const lispy_drag_n_drop_names
[] =
5127 /* Scroll bar parts. */
5128 static Lisp_Object Qabove_handle
, Qhandle
, Qbelow_handle
;
5129 Lisp_Object Qup
, Qdown
, Qbottom
;
5130 static Lisp_Object Qend_scroll
;
5132 static Lisp_Object Qratio
;
5134 /* An array of scroll bar parts, indexed by an enum scroll_bar_part value. */
5135 static Lisp_Object
*const scroll_bar_parts
[] = {
5136 &Qabove_handle
, &Qhandle
, &Qbelow_handle
,
5137 &Qup
, &Qdown
, &Qtop
, &Qbottom
, &Qend_scroll
, &Qratio
5140 /* A vector, indexed by button number, giving the down-going location
5141 of currently depressed buttons, both scroll bar and non-scroll bar.
5143 The elements have the form
5144 (BUTTON-NUMBER MODIFIER-MASK . REST)
5145 where REST is the cdr of a position as it would be reported in the event.
5147 The make_lispy_event function stores positions here to tell the
5148 difference between click and drag events, and to store the starting
5149 location to be included in drag events. */
5151 static Lisp_Object button_down_location
;
5153 /* Information about the most recent up-going button event: Which
5154 button, what location, and what time. */
5156 static int last_mouse_button
;
5157 static int last_mouse_x
;
5158 static int last_mouse_y
;
5159 static Time button_down_time
;
5161 /* The number of clicks in this multiple-click. */
5163 static int double_click_count
;
5165 /* X and Y are frame-relative coordinates for a click or wheel event.
5166 Return a Lisp-style event list. */
5169 make_lispy_position (struct frame
*f
, Lisp_Object x
, Lisp_Object y
,
5172 enum window_part part
;
5173 Lisp_Object posn
= Qnil
;
5174 Lisp_Object extra_info
= Qnil
;
5175 /* Coordinate pixel positions to return. */
5176 int xret
= 0, yret
= 0;
5177 /* The window under frame pixel coordinates (x,y) */
5178 Lisp_Object window
= f
5179 ? window_from_coordinates (f
, XINT (x
), XINT (y
), &part
, 0)
5182 if (WINDOWP (window
))
5184 /* It's a click in window WINDOW at frame coordinates (X,Y) */
5185 struct window
*w
= XWINDOW (window
);
5186 Lisp_Object string_info
= Qnil
;
5187 ptrdiff_t textpos
= -1;
5188 int col
= -1, row
= -1;
5189 int dx
= -1, dy
= -1;
5190 int width
= -1, height
= -1;
5191 Lisp_Object object
= Qnil
;
5193 /* Pixel coordinates relative to the window corner. */
5194 int wx
= XINT (x
) - WINDOW_LEFT_EDGE_X (w
);
5195 int wy
= XINT (y
) - WINDOW_TOP_EDGE_Y (w
);
5197 /* For text area clicks, return X, Y relative to the corner of
5198 this text area. Note that dX, dY etc are set below, by
5199 buffer_posn_from_coords. */
5200 if (part
== ON_TEXT
)
5202 xret
= XINT (x
) - window_box_left (w
, TEXT_AREA
);
5203 yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5205 /* For mode line and header line clicks, return X, Y relative to
5206 the left window edge. Use mode_line_string to look for a
5207 string on the click position. */
5208 else if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
)
5213 posn
= (part
== ON_MODE_LINE
) ? Qmode_line
: Qheader_line
;
5214 /* Note that mode_line_string takes COL, ROW as pixels and
5215 converts them to characters. */
5218 string
= mode_line_string (w
, part
, &col
, &row
, &charpos
,
5219 &object
, &dx
, &dy
, &width
, &height
);
5220 if (STRINGP (string
))
5221 string_info
= Fcons (string
, make_number (charpos
));
5222 textpos
= (w
== XWINDOW (selected_window
)
5223 && current_buffer
== XBUFFER (w
->buffer
))
5224 ? PT
: XMARKER (w
->pointm
)->charpos
;
5229 /* For fringes and margins, Y is relative to the area's (and the
5230 window's) top edge, while X is meaningless. */
5231 else if (part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
5236 posn
= (part
== ON_LEFT_MARGIN
) ? Qleft_margin
: Qright_margin
;
5239 string
= marginal_area_string (w
, part
, &col
, &row
, &charpos
,
5240 &object
, &dx
, &dy
, &width
, &height
);
5241 if (STRINGP (string
))
5242 string_info
= Fcons (string
, make_number (charpos
));
5243 yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5245 else if (part
== ON_LEFT_FRINGE
)
5247 posn
= Qleft_fringe
;
5250 - (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5251 ? 0 : window_box_width (w
, LEFT_MARGIN_AREA
));
5252 dy
= yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5254 else if (part
== ON_RIGHT_FRINGE
)
5256 posn
= Qright_fringe
;
5259 - window_box_width (w
, LEFT_MARGIN_AREA
)
5260 - window_box_width (w
, TEXT_AREA
)
5261 - (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5262 ? window_box_width (w
, RIGHT_MARGIN_AREA
)
5264 dy
= yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5266 else if (part
== ON_VERTICAL_BORDER
)
5268 posn
= Qvertical_line
;
5273 /* Nothing special for part == ON_SCROLL_BAR. */
5275 /* For clicks in the text area, fringes, or margins, call
5276 buffer_posn_from_coords to extract TEXTPOS, the buffer
5277 position nearest to the click. */
5280 Lisp_Object string2
, object2
= Qnil
;
5281 struct display_pos p
;
5283 int width2
, height2
;
5284 /* The pixel X coordinate passed to buffer_posn_from_coords
5285 is the X coordinate relative to the text area for
5286 text-area and right-margin clicks, zero otherwise. */
5288 = (part
== ON_TEXT
) ? xret
5289 : (part
== ON_RIGHT_FRINGE
|| part
== ON_RIGHT_MARGIN
)
5290 ? (XINT (x
) - window_box_left (w
, TEXT_AREA
))
5294 string2
= buffer_posn_from_coords (w
, &x2
, &y2
, &p
,
5295 &object2
, &dx2
, &dy2
,
5297 textpos
= CHARPOS (p
.pos
);
5298 if (col
< 0) col
= x2
;
5299 if (row
< 0) row
= y2
;
5300 if (dx
< 0) dx
= dx2
;
5301 if (dy
< 0) dy
= dy2
;
5302 if (width
< 0) width
= width2
;
5303 if (height
< 0) height
= height2
;
5307 posn
= make_number (textpos
);
5308 if (STRINGP (string2
))
5309 string_info
= Fcons (string2
,
5310 make_number (CHARPOS (p
.string_pos
)));
5316 #ifdef HAVE_WINDOW_SYSTEM
5317 if (IMAGEP (object
))
5319 Lisp_Object image_map
, hotspot
;
5320 if ((image_map
= Fplist_get (XCDR (object
), QCmap
),
5322 && (hotspot
= find_hot_spot (image_map
, dx
, dy
),
5324 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
5325 posn
= XCAR (hotspot
);
5332 Fcons (make_number (dx
), make_number (dy
)),
5333 Fcons (make_number (width
), make_number (height
)));
5336 extra_info
= Fcons (string_info
,
5337 Fcons (make_number (textpos
),
5338 Fcons (Fcons (make_number (col
),
5343 XSETFRAME (window
, f
);
5347 return Fcons (window
,
5349 Fcons (Fcons (make_number (xret
),
5350 make_number (yret
)),
5351 Fcons (make_number (t
),
5355 /* Given a struct input_event, build the lisp event which represents
5356 it. If EVENT is 0, build a mouse movement event from the mouse
5357 movement buffer, which should have a movement event in it.
5359 Note that events must be passed to this function in the order they
5360 are received; this function stores the location of button presses
5361 in order to build drag events when the button is released. */
5364 make_lispy_event (struct input_event
*event
)
5368 switch (event
->kind
)
5370 /* A simple keystroke. */
5371 case ASCII_KEYSTROKE_EVENT
:
5372 case MULTIBYTE_CHAR_KEYSTROKE_EVENT
:
5374 Lisp_Object lispy_c
;
5375 EMACS_INT c
= event
->code
;
5376 if (event
->kind
== ASCII_KEYSTROKE_EVENT
)
5379 eassert (c
== event
->code
);
5380 /* Turn ASCII characters into control characters
5382 if (event
->modifiers
& ctrl_modifier
)
5384 c
= make_ctrl_char (c
);
5385 event
->modifiers
&= ~ctrl_modifier
;
5389 /* Add in the other modifier bits. The shift key was taken care
5390 of by the X code. */
5391 c
|= (event
->modifiers
5392 & (meta_modifier
| alt_modifier
5393 | hyper_modifier
| super_modifier
| ctrl_modifier
));
5394 /* Distinguish Shift-SPC from SPC. */
5395 if ((event
->code
) == 040
5396 && event
->modifiers
& shift_modifier
)
5397 c
|= shift_modifier
;
5398 button_down_time
= 0;
5399 XSETFASTINT (lispy_c
, c
);
5404 /* NS_NONKEY_EVENTs are just like NON_ASCII_KEYSTROKE_EVENTs,
5405 except that they are non-key events (last-nonmenu-event is nil). */
5406 case NS_NONKEY_EVENT
:
5409 /* A function key. The symbol may need to have modifier prefixes
5411 case NON_ASCII_KEYSTROKE_EVENT
:
5412 button_down_time
= 0;
5414 for (i
= 0; i
< sizeof (lispy_accent_codes
) / sizeof (int); i
++)
5415 if (event
->code
== lispy_accent_codes
[i
])
5416 return modify_event_symbol (i
,
5418 Qfunction_key
, Qnil
,
5419 lispy_accent_keys
, &accent_key_syms
,
5420 (sizeof (lispy_accent_keys
)
5421 / sizeof (lispy_accent_keys
[0])));
5425 if (event
->code
>= 0x400 && event
->code
< 0x500)
5426 return modify_event_symbol (event
->code
- 0x400,
5427 event
->modifiers
& ~shift_modifier
,
5428 Qfunction_key
, Qnil
,
5429 lispy_kana_keys
, &func_key_syms
,
5430 (sizeof (lispy_kana_keys
)
5431 / sizeof (lispy_kana_keys
[0])));
5432 #endif /* XK_kana_A */
5435 #ifdef ISO_FUNCTION_KEY_OFFSET
5436 if (event
->code
< FUNCTION_KEY_OFFSET
5437 && event
->code
>= ISO_FUNCTION_KEY_OFFSET
)
5438 return modify_event_symbol (event
->code
- ISO_FUNCTION_KEY_OFFSET
,
5440 Qfunction_key
, Qnil
,
5441 iso_lispy_function_keys
, &func_key_syms
,
5442 (sizeof (iso_lispy_function_keys
)
5443 / sizeof (iso_lispy_function_keys
[0])));
5446 /* Handle system-specific or unknown keysyms. */
5447 if (event
->code
& (1 << 28)
5448 || event
->code
- FUNCTION_KEY_OFFSET
< 0
5449 || (event
->code
- FUNCTION_KEY_OFFSET
5450 >= sizeof lispy_function_keys
/ sizeof *lispy_function_keys
)
5451 || !lispy_function_keys
[event
->code
- FUNCTION_KEY_OFFSET
])
5453 /* We need to use an alist rather than a vector as the cache
5454 since we can't make a vector long enough. */
5455 if (NILP (KVAR (current_kboard
, system_key_syms
)))
5456 kset_system_key_syms (current_kboard
, Fcons (Qnil
, Qnil
));
5457 return modify_event_symbol (event
->code
,
5460 KVAR (current_kboard
, Vsystem_key_alist
),
5461 0, &KVAR (current_kboard
, system_key_syms
),
5465 return modify_event_symbol (event
->code
- FUNCTION_KEY_OFFSET
,
5467 Qfunction_key
, Qnil
,
5468 lispy_function_keys
, &func_key_syms
,
5469 (sizeof (lispy_function_keys
)
5470 / sizeof (lispy_function_keys
[0])));
5473 case MULTIMEDIA_KEY_EVENT
:
5474 if (event
->code
< (sizeof (lispy_multimedia_keys
)
5475 / sizeof (lispy_multimedia_keys
[0]))
5476 && event
->code
> 0 && lispy_multimedia_keys
[event
->code
])
5478 return modify_event_symbol (event
->code
, event
->modifiers
,
5479 Qfunction_key
, Qnil
,
5480 lispy_multimedia_keys
, &func_key_syms
,
5481 (sizeof (lispy_multimedia_keys
)
5482 / sizeof (lispy_multimedia_keys
[0])));
5488 /* A mouse click. Figure out where it is, decide whether it's
5489 a press, click or drag, and build the appropriate structure. */
5490 case MOUSE_CLICK_EVENT
:
5491 #ifndef USE_TOOLKIT_SCROLL_BARS
5492 case SCROLL_BAR_CLICK_EVENT
:
5495 int button
= event
->code
;
5497 Lisp_Object position
;
5498 Lisp_Object
*start_pos_ptr
;
5499 Lisp_Object start_pos
;
5503 /* Build the position as appropriate for this mouse click. */
5504 if (event
->kind
== MOUSE_CLICK_EVENT
)
5506 struct frame
*f
= XFRAME (event
->frame_or_window
);
5507 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK) && ! defined (HAVE_NS)
5511 /* Ignore mouse events that were made on frame that
5512 have been deleted. */
5513 if (! FRAME_LIVE_P (f
))
5516 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK) && ! defined (HAVE_NS)
5517 /* EVENT->x and EVENT->y are frame-relative pixel
5518 coordinates at this place. Under old redisplay, COLUMN
5519 and ROW are set to frame relative glyph coordinates
5520 which are then used to determine whether this click is
5521 in a menu (non-toolkit version). */
5522 pixel_to_glyph_coords (f
, XINT (event
->x
), XINT (event
->y
),
5523 &column
, &row
, NULL
, 1);
5525 /* In the non-toolkit version, clicks on the menu bar
5526 are ordinary button events in the event buffer.
5527 Distinguish them, and invoke the menu.
5529 (In the toolkit version, the toolkit handles the menu bar
5530 and Emacs doesn't know about it until after the user
5531 makes a selection.) */
5532 if (row
>= 0 && row
< FRAME_MENU_BAR_LINES (f
)
5533 && (event
->modifiers
& down_modifier
))
5535 Lisp_Object items
, item
;
5537 /* Find the menu bar item under `column'. */
5539 items
= FRAME_MENU_BAR_ITEMS (f
);
5540 for (i
= 0; i
< ASIZE (items
); i
+= 4)
5542 Lisp_Object pos
, string
;
5543 string
= AREF (items
, i
+ 1);
5544 pos
= AREF (items
, i
+ 3);
5547 if (column
>= XINT (pos
)
5548 && column
< XINT (pos
) + SCHARS (string
))
5550 item
= AREF (items
, i
);
5555 /* ELisp manual 2.4b says (x y) are window relative but
5556 code says they are frame-relative. */
5558 = Fcons (event
->frame_or_window
,
5560 Fcons (Fcons (event
->x
, event
->y
),
5561 Fcons (make_number (event
->timestamp
),
5564 return Fcons (item
, Fcons (position
, Qnil
));
5566 #endif /* not USE_X_TOOLKIT && not USE_GTK && not HAVE_NS */
5568 position
= make_lispy_position (f
, event
->x
, event
->y
,
5571 #ifndef USE_TOOLKIT_SCROLL_BARS
5574 /* It's a scrollbar click. */
5576 Lisp_Object portion_whole
;
5579 window
= event
->frame_or_window
;
5580 portion_whole
= Fcons (event
->x
, event
->y
);
5581 part
= *scroll_bar_parts
[(int) event
->part
];
5585 Fcons (Qvertical_scroll_bar
,
5586 Fcons (portion_whole
,
5587 Fcons (make_number (event
->timestamp
),
5588 Fcons (part
, Qnil
)))));
5590 #endif /* not USE_TOOLKIT_SCROLL_BARS */
5592 if (button
>= ASIZE (button_down_location
))
5594 ptrdiff_t incr
= button
- ASIZE (button_down_location
) + 1;
5595 button_down_location
= larger_vector (button_down_location
,
5597 mouse_syms
= larger_vector (mouse_syms
, incr
, -1);
5600 start_pos_ptr
= aref_addr (button_down_location
, button
);
5601 start_pos
= *start_pos_ptr
;
5602 *start_pos_ptr
= Qnil
;
5605 /* On window-system frames, use the value of
5606 double-click-fuzz as is. On other frames, interpret it
5607 as a multiple of 1/8 characters. */
5611 if (WINDOWP (event
->frame_or_window
))
5612 f
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5613 else if (FRAMEP (event
->frame_or_window
))
5614 f
= XFRAME (event
->frame_or_window
);
5618 if (FRAME_WINDOW_P (f
))
5619 fuzz
= double_click_fuzz
;
5621 fuzz
= double_click_fuzz
/ 8;
5623 is_double
= (button
== last_mouse_button
5624 && (eabs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5625 && (eabs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5626 && button_down_time
!= 0
5627 && (EQ (Vdouble_click_time
, Qt
)
5628 || (NATNUMP (Vdouble_click_time
)
5629 && (event
->timestamp
- button_down_time
5630 < XFASTINT (Vdouble_click_time
)))));
5633 last_mouse_button
= button
;
5634 last_mouse_x
= XINT (event
->x
);
5635 last_mouse_y
= XINT (event
->y
);
5637 /* If this is a button press, squirrel away the location, so
5638 we can decide later whether it was a click or a drag. */
5639 if (event
->modifiers
& down_modifier
)
5643 double_click_count
++;
5644 event
->modifiers
|= ((double_click_count
> 2)
5649 double_click_count
= 1;
5650 button_down_time
= event
->timestamp
;
5651 *start_pos_ptr
= Fcopy_alist (position
);
5652 ignore_mouse_drag_p
= 0;
5655 /* Now we're releasing a button - check the co-ordinates to
5656 see if this was a click or a drag. */
5657 else if (event
->modifiers
& up_modifier
)
5659 /* If we did not see a down before this up, ignore the up.
5660 Probably this happened because the down event chose a
5661 menu item. It would be an annoyance to treat the
5662 release of the button that chose the menu item as a
5665 if (!CONSP (start_pos
))
5668 event
->modifiers
&= ~up_modifier
;
5671 Lisp_Object new_down
, down
;
5672 EMACS_INT xdiff
= double_click_fuzz
, ydiff
= double_click_fuzz
;
5674 /* The third element of every position
5675 should be the (x,y) pair. */
5676 down
= Fcar (Fcdr (Fcdr (start_pos
)));
5677 new_down
= Fcar (Fcdr (Fcdr (position
)));
5680 && INTEGERP (XCAR (down
)) && INTEGERP (XCDR (down
)))
5682 xdiff
= XINT (XCAR (new_down
)) - XINT (XCAR (down
));
5683 ydiff
= XINT (XCDR (new_down
)) - XINT (XCDR (down
));
5686 if (ignore_mouse_drag_p
)
5688 event
->modifiers
|= click_modifier
;
5689 ignore_mouse_drag_p
= 0;
5691 else if (xdiff
< double_click_fuzz
&& xdiff
> - double_click_fuzz
5692 && ydiff
< double_click_fuzz
&& ydiff
> - double_click_fuzz
5693 /* Maybe the mouse has moved a lot, caused scrolling, and
5694 eventually ended up at the same screen position (but
5695 not buffer position) in which case it is a drag, not
5697 /* FIXME: OTOH if the buffer position has changed
5698 because of a timer or process filter rather than
5699 because of mouse movement, it should be considered as
5700 a click. But mouse-drag-region completely ignores
5701 this case and it hasn't caused any real problem, so
5702 it's probably OK to ignore it as well. */
5703 && EQ (Fcar (Fcdr (start_pos
)), Fcar (Fcdr (position
))))
5704 /* Mouse hasn't moved (much). */
5705 event
->modifiers
|= click_modifier
;
5708 button_down_time
= 0;
5709 event
->modifiers
|= drag_modifier
;
5712 /* Don't check is_double; treat this as multiple
5713 if the down-event was multiple. */
5714 if (double_click_count
> 1)
5715 event
->modifiers
|= ((double_click_count
> 2)
5721 /* Every mouse event should either have the down_modifier or
5722 the up_modifier set. */
5726 /* Get the symbol we should use for the mouse click. */
5729 head
= modify_event_symbol (button
,
5731 Qmouse_click
, Vlispy_mouse_stem
,
5734 ASIZE (mouse_syms
));
5735 if (event
->modifiers
& drag_modifier
)
5740 else if (event
->modifiers
& (double_modifier
| triple_modifier
))
5743 Fcons (make_number (double_click_count
),
5753 case HORIZ_WHEEL_EVENT
:
5755 Lisp_Object position
;
5758 /* Build the position as appropriate for this mouse click. */
5759 struct frame
*f
= XFRAME (event
->frame_or_window
);
5761 /* Ignore wheel events that were made on frame that have been
5763 if (! FRAME_LIVE_P (f
))
5766 position
= make_lispy_position (f
, event
->x
, event
->y
,
5769 /* Set double or triple modifiers to indicate the wheel speed. */
5771 /* On window-system frames, use the value of
5772 double-click-fuzz as is. On other frames, interpret it
5773 as a multiple of 1/8 characters. */
5779 if (WINDOWP (event
->frame_or_window
))
5780 fr
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5781 else if (FRAMEP (event
->frame_or_window
))
5782 fr
= XFRAME (event
->frame_or_window
);
5786 fuzz
= FRAME_WINDOW_P (fr
)
5787 ? double_click_fuzz
: double_click_fuzz
/ 8;
5789 if (event
->modifiers
& up_modifier
)
5791 /* Emit a wheel-up event. */
5792 event
->modifiers
&= ~up_modifier
;
5795 else if (event
->modifiers
& down_modifier
)
5797 /* Emit a wheel-down event. */
5798 event
->modifiers
&= ~down_modifier
;
5802 /* Every wheel event should either have the down_modifier or
5803 the up_modifier set. */
5806 if (event
->kind
== HORIZ_WHEEL_EVENT
)
5809 is_double
= (last_mouse_button
== - (1 + symbol_num
)
5810 && (eabs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5811 && (eabs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5812 && button_down_time
!= 0
5813 && (EQ (Vdouble_click_time
, Qt
)
5814 || (NATNUMP (Vdouble_click_time
)
5815 && (event
->timestamp
- button_down_time
5816 < XFASTINT (Vdouble_click_time
)))));
5819 double_click_count
++;
5820 event
->modifiers
|= ((double_click_count
> 2)
5826 double_click_count
= 1;
5827 event
->modifiers
|= click_modifier
;
5830 button_down_time
= event
->timestamp
;
5831 /* Use a negative value to distinguish wheel from mouse button. */
5832 last_mouse_button
= - (1 + symbol_num
);
5833 last_mouse_x
= XINT (event
->x
);
5834 last_mouse_y
= XINT (event
->y
);
5836 /* Get the symbol we should use for the wheel event. */
5837 head
= modify_event_symbol (symbol_num
,
5843 ASIZE (wheel_syms
));
5846 if (event
->modifiers
& (double_modifier
| triple_modifier
))
5849 Fcons (make_number (double_click_count
),
5858 #ifdef USE_TOOLKIT_SCROLL_BARS
5860 /* We don't have down and up events if using toolkit scroll bars,
5861 so make this always a click event. Store in the `part' of
5862 the Lisp event a symbol which maps to the following actions:
5864 `above_handle' page up
5865 `below_handle' page down
5869 `bottom' bottom of buffer
5870 `handle' thumb has been dragged.
5871 `end-scroll' end of interaction with scroll bar
5873 The incoming input_event contains in its `part' member an
5874 index of type `enum scroll_bar_part' which we can use as an
5875 index in scroll_bar_parts to get the appropriate symbol. */
5877 case SCROLL_BAR_CLICK_EVENT
:
5879 Lisp_Object position
, head
, window
, portion_whole
, part
;
5881 window
= event
->frame_or_window
;
5882 portion_whole
= Fcons (event
->x
, event
->y
);
5883 part
= *scroll_bar_parts
[(int) event
->part
];
5887 Fcons (Qvertical_scroll_bar
,
5888 Fcons (portion_whole
,
5889 Fcons (make_number (event
->timestamp
),
5890 Fcons (part
, Qnil
)))));
5892 /* Always treat scroll bar events as clicks. */
5893 event
->modifiers
|= click_modifier
;
5894 event
->modifiers
&= ~up_modifier
;
5896 if (event
->code
>= ASIZE (mouse_syms
))
5897 mouse_syms
= larger_vector (mouse_syms
,
5898 event
->code
- ASIZE (mouse_syms
) + 1,
5901 /* Get the symbol we should use for the mouse click. */
5902 head
= modify_event_symbol (event
->code
,
5907 ASIZE (mouse_syms
));
5908 return Fcons (head
, Fcons (position
, Qnil
));
5911 #endif /* USE_TOOLKIT_SCROLL_BARS */
5913 case DRAG_N_DROP_EVENT
:
5916 Lisp_Object head
, position
;
5919 f
= XFRAME (event
->frame_or_window
);
5922 /* Ignore mouse events that were made on frames that
5923 have been deleted. */
5924 if (! FRAME_LIVE_P (f
))
5927 position
= make_lispy_position (f
, event
->x
, event
->y
,
5930 head
= modify_event_symbol (0, event
->modifiers
,
5932 lispy_drag_n_drop_names
,
5933 &drag_n_drop_syms
, 1);
5939 #endif /* HAVE_MOUSE */
5941 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
5942 || defined (HAVE_NS) || defined (USE_GTK)
5943 case MENU_BAR_EVENT
:
5944 if (EQ (event
->arg
, event
->frame_or_window
))
5945 /* This is the prefix key. We translate this to
5946 `(menu_bar)' because the code in keyboard.c for menu
5947 events, which we use, relies on this. */
5948 return Fcons (Qmenu_bar
, Qnil
);
5952 case SELECT_WINDOW_EVENT
:
5953 /* Make an event (select-window (WINDOW)). */
5954 return Fcons (Qselect_window
,
5955 Fcons (Fcons (event
->frame_or_window
, Qnil
),
5958 case TOOL_BAR_EVENT
:
5959 if (EQ (event
->arg
, event
->frame_or_window
))
5960 /* This is the prefix key. We translate this to
5961 `(tool_bar)' because the code in keyboard.c for tool bar
5962 events, which we use, relies on this. */
5963 return Fcons (Qtool_bar
, Qnil
);
5964 else if (SYMBOLP (event
->arg
))
5965 return apply_modifiers (event
->modifiers
, event
->arg
);
5968 case USER_SIGNAL_EVENT
:
5969 /* A user signal. */
5971 char *name
= find_user_signal_name (event
->code
);
5974 return intern (name
);
5977 case SAVE_SESSION_EVENT
:
5978 return Qsave_session
;
5983 return Fcons (Qdbus_event
, event
->arg
);
5985 #endif /* HAVE_DBUS */
5987 case CONFIG_CHANGED_EVENT
:
5988 return Fcons (Qconfig_changed_event
,
5990 Fcons (event
->frame_or_window
, Qnil
)));
5992 case GPM_CLICK_EVENT
:
5994 FRAME_PTR f
= XFRAME (event
->frame_or_window
);
5995 Lisp_Object head
, position
;
5996 Lisp_Object
*start_pos_ptr
;
5997 Lisp_Object start_pos
;
5998 int button
= event
->code
;
6000 if (button
>= ASIZE (button_down_location
))
6002 ptrdiff_t incr
= button
- ASIZE (button_down_location
) + 1;
6003 button_down_location
= larger_vector (button_down_location
,
6005 mouse_syms
= larger_vector (mouse_syms
, incr
, -1);
6008 start_pos_ptr
= aref_addr (button_down_location
, button
);
6009 start_pos
= *start_pos_ptr
;
6011 position
= make_lispy_position (f
, event
->x
, event
->y
,
6014 if (event
->modifiers
& down_modifier
)
6015 *start_pos_ptr
= Fcopy_alist (position
);
6016 else if (event
->modifiers
& (up_modifier
| drag_modifier
))
6018 if (!CONSP (start_pos
))
6020 event
->modifiers
&= ~up_modifier
;
6023 head
= modify_event_symbol (button
,
6025 Qmouse_click
, Vlispy_mouse_stem
,
6028 ASIZE (mouse_syms
));
6030 if (event
->modifiers
& drag_modifier
)
6035 else if (event
->modifiers
& double_modifier
)
6038 Fcons (make_number (2),
6040 else if (event
->modifiers
& triple_modifier
)
6043 Fcons (make_number (3),
6050 #endif /* HAVE_GPM */
6052 /* The 'kind' field of the event is something we don't recognize. */
6058 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
6061 make_lispy_movement (FRAME_PTR frame
, Lisp_Object bar_window
, enum scroll_bar_part part
,
6062 Lisp_Object x
, Lisp_Object y
, Time t
)
6064 /* Is it a scroll bar movement? */
6065 if (frame
&& ! NILP (bar_window
))
6067 Lisp_Object part_sym
;
6069 part_sym
= *scroll_bar_parts
[(int) part
];
6070 return Fcons (Qscroll_bar_movement
,
6071 Fcons (list5 (bar_window
,
6072 Qvertical_scroll_bar
,
6078 /* Or is it an ordinary mouse movement? */
6081 Lisp_Object position
;
6082 position
= make_lispy_position (frame
, x
, y
, t
);
6083 return list2 (Qmouse_movement
, position
);
6087 #endif /* HAVE_MOUSE || HAVE GPM */
6089 /* Construct a switch frame event. */
6091 make_lispy_switch_frame (Lisp_Object frame
)
6093 return Fcons (Qswitch_frame
, Fcons (frame
, Qnil
));
6096 /* Manipulating modifiers. */
6098 /* Parse the name of SYMBOL, and return the set of modifiers it contains.
6100 If MODIFIER_END is non-zero, set *MODIFIER_END to the position in
6101 SYMBOL's name of the end of the modifiers; the string from this
6102 position is the unmodified symbol name.
6104 This doesn't use any caches. */
6107 parse_modifiers_uncached (Lisp_Object symbol
, ptrdiff_t *modifier_end
)
6113 CHECK_SYMBOL (symbol
);
6116 name
= SYMBOL_NAME (symbol
);
6118 for (i
= 0; i
< SBYTES (name
) - 1; )
6120 ptrdiff_t this_mod_end
= 0;
6123 /* See if the name continues with a modifier word.
6124 Check that the word appears, but don't check what follows it.
6125 Set this_mod and this_mod_end to record what we find. */
6127 switch (SREF (name
, i
))
6129 #define SINGLE_LETTER_MOD(BIT) \
6130 (this_mod_end = i + 1, this_mod = BIT)
6133 SINGLE_LETTER_MOD (alt_modifier
);
6137 SINGLE_LETTER_MOD (ctrl_modifier
);
6141 SINGLE_LETTER_MOD (hyper_modifier
);
6145 SINGLE_LETTER_MOD (meta_modifier
);
6149 SINGLE_LETTER_MOD (shift_modifier
);
6153 SINGLE_LETTER_MOD (super_modifier
);
6156 #undef SINGLE_LETTER_MOD
6158 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6159 if (i + LEN + 1 <= SBYTES (name) \
6160 && ! memcmp (SDATA (name) + i, NAME, LEN)) \
6162 this_mod_end = i + LEN; \
6167 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
6168 MULTI_LETTER_MOD (down_modifier
, "down", 4);
6169 MULTI_LETTER_MOD (double_modifier
, "double", 6);
6173 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
6175 #undef MULTI_LETTER_MOD
6179 /* If we found no modifier, stop looking for them. */
6180 if (this_mod_end
== 0)
6183 /* Check there is a dash after the modifier, so that it
6184 really is a modifier. */
6185 if (this_mod_end
>= SBYTES (name
)
6186 || SREF (name
, this_mod_end
) != '-')
6189 /* This modifier is real; look for another. */
6190 modifiers
|= this_mod
;
6191 i
= this_mod_end
+ 1;
6194 /* Should we include the `click' modifier? */
6195 if (! (modifiers
& (down_modifier
| drag_modifier
6196 | double_modifier
| triple_modifier
))
6197 && i
+ 7 == SBYTES (name
)
6198 && memcmp (SDATA (name
) + i
, "mouse-", 6) == 0
6199 && ('0' <= SREF (name
, i
+ 6) && SREF (name
, i
+ 6) <= '9'))
6200 modifiers
|= click_modifier
;
6202 if (! (modifiers
& (double_modifier
| triple_modifier
))
6203 && i
+ 6 < SBYTES (name
)
6204 && memcmp (SDATA (name
) + i
, "wheel-", 6) == 0)
6205 modifiers
|= click_modifier
;
6213 /* Return a symbol whose name is the modifier prefixes for MODIFIERS
6214 prepended to the string BASE[0..BASE_LEN-1].
6215 This doesn't use any caches. */
6217 apply_modifiers_uncached (int modifiers
, char *base
, int base_len
, int base_len_byte
)
6219 /* Since BASE could contain nulls, we can't use intern here; we have
6220 to use Fintern, which expects a genuine Lisp_String, and keeps a
6222 char new_mods
[sizeof "A-C-H-M-S-s-down-drag-double-triple-"];
6228 /* Only the event queue may use the `up' modifier; it should always
6229 be turned into a click or drag event before presented to lisp code. */
6230 if (modifiers
& up_modifier
)
6233 if (modifiers
& alt_modifier
) { *p
++ = 'A'; *p
++ = '-'; }
6234 if (modifiers
& ctrl_modifier
) { *p
++ = 'C'; *p
++ = '-'; }
6235 if (modifiers
& hyper_modifier
) { *p
++ = 'H'; *p
++ = '-'; }
6236 if (modifiers
& meta_modifier
) { *p
++ = 'M'; *p
++ = '-'; }
6237 if (modifiers
& shift_modifier
) { *p
++ = 'S'; *p
++ = '-'; }
6238 if (modifiers
& super_modifier
) { *p
++ = 's'; *p
++ = '-'; }
6239 if (modifiers
& double_modifier
) { strcpy (p
, "double-"); p
+= 7; }
6240 if (modifiers
& triple_modifier
) { strcpy (p
, "triple-"); p
+= 7; }
6241 if (modifiers
& down_modifier
) { strcpy (p
, "down-"); p
+= 5; }
6242 if (modifiers
& drag_modifier
) { strcpy (p
, "drag-"); p
+= 5; }
6243 /* The click modifier is denoted by the absence of other modifiers. */
6247 mod_len
= p
- new_mods
;
6251 Lisp_Object new_name
;
6253 new_name
= make_uninit_multibyte_string (mod_len
+ base_len
,
6254 mod_len
+ base_len_byte
);
6255 memcpy (SDATA (new_name
), new_mods
, mod_len
);
6256 memcpy (SDATA (new_name
) + mod_len
, base
, base_len_byte
);
6258 return Fintern (new_name
, Qnil
);
6263 static const char *const modifier_names
[] =
6265 "up", "down", "drag", "click", "double", "triple", 0, 0,
6266 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
6267 0, 0, "alt", "super", "hyper", "shift", "control", "meta"
6269 #define NUM_MOD_NAMES (sizeof (modifier_names) / sizeof (modifier_names[0]))
6271 static Lisp_Object modifier_symbols
;
6273 /* Return the list of modifier symbols corresponding to the mask MODIFIERS. */
6275 lispy_modifier_list (int modifiers
)
6277 Lisp_Object modifier_list
;
6280 modifier_list
= Qnil
;
6281 for (i
= 0; (1<<i
) <= modifiers
&& i
< NUM_MOD_NAMES
; i
++)
6282 if (modifiers
& (1<<i
))
6283 modifier_list
= Fcons (AREF (modifier_symbols
, i
),
6286 return modifier_list
;
6290 /* Parse the modifiers on SYMBOL, and return a list like (UNMODIFIED MASK),
6291 where UNMODIFIED is the unmodified form of SYMBOL,
6292 MASK is the set of modifiers present in SYMBOL's name.
6293 This is similar to parse_modifiers_uncached, but uses the cache in
6294 SYMBOL's Qevent_symbol_element_mask property, and maintains the
6295 Qevent_symbol_elements property. */
6297 #define KEY_TO_CHAR(k) (XINT (k) & ((1 << CHARACTERBITS) - 1))
6300 parse_modifiers (Lisp_Object symbol
)
6302 Lisp_Object elements
;
6304 if (INTEGERP (symbol
))
6305 return (Fcons (make_number (KEY_TO_CHAR (symbol
)),
6306 Fcons (make_number (XINT (symbol
) & CHAR_MODIFIER_MASK
),
6308 else if (!SYMBOLP (symbol
))
6311 elements
= Fget (symbol
, Qevent_symbol_element_mask
);
6312 if (CONSP (elements
))
6317 int modifiers
= parse_modifiers_uncached (symbol
, &end
);
6318 Lisp_Object unmodified
;
6321 unmodified
= Fintern (make_string (SSDATA (SYMBOL_NAME (symbol
)) + end
,
6322 SBYTES (SYMBOL_NAME (symbol
)) - end
),
6325 if (modifiers
& ~INTMASK
)
6327 XSETFASTINT (mask
, modifiers
);
6328 elements
= Fcons (unmodified
, Fcons (mask
, Qnil
));
6330 /* Cache the parsing results on SYMBOL. */
6331 Fput (symbol
, Qevent_symbol_element_mask
,
6333 Fput (symbol
, Qevent_symbol_elements
,
6334 Fcons (unmodified
, lispy_modifier_list (modifiers
)));
6336 /* Since we know that SYMBOL is modifiers applied to unmodified,
6337 it would be nice to put that in unmodified's cache.
6338 But we can't, since we're not sure that parse_modifiers is
6345 DEFUN ("internal-event-symbol-parse-modifiers", Fevent_symbol_parse_modifiers
,
6346 Sevent_symbol_parse_modifiers
, 1, 1, 0,
6347 doc
: /* Parse the event symbol. For internal use. */)
6348 (Lisp_Object symbol
)
6350 /* Fill the cache if needed. */
6351 parse_modifiers (symbol
);
6352 /* Ignore the result (which is stored on Qevent_symbol_element_mask)
6353 and use the Lispier representation stored on Qevent_symbol_elements
6355 return Fget (symbol
, Qevent_symbol_elements
);
6358 /* Apply the modifiers MODIFIERS to the symbol BASE.
6359 BASE must be unmodified.
6361 This is like apply_modifiers_uncached, but uses BASE's
6362 Qmodifier_cache property, if present. It also builds
6363 Qevent_symbol_elements properties, since it has that info anyway.
6365 apply_modifiers copies the value of BASE's Qevent_kind property to
6366 the modified symbol. */
6368 apply_modifiers (int modifiers
, Lisp_Object base
)
6370 Lisp_Object cache
, idx
, entry
, new_symbol
;
6372 /* Mask out upper bits. We don't know where this value's been. */
6373 modifiers
&= INTMASK
;
6375 if (INTEGERP (base
))
6376 return make_number (XINT (base
) | modifiers
);
6378 /* The click modifier never figures into cache indices. */
6379 cache
= Fget (base
, Qmodifier_cache
);
6380 XSETFASTINT (idx
, (modifiers
& ~click_modifier
));
6381 entry
= assq_no_quit (idx
, cache
);
6384 new_symbol
= XCDR (entry
);
6387 /* We have to create the symbol ourselves. */
6388 new_symbol
= apply_modifiers_uncached (modifiers
,
6389 SSDATA (SYMBOL_NAME (base
)),
6390 SCHARS (SYMBOL_NAME (base
)),
6391 SBYTES (SYMBOL_NAME (base
)));
6393 /* Add the new symbol to the base's cache. */
6394 entry
= Fcons (idx
, new_symbol
);
6395 Fput (base
, Qmodifier_cache
, Fcons (entry
, cache
));
6397 /* We have the parsing info now for free, so we could add it to
6399 XSETFASTINT (idx, modifiers);
6400 Fput (new_symbol, Qevent_symbol_element_mask,
6401 Fcons (base, Fcons (idx, Qnil)));
6402 Fput (new_symbol, Qevent_symbol_elements,
6403 Fcons (base, lispy_modifier_list (modifiers)));
6404 Sadly, this is only correct if `base' is indeed a base event,
6405 which is not necessarily the case. -stef */
6408 /* Make sure this symbol is of the same kind as BASE.
6410 You'd think we could just set this once and for all when we
6411 intern the symbol above, but reorder_modifiers may call us when
6412 BASE's property isn't set right; we can't assume that just
6413 because it has a Qmodifier_cache property it must have its
6414 Qevent_kind set right as well. */
6415 if (NILP (Fget (new_symbol
, Qevent_kind
)))
6419 kind
= Fget (base
, Qevent_kind
);
6421 Fput (new_symbol
, Qevent_kind
, kind
);
6428 /* Given a symbol whose name begins with modifiers ("C-", "M-", etc),
6429 return a symbol with the modifiers placed in the canonical order.
6430 Canonical order is alphabetical, except for down and drag, which
6431 always come last. The 'click' modifier is never written out.
6433 Fdefine_key calls this to make sure that (for example) C-M-foo
6434 and M-C-foo end up being equivalent in the keymap. */
6437 reorder_modifiers (Lisp_Object symbol
)
6439 /* It's hopefully okay to write the code this way, since everything
6440 will soon be in caches, and no consing will be done at all. */
6443 parsed
= parse_modifiers (symbol
);
6444 return apply_modifiers (XFASTINT (XCAR (XCDR (parsed
))),
6449 /* For handling events, we often want to produce a symbol whose name
6450 is a series of modifier key prefixes ("M-", "C-", etcetera) attached
6451 to some base, like the name of a function key or mouse button.
6452 modify_event_symbol produces symbols of this sort.
6454 NAME_TABLE should point to an array of strings, such that NAME_TABLE[i]
6455 is the name of the i'th symbol. TABLE_SIZE is the number of elements
6458 Alternatively, NAME_ALIST_OR_STEM is either an alist mapping codes
6459 into symbol names, or a string specifying a name stem used to
6460 construct a symbol name or the form `STEM-N', where N is the decimal
6461 representation of SYMBOL_NUM. NAME_ALIST_OR_STEM is used if it is
6462 non-nil; otherwise NAME_TABLE is used.
6464 SYMBOL_TABLE should be a pointer to a Lisp_Object whose value will
6465 persist between calls to modify_event_symbol that it can use to
6466 store a cache of the symbols it's generated for this NAME_TABLE
6467 before. The object stored there may be a vector or an alist.
6469 SYMBOL_NUM is the number of the base name we want from NAME_TABLE.
6471 MODIFIERS is a set of modifier bits (as given in struct input_events)
6472 whose prefixes should be applied to the symbol name.
6474 SYMBOL_KIND is the value to be placed in the event_kind property of
6475 the returned symbol.
6477 The symbols we create are supposed to have an
6478 `event-symbol-elements' property, which lists the modifiers present
6479 in the symbol's name. */
6482 modify_event_symbol (ptrdiff_t symbol_num
, int modifiers
, Lisp_Object symbol_kind
,
6483 Lisp_Object name_alist_or_stem
, const char *const *name_table
,
6484 Lisp_Object
*symbol_table
, ptrdiff_t table_size
)
6487 Lisp_Object symbol_int
;
6489 /* Get rid of the "vendor-specific" bit here. */
6490 XSETINT (symbol_int
, symbol_num
& 0xffffff);
6492 /* Is this a request for a valid symbol? */
6493 if (symbol_num
< 0 || symbol_num
>= table_size
)
6496 if (CONSP (*symbol_table
))
6497 value
= Fcdr (assq_no_quit (symbol_int
, *symbol_table
));
6499 /* If *symbol_table doesn't seem to be initialized properly, fix that.
6500 *symbol_table should be a lisp vector TABLE_SIZE elements long,
6501 where the Nth element is the symbol for NAME_TABLE[N], or nil if
6502 we've never used that symbol before. */
6505 if (! VECTORP (*symbol_table
)
6506 || ASIZE (*symbol_table
) != table_size
)
6510 XSETFASTINT (size
, table_size
);
6511 *symbol_table
= Fmake_vector (size
, Qnil
);
6514 value
= AREF (*symbol_table
, symbol_num
);
6517 /* Have we already used this symbol before? */
6520 /* No; let's create it. */
6521 if (CONSP (name_alist_or_stem
))
6522 value
= Fcdr_safe (Fassq (symbol_int
, name_alist_or_stem
));
6523 else if (STRINGP (name_alist_or_stem
))
6526 ptrdiff_t len
= (SBYTES (name_alist_or_stem
)
6527 + sizeof "-" + INT_STRLEN_BOUND (EMACS_INT
));
6529 buf
= SAFE_ALLOCA (len
);
6530 esprintf (buf
, "%s-%"pI
"d", SDATA (name_alist_or_stem
),
6531 XINT (symbol_int
) + 1);
6532 value
= intern (buf
);
6535 else if (name_table
!= 0 && name_table
[symbol_num
])
6536 value
= intern (name_table
[symbol_num
]);
6538 #ifdef HAVE_WINDOW_SYSTEM
6541 char *name
= x_get_keysym_name (symbol_num
);
6543 value
= intern (name
);
6549 char buf
[sizeof "key-" + INT_STRLEN_BOUND (EMACS_INT
)];
6550 sprintf (buf
, "key-%"pD
"d", symbol_num
);
6551 value
= intern (buf
);
6554 if (CONSP (*symbol_table
))
6555 *symbol_table
= Fcons (Fcons (symbol_int
, value
), *symbol_table
);
6557 ASET (*symbol_table
, symbol_num
, value
);
6559 /* Fill in the cache entries for this symbol; this also
6560 builds the Qevent_symbol_elements property, which the user
6562 apply_modifiers (modifiers
& click_modifier
, value
);
6563 Fput (value
, Qevent_kind
, symbol_kind
);
6566 /* Apply modifiers to that symbol. */
6567 return apply_modifiers (modifiers
, value
);
6570 /* Convert a list that represents an event type,
6571 such as (ctrl meta backspace), into the usual representation of that
6572 event type as a number or a symbol. */
6574 DEFUN ("event-convert-list", Fevent_convert_list
, Sevent_convert_list
, 1, 1, 0,
6575 doc
: /* Convert the event description list EVENT-DESC to an event type.
6576 EVENT-DESC should contain one base event type (a character or symbol)
6577 and zero or more modifier names (control, meta, hyper, super, shift, alt,
6578 drag, down, double or triple). The base must be last.
6579 The return value is an event type (a character or symbol) which
6580 has the same base event type and all the specified modifiers. */)
6581 (Lisp_Object event_desc
)
6589 while (CONSP (rest
))
6597 /* Given a symbol, see if it is a modifier name. */
6598 if (SYMBOLP (elt
) && CONSP (rest
))
6599 this = parse_solitary_modifier (elt
);
6603 else if (!NILP (base
))
6604 error ("Two bases given in one event");
6610 /* Let the symbol A refer to the character A. */
6611 if (SYMBOLP (base
) && SCHARS (SYMBOL_NAME (base
)) == 1)
6612 XSETINT (base
, SREF (SYMBOL_NAME (base
), 0));
6614 if (INTEGERP (base
))
6616 /* Turn (shift a) into A. */
6617 if ((modifiers
& shift_modifier
) != 0
6618 && (XINT (base
) >= 'a' && XINT (base
) <= 'z'))
6620 XSETINT (base
, XINT (base
) - ('a' - 'A'));
6621 modifiers
&= ~shift_modifier
;
6624 /* Turn (control a) into C-a. */
6625 if (modifiers
& ctrl_modifier
)
6626 return make_number ((modifiers
& ~ctrl_modifier
)
6627 | make_ctrl_char (XINT (base
)));
6629 return make_number (modifiers
| XINT (base
));
6631 else if (SYMBOLP (base
))
6632 return apply_modifiers (modifiers
, base
);
6635 error ("Invalid base event");
6640 /* Try to recognize SYMBOL as a modifier name.
6641 Return the modifier flag bit, or 0 if not recognized. */
6644 parse_solitary_modifier (Lisp_Object symbol
)
6646 Lisp_Object name
= SYMBOL_NAME (symbol
);
6648 switch (SREF (name
, 0))
6650 #define SINGLE_LETTER_MOD(BIT) \
6651 if (SBYTES (name) == 1) \
6654 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6655 if (LEN == SBYTES (name) \
6656 && ! memcmp (SDATA (name), NAME, LEN)) \
6660 SINGLE_LETTER_MOD (alt_modifier
);
6664 MULTI_LETTER_MOD (alt_modifier
, "alt", 3);
6668 SINGLE_LETTER_MOD (ctrl_modifier
);
6672 MULTI_LETTER_MOD (ctrl_modifier
, "ctrl", 4);
6673 MULTI_LETTER_MOD (ctrl_modifier
, "control", 7);
6677 SINGLE_LETTER_MOD (hyper_modifier
);
6681 MULTI_LETTER_MOD (hyper_modifier
, "hyper", 5);
6685 SINGLE_LETTER_MOD (meta_modifier
);
6689 MULTI_LETTER_MOD (meta_modifier
, "meta", 4);
6693 SINGLE_LETTER_MOD (shift_modifier
);
6697 MULTI_LETTER_MOD (shift_modifier
, "shift", 5);
6698 MULTI_LETTER_MOD (super_modifier
, "super", 5);
6699 SINGLE_LETTER_MOD (super_modifier
);
6703 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
6704 MULTI_LETTER_MOD (down_modifier
, "down", 4);
6705 MULTI_LETTER_MOD (double_modifier
, "double", 6);
6709 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
6712 #undef SINGLE_LETTER_MOD
6713 #undef MULTI_LETTER_MOD
6719 /* Return 1 if EVENT is a list whose elements are all integers or symbols.
6720 Such a list is not valid as an event,
6721 but it can be a Lucid-style event type list. */
6724 lucid_event_type_list_p (Lisp_Object object
)
6728 if (! CONSP (object
))
6731 if (EQ (XCAR (object
), Qhelp_echo
)
6732 || EQ (XCAR (object
), Qvertical_line
)
6733 || EQ (XCAR (object
), Qmode_line
)
6734 || EQ (XCAR (object
), Qheader_line
))
6737 for (tail
= object
; CONSP (tail
); tail
= XCDR (tail
))
6741 if (! (INTEGERP (elt
) || SYMBOLP (elt
)))
6748 /* Store into *addr a value nonzero if terminal input chars are available.
6749 Serves the purpose of ioctl (0, FIONREAD, addr)
6750 but works even if FIONREAD does not exist.
6751 (In fact, this may actually read some input.)
6753 If READABLE_EVENTS_DO_TIMERS_NOW is set in FLAGS, actually run
6754 timer events that are ripe.
6755 If READABLE_EVENTS_FILTER_EVENTS is set in FLAGS, ignore internal
6756 events (FOCUS_IN_EVENT).
6757 If READABLE_EVENTS_IGNORE_SQUEEZABLES is set in FLAGS, ignore mouse
6758 movements and toolkit scroll bar thumb drags. */
6761 get_input_pending (int *addr
, int flags
)
6763 /* First of all, have we already counted some input? */
6764 *addr
= (!NILP (Vquit_flag
) || readable_events (flags
));
6766 /* If input is being read as it arrives, and we have none, there is none. */
6767 if (*addr
> 0 || (interrupt_input
&& ! interrupts_deferred
))
6770 /* Try to read some input and see how much we get. */
6772 *addr
= (!NILP (Vquit_flag
) || readable_events (flags
));
6775 /* Interface to read_avail_input, blocking SIGIO or SIGALRM if necessary. */
6778 gobble_input (int expected
)
6781 if (interrupt_input
)
6784 mask
= sigblock (sigmask (SIGIO
));
6785 read_avail_input (expected
);
6789 #ifdef POLL_FOR_INPUT
6790 /* XXX This condition was (read_socket_hook && !interrupt_input),
6791 but read_socket_hook is not global anymore. Let's pretend that
6793 if (!interrupt_input
&& poll_suppress_count
== 0)
6796 mask
= sigblock (sigmask (SIGALRM
));
6797 read_avail_input (expected
);
6803 read_avail_input (expected
);
6806 /* Put a BUFFER_SWITCH_EVENT in the buffer
6807 so that read_key_sequence will notice the new current buffer. */
6810 record_asynch_buffer_change (void)
6812 struct input_event event
;
6816 event
.kind
= BUFFER_SWITCH_EVENT
;
6817 event
.frame_or_window
= Qnil
;
6820 /* We don't need a buffer-switch event unless Emacs is waiting for input.
6821 The purpose of the event is to make read_key_sequence look up the
6822 keymaps again. If we aren't in read_key_sequence, we don't need one,
6823 and the event could cause trouble by messing up (input-pending-p).
6824 Note: Fwaiting_for_user_input_p always returns nil when async
6825 subprocesses aren't supported. */
6826 tem
= Fwaiting_for_user_input_p ();
6830 /* Make sure no interrupt happens while storing the event. */
6832 if (interrupt_input
)
6835 mask
= sigblock (sigmask (SIGIO
));
6836 kbd_buffer_store_event (&event
);
6843 kbd_buffer_store_event (&event
);
6848 /* Read any terminal input already buffered up by the system
6849 into the kbd_buffer, but do not wait.
6851 EXPECTED should be nonzero if the caller knows there is some input.
6853 Returns the number of keyboard chars read, or -1 meaning
6854 this is a bad time to try to read input. */
6857 read_avail_input (int expected
)
6863 /* Store pending user signal events, if any. */
6864 if (store_user_signal_events ())
6867 /* Loop through the available terminals, and call their input hooks. */
6871 struct terminal
*next
= t
->next_terminal
;
6873 if (t
->read_socket_hook
)
6876 struct input_event hold_quit
;
6878 EVENT_INIT (hold_quit
);
6879 hold_quit
.kind
= NO_EVENT
;
6881 /* No need for FIONREAD or fcntl; just say don't wait. */
6882 while (nr
= (*t
->read_socket_hook
) (t
, expected
, &hold_quit
), nr
> 0)
6888 if (nr
== -1) /* Not OK to read input now. */
6892 else if (nr
== -2) /* Non-transient error. */
6894 /* The terminal device terminated; it should be closed. */
6896 /* Kill Emacs if this was our last terminal. */
6897 if (!terminal_list
->next_terminal
)
6898 /* Formerly simply reported no input, but that
6899 sometimes led to a failure of Emacs to terminate.
6900 SIGHUP seems appropriate if we can't reach the
6902 /* ??? Is it really right to send the signal just to
6903 this process rather than to the whole process
6904 group? Perhaps on systems with FIONREAD Emacs is
6905 alone in its group. */
6906 kill (getpid (), SIGHUP
);
6908 /* XXX Is calling delete_terminal safe here? It calls delete_frame. */
6911 XSETTERMINAL (tmp
, t
);
6912 Fdelete_terminal (tmp
, Qnoelisp
);
6916 if (hold_quit
.kind
!= NO_EVENT
)
6917 kbd_buffer_store_event (&hold_quit
);
6926 frame_make_pointer_visible ();
6932 decode_keyboard_code (struct tty_display_info
*tty
,
6933 struct coding_system
*coding
,
6934 unsigned char *buf
, int nbytes
)
6936 unsigned char *src
= buf
;
6937 const unsigned char *p
;
6942 if (tty
->meta_key
!= 2)
6943 for (i
= 0; i
< nbytes
; i
++)
6945 if (coding
->carryover_bytes
> 0)
6947 src
= alloca (coding
->carryover_bytes
+ nbytes
);
6948 memcpy (src
, coding
->carryover
, coding
->carryover_bytes
);
6949 memcpy (src
+ coding
->carryover_bytes
, buf
, nbytes
);
6950 nbytes
+= coding
->carryover_bytes
;
6952 coding
->destination
= alloca (nbytes
* 4);
6953 coding
->dst_bytes
= nbytes
* 4;
6954 decode_coding_c_string (coding
, src
, nbytes
, Qnil
);
6955 if (coding
->produced_char
== 0)
6957 for (i
= 0, p
= coding
->destination
; i
< coding
->produced_char
; i
++)
6959 struct input_event event_buf
;
6961 EVENT_INIT (event_buf
);
6962 event_buf
.code
= STRING_CHAR_ADVANCE (p
);
6964 (ASCII_CHAR_P (event_buf
.code
)
6965 ? ASCII_KEYSTROKE_EVENT
: MULTIBYTE_CHAR_KEYSTROKE_EVENT
);
6966 /* See the comment in tty_read_avail_input. */
6967 event_buf
.frame_or_window
= tty
->top_frame
;
6968 event_buf
.arg
= Qnil
;
6969 kbd_buffer_store_event (&event_buf
);
6973 /* This is the tty way of reading available input.
6975 Note that each terminal device has its own `struct terminal' object,
6976 and so this function is called once for each individual termcap
6977 terminal. The first parameter indicates which terminal to read from. */
6980 tty_read_avail_input (struct terminal
*terminal
,
6982 struct input_event
*hold_quit
)
6984 /* Using KBD_BUFFER_SIZE - 1 here avoids reading more than
6985 the kbd_buffer can really hold. That may prevent loss
6986 of characters on some systems when input is stuffed at us. */
6987 unsigned char cbuf
[KBD_BUFFER_SIZE
- 1];
6989 struct tty_display_info
*tty
= terminal
->display_info
.tty
;
6992 int buffer_free
= KBD_BUFFER_SIZE
- kbd_buffer_nr_stored () - 1;
6994 if (kbd_on_hold_p () || buffer_free
<= 0)
6996 #endif /* subprocesses */
6998 if (!terminal
->name
) /* Don't read from a dead terminal. */
7001 if (terminal
->type
!= output_termcap
7002 && terminal
->type
!= output_msdos_raw
)
7005 /* XXX I think the following code should be moved to separate hook
7006 functions in system-dependent files. */
7009 #else /* not WINDOWSNT */
7010 if (! tty
->term_initted
) /* In case we get called during bootstrap. */
7014 return 0; /* The terminal is suspended. */
7017 n_to_read
= dos_keysns ();
7021 cbuf
[0] = dos_keyread ();
7024 #else /* not MSDOS */
7029 struct input_event gpm_hold_quit
;
7030 int gpm
, fd
= gpm_fd
;
7032 EVENT_INIT (gpm_hold_quit
);
7033 gpm_hold_quit
.kind
= NO_EVENT
;
7035 /* gpm==1 if event received.
7036 gpm==0 if the GPM daemon has closed the connection, in which case
7037 Gpm_GetEvent closes gpm_fd and clears it to -1, which is why
7038 we save it in `fd' so close_gpm can remove it from the
7040 gpm==-1 if a protocol error or EWOULDBLOCK; the latter is normal. */
7041 while (gpm
= Gpm_GetEvent (&event
), gpm
== 1) {
7042 nread
+= handle_one_term_event (tty
, &event
, &gpm_hold_quit
);
7045 /* Presumably the GPM daemon has closed the connection. */
7047 if (gpm_hold_quit
.kind
!= NO_EVENT
)
7048 kbd_buffer_store_event (&gpm_hold_quit
);
7052 #endif /* HAVE_GPM */
7054 /* Determine how many characters we should *try* to read. */
7056 /* Find out how much input is available. */
7057 if (ioctl (fileno (tty
->input
), FIONREAD
, &n_to_read
) < 0)
7059 if (! noninteractive
)
7060 return -2; /* Close this terminal. */
7066 if (n_to_read
> sizeof cbuf
)
7067 n_to_read
= sizeof cbuf
;
7068 #else /* no FIONREAD */
7069 #if defined (USG) || defined (CYGWIN)
7070 /* Read some input if available, but don't wait. */
7071 n_to_read
= sizeof cbuf
;
7072 fcntl (fileno (tty
->input
), F_SETFL
, O_NDELAY
);
7079 /* Don't read more than we can store. */
7080 if (n_to_read
> buffer_free
)
7081 n_to_read
= buffer_free
;
7082 #endif /* subprocesses */
7084 /* Now read; for one reason or another, this will not block.
7085 NREAD is set to the number of chars read. */
7088 nread
= emacs_read (fileno (tty
->input
), (char *) cbuf
, n_to_read
);
7089 /* POSIX infers that processes which are not in the session leader's
7090 process group won't get SIGHUP's at logout time. BSDI adheres to
7091 this part standard and returns -1 from read (0) with errno==EIO
7092 when the control tty is taken away.
7093 Jeffrey Honig <jch@bsdi.com> says this is generally safe. */
7094 if (nread
== -1 && errno
== EIO
)
7095 return -2; /* Close this terminal. */
7096 #if defined (AIX) && defined (_BSD)
7097 /* The kernel sometimes fails to deliver SIGHUP for ptys.
7098 This looks incorrect, but it isn't, because _BSD causes
7099 O_NDELAY to be defined in fcntl.h as O_NONBLOCK,
7100 and that causes a value other than 0 when there is no input. */
7102 return -2; /* Close this terminal. */
7106 /* We used to retry the read if it was interrupted.
7107 But this does the wrong thing when O_NDELAY causes
7108 an EAGAIN error. Does anybody know of a situation
7109 where a retry is actually needed? */
7111 nread
< 0 && (errno
== EAGAIN
7125 #if defined (USG) || defined (CYGWIN)
7126 fcntl (fileno (tty
->input
), F_SETFL
, 0);
7127 #endif /* USG or CYGWIN */
7128 #endif /* no FIONREAD */
7133 #endif /* not MSDOS */
7134 #endif /* not WINDOWSNT */
7136 if (TERMINAL_KEYBOARD_CODING (terminal
)->common_flags
7137 & CODING_REQUIRE_DECODING_MASK
)
7139 struct coding_system
*coding
= TERMINAL_KEYBOARD_CODING (terminal
);
7142 /* Decode the key sequence except for those with meta
7144 for (i
= from
= 0; ; i
++)
7145 if (i
== nread
|| (tty
->meta_key
== 1 && (cbuf
[i
] & 0x80)))
7147 struct input_event buf
;
7149 decode_keyboard_code (tty
, coding
, cbuf
+ from
, i
- from
);
7154 buf
.kind
= ASCII_KEYSTROKE_EVENT
;
7155 buf
.modifiers
= meta_modifier
;
7156 buf
.code
= cbuf
[i
] & ~0x80;
7157 /* See the comment below. */
7158 buf
.frame_or_window
= tty
->top_frame
;
7160 kbd_buffer_store_event (&buf
);
7166 for (i
= 0; i
< nread
; i
++)
7168 struct input_event buf
;
7170 buf
.kind
= ASCII_KEYSTROKE_EVENT
;
7172 if (tty
->meta_key
== 1 && (cbuf
[i
] & 0x80))
7173 buf
.modifiers
= meta_modifier
;
7174 if (tty
->meta_key
!= 2)
7178 /* Set the frame corresponding to the active tty. Note that the
7179 value of selected_frame is not reliable here, redisplay tends
7180 to temporarily change it. */
7181 buf
.frame_or_window
= tty
->top_frame
;
7184 kbd_buffer_store_event (&buf
);
7185 /* Don't look at input that follows a C-g too closely.
7186 This reduces lossage due to autorepeat on C-g. */
7187 if (buf
.kind
== ASCII_KEYSTROKE_EVENT
7188 && buf
.code
== quit_char
)
7195 #if defined SYNC_INPUT || defined SIGIO
7197 handle_async_input (void)
7199 interrupt_input_pending
= 0;
7201 pending_signals
= pending_atimers
;
7203 /* Tell ns_read_socket() it is being called asynchronously so it can avoid
7204 doing anything dangerous. */
7211 nread
= read_avail_input (1);
7212 /* -1 means it's not ok to read the input now.
7213 UNBLOCK_INPUT will read it later; now, avoid infinite loop.
7214 0 means there was no keyboard input available. */
7222 #endif /* SYNC_INPUT || SIGIO */
7226 process_pending_signals (void)
7228 if (interrupt_input_pending
)
7229 handle_async_input ();
7230 do_pending_atimers ();
7234 #ifdef SIGIO /* for entire page */
7235 /* Note SIGIO has been undef'd if FIONREAD is missing. */
7238 handle_input_available_signal (int sig
)
7241 interrupt_input_pending
= 1;
7242 pending_signals
= 1;
7245 if (input_available_clear_time
)
7246 *input_available_clear_time
= make_emacs_time (0, 0);
7249 handle_async_input ();
7254 deliver_input_available_signal (int sig
)
7256 handle_on_main_thread (sig
, handle_input_available_signal
);
7260 /* Send ourselves a SIGIO.
7262 This function exists so that the UNBLOCK_INPUT macro in
7263 blockinput.h can have some way to take care of input we put off
7264 dealing with, without assuming that every file which uses
7265 UNBLOCK_INPUT also has #included the files necessary to get SIGIO. */
7267 reinvoke_input_signal (void)
7270 handle_async_input ();
7276 /* User signal events. */
7278 struct user_signal_info
7280 /* Signal number. */
7283 /* Name of the signal. */
7286 /* Number of pending signals. */
7289 struct user_signal_info
*next
;
7292 /* List of user signals. */
7293 static struct user_signal_info
*user_signals
= NULL
;
7296 add_user_signal (int sig
, const char *name
)
7298 struct user_signal_info
*p
;
7300 for (p
= user_signals
; p
; p
= p
->next
)
7302 /* Already added. */
7305 p
= xmalloc (sizeof *p
);
7307 p
->name
= xstrdup (name
);
7309 p
->next
= user_signals
;
7312 signal (sig
, deliver_user_signal
);
7316 handle_user_signal (int sig
)
7318 struct user_signal_info
*p
;
7319 const char *special_event_name
= NULL
;
7321 if (SYMBOLP (Vdebug_on_event
))
7322 special_event_name
= SSDATA (SYMBOL_NAME (Vdebug_on_event
));
7324 for (p
= user_signals
; p
; p
= p
->next
)
7327 if (special_event_name
7328 && strcmp (special_event_name
, p
->name
) == 0)
7330 /* Enter the debugger in many ways. */
7331 debug_on_next_call
= 1;
7334 Vinhibit_quit
= Qnil
;
7336 /* Eat the event. */
7342 if (interrupt_input
)
7343 kill (getpid (), SIGIO
);
7347 /* Tell wait_reading_process_output that it needs to wake
7348 up and look around. */
7349 if (input_available_clear_time
)
7350 *input_available_clear_time
= make_emacs_time (0, 0);
7357 deliver_user_signal (int sig
)
7359 handle_on_main_thread (sig
, handle_user_signal
);
7363 find_user_signal_name (int sig
)
7365 struct user_signal_info
*p
;
7367 for (p
= user_signals
; p
; p
= p
->next
)
7375 store_user_signal_events (void)
7377 struct user_signal_info
*p
;
7378 struct input_event buf
;
7381 for (p
= user_signals
; p
; p
= p
->next
)
7382 if (p
->npending
> 0)
7388 memset (&buf
, 0, sizeof buf
);
7389 buf
.kind
= USER_SIGNAL_EVENT
;
7390 buf
.frame_or_window
= selected_frame
;
7392 nstored
+= p
->npending
;
7394 mask
= sigblock (sigmask (p
->sig
));
7398 kbd_buffer_store_event (&buf
);
7401 while (p
->npending
> 0);
7409 static void menu_bar_item (Lisp_Object
, Lisp_Object
, Lisp_Object
, void*);
7410 static Lisp_Object menu_bar_one_keymap_changed_items
;
7412 /* These variables hold the vector under construction within
7413 menu_bar_items and its subroutines, and the current index
7414 for storing into that vector. */
7415 static Lisp_Object menu_bar_items_vector
;
7416 static int menu_bar_items_index
;
7419 static const char* separator_names
[] = {
7424 "single-dashed-line",
7425 "double-dashed-line",
7427 "shadow-etched-out",
7428 "shadow-etched-in-dash",
7429 "shadow-etched-out-dash",
7430 "shadow-double-etched-in",
7431 "shadow-double-etched-out",
7432 "shadow-double-etched-in-dash",
7433 "shadow-double-etched-out-dash",
7437 /* Return non-zero if LABEL specifies a separator. */
7440 menu_separator_name_p (const char *label
)
7444 else if (strlen (label
) > 3
7445 && memcmp (label
, "--", 2) == 0
7450 for (i
= 0; separator_names
[i
]; ++i
)
7451 if (strcmp (label
, separator_names
[i
]) == 0)
7456 /* It's a separator if it contains only dashes. */
7457 while (*label
== '-')
7459 return (*label
== 0);
7466 /* Return a vector of menu items for a menu bar, appropriate
7467 to the current buffer. Each item has three elements in the vector:
7470 OLD is an old vector we can optionally reuse, or nil. */
7473 menu_bar_items (Lisp_Object old
)
7475 /* The number of keymaps we're scanning right now, and the number of
7476 keymaps we have allocated space for. */
7479 /* maps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
7480 in the current keymaps, or nil where it is not a prefix. */
7483 Lisp_Object def
, tail
;
7488 /* In order to build the menus, we need to call the keymap
7489 accessors. They all call QUIT. But this function is called
7490 during redisplay, during which a quit is fatal. So inhibit
7491 quitting while building the menus.
7492 We do this instead of specbind because (1) errors will clear it anyway
7493 and (2) this avoids risk of specpdl overflow. */
7494 oquit
= Vinhibit_quit
;
7498 menu_bar_items_vector
= old
;
7500 menu_bar_items_vector
= Fmake_vector (make_number (24), Qnil
);
7501 menu_bar_items_index
= 0;
7503 /* Build our list of keymaps.
7504 If we recognize a function key and replace its escape sequence in
7505 keybuf with its symbol, or if the sequence starts with a mouse
7506 click and we need to switch buffers, we jump back here to rebuild
7507 the initial keymaps from the current buffer. */
7511 /* Should overriding-terminal-local-map and overriding-local-map apply? */
7512 if (!NILP (Voverriding_local_map_menu_flag
))
7514 /* Yes, use them (if non-nil) as well as the global map. */
7515 maps
= alloca (3 * sizeof (maps
[0]));
7517 if (!NILP (KVAR (current_kboard
, Voverriding_terminal_local_map
)))
7518 maps
[nmaps
++] = KVAR (current_kboard
, Voverriding_terminal_local_map
);
7519 if (!NILP (Voverriding_local_map
))
7520 maps
[nmaps
++] = Voverriding_local_map
;
7524 /* No, so use major and minor mode keymaps and keymap property.
7525 Note that menu-bar bindings in the local-map and keymap
7526 properties may not work reliable, as they are only
7527 recognized when the menu-bar (or mode-line) is updated,
7528 which does not normally happen after every command. */
7531 nminor
= current_minor_maps (NULL
, &tmaps
);
7532 maps
= alloca ((nminor
+ 3) * sizeof *maps
);
7534 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
7535 maps
[nmaps
++] = tem
;
7536 memcpy (maps
+ nmaps
, tmaps
, nminor
* sizeof (maps
[0]));
7538 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
7540 maps
[nmaps
++] = current_global_map
;
7543 /* Look up in each map the dummy prefix key `menu-bar'. */
7545 for (mapno
= nmaps
- 1; mapno
>= 0; mapno
--)
7546 if (!NILP (maps
[mapno
]))
7548 def
= get_keymap (access_keymap (maps
[mapno
], Qmenu_bar
, 1, 0, 1),
7552 menu_bar_one_keymap_changed_items
= Qnil
;
7553 map_keymap_canonical (def
, menu_bar_item
, Qnil
, NULL
);
7557 /* Move to the end those items that should be at the end. */
7559 for (tail
= Vmenu_bar_final_items
; CONSP (tail
); tail
= XCDR (tail
))
7562 int end
= menu_bar_items_index
;
7564 for (i
= 0; i
< end
; i
+= 4)
7565 if (EQ (XCAR (tail
), AREF (menu_bar_items_vector
, i
)))
7567 Lisp_Object tem0
, tem1
, tem2
, tem3
;
7568 /* Move the item at index I to the end,
7569 shifting all the others forward. */
7570 tem0
= AREF (menu_bar_items_vector
, i
+ 0);
7571 tem1
= AREF (menu_bar_items_vector
, i
+ 1);
7572 tem2
= AREF (menu_bar_items_vector
, i
+ 2);
7573 tem3
= AREF (menu_bar_items_vector
, i
+ 3);
7575 memmove (aref_addr (menu_bar_items_vector
, i
),
7576 aref_addr (menu_bar_items_vector
, i
+ 4),
7577 (end
- i
- 4) * word_size
);
7578 ASET (menu_bar_items_vector
, end
- 4, tem0
);
7579 ASET (menu_bar_items_vector
, end
- 3, tem1
);
7580 ASET (menu_bar_items_vector
, end
- 2, tem2
);
7581 ASET (menu_bar_items_vector
, end
- 1, tem3
);
7586 /* Add nil, nil, nil, nil at the end. */
7588 int i
= menu_bar_items_index
;
7589 if (i
+ 4 > ASIZE (menu_bar_items_vector
))
7590 menu_bar_items_vector
=
7591 larger_vector (menu_bar_items_vector
, 4, -1);
7592 /* Add this item. */
7593 ASET (menu_bar_items_vector
, i
, Qnil
); i
++;
7594 ASET (menu_bar_items_vector
, i
, Qnil
); i
++;
7595 ASET (menu_bar_items_vector
, i
, Qnil
); i
++;
7596 ASET (menu_bar_items_vector
, i
, Qnil
); i
++;
7597 menu_bar_items_index
= i
;
7600 Vinhibit_quit
= oquit
;
7601 return menu_bar_items_vector
;
7604 /* Add one item to menu_bar_items_vector, for KEY, ITEM_STRING and DEF.
7605 If there's already an item for KEY, add this DEF to it. */
7607 Lisp_Object item_properties
;
7610 menu_bar_item (Lisp_Object key
, Lisp_Object item
, Lisp_Object dummy1
, void *dummy2
)
7612 struct gcpro gcpro1
;
7616 if (EQ (item
, Qundefined
))
7618 /* If a map has an explicit `undefined' as definition,
7619 discard any previously made menu bar item. */
7621 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7622 if (EQ (key
, AREF (menu_bar_items_vector
, i
)))
7624 if (menu_bar_items_index
> i
+ 4)
7625 memmove (aref_addr (menu_bar_items_vector
, i
),
7626 aref_addr (menu_bar_items_vector
, i
+ 4),
7627 (menu_bar_items_index
- i
- 4) * word_size
);
7628 menu_bar_items_index
-= 4;
7632 /* If this keymap has already contributed to this KEY,
7633 don't contribute to it a second time. */
7634 tem
= Fmemq (key
, menu_bar_one_keymap_changed_items
);
7635 if (!NILP (tem
) || NILP (item
))
7638 menu_bar_one_keymap_changed_items
7639 = Fcons (key
, menu_bar_one_keymap_changed_items
);
7641 /* We add to menu_bar_one_keymap_changed_items before doing the
7642 parse_menu_item, so that if it turns out it wasn't a menu item,
7643 it still correctly hides any further menu item. */
7645 i
= parse_menu_item (item
, 1);
7650 item
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7652 /* Find any existing item for this KEY. */
7653 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7654 if (EQ (key
, AREF (menu_bar_items_vector
, i
)))
7657 /* If we did not find this KEY, add it at the end. */
7658 if (i
== menu_bar_items_index
)
7660 /* If vector is too small, get a bigger one. */
7661 if (i
+ 4 > ASIZE (menu_bar_items_vector
))
7662 menu_bar_items_vector
= larger_vector (menu_bar_items_vector
, 4, -1);
7663 /* Add this item. */
7664 ASET (menu_bar_items_vector
, i
, key
); i
++;
7665 ASET (menu_bar_items_vector
, i
,
7666 AREF (item_properties
, ITEM_PROPERTY_NAME
)); i
++;
7667 ASET (menu_bar_items_vector
, i
, Fcons (item
, Qnil
)); i
++;
7668 ASET (menu_bar_items_vector
, i
, make_number (0)); i
++;
7669 menu_bar_items_index
= i
;
7671 /* We did find an item for this KEY. Add ITEM to its list of maps. */
7675 old
= AREF (menu_bar_items_vector
, i
+ 2);
7676 /* If the new and the old items are not both keymaps,
7677 the lookup will only find `item'. */
7678 item
= Fcons (item
, KEYMAPP (item
) && KEYMAPP (XCAR (old
)) ? old
: Qnil
);
7679 ASET (menu_bar_items_vector
, i
+ 2, item
);
7683 /* This is used as the handler when calling menu_item_eval_property. */
7685 menu_item_eval_property_1 (Lisp_Object arg
)
7687 /* If we got a quit from within the menu computation,
7688 quit all the way out of it. This takes care of C-] in the debugger. */
7689 if (CONSP (arg
) && EQ (XCAR (arg
), Qquit
))
7690 Fsignal (Qquit
, Qnil
);
7696 eval_dyn (Lisp_Object form
)
7698 return Feval (form
, Qnil
);
7701 /* Evaluate an expression and return the result (or nil if something
7702 went wrong). Used to evaluate dynamic parts of menu items. */
7704 menu_item_eval_property (Lisp_Object sexpr
)
7706 ptrdiff_t count
= SPECPDL_INDEX ();
7708 specbind (Qinhibit_redisplay
, Qt
);
7709 val
= internal_condition_case_1 (eval_dyn
, sexpr
, Qerror
,
7710 menu_item_eval_property_1
);
7711 return unbind_to (count
, val
);
7714 /* This function parses a menu item and leaves the result in the
7715 vector item_properties.
7716 ITEM is a key binding, a possible menu item.
7717 INMENUBAR is > 0 when this is considered for an entry in a menu bar
7719 INMENUBAR is < 0 when this is considered for an entry in a keyboard menu.
7720 parse_menu_item returns true if the item is a menu item and false
7724 parse_menu_item (Lisp_Object item
, int inmenubar
)
7726 Lisp_Object def
, tem
, item_string
, start
;
7728 Lisp_Object keyhint
;
7737 /* Create item_properties vector if necessary. */
7738 if (NILP (item_properties
))
7740 = Fmake_vector (make_number (ITEM_PROPERTY_ENABLE
+ 1), Qnil
);
7742 /* Initialize optional entries. */
7743 for (i
= ITEM_PROPERTY_DEF
; i
< ITEM_PROPERTY_ENABLE
; i
++)
7744 ASET (item_properties
, i
, Qnil
);
7745 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7747 /* Save the item here to protect it from GC. */
7748 ASET (item_properties
, ITEM_PROPERTY_ITEM
, item
);
7750 item_string
= XCAR (item
);
7754 if (STRINGP (item_string
))
7756 /* Old format menu item. */
7757 ASET (item_properties
, ITEM_PROPERTY_NAME
, item_string
);
7759 /* Maybe help string. */
7760 if (CONSP (item
) && STRINGP (XCAR (item
)))
7762 ASET (item_properties
, ITEM_PROPERTY_HELP
, XCAR (item
));
7767 /* Maybe an obsolete key binding cache. */
7768 if (CONSP (item
) && CONSP (XCAR (item
))
7769 && (NILP (XCAR (XCAR (item
)))
7770 || VECTORP (XCAR (XCAR (item
)))))
7773 /* This is the real definition--the function to run. */
7774 ASET (item_properties
, ITEM_PROPERTY_DEF
, item
);
7776 /* Get enable property, if any. */
7779 tem
= Fget (item
, Qmenu_enable
);
7780 if (!NILP (Venable_disabled_menus_and_buttons
))
7781 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7782 else if (!NILP (tem
))
7783 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, tem
);
7786 else if (EQ (item_string
, Qmenu_item
) && CONSP (item
))
7788 /* New format menu item. */
7789 ASET (item_properties
, ITEM_PROPERTY_NAME
, XCAR (item
));
7790 start
= XCDR (item
);
7793 /* We have a real binding. */
7794 ASET (item_properties
, ITEM_PROPERTY_DEF
, XCAR (start
));
7796 item
= XCDR (start
);
7797 /* Is there an obsolete cache list with key equivalences. */
7798 if (CONSP (item
) && CONSP (XCAR (item
)))
7801 /* Parse properties. */
7802 while (CONSP (item
) && CONSP (XCDR (item
)))
7807 if (EQ (tem
, QCenable
))
7809 if (!NILP (Venable_disabled_menus_and_buttons
))
7810 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7812 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, XCAR (item
));
7814 else if (EQ (tem
, QCvisible
))
7816 /* If got a visible property and that evaluates to nil
7817 then ignore this item. */
7818 tem
= menu_item_eval_property (XCAR (item
));
7822 else if (EQ (tem
, QChelp
))
7823 ASET (item_properties
, ITEM_PROPERTY_HELP
, XCAR (item
));
7824 else if (EQ (tem
, QCfilter
))
7826 else if (EQ (tem
, QCkey_sequence
))
7829 if (SYMBOLP (tem
) || STRINGP (tem
) || VECTORP (tem
))
7830 /* Be GC protected. Set keyhint to item instead of tem. */
7833 else if (EQ (tem
, QCkeys
))
7836 if (CONSP (tem
) || STRINGP (tem
))
7837 ASET (item_properties
, ITEM_PROPERTY_KEYEQ
, tem
);
7839 else if (EQ (tem
, QCbutton
) && CONSP (XCAR (item
)))
7844 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
7846 ASET (item_properties
, ITEM_PROPERTY_SELECTED
,
7848 ASET (item_properties
, ITEM_PROPERTY_TYPE
, type
);
7854 else if (inmenubar
|| !NILP (start
))
7858 return 0; /* not a menu item */
7860 /* If item string is not a string, evaluate it to get string.
7861 If we don't get a string, skip this item. */
7862 item_string
= AREF (item_properties
, ITEM_PROPERTY_NAME
);
7863 if (!(STRINGP (item_string
)))
7865 item_string
= menu_item_eval_property (item_string
);
7866 if (!STRINGP (item_string
))
7868 ASET (item_properties
, ITEM_PROPERTY_NAME
, item_string
);
7871 /* If got a filter apply it on definition. */
7872 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7875 def
= menu_item_eval_property (list2 (XCAR (filter
),
7876 list2 (Qquote
, def
)));
7878 ASET (item_properties
, ITEM_PROPERTY_DEF
, def
);
7881 /* Enable or disable selection of item. */
7882 tem
= AREF (item_properties
, ITEM_PROPERTY_ENABLE
);
7885 tem
= menu_item_eval_property (tem
);
7886 if (inmenubar
&& NILP (tem
))
7887 return 0; /* Ignore disabled items in menu bar. */
7888 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, tem
);
7891 /* If we got no definition, this item is just unselectable text which
7892 is OK in a submenu but not in the menubar. */
7894 return (!inmenubar
);
7896 /* See if this is a separate pane or a submenu. */
7897 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7898 tem
= get_keymap (def
, 0, 1);
7899 /* For a subkeymap, just record its details and exit. */
7902 ASET (item_properties
, ITEM_PROPERTY_MAP
, tem
);
7903 ASET (item_properties
, ITEM_PROPERTY_DEF
, tem
);
7907 /* At the top level in the menu bar, do likewise for commands also.
7908 The menu bar does not display equivalent key bindings anyway.
7909 ITEM_PROPERTY_DEF is already set up properly. */
7913 { /* This is a command. See if there is an equivalent key binding. */
7914 Lisp_Object keyeq
= AREF (item_properties
, ITEM_PROPERTY_KEYEQ
);
7916 /* The previous code preferred :key-sequence to :keys, so we
7917 preserve this behavior. */
7918 if (STRINGP (keyeq
) && !CONSP (keyhint
))
7919 keyeq
= concat2 (build_string (" "), Fsubstitute_command_keys (keyeq
));
7922 Lisp_Object prefix
= keyeq
;
7923 Lisp_Object keys
= Qnil
;
7927 def
= XCAR (prefix
);
7928 prefix
= XCDR (prefix
);
7931 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7933 if (CONSP (keyhint
) && !NILP (XCAR (keyhint
)))
7935 keys
= XCAR (keyhint
);
7936 tem
= Fkey_binding (keys
, Qnil
, Qnil
, Qnil
);
7938 /* We have a suggested key. Is it bound to the command? */
7941 /* If the command is an alias for another
7942 (such as lmenu.el set it up), check if the
7943 original command matches the cached command. */
7945 && EQ (tem
, XSYMBOL (def
)->function
))))
7950 keys
= Fwhere_is_internal (def
, Qnil
, Qt
, Qnil
, Qnil
);
7954 tem
= Fkey_description (keys
, Qnil
);
7957 if (STRINGP (XCAR (prefix
)))
7958 tem
= concat2 (XCAR (prefix
), tem
);
7959 if (STRINGP (XCDR (prefix
)))
7960 tem
= concat2 (tem
, XCDR (prefix
));
7962 keyeq
= concat2 (build_string (" "), tem
);
7963 /* keyeq = concat3(build_string(" ("),tem,build_string(")")); */
7969 /* If we have an equivalent key binding, use that. */
7970 ASET (item_properties
, ITEM_PROPERTY_KEYEQ
, keyeq
);
7973 /* Include this when menu help is implemented.
7974 tem = XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP];
7975 if (!(NILP (tem) || STRINGP (tem)))
7977 tem = menu_item_eval_property (tem);
7980 XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP] = tem;
7984 /* Handle radio buttons or toggle boxes. */
7985 tem
= AREF (item_properties
, ITEM_PROPERTY_SELECTED
);
7987 ASET (item_properties
, ITEM_PROPERTY_SELECTED
,
7988 menu_item_eval_property (tem
));
7995 /***********************************************************************
7997 ***********************************************************************/
7999 /* A vector holding tool bar items while they are parsed in function
8000 tool_bar_items. Each item occupies TOOL_BAR_ITEM_NSCLOTS elements
8003 static Lisp_Object tool_bar_items_vector
;
8005 /* A vector holding the result of parse_tool_bar_item. Layout is like
8006 the one for a single item in tool_bar_items_vector. */
8008 static Lisp_Object tool_bar_item_properties
;
8010 /* Next free index in tool_bar_items_vector. */
8012 static int ntool_bar_items
;
8014 /* The symbols `:image' and `:rtl'. */
8016 static Lisp_Object QCimage
;
8017 static Lisp_Object QCrtl
;
8019 /* Function prototypes. */
8021 static void init_tool_bar_items (Lisp_Object
);
8022 static void process_tool_bar_item (Lisp_Object
, Lisp_Object
, Lisp_Object
, void*);
8023 static int parse_tool_bar_item (Lisp_Object
, Lisp_Object
);
8024 static void append_tool_bar_item (void);
8027 /* Return a vector of tool bar items for keymaps currently in effect.
8028 Reuse vector REUSE if non-nil. Return in *NITEMS the number of
8029 tool bar items found. */
8032 tool_bar_items (Lisp_Object reuse
, int *nitems
)
8041 /* In order to build the menus, we need to call the keymap
8042 accessors. They all call QUIT. But this function is called
8043 during redisplay, during which a quit is fatal. So inhibit
8044 quitting while building the menus. We do this instead of
8045 specbind because (1) errors will clear it anyway and (2) this
8046 avoids risk of specpdl overflow. */
8047 oquit
= Vinhibit_quit
;
8050 /* Initialize tool_bar_items_vector and protect it from GC. */
8051 init_tool_bar_items (reuse
);
8053 /* Build list of keymaps in maps. Set nmaps to the number of maps
8056 /* Should overriding-terminal-local-map and overriding-local-map apply? */
8057 if (!NILP (Voverriding_local_map_menu_flag
))
8059 /* Yes, use them (if non-nil) as well as the global map. */
8060 maps
= alloca (3 * sizeof *maps
);
8062 if (!NILP (KVAR (current_kboard
, Voverriding_terminal_local_map
)))
8063 maps
[nmaps
++] = KVAR (current_kboard
, Voverriding_terminal_local_map
);
8064 if (!NILP (Voverriding_local_map
))
8065 maps
[nmaps
++] = Voverriding_local_map
;
8069 /* No, so use major and minor mode keymaps and keymap property.
8070 Note that tool-bar bindings in the local-map and keymap
8071 properties may not work reliable, as they are only
8072 recognized when the tool-bar (or mode-line) is updated,
8073 which does not normally happen after every command. */
8076 nminor
= current_minor_maps (NULL
, &tmaps
);
8077 maps
= alloca ((nminor
+ 3) * sizeof *maps
);
8079 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
8080 maps
[nmaps
++] = tem
;
8081 memcpy (maps
+ nmaps
, tmaps
, nminor
* sizeof (maps
[0]));
8083 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
8086 /* Add global keymap at the end. */
8087 maps
[nmaps
++] = current_global_map
;
8089 /* Process maps in reverse order and look up in each map the prefix
8091 for (i
= nmaps
- 1; i
>= 0; --i
)
8092 if (!NILP (maps
[i
]))
8096 keymap
= get_keymap (access_keymap (maps
[i
], Qtool_bar
, 1, 0, 1), 0, 1);
8098 map_keymap (keymap
, process_tool_bar_item
, Qnil
, NULL
, 1);
8101 Vinhibit_quit
= oquit
;
8102 *nitems
= ntool_bar_items
/ TOOL_BAR_ITEM_NSLOTS
;
8103 return tool_bar_items_vector
;
8107 /* Process the definition of KEY which is DEF. */
8110 process_tool_bar_item (Lisp_Object key
, Lisp_Object def
, Lisp_Object data
, void *args
)
8113 struct gcpro gcpro1
, gcpro2
;
8115 /* Protect KEY and DEF from GC because parse_tool_bar_item may call
8119 if (EQ (def
, Qundefined
))
8121 /* If a map has an explicit `undefined' as definition,
8122 discard any previously made item. */
8123 for (i
= 0; i
< ntool_bar_items
; i
+= TOOL_BAR_ITEM_NSLOTS
)
8125 Lisp_Object
*v
= XVECTOR (tool_bar_items_vector
)->contents
+ i
;
8127 if (EQ (key
, v
[TOOL_BAR_ITEM_KEY
]))
8129 if (ntool_bar_items
> i
+ TOOL_BAR_ITEM_NSLOTS
)
8130 memmove (v
, v
+ TOOL_BAR_ITEM_NSLOTS
,
8131 ((ntool_bar_items
- i
- TOOL_BAR_ITEM_NSLOTS
)
8133 ntool_bar_items
-= TOOL_BAR_ITEM_NSLOTS
;
8138 else if (parse_tool_bar_item (key
, def
))
8139 /* Append a new tool bar item to tool_bar_items_vector. Accept
8140 more than one definition for the same key. */
8141 append_tool_bar_item ();
8146 /* Access slot with index IDX of vector tool_bar_item_properties. */
8147 #define PROP(IDX) AREF (tool_bar_item_properties, (IDX))
8149 set_prop (ptrdiff_t idx
, Lisp_Object val
)
8151 ASET (tool_bar_item_properties
, idx
, val
);
8155 /* Parse a tool bar item specification ITEM for key KEY and return the
8156 result in tool_bar_item_properties. Value is zero if ITEM is
8159 ITEM is a list `(menu-item CAPTION BINDING PROPS...)'.
8161 CAPTION is the caption of the item, If it's not a string, it is
8162 evaluated to get a string.
8164 BINDING is the tool bar item's binding. Tool-bar items with keymaps
8165 as binding are currently ignored.
8167 The following properties are recognized:
8171 FORM is evaluated and specifies whether the tool bar item is
8172 enabled or disabled.
8176 FORM is evaluated and specifies whether the tool bar item is visible.
8178 - `:filter FUNCTION'
8180 FUNCTION is invoked with one parameter `(quote BINDING)'. Its
8181 result is stored as the new binding.
8183 - `:button (TYPE SELECTED)'
8185 TYPE must be one of `:radio' or `:toggle'. SELECTED is evaluated
8186 and specifies whether the button is selected (pressed) or not.
8190 IMAGES is either a single image specification or a vector of four
8191 image specifications. See enum tool_bar_item_images.
8193 - `:help HELP-STRING'.
8195 Gives a help string to display for the tool bar item.
8197 - `:label LABEL-STRING'.
8199 A text label to show with the tool bar button if labels are enabled. */
8202 parse_tool_bar_item (Lisp_Object key
, Lisp_Object item
)
8204 Lisp_Object filter
= Qnil
;
8205 Lisp_Object caption
;
8206 int i
, have_label
= 0;
8208 /* Definition looks like `(menu-item CAPTION BINDING PROPS...)'.
8209 Rule out items that aren't lists, don't start with
8210 `menu-item' or whose rest following `tool-bar-item' is not a
8215 /* As an exception, allow old-style menu separators. */
8216 if (STRINGP (XCAR (item
)))
8217 item
= Fcons (XCAR (item
), Qnil
);
8218 else if (!EQ (XCAR (item
), Qmenu_item
)
8219 || (item
= XCDR (item
), !CONSP (item
)))
8222 /* Create tool_bar_item_properties vector if necessary. Reset it to
8224 if (VECTORP (tool_bar_item_properties
))
8226 for (i
= 0; i
< TOOL_BAR_ITEM_NSLOTS
; ++i
)
8230 tool_bar_item_properties
8231 = Fmake_vector (make_number (TOOL_BAR_ITEM_NSLOTS
), Qnil
);
8234 set_prop (TOOL_BAR_ITEM_KEY
, key
);
8235 set_prop (TOOL_BAR_ITEM_ENABLED_P
, Qt
);
8237 /* Get the caption of the item. If the caption is not a string,
8238 evaluate it to get a string. If we don't get a string, skip this
8240 caption
= XCAR (item
);
8241 if (!STRINGP (caption
))
8243 caption
= menu_item_eval_property (caption
);
8244 if (!STRINGP (caption
))
8247 set_prop (TOOL_BAR_ITEM_CAPTION
, caption
);
8249 /* If the rest following the caption is not a list, the menu item is
8250 either a separator, or invalid. */
8254 if (menu_separator_name_p (SSDATA (caption
)))
8256 set_prop (TOOL_BAR_ITEM_TYPE
, Qt
);
8257 #if !defined (USE_GTK) && !defined (HAVE_NS)
8258 /* If we use build_desired_tool_bar_string to render the
8259 tool bar, the separator is rendered as an image. */
8260 PROP (TOOL_BAR_ITEM_IMAGES
)
8261 = menu_item_eval_property (Vtool_bar_separator_image_expression
);
8262 PROP (TOOL_BAR_ITEM_ENABLED_P
) = Qnil
;
8263 PROP (TOOL_BAR_ITEM_SELECTED_P
) = Qnil
;
8264 PROP (TOOL_BAR_ITEM_CAPTION
) = Qnil
;
8271 /* Store the binding. */
8272 set_prop (TOOL_BAR_ITEM_BINDING
, XCAR (item
));
8275 /* Ignore cached key binding, if any. */
8276 if (CONSP (item
) && CONSP (XCAR (item
)))
8279 /* Process the rest of the properties. */
8280 for (; CONSP (item
) && CONSP (XCDR (item
)); item
= XCDR (XCDR (item
)))
8282 Lisp_Object ikey
, value
;
8285 value
= XCAR (XCDR (item
));
8287 if (EQ (ikey
, QCenable
))
8289 /* `:enable FORM'. */
8290 if (!NILP (Venable_disabled_menus_and_buttons
))
8291 set_prop (TOOL_BAR_ITEM_ENABLED_P
, Qt
);
8293 set_prop (TOOL_BAR_ITEM_ENABLED_P
, value
);
8295 else if (EQ (ikey
, QCvisible
))
8297 /* `:visible FORM'. If got a visible property and that
8298 evaluates to nil then ignore this item. */
8299 if (NILP (menu_item_eval_property (value
)))
8302 else if (EQ (ikey
, QChelp
))
8303 /* `:help HELP-STRING'. */
8304 set_prop (TOOL_BAR_ITEM_HELP
, value
);
8305 else if (EQ (ikey
, QCvert_only
))
8306 /* `:vert-only t/nil'. */
8307 set_prop (TOOL_BAR_ITEM_VERT_ONLY
, value
);
8308 else if (EQ (ikey
, QClabel
))
8310 const char *bad_label
= "!!?GARBLED ITEM?!!";
8311 /* `:label LABEL-STRING'. */
8312 set_prop (TOOL_BAR_ITEM_LABEL
,
8313 STRINGP (value
) ? value
: build_string (bad_label
));
8316 else if (EQ (ikey
, QCfilter
))
8317 /* ':filter FORM'. */
8319 else if (EQ (ikey
, QCbutton
) && CONSP (value
))
8321 /* `:button (TYPE . SELECTED)'. */
8322 Lisp_Object type
, selected
;
8324 type
= XCAR (value
);
8325 selected
= XCDR (value
);
8326 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
8328 set_prop (TOOL_BAR_ITEM_SELECTED_P
, selected
);
8329 set_prop (TOOL_BAR_ITEM_TYPE
, type
);
8332 else if (EQ (ikey
, QCimage
)
8334 || (VECTORP (value
) && ASIZE (value
) == 4)))
8335 /* Value is either a single image specification or a vector
8336 of 4 such specifications for the different button states. */
8337 set_prop (TOOL_BAR_ITEM_IMAGES
, value
);
8338 else if (EQ (ikey
, QCrtl
))
8340 set_prop (TOOL_BAR_ITEM_RTL_IMAGE
, value
);
8346 /* Try to make one from caption and key. */
8347 Lisp_Object tkey
= PROP (TOOL_BAR_ITEM_KEY
);
8348 Lisp_Object tcapt
= PROP (TOOL_BAR_ITEM_CAPTION
);
8349 const char *label
= SYMBOLP (tkey
) ? SSDATA (SYMBOL_NAME (tkey
)) : "";
8350 const char *capt
= STRINGP (tcapt
) ? SSDATA (tcapt
) : "";
8352 2 * max (0, min (tool_bar_max_label_size
, STRING_BYTES_BOUND
/ 2));
8353 char *buf
= xmalloc (max_lbl
+ 1);
8354 Lisp_Object new_lbl
;
8355 ptrdiff_t caption_len
= strlen (capt
);
8357 if (caption_len
<= max_lbl
&& capt
[0] != '\0')
8360 while (caption_len
> 0 && buf
[caption_len
- 1] == '.')
8362 buf
[caption_len
] = '\0';
8366 if (strlen (label
) <= max_lbl
&& label
[0] != '\0')
8370 strcpy (buf
, label
);
8372 for (j
= 0; buf
[j
] != '\0'; ++j
)
8380 new_lbl
= Fupcase_initials (build_string (label
));
8381 if (SCHARS (new_lbl
) <= tool_bar_max_label_size
)
8382 set_prop (TOOL_BAR_ITEM_LABEL
, new_lbl
);
8384 set_prop (TOOL_BAR_ITEM_LABEL
, empty_unibyte_string
);
8388 /* If got a filter apply it on binding. */
8390 set_prop (TOOL_BAR_ITEM_BINDING
,
8391 (menu_item_eval_property
8394 PROP (TOOL_BAR_ITEM_BINDING
))))));
8396 /* See if the binding is a keymap. Give up if it is. */
8397 if (CONSP (get_keymap (PROP (TOOL_BAR_ITEM_BINDING
), 0, 1)))
8400 /* Enable or disable selection of item. */
8401 if (!EQ (PROP (TOOL_BAR_ITEM_ENABLED_P
), Qt
))
8402 set_prop (TOOL_BAR_ITEM_ENABLED_P
,
8403 menu_item_eval_property (PROP (TOOL_BAR_ITEM_ENABLED_P
)));
8405 /* Handle radio buttons or toggle boxes. */
8406 if (!NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
)))
8407 set_prop (TOOL_BAR_ITEM_SELECTED_P
,
8408 menu_item_eval_property (PROP (TOOL_BAR_ITEM_SELECTED_P
)));
8416 /* Initialize tool_bar_items_vector. REUSE, if non-nil, is a vector
8417 that can be reused. */
8420 init_tool_bar_items (Lisp_Object reuse
)
8422 if (VECTORP (reuse
))
8423 tool_bar_items_vector
= reuse
;
8425 tool_bar_items_vector
= Fmake_vector (make_number (64), Qnil
);
8426 ntool_bar_items
= 0;
8430 /* Append parsed tool bar item properties from
8431 tool_bar_item_properties */
8434 append_tool_bar_item (void)
8438 - (ASIZE (tool_bar_items_vector
) - TOOL_BAR_ITEM_NSLOTS
));
8440 /* Enlarge tool_bar_items_vector if necessary. */
8442 tool_bar_items_vector
8443 = larger_vector (tool_bar_items_vector
, incr
, -1);
8445 /* Append entries from tool_bar_item_properties to the end of
8446 tool_bar_items_vector. */
8447 vcopy (tool_bar_items_vector
, ntool_bar_items
,
8448 XVECTOR (tool_bar_item_properties
)->contents
, TOOL_BAR_ITEM_NSLOTS
);
8449 ntool_bar_items
+= TOOL_BAR_ITEM_NSLOTS
;
8456 /* Read a character using menus based on maps in the array MAPS.
8457 NMAPS is the length of MAPS. Return nil if there are no menus in the maps.
8458 Return t if we displayed a menu but the user rejected it.
8460 PREV_EVENT is the previous input event, or nil if we are reading
8461 the first event of a key sequence.
8463 If USED_MOUSE_MENU is non-null, then we set *USED_MOUSE_MENU to 1
8464 if we used a mouse menu to read the input, or zero otherwise. If
8465 USED_MOUSE_MENU is null, we don't dereference it.
8467 The prompting is done based on the prompt-string of the map
8468 and the strings associated with various map elements.
8470 This can be done with X menus or with menus put in the minibuf.
8471 These are done in different ways, depending on how the input will be read.
8472 Menus using X are done after auto-saving in read-char, getting the input
8473 event from Fx_popup_menu; menus using the minibuf use read_char recursively
8474 and do auto-saving in the inner call of read_char. */
8477 read_char_x_menu_prompt (ptrdiff_t nmaps
, Lisp_Object
*maps
,
8478 Lisp_Object prev_event
, int *used_mouse_menu
)
8484 if (used_mouse_menu
)
8485 *used_mouse_menu
= 0;
8487 /* Use local over global Menu maps */
8489 if (! menu_prompting
)
8492 /* Optionally disregard all but the global map. */
8493 if (inhibit_local_menu_bar_menus
)
8495 maps
+= (nmaps
- 1);
8500 /* If we got to this point via a mouse click,
8501 use a real menu for mouse selection. */
8502 if (EVENT_HAS_PARAMETERS (prev_event
)
8503 && !EQ (XCAR (prev_event
), Qmenu_bar
)
8504 && !EQ (XCAR (prev_event
), Qtool_bar
))
8506 /* Display the menu and get the selection. */
8507 Lisp_Object
*realmaps
= alloca (nmaps
* sizeof *realmaps
);
8509 ptrdiff_t nmaps1
= 0;
8511 /* Use the maps that are not nil. */
8512 for (mapno
= 0; mapno
< nmaps
; mapno
++)
8513 if (!NILP (maps
[mapno
]))
8514 realmaps
[nmaps1
++] = maps
[mapno
];
8516 value
= Fx_popup_menu (prev_event
, Flist (nmaps1
, realmaps
));
8521 record_menu_key (XCAR (value
));
8523 /* If we got multiple events, unread all but
8525 There is no way to prevent those unread events
8526 from showing up later in last_nonmenu_event.
8527 So turn symbol and integer events into lists,
8528 to indicate that they came from a mouse menu,
8529 so that when present in last_nonmenu_event
8530 they won't confuse things. */
8531 for (tem
= XCDR (value
); CONSP (tem
); tem
= XCDR (tem
))
8533 record_menu_key (XCAR (tem
));
8534 if (SYMBOLP (XCAR (tem
))
8535 || INTEGERP (XCAR (tem
)))
8536 XSETCAR (tem
, Fcons (XCAR (tem
), Qdisabled
));
8539 /* If we got more than one event, put all but the first
8540 onto this list to be read later.
8541 Return just the first event now. */
8542 Vunread_command_events
8543 = nconc2 (XCDR (value
), Vunread_command_events
);
8544 value
= XCAR (value
);
8546 else if (NILP (value
))
8548 if (used_mouse_menu
)
8549 *used_mouse_menu
= 1;
8552 #endif /* HAVE_MENUS */
8556 /* Buffer in use so far for the minibuf prompts for menu keymaps.
8557 We make this bigger when necessary, and never free it. */
8558 static char *read_char_minibuf_menu_text
;
8559 /* Size of that buffer. */
8560 static ptrdiff_t read_char_minibuf_menu_width
;
8563 read_char_minibuf_menu_prompt (int commandflag
,
8564 ptrdiff_t nmaps
, Lisp_Object
*maps
)
8567 register Lisp_Object name
;
8569 /* FIXME: Use the minibuffer's frame width. */
8570 ptrdiff_t width
= FRAME_COLS (SELECTED_FRAME ()) - 4;
8573 Lisp_Object rest
, vector
;
8579 if (! menu_prompting
)
8582 /* Get the menu name from the first map that has one (a prompt string). */
8583 for (mapno
= 0; mapno
< nmaps
; mapno
++)
8585 name
= Fkeymap_prompt (maps
[mapno
]);
8590 /* If we don't have any menus, just read a character normally. */
8591 if (!STRINGP (name
))
8594 /* Make sure we have a big enough buffer for the menu text. */
8595 width
= max (width
, SBYTES (name
));
8596 if (STRING_BYTES_BOUND
- 4 < width
)
8597 memory_full (SIZE_MAX
);
8598 if (width
+ 4 > read_char_minibuf_menu_width
)
8600 read_char_minibuf_menu_text
8601 = xrealloc (read_char_minibuf_menu_text
, width
+ 4);
8602 read_char_minibuf_menu_width
= width
+ 4;
8604 menu
= read_char_minibuf_menu_text
;
8606 /* Prompt string always starts with map's prompt, and a space. */
8607 strcpy (menu
, SSDATA (name
));
8608 nlength
= SBYTES (name
);
8609 menu
[nlength
++] = ':';
8610 menu
[nlength
++] = ' ';
8613 /* Start prompting at start of first map. */
8617 /* Present the documented bindings, a line at a time. */
8621 ptrdiff_t i
= nlength
;
8623 Lisp_Object orig_defn_macro
;
8625 /* Loop over elements of map. */
8630 /* If reached end of map, start at beginning of next map. */
8634 /* At end of last map, wrap around to first map if just starting,
8635 or end this line if already have something on it. */
8639 if (notfirst
|| nobindings
) break;
8644 /* Look at the next element of the map. */
8646 elt
= AREF (vector
, idx
);
8648 elt
= Fcar_safe (rest
);
8650 if (idx
< 0 && VECTORP (elt
))
8652 /* If we found a dense table in the keymap,
8653 advanced past it, but start scanning its contents. */
8654 rest
= Fcdr_safe (rest
);
8660 /* An ordinary element. */
8661 Lisp_Object event
, tem
;
8665 event
= Fcar_safe (elt
); /* alist */
8666 elt
= Fcdr_safe (elt
);
8670 XSETINT (event
, idx
); /* vector */
8673 /* Ignore the element if it has no prompt string. */
8674 if (INTEGERP (event
) && parse_menu_item (elt
, -1))
8676 /* 1 if the char to type matches the string. */
8678 Lisp_Object upcased_event
, downcased_event
;
8679 Lisp_Object desc
= Qnil
;
8681 = AREF (item_properties
, ITEM_PROPERTY_NAME
);
8683 upcased_event
= Fupcase (event
);
8684 downcased_event
= Fdowncase (event
);
8685 char_matches
= (XINT (upcased_event
) == SREF (s
, 0)
8686 || XINT (downcased_event
) == SREF (s
, 0));
8688 desc
= Fsingle_key_description (event
, Qnil
);
8690 #if 0 /* It is redundant to list the equivalent key bindings because
8691 the prefix is what the user has already typed. */
8693 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_KEYEQ
];
8695 /* Insert equivalent keybinding. */
8696 s
= concat2 (s
, tem
);
8699 = AREF (item_properties
, ITEM_PROPERTY_TYPE
);
8700 if (EQ (tem
, QCradio
) || EQ (tem
, QCtoggle
))
8702 /* Insert button prefix. */
8703 Lisp_Object selected
8704 = AREF (item_properties
, ITEM_PROPERTY_SELECTED
);
8705 if (EQ (tem
, QCradio
))
8706 tem
= build_string (NILP (selected
) ? "(*) " : "( ) ");
8708 tem
= build_string (NILP (selected
) ? "[X] " : "[ ] ");
8709 s
= concat2 (tem
, s
);
8713 /* If we have room for the prompt string, add it to this line.
8714 If this is the first on the line, always add it. */
8715 if ((SCHARS (s
) + i
+ 2
8716 + (char_matches
? 0 : SCHARS (desc
) + 3))
8720 ptrdiff_t thiswidth
;
8722 /* Punctuate between strings. */
8725 strcpy (menu
+ i
, ", ");
8731 /* If the char to type doesn't match the string's
8732 first char, explicitly show what char to type. */
8735 /* Add as much of string as fits. */
8736 thiswidth
= min (SCHARS (desc
), width
- i
);
8737 memcpy (menu
+ i
, SDATA (desc
), thiswidth
);
8739 strcpy (menu
+ i
, " = ");
8743 /* Add as much of string as fits. */
8744 thiswidth
= min (SCHARS (s
), width
- i
);
8745 memcpy (menu
+ i
, SDATA (s
), thiswidth
);
8751 /* If this element does not fit, end the line now,
8752 and save the element for the next line. */
8753 strcpy (menu
+ i
, "...");
8758 /* Move past this element. */
8759 if (idx
>= 0 && idx
+ 1 >= ASIZE (vector
))
8760 /* Handle reaching end of dense table. */
8765 rest
= Fcdr_safe (rest
);
8769 /* Prompt with that and read response. */
8770 message2_nolog (menu
, strlen (menu
),
8771 ! NILP (BVAR (current_buffer
, enable_multibyte_characters
)));
8773 /* Make believe its not a keyboard macro in case the help char
8774 is pressed. Help characters are not recorded because menu prompting
8775 is not used on replay.
8777 orig_defn_macro
= KVAR (current_kboard
, defining_kbd_macro
);
8778 kset_defining_kbd_macro (current_kboard
, Qnil
);
8780 obj
= read_char (commandflag
, 0, 0, Qt
, 0, NULL
);
8781 while (BUFFERP (obj
));
8782 kset_defining_kbd_macro (current_kboard
, orig_defn_macro
);
8784 if (!INTEGERP (obj
))
8786 else if (XINT (obj
) == -2)
8789 if (! EQ (obj
, menu_prompt_more_char
)
8790 && (!INTEGERP (menu_prompt_more_char
)
8791 || ! EQ (obj
, make_number (Ctl (XINT (menu_prompt_more_char
))))))
8793 if (!NILP (KVAR (current_kboard
, defining_kbd_macro
)))
8794 store_kbd_macro_char (obj
);
8797 /* Help char - go round again */
8801 /* Reading key sequences. */
8803 /* Follow KEY in the maps in CURRENT[0..NMAPS-1], placing its bindings
8804 in DEFS[0..NMAPS-1]. Set NEXT[i] to DEFS[i] if DEFS[i] is a
8805 keymap, or nil otherwise. Return the index of the first keymap in
8806 which KEY has any binding, or NMAPS if no map has a binding.
8808 If KEY is a meta ASCII character, treat it like meta-prefix-char
8809 followed by the corresponding non-meta character. Keymaps in
8810 CURRENT with non-prefix bindings for meta-prefix-char become nil in
8813 If KEY has no bindings in any of the CURRENT maps, NEXT is left
8816 NEXT may be the same array as CURRENT. */
8819 follow_key (Lisp_Object key
, ptrdiff_t nmaps
, Lisp_Object
*current
,
8820 Lisp_Object
*defs
, Lisp_Object
*next
)
8822 ptrdiff_t i
, first_binding
;
8824 first_binding
= nmaps
;
8825 for (i
= nmaps
- 1; i
>= 0; i
--)
8827 if (! NILP (current
[i
]))
8829 defs
[i
] = access_keymap (current
[i
], key
, 1, 0, 1);
8830 if (! NILP (defs
[i
]))
8837 /* Given the set of bindings we've found, produce the next set of maps. */
8838 if (first_binding
< nmaps
)
8839 for (i
= 0; i
< nmaps
; i
++)
8840 next
[i
] = NILP (defs
[i
]) ? Qnil
: get_keymap (defs
[i
], 0, 1);
8842 return first_binding
;
8845 /* Structure used to keep track of partial application of key remapping
8846 such as Vfunction_key_map and Vkey_translation_map. */
8847 typedef struct keyremap
8849 /* This is the map originally specified for this use. */
8851 /* This is a submap reached by looking up, in PARENT,
8852 the events from START to END. */
8854 /* Positions [START, END) in the key sequence buffer
8855 are the key that we have scanned so far.
8856 Those events are the ones that we will replace
8857 if PARENT maps them into a key sequence. */
8861 /* Lookup KEY in MAP.
8862 MAP is a keymap mapping keys to key vectors or functions.
8863 If the mapping is a function and DO_FUNCTION is non-zero, then
8864 the function is called with PROMPT as parameter and its return
8865 value is used as the return value of this function (after checking
8866 that it is indeed a vector). */
8869 access_keymap_keyremap (Lisp_Object map
, Lisp_Object key
, Lisp_Object prompt
,
8874 next
= access_keymap (map
, key
, 1, 0, 1);
8876 /* Handle a symbol whose function definition is a keymap
8878 if (SYMBOLP (next
) && !NILP (Ffboundp (next
))
8879 && (ARRAYP (XSYMBOL (next
)->function
)
8880 || KEYMAPP (XSYMBOL (next
)->function
)))
8881 next
= Fautoload_do_load (XSYMBOL (next
)->function
, next
, Qnil
);
8883 /* If the keymap gives a function, not an
8884 array, then call the function with one arg and use
8885 its value instead. */
8886 if (do_funcall
&& FUNCTIONP (next
))
8891 next
= call1 (next
, prompt
);
8892 /* If the function returned something invalid,
8893 barf--don't ignore it.
8894 (To ignore it safely, we would need to gcpro a bunch of
8895 other variables.) */
8896 if (! (VECTORP (next
) || STRINGP (next
)))
8897 error ("Function %s returns invalid key sequence",
8898 SSDATA (SYMBOL_NAME (tem
)));
8903 /* Do one step of the key remapping used for function-key-map and
8904 key-translation-map:
8905 KEYBUF is the buffer holding the input events.
8906 BUFSIZE is its maximum size.
8907 FKEY is a pointer to the keyremap structure to use.
8908 INPUT is the index of the last element in KEYBUF.
8909 DOIT if non-zero says that the remapping can actually take place.
8910 DIFF is used to return the number of keys added/removed by the remapping.
8911 PARENT is the root of the keymap.
8912 PROMPT is the prompt to use if the remapping happens through a function.
8913 The return value is non-zero if the remapping actually took place. */
8916 keyremap_step (Lisp_Object
*keybuf
, int bufsize
, volatile keyremap
*fkey
,
8917 int input
, int doit
, int *diff
, Lisp_Object prompt
)
8919 Lisp_Object next
, key
;
8921 key
= keybuf
[fkey
->end
++];
8923 if (KEYMAPP (fkey
->parent
))
8924 next
= access_keymap_keyremap (fkey
->map
, key
, prompt
, doit
);
8928 /* If keybuf[fkey->start..fkey->end] is bound in the
8929 map and we're in a position to do the key remapping, replace it with
8930 the binding and restart with fkey->start at the end. */
8931 if ((VECTORP (next
) || STRINGP (next
)) && doit
)
8933 int len
= XFASTINT (Flength (next
));
8936 *diff
= len
- (fkey
->end
- fkey
->start
);
8938 if (bufsize
- input
<= *diff
)
8939 error ("Key sequence too long");
8941 /* Shift the keys that follow fkey->end. */
8943 for (i
= fkey
->end
; i
< input
; i
++)
8944 keybuf
[i
+ *diff
] = keybuf
[i
];
8946 for (i
= input
- 1; i
>= fkey
->end
; i
--)
8947 keybuf
[i
+ *diff
] = keybuf
[i
];
8948 /* Overwrite the old keys with the new ones. */
8949 for (i
= 0; i
< len
; i
++)
8950 keybuf
[fkey
->start
+ i
]
8951 = Faref (next
, make_number (i
));
8953 fkey
->start
= fkey
->end
+= *diff
;
8954 fkey
->map
= fkey
->parent
;
8959 fkey
->map
= get_keymap (next
, 0, 1);
8961 /* If we no longer have a bound suffix, try a new position for
8963 if (!CONSP (fkey
->map
))
8965 fkey
->end
= ++fkey
->start
;
8966 fkey
->map
= fkey
->parent
;
8972 test_undefined (Lisp_Object binding
)
8974 return (EQ (binding
, Qundefined
)
8975 || (!NILP (binding
) && SYMBOLP (binding
)
8976 && EQ (Fcommand_remapping (binding
, Qnil
, Qnil
), Qundefined
)));
8979 /* Read a sequence of keys that ends with a non prefix character,
8980 storing it in KEYBUF, a buffer of size BUFSIZE.
8982 Return the length of the key sequence stored.
8983 Return -1 if the user rejected a command menu.
8985 Echo starting immediately unless `prompt' is 0.
8987 Where a key sequence ends depends on the currently active keymaps.
8988 These include any minor mode keymaps active in the current buffer,
8989 the current buffer's local map, and the global map.
8991 If a key sequence has no other bindings, we check Vfunction_key_map
8992 to see if some trailing subsequence might be the beginning of a
8993 function key's sequence. If so, we try to read the whole function
8994 key, and substitute its symbolic name into the key sequence.
8996 We ignore unbound `down-' mouse clicks. We turn unbound `drag-' and
8997 `double-' events into similar click events, if that would make them
8998 bound. We try to turn `triple-' events first into `double-' events,
9001 If we get a mouse click in a mode line, vertical divider, or other
9002 non-text area, we treat the click as if it were prefixed by the
9003 symbol denoting that area - `mode-line', `vertical-line', or
9006 If the sequence starts with a mouse click, we read the key sequence
9007 with respect to the buffer clicked on, not the current buffer.
9009 If the user switches frames in the midst of a key sequence, we put
9010 off the switch-frame event until later; the next call to
9011 read_char will return it.
9013 If FIX_CURRENT_BUFFER is nonzero, we restore current_buffer
9014 from the selected window's buffer. */
9017 read_key_sequence (Lisp_Object
*keybuf
, int bufsize
, Lisp_Object prompt
,
9018 int dont_downcase_last
, int can_return_switch_frame
,
9019 int fix_current_buffer
)
9021 Lisp_Object from_string
;
9022 ptrdiff_t count
= SPECPDL_INDEX ();
9024 /* How many keys there are in the current key sequence. */
9027 /* The length of the echo buffer when we started reading, and
9028 the length of this_command_keys when we started reading. */
9029 ptrdiff_t echo_start
IF_LINT (= 0);
9030 ptrdiff_t keys_start
;
9032 /* The number of keymaps we're scanning right now, and the number of
9033 keymaps we have allocated space for. */
9035 ptrdiff_t nmaps_allocated
= 0;
9037 /* defs[0..nmaps-1] are the definitions of KEYBUF[0..t-1] in
9038 the current keymaps. */
9039 Lisp_Object
*defs
= NULL
;
9041 /* submaps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
9042 in the current keymaps, or nil where it is not a prefix. */
9043 Lisp_Object
*submaps
= NULL
;
9045 /* The local map to start out with at start of key sequence. */
9046 Lisp_Object orig_local_map
;
9048 /* The map from the `keymap' property to start out with at start of
9050 Lisp_Object orig_keymap
;
9052 /* 1 if we have already considered switching to the local-map property
9053 of the place where a mouse click occurred. */
9054 int localized_local_map
= 0;
9056 /* The index in submaps[] of the first keymap that has a binding for
9057 this key sequence. In other words, the lowest i such that
9058 submaps[i] is non-nil. */
9059 ptrdiff_t first_binding
;
9060 /* Index of the first key that has no binding.
9061 It is useless to try fkey.start larger than that. */
9064 /* If t < mock_input, then KEYBUF[t] should be read as the next
9067 We use this to recover after recognizing a function key. Once we
9068 realize that a suffix of the current key sequence is actually a
9069 function key's escape sequence, we replace the suffix with the
9070 function key's binding from Vfunction_key_map. Now keybuf
9071 contains a new and different key sequence, so the echo area,
9072 this_command_keys, and the submaps and defs arrays are wrong. In
9073 this situation, we set mock_input to t, set t to 0, and jump to
9074 restart_sequence; the loop will read keys from keybuf up until
9075 mock_input, thus rebuilding the state; and then it will resume
9076 reading characters from the keyboard. */
9079 /* If the sequence is unbound in submaps[], then
9080 keybuf[fkey.start..fkey.end-1] is a prefix in Vfunction_key_map,
9081 and fkey.map is its binding.
9083 These might be > t, indicating that all function key scanning
9084 should hold off until t reaches them. We do this when we've just
9085 recognized a function key, to avoid searching for the function
9086 key's again in Vfunction_key_map. */
9089 /* Likewise, for key_translation_map and input-decode-map. */
9090 keyremap keytran
, indec
;
9092 /* Non-zero if we are trying to map a key by changing an upper-case
9093 letter to lower case, or a shifted function key to an unshifted
9095 int shift_translated
= 0;
9097 /* If we receive a `switch-frame' or `select-window' event in the middle of
9098 a key sequence, we put it off for later.
9099 While we're reading, we keep the event here. */
9100 Lisp_Object delayed_switch_frame
;
9102 /* See the comment below... */
9103 #if defined (GOBBLE_FIRST_EVENT)
9104 Lisp_Object first_event
;
9107 Lisp_Object original_uppercase
IF_LINT (= Qnil
);
9108 int original_uppercase_position
= -1;
9110 /* Gets around Microsoft compiler limitations. */
9113 struct buffer
*starting_buffer
;
9115 /* List of events for which a fake prefix key has been generated. */
9116 Lisp_Object fake_prefixed_keys
= Qnil
;
9118 #if defined (GOBBLE_FIRST_EVENT)
9122 struct gcpro gcpro1
;
9124 GCPRO1 (fake_prefixed_keys
);
9125 raw_keybuf_count
= 0;
9127 last_nonmenu_event
= Qnil
;
9129 delayed_switch_frame
= Qnil
;
9135 /* Install the string STR as the beginning of the string of
9136 echoing, so that it serves as a prompt for the next
9138 kset_echo_string (current_kboard
, prompt
);
9139 current_kboard
->echo_after_prompt
= SCHARS (prompt
);
9142 else if (cursor_in_echo_area
9143 && (FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
9144 && NILP (Fzerop (Vecho_keystrokes
)))
9145 /* This doesn't put in a dash if the echo buffer is empty, so
9146 you don't always see a dash hanging out in the minibuffer. */
9150 /* Record the initial state of the echo area and this_command_keys;
9151 we will need to restore them if we replay a key sequence. */
9153 echo_start
= echo_length ();
9154 keys_start
= this_command_key_count
;
9155 this_single_command_key_start
= keys_start
;
9157 #if defined (GOBBLE_FIRST_EVENT)
9158 /* This doesn't quite work, because some of the things that read_char
9159 does cannot safely be bypassed. It seems too risky to try to make
9162 /* Read the first char of the sequence specially, before setting
9163 up any keymaps, in case a filter runs and switches buffers on us. */
9164 first_event
= read_char (NILP (prompt
), 0, submaps
, last_nonmenu_event
,
9166 #endif /* GOBBLE_FIRST_EVENT */
9168 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
9169 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9172 /* We jump here when we need to reinitialize fkey and keytran; this
9173 happens if we switch keyboards between rescans. */
9174 replay_entire_sequence
:
9176 indec
.map
= indec
.parent
= KVAR (current_kboard
, Vinput_decode_map
);
9177 fkey
.map
= fkey
.parent
= KVAR (current_kboard
, Vlocal_function_key_map
);
9178 keytran
.map
= keytran
.parent
= Vkey_translation_map
;
9179 indec
.start
= indec
.end
= 0;
9180 fkey
.start
= fkey
.end
= 0;
9181 keytran
.start
= keytran
.end
= 0;
9183 /* We jump here when the key sequence has been thoroughly changed, and
9184 we need to rescan it starting from the beginning. When we jump here,
9185 keybuf[0..mock_input] holds the sequence we should reread. */
9188 starting_buffer
= current_buffer
;
9189 first_unbound
= bufsize
+ 1;
9191 /* Build our list of keymaps.
9192 If we recognize a function key and replace its escape sequence in
9193 keybuf with its symbol, or if the sequence starts with a mouse
9194 click and we need to switch buffers, we jump back here to rebuild
9195 the initial keymaps from the current buffer. */
9198 if (!NILP (KVAR (current_kboard
, Voverriding_terminal_local_map
)))
9200 if (2 > nmaps_allocated
)
9202 submaps
= alloca (2 * sizeof *submaps
);
9203 defs
= alloca (2 * sizeof *defs
);
9204 nmaps_allocated
= 2;
9206 submaps
[nmaps
++] = KVAR (current_kboard
, Voverriding_terminal_local_map
);
9208 else if (!NILP (Voverriding_local_map
))
9210 if (2 > nmaps_allocated
)
9212 submaps
= alloca (2 * sizeof *submaps
);
9213 defs
= alloca (2 * sizeof *defs
);
9214 nmaps_allocated
= 2;
9216 submaps
[nmaps
++] = Voverriding_local_map
;
9224 nminor
= current_minor_maps (0, &maps
);
9225 total
= nminor
+ (!NILP (orig_keymap
) ? 3 : 2);
9227 if (total
> nmaps_allocated
)
9229 submaps
= alloca (total
* sizeof *submaps
);
9230 defs
= alloca (total
* sizeof *defs
);
9231 nmaps_allocated
= total
;
9234 if (!NILP (orig_keymap
))
9235 submaps
[nmaps
++] = orig_keymap
;
9237 memcpy (submaps
+ nmaps
, maps
, nminor
* sizeof (submaps
[0]));
9241 submaps
[nmaps
++] = orig_local_map
;
9243 submaps
[nmaps
++] = current_global_map
;
9245 /* Find an accurate initial value for first_binding. */
9246 for (first_binding
= 0; first_binding
< nmaps
; first_binding
++)
9247 if (! NILP (submaps
[first_binding
]))
9250 /* Start from the beginning in keybuf. */
9253 /* These are no-ops the first time through, but if we restart, they
9254 revert the echo area and this_command_keys to their original state. */
9255 this_command_key_count
= keys_start
;
9256 if (INTERACTIVE
&& t
< mock_input
)
9257 echo_truncate (echo_start
);
9259 /* If the best binding for the current key sequence is a keymap, or
9260 we may be looking at a function key's escape sequence, keep on
9262 while (first_binding
< nmaps
9263 /* Keep reading as long as there's a prefix binding. */
9264 ? !NILP (submaps
[first_binding
])
9265 /* Don't return in the middle of a possible function key sequence,
9266 if the only bindings we found were via case conversion.
9267 Thus, if ESC O a has a function-key-map translation
9268 and ESC o has a binding, don't return after ESC O,
9269 so that we can translate ESC O plus the next character. */
9270 : (/* indec.start < t || fkey.start < t || */ keytran
.start
< t
))
9273 int used_mouse_menu
= 0;
9275 /* Where the last real key started. If we need to throw away a
9276 key that has expanded into more than one element of keybuf
9277 (say, a mouse click on the mode line which is being treated
9278 as [mode-line (mouse-...)], then we backtrack to this point
9280 int last_real_key_start
;
9282 /* These variables are analogous to echo_start and keys_start;
9283 while those allow us to restart the entire key sequence,
9284 echo_local_start and keys_local_start allow us to throw away
9286 ptrdiff_t echo_local_start
IF_LINT (= 0);
9287 int keys_local_start
;
9288 ptrdiff_t local_first_binding
;
9290 eassert (indec
.end
== t
|| (indec
.end
> t
&& indec
.end
<= mock_input
));
9291 eassert (indec
.start
<= indec
.end
);
9292 eassert (fkey
.start
<= fkey
.end
);
9293 eassert (keytran
.start
<= keytran
.end
);
9294 /* key-translation-map is applied *after* function-key-map
9295 which is itself applied *after* input-decode-map. */
9296 eassert (fkey
.end
<= indec
.start
);
9297 eassert (keytran
.end
<= fkey
.start
);
9299 if (/* first_unbound < indec.start && first_unbound < fkey.start && */
9300 first_unbound
< keytran
.start
)
9301 { /* The prefix upto first_unbound has no binding and has
9302 no translation left to do either, so we know it's unbound.
9303 If we don't stop now, we risk staying here indefinitely
9304 (if the user keeps entering fkey or keytran prefixes
9305 like C-c ESC ESC ESC ESC ...) */
9307 for (i
= first_unbound
+ 1; i
< t
; i
++)
9308 keybuf
[i
- first_unbound
- 1] = keybuf
[i
];
9309 mock_input
= t
- first_unbound
- 1;
9310 indec
.end
= indec
.start
-= first_unbound
+ 1;
9311 indec
.map
= indec
.parent
;
9312 fkey
.end
= fkey
.start
-= first_unbound
+ 1;
9313 fkey
.map
= fkey
.parent
;
9314 keytran
.end
= keytran
.start
-= first_unbound
+ 1;
9315 keytran
.map
= keytran
.parent
;
9316 goto replay_sequence
;
9320 error ("Key sequence too long");
9323 echo_local_start
= echo_length ();
9324 keys_local_start
= this_command_key_count
;
9325 local_first_binding
= first_binding
;
9328 /* These are no-ops, unless we throw away a keystroke below and
9329 jumped back up to replay_key; in that case, these restore the
9330 variables to their original state, allowing us to replay the
9332 if (INTERACTIVE
&& t
< mock_input
)
9333 echo_truncate (echo_local_start
);
9334 this_command_key_count
= keys_local_start
;
9335 first_binding
= local_first_binding
;
9337 /* By default, assume each event is "real". */
9338 last_real_key_start
= t
;
9340 /* Does mock_input indicate that we are re-reading a key sequence? */
9344 add_command_key (key
);
9345 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
9346 && NILP (Fzerop (Vecho_keystrokes
)))
9350 /* If not, we should actually read a character. */
9354 KBOARD
*interrupted_kboard
= current_kboard
;
9355 struct frame
*interrupted_frame
= SELECTED_FRAME ();
9356 key
= read_char (NILP (prompt
), nmaps
,
9357 (Lisp_Object
*) submaps
, last_nonmenu_event
,
9358 &used_mouse_menu
, NULL
);
9359 if ((INTEGERP (key
) && XINT (key
) == -2) /* wrong_kboard_jmpbuf */
9360 /* When switching to a new tty (with a new keyboard),
9361 read_char returns the new buffer, rather than -2
9362 (Bug#5095). This is because `terminal-init-xterm'
9363 calls read-char, which eats the wrong_kboard_jmpbuf
9364 return. Any better way to fix this? -- cyd */
9365 || (interrupted_kboard
!= current_kboard
))
9370 for (k
= all_kboards
; k
; k
= k
->next_kboard
)
9371 if (k
== interrupted_kboard
)
9376 /* Don't touch interrupted_kboard when it's been
9378 delayed_switch_frame
= Qnil
;
9379 goto replay_entire_sequence
;
9382 if (!NILP (delayed_switch_frame
))
9385 (interrupted_kboard
,
9386 Fcons (delayed_switch_frame
,
9387 KVAR (interrupted_kboard
, kbd_queue
)));
9388 delayed_switch_frame
= Qnil
;
9393 (interrupted_kboard
,
9394 Fcons (keybuf
[--t
], KVAR (interrupted_kboard
, kbd_queue
)));
9396 /* If the side queue is non-empty, ensure it begins with a
9397 switch-frame, so we'll replay it in the right context. */
9398 if (CONSP (KVAR (interrupted_kboard
, kbd_queue
))
9399 && (key
= XCAR (KVAR (interrupted_kboard
, kbd_queue
)),
9400 !(EVENT_HAS_PARAMETERS (key
)
9401 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)),
9405 XSETFRAME (frame
, interrupted_frame
);
9407 (interrupted_kboard
,
9408 Fcons (make_lispy_switch_frame (frame
),
9409 KVAR (interrupted_kboard
, kbd_queue
)));
9412 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
9413 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9414 goto replay_entire_sequence
;
9418 /* read_char returns t when it shows a menu and the user rejects it.
9422 unbind_to (count
, Qnil
);
9427 /* read_char returns -1 at the end of a macro.
9428 Emacs 18 handles this by returning immediately with a
9429 zero, so that's what we'll do. */
9430 if (INTEGERP (key
) && XINT (key
) == -1)
9433 /* The Microsoft C compiler can't handle the goto that
9439 /* If the current buffer has been changed from under us, the
9440 keymap may have changed, so replay the sequence. */
9443 timer_resume_idle ();
9446 /* Reset the current buffer from the selected window
9447 in case something changed the former and not the latter.
9448 This is to be more consistent with the behavior
9449 of the command_loop_1. */
9450 if (fix_current_buffer
)
9452 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
9454 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
9455 Fset_buffer (XWINDOW (selected_window
)->buffer
);
9458 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
9459 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9460 goto replay_sequence
;
9463 /* If we have a quit that was typed in another frame, and
9464 quit_throw_to_read_char switched buffers,
9465 replay to get the right keymap. */
9467 && XINT (key
) == quit_char
9468 && current_buffer
!= starting_buffer
)
9471 ASET (raw_keybuf
, raw_keybuf_count
, key
);
9476 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
9477 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9478 goto replay_sequence
;
9483 if (EVENT_HAS_PARAMETERS (key
)
9484 /* Either a `switch-frame' or a `select-window' event. */
9485 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)), Qswitch_frame
))
9487 /* If we're at the beginning of a key sequence, and the caller
9488 says it's okay, go ahead and return this event. If we're
9489 in the midst of a key sequence, delay it until the end. */
9490 if (t
> 0 || !can_return_switch_frame
)
9492 delayed_switch_frame
= key
;
9498 ASET (raw_keybuf
, raw_keybuf_count
, key
);
9502 /* Clicks in non-text areas get prefixed by the symbol
9503 in their CHAR-ADDRESS field. For example, a click on
9504 the mode line is prefixed by the symbol `mode-line'.
9506 Furthermore, key sequences beginning with mouse clicks
9507 are read using the keymaps of the buffer clicked on, not
9508 the current buffer. So we may have to switch the buffer
9511 When we turn one event into two events, we must make sure
9512 that neither of the two looks like the original--so that,
9513 if we replay the events, they won't be expanded again.
9514 If not for this, such reexpansion could happen either here
9515 or when user programs play with this-command-keys. */
9516 if (EVENT_HAS_PARAMETERS (key
))
9521 kind
= EVENT_HEAD_KIND (EVENT_HEAD (key
));
9522 if (EQ (kind
, Qmouse_click
))
9524 Lisp_Object window
, posn
;
9526 window
= POSN_WINDOW (EVENT_START (key
));
9527 posn
= POSN_POSN (EVENT_START (key
));
9530 || (!NILP (fake_prefixed_keys
)
9531 && !NILP (Fmemq (key
, fake_prefixed_keys
))))
9533 /* We're looking a second time at an event for which
9534 we generated a fake prefix key. Set
9535 last_real_key_start appropriately. */
9537 last_real_key_start
= t
- 1;
9540 if (last_real_key_start
== 0)
9542 /* Key sequences beginning with mouse clicks are
9543 read using the keymaps in the buffer clicked on,
9544 not the current buffer. If we're at the
9545 beginning of a key sequence, switch buffers. */
9546 if (WINDOWP (window
)
9547 && BUFFERP (XWINDOW (window
)->buffer
)
9548 && XBUFFER (XWINDOW (window
)->buffer
) != current_buffer
)
9550 ASET (raw_keybuf
, raw_keybuf_count
, key
);
9555 /* Arrange to go back to the original buffer once we're
9556 done reading the key sequence. Note that we can't
9557 use save_excursion_{save,restore} here, because they
9558 save point as well as the current buffer; we don't
9559 want to save point, because redisplay may change it,
9560 to accommodate a Fset_window_start or something. We
9561 don't want to do this at the top of the function,
9562 because we may get input from a subprocess which
9563 wants to change the selected window and stuff (say,
9565 record_unwind_current_buffer ();
9567 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
9569 set_buffer_internal (XBUFFER (XWINDOW (window
)->buffer
));
9570 orig_local_map
= get_local_map (PT
, current_buffer
,
9572 orig_keymap
= get_local_map (PT
, current_buffer
,
9574 goto replay_sequence
;
9577 /* For a mouse click, get the local text-property keymap
9578 of the place clicked on, rather than point. */
9579 if (CONSP (XCDR (key
))
9580 && ! localized_local_map
)
9582 Lisp_Object map_here
, start
, pos
;
9584 localized_local_map
= 1;
9585 start
= EVENT_START (key
);
9587 if (CONSP (start
) && POSN_INBUFFER_P (start
))
9589 pos
= POSN_BUFFER_POSN (start
);
9591 && XINT (pos
) >= BEGV
9592 && XINT (pos
) <= ZV
)
9594 map_here
= get_local_map (XINT (pos
),
9597 if (!EQ (map_here
, orig_local_map
))
9599 orig_local_map
= map_here
;
9600 ++localized_local_map
;
9603 map_here
= get_local_map (XINT (pos
),
9606 if (!EQ (map_here
, orig_keymap
))
9608 orig_keymap
= map_here
;
9609 ++localized_local_map
;
9612 if (localized_local_map
> 1)
9617 goto replay_sequence
;
9624 /* Expand mode-line and scroll-bar events into two events:
9625 use posn as a fake prefix key. */
9627 && (NILP (fake_prefixed_keys
)
9628 || NILP (Fmemq (key
, fake_prefixed_keys
))))
9630 if (bufsize
- t
<= 1)
9631 error ("Key sequence too long");
9634 keybuf
[t
+ 1] = key
;
9637 /* Record that a fake prefix key has been generated
9638 for KEY. Don't modify the event; this would
9639 prevent proper action when the event is pushed
9640 back into unread-command-events. */
9641 fake_prefixed_keys
= Fcons (key
, fake_prefixed_keys
);
9643 /* If on a mode line string with a local keymap,
9644 reconsider the key sequence with that keymap. */
9645 if (string
= POSN_STRING (EVENT_START (key
)),
9646 (CONSP (string
) && STRINGP (XCAR (string
))))
9648 Lisp_Object pos
, map
, map2
;
9650 pos
= XCDR (string
);
9651 string
= XCAR (string
);
9653 && XINT (pos
) < SCHARS (string
))
9655 map
= Fget_text_property (pos
, Qlocal_map
, string
);
9657 orig_local_map
= map
;
9658 map2
= Fget_text_property (pos
, Qkeymap
, string
);
9661 if (!NILP (map
) || !NILP (map2
))
9662 goto replay_sequence
;
9668 else if (NILP (from_string
)
9669 && (string
= POSN_STRING (EVENT_START (key
)),
9670 (CONSP (string
) && STRINGP (XCAR (string
)))))
9672 /* For a click on a string, i.e. overlay string or a
9673 string displayed via the `display' property,
9674 consider `local-map' and `keymap' properties of
9676 Lisp_Object pos
, map
, map2
;
9678 pos
= XCDR (string
);
9679 string
= XCAR (string
);
9681 && XINT (pos
) < SCHARS (string
))
9683 map
= Fget_text_property (pos
, Qlocal_map
, string
);
9685 orig_local_map
= map
;
9686 map2
= Fget_text_property (pos
, Qkeymap
, string
);
9690 if (!NILP (map
) || !NILP (map2
))
9692 from_string
= string
;
9695 goto replay_sequence
;
9700 else if (CONSP (XCDR (key
))
9701 && CONSP (EVENT_START (key
))
9702 && CONSP (XCDR (EVENT_START (key
))))
9706 posn
= POSN_POSN (EVENT_START (key
));
9707 /* Handle menu-bar events:
9708 insert the dummy prefix event `menu-bar'. */
9709 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
9711 if (bufsize
- t
<= 1)
9712 error ("Key sequence too long");
9716 /* Zap the position in key, so we know that we've
9717 expanded it, and don't try to do so again. */
9718 POSN_SET_POSN (EVENT_START (key
),
9719 Fcons (posn
, Qnil
));
9722 goto replay_sequence
;
9724 else if (CONSP (posn
))
9726 /* We're looking at the second event of a
9727 sequence which we expanded before. Set
9728 last_real_key_start appropriately. */
9729 if (last_real_key_start
== t
&& t
> 0)
9730 last_real_key_start
= t
- 1;
9735 /* We have finally decided that KEY is something we might want
9737 first_binding
= (follow_key (key
,
9738 nmaps
- first_binding
,
9739 submaps
+ first_binding
,
9740 defs
+ first_binding
,
9741 submaps
+ first_binding
)
9744 /* If KEY wasn't bound, we'll try some fallbacks. */
9745 if (first_binding
< nmaps
)
9746 /* This is needed for the following scenario:
9747 event 0: a down-event that gets dropped by calling replay_key.
9748 event 1: some normal prefix like C-h.
9749 After event 0, first_unbound is 0, after event 1 indec.start,
9750 fkey.start, and keytran.start are all 1, so when we see that
9751 C-h is bound, we need to update first_unbound. */
9752 first_unbound
= max (t
+ 1, first_unbound
);
9757 /* Remember the position to put an upper bound on indec.start. */
9758 first_unbound
= min (t
, first_unbound
);
9760 head
= EVENT_HEAD (key
);
9761 if (help_char_p (head
) && t
> 0)
9763 read_key_sequence_cmd
= Vprefix_help_command
;
9765 last_nonmenu_event
= key
;
9766 /* The Microsoft C compiler can't handle the goto that
9774 Lisp_Object breakdown
;
9777 breakdown
= parse_modifiers (head
);
9778 modifiers
= XINT (XCAR (XCDR (breakdown
)));
9779 /* Attempt to reduce an unbound mouse event to a simpler
9780 event that is bound:
9781 Drags reduce to clicks.
9782 Double-clicks reduce to clicks.
9783 Triple-clicks reduce to double-clicks, then to clicks.
9784 Down-clicks are eliminated.
9785 Double-downs reduce to downs, then are eliminated.
9786 Triple-downs reduce to double-downs, then to downs,
9787 then are eliminated. */
9788 if (modifiers
& (down_modifier
| drag_modifier
9789 | double_modifier
| triple_modifier
))
9791 while (modifiers
& (down_modifier
| drag_modifier
9792 | double_modifier
| triple_modifier
))
9794 Lisp_Object new_head
, new_click
;
9795 if (modifiers
& triple_modifier
)
9796 modifiers
^= (double_modifier
| triple_modifier
);
9797 else if (modifiers
& double_modifier
)
9798 modifiers
&= ~double_modifier
;
9799 else if (modifiers
& drag_modifier
)
9800 modifiers
&= ~drag_modifier
;
9803 /* Dispose of this `down' event by simply jumping
9804 back to replay_key, to get another event.
9806 Note that if this event came from mock input,
9807 then just jumping back to replay_key will just
9808 hand it to us again. So we have to wipe out any
9811 We could delete keybuf[t] and shift everything
9812 after that to the left by one spot, but we'd also
9813 have to fix up any variable that points into
9814 keybuf, and shifting isn't really necessary
9817 Adding prefixes for non-textual mouse clicks
9818 creates two characters of mock input, and both
9819 must be thrown away. If we're only looking at
9820 the prefix now, we can just jump back to
9821 replay_key. On the other hand, if we've already
9822 processed the prefix, and now the actual click
9823 itself is giving us trouble, then we've lost the
9824 state of the keymaps we want to backtrack to, and
9825 we need to replay the whole sequence to rebuild
9828 Beyond that, only function key expansion could
9829 create more than two keys, but that should never
9830 generate mouse events, so it's okay to zero
9831 mock_input in that case too.
9833 FIXME: The above paragraph seems just plain
9834 wrong, if you consider things like
9835 xterm-mouse-mode. -stef
9837 Isn't this just the most wonderful code ever? */
9839 /* If mock_input > t + 1, the above simplification
9840 will actually end up dropping keys on the floor.
9841 This is probably OK for now, but even
9842 if mock_input <= t + 1, we need to adjust indec,
9844 Typical case [header-line down-mouse-N]:
9845 mock_input = 2, t = 1, fkey.end = 1,
9846 last_real_key_start = 0. */
9847 if (indec
.end
> last_real_key_start
)
9849 indec
.end
= indec
.start
9850 = min (last_real_key_start
, indec
.start
);
9851 indec
.map
= indec
.parent
;
9852 if (fkey
.end
> last_real_key_start
)
9854 fkey
.end
= fkey
.start
9855 = min (last_real_key_start
, fkey
.start
);
9856 fkey
.map
= fkey
.parent
;
9857 if (keytran
.end
> last_real_key_start
)
9859 keytran
.end
= keytran
.start
9860 = min (last_real_key_start
, keytran
.start
);
9861 keytran
.map
= keytran
.parent
;
9865 if (t
== last_real_key_start
)
9872 mock_input
= last_real_key_start
;
9873 goto replay_sequence
;
9878 = apply_modifiers (modifiers
, XCAR (breakdown
));
9880 = Fcons (new_head
, Fcons (EVENT_START (key
), Qnil
));
9882 /* Look for a binding for this new key. follow_key
9883 promises that it didn't munge submaps the
9884 last time we called it, since key was unbound. */
9886 = (follow_key (new_click
,
9887 nmaps
- local_first_binding
,
9888 submaps
+ local_first_binding
,
9889 defs
+ local_first_binding
,
9890 submaps
+ local_first_binding
)
9891 + local_first_binding
);
9893 /* If that click is bound, go for it. */
9894 if (first_binding
< nmaps
)
9899 /* Otherwise, we'll leave key set to the drag event. */
9906 /* Normally, last_nonmenu_event gets the previous key we read.
9907 But when a mouse popup menu is being used,
9908 we don't update last_nonmenu_event; it continues to hold the mouse
9909 event that preceded the first level of menu. */
9910 if (!used_mouse_menu
)
9911 last_nonmenu_event
= key
;
9913 /* Record what part of this_command_keys is the current key sequence. */
9914 this_single_command_key_start
= this_command_key_count
- t
;
9916 /* Look for this sequence in input-decode-map.
9917 Scan from indec.end until we find a bound suffix. */
9918 while (indec
.end
< t
)
9920 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9923 GCPRO4 (indec
.map
, fkey
.map
, keytran
.map
, delayed_switch_frame
);
9924 done
= keyremap_step (keybuf
, bufsize
, &indec
, max (t
, mock_input
),
9929 mock_input
= diff
+ max (t
, mock_input
);
9930 goto replay_sequence
;
9934 if (first_binding
< nmaps
9935 && NILP (submaps
[first_binding
])
9936 && !test_undefined (defs
[first_binding
])
9937 && indec
.start
>= t
)
9938 /* There is a binding and it's not a prefix.
9939 (and it doesn't have any input-decode-map translation pending).
9940 There is thus no function-key in this sequence.
9941 Moving fkey.start is important in this case to allow keytran.start
9942 to go over the sequence before we return (since we keep the
9943 invariant that keytran.end <= fkey.start). */
9946 (fkey
.start
= fkey
.end
= t
, fkey
.map
= fkey
.parent
);
9949 /* If the sequence is unbound, see if we can hang a function key
9950 off the end of it. */
9951 /* Continue scan from fkey.end until we find a bound suffix. */
9952 while (fkey
.end
< indec
.start
)
9954 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9957 GCPRO4 (indec
.map
, fkey
.map
, keytran
.map
, delayed_switch_frame
);
9958 done
= keyremap_step (keybuf
, bufsize
, &fkey
,
9959 max (t
, mock_input
),
9960 /* If there's a binding (i.e.
9961 first_binding >= nmaps) we don't want
9962 to apply this function-key-mapping. */
9964 && (first_binding
>= nmaps
9965 || test_undefined (defs
[first_binding
])),
9970 mock_input
= diff
+ max (t
, mock_input
);
9971 /* Adjust the input-decode-map counters. */
9973 indec
.start
+= diff
;
9975 goto replay_sequence
;
9979 /* Look for this sequence in key-translation-map.
9980 Scan from keytran.end until we find a bound suffix. */
9981 while (keytran
.end
< fkey
.start
)
9983 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9986 GCPRO4 (indec
.map
, fkey
.map
, keytran
.map
, delayed_switch_frame
);
9987 done
= keyremap_step (keybuf
, bufsize
, &keytran
, max (t
, mock_input
),
9992 mock_input
= diff
+ max (t
, mock_input
);
9993 /* Adjust the function-key-map and input-decode-map counters. */
9995 indec
.start
+= diff
;
9999 goto replay_sequence
;
10003 /* If KEY is not defined in any of the keymaps,
10004 and cannot be part of a function key or translation,
10005 and is an upper case letter
10006 use the corresponding lower-case letter instead. */
10007 if (first_binding
>= nmaps
10008 && /* indec.start >= t && fkey.start >= t && */ keytran
.start
>= t
10010 && ((CHARACTERP (make_number (XINT (key
) & ~CHAR_MODIFIER_MASK
))
10011 && uppercasep (XINT (key
) & ~CHAR_MODIFIER_MASK
))
10012 || (XINT (key
) & shift_modifier
)))
10014 Lisp_Object new_key
;
10016 original_uppercase
= key
;
10017 original_uppercase_position
= t
- 1;
10019 if (XINT (key
) & shift_modifier
)
10020 XSETINT (new_key
, XINT (key
) & ~shift_modifier
);
10022 XSETINT (new_key
, (downcase (XINT (key
) & ~CHAR_MODIFIER_MASK
)
10023 | (XINT (key
) & CHAR_MODIFIER_MASK
)));
10025 /* We have to do this unconditionally, regardless of whether
10026 the lower-case char is defined in the keymaps, because they
10027 might get translated through function-key-map. */
10028 keybuf
[t
- 1] = new_key
;
10029 mock_input
= max (t
, mock_input
);
10030 shift_translated
= 1;
10032 goto replay_sequence
;
10034 /* If KEY is not defined in any of the keymaps,
10035 and cannot be part of a function key or translation,
10036 and is a shifted function key,
10037 use the corresponding unshifted function key instead. */
10038 if (first_binding
>= nmaps
10039 && /* indec.start >= t && fkey.start >= t && */ keytran
.start
>= t
)
10041 Lisp_Object breakdown
= parse_modifiers (key
);
10043 = CONSP (breakdown
) ? (XINT (XCAR (XCDR (breakdown
)))) : 0;
10045 if (modifiers
& shift_modifier
10046 /* Treat uppercase keys as shifted. */
10048 && (KEY_TO_CHAR (key
)
10049 < XCHAR_TABLE (BVAR (current_buffer
, downcase_table
))->header
.size
)
10050 && uppercasep (KEY_TO_CHAR (key
))))
10052 Lisp_Object new_key
10053 = (modifiers
& shift_modifier
10054 ? apply_modifiers (modifiers
& ~shift_modifier
,
10056 : make_number (downcase (KEY_TO_CHAR (key
)) | modifiers
));
10058 original_uppercase
= key
;
10059 original_uppercase_position
= t
- 1;
10061 /* We have to do this unconditionally, regardless of whether
10062 the lower-case char is defined in the keymaps, because they
10063 might get translated through function-key-map. */
10064 keybuf
[t
- 1] = new_key
;
10065 mock_input
= max (t
, mock_input
);
10066 /* Reset fkey (and consequently keytran) to apply
10067 function-key-map on the result, so that S-backspace is
10068 correctly mapped to DEL (via backspace). OTOH,
10069 input-decode-map doesn't need to go through it again. */
10070 fkey
.start
= fkey
.end
= 0;
10071 keytran
.start
= keytran
.end
= 0;
10072 shift_translated
= 1;
10074 goto replay_sequence
;
10079 read_key_sequence_cmd
= (first_binding
< nmaps
10080 ? defs
[first_binding
]
10082 read_key_sequence_remapped
10083 /* Remap command through active keymaps.
10084 Do the remapping here, before the unbind_to so it uses the keymaps
10085 of the appropriate buffer. */
10086 = SYMBOLP (read_key_sequence_cmd
)
10087 ? Fcommand_remapping (read_key_sequence_cmd
, Qnil
, Qnil
)
10090 unread_switch_frame
= delayed_switch_frame
;
10091 unbind_to (count
, Qnil
);
10093 /* Don't downcase the last character if the caller says don't.
10094 Don't downcase it if the result is undefined, either. */
10095 if ((dont_downcase_last
|| first_binding
>= nmaps
)
10097 && t
- 1 == original_uppercase_position
)
10099 keybuf
[t
- 1] = original_uppercase
;
10100 shift_translated
= 0;
10103 if (shift_translated
)
10104 Vthis_command_keys_shift_translated
= Qt
;
10106 /* Occasionally we fabricate events, perhaps by expanding something
10107 according to function-key-map, or by adding a prefix symbol to a
10108 mouse click in the scroll bar or modeline. In this cases, return
10109 the entire generated key sequence, even if we hit an unbound
10110 prefix or a definition before the end. This means that you will
10111 be able to push back the event properly, and also means that
10112 read-key-sequence will always return a logical unit.
10115 for (; t
< mock_input
; t
++)
10117 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
10118 && NILP (Fzerop (Vecho_keystrokes
)))
10119 echo_char (keybuf
[t
]);
10120 add_command_key (keybuf
[t
]);
10127 DEFUN ("read-key-sequence", Fread_key_sequence
, Sread_key_sequence
, 1, 5, 0,
10128 doc
: /* Read a sequence of keystrokes and return as a string or vector.
10129 The sequence is sufficient to specify a non-prefix command in the
10130 current local and global maps.
10132 First arg PROMPT is a prompt string. If nil, do not prompt specially.
10133 Second (optional) arg CONTINUE-ECHO, if non-nil, means this key echos
10134 as a continuation of the previous key.
10136 The third (optional) arg DONT-DOWNCASE-LAST, if non-nil, means do not
10137 convert the last event to lower case. (Normally any upper case event
10138 is converted to lower case if the original event is undefined and the lower
10139 case equivalent is defined.) A non-nil value is appropriate for reading
10140 a key sequence to be defined.
10142 A C-g typed while in this function is treated like any other character,
10143 and `quit-flag' is not set.
10145 If the key sequence starts with a mouse click, then the sequence is read
10146 using the keymaps of the buffer of the window clicked in, not the buffer
10147 of the selected window as normal.
10149 `read-key-sequence' drops unbound button-down events, since you normally
10150 only care about the click or drag events which follow them. If a drag
10151 or multi-click event is unbound, but the corresponding click event would
10152 be bound, `read-key-sequence' turns the event into a click event at the
10153 drag's starting position. This means that you don't have to distinguish
10154 between click and drag, double, or triple events unless you want to.
10156 `read-key-sequence' prefixes mouse events on mode lines, the vertical
10157 lines separating windows, and scroll bars with imaginary keys
10158 `mode-line', `vertical-line', and `vertical-scroll-bar'.
10160 Optional fourth argument CAN-RETURN-SWITCH-FRAME non-nil means that this
10161 function will process a switch-frame event if the user switches frames
10162 before typing anything. If the user switches frames in the middle of a
10163 key sequence, or at the start of the sequence but CAN-RETURN-SWITCH-FRAME
10164 is nil, then the event will be put off until after the current key sequence.
10166 `read-key-sequence' checks `function-key-map' for function key
10167 sequences, where they wouldn't conflict with ordinary bindings. See
10168 `function-key-map' for more details.
10170 The optional fifth argument CMD-LOOP, if non-nil, means
10171 that this key sequence is being read by something that will
10172 read commands one after another. It should be nil if the caller
10173 will read just one key sequence. */)
10174 (Lisp_Object prompt
, Lisp_Object continue_echo
, Lisp_Object dont_downcase_last
, Lisp_Object can_return_switch_frame
, Lisp_Object cmd_loop
)
10176 Lisp_Object keybuf
[30];
10178 struct gcpro gcpro1
;
10179 ptrdiff_t count
= SPECPDL_INDEX ();
10181 if (!NILP (prompt
))
10182 CHECK_STRING (prompt
);
10185 specbind (Qinput_method_exit_on_first_char
,
10186 (NILP (cmd_loop
) ? Qt
: Qnil
));
10187 specbind (Qinput_method_use_echo_area
,
10188 (NILP (cmd_loop
) ? Qt
: Qnil
));
10190 memset (keybuf
, 0, sizeof keybuf
);
10191 GCPRO1 (keybuf
[0]);
10192 gcpro1
.nvars
= (sizeof keybuf
/sizeof (keybuf
[0]));
10194 if (NILP (continue_echo
))
10196 this_command_key_count
= 0;
10197 this_command_key_count_reset
= 0;
10198 this_single_command_key_start
= 0;
10201 #ifdef HAVE_WINDOW_SYSTEM
10202 if (display_hourglass_p
)
10203 cancel_hourglass ();
10206 i
= read_key_sequence (keybuf
, (sizeof keybuf
/sizeof (keybuf
[0])),
10207 prompt
, ! NILP (dont_downcase_last
),
10208 ! NILP (can_return_switch_frame
), 0);
10210 #if 0 /* The following is fine for code reading a key sequence and
10211 then proceeding with a lengthy computation, but it's not good
10212 for code reading keys in a loop, like an input method. */
10213 #ifdef HAVE_WINDOW_SYSTEM
10214 if (display_hourglass_p
)
10215 start_hourglass ();
10225 return unbind_to (count
, make_event_array (i
, keybuf
));
10228 DEFUN ("read-key-sequence-vector", Fread_key_sequence_vector
,
10229 Sread_key_sequence_vector
, 1, 5, 0,
10230 doc
: /* Like `read-key-sequence' but always return a vector. */)
10231 (Lisp_Object prompt
, Lisp_Object continue_echo
, Lisp_Object dont_downcase_last
, Lisp_Object can_return_switch_frame
, Lisp_Object cmd_loop
)
10233 Lisp_Object keybuf
[30];
10235 struct gcpro gcpro1
;
10236 ptrdiff_t count
= SPECPDL_INDEX ();
10238 if (!NILP (prompt
))
10239 CHECK_STRING (prompt
);
10242 specbind (Qinput_method_exit_on_first_char
,
10243 (NILP (cmd_loop
) ? Qt
: Qnil
));
10244 specbind (Qinput_method_use_echo_area
,
10245 (NILP (cmd_loop
) ? Qt
: Qnil
));
10247 memset (keybuf
, 0, sizeof keybuf
);
10248 GCPRO1 (keybuf
[0]);
10249 gcpro1
.nvars
= (sizeof keybuf
/ sizeof (keybuf
[0]));
10251 if (NILP (continue_echo
))
10253 this_command_key_count
= 0;
10254 this_command_key_count_reset
= 0;
10255 this_single_command_key_start
= 0;
10258 #ifdef HAVE_WINDOW_SYSTEM
10259 if (display_hourglass_p
)
10260 cancel_hourglass ();
10263 i
= read_key_sequence (keybuf
, (sizeof keybuf
/ sizeof (keybuf
[0])),
10264 prompt
, ! NILP (dont_downcase_last
),
10265 ! NILP (can_return_switch_frame
), 0);
10267 #ifdef HAVE_WINDOW_SYSTEM
10268 if (display_hourglass_p
)
10269 start_hourglass ();
10278 return unbind_to (count
, Fvector (i
, keybuf
));
10281 DEFUN ("command-execute", Fcommand_execute
, Scommand_execute
, 1, 4, 0,
10282 doc
: /* Execute CMD as an editor command.
10283 CMD must be a symbol that satisfies the `commandp' predicate.
10284 Optional second arg RECORD-FLAG non-nil
10285 means unconditionally put this command in `command-history'.
10286 Otherwise, that is done only if an arg is read using the minibuffer.
10287 The argument KEYS specifies the value to use instead of (this-command-keys)
10288 when reading the arguments; if it is nil, (this-command-keys) is used.
10289 The argument SPECIAL, if non-nil, means that this command is executing
10290 a special event, so ignore the prefix argument and don't clear it. */)
10291 (Lisp_Object cmd
, Lisp_Object record_flag
, Lisp_Object keys
, Lisp_Object special
)
10293 register Lisp_Object final
;
10294 register Lisp_Object tem
;
10295 Lisp_Object prefixarg
;
10297 debug_on_next_call
= 0;
10299 if (NILP (special
))
10301 prefixarg
= KVAR (current_kboard
, Vprefix_arg
);
10302 Vcurrent_prefix_arg
= prefixarg
;
10303 kset_prefix_arg (current_kboard
, Qnil
);
10310 tem
= Fget (cmd
, Qdisabled
);
10313 tem
= Fsymbol_value (Qdisabled_command_function
);
10315 return Frun_hooks (1, &Qdisabled_command_function
);
10321 final
= Findirect_function (cmd
, Qnil
);
10323 if (CONSP (final
) && (tem
= Fcar (final
), EQ (tem
, Qautoload
)))
10325 struct gcpro gcpro1
, gcpro2
;
10327 GCPRO2 (cmd
, prefixarg
);
10328 Fautoload_do_load (final
, cmd
, Qnil
);
10335 if (STRINGP (final
) || VECTORP (final
))
10337 /* If requested, place the macro in the command history. For
10338 other sorts of commands, call-interactively takes care of
10340 if (!NILP (record_flag
))
10343 = Fcons (Fcons (Qexecute_kbd_macro
,
10344 Fcons (final
, Fcons (prefixarg
, Qnil
))),
10347 /* Don't keep command history around forever. */
10348 if (NUMBERP (Vhistory_length
) && XINT (Vhistory_length
) > 0)
10350 tem
= Fnthcdr (Vhistory_length
, Vcommand_history
);
10352 XSETCDR (tem
, Qnil
);
10356 return Fexecute_kbd_macro (final
, prefixarg
, Qnil
);
10359 if (CONSP (final
) || SUBRP (final
) || COMPILEDP (final
))
10360 /* Don't call Fcall_interactively directly because we want to make
10361 sure the backtrace has an entry for `call-interactively'.
10362 For the same reason, pass `cmd' rather than `final'. */
10363 return call3 (Qcall_interactively
, cmd
, record_flag
, keys
);
10370 /* Return nonzero if input events are pending. */
10373 detect_input_pending (void)
10375 if (!input_pending
)
10376 get_input_pending (&input_pending
, 0);
10378 return input_pending
;
10381 /* Return nonzero if input events other than mouse movements are
10385 detect_input_pending_ignore_squeezables (void)
10387 if (!input_pending
)
10388 get_input_pending (&input_pending
, READABLE_EVENTS_IGNORE_SQUEEZABLES
);
10390 return input_pending
;
10393 /* Return nonzero if input events are pending, and run any pending timers. */
10396 detect_input_pending_run_timers (int do_display
)
10398 int old_timers_run
= timers_run
;
10400 if (!input_pending
)
10401 get_input_pending (&input_pending
, READABLE_EVENTS_DO_TIMERS_NOW
);
10403 if (old_timers_run
!= timers_run
&& do_display
)
10405 redisplay_preserve_echo_area (8);
10406 /* The following fixes a bug when using lazy-lock with
10407 lazy-lock-defer-on-the-fly set to t, i.e. when fontifying
10408 from an idle timer function. The symptom of the bug is that
10409 the cursor sometimes doesn't become visible until the next X
10410 event is processed. --gerd. */
10412 Lisp_Object tail
, frame
;
10413 FOR_EACH_FRAME (tail
, frame
)
10414 if (FRAME_RIF (XFRAME (frame
)))
10415 FRAME_RIF (XFRAME (frame
))->flush_display (XFRAME (frame
));
10419 return input_pending
;
10422 /* This is called in some cases before a possible quit.
10423 It cases the next call to detect_input_pending to recompute input_pending.
10424 So calling this function unnecessarily can't do any harm. */
10427 clear_input_pending (void)
10432 /* Return nonzero if there are pending requeued events.
10433 This isn't used yet. The hope is to make wait_reading_process_output
10434 call it, and return if it runs Lisp code that unreads something.
10435 The problem is, kbd_buffer_get_event needs to be fixed to know what
10436 to do in that case. It isn't trivial. */
10439 requeued_events_pending_p (void)
10441 return (!NILP (Vunread_command_events
) || unread_command_char
!= -1);
10445 DEFUN ("input-pending-p", Finput_pending_p
, Sinput_pending_p
, 0, 0, 0,
10446 doc
: /* Return t if command input is currently available with no wait.
10447 Actually, the value is nil only if we can be sure that no input is available;
10448 if there is a doubt, the value is t. */)
10451 if (!NILP (Vunread_command_events
) || unread_command_char
!= -1
10452 || !NILP (Vunread_post_input_method_events
)
10453 || !NILP (Vunread_input_method_events
))
10456 /* Process non-user-visible events (Bug#10195). */
10457 process_special_events ();
10459 get_input_pending (&input_pending
,
10460 READABLE_EVENTS_DO_TIMERS_NOW
10461 | READABLE_EVENTS_FILTER_EVENTS
);
10462 return input_pending
> 0 ? Qt
: Qnil
;
10465 DEFUN ("recent-keys", Frecent_keys
, Srecent_keys
, 0, 0, 0,
10466 doc
: /* Return vector of last 300 events, not counting those from keyboard macros. */)
10469 Lisp_Object
*keys
= XVECTOR (recent_keys
)->contents
;
10472 if (total_keys
< NUM_RECENT_KEYS
)
10473 return Fvector (total_keys
, keys
);
10476 val
= Fvector (NUM_RECENT_KEYS
, keys
);
10477 vcopy (val
, 0, keys
+ recent_keys_index
,
10478 NUM_RECENT_KEYS
- recent_keys_index
);
10479 vcopy (val
, NUM_RECENT_KEYS
- recent_keys_index
,
10480 keys
, recent_keys_index
);
10485 DEFUN ("this-command-keys", Fthis_command_keys
, Sthis_command_keys
, 0, 0, 0,
10486 doc
: /* Return the key sequence that invoked this command.
10487 However, if the command has called `read-key-sequence', it returns
10488 the last key sequence that has been read.
10489 The value is a string or a vector.
10491 See also `this-command-keys-vector'. */)
10494 return make_event_array (this_command_key_count
,
10495 XVECTOR (this_command_keys
)->contents
);
10498 DEFUN ("this-command-keys-vector", Fthis_command_keys_vector
, Sthis_command_keys_vector
, 0, 0, 0,
10499 doc
: /* Return the key sequence that invoked this command, as a vector.
10500 However, if the command has called `read-key-sequence', it returns
10501 the last key sequence that has been read.
10503 See also `this-command-keys'. */)
10506 return Fvector (this_command_key_count
,
10507 XVECTOR (this_command_keys
)->contents
);
10510 DEFUN ("this-single-command-keys", Fthis_single_command_keys
,
10511 Sthis_single_command_keys
, 0, 0, 0,
10512 doc
: /* Return the key sequence that invoked this command.
10513 More generally, it returns the last key sequence read, either by
10514 the command loop or by `read-key-sequence'.
10515 Unlike `this-command-keys', this function's value
10516 does not include prefix arguments.
10517 The value is always a vector. */)
10520 return Fvector (this_command_key_count
10521 - this_single_command_key_start
,
10522 (XVECTOR (this_command_keys
)->contents
10523 + this_single_command_key_start
));
10526 DEFUN ("this-single-command-raw-keys", Fthis_single_command_raw_keys
,
10527 Sthis_single_command_raw_keys
, 0, 0, 0,
10528 doc
: /* Return the raw events that were read for this command.
10529 More generally, it returns the last key sequence read, either by
10530 the command loop or by `read-key-sequence'.
10531 Unlike `this-single-command-keys', this function's value
10532 shows the events before all translations (except for input methods).
10533 The value is always a vector. */)
10536 return Fvector (raw_keybuf_count
,
10537 (XVECTOR (raw_keybuf
)->contents
));
10540 DEFUN ("reset-this-command-lengths", Freset_this_command_lengths
,
10541 Sreset_this_command_lengths
, 0, 0, 0,
10542 doc
: /* Make the unread events replace the last command and echo.
10543 Used in `universal-argument-other-key'.
10545 `universal-argument-other-key' rereads the event just typed.
10546 It then gets translated through `function-key-map'.
10547 The translated event has to replace the real events,
10548 both in the value of (this-command-keys) and in echoing.
10549 To achieve this, `universal-argument-other-key' calls
10550 `reset-this-command-lengths', which discards the record of reading
10551 these events the first time. */)
10554 this_command_key_count
= before_command_key_count
;
10555 if (this_command_key_count
< this_single_command_key_start
)
10556 this_single_command_key_start
= this_command_key_count
;
10558 echo_truncate (before_command_echo_length
);
10560 /* Cause whatever we put into unread-command-events
10561 to echo as if it were being freshly read from the keyboard. */
10562 this_command_key_count_reset
= 1;
10567 DEFUN ("clear-this-command-keys", Fclear_this_command_keys
,
10568 Sclear_this_command_keys
, 0, 1, 0,
10569 doc
: /* Clear out the vector that `this-command-keys' returns.
10570 Also clear the record of the last 100 events, unless optional arg
10571 KEEP-RECORD is non-nil. */)
10572 (Lisp_Object keep_record
)
10576 this_command_key_count
= 0;
10577 this_command_key_count_reset
= 0;
10579 if (NILP (keep_record
))
10581 for (i
= 0; i
< ASIZE (recent_keys
); ++i
)
10582 ASET (recent_keys
, i
, Qnil
);
10584 recent_keys_index
= 0;
10589 DEFUN ("recursion-depth", Frecursion_depth
, Srecursion_depth
, 0, 0, 0,
10590 doc
: /* Return the current depth in recursive edits. */)
10594 /* Wrap around reliably on integer overflow. */
10595 EMACS_INT sum
= (command_loop_level
& INTMASK
) + (minibuf_level
& INTMASK
);
10596 XSETINT (temp
, sum
);
10600 DEFUN ("open-dribble-file", Fopen_dribble_file
, Sopen_dribble_file
, 1, 1,
10601 "FOpen dribble file: ",
10602 doc
: /* Start writing all keyboard characters to a dribble file called FILE.
10603 If FILE is nil, close any open dribble file.
10604 The file will be closed when Emacs exits. */)
10616 file
= Fexpand_file_name (file
, Qnil
);
10617 dribble
= fopen (SSDATA (file
), "w");
10619 report_file_error ("Opening dribble", Fcons (file
, Qnil
));
10624 DEFUN ("discard-input", Fdiscard_input
, Sdiscard_input
, 0, 0, 0,
10625 doc
: /* Discard the contents of the terminal input buffer.
10626 Also end any kbd macro being defined. */)
10629 if (!NILP (KVAR (current_kboard
, defining_kbd_macro
)))
10631 /* Discard the last command from the macro. */
10632 Fcancel_kbd_macro_events ();
10636 update_mode_lines
++;
10638 Vunread_command_events
= Qnil
;
10639 unread_command_char
= -1;
10641 discard_tty_input ();
10643 kbd_fetch_ptr
= kbd_store_ptr
;
10649 DEFUN ("suspend-emacs", Fsuspend_emacs
, Ssuspend_emacs
, 0, 1, "",
10650 doc
: /* Stop Emacs and return to superior process. You can resume later.
10651 If `cannot-suspend' is non-nil, or if the system doesn't support job
10652 control, run a subshell instead.
10654 If optional arg STUFFSTRING is non-nil, its characters are stuffed
10655 to be read as terminal input by Emacs's parent, after suspension.
10657 Before suspending, run the normal hook `suspend-hook'.
10658 After resumption run the normal hook `suspend-resume-hook'.
10660 Some operating systems cannot stop the Emacs process and resume it later.
10661 On such systems, Emacs starts a subshell instead of suspending. */)
10662 (Lisp_Object stuffstring
)
10664 ptrdiff_t count
= SPECPDL_INDEX ();
10665 int old_height
, old_width
;
10667 struct gcpro gcpro1
;
10670 if (tty_list
&& tty_list
->next
)
10671 error ("There are other tty frames open; close them before suspending Emacs");
10673 if (!NILP (stuffstring
))
10674 CHECK_STRING (stuffstring
);
10676 /* Run the functions in suspend-hook. */
10677 hook
= intern ("suspend-hook");
10678 Frun_hooks (1, &hook
);
10680 GCPRO1 (stuffstring
);
10681 get_tty_size (fileno (CURTTY ()->input
), &old_width
, &old_height
);
10682 reset_all_sys_modes ();
10683 /* sys_suspend can get an error if it tries to fork a subshell
10684 and the system resources aren't available for that. */
10685 record_unwind_protect ((Lisp_Object (*) (Lisp_Object
)) init_all_sys_modes
,
10687 stuff_buffered_input (stuffstring
);
10688 if (cannot_suspend
)
10692 unbind_to (count
, Qnil
);
10694 /* Check if terminal/window size has changed.
10695 Note that this is not useful when we are running directly
10696 with a window system; but suspend should be disabled in that case. */
10697 get_tty_size (fileno (CURTTY ()->input
), &width
, &height
);
10698 if (width
!= old_width
|| height
!= old_height
)
10699 change_frame_size (SELECTED_FRAME (), height
, width
, 0, 0, 0);
10701 /* Run suspend-resume-hook. */
10702 hook
= intern ("suspend-resume-hook");
10703 Frun_hooks (1, &hook
);
10709 /* If STUFFSTRING is a string, stuff its contents as pending terminal input.
10710 Then in any case stuff anything Emacs has read ahead and not used. */
10713 stuff_buffered_input (Lisp_Object stuffstring
)
10715 #ifdef SIGTSTP /* stuff_char is defined if SIGTSTP. */
10716 register unsigned char *p
;
10718 if (STRINGP (stuffstring
))
10720 register ptrdiff_t count
;
10722 p
= SDATA (stuffstring
);
10723 count
= SBYTES (stuffstring
);
10724 while (count
-- > 0)
10729 /* Anything we have read ahead, put back for the shell to read. */
10730 /* ?? What should this do when we have multiple keyboards??
10731 Should we ignore anything that was typed in at the "wrong" kboard?
10733 rms: we should stuff everything back into the kboard
10735 for (; kbd_fetch_ptr
!= kbd_store_ptr
; kbd_fetch_ptr
++)
10738 if (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
10739 kbd_fetch_ptr
= kbd_buffer
;
10740 if (kbd_fetch_ptr
->kind
== ASCII_KEYSTROKE_EVENT
)
10741 stuff_char (kbd_fetch_ptr
->code
);
10743 clear_event (kbd_fetch_ptr
);
10747 #endif /* SIGTSTP */
10751 set_waiting_for_input (EMACS_TIME
*time_to_clear
)
10753 input_available_clear_time
= time_to_clear
;
10755 /* Tell handle_interrupt to throw back to read_char, */
10756 waiting_for_input
= 1;
10758 /* If handle_interrupt was called before and buffered a C-g,
10759 make it run again now, to avoid timing error. */
10760 if (!NILP (Vquit_flag
))
10761 quit_throw_to_read_char (0);
10765 clear_waiting_for_input (void)
10767 /* Tell handle_interrupt not to throw back to read_char, */
10768 waiting_for_input
= 0;
10769 input_available_clear_time
= 0;
10772 /* The SIGINT handler.
10774 If we have a frame on the controlling tty, we assume that the
10775 SIGINT was generated by C-g, so we call handle_interrupt.
10776 Otherwise, tell QUIT to kill Emacs. */
10779 handle_interrupt_signal (int sig
)
10781 /* See if we have an active terminal on our controlling tty. */
10782 struct terminal
*terminal
= get_named_tty ("/dev/tty");
10785 /* If there are no frames there, let's pretend that we are a
10786 well-behaving UN*X program and quit. We must not call Lisp
10787 in a signal handler, so tell QUIT to exit when it is
10789 Vquit_flag
= Qkill_emacs
;
10793 /* Otherwise, the SIGINT was probably generated by C-g. */
10795 /* Set internal_last_event_frame to the top frame of the
10796 controlling tty, if we have a frame there. We disable the
10797 interrupt key on secondary ttys, so the SIGINT must have come
10798 from the controlling tty. */
10799 internal_last_event_frame
= terminal
->display_info
.tty
->top_frame
;
10801 handle_interrupt ();
10806 deliver_interrupt_signal (int sig
)
10808 handle_on_main_thread (sig
, handle_interrupt_signal
);
10812 /* If Emacs is stuck because `inhibit-quit' is true, then keep track
10813 of the number of times C-g has been requested. If C-g is pressed
10814 enough times, then quit anyway. See bug#6585. */
10815 static int force_quit_count
;
10817 /* This routine is called at interrupt level in response to C-g.
10819 It is called from the SIGINT handler or kbd_buffer_store_event.
10821 If `waiting_for_input' is non zero, then unless `echoing' is
10822 nonzero, immediately throw back to read_char.
10824 Otherwise it sets the Lisp variable quit-flag not-nil. This causes
10825 eval to throw, when it gets a chance. If quit-flag is already
10826 non-nil, it stops the job right away. */
10829 handle_interrupt (void)
10835 /* XXX This code needs to be revised for multi-tty support. */
10836 if (!NILP (Vquit_flag
) && get_named_tty ("/dev/tty"))
10838 /* If SIGINT isn't blocked, don't let us be interrupted by
10839 another SIGINT, it might be harmful due to non-reentrancy
10840 in I/O functions. */
10841 sigblock (sigmask (SIGINT
));
10844 reset_all_sys_modes ();
10846 #ifdef SIGTSTP /* Support possible in later USG versions */
10848 * On systems which can suspend the current process and return to the original
10849 * shell, this command causes the user to end up back at the shell.
10850 * The "Auto-save" and "Abort" questions are not asked until
10851 * the user elects to return to emacs, at which point he can save the current
10852 * job and either dump core or continue.
10856 /* Perhaps should really fork an inferior shell?
10857 But that would not provide any way to get back
10858 to the original shell, ever. */
10859 printf ("No support for stopping a process on this operating system;\n");
10860 printf ("you can continue or abort.\n");
10861 #endif /* not SIGTSTP */
10863 /* We must remain inside the screen area when the internal terminal
10864 is used. Note that [Enter] is not echoed by dos. */
10865 cursor_to (SELECTED_FRAME (), 0, 0);
10867 /* It doesn't work to autosave while GC is in progress;
10868 the code used for auto-saving doesn't cope with the mark bit. */
10869 if (!gc_in_progress
)
10871 printf ("Auto-save? (y or n) ");
10873 if (((c
= getchar ()) & ~040) == 'Y')
10875 Fdo_auto_save (Qt
, Qnil
);
10877 printf ("\r\nAuto-save done");
10878 #else /* not MSDOS */
10879 printf ("Auto-save done\n");
10880 #endif /* not MSDOS */
10882 while (c
!= '\n') c
= getchar ();
10886 /* During GC, it must be safe to reenable quitting again. */
10887 Vinhibit_quit
= Qnil
;
10890 #endif /* not MSDOS */
10891 printf ("Garbage collection in progress; cannot auto-save now\r\n");
10892 printf ("but will instead do a real quit after garbage collection ends\r\n");
10897 printf ("\r\nAbort? (y or n) ");
10898 #else /* not MSDOS */
10899 printf ("Abort (and dump core)? (y or n) ");
10900 #endif /* not MSDOS */
10902 if (((c
= getchar ()) & ~040) == 'Y')
10904 while (c
!= '\n') c
= getchar ();
10906 printf ("\r\nContinuing...\r\n");
10907 #else /* not MSDOS */
10908 printf ("Continuing...\n");
10909 #endif /* not MSDOS */
10911 init_all_sys_modes ();
10916 /* If executing a function that wants to be interrupted out of
10917 and the user has not deferred quitting by binding `inhibit-quit'
10918 then quit right away. */
10919 if (immediate_quit
&& NILP (Vinhibit_quit
))
10921 struct gl_state_s saved
;
10922 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
10924 immediate_quit
= 0;
10927 GCPRO4 (saved
.object
, saved
.global_code
,
10928 saved
.current_syntax_table
, saved
.old_prop
);
10929 Fsignal (Qquit
, Qnil
);
10930 /* FIXME: AFAIK, `quit' can never return, so this code is dead! */
10935 { /* Else request quit when it's safe. */
10936 if (NILP (Vquit_flag
))
10937 force_quit_count
= 0;
10938 if (++force_quit_count
== 3)
10940 immediate_quit
= 1;
10941 Vinhibit_quit
= Qnil
;
10947 /* TODO: The longjmp in this call throws the NS event loop integration off,
10948 and it seems to do fine without this. Probably some attention
10949 needs to be paid to the setting of waiting_for_input in
10950 wait_reading_process_output() under HAVE_NS because of the call
10951 to ns_select there (needed because otherwise events aren't picked up
10952 outside of polling since we don't get SIGIO like X and we don't have a
10953 separate event loop thread like W32. */
10955 if (waiting_for_input
&& !echoing
)
10956 quit_throw_to_read_char (1);
10960 /* Handle a C-g by making read_char return C-g. */
10963 quit_throw_to_read_char (int from_signal
)
10965 /* When not called from a signal handler it is safe to call
10967 if (!from_signal
&& EQ (Vquit_flag
, Qkill_emacs
))
10968 Fkill_emacs (Qnil
);
10971 /* Prevent another signal from doing this before we finish. */
10972 clear_waiting_for_input ();
10975 Vunread_command_events
= Qnil
;
10976 unread_command_char
= -1;
10978 #if 0 /* Currently, sit_for is called from read_char without turning
10979 off polling. And that can call set_waiting_for_input.
10980 It seems to be harmless. */
10981 #ifdef POLL_FOR_INPUT
10982 /* May be > 1 if in recursive minibuffer. */
10983 if (poll_suppress_count
== 0)
10987 if (FRAMEP (internal_last_event_frame
)
10988 && !EQ (internal_last_event_frame
, selected_frame
))
10989 do_switch_frame (make_lispy_switch_frame (internal_last_event_frame
),
10992 _longjmp (getcjmp
, 1);
10995 DEFUN ("set-input-interrupt-mode", Fset_input_interrupt_mode
,
10996 Sset_input_interrupt_mode
, 1, 1, 0,
10997 doc
: /* Set interrupt mode of reading keyboard input.
10998 If INTERRUPT is non-nil, Emacs will use input interrupts;
10999 otherwise Emacs uses CBREAK mode.
11001 See also `current-input-mode'. */)
11002 (Lisp_Object interrupt
)
11004 int new_interrupt_input
;
11006 /* Note SIGIO has been undef'd if FIONREAD is missing. */
11007 #ifdef HAVE_X_WINDOWS
11008 if (x_display_list
!= NULL
)
11010 /* When using X, don't give the user a real choice,
11011 because we haven't implemented the mechanisms to support it. */
11012 new_interrupt_input
= 1;
11015 #endif /* HAVE_X_WINDOWS */
11016 new_interrupt_input
= !NILP (interrupt
);
11017 #else /* not SIGIO */
11018 new_interrupt_input
= 0;
11019 #endif /* not SIGIO */
11021 if (new_interrupt_input
!= interrupt_input
)
11023 #ifdef POLL_FOR_INPUT
11027 /* this causes startup screen to be restored and messes with the mouse */
11028 reset_all_sys_modes ();
11029 interrupt_input
= new_interrupt_input
;
11030 init_all_sys_modes ();
11032 interrupt_input
= new_interrupt_input
;
11035 #ifdef POLL_FOR_INPUT
11036 poll_suppress_count
= 1;
11043 DEFUN ("set-output-flow-control", Fset_output_flow_control
, Sset_output_flow_control
, 1, 2, 0,
11044 doc
: /* Enable or disable ^S/^Q flow control for output to TERMINAL.
11045 If FLOW is non-nil, flow control is enabled and you cannot use C-s or
11046 C-q in key sequences.
11048 This setting only has an effect on tty terminals and only when
11049 Emacs reads input in CBREAK mode; see `set-input-interrupt-mode'.
11051 See also `current-input-mode'. */)
11052 (Lisp_Object flow
, Lisp_Object terminal
)
11054 struct terminal
*t
= get_terminal (terminal
, 1);
11055 struct tty_display_info
*tty
;
11056 if (t
== NULL
|| (t
->type
!= output_termcap
&& t
->type
!= output_msdos_raw
))
11058 tty
= t
->display_info
.tty
;
11060 if (tty
->flow_control
!= !NILP (flow
))
11063 /* this causes startup screen to be restored and messes with the mouse */
11064 reset_sys_modes (tty
);
11067 tty
->flow_control
= !NILP (flow
);
11070 init_sys_modes (tty
);
11076 DEFUN ("set-input-meta-mode", Fset_input_meta_mode
, Sset_input_meta_mode
, 1, 2, 0,
11077 doc
: /* Enable or disable 8-bit input on TERMINAL.
11078 If META is t, Emacs will accept 8-bit input, and interpret the 8th
11079 bit as the Meta modifier.
11081 If META is nil, Emacs will ignore the top bit, on the assumption it is
11084 Otherwise, Emacs will accept and pass through 8-bit input without
11085 specially interpreting the top bit.
11087 This setting only has an effect on tty terminal devices.
11089 Optional parameter TERMINAL specifies the tty terminal device to use.
11090 It may be a terminal object, a frame, or nil for the terminal used by
11091 the currently selected frame.
11093 See also `current-input-mode'. */)
11094 (Lisp_Object meta
, Lisp_Object terminal
)
11096 struct terminal
*t
= get_terminal (terminal
, 1);
11097 struct tty_display_info
*tty
;
11100 if (t
== NULL
|| (t
->type
!= output_termcap
&& t
->type
!= output_msdos_raw
))
11102 tty
= t
->display_info
.tty
;
11106 else if (EQ (meta
, Qt
))
11111 if (tty
->meta_key
!= new_meta
)
11114 /* this causes startup screen to be restored and messes with the mouse */
11115 reset_sys_modes (tty
);
11118 tty
->meta_key
= new_meta
;
11121 init_sys_modes (tty
);
11127 DEFUN ("set-quit-char", Fset_quit_char
, Sset_quit_char
, 1, 1, 0,
11128 doc
: /* Specify character used for quitting.
11129 QUIT must be an ASCII character.
11131 This function only has an effect on the controlling tty of the Emacs
11134 See also `current-input-mode'. */)
11137 struct terminal
*t
= get_named_tty ("/dev/tty");
11138 struct tty_display_info
*tty
;
11139 if (t
== NULL
|| (t
->type
!= output_termcap
&& t
->type
!= output_msdos_raw
))
11141 tty
= t
->display_info
.tty
;
11143 if (NILP (quit
) || !INTEGERP (quit
) || XINT (quit
) < 0 || XINT (quit
) > 0400)
11144 error ("QUIT must be an ASCII character");
11147 /* this causes startup screen to be restored and messes with the mouse */
11148 reset_sys_modes (tty
);
11151 /* Don't let this value be out of range. */
11152 quit_char
= XINT (quit
) & (tty
->meta_key
== 0 ? 0177 : 0377);
11155 init_sys_modes (tty
);
11161 DEFUN ("set-input-mode", Fset_input_mode
, Sset_input_mode
, 3, 4, 0,
11162 doc
: /* Set mode of reading keyboard input.
11163 First arg INTERRUPT non-nil means use input interrupts;
11164 nil means use CBREAK mode.
11165 Second arg FLOW non-nil means use ^S/^Q flow control for output to terminal
11166 (no effect except in CBREAK mode).
11167 Third arg META t means accept 8-bit input (for a Meta key).
11168 META nil means ignore the top bit, on the assumption it is parity.
11169 Otherwise, accept 8-bit input and don't use the top bit for Meta.
11170 Optional fourth arg QUIT if non-nil specifies character to use for quitting.
11171 See also `current-input-mode'. */)
11172 (Lisp_Object interrupt
, Lisp_Object flow
, Lisp_Object meta
, Lisp_Object quit
)
11174 Fset_input_interrupt_mode (interrupt
);
11175 Fset_output_flow_control (flow
, Qnil
);
11176 Fset_input_meta_mode (meta
, Qnil
);
11178 Fset_quit_char (quit
);
11182 DEFUN ("current-input-mode", Fcurrent_input_mode
, Scurrent_input_mode
, 0, 0, 0,
11183 doc
: /* Return information about the way Emacs currently reads keyboard input.
11184 The value is a list of the form (INTERRUPT FLOW META QUIT), where
11185 INTERRUPT is non-nil if Emacs is using interrupt-driven input; if
11186 nil, Emacs is using CBREAK mode.
11187 FLOW is non-nil if Emacs uses ^S/^Q flow control for output to the
11188 terminal; this does not apply if Emacs uses interrupt-driven input.
11189 META is t if accepting 8-bit input with 8th bit as Meta flag.
11190 META nil means ignoring the top bit, on the assumption it is parity.
11191 META is neither t nor nil if accepting 8-bit input and using
11192 all 8 bits as the character code.
11193 QUIT is the character Emacs currently uses to quit.
11194 The elements of this list correspond to the arguments of
11195 `set-input-mode'. */)
11198 Lisp_Object val
[4];
11199 struct frame
*sf
= XFRAME (selected_frame
);
11201 val
[0] = interrupt_input
? Qt
: Qnil
;
11202 if (FRAME_TERMCAP_P (sf
) || FRAME_MSDOS_P (sf
))
11204 val
[1] = FRAME_TTY (sf
)->flow_control
? Qt
: Qnil
;
11205 val
[2] = (FRAME_TTY (sf
)->meta_key
== 2
11207 : (CURTTY ()->meta_key
== 1 ? Qt
: Qnil
));
11214 XSETFASTINT (val
[3], quit_char
);
11216 return Flist (sizeof (val
) / sizeof (val
[0]), val
);
11219 DEFUN ("posn-at-x-y", Fposn_at_x_y
, Sposn_at_x_y
, 2, 4, 0,
11220 doc
: /* Return position information for pixel coordinates X and Y.
11221 By default, X and Y are relative to text area of the selected window.
11222 Optional third arg FRAME-OR-WINDOW non-nil specifies frame or window.
11223 If optional fourth arg WHOLE is non-nil, X is relative to the left
11224 edge of the window.
11226 The return value is similar to a mouse click position:
11227 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
11228 IMAGE (DX . DY) (WIDTH . HEIGHT))
11229 The `posn-' functions access elements of such lists. */)
11230 (Lisp_Object x
, Lisp_Object y
, Lisp_Object frame_or_window
, Lisp_Object whole
)
11235 if (NILP (frame_or_window
))
11236 frame_or_window
= selected_window
;
11238 if (WINDOWP (frame_or_window
))
11240 struct window
*w
= decode_live_window (frame_or_window
);
11242 XSETINT (x
, (XINT (x
)
11243 + WINDOW_LEFT_EDGE_X (w
)
11245 ? window_box_left_offset (w
, TEXT_AREA
)
11247 XSETINT (y
, WINDOW_TO_FRAME_PIXEL_Y (w
, XINT (y
)));
11248 frame_or_window
= w
->frame
;
11251 CHECK_LIVE_FRAME (frame_or_window
);
11253 return make_lispy_position (XFRAME (frame_or_window
), x
, y
, 0);
11256 DEFUN ("posn-at-point", Fposn_at_point
, Sposn_at_point
, 0, 2, 0,
11257 doc
: /* Return position information for buffer POS in WINDOW.
11258 POS defaults to point in WINDOW; WINDOW defaults to the selected window.
11260 Return nil if position is not visible in window. Otherwise,
11261 the return value is similar to that returned by `event-start' for
11262 a mouse click at the upper left corner of the glyph corresponding
11263 to the given buffer position:
11264 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
11265 IMAGE (DX . DY) (WIDTH . HEIGHT))
11266 The `posn-' functions access elements of such lists. */)
11267 (Lisp_Object pos
, Lisp_Object window
)
11272 window
= selected_window
;
11274 tem
= Fpos_visible_in_window_p (pos
, window
, Qt
);
11277 Lisp_Object x
= XCAR (tem
);
11278 Lisp_Object y
= XCAR (XCDR (tem
));
11280 /* Point invisible due to hscrolling? */
11283 tem
= Fposn_at_x_y (x
, y
, window
, Qnil
);
11291 * Set up a new kboard object with reasonable initial values.
11294 init_kboard (KBOARD
*kb
)
11296 kset_overriding_terminal_local_map (kb
, Qnil
);
11297 kset_last_command (kb
, Qnil
);
11298 kset_real_last_command (kb
, Qnil
);
11299 kset_keyboard_translate_table (kb
, Qnil
);
11300 kset_last_repeatable_command (kb
, Qnil
);
11301 kset_prefix_arg (kb
, Qnil
);
11302 kset_last_prefix_arg (kb
, Qnil
);
11303 kset_kbd_queue (kb
, Qnil
);
11304 kb
->kbd_queue_has_data
= 0;
11305 kb
->immediate_echo
= 0;
11306 kset_echo_string (kb
, Qnil
);
11307 kb
->echo_after_prompt
= -1;
11308 kb
->kbd_macro_buffer
= 0;
11309 kb
->kbd_macro_bufsize
= 0;
11310 kset_defining_kbd_macro (kb
, Qnil
);
11311 kset_last_kbd_macro (kb
, Qnil
);
11312 kb
->reference_count
= 0;
11313 kset_system_key_alist (kb
, Qnil
);
11314 kset_system_key_syms (kb
, Qnil
);
11315 kset_window_system (kb
, Qt
); /* Unset. */
11316 kset_input_decode_map (kb
, Fmake_sparse_keymap (Qnil
));
11317 kset_local_function_key_map (kb
, Fmake_sparse_keymap (Qnil
));
11318 Fset_keymap_parent (KVAR (kb
, Vlocal_function_key_map
), Vfunction_key_map
);
11319 kset_default_minibuffer_frame (kb
, Qnil
);
11323 * Destroy the contents of a kboard object, but not the object itself.
11324 * We use this just before deleting it, or if we're going to initialize
11325 * it a second time.
11328 wipe_kboard (KBOARD
*kb
)
11330 xfree (kb
->kbd_macro_buffer
);
11333 /* Free KB and memory referenced from it. */
11336 delete_kboard (KBOARD
*kb
)
11340 for (kbp
= &all_kboards
; *kbp
!= kb
; kbp
= &(*kbp
)->next_kboard
)
11343 *kbp
= kb
->next_kboard
;
11345 /* Prevent a dangling reference to KB. */
11346 if (kb
== current_kboard
11347 && FRAMEP (selected_frame
)
11348 && FRAME_LIVE_P (XFRAME (selected_frame
)))
11350 current_kboard
= FRAME_KBOARD (XFRAME (selected_frame
));
11352 if (current_kboard
== kb
)
11361 init_keyboard (void)
11363 /* This is correct before outermost invocation of the editor loop */
11364 command_loop_level
= -1;
11365 immediate_quit
= 0;
11366 quit_char
= Ctl ('g');
11367 Vunread_command_events
= Qnil
;
11368 unread_command_char
= -1;
11369 timer_idleness_start_time
= invalid_emacs_time ();
11371 recent_keys_index
= 0;
11372 kbd_fetch_ptr
= kbd_buffer
;
11373 kbd_store_ptr
= kbd_buffer
;
11374 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
11375 do_mouse_tracking
= Qnil
;
11378 interrupt_input_blocked
= 0;
11379 interrupt_input_pending
= 0;
11381 pending_signals
= 0;
11384 /* This means that command_loop_1 won't try to select anything the first
11386 internal_last_event_frame
= Qnil
;
11387 Vlast_event_frame
= internal_last_event_frame
;
11389 current_kboard
= initial_kboard
;
11390 /* Re-initialize the keyboard again. */
11391 wipe_kboard (current_kboard
);
11392 init_kboard (current_kboard
);
11393 /* A value of nil for Vwindow_system normally means a tty, but we also use
11394 it for the initial terminal since there is no window system there. */
11395 kset_window_system (current_kboard
, Qnil
);
11397 if (!noninteractive
)
11399 /* Before multi-tty support, these handlers used to be installed
11400 only if the current session was a tty session. Now an Emacs
11401 session may have multiple display types, so we always handle
11402 SIGINT. There is special code in interrupt_signal to exit
11403 Emacs on SIGINT when there are no termcap frames on the
11404 controlling terminal. */
11405 signal (SIGINT
, deliver_interrupt_signal
);
11407 /* For systems with SysV TERMIO, C-g is set up for both SIGINT and
11408 SIGQUIT and we can't tell which one it will give us. */
11409 signal (SIGQUIT
, deliver_interrupt_signal
);
11410 #endif /* not DOS_NT */
11412 /* Note SIGIO has been undef'd if FIONREAD is missing. */
11414 if (!noninteractive
)
11415 signal (SIGIO
, deliver_input_available_signal
);
11418 /* Use interrupt input by default, if it works and noninterrupt input
11419 has deficiencies. */
11421 #ifdef INTERRUPT_INPUT
11422 interrupt_input
= 1;
11424 interrupt_input
= 0;
11430 if (keyboard_init_hook
)
11431 (*keyboard_init_hook
) ();
11433 #ifdef POLL_FOR_INPUT
11435 poll_suppress_count
= 1;
11440 /* This type's only use is in syms_of_keyboard, to initialize the
11441 event header symbols and put properties on them. */
11442 struct event_head
{
11448 static const struct event_head head_table
[] = {
11449 {&Qmouse_movement
, "mouse-movement", &Qmouse_movement
},
11450 {&Qscroll_bar_movement
, "scroll-bar-movement", &Qmouse_movement
},
11451 {&Qswitch_frame
, "switch-frame", &Qswitch_frame
},
11452 {&Qdelete_frame
, "delete-frame", &Qdelete_frame
},
11453 {&Qiconify_frame
, "iconify-frame", &Qiconify_frame
},
11454 {&Qmake_frame_visible
, "make-frame-visible", &Qmake_frame_visible
},
11455 /* `select-window' should be handled just like `switch-frame'
11456 in read_key_sequence. */
11457 {&Qselect_window
, "select-window", &Qswitch_frame
}
11461 syms_of_keyboard (void)
11463 pending_funcalls
= Qnil
;
11464 staticpro (&pending_funcalls
);
11466 Vlispy_mouse_stem
= build_pure_c_string ("mouse");
11467 staticpro (&Vlispy_mouse_stem
);
11470 DEFSYM (QCimage
, ":image");
11471 DEFSYM (Qhelp_echo
, "help-echo");
11472 DEFSYM (QCrtl
, ":rtl");
11474 staticpro (&item_properties
);
11475 item_properties
= Qnil
;
11477 staticpro (&tool_bar_item_properties
);
11478 tool_bar_item_properties
= Qnil
;
11479 staticpro (&tool_bar_items_vector
);
11480 tool_bar_items_vector
= Qnil
;
11482 DEFSYM (Qtimer_event_handler
, "timer-event-handler");
11483 DEFSYM (Qdisabled_command_function
, "disabled-command-function");
11484 DEFSYM (Qself_insert_command
, "self-insert-command");
11485 DEFSYM (Qforward_char
, "forward-char");
11486 DEFSYM (Qbackward_char
, "backward-char");
11487 DEFSYM (Qdisabled
, "disabled");
11488 DEFSYM (Qundefined
, "undefined");
11489 DEFSYM (Qpre_command_hook
, "pre-command-hook");
11490 DEFSYM (Qpost_command_hook
, "post-command-hook");
11491 DEFSYM (Qdeferred_action_function
, "deferred-action-function");
11492 DEFSYM (Qdelayed_warnings_hook
, "delayed-warnings-hook");
11493 DEFSYM (Qfunction_key
, "function-key");
11494 DEFSYM (Qmouse_click
, "mouse-click");
11495 DEFSYM (Qdrag_n_drop
, "drag-n-drop");
11496 DEFSYM (Qsave_session
, "save-session");
11497 DEFSYM (Qconfig_changed_event
, "config-changed-event");
11498 DEFSYM (Qmenu_enable
, "menu-enable");
11500 #if defined (WINDOWSNT)
11501 DEFSYM (Qlanguage_change
, "language-change");
11505 DEFSYM (Qdbus_event
, "dbus-event");
11508 DEFSYM (QCenable
, ":enable");
11509 DEFSYM (QCvisible
, ":visible");
11510 DEFSYM (QChelp
, ":help");
11511 DEFSYM (QCfilter
, ":filter");
11512 DEFSYM (QCbutton
, ":button");
11513 DEFSYM (QCkeys
, ":keys");
11514 DEFSYM (QCkey_sequence
, ":key-sequence");
11515 DEFSYM (QCtoggle
, ":toggle");
11516 DEFSYM (QCradio
, ":radio");
11517 DEFSYM (QClabel
, ":label");
11518 DEFSYM (QCvert_only
, ":vert-only");
11520 DEFSYM (Qmode_line
, "mode-line");
11521 DEFSYM (Qvertical_line
, "vertical-line");
11522 DEFSYM (Qvertical_scroll_bar
, "vertical-scroll-bar");
11523 DEFSYM (Qmenu_bar
, "menu-bar");
11525 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
11526 DEFSYM (Qmouse_fixup_help_message
, "mouse-fixup-help-message");
11529 DEFSYM (Qabove_handle
, "above-handle");
11530 DEFSYM (Qhandle
, "handle");
11531 DEFSYM (Qbelow_handle
, "below-handle");
11532 DEFSYM (Qup
, "up");
11533 DEFSYM (Qdown
, "down");
11534 DEFSYM (Qtop
, "top");
11535 DEFSYM (Qbottom
, "bottom");
11536 DEFSYM (Qend_scroll
, "end-scroll");
11537 DEFSYM (Qratio
, "ratio");
11539 DEFSYM (Qevent_kind
, "event-kind");
11540 DEFSYM (Qevent_symbol_elements
, "event-symbol-elements");
11541 DEFSYM (Qevent_symbol_element_mask
, "event-symbol-element-mask");
11542 DEFSYM (Qmodifier_cache
, "modifier-cache");
11544 DEFSYM (Qrecompute_lucid_menubar
, "recompute-lucid-menubar");
11545 DEFSYM (Qactivate_menubar_hook
, "activate-menubar-hook");
11547 DEFSYM (Qpolling_period
, "polling-period");
11549 DEFSYM (Qx_set_selection
, "x-set-selection");
11550 DEFSYM (QPRIMARY
, "PRIMARY");
11551 DEFSYM (Qhandle_switch_frame
, "handle-switch-frame");
11552 DEFSYM (Qhandle_select_window
, "handle-select-window");
11554 DEFSYM (Qinput_method_function
, "input-method-function");
11555 DEFSYM (Qinput_method_exit_on_first_char
, "input-method-exit-on-first-char");
11556 DEFSYM (Qinput_method_use_echo_area
, "input-method-use-echo-area");
11558 DEFSYM (Qhelp_form_show
, "help-form-show");
11560 Fset (Qinput_method_exit_on_first_char
, Qnil
);
11561 Fset (Qinput_method_use_echo_area
, Qnil
);
11563 last_point_position_buffer
= Qnil
;
11564 last_point_position_window
= Qnil
;
11568 int len
= sizeof (head_table
) / sizeof (head_table
[0]);
11570 for (i
= 0; i
< len
; i
++)
11572 const struct event_head
*p
= &head_table
[i
];
11573 *p
->var
= intern_c_string (p
->name
);
11574 staticpro (p
->var
);
11575 Fput (*p
->var
, Qevent_kind
, *p
->kind
);
11576 Fput (*p
->var
, Qevent_symbol_elements
, Fcons (*p
->var
, Qnil
));
11580 button_down_location
= Fmake_vector (make_number (5), Qnil
);
11581 staticpro (&button_down_location
);
11582 mouse_syms
= Fmake_vector (make_number (5), Qnil
);
11583 staticpro (&mouse_syms
);
11584 wheel_syms
= Fmake_vector (make_number (sizeof (lispy_wheel_names
)
11585 / sizeof (lispy_wheel_names
[0])),
11587 staticpro (&wheel_syms
);
11591 int len
= sizeof (modifier_names
) / sizeof (modifier_names
[0]);
11593 modifier_symbols
= Fmake_vector (make_number (len
), Qnil
);
11594 for (i
= 0; i
< len
; i
++)
11595 if (modifier_names
[i
])
11596 ASET (modifier_symbols
, i
, intern_c_string (modifier_names
[i
]));
11597 staticpro (&modifier_symbols
);
11600 recent_keys
= Fmake_vector (make_number (NUM_RECENT_KEYS
), Qnil
);
11601 staticpro (&recent_keys
);
11603 this_command_keys
= Fmake_vector (make_number (40), Qnil
);
11604 staticpro (&this_command_keys
);
11606 raw_keybuf
= Fmake_vector (make_number (30), Qnil
);
11607 staticpro (&raw_keybuf
);
11609 DEFSYM (Qextended_command_history
, "extended-command-history");
11610 Fset (Qextended_command_history
, Qnil
);
11612 accent_key_syms
= Qnil
;
11613 staticpro (&accent_key_syms
);
11615 func_key_syms
= Qnil
;
11616 staticpro (&func_key_syms
);
11618 drag_n_drop_syms
= Qnil
;
11619 staticpro (&drag_n_drop_syms
);
11621 unread_switch_frame
= Qnil
;
11622 staticpro (&unread_switch_frame
);
11624 internal_last_event_frame
= Qnil
;
11625 staticpro (&internal_last_event_frame
);
11627 read_key_sequence_cmd
= Qnil
;
11628 staticpro (&read_key_sequence_cmd
);
11629 read_key_sequence_remapped
= Qnil
;
11630 staticpro (&read_key_sequence_remapped
);
11632 menu_bar_one_keymap_changed_items
= Qnil
;
11633 staticpro (&menu_bar_one_keymap_changed_items
);
11635 menu_bar_items_vector
= Qnil
;
11636 staticpro (&menu_bar_items_vector
);
11638 help_form_saved_window_configs
= Qnil
;
11639 staticpro (&help_form_saved_window_configs
);
11641 defsubr (&Scurrent_idle_time
);
11642 defsubr (&Sevent_symbol_parse_modifiers
);
11643 defsubr (&Sevent_convert_list
);
11644 defsubr (&Sread_key_sequence
);
11645 defsubr (&Sread_key_sequence_vector
);
11646 defsubr (&Srecursive_edit
);
11647 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
11648 defsubr (&Strack_mouse
);
11650 defsubr (&Sinput_pending_p
);
11651 defsubr (&Scommand_execute
);
11652 defsubr (&Srecent_keys
);
11653 defsubr (&Sthis_command_keys
);
11654 defsubr (&Sthis_command_keys_vector
);
11655 defsubr (&Sthis_single_command_keys
);
11656 defsubr (&Sthis_single_command_raw_keys
);
11657 defsubr (&Sreset_this_command_lengths
);
11658 defsubr (&Sclear_this_command_keys
);
11659 defsubr (&Ssuspend_emacs
);
11660 defsubr (&Sabort_recursive_edit
);
11661 defsubr (&Sexit_recursive_edit
);
11662 defsubr (&Srecursion_depth
);
11663 defsubr (&Stop_level
);
11664 defsubr (&Sdiscard_input
);
11665 defsubr (&Sopen_dribble_file
);
11666 defsubr (&Sset_input_interrupt_mode
);
11667 defsubr (&Sset_output_flow_control
);
11668 defsubr (&Sset_input_meta_mode
);
11669 defsubr (&Sset_quit_char
);
11670 defsubr (&Sset_input_mode
);
11671 defsubr (&Scurrent_input_mode
);
11672 defsubr (&Sposn_at_point
);
11673 defsubr (&Sposn_at_x_y
);
11675 DEFVAR_LISP ("last-command-event", last_command_event
,
11676 doc
: /* Last input event that was part of a command. */);
11678 DEFVAR_LISP ("last-nonmenu-event", last_nonmenu_event
,
11679 doc
: /* Last input event in a command, except for mouse menu events.
11680 Mouse menus give back keys that don't look like mouse events;
11681 this variable holds the actual mouse event that led to the menu,
11682 so that you can determine whether the command was run by mouse or not. */);
11684 DEFVAR_LISP ("last-input-event", last_input_event
,
11685 doc
: /* Last input event. */);
11687 DEFVAR_LISP ("unread-command-events", Vunread_command_events
,
11688 doc
: /* List of events to be read as the command input.
11689 These events are processed first, before actual keyboard input.
11690 Events read from this list are not normally added to `this-command-keys',
11691 as they will already have been added once as they were read for the first time.
11692 An element of the form (t . EVENT) forces EVENT to be added to that list. */);
11693 Vunread_command_events
= Qnil
;
11695 DEFVAR_INT ("unread-command-char", unread_command_char
,
11696 doc
: /* If not -1, an object to be read as next command input event. */);
11698 DEFVAR_LISP ("unread-post-input-method-events", Vunread_post_input_method_events
,
11699 doc
: /* List of events to be processed as input by input methods.
11700 These events are processed before `unread-command-events'
11701 and actual keyboard input, but are not given to `input-method-function'. */);
11702 Vunread_post_input_method_events
= Qnil
;
11704 DEFVAR_LISP ("unread-input-method-events", Vunread_input_method_events
,
11705 doc
: /* List of events to be processed as input by input methods.
11706 These events are processed after `unread-command-events', but
11707 before actual keyboard input.
11708 If there's an active input method, the events are given to
11709 `input-method-function'. */);
11710 Vunread_input_method_events
= Qnil
;
11712 DEFVAR_LISP ("meta-prefix-char", meta_prefix_char
,
11713 doc
: /* Meta-prefix character code.
11714 Meta-foo as command input turns into this character followed by foo. */);
11715 XSETINT (meta_prefix_char
, 033);
11717 DEFVAR_KBOARD ("last-command", Vlast_command
,
11718 doc
: /* The last command executed.
11719 Normally a symbol with a function definition, but can be whatever was found
11720 in the keymap, or whatever the variable `this-command' was set to by that
11723 The value `mode-exit' is special; it means that the previous command
11724 read an event that told it to exit, and it did so and unread that event.
11725 In other words, the present command is the event that made the previous
11728 The value `kill-region' is special; it means that the previous command
11729 was a kill command.
11731 `last-command' has a separate binding for each terminal device.
11732 See Info node `(elisp)Multiple Terminals'. */);
11734 DEFVAR_KBOARD ("real-last-command", Vreal_last_command
,
11735 doc
: /* Same as `last-command', but never altered by Lisp code.
11736 Taken from the previous value of `real-this-command'. */);
11738 DEFVAR_KBOARD ("last-repeatable-command", Vlast_repeatable_command
,
11739 doc
: /* Last command that may be repeated.
11740 The last command executed that was not bound to an input event.
11741 This is the command `repeat' will try to repeat.
11742 Taken from a previous value of `real-this-command'. */);
11744 DEFVAR_LISP ("this-command", Vthis_command
,
11745 doc
: /* The command now being executed.
11746 The command can set this variable; whatever is put here
11747 will be in `last-command' during the following command. */);
11748 Vthis_command
= Qnil
;
11750 DEFVAR_LISP ("real-this-command", Vreal_this_command
,
11751 doc
: /* This is like `this-command', except that commands should never modify it. */);
11752 Vreal_this_command
= Qnil
;
11754 DEFVAR_LISP ("this-command-keys-shift-translated",
11755 Vthis_command_keys_shift_translated
,
11756 doc
: /* Non-nil if the key sequence activating this command was shift-translated.
11757 Shift-translation occurs when there is no binding for the key sequence
11758 as entered, but a binding was found by changing an upper-case letter
11759 to lower-case, or a shifted function key to an unshifted one. */);
11760 Vthis_command_keys_shift_translated
= Qnil
;
11762 DEFVAR_LISP ("this-original-command", Vthis_original_command
,
11763 doc
: /* The command bound to the current key sequence before remapping.
11764 It equals `this-command' if the original command was not remapped through
11765 any of the active keymaps. Otherwise, the value of `this-command' is the
11766 result of looking up the original command in the active keymaps. */);
11767 Vthis_original_command
= Qnil
;
11769 DEFVAR_INT ("auto-save-interval", auto_save_interval
,
11770 doc
: /* Number of input events between auto-saves.
11771 Zero means disable autosaving due to number of characters typed. */);
11772 auto_save_interval
= 300;
11774 DEFVAR_LISP ("auto-save-timeout", Vauto_save_timeout
,
11775 doc
: /* Number of seconds idle time before auto-save.
11776 Zero or nil means disable auto-saving due to idleness.
11777 After auto-saving due to this many seconds of idle time,
11778 Emacs also does a garbage collection if that seems to be warranted. */);
11779 XSETFASTINT (Vauto_save_timeout
, 30);
11781 DEFVAR_LISP ("echo-keystrokes", Vecho_keystrokes
,
11782 doc
: /* Nonzero means echo unfinished commands after this many seconds of pause.
11783 The value may be integer or floating point.
11784 If the value is zero, don't echo at all. */);
11785 Vecho_keystrokes
= make_number (1);
11787 DEFVAR_INT ("polling-period", polling_period
,
11788 doc
: /* Interval between polling for input during Lisp execution.
11789 The reason for polling is to make C-g work to stop a running program.
11790 Polling is needed only when using X windows and SIGIO does not work.
11791 Polling is automatically disabled in all other cases. */);
11792 polling_period
= 2;
11794 DEFVAR_LISP ("double-click-time", Vdouble_click_time
,
11795 doc
: /* Maximum time between mouse clicks to make a double-click.
11796 Measured in milliseconds. The value nil means disable double-click
11797 recognition; t means double-clicks have no time limit and are detected
11798 by position only. */);
11799 Vdouble_click_time
= make_number (500);
11801 DEFVAR_INT ("double-click-fuzz", double_click_fuzz
,
11802 doc
: /* Maximum mouse movement between clicks to make a double-click.
11803 On window-system frames, value is the number of pixels the mouse may have
11804 moved horizontally or vertically between two clicks to make a double-click.
11805 On non window-system frames, value is interpreted in units of 1/8 characters
11808 This variable is also the threshold for motion of the mouse
11809 to count as a drag. */);
11810 double_click_fuzz
= 3;
11812 DEFVAR_BOOL ("inhibit-local-menu-bar-menus", inhibit_local_menu_bar_menus
,
11813 doc
: /* Non-nil means inhibit local map menu bar menus. */);
11814 inhibit_local_menu_bar_menus
= 0;
11816 DEFVAR_INT ("num-input-keys", num_input_keys
,
11817 doc
: /* Number of complete key sequences read as input so far.
11818 This includes key sequences read from keyboard macros.
11819 The number is effectively the number of interactive command invocations. */);
11820 num_input_keys
= 0;
11822 DEFVAR_INT ("num-nonmacro-input-events", num_nonmacro_input_events
,
11823 doc
: /* Number of input events read from the keyboard so far.
11824 This does not include events generated by keyboard macros. */);
11825 num_nonmacro_input_events
= 0;
11827 DEFVAR_LISP ("last-event-frame", Vlast_event_frame
,
11828 doc
: /* The frame in which the most recently read event occurred.
11829 If the last event came from a keyboard macro, this is set to `macro'. */);
11830 Vlast_event_frame
= Qnil
;
11832 /* This variable is set up in sysdep.c. */
11833 DEFVAR_LISP ("tty-erase-char", Vtty_erase_char
,
11834 doc
: /* The ERASE character as set by the user with stty. */);
11836 DEFVAR_LISP ("help-char", Vhelp_char
,
11837 doc
: /* Character to recognize as meaning Help.
11838 When it is read, do `(eval help-form)', and display result if it's a string.
11839 If the value of `help-form' is nil, this char can be read normally. */);
11840 XSETINT (Vhelp_char
, Ctl ('H'));
11842 DEFVAR_LISP ("help-event-list", Vhelp_event_list
,
11843 doc
: /* List of input events to recognize as meaning Help.
11844 These work just like the value of `help-char' (see that). */);
11845 Vhelp_event_list
= Qnil
;
11847 DEFVAR_LISP ("help-form", Vhelp_form
,
11848 doc
: /* Form to execute when character `help-char' is read.
11849 If the form returns a string, that string is displayed.
11850 If `help-form' is nil, the help char is not recognized. */);
11853 DEFVAR_LISP ("prefix-help-command", Vprefix_help_command
,
11854 doc
: /* Command to run when `help-char' character follows a prefix key.
11855 This command is used only when there is no actual binding
11856 for that character after that prefix key. */);
11857 Vprefix_help_command
= Qnil
;
11859 DEFVAR_LISP ("top-level", Vtop_level
,
11860 doc
: /* Form to evaluate when Emacs starts up.
11861 Useful to set before you dump a modified Emacs. */);
11864 DEFVAR_KBOARD ("keyboard-translate-table", Vkeyboard_translate_table
,
11865 doc
: /* Translate table for local keyboard input, or nil.
11866 If non-nil, the value should be a char-table. Each character read
11867 from the keyboard is looked up in this char-table. If the value found
11868 there is non-nil, then it is used instead of the actual input character.
11870 The value can also be a string or vector, but this is considered obsolete.
11871 If it is a string or vector of length N, character codes N and up are left
11872 untranslated. In a vector, an element which is nil means "no translation".
11874 This is applied to the characters supplied to input methods, not their
11875 output. See also `translation-table-for-input'.
11877 This variable has a separate binding for each terminal.
11878 See Info node `(elisp)Multiple Terminals'. */);
11880 DEFVAR_BOOL ("cannot-suspend", cannot_suspend
,
11881 doc
: /* Non-nil means to always spawn a subshell instead of suspending.
11882 \(Even if the operating system has support for stopping a process.\) */);
11883 cannot_suspend
= 0;
11885 DEFVAR_BOOL ("menu-prompting", menu_prompting
,
11886 doc
: /* Non-nil means prompt with menus when appropriate.
11887 This is done when reading from a keymap that has a prompt string,
11888 for elements that have prompt strings.
11889 The menu is displayed on the screen
11890 if X menus were enabled at configuration
11891 time and the previous event was a mouse click prefix key.
11892 Otherwise, menu prompting uses the echo area. */);
11893 menu_prompting
= 1;
11895 DEFVAR_LISP ("menu-prompt-more-char", menu_prompt_more_char
,
11896 doc
: /* Character to see next line of menu prompt.
11897 Type this character while in a menu prompt to rotate around the lines of it. */);
11898 XSETINT (menu_prompt_more_char
, ' ');
11900 DEFVAR_INT ("extra-keyboard-modifiers", extra_keyboard_modifiers
,
11901 doc
: /* A mask of additional modifier keys to use with every keyboard character.
11902 Emacs applies the modifiers of the character stored here to each keyboard
11903 character it reads. For example, after evaluating the expression
11904 (setq extra-keyboard-modifiers ?\\C-x)
11905 all input characters will have the control modifier applied to them.
11907 Note that the character ?\\C-@, equivalent to the integer zero, does
11908 not count as a control character; rather, it counts as a character
11909 with no modifiers; thus, setting `extra-keyboard-modifiers' to zero
11910 cancels any modification. */);
11911 extra_keyboard_modifiers
= 0;
11913 DEFVAR_LISP ("deactivate-mark", Vdeactivate_mark
,
11914 doc
: /* If an editing command sets this to t, deactivate the mark afterward.
11915 The command loop sets this to nil before each command,
11916 and tests the value when the command returns.
11917 Buffer modification stores t in this variable. */);
11918 Vdeactivate_mark
= Qnil
;
11919 DEFSYM (Qdeactivate_mark
, "deactivate-mark");
11921 DEFVAR_LISP ("pre-command-hook", Vpre_command_hook
,
11922 doc
: /* Normal hook run before each command is executed.
11923 If an unhandled error happens in running this hook,
11924 the function in which the error occurred is unconditionally removed, since
11925 otherwise the error might happen repeatedly and make Emacs nonfunctional. */);
11926 Vpre_command_hook
= Qnil
;
11928 DEFVAR_LISP ("post-command-hook", Vpost_command_hook
,
11929 doc
: /* Normal hook run after each command is executed.
11930 If an unhandled error happens in running this hook,
11931 the function in which the error occurred is unconditionally removed, since
11932 otherwise the error might happen repeatedly and make Emacs nonfunctional. */);
11933 Vpost_command_hook
= Qnil
;
11936 DEFVAR_LISP ("echo-area-clear-hook", ...,
11937 doc
: /* Normal hook run when clearing the echo area. */);
11939 DEFSYM (Qecho_area_clear_hook
, "echo-area-clear-hook");
11940 Fset (Qecho_area_clear_hook
, Qnil
);
11942 DEFVAR_LISP ("lucid-menu-bar-dirty-flag", Vlucid_menu_bar_dirty_flag
,
11943 doc
: /* Non-nil means menu bar, specified Lucid style, needs to be recomputed. */);
11944 Vlucid_menu_bar_dirty_flag
= Qnil
;
11946 DEFVAR_LISP ("menu-bar-final-items", Vmenu_bar_final_items
,
11947 doc
: /* List of menu bar items to move to the end of the menu bar.
11948 The elements of the list are event types that may have menu bar bindings. */);
11949 Vmenu_bar_final_items
= Qnil
;
11951 DEFVAR_LISP ("tool-bar-separator-image-expression", Vtool_bar_separator_image_expression
,
11952 doc
: /* Expression evaluating to the image spec for a tool-bar separator.
11953 This is used internally by graphical displays that do not render
11954 tool-bar separators natively. Otherwise it is unused (e.g. on GTK). */);
11955 Vtool_bar_separator_image_expression
= Qnil
;
11957 DEFVAR_KBOARD ("overriding-terminal-local-map",
11958 Voverriding_terminal_local_map
,
11959 doc
: /* Per-terminal keymap that overrides all other local keymaps.
11960 If this variable is non-nil, it is used as a keymap instead of the
11961 buffer's local map, and the minor mode keymaps and text property keymaps.
11962 It also replaces `overriding-local-map'.
11964 This variable is intended to let commands such as `universal-argument'
11965 set up a different keymap for reading the next command.
11967 `overriding-terminal-local-map' has a separate binding for each
11969 See Info node `(elisp)Multiple Terminals'. */);
11971 DEFVAR_LISP ("overriding-local-map", Voverriding_local_map
,
11972 doc
: /* Keymap that overrides all other local keymaps.
11973 If this variable is non-nil, it is used as a keymap--replacing the
11974 buffer's local map, the minor mode keymaps, and char property keymaps. */);
11975 Voverriding_local_map
= Qnil
;
11977 DEFVAR_LISP ("overriding-local-map-menu-flag", Voverriding_local_map_menu_flag
,
11978 doc
: /* Non-nil means `overriding-local-map' applies to the menu bar.
11979 Otherwise, the menu bar continues to reflect the buffer's local map
11980 and the minor mode maps regardless of `overriding-local-map'. */);
11981 Voverriding_local_map_menu_flag
= Qnil
;
11983 DEFVAR_LISP ("special-event-map", Vspecial_event_map
,
11984 doc
: /* Keymap defining bindings for special events to execute at low level. */);
11985 Vspecial_event_map
= Fcons (intern_c_string ("keymap"), Qnil
);
11987 DEFVAR_LISP ("track-mouse", do_mouse_tracking
,
11988 doc
: /* Non-nil means generate motion events for mouse motion. */);
11990 DEFVAR_KBOARD ("system-key-alist", Vsystem_key_alist
,
11991 doc
: /* Alist of system-specific X windows key symbols.
11992 Each element should have the form (N . SYMBOL) where N is the
11993 numeric keysym code (sans the \"system-specific\" bit 1<<28)
11994 and SYMBOL is its name.
11996 `system-key-alist' has a separate binding for each terminal device.
11997 See Info node `(elisp)Multiple Terminals'. */);
11999 DEFVAR_KBOARD ("local-function-key-map", Vlocal_function_key_map
,
12000 doc
: /* Keymap that translates key sequences to key sequences during input.
12001 This is used mainly for mapping key sequences into some preferred
12002 key events (symbols).
12004 The `read-key-sequence' function replaces any subsequence bound by
12005 `local-function-key-map' with its binding. More precisely, when the
12006 active keymaps have no binding for the current key sequence but
12007 `local-function-key-map' binds a suffix of the sequence to a vector or
12008 string, `read-key-sequence' replaces the matching suffix with its
12009 binding, and continues with the new sequence.
12011 If the binding is a function, it is called with one argument (the prompt)
12012 and its return value (a key sequence) is used.
12014 The events that come from bindings in `local-function-key-map' are not
12015 themselves looked up in `local-function-key-map'.
12017 For example, suppose `local-function-key-map' binds `ESC O P' to [f1].
12018 Typing `ESC O P' to `read-key-sequence' would return [f1]. Typing
12019 `C-x ESC O P' would return [?\\C-x f1]. If [f1] were a prefix key,
12020 typing `ESC O P x' would return [f1 x].
12022 `local-function-key-map' has a separate binding for each terminal
12023 device. See Info node `(elisp)Multiple Terminals'. If you need to
12024 define a binding on all terminals, change `function-key-map'
12025 instead. Initially, `local-function-key-map' is an empty keymap that
12026 has `function-key-map' as its parent on all terminal devices. */);
12028 DEFVAR_KBOARD ("input-decode-map", Vinput_decode_map
,
12029 doc
: /* Keymap that decodes input escape sequences.
12030 This is used mainly for mapping ASCII function key sequences into
12031 real Emacs function key events (symbols).
12033 The `read-key-sequence' function replaces any subsequence bound by
12034 `input-decode-map' with its binding. Contrary to `function-key-map',
12035 this map applies its rebinding regardless of the presence of an ordinary
12036 binding. So it is more like `key-translation-map' except that it applies
12037 before `function-key-map' rather than after.
12039 If the binding is a function, it is called with one argument (the prompt)
12040 and its return value (a key sequence) is used.
12042 The events that come from bindings in `input-decode-map' are not
12043 themselves looked up in `input-decode-map'.
12045 This variable is keyboard-local. */);
12047 DEFVAR_LISP ("function-key-map", Vfunction_key_map
,
12048 doc
: /* The parent keymap of all `local-function-key-map' instances.
12049 Function key definitions that apply to all terminal devices should go
12050 here. If a mapping is defined in both the current
12051 `local-function-key-map' binding and this variable, then the local
12052 definition will take precedence. */);
12053 Vfunction_key_map
= Fmake_sparse_keymap (Qnil
);
12055 DEFVAR_LISP ("key-translation-map", Vkey_translation_map
,
12056 doc
: /* Keymap of key translations that can override keymaps.
12057 This keymap works like `function-key-map', but comes after that,
12058 and its non-prefix bindings override ordinary bindings.
12059 Another difference is that it is global rather than keyboard-local. */);
12060 Vkey_translation_map
= Fmake_sparse_keymap (Qnil
);
12062 DEFVAR_LISP ("deferred-action-list", Vdeferred_action_list
,
12063 doc
: /* List of deferred actions to be performed at a later time.
12064 The precise format isn't relevant here; we just check whether it is nil. */);
12065 Vdeferred_action_list
= Qnil
;
12067 DEFVAR_LISP ("deferred-action-function", Vdeferred_action_function
,
12068 doc
: /* Function to call to handle deferred actions, after each command.
12069 This function is called with no arguments after each command
12070 whenever `deferred-action-list' is non-nil. */);
12071 Vdeferred_action_function
= Qnil
;
12073 DEFVAR_LISP ("delayed-warnings-list", Vdelayed_warnings_list
,
12074 doc
: /* List of warnings to be displayed after this command.
12075 Each element must be a list (TYPE MESSAGE [LEVEL [BUFFER-NAME]]),
12076 as per the args of `display-warning' (which see).
12077 If this variable is non-nil, `delayed-warnings-hook' will be run
12078 immediately after running `post-command-hook'. */);
12079 Vdelayed_warnings_list
= Qnil
;
12081 DEFVAR_LISP ("timer-list", Vtimer_list
,
12082 doc
: /* List of active absolute time timers in order of increasing time. */);
12083 Vtimer_list
= Qnil
;
12085 DEFVAR_LISP ("timer-idle-list", Vtimer_idle_list
,
12086 doc
: /* List of active idle-time timers in order of increasing time. */);
12087 Vtimer_idle_list
= Qnil
;
12089 DEFVAR_LISP ("input-method-function", Vinput_method_function
,
12090 doc
: /* If non-nil, the function that implements the current input method.
12091 It's called with one argument, a printing character that was just read.
12092 \(That means a character with code 040...0176.)
12093 Typically this function uses `read-event' to read additional events.
12094 When it does so, it should first bind `input-method-function' to nil
12095 so it will not be called recursively.
12097 The function should return a list of zero or more events
12098 to be used as input. If it wants to put back some events
12099 to be reconsidered, separately, by the input method,
12100 it can add them to the beginning of `unread-command-events'.
12102 The input method function can find in `input-method-previous-message'
12103 the previous echo area message.
12105 The input method function should refer to the variables
12106 `input-method-use-echo-area' and `input-method-exit-on-first-char'
12107 for guidance on what to do. */);
12108 Vinput_method_function
= Qnil
;
12110 DEFVAR_LISP ("input-method-previous-message",
12111 Vinput_method_previous_message
,
12112 doc
: /* When `input-method-function' is called, hold the previous echo area message.
12113 This variable exists because `read-event' clears the echo area
12114 before running the input method. It is nil if there was no message. */);
12115 Vinput_method_previous_message
= Qnil
;
12117 DEFVAR_LISP ("show-help-function", Vshow_help_function
,
12118 doc
: /* If non-nil, the function that implements the display of help.
12119 It's called with one argument, the help string to display. */);
12120 Vshow_help_function
= Qnil
;
12122 DEFVAR_LISP ("disable-point-adjustment", Vdisable_point_adjustment
,
12123 doc
: /* If non-nil, suppress point adjustment after executing a command.
12125 After a command is executed, if point is moved into a region that has
12126 special properties (e.g. composition, display), we adjust point to
12127 the boundary of the region. But, when a command sets this variable to
12128 non-nil, we suppress the point adjustment.
12130 This variable is set to nil before reading a command, and is checked
12131 just after executing the command. */);
12132 Vdisable_point_adjustment
= Qnil
;
12134 DEFVAR_LISP ("global-disable-point-adjustment",
12135 Vglobal_disable_point_adjustment
,
12136 doc
: /* If non-nil, always suppress point adjustment.
12138 The default value is nil, in which case, point adjustment are
12139 suppressed only after special commands that set
12140 `disable-point-adjustment' (which see) to non-nil. */);
12141 Vglobal_disable_point_adjustment
= Qnil
;
12143 DEFVAR_LISP ("minibuffer-message-timeout", Vminibuffer_message_timeout
,
12144 doc
: /* How long to display an echo-area message when the minibuffer is active.
12145 If the value is not a number, such messages don't time out. */);
12146 Vminibuffer_message_timeout
= make_number (2);
12148 DEFVAR_LISP ("throw-on-input", Vthrow_on_input
,
12149 doc
: /* If non-nil, any keyboard input throws to this symbol.
12150 The value of that variable is passed to `quit-flag' and later causes a
12151 peculiar kind of quitting. */);
12152 Vthrow_on_input
= Qnil
;
12154 DEFVAR_LISP ("command-error-function", Vcommand_error_function
,
12155 doc
: /* If non-nil, function to output error messages.
12156 The arguments are the error data, a list of the form
12157 (SIGNALED-CONDITIONS . SIGNAL-DATA)
12158 such as just as `condition-case' would bind its variable to,
12159 the context (a string which normally goes at the start of the message),
12160 and the Lisp function within which the error was signaled. */);
12161 Vcommand_error_function
= Qnil
;
12163 DEFVAR_LISP ("enable-disabled-menus-and-buttons",
12164 Venable_disabled_menus_and_buttons
,
12165 doc
: /* If non-nil, don't ignore events produced by disabled menu items and tool-bar.
12167 Help functions bind this to allow help on disabled menu items
12168 and tool-bar buttons. */);
12169 Venable_disabled_menus_and_buttons
= Qnil
;
12171 DEFVAR_LISP ("select-active-regions",
12172 Vselect_active_regions
,
12173 doc
: /* If non-nil, an active region automatically sets the primary selection.
12174 If the value is `only', only temporarily active regions (usually made
12175 by mouse-dragging or shift-selection) set the window selection.
12177 This takes effect only when Transient Mark mode is enabled. */);
12178 Vselect_active_regions
= Qt
;
12180 DEFVAR_LISP ("saved-region-selection",
12181 Vsaved_region_selection
,
12182 doc
: /* Contents of active region prior to buffer modification.
12183 If `select-active-regions' is non-nil, Emacs sets this to the
12184 text in the region before modifying the buffer. The next
12185 `deactivate-mark' call uses this to set the window selection. */);
12186 Vsaved_region_selection
= Qnil
;
12188 DEFVAR_LISP ("selection-inhibit-update-commands",
12189 Vselection_inhibit_update_commands
,
12190 doc
: /* List of commands which should not update the selection.
12191 Normally, if `select-active-regions' is non-nil and the mark remains
12192 active after a command (i.e. the mark was not deactivated), the Emacs
12193 command loop sets the selection to the text in the region. However,
12194 if the command is in this list, the selection is not updated. */);
12195 Vselection_inhibit_update_commands
12196 = list2 (Qhandle_switch_frame
, Qhandle_select_window
);
12198 DEFVAR_LISP ("debug-on-event",
12200 doc
: /* Enter debugger on this event. When Emacs
12201 receives the special event specified by this variable, it will try to
12202 break into the debugger as soon as possible instead of processing the
12203 event normally through `special-event-map'.
12205 Currently, the only supported values for this
12206 variable are `sigusr1' and `sigusr2'. */);
12207 Vdebug_on_event
= intern_c_string ("sigusr2");
12209 /* Create the initial keyboard. */
12210 initial_kboard
= xmalloc (sizeof *initial_kboard
);
12211 init_kboard (initial_kboard
);
12212 /* Vwindow_system is left at t for now. */
12213 initial_kboard
->next_kboard
= all_kboards
;
12214 all_kboards
= initial_kboard
;
12218 keys_of_keyboard (void)
12220 initial_define_key (global_map
, Ctl ('Z'), "suspend-emacs");
12221 initial_define_key (control_x_map
, Ctl ('Z'), "suspend-emacs");
12222 initial_define_key (meta_map
, Ctl ('C'), "exit-recursive-edit");
12223 initial_define_key (global_map
, Ctl (']'), "abort-recursive-edit");
12224 initial_define_key (meta_map
, 'x', "execute-extended-command");
12226 initial_define_lispy_key (Vspecial_event_map
, "delete-frame",
12227 "handle-delete-frame");
12228 initial_define_lispy_key (Vspecial_event_map
, "ns-put-working-text",
12229 "ns-put-working-text");
12230 initial_define_lispy_key (Vspecial_event_map
, "ns-unput-working-text",
12231 "ns-unput-working-text");
12232 /* Here we used to use `ignore-event' which would simple set prefix-arg to
12233 current-prefix-arg, as is done in `handle-switch-frame'.
12234 But `handle-switch-frame is not run from the special-map.
12235 Commands from that map are run in a special way that automatically
12236 preserves the prefix-arg. Restoring the prefix arg here is not just
12237 redundant but harmful:
12239 - current-prefix-arg is set to non-nil, prefix-arg is set to nil.
12240 - after the first prompt, the exit-minibuffer-hook is run which may
12241 iconify a frame and thus push a `iconify-frame' event.
12242 - after running exit-minibuffer-hook, current-prefix-arg is
12243 restored to the non-nil value it had before the prompt.
12244 - we enter the second prompt.
12245 current-prefix-arg is non-nil, prefix-arg is nil.
12246 - before running the first real event, we run the special iconify-frame
12247 event, but we pass the `special' arg to execute-command so
12248 current-prefix-arg and prefix-arg are left untouched.
12249 - here we foolishly copy the non-nil current-prefix-arg to prefix-arg.
12250 - the next key event will have a spuriously non-nil current-prefix-arg. */
12251 initial_define_lispy_key (Vspecial_event_map
, "iconify-frame",
12253 initial_define_lispy_key (Vspecial_event_map
, "make-frame-visible",
12255 /* Handling it at such a low-level causes read_key_sequence to get
12256 * confused because it doesn't realize that the current_buffer was
12257 * changed by read_char.
12259 * initial_define_lispy_key (Vspecial_event_map, "select-window",
12260 * "handle-select-window"); */
12261 initial_define_lispy_key (Vspecial_event_map
, "save-session",
12262 "handle-save-session");
12265 /* Define a special event which is raised for dbus callback
12267 initial_define_lispy_key (Vspecial_event_map
, "dbus-event",
12268 "dbus-handle-event");
12271 initial_define_lispy_key (Vspecial_event_map
, "config-changed-event",
12273 #if defined (WINDOWSNT)
12274 initial_define_lispy_key (Vspecial_event_map
, "language-change",
12279 /* Mark the pointers in the kboard objects.
12280 Called by Fgarbage_collect. */
12282 mark_kboards (void)
12286 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
12288 if (kb
->kbd_macro_buffer
)
12289 for (p
= kb
->kbd_macro_buffer
; p
< kb
->kbd_macro_ptr
; p
++)
12291 mark_object (KVAR (kb
, Voverriding_terminal_local_map
));
12292 mark_object (KVAR (kb
, Vlast_command
));
12293 mark_object (KVAR (kb
, Vreal_last_command
));
12294 mark_object (KVAR (kb
, Vkeyboard_translate_table
));
12295 mark_object (KVAR (kb
, Vlast_repeatable_command
));
12296 mark_object (KVAR (kb
, Vprefix_arg
));
12297 mark_object (KVAR (kb
, Vlast_prefix_arg
));
12298 mark_object (KVAR (kb
, kbd_queue
));
12299 mark_object (KVAR (kb
, defining_kbd_macro
));
12300 mark_object (KVAR (kb
, Vlast_kbd_macro
));
12301 mark_object (KVAR (kb
, Vsystem_key_alist
));
12302 mark_object (KVAR (kb
, system_key_syms
));
12303 mark_object (KVAR (kb
, Vwindow_system
));
12304 mark_object (KVAR (kb
, Vinput_decode_map
));
12305 mark_object (KVAR (kb
, Vlocal_function_key_map
));
12306 mark_object (KVAR (kb
, Vdefault_minibuffer_frame
));
12307 mark_object (KVAR (kb
, echo_string
));
12310 struct input_event
*event
;
12311 for (event
= kbd_fetch_ptr
; event
!= kbd_store_ptr
; event
++)
12313 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
12314 event
= kbd_buffer
;
12315 if (event
->kind
!= SELECTION_REQUEST_EVENT
12316 && event
->kind
!= SELECTION_CLEAR_EVENT
)
12318 mark_object (event
->x
);
12319 mark_object (event
->y
);
12321 mark_object (event
->frame_or_window
);
12322 mark_object (event
->arg
);