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
30 #include "termhooks.h"
35 #include "character.h"
38 #include "dispextern.h"
40 #include "intervals.h"
42 #include "blockinput.h"
56 #include <sys/ioctl.h>
57 #endif /* not MSDOS */
59 #if defined USABLE_FIONREAD && defined USG5_4
60 # include <sys/filio.h>
63 #include "syssignal.h"
65 #include <sys/types.h>
69 #ifdef HAVE_WINDOW_SYSTEM
71 #endif /* HAVE_WINDOW_SYSTEM */
73 /* Variables for blockinput.h: */
75 /* Non-zero if interrupt input is blocked right now. */
76 volatile int interrupt_input_blocked
;
78 /* Nonzero means an input interrupt has arrived
79 during the current critical section. */
80 int interrupt_input_pending
;
82 /* This var should be (interrupt_input_pending || pending_atimers).
83 The QUIT macro checks this instead of interrupt_input_pending and
84 pending_atimers separately, to reduce code size. So, any code that
85 changes interrupt_input_pending or pending_atimers should update
91 #define KBD_BUFFER_SIZE 4096
93 KBOARD
*initial_kboard
;
94 KBOARD
*current_kboard
;
97 /* Nonzero in the single-kboard state, 0 in the any-kboard state. */
98 static int single_kboard
;
100 /* Non-nil disable property on a command means
101 do not execute it; call disabled-command-function's value instead. */
102 Lisp_Object Qdisabled
;
103 static Lisp_Object Qdisabled_command_function
;
105 #define NUM_RECENT_KEYS (300)
107 /* Index for storing next element into recent_keys. */
108 static int recent_keys_index
;
110 /* Total number of elements stored into recent_keys. */
111 static int total_keys
;
113 /* This vector holds the last NUM_RECENT_KEYS keystrokes. */
114 static Lisp_Object recent_keys
;
116 /* Vector holding the key sequence that invoked the current command.
117 It is reused for each command, and it may be longer than the current
118 sequence; this_command_key_count indicates how many elements
119 actually mean something.
120 It's easier to staticpro a single Lisp_Object than an array. */
121 Lisp_Object this_command_keys
;
122 ptrdiff_t this_command_key_count
;
124 /* 1 after calling Freset_this_command_lengths.
126 static int this_command_key_count_reset
;
128 /* This vector is used as a buffer to record the events that were actually read
129 by read_key_sequence. */
130 static Lisp_Object raw_keybuf
;
131 static int raw_keybuf_count
;
133 #define GROW_RAW_KEYBUF \
134 if (raw_keybuf_count == ASIZE (raw_keybuf)) \
135 raw_keybuf = larger_vector (raw_keybuf, 1, -1)
137 /* Number of elements of this_command_keys
138 that precede this key sequence. */
139 static ptrdiff_t this_single_command_key_start
;
141 /* Record values of this_command_key_count and echo_length ()
142 before this command was read. */
143 static ptrdiff_t before_command_key_count
;
144 static ptrdiff_t before_command_echo_length
;
146 /* For longjmp to where kbd input is being done. */
148 static jmp_buf getcjmp
;
150 /* True while doing kbd input. */
151 int waiting_for_input
;
153 /* True while displaying for echoing. Delays C-g throwing. */
157 /* Non-null means we can start echoing at the next input pause even
158 though there is something in the echo area. */
160 static struct kboard
*ok_to_echo_at_next_pause
;
162 /* The kboard last echoing, or null for none. Reset to 0 in
163 cancel_echoing. If non-null, and a current echo area message
164 exists, and echo_message_buffer is eq to the current message
165 buffer, we know that the message comes from echo_kboard. */
167 struct kboard
*echo_kboard
;
169 /* The buffer used for echoing. Set in echo_now, reset in
172 Lisp_Object echo_message_buffer
;
174 /* Nonzero means C-g should cause immediate error-signal. */
177 /* Character that causes a quit. Normally C-g.
179 If we are running on an ordinary terminal, this must be an ordinary
180 ASCII char, since we want to make it our interrupt character.
182 If we are not running on an ordinary terminal, it still needs to be
183 an ordinary ASCII char. This character needs to be recognized in
184 the input interrupt handler. At this point, the keystroke is
185 represented as a struct input_event, while the desired quit
186 character is specified as a lispy event. The mapping from struct
187 input_events to lispy events cannot run in an interrupt handler,
188 and the reverse mapping is difficult for anything but ASCII
191 FOR THESE ELABORATE AND UNSATISFYING REASONS, quit_char must be an
195 /* Current depth in recursive edits. */
196 EMACS_INT command_loop_level
;
198 /* If not Qnil, this is a switch-frame event which we decided to put
199 off until the end of a key sequence. This should be read as the
200 next command input, after any unread_command_events.
202 read_key_sequence uses this to delay switch-frame events until the
203 end of the key sequence; Fread_char uses it to put off switch-frame
204 events until a non-ASCII event is acceptable as input. */
205 Lisp_Object unread_switch_frame
;
207 /* Last size recorded for a current buffer which is not a minibuffer. */
208 static ptrdiff_t last_non_minibuf_size
;
210 /* Total number of times read_char has returned, modulo UINTMAX_MAX + 1. */
211 uintmax_t num_input_events
;
213 /* Value of num_nonmacro_input_events as of last auto save. */
215 static EMACS_INT last_auto_save
;
217 /* The value of point when the last command was started. */
218 static ptrdiff_t last_point_position
;
220 /* The buffer that was current when the last command was started. */
221 static Lisp_Object last_point_position_buffer
;
223 /* The window that was selected when the last command was started. */
224 static Lisp_Object last_point_position_window
;
226 /* The frame in which the last input event occurred, or Qmacro if the
227 last event came from a macro. We use this to determine when to
228 generate switch-frame events. This may be cleared by functions
229 like Fselect_frame, to make sure that a switch-frame event is
230 generated by the next character. */
231 Lisp_Object internal_last_event_frame
;
233 /* The timestamp of the last input event we received from the X server.
234 X Windows wants this for selection ownership. */
235 Time last_event_timestamp
;
237 static Lisp_Object Qx_set_selection
, Qhandle_switch_frame
;
238 static Lisp_Object Qhandle_select_window
;
239 Lisp_Object QPRIMARY
;
241 static Lisp_Object Qself_insert_command
;
242 static Lisp_Object Qforward_char
;
243 static Lisp_Object Qbackward_char
;
244 Lisp_Object Qundefined
;
245 static Lisp_Object Qtimer_event_handler
;
247 /* read_key_sequence stores here the command definition of the
248 key sequence that it reads. */
249 static Lisp_Object read_key_sequence_cmd
;
250 static Lisp_Object read_key_sequence_remapped
;
252 static Lisp_Object Qinput_method_function
;
254 static Lisp_Object Qdeactivate_mark
;
256 Lisp_Object Qrecompute_lucid_menubar
, Qactivate_menubar_hook
;
258 static Lisp_Object Qecho_area_clear_hook
;
260 /* Hooks to run before and after each command. */
261 static Lisp_Object Qpre_command_hook
;
262 static Lisp_Object Qpost_command_hook
;
264 static Lisp_Object Qdeferred_action_function
;
266 static Lisp_Object Qdelayed_warnings_hook
;
268 static Lisp_Object Qinput_method_exit_on_first_char
;
269 static Lisp_Object Qinput_method_use_echo_area
;
271 static Lisp_Object Qhelp_form_show
;
273 /* File in which we write all commands we read. */
274 static FILE *dribble
;
276 /* Nonzero if input is available. */
279 /* Circular buffer for pre-read keyboard input. */
281 static struct input_event kbd_buffer
[KBD_BUFFER_SIZE
];
283 /* Pointer to next available character in kbd_buffer.
284 If kbd_fetch_ptr == kbd_store_ptr, the buffer is empty.
285 This may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the
286 next available char is in kbd_buffer[0]. */
287 static struct input_event
*kbd_fetch_ptr
;
289 /* Pointer to next place to store character in kbd_buffer. This
290 may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the next
291 character should go in kbd_buffer[0]. */
292 static struct input_event
* volatile kbd_store_ptr
;
294 /* The above pair of variables forms a "queue empty" flag. When we
295 enqueue a non-hook event, we increment kbd_store_ptr. When we
296 dequeue a non-hook event, we increment kbd_fetch_ptr. We say that
297 there is input available if the two pointers are not equal.
299 Why not just have a flag set and cleared by the enqueuing and
300 dequeuing functions? Such a flag could be screwed up by interrupts
301 at inopportune times. */
303 /* Symbols to head events. */
304 static Lisp_Object Qmouse_movement
;
305 static Lisp_Object Qscroll_bar_movement
;
306 Lisp_Object Qswitch_frame
;
307 static Lisp_Object Qdelete_frame
;
308 static Lisp_Object Qiconify_frame
;
309 static Lisp_Object Qmake_frame_visible
;
310 static Lisp_Object Qselect_window
;
311 Lisp_Object Qhelp_echo
;
313 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
314 static Lisp_Object Qmouse_fixup_help_message
;
317 /* Symbols to denote kinds of events. */
318 static Lisp_Object Qfunction_key
;
319 Lisp_Object Qmouse_click
;
320 #if defined (WINDOWSNT)
321 Lisp_Object Qlanguage_change
;
323 static Lisp_Object Qdrag_n_drop
;
324 static Lisp_Object Qsave_session
;
326 static Lisp_Object Qdbus_event
;
328 static Lisp_Object Qconfig_changed_event
;
330 /* Lisp_Object Qmouse_movement; - also an event header */
332 /* Properties of event headers. */
333 Lisp_Object Qevent_kind
;
334 static Lisp_Object Qevent_symbol_elements
;
336 /* Menu and tool bar item parts. */
337 static Lisp_Object Qmenu_enable
;
338 static Lisp_Object QCenable
, QCvisible
, QChelp
, QCkeys
, QCkey_sequence
;
339 Lisp_Object QCfilter
;
341 /* Non-nil disable property on a command means
342 do not execute it; call disabled-command-function's value instead. */
343 Lisp_Object QCtoggle
, QCradio
;
344 static Lisp_Object QCbutton
, QClabel
;
346 static Lisp_Object QCvert_only
;
348 /* An event header symbol HEAD may have a property named
349 Qevent_symbol_element_mask, which is of the form (BASE MODIFIERS);
350 BASE is the base, unmodified version of HEAD, and MODIFIERS is the
351 mask of modifiers applied to it. If present, this is used to help
352 speed up parse_modifiers. */
353 Lisp_Object Qevent_symbol_element_mask
;
355 /* An unmodified event header BASE may have a property named
356 Qmodifier_cache, which is an alist mapping modifier masks onto
357 modified versions of BASE. If present, this helps speed up
359 static Lisp_Object Qmodifier_cache
;
361 /* Symbols to use for parts of windows. */
362 Lisp_Object Qmode_line
;
363 Lisp_Object Qvertical_line
;
364 static Lisp_Object Qvertical_scroll_bar
;
365 Lisp_Object Qmenu_bar
;
367 static Lisp_Object
recursive_edit_unwind (Lisp_Object buffer
);
368 static Lisp_Object
command_loop (void);
369 static Lisp_Object Qextended_command_history
;
370 EMACS_TIME
timer_check (void);
372 static void record_menu_key (Lisp_Object c
);
373 static void echo_now (void);
374 static ptrdiff_t echo_length (void);
376 static Lisp_Object Qpolling_period
;
378 /* Incremented whenever a timer is run. */
381 /* Address (if not 0) of EMACS_TIME to zero out if a SIGIO interrupt
383 EMACS_TIME
*input_available_clear_time
;
385 /* Nonzero means use SIGIO interrupts; zero means use CBREAK mode.
386 Default is 1 if INTERRUPT_INPUT is defined. */
389 /* Nonzero while interrupts are temporarily deferred during redisplay. */
390 int interrupts_deferred
;
392 /* If we support a window system, turn on the code to poll periodically
393 to detect C-g. It isn't actually used when doing interrupt input. */
394 #if defined (HAVE_WINDOW_SYSTEM) && !defined (USE_ASYNC_EVENTS)
395 #define POLL_FOR_INPUT
398 /* The time when Emacs started being idle. */
400 static EMACS_TIME timer_idleness_start_time
;
402 /* After Emacs stops being idle, this saves the last value
403 of timer_idleness_start_time from when it was idle. */
405 static EMACS_TIME timer_last_idleness_start_time
;
408 /* Global variable declarations. */
410 /* Flags for readable_events. */
411 #define READABLE_EVENTS_DO_TIMERS_NOW (1 << 0)
412 #define READABLE_EVENTS_FILTER_EVENTS (1 << 1)
413 #define READABLE_EVENTS_IGNORE_SQUEEZABLES (1 << 2)
415 /* Function for init_keyboard to call with no args (if nonzero). */
416 static void (*keyboard_init_hook
) (void);
418 static int read_avail_input (int);
419 static void get_input_pending (int *, int);
420 static int readable_events (int);
421 static Lisp_Object
read_char_x_menu_prompt (ptrdiff_t, Lisp_Object
*,
423 static Lisp_Object
read_char_minibuf_menu_prompt (int, ptrdiff_t,
425 static Lisp_Object
make_lispy_event (struct input_event
*);
426 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
427 static Lisp_Object
make_lispy_movement (struct frame
*, Lisp_Object
,
428 enum scroll_bar_part
,
429 Lisp_Object
, Lisp_Object
,
432 static Lisp_Object
modify_event_symbol (ptrdiff_t, int, Lisp_Object
,
433 Lisp_Object
, const char *const *,
434 Lisp_Object
*, ptrdiff_t);
435 static Lisp_Object
make_lispy_switch_frame (Lisp_Object
);
436 static int help_char_p (Lisp_Object
);
437 static void save_getcjmp (jmp_buf);
438 static void restore_getcjmp (jmp_buf);
439 static Lisp_Object
apply_modifiers (int, Lisp_Object
);
440 static void clear_event (struct input_event
*);
441 static Lisp_Object
restore_kboard_configuration (Lisp_Object
);
443 static void deliver_input_available_signal (int signo
);
445 static void handle_interrupt (void);
446 static _Noreturn
void quit_throw_to_read_char (int);
447 static void process_special_events (void);
448 static void timer_start_idle (void);
449 static void timer_stop_idle (void);
450 static void timer_resume_idle (void);
451 static void deliver_user_signal (int);
452 static char *find_user_signal_name (int);
453 static int store_user_signal_events (void);
455 /* These setters are used only in this file, so they can be private. */
457 kset_echo_string (struct kboard
*kb
, Lisp_Object val
)
459 kb
->INTERNAL_FIELD (echo_string
) = val
;
462 kset_kbd_queue (struct kboard
*kb
, Lisp_Object val
)
464 kb
->INTERNAL_FIELD (kbd_queue
) = val
;
467 kset_keyboard_translate_table (struct kboard
*kb
, Lisp_Object val
)
469 kb
->INTERNAL_FIELD (Vkeyboard_translate_table
) = val
;
472 kset_last_prefix_arg (struct kboard
*kb
, Lisp_Object val
)
474 kb
->INTERNAL_FIELD (Vlast_prefix_arg
) = val
;
477 kset_last_repeatable_command (struct kboard
*kb
, Lisp_Object val
)
479 kb
->INTERNAL_FIELD (Vlast_repeatable_command
) = val
;
482 kset_local_function_key_map (struct kboard
*kb
, Lisp_Object val
)
484 kb
->INTERNAL_FIELD (Vlocal_function_key_map
) = val
;
487 kset_overriding_terminal_local_map (struct kboard
*kb
, Lisp_Object val
)
489 kb
->INTERNAL_FIELD (Voverriding_terminal_local_map
) = val
;
492 kset_real_last_command (struct kboard
*kb
, Lisp_Object val
)
494 kb
->INTERNAL_FIELD (Vreal_last_command
) = val
;
497 kset_system_key_syms (struct kboard
*kb
, Lisp_Object val
)
499 kb
->INTERNAL_FIELD (system_key_syms
) = val
;
503 /* Add C to the echo string, if echoing is going on.
504 C can be a character, which is printed prettily ("M-C-x" and all that
505 jazz), or a symbol, whose name is printed. */
508 echo_char (Lisp_Object c
)
510 if (current_kboard
->immediate_echo
)
512 int size
= KEY_DESCRIPTION_SIZE
+ 100;
513 char *buffer
= alloca (size
);
515 Lisp_Object echo_string
;
517 echo_string
= KVAR (current_kboard
, echo_string
);
519 /* If someone has passed us a composite event, use its head symbol. */
524 ptr
= push_key_description (XINT (c
), ptr
, 1);
526 else if (SYMBOLP (c
))
528 Lisp_Object name
= SYMBOL_NAME (c
);
529 int nbytes
= SBYTES (name
);
531 if (size
- (ptr
- buffer
) < nbytes
)
533 int offset
= ptr
- buffer
;
534 size
= max (2 * size
, size
+ nbytes
);
535 buffer
= alloca (size
);
536 ptr
= buffer
+ offset
;
539 ptr
+= copy_text (SDATA (name
), (unsigned char *) ptr
, nbytes
,
540 STRING_MULTIBYTE (name
), 1);
543 if ((NILP (echo_string
) || SCHARS (echo_string
) == 0)
546 const char *text
= " (Type ? for further options)";
547 int len
= strlen (text
);
549 if (size
- (ptr
- buffer
) < len
)
551 int offset
= ptr
- buffer
;
553 buffer
= alloca (size
);
554 ptr
= buffer
+ offset
;
557 memcpy (ptr
, text
, len
);
561 /* Replace a dash from echo_dash with a space, otherwise
562 add a space at the end as a separator between keys. */
563 if (STRINGP (echo_string
)
564 && SCHARS (echo_string
) > 1)
566 Lisp_Object last_char
, prev_char
, idx
;
568 idx
= make_number (SCHARS (echo_string
) - 2);
569 prev_char
= Faref (echo_string
, idx
);
571 idx
= make_number (SCHARS (echo_string
) - 1);
572 last_char
= Faref (echo_string
, idx
);
574 /* We test PREV_CHAR to make sure this isn't the echoing
576 if (XINT (last_char
) == '-' && XINT (prev_char
) != ' ')
577 Faset (echo_string
, idx
, make_number (' '));
579 echo_string
= concat2 (echo_string
, build_string (" "));
581 else if (STRINGP (echo_string
))
582 echo_string
= concat2 (echo_string
, build_string (" "));
586 concat2 (echo_string
, make_string (buffer
, ptr
- buffer
)));
592 /* Temporarily add a dash to the end of the echo string if it's not
593 empty, so that it serves as a mini-prompt for the very next character. */
598 /* Do nothing if not echoing at all. */
599 if (NILP (KVAR (current_kboard
, echo_string
)))
602 if (this_command_key_count
== 0)
605 if (!current_kboard
->immediate_echo
606 && SCHARS (KVAR (current_kboard
, echo_string
)) == 0)
609 /* Do nothing if we just printed a prompt. */
610 if (current_kboard
->echo_after_prompt
611 == SCHARS (KVAR (current_kboard
, echo_string
)))
614 /* Do nothing if we have already put a dash at the end. */
615 if (SCHARS (KVAR (current_kboard
, echo_string
)) > 1)
617 Lisp_Object last_char
, prev_char
, idx
;
619 idx
= make_number (SCHARS (KVAR (current_kboard
, echo_string
)) - 2);
620 prev_char
= Faref (KVAR (current_kboard
, echo_string
), idx
);
622 idx
= make_number (SCHARS (KVAR (current_kboard
, echo_string
)) - 1);
623 last_char
= Faref (KVAR (current_kboard
, echo_string
), idx
);
625 if (XINT (last_char
) == '-' && XINT (prev_char
) != ' ')
629 /* Put a dash at the end of the buffer temporarily,
630 but make it go away when the next character is added. */
633 concat2 (KVAR (current_kboard
, echo_string
), build_string ("-")));
637 /* Display the current echo string, and begin echoing if not already
643 if (!current_kboard
->immediate_echo
)
646 current_kboard
->immediate_echo
= 1;
648 for (i
= 0; i
< this_command_key_count
; i
++)
652 /* Set before_command_echo_length to the value that would
653 have been saved before the start of this subcommand in
654 command_loop_1, if we had already been echoing then. */
655 if (i
== this_single_command_key_start
)
656 before_command_echo_length
= echo_length ();
658 c
= AREF (this_command_keys
, i
);
659 if (! (EVENT_HAS_PARAMETERS (c
)
660 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
664 /* Set before_command_echo_length to the value that would
665 have been saved before the start of this subcommand in
666 command_loop_1, if we had already been echoing then. */
667 if (this_command_key_count
== this_single_command_key_start
)
668 before_command_echo_length
= echo_length ();
670 /* Put a dash at the end to invite the user to type more. */
675 message3_nolog (KVAR (current_kboard
, echo_string
),
676 SBYTES (KVAR (current_kboard
, echo_string
)),
677 STRING_MULTIBYTE (KVAR (current_kboard
, echo_string
)));
680 /* Record in what buffer we echoed, and from which kboard. */
681 echo_message_buffer
= echo_area_buffer
[0];
682 echo_kboard
= current_kboard
;
684 if (waiting_for_input
&& !NILP (Vquit_flag
))
685 quit_throw_to_read_char (0);
688 /* Turn off echoing, for the start of a new command. */
691 cancel_echoing (void)
693 current_kboard
->immediate_echo
= 0;
694 current_kboard
->echo_after_prompt
= -1;
695 kset_echo_string (current_kboard
, Qnil
);
696 ok_to_echo_at_next_pause
= NULL
;
698 echo_message_buffer
= Qnil
;
701 /* Return the length of the current echo string. */
706 return (STRINGP (KVAR (current_kboard
, echo_string
))
707 ? SCHARS (KVAR (current_kboard
, echo_string
))
711 /* Truncate the current echo message to its first LEN chars.
712 This and echo_char get used by read_key_sequence when the user
713 switches frames while entering a key sequence. */
716 echo_truncate (ptrdiff_t nchars
)
718 if (STRINGP (KVAR (current_kboard
, echo_string
)))
719 kset_echo_string (current_kboard
,
720 Fsubstring (KVAR (current_kboard
, echo_string
),
721 make_number (0), make_number (nchars
)));
722 truncate_echo_area (nchars
);
726 /* Functions for manipulating this_command_keys. */
728 add_command_key (Lisp_Object key
)
730 #if 0 /* Not needed after we made Freset_this_command_lengths
731 do the job immediately. */
732 /* If reset-this-command-length was called recently, obey it now.
733 See the doc string of that function for an explanation of why. */
734 if (before_command_restore_flag
)
736 this_command_key_count
= before_command_key_count_1
;
737 if (this_command_key_count
< this_single_command_key_start
)
738 this_single_command_key_start
= this_command_key_count
;
739 echo_truncate (before_command_echo_length_1
);
740 before_command_restore_flag
= 0;
744 if (this_command_key_count
>= ASIZE (this_command_keys
))
745 this_command_keys
= larger_vector (this_command_keys
, 1, -1);
747 ASET (this_command_keys
, this_command_key_count
, key
);
748 ++this_command_key_count
;
753 recursive_edit_1 (void)
755 ptrdiff_t count
= SPECPDL_INDEX ();
758 if (command_loop_level
> 0)
760 specbind (Qstandard_output
, Qt
);
761 specbind (Qstandard_input
, Qt
);
764 #ifdef HAVE_WINDOW_SYSTEM
765 /* The command loop has started an hourglass timer, so we have to
766 cancel it here, otherwise it will fire because the recursive edit
767 can take some time. Do not check for display_hourglass_p here,
768 because it could already be nil. */
772 /* This function may have been called from a debugger called from
773 within redisplay, for instance by Edebugging a function called
774 from fontification-functions. We want to allow redisplay in
775 the debugging session.
777 The recursive edit is left with a `(throw exit ...)'. The `exit'
778 tag is not caught anywhere in redisplay, i.e. when we leave the
779 recursive edit, the original redisplay leading to the recursive
780 edit will be unwound. The outcome should therefore be safe. */
781 specbind (Qinhibit_redisplay
, Qnil
);
784 val
= command_loop ();
786 Fsignal (Qquit
, Qnil
);
787 /* Handle throw from read_minibuf when using minibuffer
788 while it's active but we're in another window. */
790 xsignal1 (Qerror
, val
);
792 return unbind_to (count
, Qnil
);
795 /* When an auto-save happens, record the "time", and don't do again soon. */
798 record_auto_save (void)
800 last_auto_save
= num_nonmacro_input_events
;
803 /* Make an auto save happen as soon as possible at command level. */
807 force_auto_save_soon (void)
809 last_auto_save
= - auto_save_interval
- 1;
811 record_asynch_buffer_change ();
815 DEFUN ("recursive-edit", Frecursive_edit
, Srecursive_edit
, 0, 0, "",
816 doc
: /* Invoke the editor command loop recursively.
817 To get out of the recursive edit, a command can do `(throw 'exit nil)';
818 that tells this function to return.
819 Alternatively, `(throw 'exit t)' makes this function signal an error.
820 This function is called by the editor initialization to begin editing. */)
823 ptrdiff_t count
= SPECPDL_INDEX ();
826 /* If we enter while input is blocked, don't lock up here.
827 This may happen through the debugger during redisplay. */
831 command_loop_level
++;
832 update_mode_lines
= 1;
834 if (command_loop_level
835 && current_buffer
!= XBUFFER (XWINDOW (selected_window
)->buffer
))
836 buffer
= Fcurrent_buffer ();
840 /* If we leave recursive_edit_1 below with a `throw' for instance,
841 like it is done in the splash screen display, we have to
842 make sure that we restore single_kboard as command_loop_1
843 would have done if it were left normally. */
844 if (command_loop_level
> 0)
845 temporarily_switch_to_single_kboard (SELECTED_FRAME ());
846 record_unwind_protect (recursive_edit_unwind
, buffer
);
849 return unbind_to (count
, Qnil
);
853 recursive_edit_unwind (Lisp_Object buffer
)
855 if (BUFFERP (buffer
))
856 Fset_buffer (buffer
);
858 command_loop_level
--;
859 update_mode_lines
= 1;
864 #if 0 /* These two functions are now replaced with
865 temporarily_switch_to_single_kboard. */
869 #if 0 /* Theory: if there's anything in Vunread_command_events,
870 it will right away be read by read_key_sequence,
871 and then if we do switch KBOARDS, it will go into the side
872 queue then. So we don't need to do anything special here -- rms. */
873 if (CONSP (Vunread_command_events
))
875 current_kboard
->kbd_queue
876 = nconc2 (Vunread_command_events
, current_kboard
->kbd_queue
);
877 current_kboard
->kbd_queue_has_data
= 1;
879 Vunread_command_events
= Qnil
;
884 /* Switch to the single-kboard state, making current_kboard
885 the only KBOARD from which further input is accepted. */
888 single_kboard_state ()
894 /* If we're in single_kboard state for kboard KBOARD,
898 not_single_kboard_state (KBOARD
*kboard
)
900 if (kboard
== current_kboard
)
904 /* Maintain a stack of kboards, so other parts of Emacs
905 can switch temporarily to the kboard of a given frame
906 and then revert to the previous status. */
911 struct kboard_stack
*next
;
914 static struct kboard_stack
*kboard_stack
;
917 push_kboard (struct kboard
*k
)
919 struct kboard_stack
*p
= xmalloc (sizeof *p
);
921 p
->next
= kboard_stack
;
922 p
->kboard
= current_kboard
;
932 struct kboard_stack
*p
= kboard_stack
;
934 for (t
= terminal_list
; t
; t
= t
->next_terminal
)
936 if (t
->kboard
== p
->kboard
)
938 current_kboard
= p
->kboard
;
945 /* The terminal we remembered has been deleted. */
946 current_kboard
= FRAME_KBOARD (SELECTED_FRAME ());
949 kboard_stack
= p
->next
;
953 /* Switch to single_kboard mode, making current_kboard the only KBOARD
954 from which further input is accepted. If F is non-nil, set its
955 KBOARD as the current keyboard.
957 This function uses record_unwind_protect to return to the previous
960 If Emacs is already in single_kboard mode, and F's keyboard is
961 locked, then this function will throw an error. */
964 temporarily_switch_to_single_kboard (struct frame
*f
)
966 int was_locked
= single_kboard
;
969 if (f
!= NULL
&& FRAME_KBOARD (f
) != current_kboard
)
970 /* We can not switch keyboards while in single_kboard mode.
971 In rare cases, Lisp code may call `recursive-edit' (or
972 `read-minibuffer' or `y-or-n-p') after it switched to a
973 locked frame. For example, this is likely to happen
974 when server.el connects to a new terminal while Emacs is in
975 single_kboard mode. It is best to throw an error instead
976 of presenting the user with a frozen screen. */
977 error ("Terminal %d is locked, cannot read from it",
978 FRAME_TERMINAL (f
)->id
);
980 /* This call is unnecessary, but helps
981 `restore_kboard_configuration' discover if somebody changed
982 `current_kboard' behind our back. */
983 push_kboard (current_kboard
);
986 current_kboard
= FRAME_KBOARD (f
);
988 record_unwind_protect (restore_kboard_configuration
,
989 (was_locked
? Qt
: Qnil
));
992 #if 0 /* This function is not needed anymore. */
994 record_single_kboard_state ()
997 push_kboard (current_kboard
);
998 record_unwind_protect (restore_kboard_configuration
,
999 (single_kboard
? Qt
: Qnil
));
1004 restore_kboard_configuration (Lisp_Object was_locked
)
1006 if (NILP (was_locked
))
1010 struct kboard
*prev
= current_kboard
;
1013 /* The pop should not change the kboard. */
1014 if (single_kboard
&& current_kboard
!= prev
)
1021 /* Handle errors that are not handled at inner levels
1022 by printing an error message and returning to the editor command loop. */
1025 cmd_error (Lisp_Object data
)
1027 Lisp_Object old_level
, old_length
;
1028 char macroerror
[sizeof "After..kbd macro iterations: "
1029 + INT_STRLEN_BOUND (EMACS_INT
)];
1031 #ifdef HAVE_WINDOW_SYSTEM
1032 if (display_hourglass_p
)
1033 cancel_hourglass ();
1036 if (!NILP (executing_kbd_macro
))
1038 if (executing_kbd_macro_iterations
== 1)
1039 sprintf (macroerror
, "After 1 kbd macro iteration: ");
1041 sprintf (macroerror
, "After %"pI
"d kbd macro iterations: ",
1042 executing_kbd_macro_iterations
);
1047 Vstandard_output
= Qt
;
1048 Vstandard_input
= Qt
;
1049 Vexecuting_kbd_macro
= Qnil
;
1050 executing_kbd_macro
= Qnil
;
1051 kset_prefix_arg (current_kboard
, Qnil
);
1052 kset_last_prefix_arg (current_kboard
, Qnil
);
1055 /* Avoid unquittable loop if data contains a circular list. */
1056 old_level
= Vprint_level
;
1057 old_length
= Vprint_length
;
1058 XSETFASTINT (Vprint_level
, 10);
1059 XSETFASTINT (Vprint_length
, 10);
1060 cmd_error_internal (data
, macroerror
);
1061 Vprint_level
= old_level
;
1062 Vprint_length
= old_length
;
1066 Vinhibit_quit
= Qnil
;
1067 #if 0 /* This shouldn't be necessary anymore. --lorentey */
1068 if (command_loop_level
== 0 && minibuf_level
== 0)
1069 any_kboard_state ();
1072 return make_number (0);
1075 /* Take actions on handling an error. DATA is the data that describes
1078 CONTEXT is a C-string containing ASCII characters only which
1079 describes the context in which the error happened. If we need to
1080 generalize CONTEXT to allow multibyte characters, make it a Lisp
1084 cmd_error_internal (Lisp_Object data
, const char *context
)
1086 struct frame
*sf
= SELECTED_FRAME ();
1088 /* The immediate context is not interesting for Quits,
1089 since they are asynchronous. */
1090 if (EQ (XCAR (data
), Qquit
))
1091 Vsignaling_function
= Qnil
;
1096 /* Use user's specified output function if any. */
1097 if (!NILP (Vcommand_error_function
))
1098 call3 (Vcommand_error_function
, data
,
1099 context
? build_string (context
) : empty_unibyte_string
,
1100 Vsignaling_function
);
1101 /* If the window system or terminal frame hasn't been initialized
1102 yet, or we're not interactive, write the message to stderr and exit. */
1103 else if (!sf
->glyphs_initialized_p
1104 /* The initial frame is a special non-displaying frame. It
1105 will be current in daemon mode when there are no frames
1106 to display, and in non-daemon mode before the real frame
1107 has finished initializing. If an error is thrown in the
1108 latter case while creating the frame, then the frame
1109 will never be displayed, so the safest thing to do is
1110 write to stderr and quit. In daemon mode, there are
1111 many other potential errors that do not prevent frames
1112 from being created, so continuing as normal is better in
1114 || (!IS_DAEMON
&& FRAME_INITIAL_P (sf
))
1117 print_error_message (data
, Qexternal_debugging_output
,
1118 context
, Vsignaling_function
);
1119 Fterpri (Qexternal_debugging_output
);
1120 Fkill_emacs (make_number (-1));
1124 clear_message (1, 0);
1126 message_log_maybe_newline ();
1129 print_error_message (data
, Qt
, context
, Vsignaling_function
);
1132 Vsignaling_function
= Qnil
;
1135 Lisp_Object
command_loop_1 (void);
1136 static Lisp_Object
command_loop_2 (Lisp_Object
);
1137 static Lisp_Object
top_level_1 (Lisp_Object
);
1139 /* Entry to editor-command-loop.
1140 This level has the catches for exiting/returning to editor command loop.
1141 It returns nil to exit recursive edit, t to abort it. */
1146 if (command_loop_level
> 0 || minibuf_level
> 0)
1149 val
= internal_catch (Qexit
, command_loop_2
, Qnil
);
1150 executing_kbd_macro
= Qnil
;
1156 internal_catch (Qtop_level
, top_level_1
, Qnil
);
1157 #if 0 /* This shouldn't be necessary anymore. --lorentey */
1158 /* Reset single_kboard in case top-level set it while
1159 evaluating an -f option, or we are stuck there for some
1161 any_kboard_state ();
1163 internal_catch (Qtop_level
, command_loop_2
, Qnil
);
1164 executing_kbd_macro
= Qnil
;
1166 /* End of file in -batch run causes exit here. */
1172 /* Here we catch errors in execution of commands within the
1173 editing loop, and reenter the editing loop.
1174 When there is an error, cmd_error runs and returns a non-nil
1175 value to us. A value of nil means that command_loop_1 itself
1176 returned due to end of file (or end of kbd macro). */
1179 command_loop_2 (Lisp_Object ignore
)
1181 register Lisp_Object val
;
1184 val
= internal_condition_case (command_loop_1
, Qerror
, cmd_error
);
1185 while (!NILP (val
));
1193 return Feval (Vtop_level
, Qnil
);
1197 top_level_1 (Lisp_Object ignore
)
1199 /* On entry to the outer level, run the startup file */
1200 if (!NILP (Vtop_level
))
1201 internal_condition_case (top_level_2
, Qerror
, cmd_error
);
1202 else if (!NILP (Vpurify_flag
))
1203 message ("Bare impure Emacs (standard Lisp code not loaded)");
1205 message ("Bare Emacs (standard Lisp code not loaded)");
1209 DEFUN ("top-level", Ftop_level
, Stop_level
, 0, 0, "",
1210 doc
: /* Exit all recursive editing levels.
1211 This also exits all active minibuffers. */)
1214 #ifdef HAVE_WINDOW_SYSTEM
1215 if (display_hourglass_p
)
1216 cancel_hourglass ();
1219 /* Unblock input if we enter with input blocked. This may happen if
1220 redisplay traps e.g. during tool-bar update with input blocked. */
1221 while (INPUT_BLOCKED_P
)
1224 Fthrow (Qtop_level
, Qnil
);
1227 static _Noreturn
void
1228 user_error (const char *msg
)
1230 xsignal1 (Quser_error
, build_string (msg
));
1234 DEFUN ("exit-recursive-edit", Fexit_recursive_edit
, Sexit_recursive_edit
, 0, 0, "",
1235 doc
: /* Exit from the innermost recursive edit or minibuffer. */)
1238 if (command_loop_level
> 0 || minibuf_level
> 0)
1239 Fthrow (Qexit
, Qnil
);
1241 user_error ("No recursive edit is in progress");
1245 DEFUN ("abort-recursive-edit", Fabort_recursive_edit
, Sabort_recursive_edit
, 0, 0, "",
1246 doc
: /* Abort the command that requested this recursive edit or minibuffer input. */)
1249 if (command_loop_level
> 0 || minibuf_level
> 0)
1252 user_error ("No recursive edit is in progress");
1255 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
1257 /* Restore mouse tracking enablement. See Ftrack_mouse for the only use
1258 of this function. */
1261 tracking_off (Lisp_Object old_value
)
1263 do_mouse_tracking
= old_value
;
1264 if (NILP (old_value
))
1266 /* Redisplay may have been preempted because there was input
1267 available, and it assumes it will be called again after the
1268 input has been processed. If the only input available was
1269 the sort that we have just disabled, then we need to call
1271 if (!readable_events (READABLE_EVENTS_DO_TIMERS_NOW
))
1273 redisplay_preserve_echo_area (6);
1274 get_input_pending (&input_pending
,
1275 READABLE_EVENTS_DO_TIMERS_NOW
);
1281 DEFUN ("track-mouse", Ftrack_mouse
, Strack_mouse
, 0, UNEVALLED
, 0,
1282 doc
: /* Evaluate BODY with mouse movement events enabled.
1283 Within a `track-mouse' form, mouse motion generates input events that
1284 you can read with `read-event'.
1285 Normally, mouse motion is ignored.
1286 usage: (track-mouse BODY...) */)
1289 ptrdiff_t count
= SPECPDL_INDEX ();
1292 record_unwind_protect (tracking_off
, do_mouse_tracking
);
1294 do_mouse_tracking
= Qt
;
1296 val
= Fprogn (args
);
1297 return unbind_to (count
, val
);
1300 /* If mouse has moved on some frame, return one of those frames.
1304 If ignore_mouse_drag_p is non-zero, ignore (implicit) mouse movement
1305 after resizing the tool-bar window. */
1307 #if !defined HAVE_WINDOW_SYSTEM || defined USE_GTK || defined HAVE_NS
1310 int ignore_mouse_drag_p
;
1313 some_mouse_moved (void)
1315 Lisp_Object tail
, frame
;
1317 if (ignore_mouse_drag_p
)
1319 /* ignore_mouse_drag_p = 0; */
1323 FOR_EACH_FRAME (tail
, frame
)
1325 if (XFRAME (frame
)->mouse_moved
)
1326 return XFRAME (frame
);
1332 #endif /* HAVE_MOUSE || HAVE_GPM */
1334 /* This is the actual command reading loop,
1335 sans error-handling encapsulation. */
1337 static int read_key_sequence (Lisp_Object
*, int, Lisp_Object
,
1339 void safe_run_hooks (Lisp_Object
);
1340 static void adjust_point_for_property (ptrdiff_t, int);
1342 /* Cancel hourglass from protect_unwind.
1344 #ifdef HAVE_WINDOW_SYSTEM
1346 cancel_hourglass_unwind (Lisp_Object arg
)
1348 cancel_hourglass ();
1353 /* The last boundary auto-added to buffer-undo-list. */
1354 Lisp_Object last_undo_boundary
;
1356 /* FIXME: This is wrong rather than test window-system, we should call
1357 a new set-selection, which will then dispatch to x-set-selection, or
1358 tty-set-selection, or w32-set-selection, ... */
1361 command_loop_1 (void)
1364 Lisp_Object keybuf
[30];
1366 EMACS_INT prev_modiff
= 0;
1367 struct buffer
*prev_buffer
= NULL
;
1368 #if 0 /* This shouldn't be necessary anymore. --lorentey */
1369 int was_locked
= single_kboard
;
1371 int already_adjusted
= 0;
1373 kset_prefix_arg (current_kboard
, Qnil
);
1374 kset_last_prefix_arg (current_kboard
, Qnil
);
1375 Vdeactivate_mark
= Qnil
;
1376 waiting_for_input
= 0;
1379 this_command_key_count
= 0;
1380 this_command_key_count_reset
= 0;
1381 this_single_command_key_start
= 0;
1383 if (NILP (Vmemory_full
))
1385 /* Make sure this hook runs after commands that get errors and
1386 throw to top level. */
1387 /* Note that the value cell will never directly contain nil
1388 if the symbol is a local variable. */
1389 if (!NILP (Vpost_command_hook
) && !NILP (Vrun_hooks
))
1390 safe_run_hooks (Qpost_command_hook
);
1392 /* If displaying a message, resize the echo area window to fit
1393 that message's size exactly. */
1394 if (!NILP (echo_area_buffer
[0]))
1395 resize_echo_area_exactly ();
1397 /* If there are warnings waiting, process them. */
1398 if (!NILP (Vdelayed_warnings_list
))
1399 safe_run_hooks (Qdelayed_warnings_hook
);
1401 if (!NILP (Vdeferred_action_list
))
1402 safe_run_hooks (Qdeferred_action_function
);
1405 /* Do this after running Vpost_command_hook, for consistency. */
1406 kset_last_command (current_kboard
, Vthis_command
);
1407 kset_real_last_command (current_kboard
, Vreal_this_command
);
1408 if (!CONSP (last_command_event
))
1409 kset_last_repeatable_command (current_kboard
, Vreal_this_command
);
1413 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1416 /* Make sure the current window's buffer is selected. */
1417 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->buffer
));
1419 /* Display any malloc warning that just came out. Use while because
1420 displaying one warning can cause another. */
1422 while (pending_malloc_warning
)
1423 display_malloc_warning ();
1425 Vdeactivate_mark
= Qnil
;
1427 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
1429 /* Don't ignore mouse movements for more than a single command
1430 loop. (This flag is set in xdisp.c whenever the tool bar is
1431 resized, because the resize moves text up or down, and would
1432 generate false mouse drag events if we don't ignore them.) */
1433 ignore_mouse_drag_p
= 0;
1436 /* If minibuffer on and echo area in use,
1437 wait a short time and redraw minibuffer. */
1440 && !NILP (echo_area_buffer
[0])
1441 && EQ (minibuf_window
, echo_area_window
)
1442 && NUMBERP (Vminibuffer_message_timeout
))
1444 /* Bind inhibit-quit to t so that C-g gets read in
1445 rather than quitting back to the minibuffer. */
1446 ptrdiff_t count
= SPECPDL_INDEX ();
1447 specbind (Qinhibit_quit
, Qt
);
1449 sit_for (Vminibuffer_message_timeout
, 0, 2);
1451 /* Clear the echo area. */
1453 safe_run_hooks (Qecho_area_clear_hook
);
1455 unbind_to (count
, Qnil
);
1457 /* If a C-g came in before, treat it as input now. */
1458 if (!NILP (Vquit_flag
))
1461 Vunread_command_events
= Fcons (make_number (quit_char
), Qnil
);
1466 /* Select the frame that the last event came from. Usually,
1467 switch-frame events will take care of this, but if some lisp
1468 code swallows a switch-frame event, we'll fix things up here.
1469 Is this a good idea? */
1470 if (FRAMEP (internal_last_event_frame
)
1471 && !EQ (internal_last_event_frame
, selected_frame
))
1472 Fselect_frame (internal_last_event_frame
, Qnil
);
1474 /* If it has changed current-menubar from previous value,
1475 really recompute the menubar from the value. */
1476 if (! NILP (Vlucid_menu_bar_dirty_flag
)
1477 && !NILP (Ffboundp (Qrecompute_lucid_menubar
)))
1478 call0 (Qrecompute_lucid_menubar
);
1480 before_command_key_count
= this_command_key_count
;
1481 before_command_echo_length
= echo_length ();
1483 Vthis_command
= Qnil
;
1484 Vreal_this_command
= Qnil
;
1485 Vthis_original_command
= Qnil
;
1486 Vthis_command_keys_shift_translated
= Qnil
;
1488 /* Read next key sequence; i gets its length. */
1489 i
= read_key_sequence (keybuf
, sizeof keybuf
/ sizeof keybuf
[0],
1492 /* A filter may have run while we were reading the input. */
1493 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1495 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->buffer
));
1499 /* Now we have read a key sequence of length I,
1500 or else I is 0 and we found end of file. */
1502 if (i
== 0) /* End of file -- happens only in */
1503 return Qnil
; /* a kbd macro, at the end. */
1504 /* -1 means read_key_sequence got a menu that was rejected.
1505 Just loop around and read another command. */
1509 this_command_key_count
= 0;
1510 this_command_key_count_reset
= 0;
1511 this_single_command_key_start
= 0;
1515 last_command_event
= keybuf
[i
- 1];
1517 /* If the previous command tried to force a specific window-start,
1518 forget about that, in case this command moves point far away
1519 from that position. But also throw away beg_unchanged and
1520 end_unchanged information in that case, so that redisplay will
1521 update the whole window properly. */
1522 if (XWINDOW (selected_window
)->force_start
)
1525 XWINDOW (selected_window
)->force_start
= 0;
1526 b
= XBUFFER (XWINDOW (selected_window
)->buffer
);
1527 BUF_BEG_UNCHANGED (b
) = BUF_END_UNCHANGED (b
) = 0;
1530 cmd
= read_key_sequence_cmd
;
1531 if (!NILP (Vexecuting_kbd_macro
))
1533 if (!NILP (Vquit_flag
))
1535 Vexecuting_kbd_macro
= Qt
;
1536 QUIT
; /* Make some noise. */
1537 /* Will return since macro now empty. */
1541 /* Do redisplay processing after this command except in special
1542 cases identified below. */
1543 prev_buffer
= current_buffer
;
1544 prev_modiff
= MODIFF
;
1545 last_point_position
= PT
;
1546 last_point_position_window
= selected_window
;
1547 XSETBUFFER (last_point_position_buffer
, prev_buffer
);
1549 /* By default, we adjust point to a boundary of a region that
1550 has such a property that should be treated intangible
1551 (e.g. composition, display). But, some commands will set
1552 this variable differently. */
1553 Vdisable_point_adjustment
= Qnil
;
1555 /* Process filters and timers may have messed with deactivate-mark.
1556 reset it before we execute the command. */
1557 Vdeactivate_mark
= Qnil
;
1559 /* Remap command through active keymaps. */
1560 Vthis_original_command
= cmd
;
1561 if (!NILP (read_key_sequence_remapped
))
1562 cmd
= read_key_sequence_remapped
;
1564 /* Execute the command. */
1566 Vthis_command
= cmd
;
1567 Vreal_this_command
= cmd
;
1568 safe_run_hooks (Qpre_command_hook
);
1570 already_adjusted
= 0;
1572 if (NILP (Vthis_command
))
1574 /* nil means key is undefined. */
1575 Lisp_Object keys
= Fvector (i
, keybuf
);
1576 keys
= Fkey_description (keys
, Qnil
);
1578 message_with_string ("%s is undefined", keys
, 0);
1579 kset_defining_kbd_macro (current_kboard
, Qnil
);
1580 update_mode_lines
= 1;
1581 /* If this is a down-mouse event, don't reset prefix-arg;
1582 pass it to the command run by the up event. */
1583 if (EVENT_HAS_PARAMETERS (last_command_event
))
1585 Lisp_Object breakdown
1586 = parse_modifiers (EVENT_HEAD (last_command_event
));
1587 int modifiers
= XINT (XCAR (XCDR (breakdown
)));
1588 if (!(modifiers
& down_modifier
))
1589 kset_prefix_arg (current_kboard
, Qnil
);
1592 kset_prefix_arg (current_kboard
, Qnil
);
1596 /* Here for a command that isn't executed directly. */
1598 #ifdef HAVE_WINDOW_SYSTEM
1599 ptrdiff_t scount
= SPECPDL_INDEX ();
1601 if (display_hourglass_p
1602 && NILP (Vexecuting_kbd_macro
))
1604 record_unwind_protect (cancel_hourglass_unwind
, Qnil
);
1609 if (NILP (KVAR (current_kboard
, Vprefix_arg
))) /* FIXME: Why? --Stef */
1611 Lisp_Object undo
= BVAR (current_buffer
, undo_list
);
1614 = (EQ (undo
, BVAR (current_buffer
, undo_list
))
1615 ? Qnil
: BVAR (current_buffer
, undo_list
));
1617 Fcommand_execute (Vthis_command
, Qnil
, Qnil
, Qnil
);
1619 #ifdef HAVE_WINDOW_SYSTEM
1620 /* Do not check display_hourglass_p here, because
1621 Fcommand_execute could change it, but we should cancel
1622 hourglass cursor anyway.
1623 But don't cancel the hourglass within a macro
1624 just because a command in the macro finishes. */
1625 if (NILP (Vexecuting_kbd_macro
))
1626 unbind_to (scount
, Qnil
);
1629 kset_last_prefix_arg (current_kboard
, Vcurrent_prefix_arg
);
1631 safe_run_hooks (Qpost_command_hook
);
1633 /* If displaying a message, resize the echo area window to fit
1634 that message's size exactly. */
1635 if (!NILP (echo_area_buffer
[0]))
1636 resize_echo_area_exactly ();
1638 /* If there are warnings waiting, process them. */
1639 if (!NILP (Vdelayed_warnings_list
))
1640 safe_run_hooks (Qdelayed_warnings_hook
);
1642 safe_run_hooks (Qdeferred_action_function
);
1644 /* If there is a prefix argument,
1645 1) We don't want Vlast_command to be ``universal-argument''
1646 (that would be dumb), so don't set Vlast_command,
1647 2) we want to leave echoing on so that the prefix will be
1648 echoed as part of this key sequence, so don't call
1650 3) we want to leave this_command_key_count non-zero, so that
1651 read_char will realize that it is re-reading a character, and
1652 not echo it a second time.
1654 If the command didn't actually create a prefix arg,
1655 but is merely a frame event that is transparent to prefix args,
1656 then the above doesn't apply. */
1657 if (NILP (KVAR (current_kboard
, Vprefix_arg
))
1658 || CONSP (last_command_event
))
1660 kset_last_command (current_kboard
, Vthis_command
);
1661 kset_real_last_command (current_kboard
, Vreal_this_command
);
1662 if (!CONSP (last_command_event
))
1663 kset_last_repeatable_command (current_kboard
, Vreal_this_command
);
1665 this_command_key_count
= 0;
1666 this_command_key_count_reset
= 0;
1667 this_single_command_key_start
= 0;
1670 if (!NILP (BVAR (current_buffer
, mark_active
))
1671 && !NILP (Vrun_hooks
))
1673 /* In Emacs 22, setting transient-mark-mode to `only' was a
1674 way of turning it on for just one command. This usage is
1675 obsolete, but support it anyway. */
1676 if (EQ (Vtransient_mark_mode
, Qidentity
))
1677 Vtransient_mark_mode
= Qnil
;
1678 else if (EQ (Vtransient_mark_mode
, Qonly
))
1679 Vtransient_mark_mode
= Qidentity
;
1681 if (!NILP (Vdeactivate_mark
))
1682 /* If `select-active-regions' is non-nil, this call to
1683 `deactivate-mark' also sets the PRIMARY selection. */
1684 call0 (Qdeactivate_mark
);
1687 /* Even if not deactivating the mark, set PRIMARY if
1688 `select-active-regions' is non-nil. */
1689 if (!NILP (Fwindow_system (Qnil
))
1690 /* Even if mark_active is non-nil, the actual buffer
1691 marker may not have been set yet (Bug#7044). */
1692 && XMARKER (BVAR (current_buffer
, mark
))->buffer
1693 && (EQ (Vselect_active_regions
, Qonly
)
1694 ? EQ (CAR_SAFE (Vtransient_mark_mode
), Qonly
)
1695 : (!NILP (Vselect_active_regions
)
1696 && !NILP (Vtransient_mark_mode
)))
1697 && NILP (Fmemq (Vthis_command
,
1698 Vselection_inhibit_update_commands
)))
1701 XINT (Fmarker_position (BVAR (current_buffer
, mark
)));
1704 call2 (Qx_set_selection
, QPRIMARY
,
1705 make_buffer_string (beg
, end
, 0));
1707 call2 (Qx_set_selection
, QPRIMARY
,
1708 make_buffer_string (end
, beg
, 0));
1709 /* Don't set empty selections. */
1712 if (current_buffer
!= prev_buffer
|| MODIFF
!= prev_modiff
)
1714 Lisp_Object hook
= intern ("activate-mark-hook");
1715 Frun_hooks (1, &hook
);
1719 Vsaved_region_selection
= Qnil
;
1724 if (current_buffer
== prev_buffer
1725 && last_point_position
!= PT
1726 && NILP (Vdisable_point_adjustment
)
1727 && NILP (Vglobal_disable_point_adjustment
))
1729 if (last_point_position
> BEGV
1730 && last_point_position
< ZV
1731 && (composition_adjust_point (last_point_position
,
1732 last_point_position
)
1733 != last_point_position
))
1734 /* The last point was temporarily set within a grapheme
1735 cluster to prevent automatic composition. To recover
1736 the automatic composition, we must update the
1738 windows_or_buffers_changed
++;
1739 if (!already_adjusted
)
1740 adjust_point_for_property (last_point_position
,
1741 MODIFF
!= prev_modiff
);
1744 /* Install chars successfully executed in kbd macro. */
1746 if (!NILP (KVAR (current_kboard
, defining_kbd_macro
))
1747 && NILP (KVAR (current_kboard
, Vprefix_arg
)))
1748 finalize_kbd_macro_chars ();
1749 #if 0 /* This shouldn't be necessary anymore. --lorentey */
1751 any_kboard_state ();
1756 /* Adjust point to a boundary of a region that has such a property
1757 that should be treated intangible. For the moment, we check
1758 `composition', `display' and `invisible' properties.
1759 LAST_PT is the last position of point. */
1762 adjust_point_for_property (ptrdiff_t last_pt
, int modified
)
1765 Lisp_Object val
, overlay
, tmp
;
1766 /* When called after buffer modification, we should temporarily
1767 suppress the point adjustment for automatic composition so that a
1768 user can keep inserting another character at point or keep
1769 deleting characters around point. */
1770 int check_composition
= ! modified
, check_display
= 1, check_invisible
= 1;
1771 ptrdiff_t orig_pt
= PT
;
1773 /* FIXME: cycling is probably not necessary because these properties
1774 can't be usefully combined anyway. */
1775 while (check_composition
|| check_display
|| check_invisible
)
1777 /* FIXME: check `intangible'. */
1778 if (check_composition
1779 && PT
> BEGV
&& PT
< ZV
1780 && (beg
= composition_adjust_point (last_pt
, PT
)) != PT
)
1783 check_display
= check_invisible
= 1;
1785 check_composition
= 0;
1787 && PT
> BEGV
&& PT
< ZV
1788 && !NILP (val
= get_char_property_and_overlay
1789 (make_number (PT
), Qdisplay
, Qnil
, &overlay
))
1790 && display_prop_intangible_p (val
, overlay
, PT
, PT_BYTE
)
1791 && (!OVERLAYP (overlay
)
1792 ? get_property_and_range (PT
, Qdisplay
, &val
, &beg
, &end
, Qnil
)
1793 : (beg
= OVERLAY_POSITION (OVERLAY_START (overlay
)),
1794 end
= OVERLAY_POSITION (OVERLAY_END (overlay
))))
1795 && (beg
< PT
/* && end > PT <- It's always the case. */
1796 || (beg
<= PT
&& STRINGP (val
) && SCHARS (val
) == 0)))
1799 SET_PT (PT
< last_pt
1800 ? (STRINGP (val
) && SCHARS (val
) == 0
1801 ? max (beg
- 1, BEGV
)
1804 check_composition
= check_invisible
= 1;
1807 if (check_invisible
&& PT
> BEGV
&& PT
< ZV
)
1809 int inv
, ellipsis
= 0;
1812 /* Find boundaries `beg' and `end' of the invisible area, if any. */
1815 /* FIXME: We should stop if we find a spot between
1816 two runs of `invisible' where inserted text would
1817 be visible. This is important when we have two
1818 invisible boundaries that enclose an area: if the
1819 area is empty, we need this test in order to make
1820 it possible to place point in the middle rather
1821 than skip both boundaries. However, this code
1822 also stops anywhere in a non-sticky text-property,
1823 which breaks (e.g.) Org mode. */
1824 && (val
= get_pos_property (make_number (end
),
1826 TEXT_PROP_MEANS_INVISIBLE (val
))
1828 && !NILP (val
= get_char_property_and_overlay
1829 (make_number (end
), Qinvisible
, Qnil
, &overlay
))
1830 && (inv
= TEXT_PROP_MEANS_INVISIBLE (val
)))
1832 ellipsis
= ellipsis
|| inv
> 1
1833 || (OVERLAYP (overlay
)
1834 && (!NILP (Foverlay_get (overlay
, Qafter_string
))
1835 || !NILP (Foverlay_get (overlay
, Qbefore_string
))));
1836 tmp
= Fnext_single_char_property_change
1837 (make_number (end
), Qinvisible
, Qnil
, Qnil
);
1838 end
= NATNUMP (tmp
) ? XFASTINT (tmp
) : ZV
;
1842 && (val
= get_pos_property (make_number (beg
),
1844 TEXT_PROP_MEANS_INVISIBLE (val
))
1846 && !NILP (val
= get_char_property_and_overlay
1847 (make_number (beg
- 1), Qinvisible
, Qnil
, &overlay
))
1848 && (inv
= TEXT_PROP_MEANS_INVISIBLE (val
)))
1850 ellipsis
= ellipsis
|| inv
> 1
1851 || (OVERLAYP (overlay
)
1852 && (!NILP (Foverlay_get (overlay
, Qafter_string
))
1853 || !NILP (Foverlay_get (overlay
, Qbefore_string
))));
1854 tmp
= Fprevious_single_char_property_change
1855 (make_number (beg
), Qinvisible
, Qnil
, Qnil
);
1856 beg
= NATNUMP (tmp
) ? XFASTINT (tmp
) : BEGV
;
1859 /* Move away from the inside area. */
1860 if (beg
< PT
&& end
> PT
)
1862 SET_PT ((orig_pt
== PT
&& (last_pt
< beg
|| last_pt
> end
))
1863 /* We haven't moved yet (so we don't need to fear
1864 infinite-looping) and we were outside the range
1865 before (so either end of the range still corresponds
1866 to a move in the right direction): pretend we moved
1867 less than we actually did, so that we still have
1868 more freedom below in choosing which end of the range
1870 ? (orig_pt
= -1, PT
< last_pt
? end
: beg
)
1871 /* We either have moved already or the last point
1872 was already in the range: we don't get to choose
1873 which end of the range we have to go to. */
1874 : (PT
< last_pt
? beg
: end
));
1875 check_composition
= check_display
= 1;
1877 #if 0 /* This assertion isn't correct, because SET_PT may end up setting
1878 the point to something other than its argument, due to
1879 point-motion hooks, intangibility, etc. */
1880 eassert (PT
== beg
|| PT
== end
);
1883 /* Pretend the area doesn't exist if the buffer is not
1885 if (!modified
&& !ellipsis
&& beg
< end
)
1887 if (last_pt
== beg
&& PT
== end
&& end
< ZV
)
1888 (check_composition
= check_display
= 1, SET_PT (end
+ 1));
1889 else if (last_pt
== end
&& PT
== beg
&& beg
> BEGV
)
1890 (check_composition
= check_display
= 1, SET_PT (beg
- 1));
1891 else if (PT
== ((PT
< last_pt
) ? beg
: end
))
1892 /* We've already moved as far as we can. Trying to go
1893 to the other end would mean moving backwards and thus
1894 could lead to an infinite loop. */
1896 else if (val
= get_pos_property (make_number (PT
),
1898 TEXT_PROP_MEANS_INVISIBLE (val
)
1899 && (val
= get_pos_property
1900 (make_number (PT
== beg
? end
: beg
),
1902 !TEXT_PROP_MEANS_INVISIBLE (val
)))
1903 (check_composition
= check_display
= 1,
1904 SET_PT (PT
== beg
? end
: beg
));
1907 check_invisible
= 0;
1911 /* Subroutine for safe_run_hooks: run the hook HOOK. */
1914 safe_run_hooks_1 (void)
1916 eassert (CONSP (Vinhibit_quit
));
1917 return call0 (XCDR (Vinhibit_quit
));
1920 /* Subroutine for safe_run_hooks: handle an error by clearing out the function
1924 safe_run_hooks_error (Lisp_Object error_data
)
1927 = CONSP (Vinhibit_quit
) ? XCAR (Vinhibit_quit
) : Vinhibit_quit
;
1928 Lisp_Object fun
= CONSP (Vinhibit_quit
) ? XCDR (Vinhibit_quit
) : Qnil
;
1929 Lisp_Object args
[4];
1930 args
[0] = build_string ("Error in %s (%s): %S");
1933 args
[3] = error_data
;
1939 Lisp_Object newval
= Qnil
;
1940 for (val
= find_symbol_value (hook
); CONSP (val
); val
= XCDR (val
))
1941 if (EQ (fun
, XCAR (val
)))
1944 newval
= Fcons (XCAR (val
), newval
);
1946 return Fset (hook
, Fnreverse (newval
));
1947 /* Not found in the local part of the hook. Let's look at the global
1950 for (val
= (NILP (Fdefault_boundp (hook
)) ? Qnil
1951 : Fdefault_value (hook
));
1952 CONSP (val
); val
= XCDR (val
))
1953 if (EQ (fun
, XCAR (val
)))
1956 newval
= Fcons (XCAR (val
), newval
);
1958 return Fset_default (hook
, Fnreverse (newval
));
1964 safe_run_hook_funcall (ptrdiff_t nargs
, Lisp_Object
*args
)
1966 eassert (nargs
== 1);
1967 if (CONSP (Vinhibit_quit
))
1968 XSETCDR (Vinhibit_quit
, args
[0]);
1970 Vinhibit_quit
= Fcons (Vinhibit_quit
, args
[0]);
1972 internal_condition_case (safe_run_hooks_1
, Qt
, safe_run_hooks_error
);
1976 /* If we get an error while running the hook, cause the hook variable
1977 to be nil. Also inhibit quits, so that C-g won't cause the hook
1978 to mysteriously evaporate. */
1981 safe_run_hooks (Lisp_Object hook
)
1983 /* FIXME: our `internal_condition_case' does not provide any way to pass data
1984 to its body or to its handlers other than via globals such as
1985 dynamically-bound variables ;-) */
1986 ptrdiff_t count
= SPECPDL_INDEX ();
1987 specbind (Qinhibit_quit
, hook
);
1989 run_hook_with_args (1, &hook
, safe_run_hook_funcall
);
1991 unbind_to (count
, Qnil
);
1995 /* Nonzero means polling for input is temporarily suppressed. */
1997 int poll_suppress_count
;
1999 /* Asynchronous timer for polling. */
2001 static struct atimer
*poll_timer
;
2004 #ifdef POLL_FOR_INPUT
2006 /* Poll for input, so that we catch a C-g if it comes in. This
2007 function is called from x_make_frame_visible, see comment
2011 poll_for_input_1 (void)
2013 /* Tell ns_read_socket() it is being called asynchronously so it can avoid
2014 doing anything dangerous. */
2018 if (interrupt_input_blocked
== 0
2019 && !waiting_for_input
)
2020 read_avail_input (0);
2026 /* Timer callback function for poll_timer. TIMER is equal to
2030 poll_for_input (struct atimer
*timer
)
2032 if (poll_suppress_count
== 0)
2035 interrupt_input_pending
= 1;
2036 pending_signals
= 1;
2038 poll_for_input_1 ();
2043 #endif /* POLL_FOR_INPUT */
2045 /* Begin signals to poll for input, if they are appropriate.
2046 This function is called unconditionally from various places. */
2049 start_polling (void)
2051 #ifdef POLL_FOR_INPUT
2052 /* XXX This condition was (read_socket_hook && !interrupt_input),
2053 but read_socket_hook is not global anymore. Let's pretend that
2055 if (!interrupt_input
)
2057 /* Turn alarm handling on unconditionally. It might have
2058 been turned off in process.c. */
2059 turn_on_atimers (1);
2061 /* If poll timer doesn't exist, are we need one with
2062 a different interval, start a new one. */
2063 if (poll_timer
== NULL
2064 || EMACS_SECS (poll_timer
->interval
) != polling_period
)
2066 time_t period
= max (1, min (polling_period
, TYPE_MAXIMUM (time_t)));
2067 EMACS_TIME interval
= make_emacs_time (period
, 0);
2070 cancel_atimer (poll_timer
);
2072 poll_timer
= start_atimer (ATIMER_CONTINUOUS
, interval
,
2073 poll_for_input
, NULL
);
2076 /* Let the timer's callback function poll for input
2077 if this becomes zero. */
2078 --poll_suppress_count
;
2083 /* Nonzero if we are using polling to handle input asynchronously. */
2086 input_polling_used (void)
2088 #ifdef POLL_FOR_INPUT
2089 /* XXX This condition was (read_socket_hook && !interrupt_input),
2090 but read_socket_hook is not global anymore. Let's pretend that
2092 return !interrupt_input
;
2098 /* Turn off polling. */
2103 #ifdef POLL_FOR_INPUT
2104 /* XXX This condition was (read_socket_hook && !interrupt_input),
2105 but read_socket_hook is not global anymore. Let's pretend that
2107 if (!interrupt_input
)
2108 ++poll_suppress_count
;
2112 /* Set the value of poll_suppress_count to COUNT
2113 and start or stop polling accordingly. */
2116 set_poll_suppress_count (int count
)
2118 #ifdef POLL_FOR_INPUT
2119 if (count
== 0 && poll_suppress_count
!= 0)
2121 poll_suppress_count
= 1;
2124 else if (count
!= 0 && poll_suppress_count
== 0)
2128 poll_suppress_count
= count
;
2132 /* Bind polling_period to a value at least N.
2133 But don't decrease it. */
2136 bind_polling_period (int n
)
2138 #ifdef POLL_FOR_INPUT
2139 EMACS_INT
new = polling_period
;
2144 stop_other_atimers (poll_timer
);
2146 specbind (Qpolling_period
, make_number (new));
2147 /* Start a new alarm with the new period. */
2152 /* Apply the control modifier to CHARACTER. */
2155 make_ctrl_char (int c
)
2157 /* Save the upper bits here. */
2158 int upper
= c
& ~0177;
2160 if (! ASCII_BYTE_P (c
))
2161 return c
|= ctrl_modifier
;
2165 /* Everything in the columns containing the upper-case letters
2166 denotes a control character. */
2167 if (c
>= 0100 && c
< 0140)
2171 /* Set the shift modifier for a control char
2172 made from a shifted letter. But only for letters! */
2173 if (oc
>= 'A' && oc
<= 'Z')
2174 c
|= shift_modifier
;
2177 /* The lower-case letters denote control characters too. */
2178 else if (c
>= 'a' && c
<= 'z')
2181 /* Include the bits for control and shift
2182 only if the basic ASCII code can't indicate them. */
2186 /* Replace the high bits. */
2187 c
|= (upper
& ~ctrl_modifier
);
2192 /* Display the help-echo property of the character after the mouse pointer.
2193 Either show it in the echo area, or call show-help-function to display
2194 it by other means (maybe in a tooltip).
2196 If HELP is nil, that means clear the previous help echo.
2198 If HELP is a string, display that string. If HELP is a function,
2199 call it with OBJECT and POS as arguments; the function should
2200 return a help string or nil for none. For all other types of HELP,
2201 evaluate it to obtain a string.
2203 WINDOW is the window in which the help was generated, if any.
2204 It is nil if not in a window.
2206 If OBJECT is a buffer, POS is the position in the buffer where the
2207 `help-echo' text property was found.
2209 If OBJECT is an overlay, that overlay has a `help-echo' property,
2210 and POS is the position in the overlay's buffer under the mouse.
2212 If OBJECT is a string (an overlay string or a string displayed with
2213 the `display' property). POS is the position in that string under
2216 Note: this function may only be called with HELP nil or a string
2217 from X code running asynchronously. */
2220 show_help_echo (Lisp_Object help
, Lisp_Object window
, Lisp_Object object
,
2223 if (!NILP (help
) && !STRINGP (help
))
2225 if (FUNCTIONP (help
))
2226 help
= safe_call (4, help
, window
, object
, pos
);
2228 help
= safe_eval (help
);
2230 if (!STRINGP (help
))
2234 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
2235 if (!noninteractive
&& STRINGP (help
))
2237 /* The mouse-fixup-help-message Lisp function can call
2238 mouse_position_hook, which resets the mouse_moved flags.
2239 This causes trouble if we are trying to read a mouse motion
2240 event (i.e., if we are inside a `track-mouse' form), so we
2241 restore the mouse_moved flag. */
2242 FRAME_PTR f
= NILP (do_mouse_tracking
) ? NULL
: some_mouse_moved ();
2243 help
= call1 (Qmouse_fixup_help_message
, help
);
2249 if (STRINGP (help
) || NILP (help
))
2251 if (!NILP (Vshow_help_function
))
2252 call1 (Vshow_help_function
, help
);
2253 help_echo_showing_p
= STRINGP (help
);
2259 /* Input of single characters from keyboard */
2261 static Lisp_Object
kbd_buffer_get_event (KBOARD
**kbp
, int *used_mouse_menu
,
2262 EMACS_TIME
*end_time
);
2263 static void record_char (Lisp_Object c
);
2265 static Lisp_Object help_form_saved_window_configs
;
2267 read_char_help_form_unwind (Lisp_Object arg
)
2269 Lisp_Object window_config
= XCAR (help_form_saved_window_configs
);
2270 help_form_saved_window_configs
= XCDR (help_form_saved_window_configs
);
2271 if (!NILP (window_config
))
2272 Fset_window_configuration (window_config
);
2276 #define STOP_POLLING \
2277 do { if (! polling_stopped_here) stop_polling (); \
2278 polling_stopped_here = 1; } while (0)
2280 #define RESUME_POLLING \
2281 do { if (polling_stopped_here) start_polling (); \
2282 polling_stopped_here = 0; } while (0)
2284 /* read a character from the keyboard; call the redisplay if needed */
2285 /* commandflag 0 means do not autosave, but do redisplay.
2286 -1 means do not redisplay, but do autosave.
2289 /* The arguments MAPS and NMAPS are for menu prompting.
2290 MAPS is an array of keymaps; NMAPS is the length of MAPS.
2292 PREV_EVENT is the previous input event, or nil if we are reading
2293 the first event of a key sequence (or not reading a key sequence).
2294 If PREV_EVENT is t, that is a "magic" value that says
2295 not to run input methods, but in other respects to act as if
2296 not reading a key sequence.
2298 If USED_MOUSE_MENU is non-null, then we set *USED_MOUSE_MENU to 1
2299 if we used a mouse menu to read the input, or zero otherwise. If
2300 USED_MOUSE_MENU is null, we don't dereference it.
2302 Value is -2 when we find input on another keyboard. A second call
2303 to read_char will read it.
2305 If END_TIME is non-null, it is a pointer to an EMACS_TIME
2306 specifying the maximum time to wait until. If no input arrives by
2307 that time, stop waiting and return nil.
2309 Value is t if we showed a menu and the user rejected it. */
2312 read_char (int commandflag
, ptrdiff_t nmaps
, Lisp_Object
*maps
,
2313 Lisp_Object prev_event
,
2314 int *used_mouse_menu
, EMACS_TIME
*end_time
)
2316 volatile Lisp_Object c
;
2318 jmp_buf local_getcjmp
;
2320 volatile int key_already_recorded
= 0;
2321 Lisp_Object tem
, save
;
2322 volatile Lisp_Object previous_echo_area_message
;
2323 volatile Lisp_Object also_record
;
2324 volatile int reread
;
2325 struct gcpro gcpro1
, gcpro2
;
2326 int volatile polling_stopped_here
= 0;
2327 struct kboard
*orig_kboard
= current_kboard
;
2331 #if 0 /* This was commented out as part of fixing echo for C-u left. */
2332 before_command_key_count
= this_command_key_count
;
2333 before_command_echo_length
= echo_length ();
2336 previous_echo_area_message
= Qnil
;
2338 GCPRO2 (c
, previous_echo_area_message
);
2343 if (CONSP (Vunread_post_input_method_events
))
2345 c
= XCAR (Vunread_post_input_method_events
);
2346 Vunread_post_input_method_events
2347 = XCDR (Vunread_post_input_method_events
);
2349 /* Undo what read_char_x_menu_prompt did when it unread
2350 additional keys returned by Fx_popup_menu. */
2352 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2360 if (CONSP (Vunread_command_events
))
2362 int was_disabled
= 0;
2364 c
= XCAR (Vunread_command_events
);
2365 Vunread_command_events
= XCDR (Vunread_command_events
);
2369 /* Undo what sit-for did when it unread additional keys
2370 inside universal-argument. */
2373 && EQ (XCAR (c
), Qt
))
2379 /* Undo what read_char_x_menu_prompt did when it unread
2380 additional keys returned by Fx_popup_menu. */
2382 && EQ (XCDR (c
), Qdisabled
)
2383 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
))))
2389 /* If the queued event is something that used the mouse,
2390 set used_mouse_menu accordingly. */
2392 /* Also check was_disabled so last-nonmenu-event won't return
2393 a bad value when submenus are involved. (Bug#447) */
2394 && (EQ (c
, Qtool_bar
) || EQ (c
, Qmenu_bar
) || was_disabled
))
2395 *used_mouse_menu
= 1;
2397 goto reread_for_input_method
;
2400 if (CONSP (Vunread_input_method_events
))
2402 c
= XCAR (Vunread_input_method_events
);
2403 Vunread_input_method_events
= XCDR (Vunread_input_method_events
);
2405 /* Undo what read_char_x_menu_prompt did when it unread
2406 additional keys returned by Fx_popup_menu. */
2408 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2412 goto reread_for_input_method
;
2415 this_command_key_count_reset
= 0;
2417 if (!NILP (Vexecuting_kbd_macro
))
2419 /* We set this to Qmacro; since that's not a frame, nobody will
2420 try to switch frames on us, and the selected window will
2423 Since this event came from a macro, it would be misleading to
2424 leave internal_last_event_frame set to wherever the last
2425 real event came from. Normally, a switch-frame event selects
2426 internal_last_event_frame after each command is read, but
2427 events read from a macro should never cause a new frame to be
2429 Vlast_event_frame
= internal_last_event_frame
= Qmacro
;
2431 /* Exit the macro if we are at the end.
2432 Also, some things replace the macro with t
2433 to force an early exit. */
2434 if (EQ (Vexecuting_kbd_macro
, Qt
)
2435 || executing_kbd_macro_index
>= XFASTINT (Flength (Vexecuting_kbd_macro
)))
2441 c
= Faref (Vexecuting_kbd_macro
, make_number (executing_kbd_macro_index
));
2442 if (STRINGP (Vexecuting_kbd_macro
)
2443 && (XFASTINT (c
) & 0x80) && (XFASTINT (c
) <= 0xff))
2444 XSETFASTINT (c
, CHAR_META
| (XFASTINT (c
) & ~0x80));
2446 executing_kbd_macro_index
++;
2451 if (!NILP (unread_switch_frame
))
2453 c
= unread_switch_frame
;
2454 unread_switch_frame
= Qnil
;
2456 /* This event should make it into this_command_keys, and get echoed
2457 again, so we do not set `reread'. */
2461 /* if redisplay was requested */
2462 if (commandflag
>= 0)
2464 int echo_current
= EQ (echo_message_buffer
, echo_area_buffer
[0]);
2466 /* If there is pending input, process any events which are not
2467 user-visible, such as X selection_request events. */
2469 || detect_input_pending_run_timers (0))
2470 swallow_events (0); /* may clear input_pending */
2472 /* Redisplay if no pending input. */
2473 while (!input_pending
)
2475 if (help_echo_showing_p
&& !EQ (selected_window
, minibuf_window
))
2476 redisplay_preserve_echo_area (5);
2481 /* Normal case: no input arrived during redisplay. */
2484 /* Input arrived and pre-empted redisplay.
2485 Process any events which are not user-visible. */
2487 /* If that cleared input_pending, try again to redisplay. */
2490 /* Prevent the redisplay we just did
2491 from messing up echoing of the input after the prompt. */
2492 if (commandflag
== 0 && echo_current
)
2493 echo_message_buffer
= echo_area_buffer
[0];
2497 /* Message turns off echoing unless more keystrokes turn it on again.
2499 The code in 20.x for the condition was
2501 1. echo_area_glyphs && *echo_area_glyphs
2502 2. && echo_area_glyphs != current_kboard->echobuf
2503 3. && ok_to_echo_at_next_pause != echo_area_glyphs
2505 (1) means there's a current message displayed
2507 (2) means it's not the message from echoing from the current
2510 (3) There's only one place in 20.x where ok_to_echo_at_next_pause
2511 is set to a non-null value. This is done in read_char and it is
2512 set to echo_area_glyphs after a call to echo_char. That means
2513 ok_to_echo_at_next_pause is either null or
2514 current_kboard->echobuf with the appropriate current_kboard at
2517 So, condition (3) means in clear text ok_to_echo_at_next_pause
2518 must be either null, or the current message isn't from echoing at
2519 all, or it's from echoing from a different kboard than the
2522 if (/* There currently is something in the echo area. */
2523 !NILP (echo_area_buffer
[0])
2524 && (/* And it's either not from echoing. */
2525 !EQ (echo_area_buffer
[0], echo_message_buffer
)
2526 /* Or it's an echo from a different kboard. */
2527 || echo_kboard
!= current_kboard
2528 /* Or we explicitly allow overwriting whatever there is. */
2529 || ok_to_echo_at_next_pause
== NULL
))
2534 /* Try reading a character via menu prompting in the minibuf.
2535 Try this before the sit-for, because the sit-for
2536 would do the wrong thing if we are supposed to do
2537 menu prompting. If EVENT_HAS_PARAMETERS then we are reading
2538 after a mouse event so don't try a minibuf menu. */
2540 if (nmaps
> 0 && INTERACTIVE
2541 && !NILP (prev_event
) && ! EVENT_HAS_PARAMETERS (prev_event
)
2542 /* Don't bring up a menu if we already have another event. */
2543 && NILP (Vunread_command_events
)
2544 && !detect_input_pending_run_timers (0))
2546 c
= read_char_minibuf_menu_prompt (commandflag
, nmaps
, maps
);
2548 if (INTEGERP (c
) && XINT (c
) == -2)
2549 return c
; /* wrong_kboard_jmpbuf */
2553 key_already_recorded
= 1;
2558 /* Make a longjmp point for quits to use, but don't alter getcjmp just yet.
2559 We will do that below, temporarily for short sections of code,
2560 when appropriate. local_getcjmp must be in effect
2561 around any call to sit_for or kbd_buffer_get_event;
2562 it *must not* be in effect when we call redisplay. */
2564 jmpcount
= SPECPDL_INDEX ();
2565 if (_setjmp (local_getcjmp
))
2567 /* Handle quits while reading the keyboard. */
2568 /* We must have saved the outer value of getcjmp here,
2569 so restore it now. */
2570 restore_getcjmp (save_jump
);
2571 unbind_to (jmpcount
, Qnil
);
2572 XSETINT (c
, quit_char
);
2573 internal_last_event_frame
= selected_frame
;
2574 Vlast_event_frame
= internal_last_event_frame
;
2575 /* If we report the quit char as an event,
2576 don't do so more than once. */
2577 if (!NILP (Vinhibit_quit
))
2581 KBOARD
*kb
= FRAME_KBOARD (XFRAME (selected_frame
));
2582 if (kb
!= current_kboard
)
2584 Lisp_Object last
= KVAR (kb
, kbd_queue
);
2585 /* We shouldn't get here if we were in single-kboard mode! */
2590 while (CONSP (XCDR (last
)))
2592 if (!NILP (XCDR (last
)))
2596 kset_kbd_queue (kb
, Fcons (c
, Qnil
));
2598 XSETCDR (last
, Fcons (c
, Qnil
));
2599 kb
->kbd_queue_has_data
= 1;
2600 current_kboard
= kb
;
2601 /* This is going to exit from read_char
2602 so we had better get rid of this frame's stuff. */
2604 return make_number (-2); /* wrong_kboard_jmpbuf */
2610 /* Start idle timers if no time limit is supplied. We don't do it
2611 if a time limit is supplied to avoid an infinite recursion in the
2612 situation where an idle timer calls `sit-for'. */
2615 timer_start_idle ();
2617 /* If in middle of key sequence and minibuffer not active,
2618 start echoing if enough time elapses. */
2620 if (minibuf_level
== 0
2622 && !current_kboard
->immediate_echo
2623 && this_command_key_count
> 0
2625 && (FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
2626 && NILP (Fzerop (Vecho_keystrokes
))
2627 && (/* No message. */
2628 NILP (echo_area_buffer
[0])
2629 /* Or empty message. */
2630 || (BUF_BEG (XBUFFER (echo_area_buffer
[0]))
2631 == BUF_Z (XBUFFER (echo_area_buffer
[0])))
2632 /* Or already echoing from same kboard. */
2633 || (echo_kboard
&& ok_to_echo_at_next_pause
== echo_kboard
)
2634 /* Or not echoing before and echoing allowed. */
2635 || (!echo_kboard
&& ok_to_echo_at_next_pause
)))
2637 /* After a mouse event, start echoing right away.
2638 This is because we are probably about to display a menu,
2639 and we don't want to delay before doing so. */
2640 if (EVENT_HAS_PARAMETERS (prev_event
))
2646 save_getcjmp (save_jump
);
2647 restore_getcjmp (local_getcjmp
);
2648 tem0
= sit_for (Vecho_keystrokes
, 1, 1);
2649 restore_getcjmp (save_jump
);
2651 && ! CONSP (Vunread_command_events
))
2656 /* Maybe auto save due to number of keystrokes. */
2658 if (commandflag
!= 0
2659 && auto_save_interval
> 0
2660 && num_nonmacro_input_events
- last_auto_save
> max (auto_save_interval
, 20)
2661 && !detect_input_pending_run_timers (0))
2663 Fdo_auto_save (Qnil
, Qnil
);
2664 /* Hooks can actually change some buffers in auto save. */
2668 /* Try reading using an X menu.
2669 This is never confused with reading using the minibuf
2670 because the recursive call of read_char in read_char_minibuf_menu_prompt
2671 does not pass on any keymaps. */
2673 if (nmaps
> 0 && INTERACTIVE
2674 && !NILP (prev_event
)
2675 && EVENT_HAS_PARAMETERS (prev_event
)
2676 && !EQ (XCAR (prev_event
), Qmenu_bar
)
2677 && !EQ (XCAR (prev_event
), Qtool_bar
)
2678 /* Don't bring up a menu if we already have another event. */
2679 && NILP (Vunread_command_events
))
2681 c
= read_char_x_menu_prompt (nmaps
, maps
, prev_event
, used_mouse_menu
);
2683 /* Now that we have read an event, Emacs is not idle. */
2690 /* Maybe autosave and/or garbage collect due to idleness. */
2692 if (INTERACTIVE
&& NILP (c
))
2695 ptrdiff_t buffer_size
;
2697 /* Slow down auto saves logarithmically in size of current buffer,
2698 and garbage collect while we're at it. */
2699 if (! MINI_WINDOW_P (XWINDOW (selected_window
)))
2700 last_non_minibuf_size
= Z
- BEG
;
2701 buffer_size
= (last_non_minibuf_size
>> 8) + 1;
2703 while (buffer_size
> 64)
2704 delay_level
++, buffer_size
-= buffer_size
>> 2;
2705 if (delay_level
< 4) delay_level
= 4;
2706 /* delay_level is 4 for files under around 50k, 7 at 100k,
2707 9 at 200k, 11 at 300k, and 12 at 500k. It is 15 at 1 meg. */
2709 /* Auto save if enough time goes by without input. */
2710 if (commandflag
!= 0
2711 && num_nonmacro_input_events
> last_auto_save
2712 && INTEGERP (Vauto_save_timeout
)
2713 && XINT (Vauto_save_timeout
) > 0)
2716 EMACS_INT timeout
= (delay_level
2717 * min (XFASTINT (Vauto_save_timeout
) / 4,
2718 MOST_POSITIVE_FIXNUM
/ delay_level
));
2719 save_getcjmp (save_jump
);
2720 restore_getcjmp (local_getcjmp
);
2721 tem0
= sit_for (make_number (timeout
), 1, 1);
2722 restore_getcjmp (save_jump
);
2725 && ! CONSP (Vunread_command_events
))
2727 Fdo_auto_save (Qnil
, Qnil
);
2732 /* If there is still no input available, ask for GC. */
2733 if (!detect_input_pending_run_timers (0))
2737 /* Notify the caller if an autosave hook, or a timer, sentinel or
2738 filter in the sit_for calls above have changed the current
2739 kboard. This could happen if they use the minibuffer or start a
2740 recursive edit, like the fancy splash screen in server.el's
2741 filter. If this longjmp wasn't here, read_key_sequence would
2742 interpret the next key sequence using the wrong translation
2743 tables and function keymaps. */
2744 if (NILP (c
) && current_kboard
!= orig_kboard
)
2747 return make_number (-2); /* wrong_kboard_jmpbuf */
2750 /* If this has become non-nil here, it has been set by a timer
2751 or sentinel or filter. */
2752 if (CONSP (Vunread_command_events
))
2754 c
= XCAR (Vunread_command_events
);
2755 Vunread_command_events
= XCDR (Vunread_command_events
);
2758 /* Read something from current KBOARD's side queue, if possible. */
2762 if (current_kboard
->kbd_queue_has_data
)
2764 if (!CONSP (KVAR (current_kboard
, kbd_queue
)))
2766 c
= XCAR (KVAR (current_kboard
, kbd_queue
));
2767 kset_kbd_queue (current_kboard
,
2768 XCDR (KVAR (current_kboard
, kbd_queue
)));
2769 if (NILP (KVAR (current_kboard
, kbd_queue
)))
2770 current_kboard
->kbd_queue_has_data
= 0;
2771 input_pending
= readable_events (0);
2772 if (EVENT_HAS_PARAMETERS (c
)
2773 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qswitch_frame
))
2774 internal_last_event_frame
= XCAR (XCDR (c
));
2775 Vlast_event_frame
= internal_last_event_frame
;
2779 /* If current_kboard's side queue is empty check the other kboards.
2780 If one of them has data that we have not yet seen here,
2781 switch to it and process the data waiting for it.
2783 Note: if the events queued up for another kboard
2784 have already been seen here, and therefore are not a complete command,
2785 the kbd_queue_has_data field is 0, so we skip that kboard here.
2786 That's to avoid an infinite loop switching between kboards here. */
2787 if (NILP (c
) && !single_kboard
)
2790 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
2791 if (kb
->kbd_queue_has_data
)
2793 current_kboard
= kb
;
2794 /* This is going to exit from read_char
2795 so we had better get rid of this frame's stuff. */
2797 return make_number (-2); /* wrong_kboard_jmpbuf */
2805 /* Finally, we read from the main queue,
2806 and if that gives us something we can't use yet, we put it on the
2807 appropriate side queue and try again. */
2811 KBOARD
*kb
IF_LINT (= NULL
);
2813 if (end_time
&& EMACS_TIME_LE (*end_time
, current_emacs_time ()))
2816 /* Actually read a character, waiting if necessary. */
2817 save_getcjmp (save_jump
);
2818 restore_getcjmp (local_getcjmp
);
2820 timer_start_idle ();
2821 c
= kbd_buffer_get_event (&kb
, used_mouse_menu
, end_time
);
2822 restore_getcjmp (save_jump
);
2824 if (! NILP (c
) && (kb
!= current_kboard
))
2826 Lisp_Object last
= KVAR (kb
, kbd_queue
);
2829 while (CONSP (XCDR (last
)))
2831 if (!NILP (XCDR (last
)))
2835 kset_kbd_queue (kb
, Fcons (c
, Qnil
));
2837 XSETCDR (last
, Fcons (c
, Qnil
));
2838 kb
->kbd_queue_has_data
= 1;
2842 current_kboard
= kb
;
2843 /* This is going to exit from read_char
2844 so we had better get rid of this frame's stuff. */
2846 return make_number (-2);
2850 /* Terminate Emacs in batch mode if at eof. */
2851 if (noninteractive
&& INTEGERP (c
) && XINT (c
) < 0)
2852 Fkill_emacs (make_number (1));
2856 /* Add in any extra modifiers, where appropriate. */
2857 if ((extra_keyboard_modifiers
& CHAR_CTL
)
2858 || ((extra_keyboard_modifiers
& 0177) < ' '
2859 && (extra_keyboard_modifiers
& 0177) != 0))
2860 XSETINT (c
, make_ctrl_char (XINT (c
)));
2862 /* Transfer any other modifier bits directly from
2863 extra_keyboard_modifiers to c. Ignore the actual character code
2864 in the low 16 bits of extra_keyboard_modifiers. */
2865 XSETINT (c
, XINT (c
) | (extra_keyboard_modifiers
& ~0xff7f & ~CHAR_CTL
));
2876 if (commandflag
>= 0
2877 && !input_pending
&& !detect_input_pending_run_timers (0))
2885 /* Buffer switch events are only for internal wakeups
2886 so don't show them to the user.
2887 Also, don't record a key if we already did. */
2888 if (BUFFERP (c
) || key_already_recorded
)
2891 /* Process special events within read_char
2892 and loop around to read another event. */
2895 tem
= access_keymap (get_keymap (Vspecial_event_map
, 0, 1), c
, 0, 0, 1);
2900 struct buffer
*prev_buffer
= current_buffer
;
2901 #if 0 /* This shouldn't be necessary anymore. --lorentey */
2902 int was_locked
= single_kboard
;
2903 ptrdiff_t count
= SPECPDL_INDEX ();
2904 record_single_kboard_state ();
2907 last_input_event
= c
;
2908 Fcommand_execute (tem
, Qnil
, Fvector (1, &last_input_event
), Qt
);
2910 if (CONSP (c
) && EQ (XCAR (c
), Qselect_window
) && !end_time
)
2911 /* We stopped being idle for this event; undo that. This
2912 prevents automatic window selection (under
2913 mouse_autoselect_window from acting as a real input event, for
2914 example banishing the mouse under mouse-avoidance-mode. */
2915 timer_resume_idle ();
2917 #if 0 /* This shouldn't be necessary anymore. --lorentey */
2918 /* Resume allowing input from any kboard, if that was true before. */
2920 any_kboard_state ();
2921 unbind_to (count
, Qnil
);
2924 if (current_buffer
!= prev_buffer
)
2926 /* The command may have changed the keymaps. Pretend there
2927 is input in another keyboard and return. This will
2928 recalculate keymaps. */
2929 c
= make_number (-2);
2936 /* Handle things that only apply to characters. */
2939 /* If kbd_buffer_get_event gave us an EOF, return that. */
2943 if ((STRINGP (KVAR (current_kboard
, Vkeyboard_translate_table
))
2944 && UNSIGNED_CMP (XFASTINT (c
), <,
2945 SCHARS (KVAR (current_kboard
,
2946 Vkeyboard_translate_table
))))
2947 || (VECTORP (KVAR (current_kboard
, Vkeyboard_translate_table
))
2948 && UNSIGNED_CMP (XFASTINT (c
), <,
2949 ASIZE (KVAR (current_kboard
,
2950 Vkeyboard_translate_table
))))
2951 || (CHAR_TABLE_P (KVAR (current_kboard
, Vkeyboard_translate_table
))
2955 d
= Faref (KVAR (current_kboard
, Vkeyboard_translate_table
), c
);
2956 /* nil in keyboard-translate-table means no translation. */
2962 /* If this event is a mouse click in the menu bar,
2963 return just menu-bar for now. Modify the mouse click event
2964 so we won't do this twice, then queue it up. */
2965 if (EVENT_HAS_PARAMETERS (c
)
2967 && CONSP (EVENT_START (c
))
2968 && CONSP (XCDR (EVENT_START (c
))))
2972 posn
= POSN_POSN (EVENT_START (c
));
2973 /* Handle menu-bar events:
2974 insert the dummy prefix event `menu-bar'. */
2975 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
2977 /* Change menu-bar to (menu-bar) as the event "position". */
2978 POSN_SET_POSN (EVENT_START (c
), Fcons (posn
, Qnil
));
2981 Vunread_command_events
= Fcons (c
, Vunread_command_events
);
2986 /* Store these characters into recent_keys, the dribble file if any,
2987 and the keyboard macro being defined, if any. */
2989 if (! NILP (also_record
))
2990 record_char (also_record
);
2992 /* Wipe the echo area.
2993 But first, if we are about to use an input method,
2994 save the echo area contents for it to refer to. */
2996 && ! NILP (Vinput_method_function
)
2997 && ' ' <= XINT (c
) && XINT (c
) < 256 && XINT (c
) != 127)
2999 previous_echo_area_message
= Fcurrent_message ();
3000 Vinput_method_previous_message
= previous_echo_area_message
;
3003 /* Now wipe the echo area, except for help events which do their
3004 own stuff with the echo area. */
3006 || (!(EQ (Qhelp_echo
, XCAR (c
)))
3007 && !(EQ (Qswitch_frame
, XCAR (c
)))
3008 /* Don't wipe echo area for select window events: These might
3009 get delayed via `mouse-autoselect-window' (Bug#11304). */
3010 && !(EQ (Qselect_window
, XCAR (c
)))))
3012 if (!NILP (echo_area_buffer
[0]))
3014 safe_run_hooks (Qecho_area_clear_hook
);
3015 clear_message (1, 0);
3019 reread_for_input_method
:
3021 /* Pass this to the input method, if appropriate. */
3023 && ! NILP (Vinput_method_function
)
3024 /* Don't run the input method within a key sequence,
3025 after the first event of the key sequence. */
3026 && NILP (prev_event
)
3027 && ' ' <= XINT (c
) && XINT (c
) < 256 && XINT (c
) != 127)
3030 ptrdiff_t key_count
;
3031 int key_count_reset
;
3032 struct gcpro gcpro1
;
3033 ptrdiff_t count
= SPECPDL_INDEX ();
3035 /* Save the echo status. */
3036 int saved_immediate_echo
= current_kboard
->immediate_echo
;
3037 struct kboard
*saved_ok_to_echo
= ok_to_echo_at_next_pause
;
3038 Lisp_Object saved_echo_string
= KVAR (current_kboard
, echo_string
);
3039 int saved_echo_after_prompt
= current_kboard
->echo_after_prompt
;
3042 if (before_command_restore_flag
)
3044 this_command_key_count
= before_command_key_count_1
;
3045 if (this_command_key_count
< this_single_command_key_start
)
3046 this_single_command_key_start
= this_command_key_count
;
3047 echo_truncate (before_command_echo_length_1
);
3048 before_command_restore_flag
= 0;
3052 /* Save the this_command_keys status. */
3053 key_count
= this_command_key_count
;
3054 key_count_reset
= this_command_key_count_reset
;
3057 keys
= Fcopy_sequence (this_command_keys
);
3062 /* Clear out this_command_keys. */
3063 this_command_key_count
= 0;
3064 this_command_key_count_reset
= 0;
3066 /* Now wipe the echo area. */
3067 if (!NILP (echo_area_buffer
[0]))
3068 safe_run_hooks (Qecho_area_clear_hook
);
3069 clear_message (1, 0);
3072 /* If we are not reading a key sequence,
3073 never use the echo area. */
3076 specbind (Qinput_method_use_echo_area
, Qt
);
3079 /* Call the input method. */
3080 tem
= call1 (Vinput_method_function
, c
);
3082 tem
= unbind_to (count
, tem
);
3084 /* Restore the saved echoing state
3085 and this_command_keys state. */
3086 this_command_key_count
= key_count
;
3087 this_command_key_count_reset
= key_count_reset
;
3089 this_command_keys
= keys
;
3092 ok_to_echo_at_next_pause
= saved_ok_to_echo
;
3093 kset_echo_string (current_kboard
, saved_echo_string
);
3094 current_kboard
->echo_after_prompt
= saved_echo_after_prompt
;
3095 if (saved_immediate_echo
)
3100 /* The input method can return no events. */
3103 /* Bring back the previous message, if any. */
3104 if (! NILP (previous_echo_area_message
))
3105 message_with_string ("%s", previous_echo_area_message
, 0);
3108 /* It returned one event or more. */
3110 Vunread_post_input_method_events
3111 = nconc2 (XCDR (tem
), Vunread_post_input_method_events
);
3116 /* Display help if not echoing. */
3117 if (CONSP (c
) && EQ (XCAR (c
), Qhelp_echo
))
3119 /* (help-echo FRAME HELP WINDOW OBJECT POS). */
3120 Lisp_Object help
, object
, position
, window
, htem
;
3122 htem
= Fcdr (XCDR (c
));
3125 window
= Fcar (htem
);
3127 object
= Fcar (htem
);
3129 position
= Fcar (htem
);
3131 show_help_echo (help
, window
, object
, position
);
3133 /* We stopped being idle for this event; undo that. */
3135 timer_resume_idle ();
3139 if ((! reread
|| this_command_key_count
== 0
3140 || this_command_key_count_reset
)
3144 /* Don't echo mouse motion events. */
3145 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
3146 && NILP (Fzerop (Vecho_keystrokes
))
3147 && ! (EVENT_HAS_PARAMETERS (c
)
3148 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
3151 if (! NILP (also_record
))
3152 echo_char (also_record
);
3153 /* Once we reread a character, echoing can happen
3154 the next time we pause to read a new one. */
3155 ok_to_echo_at_next_pause
= current_kboard
;
3158 /* Record this character as part of the current key. */
3159 add_command_key (c
);
3160 if (! NILP (also_record
))
3161 add_command_key (also_record
);
3164 last_input_event
= c
;
3167 /* Process the help character specially if enabled */
3168 if (!NILP (Vhelp_form
) && help_char_p (c
))
3170 ptrdiff_t count
= SPECPDL_INDEX ();
3172 help_form_saved_window_configs
3173 = Fcons (Fcurrent_window_configuration (Qnil
),
3174 help_form_saved_window_configs
);
3175 record_unwind_protect (read_char_help_form_unwind
, Qnil
);
3176 call0 (Qhelp_form_show
);
3181 c
= read_char (0, 0, 0, Qnil
, 0, NULL
);
3182 if (EVENT_HAS_PARAMETERS (c
)
3183 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_click
))
3184 XSETCAR (help_form_saved_window_configs
, Qnil
);
3186 while (BUFFERP (c
));
3187 /* Remove the help from the frame */
3188 unbind_to (count
, Qnil
);
3191 if (EQ (c
, make_number (040)))
3195 c
= read_char (0, 0, 0, Qnil
, 0, NULL
);
3196 while (BUFFERP (c
));
3205 /* Record a key that came from a mouse menu.
3206 Record it for echoing, for this-command-keys, and so on. */
3209 record_menu_key (Lisp_Object c
)
3211 /* Wipe the echo area. */
3212 clear_message (1, 0);
3217 before_command_key_count
= this_command_key_count
;
3218 before_command_echo_length
= echo_length ();
3221 /* Don't echo mouse motion events. */
3222 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
3223 && NILP (Fzerop (Vecho_keystrokes
)))
3227 /* Once we reread a character, echoing can happen
3228 the next time we pause to read a new one. */
3229 ok_to_echo_at_next_pause
= 0;
3232 /* Record this character as part of the current key. */
3233 add_command_key (c
);
3235 /* Re-reading in the middle of a command */
3236 last_input_event
= c
;
3240 /* Return 1 if should recognize C as "the help character". */
3243 help_char_p (Lisp_Object c
)
3247 if (EQ (c
, Vhelp_char
))
3249 for (tail
= Vhelp_event_list
; CONSP (tail
); tail
= XCDR (tail
))
3250 if (EQ (c
, XCAR (tail
)))
3255 /* Record the input event C in various ways. */
3258 record_char (Lisp_Object c
)
3262 if (CONSP (c
) && (EQ (XCAR (c
), Qhelp_echo
) || EQ (XCAR (c
), Qmouse_movement
)))
3264 /* To avoid filling recent_keys with help-echo and mouse-movement
3265 events, we filter out repeated help-echo events, only store the
3266 first and last in a series of mouse-movement events, and don't
3267 store repeated help-echo events which are only separated by
3268 mouse-movement events. */
3270 Lisp_Object ev1
, ev2
, ev3
;
3273 if ((ix1
= recent_keys_index
- 1) < 0)
3274 ix1
= NUM_RECENT_KEYS
- 1;
3275 ev1
= AREF (recent_keys
, ix1
);
3277 if ((ix2
= ix1
- 1) < 0)
3278 ix2
= NUM_RECENT_KEYS
- 1;
3279 ev2
= AREF (recent_keys
, ix2
);
3281 if ((ix3
= ix2
- 1) < 0)
3282 ix3
= NUM_RECENT_KEYS
- 1;
3283 ev3
= AREF (recent_keys
, ix3
);
3285 if (EQ (XCAR (c
), Qhelp_echo
))
3287 /* Don't record `help-echo' in recent_keys unless it shows some help
3288 message, and a different help than the previously recorded
3290 Lisp_Object help
, last_help
;
3292 help
= Fcar_safe (Fcdr_safe (XCDR (c
)));
3293 if (!STRINGP (help
))
3295 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qhelp_echo
)
3296 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev1
))), EQ (last_help
, help
)))
3298 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3299 && CONSP (ev2
) && EQ (XCAR (ev2
), Qhelp_echo
)
3300 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev2
))), EQ (last_help
, help
)))
3302 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3303 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3304 && CONSP (ev3
) && EQ (XCAR (ev3
), Qhelp_echo
)
3305 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev3
))), EQ (last_help
, help
)))
3308 else if (EQ (XCAR (c
), Qmouse_movement
))
3310 /* Only record one pair of `mouse-movement' on a window in recent_keys.
3311 So additional mouse movement events replace the last element. */
3312 Lisp_Object last_window
, window
;
3314 window
= Fcar_safe (Fcar_safe (XCDR (c
)));
3315 if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3316 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev1
))), EQ (last_window
, window
))
3317 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3318 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev2
))), EQ (last_window
, window
)))
3320 ASET (recent_keys
, ix1
, c
);
3326 store_kbd_macro_char (c
);
3330 total_keys
+= total_keys
< NUM_RECENT_KEYS
;
3331 ASET (recent_keys
, recent_keys_index
, c
);
3332 if (++recent_keys_index
>= NUM_RECENT_KEYS
)
3333 recent_keys_index
= 0;
3335 else if (recorded
< 0)
3337 /* We need to remove one or two events from recent_keys.
3338 To do this, we simply put nil at those events and move the
3339 recent_keys_index backwards over those events. Usually,
3340 users will never see those nil events, as they will be
3341 overwritten by the command keys entered to see recent_keys
3344 while (recorded
++ < 0 && total_keys
> 0)
3346 if (total_keys
< NUM_RECENT_KEYS
)
3348 if (--recent_keys_index
< 0)
3349 recent_keys_index
= NUM_RECENT_KEYS
- 1;
3350 ASET (recent_keys
, recent_keys_index
, Qnil
);
3354 num_nonmacro_input_events
++;
3356 /* Write c to the dribble file. If c is a lispy event, write
3357 the event's symbol to the dribble file, in <brackets>. Bleaugh.
3358 If you, dear reader, have a better idea, you've got the source. :-) */
3364 if (XUINT (c
) < 0x100)
3365 putc (XUINT (c
), dribble
);
3367 fprintf (dribble
, " 0x%"pI
"x", XUINT (c
));
3371 Lisp_Object dribblee
;
3373 /* If it's a structured event, take the event header. */
3374 dribblee
= EVENT_HEAD (c
);
3376 if (SYMBOLP (dribblee
))
3378 putc ('<', dribble
);
3379 fwrite (SDATA (SYMBOL_NAME (dribblee
)), sizeof (char),
3380 SBYTES (SYMBOL_NAME (dribblee
)),
3382 putc ('>', dribble
);
3391 /* Copy out or in the info on where C-g should throw to.
3392 This is used when running Lisp code from within get_char,
3393 in case get_char is called recursively.
3394 See read_process_output. */
3397 save_getcjmp (jmp_buf temp
)
3399 memcpy (temp
, getcjmp
, sizeof getcjmp
);
3403 restore_getcjmp (jmp_buf temp
)
3405 memcpy (getcjmp
, temp
, sizeof getcjmp
);
3408 /* Low level keyboard/mouse input.
3409 kbd_buffer_store_event places events in kbd_buffer, and
3410 kbd_buffer_get_event retrieves them. */
3412 /* Return true if there are any events in the queue that read-char
3413 would return. If this returns false, a read-char would block. */
3415 readable_events (int flags
)
3417 if (flags
& READABLE_EVENTS_DO_TIMERS_NOW
)
3420 /* If the buffer contains only FOCUS_IN_EVENT events, and
3421 READABLE_EVENTS_FILTER_EVENTS is set, report it as empty. */
3422 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3424 if (flags
& (READABLE_EVENTS_FILTER_EVENTS
3425 #ifdef USE_TOOLKIT_SCROLL_BARS
3426 | READABLE_EVENTS_IGNORE_SQUEEZABLES
3430 struct input_event
*event
;
3432 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
3439 #ifdef USE_TOOLKIT_SCROLL_BARS
3440 (flags
& READABLE_EVENTS_FILTER_EVENTS
) &&
3442 event
->kind
== FOCUS_IN_EVENT
)
3443 #ifdef USE_TOOLKIT_SCROLL_BARS
3444 && !((flags
& READABLE_EVENTS_IGNORE_SQUEEZABLES
)
3445 && event
->kind
== SCROLL_BAR_CLICK_EVENT
3446 && event
->part
== scroll_bar_handle
3447 && event
->modifiers
== 0)
3452 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3455 while (event
!= kbd_store_ptr
);
3461 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
3462 if (!(flags
& READABLE_EVENTS_IGNORE_SQUEEZABLES
)
3463 && !NILP (do_mouse_tracking
) && some_mouse_moved ())
3468 if (current_kboard
->kbd_queue_has_data
)
3474 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
3475 if (kb
->kbd_queue_has_data
)
3481 /* Set this for debugging, to have a way to get out */
3482 int stop_character EXTERNALLY_VISIBLE
;
3485 event_to_kboard (struct input_event
*event
)
3488 frame
= event
->frame_or_window
;
3490 frame
= XCAR (frame
);
3491 else if (WINDOWP (frame
))
3492 frame
= WINDOW_FRAME (XWINDOW (frame
));
3494 /* There are still some events that don't set this field.
3495 For now, just ignore the problem.
3496 Also ignore dead frames here. */
3497 if (!FRAMEP (frame
) || !FRAME_LIVE_P (XFRAME (frame
)))
3500 return FRAME_KBOARD (XFRAME (frame
));
3504 /* Return the number of slots occupied in kbd_buffer. */
3507 kbd_buffer_nr_stored (void)
3509 return kbd_fetch_ptr
== kbd_store_ptr
3511 : (kbd_fetch_ptr
< kbd_store_ptr
3512 ? kbd_store_ptr
- kbd_fetch_ptr
3513 : ((kbd_buffer
+ KBD_BUFFER_SIZE
) - kbd_fetch_ptr
3514 + (kbd_store_ptr
- kbd_buffer
)));
3516 #endif /* Store an event obtained at interrupt level into kbd_buffer, fifo */
3519 kbd_buffer_store_event (register struct input_event
*event
)
3521 kbd_buffer_store_event_hold (event
, 0);
3524 /* Store EVENT obtained at interrupt level into kbd_buffer, fifo.
3526 If HOLD_QUIT is 0, just stuff EVENT into the fifo.
3527 Else, if HOLD_QUIT.kind != NO_EVENT, discard EVENT.
3528 Else, if EVENT is a quit event, store the quit event
3529 in HOLD_QUIT, and return (thus ignoring further events).
3531 This is used in read_avail_input to postpone the processing
3532 of the quit event until all subsequent input events have been
3533 parsed (and discarded).
3537 kbd_buffer_store_event_hold (register struct input_event
*event
,
3538 struct input_event
*hold_quit
)
3540 if (event
->kind
== NO_EVENT
)
3543 if (hold_quit
&& hold_quit
->kind
!= NO_EVENT
)
3546 if (event
->kind
== ASCII_KEYSTROKE_EVENT
)
3548 register int c
= event
->code
& 0377;
3550 if (event
->modifiers
& ctrl_modifier
)
3551 c
= make_ctrl_char (c
);
3553 c
|= (event
->modifiers
3554 & (meta_modifier
| alt_modifier
3555 | hyper_modifier
| super_modifier
));
3559 KBOARD
*kb
= FRAME_KBOARD (XFRAME (event
->frame_or_window
));
3560 struct input_event
*sp
;
3562 if (single_kboard
&& kb
!= current_kboard
)
3565 (kb
, Fcons (make_lispy_switch_frame (event
->frame_or_window
),
3566 Fcons (make_number (c
), Qnil
)));
3567 kb
->kbd_queue_has_data
= 1;
3568 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3570 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3573 if (event_to_kboard (sp
) == kb
)
3575 sp
->kind
= NO_EVENT
;
3576 sp
->frame_or_window
= Qnil
;
3585 *hold_quit
= *event
;
3589 /* If this results in a quit_char being returned to Emacs as
3590 input, set Vlast_event_frame properly. If this doesn't
3591 get returned to Emacs as an event, the next event read
3592 will set Vlast_event_frame again, so this is safe to do. */
3596 focus
= FRAME_FOCUS_FRAME (XFRAME (event
->frame_or_window
));
3598 focus
= event
->frame_or_window
;
3599 internal_last_event_frame
= focus
;
3600 Vlast_event_frame
= focus
;
3603 last_event_timestamp
= event
->timestamp
;
3604 handle_interrupt ();
3608 if (c
&& c
== stop_character
)
3614 /* Don't insert two BUFFER_SWITCH_EVENT's in a row.
3615 Just ignore the second one. */
3616 else if (event
->kind
== BUFFER_SWITCH_EVENT
3617 && kbd_fetch_ptr
!= kbd_store_ptr
3618 && ((kbd_store_ptr
== kbd_buffer
3619 ? kbd_buffer
+ KBD_BUFFER_SIZE
- 1
3620 : kbd_store_ptr
- 1)->kind
) == BUFFER_SWITCH_EVENT
)
3623 if (kbd_store_ptr
- kbd_buffer
== KBD_BUFFER_SIZE
)
3624 kbd_store_ptr
= kbd_buffer
;
3626 /* Don't let the very last slot in the buffer become full,
3627 since that would make the two pointers equal,
3628 and that is indistinguishable from an empty buffer.
3629 Discard the event if it would fill the last slot. */
3630 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
3632 *kbd_store_ptr
= *event
;
3635 if (kbd_buffer_nr_stored () > KBD_BUFFER_SIZE
/2 && ! kbd_on_hold_p ())
3637 /* Don't read keyboard input until we have processed kbd_buffer.
3638 This happens when pasting text longer than KBD_BUFFER_SIZE/2. */
3639 hold_keyboard_input ();
3640 if (!noninteractive
)
3644 #endif /* subprocesses */
3647 /* If we're inside while-no-input, and this event qualifies
3648 as input, set quit-flag to cause an interrupt. */
3649 if (!NILP (Vthrow_on_input
)
3650 && event
->kind
!= FOCUS_IN_EVENT
3651 && event
->kind
!= HELP_EVENT
3652 && event
->kind
!= DEICONIFY_EVENT
)
3654 Vquit_flag
= Vthrow_on_input
;
3655 /* If we're inside a function that wants immediate quits,
3657 if (immediate_quit
&& NILP (Vinhibit_quit
))
3660 pthread_sigmask (SIG_SETMASK
, &empty_mask
, 0);
3667 /* Put an input event back in the head of the event queue. */
3670 kbd_buffer_unget_event (register struct input_event
*event
)
3672 if (kbd_fetch_ptr
== kbd_buffer
)
3673 kbd_fetch_ptr
= kbd_buffer
+ KBD_BUFFER_SIZE
;
3675 /* Don't let the very last slot in the buffer become full, */
3676 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
3679 *kbd_fetch_ptr
= *event
;
3684 /* Generate a HELP_EVENT input_event and store it in the keyboard
3687 HELP is the help form.
3689 FRAME and WINDOW are the frame and window where the help is
3690 generated. OBJECT is the Lisp object where the help was found (a
3691 buffer, a string, an overlay, or nil if neither from a string nor
3692 from a buffer). POS is the position within OBJECT where the help
3696 gen_help_event (Lisp_Object help
, Lisp_Object frame
, Lisp_Object window
,
3697 Lisp_Object object
, ptrdiff_t pos
)
3699 struct input_event event
;
3703 event
.kind
= HELP_EVENT
;
3704 event
.frame_or_window
= frame
;
3706 event
.x
= WINDOWP (window
) ? window
: frame
;
3709 kbd_buffer_store_event (&event
);
3713 /* Store HELP_EVENTs for HELP on FRAME in the input queue. */
3716 kbd_buffer_store_help_event (Lisp_Object frame
, Lisp_Object help
)
3718 struct input_event event
;
3720 event
.kind
= HELP_EVENT
;
3721 event
.frame_or_window
= frame
;
3726 kbd_buffer_store_event (&event
);
3730 /* Discard any mouse events in the event buffer by setting them to
3733 discard_mouse_events (void)
3735 struct input_event
*sp
;
3736 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3738 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3741 if (sp
->kind
== MOUSE_CLICK_EVENT
3742 || sp
->kind
== WHEEL_EVENT
3743 || sp
->kind
== HORIZ_WHEEL_EVENT
3745 || sp
->kind
== GPM_CLICK_EVENT
3747 || sp
->kind
== SCROLL_BAR_CLICK_EVENT
)
3749 sp
->kind
= NO_EVENT
;
3755 /* Return non-zero if there are any real events waiting in the event
3756 buffer, not counting `NO_EVENT's.
3758 If DISCARD is non-zero, discard NO_EVENT events at the front of
3759 the input queue, possibly leaving the input queue empty if there
3760 are no real input events. */
3763 kbd_buffer_events_waiting (int discard
)
3765 struct input_event
*sp
;
3767 for (sp
= kbd_fetch_ptr
;
3768 sp
!= kbd_store_ptr
&& sp
->kind
== NO_EVENT
;
3771 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3778 return sp
!= kbd_store_ptr
&& sp
->kind
!= NO_EVENT
;
3782 /* Clear input event EVENT. */
3785 clear_event (struct input_event
*event
)
3787 event
->kind
= NO_EVENT
;
3791 /* Read one event from the event buffer, waiting if necessary.
3792 The value is a Lisp object representing the event.
3793 The value is nil for an event that should be ignored,
3794 or that was handled here.
3795 We always read and discard one event. */
3798 kbd_buffer_get_event (KBOARD
**kbp
,
3799 int *used_mouse_menu
,
3800 EMACS_TIME
*end_time
)
3805 if (kbd_on_hold_p () && kbd_buffer_nr_stored () < KBD_BUFFER_SIZE
/4)
3807 /* Start reading input again, we have processed enough so we can
3808 accept new events again. */
3809 unhold_keyboard_input ();
3811 if (!noninteractive
)
3813 struct sigaction action
;
3814 emacs_sigaction_init (&action
, deliver_input_available_signal
);
3815 sigaction (SIGIO
, &action
, 0);
3820 #endif /* subprocesses */
3822 #ifndef HAVE_DBUS /* We want to read D-Bus events in batch mode. */
3824 /* In case we are running as a daemon, only do this before
3825 detaching from the terminal. */
3826 || (IS_DAEMON
&& daemon_pipe
[1] >= 0))
3830 *kbp
= current_kboard
;
3833 #endif /* ! HAVE_DBUS */
3835 /* Wait until there is input available. */
3838 /* Break loop if there's an unread command event. Needed in
3839 moused window autoselection which uses a timer to insert such
3841 if (CONSP (Vunread_command_events
))
3844 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3846 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
3847 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3851 /* If the quit flag is set, then read_char will return
3852 quit_char, so that counts as "available input." */
3853 if (!NILP (Vquit_flag
))
3854 quit_throw_to_read_char (0);
3856 /* One way or another, wait until input is available; then, if
3857 interrupt handlers have not read it, read it now. */
3862 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3864 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
3865 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3870 EMACS_TIME now
= current_emacs_time ();
3871 if (EMACS_TIME_LE (*end_time
, now
))
3872 return Qnil
; /* Finished waiting. */
3875 EMACS_TIME duration
= sub_emacs_time (*end_time
, now
);
3876 wait_reading_process_output (min (EMACS_SECS (duration
),
3878 EMACS_NSECS (duration
),
3879 -1, 1, Qnil
, NULL
, 0);
3883 wait_reading_process_output (0, 0, -1, 1, Qnil
, NULL
, 0);
3885 if (!interrupt_input
&& kbd_fetch_ptr
== kbd_store_ptr
)
3886 /* Pass 1 for EXPECT since we just waited to have input. */
3887 read_avail_input (1);
3890 if (CONSP (Vunread_command_events
))
3893 first
= XCAR (Vunread_command_events
);
3894 Vunread_command_events
= XCDR (Vunread_command_events
);
3895 *kbp
= current_kboard
;
3899 /* At this point, we know that there is a readable event available
3900 somewhere. If the event queue is empty, then there must be a
3901 mouse movement enabled and available. */
3902 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3904 struct input_event
*event
;
3906 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
3910 last_event_timestamp
= event
->timestamp
;
3912 *kbp
= event_to_kboard (event
);
3914 *kbp
= current_kboard
; /* Better than returning null ptr? */
3918 /* These two kinds of events get special handling
3919 and don't actually appear to the command loop.
3920 We return nil for them. */
3921 if (event
->kind
== SELECTION_REQUEST_EVENT
3922 || event
->kind
== SELECTION_CLEAR_EVENT
)
3925 struct input_event copy
;
3927 /* Remove it from the buffer before processing it,
3928 since otherwise swallow_events will see it
3929 and process it again. */
3931 kbd_fetch_ptr
= event
+ 1;
3932 input_pending
= readable_events (0);
3933 x_handle_selection_event (©
);
3935 /* We're getting selection request events, but we don't have
3941 #if defined (HAVE_NS)
3942 else if (event
->kind
== NS_TEXT_EVENT
)
3944 if (event
->code
== KEY_NS_PUT_WORKING_TEXT
)
3945 obj
= Fcons (intern ("ns-put-working-text"), Qnil
);
3947 obj
= Fcons (intern ("ns-unput-working-text"), Qnil
);
3948 kbd_fetch_ptr
= event
+ 1;
3949 if (used_mouse_menu
)
3950 *used_mouse_menu
= 1;
3954 #if defined (HAVE_X11) || defined (HAVE_NTGUI) \
3955 || defined (HAVE_NS)
3956 else if (event
->kind
== DELETE_WINDOW_EVENT
)
3958 /* Make an event (delete-frame (FRAME)). */
3959 obj
= Fcons (event
->frame_or_window
, Qnil
);
3960 obj
= Fcons (Qdelete_frame
, Fcons (obj
, Qnil
));
3961 kbd_fetch_ptr
= event
+ 1;
3964 #if defined (HAVE_X11) || defined (HAVE_NTGUI) \
3965 || defined (HAVE_NS)
3966 else if (event
->kind
== ICONIFY_EVENT
)
3968 /* Make an event (iconify-frame (FRAME)). */
3969 obj
= Fcons (event
->frame_or_window
, Qnil
);
3970 obj
= Fcons (Qiconify_frame
, Fcons (obj
, Qnil
));
3971 kbd_fetch_ptr
= event
+ 1;
3973 else if (event
->kind
== DEICONIFY_EVENT
)
3975 /* Make an event (make-frame-visible (FRAME)). */
3976 obj
= Fcons (event
->frame_or_window
, Qnil
);
3977 obj
= Fcons (Qmake_frame_visible
, Fcons (obj
, Qnil
));
3978 kbd_fetch_ptr
= event
+ 1;
3981 else if (event
->kind
== BUFFER_SWITCH_EVENT
)
3983 /* The value doesn't matter here; only the type is tested. */
3984 XSETBUFFER (obj
, current_buffer
);
3985 kbd_fetch_ptr
= event
+ 1;
3987 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
3988 || defined (HAVE_NS) || defined (USE_GTK)
3989 else if (event
->kind
== MENU_BAR_ACTIVATE_EVENT
)
3991 kbd_fetch_ptr
= event
+ 1;
3992 input_pending
= readable_events (0);
3993 if (FRAME_LIVE_P (XFRAME (event
->frame_or_window
)))
3994 x_activate_menubar (XFRAME (event
->frame_or_window
));
3997 #if defined (WINDOWSNT)
3998 else if (event
->kind
== LANGUAGE_CHANGE_EVENT
)
4000 /* Make an event (language-change (FRAME CODEPAGE LANGUAGE-ID)). */
4001 obj
= Fcons (Qlanguage_change
,
4002 list3 (event
->frame_or_window
,
4003 make_number (event
->code
),
4004 make_number (event
->modifiers
)));
4005 kbd_fetch_ptr
= event
+ 1;
4008 else if (event
->kind
== SAVE_SESSION_EVENT
)
4010 obj
= Fcons (Qsave_session
, Fcons (event
->arg
, Qnil
));
4011 kbd_fetch_ptr
= event
+ 1;
4013 /* Just discard these, by returning nil.
4014 With MULTI_KBOARD, these events are used as placeholders
4015 when we need to randomly delete events from the queue.
4016 (They shouldn't otherwise be found in the buffer,
4017 but on some machines it appears they do show up
4018 even without MULTI_KBOARD.) */
4019 /* On Windows NT/9X, NO_EVENT is used to delete extraneous
4020 mouse events during a popup-menu call. */
4021 else if (event
->kind
== NO_EVENT
)
4022 kbd_fetch_ptr
= event
+ 1;
4023 else if (event
->kind
== HELP_EVENT
)
4025 Lisp_Object object
, position
, help
, frame
, window
;
4027 frame
= event
->frame_or_window
;
4028 object
= event
->arg
;
4029 position
= make_number (event
->code
);
4032 clear_event (event
);
4034 kbd_fetch_ptr
= event
+ 1;
4035 if (!WINDOWP (window
))
4037 obj
= Fcons (Qhelp_echo
,
4038 list5 (frame
, help
, window
, object
, position
));
4040 else if (event
->kind
== FOCUS_IN_EVENT
)
4042 /* Notification of a FocusIn event. The frame receiving the
4043 focus is in event->frame_or_window. Generate a
4044 switch-frame event if necessary. */
4045 Lisp_Object frame
, focus
;
4047 frame
= event
->frame_or_window
;
4048 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
4052 if (!EQ (frame
, internal_last_event_frame
)
4053 && !EQ (frame
, selected_frame
))
4054 obj
= make_lispy_switch_frame (frame
);
4055 internal_last_event_frame
= frame
;
4056 kbd_fetch_ptr
= event
+ 1;
4059 else if (event
->kind
== DBUS_EVENT
)
4061 obj
= make_lispy_event (event
);
4062 kbd_fetch_ptr
= event
+ 1;
4065 else if (event
->kind
== CONFIG_CHANGED_EVENT
)
4067 obj
= make_lispy_event (event
);
4068 kbd_fetch_ptr
= event
+ 1;
4072 /* If this event is on a different frame, return a switch-frame this
4073 time, and leave the event in the queue for next time. */
4077 frame
= event
->frame_or_window
;
4079 frame
= XCAR (frame
);
4080 else if (WINDOWP (frame
))
4081 frame
= WINDOW_FRAME (XWINDOW (frame
));
4083 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
4087 if (! EQ (frame
, internal_last_event_frame
)
4088 && !EQ (frame
, selected_frame
))
4089 obj
= make_lispy_switch_frame (frame
);
4090 internal_last_event_frame
= frame
;
4092 /* If we didn't decide to make a switch-frame event, go ahead
4093 and build a real event from the queue entry. */
4097 obj
= make_lispy_event (event
);
4099 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
4100 || defined (HAVE_NS) || defined (USE_GTK)
4101 /* If this was a menu selection, then set the flag to inhibit
4102 writing to last_nonmenu_event. Don't do this if the event
4103 we're returning is (menu-bar), though; that indicates the
4104 beginning of the menu sequence, and we might as well leave
4105 that as the `event with parameters' for this selection. */
4107 && !EQ (event
->frame_or_window
, event
->arg
)
4108 && (event
->kind
== MENU_BAR_EVENT
4109 || event
->kind
== TOOL_BAR_EVENT
))
4110 *used_mouse_menu
= 1;
4113 /* Certain system events are non-key events. */
4115 && event
->kind
== NS_NONKEY_EVENT
)
4116 *used_mouse_menu
= 1;
4119 /* Wipe out this event, to catch bugs. */
4120 clear_event (event
);
4121 kbd_fetch_ptr
= event
+ 1;
4125 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
4126 /* Try generating a mouse motion event. */
4127 else if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
4129 FRAME_PTR f
= some_mouse_moved ();
4130 Lisp_Object bar_window
;
4131 enum scroll_bar_part part
;
4135 *kbp
= current_kboard
;
4136 /* Note that this uses F to determine which terminal to look at.
4137 If there is no valid info, it does not store anything
4138 so x remains nil. */
4141 /* XXX Can f or mouse_position_hook be NULL here? */
4142 if (f
&& FRAME_TERMINAL (f
)->mouse_position_hook
)
4143 (*FRAME_TERMINAL (f
)->mouse_position_hook
) (&f
, 0, &bar_window
,
4148 /* Decide if we should generate a switch-frame event. Don't
4149 generate switch-frame events for motion outside of all Emacs
4155 frame
= FRAME_FOCUS_FRAME (f
);
4157 XSETFRAME (frame
, f
);
4159 if (! EQ (frame
, internal_last_event_frame
)
4160 && !EQ (frame
, selected_frame
))
4161 obj
= make_lispy_switch_frame (frame
);
4162 internal_last_event_frame
= frame
;
4165 /* If we didn't decide to make a switch-frame event, go ahead and
4166 return a mouse-motion event. */
4167 if (!NILP (x
) && NILP (obj
))
4168 obj
= make_lispy_movement (f
, bar_window
, part
, x
, y
, t
);
4170 #endif /* HAVE_MOUSE || HAVE GPM */
4172 /* We were promised by the above while loop that there was
4173 something for us to read! */
4176 input_pending
= readable_events (0);
4178 Vlast_event_frame
= internal_last_event_frame
;
4183 /* Process any non-user-visible events (currently X selection events),
4184 without reading any user-visible events. */
4187 process_special_events (void)
4189 struct input_event
*event
;
4191 for (event
= kbd_fetch_ptr
; event
!= kbd_store_ptr
; ++event
)
4193 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
4196 if (event
== kbd_store_ptr
)
4200 /* If we find a stored X selection request, handle it now. */
4201 if (event
->kind
== SELECTION_REQUEST_EVENT
4202 || event
->kind
== SELECTION_CLEAR_EVENT
)
4206 /* Remove the event from the fifo buffer before processing;
4207 otherwise swallow_events called recursively could see it
4208 and process it again. To do this, we move the events
4209 between kbd_fetch_ptr and EVENT one slot to the right,
4212 struct input_event copy
= *event
;
4213 struct input_event
*beg
4214 = (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
4215 ? kbd_buffer
: kbd_fetch_ptr
;
4218 memmove (beg
+ 1, beg
, (event
- beg
) * sizeof (struct input_event
));
4219 else if (event
< beg
)
4221 if (event
> kbd_buffer
)
4222 memmove (kbd_buffer
+ 1, kbd_buffer
,
4223 (event
- kbd_buffer
) * sizeof (struct input_event
));
4224 *kbd_buffer
= *(kbd_buffer
+ KBD_BUFFER_SIZE
- 1);
4225 if (beg
< kbd_buffer
+ KBD_BUFFER_SIZE
- 1)
4226 memmove (beg
+ 1, beg
,
4227 (kbd_buffer
+ KBD_BUFFER_SIZE
- 1 - beg
)
4228 * sizeof (struct input_event
));
4231 if (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
4232 kbd_fetch_ptr
= kbd_buffer
+ 1;
4236 /* X wants last_event_timestamp for selection ownership. */
4237 last_event_timestamp
= copy
.timestamp
;
4238 input_pending
= readable_events (0);
4239 x_handle_selection_event (©
);
4241 /* We're getting selection request events, but we don't have
4249 /* Process any events that are not user-visible, run timer events that
4250 are ripe, and return, without reading any user-visible events. */
4253 swallow_events (int do_display
)
4257 process_special_events ();
4259 old_timers_run
= timers_run
;
4260 get_input_pending (&input_pending
, READABLE_EVENTS_DO_TIMERS_NOW
);
4262 if (timers_run
!= old_timers_run
&& do_display
)
4263 redisplay_preserve_echo_area (7);
4266 /* Record the start of when Emacs is idle,
4267 for the sake of running idle-time timers. */
4270 timer_start_idle (void)
4274 /* If we are already in the idle state, do nothing. */
4275 if (EMACS_TIME_VALID_P (timer_idleness_start_time
))
4278 timer_idleness_start_time
= current_emacs_time ();
4279 timer_last_idleness_start_time
= timer_idleness_start_time
;
4281 /* Mark all idle-time timers as once again candidates for running. */
4282 for (timers
= Vtimer_idle_list
; CONSP (timers
); timers
= XCDR (timers
))
4286 timer
= XCAR (timers
);
4288 if (!VECTORP (timer
) || ASIZE (timer
) != 9)
4290 ASET (timer
, 0, Qnil
);
4294 /* Record that Emacs is no longer idle, so stop running idle-time timers. */
4297 timer_stop_idle (void)
4299 timer_idleness_start_time
= invalid_emacs_time ();
4302 /* Resume idle timer from last idle start time. */
4305 timer_resume_idle (void)
4307 if (EMACS_TIME_VALID_P (timer_idleness_start_time
))
4310 timer_idleness_start_time
= timer_last_idleness_start_time
;
4313 /* This is only for debugging. */
4314 struct input_event last_timer_event EXTERNALLY_VISIBLE
;
4316 /* List of elisp functions to call, delayed because they were generated in
4317 a context where Elisp could not be safely run (e.g. redisplay, signal,
4318 ...). Each element has the form (FUN . ARGS). */
4319 Lisp_Object pending_funcalls
;
4321 /* Return true if TIMER is a valid timer, placing its value into *RESULT. */
4323 decode_timer (Lisp_Object timer
, EMACS_TIME
*result
)
4325 Lisp_Object
*vector
;
4327 if (! (VECTORP (timer
) && ASIZE (timer
) == 9))
4329 vector
= XVECTOR (timer
)->contents
;
4330 if (! NILP (vector
[0]))
4333 return decode_time_components (vector
[1], vector
[2], vector
[3], vector
[8],
4338 /* Check whether a timer has fired. To prevent larger problems we simply
4339 disregard elements that are not proper timers. Do not make a circular
4340 timer list for the time being.
4342 Returns the time to wait until the next timer fires. If a
4343 timer is triggering now, return zero.
4344 If no timer is active, return -1.
4346 If a timer is ripe, we run it, with quitting turned off.
4347 In that case we return 0 to indicate that a new timer_check_2 call
4351 timer_check_2 (void)
4353 EMACS_TIME nexttime
;
4355 EMACS_TIME idleness_now
;
4356 Lisp_Object timers
, idle_timers
, chosen_timer
;
4357 struct gcpro gcpro1
, gcpro2
, gcpro3
;
4359 nexttime
= invalid_emacs_time ();
4361 /* Always consider the ordinary timers. */
4362 timers
= Vtimer_list
;
4363 /* Consider the idle timers only if Emacs is idle. */
4364 if (EMACS_TIME_VALID_P (timer_idleness_start_time
))
4365 idle_timers
= Vtimer_idle_list
;
4368 chosen_timer
= Qnil
;
4369 GCPRO3 (timers
, idle_timers
, chosen_timer
);
4371 /* First run the code that was delayed. */
4372 while (CONSP (pending_funcalls
))
4374 Lisp_Object funcall
= XCAR (pending_funcalls
);
4375 pending_funcalls
= XCDR (pending_funcalls
);
4376 safe_call2 (Qapply
, XCAR (funcall
), XCDR (funcall
));
4379 if (CONSP (timers
) || CONSP (idle_timers
))
4381 now
= current_emacs_time ();
4382 idleness_now
= (EMACS_TIME_VALID_P (timer_idleness_start_time
)
4383 ? sub_emacs_time (now
, timer_idleness_start_time
)
4384 : make_emacs_time (0, 0));
4387 while (CONSP (timers
) || CONSP (idle_timers
))
4389 Lisp_Object timer
= Qnil
, idle_timer
= Qnil
;
4390 EMACS_TIME timer_time
, idle_timer_time
;
4391 EMACS_TIME difference
;
4392 EMACS_TIME timer_difference
= invalid_emacs_time ();
4393 EMACS_TIME idle_timer_difference
= invalid_emacs_time ();
4394 int ripe
, timer_ripe
= 0, idle_timer_ripe
= 0;
4396 /* Set TIMER and TIMER_DIFFERENCE
4397 based on the next ordinary timer.
4398 TIMER_DIFFERENCE is the distance in time from NOW to when
4399 this timer becomes ripe (negative if it's already ripe).
4400 Skip past invalid timers and timers already handled. */
4403 timer
= XCAR (timers
);
4404 if (! decode_timer (timer
, &timer_time
))
4406 timers
= XCDR (timers
);
4410 timer_ripe
= EMACS_TIME_LE (timer_time
, now
);
4411 timer_difference
= (timer_ripe
4412 ? sub_emacs_time (now
, timer_time
)
4413 : sub_emacs_time (timer_time
, now
));
4416 /* Likewise for IDLE_TIMER and IDLE_TIMER_DIFFERENCE
4417 based on the next idle timer. */
4418 if (CONSP (idle_timers
))
4420 idle_timer
= XCAR (idle_timers
);
4421 if (! decode_timer (idle_timer
, &idle_timer_time
))
4423 idle_timers
= XCDR (idle_timers
);
4427 idle_timer_ripe
= EMACS_TIME_LE (idle_timer_time
, idleness_now
);
4428 idle_timer_difference
=
4430 ? sub_emacs_time (idleness_now
, idle_timer_time
)
4431 : sub_emacs_time (idle_timer_time
, idleness_now
));
4434 /* Decide which timer is the next timer,
4435 and set CHOSEN_TIMER, DIFFERENCE, and RIPE accordingly.
4436 Also step down the list where we found that timer. */
4438 if (EMACS_TIME_VALID_P (timer_difference
)
4439 && (! EMACS_TIME_VALID_P (idle_timer_difference
)
4440 || idle_timer_ripe
< timer_ripe
4441 || (idle_timer_ripe
== timer_ripe
4443 ? EMACS_TIME_LT (idle_timer_difference
,
4445 : EMACS_TIME_LT (timer_difference
,
4446 idle_timer_difference
)))))
4448 chosen_timer
= timer
;
4449 timers
= XCDR (timers
);
4450 difference
= timer_difference
;
4455 chosen_timer
= idle_timer
;
4456 idle_timers
= XCDR (idle_timers
);
4457 difference
= idle_timer_difference
;
4458 ripe
= idle_timer_ripe
;
4461 /* If timer is ripe, run it if it hasn't been run. */
4464 if (NILP (AREF (chosen_timer
, 0)))
4466 ptrdiff_t count
= SPECPDL_INDEX ();
4467 Lisp_Object old_deactivate_mark
= Vdeactivate_mark
;
4469 /* Mark the timer as triggered to prevent problems if the lisp
4470 code fails to reschedule it right. */
4471 ASET (chosen_timer
, 0, Qt
);
4473 specbind (Qinhibit_quit
, Qt
);
4475 call1 (Qtimer_event_handler
, chosen_timer
);
4476 Vdeactivate_mark
= old_deactivate_mark
;
4478 unbind_to (count
, Qnil
);
4480 /* Since we have handled the event,
4481 we don't need to tell the caller to wake up and do it. */
4482 /* But the caller must still wait for the next timer, so
4483 return 0 to indicate that. */
4486 nexttime
= make_emacs_time (0, 0);
4490 /* When we encounter a timer that is still waiting,
4491 return the amount of time to wait before it is ripe. */
4498 /* No timers are pending in the future. */
4499 /* Return 0 if we generated an event, and -1 if not. */
4505 /* Check whether a timer has fired. To prevent larger problems we simply
4506 disregard elements that are not proper timers. Do not make a circular
4507 timer list for the time being.
4509 Returns the time to wait until the next timer fires.
4510 If no timer is active, return an invalid value.
4512 As long as any timer is ripe, we run it. */
4517 EMACS_TIME nexttime
;
4521 nexttime
= timer_check_2 ();
4523 while (EMACS_SECS (nexttime
) == 0 && EMACS_NSECS (nexttime
) == 0);
4528 DEFUN ("current-idle-time", Fcurrent_idle_time
, Scurrent_idle_time
, 0, 0, 0,
4529 doc
: /* Return the current length of Emacs idleness, or nil.
4530 The value when Emacs is idle is a list of four integers (HIGH LOW USEC PSEC)
4531 in the same style as (current-time).
4533 The value when Emacs is not idle is nil.
4535 PSEC is a multiple of the system clock resolution. */)
4538 if (EMACS_TIME_VALID_P (timer_idleness_start_time
))
4539 return make_lisp_time (sub_emacs_time (current_emacs_time (),
4540 timer_idleness_start_time
));
4545 /* Caches for modify_event_symbol. */
4546 static Lisp_Object accent_key_syms
;
4547 static Lisp_Object func_key_syms
;
4548 static Lisp_Object mouse_syms
;
4549 static Lisp_Object wheel_syms
;
4550 static Lisp_Object drag_n_drop_syms
;
4552 /* This is a list of keysym codes for special "accent" characters.
4553 It parallels lispy_accent_keys. */
4555 static const int lispy_accent_codes
[] =
4557 #ifdef XK_dead_circumflex
4562 #ifdef XK_dead_grave
4567 #ifdef XK_dead_tilde
4572 #ifdef XK_dead_diaeresis
4577 #ifdef XK_dead_macron
4582 #ifdef XK_dead_degree
4587 #ifdef XK_dead_acute
4592 #ifdef XK_dead_cedilla
4597 #ifdef XK_dead_breve
4602 #ifdef XK_dead_ogonek
4607 #ifdef XK_dead_caron
4612 #ifdef XK_dead_doubleacute
4613 XK_dead_doubleacute
,
4617 #ifdef XK_dead_abovedot
4622 #ifdef XK_dead_abovering
4632 #ifdef XK_dead_belowdot
4637 #ifdef XK_dead_voiced_sound
4638 XK_dead_voiced_sound
,
4642 #ifdef XK_dead_semivoiced_sound
4643 XK_dead_semivoiced_sound
,
4659 /* This is a list of Lisp names for special "accent" characters.
4660 It parallels lispy_accent_codes. */
4662 static const char *const lispy_accent_keys
[] =
4680 "dead-voiced-sound",
4681 "dead-semivoiced-sound",
4687 #define FUNCTION_KEY_OFFSET 0x0
4689 const char *const lispy_function_keys
[] =
4693 0, /* VK_LBUTTON 0x01 */
4694 0, /* VK_RBUTTON 0x02 */
4695 "cancel", /* VK_CANCEL 0x03 */
4696 0, /* VK_MBUTTON 0x04 */
4698 0, 0, 0, /* 0x05 .. 0x07 */
4700 "backspace", /* VK_BACK 0x08 */
4701 "tab", /* VK_TAB 0x09 */
4703 0, 0, /* 0x0A .. 0x0B */
4705 "clear", /* VK_CLEAR 0x0C */
4706 "return", /* VK_RETURN 0x0D */
4708 0, 0, /* 0x0E .. 0x0F */
4710 0, /* VK_SHIFT 0x10 */
4711 0, /* VK_CONTROL 0x11 */
4712 0, /* VK_MENU 0x12 */
4713 "pause", /* VK_PAUSE 0x13 */
4714 "capslock", /* VK_CAPITAL 0x14 */
4715 "kana", /* VK_KANA/VK_HANGUL 0x15 */
4717 "junja", /* VK_JUNJA 0x17 */
4718 "final", /* VK_FINAL 0x18 */
4719 "kanji", /* VK_KANJI/VK_HANJA 0x19 */
4721 "escape", /* VK_ESCAPE 0x1B */
4722 "convert", /* VK_CONVERT 0x1C */
4723 "non-convert", /* VK_NONCONVERT 0x1D */
4724 "accept", /* VK_ACCEPT 0x1E */
4725 "mode-change", /* VK_MODECHANGE 0x1F */
4726 0, /* VK_SPACE 0x20 */
4727 "prior", /* VK_PRIOR 0x21 */
4728 "next", /* VK_NEXT 0x22 */
4729 "end", /* VK_END 0x23 */
4730 "home", /* VK_HOME 0x24 */
4731 "left", /* VK_LEFT 0x25 */
4732 "up", /* VK_UP 0x26 */
4733 "right", /* VK_RIGHT 0x27 */
4734 "down", /* VK_DOWN 0x28 */
4735 "select", /* VK_SELECT 0x29 */
4736 "print", /* VK_PRINT 0x2A */
4737 "execute", /* VK_EXECUTE 0x2B */
4738 "snapshot", /* VK_SNAPSHOT 0x2C */
4739 "insert", /* VK_INSERT 0x2D */
4740 "delete", /* VK_DELETE 0x2E */
4741 "help", /* VK_HELP 0x2F */
4743 /* VK_0 thru VK_9 are the same as ASCII '0' thru '9' (0x30 - 0x39) */
4745 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4747 0, 0, 0, 0, 0, 0, 0, /* 0x3A .. 0x40 */
4749 /* VK_A thru VK_Z are the same as ASCII 'A' thru 'Z' (0x41 - 0x5A) */
4751 0, 0, 0, 0, 0, 0, 0, 0, 0,
4752 0, 0, 0, 0, 0, 0, 0, 0, 0,
4753 0, 0, 0, 0, 0, 0, 0, 0,
4755 "lwindow", /* VK_LWIN 0x5B */
4756 "rwindow", /* VK_RWIN 0x5C */
4757 "apps", /* VK_APPS 0x5D */
4760 "kp-0", /* VK_NUMPAD0 0x60 */
4761 "kp-1", /* VK_NUMPAD1 0x61 */
4762 "kp-2", /* VK_NUMPAD2 0x62 */
4763 "kp-3", /* VK_NUMPAD3 0x63 */
4764 "kp-4", /* VK_NUMPAD4 0x64 */
4765 "kp-5", /* VK_NUMPAD5 0x65 */
4766 "kp-6", /* VK_NUMPAD6 0x66 */
4767 "kp-7", /* VK_NUMPAD7 0x67 */
4768 "kp-8", /* VK_NUMPAD8 0x68 */
4769 "kp-9", /* VK_NUMPAD9 0x69 */
4770 "kp-multiply", /* VK_MULTIPLY 0x6A */
4771 "kp-add", /* VK_ADD 0x6B */
4772 "kp-separator", /* VK_SEPARATOR 0x6C */
4773 "kp-subtract", /* VK_SUBTRACT 0x6D */
4774 "kp-decimal", /* VK_DECIMAL 0x6E */
4775 "kp-divide", /* VK_DIVIDE 0x6F */
4776 "f1", /* VK_F1 0x70 */
4777 "f2", /* VK_F2 0x71 */
4778 "f3", /* VK_F3 0x72 */
4779 "f4", /* VK_F4 0x73 */
4780 "f5", /* VK_F5 0x74 */
4781 "f6", /* VK_F6 0x75 */
4782 "f7", /* VK_F7 0x76 */
4783 "f8", /* VK_F8 0x77 */
4784 "f9", /* VK_F9 0x78 */
4785 "f10", /* VK_F10 0x79 */
4786 "f11", /* VK_F11 0x7A */
4787 "f12", /* VK_F12 0x7B */
4788 "f13", /* VK_F13 0x7C */
4789 "f14", /* VK_F14 0x7D */
4790 "f15", /* VK_F15 0x7E */
4791 "f16", /* VK_F16 0x7F */
4792 "f17", /* VK_F17 0x80 */
4793 "f18", /* VK_F18 0x81 */
4794 "f19", /* VK_F19 0x82 */
4795 "f20", /* VK_F20 0x83 */
4796 "f21", /* VK_F21 0x84 */
4797 "f22", /* VK_F22 0x85 */
4798 "f23", /* VK_F23 0x86 */
4799 "f24", /* VK_F24 0x87 */
4801 0, 0, 0, 0, /* 0x88 .. 0x8B */
4802 0, 0, 0, 0, /* 0x8C .. 0x8F */
4804 "kp-numlock", /* VK_NUMLOCK 0x90 */
4805 "scroll", /* VK_SCROLL 0x91 */
4806 /* Not sure where the following block comes from.
4807 Windows headers have NEC and Fujitsu specific keys in
4808 this block, but nothing generic. */
4809 "kp-space", /* VK_NUMPAD_CLEAR 0x92 */
4810 "kp-enter", /* VK_NUMPAD_ENTER 0x93 */
4811 "kp-prior", /* VK_NUMPAD_PRIOR 0x94 */
4812 "kp-next", /* VK_NUMPAD_NEXT 0x95 */
4813 "kp-end", /* VK_NUMPAD_END 0x96 */
4814 "kp-home", /* VK_NUMPAD_HOME 0x97 */
4815 "kp-left", /* VK_NUMPAD_LEFT 0x98 */
4816 "kp-up", /* VK_NUMPAD_UP 0x99 */
4817 "kp-right", /* VK_NUMPAD_RIGHT 0x9A */
4818 "kp-down", /* VK_NUMPAD_DOWN 0x9B */
4819 "kp-insert", /* VK_NUMPAD_INSERT 0x9C */
4820 "kp-delete", /* VK_NUMPAD_DELETE 0x9D */
4822 0, 0, /* 0x9E .. 0x9F */
4825 * VK_L* & VK_R* - left and right Alt, Ctrl and Shift virtual keys.
4826 * Used only as parameters to GetAsyncKeyState and GetKeyState.
4827 * No other API or message will distinguish left and right keys this way.
4832 /* Multimedia keys. These are handled as WM_APPCOMMAND, which allows us
4833 to enable them selectively, and gives access to a few more functions.
4834 See lispy_multimedia_keys below. */
4835 0, 0, 0, 0, 0, 0, 0, /* 0xA6 .. 0xAC Browser */
4836 0, 0, 0, /* 0xAD .. 0xAF Volume */
4837 0, 0, 0, 0, /* 0xB0 .. 0xB3 Media */
4838 0, 0, 0, 0, /* 0xB4 .. 0xB7 Apps */
4840 /* 0xB8 .. 0xC0 "OEM" keys - all seem to be punctuation. */
4841 0, 0, 0, 0, 0, 0, 0, 0, 0,
4843 /* 0xC1 - 0xDA unallocated, 0xDB-0xDF more OEM keys */
4844 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4845 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4848 "ax", /* VK_OEM_AX 0xE1 */
4849 0, /* VK_OEM_102 0xE2 */
4850 "ico-help", /* VK_ICO_HELP 0xE3 */
4851 "ico-00", /* VK_ICO_00 0xE4 */
4852 0, /* VK_PROCESSKEY 0xE5 - used by IME */
4853 "ico-clear", /* VK_ICO_CLEAR 0xE6 */
4854 0, /* VK_PACKET 0xE7 - used to pass Unicode chars */
4856 "reset", /* VK_OEM_RESET 0xE9 */
4857 "jump", /* VK_OEM_JUMP 0xEA */
4858 "oem-pa1", /* VK_OEM_PA1 0xEB */
4859 "oem-pa2", /* VK_OEM_PA2 0xEC */
4860 "oem-pa3", /* VK_OEM_PA3 0xED */
4861 "wsctrl", /* VK_OEM_WSCTRL 0xEE */
4862 "cusel", /* VK_OEM_CUSEL 0xEF */
4863 "oem-attn", /* VK_OEM_ATTN 0xF0 */
4864 "finish", /* VK_OEM_FINISH 0xF1 */
4865 "copy", /* VK_OEM_COPY 0xF2 */
4866 "auto", /* VK_OEM_AUTO 0xF3 */
4867 "enlw", /* VK_OEM_ENLW 0xF4 */
4868 "backtab", /* VK_OEM_BACKTAB 0xF5 */
4869 "attn", /* VK_ATTN 0xF6 */
4870 "crsel", /* VK_CRSEL 0xF7 */
4871 "exsel", /* VK_EXSEL 0xF8 */
4872 "ereof", /* VK_EREOF 0xF9 */
4873 "play", /* VK_PLAY 0xFA */
4874 "zoom", /* VK_ZOOM 0xFB */
4875 "noname", /* VK_NONAME 0xFC */
4876 "pa1", /* VK_PA1 0xFD */
4877 "oem_clear", /* VK_OEM_CLEAR 0xFE */
4881 /* Some of these duplicate the "Media keys" on newer keyboards,
4882 but they are delivered to the application in a different way. */
4883 static const char *const lispy_multimedia_keys
[] =
4891 "browser-favorites",
4928 "toggle-dictate-command",
4934 "media-fast-forward",
4937 "media-channel-down"
4940 #else /* not HAVE_NTGUI */
4942 /* This should be dealt with in XTread_socket now, and that doesn't
4943 depend on the client system having the Kana syms defined. See also
4944 the XK_kana_A case below. */
4947 static const char *const lispy_kana_keys
[] =
4949 /* X Keysym value */
4950 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x400 .. 0x40f */
4951 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x410 .. 0x41f */
4952 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x420 .. 0x42f */
4953 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x430 .. 0x43f */
4954 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x440 .. 0x44f */
4955 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x450 .. 0x45f */
4956 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x460 .. 0x46f */
4957 0,0,0,0,0,0,0,0,0,0,0,0,0,0,"overline",0,
4958 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x480 .. 0x48f */
4959 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x490 .. 0x49f */
4960 0, "kana-fullstop", "kana-openingbracket", "kana-closingbracket",
4961 "kana-comma", "kana-conjunctive", "kana-WO", "kana-a",
4962 "kana-i", "kana-u", "kana-e", "kana-o",
4963 "kana-ya", "kana-yu", "kana-yo", "kana-tsu",
4964 "prolongedsound", "kana-A", "kana-I", "kana-U",
4965 "kana-E", "kana-O", "kana-KA", "kana-KI",
4966 "kana-KU", "kana-KE", "kana-KO", "kana-SA",
4967 "kana-SHI", "kana-SU", "kana-SE", "kana-SO",
4968 "kana-TA", "kana-CHI", "kana-TSU", "kana-TE",
4969 "kana-TO", "kana-NA", "kana-NI", "kana-NU",
4970 "kana-NE", "kana-NO", "kana-HA", "kana-HI",
4971 "kana-FU", "kana-HE", "kana-HO", "kana-MA",
4972 "kana-MI", "kana-MU", "kana-ME", "kana-MO",
4973 "kana-YA", "kana-YU", "kana-YO", "kana-RA",
4974 "kana-RI", "kana-RU", "kana-RE", "kana-RO",
4975 "kana-WA", "kana-N", "voicedsound", "semivoicedsound",
4976 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4e0 .. 0x4ef */
4977 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4f0 .. 0x4ff */
4979 #endif /* XK_kana_A */
4982 #define FUNCTION_KEY_OFFSET 0xff00
4984 /* You'll notice that this table is arranged to be conveniently
4985 indexed by X Windows keysym values. */
4986 static const char *const lispy_function_keys
[] =
4988 /* X Keysym value */
4990 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff00...0f */
4991 "backspace", "tab", "linefeed", "clear",
4993 0, 0, 0, "pause", /* 0xff10...1f */
4994 0, 0, 0, 0, 0, 0, 0, "escape",
4996 0, "kanji", "muhenkan", "henkan", /* 0xff20...2f */
4997 "romaji", "hiragana", "katakana", "hiragana-katakana",
4998 "zenkaku", "hankaku", "zenkaku-hankaku", "touroku",
4999 "massyo", "kana-lock", "kana-shift", "eisu-shift",
5000 "eisu-toggle", /* 0xff30...3f */
5001 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
5002 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff40...4f */
5004 "home", "left", "up", "right", /* 0xff50 */ /* IsCursorKey */
5005 "down", "prior", "next", "end",
5006 "begin", 0, 0, 0, 0, 0, 0, 0,
5007 "select", /* 0xff60 */ /* IsMiscFunctionKey */
5018 "break", /* 0xff6b */
5021 0, 0, 0, 0, "backtab", 0, 0, 0, /* 0xff70... */
5022 0, 0, 0, 0, 0, 0, 0, "kp-numlock", /* 0xff78... */
5023 "kp-space", /* 0xff80 */ /* IsKeypadKey */
5024 0, 0, 0, 0, 0, 0, 0, 0,
5025 "kp-tab", /* 0xff89 */
5027 "kp-enter", /* 0xff8d */
5029 "kp-f1", /* 0xff91 */
5033 "kp-home", /* 0xff95 */
5038 "kp-prior", /* kp-page-up */
5039 "kp-next", /* kp-page-down */
5045 0, 0, 0, 0, 0, 0, 0, 0, 0,
5046 "kp-multiply", /* 0xffaa */
5051 "kp-divide", /* 0xffaf */
5052 "kp-0", /* 0xffb0 */
5053 "kp-1", "kp-2", "kp-3", "kp-4", "kp-5", "kp-6", "kp-7", "kp-8", "kp-9",
5056 "kp-equal", /* 0xffbd */
5057 "f1", /* 0xffbe */ /* IsFunctionKey */
5059 "f3", "f4", "f5", "f6", "f7", "f8", "f9", "f10", /* 0xffc0 */
5060 "f11", "f12", "f13", "f14", "f15", "f16", "f17", "f18",
5061 "f19", "f20", "f21", "f22", "f23", "f24", "f25", "f26", /* 0xffd0 */
5062 "f27", "f28", "f29", "f30", "f31", "f32", "f33", "f34",
5063 "f35", 0, 0, 0, 0, 0, 0, 0, /* 0xffe0 */
5064 0, 0, 0, 0, 0, 0, 0, 0,
5065 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfff0 */
5066 0, 0, 0, 0, 0, 0, 0, "delete"
5069 /* ISO 9995 Function and Modifier Keys; the first byte is 0xFE. */
5070 #define ISO_FUNCTION_KEY_OFFSET 0xfe00
5072 static const char *const iso_lispy_function_keys
[] =
5074 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe00 */
5075 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe08 */
5076 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe10 */
5077 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe18 */
5078 "iso-lefttab", /* 0xfe20 */
5079 "iso-move-line-up", "iso-move-line-down",
5080 "iso-partial-line-up", "iso-partial-line-down",
5081 "iso-partial-space-left", "iso-partial-space-right",
5082 "iso-set-margin-left", "iso-set-margin-right", /* 0xffe27, 28 */
5083 "iso-release-margin-left", "iso-release-margin-right",
5084 "iso-release-both-margins",
5085 "iso-fast-cursor-left", "iso-fast-cursor-right",
5086 "iso-fast-cursor-up", "iso-fast-cursor-down",
5087 "iso-continuous-underline", "iso-discontinuous-underline", /* 0xfe30, 31 */
5088 "iso-emphasize", "iso-center-object", "iso-enter", /* ... 0xfe34 */
5091 #endif /* not HAVE_NTGUI */
5093 static Lisp_Object Vlispy_mouse_stem
;
5095 static const char *const lispy_wheel_names
[] =
5097 "wheel-up", "wheel-down", "wheel-left", "wheel-right"
5100 /* drag-n-drop events are generated when a set of selected files are
5101 dragged from another application and dropped onto an Emacs window. */
5102 static const char *const lispy_drag_n_drop_names
[] =
5107 /* Scroll bar parts. */
5108 static Lisp_Object Qabove_handle
, Qhandle
, Qbelow_handle
;
5109 Lisp_Object Qup
, Qdown
, Qbottom
;
5110 static Lisp_Object Qend_scroll
;
5112 static Lisp_Object Qratio
;
5114 /* An array of scroll bar parts, indexed by an enum scroll_bar_part value. */
5115 static Lisp_Object
*const scroll_bar_parts
[] = {
5116 &Qabove_handle
, &Qhandle
, &Qbelow_handle
,
5117 &Qup
, &Qdown
, &Qtop
, &Qbottom
, &Qend_scroll
, &Qratio
5120 /* A vector, indexed by button number, giving the down-going location
5121 of currently depressed buttons, both scroll bar and non-scroll bar.
5123 The elements have the form
5124 (BUTTON-NUMBER MODIFIER-MASK . REST)
5125 where REST is the cdr of a position as it would be reported in the event.
5127 The make_lispy_event function stores positions here to tell the
5128 difference between click and drag events, and to store the starting
5129 location to be included in drag events. */
5131 static Lisp_Object button_down_location
;
5133 /* Information about the most recent up-going button event: Which
5134 button, what location, and what time. */
5136 static int last_mouse_button
;
5137 static int last_mouse_x
;
5138 static int last_mouse_y
;
5139 static Time button_down_time
;
5141 /* The number of clicks in this multiple-click. */
5143 static int double_click_count
;
5145 /* X and Y are frame-relative coordinates for a click or wheel event.
5146 Return a Lisp-style event list. */
5149 make_lispy_position (struct frame
*f
, Lisp_Object x
, Lisp_Object y
,
5152 enum window_part part
;
5153 Lisp_Object posn
= Qnil
;
5154 Lisp_Object extra_info
= Qnil
;
5155 /* Coordinate pixel positions to return. */
5156 int xret
= 0, yret
= 0;
5157 /* The window under frame pixel coordinates (x,y) */
5158 Lisp_Object window
= f
5159 ? window_from_coordinates (f
, XINT (x
), XINT (y
), &part
, 0)
5162 if (WINDOWP (window
))
5164 /* It's a click in window WINDOW at frame coordinates (X,Y) */
5165 struct window
*w
= XWINDOW (window
);
5166 Lisp_Object string_info
= Qnil
;
5167 ptrdiff_t textpos
= -1;
5168 int col
= -1, row
= -1;
5169 int dx
= -1, dy
= -1;
5170 int width
= -1, height
= -1;
5171 Lisp_Object object
= Qnil
;
5173 /* Pixel coordinates relative to the window corner. */
5174 int wx
= XINT (x
) - WINDOW_LEFT_EDGE_X (w
);
5175 int wy
= XINT (y
) - WINDOW_TOP_EDGE_Y (w
);
5177 /* For text area clicks, return X, Y relative to the corner of
5178 this text area. Note that dX, dY etc are set below, by
5179 buffer_posn_from_coords. */
5180 if (part
== ON_TEXT
)
5182 xret
= XINT (x
) - window_box_left (w
, TEXT_AREA
);
5183 yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5185 /* For mode line and header line clicks, return X, Y relative to
5186 the left window edge. Use mode_line_string to look for a
5187 string on the click position. */
5188 else if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
)
5193 posn
= (part
== ON_MODE_LINE
) ? Qmode_line
: Qheader_line
;
5194 /* Note that mode_line_string takes COL, ROW as pixels and
5195 converts them to characters. */
5198 string
= mode_line_string (w
, part
, &col
, &row
, &charpos
,
5199 &object
, &dx
, &dy
, &width
, &height
);
5200 if (STRINGP (string
))
5201 string_info
= Fcons (string
, make_number (charpos
));
5202 textpos
= (w
== XWINDOW (selected_window
)
5203 && current_buffer
== XBUFFER (w
->buffer
))
5204 ? PT
: XMARKER (w
->pointm
)->charpos
;
5209 /* For fringes and margins, Y is relative to the area's (and the
5210 window's) top edge, while X is meaningless. */
5211 else if (part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
5216 posn
= (part
== ON_LEFT_MARGIN
) ? Qleft_margin
: Qright_margin
;
5219 string
= marginal_area_string (w
, part
, &col
, &row
, &charpos
,
5220 &object
, &dx
, &dy
, &width
, &height
);
5221 if (STRINGP (string
))
5222 string_info
= Fcons (string
, make_number (charpos
));
5223 yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5225 else if (part
== ON_LEFT_FRINGE
)
5227 posn
= Qleft_fringe
;
5230 - (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5231 ? 0 : window_box_width (w
, LEFT_MARGIN_AREA
));
5232 dy
= yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5234 else if (part
== ON_RIGHT_FRINGE
)
5236 posn
= Qright_fringe
;
5239 - window_box_width (w
, LEFT_MARGIN_AREA
)
5240 - window_box_width (w
, TEXT_AREA
)
5241 - (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5242 ? window_box_width (w
, RIGHT_MARGIN_AREA
)
5244 dy
= yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5246 else if (part
== ON_VERTICAL_BORDER
)
5248 posn
= Qvertical_line
;
5253 /* Nothing special for part == ON_SCROLL_BAR. */
5255 /* For clicks in the text area, fringes, or margins, call
5256 buffer_posn_from_coords to extract TEXTPOS, the buffer
5257 position nearest to the click. */
5260 Lisp_Object string2
, object2
= Qnil
;
5261 struct display_pos p
;
5263 int width2
, height2
;
5264 /* The pixel X coordinate passed to buffer_posn_from_coords
5265 is the X coordinate relative to the text area for
5266 text-area and right-margin clicks, zero otherwise. */
5268 = (part
== ON_TEXT
) ? xret
5269 : (part
== ON_RIGHT_FRINGE
|| part
== ON_RIGHT_MARGIN
)
5270 ? (XINT (x
) - window_box_left (w
, TEXT_AREA
))
5274 string2
= buffer_posn_from_coords (w
, &x2
, &y2
, &p
,
5275 &object2
, &dx2
, &dy2
,
5277 textpos
= CHARPOS (p
.pos
);
5278 if (col
< 0) col
= x2
;
5279 if (row
< 0) row
= y2
;
5280 if (dx
< 0) dx
= dx2
;
5281 if (dy
< 0) dy
= dy2
;
5282 if (width
< 0) width
= width2
;
5283 if (height
< 0) height
= height2
;
5287 posn
= make_number (textpos
);
5288 if (STRINGP (string2
))
5289 string_info
= Fcons (string2
,
5290 make_number (CHARPOS (p
.string_pos
)));
5296 #ifdef HAVE_WINDOW_SYSTEM
5297 if (IMAGEP (object
))
5299 Lisp_Object image_map
, hotspot
;
5300 if ((image_map
= Fplist_get (XCDR (object
), QCmap
),
5302 && (hotspot
= find_hot_spot (image_map
, dx
, dy
),
5304 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
5305 posn
= XCAR (hotspot
);
5312 Fcons (make_number (dx
), make_number (dy
)),
5313 Fcons (make_number (width
), make_number (height
)));
5316 extra_info
= Fcons (string_info
,
5317 Fcons (make_number (textpos
),
5318 Fcons (Fcons (make_number (col
),
5323 XSETFRAME (window
, f
);
5327 return Fcons (window
,
5329 Fcons (Fcons (make_number (xret
),
5330 make_number (yret
)),
5331 Fcons (make_number (t
),
5335 /* Given a struct input_event, build the lisp event which represents
5336 it. If EVENT is 0, build a mouse movement event from the mouse
5337 movement buffer, which should have a movement event in it.
5339 Note that events must be passed to this function in the order they
5340 are received; this function stores the location of button presses
5341 in order to build drag events when the button is released. */
5344 make_lispy_event (struct input_event
*event
)
5348 switch (event
->kind
)
5350 /* A simple keystroke. */
5351 case ASCII_KEYSTROKE_EVENT
:
5352 case MULTIBYTE_CHAR_KEYSTROKE_EVENT
:
5354 Lisp_Object lispy_c
;
5355 EMACS_INT c
= event
->code
;
5356 if (event
->kind
== ASCII_KEYSTROKE_EVENT
)
5359 eassert (c
== event
->code
);
5360 /* Turn ASCII characters into control characters
5362 if (event
->modifiers
& ctrl_modifier
)
5364 c
= make_ctrl_char (c
);
5365 event
->modifiers
&= ~ctrl_modifier
;
5369 /* Add in the other modifier bits. The shift key was taken care
5370 of by the X code. */
5371 c
|= (event
->modifiers
5372 & (meta_modifier
| alt_modifier
5373 | hyper_modifier
| super_modifier
| ctrl_modifier
));
5374 /* Distinguish Shift-SPC from SPC. */
5375 if ((event
->code
) == 040
5376 && event
->modifiers
& shift_modifier
)
5377 c
|= shift_modifier
;
5378 button_down_time
= 0;
5379 XSETFASTINT (lispy_c
, c
);
5384 /* NS_NONKEY_EVENTs are just like NON_ASCII_KEYSTROKE_EVENTs,
5385 except that they are non-key events (last-nonmenu-event is nil). */
5386 case NS_NONKEY_EVENT
:
5389 /* A function key. The symbol may need to have modifier prefixes
5391 case NON_ASCII_KEYSTROKE_EVENT
:
5392 button_down_time
= 0;
5394 for (i
= 0; i
< sizeof (lispy_accent_codes
) / sizeof (int); i
++)
5395 if (event
->code
== lispy_accent_codes
[i
])
5396 return modify_event_symbol (i
,
5398 Qfunction_key
, Qnil
,
5399 lispy_accent_keys
, &accent_key_syms
,
5400 (sizeof (lispy_accent_keys
)
5401 / sizeof (lispy_accent_keys
[0])));
5405 if (event
->code
>= 0x400 && event
->code
< 0x500)
5406 return modify_event_symbol (event
->code
- 0x400,
5407 event
->modifiers
& ~shift_modifier
,
5408 Qfunction_key
, Qnil
,
5409 lispy_kana_keys
, &func_key_syms
,
5410 (sizeof (lispy_kana_keys
)
5411 / sizeof (lispy_kana_keys
[0])));
5412 #endif /* XK_kana_A */
5415 #ifdef ISO_FUNCTION_KEY_OFFSET
5416 if (event
->code
< FUNCTION_KEY_OFFSET
5417 && event
->code
>= ISO_FUNCTION_KEY_OFFSET
)
5418 return modify_event_symbol (event
->code
- ISO_FUNCTION_KEY_OFFSET
,
5420 Qfunction_key
, Qnil
,
5421 iso_lispy_function_keys
, &func_key_syms
,
5422 (sizeof (iso_lispy_function_keys
)
5423 / sizeof (iso_lispy_function_keys
[0])));
5426 /* Handle system-specific or unknown keysyms. */
5427 if (event
->code
& (1 << 28)
5428 || event
->code
- FUNCTION_KEY_OFFSET
< 0
5429 || (event
->code
- FUNCTION_KEY_OFFSET
5430 >= sizeof lispy_function_keys
/ sizeof *lispy_function_keys
)
5431 || !lispy_function_keys
[event
->code
- FUNCTION_KEY_OFFSET
])
5433 /* We need to use an alist rather than a vector as the cache
5434 since we can't make a vector long enough. */
5435 if (NILP (KVAR (current_kboard
, system_key_syms
)))
5436 kset_system_key_syms (current_kboard
, Fcons (Qnil
, Qnil
));
5437 return modify_event_symbol (event
->code
,
5440 KVAR (current_kboard
, Vsystem_key_alist
),
5441 0, &KVAR (current_kboard
, system_key_syms
),
5445 return modify_event_symbol (event
->code
- FUNCTION_KEY_OFFSET
,
5447 Qfunction_key
, Qnil
,
5448 lispy_function_keys
, &func_key_syms
,
5449 (sizeof (lispy_function_keys
)
5450 / sizeof (lispy_function_keys
[0])));
5453 case MULTIMEDIA_KEY_EVENT
:
5454 if (event
->code
< (sizeof (lispy_multimedia_keys
)
5455 / sizeof (lispy_multimedia_keys
[0]))
5456 && event
->code
> 0 && lispy_multimedia_keys
[event
->code
])
5458 return modify_event_symbol (event
->code
, event
->modifiers
,
5459 Qfunction_key
, Qnil
,
5460 lispy_multimedia_keys
, &func_key_syms
,
5461 (sizeof (lispy_multimedia_keys
)
5462 / sizeof (lispy_multimedia_keys
[0])));
5468 /* A mouse click. Figure out where it is, decide whether it's
5469 a press, click or drag, and build the appropriate structure. */
5470 case MOUSE_CLICK_EVENT
:
5471 #ifndef USE_TOOLKIT_SCROLL_BARS
5472 case SCROLL_BAR_CLICK_EVENT
:
5475 int button
= event
->code
;
5477 Lisp_Object position
;
5478 Lisp_Object
*start_pos_ptr
;
5479 Lisp_Object start_pos
;
5483 /* Build the position as appropriate for this mouse click. */
5484 if (event
->kind
== MOUSE_CLICK_EVENT
)
5486 struct frame
*f
= XFRAME (event
->frame_or_window
);
5487 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK) && ! defined (HAVE_NS)
5491 /* Ignore mouse events that were made on frame that
5492 have been deleted. */
5493 if (! FRAME_LIVE_P (f
))
5496 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK) && ! defined (HAVE_NS)
5497 /* EVENT->x and EVENT->y are frame-relative pixel
5498 coordinates at this place. Under old redisplay, COLUMN
5499 and ROW are set to frame relative glyph coordinates
5500 which are then used to determine whether this click is
5501 in a menu (non-toolkit version). */
5502 pixel_to_glyph_coords (f
, XINT (event
->x
), XINT (event
->y
),
5503 &column
, &row
, NULL
, 1);
5505 /* In the non-toolkit version, clicks on the menu bar
5506 are ordinary button events in the event buffer.
5507 Distinguish them, and invoke the menu.
5509 (In the toolkit version, the toolkit handles the menu bar
5510 and Emacs doesn't know about it until after the user
5511 makes a selection.) */
5512 if (row
>= 0 && row
< FRAME_MENU_BAR_LINES (f
)
5513 && (event
->modifiers
& down_modifier
))
5515 Lisp_Object items
, item
;
5517 /* Find the menu bar item under `column'. */
5519 items
= FRAME_MENU_BAR_ITEMS (f
);
5520 for (i
= 0; i
< ASIZE (items
); i
+= 4)
5522 Lisp_Object pos
, string
;
5523 string
= AREF (items
, i
+ 1);
5524 pos
= AREF (items
, i
+ 3);
5527 if (column
>= XINT (pos
)
5528 && column
< XINT (pos
) + SCHARS (string
))
5530 item
= AREF (items
, i
);
5535 /* ELisp manual 2.4b says (x y) are window relative but
5536 code says they are frame-relative. */
5538 = Fcons (event
->frame_or_window
,
5540 Fcons (Fcons (event
->x
, event
->y
),
5541 Fcons (make_number (event
->timestamp
),
5544 return Fcons (item
, Fcons (position
, Qnil
));
5546 #endif /* not USE_X_TOOLKIT && not USE_GTK && not HAVE_NS */
5548 position
= make_lispy_position (f
, event
->x
, event
->y
,
5551 #ifndef USE_TOOLKIT_SCROLL_BARS
5554 /* It's a scrollbar click. */
5556 Lisp_Object portion_whole
;
5559 window
= event
->frame_or_window
;
5560 portion_whole
= Fcons (event
->x
, event
->y
);
5561 part
= *scroll_bar_parts
[(int) event
->part
];
5565 Fcons (Qvertical_scroll_bar
,
5566 Fcons (portion_whole
,
5567 Fcons (make_number (event
->timestamp
),
5568 Fcons (part
, Qnil
)))));
5570 #endif /* not USE_TOOLKIT_SCROLL_BARS */
5572 if (button
>= ASIZE (button_down_location
))
5574 ptrdiff_t incr
= button
- ASIZE (button_down_location
) + 1;
5575 button_down_location
= larger_vector (button_down_location
,
5577 mouse_syms
= larger_vector (mouse_syms
, incr
, -1);
5580 start_pos_ptr
= aref_addr (button_down_location
, button
);
5581 start_pos
= *start_pos_ptr
;
5582 *start_pos_ptr
= Qnil
;
5585 /* On window-system frames, use the value of
5586 double-click-fuzz as is. On other frames, interpret it
5587 as a multiple of 1/8 characters. */
5591 if (WINDOWP (event
->frame_or_window
))
5592 f
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5593 else if (FRAMEP (event
->frame_or_window
))
5594 f
= XFRAME (event
->frame_or_window
);
5598 if (FRAME_WINDOW_P (f
))
5599 fuzz
= double_click_fuzz
;
5601 fuzz
= double_click_fuzz
/ 8;
5603 is_double
= (button
== last_mouse_button
5604 && (eabs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5605 && (eabs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5606 && button_down_time
!= 0
5607 && (EQ (Vdouble_click_time
, Qt
)
5608 || (NATNUMP (Vdouble_click_time
)
5609 && (event
->timestamp
- button_down_time
5610 < XFASTINT (Vdouble_click_time
)))));
5613 last_mouse_button
= button
;
5614 last_mouse_x
= XINT (event
->x
);
5615 last_mouse_y
= XINT (event
->y
);
5617 /* If this is a button press, squirrel away the location, so
5618 we can decide later whether it was a click or a drag. */
5619 if (event
->modifiers
& down_modifier
)
5623 double_click_count
++;
5624 event
->modifiers
|= ((double_click_count
> 2)
5629 double_click_count
= 1;
5630 button_down_time
= event
->timestamp
;
5631 *start_pos_ptr
= Fcopy_alist (position
);
5632 ignore_mouse_drag_p
= 0;
5635 /* Now we're releasing a button - check the co-ordinates to
5636 see if this was a click or a drag. */
5637 else if (event
->modifiers
& up_modifier
)
5639 /* If we did not see a down before this up, ignore the up.
5640 Probably this happened because the down event chose a
5641 menu item. It would be an annoyance to treat the
5642 release of the button that chose the menu item as a
5645 if (!CONSP (start_pos
))
5648 event
->modifiers
&= ~up_modifier
;
5651 Lisp_Object new_down
, down
;
5652 EMACS_INT xdiff
= double_click_fuzz
, ydiff
= double_click_fuzz
;
5654 /* The third element of every position
5655 should be the (x,y) pair. */
5656 down
= Fcar (Fcdr (Fcdr (start_pos
)));
5657 new_down
= Fcar (Fcdr (Fcdr (position
)));
5660 && INTEGERP (XCAR (down
)) && INTEGERP (XCDR (down
)))
5662 xdiff
= XINT (XCAR (new_down
)) - XINT (XCAR (down
));
5663 ydiff
= XINT (XCDR (new_down
)) - XINT (XCDR (down
));
5666 if (ignore_mouse_drag_p
)
5668 event
->modifiers
|= click_modifier
;
5669 ignore_mouse_drag_p
= 0;
5671 else if (xdiff
< double_click_fuzz
&& xdiff
> - double_click_fuzz
5672 && ydiff
< double_click_fuzz
&& ydiff
> - double_click_fuzz
5673 /* Maybe the mouse has moved a lot, caused scrolling, and
5674 eventually ended up at the same screen position (but
5675 not buffer position) in which case it is a drag, not
5677 /* FIXME: OTOH if the buffer position has changed
5678 because of a timer or process filter rather than
5679 because of mouse movement, it should be considered as
5680 a click. But mouse-drag-region completely ignores
5681 this case and it hasn't caused any real problem, so
5682 it's probably OK to ignore it as well. */
5683 && EQ (Fcar (Fcdr (start_pos
)), Fcar (Fcdr (position
))))
5684 /* Mouse hasn't moved (much). */
5685 event
->modifiers
|= click_modifier
;
5688 button_down_time
= 0;
5689 event
->modifiers
|= drag_modifier
;
5692 /* Don't check is_double; treat this as multiple
5693 if the down-event was multiple. */
5694 if (double_click_count
> 1)
5695 event
->modifiers
|= ((double_click_count
> 2)
5701 /* Every mouse event should either have the down_modifier or
5702 the up_modifier set. */
5706 /* Get the symbol we should use for the mouse click. */
5709 head
= modify_event_symbol (button
,
5711 Qmouse_click
, Vlispy_mouse_stem
,
5714 ASIZE (mouse_syms
));
5715 if (event
->modifiers
& drag_modifier
)
5720 else if (event
->modifiers
& (double_modifier
| triple_modifier
))
5723 Fcons (make_number (double_click_count
),
5733 case HORIZ_WHEEL_EVENT
:
5735 Lisp_Object position
;
5738 /* Build the position as appropriate for this mouse click. */
5739 struct frame
*f
= XFRAME (event
->frame_or_window
);
5741 /* Ignore wheel events that were made on frame that have been
5743 if (! FRAME_LIVE_P (f
))
5746 position
= make_lispy_position (f
, event
->x
, event
->y
,
5749 /* Set double or triple modifiers to indicate the wheel speed. */
5751 /* On window-system frames, use the value of
5752 double-click-fuzz as is. On other frames, interpret it
5753 as a multiple of 1/8 characters. */
5759 if (WINDOWP (event
->frame_or_window
))
5760 fr
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5761 else if (FRAMEP (event
->frame_or_window
))
5762 fr
= XFRAME (event
->frame_or_window
);
5766 fuzz
= FRAME_WINDOW_P (fr
)
5767 ? double_click_fuzz
: double_click_fuzz
/ 8;
5769 if (event
->modifiers
& up_modifier
)
5771 /* Emit a wheel-up event. */
5772 event
->modifiers
&= ~up_modifier
;
5775 else if (event
->modifiers
& down_modifier
)
5777 /* Emit a wheel-down event. */
5778 event
->modifiers
&= ~down_modifier
;
5782 /* Every wheel event should either have the down_modifier or
5783 the up_modifier set. */
5786 if (event
->kind
== HORIZ_WHEEL_EVENT
)
5789 is_double
= (last_mouse_button
== - (1 + symbol_num
)
5790 && (eabs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5791 && (eabs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5792 && button_down_time
!= 0
5793 && (EQ (Vdouble_click_time
, Qt
)
5794 || (NATNUMP (Vdouble_click_time
)
5795 && (event
->timestamp
- button_down_time
5796 < XFASTINT (Vdouble_click_time
)))));
5799 double_click_count
++;
5800 event
->modifiers
|= ((double_click_count
> 2)
5806 double_click_count
= 1;
5807 event
->modifiers
|= click_modifier
;
5810 button_down_time
= event
->timestamp
;
5811 /* Use a negative value to distinguish wheel from mouse button. */
5812 last_mouse_button
= - (1 + symbol_num
);
5813 last_mouse_x
= XINT (event
->x
);
5814 last_mouse_y
= XINT (event
->y
);
5816 /* Get the symbol we should use for the wheel event. */
5817 head
= modify_event_symbol (symbol_num
,
5823 ASIZE (wheel_syms
));
5826 if (event
->modifiers
& (double_modifier
| triple_modifier
))
5829 Fcons (make_number (double_click_count
),
5838 #ifdef USE_TOOLKIT_SCROLL_BARS
5840 /* We don't have down and up events if using toolkit scroll bars,
5841 so make this always a click event. Store in the `part' of
5842 the Lisp event a symbol which maps to the following actions:
5844 `above_handle' page up
5845 `below_handle' page down
5849 `bottom' bottom of buffer
5850 `handle' thumb has been dragged.
5851 `end-scroll' end of interaction with scroll bar
5853 The incoming input_event contains in its `part' member an
5854 index of type `enum scroll_bar_part' which we can use as an
5855 index in scroll_bar_parts to get the appropriate symbol. */
5857 case SCROLL_BAR_CLICK_EVENT
:
5859 Lisp_Object position
, head
, window
, portion_whole
, part
;
5861 window
= event
->frame_or_window
;
5862 portion_whole
= Fcons (event
->x
, event
->y
);
5863 part
= *scroll_bar_parts
[(int) event
->part
];
5867 Fcons (Qvertical_scroll_bar
,
5868 Fcons (portion_whole
,
5869 Fcons (make_number (event
->timestamp
),
5870 Fcons (part
, Qnil
)))));
5872 /* Always treat scroll bar events as clicks. */
5873 event
->modifiers
|= click_modifier
;
5874 event
->modifiers
&= ~up_modifier
;
5876 if (event
->code
>= ASIZE (mouse_syms
))
5877 mouse_syms
= larger_vector (mouse_syms
,
5878 event
->code
- ASIZE (mouse_syms
) + 1,
5881 /* Get the symbol we should use for the mouse click. */
5882 head
= modify_event_symbol (event
->code
,
5887 ASIZE (mouse_syms
));
5888 return Fcons (head
, Fcons (position
, Qnil
));
5891 #endif /* USE_TOOLKIT_SCROLL_BARS */
5893 case DRAG_N_DROP_EVENT
:
5896 Lisp_Object head
, position
;
5899 f
= XFRAME (event
->frame_or_window
);
5902 /* Ignore mouse events that were made on frames that
5903 have been deleted. */
5904 if (! FRAME_LIVE_P (f
))
5907 position
= make_lispy_position (f
, event
->x
, event
->y
,
5910 head
= modify_event_symbol (0, event
->modifiers
,
5912 lispy_drag_n_drop_names
,
5913 &drag_n_drop_syms
, 1);
5919 #endif /* HAVE_MOUSE */
5921 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
5922 || defined (HAVE_NS) || defined (USE_GTK)
5923 case MENU_BAR_EVENT
:
5924 if (EQ (event
->arg
, event
->frame_or_window
))
5925 /* This is the prefix key. We translate this to
5926 `(menu_bar)' because the code in keyboard.c for menu
5927 events, which we use, relies on this. */
5928 return Fcons (Qmenu_bar
, Qnil
);
5932 case SELECT_WINDOW_EVENT
:
5933 /* Make an event (select-window (WINDOW)). */
5934 return Fcons (Qselect_window
,
5935 Fcons (Fcons (event
->frame_or_window
, Qnil
),
5938 case TOOL_BAR_EVENT
:
5939 if (EQ (event
->arg
, event
->frame_or_window
))
5940 /* This is the prefix key. We translate this to
5941 `(tool_bar)' because the code in keyboard.c for tool bar
5942 events, which we use, relies on this. */
5943 return Fcons (Qtool_bar
, Qnil
);
5944 else if (SYMBOLP (event
->arg
))
5945 return apply_modifiers (event
->modifiers
, event
->arg
);
5948 case USER_SIGNAL_EVENT
:
5949 /* A user signal. */
5951 char *name
= find_user_signal_name (event
->code
);
5954 return intern (name
);
5957 case SAVE_SESSION_EVENT
:
5958 return Qsave_session
;
5963 return Fcons (Qdbus_event
, event
->arg
);
5965 #endif /* HAVE_DBUS */
5967 case CONFIG_CHANGED_EVENT
:
5968 return Fcons (Qconfig_changed_event
,
5970 Fcons (event
->frame_or_window
, Qnil
)));
5972 case GPM_CLICK_EVENT
:
5974 FRAME_PTR f
= XFRAME (event
->frame_or_window
);
5975 Lisp_Object head
, position
;
5976 Lisp_Object
*start_pos_ptr
;
5977 Lisp_Object start_pos
;
5978 int button
= event
->code
;
5980 if (button
>= ASIZE (button_down_location
))
5982 ptrdiff_t incr
= button
- ASIZE (button_down_location
) + 1;
5983 button_down_location
= larger_vector (button_down_location
,
5985 mouse_syms
= larger_vector (mouse_syms
, incr
, -1);
5988 start_pos_ptr
= aref_addr (button_down_location
, button
);
5989 start_pos
= *start_pos_ptr
;
5991 position
= make_lispy_position (f
, event
->x
, event
->y
,
5994 if (event
->modifiers
& down_modifier
)
5995 *start_pos_ptr
= Fcopy_alist (position
);
5996 else if (event
->modifiers
& (up_modifier
| drag_modifier
))
5998 if (!CONSP (start_pos
))
6000 event
->modifiers
&= ~up_modifier
;
6003 head
= modify_event_symbol (button
,
6005 Qmouse_click
, Vlispy_mouse_stem
,
6008 ASIZE (mouse_syms
));
6010 if (event
->modifiers
& drag_modifier
)
6015 else if (event
->modifiers
& double_modifier
)
6018 Fcons (make_number (2),
6020 else if (event
->modifiers
& triple_modifier
)
6023 Fcons (make_number (3),
6030 #endif /* HAVE_GPM */
6032 /* The 'kind' field of the event is something we don't recognize. */
6038 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
6041 make_lispy_movement (FRAME_PTR frame
, Lisp_Object bar_window
, enum scroll_bar_part part
,
6042 Lisp_Object x
, Lisp_Object y
, Time t
)
6044 /* Is it a scroll bar movement? */
6045 if (frame
&& ! NILP (bar_window
))
6047 Lisp_Object part_sym
;
6049 part_sym
= *scroll_bar_parts
[(int) part
];
6050 return Fcons (Qscroll_bar_movement
,
6051 Fcons (list5 (bar_window
,
6052 Qvertical_scroll_bar
,
6058 /* Or is it an ordinary mouse movement? */
6061 Lisp_Object position
;
6062 position
= make_lispy_position (frame
, x
, y
, t
);
6063 return list2 (Qmouse_movement
, position
);
6067 #endif /* HAVE_MOUSE || HAVE GPM */
6069 /* Construct a switch frame event. */
6071 make_lispy_switch_frame (Lisp_Object frame
)
6073 return Fcons (Qswitch_frame
, Fcons (frame
, Qnil
));
6076 /* Manipulating modifiers. */
6078 /* Parse the name of SYMBOL, and return the set of modifiers it contains.
6080 If MODIFIER_END is non-zero, set *MODIFIER_END to the position in
6081 SYMBOL's name of the end of the modifiers; the string from this
6082 position is the unmodified symbol name.
6084 This doesn't use any caches. */
6087 parse_modifiers_uncached (Lisp_Object symbol
, ptrdiff_t *modifier_end
)
6093 CHECK_SYMBOL (symbol
);
6096 name
= SYMBOL_NAME (symbol
);
6098 for (i
= 0; i
< SBYTES (name
) - 1; )
6100 ptrdiff_t this_mod_end
= 0;
6103 /* See if the name continues with a modifier word.
6104 Check that the word appears, but don't check what follows it.
6105 Set this_mod and this_mod_end to record what we find. */
6107 switch (SREF (name
, i
))
6109 #define SINGLE_LETTER_MOD(BIT) \
6110 (this_mod_end = i + 1, this_mod = BIT)
6113 SINGLE_LETTER_MOD (alt_modifier
);
6117 SINGLE_LETTER_MOD (ctrl_modifier
);
6121 SINGLE_LETTER_MOD (hyper_modifier
);
6125 SINGLE_LETTER_MOD (meta_modifier
);
6129 SINGLE_LETTER_MOD (shift_modifier
);
6133 SINGLE_LETTER_MOD (super_modifier
);
6136 #undef SINGLE_LETTER_MOD
6138 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6139 if (i + LEN + 1 <= SBYTES (name) \
6140 && ! memcmp (SDATA (name) + i, NAME, LEN)) \
6142 this_mod_end = i + LEN; \
6147 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
6148 MULTI_LETTER_MOD (down_modifier
, "down", 4);
6149 MULTI_LETTER_MOD (double_modifier
, "double", 6);
6153 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
6155 #undef MULTI_LETTER_MOD
6159 /* If we found no modifier, stop looking for them. */
6160 if (this_mod_end
== 0)
6163 /* Check there is a dash after the modifier, so that it
6164 really is a modifier. */
6165 if (this_mod_end
>= SBYTES (name
)
6166 || SREF (name
, this_mod_end
) != '-')
6169 /* This modifier is real; look for another. */
6170 modifiers
|= this_mod
;
6171 i
= this_mod_end
+ 1;
6174 /* Should we include the `click' modifier? */
6175 if (! (modifiers
& (down_modifier
| drag_modifier
6176 | double_modifier
| triple_modifier
))
6177 && i
+ 7 == SBYTES (name
)
6178 && memcmp (SDATA (name
) + i
, "mouse-", 6) == 0
6179 && ('0' <= SREF (name
, i
+ 6) && SREF (name
, i
+ 6) <= '9'))
6180 modifiers
|= click_modifier
;
6182 if (! (modifiers
& (double_modifier
| triple_modifier
))
6183 && i
+ 6 < SBYTES (name
)
6184 && memcmp (SDATA (name
) + i
, "wheel-", 6) == 0)
6185 modifiers
|= click_modifier
;
6193 /* Return a symbol whose name is the modifier prefixes for MODIFIERS
6194 prepended to the string BASE[0..BASE_LEN-1].
6195 This doesn't use any caches. */
6197 apply_modifiers_uncached (int modifiers
, char *base
, int base_len
, int base_len_byte
)
6199 /* Since BASE could contain nulls, we can't use intern here; we have
6200 to use Fintern, which expects a genuine Lisp_String, and keeps a
6202 char new_mods
[sizeof "A-C-H-M-S-s-down-drag-double-triple-"];
6208 /* Only the event queue may use the `up' modifier; it should always
6209 be turned into a click or drag event before presented to lisp code. */
6210 if (modifiers
& up_modifier
)
6213 if (modifiers
& alt_modifier
) { *p
++ = 'A'; *p
++ = '-'; }
6214 if (modifiers
& ctrl_modifier
) { *p
++ = 'C'; *p
++ = '-'; }
6215 if (modifiers
& hyper_modifier
) { *p
++ = 'H'; *p
++ = '-'; }
6216 if (modifiers
& meta_modifier
) { *p
++ = 'M'; *p
++ = '-'; }
6217 if (modifiers
& shift_modifier
) { *p
++ = 'S'; *p
++ = '-'; }
6218 if (modifiers
& super_modifier
) { *p
++ = 's'; *p
++ = '-'; }
6219 if (modifiers
& double_modifier
) { strcpy (p
, "double-"); p
+= 7; }
6220 if (modifiers
& triple_modifier
) { strcpy (p
, "triple-"); p
+= 7; }
6221 if (modifiers
& down_modifier
) { strcpy (p
, "down-"); p
+= 5; }
6222 if (modifiers
& drag_modifier
) { strcpy (p
, "drag-"); p
+= 5; }
6223 /* The click modifier is denoted by the absence of other modifiers. */
6227 mod_len
= p
- new_mods
;
6231 Lisp_Object new_name
;
6233 new_name
= make_uninit_multibyte_string (mod_len
+ base_len
,
6234 mod_len
+ base_len_byte
);
6235 memcpy (SDATA (new_name
), new_mods
, mod_len
);
6236 memcpy (SDATA (new_name
) + mod_len
, base
, base_len_byte
);
6238 return Fintern (new_name
, Qnil
);
6243 static const char *const modifier_names
[] =
6245 "up", "down", "drag", "click", "double", "triple", 0, 0,
6246 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
6247 0, 0, "alt", "super", "hyper", "shift", "control", "meta"
6249 #define NUM_MOD_NAMES (sizeof (modifier_names) / sizeof (modifier_names[0]))
6251 static Lisp_Object modifier_symbols
;
6253 /* Return the list of modifier symbols corresponding to the mask MODIFIERS. */
6255 lispy_modifier_list (int modifiers
)
6257 Lisp_Object modifier_list
;
6260 modifier_list
= Qnil
;
6261 for (i
= 0; (1<<i
) <= modifiers
&& i
< NUM_MOD_NAMES
; i
++)
6262 if (modifiers
& (1<<i
))
6263 modifier_list
= Fcons (AREF (modifier_symbols
, i
),
6266 return modifier_list
;
6270 /* Parse the modifiers on SYMBOL, and return a list like (UNMODIFIED MASK),
6271 where UNMODIFIED is the unmodified form of SYMBOL,
6272 MASK is the set of modifiers present in SYMBOL's name.
6273 This is similar to parse_modifiers_uncached, but uses the cache in
6274 SYMBOL's Qevent_symbol_element_mask property, and maintains the
6275 Qevent_symbol_elements property. */
6277 #define KEY_TO_CHAR(k) (XINT (k) & ((1 << CHARACTERBITS) - 1))
6280 parse_modifiers (Lisp_Object symbol
)
6282 Lisp_Object elements
;
6284 if (INTEGERP (symbol
))
6285 return (Fcons (make_number (KEY_TO_CHAR (symbol
)),
6286 Fcons (make_number (XINT (symbol
) & CHAR_MODIFIER_MASK
),
6288 else if (!SYMBOLP (symbol
))
6291 elements
= Fget (symbol
, Qevent_symbol_element_mask
);
6292 if (CONSP (elements
))
6297 int modifiers
= parse_modifiers_uncached (symbol
, &end
);
6298 Lisp_Object unmodified
;
6301 unmodified
= Fintern (make_string (SSDATA (SYMBOL_NAME (symbol
)) + end
,
6302 SBYTES (SYMBOL_NAME (symbol
)) - end
),
6305 if (modifiers
& ~INTMASK
)
6307 XSETFASTINT (mask
, modifiers
);
6308 elements
= Fcons (unmodified
, Fcons (mask
, Qnil
));
6310 /* Cache the parsing results on SYMBOL. */
6311 Fput (symbol
, Qevent_symbol_element_mask
,
6313 Fput (symbol
, Qevent_symbol_elements
,
6314 Fcons (unmodified
, lispy_modifier_list (modifiers
)));
6316 /* Since we know that SYMBOL is modifiers applied to unmodified,
6317 it would be nice to put that in unmodified's cache.
6318 But we can't, since we're not sure that parse_modifiers is
6325 DEFUN ("internal-event-symbol-parse-modifiers", Fevent_symbol_parse_modifiers
,
6326 Sevent_symbol_parse_modifiers
, 1, 1, 0,
6327 doc
: /* Parse the event symbol. For internal use. */)
6328 (Lisp_Object symbol
)
6330 /* Fill the cache if needed. */
6331 parse_modifiers (symbol
);
6332 /* Ignore the result (which is stored on Qevent_symbol_element_mask)
6333 and use the Lispier representation stored on Qevent_symbol_elements
6335 return Fget (symbol
, Qevent_symbol_elements
);
6338 /* Apply the modifiers MODIFIERS to the symbol BASE.
6339 BASE must be unmodified.
6341 This is like apply_modifiers_uncached, but uses BASE's
6342 Qmodifier_cache property, if present. It also builds
6343 Qevent_symbol_elements properties, since it has that info anyway.
6345 apply_modifiers copies the value of BASE's Qevent_kind property to
6346 the modified symbol. */
6348 apply_modifiers (int modifiers
, Lisp_Object base
)
6350 Lisp_Object cache
, idx
, entry
, new_symbol
;
6352 /* Mask out upper bits. We don't know where this value's been. */
6353 modifiers
&= INTMASK
;
6355 if (INTEGERP (base
))
6356 return make_number (XINT (base
) | modifiers
);
6358 /* The click modifier never figures into cache indices. */
6359 cache
= Fget (base
, Qmodifier_cache
);
6360 XSETFASTINT (idx
, (modifiers
& ~click_modifier
));
6361 entry
= assq_no_quit (idx
, cache
);
6364 new_symbol
= XCDR (entry
);
6367 /* We have to create the symbol ourselves. */
6368 new_symbol
= apply_modifiers_uncached (modifiers
,
6369 SSDATA (SYMBOL_NAME (base
)),
6370 SCHARS (SYMBOL_NAME (base
)),
6371 SBYTES (SYMBOL_NAME (base
)));
6373 /* Add the new symbol to the base's cache. */
6374 entry
= Fcons (idx
, new_symbol
);
6375 Fput (base
, Qmodifier_cache
, Fcons (entry
, cache
));
6377 /* We have the parsing info now for free, so we could add it to
6379 XSETFASTINT (idx, modifiers);
6380 Fput (new_symbol, Qevent_symbol_element_mask,
6381 Fcons (base, Fcons (idx, Qnil)));
6382 Fput (new_symbol, Qevent_symbol_elements,
6383 Fcons (base, lispy_modifier_list (modifiers)));
6384 Sadly, this is only correct if `base' is indeed a base event,
6385 which is not necessarily the case. -stef */
6388 /* Make sure this symbol is of the same kind as BASE.
6390 You'd think we could just set this once and for all when we
6391 intern the symbol above, but reorder_modifiers may call us when
6392 BASE's property isn't set right; we can't assume that just
6393 because it has a Qmodifier_cache property it must have its
6394 Qevent_kind set right as well. */
6395 if (NILP (Fget (new_symbol
, Qevent_kind
)))
6399 kind
= Fget (base
, Qevent_kind
);
6401 Fput (new_symbol
, Qevent_kind
, kind
);
6408 /* Given a symbol whose name begins with modifiers ("C-", "M-", etc),
6409 return a symbol with the modifiers placed in the canonical order.
6410 Canonical order is alphabetical, except for down and drag, which
6411 always come last. The 'click' modifier is never written out.
6413 Fdefine_key calls this to make sure that (for example) C-M-foo
6414 and M-C-foo end up being equivalent in the keymap. */
6417 reorder_modifiers (Lisp_Object symbol
)
6419 /* It's hopefully okay to write the code this way, since everything
6420 will soon be in caches, and no consing will be done at all. */
6423 parsed
= parse_modifiers (symbol
);
6424 return apply_modifiers (XFASTINT (XCAR (XCDR (parsed
))),
6429 /* For handling events, we often want to produce a symbol whose name
6430 is a series of modifier key prefixes ("M-", "C-", etcetera) attached
6431 to some base, like the name of a function key or mouse button.
6432 modify_event_symbol produces symbols of this sort.
6434 NAME_TABLE should point to an array of strings, such that NAME_TABLE[i]
6435 is the name of the i'th symbol. TABLE_SIZE is the number of elements
6438 Alternatively, NAME_ALIST_OR_STEM is either an alist mapping codes
6439 into symbol names, or a string specifying a name stem used to
6440 construct a symbol name or the form `STEM-N', where N is the decimal
6441 representation of SYMBOL_NUM. NAME_ALIST_OR_STEM is used if it is
6442 non-nil; otherwise NAME_TABLE is used.
6444 SYMBOL_TABLE should be a pointer to a Lisp_Object whose value will
6445 persist between calls to modify_event_symbol that it can use to
6446 store a cache of the symbols it's generated for this NAME_TABLE
6447 before. The object stored there may be a vector or an alist.
6449 SYMBOL_NUM is the number of the base name we want from NAME_TABLE.
6451 MODIFIERS is a set of modifier bits (as given in struct input_events)
6452 whose prefixes should be applied to the symbol name.
6454 SYMBOL_KIND is the value to be placed in the event_kind property of
6455 the returned symbol.
6457 The symbols we create are supposed to have an
6458 `event-symbol-elements' property, which lists the modifiers present
6459 in the symbol's name. */
6462 modify_event_symbol (ptrdiff_t symbol_num
, int modifiers
, Lisp_Object symbol_kind
,
6463 Lisp_Object name_alist_or_stem
, const char *const *name_table
,
6464 Lisp_Object
*symbol_table
, ptrdiff_t table_size
)
6467 Lisp_Object symbol_int
;
6469 /* Get rid of the "vendor-specific" bit here. */
6470 XSETINT (symbol_int
, symbol_num
& 0xffffff);
6472 /* Is this a request for a valid symbol? */
6473 if (symbol_num
< 0 || symbol_num
>= table_size
)
6476 if (CONSP (*symbol_table
))
6477 value
= Fcdr (assq_no_quit (symbol_int
, *symbol_table
));
6479 /* If *symbol_table doesn't seem to be initialized properly, fix that.
6480 *symbol_table should be a lisp vector TABLE_SIZE elements long,
6481 where the Nth element is the symbol for NAME_TABLE[N], or nil if
6482 we've never used that symbol before. */
6485 if (! VECTORP (*symbol_table
)
6486 || ASIZE (*symbol_table
) != table_size
)
6490 XSETFASTINT (size
, table_size
);
6491 *symbol_table
= Fmake_vector (size
, Qnil
);
6494 value
= AREF (*symbol_table
, symbol_num
);
6497 /* Have we already used this symbol before? */
6500 /* No; let's create it. */
6501 if (CONSP (name_alist_or_stem
))
6502 value
= Fcdr_safe (Fassq (symbol_int
, name_alist_or_stem
));
6503 else if (STRINGP (name_alist_or_stem
))
6506 ptrdiff_t len
= (SBYTES (name_alist_or_stem
)
6507 + sizeof "-" + INT_STRLEN_BOUND (EMACS_INT
));
6509 buf
= SAFE_ALLOCA (len
);
6510 esprintf (buf
, "%s-%"pI
"d", SDATA (name_alist_or_stem
),
6511 XINT (symbol_int
) + 1);
6512 value
= intern (buf
);
6515 else if (name_table
!= 0 && name_table
[symbol_num
])
6516 value
= intern (name_table
[symbol_num
]);
6518 #ifdef HAVE_WINDOW_SYSTEM
6521 char *name
= x_get_keysym_name (symbol_num
);
6523 value
= intern (name
);
6529 char buf
[sizeof "key-" + INT_STRLEN_BOUND (EMACS_INT
)];
6530 sprintf (buf
, "key-%"pD
"d", symbol_num
);
6531 value
= intern (buf
);
6534 if (CONSP (*symbol_table
))
6535 *symbol_table
= Fcons (Fcons (symbol_int
, value
), *symbol_table
);
6537 ASET (*symbol_table
, symbol_num
, value
);
6539 /* Fill in the cache entries for this symbol; this also
6540 builds the Qevent_symbol_elements property, which the user
6542 apply_modifiers (modifiers
& click_modifier
, value
);
6543 Fput (value
, Qevent_kind
, symbol_kind
);
6546 /* Apply modifiers to that symbol. */
6547 return apply_modifiers (modifiers
, value
);
6550 /* Convert a list that represents an event type,
6551 such as (ctrl meta backspace), into the usual representation of that
6552 event type as a number or a symbol. */
6554 DEFUN ("event-convert-list", Fevent_convert_list
, Sevent_convert_list
, 1, 1, 0,
6555 doc
: /* Convert the event description list EVENT-DESC to an event type.
6556 EVENT-DESC should contain one base event type (a character or symbol)
6557 and zero or more modifier names (control, meta, hyper, super, shift, alt,
6558 drag, down, double or triple). The base must be last.
6559 The return value is an event type (a character or symbol) which
6560 has the same base event type and all the specified modifiers. */)
6561 (Lisp_Object event_desc
)
6569 while (CONSP (rest
))
6577 /* Given a symbol, see if it is a modifier name. */
6578 if (SYMBOLP (elt
) && CONSP (rest
))
6579 this = parse_solitary_modifier (elt
);
6583 else if (!NILP (base
))
6584 error ("Two bases given in one event");
6590 /* Let the symbol A refer to the character A. */
6591 if (SYMBOLP (base
) && SCHARS (SYMBOL_NAME (base
)) == 1)
6592 XSETINT (base
, SREF (SYMBOL_NAME (base
), 0));
6594 if (INTEGERP (base
))
6596 /* Turn (shift a) into A. */
6597 if ((modifiers
& shift_modifier
) != 0
6598 && (XINT (base
) >= 'a' && XINT (base
) <= 'z'))
6600 XSETINT (base
, XINT (base
) - ('a' - 'A'));
6601 modifiers
&= ~shift_modifier
;
6604 /* Turn (control a) into C-a. */
6605 if (modifiers
& ctrl_modifier
)
6606 return make_number ((modifiers
& ~ctrl_modifier
)
6607 | make_ctrl_char (XINT (base
)));
6609 return make_number (modifiers
| XINT (base
));
6611 else if (SYMBOLP (base
))
6612 return apply_modifiers (modifiers
, base
);
6615 error ("Invalid base event");
6620 /* Try to recognize SYMBOL as a modifier name.
6621 Return the modifier flag bit, or 0 if not recognized. */
6624 parse_solitary_modifier (Lisp_Object symbol
)
6626 Lisp_Object name
= SYMBOL_NAME (symbol
);
6628 switch (SREF (name
, 0))
6630 #define SINGLE_LETTER_MOD(BIT) \
6631 if (SBYTES (name) == 1) \
6634 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6635 if (LEN == SBYTES (name) \
6636 && ! memcmp (SDATA (name), NAME, LEN)) \
6640 SINGLE_LETTER_MOD (alt_modifier
);
6644 MULTI_LETTER_MOD (alt_modifier
, "alt", 3);
6648 SINGLE_LETTER_MOD (ctrl_modifier
);
6652 MULTI_LETTER_MOD (ctrl_modifier
, "ctrl", 4);
6653 MULTI_LETTER_MOD (ctrl_modifier
, "control", 7);
6657 SINGLE_LETTER_MOD (hyper_modifier
);
6661 MULTI_LETTER_MOD (hyper_modifier
, "hyper", 5);
6665 SINGLE_LETTER_MOD (meta_modifier
);
6669 MULTI_LETTER_MOD (meta_modifier
, "meta", 4);
6673 SINGLE_LETTER_MOD (shift_modifier
);
6677 MULTI_LETTER_MOD (shift_modifier
, "shift", 5);
6678 MULTI_LETTER_MOD (super_modifier
, "super", 5);
6679 SINGLE_LETTER_MOD (super_modifier
);
6683 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
6684 MULTI_LETTER_MOD (down_modifier
, "down", 4);
6685 MULTI_LETTER_MOD (double_modifier
, "double", 6);
6689 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
6692 #undef SINGLE_LETTER_MOD
6693 #undef MULTI_LETTER_MOD
6699 /* Return 1 if EVENT is a list whose elements are all integers or symbols.
6700 Such a list is not valid as an event,
6701 but it can be a Lucid-style event type list. */
6704 lucid_event_type_list_p (Lisp_Object object
)
6708 if (! CONSP (object
))
6711 if (EQ (XCAR (object
), Qhelp_echo
)
6712 || EQ (XCAR (object
), Qvertical_line
)
6713 || EQ (XCAR (object
), Qmode_line
)
6714 || EQ (XCAR (object
), Qheader_line
))
6717 for (tail
= object
; CONSP (tail
); tail
= XCDR (tail
))
6721 if (! (INTEGERP (elt
) || SYMBOLP (elt
)))
6728 /* Store into *addr a value nonzero if terminal input chars are available.
6729 Serves the purpose of ioctl (0, FIONREAD, addr)
6730 but works even if FIONREAD does not exist.
6731 (In fact, this may actually read some input.)
6733 If READABLE_EVENTS_DO_TIMERS_NOW is set in FLAGS, actually run
6734 timer events that are ripe.
6735 If READABLE_EVENTS_FILTER_EVENTS is set in FLAGS, ignore internal
6736 events (FOCUS_IN_EVENT).
6737 If READABLE_EVENTS_IGNORE_SQUEEZABLES is set in FLAGS, ignore mouse
6738 movements and toolkit scroll bar thumb drags. */
6741 get_input_pending (int *addr
, int flags
)
6743 /* First of all, have we already counted some input? */
6744 *addr
= (!NILP (Vquit_flag
) || readable_events (flags
));
6746 /* If input is being read as it arrives, and we have none, there is none. */
6747 if (*addr
> 0 || (interrupt_input
&& ! interrupts_deferred
))
6750 /* Try to read some input and see how much we get. */
6752 *addr
= (!NILP (Vquit_flag
) || readable_events (flags
));
6755 /* Interface to read_avail_input, blocking SIGIO or SIGALRM if necessary. */
6758 gobble_input (int expected
)
6761 if (interrupt_input
)
6763 sigset_t blocked
, procmask
;
6764 sigemptyset (&blocked
);
6765 sigaddset (&blocked
, SIGIO
);
6766 pthread_sigmask (SIG_BLOCK
, &blocked
, &procmask
);
6767 read_avail_input (expected
);
6768 pthread_sigmask (SIG_SETMASK
, &procmask
, 0);
6771 #ifdef POLL_FOR_INPUT
6772 /* XXX This condition was (read_socket_hook && !interrupt_input),
6773 but read_socket_hook is not global anymore. Let's pretend that
6775 if (!interrupt_input
&& poll_suppress_count
== 0)
6777 sigset_t blocked
, procmask
;
6778 sigemptyset (&blocked
);
6779 sigaddset (&blocked
, SIGALRM
);
6780 pthread_sigmask (SIG_BLOCK
, &blocked
, &procmask
);
6781 read_avail_input (expected
);
6782 pthread_sigmask (SIG_SETMASK
, &procmask
, 0);
6787 read_avail_input (expected
);
6790 /* Put a BUFFER_SWITCH_EVENT in the buffer
6791 so that read_key_sequence will notice the new current buffer. */
6794 record_asynch_buffer_change (void)
6796 struct input_event event
;
6800 event
.kind
= BUFFER_SWITCH_EVENT
;
6801 event
.frame_or_window
= Qnil
;
6804 /* We don't need a buffer-switch event unless Emacs is waiting for input.
6805 The purpose of the event is to make read_key_sequence look up the
6806 keymaps again. If we aren't in read_key_sequence, we don't need one,
6807 and the event could cause trouble by messing up (input-pending-p).
6808 Note: Fwaiting_for_user_input_p always returns nil when async
6809 subprocesses aren't supported. */
6810 tem
= Fwaiting_for_user_input_p ();
6814 /* Make sure no interrupt happens while storing the event. */
6816 if (interrupt_input
)
6818 sigset_t blocked
, procmask
;
6819 sigemptyset (&blocked
);
6820 sigaddset (&blocked
, SIGIO
);
6821 pthread_sigmask (SIG_BLOCK
, &blocked
, &procmask
);
6822 kbd_buffer_store_event (&event
);
6823 pthread_sigmask (SIG_SETMASK
, &procmask
, 0);
6829 kbd_buffer_store_event (&event
);
6834 /* Read any terminal input already buffered up by the system
6835 into the kbd_buffer, but do not wait.
6837 EXPECTED should be nonzero if the caller knows there is some input.
6839 Returns the number of keyboard chars read, or -1 meaning
6840 this is a bad time to try to read input. */
6843 read_avail_input (int expected
)
6849 /* Store pending user signal events, if any. */
6850 if (store_user_signal_events ())
6853 /* Loop through the available terminals, and call their input hooks. */
6857 struct terminal
*next
= t
->next_terminal
;
6859 if (t
->read_socket_hook
)
6862 struct input_event hold_quit
;
6864 EVENT_INIT (hold_quit
);
6865 hold_quit
.kind
= NO_EVENT
;
6867 /* No need for FIONREAD or fcntl; just say don't wait. */
6868 while (nr
= (*t
->read_socket_hook
) (t
, expected
, &hold_quit
), nr
> 0)
6874 if (nr
== -1) /* Not OK to read input now. */
6878 else if (nr
== -2) /* Non-transient error. */
6880 /* The terminal device terminated; it should be closed. */
6882 /* Kill Emacs if this was our last terminal. */
6883 if (!terminal_list
->next_terminal
)
6884 /* Formerly simply reported no input, but that
6885 sometimes led to a failure of Emacs to terminate.
6886 SIGHUP seems appropriate if we can't reach the
6888 /* ??? Is it really right to send the signal just to
6889 this process rather than to the whole process
6890 group? Perhaps on systems with FIONREAD Emacs is
6891 alone in its group. */
6892 kill (getpid (), SIGHUP
);
6894 /* XXX Is calling delete_terminal safe here? It calls delete_frame. */
6897 XSETTERMINAL (tmp
, t
);
6898 Fdelete_terminal (tmp
, Qnoelisp
);
6902 if (hold_quit
.kind
!= NO_EVENT
)
6903 kbd_buffer_store_event (&hold_quit
);
6912 frame_make_pointer_visible ();
6918 decode_keyboard_code (struct tty_display_info
*tty
,
6919 struct coding_system
*coding
,
6920 unsigned char *buf
, int nbytes
)
6922 unsigned char *src
= buf
;
6923 const unsigned char *p
;
6928 if (tty
->meta_key
!= 2)
6929 for (i
= 0; i
< nbytes
; i
++)
6931 if (coding
->carryover_bytes
> 0)
6933 src
= alloca (coding
->carryover_bytes
+ nbytes
);
6934 memcpy (src
, coding
->carryover
, coding
->carryover_bytes
);
6935 memcpy (src
+ coding
->carryover_bytes
, buf
, nbytes
);
6936 nbytes
+= coding
->carryover_bytes
;
6938 coding
->destination
= alloca (nbytes
* 4);
6939 coding
->dst_bytes
= nbytes
* 4;
6940 decode_coding_c_string (coding
, src
, nbytes
, Qnil
);
6941 if (coding
->produced_char
== 0)
6943 for (i
= 0, p
= coding
->destination
; i
< coding
->produced_char
; i
++)
6945 struct input_event event_buf
;
6947 EVENT_INIT (event_buf
);
6948 event_buf
.code
= STRING_CHAR_ADVANCE (p
);
6950 (ASCII_CHAR_P (event_buf
.code
)
6951 ? ASCII_KEYSTROKE_EVENT
: MULTIBYTE_CHAR_KEYSTROKE_EVENT
);
6952 /* See the comment in tty_read_avail_input. */
6953 event_buf
.frame_or_window
= tty
->top_frame
;
6954 event_buf
.arg
= Qnil
;
6955 kbd_buffer_store_event (&event_buf
);
6959 /* This is the tty way of reading available input.
6961 Note that each terminal device has its own `struct terminal' object,
6962 and so this function is called once for each individual termcap
6963 terminal. The first parameter indicates which terminal to read from. */
6966 tty_read_avail_input (struct terminal
*terminal
,
6968 struct input_event
*hold_quit
)
6970 /* Using KBD_BUFFER_SIZE - 1 here avoids reading more than
6971 the kbd_buffer can really hold. That may prevent loss
6972 of characters on some systems when input is stuffed at us. */
6973 unsigned char cbuf
[KBD_BUFFER_SIZE
- 1];
6975 struct tty_display_info
*tty
= terminal
->display_info
.tty
;
6978 int buffer_free
= KBD_BUFFER_SIZE
- kbd_buffer_nr_stored () - 1;
6980 if (kbd_on_hold_p () || buffer_free
<= 0)
6982 #endif /* subprocesses */
6984 if (!terminal
->name
) /* Don't read from a dead terminal. */
6987 if (terminal
->type
!= output_termcap
6988 && terminal
->type
!= output_msdos_raw
)
6991 /* XXX I think the following code should be moved to separate hook
6992 functions in system-dependent files. */
6995 #else /* not WINDOWSNT */
6996 if (! tty
->term_initted
) /* In case we get called during bootstrap. */
7000 return 0; /* The terminal is suspended. */
7003 n_to_read
= dos_keysns ();
7007 cbuf
[0] = dos_keyread ();
7010 #else /* not MSDOS */
7015 struct input_event gpm_hold_quit
;
7016 int gpm
, fd
= gpm_fd
;
7018 EVENT_INIT (gpm_hold_quit
);
7019 gpm_hold_quit
.kind
= NO_EVENT
;
7021 /* gpm==1 if event received.
7022 gpm==0 if the GPM daemon has closed the connection, in which case
7023 Gpm_GetEvent closes gpm_fd and clears it to -1, which is why
7024 we save it in `fd' so close_gpm can remove it from the
7026 gpm==-1 if a protocol error or EWOULDBLOCK; the latter is normal. */
7027 while (gpm
= Gpm_GetEvent (&event
), gpm
== 1) {
7028 nread
+= handle_one_term_event (tty
, &event
, &gpm_hold_quit
);
7031 /* Presumably the GPM daemon has closed the connection. */
7033 if (gpm_hold_quit
.kind
!= NO_EVENT
)
7034 kbd_buffer_store_event (&gpm_hold_quit
);
7038 #endif /* HAVE_GPM */
7040 /* Determine how many characters we should *try* to read. */
7041 #ifdef USABLE_FIONREAD
7042 /* Find out how much input is available. */
7043 if (ioctl (fileno (tty
->input
), FIONREAD
, &n_to_read
) < 0)
7045 if (! noninteractive
)
7046 return -2; /* Close this terminal. */
7052 if (n_to_read
> sizeof cbuf
)
7053 n_to_read
= sizeof cbuf
;
7054 #elif defined USG || defined CYGWIN
7055 /* Read some input if available, but don't wait. */
7056 n_to_read
= sizeof cbuf
;
7057 fcntl (fileno (tty
->input
), F_SETFL
, O_NDELAY
);
7059 # error "Cannot read without possibly delaying"
7063 /* Don't read more than we can store. */
7064 if (n_to_read
> buffer_free
)
7065 n_to_read
= buffer_free
;
7066 #endif /* subprocesses */
7068 /* Now read; for one reason or another, this will not block.
7069 NREAD is set to the number of chars read. */
7072 nread
= emacs_read (fileno (tty
->input
), (char *) cbuf
, n_to_read
);
7073 /* POSIX infers that processes which are not in the session leader's
7074 process group won't get SIGHUP's at logout time. BSDI adheres to
7075 this part standard and returns -1 from read (0) with errno==EIO
7076 when the control tty is taken away.
7077 Jeffrey Honig <jch@bsdi.com> says this is generally safe. */
7078 if (nread
== -1 && errno
== EIO
)
7079 return -2; /* Close this terminal. */
7080 #if defined (AIX) && defined (_BSD)
7081 /* The kernel sometimes fails to deliver SIGHUP for ptys.
7082 This looks incorrect, but it isn't, because _BSD causes
7083 O_NDELAY to be defined in fcntl.h as O_NONBLOCK,
7084 and that causes a value other than 0 when there is no input. */
7086 return -2; /* Close this terminal. */
7090 /* We used to retry the read if it was interrupted.
7091 But this does the wrong thing when O_NDELAY causes
7092 an EAGAIN error. Does anybody know of a situation
7093 where a retry is actually needed? */
7095 nread
< 0 && (errno
== EAGAIN
7108 #ifndef USABLE_FIONREAD
7109 #if defined (USG) || defined (CYGWIN)
7110 fcntl (fileno (tty
->input
), F_SETFL
, 0);
7111 #endif /* USG or CYGWIN */
7112 #endif /* no FIONREAD */
7117 #endif /* not MSDOS */
7118 #endif /* not WINDOWSNT */
7120 if (TERMINAL_KEYBOARD_CODING (terminal
)->common_flags
7121 & CODING_REQUIRE_DECODING_MASK
)
7123 struct coding_system
*coding
= TERMINAL_KEYBOARD_CODING (terminal
);
7126 /* Decode the key sequence except for those with meta
7128 for (i
= from
= 0; ; i
++)
7129 if (i
== nread
|| (tty
->meta_key
== 1 && (cbuf
[i
] & 0x80)))
7131 struct input_event buf
;
7133 decode_keyboard_code (tty
, coding
, cbuf
+ from
, i
- from
);
7138 buf
.kind
= ASCII_KEYSTROKE_EVENT
;
7139 buf
.modifiers
= meta_modifier
;
7140 buf
.code
= cbuf
[i
] & ~0x80;
7141 /* See the comment below. */
7142 buf
.frame_or_window
= tty
->top_frame
;
7144 kbd_buffer_store_event (&buf
);
7150 for (i
= 0; i
< nread
; i
++)
7152 struct input_event buf
;
7154 buf
.kind
= ASCII_KEYSTROKE_EVENT
;
7156 if (tty
->meta_key
== 1 && (cbuf
[i
] & 0x80))
7157 buf
.modifiers
= meta_modifier
;
7158 if (tty
->meta_key
!= 2)
7162 /* Set the frame corresponding to the active tty. Note that the
7163 value of selected_frame is not reliable here, redisplay tends
7164 to temporarily change it. */
7165 buf
.frame_or_window
= tty
->top_frame
;
7168 kbd_buffer_store_event (&buf
);
7169 /* Don't look at input that follows a C-g too closely.
7170 This reduces lossage due to autorepeat on C-g. */
7171 if (buf
.kind
== ASCII_KEYSTROKE_EVENT
7172 && buf
.code
== quit_char
)
7179 #if defined SYNC_INPUT || defined USABLE_SIGIO
7181 handle_async_input (void)
7183 interrupt_input_pending
= 0;
7185 pending_signals
= pending_atimers
;
7187 /* Tell ns_read_socket() it is being called asynchronously so it can avoid
7188 doing anything dangerous. */
7195 nread
= read_avail_input (1);
7196 /* -1 means it's not ok to read the input now.
7197 UNBLOCK_INPUT will read it later; now, avoid infinite loop.
7198 0 means there was no keyboard input available. */
7206 #endif /* SYNC_INPUT || USABLE_SIGIO */
7210 process_pending_signals (void)
7212 if (interrupt_input_pending
)
7213 handle_async_input ();
7214 do_pending_atimers ();
7221 handle_input_available_signal (int sig
)
7224 interrupt_input_pending
= 1;
7225 pending_signals
= 1;
7228 if (input_available_clear_time
)
7229 *input_available_clear_time
= make_emacs_time (0, 0);
7232 handle_async_input ();
7237 deliver_input_available_signal (int sig
)
7239 handle_on_main_thread (sig
, handle_input_available_signal
);
7241 #endif /* USABLE_SIGIO */
7243 /* Send ourselves a SIGIO.
7245 This function exists so that the UNBLOCK_INPUT macro in
7246 blockinput.h can have some way to take care of input we put off
7247 dealing with, without assuming that every file which uses
7248 UNBLOCK_INPUT also has #included the files necessary to get SIGIO. */
7250 reinvoke_input_signal (void)
7253 handle_async_input ();
7259 /* User signal events. */
7261 struct user_signal_info
7263 /* Signal number. */
7266 /* Name of the signal. */
7269 /* Number of pending signals. */
7272 struct user_signal_info
*next
;
7275 /* List of user signals. */
7276 static struct user_signal_info
*user_signals
= NULL
;
7279 add_user_signal (int sig
, const char *name
)
7281 struct sigaction action
;
7282 struct user_signal_info
*p
;
7284 for (p
= user_signals
; p
; p
= p
->next
)
7286 /* Already added. */
7289 p
= xmalloc (sizeof *p
);
7291 p
->name
= xstrdup (name
);
7293 p
->next
= user_signals
;
7296 emacs_sigaction_init (&action
, deliver_user_signal
);
7297 sigaction (sig
, &action
, 0);
7301 handle_user_signal (int sig
)
7303 struct user_signal_info
*p
;
7304 const char *special_event_name
= NULL
;
7306 if (SYMBOLP (Vdebug_on_event
))
7307 special_event_name
= SSDATA (SYMBOL_NAME (Vdebug_on_event
));
7309 for (p
= user_signals
; p
; p
= p
->next
)
7312 if (special_event_name
7313 && strcmp (special_event_name
, p
->name
) == 0)
7315 /* Enter the debugger in many ways. */
7316 debug_on_next_call
= 1;
7319 Vinhibit_quit
= Qnil
;
7321 /* Eat the event. */
7327 if (interrupt_input
)
7328 kill (getpid (), SIGIO
);
7332 /* Tell wait_reading_process_output that it needs to wake
7333 up and look around. */
7334 if (input_available_clear_time
)
7335 *input_available_clear_time
= make_emacs_time (0, 0);
7342 deliver_user_signal (int sig
)
7344 handle_on_main_thread (sig
, handle_user_signal
);
7348 find_user_signal_name (int sig
)
7350 struct user_signal_info
*p
;
7352 for (p
= user_signals
; p
; p
= p
->next
)
7360 store_user_signal_events (void)
7362 struct user_signal_info
*p
;
7363 struct input_event buf
;
7366 for (p
= user_signals
; p
; p
= p
->next
)
7367 if (p
->npending
> 0)
7369 sigset_t blocked
, procmask
;
7373 memset (&buf
, 0, sizeof buf
);
7374 buf
.kind
= USER_SIGNAL_EVENT
;
7375 buf
.frame_or_window
= selected_frame
;
7377 nstored
+= p
->npending
;
7379 sigemptyset (&blocked
);
7380 sigaddset (&blocked
, p
->sig
);
7381 pthread_sigmask (SIG_BLOCK
, &blocked
, &procmask
);
7386 kbd_buffer_store_event (&buf
);
7389 while (p
->npending
> 0);
7391 pthread_sigmask (SIG_SETMASK
, &procmask
, 0);
7398 static void menu_bar_item (Lisp_Object
, Lisp_Object
, Lisp_Object
, void*);
7399 static Lisp_Object menu_bar_one_keymap_changed_items
;
7401 /* These variables hold the vector under construction within
7402 menu_bar_items and its subroutines, and the current index
7403 for storing into that vector. */
7404 static Lisp_Object menu_bar_items_vector
;
7405 static int menu_bar_items_index
;
7408 static const char* separator_names
[] = {
7413 "single-dashed-line",
7414 "double-dashed-line",
7416 "shadow-etched-out",
7417 "shadow-etched-in-dash",
7418 "shadow-etched-out-dash",
7419 "shadow-double-etched-in",
7420 "shadow-double-etched-out",
7421 "shadow-double-etched-in-dash",
7422 "shadow-double-etched-out-dash",
7426 /* Return non-zero if LABEL specifies a separator. */
7429 menu_separator_name_p (const char *label
)
7433 else if (strlen (label
) > 3
7434 && memcmp (label
, "--", 2) == 0
7439 for (i
= 0; separator_names
[i
]; ++i
)
7440 if (strcmp (label
, separator_names
[i
]) == 0)
7445 /* It's a separator if it contains only dashes. */
7446 while (*label
== '-')
7448 return (*label
== 0);
7455 /* Return a vector of menu items for a menu bar, appropriate
7456 to the current buffer. Each item has three elements in the vector:
7459 OLD is an old vector we can optionally reuse, or nil. */
7462 menu_bar_items (Lisp_Object old
)
7464 /* The number of keymaps we're scanning right now, and the number of
7465 keymaps we have allocated space for. */
7468 /* maps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
7469 in the current keymaps, or nil where it is not a prefix. */
7472 Lisp_Object def
, tail
;
7477 /* In order to build the menus, we need to call the keymap
7478 accessors. They all call QUIT. But this function is called
7479 during redisplay, during which a quit is fatal. So inhibit
7480 quitting while building the menus.
7481 We do this instead of specbind because (1) errors will clear it anyway
7482 and (2) this avoids risk of specpdl overflow. */
7483 oquit
= Vinhibit_quit
;
7487 menu_bar_items_vector
= old
;
7489 menu_bar_items_vector
= Fmake_vector (make_number (24), Qnil
);
7490 menu_bar_items_index
= 0;
7492 /* Build our list of keymaps.
7493 If we recognize a function key and replace its escape sequence in
7494 keybuf with its symbol, or if the sequence starts with a mouse
7495 click and we need to switch buffers, we jump back here to rebuild
7496 the initial keymaps from the current buffer. */
7500 /* Should overriding-terminal-local-map and overriding-local-map apply? */
7501 if (!NILP (Voverriding_local_map_menu_flag
))
7503 /* Yes, use them (if non-nil) as well as the global map. */
7504 maps
= alloca (3 * sizeof (maps
[0]));
7506 if (!NILP (KVAR (current_kboard
, Voverriding_terminal_local_map
)))
7507 maps
[nmaps
++] = KVAR (current_kboard
, Voverriding_terminal_local_map
);
7508 if (!NILP (Voverriding_local_map
))
7509 maps
[nmaps
++] = Voverriding_local_map
;
7513 /* No, so use major and minor mode keymaps and keymap property.
7514 Note that menu-bar bindings in the local-map and keymap
7515 properties may not work reliable, as they are only
7516 recognized when the menu-bar (or mode-line) is updated,
7517 which does not normally happen after every command. */
7520 nminor
= current_minor_maps (NULL
, &tmaps
);
7521 maps
= alloca ((nminor
+ 3) * sizeof *maps
);
7523 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
7524 maps
[nmaps
++] = tem
;
7525 memcpy (maps
+ nmaps
, tmaps
, nminor
* sizeof (maps
[0]));
7527 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
7529 maps
[nmaps
++] = current_global_map
;
7532 /* Look up in each map the dummy prefix key `menu-bar'. */
7534 for (mapno
= nmaps
- 1; mapno
>= 0; mapno
--)
7535 if (!NILP (maps
[mapno
]))
7537 def
= get_keymap (access_keymap (maps
[mapno
], Qmenu_bar
, 1, 0, 1),
7541 menu_bar_one_keymap_changed_items
= Qnil
;
7542 map_keymap_canonical (def
, menu_bar_item
, Qnil
, NULL
);
7546 /* Move to the end those items that should be at the end. */
7548 for (tail
= Vmenu_bar_final_items
; CONSP (tail
); tail
= XCDR (tail
))
7551 int end
= menu_bar_items_index
;
7553 for (i
= 0; i
< end
; i
+= 4)
7554 if (EQ (XCAR (tail
), AREF (menu_bar_items_vector
, i
)))
7556 Lisp_Object tem0
, tem1
, tem2
, tem3
;
7557 /* Move the item at index I to the end,
7558 shifting all the others forward. */
7559 tem0
= AREF (menu_bar_items_vector
, i
+ 0);
7560 tem1
= AREF (menu_bar_items_vector
, i
+ 1);
7561 tem2
= AREF (menu_bar_items_vector
, i
+ 2);
7562 tem3
= AREF (menu_bar_items_vector
, i
+ 3);
7564 memmove (aref_addr (menu_bar_items_vector
, i
),
7565 aref_addr (menu_bar_items_vector
, i
+ 4),
7566 (end
- i
- 4) * word_size
);
7567 ASET (menu_bar_items_vector
, end
- 4, tem0
);
7568 ASET (menu_bar_items_vector
, end
- 3, tem1
);
7569 ASET (menu_bar_items_vector
, end
- 2, tem2
);
7570 ASET (menu_bar_items_vector
, end
- 1, tem3
);
7575 /* Add nil, nil, nil, nil at the end. */
7577 int i
= menu_bar_items_index
;
7578 if (i
+ 4 > ASIZE (menu_bar_items_vector
))
7579 menu_bar_items_vector
=
7580 larger_vector (menu_bar_items_vector
, 4, -1);
7581 /* Add this item. */
7582 ASET (menu_bar_items_vector
, i
, Qnil
); i
++;
7583 ASET (menu_bar_items_vector
, i
, Qnil
); i
++;
7584 ASET (menu_bar_items_vector
, i
, Qnil
); i
++;
7585 ASET (menu_bar_items_vector
, i
, Qnil
); i
++;
7586 menu_bar_items_index
= i
;
7589 Vinhibit_quit
= oquit
;
7590 return menu_bar_items_vector
;
7593 /* Add one item to menu_bar_items_vector, for KEY, ITEM_STRING and DEF.
7594 If there's already an item for KEY, add this DEF to it. */
7596 Lisp_Object item_properties
;
7599 menu_bar_item (Lisp_Object key
, Lisp_Object item
, Lisp_Object dummy1
, void *dummy2
)
7601 struct gcpro gcpro1
;
7605 if (EQ (item
, Qundefined
))
7607 /* If a map has an explicit `undefined' as definition,
7608 discard any previously made menu bar item. */
7610 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7611 if (EQ (key
, AREF (menu_bar_items_vector
, i
)))
7613 if (menu_bar_items_index
> i
+ 4)
7614 memmove (aref_addr (menu_bar_items_vector
, i
),
7615 aref_addr (menu_bar_items_vector
, i
+ 4),
7616 (menu_bar_items_index
- i
- 4) * word_size
);
7617 menu_bar_items_index
-= 4;
7621 /* If this keymap has already contributed to this KEY,
7622 don't contribute to it a second time. */
7623 tem
= Fmemq (key
, menu_bar_one_keymap_changed_items
);
7624 if (!NILP (tem
) || NILP (item
))
7627 menu_bar_one_keymap_changed_items
7628 = Fcons (key
, menu_bar_one_keymap_changed_items
);
7630 /* We add to menu_bar_one_keymap_changed_items before doing the
7631 parse_menu_item, so that if it turns out it wasn't a menu item,
7632 it still correctly hides any further menu item. */
7634 i
= parse_menu_item (item
, 1);
7639 item
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7641 /* Find any existing item for this KEY. */
7642 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7643 if (EQ (key
, AREF (menu_bar_items_vector
, i
)))
7646 /* If we did not find this KEY, add it at the end. */
7647 if (i
== menu_bar_items_index
)
7649 /* If vector is too small, get a bigger one. */
7650 if (i
+ 4 > ASIZE (menu_bar_items_vector
))
7651 menu_bar_items_vector
= larger_vector (menu_bar_items_vector
, 4, -1);
7652 /* Add this item. */
7653 ASET (menu_bar_items_vector
, i
, key
); i
++;
7654 ASET (menu_bar_items_vector
, i
,
7655 AREF (item_properties
, ITEM_PROPERTY_NAME
)); i
++;
7656 ASET (menu_bar_items_vector
, i
, Fcons (item
, Qnil
)); i
++;
7657 ASET (menu_bar_items_vector
, i
, make_number (0)); i
++;
7658 menu_bar_items_index
= i
;
7660 /* We did find an item for this KEY. Add ITEM to its list of maps. */
7664 old
= AREF (menu_bar_items_vector
, i
+ 2);
7665 /* If the new and the old items are not both keymaps,
7666 the lookup will only find `item'. */
7667 item
= Fcons (item
, KEYMAPP (item
) && KEYMAPP (XCAR (old
)) ? old
: Qnil
);
7668 ASET (menu_bar_items_vector
, i
+ 2, item
);
7672 /* This is used as the handler when calling menu_item_eval_property. */
7674 menu_item_eval_property_1 (Lisp_Object arg
)
7676 /* If we got a quit from within the menu computation,
7677 quit all the way out of it. This takes care of C-] in the debugger. */
7678 if (CONSP (arg
) && EQ (XCAR (arg
), Qquit
))
7679 Fsignal (Qquit
, Qnil
);
7685 eval_dyn (Lisp_Object form
)
7687 return Feval (form
, Qnil
);
7690 /* Evaluate an expression and return the result (or nil if something
7691 went wrong). Used to evaluate dynamic parts of menu items. */
7693 menu_item_eval_property (Lisp_Object sexpr
)
7695 ptrdiff_t count
= SPECPDL_INDEX ();
7697 specbind (Qinhibit_redisplay
, Qt
);
7698 val
= internal_condition_case_1 (eval_dyn
, sexpr
, Qerror
,
7699 menu_item_eval_property_1
);
7700 return unbind_to (count
, val
);
7703 /* This function parses a menu item and leaves the result in the
7704 vector item_properties.
7705 ITEM is a key binding, a possible menu item.
7706 INMENUBAR is > 0 when this is considered for an entry in a menu bar
7708 INMENUBAR is < 0 when this is considered for an entry in a keyboard menu.
7709 parse_menu_item returns true if the item is a menu item and false
7713 parse_menu_item (Lisp_Object item
, int inmenubar
)
7715 Lisp_Object def
, tem
, item_string
, start
;
7717 Lisp_Object keyhint
;
7726 /* Create item_properties vector if necessary. */
7727 if (NILP (item_properties
))
7729 = Fmake_vector (make_number (ITEM_PROPERTY_ENABLE
+ 1), Qnil
);
7731 /* Initialize optional entries. */
7732 for (i
= ITEM_PROPERTY_DEF
; i
< ITEM_PROPERTY_ENABLE
; i
++)
7733 ASET (item_properties
, i
, Qnil
);
7734 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7736 /* Save the item here to protect it from GC. */
7737 ASET (item_properties
, ITEM_PROPERTY_ITEM
, item
);
7739 item_string
= XCAR (item
);
7743 if (STRINGP (item_string
))
7745 /* Old format menu item. */
7746 ASET (item_properties
, ITEM_PROPERTY_NAME
, item_string
);
7748 /* Maybe help string. */
7749 if (CONSP (item
) && STRINGP (XCAR (item
)))
7751 ASET (item_properties
, ITEM_PROPERTY_HELP
, XCAR (item
));
7756 /* Maybe an obsolete key binding cache. */
7757 if (CONSP (item
) && CONSP (XCAR (item
))
7758 && (NILP (XCAR (XCAR (item
)))
7759 || VECTORP (XCAR (XCAR (item
)))))
7762 /* This is the real definition--the function to run. */
7763 ASET (item_properties
, ITEM_PROPERTY_DEF
, item
);
7765 /* Get enable property, if any. */
7768 tem
= Fget (item
, Qmenu_enable
);
7769 if (!NILP (Venable_disabled_menus_and_buttons
))
7770 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7771 else if (!NILP (tem
))
7772 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, tem
);
7775 else if (EQ (item_string
, Qmenu_item
) && CONSP (item
))
7777 /* New format menu item. */
7778 ASET (item_properties
, ITEM_PROPERTY_NAME
, XCAR (item
));
7779 start
= XCDR (item
);
7782 /* We have a real binding. */
7783 ASET (item_properties
, ITEM_PROPERTY_DEF
, XCAR (start
));
7785 item
= XCDR (start
);
7786 /* Is there an obsolete cache list with key equivalences. */
7787 if (CONSP (item
) && CONSP (XCAR (item
)))
7790 /* Parse properties. */
7791 while (CONSP (item
) && CONSP (XCDR (item
)))
7796 if (EQ (tem
, QCenable
))
7798 if (!NILP (Venable_disabled_menus_and_buttons
))
7799 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7801 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, XCAR (item
));
7803 else if (EQ (tem
, QCvisible
))
7805 /* If got a visible property and that evaluates to nil
7806 then ignore this item. */
7807 tem
= menu_item_eval_property (XCAR (item
));
7811 else if (EQ (tem
, QChelp
))
7812 ASET (item_properties
, ITEM_PROPERTY_HELP
, XCAR (item
));
7813 else if (EQ (tem
, QCfilter
))
7815 else if (EQ (tem
, QCkey_sequence
))
7818 if (SYMBOLP (tem
) || STRINGP (tem
) || VECTORP (tem
))
7819 /* Be GC protected. Set keyhint to item instead of tem. */
7822 else if (EQ (tem
, QCkeys
))
7825 if (CONSP (tem
) || STRINGP (tem
))
7826 ASET (item_properties
, ITEM_PROPERTY_KEYEQ
, tem
);
7828 else if (EQ (tem
, QCbutton
) && CONSP (XCAR (item
)))
7833 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
7835 ASET (item_properties
, ITEM_PROPERTY_SELECTED
,
7837 ASET (item_properties
, ITEM_PROPERTY_TYPE
, type
);
7843 else if (inmenubar
|| !NILP (start
))
7847 return 0; /* not a menu item */
7849 /* If item string is not a string, evaluate it to get string.
7850 If we don't get a string, skip this item. */
7851 item_string
= AREF (item_properties
, ITEM_PROPERTY_NAME
);
7852 if (!(STRINGP (item_string
)))
7854 item_string
= menu_item_eval_property (item_string
);
7855 if (!STRINGP (item_string
))
7857 ASET (item_properties
, ITEM_PROPERTY_NAME
, item_string
);
7860 /* If got a filter apply it on definition. */
7861 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7864 def
= menu_item_eval_property (list2 (XCAR (filter
),
7865 list2 (Qquote
, def
)));
7867 ASET (item_properties
, ITEM_PROPERTY_DEF
, def
);
7870 /* Enable or disable selection of item. */
7871 tem
= AREF (item_properties
, ITEM_PROPERTY_ENABLE
);
7874 tem
= menu_item_eval_property (tem
);
7875 if (inmenubar
&& NILP (tem
))
7876 return 0; /* Ignore disabled items in menu bar. */
7877 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, tem
);
7880 /* If we got no definition, this item is just unselectable text which
7881 is OK in a submenu but not in the menubar. */
7883 return (!inmenubar
);
7885 /* See if this is a separate pane or a submenu. */
7886 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7887 tem
= get_keymap (def
, 0, 1);
7888 /* For a subkeymap, just record its details and exit. */
7891 ASET (item_properties
, ITEM_PROPERTY_MAP
, tem
);
7892 ASET (item_properties
, ITEM_PROPERTY_DEF
, tem
);
7896 /* At the top level in the menu bar, do likewise for commands also.
7897 The menu bar does not display equivalent key bindings anyway.
7898 ITEM_PROPERTY_DEF is already set up properly. */
7902 { /* This is a command. See if there is an equivalent key binding. */
7903 Lisp_Object keyeq
= AREF (item_properties
, ITEM_PROPERTY_KEYEQ
);
7905 /* The previous code preferred :key-sequence to :keys, so we
7906 preserve this behavior. */
7907 if (STRINGP (keyeq
) && !CONSP (keyhint
))
7908 keyeq
= concat2 (build_string (" "), Fsubstitute_command_keys (keyeq
));
7911 Lisp_Object prefix
= keyeq
;
7912 Lisp_Object keys
= Qnil
;
7916 def
= XCAR (prefix
);
7917 prefix
= XCDR (prefix
);
7920 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7922 if (CONSP (keyhint
) && !NILP (XCAR (keyhint
)))
7924 keys
= XCAR (keyhint
);
7925 tem
= Fkey_binding (keys
, Qnil
, Qnil
, Qnil
);
7927 /* We have a suggested key. Is it bound to the command? */
7930 /* If the command is an alias for another
7931 (such as lmenu.el set it up), check if the
7932 original command matches the cached command. */
7934 && EQ (tem
, XSYMBOL (def
)->function
))))
7939 keys
= Fwhere_is_internal (def
, Qnil
, Qt
, Qnil
, Qnil
);
7943 tem
= Fkey_description (keys
, Qnil
);
7946 if (STRINGP (XCAR (prefix
)))
7947 tem
= concat2 (XCAR (prefix
), tem
);
7948 if (STRINGP (XCDR (prefix
)))
7949 tem
= concat2 (tem
, XCDR (prefix
));
7951 keyeq
= concat2 (build_string (" "), tem
);
7952 /* keyeq = concat3(build_string(" ("),tem,build_string(")")); */
7958 /* If we have an equivalent key binding, use that. */
7959 ASET (item_properties
, ITEM_PROPERTY_KEYEQ
, keyeq
);
7962 /* Include this when menu help is implemented.
7963 tem = XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP];
7964 if (!(NILP (tem) || STRINGP (tem)))
7966 tem = menu_item_eval_property (tem);
7969 XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP] = tem;
7973 /* Handle radio buttons or toggle boxes. */
7974 tem
= AREF (item_properties
, ITEM_PROPERTY_SELECTED
);
7976 ASET (item_properties
, ITEM_PROPERTY_SELECTED
,
7977 menu_item_eval_property (tem
));
7984 /***********************************************************************
7986 ***********************************************************************/
7988 /* A vector holding tool bar items while they are parsed in function
7989 tool_bar_items. Each item occupies TOOL_BAR_ITEM_NSCLOTS elements
7992 static Lisp_Object tool_bar_items_vector
;
7994 /* A vector holding the result of parse_tool_bar_item. Layout is like
7995 the one for a single item in tool_bar_items_vector. */
7997 static Lisp_Object tool_bar_item_properties
;
7999 /* Next free index in tool_bar_items_vector. */
8001 static int ntool_bar_items
;
8003 /* The symbols `:image' and `:rtl'. */
8005 static Lisp_Object QCimage
;
8006 static Lisp_Object QCrtl
;
8008 /* Function prototypes. */
8010 static void init_tool_bar_items (Lisp_Object
);
8011 static void process_tool_bar_item (Lisp_Object
, Lisp_Object
, Lisp_Object
, void*);
8012 static int parse_tool_bar_item (Lisp_Object
, Lisp_Object
);
8013 static void append_tool_bar_item (void);
8016 /* Return a vector of tool bar items for keymaps currently in effect.
8017 Reuse vector REUSE if non-nil. Return in *NITEMS the number of
8018 tool bar items found. */
8021 tool_bar_items (Lisp_Object reuse
, int *nitems
)
8030 /* In order to build the menus, we need to call the keymap
8031 accessors. They all call QUIT. But this function is called
8032 during redisplay, during which a quit is fatal. So inhibit
8033 quitting while building the menus. We do this instead of
8034 specbind because (1) errors will clear it anyway and (2) this
8035 avoids risk of specpdl overflow. */
8036 oquit
= Vinhibit_quit
;
8039 /* Initialize tool_bar_items_vector and protect it from GC. */
8040 init_tool_bar_items (reuse
);
8042 /* Build list of keymaps in maps. Set nmaps to the number of maps
8045 /* Should overriding-terminal-local-map and overriding-local-map apply? */
8046 if (!NILP (Voverriding_local_map_menu_flag
))
8048 /* Yes, use them (if non-nil) as well as the global map. */
8049 maps
= alloca (3 * sizeof *maps
);
8051 if (!NILP (KVAR (current_kboard
, Voverriding_terminal_local_map
)))
8052 maps
[nmaps
++] = KVAR (current_kboard
, Voverriding_terminal_local_map
);
8053 if (!NILP (Voverriding_local_map
))
8054 maps
[nmaps
++] = Voverriding_local_map
;
8058 /* No, so use major and minor mode keymaps and keymap property.
8059 Note that tool-bar bindings in the local-map and keymap
8060 properties may not work reliable, as they are only
8061 recognized when the tool-bar (or mode-line) is updated,
8062 which does not normally happen after every command. */
8065 nminor
= current_minor_maps (NULL
, &tmaps
);
8066 maps
= alloca ((nminor
+ 3) * sizeof *maps
);
8068 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
8069 maps
[nmaps
++] = tem
;
8070 memcpy (maps
+ nmaps
, tmaps
, nminor
* sizeof (maps
[0]));
8072 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
8075 /* Add global keymap at the end. */
8076 maps
[nmaps
++] = current_global_map
;
8078 /* Process maps in reverse order and look up in each map the prefix
8080 for (i
= nmaps
- 1; i
>= 0; --i
)
8081 if (!NILP (maps
[i
]))
8085 keymap
= get_keymap (access_keymap (maps
[i
], Qtool_bar
, 1, 0, 1), 0, 1);
8087 map_keymap (keymap
, process_tool_bar_item
, Qnil
, NULL
, 1);
8090 Vinhibit_quit
= oquit
;
8091 *nitems
= ntool_bar_items
/ TOOL_BAR_ITEM_NSLOTS
;
8092 return tool_bar_items_vector
;
8096 /* Process the definition of KEY which is DEF. */
8099 process_tool_bar_item (Lisp_Object key
, Lisp_Object def
, Lisp_Object data
, void *args
)
8102 struct gcpro gcpro1
, gcpro2
;
8104 /* Protect KEY and DEF from GC because parse_tool_bar_item may call
8108 if (EQ (def
, Qundefined
))
8110 /* If a map has an explicit `undefined' as definition,
8111 discard any previously made item. */
8112 for (i
= 0; i
< ntool_bar_items
; i
+= TOOL_BAR_ITEM_NSLOTS
)
8114 Lisp_Object
*v
= XVECTOR (tool_bar_items_vector
)->contents
+ i
;
8116 if (EQ (key
, v
[TOOL_BAR_ITEM_KEY
]))
8118 if (ntool_bar_items
> i
+ TOOL_BAR_ITEM_NSLOTS
)
8119 memmove (v
, v
+ TOOL_BAR_ITEM_NSLOTS
,
8120 ((ntool_bar_items
- i
- TOOL_BAR_ITEM_NSLOTS
)
8122 ntool_bar_items
-= TOOL_BAR_ITEM_NSLOTS
;
8127 else if (parse_tool_bar_item (key
, def
))
8128 /* Append a new tool bar item to tool_bar_items_vector. Accept
8129 more than one definition for the same key. */
8130 append_tool_bar_item ();
8135 /* Access slot with index IDX of vector tool_bar_item_properties. */
8136 #define PROP(IDX) AREF (tool_bar_item_properties, (IDX))
8138 set_prop (ptrdiff_t idx
, Lisp_Object val
)
8140 ASET (tool_bar_item_properties
, idx
, val
);
8144 /* Parse a tool bar item specification ITEM for key KEY and return the
8145 result in tool_bar_item_properties. Value is zero if ITEM is
8148 ITEM is a list `(menu-item CAPTION BINDING PROPS...)'.
8150 CAPTION is the caption of the item, If it's not a string, it is
8151 evaluated to get a string.
8153 BINDING is the tool bar item's binding. Tool-bar items with keymaps
8154 as binding are currently ignored.
8156 The following properties are recognized:
8160 FORM is evaluated and specifies whether the tool bar item is
8161 enabled or disabled.
8165 FORM is evaluated and specifies whether the tool bar item is visible.
8167 - `:filter FUNCTION'
8169 FUNCTION is invoked with one parameter `(quote BINDING)'. Its
8170 result is stored as the new binding.
8172 - `:button (TYPE SELECTED)'
8174 TYPE must be one of `:radio' or `:toggle'. SELECTED is evaluated
8175 and specifies whether the button is selected (pressed) or not.
8179 IMAGES is either a single image specification or a vector of four
8180 image specifications. See enum tool_bar_item_images.
8182 - `:help HELP-STRING'.
8184 Gives a help string to display for the tool bar item.
8186 - `:label LABEL-STRING'.
8188 A text label to show with the tool bar button if labels are enabled. */
8191 parse_tool_bar_item (Lisp_Object key
, Lisp_Object item
)
8193 Lisp_Object filter
= Qnil
;
8194 Lisp_Object caption
;
8195 int i
, have_label
= 0;
8197 /* Definition looks like `(menu-item CAPTION BINDING PROPS...)'.
8198 Rule out items that aren't lists, don't start with
8199 `menu-item' or whose rest following `tool-bar-item' is not a
8204 /* As an exception, allow old-style menu separators. */
8205 if (STRINGP (XCAR (item
)))
8206 item
= Fcons (XCAR (item
), Qnil
);
8207 else if (!EQ (XCAR (item
), Qmenu_item
)
8208 || (item
= XCDR (item
), !CONSP (item
)))
8211 /* Create tool_bar_item_properties vector if necessary. Reset it to
8213 if (VECTORP (tool_bar_item_properties
))
8215 for (i
= 0; i
< TOOL_BAR_ITEM_NSLOTS
; ++i
)
8219 tool_bar_item_properties
8220 = Fmake_vector (make_number (TOOL_BAR_ITEM_NSLOTS
), Qnil
);
8223 set_prop (TOOL_BAR_ITEM_KEY
, key
);
8224 set_prop (TOOL_BAR_ITEM_ENABLED_P
, Qt
);
8226 /* Get the caption of the item. If the caption is not a string,
8227 evaluate it to get a string. If we don't get a string, skip this
8229 caption
= XCAR (item
);
8230 if (!STRINGP (caption
))
8232 caption
= menu_item_eval_property (caption
);
8233 if (!STRINGP (caption
))
8236 set_prop (TOOL_BAR_ITEM_CAPTION
, caption
);
8238 /* If the rest following the caption is not a list, the menu item is
8239 either a separator, or invalid. */
8243 if (menu_separator_name_p (SSDATA (caption
)))
8245 set_prop (TOOL_BAR_ITEM_TYPE
, Qt
);
8246 #if !defined (USE_GTK) && !defined (HAVE_NS)
8247 /* If we use build_desired_tool_bar_string to render the
8248 tool bar, the separator is rendered as an image. */
8249 PROP (TOOL_BAR_ITEM_IMAGES
)
8250 = menu_item_eval_property (Vtool_bar_separator_image_expression
);
8251 PROP (TOOL_BAR_ITEM_ENABLED_P
) = Qnil
;
8252 PROP (TOOL_BAR_ITEM_SELECTED_P
) = Qnil
;
8253 PROP (TOOL_BAR_ITEM_CAPTION
) = Qnil
;
8260 /* Store the binding. */
8261 set_prop (TOOL_BAR_ITEM_BINDING
, XCAR (item
));
8264 /* Ignore cached key binding, if any. */
8265 if (CONSP (item
) && CONSP (XCAR (item
)))
8268 /* Process the rest of the properties. */
8269 for (; CONSP (item
) && CONSP (XCDR (item
)); item
= XCDR (XCDR (item
)))
8271 Lisp_Object ikey
, value
;
8274 value
= XCAR (XCDR (item
));
8276 if (EQ (ikey
, QCenable
))
8278 /* `:enable FORM'. */
8279 if (!NILP (Venable_disabled_menus_and_buttons
))
8280 set_prop (TOOL_BAR_ITEM_ENABLED_P
, Qt
);
8282 set_prop (TOOL_BAR_ITEM_ENABLED_P
, value
);
8284 else if (EQ (ikey
, QCvisible
))
8286 /* `:visible FORM'. If got a visible property and that
8287 evaluates to nil then ignore this item. */
8288 if (NILP (menu_item_eval_property (value
)))
8291 else if (EQ (ikey
, QChelp
))
8292 /* `:help HELP-STRING'. */
8293 set_prop (TOOL_BAR_ITEM_HELP
, value
);
8294 else if (EQ (ikey
, QCvert_only
))
8295 /* `:vert-only t/nil'. */
8296 set_prop (TOOL_BAR_ITEM_VERT_ONLY
, value
);
8297 else if (EQ (ikey
, QClabel
))
8299 const char *bad_label
= "!!?GARBLED ITEM?!!";
8300 /* `:label LABEL-STRING'. */
8301 set_prop (TOOL_BAR_ITEM_LABEL
,
8302 STRINGP (value
) ? value
: build_string (bad_label
));
8305 else if (EQ (ikey
, QCfilter
))
8306 /* ':filter FORM'. */
8308 else if (EQ (ikey
, QCbutton
) && CONSP (value
))
8310 /* `:button (TYPE . SELECTED)'. */
8311 Lisp_Object type
, selected
;
8313 type
= XCAR (value
);
8314 selected
= XCDR (value
);
8315 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
8317 set_prop (TOOL_BAR_ITEM_SELECTED_P
, selected
);
8318 set_prop (TOOL_BAR_ITEM_TYPE
, type
);
8321 else if (EQ (ikey
, QCimage
)
8323 || (VECTORP (value
) && ASIZE (value
) == 4)))
8324 /* Value is either a single image specification or a vector
8325 of 4 such specifications for the different button states. */
8326 set_prop (TOOL_BAR_ITEM_IMAGES
, value
);
8327 else if (EQ (ikey
, QCrtl
))
8329 set_prop (TOOL_BAR_ITEM_RTL_IMAGE
, value
);
8335 /* Try to make one from caption and key. */
8336 Lisp_Object tkey
= PROP (TOOL_BAR_ITEM_KEY
);
8337 Lisp_Object tcapt
= PROP (TOOL_BAR_ITEM_CAPTION
);
8338 const char *label
= SYMBOLP (tkey
) ? SSDATA (SYMBOL_NAME (tkey
)) : "";
8339 const char *capt
= STRINGP (tcapt
) ? SSDATA (tcapt
) : "";
8341 2 * max (0, min (tool_bar_max_label_size
, STRING_BYTES_BOUND
/ 2));
8342 char *buf
= xmalloc (max_lbl
+ 1);
8343 Lisp_Object new_lbl
;
8344 ptrdiff_t caption_len
= strlen (capt
);
8346 if (caption_len
<= max_lbl
&& capt
[0] != '\0')
8349 while (caption_len
> 0 && buf
[caption_len
- 1] == '.')
8351 buf
[caption_len
] = '\0';
8355 if (strlen (label
) <= max_lbl
&& label
[0] != '\0')
8359 strcpy (buf
, label
);
8361 for (j
= 0; buf
[j
] != '\0'; ++j
)
8369 new_lbl
= Fupcase_initials (build_string (label
));
8370 if (SCHARS (new_lbl
) <= tool_bar_max_label_size
)
8371 set_prop (TOOL_BAR_ITEM_LABEL
, new_lbl
);
8373 set_prop (TOOL_BAR_ITEM_LABEL
, empty_unibyte_string
);
8377 /* If got a filter apply it on binding. */
8379 set_prop (TOOL_BAR_ITEM_BINDING
,
8380 (menu_item_eval_property
8383 PROP (TOOL_BAR_ITEM_BINDING
))))));
8385 /* See if the binding is a keymap. Give up if it is. */
8386 if (CONSP (get_keymap (PROP (TOOL_BAR_ITEM_BINDING
), 0, 1)))
8389 /* Enable or disable selection of item. */
8390 if (!EQ (PROP (TOOL_BAR_ITEM_ENABLED_P
), Qt
))
8391 set_prop (TOOL_BAR_ITEM_ENABLED_P
,
8392 menu_item_eval_property (PROP (TOOL_BAR_ITEM_ENABLED_P
)));
8394 /* Handle radio buttons or toggle boxes. */
8395 if (!NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
)))
8396 set_prop (TOOL_BAR_ITEM_SELECTED_P
,
8397 menu_item_eval_property (PROP (TOOL_BAR_ITEM_SELECTED_P
)));
8405 /* Initialize tool_bar_items_vector. REUSE, if non-nil, is a vector
8406 that can be reused. */
8409 init_tool_bar_items (Lisp_Object reuse
)
8411 if (VECTORP (reuse
))
8412 tool_bar_items_vector
= reuse
;
8414 tool_bar_items_vector
= Fmake_vector (make_number (64), Qnil
);
8415 ntool_bar_items
= 0;
8419 /* Append parsed tool bar item properties from
8420 tool_bar_item_properties */
8423 append_tool_bar_item (void)
8427 - (ASIZE (tool_bar_items_vector
) - TOOL_BAR_ITEM_NSLOTS
));
8429 /* Enlarge tool_bar_items_vector if necessary. */
8431 tool_bar_items_vector
8432 = larger_vector (tool_bar_items_vector
, incr
, -1);
8434 /* Append entries from tool_bar_item_properties to the end of
8435 tool_bar_items_vector. */
8436 vcopy (tool_bar_items_vector
, ntool_bar_items
,
8437 XVECTOR (tool_bar_item_properties
)->contents
, TOOL_BAR_ITEM_NSLOTS
);
8438 ntool_bar_items
+= TOOL_BAR_ITEM_NSLOTS
;
8445 /* Read a character using menus based on maps in the array MAPS.
8446 NMAPS is the length of MAPS. Return nil if there are no menus in the maps.
8447 Return t if we displayed a menu but the user rejected it.
8449 PREV_EVENT is the previous input event, or nil if we are reading
8450 the first event of a key sequence.
8452 If USED_MOUSE_MENU is non-null, then we set *USED_MOUSE_MENU to 1
8453 if we used a mouse menu to read the input, or zero otherwise. If
8454 USED_MOUSE_MENU is null, we don't dereference it.
8456 The prompting is done based on the prompt-string of the map
8457 and the strings associated with various map elements.
8459 This can be done with X menus or with menus put in the minibuf.
8460 These are done in different ways, depending on how the input will be read.
8461 Menus using X are done after auto-saving in read-char, getting the input
8462 event from Fx_popup_menu; menus using the minibuf use read_char recursively
8463 and do auto-saving in the inner call of read_char. */
8466 read_char_x_menu_prompt (ptrdiff_t nmaps
, Lisp_Object
*maps
,
8467 Lisp_Object prev_event
, int *used_mouse_menu
)
8473 if (used_mouse_menu
)
8474 *used_mouse_menu
= 0;
8476 /* Use local over global Menu maps */
8478 if (! menu_prompting
)
8481 /* Optionally disregard all but the global map. */
8482 if (inhibit_local_menu_bar_menus
)
8484 maps
+= (nmaps
- 1);
8489 /* If we got to this point via a mouse click,
8490 use a real menu for mouse selection. */
8491 if (EVENT_HAS_PARAMETERS (prev_event
)
8492 && !EQ (XCAR (prev_event
), Qmenu_bar
)
8493 && !EQ (XCAR (prev_event
), Qtool_bar
))
8495 /* Display the menu and get the selection. */
8496 Lisp_Object
*realmaps
= alloca (nmaps
* sizeof *realmaps
);
8498 ptrdiff_t nmaps1
= 0;
8500 /* Use the maps that are not nil. */
8501 for (mapno
= 0; mapno
< nmaps
; mapno
++)
8502 if (!NILP (maps
[mapno
]))
8503 realmaps
[nmaps1
++] = maps
[mapno
];
8505 value
= Fx_popup_menu (prev_event
, Flist (nmaps1
, realmaps
));
8510 record_menu_key (XCAR (value
));
8512 /* If we got multiple events, unread all but
8514 There is no way to prevent those unread events
8515 from showing up later in last_nonmenu_event.
8516 So turn symbol and integer events into lists,
8517 to indicate that they came from a mouse menu,
8518 so that when present in last_nonmenu_event
8519 they won't confuse things. */
8520 for (tem
= XCDR (value
); CONSP (tem
); tem
= XCDR (tem
))
8522 record_menu_key (XCAR (tem
));
8523 if (SYMBOLP (XCAR (tem
))
8524 || INTEGERP (XCAR (tem
)))
8525 XSETCAR (tem
, Fcons (XCAR (tem
), Qdisabled
));
8528 /* If we got more than one event, put all but the first
8529 onto this list to be read later.
8530 Return just the first event now. */
8531 Vunread_command_events
8532 = nconc2 (XCDR (value
), Vunread_command_events
);
8533 value
= XCAR (value
);
8535 else if (NILP (value
))
8537 if (used_mouse_menu
)
8538 *used_mouse_menu
= 1;
8541 #endif /* HAVE_MENUS */
8545 /* Buffer in use so far for the minibuf prompts for menu keymaps.
8546 We make this bigger when necessary, and never free it. */
8547 static char *read_char_minibuf_menu_text
;
8548 /* Size of that buffer. */
8549 static ptrdiff_t read_char_minibuf_menu_width
;
8552 read_char_minibuf_menu_prompt (int commandflag
,
8553 ptrdiff_t nmaps
, Lisp_Object
*maps
)
8556 register Lisp_Object name
;
8558 /* FIXME: Use the minibuffer's frame width. */
8559 ptrdiff_t width
= FRAME_COLS (SELECTED_FRAME ()) - 4;
8562 Lisp_Object rest
, vector
;
8568 if (! menu_prompting
)
8571 /* Get the menu name from the first map that has one (a prompt string). */
8572 for (mapno
= 0; mapno
< nmaps
; mapno
++)
8574 name
= Fkeymap_prompt (maps
[mapno
]);
8579 /* If we don't have any menus, just read a character normally. */
8580 if (!STRINGP (name
))
8583 /* Make sure we have a big enough buffer for the menu text. */
8584 width
= max (width
, SBYTES (name
));
8585 if (STRING_BYTES_BOUND
- 4 < width
)
8586 memory_full (SIZE_MAX
);
8587 if (width
+ 4 > read_char_minibuf_menu_width
)
8589 read_char_minibuf_menu_text
8590 = xrealloc (read_char_minibuf_menu_text
, width
+ 4);
8591 read_char_minibuf_menu_width
= width
+ 4;
8593 menu
= read_char_minibuf_menu_text
;
8595 /* Prompt string always starts with map's prompt, and a space. */
8596 strcpy (menu
, SSDATA (name
));
8597 nlength
= SBYTES (name
);
8598 menu
[nlength
++] = ':';
8599 menu
[nlength
++] = ' ';
8602 /* Start prompting at start of first map. */
8606 /* Present the documented bindings, a line at a time. */
8610 ptrdiff_t i
= nlength
;
8612 Lisp_Object orig_defn_macro
;
8614 /* Loop over elements of map. */
8619 /* If reached end of map, start at beginning of next map. */
8623 /* At end of last map, wrap around to first map if just starting,
8624 or end this line if already have something on it. */
8628 if (notfirst
|| nobindings
) break;
8633 /* Look at the next element of the map. */
8635 elt
= AREF (vector
, idx
);
8637 elt
= Fcar_safe (rest
);
8639 if (idx
< 0 && VECTORP (elt
))
8641 /* If we found a dense table in the keymap,
8642 advanced past it, but start scanning its contents. */
8643 rest
= Fcdr_safe (rest
);
8649 /* An ordinary element. */
8650 Lisp_Object event
, tem
;
8654 event
= Fcar_safe (elt
); /* alist */
8655 elt
= Fcdr_safe (elt
);
8659 XSETINT (event
, idx
); /* vector */
8662 /* Ignore the element if it has no prompt string. */
8663 if (INTEGERP (event
) && parse_menu_item (elt
, -1))
8665 /* 1 if the char to type matches the string. */
8667 Lisp_Object upcased_event
, downcased_event
;
8668 Lisp_Object desc
= Qnil
;
8670 = AREF (item_properties
, ITEM_PROPERTY_NAME
);
8672 upcased_event
= Fupcase (event
);
8673 downcased_event
= Fdowncase (event
);
8674 char_matches
= (XINT (upcased_event
) == SREF (s
, 0)
8675 || XINT (downcased_event
) == SREF (s
, 0));
8677 desc
= Fsingle_key_description (event
, Qnil
);
8679 #if 0 /* It is redundant to list the equivalent key bindings because
8680 the prefix is what the user has already typed. */
8682 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_KEYEQ
];
8684 /* Insert equivalent keybinding. */
8685 s
= concat2 (s
, tem
);
8688 = AREF (item_properties
, ITEM_PROPERTY_TYPE
);
8689 if (EQ (tem
, QCradio
) || EQ (tem
, QCtoggle
))
8691 /* Insert button prefix. */
8692 Lisp_Object selected
8693 = AREF (item_properties
, ITEM_PROPERTY_SELECTED
);
8694 if (EQ (tem
, QCradio
))
8695 tem
= build_string (NILP (selected
) ? "(*) " : "( ) ");
8697 tem
= build_string (NILP (selected
) ? "[X] " : "[ ] ");
8698 s
= concat2 (tem
, s
);
8702 /* If we have room for the prompt string, add it to this line.
8703 If this is the first on the line, always add it. */
8704 if ((SCHARS (s
) + i
+ 2
8705 + (char_matches
? 0 : SCHARS (desc
) + 3))
8709 ptrdiff_t thiswidth
;
8711 /* Punctuate between strings. */
8714 strcpy (menu
+ i
, ", ");
8720 /* If the char to type doesn't match the string's
8721 first char, explicitly show what char to type. */
8724 /* Add as much of string as fits. */
8725 thiswidth
= min (SCHARS (desc
), width
- i
);
8726 memcpy (menu
+ i
, SDATA (desc
), thiswidth
);
8728 strcpy (menu
+ i
, " = ");
8732 /* Add as much of string as fits. */
8733 thiswidth
= min (SCHARS (s
), width
- i
);
8734 memcpy (menu
+ i
, SDATA (s
), thiswidth
);
8740 /* If this element does not fit, end the line now,
8741 and save the element for the next line. */
8742 strcpy (menu
+ i
, "...");
8747 /* Move past this element. */
8748 if (idx
>= 0 && idx
+ 1 >= ASIZE (vector
))
8749 /* Handle reaching end of dense table. */
8754 rest
= Fcdr_safe (rest
);
8758 /* Prompt with that and read response. */
8759 message2_nolog (menu
, strlen (menu
),
8760 ! NILP (BVAR (current_buffer
, enable_multibyte_characters
)));
8762 /* Make believe its not a keyboard macro in case the help char
8763 is pressed. Help characters are not recorded because menu prompting
8764 is not used on replay.
8766 orig_defn_macro
= KVAR (current_kboard
, defining_kbd_macro
);
8767 kset_defining_kbd_macro (current_kboard
, Qnil
);
8769 obj
= read_char (commandflag
, 0, 0, Qt
, 0, NULL
);
8770 while (BUFFERP (obj
));
8771 kset_defining_kbd_macro (current_kboard
, orig_defn_macro
);
8773 if (!INTEGERP (obj
))
8775 else if (XINT (obj
) == -2)
8778 if (! EQ (obj
, menu_prompt_more_char
)
8779 && (!INTEGERP (menu_prompt_more_char
)
8780 || ! EQ (obj
, make_number (Ctl (XINT (menu_prompt_more_char
))))))
8782 if (!NILP (KVAR (current_kboard
, defining_kbd_macro
)))
8783 store_kbd_macro_char (obj
);
8786 /* Help char - go round again */
8790 /* Reading key sequences. */
8792 /* Follow KEY in the maps in CURRENT[0..NMAPS-1], placing its bindings
8793 in DEFS[0..NMAPS-1]. Set NEXT[i] to DEFS[i] if DEFS[i] is a
8794 keymap, or nil otherwise. Return the index of the first keymap in
8795 which KEY has any binding, or NMAPS if no map has a binding.
8797 If KEY is a meta ASCII character, treat it like meta-prefix-char
8798 followed by the corresponding non-meta character. Keymaps in
8799 CURRENT with non-prefix bindings for meta-prefix-char become nil in
8802 If KEY has no bindings in any of the CURRENT maps, NEXT is left
8805 NEXT may be the same array as CURRENT. */
8808 follow_key (Lisp_Object key
, ptrdiff_t nmaps
, Lisp_Object
*current
,
8809 Lisp_Object
*defs
, Lisp_Object
*next
)
8811 ptrdiff_t i
, first_binding
;
8813 first_binding
= nmaps
;
8814 for (i
= nmaps
- 1; i
>= 0; i
--)
8816 if (! NILP (current
[i
]))
8818 defs
[i
] = access_keymap (current
[i
], key
, 1, 0, 1);
8819 if (! NILP (defs
[i
]))
8826 /* Given the set of bindings we've found, produce the next set of maps. */
8827 if (first_binding
< nmaps
)
8828 for (i
= 0; i
< nmaps
; i
++)
8829 next
[i
] = NILP (defs
[i
]) ? Qnil
: get_keymap (defs
[i
], 0, 1);
8831 return first_binding
;
8834 /* Structure used to keep track of partial application of key remapping
8835 such as Vfunction_key_map and Vkey_translation_map. */
8836 typedef struct keyremap
8838 /* This is the map originally specified for this use. */
8840 /* This is a submap reached by looking up, in PARENT,
8841 the events from START to END. */
8843 /* Positions [START, END) in the key sequence buffer
8844 are the key that we have scanned so far.
8845 Those events are the ones that we will replace
8846 if PARENT maps them into a key sequence. */
8850 /* Lookup KEY in MAP.
8851 MAP is a keymap mapping keys to key vectors or functions.
8852 If the mapping is a function and DO_FUNCTION is non-zero, then
8853 the function is called with PROMPT as parameter and its return
8854 value is used as the return value of this function (after checking
8855 that it is indeed a vector). */
8858 access_keymap_keyremap (Lisp_Object map
, Lisp_Object key
, Lisp_Object prompt
,
8863 next
= access_keymap (map
, key
, 1, 0, 1);
8865 /* Handle a symbol whose function definition is a keymap
8867 if (SYMBOLP (next
) && !NILP (Ffboundp (next
))
8868 && (ARRAYP (XSYMBOL (next
)->function
)
8869 || KEYMAPP (XSYMBOL (next
)->function
)))
8870 next
= Fautoload_do_load (XSYMBOL (next
)->function
, next
, Qnil
);
8872 /* If the keymap gives a function, not an
8873 array, then call the function with one arg and use
8874 its value instead. */
8875 if (do_funcall
&& FUNCTIONP (next
))
8880 next
= call1 (next
, prompt
);
8881 /* If the function returned something invalid,
8882 barf--don't ignore it.
8883 (To ignore it safely, we would need to gcpro a bunch of
8884 other variables.) */
8885 if (! (VECTORP (next
) || STRINGP (next
)))
8886 error ("Function %s returns invalid key sequence",
8887 SSDATA (SYMBOL_NAME (tem
)));
8892 /* Do one step of the key remapping used for function-key-map and
8893 key-translation-map:
8894 KEYBUF is the buffer holding the input events.
8895 BUFSIZE is its maximum size.
8896 FKEY is a pointer to the keyremap structure to use.
8897 INPUT is the index of the last element in KEYBUF.
8898 DOIT if non-zero says that the remapping can actually take place.
8899 DIFF is used to return the number of keys added/removed by the remapping.
8900 PARENT is the root of the keymap.
8901 PROMPT is the prompt to use if the remapping happens through a function.
8902 The return value is non-zero if the remapping actually took place. */
8905 keyremap_step (Lisp_Object
*keybuf
, int bufsize
, volatile keyremap
*fkey
,
8906 int input
, int doit
, int *diff
, Lisp_Object prompt
)
8908 Lisp_Object next
, key
;
8910 key
= keybuf
[fkey
->end
++];
8912 if (KEYMAPP (fkey
->parent
))
8913 next
= access_keymap_keyremap (fkey
->map
, key
, prompt
, doit
);
8917 /* If keybuf[fkey->start..fkey->end] is bound in the
8918 map and we're in a position to do the key remapping, replace it with
8919 the binding and restart with fkey->start at the end. */
8920 if ((VECTORP (next
) || STRINGP (next
)) && doit
)
8922 int len
= XFASTINT (Flength (next
));
8925 *diff
= len
- (fkey
->end
- fkey
->start
);
8927 if (bufsize
- input
<= *diff
)
8928 error ("Key sequence too long");
8930 /* Shift the keys that follow fkey->end. */
8932 for (i
= fkey
->end
; i
< input
; i
++)
8933 keybuf
[i
+ *diff
] = keybuf
[i
];
8935 for (i
= input
- 1; i
>= fkey
->end
; i
--)
8936 keybuf
[i
+ *diff
] = keybuf
[i
];
8937 /* Overwrite the old keys with the new ones. */
8938 for (i
= 0; i
< len
; i
++)
8939 keybuf
[fkey
->start
+ i
]
8940 = Faref (next
, make_number (i
));
8942 fkey
->start
= fkey
->end
+= *diff
;
8943 fkey
->map
= fkey
->parent
;
8948 fkey
->map
= get_keymap (next
, 0, 1);
8950 /* If we no longer have a bound suffix, try a new position for
8952 if (!CONSP (fkey
->map
))
8954 fkey
->end
= ++fkey
->start
;
8955 fkey
->map
= fkey
->parent
;
8961 test_undefined (Lisp_Object binding
)
8963 return (EQ (binding
, Qundefined
)
8964 || (!NILP (binding
) && SYMBOLP (binding
)
8965 && EQ (Fcommand_remapping (binding
, Qnil
, Qnil
), Qundefined
)));
8968 /* Read a sequence of keys that ends with a non prefix character,
8969 storing it in KEYBUF, a buffer of size BUFSIZE.
8971 Return the length of the key sequence stored.
8972 Return -1 if the user rejected a command menu.
8974 Echo starting immediately unless `prompt' is 0.
8976 Where a key sequence ends depends on the currently active keymaps.
8977 These include any minor mode keymaps active in the current buffer,
8978 the current buffer's local map, and the global map.
8980 If a key sequence has no other bindings, we check Vfunction_key_map
8981 to see if some trailing subsequence might be the beginning of a
8982 function key's sequence. If so, we try to read the whole function
8983 key, and substitute its symbolic name into the key sequence.
8985 We ignore unbound `down-' mouse clicks. We turn unbound `drag-' and
8986 `double-' events into similar click events, if that would make them
8987 bound. We try to turn `triple-' events first into `double-' events,
8990 If we get a mouse click in a mode line, vertical divider, or other
8991 non-text area, we treat the click as if it were prefixed by the
8992 symbol denoting that area - `mode-line', `vertical-line', or
8995 If the sequence starts with a mouse click, we read the key sequence
8996 with respect to the buffer clicked on, not the current buffer.
8998 If the user switches frames in the midst of a key sequence, we put
8999 off the switch-frame event until later; the next call to
9000 read_char will return it.
9002 If FIX_CURRENT_BUFFER is nonzero, we restore current_buffer
9003 from the selected window's buffer. */
9006 read_key_sequence (Lisp_Object
*keybuf
, int bufsize
, Lisp_Object prompt
,
9007 int dont_downcase_last
, int can_return_switch_frame
,
9008 int fix_current_buffer
)
9010 Lisp_Object from_string
;
9011 ptrdiff_t count
= SPECPDL_INDEX ();
9013 /* How many keys there are in the current key sequence. */
9016 /* The length of the echo buffer when we started reading, and
9017 the length of this_command_keys when we started reading. */
9018 ptrdiff_t echo_start
IF_LINT (= 0);
9019 ptrdiff_t keys_start
;
9021 /* The number of keymaps we're scanning right now, and the number of
9022 keymaps we have allocated space for. */
9024 ptrdiff_t nmaps_allocated
= 0;
9026 /* defs[0..nmaps-1] are the definitions of KEYBUF[0..t-1] in
9027 the current keymaps. */
9028 Lisp_Object
*defs
= NULL
;
9030 /* submaps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
9031 in the current keymaps, or nil where it is not a prefix. */
9032 Lisp_Object
*submaps
= NULL
;
9034 /* The local map to start out with at start of key sequence. */
9035 Lisp_Object orig_local_map
;
9037 /* The map from the `keymap' property to start out with at start of
9039 Lisp_Object orig_keymap
;
9041 /* 1 if we have already considered switching to the local-map property
9042 of the place where a mouse click occurred. */
9043 int localized_local_map
= 0;
9045 /* The index in submaps[] of the first keymap that has a binding for
9046 this key sequence. In other words, the lowest i such that
9047 submaps[i] is non-nil. */
9048 ptrdiff_t first_binding
;
9049 /* Index of the first key that has no binding.
9050 It is useless to try fkey.start larger than that. */
9053 /* If t < mock_input, then KEYBUF[t] should be read as the next
9056 We use this to recover after recognizing a function key. Once we
9057 realize that a suffix of the current key sequence is actually a
9058 function key's escape sequence, we replace the suffix with the
9059 function key's binding from Vfunction_key_map. Now keybuf
9060 contains a new and different key sequence, so the echo area,
9061 this_command_keys, and the submaps and defs arrays are wrong. In
9062 this situation, we set mock_input to t, set t to 0, and jump to
9063 restart_sequence; the loop will read keys from keybuf up until
9064 mock_input, thus rebuilding the state; and then it will resume
9065 reading characters from the keyboard. */
9068 /* If the sequence is unbound in submaps[], then
9069 keybuf[fkey.start..fkey.end-1] is a prefix in Vfunction_key_map,
9070 and fkey.map is its binding.
9072 These might be > t, indicating that all function key scanning
9073 should hold off until t reaches them. We do this when we've just
9074 recognized a function key, to avoid searching for the function
9075 key's again in Vfunction_key_map. */
9078 /* Likewise, for key_translation_map and input-decode-map. */
9079 keyremap keytran
, indec
;
9081 /* Non-zero if we are trying to map a key by changing an upper-case
9082 letter to lower case, or a shifted function key to an unshifted
9084 int shift_translated
= 0;
9086 /* If we receive a `switch-frame' or `select-window' event in the middle of
9087 a key sequence, we put it off for later.
9088 While we're reading, we keep the event here. */
9089 Lisp_Object delayed_switch_frame
;
9091 /* See the comment below... */
9092 #if defined (GOBBLE_FIRST_EVENT)
9093 Lisp_Object first_event
;
9096 Lisp_Object original_uppercase
IF_LINT (= Qnil
);
9097 int original_uppercase_position
= -1;
9099 /* Gets around Microsoft compiler limitations. */
9102 struct buffer
*starting_buffer
;
9104 /* List of events for which a fake prefix key has been generated. */
9105 Lisp_Object fake_prefixed_keys
= Qnil
;
9107 #if defined (GOBBLE_FIRST_EVENT)
9111 struct gcpro gcpro1
;
9113 GCPRO1 (fake_prefixed_keys
);
9114 raw_keybuf_count
= 0;
9116 last_nonmenu_event
= Qnil
;
9118 delayed_switch_frame
= Qnil
;
9124 /* Install the string STR as the beginning of the string of
9125 echoing, so that it serves as a prompt for the next
9127 kset_echo_string (current_kboard
, prompt
);
9128 current_kboard
->echo_after_prompt
= SCHARS (prompt
);
9131 else if (cursor_in_echo_area
9132 && (FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
9133 && NILP (Fzerop (Vecho_keystrokes
)))
9134 /* This doesn't put in a dash if the echo buffer is empty, so
9135 you don't always see a dash hanging out in the minibuffer. */
9139 /* Record the initial state of the echo area and this_command_keys;
9140 we will need to restore them if we replay a key sequence. */
9142 echo_start
= echo_length ();
9143 keys_start
= this_command_key_count
;
9144 this_single_command_key_start
= keys_start
;
9146 #if defined (GOBBLE_FIRST_EVENT)
9147 /* This doesn't quite work, because some of the things that read_char
9148 does cannot safely be bypassed. It seems too risky to try to make
9151 /* Read the first char of the sequence specially, before setting
9152 up any keymaps, in case a filter runs and switches buffers on us. */
9153 first_event
= read_char (NILP (prompt
), 0, submaps
, last_nonmenu_event
,
9155 #endif /* GOBBLE_FIRST_EVENT */
9157 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
9158 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9161 /* We jump here when we need to reinitialize fkey and keytran; this
9162 happens if we switch keyboards between rescans. */
9163 replay_entire_sequence
:
9165 indec
.map
= indec
.parent
= KVAR (current_kboard
, Vinput_decode_map
);
9166 fkey
.map
= fkey
.parent
= KVAR (current_kboard
, Vlocal_function_key_map
);
9167 keytran
.map
= keytran
.parent
= Vkey_translation_map
;
9168 indec
.start
= indec
.end
= 0;
9169 fkey
.start
= fkey
.end
= 0;
9170 keytran
.start
= keytran
.end
= 0;
9172 /* We jump here when the key sequence has been thoroughly changed, and
9173 we need to rescan it starting from the beginning. When we jump here,
9174 keybuf[0..mock_input] holds the sequence we should reread. */
9177 starting_buffer
= current_buffer
;
9178 first_unbound
= bufsize
+ 1;
9180 /* Build our list of keymaps.
9181 If we recognize a function key and replace its escape sequence in
9182 keybuf with its symbol, or if the sequence starts with a mouse
9183 click and we need to switch buffers, we jump back here to rebuild
9184 the initial keymaps from the current buffer. */
9187 if (!NILP (KVAR (current_kboard
, Voverriding_terminal_local_map
)))
9189 if (2 > nmaps_allocated
)
9191 submaps
= alloca (2 * sizeof *submaps
);
9192 defs
= alloca (2 * sizeof *defs
);
9193 nmaps_allocated
= 2;
9195 submaps
[nmaps
++] = KVAR (current_kboard
, Voverriding_terminal_local_map
);
9197 else if (!NILP (Voverriding_local_map
))
9199 if (2 > nmaps_allocated
)
9201 submaps
= alloca (2 * sizeof *submaps
);
9202 defs
= alloca (2 * sizeof *defs
);
9203 nmaps_allocated
= 2;
9205 submaps
[nmaps
++] = Voverriding_local_map
;
9213 nminor
= current_minor_maps (0, &maps
);
9214 total
= nminor
+ (!NILP (orig_keymap
) ? 3 : 2);
9216 if (total
> nmaps_allocated
)
9218 submaps
= alloca (total
* sizeof *submaps
);
9219 defs
= alloca (total
* sizeof *defs
);
9220 nmaps_allocated
= total
;
9223 if (!NILP (orig_keymap
))
9224 submaps
[nmaps
++] = orig_keymap
;
9226 memcpy (submaps
+ nmaps
, maps
, nminor
* sizeof (submaps
[0]));
9230 submaps
[nmaps
++] = orig_local_map
;
9232 submaps
[nmaps
++] = current_global_map
;
9234 /* Find an accurate initial value for first_binding. */
9235 for (first_binding
= 0; first_binding
< nmaps
; first_binding
++)
9236 if (! NILP (submaps
[first_binding
]))
9239 /* Start from the beginning in keybuf. */
9242 /* These are no-ops the first time through, but if we restart, they
9243 revert the echo area and this_command_keys to their original state. */
9244 this_command_key_count
= keys_start
;
9245 if (INTERACTIVE
&& t
< mock_input
)
9246 echo_truncate (echo_start
);
9248 /* If the best binding for the current key sequence is a keymap, or
9249 we may be looking at a function key's escape sequence, keep on
9251 while (first_binding
< nmaps
9252 /* Keep reading as long as there's a prefix binding. */
9253 ? !NILP (submaps
[first_binding
])
9254 /* Don't return in the middle of a possible function key sequence,
9255 if the only bindings we found were via case conversion.
9256 Thus, if ESC O a has a function-key-map translation
9257 and ESC o has a binding, don't return after ESC O,
9258 so that we can translate ESC O plus the next character. */
9259 : (/* indec.start < t || fkey.start < t || */ keytran
.start
< t
))
9262 int used_mouse_menu
= 0;
9264 /* Where the last real key started. If we need to throw away a
9265 key that has expanded into more than one element of keybuf
9266 (say, a mouse click on the mode line which is being treated
9267 as [mode-line (mouse-...)], then we backtrack to this point
9269 int last_real_key_start
;
9271 /* These variables are analogous to echo_start and keys_start;
9272 while those allow us to restart the entire key sequence,
9273 echo_local_start and keys_local_start allow us to throw away
9275 ptrdiff_t echo_local_start
IF_LINT (= 0);
9276 int keys_local_start
;
9277 ptrdiff_t local_first_binding
;
9279 eassert (indec
.end
== t
|| (indec
.end
> t
&& indec
.end
<= mock_input
));
9280 eassert (indec
.start
<= indec
.end
);
9281 eassert (fkey
.start
<= fkey
.end
);
9282 eassert (keytran
.start
<= keytran
.end
);
9283 /* key-translation-map is applied *after* function-key-map
9284 which is itself applied *after* input-decode-map. */
9285 eassert (fkey
.end
<= indec
.start
);
9286 eassert (keytran
.end
<= fkey
.start
);
9288 if (/* first_unbound < indec.start && first_unbound < fkey.start && */
9289 first_unbound
< keytran
.start
)
9290 { /* The prefix upto first_unbound has no binding and has
9291 no translation left to do either, so we know it's unbound.
9292 If we don't stop now, we risk staying here indefinitely
9293 (if the user keeps entering fkey or keytran prefixes
9294 like C-c ESC ESC ESC ESC ...) */
9296 for (i
= first_unbound
+ 1; i
< t
; i
++)
9297 keybuf
[i
- first_unbound
- 1] = keybuf
[i
];
9298 mock_input
= t
- first_unbound
- 1;
9299 indec
.end
= indec
.start
-= first_unbound
+ 1;
9300 indec
.map
= indec
.parent
;
9301 fkey
.end
= fkey
.start
-= first_unbound
+ 1;
9302 fkey
.map
= fkey
.parent
;
9303 keytran
.end
= keytran
.start
-= first_unbound
+ 1;
9304 keytran
.map
= keytran
.parent
;
9305 goto replay_sequence
;
9309 error ("Key sequence too long");
9312 echo_local_start
= echo_length ();
9313 keys_local_start
= this_command_key_count
;
9314 local_first_binding
= first_binding
;
9317 /* These are no-ops, unless we throw away a keystroke below and
9318 jumped back up to replay_key; in that case, these restore the
9319 variables to their original state, allowing us to replay the
9321 if (INTERACTIVE
&& t
< mock_input
)
9322 echo_truncate (echo_local_start
);
9323 this_command_key_count
= keys_local_start
;
9324 first_binding
= local_first_binding
;
9326 /* By default, assume each event is "real". */
9327 last_real_key_start
= t
;
9329 /* Does mock_input indicate that we are re-reading a key sequence? */
9333 add_command_key (key
);
9334 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
9335 && NILP (Fzerop (Vecho_keystrokes
)))
9339 /* If not, we should actually read a character. */
9343 KBOARD
*interrupted_kboard
= current_kboard
;
9344 struct frame
*interrupted_frame
= SELECTED_FRAME ();
9345 key
= read_char (NILP (prompt
), nmaps
,
9346 (Lisp_Object
*) submaps
, last_nonmenu_event
,
9347 &used_mouse_menu
, NULL
);
9348 if ((INTEGERP (key
) && XINT (key
) == -2) /* wrong_kboard_jmpbuf */
9349 /* When switching to a new tty (with a new keyboard),
9350 read_char returns the new buffer, rather than -2
9351 (Bug#5095). This is because `terminal-init-xterm'
9352 calls read-char, which eats the wrong_kboard_jmpbuf
9353 return. Any better way to fix this? -- cyd */
9354 || (interrupted_kboard
!= current_kboard
))
9359 for (k
= all_kboards
; k
; k
= k
->next_kboard
)
9360 if (k
== interrupted_kboard
)
9365 /* Don't touch interrupted_kboard when it's been
9367 delayed_switch_frame
= Qnil
;
9368 goto replay_entire_sequence
;
9371 if (!NILP (delayed_switch_frame
))
9374 (interrupted_kboard
,
9375 Fcons (delayed_switch_frame
,
9376 KVAR (interrupted_kboard
, kbd_queue
)));
9377 delayed_switch_frame
= Qnil
;
9382 (interrupted_kboard
,
9383 Fcons (keybuf
[--t
], KVAR (interrupted_kboard
, kbd_queue
)));
9385 /* If the side queue is non-empty, ensure it begins with a
9386 switch-frame, so we'll replay it in the right context. */
9387 if (CONSP (KVAR (interrupted_kboard
, kbd_queue
))
9388 && (key
= XCAR (KVAR (interrupted_kboard
, kbd_queue
)),
9389 !(EVENT_HAS_PARAMETERS (key
)
9390 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)),
9394 XSETFRAME (frame
, interrupted_frame
);
9396 (interrupted_kboard
,
9397 Fcons (make_lispy_switch_frame (frame
),
9398 KVAR (interrupted_kboard
, kbd_queue
)));
9401 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
9402 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9403 goto replay_entire_sequence
;
9407 /* read_char returns t when it shows a menu and the user rejects it.
9411 unbind_to (count
, Qnil
);
9416 /* read_char returns -1 at the end of a macro.
9417 Emacs 18 handles this by returning immediately with a
9418 zero, so that's what we'll do. */
9419 if (INTEGERP (key
) && XINT (key
) == -1)
9422 /* The Microsoft C compiler can't handle the goto that
9428 /* If the current buffer has been changed from under us, the
9429 keymap may have changed, so replay the sequence. */
9432 timer_resume_idle ();
9435 /* Reset the current buffer from the selected window
9436 in case something changed the former and not the latter.
9437 This is to be more consistent with the behavior
9438 of the command_loop_1. */
9439 if (fix_current_buffer
)
9441 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
9443 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
9444 Fset_buffer (XWINDOW (selected_window
)->buffer
);
9447 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
9448 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9449 goto replay_sequence
;
9452 /* If we have a quit that was typed in another frame, and
9453 quit_throw_to_read_char switched buffers,
9454 replay to get the right keymap. */
9456 && XINT (key
) == quit_char
9457 && current_buffer
!= starting_buffer
)
9460 ASET (raw_keybuf
, raw_keybuf_count
, key
);
9465 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
9466 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9467 goto replay_sequence
;
9472 if (EVENT_HAS_PARAMETERS (key
)
9473 /* Either a `switch-frame' or a `select-window' event. */
9474 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)), Qswitch_frame
))
9476 /* If we're at the beginning of a key sequence, and the caller
9477 says it's okay, go ahead and return this event. If we're
9478 in the midst of a key sequence, delay it until the end. */
9479 if (t
> 0 || !can_return_switch_frame
)
9481 delayed_switch_frame
= key
;
9487 ASET (raw_keybuf
, raw_keybuf_count
, key
);
9491 /* Clicks in non-text areas get prefixed by the symbol
9492 in their CHAR-ADDRESS field. For example, a click on
9493 the mode line is prefixed by the symbol `mode-line'.
9495 Furthermore, key sequences beginning with mouse clicks
9496 are read using the keymaps of the buffer clicked on, not
9497 the current buffer. So we may have to switch the buffer
9500 When we turn one event into two events, we must make sure
9501 that neither of the two looks like the original--so that,
9502 if we replay the events, they won't be expanded again.
9503 If not for this, such reexpansion could happen either here
9504 or when user programs play with this-command-keys. */
9505 if (EVENT_HAS_PARAMETERS (key
))
9510 kind
= EVENT_HEAD_KIND (EVENT_HEAD (key
));
9511 if (EQ (kind
, Qmouse_click
))
9513 Lisp_Object window
, posn
;
9515 window
= POSN_WINDOW (EVENT_START (key
));
9516 posn
= POSN_POSN (EVENT_START (key
));
9519 || (!NILP (fake_prefixed_keys
)
9520 && !NILP (Fmemq (key
, fake_prefixed_keys
))))
9522 /* We're looking a second time at an event for which
9523 we generated a fake prefix key. Set
9524 last_real_key_start appropriately. */
9526 last_real_key_start
= t
- 1;
9529 if (last_real_key_start
== 0)
9531 /* Key sequences beginning with mouse clicks are
9532 read using the keymaps in the buffer clicked on,
9533 not the current buffer. If we're at the
9534 beginning of a key sequence, switch buffers. */
9535 if (WINDOWP (window
)
9536 && BUFFERP (XWINDOW (window
)->buffer
)
9537 && XBUFFER (XWINDOW (window
)->buffer
) != current_buffer
)
9539 ASET (raw_keybuf
, raw_keybuf_count
, key
);
9544 /* Arrange to go back to the original buffer once we're
9545 done reading the key sequence. Note that we can't
9546 use save_excursion_{save,restore} here, because they
9547 save point as well as the current buffer; we don't
9548 want to save point, because redisplay may change it,
9549 to accommodate a Fset_window_start or something. We
9550 don't want to do this at the top of the function,
9551 because we may get input from a subprocess which
9552 wants to change the selected window and stuff (say,
9554 record_unwind_current_buffer ();
9556 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
9558 set_buffer_internal (XBUFFER (XWINDOW (window
)->buffer
));
9559 orig_local_map
= get_local_map (PT
, current_buffer
,
9561 orig_keymap
= get_local_map (PT
, current_buffer
,
9563 goto replay_sequence
;
9566 /* For a mouse click, get the local text-property keymap
9567 of the place clicked on, rather than point. */
9568 if (CONSP (XCDR (key
))
9569 && ! localized_local_map
)
9571 Lisp_Object map_here
, start
, pos
;
9573 localized_local_map
= 1;
9574 start
= EVENT_START (key
);
9576 if (CONSP (start
) && POSN_INBUFFER_P (start
))
9578 pos
= POSN_BUFFER_POSN (start
);
9580 && XINT (pos
) >= BEGV
9581 && XINT (pos
) <= ZV
)
9583 map_here
= get_local_map (XINT (pos
),
9586 if (!EQ (map_here
, orig_local_map
))
9588 orig_local_map
= map_here
;
9589 ++localized_local_map
;
9592 map_here
= get_local_map (XINT (pos
),
9595 if (!EQ (map_here
, orig_keymap
))
9597 orig_keymap
= map_here
;
9598 ++localized_local_map
;
9601 if (localized_local_map
> 1)
9606 goto replay_sequence
;
9613 /* Expand mode-line and scroll-bar events into two events:
9614 use posn as a fake prefix key. */
9616 && (NILP (fake_prefixed_keys
)
9617 || NILP (Fmemq (key
, fake_prefixed_keys
))))
9619 if (bufsize
- t
<= 1)
9620 error ("Key sequence too long");
9623 keybuf
[t
+ 1] = key
;
9626 /* Record that a fake prefix key has been generated
9627 for KEY. Don't modify the event; this would
9628 prevent proper action when the event is pushed
9629 back into unread-command-events. */
9630 fake_prefixed_keys
= Fcons (key
, fake_prefixed_keys
);
9632 /* If on a mode line string with a local keymap,
9633 reconsider the key sequence with that keymap. */
9634 if (string
= POSN_STRING (EVENT_START (key
)),
9635 (CONSP (string
) && STRINGP (XCAR (string
))))
9637 Lisp_Object pos
, map
, map2
;
9639 pos
= XCDR (string
);
9640 string
= XCAR (string
);
9642 && XINT (pos
) < SCHARS (string
))
9644 map
= Fget_text_property (pos
, Qlocal_map
, string
);
9646 orig_local_map
= map
;
9647 map2
= Fget_text_property (pos
, Qkeymap
, string
);
9650 if (!NILP (map
) || !NILP (map2
))
9651 goto replay_sequence
;
9657 else if (NILP (from_string
)
9658 && (string
= POSN_STRING (EVENT_START (key
)),
9659 (CONSP (string
) && STRINGP (XCAR (string
)))))
9661 /* For a click on a string, i.e. overlay string or a
9662 string displayed via the `display' property,
9663 consider `local-map' and `keymap' properties of
9665 Lisp_Object pos
, map
, map2
;
9667 pos
= XCDR (string
);
9668 string
= XCAR (string
);
9670 && XINT (pos
) < SCHARS (string
))
9672 map
= Fget_text_property (pos
, Qlocal_map
, string
);
9674 orig_local_map
= map
;
9675 map2
= Fget_text_property (pos
, Qkeymap
, string
);
9679 if (!NILP (map
) || !NILP (map2
))
9681 from_string
= string
;
9684 goto replay_sequence
;
9689 else if (CONSP (XCDR (key
))
9690 && CONSP (EVENT_START (key
))
9691 && CONSP (XCDR (EVENT_START (key
))))
9695 posn
= POSN_POSN (EVENT_START (key
));
9696 /* Handle menu-bar events:
9697 insert the dummy prefix event `menu-bar'. */
9698 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
9700 if (bufsize
- t
<= 1)
9701 error ("Key sequence too long");
9705 /* Zap the position in key, so we know that we've
9706 expanded it, and don't try to do so again. */
9707 POSN_SET_POSN (EVENT_START (key
),
9708 Fcons (posn
, Qnil
));
9711 goto replay_sequence
;
9713 else if (CONSP (posn
))
9715 /* We're looking at the second event of a
9716 sequence which we expanded before. Set
9717 last_real_key_start appropriately. */
9718 if (last_real_key_start
== t
&& t
> 0)
9719 last_real_key_start
= t
- 1;
9724 /* We have finally decided that KEY is something we might want
9726 first_binding
= (follow_key (key
,
9727 nmaps
- first_binding
,
9728 submaps
+ first_binding
,
9729 defs
+ first_binding
,
9730 submaps
+ first_binding
)
9733 /* If KEY wasn't bound, we'll try some fallbacks. */
9734 if (first_binding
< nmaps
)
9735 /* This is needed for the following scenario:
9736 event 0: a down-event that gets dropped by calling replay_key.
9737 event 1: some normal prefix like C-h.
9738 After event 0, first_unbound is 0, after event 1 indec.start,
9739 fkey.start, and keytran.start are all 1, so when we see that
9740 C-h is bound, we need to update first_unbound. */
9741 first_unbound
= max (t
+ 1, first_unbound
);
9746 /* Remember the position to put an upper bound on indec.start. */
9747 first_unbound
= min (t
, first_unbound
);
9749 head
= EVENT_HEAD (key
);
9750 if (help_char_p (head
) && t
> 0)
9752 read_key_sequence_cmd
= Vprefix_help_command
;
9754 last_nonmenu_event
= key
;
9755 /* The Microsoft C compiler can't handle the goto that
9763 Lisp_Object breakdown
;
9766 breakdown
= parse_modifiers (head
);
9767 modifiers
= XINT (XCAR (XCDR (breakdown
)));
9768 /* Attempt to reduce an unbound mouse event to a simpler
9769 event that is bound:
9770 Drags reduce to clicks.
9771 Double-clicks reduce to clicks.
9772 Triple-clicks reduce to double-clicks, then to clicks.
9773 Down-clicks are eliminated.
9774 Double-downs reduce to downs, then are eliminated.
9775 Triple-downs reduce to double-downs, then to downs,
9776 then are eliminated. */
9777 if (modifiers
& (down_modifier
| drag_modifier
9778 | double_modifier
| triple_modifier
))
9780 while (modifiers
& (down_modifier
| drag_modifier
9781 | double_modifier
| triple_modifier
))
9783 Lisp_Object new_head
, new_click
;
9784 if (modifiers
& triple_modifier
)
9785 modifiers
^= (double_modifier
| triple_modifier
);
9786 else if (modifiers
& double_modifier
)
9787 modifiers
&= ~double_modifier
;
9788 else if (modifiers
& drag_modifier
)
9789 modifiers
&= ~drag_modifier
;
9792 /* Dispose of this `down' event by simply jumping
9793 back to replay_key, to get another event.
9795 Note that if this event came from mock input,
9796 then just jumping back to replay_key will just
9797 hand it to us again. So we have to wipe out any
9800 We could delete keybuf[t] and shift everything
9801 after that to the left by one spot, but we'd also
9802 have to fix up any variable that points into
9803 keybuf, and shifting isn't really necessary
9806 Adding prefixes for non-textual mouse clicks
9807 creates two characters of mock input, and both
9808 must be thrown away. If we're only looking at
9809 the prefix now, we can just jump back to
9810 replay_key. On the other hand, if we've already
9811 processed the prefix, and now the actual click
9812 itself is giving us trouble, then we've lost the
9813 state of the keymaps we want to backtrack to, and
9814 we need to replay the whole sequence to rebuild
9817 Beyond that, only function key expansion could
9818 create more than two keys, but that should never
9819 generate mouse events, so it's okay to zero
9820 mock_input in that case too.
9822 FIXME: The above paragraph seems just plain
9823 wrong, if you consider things like
9824 xterm-mouse-mode. -stef
9826 Isn't this just the most wonderful code ever? */
9828 /* If mock_input > t + 1, the above simplification
9829 will actually end up dropping keys on the floor.
9830 This is probably OK for now, but even
9831 if mock_input <= t + 1, we need to adjust indec,
9833 Typical case [header-line down-mouse-N]:
9834 mock_input = 2, t = 1, fkey.end = 1,
9835 last_real_key_start = 0. */
9836 if (indec
.end
> last_real_key_start
)
9838 indec
.end
= indec
.start
9839 = min (last_real_key_start
, indec
.start
);
9840 indec
.map
= indec
.parent
;
9841 if (fkey
.end
> last_real_key_start
)
9843 fkey
.end
= fkey
.start
9844 = min (last_real_key_start
, fkey
.start
);
9845 fkey
.map
= fkey
.parent
;
9846 if (keytran
.end
> last_real_key_start
)
9848 keytran
.end
= keytran
.start
9849 = min (last_real_key_start
, keytran
.start
);
9850 keytran
.map
= keytran
.parent
;
9854 if (t
== last_real_key_start
)
9861 mock_input
= last_real_key_start
;
9862 goto replay_sequence
;
9867 = apply_modifiers (modifiers
, XCAR (breakdown
));
9869 = Fcons (new_head
, Fcons (EVENT_START (key
), Qnil
));
9871 /* Look for a binding for this new key. follow_key
9872 promises that it didn't munge submaps the
9873 last time we called it, since key was unbound. */
9875 = (follow_key (new_click
,
9876 nmaps
- local_first_binding
,
9877 submaps
+ local_first_binding
,
9878 defs
+ local_first_binding
,
9879 submaps
+ local_first_binding
)
9880 + local_first_binding
);
9882 /* If that click is bound, go for it. */
9883 if (first_binding
< nmaps
)
9888 /* Otherwise, we'll leave key set to the drag event. */
9895 /* Normally, last_nonmenu_event gets the previous key we read.
9896 But when a mouse popup menu is being used,
9897 we don't update last_nonmenu_event; it continues to hold the mouse
9898 event that preceded the first level of menu. */
9899 if (!used_mouse_menu
)
9900 last_nonmenu_event
= key
;
9902 /* Record what part of this_command_keys is the current key sequence. */
9903 this_single_command_key_start
= this_command_key_count
- t
;
9905 /* Look for this sequence in input-decode-map.
9906 Scan from indec.end until we find a bound suffix. */
9907 while (indec
.end
< t
)
9909 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9912 GCPRO4 (indec
.map
, fkey
.map
, keytran
.map
, delayed_switch_frame
);
9913 done
= keyremap_step (keybuf
, bufsize
, &indec
, max (t
, mock_input
),
9918 mock_input
= diff
+ max (t
, mock_input
);
9919 goto replay_sequence
;
9923 if (first_binding
< nmaps
9924 && NILP (submaps
[first_binding
])
9925 && !test_undefined (defs
[first_binding
])
9926 && indec
.start
>= t
)
9927 /* There is a binding and it's not a prefix.
9928 (and it doesn't have any input-decode-map translation pending).
9929 There is thus no function-key in this sequence.
9930 Moving fkey.start is important in this case to allow keytran.start
9931 to go over the sequence before we return (since we keep the
9932 invariant that keytran.end <= fkey.start). */
9935 (fkey
.start
= fkey
.end
= t
, fkey
.map
= fkey
.parent
);
9938 /* If the sequence is unbound, see if we can hang a function key
9939 off the end of it. */
9940 /* Continue scan from fkey.end until we find a bound suffix. */
9941 while (fkey
.end
< indec
.start
)
9943 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9946 GCPRO4 (indec
.map
, fkey
.map
, keytran
.map
, delayed_switch_frame
);
9947 done
= keyremap_step (keybuf
, bufsize
, &fkey
,
9948 max (t
, mock_input
),
9949 /* If there's a binding (i.e.
9950 first_binding >= nmaps) we don't want
9951 to apply this function-key-mapping. */
9953 && (first_binding
>= nmaps
9954 || test_undefined (defs
[first_binding
])),
9959 mock_input
= diff
+ max (t
, mock_input
);
9960 /* Adjust the input-decode-map counters. */
9962 indec
.start
+= diff
;
9964 goto replay_sequence
;
9968 /* Look for this sequence in key-translation-map.
9969 Scan from keytran.end until we find a bound suffix. */
9970 while (keytran
.end
< fkey
.start
)
9972 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9975 GCPRO4 (indec
.map
, fkey
.map
, keytran
.map
, delayed_switch_frame
);
9976 done
= keyremap_step (keybuf
, bufsize
, &keytran
, max (t
, mock_input
),
9981 mock_input
= diff
+ max (t
, mock_input
);
9982 /* Adjust the function-key-map and input-decode-map counters. */
9984 indec
.start
+= diff
;
9988 goto replay_sequence
;
9992 /* If KEY is not defined in any of the keymaps,
9993 and cannot be part of a function key or translation,
9994 and is an upper case letter
9995 use the corresponding lower-case letter instead. */
9996 if (first_binding
>= nmaps
9997 && /* indec.start >= t && fkey.start >= t && */ keytran
.start
>= t
9999 && ((CHARACTERP (make_number (XINT (key
) & ~CHAR_MODIFIER_MASK
))
10000 && uppercasep (XINT (key
) & ~CHAR_MODIFIER_MASK
))
10001 || (XINT (key
) & shift_modifier
)))
10003 Lisp_Object new_key
;
10005 original_uppercase
= key
;
10006 original_uppercase_position
= t
- 1;
10008 if (XINT (key
) & shift_modifier
)
10009 XSETINT (new_key
, XINT (key
) & ~shift_modifier
);
10011 XSETINT (new_key
, (downcase (XINT (key
) & ~CHAR_MODIFIER_MASK
)
10012 | (XINT (key
) & CHAR_MODIFIER_MASK
)));
10014 /* We have to do this unconditionally, regardless of whether
10015 the lower-case char is defined in the keymaps, because they
10016 might get translated through function-key-map. */
10017 keybuf
[t
- 1] = new_key
;
10018 mock_input
= max (t
, mock_input
);
10019 shift_translated
= 1;
10021 goto replay_sequence
;
10023 /* If KEY is not defined in any of the keymaps,
10024 and cannot be part of a function key or translation,
10025 and is a shifted function key,
10026 use the corresponding unshifted function key instead. */
10027 if (first_binding
>= nmaps
10028 && /* indec.start >= t && fkey.start >= t && */ keytran
.start
>= t
)
10030 Lisp_Object breakdown
= parse_modifiers (key
);
10032 = CONSP (breakdown
) ? (XINT (XCAR (XCDR (breakdown
)))) : 0;
10034 if (modifiers
& shift_modifier
10035 /* Treat uppercase keys as shifted. */
10037 && (KEY_TO_CHAR (key
)
10038 < XCHAR_TABLE (BVAR (current_buffer
, downcase_table
))->header
.size
)
10039 && uppercasep (KEY_TO_CHAR (key
))))
10041 Lisp_Object new_key
10042 = (modifiers
& shift_modifier
10043 ? apply_modifiers (modifiers
& ~shift_modifier
,
10045 : make_number (downcase (KEY_TO_CHAR (key
)) | modifiers
));
10047 original_uppercase
= key
;
10048 original_uppercase_position
= t
- 1;
10050 /* We have to do this unconditionally, regardless of whether
10051 the lower-case char is defined in the keymaps, because they
10052 might get translated through function-key-map. */
10053 keybuf
[t
- 1] = new_key
;
10054 mock_input
= max (t
, mock_input
);
10055 /* Reset fkey (and consequently keytran) to apply
10056 function-key-map on the result, so that S-backspace is
10057 correctly mapped to DEL (via backspace). OTOH,
10058 input-decode-map doesn't need to go through it again. */
10059 fkey
.start
= fkey
.end
= 0;
10060 keytran
.start
= keytran
.end
= 0;
10061 shift_translated
= 1;
10063 goto replay_sequence
;
10068 read_key_sequence_cmd
= (first_binding
< nmaps
10069 ? defs
[first_binding
]
10071 read_key_sequence_remapped
10072 /* Remap command through active keymaps.
10073 Do the remapping here, before the unbind_to so it uses the keymaps
10074 of the appropriate buffer. */
10075 = SYMBOLP (read_key_sequence_cmd
)
10076 ? Fcommand_remapping (read_key_sequence_cmd
, Qnil
, Qnil
)
10079 unread_switch_frame
= delayed_switch_frame
;
10080 unbind_to (count
, Qnil
);
10082 /* Don't downcase the last character if the caller says don't.
10083 Don't downcase it if the result is undefined, either. */
10084 if ((dont_downcase_last
|| first_binding
>= nmaps
)
10086 && t
- 1 == original_uppercase_position
)
10088 keybuf
[t
- 1] = original_uppercase
;
10089 shift_translated
= 0;
10092 if (shift_translated
)
10093 Vthis_command_keys_shift_translated
= Qt
;
10095 /* Occasionally we fabricate events, perhaps by expanding something
10096 according to function-key-map, or by adding a prefix symbol to a
10097 mouse click in the scroll bar or modeline. In this cases, return
10098 the entire generated key sequence, even if we hit an unbound
10099 prefix or a definition before the end. This means that you will
10100 be able to push back the event properly, and also means that
10101 read-key-sequence will always return a logical unit.
10104 for (; t
< mock_input
; t
++)
10106 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
10107 && NILP (Fzerop (Vecho_keystrokes
)))
10108 echo_char (keybuf
[t
]);
10109 add_command_key (keybuf
[t
]);
10116 DEFUN ("read-key-sequence", Fread_key_sequence
, Sread_key_sequence
, 1, 5, 0,
10117 doc
: /* Read a sequence of keystrokes and return as a string or vector.
10118 The sequence is sufficient to specify a non-prefix command in the
10119 current local and global maps.
10121 First arg PROMPT is a prompt string. If nil, do not prompt specially.
10122 Second (optional) arg CONTINUE-ECHO, if non-nil, means this key echos
10123 as a continuation of the previous key.
10125 The third (optional) arg DONT-DOWNCASE-LAST, if non-nil, means do not
10126 convert the last event to lower case. (Normally any upper case event
10127 is converted to lower case if the original event is undefined and the lower
10128 case equivalent is defined.) A non-nil value is appropriate for reading
10129 a key sequence to be defined.
10131 A C-g typed while in this function is treated like any other character,
10132 and `quit-flag' is not set.
10134 If the key sequence starts with a mouse click, then the sequence is read
10135 using the keymaps of the buffer of the window clicked in, not the buffer
10136 of the selected window as normal.
10138 `read-key-sequence' drops unbound button-down events, since you normally
10139 only care about the click or drag events which follow them. If a drag
10140 or multi-click event is unbound, but the corresponding click event would
10141 be bound, `read-key-sequence' turns the event into a click event at the
10142 drag's starting position. This means that you don't have to distinguish
10143 between click and drag, double, or triple events unless you want to.
10145 `read-key-sequence' prefixes mouse events on mode lines, the vertical
10146 lines separating windows, and scroll bars with imaginary keys
10147 `mode-line', `vertical-line', and `vertical-scroll-bar'.
10149 Optional fourth argument CAN-RETURN-SWITCH-FRAME non-nil means that this
10150 function will process a switch-frame event if the user switches frames
10151 before typing anything. If the user switches frames in the middle of a
10152 key sequence, or at the start of the sequence but CAN-RETURN-SWITCH-FRAME
10153 is nil, then the event will be put off until after the current key sequence.
10155 `read-key-sequence' checks `function-key-map' for function key
10156 sequences, where they wouldn't conflict with ordinary bindings. See
10157 `function-key-map' for more details.
10159 The optional fifth argument CMD-LOOP, if non-nil, means
10160 that this key sequence is being read by something that will
10161 read commands one after another. It should be nil if the caller
10162 will read just one key sequence. */)
10163 (Lisp_Object prompt
, Lisp_Object continue_echo
, Lisp_Object dont_downcase_last
, Lisp_Object can_return_switch_frame
, Lisp_Object cmd_loop
)
10165 Lisp_Object keybuf
[30];
10167 struct gcpro gcpro1
;
10168 ptrdiff_t count
= SPECPDL_INDEX ();
10170 if (!NILP (prompt
))
10171 CHECK_STRING (prompt
);
10174 specbind (Qinput_method_exit_on_first_char
,
10175 (NILP (cmd_loop
) ? Qt
: Qnil
));
10176 specbind (Qinput_method_use_echo_area
,
10177 (NILP (cmd_loop
) ? Qt
: Qnil
));
10179 memset (keybuf
, 0, sizeof keybuf
);
10180 GCPRO1 (keybuf
[0]);
10181 gcpro1
.nvars
= (sizeof keybuf
/sizeof (keybuf
[0]));
10183 if (NILP (continue_echo
))
10185 this_command_key_count
= 0;
10186 this_command_key_count_reset
= 0;
10187 this_single_command_key_start
= 0;
10190 #ifdef HAVE_WINDOW_SYSTEM
10191 if (display_hourglass_p
)
10192 cancel_hourglass ();
10195 i
= read_key_sequence (keybuf
, (sizeof keybuf
/sizeof (keybuf
[0])),
10196 prompt
, ! NILP (dont_downcase_last
),
10197 ! NILP (can_return_switch_frame
), 0);
10199 #if 0 /* The following is fine for code reading a key sequence and
10200 then proceeding with a lengthy computation, but it's not good
10201 for code reading keys in a loop, like an input method. */
10202 #ifdef HAVE_WINDOW_SYSTEM
10203 if (display_hourglass_p
)
10204 start_hourglass ();
10214 return unbind_to (count
, make_event_array (i
, keybuf
));
10217 DEFUN ("read-key-sequence-vector", Fread_key_sequence_vector
,
10218 Sread_key_sequence_vector
, 1, 5, 0,
10219 doc
: /* Like `read-key-sequence' but always return a vector. */)
10220 (Lisp_Object prompt
, Lisp_Object continue_echo
, Lisp_Object dont_downcase_last
, Lisp_Object can_return_switch_frame
, Lisp_Object cmd_loop
)
10222 Lisp_Object keybuf
[30];
10224 struct gcpro gcpro1
;
10225 ptrdiff_t count
= SPECPDL_INDEX ();
10227 if (!NILP (prompt
))
10228 CHECK_STRING (prompt
);
10231 specbind (Qinput_method_exit_on_first_char
,
10232 (NILP (cmd_loop
) ? Qt
: Qnil
));
10233 specbind (Qinput_method_use_echo_area
,
10234 (NILP (cmd_loop
) ? Qt
: Qnil
));
10236 memset (keybuf
, 0, sizeof keybuf
);
10237 GCPRO1 (keybuf
[0]);
10238 gcpro1
.nvars
= (sizeof keybuf
/ sizeof (keybuf
[0]));
10240 if (NILP (continue_echo
))
10242 this_command_key_count
= 0;
10243 this_command_key_count_reset
= 0;
10244 this_single_command_key_start
= 0;
10247 #ifdef HAVE_WINDOW_SYSTEM
10248 if (display_hourglass_p
)
10249 cancel_hourglass ();
10252 i
= read_key_sequence (keybuf
, (sizeof keybuf
/ sizeof (keybuf
[0])),
10253 prompt
, ! NILP (dont_downcase_last
),
10254 ! NILP (can_return_switch_frame
), 0);
10256 #ifdef HAVE_WINDOW_SYSTEM
10257 if (display_hourglass_p
)
10258 start_hourglass ();
10267 return unbind_to (count
, Fvector (i
, keybuf
));
10270 DEFUN ("command-execute", Fcommand_execute
, Scommand_execute
, 1, 4, 0,
10271 doc
: /* Execute CMD as an editor command.
10272 CMD must be a symbol that satisfies the `commandp' predicate.
10273 Optional second arg RECORD-FLAG non-nil
10274 means unconditionally put this command in `command-history'.
10275 Otherwise, that is done only if an arg is read using the minibuffer.
10276 The argument KEYS specifies the value to use instead of (this-command-keys)
10277 when reading the arguments; if it is nil, (this-command-keys) is used.
10278 The argument SPECIAL, if non-nil, means that this command is executing
10279 a special event, so ignore the prefix argument and don't clear it. */)
10280 (Lisp_Object cmd
, Lisp_Object record_flag
, Lisp_Object keys
, Lisp_Object special
)
10282 register Lisp_Object final
;
10283 register Lisp_Object tem
;
10284 Lisp_Object prefixarg
;
10286 debug_on_next_call
= 0;
10288 if (NILP (special
))
10290 prefixarg
= KVAR (current_kboard
, Vprefix_arg
);
10291 Vcurrent_prefix_arg
= prefixarg
;
10292 kset_prefix_arg (current_kboard
, Qnil
);
10299 tem
= Fget (cmd
, Qdisabled
);
10302 tem
= Fsymbol_value (Qdisabled_command_function
);
10304 return Frun_hooks (1, &Qdisabled_command_function
);
10310 final
= Findirect_function (cmd
, Qnil
);
10312 if (CONSP (final
) && (tem
= Fcar (final
), EQ (tem
, Qautoload
)))
10314 struct gcpro gcpro1
, gcpro2
;
10316 GCPRO2 (cmd
, prefixarg
);
10317 Fautoload_do_load (final
, cmd
, Qnil
);
10324 if (STRINGP (final
) || VECTORP (final
))
10326 /* If requested, place the macro in the command history. For
10327 other sorts of commands, call-interactively takes care of
10329 if (!NILP (record_flag
))
10332 = Fcons (Fcons (Qexecute_kbd_macro
,
10333 Fcons (final
, Fcons (prefixarg
, Qnil
))),
10336 /* Don't keep command history around forever. */
10337 if (NUMBERP (Vhistory_length
) && XINT (Vhistory_length
) > 0)
10339 tem
= Fnthcdr (Vhistory_length
, Vcommand_history
);
10341 XSETCDR (tem
, Qnil
);
10345 return Fexecute_kbd_macro (final
, prefixarg
, Qnil
);
10348 if (CONSP (final
) || SUBRP (final
) || COMPILEDP (final
))
10349 /* Don't call Fcall_interactively directly because we want to make
10350 sure the backtrace has an entry for `call-interactively'.
10351 For the same reason, pass `cmd' rather than `final'. */
10352 return call3 (Qcall_interactively
, cmd
, record_flag
, keys
);
10359 /* Return nonzero if input events are pending. */
10362 detect_input_pending (void)
10364 if (!input_pending
)
10365 get_input_pending (&input_pending
, 0);
10367 return input_pending
;
10370 /* Return nonzero if input events other than mouse movements are
10374 detect_input_pending_ignore_squeezables (void)
10376 if (!input_pending
)
10377 get_input_pending (&input_pending
, READABLE_EVENTS_IGNORE_SQUEEZABLES
);
10379 return input_pending
;
10382 /* Return nonzero if input events are pending, and run any pending timers. */
10385 detect_input_pending_run_timers (int do_display
)
10387 int old_timers_run
= timers_run
;
10389 if (!input_pending
)
10390 get_input_pending (&input_pending
, READABLE_EVENTS_DO_TIMERS_NOW
);
10392 if (old_timers_run
!= timers_run
&& do_display
)
10394 redisplay_preserve_echo_area (8);
10395 /* The following fixes a bug when using lazy-lock with
10396 lazy-lock-defer-on-the-fly set to t, i.e. when fontifying
10397 from an idle timer function. The symptom of the bug is that
10398 the cursor sometimes doesn't become visible until the next X
10399 event is processed. --gerd. */
10401 Lisp_Object tail
, frame
;
10402 FOR_EACH_FRAME (tail
, frame
)
10403 if (FRAME_RIF (XFRAME (frame
)))
10404 FRAME_RIF (XFRAME (frame
))->flush_display (XFRAME (frame
));
10408 return input_pending
;
10411 /* This is called in some cases before a possible quit.
10412 It cases the next call to detect_input_pending to recompute input_pending.
10413 So calling this function unnecessarily can't do any harm. */
10416 clear_input_pending (void)
10421 /* Return nonzero if there are pending requeued events.
10422 This isn't used yet. The hope is to make wait_reading_process_output
10423 call it, and return if it runs Lisp code that unreads something.
10424 The problem is, kbd_buffer_get_event needs to be fixed to know what
10425 to do in that case. It isn't trivial. */
10428 requeued_events_pending_p (void)
10430 return (!NILP (Vunread_command_events
));
10434 DEFUN ("input-pending-p", Finput_pending_p
, Sinput_pending_p
, 0, 0, 0,
10435 doc
: /* Return t if command input is currently available with no wait.
10436 Actually, the value is nil only if we can be sure that no input is available;
10437 if there is a doubt, the value is t. */)
10440 if (!NILP (Vunread_command_events
)
10441 || !NILP (Vunread_post_input_method_events
)
10442 || !NILP (Vunread_input_method_events
))
10445 /* Process non-user-visible events (Bug#10195). */
10446 process_special_events ();
10448 get_input_pending (&input_pending
,
10449 READABLE_EVENTS_DO_TIMERS_NOW
10450 | READABLE_EVENTS_FILTER_EVENTS
);
10451 return input_pending
> 0 ? Qt
: Qnil
;
10454 DEFUN ("recent-keys", Frecent_keys
, Srecent_keys
, 0, 0, 0,
10455 doc
: /* Return vector of last 300 events, not counting those from keyboard macros. */)
10458 Lisp_Object
*keys
= XVECTOR (recent_keys
)->contents
;
10461 if (total_keys
< NUM_RECENT_KEYS
)
10462 return Fvector (total_keys
, keys
);
10465 val
= Fvector (NUM_RECENT_KEYS
, keys
);
10466 vcopy (val
, 0, keys
+ recent_keys_index
,
10467 NUM_RECENT_KEYS
- recent_keys_index
);
10468 vcopy (val
, NUM_RECENT_KEYS
- recent_keys_index
,
10469 keys
, recent_keys_index
);
10474 DEFUN ("this-command-keys", Fthis_command_keys
, Sthis_command_keys
, 0, 0, 0,
10475 doc
: /* Return the key sequence that invoked this command.
10476 However, if the command has called `read-key-sequence', it returns
10477 the last key sequence that has been read.
10478 The value is a string or a vector.
10480 See also `this-command-keys-vector'. */)
10483 return make_event_array (this_command_key_count
,
10484 XVECTOR (this_command_keys
)->contents
);
10487 DEFUN ("this-command-keys-vector", Fthis_command_keys_vector
, Sthis_command_keys_vector
, 0, 0, 0,
10488 doc
: /* Return the key sequence that invoked this command, as a vector.
10489 However, if the command has called `read-key-sequence', it returns
10490 the last key sequence that has been read.
10492 See also `this-command-keys'. */)
10495 return Fvector (this_command_key_count
,
10496 XVECTOR (this_command_keys
)->contents
);
10499 DEFUN ("this-single-command-keys", Fthis_single_command_keys
,
10500 Sthis_single_command_keys
, 0, 0, 0,
10501 doc
: /* Return the key sequence that invoked this command.
10502 More generally, it returns the last key sequence read, either by
10503 the command loop or by `read-key-sequence'.
10504 Unlike `this-command-keys', this function's value
10505 does not include prefix arguments.
10506 The value is always a vector. */)
10509 return Fvector (this_command_key_count
10510 - this_single_command_key_start
,
10511 (XVECTOR (this_command_keys
)->contents
10512 + this_single_command_key_start
));
10515 DEFUN ("this-single-command-raw-keys", Fthis_single_command_raw_keys
,
10516 Sthis_single_command_raw_keys
, 0, 0, 0,
10517 doc
: /* Return the raw events that were read for this command.
10518 More generally, it returns the last key sequence read, either by
10519 the command loop or by `read-key-sequence'.
10520 Unlike `this-single-command-keys', this function's value
10521 shows the events before all translations (except for input methods).
10522 The value is always a vector. */)
10525 return Fvector (raw_keybuf_count
,
10526 (XVECTOR (raw_keybuf
)->contents
));
10529 DEFUN ("reset-this-command-lengths", Freset_this_command_lengths
,
10530 Sreset_this_command_lengths
, 0, 0, 0,
10531 doc
: /* Make the unread events replace the last command and echo.
10532 Used in `universal-argument-other-key'.
10534 `universal-argument-other-key' rereads the event just typed.
10535 It then gets translated through `function-key-map'.
10536 The translated event has to replace the real events,
10537 both in the value of (this-command-keys) and in echoing.
10538 To achieve this, `universal-argument-other-key' calls
10539 `reset-this-command-lengths', which discards the record of reading
10540 these events the first time. */)
10543 this_command_key_count
= before_command_key_count
;
10544 if (this_command_key_count
< this_single_command_key_start
)
10545 this_single_command_key_start
= this_command_key_count
;
10547 echo_truncate (before_command_echo_length
);
10549 /* Cause whatever we put into unread-command-events
10550 to echo as if it were being freshly read from the keyboard. */
10551 this_command_key_count_reset
= 1;
10556 DEFUN ("clear-this-command-keys", Fclear_this_command_keys
,
10557 Sclear_this_command_keys
, 0, 1, 0,
10558 doc
: /* Clear out the vector that `this-command-keys' returns.
10559 Also clear the record of the last 100 events, unless optional arg
10560 KEEP-RECORD is non-nil. */)
10561 (Lisp_Object keep_record
)
10565 this_command_key_count
= 0;
10566 this_command_key_count_reset
= 0;
10568 if (NILP (keep_record
))
10570 for (i
= 0; i
< ASIZE (recent_keys
); ++i
)
10571 ASET (recent_keys
, i
, Qnil
);
10573 recent_keys_index
= 0;
10578 DEFUN ("recursion-depth", Frecursion_depth
, Srecursion_depth
, 0, 0, 0,
10579 doc
: /* Return the current depth in recursive edits. */)
10583 /* Wrap around reliably on integer overflow. */
10584 EMACS_INT sum
= (command_loop_level
& INTMASK
) + (minibuf_level
& INTMASK
);
10585 XSETINT (temp
, sum
);
10589 DEFUN ("open-dribble-file", Fopen_dribble_file
, Sopen_dribble_file
, 1, 1,
10590 "FOpen dribble file: ",
10591 doc
: /* Start writing all keyboard characters to a dribble file called FILE.
10592 If FILE is nil, close any open dribble file.
10593 The file will be closed when Emacs exits. */)
10605 file
= Fexpand_file_name (file
, Qnil
);
10606 dribble
= fopen (SSDATA (file
), "w");
10608 report_file_error ("Opening dribble", Fcons (file
, Qnil
));
10613 DEFUN ("discard-input", Fdiscard_input
, Sdiscard_input
, 0, 0, 0,
10614 doc
: /* Discard the contents of the terminal input buffer.
10615 Also end any kbd macro being defined. */)
10618 if (!NILP (KVAR (current_kboard
, defining_kbd_macro
)))
10620 /* Discard the last command from the macro. */
10621 Fcancel_kbd_macro_events ();
10625 update_mode_lines
++;
10627 Vunread_command_events
= Qnil
;
10629 discard_tty_input ();
10631 kbd_fetch_ptr
= kbd_store_ptr
;
10637 DEFUN ("suspend-emacs", Fsuspend_emacs
, Ssuspend_emacs
, 0, 1, "",
10638 doc
: /* Stop Emacs and return to superior process. You can resume later.
10639 If `cannot-suspend' is non-nil, or if the system doesn't support job
10640 control, run a subshell instead.
10642 If optional arg STUFFSTRING is non-nil, its characters are stuffed
10643 to be read as terminal input by Emacs's parent, after suspension.
10645 Before suspending, run the normal hook `suspend-hook'.
10646 After resumption run the normal hook `suspend-resume-hook'.
10648 Some operating systems cannot stop the Emacs process and resume it later.
10649 On such systems, Emacs starts a subshell instead of suspending. */)
10650 (Lisp_Object stuffstring
)
10652 ptrdiff_t count
= SPECPDL_INDEX ();
10653 int old_height
, old_width
;
10655 struct gcpro gcpro1
;
10658 if (tty_list
&& tty_list
->next
)
10659 error ("There are other tty frames open; close them before suspending Emacs");
10661 if (!NILP (stuffstring
))
10662 CHECK_STRING (stuffstring
);
10664 /* Run the functions in suspend-hook. */
10665 hook
= intern ("suspend-hook");
10666 Frun_hooks (1, &hook
);
10668 GCPRO1 (stuffstring
);
10669 get_tty_size (fileno (CURTTY ()->input
), &old_width
, &old_height
);
10670 reset_all_sys_modes ();
10671 /* sys_suspend can get an error if it tries to fork a subshell
10672 and the system resources aren't available for that. */
10673 record_unwind_protect ((Lisp_Object (*) (Lisp_Object
)) init_all_sys_modes
,
10675 stuff_buffered_input (stuffstring
);
10676 if (cannot_suspend
)
10680 unbind_to (count
, Qnil
);
10682 /* Check if terminal/window size has changed.
10683 Note that this is not useful when we are running directly
10684 with a window system; but suspend should be disabled in that case. */
10685 get_tty_size (fileno (CURTTY ()->input
), &width
, &height
);
10686 if (width
!= old_width
|| height
!= old_height
)
10687 change_frame_size (SELECTED_FRAME (), height
, width
, 0, 0, 0);
10689 /* Run suspend-resume-hook. */
10690 hook
= intern ("suspend-resume-hook");
10691 Frun_hooks (1, &hook
);
10697 /* If STUFFSTRING is a string, stuff its contents as pending terminal input.
10698 Then in any case stuff anything Emacs has read ahead and not used. */
10701 stuff_buffered_input (Lisp_Object stuffstring
)
10703 #ifdef SIGTSTP /* stuff_char is defined if SIGTSTP. */
10704 register unsigned char *p
;
10706 if (STRINGP (stuffstring
))
10708 register ptrdiff_t count
;
10710 p
= SDATA (stuffstring
);
10711 count
= SBYTES (stuffstring
);
10712 while (count
-- > 0)
10717 /* Anything we have read ahead, put back for the shell to read. */
10718 /* ?? What should this do when we have multiple keyboards??
10719 Should we ignore anything that was typed in at the "wrong" kboard?
10721 rms: we should stuff everything back into the kboard
10723 for (; kbd_fetch_ptr
!= kbd_store_ptr
; kbd_fetch_ptr
++)
10726 if (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
10727 kbd_fetch_ptr
= kbd_buffer
;
10728 if (kbd_fetch_ptr
->kind
== ASCII_KEYSTROKE_EVENT
)
10729 stuff_char (kbd_fetch_ptr
->code
);
10731 clear_event (kbd_fetch_ptr
);
10735 #endif /* SIGTSTP */
10739 set_waiting_for_input (EMACS_TIME
*time_to_clear
)
10741 input_available_clear_time
= time_to_clear
;
10743 /* Tell handle_interrupt to throw back to read_char, */
10744 waiting_for_input
= 1;
10746 /* If handle_interrupt was called before and buffered a C-g,
10747 make it run again now, to avoid timing error. */
10748 if (!NILP (Vquit_flag
))
10749 quit_throw_to_read_char (0);
10753 clear_waiting_for_input (void)
10755 /* Tell handle_interrupt not to throw back to read_char, */
10756 waiting_for_input
= 0;
10757 input_available_clear_time
= 0;
10760 /* The SIGINT handler.
10762 If we have a frame on the controlling tty, we assume that the
10763 SIGINT was generated by C-g, so we call handle_interrupt.
10764 Otherwise, tell QUIT to kill Emacs. */
10767 handle_interrupt_signal (int sig
)
10769 /* See if we have an active terminal on our controlling tty. */
10770 struct terminal
*terminal
= get_named_tty ("/dev/tty");
10773 /* If there are no frames there, let's pretend that we are a
10774 well-behaving UN*X program and quit. We must not call Lisp
10775 in a signal handler, so tell QUIT to exit when it is
10777 Vquit_flag
= Qkill_emacs
;
10781 /* Otherwise, the SIGINT was probably generated by C-g. */
10783 /* Set internal_last_event_frame to the top frame of the
10784 controlling tty, if we have a frame there. We disable the
10785 interrupt key on secondary ttys, so the SIGINT must have come
10786 from the controlling tty. */
10787 internal_last_event_frame
= terminal
->display_info
.tty
->top_frame
;
10789 handle_interrupt ();
10794 deliver_interrupt_signal (int sig
)
10796 handle_on_main_thread (sig
, handle_interrupt_signal
);
10800 /* If Emacs is stuck because `inhibit-quit' is true, then keep track
10801 of the number of times C-g has been requested. If C-g is pressed
10802 enough times, then quit anyway. See bug#6585. */
10803 static int force_quit_count
;
10805 /* This routine is called at interrupt level in response to C-g.
10807 It is called from the SIGINT handler or kbd_buffer_store_event.
10809 If `waiting_for_input' is non zero, then unless `echoing' is
10810 nonzero, immediately throw back to read_char.
10812 Otherwise it sets the Lisp variable quit-flag not-nil. This causes
10813 eval to throw, when it gets a chance. If quit-flag is already
10814 non-nil, it stops the job right away. */
10817 handle_interrupt (void)
10823 /* XXX This code needs to be revised for multi-tty support. */
10824 if (!NILP (Vquit_flag
) && get_named_tty ("/dev/tty"))
10826 /* If SIGINT isn't blocked, don't let us be interrupted by
10827 another SIGINT, it might be harmful due to non-reentrancy
10828 in I/O functions. */
10830 sigemptyset (&blocked
);
10831 sigaddset (&blocked
, SIGINT
);
10832 pthread_sigmask (SIG_BLOCK
, &blocked
, 0);
10835 reset_all_sys_modes ();
10837 #ifdef SIGTSTP /* Support possible in later USG versions */
10839 * On systems which can suspend the current process and return to the original
10840 * shell, this command causes the user to end up back at the shell.
10841 * The "Auto-save" and "Abort" questions are not asked until
10842 * the user elects to return to emacs, at which point he can save the current
10843 * job and either dump core or continue.
10847 /* Perhaps should really fork an inferior shell?
10848 But that would not provide any way to get back
10849 to the original shell, ever. */
10850 printf ("No support for stopping a process on this operating system;\n");
10851 printf ("you can continue or abort.\n");
10852 #endif /* not SIGTSTP */
10854 /* We must remain inside the screen area when the internal terminal
10855 is used. Note that [Enter] is not echoed by dos. */
10856 cursor_to (SELECTED_FRAME (), 0, 0);
10858 /* It doesn't work to autosave while GC is in progress;
10859 the code used for auto-saving doesn't cope with the mark bit. */
10860 if (!gc_in_progress
)
10862 printf ("Auto-save? (y or n) ");
10864 if (((c
= getchar ()) & ~040) == 'Y')
10866 Fdo_auto_save (Qt
, Qnil
);
10868 printf ("\r\nAuto-save done");
10869 #else /* not MSDOS */
10870 printf ("Auto-save done\n");
10871 #endif /* not MSDOS */
10873 while (c
!= '\n') c
= getchar ();
10877 /* During GC, it must be safe to reenable quitting again. */
10878 Vinhibit_quit
= Qnil
;
10881 #endif /* not MSDOS */
10882 printf ("Garbage collection in progress; cannot auto-save now\r\n");
10883 printf ("but will instead do a real quit after garbage collection ends\r\n");
10888 printf ("\r\nAbort? (y or n) ");
10889 #else /* not MSDOS */
10890 printf ("Abort (and dump core)? (y or n) ");
10891 #endif /* not MSDOS */
10893 if (((c
= getchar ()) & ~040) == 'Y')
10895 while (c
!= '\n') c
= getchar ();
10897 printf ("\r\nContinuing...\r\n");
10898 #else /* not MSDOS */
10899 printf ("Continuing...\n");
10900 #endif /* not MSDOS */
10902 init_all_sys_modes ();
10903 pthread_sigmask (SIG_SETMASK
, &empty_mask
, 0);
10907 /* If executing a function that wants to be interrupted out of
10908 and the user has not deferred quitting by binding `inhibit-quit'
10909 then quit right away. */
10910 if (immediate_quit
&& NILP (Vinhibit_quit
))
10912 struct gl_state_s saved
;
10913 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
10915 immediate_quit
= 0;
10916 pthread_sigmask (SIG_SETMASK
, &empty_mask
, 0);
10918 GCPRO4 (saved
.object
, saved
.global_code
,
10919 saved
.current_syntax_table
, saved
.old_prop
);
10920 Fsignal (Qquit
, Qnil
);
10921 /* FIXME: AFAIK, `quit' can never return, so this code is dead! */
10926 { /* Else request quit when it's safe. */
10927 if (NILP (Vquit_flag
))
10928 force_quit_count
= 0;
10929 if (++force_quit_count
== 3)
10931 immediate_quit
= 1;
10932 Vinhibit_quit
= Qnil
;
10938 /* TODO: The longjmp in this call throws the NS event loop integration off,
10939 and it seems to do fine without this. Probably some attention
10940 needs to be paid to the setting of waiting_for_input in
10941 wait_reading_process_output() under HAVE_NS because of the call
10942 to ns_select there (needed because otherwise events aren't picked up
10943 outside of polling since we don't get SIGIO like X and we don't have a
10944 separate event loop thread like W32. */
10946 if (waiting_for_input
&& !echoing
)
10947 quit_throw_to_read_char (1);
10951 /* Handle a C-g by making read_char return C-g. */
10954 quit_throw_to_read_char (int from_signal
)
10956 /* When not called from a signal handler it is safe to call
10958 if (!from_signal
&& EQ (Vquit_flag
, Qkill_emacs
))
10959 Fkill_emacs (Qnil
);
10961 pthread_sigmask (SIG_SETMASK
, &empty_mask
, 0);
10962 /* Prevent another signal from doing this before we finish. */
10963 clear_waiting_for_input ();
10966 Vunread_command_events
= Qnil
;
10968 #if 0 /* Currently, sit_for is called from read_char without turning
10969 off polling. And that can call set_waiting_for_input.
10970 It seems to be harmless. */
10971 #ifdef POLL_FOR_INPUT
10972 /* May be > 1 if in recursive minibuffer. */
10973 if (poll_suppress_count
== 0)
10977 if (FRAMEP (internal_last_event_frame
)
10978 && !EQ (internal_last_event_frame
, selected_frame
))
10979 do_switch_frame (make_lispy_switch_frame (internal_last_event_frame
),
10982 _longjmp (getcjmp
, 1);
10985 DEFUN ("set-input-interrupt-mode", Fset_input_interrupt_mode
,
10986 Sset_input_interrupt_mode
, 1, 1, 0,
10987 doc
: /* Set interrupt mode of reading keyboard input.
10988 If INTERRUPT is non-nil, Emacs will use input interrupts;
10989 otherwise Emacs uses CBREAK mode.
10991 See also `current-input-mode'. */)
10992 (Lisp_Object interrupt
)
10994 int new_interrupt_input
;
10995 #ifdef USABLE_SIGIO
10996 #ifdef HAVE_X_WINDOWS
10997 if (x_display_list
!= NULL
)
10999 /* When using X, don't give the user a real choice,
11000 because we haven't implemented the mechanisms to support it. */
11001 new_interrupt_input
= 1;
11004 #endif /* HAVE_X_WINDOWS */
11005 new_interrupt_input
= !NILP (interrupt
);
11006 #else /* not USABLE_SIGIO */
11007 new_interrupt_input
= 0;
11008 #endif /* not USABLE_SIGIO */
11010 if (new_interrupt_input
!= interrupt_input
)
11012 #ifdef POLL_FOR_INPUT
11016 /* this causes startup screen to be restored and messes with the mouse */
11017 reset_all_sys_modes ();
11018 interrupt_input
= new_interrupt_input
;
11019 init_all_sys_modes ();
11021 interrupt_input
= new_interrupt_input
;
11024 #ifdef POLL_FOR_INPUT
11025 poll_suppress_count
= 1;
11032 DEFUN ("set-output-flow-control", Fset_output_flow_control
, Sset_output_flow_control
, 1, 2, 0,
11033 doc
: /* Enable or disable ^S/^Q flow control for output to TERMINAL.
11034 If FLOW is non-nil, flow control is enabled and you cannot use C-s or
11035 C-q in key sequences.
11037 This setting only has an effect on tty terminals and only when
11038 Emacs reads input in CBREAK mode; see `set-input-interrupt-mode'.
11040 See also `current-input-mode'. */)
11041 (Lisp_Object flow
, Lisp_Object terminal
)
11043 struct terminal
*t
= get_terminal (terminal
, 1);
11044 struct tty_display_info
*tty
;
11045 if (t
== NULL
|| (t
->type
!= output_termcap
&& t
->type
!= output_msdos_raw
))
11047 tty
= t
->display_info
.tty
;
11049 if (tty
->flow_control
!= !NILP (flow
))
11052 /* this causes startup screen to be restored and messes with the mouse */
11053 reset_sys_modes (tty
);
11056 tty
->flow_control
= !NILP (flow
);
11059 init_sys_modes (tty
);
11065 DEFUN ("set-input-meta-mode", Fset_input_meta_mode
, Sset_input_meta_mode
, 1, 2, 0,
11066 doc
: /* Enable or disable 8-bit input on TERMINAL.
11067 If META is t, Emacs will accept 8-bit input, and interpret the 8th
11068 bit as the Meta modifier.
11070 If META is nil, Emacs will ignore the top bit, on the assumption it is
11073 Otherwise, Emacs will accept and pass through 8-bit input without
11074 specially interpreting the top bit.
11076 This setting only has an effect on tty terminal devices.
11078 Optional parameter TERMINAL specifies the tty terminal device to use.
11079 It may be a terminal object, a frame, or nil for the terminal used by
11080 the currently selected frame.
11082 See also `current-input-mode'. */)
11083 (Lisp_Object meta
, Lisp_Object terminal
)
11085 struct terminal
*t
= get_terminal (terminal
, 1);
11086 struct tty_display_info
*tty
;
11089 if (t
== NULL
|| (t
->type
!= output_termcap
&& t
->type
!= output_msdos_raw
))
11091 tty
= t
->display_info
.tty
;
11095 else if (EQ (meta
, Qt
))
11100 if (tty
->meta_key
!= new_meta
)
11103 /* this causes startup screen to be restored and messes with the mouse */
11104 reset_sys_modes (tty
);
11107 tty
->meta_key
= new_meta
;
11110 init_sys_modes (tty
);
11116 DEFUN ("set-quit-char", Fset_quit_char
, Sset_quit_char
, 1, 1, 0,
11117 doc
: /* Specify character used for quitting.
11118 QUIT must be an ASCII character.
11120 This function only has an effect on the controlling tty of the Emacs
11123 See also `current-input-mode'. */)
11126 struct terminal
*t
= get_named_tty ("/dev/tty");
11127 struct tty_display_info
*tty
;
11128 if (t
== NULL
|| (t
->type
!= output_termcap
&& t
->type
!= output_msdos_raw
))
11130 tty
= t
->display_info
.tty
;
11132 if (NILP (quit
) || !INTEGERP (quit
) || XINT (quit
) < 0 || XINT (quit
) > 0400)
11133 error ("QUIT must be an ASCII character");
11136 /* this causes startup screen to be restored and messes with the mouse */
11137 reset_sys_modes (tty
);
11140 /* Don't let this value be out of range. */
11141 quit_char
= XINT (quit
) & (tty
->meta_key
== 0 ? 0177 : 0377);
11144 init_sys_modes (tty
);
11150 DEFUN ("set-input-mode", Fset_input_mode
, Sset_input_mode
, 3, 4, 0,
11151 doc
: /* Set mode of reading keyboard input.
11152 First arg INTERRUPT non-nil means use input interrupts;
11153 nil means use CBREAK mode.
11154 Second arg FLOW non-nil means use ^S/^Q flow control for output to terminal
11155 (no effect except in CBREAK mode).
11156 Third arg META t means accept 8-bit input (for a Meta key).
11157 META nil means ignore the top bit, on the assumption it is parity.
11158 Otherwise, accept 8-bit input and don't use the top bit for Meta.
11159 Optional fourth arg QUIT if non-nil specifies character to use for quitting.
11160 See also `current-input-mode'. */)
11161 (Lisp_Object interrupt
, Lisp_Object flow
, Lisp_Object meta
, Lisp_Object quit
)
11163 Fset_input_interrupt_mode (interrupt
);
11164 Fset_output_flow_control (flow
, Qnil
);
11165 Fset_input_meta_mode (meta
, Qnil
);
11167 Fset_quit_char (quit
);
11171 DEFUN ("current-input-mode", Fcurrent_input_mode
, Scurrent_input_mode
, 0, 0, 0,
11172 doc
: /* Return information about the way Emacs currently reads keyboard input.
11173 The value is a list of the form (INTERRUPT FLOW META QUIT), where
11174 INTERRUPT is non-nil if Emacs is using interrupt-driven input; if
11175 nil, Emacs is using CBREAK mode.
11176 FLOW is non-nil if Emacs uses ^S/^Q flow control for output to the
11177 terminal; this does not apply if Emacs uses interrupt-driven input.
11178 META is t if accepting 8-bit input with 8th bit as Meta flag.
11179 META nil means ignoring the top bit, on the assumption it is parity.
11180 META is neither t nor nil if accepting 8-bit input and using
11181 all 8 bits as the character code.
11182 QUIT is the character Emacs currently uses to quit.
11183 The elements of this list correspond to the arguments of
11184 `set-input-mode'. */)
11187 Lisp_Object val
[4];
11188 struct frame
*sf
= XFRAME (selected_frame
);
11190 val
[0] = interrupt_input
? Qt
: Qnil
;
11191 if (FRAME_TERMCAP_P (sf
) || FRAME_MSDOS_P (sf
))
11193 val
[1] = FRAME_TTY (sf
)->flow_control
? Qt
: Qnil
;
11194 val
[2] = (FRAME_TTY (sf
)->meta_key
== 2
11196 : (CURTTY ()->meta_key
== 1 ? Qt
: Qnil
));
11203 XSETFASTINT (val
[3], quit_char
);
11205 return Flist (sizeof (val
) / sizeof (val
[0]), val
);
11208 DEFUN ("posn-at-x-y", Fposn_at_x_y
, Sposn_at_x_y
, 2, 4, 0,
11209 doc
: /* Return position information for pixel coordinates X and Y.
11210 By default, X and Y are relative to text area of the selected window.
11211 Optional third arg FRAME-OR-WINDOW non-nil specifies frame or window.
11212 If optional fourth arg WHOLE is non-nil, X is relative to the left
11213 edge of the window.
11215 The return value is similar to a mouse click position:
11216 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
11217 IMAGE (DX . DY) (WIDTH . HEIGHT))
11218 The `posn-' functions access elements of such lists. */)
11219 (Lisp_Object x
, Lisp_Object y
, Lisp_Object frame_or_window
, Lisp_Object whole
)
11224 if (NILP (frame_or_window
))
11225 frame_or_window
= selected_window
;
11227 if (WINDOWP (frame_or_window
))
11229 struct window
*w
= decode_live_window (frame_or_window
);
11231 XSETINT (x
, (XINT (x
)
11232 + WINDOW_LEFT_EDGE_X (w
)
11234 ? window_box_left_offset (w
, TEXT_AREA
)
11236 XSETINT (y
, WINDOW_TO_FRAME_PIXEL_Y (w
, XINT (y
)));
11237 frame_or_window
= w
->frame
;
11240 CHECK_LIVE_FRAME (frame_or_window
);
11242 return make_lispy_position (XFRAME (frame_or_window
), x
, y
, 0);
11245 DEFUN ("posn-at-point", Fposn_at_point
, Sposn_at_point
, 0, 2, 0,
11246 doc
: /* Return position information for buffer POS in WINDOW.
11247 POS defaults to point in WINDOW; WINDOW defaults to the selected window.
11249 Return nil if position is not visible in window. Otherwise,
11250 the return value is similar to that returned by `event-start' for
11251 a mouse click at the upper left corner of the glyph corresponding
11252 to the given buffer position:
11253 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
11254 IMAGE (DX . DY) (WIDTH . HEIGHT))
11255 The `posn-' functions access elements of such lists. */)
11256 (Lisp_Object pos
, Lisp_Object window
)
11261 window
= selected_window
;
11263 tem
= Fpos_visible_in_window_p (pos
, window
, Qt
);
11266 Lisp_Object x
= XCAR (tem
);
11267 Lisp_Object y
= XCAR (XCDR (tem
));
11269 /* Point invisible due to hscrolling? */
11272 tem
= Fposn_at_x_y (x
, y
, window
, Qnil
);
11280 * Set up a new kboard object with reasonable initial values.
11283 init_kboard (KBOARD
*kb
)
11285 kset_overriding_terminal_local_map (kb
, Qnil
);
11286 kset_last_command (kb
, Qnil
);
11287 kset_real_last_command (kb
, Qnil
);
11288 kset_keyboard_translate_table (kb
, Qnil
);
11289 kset_last_repeatable_command (kb
, Qnil
);
11290 kset_prefix_arg (kb
, Qnil
);
11291 kset_last_prefix_arg (kb
, Qnil
);
11292 kset_kbd_queue (kb
, Qnil
);
11293 kb
->kbd_queue_has_data
= 0;
11294 kb
->immediate_echo
= 0;
11295 kset_echo_string (kb
, Qnil
);
11296 kb
->echo_after_prompt
= -1;
11297 kb
->kbd_macro_buffer
= 0;
11298 kb
->kbd_macro_bufsize
= 0;
11299 kset_defining_kbd_macro (kb
, Qnil
);
11300 kset_last_kbd_macro (kb
, Qnil
);
11301 kb
->reference_count
= 0;
11302 kset_system_key_alist (kb
, Qnil
);
11303 kset_system_key_syms (kb
, Qnil
);
11304 kset_window_system (kb
, Qt
); /* Unset. */
11305 kset_input_decode_map (kb
, Fmake_sparse_keymap (Qnil
));
11306 kset_local_function_key_map (kb
, Fmake_sparse_keymap (Qnil
));
11307 Fset_keymap_parent (KVAR (kb
, Vlocal_function_key_map
), Vfunction_key_map
);
11308 kset_default_minibuffer_frame (kb
, Qnil
);
11312 * Destroy the contents of a kboard object, but not the object itself.
11313 * We use this just before deleting it, or if we're going to initialize
11314 * it a second time.
11317 wipe_kboard (KBOARD
*kb
)
11319 xfree (kb
->kbd_macro_buffer
);
11322 /* Free KB and memory referenced from it. */
11325 delete_kboard (KBOARD
*kb
)
11329 for (kbp
= &all_kboards
; *kbp
!= kb
; kbp
= &(*kbp
)->next_kboard
)
11332 *kbp
= kb
->next_kboard
;
11334 /* Prevent a dangling reference to KB. */
11335 if (kb
== current_kboard
11336 && FRAMEP (selected_frame
)
11337 && FRAME_LIVE_P (XFRAME (selected_frame
)))
11339 current_kboard
= FRAME_KBOARD (XFRAME (selected_frame
));
11341 if (current_kboard
== kb
)
11350 init_keyboard (void)
11352 /* This is correct before outermost invocation of the editor loop. */
11353 command_loop_level
= -1;
11354 immediate_quit
= 0;
11355 quit_char
= Ctl ('g');
11356 Vunread_command_events
= Qnil
;
11357 timer_idleness_start_time
= invalid_emacs_time ();
11359 recent_keys_index
= 0;
11360 kbd_fetch_ptr
= kbd_buffer
;
11361 kbd_store_ptr
= kbd_buffer
;
11362 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
11363 do_mouse_tracking
= Qnil
;
11366 interrupt_input_blocked
= 0;
11367 interrupt_input_pending
= 0;
11369 pending_signals
= 0;
11372 /* This means that command_loop_1 won't try to select anything the first
11374 internal_last_event_frame
= Qnil
;
11375 Vlast_event_frame
= internal_last_event_frame
;
11377 current_kboard
= initial_kboard
;
11378 /* Re-initialize the keyboard again. */
11379 wipe_kboard (current_kboard
);
11380 init_kboard (current_kboard
);
11381 /* A value of nil for Vwindow_system normally means a tty, but we also use
11382 it for the initial terminal since there is no window system there. */
11383 kset_window_system (current_kboard
, Qnil
);
11385 if (!noninteractive
)
11387 /* Before multi-tty support, these handlers used to be installed
11388 only if the current session was a tty session. Now an Emacs
11389 session may have multiple display types, so we always handle
11390 SIGINT. There is special code in interrupt_signal to exit
11391 Emacs on SIGINT when there are no termcap frames on the
11392 controlling terminal. */
11393 struct sigaction action
;
11394 emacs_sigaction_init (&action
, deliver_interrupt_signal
);
11395 sigaction (SIGINT
, &action
, 0);
11397 /* For systems with SysV TERMIO, C-g is set up for both SIGINT and
11398 SIGQUIT and we can't tell which one it will give us. */
11399 sigaction (SIGQUIT
, &action
, 0);
11400 #endif /* not DOS_NT */
11402 #ifdef USABLE_SIGIO
11403 if (!noninteractive
)
11405 struct sigaction action
;
11406 emacs_sigaction_init (&action
, deliver_input_available_signal
);
11407 sigaction (SIGIO
, &action
, 0);
11411 /* Use interrupt input by default, if it works and noninterrupt input
11412 has deficiencies. */
11414 #ifdef INTERRUPT_INPUT
11415 interrupt_input
= 1;
11417 interrupt_input
= 0;
11420 pthread_sigmask (SIG_SETMASK
, &empty_mask
, 0);
11423 if (keyboard_init_hook
)
11424 (*keyboard_init_hook
) ();
11426 #ifdef POLL_FOR_INPUT
11428 poll_suppress_count
= 1;
11433 /* This type's only use is in syms_of_keyboard, to initialize the
11434 event header symbols and put properties on them. */
11435 struct event_head
{
11441 static const struct event_head head_table
[] = {
11442 {&Qmouse_movement
, "mouse-movement", &Qmouse_movement
},
11443 {&Qscroll_bar_movement
, "scroll-bar-movement", &Qmouse_movement
},
11444 {&Qswitch_frame
, "switch-frame", &Qswitch_frame
},
11445 {&Qdelete_frame
, "delete-frame", &Qdelete_frame
},
11446 {&Qiconify_frame
, "iconify-frame", &Qiconify_frame
},
11447 {&Qmake_frame_visible
, "make-frame-visible", &Qmake_frame_visible
},
11448 /* `select-window' should be handled just like `switch-frame'
11449 in read_key_sequence. */
11450 {&Qselect_window
, "select-window", &Qswitch_frame
}
11454 syms_of_keyboard (void)
11456 pending_funcalls
= Qnil
;
11457 staticpro (&pending_funcalls
);
11459 Vlispy_mouse_stem
= build_pure_c_string ("mouse");
11460 staticpro (&Vlispy_mouse_stem
);
11463 DEFSYM (QCimage
, ":image");
11464 DEFSYM (Qhelp_echo
, "help-echo");
11465 DEFSYM (QCrtl
, ":rtl");
11467 staticpro (&item_properties
);
11468 item_properties
= Qnil
;
11470 staticpro (&tool_bar_item_properties
);
11471 tool_bar_item_properties
= Qnil
;
11472 staticpro (&tool_bar_items_vector
);
11473 tool_bar_items_vector
= Qnil
;
11475 DEFSYM (Qtimer_event_handler
, "timer-event-handler");
11476 DEFSYM (Qdisabled_command_function
, "disabled-command-function");
11477 DEFSYM (Qself_insert_command
, "self-insert-command");
11478 DEFSYM (Qforward_char
, "forward-char");
11479 DEFSYM (Qbackward_char
, "backward-char");
11480 DEFSYM (Qdisabled
, "disabled");
11481 DEFSYM (Qundefined
, "undefined");
11482 DEFSYM (Qpre_command_hook
, "pre-command-hook");
11483 DEFSYM (Qpost_command_hook
, "post-command-hook");
11484 DEFSYM (Qdeferred_action_function
, "deferred-action-function");
11485 DEFSYM (Qdelayed_warnings_hook
, "delayed-warnings-hook");
11486 DEFSYM (Qfunction_key
, "function-key");
11487 DEFSYM (Qmouse_click
, "mouse-click");
11488 DEFSYM (Qdrag_n_drop
, "drag-n-drop");
11489 DEFSYM (Qsave_session
, "save-session");
11490 DEFSYM (Qconfig_changed_event
, "config-changed-event");
11491 DEFSYM (Qmenu_enable
, "menu-enable");
11493 #if defined (WINDOWSNT)
11494 DEFSYM (Qlanguage_change
, "language-change");
11498 DEFSYM (Qdbus_event
, "dbus-event");
11501 DEFSYM (QCenable
, ":enable");
11502 DEFSYM (QCvisible
, ":visible");
11503 DEFSYM (QChelp
, ":help");
11504 DEFSYM (QCfilter
, ":filter");
11505 DEFSYM (QCbutton
, ":button");
11506 DEFSYM (QCkeys
, ":keys");
11507 DEFSYM (QCkey_sequence
, ":key-sequence");
11508 DEFSYM (QCtoggle
, ":toggle");
11509 DEFSYM (QCradio
, ":radio");
11510 DEFSYM (QClabel
, ":label");
11511 DEFSYM (QCvert_only
, ":vert-only");
11513 DEFSYM (Qmode_line
, "mode-line");
11514 DEFSYM (Qvertical_line
, "vertical-line");
11515 DEFSYM (Qvertical_scroll_bar
, "vertical-scroll-bar");
11516 DEFSYM (Qmenu_bar
, "menu-bar");
11518 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
11519 DEFSYM (Qmouse_fixup_help_message
, "mouse-fixup-help-message");
11522 DEFSYM (Qabove_handle
, "above-handle");
11523 DEFSYM (Qhandle
, "handle");
11524 DEFSYM (Qbelow_handle
, "below-handle");
11525 DEFSYM (Qup
, "up");
11526 DEFSYM (Qdown
, "down");
11527 DEFSYM (Qtop
, "top");
11528 DEFSYM (Qbottom
, "bottom");
11529 DEFSYM (Qend_scroll
, "end-scroll");
11530 DEFSYM (Qratio
, "ratio");
11532 DEFSYM (Qevent_kind
, "event-kind");
11533 DEFSYM (Qevent_symbol_elements
, "event-symbol-elements");
11534 DEFSYM (Qevent_symbol_element_mask
, "event-symbol-element-mask");
11535 DEFSYM (Qmodifier_cache
, "modifier-cache");
11537 DEFSYM (Qrecompute_lucid_menubar
, "recompute-lucid-menubar");
11538 DEFSYM (Qactivate_menubar_hook
, "activate-menubar-hook");
11540 DEFSYM (Qpolling_period
, "polling-period");
11542 DEFSYM (Qx_set_selection
, "x-set-selection");
11543 DEFSYM (QPRIMARY
, "PRIMARY");
11544 DEFSYM (Qhandle_switch_frame
, "handle-switch-frame");
11545 DEFSYM (Qhandle_select_window
, "handle-select-window");
11547 DEFSYM (Qinput_method_function
, "input-method-function");
11548 DEFSYM (Qinput_method_exit_on_first_char
, "input-method-exit-on-first-char");
11549 DEFSYM (Qinput_method_use_echo_area
, "input-method-use-echo-area");
11551 DEFSYM (Qhelp_form_show
, "help-form-show");
11553 Fset (Qinput_method_exit_on_first_char
, Qnil
);
11554 Fset (Qinput_method_use_echo_area
, Qnil
);
11556 last_point_position_buffer
= Qnil
;
11557 last_point_position_window
= Qnil
;
11561 int len
= sizeof (head_table
) / sizeof (head_table
[0]);
11563 for (i
= 0; i
< len
; i
++)
11565 const struct event_head
*p
= &head_table
[i
];
11566 *p
->var
= intern_c_string (p
->name
);
11567 staticpro (p
->var
);
11568 Fput (*p
->var
, Qevent_kind
, *p
->kind
);
11569 Fput (*p
->var
, Qevent_symbol_elements
, Fcons (*p
->var
, Qnil
));
11573 button_down_location
= Fmake_vector (make_number (5), Qnil
);
11574 staticpro (&button_down_location
);
11575 mouse_syms
= Fmake_vector (make_number (5), Qnil
);
11576 staticpro (&mouse_syms
);
11577 wheel_syms
= Fmake_vector (make_number (sizeof (lispy_wheel_names
)
11578 / sizeof (lispy_wheel_names
[0])),
11580 staticpro (&wheel_syms
);
11584 int len
= sizeof (modifier_names
) / sizeof (modifier_names
[0]);
11586 modifier_symbols
= Fmake_vector (make_number (len
), Qnil
);
11587 for (i
= 0; i
< len
; i
++)
11588 if (modifier_names
[i
])
11589 ASET (modifier_symbols
, i
, intern_c_string (modifier_names
[i
]));
11590 staticpro (&modifier_symbols
);
11593 recent_keys
= Fmake_vector (make_number (NUM_RECENT_KEYS
), Qnil
);
11594 staticpro (&recent_keys
);
11596 this_command_keys
= Fmake_vector (make_number (40), Qnil
);
11597 staticpro (&this_command_keys
);
11599 raw_keybuf
= Fmake_vector (make_number (30), Qnil
);
11600 staticpro (&raw_keybuf
);
11602 DEFSYM (Qextended_command_history
, "extended-command-history");
11603 Fset (Qextended_command_history
, Qnil
);
11605 accent_key_syms
= Qnil
;
11606 staticpro (&accent_key_syms
);
11608 func_key_syms
= Qnil
;
11609 staticpro (&func_key_syms
);
11611 drag_n_drop_syms
= Qnil
;
11612 staticpro (&drag_n_drop_syms
);
11614 unread_switch_frame
= Qnil
;
11615 staticpro (&unread_switch_frame
);
11617 internal_last_event_frame
= Qnil
;
11618 staticpro (&internal_last_event_frame
);
11620 read_key_sequence_cmd
= Qnil
;
11621 staticpro (&read_key_sequence_cmd
);
11622 read_key_sequence_remapped
= Qnil
;
11623 staticpro (&read_key_sequence_remapped
);
11625 menu_bar_one_keymap_changed_items
= Qnil
;
11626 staticpro (&menu_bar_one_keymap_changed_items
);
11628 menu_bar_items_vector
= Qnil
;
11629 staticpro (&menu_bar_items_vector
);
11631 help_form_saved_window_configs
= Qnil
;
11632 staticpro (&help_form_saved_window_configs
);
11634 defsubr (&Scurrent_idle_time
);
11635 defsubr (&Sevent_symbol_parse_modifiers
);
11636 defsubr (&Sevent_convert_list
);
11637 defsubr (&Sread_key_sequence
);
11638 defsubr (&Sread_key_sequence_vector
);
11639 defsubr (&Srecursive_edit
);
11640 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
11641 defsubr (&Strack_mouse
);
11643 defsubr (&Sinput_pending_p
);
11644 defsubr (&Scommand_execute
);
11645 defsubr (&Srecent_keys
);
11646 defsubr (&Sthis_command_keys
);
11647 defsubr (&Sthis_command_keys_vector
);
11648 defsubr (&Sthis_single_command_keys
);
11649 defsubr (&Sthis_single_command_raw_keys
);
11650 defsubr (&Sreset_this_command_lengths
);
11651 defsubr (&Sclear_this_command_keys
);
11652 defsubr (&Ssuspend_emacs
);
11653 defsubr (&Sabort_recursive_edit
);
11654 defsubr (&Sexit_recursive_edit
);
11655 defsubr (&Srecursion_depth
);
11656 defsubr (&Stop_level
);
11657 defsubr (&Sdiscard_input
);
11658 defsubr (&Sopen_dribble_file
);
11659 defsubr (&Sset_input_interrupt_mode
);
11660 defsubr (&Sset_output_flow_control
);
11661 defsubr (&Sset_input_meta_mode
);
11662 defsubr (&Sset_quit_char
);
11663 defsubr (&Sset_input_mode
);
11664 defsubr (&Scurrent_input_mode
);
11665 defsubr (&Sposn_at_point
);
11666 defsubr (&Sposn_at_x_y
);
11668 DEFVAR_LISP ("last-command-event", last_command_event
,
11669 doc
: /* Last input event that was part of a command. */);
11671 DEFVAR_LISP ("last-nonmenu-event", last_nonmenu_event
,
11672 doc
: /* Last input event in a command, except for mouse menu events.
11673 Mouse menus give back keys that don't look like mouse events;
11674 this variable holds the actual mouse event that led to the menu,
11675 so that you can determine whether the command was run by mouse or not. */);
11677 DEFVAR_LISP ("last-input-event", last_input_event
,
11678 doc
: /* Last input event. */);
11680 DEFVAR_LISP ("unread-command-events", Vunread_command_events
,
11681 doc
: /* List of events to be read as the command input.
11682 These events are processed first, before actual keyboard input.
11683 Events read from this list are not normally added to `this-command-keys',
11684 as they will already have been added once as they were read for the first time.
11685 An element of the form (t . EVENT) forces EVENT to be added to that list. */);
11686 Vunread_command_events
= Qnil
;
11688 DEFVAR_LISP ("unread-post-input-method-events", Vunread_post_input_method_events
,
11689 doc
: /* List of events to be processed as input by input methods.
11690 These events are processed before `unread-command-events'
11691 and actual keyboard input, but are not given to `input-method-function'. */);
11692 Vunread_post_input_method_events
= Qnil
;
11694 DEFVAR_LISP ("unread-input-method-events", Vunread_input_method_events
,
11695 doc
: /* List of events to be processed as input by input methods.
11696 These events are processed after `unread-command-events', but
11697 before actual keyboard input.
11698 If there's an active input method, the events are given to
11699 `input-method-function'. */);
11700 Vunread_input_method_events
= Qnil
;
11702 DEFVAR_LISP ("meta-prefix-char", meta_prefix_char
,
11703 doc
: /* Meta-prefix character code.
11704 Meta-foo as command input turns into this character followed by foo. */);
11705 XSETINT (meta_prefix_char
, 033);
11707 DEFVAR_KBOARD ("last-command", Vlast_command
,
11708 doc
: /* The last command executed.
11709 Normally a symbol with a function definition, but can be whatever was found
11710 in the keymap, or whatever the variable `this-command' was set to by that
11713 The value `mode-exit' is special; it means that the previous command
11714 read an event that told it to exit, and it did so and unread that event.
11715 In other words, the present command is the event that made the previous
11718 The value `kill-region' is special; it means that the previous command
11719 was a kill command.
11721 `last-command' has a separate binding for each terminal device.
11722 See Info node `(elisp)Multiple Terminals'. */);
11724 DEFVAR_KBOARD ("real-last-command", Vreal_last_command
,
11725 doc
: /* Same as `last-command', but never altered by Lisp code.
11726 Taken from the previous value of `real-this-command'. */);
11728 DEFVAR_KBOARD ("last-repeatable-command", Vlast_repeatable_command
,
11729 doc
: /* Last command that may be repeated.
11730 The last command executed that was not bound to an input event.
11731 This is the command `repeat' will try to repeat.
11732 Taken from a previous value of `real-this-command'. */);
11734 DEFVAR_LISP ("this-command", Vthis_command
,
11735 doc
: /* The command now being executed.
11736 The command can set this variable; whatever is put here
11737 will be in `last-command' during the following command. */);
11738 Vthis_command
= Qnil
;
11740 DEFVAR_LISP ("real-this-command", Vreal_this_command
,
11741 doc
: /* This is like `this-command', except that commands should never modify it. */);
11742 Vreal_this_command
= Qnil
;
11744 DEFVAR_LISP ("this-command-keys-shift-translated",
11745 Vthis_command_keys_shift_translated
,
11746 doc
: /* Non-nil if the key sequence activating this command was shift-translated.
11747 Shift-translation occurs when there is no binding for the key sequence
11748 as entered, but a binding was found by changing an upper-case letter
11749 to lower-case, or a shifted function key to an unshifted one. */);
11750 Vthis_command_keys_shift_translated
= Qnil
;
11752 DEFVAR_LISP ("this-original-command", Vthis_original_command
,
11753 doc
: /* The command bound to the current key sequence before remapping.
11754 It equals `this-command' if the original command was not remapped through
11755 any of the active keymaps. Otherwise, the value of `this-command' is the
11756 result of looking up the original command in the active keymaps. */);
11757 Vthis_original_command
= Qnil
;
11759 DEFVAR_INT ("auto-save-interval", auto_save_interval
,
11760 doc
: /* Number of input events between auto-saves.
11761 Zero means disable autosaving due to number of characters typed. */);
11762 auto_save_interval
= 300;
11764 DEFVAR_LISP ("auto-save-timeout", Vauto_save_timeout
,
11765 doc
: /* Number of seconds idle time before auto-save.
11766 Zero or nil means disable auto-saving due to idleness.
11767 After auto-saving due to this many seconds of idle time,
11768 Emacs also does a garbage collection if that seems to be warranted. */);
11769 XSETFASTINT (Vauto_save_timeout
, 30);
11771 DEFVAR_LISP ("echo-keystrokes", Vecho_keystrokes
,
11772 doc
: /* Nonzero means echo unfinished commands after this many seconds of pause.
11773 The value may be integer or floating point.
11774 If the value is zero, don't echo at all. */);
11775 Vecho_keystrokes
= make_number (1);
11777 DEFVAR_INT ("polling-period", polling_period
,
11778 doc
: /* Interval between polling for input during Lisp execution.
11779 The reason for polling is to make C-g work to stop a running program.
11780 Polling is needed only when using X windows and SIGIO does not work.
11781 Polling is automatically disabled in all other cases. */);
11782 polling_period
= 2;
11784 DEFVAR_LISP ("double-click-time", Vdouble_click_time
,
11785 doc
: /* Maximum time between mouse clicks to make a double-click.
11786 Measured in milliseconds. The value nil means disable double-click
11787 recognition; t means double-clicks have no time limit and are detected
11788 by position only. */);
11789 Vdouble_click_time
= make_number (500);
11791 DEFVAR_INT ("double-click-fuzz", double_click_fuzz
,
11792 doc
: /* Maximum mouse movement between clicks to make a double-click.
11793 On window-system frames, value is the number of pixels the mouse may have
11794 moved horizontally or vertically between two clicks to make a double-click.
11795 On non window-system frames, value is interpreted in units of 1/8 characters
11798 This variable is also the threshold for motion of the mouse
11799 to count as a drag. */);
11800 double_click_fuzz
= 3;
11802 DEFVAR_BOOL ("inhibit-local-menu-bar-menus", inhibit_local_menu_bar_menus
,
11803 doc
: /* Non-nil means inhibit local map menu bar menus. */);
11804 inhibit_local_menu_bar_menus
= 0;
11806 DEFVAR_INT ("num-input-keys", num_input_keys
,
11807 doc
: /* Number of complete key sequences read as input so far.
11808 This includes key sequences read from keyboard macros.
11809 The number is effectively the number of interactive command invocations. */);
11810 num_input_keys
= 0;
11812 DEFVAR_INT ("num-nonmacro-input-events", num_nonmacro_input_events
,
11813 doc
: /* Number of input events read from the keyboard so far.
11814 This does not include events generated by keyboard macros. */);
11815 num_nonmacro_input_events
= 0;
11817 DEFVAR_LISP ("last-event-frame", Vlast_event_frame
,
11818 doc
: /* The frame in which the most recently read event occurred.
11819 If the last event came from a keyboard macro, this is set to `macro'. */);
11820 Vlast_event_frame
= Qnil
;
11822 /* This variable is set up in sysdep.c. */
11823 DEFVAR_LISP ("tty-erase-char", Vtty_erase_char
,
11824 doc
: /* The ERASE character as set by the user with stty. */);
11826 DEFVAR_LISP ("help-char", Vhelp_char
,
11827 doc
: /* Character to recognize as meaning Help.
11828 When it is read, do `(eval help-form)', and display result if it's a string.
11829 If the value of `help-form' is nil, this char can be read normally. */);
11830 XSETINT (Vhelp_char
, Ctl ('H'));
11832 DEFVAR_LISP ("help-event-list", Vhelp_event_list
,
11833 doc
: /* List of input events to recognize as meaning Help.
11834 These work just like the value of `help-char' (see that). */);
11835 Vhelp_event_list
= Qnil
;
11837 DEFVAR_LISP ("help-form", Vhelp_form
,
11838 doc
: /* Form to execute when character `help-char' is read.
11839 If the form returns a string, that string is displayed.
11840 If `help-form' is nil, the help char is not recognized. */);
11843 DEFVAR_LISP ("prefix-help-command", Vprefix_help_command
,
11844 doc
: /* Command to run when `help-char' character follows a prefix key.
11845 This command is used only when there is no actual binding
11846 for that character after that prefix key. */);
11847 Vprefix_help_command
= Qnil
;
11849 DEFVAR_LISP ("top-level", Vtop_level
,
11850 doc
: /* Form to evaluate when Emacs starts up.
11851 Useful to set before you dump a modified Emacs. */);
11854 DEFVAR_KBOARD ("keyboard-translate-table", Vkeyboard_translate_table
,
11855 doc
: /* Translate table for local keyboard input, or nil.
11856 If non-nil, the value should be a char-table. Each character read
11857 from the keyboard is looked up in this char-table. If the value found
11858 there is non-nil, then it is used instead of the actual input character.
11860 The value can also be a string or vector, but this is considered obsolete.
11861 If it is a string or vector of length N, character codes N and up are left
11862 untranslated. In a vector, an element which is nil means "no translation".
11864 This is applied to the characters supplied to input methods, not their
11865 output. See also `translation-table-for-input'.
11867 This variable has a separate binding for each terminal.
11868 See Info node `(elisp)Multiple Terminals'. */);
11870 DEFVAR_BOOL ("cannot-suspend", cannot_suspend
,
11871 doc
: /* Non-nil means to always spawn a subshell instead of suspending.
11872 \(Even if the operating system has support for stopping a process.\) */);
11873 cannot_suspend
= 0;
11875 DEFVAR_BOOL ("menu-prompting", menu_prompting
,
11876 doc
: /* Non-nil means prompt with menus when appropriate.
11877 This is done when reading from a keymap that has a prompt string,
11878 for elements that have prompt strings.
11879 The menu is displayed on the screen
11880 if X menus were enabled at configuration
11881 time and the previous event was a mouse click prefix key.
11882 Otherwise, menu prompting uses the echo area. */);
11883 menu_prompting
= 1;
11885 DEFVAR_LISP ("menu-prompt-more-char", menu_prompt_more_char
,
11886 doc
: /* Character to see next line of menu prompt.
11887 Type this character while in a menu prompt to rotate around the lines of it. */);
11888 XSETINT (menu_prompt_more_char
, ' ');
11890 DEFVAR_INT ("extra-keyboard-modifiers", extra_keyboard_modifiers
,
11891 doc
: /* A mask of additional modifier keys to use with every keyboard character.
11892 Emacs applies the modifiers of the character stored here to each keyboard
11893 character it reads. For example, after evaluating the expression
11894 (setq extra-keyboard-modifiers ?\\C-x)
11895 all input characters will have the control modifier applied to them.
11897 Note that the character ?\\C-@, equivalent to the integer zero, does
11898 not count as a control character; rather, it counts as a character
11899 with no modifiers; thus, setting `extra-keyboard-modifiers' to zero
11900 cancels any modification. */);
11901 extra_keyboard_modifiers
= 0;
11903 DEFVAR_LISP ("deactivate-mark", Vdeactivate_mark
,
11904 doc
: /* If an editing command sets this to t, deactivate the mark afterward.
11905 The command loop sets this to nil before each command,
11906 and tests the value when the command returns.
11907 Buffer modification stores t in this variable. */);
11908 Vdeactivate_mark
= Qnil
;
11909 DEFSYM (Qdeactivate_mark
, "deactivate-mark");
11911 DEFVAR_LISP ("pre-command-hook", Vpre_command_hook
,
11912 doc
: /* Normal hook run before each command is executed.
11913 If an unhandled error happens in running this hook,
11914 the function in which the error occurred is unconditionally removed, since
11915 otherwise the error might happen repeatedly and make Emacs nonfunctional. */);
11916 Vpre_command_hook
= Qnil
;
11918 DEFVAR_LISP ("post-command-hook", Vpost_command_hook
,
11919 doc
: /* Normal hook run after each command is executed.
11920 If an unhandled error happens in running this hook,
11921 the function in which the error occurred is unconditionally removed, since
11922 otherwise the error might happen repeatedly and make Emacs nonfunctional. */);
11923 Vpost_command_hook
= Qnil
;
11926 DEFVAR_LISP ("echo-area-clear-hook", ...,
11927 doc
: /* Normal hook run when clearing the echo area. */);
11929 DEFSYM (Qecho_area_clear_hook
, "echo-area-clear-hook");
11930 Fset (Qecho_area_clear_hook
, Qnil
);
11932 DEFVAR_LISP ("lucid-menu-bar-dirty-flag", Vlucid_menu_bar_dirty_flag
,
11933 doc
: /* Non-nil means menu bar, specified Lucid style, needs to be recomputed. */);
11934 Vlucid_menu_bar_dirty_flag
= Qnil
;
11936 DEFVAR_LISP ("menu-bar-final-items", Vmenu_bar_final_items
,
11937 doc
: /* List of menu bar items to move to the end of the menu bar.
11938 The elements of the list are event types that may have menu bar bindings. */);
11939 Vmenu_bar_final_items
= Qnil
;
11941 DEFVAR_LISP ("tool-bar-separator-image-expression", Vtool_bar_separator_image_expression
,
11942 doc
: /* Expression evaluating to the image spec for a tool-bar separator.
11943 This is used internally by graphical displays that do not render
11944 tool-bar separators natively. Otherwise it is unused (e.g. on GTK). */);
11945 Vtool_bar_separator_image_expression
= Qnil
;
11947 DEFVAR_KBOARD ("overriding-terminal-local-map",
11948 Voverriding_terminal_local_map
,
11949 doc
: /* Per-terminal keymap that overrides all other local keymaps.
11950 If this variable is non-nil, it is used as a keymap instead of the
11951 buffer's local map, and the minor mode keymaps and text property keymaps.
11952 It also replaces `overriding-local-map'.
11954 This variable is intended to let commands such as `universal-argument'
11955 set up a different keymap for reading the next command.
11957 `overriding-terminal-local-map' has a separate binding for each
11959 See Info node `(elisp)Multiple Terminals'. */);
11961 DEFVAR_LISP ("overriding-local-map", Voverriding_local_map
,
11962 doc
: /* Keymap that overrides all other local keymaps.
11963 If this variable is non-nil, it is used as a keymap--replacing the
11964 buffer's local map, the minor mode keymaps, and char property keymaps. */);
11965 Voverriding_local_map
= Qnil
;
11967 DEFVAR_LISP ("overriding-local-map-menu-flag", Voverriding_local_map_menu_flag
,
11968 doc
: /* Non-nil means `overriding-local-map' applies to the menu bar.
11969 Otherwise, the menu bar continues to reflect the buffer's local map
11970 and the minor mode maps regardless of `overriding-local-map'. */);
11971 Voverriding_local_map_menu_flag
= Qnil
;
11973 DEFVAR_LISP ("special-event-map", Vspecial_event_map
,
11974 doc
: /* Keymap defining bindings for special events to execute at low level. */);
11975 Vspecial_event_map
= Fcons (intern_c_string ("keymap"), Qnil
);
11977 DEFVAR_LISP ("track-mouse", do_mouse_tracking
,
11978 doc
: /* Non-nil means generate motion events for mouse motion. */);
11980 DEFVAR_KBOARD ("system-key-alist", Vsystem_key_alist
,
11981 doc
: /* Alist of system-specific X windows key symbols.
11982 Each element should have the form (N . SYMBOL) where N is the
11983 numeric keysym code (sans the \"system-specific\" bit 1<<28)
11984 and SYMBOL is its name.
11986 `system-key-alist' has a separate binding for each terminal device.
11987 See Info node `(elisp)Multiple Terminals'. */);
11989 DEFVAR_KBOARD ("local-function-key-map", Vlocal_function_key_map
,
11990 doc
: /* Keymap that translates key sequences to key sequences during input.
11991 This is used mainly for mapping key sequences into some preferred
11992 key events (symbols).
11994 The `read-key-sequence' function replaces any subsequence bound by
11995 `local-function-key-map' with its binding. More precisely, when the
11996 active keymaps have no binding for the current key sequence but
11997 `local-function-key-map' binds a suffix of the sequence to a vector or
11998 string, `read-key-sequence' replaces the matching suffix with its
11999 binding, and continues with the new sequence.
12001 If the binding is a function, it is called with one argument (the prompt)
12002 and its return value (a key sequence) is used.
12004 The events that come from bindings in `local-function-key-map' are not
12005 themselves looked up in `local-function-key-map'.
12007 For example, suppose `local-function-key-map' binds `ESC O P' to [f1].
12008 Typing `ESC O P' to `read-key-sequence' would return [f1]. Typing
12009 `C-x ESC O P' would return [?\\C-x f1]. If [f1] were a prefix key,
12010 typing `ESC O P x' would return [f1 x].
12012 `local-function-key-map' has a separate binding for each terminal
12013 device. See Info node `(elisp)Multiple Terminals'. If you need to
12014 define a binding on all terminals, change `function-key-map'
12015 instead. Initially, `local-function-key-map' is an empty keymap that
12016 has `function-key-map' as its parent on all terminal devices. */);
12018 DEFVAR_KBOARD ("input-decode-map", Vinput_decode_map
,
12019 doc
: /* Keymap that decodes input escape sequences.
12020 This is used mainly for mapping ASCII function key sequences into
12021 real Emacs function key events (symbols).
12023 The `read-key-sequence' function replaces any subsequence bound by
12024 `input-decode-map' with its binding. Contrary to `function-key-map',
12025 this map applies its rebinding regardless of the presence of an ordinary
12026 binding. So it is more like `key-translation-map' except that it applies
12027 before `function-key-map' rather than after.
12029 If the binding is a function, it is called with one argument (the prompt)
12030 and its return value (a key sequence) is used.
12032 The events that come from bindings in `input-decode-map' are not
12033 themselves looked up in `input-decode-map'.
12035 This variable is keyboard-local. */);
12037 DEFVAR_LISP ("function-key-map", Vfunction_key_map
,
12038 doc
: /* The parent keymap of all `local-function-key-map' instances.
12039 Function key definitions that apply to all terminal devices should go
12040 here. If a mapping is defined in both the current
12041 `local-function-key-map' binding and this variable, then the local
12042 definition will take precedence. */);
12043 Vfunction_key_map
= Fmake_sparse_keymap (Qnil
);
12045 DEFVAR_LISP ("key-translation-map", Vkey_translation_map
,
12046 doc
: /* Keymap of key translations that can override keymaps.
12047 This keymap works like `function-key-map', but comes after that,
12048 and its non-prefix bindings override ordinary bindings.
12049 Another difference is that it is global rather than keyboard-local. */);
12050 Vkey_translation_map
= Fmake_sparse_keymap (Qnil
);
12052 DEFVAR_LISP ("deferred-action-list", Vdeferred_action_list
,
12053 doc
: /* List of deferred actions to be performed at a later time.
12054 The precise format isn't relevant here; we just check whether it is nil. */);
12055 Vdeferred_action_list
= Qnil
;
12057 DEFVAR_LISP ("deferred-action-function", Vdeferred_action_function
,
12058 doc
: /* Function to call to handle deferred actions, after each command.
12059 This function is called with no arguments after each command
12060 whenever `deferred-action-list' is non-nil. */);
12061 Vdeferred_action_function
= Qnil
;
12063 DEFVAR_LISP ("delayed-warnings-list", Vdelayed_warnings_list
,
12064 doc
: /* List of warnings to be displayed after this command.
12065 Each element must be a list (TYPE MESSAGE [LEVEL [BUFFER-NAME]]),
12066 as per the args of `display-warning' (which see).
12067 If this variable is non-nil, `delayed-warnings-hook' will be run
12068 immediately after running `post-command-hook'. */);
12069 Vdelayed_warnings_list
= Qnil
;
12071 DEFVAR_LISP ("timer-list", Vtimer_list
,
12072 doc
: /* List of active absolute time timers in order of increasing time. */);
12073 Vtimer_list
= Qnil
;
12075 DEFVAR_LISP ("timer-idle-list", Vtimer_idle_list
,
12076 doc
: /* List of active idle-time timers in order of increasing time. */);
12077 Vtimer_idle_list
= Qnil
;
12079 DEFVAR_LISP ("input-method-function", Vinput_method_function
,
12080 doc
: /* If non-nil, the function that implements the current input method.
12081 It's called with one argument, a printing character that was just read.
12082 \(That means a character with code 040...0176.)
12083 Typically this function uses `read-event' to read additional events.
12084 When it does so, it should first bind `input-method-function' to nil
12085 so it will not be called recursively.
12087 The function should return a list of zero or more events
12088 to be used as input. If it wants to put back some events
12089 to be reconsidered, separately, by the input method,
12090 it can add them to the beginning of `unread-command-events'.
12092 The input method function can find in `input-method-previous-message'
12093 the previous echo area message.
12095 The input method function should refer to the variables
12096 `input-method-use-echo-area' and `input-method-exit-on-first-char'
12097 for guidance on what to do. */);
12098 Vinput_method_function
= Qnil
;
12100 DEFVAR_LISP ("input-method-previous-message",
12101 Vinput_method_previous_message
,
12102 doc
: /* When `input-method-function' is called, hold the previous echo area message.
12103 This variable exists because `read-event' clears the echo area
12104 before running the input method. It is nil if there was no message. */);
12105 Vinput_method_previous_message
= Qnil
;
12107 DEFVAR_LISP ("show-help-function", Vshow_help_function
,
12108 doc
: /* If non-nil, the function that implements the display of help.
12109 It's called with one argument, the help string to display. */);
12110 Vshow_help_function
= Qnil
;
12112 DEFVAR_LISP ("disable-point-adjustment", Vdisable_point_adjustment
,
12113 doc
: /* If non-nil, suppress point adjustment after executing a command.
12115 After a command is executed, if point is moved into a region that has
12116 special properties (e.g. composition, display), we adjust point to
12117 the boundary of the region. But, when a command sets this variable to
12118 non-nil, we suppress the point adjustment.
12120 This variable is set to nil before reading a command, and is checked
12121 just after executing the command. */);
12122 Vdisable_point_adjustment
= Qnil
;
12124 DEFVAR_LISP ("global-disable-point-adjustment",
12125 Vglobal_disable_point_adjustment
,
12126 doc
: /* If non-nil, always suppress point adjustment.
12128 The default value is nil, in which case, point adjustment are
12129 suppressed only after special commands that set
12130 `disable-point-adjustment' (which see) to non-nil. */);
12131 Vglobal_disable_point_adjustment
= Qnil
;
12133 DEFVAR_LISP ("minibuffer-message-timeout", Vminibuffer_message_timeout
,
12134 doc
: /* How long to display an echo-area message when the minibuffer is active.
12135 If the value is not a number, such messages don't time out. */);
12136 Vminibuffer_message_timeout
= make_number (2);
12138 DEFVAR_LISP ("throw-on-input", Vthrow_on_input
,
12139 doc
: /* If non-nil, any keyboard input throws to this symbol.
12140 The value of that variable is passed to `quit-flag' and later causes a
12141 peculiar kind of quitting. */);
12142 Vthrow_on_input
= Qnil
;
12144 DEFVAR_LISP ("command-error-function", Vcommand_error_function
,
12145 doc
: /* If non-nil, function to output error messages.
12146 The arguments are the error data, a list of the form
12147 (SIGNALED-CONDITIONS . SIGNAL-DATA)
12148 such as just as `condition-case' would bind its variable to,
12149 the context (a string which normally goes at the start of the message),
12150 and the Lisp function within which the error was signaled. */);
12151 Vcommand_error_function
= Qnil
;
12153 DEFVAR_LISP ("enable-disabled-menus-and-buttons",
12154 Venable_disabled_menus_and_buttons
,
12155 doc
: /* If non-nil, don't ignore events produced by disabled menu items and tool-bar.
12157 Help functions bind this to allow help on disabled menu items
12158 and tool-bar buttons. */);
12159 Venable_disabled_menus_and_buttons
= Qnil
;
12161 DEFVAR_LISP ("select-active-regions",
12162 Vselect_active_regions
,
12163 doc
: /* If non-nil, an active region automatically sets the primary selection.
12164 If the value is `only', only temporarily active regions (usually made
12165 by mouse-dragging or shift-selection) set the window selection.
12167 This takes effect only when Transient Mark mode is enabled. */);
12168 Vselect_active_regions
= Qt
;
12170 DEFVAR_LISP ("saved-region-selection",
12171 Vsaved_region_selection
,
12172 doc
: /* Contents of active region prior to buffer modification.
12173 If `select-active-regions' is non-nil, Emacs sets this to the
12174 text in the region before modifying the buffer. The next
12175 `deactivate-mark' call uses this to set the window selection. */);
12176 Vsaved_region_selection
= Qnil
;
12178 DEFVAR_LISP ("selection-inhibit-update-commands",
12179 Vselection_inhibit_update_commands
,
12180 doc
: /* List of commands which should not update the selection.
12181 Normally, if `select-active-regions' is non-nil and the mark remains
12182 active after a command (i.e. the mark was not deactivated), the Emacs
12183 command loop sets the selection to the text in the region. However,
12184 if the command is in this list, the selection is not updated. */);
12185 Vselection_inhibit_update_commands
12186 = list2 (Qhandle_switch_frame
, Qhandle_select_window
);
12188 DEFVAR_LISP ("debug-on-event",
12190 doc
: /* Enter debugger on this event. When Emacs
12191 receives the special event specified by this variable, it will try to
12192 break into the debugger as soon as possible instead of processing the
12193 event normally through `special-event-map'.
12195 Currently, the only supported values for this
12196 variable are `sigusr1' and `sigusr2'. */);
12197 Vdebug_on_event
= intern_c_string ("sigusr2");
12199 /* Create the initial keyboard. */
12200 initial_kboard
= xmalloc (sizeof *initial_kboard
);
12201 init_kboard (initial_kboard
);
12202 /* Vwindow_system is left at t for now. */
12203 initial_kboard
->next_kboard
= all_kboards
;
12204 all_kboards
= initial_kboard
;
12208 keys_of_keyboard (void)
12210 initial_define_key (global_map
, Ctl ('Z'), "suspend-emacs");
12211 initial_define_key (control_x_map
, Ctl ('Z'), "suspend-emacs");
12212 initial_define_key (meta_map
, Ctl ('C'), "exit-recursive-edit");
12213 initial_define_key (global_map
, Ctl (']'), "abort-recursive-edit");
12214 initial_define_key (meta_map
, 'x', "execute-extended-command");
12216 initial_define_lispy_key (Vspecial_event_map
, "delete-frame",
12217 "handle-delete-frame");
12218 initial_define_lispy_key (Vspecial_event_map
, "ns-put-working-text",
12219 "ns-put-working-text");
12220 initial_define_lispy_key (Vspecial_event_map
, "ns-unput-working-text",
12221 "ns-unput-working-text");
12222 /* Here we used to use `ignore-event' which would simple set prefix-arg to
12223 current-prefix-arg, as is done in `handle-switch-frame'.
12224 But `handle-switch-frame is not run from the special-map.
12225 Commands from that map are run in a special way that automatically
12226 preserves the prefix-arg. Restoring the prefix arg here is not just
12227 redundant but harmful:
12229 - current-prefix-arg is set to non-nil, prefix-arg is set to nil.
12230 - after the first prompt, the exit-minibuffer-hook is run which may
12231 iconify a frame and thus push a `iconify-frame' event.
12232 - after running exit-minibuffer-hook, current-prefix-arg is
12233 restored to the non-nil value it had before the prompt.
12234 - we enter the second prompt.
12235 current-prefix-arg is non-nil, prefix-arg is nil.
12236 - before running the first real event, we run the special iconify-frame
12237 event, but we pass the `special' arg to execute-command so
12238 current-prefix-arg and prefix-arg are left untouched.
12239 - here we foolishly copy the non-nil current-prefix-arg to prefix-arg.
12240 - the next key event will have a spuriously non-nil current-prefix-arg. */
12241 initial_define_lispy_key (Vspecial_event_map
, "iconify-frame",
12243 initial_define_lispy_key (Vspecial_event_map
, "make-frame-visible",
12245 /* Handling it at such a low-level causes read_key_sequence to get
12246 * confused because it doesn't realize that the current_buffer was
12247 * changed by read_char.
12249 * initial_define_lispy_key (Vspecial_event_map, "select-window",
12250 * "handle-select-window"); */
12251 initial_define_lispy_key (Vspecial_event_map
, "save-session",
12252 "handle-save-session");
12255 /* Define a special event which is raised for dbus callback
12257 initial_define_lispy_key (Vspecial_event_map
, "dbus-event",
12258 "dbus-handle-event");
12261 initial_define_lispy_key (Vspecial_event_map
, "config-changed-event",
12263 #if defined (WINDOWSNT)
12264 initial_define_lispy_key (Vspecial_event_map
, "language-change",
12269 /* Mark the pointers in the kboard objects.
12270 Called by Fgarbage_collect. */
12272 mark_kboards (void)
12276 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
12278 if (kb
->kbd_macro_buffer
)
12279 for (p
= kb
->kbd_macro_buffer
; p
< kb
->kbd_macro_ptr
; p
++)
12281 mark_object (KVAR (kb
, Voverriding_terminal_local_map
));
12282 mark_object (KVAR (kb
, Vlast_command
));
12283 mark_object (KVAR (kb
, Vreal_last_command
));
12284 mark_object (KVAR (kb
, Vkeyboard_translate_table
));
12285 mark_object (KVAR (kb
, Vlast_repeatable_command
));
12286 mark_object (KVAR (kb
, Vprefix_arg
));
12287 mark_object (KVAR (kb
, Vlast_prefix_arg
));
12288 mark_object (KVAR (kb
, kbd_queue
));
12289 mark_object (KVAR (kb
, defining_kbd_macro
));
12290 mark_object (KVAR (kb
, Vlast_kbd_macro
));
12291 mark_object (KVAR (kb
, Vsystem_key_alist
));
12292 mark_object (KVAR (kb
, system_key_syms
));
12293 mark_object (KVAR (kb
, Vwindow_system
));
12294 mark_object (KVAR (kb
, Vinput_decode_map
));
12295 mark_object (KVAR (kb
, Vlocal_function_key_map
));
12296 mark_object (KVAR (kb
, Vdefault_minibuffer_frame
));
12297 mark_object (KVAR (kb
, echo_string
));
12300 struct input_event
*event
;
12301 for (event
= kbd_fetch_ptr
; event
!= kbd_store_ptr
; event
++)
12303 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
12304 event
= kbd_buffer
;
12305 if (event
->kind
!= SELECTION_REQUEST_EVENT
12306 && event
->kind
!= SELECTION_CLEAR_EVENT
)
12308 mark_object (event
->x
);
12309 mark_object (event
->y
);
12311 mark_object (event
->frame_or_window
);
12312 mark_object (event
->arg
);