1 /* Keyboard and mouse input; editor command loop.
3 Copyright (C) 1985-1989, 1993-1997, 1999-2012 Free Software Foundation, Inc.
5 This file is part of GNU Emacs.
7 GNU Emacs is free software: you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation, either version 3 of the License, or
10 (at your option) any later version.
12 GNU Emacs is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
22 #define BLOCKINPUT_INLINE EXTERN_INLINE
23 #define KEYBOARD_INLINE EXTERN_INLINE
31 #include "termhooks.h"
36 #include "character.h"
39 #include "dispextern.h"
41 #include "intervals.h"
43 #include "blockinput.h"
57 #include <sys/ioctl.h>
58 #endif /* not MSDOS */
60 #if defined USABLE_FIONREAD && defined USG5_4
61 # include <sys/filio.h>
64 #include "syssignal.h"
66 #include <sys/types.h>
70 #ifdef HAVE_WINDOW_SYSTEM
72 #endif /* HAVE_WINDOW_SYSTEM */
74 /* Variables for blockinput.h: */
76 /* Positive if interrupt input is blocked right now. */
77 volatile int interrupt_input_blocked
;
79 /* True means an input interrupt or alarm signal has arrived.
80 The QUIT macro checks this. */
81 volatile bool pending_signals
;
83 #define KBD_BUFFER_SIZE 4096
85 KBOARD
*initial_kboard
;
86 KBOARD
*current_kboard
;
89 /* True in the single-kboard state, false in the any-kboard state. */
90 static bool single_kboard
;
92 /* Non-nil disable property on a command means
93 do not execute it; call disabled-command-function's value instead. */
94 Lisp_Object Qdisabled
;
95 static Lisp_Object Qdisabled_command_function
;
97 #define NUM_RECENT_KEYS (300)
99 /* Index for storing next element into recent_keys. */
100 static int recent_keys_index
;
102 /* Total number of elements stored into recent_keys. */
103 static int total_keys
;
105 /* This vector holds the last NUM_RECENT_KEYS keystrokes. */
106 static Lisp_Object recent_keys
;
108 /* Vector holding the key sequence that invoked the current command.
109 It is reused for each command, and it may be longer than the current
110 sequence; this_command_key_count indicates how many elements
111 actually mean something.
112 It's easier to staticpro a single Lisp_Object than an array. */
113 Lisp_Object this_command_keys
;
114 ptrdiff_t this_command_key_count
;
116 /* True after calling Freset_this_command_lengths.
117 Usually it is false. */
118 static bool this_command_key_count_reset
;
120 /* This vector is used as a buffer to record the events that were actually read
121 by read_key_sequence. */
122 static Lisp_Object raw_keybuf
;
123 static int raw_keybuf_count
;
125 #define GROW_RAW_KEYBUF \
126 if (raw_keybuf_count == ASIZE (raw_keybuf)) \
127 raw_keybuf = larger_vector (raw_keybuf, 1, -1)
129 /* Number of elements of this_command_keys
130 that precede this key sequence. */
131 static ptrdiff_t this_single_command_key_start
;
133 /* Record values of this_command_key_count and echo_length ()
134 before this command was read. */
135 static ptrdiff_t before_command_key_count
;
136 static ptrdiff_t before_command_echo_length
;
138 /* For longjmp to where kbd input is being done. */
140 static sys_jmp_buf getcjmp
;
142 /* True while doing kbd input. */
143 bool waiting_for_input
;
145 /* True while displaying for echoing. Delays C-g throwing. */
149 /* Non-null means we can start echoing at the next input pause even
150 though there is something in the echo area. */
152 static struct kboard
*ok_to_echo_at_next_pause
;
154 /* The kboard last echoing, or null for none. Reset to 0 in
155 cancel_echoing. If non-null, and a current echo area message
156 exists, and echo_message_buffer is eq to the current message
157 buffer, we know that the message comes from echo_kboard. */
159 struct kboard
*echo_kboard
;
161 /* The buffer used for echoing. Set in echo_now, reset in
164 Lisp_Object echo_message_buffer
;
166 /* True means C-g should cause immediate error-signal. */
169 /* Character that causes a quit. Normally C-g.
171 If we are running on an ordinary terminal, this must be an ordinary
172 ASCII char, since we want to make it our interrupt character.
174 If we are not running on an ordinary terminal, it still needs to be
175 an ordinary ASCII char. This character needs to be recognized in
176 the input interrupt handler. At this point, the keystroke is
177 represented as a struct input_event, while the desired quit
178 character is specified as a lispy event. The mapping from struct
179 input_events to lispy events cannot run in an interrupt handler,
180 and the reverse mapping is difficult for anything but ASCII
183 FOR THESE ELABORATE AND UNSATISFYING REASONS, quit_char must be an
187 /* Current depth in recursive edits. */
188 EMACS_INT command_loop_level
;
190 /* If not Qnil, this is a switch-frame event which we decided to put
191 off until the end of a key sequence. This should be read as the
192 next command input, after any unread_command_events.
194 read_key_sequence uses this to delay switch-frame events until the
195 end of the key sequence; Fread_char uses it to put off switch-frame
196 events until a non-ASCII event is acceptable as input. */
197 Lisp_Object unread_switch_frame
;
199 /* Last size recorded for a current buffer which is not a minibuffer. */
200 static ptrdiff_t last_non_minibuf_size
;
202 /* Total number of times read_char has returned, modulo UINTMAX_MAX + 1. */
203 uintmax_t num_input_events
;
205 /* Value of num_nonmacro_input_events as of last auto save. */
207 static EMACS_INT last_auto_save
;
209 /* The value of point when the last command was started. */
210 static ptrdiff_t last_point_position
;
212 /* The buffer that was current when the last command was started. */
213 static Lisp_Object last_point_position_buffer
;
215 /* The window that was selected when the last command was started. */
216 static Lisp_Object last_point_position_window
;
218 /* The frame in which the last input event occurred, or Qmacro if the
219 last event came from a macro. We use this to determine when to
220 generate switch-frame events. This may be cleared by functions
221 like Fselect_frame, to make sure that a switch-frame event is
222 generated by the next character.
224 FIXME: This is modified by a signal handler so it should be volatile.
225 It's exported to Lisp, though, so it can't simply be marked
227 Lisp_Object internal_last_event_frame
;
229 /* The timestamp of the last input event we received from the X server.
230 X Windows wants this for selection ownership. */
231 Time last_event_timestamp
;
233 static Lisp_Object Qx_set_selection
, Qhandle_switch_frame
;
234 static Lisp_Object Qhandle_select_window
;
235 Lisp_Object QPRIMARY
;
237 static Lisp_Object Qself_insert_command
;
238 static Lisp_Object Qforward_char
;
239 static Lisp_Object Qbackward_char
;
240 Lisp_Object Qundefined
;
241 static Lisp_Object Qtimer_event_handler
;
243 /* read_key_sequence stores here the command definition of the
244 key sequence that it reads. */
245 static Lisp_Object read_key_sequence_cmd
;
246 static Lisp_Object read_key_sequence_remapped
;
248 static Lisp_Object Qinput_method_function
;
250 static Lisp_Object Qdeactivate_mark
;
252 Lisp_Object Qrecompute_lucid_menubar
, Qactivate_menubar_hook
;
254 static Lisp_Object Qecho_area_clear_hook
;
256 /* Hooks to run before and after each command. */
257 static Lisp_Object Qpre_command_hook
;
258 static Lisp_Object Qpost_command_hook
;
260 static Lisp_Object Qdeferred_action_function
;
262 static Lisp_Object Qdelayed_warnings_hook
;
264 static Lisp_Object Qinput_method_exit_on_first_char
;
265 static Lisp_Object Qinput_method_use_echo_area
;
267 static Lisp_Object Qhelp_form_show
;
269 /* File in which we write all commands we read. */
270 static FILE *dribble
;
272 /* Nonzero if input is available. */
275 /* Circular buffer for pre-read keyboard input. */
277 static struct input_event kbd_buffer
[KBD_BUFFER_SIZE
];
279 /* Pointer to next available character in kbd_buffer.
280 If kbd_fetch_ptr == kbd_store_ptr, the buffer is empty.
281 This may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the
282 next available char is in kbd_buffer[0]. */
283 static struct input_event
*kbd_fetch_ptr
;
285 /* Pointer to next place to store character in kbd_buffer. This
286 may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the next
287 character should go in kbd_buffer[0]. */
288 static struct input_event
* volatile kbd_store_ptr
;
290 /* The above pair of variables forms a "queue empty" flag. When we
291 enqueue a non-hook event, we increment kbd_store_ptr. When we
292 dequeue a non-hook event, we increment kbd_fetch_ptr. We say that
293 there is input available if the two pointers are not equal.
295 Why not just have a flag set and cleared by the enqueuing and
296 dequeuing functions? Such a flag could be screwed up by interrupts
297 at inopportune times. */
299 /* Symbols to head events. */
300 static Lisp_Object Qmouse_movement
;
301 static Lisp_Object Qscroll_bar_movement
;
302 Lisp_Object Qswitch_frame
;
303 static Lisp_Object Qdelete_frame
;
304 static Lisp_Object Qiconify_frame
;
305 static Lisp_Object Qmake_frame_visible
;
306 static Lisp_Object Qselect_window
;
307 Lisp_Object Qhelp_echo
;
309 static Lisp_Object Qmouse_fixup_help_message
;
311 /* Symbols to denote kinds of events. */
312 static Lisp_Object Qfunction_key
;
313 Lisp_Object Qmouse_click
;
315 Lisp_Object Qlanguage_change
;
317 static Lisp_Object Qdrag_n_drop
;
318 static Lisp_Object Qsave_session
;
320 static Lisp_Object Qdbus_event
;
322 static Lisp_Object Qconfig_changed_event
;
324 /* Lisp_Object Qmouse_movement; - also an event header */
326 /* Properties of event headers. */
327 Lisp_Object Qevent_kind
;
328 static Lisp_Object Qevent_symbol_elements
;
330 /* Menu and tool bar item parts. */
331 static Lisp_Object Qmenu_enable
;
332 static Lisp_Object QCenable
, QCvisible
, QChelp
, QCkeys
, QCkey_sequence
;
333 Lisp_Object QCfilter
;
335 /* Non-nil disable property on a command means
336 do not execute it; call disabled-command-function's value instead. */
337 Lisp_Object QCtoggle
, QCradio
;
338 static Lisp_Object QCbutton
, QClabel
;
340 static Lisp_Object QCvert_only
;
342 /* An event header symbol HEAD may have a property named
343 Qevent_symbol_element_mask, which is of the form (BASE MODIFIERS);
344 BASE is the base, unmodified version of HEAD, and MODIFIERS is the
345 mask of modifiers applied to it. If present, this is used to help
346 speed up parse_modifiers. */
347 Lisp_Object Qevent_symbol_element_mask
;
349 /* An unmodified event header BASE may have a property named
350 Qmodifier_cache, which is an alist mapping modifier masks onto
351 modified versions of BASE. If present, this helps speed up
353 static Lisp_Object Qmodifier_cache
;
355 /* Symbols to use for parts of windows. */
356 Lisp_Object Qmode_line
;
357 Lisp_Object Qvertical_line
;
358 static Lisp_Object Qvertical_scroll_bar
;
359 Lisp_Object Qmenu_bar
;
361 static Lisp_Object
recursive_edit_unwind (Lisp_Object buffer
);
362 static Lisp_Object
command_loop (void);
363 static Lisp_Object Qextended_command_history
;
364 EMACS_TIME
timer_check (void);
366 static void echo_now (void);
367 static ptrdiff_t echo_length (void);
369 static Lisp_Object Qpolling_period
;
371 /* Incremented whenever a timer is run. */
374 /* Address (if not 0) of EMACS_TIME to zero out if a SIGIO interrupt
376 EMACS_TIME
*input_available_clear_time
;
378 /* True means use SIGIO interrupts; false means use CBREAK mode.
379 Default is true if INTERRUPT_INPUT is defined. */
380 bool interrupt_input
;
382 /* Nonzero while interrupts are temporarily deferred during redisplay. */
383 bool interrupts_deferred
;
385 /* If we support a window system, turn on the code to poll periodically
386 to detect C-g. It isn't actually used when doing interrupt input. */
387 #ifdef HAVE_WINDOW_SYSTEM
388 #define POLL_FOR_INPUT
391 /* The time when Emacs started being idle. */
393 static EMACS_TIME timer_idleness_start_time
;
395 /* After Emacs stops being idle, this saves the last value
396 of timer_idleness_start_time from when it was idle. */
398 static EMACS_TIME timer_last_idleness_start_time
;
401 /* Global variable declarations. */
403 /* Flags for readable_events. */
404 #define READABLE_EVENTS_DO_TIMERS_NOW (1 << 0)
405 #define READABLE_EVENTS_FILTER_EVENTS (1 << 1)
406 #define READABLE_EVENTS_IGNORE_SQUEEZABLES (1 << 2)
408 /* Function for init_keyboard to call with no args (if nonzero). */
409 static void (*keyboard_init_hook
) (void);
411 static bool get_input_pending (int);
412 static bool readable_events (int);
413 static Lisp_Object
read_char_x_menu_prompt (ptrdiff_t, Lisp_Object
*,
414 Lisp_Object
, bool *);
415 static Lisp_Object
read_char_minibuf_menu_prompt (int, ptrdiff_t,
417 static Lisp_Object
make_lispy_event (struct input_event
*);
418 static Lisp_Object
make_lispy_movement (struct frame
*, Lisp_Object
,
419 enum scroll_bar_part
,
420 Lisp_Object
, Lisp_Object
,
422 static Lisp_Object
modify_event_symbol (ptrdiff_t, int, Lisp_Object
,
423 Lisp_Object
, const char *const *,
424 Lisp_Object
*, ptrdiff_t);
425 static Lisp_Object
make_lispy_switch_frame (Lisp_Object
);
426 static bool help_char_p (Lisp_Object
);
427 static void save_getcjmp (sys_jmp_buf
);
428 static void restore_getcjmp (sys_jmp_buf
);
429 static Lisp_Object
apply_modifiers (int, Lisp_Object
);
430 static void clear_event (struct input_event
*);
431 static Lisp_Object
restore_kboard_configuration (Lisp_Object
);
433 static void deliver_input_available_signal (int signo
);
435 static void handle_interrupt (bool);
436 static _Noreturn
void quit_throw_to_read_char (bool);
437 static void process_special_events (void);
438 static void timer_start_idle (void);
439 static void timer_stop_idle (void);
440 static void timer_resume_idle (void);
441 static void deliver_user_signal (int);
442 static char *find_user_signal_name (int);
443 static void store_user_signal_events (void);
445 /* These setters are used only in this file, so they can be private. */
447 kset_echo_string (struct kboard
*kb
, Lisp_Object val
)
449 kb
->INTERNAL_FIELD (echo_string
) = val
;
452 kset_kbd_queue (struct kboard
*kb
, Lisp_Object val
)
454 kb
->INTERNAL_FIELD (kbd_queue
) = val
;
457 kset_keyboard_translate_table (struct kboard
*kb
, Lisp_Object val
)
459 kb
->INTERNAL_FIELD (Vkeyboard_translate_table
) = val
;
462 kset_last_prefix_arg (struct kboard
*kb
, Lisp_Object val
)
464 kb
->INTERNAL_FIELD (Vlast_prefix_arg
) = val
;
467 kset_last_repeatable_command (struct kboard
*kb
, Lisp_Object val
)
469 kb
->INTERNAL_FIELD (Vlast_repeatable_command
) = val
;
472 kset_local_function_key_map (struct kboard
*kb
, Lisp_Object val
)
474 kb
->INTERNAL_FIELD (Vlocal_function_key_map
) = val
;
477 kset_overriding_terminal_local_map (struct kboard
*kb
, Lisp_Object val
)
479 kb
->INTERNAL_FIELD (Voverriding_terminal_local_map
) = val
;
482 kset_real_last_command (struct kboard
*kb
, Lisp_Object val
)
484 kb
->INTERNAL_FIELD (Vreal_last_command
) = val
;
487 kset_system_key_syms (struct kboard
*kb
, Lisp_Object val
)
489 kb
->INTERNAL_FIELD (system_key_syms
) = val
;
493 /* Add C to the echo string, if echoing is going on.
494 C can be a character, which is printed prettily ("M-C-x" and all that
495 jazz), or a symbol, whose name is printed. */
498 echo_char (Lisp_Object c
)
500 if (current_kboard
->immediate_echo
)
502 int size
= KEY_DESCRIPTION_SIZE
+ 100;
503 char *buffer
= alloca (size
);
505 Lisp_Object echo_string
;
507 echo_string
= KVAR (current_kboard
, echo_string
);
509 /* If someone has passed us a composite event, use its head symbol. */
514 ptr
= push_key_description (XINT (c
), ptr
);
516 else if (SYMBOLP (c
))
518 Lisp_Object name
= SYMBOL_NAME (c
);
519 int nbytes
= SBYTES (name
);
521 if (size
- (ptr
- buffer
) < nbytes
)
523 int offset
= ptr
- buffer
;
524 size
= max (2 * size
, size
+ nbytes
);
525 buffer
= alloca (size
);
526 ptr
= buffer
+ offset
;
529 ptr
+= copy_text (SDATA (name
), (unsigned char *) ptr
, nbytes
,
530 STRING_MULTIBYTE (name
), 1);
533 if ((NILP (echo_string
) || SCHARS (echo_string
) == 0)
536 const char *text
= " (Type ? for further options)";
537 int len
= strlen (text
);
539 if (size
- (ptr
- buffer
) < len
)
541 int offset
= ptr
- buffer
;
543 buffer
= alloca (size
);
544 ptr
= buffer
+ offset
;
547 memcpy (ptr
, text
, len
);
551 /* Replace a dash from echo_dash with a space, otherwise
552 add a space at the end as a separator between keys. */
553 if (STRINGP (echo_string
)
554 && SCHARS (echo_string
) > 1)
556 Lisp_Object last_char
, prev_char
, idx
;
558 idx
= make_number (SCHARS (echo_string
) - 2);
559 prev_char
= Faref (echo_string
, idx
);
561 idx
= make_number (SCHARS (echo_string
) - 1);
562 last_char
= Faref (echo_string
, idx
);
564 /* We test PREV_CHAR to make sure this isn't the echoing
566 if (XINT (last_char
) == '-' && XINT (prev_char
) != ' ')
567 Faset (echo_string
, idx
, make_number (' '));
569 echo_string
= concat2 (echo_string
, build_string (" "));
571 else if (STRINGP (echo_string
))
572 echo_string
= concat2 (echo_string
, build_string (" "));
576 concat2 (echo_string
, make_string (buffer
, ptr
- buffer
)));
582 /* Temporarily add a dash to the end of the echo string if it's not
583 empty, so that it serves as a mini-prompt for the very next character. */
588 /* Do nothing if not echoing at all. */
589 if (NILP (KVAR (current_kboard
, echo_string
)))
592 if (this_command_key_count
== 0)
595 if (!current_kboard
->immediate_echo
596 && SCHARS (KVAR (current_kboard
, echo_string
)) == 0)
599 /* Do nothing if we just printed a prompt. */
600 if (current_kboard
->echo_after_prompt
601 == SCHARS (KVAR (current_kboard
, echo_string
)))
604 /* Do nothing if we have already put a dash at the end. */
605 if (SCHARS (KVAR (current_kboard
, echo_string
)) > 1)
607 Lisp_Object last_char
, prev_char
, idx
;
609 idx
= make_number (SCHARS (KVAR (current_kboard
, echo_string
)) - 2);
610 prev_char
= Faref (KVAR (current_kboard
, echo_string
), idx
);
612 idx
= make_number (SCHARS (KVAR (current_kboard
, echo_string
)) - 1);
613 last_char
= Faref (KVAR (current_kboard
, echo_string
), idx
);
615 if (XINT (last_char
) == '-' && XINT (prev_char
) != ' ')
619 /* Put a dash at the end of the buffer temporarily,
620 but make it go away when the next character is added. */
623 concat2 (KVAR (current_kboard
, echo_string
), build_string ("-")));
627 /* Display the current echo string, and begin echoing if not already
633 if (!current_kboard
->immediate_echo
)
636 current_kboard
->immediate_echo
= 1;
638 for (i
= 0; i
< this_command_key_count
; i
++)
642 /* Set before_command_echo_length to the value that would
643 have been saved before the start of this subcommand in
644 command_loop_1, if we had already been echoing then. */
645 if (i
== this_single_command_key_start
)
646 before_command_echo_length
= echo_length ();
648 c
= AREF (this_command_keys
, i
);
649 if (! (EVENT_HAS_PARAMETERS (c
)
650 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
654 /* Set before_command_echo_length to the value that would
655 have been saved before the start of this subcommand in
656 command_loop_1, if we had already been echoing then. */
657 if (this_command_key_count
== this_single_command_key_start
)
658 before_command_echo_length
= echo_length ();
660 /* Put a dash at the end to invite the user to type more. */
665 message3_nolog (KVAR (current_kboard
, echo_string
),
666 SBYTES (KVAR (current_kboard
, echo_string
)),
667 STRING_MULTIBYTE (KVAR (current_kboard
, echo_string
)));
670 /* Record in what buffer we echoed, and from which kboard. */
671 echo_message_buffer
= echo_area_buffer
[0];
672 echo_kboard
= current_kboard
;
674 if (waiting_for_input
&& !NILP (Vquit_flag
))
675 quit_throw_to_read_char (0);
678 /* Turn off echoing, for the start of a new command. */
681 cancel_echoing (void)
683 current_kboard
->immediate_echo
= 0;
684 current_kboard
->echo_after_prompt
= -1;
685 kset_echo_string (current_kboard
, Qnil
);
686 ok_to_echo_at_next_pause
= NULL
;
688 echo_message_buffer
= Qnil
;
691 /* Return the length of the current echo string. */
696 return (STRINGP (KVAR (current_kboard
, echo_string
))
697 ? SCHARS (KVAR (current_kboard
, echo_string
))
701 /* Truncate the current echo message to its first LEN chars.
702 This and echo_char get used by read_key_sequence when the user
703 switches frames while entering a key sequence. */
706 echo_truncate (ptrdiff_t nchars
)
708 if (STRINGP (KVAR (current_kboard
, echo_string
)))
709 kset_echo_string (current_kboard
,
710 Fsubstring (KVAR (current_kboard
, echo_string
),
711 make_number (0), make_number (nchars
)));
712 truncate_echo_area (nchars
);
716 /* Functions for manipulating this_command_keys. */
718 add_command_key (Lisp_Object key
)
720 #if 0 /* Not needed after we made Freset_this_command_lengths
721 do the job immediately. */
722 /* If reset-this-command-length was called recently, obey it now.
723 See the doc string of that function for an explanation of why. */
724 if (before_command_restore_flag
)
726 this_command_key_count
= before_command_key_count_1
;
727 if (this_command_key_count
< this_single_command_key_start
)
728 this_single_command_key_start
= this_command_key_count
;
729 echo_truncate (before_command_echo_length_1
);
730 before_command_restore_flag
= 0;
734 if (this_command_key_count
>= ASIZE (this_command_keys
))
735 this_command_keys
= larger_vector (this_command_keys
, 1, -1);
737 ASET (this_command_keys
, this_command_key_count
, key
);
738 ++this_command_key_count
;
743 recursive_edit_1 (void)
745 ptrdiff_t count
= SPECPDL_INDEX ();
748 if (command_loop_level
> 0)
750 specbind (Qstandard_output
, Qt
);
751 specbind (Qstandard_input
, Qt
);
754 #ifdef HAVE_WINDOW_SYSTEM
755 /* The command loop has started an hourglass timer, so we have to
756 cancel it here, otherwise it will fire because the recursive edit
757 can take some time. Do not check for display_hourglass_p here,
758 because it could already be nil. */
762 /* This function may have been called from a debugger called from
763 within redisplay, for instance by Edebugging a function called
764 from fontification-functions. We want to allow redisplay in
765 the debugging session.
767 The recursive edit is left with a `(throw exit ...)'. The `exit'
768 tag is not caught anywhere in redisplay, i.e. when we leave the
769 recursive edit, the original redisplay leading to the recursive
770 edit will be unwound. The outcome should therefore be safe. */
771 specbind (Qinhibit_redisplay
, Qnil
);
774 val
= command_loop ();
776 Fsignal (Qquit
, Qnil
);
777 /* Handle throw from read_minibuf when using minibuffer
778 while it's active but we're in another window. */
780 xsignal1 (Qerror
, val
);
782 return unbind_to (count
, Qnil
);
785 /* When an auto-save happens, record the "time", and don't do again soon. */
788 record_auto_save (void)
790 last_auto_save
= num_nonmacro_input_events
;
793 /* Make an auto save happen as soon as possible at command level. */
797 force_auto_save_soon (void)
799 last_auto_save
= - auto_save_interval
- 1;
801 record_asynch_buffer_change ();
805 DEFUN ("recursive-edit", Frecursive_edit
, Srecursive_edit
, 0, 0, "",
806 doc
: /* Invoke the editor command loop recursively.
807 To get out of the recursive edit, a command can do `(throw 'exit nil)';
808 that tells this function to return.
809 Alternatively, `(throw 'exit t)' makes this function signal an error.
810 This function is called by the editor initialization to begin editing. */)
813 ptrdiff_t count
= SPECPDL_INDEX ();
816 /* If we enter while input is blocked, don't lock up here.
817 This may happen through the debugger during redisplay. */
818 if (input_blocked_p ())
821 command_loop_level
++;
822 update_mode_lines
= 1;
824 if (command_loop_level
825 && current_buffer
!= XBUFFER (XWINDOW (selected_window
)->buffer
))
826 buffer
= Fcurrent_buffer ();
830 /* If we leave recursive_edit_1 below with a `throw' for instance,
831 like it is done in the splash screen display, we have to
832 make sure that we restore single_kboard as command_loop_1
833 would have done if it were left normally. */
834 if (command_loop_level
> 0)
835 temporarily_switch_to_single_kboard (SELECTED_FRAME ());
836 record_unwind_protect (recursive_edit_unwind
, buffer
);
839 return unbind_to (count
, Qnil
);
843 recursive_edit_unwind (Lisp_Object buffer
)
845 if (BUFFERP (buffer
))
846 Fset_buffer (buffer
);
848 command_loop_level
--;
849 update_mode_lines
= 1;
854 #if 0 /* These two functions are now replaced with
855 temporarily_switch_to_single_kboard. */
859 #if 0 /* Theory: if there's anything in Vunread_command_events,
860 it will right away be read by read_key_sequence,
861 and then if we do switch KBOARDS, it will go into the side
862 queue then. So we don't need to do anything special here -- rms. */
863 if (CONSP (Vunread_command_events
))
865 current_kboard
->kbd_queue
866 = nconc2 (Vunread_command_events
, current_kboard
->kbd_queue
);
867 current_kboard
->kbd_queue_has_data
= 1;
869 Vunread_command_events
= Qnil
;
874 /* Switch to the single-kboard state, making current_kboard
875 the only KBOARD from which further input is accepted. */
878 single_kboard_state ()
884 /* If we're in single_kboard state for kboard KBOARD,
888 not_single_kboard_state (KBOARD
*kboard
)
890 if (kboard
== current_kboard
)
894 /* Maintain a stack of kboards, so other parts of Emacs
895 can switch temporarily to the kboard of a given frame
896 and then revert to the previous status. */
901 struct kboard_stack
*next
;
904 static struct kboard_stack
*kboard_stack
;
907 push_kboard (struct kboard
*k
)
909 struct kboard_stack
*p
= xmalloc (sizeof *p
);
911 p
->next
= kboard_stack
;
912 p
->kboard
= current_kboard
;
922 struct kboard_stack
*p
= kboard_stack
;
924 for (t
= terminal_list
; t
; t
= t
->next_terminal
)
926 if (t
->kboard
== p
->kboard
)
928 current_kboard
= p
->kboard
;
935 /* The terminal we remembered has been deleted. */
936 current_kboard
= FRAME_KBOARD (SELECTED_FRAME ());
939 kboard_stack
= p
->next
;
943 /* Switch to single_kboard mode, making current_kboard the only KBOARD
944 from which further input is accepted. If F is non-nil, set its
945 KBOARD as the current keyboard.
947 This function uses record_unwind_protect to return to the previous
950 If Emacs is already in single_kboard mode, and F's keyboard is
951 locked, then this function will throw an error. */
954 temporarily_switch_to_single_kboard (struct frame
*f
)
956 bool was_locked
= single_kboard
;
959 if (f
!= NULL
&& FRAME_KBOARD (f
) != current_kboard
)
960 /* We can not switch keyboards while in single_kboard mode.
961 In rare cases, Lisp code may call `recursive-edit' (or
962 `read-minibuffer' or `y-or-n-p') after it switched to a
963 locked frame. For example, this is likely to happen
964 when server.el connects to a new terminal while Emacs is in
965 single_kboard mode. It is best to throw an error instead
966 of presenting the user with a frozen screen. */
967 error ("Terminal %d is locked, cannot read from it",
968 FRAME_TERMINAL (f
)->id
);
970 /* This call is unnecessary, but helps
971 `restore_kboard_configuration' discover if somebody changed
972 `current_kboard' behind our back. */
973 push_kboard (current_kboard
);
976 current_kboard
= FRAME_KBOARD (f
);
978 record_unwind_protect (restore_kboard_configuration
,
979 (was_locked
? Qt
: Qnil
));
982 #if 0 /* This function is not needed anymore. */
984 record_single_kboard_state ()
987 push_kboard (current_kboard
);
988 record_unwind_protect (restore_kboard_configuration
,
989 (single_kboard
? Qt
: Qnil
));
994 restore_kboard_configuration (Lisp_Object was_locked
)
996 if (NILP (was_locked
))
1000 struct kboard
*prev
= current_kboard
;
1003 /* The pop should not change the kboard. */
1004 if (single_kboard
&& current_kboard
!= prev
)
1011 /* Handle errors that are not handled at inner levels
1012 by printing an error message and returning to the editor command loop. */
1015 cmd_error (Lisp_Object data
)
1017 Lisp_Object old_level
, old_length
;
1018 char macroerror
[sizeof "After..kbd macro iterations: "
1019 + INT_STRLEN_BOUND (EMACS_INT
)];
1021 #ifdef HAVE_WINDOW_SYSTEM
1022 if (display_hourglass_p
)
1023 cancel_hourglass ();
1026 if (!NILP (executing_kbd_macro
))
1028 if (executing_kbd_macro_iterations
== 1)
1029 sprintf (macroerror
, "After 1 kbd macro iteration: ");
1031 sprintf (macroerror
, "After %"pI
"d kbd macro iterations: ",
1032 executing_kbd_macro_iterations
);
1037 Vstandard_output
= Qt
;
1038 Vstandard_input
= Qt
;
1039 Vexecuting_kbd_macro
= Qnil
;
1040 executing_kbd_macro
= Qnil
;
1041 kset_prefix_arg (current_kboard
, Qnil
);
1042 kset_last_prefix_arg (current_kboard
, Qnil
);
1045 /* Avoid unquittable loop if data contains a circular list. */
1046 old_level
= Vprint_level
;
1047 old_length
= Vprint_length
;
1048 XSETFASTINT (Vprint_level
, 10);
1049 XSETFASTINT (Vprint_length
, 10);
1050 cmd_error_internal (data
, macroerror
);
1051 Vprint_level
= old_level
;
1052 Vprint_length
= old_length
;
1055 Vinhibit_quit
= Qnil
;
1057 return make_number (0);
1060 /* Take actions on handling an error. DATA is the data that describes
1063 CONTEXT is a C-string containing ASCII characters only which
1064 describes the context in which the error happened. If we need to
1065 generalize CONTEXT to allow multibyte characters, make it a Lisp
1069 cmd_error_internal (Lisp_Object data
, const char *context
)
1071 struct frame
*sf
= SELECTED_FRAME ();
1073 /* The immediate context is not interesting for Quits,
1074 since they are asynchronous. */
1075 if (EQ (XCAR (data
), Qquit
))
1076 Vsignaling_function
= Qnil
;
1081 /* Use user's specified output function if any. */
1082 if (!NILP (Vcommand_error_function
))
1083 call3 (Vcommand_error_function
, data
,
1084 context
? build_string (context
) : empty_unibyte_string
,
1085 Vsignaling_function
);
1086 /* If the window system or terminal frame hasn't been initialized
1087 yet, or we're not interactive, write the message to stderr and exit. */
1088 else if (!sf
->glyphs_initialized_p
1089 /* The initial frame is a special non-displaying frame. It
1090 will be current in daemon mode when there are no frames
1091 to display, and in non-daemon mode before the real frame
1092 has finished initializing. If an error is thrown in the
1093 latter case while creating the frame, then the frame
1094 will never be displayed, so the safest thing to do is
1095 write to stderr and quit. In daemon mode, there are
1096 many other potential errors that do not prevent frames
1097 from being created, so continuing as normal is better in
1099 || (!IS_DAEMON
&& FRAME_INITIAL_P (sf
))
1102 print_error_message (data
, Qexternal_debugging_output
,
1103 context
, Vsignaling_function
);
1104 Fterpri (Qexternal_debugging_output
);
1105 Fkill_emacs (make_number (-1));
1109 clear_message (1, 0);
1111 message_log_maybe_newline ();
1114 print_error_message (data
, Qt
, context
, Vsignaling_function
);
1117 Vsignaling_function
= Qnil
;
1120 static Lisp_Object
command_loop_2 (Lisp_Object
);
1121 static Lisp_Object
top_level_1 (Lisp_Object
);
1123 /* Entry to editor-command-loop.
1124 This level has the catches for exiting/returning to editor command loop.
1125 It returns nil to exit recursive edit, t to abort it. */
1130 if (command_loop_level
> 0 || minibuf_level
> 0)
1133 val
= internal_catch (Qexit
, command_loop_2
, Qnil
);
1134 executing_kbd_macro
= Qnil
;
1140 internal_catch (Qtop_level
, top_level_1
, Qnil
);
1141 internal_catch (Qtop_level
, command_loop_2
, Qnil
);
1142 executing_kbd_macro
= Qnil
;
1144 /* End of file in -batch run causes exit here. */
1150 /* Here we catch errors in execution of commands within the
1151 editing loop, and reenter the editing loop.
1152 When there is an error, cmd_error runs and returns a non-nil
1153 value to us. A value of nil means that command_loop_1 itself
1154 returned due to end of file (or end of kbd macro). */
1157 command_loop_2 (Lisp_Object ignore
)
1159 register Lisp_Object val
;
1162 val
= internal_condition_case (command_loop_1
, Qerror
, cmd_error
);
1163 while (!NILP (val
));
1171 return Feval (Vtop_level
, Qnil
);
1175 top_level_1 (Lisp_Object ignore
)
1177 /* On entry to the outer level, run the startup file */
1178 if (!NILP (Vtop_level
))
1179 internal_condition_case (top_level_2
, Qerror
, cmd_error
);
1180 else if (!NILP (Vpurify_flag
))
1181 message ("Bare impure Emacs (standard Lisp code not loaded)");
1183 message ("Bare Emacs (standard Lisp code not loaded)");
1187 DEFUN ("top-level", Ftop_level
, Stop_level
, 0, 0, "",
1188 doc
: /* Exit all recursive editing levels.
1189 This also exits all active minibuffers. */)
1192 #ifdef HAVE_WINDOW_SYSTEM
1193 if (display_hourglass_p
)
1194 cancel_hourglass ();
1197 /* Unblock input if we enter with input blocked. This may happen if
1198 redisplay traps e.g. during tool-bar update with input blocked. */
1199 totally_unblock_input ();
1201 Fthrow (Qtop_level
, Qnil
);
1204 static _Noreturn
void
1205 user_error (const char *msg
)
1207 xsignal1 (Quser_error
, build_string (msg
));
1211 DEFUN ("exit-recursive-edit", Fexit_recursive_edit
, Sexit_recursive_edit
, 0, 0, "",
1212 doc
: /* Exit from the innermost recursive edit or minibuffer. */)
1215 if (command_loop_level
> 0 || minibuf_level
> 0)
1216 Fthrow (Qexit
, Qnil
);
1218 user_error ("No recursive edit is in progress");
1222 DEFUN ("abort-recursive-edit", Fabort_recursive_edit
, Sabort_recursive_edit
, 0, 0, "",
1223 doc
: /* Abort the command that requested this recursive edit or minibuffer input. */)
1226 if (command_loop_level
> 0 || minibuf_level
> 0)
1229 user_error ("No recursive edit is in progress");
1232 /* Restore mouse tracking enablement. See Ftrack_mouse for the only use
1233 of this function. */
1236 tracking_off (Lisp_Object old_value
)
1238 do_mouse_tracking
= old_value
;
1239 if (NILP (old_value
))
1241 /* Redisplay may have been preempted because there was input
1242 available, and it assumes it will be called again after the
1243 input has been processed. If the only input available was
1244 the sort that we have just disabled, then we need to call
1246 if (!readable_events (READABLE_EVENTS_DO_TIMERS_NOW
))
1248 redisplay_preserve_echo_area (6);
1249 get_input_pending (READABLE_EVENTS_DO_TIMERS_NOW
);
1255 DEFUN ("track-mouse", Ftrack_mouse
, Strack_mouse
, 0, UNEVALLED
, 0,
1256 doc
: /* Evaluate BODY with mouse movement events enabled.
1257 Within a `track-mouse' form, mouse motion generates input events that
1258 you can read with `read-event'.
1259 Normally, mouse motion is ignored.
1260 usage: (track-mouse BODY...) */)
1263 ptrdiff_t count
= SPECPDL_INDEX ();
1266 record_unwind_protect (tracking_off
, do_mouse_tracking
);
1268 do_mouse_tracking
= Qt
;
1270 val
= Fprogn (args
);
1271 return unbind_to (count
, val
);
1274 /* If mouse has moved on some frame, return one of those frames.
1278 If ignore_mouse_drag_p is non-zero, ignore (implicit) mouse movement
1279 after resizing the tool-bar window. */
1281 #if !defined HAVE_WINDOW_SYSTEM || defined USE_GTK || defined HAVE_NS
1284 bool ignore_mouse_drag_p
;
1287 some_mouse_moved (void)
1289 Lisp_Object tail
, frame
;
1291 if (ignore_mouse_drag_p
)
1293 /* ignore_mouse_drag_p = 0; */
1297 FOR_EACH_FRAME (tail
, frame
)
1299 if (XFRAME (frame
)->mouse_moved
)
1300 return XFRAME (frame
);
1307 /* This is the actual command reading loop,
1308 sans error-handling encapsulation. */
1310 static int read_key_sequence (Lisp_Object
*, int, Lisp_Object
,
1312 void safe_run_hooks (Lisp_Object
);
1313 static void adjust_point_for_property (ptrdiff_t, bool);
1315 /* Cancel hourglass from protect_unwind.
1317 #ifdef HAVE_WINDOW_SYSTEM
1319 cancel_hourglass_unwind (Lisp_Object arg
)
1321 cancel_hourglass ();
1326 /* The last boundary auto-added to buffer-undo-list. */
1327 Lisp_Object last_undo_boundary
;
1329 /* FIXME: This is wrong rather than test window-system, we should call
1330 a new set-selection, which will then dispatch to x-set-selection, or
1331 tty-set-selection, or w32-set-selection, ... */
1334 command_loop_1 (void)
1337 Lisp_Object keybuf
[30];
1339 EMACS_INT prev_modiff
= 0;
1340 struct buffer
*prev_buffer
= NULL
;
1341 bool already_adjusted
= 0;
1343 kset_prefix_arg (current_kboard
, Qnil
);
1344 kset_last_prefix_arg (current_kboard
, Qnil
);
1345 Vdeactivate_mark
= Qnil
;
1346 waiting_for_input
= 0;
1349 this_command_key_count
= 0;
1350 this_command_key_count_reset
= 0;
1351 this_single_command_key_start
= 0;
1353 if (NILP (Vmemory_full
))
1355 /* Make sure this hook runs after commands that get errors and
1356 throw to top level. */
1357 /* Note that the value cell will never directly contain nil
1358 if the symbol is a local variable. */
1359 if (!NILP (Vpost_command_hook
) && !NILP (Vrun_hooks
))
1360 safe_run_hooks (Qpost_command_hook
);
1362 /* If displaying a message, resize the echo area window to fit
1363 that message's size exactly. */
1364 if (!NILP (echo_area_buffer
[0]))
1365 resize_echo_area_exactly ();
1367 /* If there are warnings waiting, process them. */
1368 if (!NILP (Vdelayed_warnings_list
))
1369 safe_run_hooks (Qdelayed_warnings_hook
);
1371 if (!NILP (Vdeferred_action_list
))
1372 safe_run_hooks (Qdeferred_action_function
);
1375 /* Do this after running Vpost_command_hook, for consistency. */
1376 kset_last_command (current_kboard
, Vthis_command
);
1377 kset_real_last_command (current_kboard
, Vreal_this_command
);
1378 if (!CONSP (last_command_event
))
1379 kset_last_repeatable_command (current_kboard
, Vreal_this_command
);
1383 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1386 /* Make sure the current window's buffer is selected. */
1387 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->buffer
));
1389 /* Display any malloc warning that just came out. Use while because
1390 displaying one warning can cause another. */
1392 while (pending_malloc_warning
)
1393 display_malloc_warning ();
1395 Vdeactivate_mark
= Qnil
;
1397 /* Don't ignore mouse movements for more than a single command
1398 loop. (This flag is set in xdisp.c whenever the tool bar is
1399 resized, because the resize moves text up or down, and would
1400 generate false mouse drag events if we don't ignore them.) */
1401 ignore_mouse_drag_p
= 0;
1403 /* If minibuffer on and echo area in use,
1404 wait a short time and redraw minibuffer. */
1407 && !NILP (echo_area_buffer
[0])
1408 && EQ (minibuf_window
, echo_area_window
)
1409 && NUMBERP (Vminibuffer_message_timeout
))
1411 /* Bind inhibit-quit to t so that C-g gets read in
1412 rather than quitting back to the minibuffer. */
1413 ptrdiff_t count
= SPECPDL_INDEX ();
1414 specbind (Qinhibit_quit
, Qt
);
1416 sit_for (Vminibuffer_message_timeout
, 0, 2);
1418 /* Clear the echo area. */
1420 safe_run_hooks (Qecho_area_clear_hook
);
1422 unbind_to (count
, Qnil
);
1424 /* If a C-g came in before, treat it as input now. */
1425 if (!NILP (Vquit_flag
))
1428 Vunread_command_events
= Fcons (make_number (quit_char
), Qnil
);
1432 /* If it has changed current-menubar from previous value,
1433 really recompute the menubar from the value. */
1434 if (! NILP (Vlucid_menu_bar_dirty_flag
)
1435 && !NILP (Ffboundp (Qrecompute_lucid_menubar
)))
1436 call0 (Qrecompute_lucid_menubar
);
1438 before_command_key_count
= this_command_key_count
;
1439 before_command_echo_length
= echo_length ();
1441 Vthis_command
= Qnil
;
1442 Vreal_this_command
= Qnil
;
1443 Vthis_original_command
= Qnil
;
1444 Vthis_command_keys_shift_translated
= Qnil
;
1446 /* Read next key sequence; i gets its length. */
1447 i
= read_key_sequence (keybuf
, sizeof keybuf
/ sizeof keybuf
[0],
1450 /* A filter may have run while we were reading the input. */
1451 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1453 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->buffer
));
1457 /* Now we have read a key sequence of length I,
1458 or else I is 0 and we found end of file. */
1460 if (i
== 0) /* End of file -- happens only in */
1461 return Qnil
; /* a kbd macro, at the end. */
1462 /* -1 means read_key_sequence got a menu that was rejected.
1463 Just loop around and read another command. */
1467 this_command_key_count
= 0;
1468 this_command_key_count_reset
= 0;
1469 this_single_command_key_start
= 0;
1473 last_command_event
= keybuf
[i
- 1];
1475 /* If the previous command tried to force a specific window-start,
1476 forget about that, in case this command moves point far away
1477 from that position. But also throw away beg_unchanged and
1478 end_unchanged information in that case, so that redisplay will
1479 update the whole window properly. */
1480 if (XWINDOW (selected_window
)->force_start
)
1483 XWINDOW (selected_window
)->force_start
= 0;
1484 b
= XBUFFER (XWINDOW (selected_window
)->buffer
);
1485 BUF_BEG_UNCHANGED (b
) = BUF_END_UNCHANGED (b
) = 0;
1488 cmd
= read_key_sequence_cmd
;
1489 if (!NILP (Vexecuting_kbd_macro
))
1491 if (!NILP (Vquit_flag
))
1493 Vexecuting_kbd_macro
= Qt
;
1494 QUIT
; /* Make some noise. */
1495 /* Will return since macro now empty. */
1499 /* Do redisplay processing after this command except in special
1500 cases identified below. */
1501 prev_buffer
= current_buffer
;
1502 prev_modiff
= MODIFF
;
1503 last_point_position
= PT
;
1504 last_point_position_window
= selected_window
;
1505 XSETBUFFER (last_point_position_buffer
, prev_buffer
);
1507 /* By default, we adjust point to a boundary of a region that
1508 has such a property that should be treated intangible
1509 (e.g. composition, display). But, some commands will set
1510 this variable differently. */
1511 Vdisable_point_adjustment
= Qnil
;
1513 /* Process filters and timers may have messed with deactivate-mark.
1514 reset it before we execute the command. */
1515 Vdeactivate_mark
= Qnil
;
1517 /* Remap command through active keymaps. */
1518 Vthis_original_command
= cmd
;
1519 if (!NILP (read_key_sequence_remapped
))
1520 cmd
= read_key_sequence_remapped
;
1522 /* Execute the command. */
1524 Vthis_command
= cmd
;
1525 Vreal_this_command
= cmd
;
1526 safe_run_hooks (Qpre_command_hook
);
1528 already_adjusted
= 0;
1530 if (NILP (Vthis_command
))
1532 /* nil means key is undefined. */
1533 Lisp_Object keys
= Fvector (i
, keybuf
);
1534 keys
= Fkey_description (keys
, Qnil
);
1536 message_with_string ("%s is undefined", keys
, 0);
1537 kset_defining_kbd_macro (current_kboard
, Qnil
);
1538 update_mode_lines
= 1;
1539 /* If this is a down-mouse event, don't reset prefix-arg;
1540 pass it to the command run by the up event. */
1541 if (EVENT_HAS_PARAMETERS (last_command_event
))
1543 Lisp_Object breakdown
1544 = parse_modifiers (EVENT_HEAD (last_command_event
));
1545 int modifiers
= XINT (XCAR (XCDR (breakdown
)));
1546 if (!(modifiers
& down_modifier
))
1547 kset_prefix_arg (current_kboard
, Qnil
);
1550 kset_prefix_arg (current_kboard
, Qnil
);
1554 /* Here for a command that isn't executed directly. */
1556 #ifdef HAVE_WINDOW_SYSTEM
1557 ptrdiff_t scount
= SPECPDL_INDEX ();
1559 if (display_hourglass_p
1560 && NILP (Vexecuting_kbd_macro
))
1562 record_unwind_protect (cancel_hourglass_unwind
, Qnil
);
1567 if (NILP (KVAR (current_kboard
, Vprefix_arg
))) /* FIXME: Why? --Stef */
1569 Lisp_Object undo
= BVAR (current_buffer
, undo_list
);
1572 = (EQ (undo
, BVAR (current_buffer
, undo_list
))
1573 ? Qnil
: BVAR (current_buffer
, undo_list
));
1575 Fcommand_execute (Vthis_command
, Qnil
, Qnil
, Qnil
);
1577 #ifdef HAVE_WINDOW_SYSTEM
1578 /* Do not check display_hourglass_p here, because
1579 Fcommand_execute could change it, but we should cancel
1580 hourglass cursor anyway.
1581 But don't cancel the hourglass within a macro
1582 just because a command in the macro finishes. */
1583 if (NILP (Vexecuting_kbd_macro
))
1584 unbind_to (scount
, Qnil
);
1587 kset_last_prefix_arg (current_kboard
, Vcurrent_prefix_arg
);
1589 safe_run_hooks (Qpost_command_hook
);
1591 /* If displaying a message, resize the echo area window to fit
1592 that message's size exactly. */
1593 if (!NILP (echo_area_buffer
[0]))
1594 resize_echo_area_exactly ();
1596 /* If there are warnings waiting, process them. */
1597 if (!NILP (Vdelayed_warnings_list
))
1598 safe_run_hooks (Qdelayed_warnings_hook
);
1600 safe_run_hooks (Qdeferred_action_function
);
1602 /* If there is a prefix argument,
1603 1) We don't want Vlast_command to be ``universal-argument''
1604 (that would be dumb), so don't set Vlast_command,
1605 2) we want to leave echoing on so that the prefix will be
1606 echoed as part of this key sequence, so don't call
1608 3) we want to leave this_command_key_count non-zero, so that
1609 read_char will realize that it is re-reading a character, and
1610 not echo it a second time.
1612 If the command didn't actually create a prefix arg,
1613 but is merely a frame event that is transparent to prefix args,
1614 then the above doesn't apply. */
1615 if (NILP (KVAR (current_kboard
, Vprefix_arg
))
1616 || CONSP (last_command_event
))
1618 kset_last_command (current_kboard
, Vthis_command
);
1619 kset_real_last_command (current_kboard
, Vreal_this_command
);
1620 if (!CONSP (last_command_event
))
1621 kset_last_repeatable_command (current_kboard
, Vreal_this_command
);
1623 this_command_key_count
= 0;
1624 this_command_key_count_reset
= 0;
1625 this_single_command_key_start
= 0;
1628 if (!NILP (BVAR (current_buffer
, mark_active
))
1629 && !NILP (Vrun_hooks
))
1631 /* In Emacs 22, setting transient-mark-mode to `only' was a
1632 way of turning it on for just one command. This usage is
1633 obsolete, but support it anyway. */
1634 if (EQ (Vtransient_mark_mode
, Qidentity
))
1635 Vtransient_mark_mode
= Qnil
;
1636 else if (EQ (Vtransient_mark_mode
, Qonly
))
1637 Vtransient_mark_mode
= Qidentity
;
1639 if (!NILP (Vdeactivate_mark
))
1640 /* If `select-active-regions' is non-nil, this call to
1641 `deactivate-mark' also sets the PRIMARY selection. */
1642 call0 (Qdeactivate_mark
);
1645 /* Even if not deactivating the mark, set PRIMARY if
1646 `select-active-regions' is non-nil. */
1647 if (!NILP (Fwindow_system (Qnil
))
1648 /* Even if mark_active is non-nil, the actual buffer
1649 marker may not have been set yet (Bug#7044). */
1650 && XMARKER (BVAR (current_buffer
, mark
))->buffer
1651 && (EQ (Vselect_active_regions
, Qonly
)
1652 ? EQ (CAR_SAFE (Vtransient_mark_mode
), Qonly
)
1653 : (!NILP (Vselect_active_regions
)
1654 && !NILP (Vtransient_mark_mode
)))
1655 && NILP (Fmemq (Vthis_command
,
1656 Vselection_inhibit_update_commands
)))
1659 XINT (Fmarker_position (BVAR (current_buffer
, mark
)));
1662 call2 (Qx_set_selection
, QPRIMARY
,
1663 make_buffer_string (beg
, end
, 0));
1665 call2 (Qx_set_selection
, QPRIMARY
,
1666 make_buffer_string (end
, beg
, 0));
1667 /* Don't set empty selections. */
1670 if (current_buffer
!= prev_buffer
|| MODIFF
!= prev_modiff
)
1672 Lisp_Object hook
= intern ("activate-mark-hook");
1673 Frun_hooks (1, &hook
);
1677 Vsaved_region_selection
= Qnil
;
1682 if (current_buffer
== prev_buffer
1683 && last_point_position
!= PT
1684 && NILP (Vdisable_point_adjustment
)
1685 && NILP (Vglobal_disable_point_adjustment
))
1687 if (last_point_position
> BEGV
1688 && last_point_position
< ZV
1689 && (composition_adjust_point (last_point_position
,
1690 last_point_position
)
1691 != last_point_position
))
1692 /* The last point was temporarily set within a grapheme
1693 cluster to prevent automatic composition. To recover
1694 the automatic composition, we must update the
1696 windows_or_buffers_changed
++;
1697 if (!already_adjusted
)
1698 adjust_point_for_property (last_point_position
,
1699 MODIFF
!= prev_modiff
);
1702 /* Install chars successfully executed in kbd macro. */
1704 if (!NILP (KVAR (current_kboard
, defining_kbd_macro
))
1705 && NILP (KVAR (current_kboard
, Vprefix_arg
)))
1706 finalize_kbd_macro_chars ();
1710 /* Adjust point to a boundary of a region that has such a property
1711 that should be treated intangible. For the moment, we check
1712 `composition', `display' and `invisible' properties.
1713 LAST_PT is the last position of point. */
1716 adjust_point_for_property (ptrdiff_t last_pt
, bool modified
)
1719 Lisp_Object val
, overlay
, tmp
;
1720 /* When called after buffer modification, we should temporarily
1721 suppress the point adjustment for automatic composition so that a
1722 user can keep inserting another character at point or keep
1723 deleting characters around point. */
1724 bool check_composition
= ! modified
, check_display
= 1, check_invisible
= 1;
1725 ptrdiff_t orig_pt
= PT
;
1727 /* FIXME: cycling is probably not necessary because these properties
1728 can't be usefully combined anyway. */
1729 while (check_composition
|| check_display
|| check_invisible
)
1731 /* FIXME: check `intangible'. */
1732 if (check_composition
1733 && PT
> BEGV
&& PT
< ZV
1734 && (beg
= composition_adjust_point (last_pt
, PT
)) != PT
)
1737 check_display
= check_invisible
= 1;
1739 check_composition
= 0;
1741 && PT
> BEGV
&& PT
< ZV
1742 && !NILP (val
= get_char_property_and_overlay
1743 (make_number (PT
), Qdisplay
, Qnil
, &overlay
))
1744 && display_prop_intangible_p (val
, overlay
, PT
, PT_BYTE
)
1745 && (!OVERLAYP (overlay
)
1746 ? get_property_and_range (PT
, Qdisplay
, &val
, &beg
, &end
, Qnil
)
1747 : (beg
= OVERLAY_POSITION (OVERLAY_START (overlay
)),
1748 end
= OVERLAY_POSITION (OVERLAY_END (overlay
))))
1749 && (beg
< PT
/* && end > PT <- It's always the case. */
1750 || (beg
<= PT
&& STRINGP (val
) && SCHARS (val
) == 0)))
1753 SET_PT (PT
< last_pt
1754 ? (STRINGP (val
) && SCHARS (val
) == 0
1755 ? max (beg
- 1, BEGV
)
1758 check_composition
= check_invisible
= 1;
1761 if (check_invisible
&& PT
> BEGV
&& PT
< ZV
)
1767 /* Find boundaries `beg' and `end' of the invisible area, if any. */
1770 /* FIXME: We should stop if we find a spot between
1771 two runs of `invisible' where inserted text would
1772 be visible. This is important when we have two
1773 invisible boundaries that enclose an area: if the
1774 area is empty, we need this test in order to make
1775 it possible to place point in the middle rather
1776 than skip both boundaries. However, this code
1777 also stops anywhere in a non-sticky text-property,
1778 which breaks (e.g.) Org mode. */
1779 && (val
= get_pos_property (make_number (end
),
1781 TEXT_PROP_MEANS_INVISIBLE (val
))
1783 && !NILP (val
= get_char_property_and_overlay
1784 (make_number (end
), Qinvisible
, Qnil
, &overlay
))
1785 && (inv
= TEXT_PROP_MEANS_INVISIBLE (val
)))
1787 ellipsis
= ellipsis
|| inv
> 1
1788 || (OVERLAYP (overlay
)
1789 && (!NILP (Foverlay_get (overlay
, Qafter_string
))
1790 || !NILP (Foverlay_get (overlay
, Qbefore_string
))));
1791 tmp
= Fnext_single_char_property_change
1792 (make_number (end
), Qinvisible
, Qnil
, Qnil
);
1793 end
= NATNUMP (tmp
) ? XFASTINT (tmp
) : ZV
;
1797 && (val
= get_pos_property (make_number (beg
),
1799 TEXT_PROP_MEANS_INVISIBLE (val
))
1801 && !NILP (val
= get_char_property_and_overlay
1802 (make_number (beg
- 1), Qinvisible
, Qnil
, &overlay
))
1803 && (inv
= TEXT_PROP_MEANS_INVISIBLE (val
)))
1805 ellipsis
= ellipsis
|| inv
> 1
1806 || (OVERLAYP (overlay
)
1807 && (!NILP (Foverlay_get (overlay
, Qafter_string
))
1808 || !NILP (Foverlay_get (overlay
, Qbefore_string
))));
1809 tmp
= Fprevious_single_char_property_change
1810 (make_number (beg
), Qinvisible
, Qnil
, Qnil
);
1811 beg
= NATNUMP (tmp
) ? XFASTINT (tmp
) : BEGV
;
1814 /* Move away from the inside area. */
1815 if (beg
< PT
&& end
> PT
)
1817 SET_PT ((orig_pt
== PT
&& (last_pt
< beg
|| last_pt
> end
))
1818 /* We haven't moved yet (so we don't need to fear
1819 infinite-looping) and we were outside the range
1820 before (so either end of the range still corresponds
1821 to a move in the right direction): pretend we moved
1822 less than we actually did, so that we still have
1823 more freedom below in choosing which end of the range
1825 ? (orig_pt
= -1, PT
< last_pt
? end
: beg
)
1826 /* We either have moved already or the last point
1827 was already in the range: we don't get to choose
1828 which end of the range we have to go to. */
1829 : (PT
< last_pt
? beg
: end
));
1830 check_composition
= check_display
= 1;
1832 #if 0 /* This assertion isn't correct, because SET_PT may end up setting
1833 the point to something other than its argument, due to
1834 point-motion hooks, intangibility, etc. */
1835 eassert (PT
== beg
|| PT
== end
);
1838 /* Pretend the area doesn't exist if the buffer is not
1840 if (!modified
&& !ellipsis
&& beg
< end
)
1842 if (last_pt
== beg
&& PT
== end
&& end
< ZV
)
1843 (check_composition
= check_display
= 1, SET_PT (end
+ 1));
1844 else if (last_pt
== end
&& PT
== beg
&& beg
> BEGV
)
1845 (check_composition
= check_display
= 1, SET_PT (beg
- 1));
1846 else if (PT
== ((PT
< last_pt
) ? beg
: end
))
1847 /* We've already moved as far as we can. Trying to go
1848 to the other end would mean moving backwards and thus
1849 could lead to an infinite loop. */
1851 else if (val
= get_pos_property (make_number (PT
),
1853 TEXT_PROP_MEANS_INVISIBLE (val
)
1854 && (val
= get_pos_property
1855 (make_number (PT
== beg
? end
: beg
),
1857 !TEXT_PROP_MEANS_INVISIBLE (val
)))
1858 (check_composition
= check_display
= 1,
1859 SET_PT (PT
== beg
? end
: beg
));
1862 check_invisible
= 0;
1866 /* Subroutine for safe_run_hooks: run the hook HOOK. */
1869 safe_run_hooks_1 (void)
1871 eassert (CONSP (Vinhibit_quit
));
1872 return call0 (XCDR (Vinhibit_quit
));
1875 /* Subroutine for safe_run_hooks: handle an error by clearing out the function
1879 safe_run_hooks_error (Lisp_Object error_data
)
1882 = CONSP (Vinhibit_quit
) ? XCAR (Vinhibit_quit
) : Vinhibit_quit
;
1883 Lisp_Object fun
= CONSP (Vinhibit_quit
) ? XCDR (Vinhibit_quit
) : Qnil
;
1884 Lisp_Object args
[4];
1885 args
[0] = build_string ("Error in %s (%s): %S");
1888 args
[3] = error_data
;
1894 Lisp_Object newval
= Qnil
;
1895 for (val
= find_symbol_value (hook
); CONSP (val
); val
= XCDR (val
))
1896 if (EQ (fun
, XCAR (val
)))
1899 newval
= Fcons (XCAR (val
), newval
);
1901 return Fset (hook
, Fnreverse (newval
));
1902 /* Not found in the local part of the hook. Let's look at the global
1905 for (val
= (NILP (Fdefault_boundp (hook
)) ? Qnil
1906 : Fdefault_value (hook
));
1907 CONSP (val
); val
= XCDR (val
))
1908 if (EQ (fun
, XCAR (val
)))
1911 newval
= Fcons (XCAR (val
), newval
);
1913 return Fset_default (hook
, Fnreverse (newval
));
1919 safe_run_hook_funcall (ptrdiff_t nargs
, Lisp_Object
*args
)
1921 eassert (nargs
== 1);
1922 if (CONSP (Vinhibit_quit
))
1923 XSETCDR (Vinhibit_quit
, args
[0]);
1925 Vinhibit_quit
= Fcons (Vinhibit_quit
, args
[0]);
1927 internal_condition_case (safe_run_hooks_1
, Qt
, safe_run_hooks_error
);
1931 /* If we get an error while running the hook, cause the hook variable
1932 to be nil. Also inhibit quits, so that C-g won't cause the hook
1933 to mysteriously evaporate. */
1936 safe_run_hooks (Lisp_Object hook
)
1938 /* FIXME: our `internal_condition_case' does not provide any way to pass data
1939 to its body or to its handlers other than via globals such as
1940 dynamically-bound variables ;-) */
1941 ptrdiff_t count
= SPECPDL_INDEX ();
1942 specbind (Qinhibit_quit
, hook
);
1944 run_hook_with_args (1, &hook
, safe_run_hook_funcall
);
1946 unbind_to (count
, Qnil
);
1950 /* Nonzero means polling for input is temporarily suppressed. */
1952 int poll_suppress_count
;
1955 #ifdef POLL_FOR_INPUT
1957 /* Asynchronous timer for polling. */
1959 static struct atimer
*poll_timer
;
1961 /* Poll for input, so that we catch a C-g if it comes in. This
1962 function is called from x_make_frame_visible, see comment
1966 poll_for_input_1 (void)
1968 if (! input_blocked_p ()
1969 && !waiting_for_input
)
1973 /* Timer callback function for poll_timer. TIMER is equal to
1977 poll_for_input (struct atimer
*timer
)
1979 if (poll_suppress_count
== 0)
1980 pending_signals
= 1;
1983 #endif /* POLL_FOR_INPUT */
1985 /* Begin signals to poll for input, if they are appropriate.
1986 This function is called unconditionally from various places. */
1989 start_polling (void)
1991 #ifdef POLL_FOR_INPUT
1992 /* XXX This condition was (read_socket_hook && !interrupt_input),
1993 but read_socket_hook is not global anymore. Let's pretend that
1995 if (!interrupt_input
)
1997 /* Turn alarm handling on unconditionally. It might have
1998 been turned off in process.c. */
1999 turn_on_atimers (1);
2001 /* If poll timer doesn't exist, are we need one with
2002 a different interval, start a new one. */
2003 if (poll_timer
== NULL
2004 || EMACS_SECS (poll_timer
->interval
) != polling_period
)
2006 time_t period
= max (1, min (polling_period
, TYPE_MAXIMUM (time_t)));
2007 EMACS_TIME interval
= make_emacs_time (period
, 0);
2010 cancel_atimer (poll_timer
);
2012 poll_timer
= start_atimer (ATIMER_CONTINUOUS
, interval
,
2013 poll_for_input
, NULL
);
2016 /* Let the timer's callback function poll for input
2017 if this becomes zero. */
2018 --poll_suppress_count
;
2023 /* True if we are using polling to handle input asynchronously. */
2026 input_polling_used (void)
2028 #ifdef POLL_FOR_INPUT
2029 /* XXX This condition was (read_socket_hook && !interrupt_input),
2030 but read_socket_hook is not global anymore. Let's pretend that
2032 return !interrupt_input
;
2038 /* Turn off polling. */
2043 #ifdef POLL_FOR_INPUT
2044 /* XXX This condition was (read_socket_hook && !interrupt_input),
2045 but read_socket_hook is not global anymore. Let's pretend that
2047 if (!interrupt_input
)
2048 ++poll_suppress_count
;
2052 /* Set the value of poll_suppress_count to COUNT
2053 and start or stop polling accordingly. */
2056 set_poll_suppress_count (int count
)
2058 #ifdef POLL_FOR_INPUT
2059 if (count
== 0 && poll_suppress_count
!= 0)
2061 poll_suppress_count
= 1;
2064 else if (count
!= 0 && poll_suppress_count
== 0)
2068 poll_suppress_count
= count
;
2072 /* Bind polling_period to a value at least N.
2073 But don't decrease it. */
2076 bind_polling_period (int n
)
2078 #ifdef POLL_FOR_INPUT
2079 EMACS_INT
new = polling_period
;
2084 stop_other_atimers (poll_timer
);
2086 specbind (Qpolling_period
, make_number (new));
2087 /* Start a new alarm with the new period. */
2092 /* Apply the control modifier to CHARACTER. */
2095 make_ctrl_char (int c
)
2097 /* Save the upper bits here. */
2098 int upper
= c
& ~0177;
2100 if (! ASCII_BYTE_P (c
))
2101 return c
|= ctrl_modifier
;
2105 /* Everything in the columns containing the upper-case letters
2106 denotes a control character. */
2107 if (c
>= 0100 && c
< 0140)
2111 /* Set the shift modifier for a control char
2112 made from a shifted letter. But only for letters! */
2113 if (oc
>= 'A' && oc
<= 'Z')
2114 c
|= shift_modifier
;
2117 /* The lower-case letters denote control characters too. */
2118 else if (c
>= 'a' && c
<= 'z')
2121 /* Include the bits for control and shift
2122 only if the basic ASCII code can't indicate them. */
2126 /* Replace the high bits. */
2127 c
|= (upper
& ~ctrl_modifier
);
2132 /* Display the help-echo property of the character after the mouse pointer.
2133 Either show it in the echo area, or call show-help-function to display
2134 it by other means (maybe in a tooltip).
2136 If HELP is nil, that means clear the previous help echo.
2138 If HELP is a string, display that string. If HELP is a function,
2139 call it with OBJECT and POS as arguments; the function should
2140 return a help string or nil for none. For all other types of HELP,
2141 evaluate it to obtain a string.
2143 WINDOW is the window in which the help was generated, if any.
2144 It is nil if not in a window.
2146 If OBJECT is a buffer, POS is the position in the buffer where the
2147 `help-echo' text property was found.
2149 If OBJECT is an overlay, that overlay has a `help-echo' property,
2150 and POS is the position in the overlay's buffer under the mouse.
2152 If OBJECT is a string (an overlay string or a string displayed with
2153 the `display' property). POS is the position in that string under
2156 Note: this function may only be called with HELP nil or a string
2157 from X code running asynchronously. */
2160 show_help_echo (Lisp_Object help
, Lisp_Object window
, Lisp_Object object
,
2163 if (!NILP (help
) && !STRINGP (help
))
2165 if (FUNCTIONP (help
))
2166 help
= safe_call (4, help
, window
, object
, pos
);
2168 help
= safe_eval (help
);
2170 if (!STRINGP (help
))
2174 if (!noninteractive
&& STRINGP (help
))
2176 /* The mouse-fixup-help-message Lisp function can call
2177 mouse_position_hook, which resets the mouse_moved flags.
2178 This causes trouble if we are trying to read a mouse motion
2179 event (i.e., if we are inside a `track-mouse' form), so we
2180 restore the mouse_moved flag. */
2181 FRAME_PTR f
= NILP (do_mouse_tracking
) ? NULL
: some_mouse_moved ();
2182 help
= call1 (Qmouse_fixup_help_message
, help
);
2187 if (STRINGP (help
) || NILP (help
))
2189 if (!NILP (Vshow_help_function
))
2190 call1 (Vshow_help_function
, help
);
2191 help_echo_showing_p
= STRINGP (help
);
2197 /* Input of single characters from keyboard */
2199 static Lisp_Object
kbd_buffer_get_event (KBOARD
**kbp
, bool *used_mouse_menu
,
2200 EMACS_TIME
*end_time
);
2201 static void record_char (Lisp_Object c
);
2203 static Lisp_Object help_form_saved_window_configs
;
2205 read_char_help_form_unwind (Lisp_Object arg
)
2207 Lisp_Object window_config
= XCAR (help_form_saved_window_configs
);
2208 help_form_saved_window_configs
= XCDR (help_form_saved_window_configs
);
2209 if (!NILP (window_config
))
2210 Fset_window_configuration (window_config
);
2214 #define STOP_POLLING \
2215 do { if (! polling_stopped_here) stop_polling (); \
2216 polling_stopped_here = 1; } while (0)
2218 #define RESUME_POLLING \
2219 do { if (polling_stopped_here) start_polling (); \
2220 polling_stopped_here = 0; } while (0)
2222 /* read a character from the keyboard; call the redisplay if needed */
2223 /* commandflag 0 means do not autosave, but do redisplay.
2224 -1 means do not redisplay, but do autosave.
2227 /* The arguments MAPS and NMAPS are for menu prompting.
2228 MAPS is an array of keymaps; NMAPS is the length of MAPS.
2230 PREV_EVENT is the previous input event, or nil if we are reading
2231 the first event of a key sequence (or not reading a key sequence).
2232 If PREV_EVENT is t, that is a "magic" value that says
2233 not to run input methods, but in other respects to act as if
2234 not reading a key sequence.
2236 If USED_MOUSE_MENU is non-null, then set *USED_MOUSE_MENU to true
2237 if we used a mouse menu to read the input, or false otherwise. If
2238 USED_MOUSE_MENU is null, don't dereference it.
2240 Value is -2 when we find input on another keyboard. A second call
2241 to read_char will read it.
2243 If END_TIME is non-null, it is a pointer to an EMACS_TIME
2244 specifying the maximum time to wait until. If no input arrives by
2245 that time, stop waiting and return nil.
2247 Value is t if we showed a menu and the user rejected it. */
2250 read_char (int commandflag
, ptrdiff_t nmaps
, Lisp_Object
*maps
,
2251 Lisp_Object prev_event
,
2252 bool *used_mouse_menu
, EMACS_TIME
*end_time
)
2256 sys_jmp_buf local_getcjmp
;
2257 sys_jmp_buf save_jump
;
2258 Lisp_Object tem
, save
;
2259 volatile Lisp_Object previous_echo_area_message
;
2260 volatile Lisp_Object also_record
;
2261 volatile bool reread
;
2262 struct gcpro gcpro1
, gcpro2
;
2263 bool volatile polling_stopped_here
= 0;
2264 struct kboard
*orig_kboard
= current_kboard
;
2268 #if 0 /* This was commented out as part of fixing echo for C-u left. */
2269 before_command_key_count
= this_command_key_count
;
2270 before_command_echo_length
= echo_length ();
2273 previous_echo_area_message
= Qnil
;
2275 GCPRO2 (c
, previous_echo_area_message
);
2280 if (CONSP (Vunread_post_input_method_events
))
2282 c
= XCAR (Vunread_post_input_method_events
);
2283 Vunread_post_input_method_events
2284 = XCDR (Vunread_post_input_method_events
);
2286 /* Undo what read_char_x_menu_prompt did when it unread
2287 additional keys returned by Fx_popup_menu. */
2289 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2297 if (CONSP (Vunread_command_events
))
2299 bool was_disabled
= 0;
2301 c
= XCAR (Vunread_command_events
);
2302 Vunread_command_events
= XCDR (Vunread_command_events
);
2306 /* Undo what sit-for did when it unread additional keys
2307 inside universal-argument. */
2310 && EQ (XCAR (c
), Qt
))
2316 /* Undo what read_char_x_menu_prompt did when it unread
2317 additional keys returned by Fx_popup_menu. */
2319 && EQ (XCDR (c
), Qdisabled
)
2320 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
))))
2326 /* If the queued event is something that used the mouse,
2327 set used_mouse_menu accordingly. */
2329 /* Also check was_disabled so last-nonmenu-event won't return
2330 a bad value when submenus are involved. (Bug#447) */
2331 && (EQ (c
, Qtool_bar
) || EQ (c
, Qmenu_bar
) || was_disabled
))
2332 *used_mouse_menu
= 1;
2334 goto reread_for_input_method
;
2337 if (CONSP (Vunread_input_method_events
))
2339 c
= XCAR (Vunread_input_method_events
);
2340 Vunread_input_method_events
= XCDR (Vunread_input_method_events
);
2342 /* Undo what read_char_x_menu_prompt did when it unread
2343 additional keys returned by Fx_popup_menu. */
2345 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2349 goto reread_for_input_method
;
2352 this_command_key_count_reset
= 0;
2354 if (!NILP (Vexecuting_kbd_macro
))
2356 /* We set this to Qmacro; since that's not a frame, nobody will
2357 try to switch frames on us, and the selected window will
2360 Since this event came from a macro, it would be misleading to
2361 leave internal_last_event_frame set to wherever the last
2362 real event came from. Normally, a switch-frame event selects
2363 internal_last_event_frame after each command is read, but
2364 events read from a macro should never cause a new frame to be
2366 Vlast_event_frame
= internal_last_event_frame
= Qmacro
;
2368 /* Exit the macro if we are at the end.
2369 Also, some things replace the macro with t
2370 to force an early exit. */
2371 if (EQ (Vexecuting_kbd_macro
, Qt
)
2372 || executing_kbd_macro_index
>= XFASTINT (Flength (Vexecuting_kbd_macro
)))
2378 c
= Faref (Vexecuting_kbd_macro
, make_number (executing_kbd_macro_index
));
2379 if (STRINGP (Vexecuting_kbd_macro
)
2380 && (XFASTINT (c
) & 0x80) && (XFASTINT (c
) <= 0xff))
2381 XSETFASTINT (c
, CHAR_META
| (XFASTINT (c
) & ~0x80));
2383 executing_kbd_macro_index
++;
2388 if (!NILP (unread_switch_frame
))
2390 c
= unread_switch_frame
;
2391 unread_switch_frame
= Qnil
;
2393 /* This event should make it into this_command_keys, and get echoed
2394 again, so we do not set `reread'. */
2398 /* if redisplay was requested */
2399 if (commandflag
>= 0)
2401 bool echo_current
= EQ (echo_message_buffer
, echo_area_buffer
[0]);
2403 /* If there is pending input, process any events which are not
2404 user-visible, such as X selection_request events. */
2406 || detect_input_pending_run_timers (0))
2407 swallow_events (0); /* may clear input_pending */
2409 /* Redisplay if no pending input. */
2410 while (!input_pending
)
2412 if (help_echo_showing_p
&& !EQ (selected_window
, minibuf_window
))
2413 redisplay_preserve_echo_area (5);
2418 /* Normal case: no input arrived during redisplay. */
2421 /* Input arrived and pre-empted redisplay.
2422 Process any events which are not user-visible. */
2424 /* If that cleared input_pending, try again to redisplay. */
2427 /* Prevent the redisplay we just did
2428 from messing up echoing of the input after the prompt. */
2429 if (commandflag
== 0 && echo_current
)
2430 echo_message_buffer
= echo_area_buffer
[0];
2434 /* Message turns off echoing unless more keystrokes turn it on again.
2436 The code in 20.x for the condition was
2438 1. echo_area_glyphs && *echo_area_glyphs
2439 2. && echo_area_glyphs != current_kboard->echobuf
2440 3. && ok_to_echo_at_next_pause != echo_area_glyphs
2442 (1) means there's a current message displayed
2444 (2) means it's not the message from echoing from the current
2447 (3) There's only one place in 20.x where ok_to_echo_at_next_pause
2448 is set to a non-null value. This is done in read_char and it is
2449 set to echo_area_glyphs after a call to echo_char. That means
2450 ok_to_echo_at_next_pause is either null or
2451 current_kboard->echobuf with the appropriate current_kboard at
2454 So, condition (3) means in clear text ok_to_echo_at_next_pause
2455 must be either null, or the current message isn't from echoing at
2456 all, or it's from echoing from a different kboard than the
2459 if (/* There currently is something in the echo area. */
2460 !NILP (echo_area_buffer
[0])
2461 && (/* And it's either not from echoing. */
2462 !EQ (echo_area_buffer
[0], echo_message_buffer
)
2463 /* Or it's an echo from a different kboard. */
2464 || echo_kboard
!= current_kboard
2465 /* Or we explicitly allow overwriting whatever there is. */
2466 || ok_to_echo_at_next_pause
== NULL
))
2471 /* Try reading a character via menu prompting in the minibuf.
2472 Try this before the sit-for, because the sit-for
2473 would do the wrong thing if we are supposed to do
2474 menu prompting. If EVENT_HAS_PARAMETERS then we are reading
2475 after a mouse event so don't try a minibuf menu. */
2477 if (nmaps
> 0 && INTERACTIVE
2478 && !NILP (prev_event
) && ! EVENT_HAS_PARAMETERS (prev_event
)
2479 /* Don't bring up a menu if we already have another event. */
2480 && NILP (Vunread_command_events
)
2481 && !detect_input_pending_run_timers (0))
2483 c
= read_char_minibuf_menu_prompt (commandflag
, nmaps
, maps
);
2485 if (INTEGERP (c
) && XINT (c
) == -2)
2486 return c
; /* wrong_kboard_jmpbuf */
2492 /* Make a longjmp point for quits to use, but don't alter getcjmp just yet.
2493 We will do that below, temporarily for short sections of code,
2494 when appropriate. local_getcjmp must be in effect
2495 around any call to sit_for or kbd_buffer_get_event;
2496 it *must not* be in effect when we call redisplay. */
2498 jmpcount
= SPECPDL_INDEX ();
2499 if (sys_setjmp (local_getcjmp
))
2501 /* Handle quits while reading the keyboard. */
2502 /* We must have saved the outer value of getcjmp here,
2503 so restore it now. */
2504 restore_getcjmp (save_jump
);
2505 unbind_to (jmpcount
, Qnil
);
2506 XSETINT (c
, quit_char
);
2507 internal_last_event_frame
= selected_frame
;
2508 Vlast_event_frame
= internal_last_event_frame
;
2509 /* If we report the quit char as an event,
2510 don't do so more than once. */
2511 if (!NILP (Vinhibit_quit
))
2515 KBOARD
*kb
= FRAME_KBOARD (XFRAME (selected_frame
));
2516 if (kb
!= current_kboard
)
2518 Lisp_Object last
= KVAR (kb
, kbd_queue
);
2519 /* We shouldn't get here if we were in single-kboard mode! */
2524 while (CONSP (XCDR (last
)))
2526 if (!NILP (XCDR (last
)))
2530 kset_kbd_queue (kb
, Fcons (c
, Qnil
));
2532 XSETCDR (last
, Fcons (c
, Qnil
));
2533 kb
->kbd_queue_has_data
= 1;
2534 current_kboard
= kb
;
2535 /* This is going to exit from read_char
2536 so we had better get rid of this frame's stuff. */
2538 return make_number (-2); /* wrong_kboard_jmpbuf */
2544 /* Start idle timers if no time limit is supplied. We don't do it
2545 if a time limit is supplied to avoid an infinite recursion in the
2546 situation where an idle timer calls `sit-for'. */
2549 timer_start_idle ();
2551 /* If in middle of key sequence and minibuffer not active,
2552 start echoing if enough time elapses. */
2554 if (minibuf_level
== 0
2556 && !current_kboard
->immediate_echo
2557 && this_command_key_count
> 0
2559 && (FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
2560 && NILP (Fzerop (Vecho_keystrokes
))
2561 && (/* No message. */
2562 NILP (echo_area_buffer
[0])
2563 /* Or empty message. */
2564 || (BUF_BEG (XBUFFER (echo_area_buffer
[0]))
2565 == BUF_Z (XBUFFER (echo_area_buffer
[0])))
2566 /* Or already echoing from same kboard. */
2567 || (echo_kboard
&& ok_to_echo_at_next_pause
== echo_kboard
)
2568 /* Or not echoing before and echoing allowed. */
2569 || (!echo_kboard
&& ok_to_echo_at_next_pause
)))
2571 /* After a mouse event, start echoing right away.
2572 This is because we are probably about to display a menu,
2573 and we don't want to delay before doing so. */
2574 if (EVENT_HAS_PARAMETERS (prev_event
))
2580 save_getcjmp (save_jump
);
2581 restore_getcjmp (local_getcjmp
);
2582 tem0
= sit_for (Vecho_keystrokes
, 1, 1);
2583 restore_getcjmp (save_jump
);
2585 && ! CONSP (Vunread_command_events
))
2590 /* Maybe auto save due to number of keystrokes. */
2592 if (commandflag
!= 0
2593 && auto_save_interval
> 0
2594 && num_nonmacro_input_events
- last_auto_save
> max (auto_save_interval
, 20)
2595 && !detect_input_pending_run_timers (0))
2597 Fdo_auto_save (Qnil
, Qnil
);
2598 /* Hooks can actually change some buffers in auto save. */
2602 /* Try reading using an X menu.
2603 This is never confused with reading using the minibuf
2604 because the recursive call of read_char in read_char_minibuf_menu_prompt
2605 does not pass on any keymaps. */
2607 if (nmaps
> 0 && INTERACTIVE
2608 && !NILP (prev_event
)
2609 && EVENT_HAS_PARAMETERS (prev_event
)
2610 && !EQ (XCAR (prev_event
), Qmenu_bar
)
2611 && !EQ (XCAR (prev_event
), Qtool_bar
)
2612 /* Don't bring up a menu if we already have another event. */
2613 && NILP (Vunread_command_events
))
2615 c
= read_char_x_menu_prompt (nmaps
, maps
, prev_event
, used_mouse_menu
);
2617 /* Now that we have read an event, Emacs is not idle. */
2624 /* Maybe autosave and/or garbage collect due to idleness. */
2626 if (INTERACTIVE
&& NILP (c
))
2629 ptrdiff_t buffer_size
;
2631 /* Slow down auto saves logarithmically in size of current buffer,
2632 and garbage collect while we're at it. */
2633 if (! MINI_WINDOW_P (XWINDOW (selected_window
)))
2634 last_non_minibuf_size
= Z
- BEG
;
2635 buffer_size
= (last_non_minibuf_size
>> 8) + 1;
2637 while (buffer_size
> 64)
2638 delay_level
++, buffer_size
-= buffer_size
>> 2;
2639 if (delay_level
< 4) delay_level
= 4;
2640 /* delay_level is 4 for files under around 50k, 7 at 100k,
2641 9 at 200k, 11 at 300k, and 12 at 500k. It is 15 at 1 meg. */
2643 /* Auto save if enough time goes by without input. */
2644 if (commandflag
!= 0
2645 && num_nonmacro_input_events
> last_auto_save
2646 && INTEGERP (Vauto_save_timeout
)
2647 && XINT (Vauto_save_timeout
) > 0)
2650 EMACS_INT timeout
= (delay_level
2651 * min (XFASTINT (Vauto_save_timeout
) / 4,
2652 MOST_POSITIVE_FIXNUM
/ delay_level
));
2653 save_getcjmp (save_jump
);
2654 restore_getcjmp (local_getcjmp
);
2655 tem0
= sit_for (make_number (timeout
), 1, 1);
2656 restore_getcjmp (save_jump
);
2659 && ! CONSP (Vunread_command_events
))
2661 Fdo_auto_save (Qnil
, Qnil
);
2666 /* If there is still no input available, ask for GC. */
2667 if (!detect_input_pending_run_timers (0))
2671 /* Notify the caller if an autosave hook, or a timer, sentinel or
2672 filter in the sit_for calls above have changed the current
2673 kboard. This could happen if they use the minibuffer or start a
2674 recursive edit, like the fancy splash screen in server.el's
2675 filter. If this longjmp wasn't here, read_key_sequence would
2676 interpret the next key sequence using the wrong translation
2677 tables and function keymaps. */
2678 if (NILP (c
) && current_kboard
!= orig_kboard
)
2681 return make_number (-2); /* wrong_kboard_jmpbuf */
2684 /* If this has become non-nil here, it has been set by a timer
2685 or sentinel or filter. */
2686 if (CONSP (Vunread_command_events
))
2688 c
= XCAR (Vunread_command_events
);
2689 Vunread_command_events
= XCDR (Vunread_command_events
);
2692 /* Read something from current KBOARD's side queue, if possible. */
2696 if (current_kboard
->kbd_queue_has_data
)
2698 if (!CONSP (KVAR (current_kboard
, kbd_queue
)))
2700 c
= XCAR (KVAR (current_kboard
, kbd_queue
));
2701 kset_kbd_queue (current_kboard
,
2702 XCDR (KVAR (current_kboard
, kbd_queue
)));
2703 if (NILP (KVAR (current_kboard
, kbd_queue
)))
2704 current_kboard
->kbd_queue_has_data
= 0;
2705 input_pending
= readable_events (0);
2706 if (EVENT_HAS_PARAMETERS (c
)
2707 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qswitch_frame
))
2708 internal_last_event_frame
= XCAR (XCDR (c
));
2709 Vlast_event_frame
= internal_last_event_frame
;
2713 /* If current_kboard's side queue is empty check the other kboards.
2714 If one of them has data that we have not yet seen here,
2715 switch to it and process the data waiting for it.
2717 Note: if the events queued up for another kboard
2718 have already been seen here, and therefore are not a complete command,
2719 the kbd_queue_has_data field is 0, so we skip that kboard here.
2720 That's to avoid an infinite loop switching between kboards here. */
2721 if (NILP (c
) && !single_kboard
)
2724 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
2725 if (kb
->kbd_queue_has_data
)
2727 current_kboard
= kb
;
2728 /* This is going to exit from read_char
2729 so we had better get rid of this frame's stuff. */
2731 return make_number (-2); /* wrong_kboard_jmpbuf */
2739 /* Finally, we read from the main queue,
2740 and if that gives us something we can't use yet, we put it on the
2741 appropriate side queue and try again. */
2745 KBOARD
*kb
IF_LINT (= NULL
);
2747 if (end_time
&& EMACS_TIME_LE (*end_time
, current_emacs_time ()))
2750 /* Actually read a character, waiting if necessary. */
2751 save_getcjmp (save_jump
);
2752 restore_getcjmp (local_getcjmp
);
2754 timer_start_idle ();
2755 c
= kbd_buffer_get_event (&kb
, used_mouse_menu
, end_time
);
2756 restore_getcjmp (save_jump
);
2758 if (! NILP (c
) && (kb
!= current_kboard
))
2760 Lisp_Object last
= KVAR (kb
, kbd_queue
);
2763 while (CONSP (XCDR (last
)))
2765 if (!NILP (XCDR (last
)))
2769 kset_kbd_queue (kb
, Fcons (c
, Qnil
));
2771 XSETCDR (last
, Fcons (c
, Qnil
));
2772 kb
->kbd_queue_has_data
= 1;
2776 current_kboard
= kb
;
2777 /* This is going to exit from read_char
2778 so we had better get rid of this frame's stuff. */
2780 return make_number (-2);
2784 /* Terminate Emacs in batch mode if at eof. */
2785 if (noninteractive
&& INTEGERP (c
) && XINT (c
) < 0)
2786 Fkill_emacs (make_number (1));
2790 /* Add in any extra modifiers, where appropriate. */
2791 if ((extra_keyboard_modifiers
& CHAR_CTL
)
2792 || ((extra_keyboard_modifiers
& 0177) < ' '
2793 && (extra_keyboard_modifiers
& 0177) != 0))
2794 XSETINT (c
, make_ctrl_char (XINT (c
)));
2796 /* Transfer any other modifier bits directly from
2797 extra_keyboard_modifiers to c. Ignore the actual character code
2798 in the low 16 bits of extra_keyboard_modifiers. */
2799 XSETINT (c
, XINT (c
) | (extra_keyboard_modifiers
& ~0xff7f & ~CHAR_CTL
));
2810 if (commandflag
>= 0
2811 && !input_pending
&& !detect_input_pending_run_timers (0))
2817 /* Buffer switch events are only for internal wakeups
2818 so don't show them to the user.
2819 Also, don't record a key if we already did. */
2823 /* Process special events within read_char
2824 and loop around to read another event. */
2827 tem
= access_keymap (get_keymap (Vspecial_event_map
, 0, 1), c
, 0, 0, 1);
2832 struct buffer
*prev_buffer
= current_buffer
;
2833 last_input_event
= c
;
2834 Fcommand_execute (tem
, Qnil
, Fvector (1, &last_input_event
), Qt
);
2836 if (CONSP (c
) && EQ (XCAR (c
), Qselect_window
) && !end_time
)
2837 /* We stopped being idle for this event; undo that. This
2838 prevents automatic window selection (under
2839 mouse_autoselect_window from acting as a real input event, for
2840 example banishing the mouse under mouse-avoidance-mode. */
2841 timer_resume_idle ();
2843 if (current_buffer
!= prev_buffer
)
2845 /* The command may have changed the keymaps. Pretend there
2846 is input in another keyboard and return. This will
2847 recalculate keymaps. */
2848 c
= make_number (-2);
2855 /* Handle things that only apply to characters. */
2858 /* If kbd_buffer_get_event gave us an EOF, return that. */
2862 if ((STRINGP (KVAR (current_kboard
, Vkeyboard_translate_table
))
2863 && UNSIGNED_CMP (XFASTINT (c
), <,
2864 SCHARS (KVAR (current_kboard
,
2865 Vkeyboard_translate_table
))))
2866 || (VECTORP (KVAR (current_kboard
, Vkeyboard_translate_table
))
2867 && UNSIGNED_CMP (XFASTINT (c
), <,
2868 ASIZE (KVAR (current_kboard
,
2869 Vkeyboard_translate_table
))))
2870 || (CHAR_TABLE_P (KVAR (current_kboard
, Vkeyboard_translate_table
))
2874 d
= Faref (KVAR (current_kboard
, Vkeyboard_translate_table
), c
);
2875 /* nil in keyboard-translate-table means no translation. */
2881 /* If this event is a mouse click in the menu bar,
2882 return just menu-bar for now. Modify the mouse click event
2883 so we won't do this twice, then queue it up. */
2884 if (EVENT_HAS_PARAMETERS (c
)
2886 && CONSP (EVENT_START (c
))
2887 && CONSP (XCDR (EVENT_START (c
))))
2891 posn
= POSN_POSN (EVENT_START (c
));
2892 /* Handle menu-bar events:
2893 insert the dummy prefix event `menu-bar'. */
2894 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
2896 /* Change menu-bar to (menu-bar) as the event "position". */
2897 POSN_SET_POSN (EVENT_START (c
), Fcons (posn
, Qnil
));
2900 Vunread_command_events
= Fcons (c
, Vunread_command_events
);
2905 /* Store these characters into recent_keys, the dribble file if any,
2906 and the keyboard macro being defined, if any. */
2908 if (! NILP (also_record
))
2909 record_char (also_record
);
2911 /* Wipe the echo area.
2912 But first, if we are about to use an input method,
2913 save the echo area contents for it to refer to. */
2915 && ! NILP (Vinput_method_function
)
2916 && ' ' <= XINT (c
) && XINT (c
) < 256 && XINT (c
) != 127)
2918 previous_echo_area_message
= Fcurrent_message ();
2919 Vinput_method_previous_message
= previous_echo_area_message
;
2922 /* Now wipe the echo area, except for help events which do their
2923 own stuff with the echo area. */
2925 || (!(EQ (Qhelp_echo
, XCAR (c
)))
2926 && !(EQ (Qswitch_frame
, XCAR (c
)))
2927 /* Don't wipe echo area for select window events: These might
2928 get delayed via `mouse-autoselect-window' (Bug#11304). */
2929 && !(EQ (Qselect_window
, XCAR (c
)))))
2931 if (!NILP (echo_area_buffer
[0]))
2933 safe_run_hooks (Qecho_area_clear_hook
);
2934 clear_message (1, 0);
2938 reread_for_input_method
:
2940 /* Pass this to the input method, if appropriate. */
2942 && ! NILP (Vinput_method_function
)
2943 /* Don't run the input method within a key sequence,
2944 after the first event of the key sequence. */
2945 && NILP (prev_event
)
2946 && ' ' <= XINT (c
) && XINT (c
) < 256 && XINT (c
) != 127)
2949 ptrdiff_t key_count
;
2950 bool key_count_reset
;
2951 struct gcpro gcpro1
;
2952 ptrdiff_t count
= SPECPDL_INDEX ();
2954 /* Save the echo status. */
2955 bool saved_immediate_echo
= current_kboard
->immediate_echo
;
2956 struct kboard
*saved_ok_to_echo
= ok_to_echo_at_next_pause
;
2957 Lisp_Object saved_echo_string
= KVAR (current_kboard
, echo_string
);
2958 ptrdiff_t saved_echo_after_prompt
= current_kboard
->echo_after_prompt
;
2961 if (before_command_restore_flag
)
2963 this_command_key_count
= before_command_key_count_1
;
2964 if (this_command_key_count
< this_single_command_key_start
)
2965 this_single_command_key_start
= this_command_key_count
;
2966 echo_truncate (before_command_echo_length_1
);
2967 before_command_restore_flag
= 0;
2971 /* Save the this_command_keys status. */
2972 key_count
= this_command_key_count
;
2973 key_count_reset
= this_command_key_count_reset
;
2976 keys
= Fcopy_sequence (this_command_keys
);
2981 /* Clear out this_command_keys. */
2982 this_command_key_count
= 0;
2983 this_command_key_count_reset
= 0;
2985 /* Now wipe the echo area. */
2986 if (!NILP (echo_area_buffer
[0]))
2987 safe_run_hooks (Qecho_area_clear_hook
);
2988 clear_message (1, 0);
2991 /* If we are not reading a key sequence,
2992 never use the echo area. */
2995 specbind (Qinput_method_use_echo_area
, Qt
);
2998 /* Call the input method. */
2999 tem
= call1 (Vinput_method_function
, c
);
3001 tem
= unbind_to (count
, tem
);
3003 /* Restore the saved echoing state
3004 and this_command_keys state. */
3005 this_command_key_count
= key_count
;
3006 this_command_key_count_reset
= key_count_reset
;
3008 this_command_keys
= keys
;
3011 ok_to_echo_at_next_pause
= saved_ok_to_echo
;
3012 kset_echo_string (current_kboard
, saved_echo_string
);
3013 current_kboard
->echo_after_prompt
= saved_echo_after_prompt
;
3014 if (saved_immediate_echo
)
3019 /* The input method can return no events. */
3022 /* Bring back the previous message, if any. */
3023 if (! NILP (previous_echo_area_message
))
3024 message_with_string ("%s", previous_echo_area_message
, 0);
3027 /* It returned one event or more. */
3029 Vunread_post_input_method_events
3030 = nconc2 (XCDR (tem
), Vunread_post_input_method_events
);
3035 /* Display help if not echoing. */
3036 if (CONSP (c
) && EQ (XCAR (c
), Qhelp_echo
))
3038 /* (help-echo FRAME HELP WINDOW OBJECT POS). */
3039 Lisp_Object help
, object
, position
, window
, htem
;
3041 htem
= Fcdr (XCDR (c
));
3044 window
= Fcar (htem
);
3046 object
= Fcar (htem
);
3048 position
= Fcar (htem
);
3050 show_help_echo (help
, window
, object
, position
);
3052 /* We stopped being idle for this event; undo that. */
3054 timer_resume_idle ();
3058 if ((! reread
|| this_command_key_count
== 0
3059 || this_command_key_count_reset
)
3063 /* Don't echo mouse motion events. */
3064 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
3065 && NILP (Fzerop (Vecho_keystrokes
))
3066 && ! (EVENT_HAS_PARAMETERS (c
)
3067 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
3070 if (! NILP (also_record
))
3071 echo_char (also_record
);
3072 /* Once we reread a character, echoing can happen
3073 the next time we pause to read a new one. */
3074 ok_to_echo_at_next_pause
= current_kboard
;
3077 /* Record this character as part of the current key. */
3078 add_command_key (c
);
3079 if (! NILP (also_record
))
3080 add_command_key (also_record
);
3083 last_input_event
= c
;
3086 /* Process the help character specially if enabled */
3087 if (!NILP (Vhelp_form
) && help_char_p (c
))
3089 ptrdiff_t count
= SPECPDL_INDEX ();
3091 help_form_saved_window_configs
3092 = Fcons (Fcurrent_window_configuration (Qnil
),
3093 help_form_saved_window_configs
);
3094 record_unwind_protect (read_char_help_form_unwind
, Qnil
);
3095 call0 (Qhelp_form_show
);
3100 c
= read_char (0, 0, 0, Qnil
, 0, NULL
);
3101 if (EVENT_HAS_PARAMETERS (c
)
3102 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_click
))
3103 XSETCAR (help_form_saved_window_configs
, Qnil
);
3105 while (BUFFERP (c
));
3106 /* Remove the help from the frame */
3107 unbind_to (count
, Qnil
);
3110 if (EQ (c
, make_number (040)))
3114 c
= read_char (0, 0, 0, Qnil
, 0, NULL
);
3115 while (BUFFERP (c
));
3124 /* Record a key that came from a mouse menu.
3125 Record it for echoing, for this-command-keys, and so on. */
3128 record_menu_key (Lisp_Object c
)
3130 /* Wipe the echo area. */
3131 clear_message (1, 0);
3136 before_command_key_count
= this_command_key_count
;
3137 before_command_echo_length
= echo_length ();
3140 /* Don't echo mouse motion events. */
3141 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
3142 && NILP (Fzerop (Vecho_keystrokes
)))
3146 /* Once we reread a character, echoing can happen
3147 the next time we pause to read a new one. */
3148 ok_to_echo_at_next_pause
= 0;
3151 /* Record this character as part of the current key. */
3152 add_command_key (c
);
3154 /* Re-reading in the middle of a command */
3155 last_input_event
= c
;
3159 /* Return true if should recognize C as "the help character". */
3162 help_char_p (Lisp_Object c
)
3166 if (EQ (c
, Vhelp_char
))
3168 for (tail
= Vhelp_event_list
; CONSP (tail
); tail
= XCDR (tail
))
3169 if (EQ (c
, XCAR (tail
)))
3174 /* Record the input event C in various ways. */
3177 record_char (Lisp_Object c
)
3181 if (CONSP (c
) && (EQ (XCAR (c
), Qhelp_echo
) || EQ (XCAR (c
), Qmouse_movement
)))
3183 /* To avoid filling recent_keys with help-echo and mouse-movement
3184 events, we filter out repeated help-echo events, only store the
3185 first and last in a series of mouse-movement events, and don't
3186 store repeated help-echo events which are only separated by
3187 mouse-movement events. */
3189 Lisp_Object ev1
, ev2
, ev3
;
3192 if ((ix1
= recent_keys_index
- 1) < 0)
3193 ix1
= NUM_RECENT_KEYS
- 1;
3194 ev1
= AREF (recent_keys
, ix1
);
3196 if ((ix2
= ix1
- 1) < 0)
3197 ix2
= NUM_RECENT_KEYS
- 1;
3198 ev2
= AREF (recent_keys
, ix2
);
3200 if ((ix3
= ix2
- 1) < 0)
3201 ix3
= NUM_RECENT_KEYS
- 1;
3202 ev3
= AREF (recent_keys
, ix3
);
3204 if (EQ (XCAR (c
), Qhelp_echo
))
3206 /* Don't record `help-echo' in recent_keys unless it shows some help
3207 message, and a different help than the previously recorded
3209 Lisp_Object help
, last_help
;
3211 help
= Fcar_safe (Fcdr_safe (XCDR (c
)));
3212 if (!STRINGP (help
))
3214 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qhelp_echo
)
3215 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev1
))), EQ (last_help
, help
)))
3217 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3218 && CONSP (ev2
) && EQ (XCAR (ev2
), Qhelp_echo
)
3219 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev2
))), EQ (last_help
, help
)))
3221 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3222 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3223 && CONSP (ev3
) && EQ (XCAR (ev3
), Qhelp_echo
)
3224 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev3
))), EQ (last_help
, help
)))
3227 else if (EQ (XCAR (c
), Qmouse_movement
))
3229 /* Only record one pair of `mouse-movement' on a window in recent_keys.
3230 So additional mouse movement events replace the last element. */
3231 Lisp_Object last_window
, window
;
3233 window
= Fcar_safe (Fcar_safe (XCDR (c
)));
3234 if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3235 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev1
))), EQ (last_window
, window
))
3236 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3237 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev2
))), EQ (last_window
, window
)))
3239 ASET (recent_keys
, ix1
, c
);
3245 store_kbd_macro_char (c
);
3249 total_keys
+= total_keys
< NUM_RECENT_KEYS
;
3250 ASET (recent_keys
, recent_keys_index
, c
);
3251 if (++recent_keys_index
>= NUM_RECENT_KEYS
)
3252 recent_keys_index
= 0;
3254 else if (recorded
< 0)
3256 /* We need to remove one or two events from recent_keys.
3257 To do this, we simply put nil at those events and move the
3258 recent_keys_index backwards over those events. Usually,
3259 users will never see those nil events, as they will be
3260 overwritten by the command keys entered to see recent_keys
3263 while (recorded
++ < 0 && total_keys
> 0)
3265 if (total_keys
< NUM_RECENT_KEYS
)
3267 if (--recent_keys_index
< 0)
3268 recent_keys_index
= NUM_RECENT_KEYS
- 1;
3269 ASET (recent_keys
, recent_keys_index
, Qnil
);
3273 num_nonmacro_input_events
++;
3275 /* Write c to the dribble file. If c is a lispy event, write
3276 the event's symbol to the dribble file, in <brackets>. Bleaugh.
3277 If you, dear reader, have a better idea, you've got the source. :-) */
3283 if (XUINT (c
) < 0x100)
3284 putc (XUINT (c
), dribble
);
3286 fprintf (dribble
, " 0x%"pI
"x", XUINT (c
));
3290 Lisp_Object dribblee
;
3292 /* If it's a structured event, take the event header. */
3293 dribblee
= EVENT_HEAD (c
);
3295 if (SYMBOLP (dribblee
))
3297 putc ('<', dribble
);
3298 fwrite (SDATA (SYMBOL_NAME (dribblee
)), sizeof (char),
3299 SBYTES (SYMBOL_NAME (dribblee
)),
3301 putc ('>', dribble
);
3310 /* Copy out or in the info on where C-g should throw to.
3311 This is used when running Lisp code from within get_char,
3312 in case get_char is called recursively.
3313 See read_process_output. */
3316 save_getcjmp (sys_jmp_buf temp
)
3318 memcpy (temp
, getcjmp
, sizeof getcjmp
);
3322 restore_getcjmp (sys_jmp_buf temp
)
3324 memcpy (getcjmp
, temp
, sizeof getcjmp
);
3327 /* Low level keyboard/mouse input.
3328 kbd_buffer_store_event places events in kbd_buffer, and
3329 kbd_buffer_get_event retrieves them. */
3331 /* Return true if there are any events in the queue that read-char
3332 would return. If this returns false, a read-char would block. */
3334 readable_events (int flags
)
3336 if (flags
& READABLE_EVENTS_DO_TIMERS_NOW
)
3339 /* If the buffer contains only FOCUS_IN_EVENT events, and
3340 READABLE_EVENTS_FILTER_EVENTS is set, report it as empty. */
3341 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3343 if (flags
& (READABLE_EVENTS_FILTER_EVENTS
3344 #ifdef USE_TOOLKIT_SCROLL_BARS
3345 | READABLE_EVENTS_IGNORE_SQUEEZABLES
3349 struct input_event
*event
;
3351 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
3358 #ifdef USE_TOOLKIT_SCROLL_BARS
3359 (flags
& READABLE_EVENTS_FILTER_EVENTS
) &&
3361 event
->kind
== FOCUS_IN_EVENT
)
3362 #ifdef USE_TOOLKIT_SCROLL_BARS
3363 && !((flags
& READABLE_EVENTS_IGNORE_SQUEEZABLES
)
3364 && event
->kind
== SCROLL_BAR_CLICK_EVENT
3365 && event
->part
== scroll_bar_handle
3366 && event
->modifiers
== 0)
3371 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3374 while (event
!= kbd_store_ptr
);
3380 if (!(flags
& READABLE_EVENTS_IGNORE_SQUEEZABLES
)
3381 && !NILP (do_mouse_tracking
) && some_mouse_moved ())
3385 if (current_kboard
->kbd_queue_has_data
)
3391 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
3392 if (kb
->kbd_queue_has_data
)
3398 /* Set this for debugging, to have a way to get out */
3399 int stop_character EXTERNALLY_VISIBLE
;
3402 event_to_kboard (struct input_event
*event
)
3404 /* Not applicable for these special events. */
3405 if (event
->kind
== SELECTION_REQUEST_EVENT
3406 || event
->kind
== SELECTION_CLEAR_EVENT
)
3410 Lisp_Object obj
= event
->frame_or_window
;
3411 /* There are some events that set this field to nil or string. */
3413 obj
= WINDOW_FRAME (XWINDOW (obj
));
3414 /* Also ignore dead frames here. */
3415 return ((FRAMEP (obj
) && FRAME_LIVE_P (XFRAME (obj
)))
3416 ? FRAME_KBOARD (XFRAME (obj
)) : NULL
);
3421 /* Return the number of slots occupied in kbd_buffer. */
3424 kbd_buffer_nr_stored (void)
3426 return kbd_fetch_ptr
== kbd_store_ptr
3428 : (kbd_fetch_ptr
< kbd_store_ptr
3429 ? kbd_store_ptr
- kbd_fetch_ptr
3430 : ((kbd_buffer
+ KBD_BUFFER_SIZE
) - kbd_fetch_ptr
3431 + (kbd_store_ptr
- kbd_buffer
)));
3433 #endif /* Store an event obtained at interrupt level into kbd_buffer, fifo */
3436 kbd_buffer_store_event (register struct input_event
*event
)
3438 kbd_buffer_store_event_hold (event
, 0);
3441 /* Store EVENT obtained at interrupt level into kbd_buffer, fifo.
3443 If HOLD_QUIT is 0, just stuff EVENT into the fifo.
3444 Else, if HOLD_QUIT.kind != NO_EVENT, discard EVENT.
3445 Else, if EVENT is a quit event, store the quit event
3446 in HOLD_QUIT, and return (thus ignoring further events).
3448 This is used to postpone the processing of the quit event until all
3449 subsequent input events have been parsed (and discarded). */
3452 kbd_buffer_store_event_hold (register struct input_event
*event
,
3453 struct input_event
*hold_quit
)
3455 if (event
->kind
== NO_EVENT
)
3458 if (hold_quit
&& hold_quit
->kind
!= NO_EVENT
)
3461 if (event
->kind
== ASCII_KEYSTROKE_EVENT
)
3463 register int c
= event
->code
& 0377;
3465 if (event
->modifiers
& ctrl_modifier
)
3466 c
= make_ctrl_char (c
);
3468 c
|= (event
->modifiers
3469 & (meta_modifier
| alt_modifier
3470 | hyper_modifier
| super_modifier
));
3474 KBOARD
*kb
= FRAME_KBOARD (XFRAME (event
->frame_or_window
));
3475 struct input_event
*sp
;
3477 if (single_kboard
&& kb
!= current_kboard
)
3480 (kb
, Fcons (make_lispy_switch_frame (event
->frame_or_window
),
3481 Fcons (make_number (c
), Qnil
)));
3482 kb
->kbd_queue_has_data
= 1;
3483 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3485 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3488 if (event_to_kboard (sp
) == kb
)
3490 sp
->kind
= NO_EVENT
;
3491 sp
->frame_or_window
= Qnil
;
3500 *hold_quit
= *event
;
3504 /* If this results in a quit_char being returned to Emacs as
3505 input, set Vlast_event_frame properly. If this doesn't
3506 get returned to Emacs as an event, the next event read
3507 will set Vlast_event_frame again, so this is safe to do. */
3511 focus
= FRAME_FOCUS_FRAME (XFRAME (event
->frame_or_window
));
3513 focus
= event
->frame_or_window
;
3514 internal_last_event_frame
= focus
;
3515 Vlast_event_frame
= focus
;
3518 last_event_timestamp
= event
->timestamp
;
3520 handle_interrupt (0);
3524 if (c
&& c
== stop_character
)
3530 /* Don't insert two BUFFER_SWITCH_EVENT's in a row.
3531 Just ignore the second one. */
3532 else if (event
->kind
== BUFFER_SWITCH_EVENT
3533 && kbd_fetch_ptr
!= kbd_store_ptr
3534 && ((kbd_store_ptr
== kbd_buffer
3535 ? kbd_buffer
+ KBD_BUFFER_SIZE
- 1
3536 : kbd_store_ptr
- 1)->kind
) == BUFFER_SWITCH_EVENT
)
3539 if (kbd_store_ptr
- kbd_buffer
== KBD_BUFFER_SIZE
)
3540 kbd_store_ptr
= kbd_buffer
;
3542 /* Don't let the very last slot in the buffer become full,
3543 since that would make the two pointers equal,
3544 and that is indistinguishable from an empty buffer.
3545 Discard the event if it would fill the last slot. */
3546 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
3548 *kbd_store_ptr
= *event
;
3551 if (kbd_buffer_nr_stored () > KBD_BUFFER_SIZE
/2 && ! kbd_on_hold_p ())
3553 /* Don't read keyboard input until we have processed kbd_buffer.
3554 This happens when pasting text longer than KBD_BUFFER_SIZE/2. */
3555 hold_keyboard_input ();
3556 if (!noninteractive
)
3560 #endif /* subprocesses */
3563 /* If we're inside while-no-input, and this event qualifies
3564 as input, set quit-flag to cause an interrupt. */
3565 if (!NILP (Vthrow_on_input
)
3566 && event
->kind
!= FOCUS_IN_EVENT
3567 && event
->kind
!= HELP_EVENT
3568 && event
->kind
!= DEICONIFY_EVENT
)
3570 Vquit_flag
= Vthrow_on_input
;
3571 /* If we're inside a function that wants immediate quits,
3573 if (immediate_quit
&& NILP (Vinhibit_quit
))
3582 /* Put an input event back in the head of the event queue. */
3585 kbd_buffer_unget_event (register struct input_event
*event
)
3587 if (kbd_fetch_ptr
== kbd_buffer
)
3588 kbd_fetch_ptr
= kbd_buffer
+ KBD_BUFFER_SIZE
;
3590 /* Don't let the very last slot in the buffer become full, */
3591 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
3594 *kbd_fetch_ptr
= *event
;
3599 /* Generate a HELP_EVENT input_event and store it in the keyboard
3602 HELP is the help form.
3604 FRAME and WINDOW are the frame and window where the help is
3605 generated. OBJECT is the Lisp object where the help was found (a
3606 buffer, a string, an overlay, or nil if neither from a string nor
3607 from a buffer). POS is the position within OBJECT where the help
3611 gen_help_event (Lisp_Object help
, Lisp_Object frame
, Lisp_Object window
,
3612 Lisp_Object object
, ptrdiff_t pos
)
3614 struct input_event event
;
3618 event
.kind
= HELP_EVENT
;
3619 event
.frame_or_window
= frame
;
3621 event
.x
= WINDOWP (window
) ? window
: frame
;
3624 kbd_buffer_store_event (&event
);
3628 /* Store HELP_EVENTs for HELP on FRAME in the input queue. */
3631 kbd_buffer_store_help_event (Lisp_Object frame
, Lisp_Object help
)
3633 struct input_event event
;
3635 event
.kind
= HELP_EVENT
;
3636 event
.frame_or_window
= frame
;
3641 kbd_buffer_store_event (&event
);
3645 /* Discard any mouse events in the event buffer by setting them to
3648 discard_mouse_events (void)
3650 struct input_event
*sp
;
3651 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3653 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3656 if (sp
->kind
== MOUSE_CLICK_EVENT
3657 || sp
->kind
== WHEEL_EVENT
3658 || sp
->kind
== HORIZ_WHEEL_EVENT
3660 || sp
->kind
== GPM_CLICK_EVENT
3662 || sp
->kind
== SCROLL_BAR_CLICK_EVENT
)
3664 sp
->kind
= NO_EVENT
;
3670 /* Return true if there are any real events waiting in the event
3671 buffer, not counting `NO_EVENT's.
3673 Discard NO_EVENT events at the front of the input queue, possibly
3674 leaving the input queue empty if there are no real input events. */
3677 kbd_buffer_events_waiting (void)
3679 struct input_event
*sp
;
3681 for (sp
= kbd_fetch_ptr
;
3682 sp
!= kbd_store_ptr
&& sp
->kind
== NO_EVENT
;
3685 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3690 return sp
!= kbd_store_ptr
&& sp
->kind
!= NO_EVENT
;
3694 /* Clear input event EVENT. */
3697 clear_event (struct input_event
*event
)
3699 event
->kind
= NO_EVENT
;
3703 /* Read one event from the event buffer, waiting if necessary.
3704 The value is a Lisp object representing the event.
3705 The value is nil for an event that should be ignored,
3706 or that was handled here.
3707 We always read and discard one event. */
3710 kbd_buffer_get_event (KBOARD
**kbp
,
3711 bool *used_mouse_menu
,
3712 EMACS_TIME
*end_time
)
3717 if (kbd_on_hold_p () && kbd_buffer_nr_stored () < KBD_BUFFER_SIZE
/4)
3719 /* Start reading input again because we have processed enough to
3720 be able to accept new events again. */
3721 unhold_keyboard_input ();
3724 #endif /* subprocesses */
3726 #ifndef HAVE_DBUS /* We want to read D-Bus events in batch mode. */
3728 /* In case we are running as a daemon, only do this before
3729 detaching from the terminal. */
3730 || (IS_DAEMON
&& daemon_pipe
[1] >= 0))
3734 *kbp
= current_kboard
;
3737 #endif /* ! HAVE_DBUS */
3739 /* Wait until there is input available. */
3742 /* Break loop if there's an unread command event. Needed in
3743 moused window autoselection which uses a timer to insert such
3745 if (CONSP (Vunread_command_events
))
3748 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3750 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3753 /* If the quit flag is set, then read_char will return
3754 quit_char, so that counts as "available input." */
3755 if (!NILP (Vquit_flag
))
3756 quit_throw_to_read_char (0);
3758 /* One way or another, wait until input is available; then, if
3759 interrupt handlers have not read it, read it now. */
3764 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3766 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3770 EMACS_TIME now
= current_emacs_time ();
3771 if (EMACS_TIME_LE (*end_time
, now
))
3772 return Qnil
; /* Finished waiting. */
3775 EMACS_TIME duration
= sub_emacs_time (*end_time
, now
);
3776 wait_reading_process_output (min (EMACS_SECS (duration
),
3778 EMACS_NSECS (duration
),
3779 -1, 1, Qnil
, NULL
, 0);
3783 wait_reading_process_output (0, 0, -1, 1, Qnil
, NULL
, 0);
3785 if (!interrupt_input
&& kbd_fetch_ptr
== kbd_store_ptr
)
3789 if (CONSP (Vunread_command_events
))
3792 first
= XCAR (Vunread_command_events
);
3793 Vunread_command_events
= XCDR (Vunread_command_events
);
3794 *kbp
= current_kboard
;
3798 /* At this point, we know that there is a readable event available
3799 somewhere. If the event queue is empty, then there must be a
3800 mouse movement enabled and available. */
3801 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3803 struct input_event
*event
;
3805 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
3809 last_event_timestamp
= event
->timestamp
;
3811 *kbp
= event_to_kboard (event
);
3813 *kbp
= current_kboard
; /* Better than returning null ptr? */
3817 /* These two kinds of events get special handling
3818 and don't actually appear to the command loop.
3819 We return nil for them. */
3820 if (event
->kind
== SELECTION_REQUEST_EVENT
3821 || event
->kind
== SELECTION_CLEAR_EVENT
)
3824 struct input_event copy
;
3826 /* Remove it from the buffer before processing it,
3827 since otherwise swallow_events will see it
3828 and process it again. */
3830 kbd_fetch_ptr
= event
+ 1;
3831 input_pending
= readable_events (0);
3832 x_handle_selection_event (©
);
3834 /* We're getting selection request events, but we don't have
3840 #if defined (HAVE_NS)
3841 else if (event
->kind
== NS_TEXT_EVENT
)
3843 if (event
->code
== KEY_NS_PUT_WORKING_TEXT
)
3844 obj
= Fcons (intern ("ns-put-working-text"), Qnil
);
3846 obj
= Fcons (intern ("ns-unput-working-text"), Qnil
);
3847 kbd_fetch_ptr
= event
+ 1;
3848 if (used_mouse_menu
)
3849 *used_mouse_menu
= 1;
3853 #if defined (HAVE_X11) || defined (HAVE_NTGUI) \
3854 || defined (HAVE_NS)
3855 else if (event
->kind
== DELETE_WINDOW_EVENT
)
3857 /* Make an event (delete-frame (FRAME)). */
3858 obj
= Fcons (event
->frame_or_window
, Qnil
);
3859 obj
= Fcons (Qdelete_frame
, Fcons (obj
, Qnil
));
3860 kbd_fetch_ptr
= event
+ 1;
3863 #if defined (HAVE_X11) || defined (HAVE_NTGUI) \
3864 || defined (HAVE_NS)
3865 else if (event
->kind
== ICONIFY_EVENT
)
3867 /* Make an event (iconify-frame (FRAME)). */
3868 obj
= Fcons (event
->frame_or_window
, Qnil
);
3869 obj
= Fcons (Qiconify_frame
, Fcons (obj
, Qnil
));
3870 kbd_fetch_ptr
= event
+ 1;
3872 else if (event
->kind
== DEICONIFY_EVENT
)
3874 /* Make an event (make-frame-visible (FRAME)). */
3875 obj
= Fcons (event
->frame_or_window
, Qnil
);
3876 obj
= Fcons (Qmake_frame_visible
, Fcons (obj
, Qnil
));
3877 kbd_fetch_ptr
= event
+ 1;
3880 else if (event
->kind
== BUFFER_SWITCH_EVENT
)
3882 /* The value doesn't matter here; only the type is tested. */
3883 XSETBUFFER (obj
, current_buffer
);
3884 kbd_fetch_ptr
= event
+ 1;
3886 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
3887 || defined (HAVE_NS) || defined (USE_GTK)
3888 else if (event
->kind
== MENU_BAR_ACTIVATE_EVENT
)
3890 kbd_fetch_ptr
= event
+ 1;
3891 input_pending
= readable_events (0);
3892 if (FRAME_LIVE_P (XFRAME (event
->frame_or_window
)))
3893 x_activate_menubar (XFRAME (event
->frame_or_window
));
3897 else if (event
->kind
== LANGUAGE_CHANGE_EVENT
)
3899 /* Make an event (language-change (FRAME CODEPAGE LANGUAGE-ID)). */
3900 obj
= Fcons (Qlanguage_change
,
3901 list3 (event
->frame_or_window
,
3902 make_number (event
->code
),
3903 make_number (event
->modifiers
)));
3904 kbd_fetch_ptr
= event
+ 1;
3907 else if (event
->kind
== SAVE_SESSION_EVENT
)
3909 obj
= Fcons (Qsave_session
, Fcons (event
->arg
, Qnil
));
3910 kbd_fetch_ptr
= event
+ 1;
3912 /* Just discard these, by returning nil.
3913 With MULTI_KBOARD, these events are used as placeholders
3914 when we need to randomly delete events from the queue.
3915 (They shouldn't otherwise be found in the buffer,
3916 but on some machines it appears they do show up
3917 even without MULTI_KBOARD.) */
3918 /* On Windows NT/9X, NO_EVENT is used to delete extraneous
3919 mouse events during a popup-menu call. */
3920 else if (event
->kind
== NO_EVENT
)
3921 kbd_fetch_ptr
= event
+ 1;
3922 else if (event
->kind
== HELP_EVENT
)
3924 Lisp_Object object
, position
, help
, frame
, window
;
3926 frame
= event
->frame_or_window
;
3927 object
= event
->arg
;
3928 position
= make_number (event
->code
);
3931 clear_event (event
);
3933 kbd_fetch_ptr
= event
+ 1;
3934 if (!WINDOWP (window
))
3936 obj
= Fcons (Qhelp_echo
,
3937 list5 (frame
, help
, window
, object
, position
));
3939 else if (event
->kind
== FOCUS_IN_EVENT
)
3941 /* Notification of a FocusIn event. The frame receiving the
3942 focus is in event->frame_or_window. Generate a
3943 switch-frame event if necessary. */
3944 Lisp_Object frame
, focus
;
3946 frame
= event
->frame_or_window
;
3947 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
3951 if (!EQ (frame
, internal_last_event_frame
)
3952 && !EQ (frame
, selected_frame
))
3953 obj
= make_lispy_switch_frame (frame
);
3954 internal_last_event_frame
= frame
;
3955 kbd_fetch_ptr
= event
+ 1;
3958 else if (event
->kind
== DBUS_EVENT
)
3960 obj
= make_lispy_event (event
);
3961 kbd_fetch_ptr
= event
+ 1;
3964 else if (event
->kind
== CONFIG_CHANGED_EVENT
)
3966 obj
= make_lispy_event (event
);
3967 kbd_fetch_ptr
= event
+ 1;
3971 /* If this event is on a different frame, return a switch-frame this
3972 time, and leave the event in the queue for next time. */
3976 frame
= event
->frame_or_window
;
3978 frame
= XCAR (frame
);
3979 else if (WINDOWP (frame
))
3980 frame
= WINDOW_FRAME (XWINDOW (frame
));
3982 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
3986 if (! EQ (frame
, internal_last_event_frame
)
3987 && !EQ (frame
, selected_frame
))
3988 obj
= make_lispy_switch_frame (frame
);
3989 internal_last_event_frame
= frame
;
3991 /* If we didn't decide to make a switch-frame event, go ahead
3992 and build a real event from the queue entry. */
3996 obj
= make_lispy_event (event
);
3998 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
3999 || defined (HAVE_NS) || defined (USE_GTK)
4000 /* If this was a menu selection, then set the flag to inhibit
4001 writing to last_nonmenu_event. Don't do this if the event
4002 we're returning is (menu-bar), though; that indicates the
4003 beginning of the menu sequence, and we might as well leave
4004 that as the `event with parameters' for this selection. */
4006 && !EQ (event
->frame_or_window
, event
->arg
)
4007 && (event
->kind
== MENU_BAR_EVENT
4008 || event
->kind
== TOOL_BAR_EVENT
))
4009 *used_mouse_menu
= 1;
4012 /* Certain system events are non-key events. */
4014 && event
->kind
== NS_NONKEY_EVENT
)
4015 *used_mouse_menu
= 1;
4018 /* Wipe out this event, to catch bugs. */
4019 clear_event (event
);
4020 kbd_fetch_ptr
= event
+ 1;
4024 /* Try generating a mouse motion event. */
4025 else if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
4027 FRAME_PTR f
= some_mouse_moved ();
4028 Lisp_Object bar_window
;
4029 enum scroll_bar_part part
;
4033 *kbp
= current_kboard
;
4034 /* Note that this uses F to determine which terminal to look at.
4035 If there is no valid info, it does not store anything
4036 so x remains nil. */
4039 /* XXX Can f or mouse_position_hook be NULL here? */
4040 if (f
&& FRAME_TERMINAL (f
)->mouse_position_hook
)
4041 (*FRAME_TERMINAL (f
)->mouse_position_hook
) (&f
, 0, &bar_window
,
4046 /* Decide if we should generate a switch-frame event. Don't
4047 generate switch-frame events for motion outside of all Emacs
4053 frame
= FRAME_FOCUS_FRAME (f
);
4055 XSETFRAME (frame
, f
);
4057 if (! EQ (frame
, internal_last_event_frame
)
4058 && !EQ (frame
, selected_frame
))
4059 obj
= make_lispy_switch_frame (frame
);
4060 internal_last_event_frame
= frame
;
4063 /* If we didn't decide to make a switch-frame event, go ahead and
4064 return a mouse-motion event. */
4065 if (!NILP (x
) && NILP (obj
))
4066 obj
= make_lispy_movement (f
, bar_window
, part
, x
, y
, t
);
4069 /* We were promised by the above while loop that there was
4070 something for us to read! */
4073 input_pending
= readable_events (0);
4075 Vlast_event_frame
= internal_last_event_frame
;
4080 /* Process any non-user-visible events (currently X selection events),
4081 without reading any user-visible events. */
4084 process_special_events (void)
4086 struct input_event
*event
;
4088 for (event
= kbd_fetch_ptr
; event
!= kbd_store_ptr
; ++event
)
4090 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
4093 if (event
== kbd_store_ptr
)
4097 /* If we find a stored X selection request, handle it now. */
4098 if (event
->kind
== SELECTION_REQUEST_EVENT
4099 || event
->kind
== SELECTION_CLEAR_EVENT
)
4103 /* Remove the event from the fifo buffer before processing;
4104 otherwise swallow_events called recursively could see it
4105 and process it again. To do this, we move the events
4106 between kbd_fetch_ptr and EVENT one slot to the right,
4109 struct input_event copy
= *event
;
4110 struct input_event
*beg
4111 = (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
4112 ? kbd_buffer
: kbd_fetch_ptr
;
4115 memmove (beg
+ 1, beg
, (event
- beg
) * sizeof (struct input_event
));
4116 else if (event
< beg
)
4118 if (event
> kbd_buffer
)
4119 memmove (kbd_buffer
+ 1, kbd_buffer
,
4120 (event
- kbd_buffer
) * sizeof (struct input_event
));
4121 *kbd_buffer
= *(kbd_buffer
+ KBD_BUFFER_SIZE
- 1);
4122 if (beg
< kbd_buffer
+ KBD_BUFFER_SIZE
- 1)
4123 memmove (beg
+ 1, beg
,
4124 (kbd_buffer
+ KBD_BUFFER_SIZE
- 1 - beg
)
4125 * sizeof (struct input_event
));
4128 if (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
4129 kbd_fetch_ptr
= kbd_buffer
+ 1;
4133 /* X wants last_event_timestamp for selection ownership. */
4134 last_event_timestamp
= copy
.timestamp
;
4135 input_pending
= readable_events (0);
4136 x_handle_selection_event (©
);
4138 /* We're getting selection request events, but we don't have
4146 /* Process any events that are not user-visible, run timer events that
4147 are ripe, and return, without reading any user-visible events. */
4150 swallow_events (bool do_display
)
4152 unsigned old_timers_run
;
4154 process_special_events ();
4156 old_timers_run
= timers_run
;
4157 get_input_pending (READABLE_EVENTS_DO_TIMERS_NOW
);
4159 if (timers_run
!= old_timers_run
&& do_display
)
4160 redisplay_preserve_echo_area (7);
4163 /* Record the start of when Emacs is idle,
4164 for the sake of running idle-time timers. */
4167 timer_start_idle (void)
4171 /* If we are already in the idle state, do nothing. */
4172 if (EMACS_TIME_VALID_P (timer_idleness_start_time
))
4175 timer_idleness_start_time
= current_emacs_time ();
4176 timer_last_idleness_start_time
= timer_idleness_start_time
;
4178 /* Mark all idle-time timers as once again candidates for running. */
4179 for (timers
= Vtimer_idle_list
; CONSP (timers
); timers
= XCDR (timers
))
4183 timer
= XCAR (timers
);
4185 if (!VECTORP (timer
) || ASIZE (timer
) != 9)
4187 ASET (timer
, 0, Qnil
);
4191 /* Record that Emacs is no longer idle, so stop running idle-time timers. */
4194 timer_stop_idle (void)
4196 timer_idleness_start_time
= invalid_emacs_time ();
4199 /* Resume idle timer from last idle start time. */
4202 timer_resume_idle (void)
4204 if (EMACS_TIME_VALID_P (timer_idleness_start_time
))
4207 timer_idleness_start_time
= timer_last_idleness_start_time
;
4210 /* This is only for debugging. */
4211 struct input_event last_timer_event EXTERNALLY_VISIBLE
;
4213 /* List of elisp functions to call, delayed because they were generated in
4214 a context where Elisp could not be safely run (e.g. redisplay, signal,
4215 ...). Each element has the form (FUN . ARGS). */
4216 Lisp_Object pending_funcalls
;
4218 /* Return true if TIMER is a valid timer, placing its value into *RESULT. */
4220 decode_timer (Lisp_Object timer
, EMACS_TIME
*result
)
4222 Lisp_Object
*vector
;
4224 if (! (VECTORP (timer
) && ASIZE (timer
) == 9))
4226 vector
= XVECTOR (timer
)->contents
;
4227 if (! NILP (vector
[0]))
4230 return decode_time_components (vector
[1], vector
[2], vector
[3], vector
[8],
4235 /* Check whether a timer has fired. To prevent larger problems we simply
4236 disregard elements that are not proper timers. Do not make a circular
4237 timer list for the time being.
4239 Returns the time to wait until the next timer fires. If a
4240 timer is triggering now, return zero.
4241 If no timer is active, return -1.
4243 If a timer is ripe, we run it, with quitting turned off.
4244 In that case we return 0 to indicate that a new timer_check_2 call
4248 timer_check_2 (Lisp_Object timers
, Lisp_Object idle_timers
)
4250 EMACS_TIME nexttime
;
4252 EMACS_TIME idleness_now
;
4253 Lisp_Object chosen_timer
;
4254 struct gcpro gcpro1
;
4256 nexttime
= invalid_emacs_time ();
4258 chosen_timer
= Qnil
;
4259 GCPRO1 (chosen_timer
);
4261 /* First run the code that was delayed. */
4262 while (CONSP (pending_funcalls
))
4264 Lisp_Object funcall
= XCAR (pending_funcalls
);
4265 pending_funcalls
= XCDR (pending_funcalls
);
4266 safe_call2 (Qapply
, XCAR (funcall
), XCDR (funcall
));
4269 if (CONSP (timers
) || CONSP (idle_timers
))
4271 now
= current_emacs_time ();
4272 idleness_now
= (EMACS_TIME_VALID_P (timer_idleness_start_time
)
4273 ? sub_emacs_time (now
, timer_idleness_start_time
)
4274 : make_emacs_time (0, 0));
4277 while (CONSP (timers
) || CONSP (idle_timers
))
4279 Lisp_Object timer
= Qnil
, idle_timer
= Qnil
;
4280 EMACS_TIME timer_time
, idle_timer_time
;
4281 EMACS_TIME difference
;
4282 EMACS_TIME timer_difference
= invalid_emacs_time ();
4283 EMACS_TIME idle_timer_difference
= invalid_emacs_time ();
4284 bool ripe
, timer_ripe
= 0, idle_timer_ripe
= 0;
4286 /* Set TIMER and TIMER_DIFFERENCE
4287 based on the next ordinary timer.
4288 TIMER_DIFFERENCE is the distance in time from NOW to when
4289 this timer becomes ripe (negative if it's already ripe).
4290 Skip past invalid timers and timers already handled. */
4293 timer
= XCAR (timers
);
4294 if (! decode_timer (timer
, &timer_time
))
4296 timers
= XCDR (timers
);
4300 timer_ripe
= EMACS_TIME_LE (timer_time
, now
);
4301 timer_difference
= (timer_ripe
4302 ? sub_emacs_time (now
, timer_time
)
4303 : sub_emacs_time (timer_time
, now
));
4306 /* Likewise for IDLE_TIMER and IDLE_TIMER_DIFFERENCE
4307 based on the next idle timer. */
4308 if (CONSP (idle_timers
))
4310 idle_timer
= XCAR (idle_timers
);
4311 if (! decode_timer (idle_timer
, &idle_timer_time
))
4313 idle_timers
= XCDR (idle_timers
);
4317 idle_timer_ripe
= EMACS_TIME_LE (idle_timer_time
, idleness_now
);
4318 idle_timer_difference
=
4320 ? sub_emacs_time (idleness_now
, idle_timer_time
)
4321 : sub_emacs_time (idle_timer_time
, idleness_now
));
4324 /* Decide which timer is the next timer,
4325 and set CHOSEN_TIMER, DIFFERENCE, and RIPE accordingly.
4326 Also step down the list where we found that timer. */
4328 if (EMACS_TIME_VALID_P (timer_difference
)
4329 && (! EMACS_TIME_VALID_P (idle_timer_difference
)
4330 || idle_timer_ripe
< timer_ripe
4331 || (idle_timer_ripe
== timer_ripe
4333 ? EMACS_TIME_LT (idle_timer_difference
,
4335 : EMACS_TIME_LT (timer_difference
,
4336 idle_timer_difference
)))))
4338 chosen_timer
= timer
;
4339 timers
= XCDR (timers
);
4340 difference
= timer_difference
;
4345 chosen_timer
= idle_timer
;
4346 idle_timers
= XCDR (idle_timers
);
4347 difference
= idle_timer_difference
;
4348 ripe
= idle_timer_ripe
;
4351 /* If timer is ripe, run it if it hasn't been run. */
4354 if (NILP (AREF (chosen_timer
, 0)))
4356 ptrdiff_t count
= SPECPDL_INDEX ();
4357 Lisp_Object old_deactivate_mark
= Vdeactivate_mark
;
4359 /* Mark the timer as triggered to prevent problems if the lisp
4360 code fails to reschedule it right. */
4361 ASET (chosen_timer
, 0, Qt
);
4363 specbind (Qinhibit_quit
, Qt
);
4365 call1 (Qtimer_event_handler
, chosen_timer
);
4366 Vdeactivate_mark
= old_deactivate_mark
;
4368 unbind_to (count
, Qnil
);
4370 /* Since we have handled the event,
4371 we don't need to tell the caller to wake up and do it. */
4372 /* But the caller must still wait for the next timer, so
4373 return 0 to indicate that. */
4376 nexttime
= make_emacs_time (0, 0);
4380 /* When we encounter a timer that is still waiting,
4381 return the amount of time to wait before it is ripe. */
4388 /* No timers are pending in the future. */
4389 /* Return 0 if we generated an event, and -1 if not. */
4395 /* Check whether a timer has fired. To prevent larger problems we simply
4396 disregard elements that are not proper timers. Do not make a circular
4397 timer list for the time being.
4399 Returns the time to wait until the next timer fires.
4400 If no timer is active, return an invalid value.
4402 As long as any timer is ripe, we run it. */
4407 EMACS_TIME nexttime
;
4408 Lisp_Object timers
, idle_timers
;
4409 struct gcpro gcpro1
, gcpro2
;
4411 Lisp_Object tem
= Vinhibit_quit
;
4414 /* We use copies of the timers' lists to allow a timer to add itself
4415 again, without locking up Emacs if the newly added timer is
4416 already ripe when added. */
4418 /* Always consider the ordinary timers. */
4419 timers
= Fcopy_sequence (Vtimer_list
);
4420 /* Consider the idle timers only if Emacs is idle. */
4421 if (EMACS_TIME_VALID_P (timer_idleness_start_time
))
4422 idle_timers
= Fcopy_sequence (Vtimer_idle_list
);
4426 Vinhibit_quit
= tem
;
4428 GCPRO2 (timers
, idle_timers
);
4432 nexttime
= timer_check_2 (timers
, idle_timers
);
4434 while (EMACS_SECS (nexttime
) == 0 && EMACS_NSECS (nexttime
) == 0);
4440 DEFUN ("current-idle-time", Fcurrent_idle_time
, Scurrent_idle_time
, 0, 0, 0,
4441 doc
: /* Return the current length of Emacs idleness, or nil.
4442 The value when Emacs is idle is a list of four integers (HIGH LOW USEC PSEC)
4443 in the same style as (current-time).
4445 The value when Emacs is not idle is nil.
4447 PSEC is a multiple of the system clock resolution. */)
4450 if (EMACS_TIME_VALID_P (timer_idleness_start_time
))
4451 return make_lisp_time (sub_emacs_time (current_emacs_time (),
4452 timer_idleness_start_time
));
4457 /* Caches for modify_event_symbol. */
4458 static Lisp_Object accent_key_syms
;
4459 static Lisp_Object func_key_syms
;
4460 static Lisp_Object mouse_syms
;
4461 static Lisp_Object wheel_syms
;
4462 static Lisp_Object drag_n_drop_syms
;
4464 /* This is a list of keysym codes for special "accent" characters.
4465 It parallels lispy_accent_keys. */
4467 static const int lispy_accent_codes
[] =
4469 #ifdef XK_dead_circumflex
4474 #ifdef XK_dead_grave
4479 #ifdef XK_dead_tilde
4484 #ifdef XK_dead_diaeresis
4489 #ifdef XK_dead_macron
4494 #ifdef XK_dead_degree
4499 #ifdef XK_dead_acute
4504 #ifdef XK_dead_cedilla
4509 #ifdef XK_dead_breve
4514 #ifdef XK_dead_ogonek
4519 #ifdef XK_dead_caron
4524 #ifdef XK_dead_doubleacute
4525 XK_dead_doubleacute
,
4529 #ifdef XK_dead_abovedot
4534 #ifdef XK_dead_abovering
4544 #ifdef XK_dead_belowdot
4549 #ifdef XK_dead_voiced_sound
4550 XK_dead_voiced_sound
,
4554 #ifdef XK_dead_semivoiced_sound
4555 XK_dead_semivoiced_sound
,
4571 /* This is a list of Lisp names for special "accent" characters.
4572 It parallels lispy_accent_codes. */
4574 static const char *const lispy_accent_keys
[] =
4592 "dead-voiced-sound",
4593 "dead-semivoiced-sound",
4599 #define FUNCTION_KEY_OFFSET 0x0
4601 const char *const lispy_function_keys
[] =
4605 0, /* VK_LBUTTON 0x01 */
4606 0, /* VK_RBUTTON 0x02 */
4607 "cancel", /* VK_CANCEL 0x03 */
4608 0, /* VK_MBUTTON 0x04 */
4610 0, 0, 0, /* 0x05 .. 0x07 */
4612 "backspace", /* VK_BACK 0x08 */
4613 "tab", /* VK_TAB 0x09 */
4615 0, 0, /* 0x0A .. 0x0B */
4617 "clear", /* VK_CLEAR 0x0C */
4618 "return", /* VK_RETURN 0x0D */
4620 0, 0, /* 0x0E .. 0x0F */
4622 0, /* VK_SHIFT 0x10 */
4623 0, /* VK_CONTROL 0x11 */
4624 0, /* VK_MENU 0x12 */
4625 "pause", /* VK_PAUSE 0x13 */
4626 "capslock", /* VK_CAPITAL 0x14 */
4627 "kana", /* VK_KANA/VK_HANGUL 0x15 */
4629 "junja", /* VK_JUNJA 0x17 */
4630 "final", /* VK_FINAL 0x18 */
4631 "kanji", /* VK_KANJI/VK_HANJA 0x19 */
4633 "escape", /* VK_ESCAPE 0x1B */
4634 "convert", /* VK_CONVERT 0x1C */
4635 "non-convert", /* VK_NONCONVERT 0x1D */
4636 "accept", /* VK_ACCEPT 0x1E */
4637 "mode-change", /* VK_MODECHANGE 0x1F */
4638 0, /* VK_SPACE 0x20 */
4639 "prior", /* VK_PRIOR 0x21 */
4640 "next", /* VK_NEXT 0x22 */
4641 "end", /* VK_END 0x23 */
4642 "home", /* VK_HOME 0x24 */
4643 "left", /* VK_LEFT 0x25 */
4644 "up", /* VK_UP 0x26 */
4645 "right", /* VK_RIGHT 0x27 */
4646 "down", /* VK_DOWN 0x28 */
4647 "select", /* VK_SELECT 0x29 */
4648 "print", /* VK_PRINT 0x2A */
4649 "execute", /* VK_EXECUTE 0x2B */
4650 "snapshot", /* VK_SNAPSHOT 0x2C */
4651 "insert", /* VK_INSERT 0x2D */
4652 "delete", /* VK_DELETE 0x2E */
4653 "help", /* VK_HELP 0x2F */
4655 /* VK_0 thru VK_9 are the same as ASCII '0' thru '9' (0x30 - 0x39) */
4657 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4659 0, 0, 0, 0, 0, 0, 0, /* 0x3A .. 0x40 */
4661 /* VK_A thru VK_Z are the same as ASCII 'A' thru 'Z' (0x41 - 0x5A) */
4663 0, 0, 0, 0, 0, 0, 0, 0, 0,
4664 0, 0, 0, 0, 0, 0, 0, 0, 0,
4665 0, 0, 0, 0, 0, 0, 0, 0,
4667 "lwindow", /* VK_LWIN 0x5B */
4668 "rwindow", /* VK_RWIN 0x5C */
4669 "apps", /* VK_APPS 0x5D */
4672 "kp-0", /* VK_NUMPAD0 0x60 */
4673 "kp-1", /* VK_NUMPAD1 0x61 */
4674 "kp-2", /* VK_NUMPAD2 0x62 */
4675 "kp-3", /* VK_NUMPAD3 0x63 */
4676 "kp-4", /* VK_NUMPAD4 0x64 */
4677 "kp-5", /* VK_NUMPAD5 0x65 */
4678 "kp-6", /* VK_NUMPAD6 0x66 */
4679 "kp-7", /* VK_NUMPAD7 0x67 */
4680 "kp-8", /* VK_NUMPAD8 0x68 */
4681 "kp-9", /* VK_NUMPAD9 0x69 */
4682 "kp-multiply", /* VK_MULTIPLY 0x6A */
4683 "kp-add", /* VK_ADD 0x6B */
4684 "kp-separator", /* VK_SEPARATOR 0x6C */
4685 "kp-subtract", /* VK_SUBTRACT 0x6D */
4686 "kp-decimal", /* VK_DECIMAL 0x6E */
4687 "kp-divide", /* VK_DIVIDE 0x6F */
4688 "f1", /* VK_F1 0x70 */
4689 "f2", /* VK_F2 0x71 */
4690 "f3", /* VK_F3 0x72 */
4691 "f4", /* VK_F4 0x73 */
4692 "f5", /* VK_F5 0x74 */
4693 "f6", /* VK_F6 0x75 */
4694 "f7", /* VK_F7 0x76 */
4695 "f8", /* VK_F8 0x77 */
4696 "f9", /* VK_F9 0x78 */
4697 "f10", /* VK_F10 0x79 */
4698 "f11", /* VK_F11 0x7A */
4699 "f12", /* VK_F12 0x7B */
4700 "f13", /* VK_F13 0x7C */
4701 "f14", /* VK_F14 0x7D */
4702 "f15", /* VK_F15 0x7E */
4703 "f16", /* VK_F16 0x7F */
4704 "f17", /* VK_F17 0x80 */
4705 "f18", /* VK_F18 0x81 */
4706 "f19", /* VK_F19 0x82 */
4707 "f20", /* VK_F20 0x83 */
4708 "f21", /* VK_F21 0x84 */
4709 "f22", /* VK_F22 0x85 */
4710 "f23", /* VK_F23 0x86 */
4711 "f24", /* VK_F24 0x87 */
4713 0, 0, 0, 0, /* 0x88 .. 0x8B */
4714 0, 0, 0, 0, /* 0x8C .. 0x8F */
4716 "kp-numlock", /* VK_NUMLOCK 0x90 */
4717 "scroll", /* VK_SCROLL 0x91 */
4718 /* Not sure where the following block comes from.
4719 Windows headers have NEC and Fujitsu specific keys in
4720 this block, but nothing generic. */
4721 "kp-space", /* VK_NUMPAD_CLEAR 0x92 */
4722 "kp-enter", /* VK_NUMPAD_ENTER 0x93 */
4723 "kp-prior", /* VK_NUMPAD_PRIOR 0x94 */
4724 "kp-next", /* VK_NUMPAD_NEXT 0x95 */
4725 "kp-end", /* VK_NUMPAD_END 0x96 */
4726 "kp-home", /* VK_NUMPAD_HOME 0x97 */
4727 "kp-left", /* VK_NUMPAD_LEFT 0x98 */
4728 "kp-up", /* VK_NUMPAD_UP 0x99 */
4729 "kp-right", /* VK_NUMPAD_RIGHT 0x9A */
4730 "kp-down", /* VK_NUMPAD_DOWN 0x9B */
4731 "kp-insert", /* VK_NUMPAD_INSERT 0x9C */
4732 "kp-delete", /* VK_NUMPAD_DELETE 0x9D */
4734 0, 0, /* 0x9E .. 0x9F */
4737 * VK_L* & VK_R* - left and right Alt, Ctrl and Shift virtual keys.
4738 * Used only as parameters to GetAsyncKeyState and GetKeyState.
4739 * No other API or message will distinguish left and right keys this way.
4744 /* Multimedia keys. These are handled as WM_APPCOMMAND, which allows us
4745 to enable them selectively, and gives access to a few more functions.
4746 See lispy_multimedia_keys below. */
4747 0, 0, 0, 0, 0, 0, 0, /* 0xA6 .. 0xAC Browser */
4748 0, 0, 0, /* 0xAD .. 0xAF Volume */
4749 0, 0, 0, 0, /* 0xB0 .. 0xB3 Media */
4750 0, 0, 0, 0, /* 0xB4 .. 0xB7 Apps */
4752 /* 0xB8 .. 0xC0 "OEM" keys - all seem to be punctuation. */
4753 0, 0, 0, 0, 0, 0, 0, 0, 0,
4755 /* 0xC1 - 0xDA unallocated, 0xDB-0xDF more OEM keys */
4756 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4757 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4760 "ax", /* VK_OEM_AX 0xE1 */
4761 0, /* VK_OEM_102 0xE2 */
4762 "ico-help", /* VK_ICO_HELP 0xE3 */
4763 "ico-00", /* VK_ICO_00 0xE4 */
4764 0, /* VK_PROCESSKEY 0xE5 - used by IME */
4765 "ico-clear", /* VK_ICO_CLEAR 0xE6 */
4766 0, /* VK_PACKET 0xE7 - used to pass Unicode chars */
4768 "reset", /* VK_OEM_RESET 0xE9 */
4769 "jump", /* VK_OEM_JUMP 0xEA */
4770 "oem-pa1", /* VK_OEM_PA1 0xEB */
4771 "oem-pa2", /* VK_OEM_PA2 0xEC */
4772 "oem-pa3", /* VK_OEM_PA3 0xED */
4773 "wsctrl", /* VK_OEM_WSCTRL 0xEE */
4774 "cusel", /* VK_OEM_CUSEL 0xEF */
4775 "oem-attn", /* VK_OEM_ATTN 0xF0 */
4776 "finish", /* VK_OEM_FINISH 0xF1 */
4777 "copy", /* VK_OEM_COPY 0xF2 */
4778 "auto", /* VK_OEM_AUTO 0xF3 */
4779 "enlw", /* VK_OEM_ENLW 0xF4 */
4780 "backtab", /* VK_OEM_BACKTAB 0xF5 */
4781 "attn", /* VK_ATTN 0xF6 */
4782 "crsel", /* VK_CRSEL 0xF7 */
4783 "exsel", /* VK_EXSEL 0xF8 */
4784 "ereof", /* VK_EREOF 0xF9 */
4785 "play", /* VK_PLAY 0xFA */
4786 "zoom", /* VK_ZOOM 0xFB */
4787 "noname", /* VK_NONAME 0xFC */
4788 "pa1", /* VK_PA1 0xFD */
4789 "oem_clear", /* VK_OEM_CLEAR 0xFE */
4793 /* Some of these duplicate the "Media keys" on newer keyboards,
4794 but they are delivered to the application in a different way. */
4795 static const char *const lispy_multimedia_keys
[] =
4803 "browser-favorites",
4840 "toggle-dictate-command",
4846 "media-fast-forward",
4849 "media-channel-down"
4852 #else /* not HAVE_NTGUI */
4854 /* This should be dealt with in XTread_socket now, and that doesn't
4855 depend on the client system having the Kana syms defined. See also
4856 the XK_kana_A case below. */
4859 static const char *const lispy_kana_keys
[] =
4861 /* X Keysym value */
4862 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x400 .. 0x40f */
4863 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x410 .. 0x41f */
4864 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x420 .. 0x42f */
4865 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x430 .. 0x43f */
4866 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x440 .. 0x44f */
4867 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x450 .. 0x45f */
4868 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x460 .. 0x46f */
4869 0,0,0,0,0,0,0,0,0,0,0,0,0,0,"overline",0,
4870 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x480 .. 0x48f */
4871 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x490 .. 0x49f */
4872 0, "kana-fullstop", "kana-openingbracket", "kana-closingbracket",
4873 "kana-comma", "kana-conjunctive", "kana-WO", "kana-a",
4874 "kana-i", "kana-u", "kana-e", "kana-o",
4875 "kana-ya", "kana-yu", "kana-yo", "kana-tsu",
4876 "prolongedsound", "kana-A", "kana-I", "kana-U",
4877 "kana-E", "kana-O", "kana-KA", "kana-KI",
4878 "kana-KU", "kana-KE", "kana-KO", "kana-SA",
4879 "kana-SHI", "kana-SU", "kana-SE", "kana-SO",
4880 "kana-TA", "kana-CHI", "kana-TSU", "kana-TE",
4881 "kana-TO", "kana-NA", "kana-NI", "kana-NU",
4882 "kana-NE", "kana-NO", "kana-HA", "kana-HI",
4883 "kana-FU", "kana-HE", "kana-HO", "kana-MA",
4884 "kana-MI", "kana-MU", "kana-ME", "kana-MO",
4885 "kana-YA", "kana-YU", "kana-YO", "kana-RA",
4886 "kana-RI", "kana-RU", "kana-RE", "kana-RO",
4887 "kana-WA", "kana-N", "voicedsound", "semivoicedsound",
4888 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4e0 .. 0x4ef */
4889 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4f0 .. 0x4ff */
4891 #endif /* XK_kana_A */
4894 #define FUNCTION_KEY_OFFSET 0xff00
4896 /* You'll notice that this table is arranged to be conveniently
4897 indexed by X Windows keysym values. */
4898 static const char *const lispy_function_keys
[] =
4900 /* X Keysym value */
4902 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff00...0f */
4903 "backspace", "tab", "linefeed", "clear",
4905 0, 0, 0, "pause", /* 0xff10...1f */
4906 0, 0, 0, 0, 0, 0, 0, "escape",
4908 0, "kanji", "muhenkan", "henkan", /* 0xff20...2f */
4909 "romaji", "hiragana", "katakana", "hiragana-katakana",
4910 "zenkaku", "hankaku", "zenkaku-hankaku", "touroku",
4911 "massyo", "kana-lock", "kana-shift", "eisu-shift",
4912 "eisu-toggle", /* 0xff30...3f */
4913 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4914 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff40...4f */
4916 "home", "left", "up", "right", /* 0xff50 */ /* IsCursorKey */
4917 "down", "prior", "next", "end",
4918 "begin", 0, 0, 0, 0, 0, 0, 0,
4919 "select", /* 0xff60 */ /* IsMiscFunctionKey */
4930 "break", /* 0xff6b */
4933 0, 0, 0, 0, "backtab", 0, 0, 0, /* 0xff70... */
4934 0, 0, 0, 0, 0, 0, 0, "kp-numlock", /* 0xff78... */
4935 "kp-space", /* 0xff80 */ /* IsKeypadKey */
4936 0, 0, 0, 0, 0, 0, 0, 0,
4937 "kp-tab", /* 0xff89 */
4939 "kp-enter", /* 0xff8d */
4941 "kp-f1", /* 0xff91 */
4945 "kp-home", /* 0xff95 */
4950 "kp-prior", /* kp-page-up */
4951 "kp-next", /* kp-page-down */
4957 0, 0, 0, 0, 0, 0, 0, 0, 0,
4958 "kp-multiply", /* 0xffaa */
4963 "kp-divide", /* 0xffaf */
4964 "kp-0", /* 0xffb0 */
4965 "kp-1", "kp-2", "kp-3", "kp-4", "kp-5", "kp-6", "kp-7", "kp-8", "kp-9",
4968 "kp-equal", /* 0xffbd */
4969 "f1", /* 0xffbe */ /* IsFunctionKey */
4971 "f3", "f4", "f5", "f6", "f7", "f8", "f9", "f10", /* 0xffc0 */
4972 "f11", "f12", "f13", "f14", "f15", "f16", "f17", "f18",
4973 "f19", "f20", "f21", "f22", "f23", "f24", "f25", "f26", /* 0xffd0 */
4974 "f27", "f28", "f29", "f30", "f31", "f32", "f33", "f34",
4975 "f35", 0, 0, 0, 0, 0, 0, 0, /* 0xffe0 */
4976 0, 0, 0, 0, 0, 0, 0, 0,
4977 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfff0 */
4978 0, 0, 0, 0, 0, 0, 0, "delete"
4981 /* ISO 9995 Function and Modifier Keys; the first byte is 0xFE. */
4982 #define ISO_FUNCTION_KEY_OFFSET 0xfe00
4984 static const char *const iso_lispy_function_keys
[] =
4986 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe00 */
4987 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe08 */
4988 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe10 */
4989 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe18 */
4990 "iso-lefttab", /* 0xfe20 */
4991 "iso-move-line-up", "iso-move-line-down",
4992 "iso-partial-line-up", "iso-partial-line-down",
4993 "iso-partial-space-left", "iso-partial-space-right",
4994 "iso-set-margin-left", "iso-set-margin-right", /* 0xffe27, 28 */
4995 "iso-release-margin-left", "iso-release-margin-right",
4996 "iso-release-both-margins",
4997 "iso-fast-cursor-left", "iso-fast-cursor-right",
4998 "iso-fast-cursor-up", "iso-fast-cursor-down",
4999 "iso-continuous-underline", "iso-discontinuous-underline", /* 0xfe30, 31 */
5000 "iso-emphasize", "iso-center-object", "iso-enter", /* ... 0xfe34 */
5003 #endif /* not HAVE_NTGUI */
5005 static Lisp_Object Vlispy_mouse_stem
;
5007 static const char *const lispy_wheel_names
[] =
5009 "wheel-up", "wheel-down", "wheel-left", "wheel-right"
5012 /* drag-n-drop events are generated when a set of selected files are
5013 dragged from another application and dropped onto an Emacs window. */
5014 static const char *const lispy_drag_n_drop_names
[] =
5019 /* Scroll bar parts. */
5020 static Lisp_Object Qabove_handle
, Qhandle
, Qbelow_handle
;
5021 Lisp_Object Qup
, Qdown
, Qbottom
;
5022 static Lisp_Object Qend_scroll
;
5024 static Lisp_Object Qratio
;
5026 /* An array of scroll bar parts, indexed by an enum scroll_bar_part value. */
5027 static Lisp_Object
*const scroll_bar_parts
[] = {
5028 &Qabove_handle
, &Qhandle
, &Qbelow_handle
,
5029 &Qup
, &Qdown
, &Qtop
, &Qbottom
, &Qend_scroll
, &Qratio
5032 /* A vector, indexed by button number, giving the down-going location
5033 of currently depressed buttons, both scroll bar and non-scroll bar.
5035 The elements have the form
5036 (BUTTON-NUMBER MODIFIER-MASK . REST)
5037 where REST is the cdr of a position as it would be reported in the event.
5039 The make_lispy_event function stores positions here to tell the
5040 difference between click and drag events, and to store the starting
5041 location to be included in drag events. */
5043 static Lisp_Object button_down_location
;
5045 /* Information about the most recent up-going button event: Which
5046 button, what location, and what time. */
5048 static int last_mouse_button
;
5049 static int last_mouse_x
;
5050 static int last_mouse_y
;
5051 static Time button_down_time
;
5053 /* The number of clicks in this multiple-click. */
5055 static int double_click_count
;
5057 /* X and Y are frame-relative coordinates for a click or wheel event.
5058 Return a Lisp-style event list. */
5061 make_lispy_position (struct frame
*f
, Lisp_Object x
, Lisp_Object y
,
5064 enum window_part part
;
5065 Lisp_Object posn
= Qnil
;
5066 Lisp_Object extra_info
= Qnil
;
5067 /* Coordinate pixel positions to return. */
5068 int xret
= 0, yret
= 0;
5069 /* The window under frame pixel coordinates (x,y) */
5070 Lisp_Object window
= f
5071 ? window_from_coordinates (f
, XINT (x
), XINT (y
), &part
, 0)
5074 if (WINDOWP (window
))
5076 /* It's a click in window WINDOW at frame coordinates (X,Y) */
5077 struct window
*w
= XWINDOW (window
);
5078 Lisp_Object string_info
= Qnil
;
5079 ptrdiff_t textpos
= -1;
5080 int col
= -1, row
= -1;
5081 int dx
= -1, dy
= -1;
5082 int width
= -1, height
= -1;
5083 Lisp_Object object
= Qnil
;
5085 /* Pixel coordinates relative to the window corner. */
5086 int wx
= XINT (x
) - WINDOW_LEFT_EDGE_X (w
);
5087 int wy
= XINT (y
) - WINDOW_TOP_EDGE_Y (w
);
5089 /* For text area clicks, return X, Y relative to the corner of
5090 this text area. Note that dX, dY etc are set below, by
5091 buffer_posn_from_coords. */
5092 if (part
== ON_TEXT
)
5094 xret
= XINT (x
) - window_box_left (w
, TEXT_AREA
);
5095 yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5097 /* For mode line and header line clicks, return X, Y relative to
5098 the left window edge. Use mode_line_string to look for a
5099 string on the click position. */
5100 else if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
)
5105 posn
= (part
== ON_MODE_LINE
) ? Qmode_line
: Qheader_line
;
5106 /* Note that mode_line_string takes COL, ROW as pixels and
5107 converts them to characters. */
5110 string
= mode_line_string (w
, part
, &col
, &row
, &charpos
,
5111 &object
, &dx
, &dy
, &width
, &height
);
5112 if (STRINGP (string
))
5113 string_info
= Fcons (string
, make_number (charpos
));
5114 textpos
= (w
== XWINDOW (selected_window
)
5115 && current_buffer
== XBUFFER (w
->buffer
))
5116 ? PT
: XMARKER (w
->pointm
)->charpos
;
5121 /* For fringes and margins, Y is relative to the area's (and the
5122 window's) top edge, while X is meaningless. */
5123 else if (part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
5128 posn
= (part
== ON_LEFT_MARGIN
) ? Qleft_margin
: Qright_margin
;
5131 string
= marginal_area_string (w
, part
, &col
, &row
, &charpos
,
5132 &object
, &dx
, &dy
, &width
, &height
);
5133 if (STRINGP (string
))
5134 string_info
= Fcons (string
, make_number (charpos
));
5135 yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5137 else if (part
== ON_LEFT_FRINGE
)
5139 posn
= Qleft_fringe
;
5142 - (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5143 ? 0 : window_box_width (w
, LEFT_MARGIN_AREA
));
5144 dy
= yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5146 else if (part
== ON_RIGHT_FRINGE
)
5148 posn
= Qright_fringe
;
5151 - window_box_width (w
, LEFT_MARGIN_AREA
)
5152 - window_box_width (w
, TEXT_AREA
)
5153 - (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5154 ? window_box_width (w
, RIGHT_MARGIN_AREA
)
5156 dy
= yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5158 else if (part
== ON_VERTICAL_BORDER
)
5160 posn
= Qvertical_line
;
5165 /* Nothing special for part == ON_SCROLL_BAR. */
5167 /* For clicks in the text area, fringes, or margins, call
5168 buffer_posn_from_coords to extract TEXTPOS, the buffer
5169 position nearest to the click. */
5172 Lisp_Object string2
, object2
= Qnil
;
5173 struct display_pos p
;
5175 int width2
, height2
;
5176 /* The pixel X coordinate passed to buffer_posn_from_coords
5177 is the X coordinate relative to the text area for
5178 text-area and right-margin clicks, zero otherwise. */
5180 = (part
== ON_TEXT
) ? xret
5181 : (part
== ON_RIGHT_FRINGE
|| part
== ON_RIGHT_MARGIN
)
5182 ? (XINT (x
) - window_box_left (w
, TEXT_AREA
))
5186 string2
= buffer_posn_from_coords (w
, &x2
, &y2
, &p
,
5187 &object2
, &dx2
, &dy2
,
5189 textpos
= CHARPOS (p
.pos
);
5190 if (col
< 0) col
= x2
;
5191 if (row
< 0) row
= y2
;
5192 if (dx
< 0) dx
= dx2
;
5193 if (dy
< 0) dy
= dy2
;
5194 if (width
< 0) width
= width2
;
5195 if (height
< 0) height
= height2
;
5199 posn
= make_number (textpos
);
5200 if (STRINGP (string2
))
5201 string_info
= Fcons (string2
,
5202 make_number (CHARPOS (p
.string_pos
)));
5208 #ifdef HAVE_WINDOW_SYSTEM
5209 if (IMAGEP (object
))
5211 Lisp_Object image_map
, hotspot
;
5212 if ((image_map
= Fplist_get (XCDR (object
), QCmap
),
5214 && (hotspot
= find_hot_spot (image_map
, dx
, dy
),
5216 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
5217 posn
= XCAR (hotspot
);
5224 Fcons (make_number (dx
), make_number (dy
)),
5225 Fcons (make_number (width
), make_number (height
)));
5228 extra_info
= Fcons (string_info
,
5229 Fcons (make_number (textpos
),
5230 Fcons (Fcons (make_number (col
),
5235 XSETFRAME (window
, f
);
5239 return Fcons (window
,
5241 Fcons (Fcons (make_number (xret
),
5242 make_number (yret
)),
5243 Fcons (make_number (t
),
5247 /* Given a struct input_event, build the lisp event which represents
5248 it. If EVENT is 0, build a mouse movement event from the mouse
5249 movement buffer, which should have a movement event in it.
5251 Note that events must be passed to this function in the order they
5252 are received; this function stores the location of button presses
5253 in order to build drag events when the button is released. */
5256 make_lispy_event (struct input_event
*event
)
5260 switch (event
->kind
)
5262 /* A simple keystroke. */
5263 case ASCII_KEYSTROKE_EVENT
:
5264 case MULTIBYTE_CHAR_KEYSTROKE_EVENT
:
5266 Lisp_Object lispy_c
;
5267 EMACS_INT c
= event
->code
;
5268 if (event
->kind
== ASCII_KEYSTROKE_EVENT
)
5271 eassert (c
== event
->code
);
5272 /* Turn ASCII characters into control characters
5274 if (event
->modifiers
& ctrl_modifier
)
5276 c
= make_ctrl_char (c
);
5277 event
->modifiers
&= ~ctrl_modifier
;
5281 /* Add in the other modifier bits. The shift key was taken care
5282 of by the X code. */
5283 c
|= (event
->modifiers
5284 & (meta_modifier
| alt_modifier
5285 | hyper_modifier
| super_modifier
| ctrl_modifier
));
5286 /* Distinguish Shift-SPC from SPC. */
5287 if ((event
->code
) == 040
5288 && event
->modifiers
& shift_modifier
)
5289 c
|= shift_modifier
;
5290 button_down_time
= 0;
5291 XSETFASTINT (lispy_c
, c
);
5296 /* NS_NONKEY_EVENTs are just like NON_ASCII_KEYSTROKE_EVENTs,
5297 except that they are non-key events (last-nonmenu-event is nil). */
5298 case NS_NONKEY_EVENT
:
5301 /* A function key. The symbol may need to have modifier prefixes
5303 case NON_ASCII_KEYSTROKE_EVENT
:
5304 button_down_time
= 0;
5306 for (i
= 0; i
< sizeof (lispy_accent_codes
) / sizeof (int); i
++)
5307 if (event
->code
== lispy_accent_codes
[i
])
5308 return modify_event_symbol (i
,
5310 Qfunction_key
, Qnil
,
5311 lispy_accent_keys
, &accent_key_syms
,
5312 (sizeof (lispy_accent_keys
)
5313 / sizeof (lispy_accent_keys
[0])));
5317 if (event
->code
>= 0x400 && event
->code
< 0x500)
5318 return modify_event_symbol (event
->code
- 0x400,
5319 event
->modifiers
& ~shift_modifier
,
5320 Qfunction_key
, Qnil
,
5321 lispy_kana_keys
, &func_key_syms
,
5322 (sizeof (lispy_kana_keys
)
5323 / sizeof (lispy_kana_keys
[0])));
5324 #endif /* XK_kana_A */
5327 #ifdef ISO_FUNCTION_KEY_OFFSET
5328 if (event
->code
< FUNCTION_KEY_OFFSET
5329 && event
->code
>= ISO_FUNCTION_KEY_OFFSET
)
5330 return modify_event_symbol (event
->code
- ISO_FUNCTION_KEY_OFFSET
,
5332 Qfunction_key
, Qnil
,
5333 iso_lispy_function_keys
, &func_key_syms
,
5334 (sizeof (iso_lispy_function_keys
)
5335 / sizeof (iso_lispy_function_keys
[0])));
5338 /* Handle system-specific or unknown keysyms. */
5339 if (event
->code
& (1 << 28)
5340 || event
->code
- FUNCTION_KEY_OFFSET
< 0
5341 || (event
->code
- FUNCTION_KEY_OFFSET
5342 >= sizeof lispy_function_keys
/ sizeof *lispy_function_keys
)
5343 || !lispy_function_keys
[event
->code
- FUNCTION_KEY_OFFSET
])
5345 /* We need to use an alist rather than a vector as the cache
5346 since we can't make a vector long enough. */
5347 if (NILP (KVAR (current_kboard
, system_key_syms
)))
5348 kset_system_key_syms (current_kboard
, Fcons (Qnil
, Qnil
));
5349 return modify_event_symbol (event
->code
,
5352 KVAR (current_kboard
, Vsystem_key_alist
),
5353 0, &KVAR (current_kboard
, system_key_syms
),
5357 return modify_event_symbol (event
->code
- FUNCTION_KEY_OFFSET
,
5359 Qfunction_key
, Qnil
,
5360 lispy_function_keys
, &func_key_syms
,
5361 (sizeof (lispy_function_keys
)
5362 / sizeof (lispy_function_keys
[0])));
5365 case MULTIMEDIA_KEY_EVENT
:
5366 if (event
->code
< (sizeof (lispy_multimedia_keys
)
5367 / sizeof (lispy_multimedia_keys
[0]))
5368 && event
->code
> 0 && lispy_multimedia_keys
[event
->code
])
5370 return modify_event_symbol (event
->code
, event
->modifiers
,
5371 Qfunction_key
, Qnil
,
5372 lispy_multimedia_keys
, &func_key_syms
,
5373 (sizeof (lispy_multimedia_keys
)
5374 / sizeof (lispy_multimedia_keys
[0])));
5379 /* A mouse click. Figure out where it is, decide whether it's
5380 a press, click or drag, and build the appropriate structure. */
5381 case MOUSE_CLICK_EVENT
:
5382 #ifndef USE_TOOLKIT_SCROLL_BARS
5383 case SCROLL_BAR_CLICK_EVENT
:
5386 int button
= event
->code
;
5388 Lisp_Object position
;
5389 Lisp_Object
*start_pos_ptr
;
5390 Lisp_Object start_pos
;
5394 /* Build the position as appropriate for this mouse click. */
5395 if (event
->kind
== MOUSE_CLICK_EVENT
)
5397 struct frame
*f
= XFRAME (event
->frame_or_window
);
5398 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK) && ! defined (HAVE_NS)
5402 /* Ignore mouse events that were made on frame that
5403 have been deleted. */
5404 if (! FRAME_LIVE_P (f
))
5407 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK) && ! defined (HAVE_NS)
5408 /* EVENT->x and EVENT->y are frame-relative pixel
5409 coordinates at this place. Under old redisplay, COLUMN
5410 and ROW are set to frame relative glyph coordinates
5411 which are then used to determine whether this click is
5412 in a menu (non-toolkit version). */
5413 pixel_to_glyph_coords (f
, XINT (event
->x
), XINT (event
->y
),
5414 &column
, &row
, NULL
, 1);
5416 /* In the non-toolkit version, clicks on the menu bar
5417 are ordinary button events in the event buffer.
5418 Distinguish them, and invoke the menu.
5420 (In the toolkit version, the toolkit handles the menu bar
5421 and Emacs doesn't know about it until after the user
5422 makes a selection.) */
5423 if (row
>= 0 && row
< FRAME_MENU_BAR_LINES (f
)
5424 && (event
->modifiers
& down_modifier
))
5426 Lisp_Object items
, item
;
5428 /* Find the menu bar item under `column'. */
5430 items
= FRAME_MENU_BAR_ITEMS (f
);
5431 for (i
= 0; i
< ASIZE (items
); i
+= 4)
5433 Lisp_Object pos
, string
;
5434 string
= AREF (items
, i
+ 1);
5435 pos
= AREF (items
, i
+ 3);
5438 if (column
>= XINT (pos
)
5439 && column
< XINT (pos
) + SCHARS (string
))
5441 item
= AREF (items
, i
);
5446 /* ELisp manual 2.4b says (x y) are window relative but
5447 code says they are frame-relative. */
5449 = Fcons (event
->frame_or_window
,
5451 Fcons (Fcons (event
->x
, event
->y
),
5452 Fcons (make_number (event
->timestamp
),
5455 return Fcons (item
, Fcons (position
, Qnil
));
5457 #endif /* not USE_X_TOOLKIT && not USE_GTK && not HAVE_NS */
5459 position
= make_lispy_position (f
, event
->x
, event
->y
,
5462 #ifndef USE_TOOLKIT_SCROLL_BARS
5465 /* It's a scrollbar click. */
5467 Lisp_Object portion_whole
;
5470 window
= event
->frame_or_window
;
5471 portion_whole
= Fcons (event
->x
, event
->y
);
5472 part
= *scroll_bar_parts
[(int) event
->part
];
5476 Fcons (Qvertical_scroll_bar
,
5477 Fcons (portion_whole
,
5478 Fcons (make_number (event
->timestamp
),
5479 Fcons (part
, Qnil
)))));
5481 #endif /* not USE_TOOLKIT_SCROLL_BARS */
5483 if (button
>= ASIZE (button_down_location
))
5485 ptrdiff_t incr
= button
- ASIZE (button_down_location
) + 1;
5486 button_down_location
= larger_vector (button_down_location
,
5488 mouse_syms
= larger_vector (mouse_syms
, incr
, -1);
5491 start_pos_ptr
= aref_addr (button_down_location
, button
);
5492 start_pos
= *start_pos_ptr
;
5493 *start_pos_ptr
= Qnil
;
5496 /* On window-system frames, use the value of
5497 double-click-fuzz as is. On other frames, interpret it
5498 as a multiple of 1/8 characters. */
5502 if (WINDOWP (event
->frame_or_window
))
5503 f
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5504 else if (FRAMEP (event
->frame_or_window
))
5505 f
= XFRAME (event
->frame_or_window
);
5509 if (FRAME_WINDOW_P (f
))
5510 fuzz
= double_click_fuzz
;
5512 fuzz
= double_click_fuzz
/ 8;
5514 is_double
= (button
== last_mouse_button
5515 && (eabs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5516 && (eabs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5517 && button_down_time
!= 0
5518 && (EQ (Vdouble_click_time
, Qt
)
5519 || (NATNUMP (Vdouble_click_time
)
5520 && (event
->timestamp
- button_down_time
5521 < XFASTINT (Vdouble_click_time
)))));
5524 last_mouse_button
= button
;
5525 last_mouse_x
= XINT (event
->x
);
5526 last_mouse_y
= XINT (event
->y
);
5528 /* If this is a button press, squirrel away the location, so
5529 we can decide later whether it was a click or a drag. */
5530 if (event
->modifiers
& down_modifier
)
5534 double_click_count
++;
5535 event
->modifiers
|= ((double_click_count
> 2)
5540 double_click_count
= 1;
5541 button_down_time
= event
->timestamp
;
5542 *start_pos_ptr
= Fcopy_alist (position
);
5543 ignore_mouse_drag_p
= 0;
5546 /* Now we're releasing a button - check the co-ordinates to
5547 see if this was a click or a drag. */
5548 else if (event
->modifiers
& up_modifier
)
5550 /* If we did not see a down before this up, ignore the up.
5551 Probably this happened because the down event chose a
5552 menu item. It would be an annoyance to treat the
5553 release of the button that chose the menu item as a
5556 if (!CONSP (start_pos
))
5559 event
->modifiers
&= ~up_modifier
;
5562 Lisp_Object new_down
, down
;
5563 EMACS_INT xdiff
= double_click_fuzz
, ydiff
= double_click_fuzz
;
5565 /* The third element of every position
5566 should be the (x,y) pair. */
5567 down
= Fcar (Fcdr (Fcdr (start_pos
)));
5568 new_down
= Fcar (Fcdr (Fcdr (position
)));
5571 && INTEGERP (XCAR (down
)) && INTEGERP (XCDR (down
)))
5573 xdiff
= XINT (XCAR (new_down
)) - XINT (XCAR (down
));
5574 ydiff
= XINT (XCDR (new_down
)) - XINT (XCDR (down
));
5577 if (ignore_mouse_drag_p
)
5579 event
->modifiers
|= click_modifier
;
5580 ignore_mouse_drag_p
= 0;
5582 else if (xdiff
< double_click_fuzz
&& xdiff
> - double_click_fuzz
5583 && ydiff
< double_click_fuzz
&& ydiff
> - double_click_fuzz
5584 /* Maybe the mouse has moved a lot, caused scrolling, and
5585 eventually ended up at the same screen position (but
5586 not buffer position) in which case it is a drag, not
5588 /* FIXME: OTOH if the buffer position has changed
5589 because of a timer or process filter rather than
5590 because of mouse movement, it should be considered as
5591 a click. But mouse-drag-region completely ignores
5592 this case and it hasn't caused any real problem, so
5593 it's probably OK to ignore it as well. */
5594 && EQ (Fcar (Fcdr (start_pos
)), Fcar (Fcdr (position
))))
5595 /* Mouse hasn't moved (much). */
5596 event
->modifiers
|= click_modifier
;
5599 button_down_time
= 0;
5600 event
->modifiers
|= drag_modifier
;
5603 /* Don't check is_double; treat this as multiple
5604 if the down-event was multiple. */
5605 if (double_click_count
> 1)
5606 event
->modifiers
|= ((double_click_count
> 2)
5612 /* Every mouse event should either have the down_modifier or
5613 the up_modifier set. */
5617 /* Get the symbol we should use for the mouse click. */
5620 head
= modify_event_symbol (button
,
5622 Qmouse_click
, Vlispy_mouse_stem
,
5625 ASIZE (mouse_syms
));
5626 if (event
->modifiers
& drag_modifier
)
5631 else if (event
->modifiers
& (double_modifier
| triple_modifier
))
5634 Fcons (make_number (double_click_count
),
5644 case HORIZ_WHEEL_EVENT
:
5646 Lisp_Object position
;
5649 /* Build the position as appropriate for this mouse click. */
5650 struct frame
*f
= XFRAME (event
->frame_or_window
);
5652 /* Ignore wheel events that were made on frame that have been
5654 if (! FRAME_LIVE_P (f
))
5657 position
= make_lispy_position (f
, event
->x
, event
->y
,
5660 /* Set double or triple modifiers to indicate the wheel speed. */
5662 /* On window-system frames, use the value of
5663 double-click-fuzz as is. On other frames, interpret it
5664 as a multiple of 1/8 characters. */
5670 if (WINDOWP (event
->frame_or_window
))
5671 fr
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5672 else if (FRAMEP (event
->frame_or_window
))
5673 fr
= XFRAME (event
->frame_or_window
);
5677 fuzz
= FRAME_WINDOW_P (fr
)
5678 ? double_click_fuzz
: double_click_fuzz
/ 8;
5680 if (event
->modifiers
& up_modifier
)
5682 /* Emit a wheel-up event. */
5683 event
->modifiers
&= ~up_modifier
;
5686 else if (event
->modifiers
& down_modifier
)
5688 /* Emit a wheel-down event. */
5689 event
->modifiers
&= ~down_modifier
;
5693 /* Every wheel event should either have the down_modifier or
5694 the up_modifier set. */
5697 if (event
->kind
== HORIZ_WHEEL_EVENT
)
5700 is_double
= (last_mouse_button
== - (1 + symbol_num
)
5701 && (eabs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5702 && (eabs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5703 && button_down_time
!= 0
5704 && (EQ (Vdouble_click_time
, Qt
)
5705 || (NATNUMP (Vdouble_click_time
)
5706 && (event
->timestamp
- button_down_time
5707 < XFASTINT (Vdouble_click_time
)))));
5710 double_click_count
++;
5711 event
->modifiers
|= ((double_click_count
> 2)
5717 double_click_count
= 1;
5718 event
->modifiers
|= click_modifier
;
5721 button_down_time
= event
->timestamp
;
5722 /* Use a negative value to distinguish wheel from mouse button. */
5723 last_mouse_button
= - (1 + symbol_num
);
5724 last_mouse_x
= XINT (event
->x
);
5725 last_mouse_y
= XINT (event
->y
);
5727 /* Get the symbol we should use for the wheel event. */
5728 head
= modify_event_symbol (symbol_num
,
5734 ASIZE (wheel_syms
));
5737 if (event
->modifiers
& (double_modifier
| triple_modifier
))
5740 Fcons (make_number (double_click_count
),
5749 #ifdef USE_TOOLKIT_SCROLL_BARS
5751 /* We don't have down and up events if using toolkit scroll bars,
5752 so make this always a click event. Store in the `part' of
5753 the Lisp event a symbol which maps to the following actions:
5755 `above_handle' page up
5756 `below_handle' page down
5760 `bottom' bottom of buffer
5761 `handle' thumb has been dragged.
5762 `end-scroll' end of interaction with scroll bar
5764 The incoming input_event contains in its `part' member an
5765 index of type `enum scroll_bar_part' which we can use as an
5766 index in scroll_bar_parts to get the appropriate symbol. */
5768 case SCROLL_BAR_CLICK_EVENT
:
5770 Lisp_Object position
, head
, window
, portion_whole
, part
;
5772 window
= event
->frame_or_window
;
5773 portion_whole
= Fcons (event
->x
, event
->y
);
5774 part
= *scroll_bar_parts
[(int) event
->part
];
5778 Fcons (Qvertical_scroll_bar
,
5779 Fcons (portion_whole
,
5780 Fcons (make_number (event
->timestamp
),
5781 Fcons (part
, Qnil
)))));
5783 /* Always treat scroll bar events as clicks. */
5784 event
->modifiers
|= click_modifier
;
5785 event
->modifiers
&= ~up_modifier
;
5787 if (event
->code
>= ASIZE (mouse_syms
))
5788 mouse_syms
= larger_vector (mouse_syms
,
5789 event
->code
- ASIZE (mouse_syms
) + 1,
5792 /* Get the symbol we should use for the mouse click. */
5793 head
= modify_event_symbol (event
->code
,
5798 ASIZE (mouse_syms
));
5799 return Fcons (head
, Fcons (position
, Qnil
));
5802 #endif /* USE_TOOLKIT_SCROLL_BARS */
5804 case DRAG_N_DROP_EVENT
:
5807 Lisp_Object head
, position
;
5810 f
= XFRAME (event
->frame_or_window
);
5813 /* Ignore mouse events that were made on frames that
5814 have been deleted. */
5815 if (! FRAME_LIVE_P (f
))
5818 position
= make_lispy_position (f
, event
->x
, event
->y
,
5821 head
= modify_event_symbol (0, event
->modifiers
,
5823 lispy_drag_n_drop_names
,
5824 &drag_n_drop_syms
, 1);
5831 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
5832 || defined (HAVE_NS) || defined (USE_GTK)
5833 case MENU_BAR_EVENT
:
5834 if (EQ (event
->arg
, event
->frame_or_window
))
5835 /* This is the prefix key. We translate this to
5836 `(menu_bar)' because the code in keyboard.c for menu
5837 events, which we use, relies on this. */
5838 return Fcons (Qmenu_bar
, Qnil
);
5842 case SELECT_WINDOW_EVENT
:
5843 /* Make an event (select-window (WINDOW)). */
5844 return Fcons (Qselect_window
,
5845 Fcons (Fcons (event
->frame_or_window
, Qnil
),
5848 case TOOL_BAR_EVENT
:
5849 if (EQ (event
->arg
, event
->frame_or_window
))
5850 /* This is the prefix key. We translate this to
5851 `(tool_bar)' because the code in keyboard.c for tool bar
5852 events, which we use, relies on this. */
5853 return Fcons (Qtool_bar
, Qnil
);
5854 else if (SYMBOLP (event
->arg
))
5855 return apply_modifiers (event
->modifiers
, event
->arg
);
5858 case USER_SIGNAL_EVENT
:
5859 /* A user signal. */
5861 char *name
= find_user_signal_name (event
->code
);
5864 return intern (name
);
5867 case SAVE_SESSION_EVENT
:
5868 return Qsave_session
;
5873 return Fcons (Qdbus_event
, event
->arg
);
5875 #endif /* HAVE_DBUS */
5877 case CONFIG_CHANGED_EVENT
:
5878 return Fcons (Qconfig_changed_event
,
5880 Fcons (event
->frame_or_window
, Qnil
)));
5882 case GPM_CLICK_EVENT
:
5884 FRAME_PTR f
= XFRAME (event
->frame_or_window
);
5885 Lisp_Object head
, position
;
5886 Lisp_Object
*start_pos_ptr
;
5887 Lisp_Object start_pos
;
5888 int button
= event
->code
;
5890 if (button
>= ASIZE (button_down_location
))
5892 ptrdiff_t incr
= button
- ASIZE (button_down_location
) + 1;
5893 button_down_location
= larger_vector (button_down_location
,
5895 mouse_syms
= larger_vector (mouse_syms
, incr
, -1);
5898 start_pos_ptr
= aref_addr (button_down_location
, button
);
5899 start_pos
= *start_pos_ptr
;
5901 position
= make_lispy_position (f
, event
->x
, event
->y
,
5904 if (event
->modifiers
& down_modifier
)
5905 *start_pos_ptr
= Fcopy_alist (position
);
5906 else if (event
->modifiers
& (up_modifier
| drag_modifier
))
5908 if (!CONSP (start_pos
))
5910 event
->modifiers
&= ~up_modifier
;
5913 head
= modify_event_symbol (button
,
5915 Qmouse_click
, Vlispy_mouse_stem
,
5918 ASIZE (mouse_syms
));
5920 if (event
->modifiers
& drag_modifier
)
5925 else if (event
->modifiers
& double_modifier
)
5928 Fcons (make_number (2),
5930 else if (event
->modifiers
& triple_modifier
)
5933 Fcons (make_number (3),
5940 #endif /* HAVE_GPM */
5942 /* The 'kind' field of the event is something we don't recognize. */
5949 make_lispy_movement (FRAME_PTR frame
, Lisp_Object bar_window
, enum scroll_bar_part part
,
5950 Lisp_Object x
, Lisp_Object y
, Time t
)
5952 /* Is it a scroll bar movement? */
5953 if (frame
&& ! NILP (bar_window
))
5955 Lisp_Object part_sym
;
5957 part_sym
= *scroll_bar_parts
[(int) part
];
5958 return Fcons (Qscroll_bar_movement
,
5959 Fcons (list5 (bar_window
,
5960 Qvertical_scroll_bar
,
5966 /* Or is it an ordinary mouse movement? */
5969 Lisp_Object position
;
5970 position
= make_lispy_position (frame
, x
, y
, t
);
5971 return list2 (Qmouse_movement
, position
);
5975 /* Construct a switch frame event. */
5977 make_lispy_switch_frame (Lisp_Object frame
)
5979 return Fcons (Qswitch_frame
, Fcons (frame
, Qnil
));
5982 /* Manipulating modifiers. */
5984 /* Parse the name of SYMBOL, and return the set of modifiers it contains.
5986 If MODIFIER_END is non-zero, set *MODIFIER_END to the position in
5987 SYMBOL's name of the end of the modifiers; the string from this
5988 position is the unmodified symbol name.
5990 This doesn't use any caches. */
5993 parse_modifiers_uncached (Lisp_Object symbol
, ptrdiff_t *modifier_end
)
5999 CHECK_SYMBOL (symbol
);
6002 name
= SYMBOL_NAME (symbol
);
6004 for (i
= 0; i
< SBYTES (name
) - 1; )
6006 ptrdiff_t this_mod_end
= 0;
6009 /* See if the name continues with a modifier word.
6010 Check that the word appears, but don't check what follows it.
6011 Set this_mod and this_mod_end to record what we find. */
6013 switch (SREF (name
, i
))
6015 #define SINGLE_LETTER_MOD(BIT) \
6016 (this_mod_end = i + 1, this_mod = BIT)
6019 SINGLE_LETTER_MOD (alt_modifier
);
6023 SINGLE_LETTER_MOD (ctrl_modifier
);
6027 SINGLE_LETTER_MOD (hyper_modifier
);
6031 SINGLE_LETTER_MOD (meta_modifier
);
6035 SINGLE_LETTER_MOD (shift_modifier
);
6039 SINGLE_LETTER_MOD (super_modifier
);
6042 #undef SINGLE_LETTER_MOD
6044 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6045 if (i + LEN + 1 <= SBYTES (name) \
6046 && ! memcmp (SDATA (name) + i, NAME, LEN)) \
6048 this_mod_end = i + LEN; \
6053 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
6054 MULTI_LETTER_MOD (down_modifier
, "down", 4);
6055 MULTI_LETTER_MOD (double_modifier
, "double", 6);
6059 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
6061 #undef MULTI_LETTER_MOD
6065 /* If we found no modifier, stop looking for them. */
6066 if (this_mod_end
== 0)
6069 /* Check there is a dash after the modifier, so that it
6070 really is a modifier. */
6071 if (this_mod_end
>= SBYTES (name
)
6072 || SREF (name
, this_mod_end
) != '-')
6075 /* This modifier is real; look for another. */
6076 modifiers
|= this_mod
;
6077 i
= this_mod_end
+ 1;
6080 /* Should we include the `click' modifier? */
6081 if (! (modifiers
& (down_modifier
| drag_modifier
6082 | double_modifier
| triple_modifier
))
6083 && i
+ 7 == SBYTES (name
)
6084 && memcmp (SDATA (name
) + i
, "mouse-", 6) == 0
6085 && ('0' <= SREF (name
, i
+ 6) && SREF (name
, i
+ 6) <= '9'))
6086 modifiers
|= click_modifier
;
6088 if (! (modifiers
& (double_modifier
| triple_modifier
))
6089 && i
+ 6 < SBYTES (name
)
6090 && memcmp (SDATA (name
) + i
, "wheel-", 6) == 0)
6091 modifiers
|= click_modifier
;
6099 /* Return a symbol whose name is the modifier prefixes for MODIFIERS
6100 prepended to the string BASE[0..BASE_LEN-1].
6101 This doesn't use any caches. */
6103 apply_modifiers_uncached (int modifiers
, char *base
, int base_len
, int base_len_byte
)
6105 /* Since BASE could contain nulls, we can't use intern here; we have
6106 to use Fintern, which expects a genuine Lisp_String, and keeps a
6108 char new_mods
[sizeof "A-C-H-M-S-s-down-drag-double-triple-"];
6114 /* Only the event queue may use the `up' modifier; it should always
6115 be turned into a click or drag event before presented to lisp code. */
6116 if (modifiers
& up_modifier
)
6119 if (modifiers
& alt_modifier
) { *p
++ = 'A'; *p
++ = '-'; }
6120 if (modifiers
& ctrl_modifier
) { *p
++ = 'C'; *p
++ = '-'; }
6121 if (modifiers
& hyper_modifier
) { *p
++ = 'H'; *p
++ = '-'; }
6122 if (modifiers
& meta_modifier
) { *p
++ = 'M'; *p
++ = '-'; }
6123 if (modifiers
& shift_modifier
) { *p
++ = 'S'; *p
++ = '-'; }
6124 if (modifiers
& super_modifier
) { *p
++ = 's'; *p
++ = '-'; }
6125 if (modifiers
& double_modifier
) { strcpy (p
, "double-"); p
+= 7; }
6126 if (modifiers
& triple_modifier
) { strcpy (p
, "triple-"); p
+= 7; }
6127 if (modifiers
& down_modifier
) { strcpy (p
, "down-"); p
+= 5; }
6128 if (modifiers
& drag_modifier
) { strcpy (p
, "drag-"); p
+= 5; }
6129 /* The click modifier is denoted by the absence of other modifiers. */
6133 mod_len
= p
- new_mods
;
6137 Lisp_Object new_name
;
6139 new_name
= make_uninit_multibyte_string (mod_len
+ base_len
,
6140 mod_len
+ base_len_byte
);
6141 memcpy (SDATA (new_name
), new_mods
, mod_len
);
6142 memcpy (SDATA (new_name
) + mod_len
, base
, base_len_byte
);
6144 return Fintern (new_name
, Qnil
);
6149 static const char *const modifier_names
[] =
6151 "up", "down", "drag", "click", "double", "triple", 0, 0,
6152 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
6153 0, 0, "alt", "super", "hyper", "shift", "control", "meta"
6155 #define NUM_MOD_NAMES (sizeof (modifier_names) / sizeof (modifier_names[0]))
6157 static Lisp_Object modifier_symbols
;
6159 /* Return the list of modifier symbols corresponding to the mask MODIFIERS. */
6161 lispy_modifier_list (int modifiers
)
6163 Lisp_Object modifier_list
;
6166 modifier_list
= Qnil
;
6167 for (i
= 0; (1<<i
) <= modifiers
&& i
< NUM_MOD_NAMES
; i
++)
6168 if (modifiers
& (1<<i
))
6169 modifier_list
= Fcons (AREF (modifier_symbols
, i
),
6172 return modifier_list
;
6176 /* Parse the modifiers on SYMBOL, and return a list like (UNMODIFIED MASK),
6177 where UNMODIFIED is the unmodified form of SYMBOL,
6178 MASK is the set of modifiers present in SYMBOL's name.
6179 This is similar to parse_modifiers_uncached, but uses the cache in
6180 SYMBOL's Qevent_symbol_element_mask property, and maintains the
6181 Qevent_symbol_elements property. */
6183 #define KEY_TO_CHAR(k) (XINT (k) & ((1 << CHARACTERBITS) - 1))
6186 parse_modifiers (Lisp_Object symbol
)
6188 Lisp_Object elements
;
6190 if (INTEGERP (symbol
))
6191 return (Fcons (make_number (KEY_TO_CHAR (symbol
)),
6192 Fcons (make_number (XINT (symbol
) & CHAR_MODIFIER_MASK
),
6194 else if (!SYMBOLP (symbol
))
6197 elements
= Fget (symbol
, Qevent_symbol_element_mask
);
6198 if (CONSP (elements
))
6203 int modifiers
= parse_modifiers_uncached (symbol
, &end
);
6204 Lisp_Object unmodified
;
6207 unmodified
= Fintern (make_string (SSDATA (SYMBOL_NAME (symbol
)) + end
,
6208 SBYTES (SYMBOL_NAME (symbol
)) - end
),
6211 if (modifiers
& ~INTMASK
)
6213 XSETFASTINT (mask
, modifiers
);
6214 elements
= Fcons (unmodified
, Fcons (mask
, Qnil
));
6216 /* Cache the parsing results on SYMBOL. */
6217 Fput (symbol
, Qevent_symbol_element_mask
,
6219 Fput (symbol
, Qevent_symbol_elements
,
6220 Fcons (unmodified
, lispy_modifier_list (modifiers
)));
6222 /* Since we know that SYMBOL is modifiers applied to unmodified,
6223 it would be nice to put that in unmodified's cache.
6224 But we can't, since we're not sure that parse_modifiers is
6231 DEFUN ("internal-event-symbol-parse-modifiers", Fevent_symbol_parse_modifiers
,
6232 Sevent_symbol_parse_modifiers
, 1, 1, 0,
6233 doc
: /* Parse the event symbol. For internal use. */)
6234 (Lisp_Object symbol
)
6236 /* Fill the cache if needed. */
6237 parse_modifiers (symbol
);
6238 /* Ignore the result (which is stored on Qevent_symbol_element_mask)
6239 and use the Lispier representation stored on Qevent_symbol_elements
6241 return Fget (symbol
, Qevent_symbol_elements
);
6244 /* Apply the modifiers MODIFIERS to the symbol BASE.
6245 BASE must be unmodified.
6247 This is like apply_modifiers_uncached, but uses BASE's
6248 Qmodifier_cache property, if present. It also builds
6249 Qevent_symbol_elements properties, since it has that info anyway.
6251 apply_modifiers copies the value of BASE's Qevent_kind property to
6252 the modified symbol. */
6254 apply_modifiers (int modifiers
, Lisp_Object base
)
6256 Lisp_Object cache
, idx
, entry
, new_symbol
;
6258 /* Mask out upper bits. We don't know where this value's been. */
6259 modifiers
&= INTMASK
;
6261 if (INTEGERP (base
))
6262 return make_number (XINT (base
) | modifiers
);
6264 /* The click modifier never figures into cache indices. */
6265 cache
= Fget (base
, Qmodifier_cache
);
6266 XSETFASTINT (idx
, (modifiers
& ~click_modifier
));
6267 entry
= assq_no_quit (idx
, cache
);
6270 new_symbol
= XCDR (entry
);
6273 /* We have to create the symbol ourselves. */
6274 new_symbol
= apply_modifiers_uncached (modifiers
,
6275 SSDATA (SYMBOL_NAME (base
)),
6276 SCHARS (SYMBOL_NAME (base
)),
6277 SBYTES (SYMBOL_NAME (base
)));
6279 /* Add the new symbol to the base's cache. */
6280 entry
= Fcons (idx
, new_symbol
);
6281 Fput (base
, Qmodifier_cache
, Fcons (entry
, cache
));
6283 /* We have the parsing info now for free, so we could add it to
6285 XSETFASTINT (idx, modifiers);
6286 Fput (new_symbol, Qevent_symbol_element_mask,
6287 Fcons (base, Fcons (idx, Qnil)));
6288 Fput (new_symbol, Qevent_symbol_elements,
6289 Fcons (base, lispy_modifier_list (modifiers)));
6290 Sadly, this is only correct if `base' is indeed a base event,
6291 which is not necessarily the case. -stef */
6294 /* Make sure this symbol is of the same kind as BASE.
6296 You'd think we could just set this once and for all when we
6297 intern the symbol above, but reorder_modifiers may call us when
6298 BASE's property isn't set right; we can't assume that just
6299 because it has a Qmodifier_cache property it must have its
6300 Qevent_kind set right as well. */
6301 if (NILP (Fget (new_symbol
, Qevent_kind
)))
6305 kind
= Fget (base
, Qevent_kind
);
6307 Fput (new_symbol
, Qevent_kind
, kind
);
6314 /* Given a symbol whose name begins with modifiers ("C-", "M-", etc),
6315 return a symbol with the modifiers placed in the canonical order.
6316 Canonical order is alphabetical, except for down and drag, which
6317 always come last. The 'click' modifier is never written out.
6319 Fdefine_key calls this to make sure that (for example) C-M-foo
6320 and M-C-foo end up being equivalent in the keymap. */
6323 reorder_modifiers (Lisp_Object symbol
)
6325 /* It's hopefully okay to write the code this way, since everything
6326 will soon be in caches, and no consing will be done at all. */
6329 parsed
= parse_modifiers (symbol
);
6330 return apply_modifiers (XFASTINT (XCAR (XCDR (parsed
))),
6335 /* For handling events, we often want to produce a symbol whose name
6336 is a series of modifier key prefixes ("M-", "C-", etcetera) attached
6337 to some base, like the name of a function key or mouse button.
6338 modify_event_symbol produces symbols of this sort.
6340 NAME_TABLE should point to an array of strings, such that NAME_TABLE[i]
6341 is the name of the i'th symbol. TABLE_SIZE is the number of elements
6344 Alternatively, NAME_ALIST_OR_STEM is either an alist mapping codes
6345 into symbol names, or a string specifying a name stem used to
6346 construct a symbol name or the form `STEM-N', where N is the decimal
6347 representation of SYMBOL_NUM. NAME_ALIST_OR_STEM is used if it is
6348 non-nil; otherwise NAME_TABLE is used.
6350 SYMBOL_TABLE should be a pointer to a Lisp_Object whose value will
6351 persist between calls to modify_event_symbol that it can use to
6352 store a cache of the symbols it's generated for this NAME_TABLE
6353 before. The object stored there may be a vector or an alist.
6355 SYMBOL_NUM is the number of the base name we want from NAME_TABLE.
6357 MODIFIERS is a set of modifier bits (as given in struct input_events)
6358 whose prefixes should be applied to the symbol name.
6360 SYMBOL_KIND is the value to be placed in the event_kind property of
6361 the returned symbol.
6363 The symbols we create are supposed to have an
6364 `event-symbol-elements' property, which lists the modifiers present
6365 in the symbol's name. */
6368 modify_event_symbol (ptrdiff_t symbol_num
, int modifiers
, Lisp_Object symbol_kind
,
6369 Lisp_Object name_alist_or_stem
, const char *const *name_table
,
6370 Lisp_Object
*symbol_table
, ptrdiff_t table_size
)
6373 Lisp_Object symbol_int
;
6375 /* Get rid of the "vendor-specific" bit here. */
6376 XSETINT (symbol_int
, symbol_num
& 0xffffff);
6378 /* Is this a request for a valid symbol? */
6379 if (symbol_num
< 0 || symbol_num
>= table_size
)
6382 if (CONSP (*symbol_table
))
6383 value
= Fcdr (assq_no_quit (symbol_int
, *symbol_table
));
6385 /* If *symbol_table doesn't seem to be initialized properly, fix that.
6386 *symbol_table should be a lisp vector TABLE_SIZE elements long,
6387 where the Nth element is the symbol for NAME_TABLE[N], or nil if
6388 we've never used that symbol before. */
6391 if (! VECTORP (*symbol_table
)
6392 || ASIZE (*symbol_table
) != table_size
)
6396 XSETFASTINT (size
, table_size
);
6397 *symbol_table
= Fmake_vector (size
, Qnil
);
6400 value
= AREF (*symbol_table
, symbol_num
);
6403 /* Have we already used this symbol before? */
6406 /* No; let's create it. */
6407 if (CONSP (name_alist_or_stem
))
6408 value
= Fcdr_safe (Fassq (symbol_int
, name_alist_or_stem
));
6409 else if (STRINGP (name_alist_or_stem
))
6412 ptrdiff_t len
= (SBYTES (name_alist_or_stem
)
6413 + sizeof "-" + INT_STRLEN_BOUND (EMACS_INT
));
6415 buf
= SAFE_ALLOCA (len
);
6416 esprintf (buf
, "%s-%"pI
"d", SDATA (name_alist_or_stem
),
6417 XINT (symbol_int
) + 1);
6418 value
= intern (buf
);
6421 else if (name_table
!= 0 && name_table
[symbol_num
])
6422 value
= intern (name_table
[symbol_num
]);
6424 #ifdef HAVE_WINDOW_SYSTEM
6427 char *name
= x_get_keysym_name (symbol_num
);
6429 value
= intern (name
);
6435 char buf
[sizeof "key-" + INT_STRLEN_BOUND (EMACS_INT
)];
6436 sprintf (buf
, "key-%"pD
"d", symbol_num
);
6437 value
= intern (buf
);
6440 if (CONSP (*symbol_table
))
6441 *symbol_table
= Fcons (Fcons (symbol_int
, value
), *symbol_table
);
6443 ASET (*symbol_table
, symbol_num
, value
);
6445 /* Fill in the cache entries for this symbol; this also
6446 builds the Qevent_symbol_elements property, which the user
6448 apply_modifiers (modifiers
& click_modifier
, value
);
6449 Fput (value
, Qevent_kind
, symbol_kind
);
6452 /* Apply modifiers to that symbol. */
6453 return apply_modifiers (modifiers
, value
);
6456 /* Convert a list that represents an event type,
6457 such as (ctrl meta backspace), into the usual representation of that
6458 event type as a number or a symbol. */
6460 DEFUN ("event-convert-list", Fevent_convert_list
, Sevent_convert_list
, 1, 1, 0,
6461 doc
: /* Convert the event description list EVENT-DESC to an event type.
6462 EVENT-DESC should contain one base event type (a character or symbol)
6463 and zero or more modifier names (control, meta, hyper, super, shift, alt,
6464 drag, down, double or triple). The base must be last.
6465 The return value is an event type (a character or symbol) which
6466 has the same base event type and all the specified modifiers. */)
6467 (Lisp_Object event_desc
)
6475 while (CONSP (rest
))
6483 /* Given a symbol, see if it is a modifier name. */
6484 if (SYMBOLP (elt
) && CONSP (rest
))
6485 this = parse_solitary_modifier (elt
);
6489 else if (!NILP (base
))
6490 error ("Two bases given in one event");
6496 /* Let the symbol A refer to the character A. */
6497 if (SYMBOLP (base
) && SCHARS (SYMBOL_NAME (base
)) == 1)
6498 XSETINT (base
, SREF (SYMBOL_NAME (base
), 0));
6500 if (INTEGERP (base
))
6502 /* Turn (shift a) into A. */
6503 if ((modifiers
& shift_modifier
) != 0
6504 && (XINT (base
) >= 'a' && XINT (base
) <= 'z'))
6506 XSETINT (base
, XINT (base
) - ('a' - 'A'));
6507 modifiers
&= ~shift_modifier
;
6510 /* Turn (control a) into C-a. */
6511 if (modifiers
& ctrl_modifier
)
6512 return make_number ((modifiers
& ~ctrl_modifier
)
6513 | make_ctrl_char (XINT (base
)));
6515 return make_number (modifiers
| XINT (base
));
6517 else if (SYMBOLP (base
))
6518 return apply_modifiers (modifiers
, base
);
6521 error ("Invalid base event");
6526 /* Try to recognize SYMBOL as a modifier name.
6527 Return the modifier flag bit, or 0 if not recognized. */
6530 parse_solitary_modifier (Lisp_Object symbol
)
6532 Lisp_Object name
= SYMBOL_NAME (symbol
);
6534 switch (SREF (name
, 0))
6536 #define SINGLE_LETTER_MOD(BIT) \
6537 if (SBYTES (name) == 1) \
6540 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6541 if (LEN == SBYTES (name) \
6542 && ! memcmp (SDATA (name), NAME, LEN)) \
6546 SINGLE_LETTER_MOD (alt_modifier
);
6550 MULTI_LETTER_MOD (alt_modifier
, "alt", 3);
6554 SINGLE_LETTER_MOD (ctrl_modifier
);
6558 MULTI_LETTER_MOD (ctrl_modifier
, "ctrl", 4);
6559 MULTI_LETTER_MOD (ctrl_modifier
, "control", 7);
6563 SINGLE_LETTER_MOD (hyper_modifier
);
6567 MULTI_LETTER_MOD (hyper_modifier
, "hyper", 5);
6571 SINGLE_LETTER_MOD (meta_modifier
);
6575 MULTI_LETTER_MOD (meta_modifier
, "meta", 4);
6579 SINGLE_LETTER_MOD (shift_modifier
);
6583 MULTI_LETTER_MOD (shift_modifier
, "shift", 5);
6584 MULTI_LETTER_MOD (super_modifier
, "super", 5);
6585 SINGLE_LETTER_MOD (super_modifier
);
6589 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
6590 MULTI_LETTER_MOD (down_modifier
, "down", 4);
6591 MULTI_LETTER_MOD (double_modifier
, "double", 6);
6595 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
6598 #undef SINGLE_LETTER_MOD
6599 #undef MULTI_LETTER_MOD
6605 /* Return true if EVENT is a list whose elements are all integers or symbols.
6606 Such a list is not valid as an event,
6607 but it can be a Lucid-style event type list. */
6610 lucid_event_type_list_p (Lisp_Object object
)
6614 if (! CONSP (object
))
6617 if (EQ (XCAR (object
), Qhelp_echo
)
6618 || EQ (XCAR (object
), Qvertical_line
)
6619 || EQ (XCAR (object
), Qmode_line
)
6620 || EQ (XCAR (object
), Qheader_line
))
6623 for (tail
= object
; CONSP (tail
); tail
= XCDR (tail
))
6627 if (! (INTEGERP (elt
) || SYMBOLP (elt
)))
6634 /* Return true if terminal input chars are available.
6635 Also, store the return value into INPUT_PENDING.
6637 Serves the purpose of ioctl (0, FIONREAD, ...)
6638 but works even if FIONREAD does not exist.
6639 (In fact, this may actually read some input.)
6641 If READABLE_EVENTS_DO_TIMERS_NOW is set in FLAGS, actually run
6642 timer events that are ripe.
6643 If READABLE_EVENTS_FILTER_EVENTS is set in FLAGS, ignore internal
6644 events (FOCUS_IN_EVENT).
6645 If READABLE_EVENTS_IGNORE_SQUEEZABLES is set in FLAGS, ignore mouse
6646 movements and toolkit scroll bar thumb drags. */
6649 get_input_pending (int flags
)
6651 /* First of all, have we already counted some input? */
6652 input_pending
= (!NILP (Vquit_flag
) || readable_events (flags
));
6654 /* If input is being read as it arrives, and we have none, there is none. */
6655 if (!input_pending
&& (!interrupt_input
|| interrupts_deferred
))
6657 /* Try to read some input and see how much we get. */
6659 input_pending
= (!NILP (Vquit_flag
) || readable_events (flags
));
6662 return input_pending
;
6665 /* Put a BUFFER_SWITCH_EVENT in the buffer
6666 so that read_key_sequence will notice the new current buffer. */
6669 record_asynch_buffer_change (void)
6671 struct input_event event
;
6675 event
.kind
= BUFFER_SWITCH_EVENT
;
6676 event
.frame_or_window
= Qnil
;
6679 /* We don't need a buffer-switch event unless Emacs is waiting for input.
6680 The purpose of the event is to make read_key_sequence look up the
6681 keymaps again. If we aren't in read_key_sequence, we don't need one,
6682 and the event could cause trouble by messing up (input-pending-p).
6683 Note: Fwaiting_for_user_input_p always returns nil when async
6684 subprocesses aren't supported. */
6685 tem
= Fwaiting_for_user_input_p ();
6689 /* Make sure no interrupt happens while storing the event. */
6691 if (interrupt_input
)
6692 kbd_buffer_store_event (&event
);
6697 kbd_buffer_store_event (&event
);
6702 /* Read any terminal input already buffered up by the system
6703 into the kbd_buffer, but do not wait.
6705 Return the number of keyboard chars read, or -1 meaning
6706 this is a bad time to try to read input. */
6715 /* Store pending user signal events, if any. */
6716 store_user_signal_events ();
6718 /* Loop through the available terminals, and call their input hooks. */
6722 struct terminal
*next
= t
->next_terminal
;
6724 if (t
->read_socket_hook
)
6727 struct input_event hold_quit
;
6729 if (input_blocked_p ())
6731 pending_signals
= 1;
6735 EVENT_INIT (hold_quit
);
6736 hold_quit
.kind
= NO_EVENT
;
6738 /* No need for FIONREAD or fcntl; just say don't wait. */
6739 while (0 < (nr
= (*t
->read_socket_hook
) (t
, &hold_quit
)))
6742 if (nr
== -1) /* Not OK to read input now. */
6746 else if (nr
== -2) /* Non-transient error. */
6748 /* The terminal device terminated; it should be closed. */
6750 /* Kill Emacs if this was our last terminal. */
6751 if (!terminal_list
->next_terminal
)
6752 /* Formerly simply reported no input, but that
6753 sometimes led to a failure of Emacs to terminate.
6754 SIGHUP seems appropriate if we can't reach the
6756 /* ??? Is it really right to send the signal just to
6757 this process rather than to the whole process
6758 group? Perhaps on systems with FIONREAD Emacs is
6759 alone in its group. */
6760 terminate_due_to_signal (SIGHUP
, 10);
6762 /* XXX Is calling delete_terminal safe here? It calls delete_frame. */
6765 XSETTERMINAL (tmp
, t
);
6766 Fdelete_terminal (tmp
, Qnoelisp
);
6770 if (hold_quit
.kind
!= NO_EVENT
)
6771 kbd_buffer_store_event (&hold_quit
);
6780 frame_make_pointer_visible ();
6786 decode_keyboard_code (struct tty_display_info
*tty
,
6787 struct coding_system
*coding
,
6788 unsigned char *buf
, int nbytes
)
6790 unsigned char *src
= buf
;
6791 const unsigned char *p
;
6796 if (tty
->meta_key
!= 2)
6797 for (i
= 0; i
< nbytes
; i
++)
6799 if (coding
->carryover_bytes
> 0)
6801 src
= alloca (coding
->carryover_bytes
+ nbytes
);
6802 memcpy (src
, coding
->carryover
, coding
->carryover_bytes
);
6803 memcpy (src
+ coding
->carryover_bytes
, buf
, nbytes
);
6804 nbytes
+= coding
->carryover_bytes
;
6806 coding
->destination
= alloca (nbytes
* 4);
6807 coding
->dst_bytes
= nbytes
* 4;
6808 decode_coding_c_string (coding
, src
, nbytes
, Qnil
);
6809 if (coding
->produced_char
== 0)
6811 for (i
= 0, p
= coding
->destination
; i
< coding
->produced_char
; i
++)
6813 struct input_event event_buf
;
6815 EVENT_INIT (event_buf
);
6816 event_buf
.code
= STRING_CHAR_ADVANCE (p
);
6818 (ASCII_CHAR_P (event_buf
.code
)
6819 ? ASCII_KEYSTROKE_EVENT
: MULTIBYTE_CHAR_KEYSTROKE_EVENT
);
6820 /* See the comment in tty_read_avail_input. */
6821 event_buf
.frame_or_window
= tty
->top_frame
;
6822 event_buf
.arg
= Qnil
;
6823 kbd_buffer_store_event (&event_buf
);
6827 /* This is the tty way of reading available input.
6829 Note that each terminal device has its own `struct terminal' object,
6830 and so this function is called once for each individual termcap
6831 terminal. The first parameter indicates which terminal to read from. */
6834 tty_read_avail_input (struct terminal
*terminal
,
6835 struct input_event
*hold_quit
)
6837 /* Using KBD_BUFFER_SIZE - 1 here avoids reading more than
6838 the kbd_buffer can really hold. That may prevent loss
6839 of characters on some systems when input is stuffed at us. */
6840 unsigned char cbuf
[KBD_BUFFER_SIZE
- 1];
6842 struct tty_display_info
*tty
= terminal
->display_info
.tty
;
6845 int buffer_free
= KBD_BUFFER_SIZE
- kbd_buffer_nr_stored () - 1;
6847 if (kbd_on_hold_p () || buffer_free
<= 0)
6849 #endif /* subprocesses */
6851 if (!terminal
->name
) /* Don't read from a dead terminal. */
6854 if (terminal
->type
!= output_termcap
6855 && terminal
->type
!= output_msdos_raw
)
6858 /* XXX I think the following code should be moved to separate hook
6859 functions in system-dependent files. */
6862 #else /* not WINDOWSNT */
6863 if (! tty
->term_initted
) /* In case we get called during bootstrap. */
6867 return 0; /* The terminal is suspended. */
6870 n_to_read
= dos_keysns ();
6874 cbuf
[0] = dos_keyread ();
6877 #else /* not MSDOS */
6882 struct input_event gpm_hold_quit
;
6883 int gpm
, fd
= gpm_fd
;
6885 EVENT_INIT (gpm_hold_quit
);
6886 gpm_hold_quit
.kind
= NO_EVENT
;
6888 /* gpm==1 if event received.
6889 gpm==0 if the GPM daemon has closed the connection, in which case
6890 Gpm_GetEvent closes gpm_fd and clears it to -1, which is why
6891 we save it in `fd' so close_gpm can remove it from the
6893 gpm==-1 if a protocol error or EWOULDBLOCK; the latter is normal. */
6894 while (gpm
= Gpm_GetEvent (&event
), gpm
== 1) {
6895 nread
+= handle_one_term_event (tty
, &event
, &gpm_hold_quit
);
6898 /* Presumably the GPM daemon has closed the connection. */
6900 if (gpm_hold_quit
.kind
!= NO_EVENT
)
6901 kbd_buffer_store_event (&gpm_hold_quit
);
6905 #endif /* HAVE_GPM */
6907 /* Determine how many characters we should *try* to read. */
6908 #ifdef USABLE_FIONREAD
6909 /* Find out how much input is available. */
6910 if (ioctl (fileno (tty
->input
), FIONREAD
, &n_to_read
) < 0)
6912 if (! noninteractive
)
6913 return -2; /* Close this terminal. */
6919 if (n_to_read
> sizeof cbuf
)
6920 n_to_read
= sizeof cbuf
;
6921 #elif defined USG || defined CYGWIN
6922 /* Read some input if available, but don't wait. */
6923 n_to_read
= sizeof cbuf
;
6924 fcntl (fileno (tty
->input
), F_SETFL
, O_NONBLOCK
);
6926 # error "Cannot read without possibly delaying"
6930 /* Don't read more than we can store. */
6931 if (n_to_read
> buffer_free
)
6932 n_to_read
= buffer_free
;
6933 #endif /* subprocesses */
6935 /* Now read; for one reason or another, this will not block.
6936 NREAD is set to the number of chars read. */
6939 nread
= emacs_read (fileno (tty
->input
), (char *) cbuf
, n_to_read
);
6940 /* POSIX infers that processes which are not in the session leader's
6941 process group won't get SIGHUP's at logout time. BSDI adheres to
6942 this part standard and returns -1 from read (0) with errno==EIO
6943 when the control tty is taken away.
6944 Jeffrey Honig <jch@bsdi.com> says this is generally safe. */
6945 if (nread
== -1 && errno
== EIO
)
6946 return -2; /* Close this terminal. */
6947 #if defined (AIX) && defined (_BSD)
6948 /* The kernel sometimes fails to deliver SIGHUP for ptys.
6949 This looks incorrect, but it isn't, because _BSD causes
6950 O_NDELAY to be defined in fcntl.h as O_NONBLOCK,
6951 and that causes a value other than 0 when there is no input. */
6953 return -2; /* Close this terminal. */
6957 /* We used to retry the read if it was interrupted.
6958 But this does the wrong thing when O_NONBLOCK causes
6959 an EAGAIN error. Does anybody know of a situation
6960 where a retry is actually needed? */
6962 nread
< 0 && (errno
== EAGAIN
|| errno
== EFAULT
6972 #ifndef USABLE_FIONREAD
6973 #if defined (USG) || defined (CYGWIN)
6974 fcntl (fileno (tty
->input
), F_SETFL
, 0);
6975 #endif /* USG or CYGWIN */
6976 #endif /* no FIONREAD */
6981 #endif /* not MSDOS */
6982 #endif /* not WINDOWSNT */
6984 if (TERMINAL_KEYBOARD_CODING (terminal
)->common_flags
6985 & CODING_REQUIRE_DECODING_MASK
)
6987 struct coding_system
*coding
= TERMINAL_KEYBOARD_CODING (terminal
);
6990 /* Decode the key sequence except for those with meta
6992 for (i
= from
= 0; ; i
++)
6993 if (i
== nread
|| (tty
->meta_key
== 1 && (cbuf
[i
] & 0x80)))
6995 struct input_event buf
;
6997 decode_keyboard_code (tty
, coding
, cbuf
+ from
, i
- from
);
7002 buf
.kind
= ASCII_KEYSTROKE_EVENT
;
7003 buf
.modifiers
= meta_modifier
;
7004 buf
.code
= cbuf
[i
] & ~0x80;
7005 /* See the comment below. */
7006 buf
.frame_or_window
= tty
->top_frame
;
7008 kbd_buffer_store_event (&buf
);
7014 for (i
= 0; i
< nread
; i
++)
7016 struct input_event buf
;
7018 buf
.kind
= ASCII_KEYSTROKE_EVENT
;
7020 if (tty
->meta_key
== 1 && (cbuf
[i
] & 0x80))
7021 buf
.modifiers
= meta_modifier
;
7022 if (tty
->meta_key
!= 2)
7026 /* Set the frame corresponding to the active tty. Note that the
7027 value of selected_frame is not reliable here, redisplay tends
7028 to temporarily change it. */
7029 buf
.frame_or_window
= tty
->top_frame
;
7032 kbd_buffer_store_event (&buf
);
7033 /* Don't look at input that follows a C-g too closely.
7034 This reduces lossage due to autorepeat on C-g. */
7035 if (buf
.kind
== ASCII_KEYSTROKE_EVENT
7036 && buf
.code
== quit_char
)
7044 handle_async_input (void)
7049 int nread
= gobble_input ();
7050 /* -1 means it's not ok to read the input now.
7051 UNBLOCK_INPUT will read it later; now, avoid infinite loop.
7052 0 means there was no keyboard input available. */
7060 process_pending_signals (void)
7062 pending_signals
= 0;
7063 handle_async_input ();
7064 do_pending_atimers ();
7067 /* Undo any number of BLOCK_INPUT calls down to level LEVEL,
7068 and also (if the level is now 0) reinvoke any pending signal. */
7071 unblock_input_to (int level
)
7073 interrupt_input_blocked
= level
;
7076 if (pending_signals
)
7077 process_pending_signals ();
7083 /* End critical section.
7085 If doing signal-driven input, and a signal came in when input was
7086 blocked, reinvoke the signal handler now to deal with it. */
7089 unblock_input (void)
7091 unblock_input_to (interrupt_input_blocked
- 1);
7094 /* Undo any number of BLOCK_INPUT calls,
7095 and also reinvoke any pending signal. */
7098 totally_unblock_input (void)
7100 unblock_input_to (0);
7106 handle_input_available_signal (int sig
)
7108 pending_signals
= 1;
7110 if (input_available_clear_time
)
7111 *input_available_clear_time
= make_emacs_time (0, 0);
7115 deliver_input_available_signal (int sig
)
7117 deliver_process_signal (sig
, handle_input_available_signal
);
7119 #endif /* USABLE_SIGIO */
7122 /* User signal events. */
7124 struct user_signal_info
7126 /* Signal number. */
7129 /* Name of the signal. */
7132 /* Number of pending signals. */
7135 struct user_signal_info
*next
;
7138 /* List of user signals. */
7139 static struct user_signal_info
*user_signals
= NULL
;
7142 add_user_signal (int sig
, const char *name
)
7144 struct sigaction action
;
7145 struct user_signal_info
*p
;
7147 for (p
= user_signals
; p
; p
= p
->next
)
7149 /* Already added. */
7152 p
= xmalloc (sizeof *p
);
7154 p
->name
= xstrdup (name
);
7156 p
->next
= user_signals
;
7159 emacs_sigaction_init (&action
, deliver_user_signal
);
7160 sigaction (sig
, &action
, 0);
7164 handle_user_signal (int sig
)
7166 struct user_signal_info
*p
;
7167 const char *special_event_name
= NULL
;
7169 if (SYMBOLP (Vdebug_on_event
))
7170 special_event_name
= SSDATA (SYMBOL_NAME (Vdebug_on_event
));
7172 for (p
= user_signals
; p
; p
= p
->next
)
7175 if (special_event_name
7176 && strcmp (special_event_name
, p
->name
) == 0)
7178 /* Enter the debugger in many ways. */
7179 debug_on_next_call
= 1;
7182 Vinhibit_quit
= Qnil
;
7184 /* Eat the event. */
7190 if (interrupt_input
)
7191 handle_input_available_signal (sig
);
7195 /* Tell wait_reading_process_output that it needs to wake
7196 up and look around. */
7197 if (input_available_clear_time
)
7198 *input_available_clear_time
= make_emacs_time (0, 0);
7205 deliver_user_signal (int sig
)
7207 deliver_process_signal (sig
, handle_user_signal
);
7211 find_user_signal_name (int sig
)
7213 struct user_signal_info
*p
;
7215 for (p
= user_signals
; p
; p
= p
->next
)
7223 store_user_signal_events (void)
7225 struct user_signal_info
*p
;
7226 struct input_event buf
;
7227 bool buf_initialized
= 0;
7229 for (p
= user_signals
; p
; p
= p
->next
)
7230 if (p
->npending
> 0)
7232 if (! buf_initialized
)
7234 memset (&buf
, 0, sizeof buf
);
7235 buf
.kind
= USER_SIGNAL_EVENT
;
7236 buf
.frame_or_window
= selected_frame
;
7237 buf_initialized
= 1;
7243 kbd_buffer_store_event (&buf
);
7246 while (p
->npending
> 0);
7251 static void menu_bar_item (Lisp_Object
, Lisp_Object
, Lisp_Object
, void*);
7252 static Lisp_Object menu_bar_one_keymap_changed_items
;
7254 /* These variables hold the vector under construction within
7255 menu_bar_items and its subroutines, and the current index
7256 for storing into that vector. */
7257 static Lisp_Object menu_bar_items_vector
;
7258 static int menu_bar_items_index
;
7261 static const char* separator_names
[] = {
7266 "single-dashed-line",
7267 "double-dashed-line",
7269 "shadow-etched-out",
7270 "shadow-etched-in-dash",
7271 "shadow-etched-out-dash",
7272 "shadow-double-etched-in",
7273 "shadow-double-etched-out",
7274 "shadow-double-etched-in-dash",
7275 "shadow-double-etched-out-dash",
7279 /* Return true if LABEL specifies a separator. */
7282 menu_separator_name_p (const char *label
)
7286 else if (strlen (label
) > 3
7287 && memcmp (label
, "--", 2) == 0
7292 for (i
= 0; separator_names
[i
]; ++i
)
7293 if (strcmp (label
, separator_names
[i
]) == 0)
7298 /* It's a separator if it contains only dashes. */
7299 while (*label
== '-')
7301 return (*label
== 0);
7308 /* Return a vector of menu items for a menu bar, appropriate
7309 to the current buffer. Each item has three elements in the vector:
7312 OLD is an old vector we can optionally reuse, or nil. */
7315 menu_bar_items (Lisp_Object old
)
7317 /* The number of keymaps we're scanning right now, and the number of
7318 keymaps we have allocated space for. */
7321 /* maps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
7322 in the current keymaps, or nil where it is not a prefix. */
7325 Lisp_Object def
, tail
;
7330 /* In order to build the menus, we need to call the keymap
7331 accessors. They all call QUIT. But this function is called
7332 during redisplay, during which a quit is fatal. So inhibit
7333 quitting while building the menus.
7334 We do this instead of specbind because (1) errors will clear it anyway
7335 and (2) this avoids risk of specpdl overflow. */
7336 oquit
= Vinhibit_quit
;
7340 menu_bar_items_vector
= old
;
7342 menu_bar_items_vector
= Fmake_vector (make_number (24), Qnil
);
7343 menu_bar_items_index
= 0;
7345 /* Build our list of keymaps.
7346 If we recognize a function key and replace its escape sequence in
7347 keybuf with its symbol, or if the sequence starts with a mouse
7348 click and we need to switch buffers, we jump back here to rebuild
7349 the initial keymaps from the current buffer. */
7353 /* Should overriding-terminal-local-map and overriding-local-map apply? */
7354 if (!NILP (Voverriding_local_map_menu_flag
))
7356 /* Yes, use them (if non-nil) as well as the global map. */
7357 maps
= alloca (3 * sizeof (maps
[0]));
7359 if (!NILP (KVAR (current_kboard
, Voverriding_terminal_local_map
)))
7360 maps
[nmaps
++] = KVAR (current_kboard
, Voverriding_terminal_local_map
);
7361 if (!NILP (Voverriding_local_map
))
7362 maps
[nmaps
++] = Voverriding_local_map
;
7366 /* No, so use major and minor mode keymaps and keymap property.
7367 Note that menu-bar bindings in the local-map and keymap
7368 properties may not work reliable, as they are only
7369 recognized when the menu-bar (or mode-line) is updated,
7370 which does not normally happen after every command. */
7373 nminor
= current_minor_maps (NULL
, &tmaps
);
7374 maps
= alloca ((nminor
+ 3) * sizeof *maps
);
7376 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
7377 maps
[nmaps
++] = tem
;
7378 memcpy (maps
+ nmaps
, tmaps
, nminor
* sizeof (maps
[0]));
7380 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
7382 maps
[nmaps
++] = current_global_map
;
7385 /* Look up in each map the dummy prefix key `menu-bar'. */
7387 for (mapno
= nmaps
- 1; mapno
>= 0; mapno
--)
7388 if (!NILP (maps
[mapno
]))
7390 def
= get_keymap (access_keymap (maps
[mapno
], Qmenu_bar
, 1, 0, 1),
7394 menu_bar_one_keymap_changed_items
= Qnil
;
7395 map_keymap_canonical (def
, menu_bar_item
, Qnil
, NULL
);
7399 /* Move to the end those items that should be at the end. */
7401 for (tail
= Vmenu_bar_final_items
; CONSP (tail
); tail
= XCDR (tail
))
7404 int end
= menu_bar_items_index
;
7406 for (i
= 0; i
< end
; i
+= 4)
7407 if (EQ (XCAR (tail
), AREF (menu_bar_items_vector
, i
)))
7409 Lisp_Object tem0
, tem1
, tem2
, tem3
;
7410 /* Move the item at index I to the end,
7411 shifting all the others forward. */
7412 tem0
= AREF (menu_bar_items_vector
, i
+ 0);
7413 tem1
= AREF (menu_bar_items_vector
, i
+ 1);
7414 tem2
= AREF (menu_bar_items_vector
, i
+ 2);
7415 tem3
= AREF (menu_bar_items_vector
, i
+ 3);
7417 memmove (aref_addr (menu_bar_items_vector
, i
),
7418 aref_addr (menu_bar_items_vector
, i
+ 4),
7419 (end
- i
- 4) * word_size
);
7420 ASET (menu_bar_items_vector
, end
- 4, tem0
);
7421 ASET (menu_bar_items_vector
, end
- 3, tem1
);
7422 ASET (menu_bar_items_vector
, end
- 2, tem2
);
7423 ASET (menu_bar_items_vector
, end
- 1, tem3
);
7428 /* Add nil, nil, nil, nil at the end. */
7430 int i
= menu_bar_items_index
;
7431 if (i
+ 4 > ASIZE (menu_bar_items_vector
))
7432 menu_bar_items_vector
=
7433 larger_vector (menu_bar_items_vector
, 4, -1);
7434 /* Add this item. */
7435 ASET (menu_bar_items_vector
, i
, Qnil
); i
++;
7436 ASET (menu_bar_items_vector
, i
, Qnil
); i
++;
7437 ASET (menu_bar_items_vector
, i
, Qnil
); i
++;
7438 ASET (menu_bar_items_vector
, i
, Qnil
); i
++;
7439 menu_bar_items_index
= i
;
7442 Vinhibit_quit
= oquit
;
7443 return menu_bar_items_vector
;
7446 /* Add one item to menu_bar_items_vector, for KEY, ITEM_STRING and DEF.
7447 If there's already an item for KEY, add this DEF to it. */
7449 Lisp_Object item_properties
;
7452 menu_bar_item (Lisp_Object key
, Lisp_Object item
, Lisp_Object dummy1
, void *dummy2
)
7454 struct gcpro gcpro1
;
7459 if (EQ (item
, Qundefined
))
7461 /* If a map has an explicit `undefined' as definition,
7462 discard any previously made menu bar item. */
7464 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7465 if (EQ (key
, AREF (menu_bar_items_vector
, i
)))
7467 if (menu_bar_items_index
> i
+ 4)
7468 memmove (aref_addr (menu_bar_items_vector
, i
),
7469 aref_addr (menu_bar_items_vector
, i
+ 4),
7470 (menu_bar_items_index
- i
- 4) * word_size
);
7471 menu_bar_items_index
-= 4;
7475 /* If this keymap has already contributed to this KEY,
7476 don't contribute to it a second time. */
7477 tem
= Fmemq (key
, menu_bar_one_keymap_changed_items
);
7478 if (!NILP (tem
) || NILP (item
))
7481 menu_bar_one_keymap_changed_items
7482 = Fcons (key
, menu_bar_one_keymap_changed_items
);
7484 /* We add to menu_bar_one_keymap_changed_items before doing the
7485 parse_menu_item, so that if it turns out it wasn't a menu item,
7486 it still correctly hides any further menu item. */
7488 parsed
= parse_menu_item (item
, 1);
7493 item
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7495 /* Find any existing item for this KEY. */
7496 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7497 if (EQ (key
, AREF (menu_bar_items_vector
, i
)))
7500 /* If we did not find this KEY, add it at the end. */
7501 if (i
== menu_bar_items_index
)
7503 /* If vector is too small, get a bigger one. */
7504 if (i
+ 4 > ASIZE (menu_bar_items_vector
))
7505 menu_bar_items_vector
= larger_vector (menu_bar_items_vector
, 4, -1);
7506 /* Add this item. */
7507 ASET (menu_bar_items_vector
, i
, key
); i
++;
7508 ASET (menu_bar_items_vector
, i
,
7509 AREF (item_properties
, ITEM_PROPERTY_NAME
)); i
++;
7510 ASET (menu_bar_items_vector
, i
, Fcons (item
, Qnil
)); i
++;
7511 ASET (menu_bar_items_vector
, i
, make_number (0)); i
++;
7512 menu_bar_items_index
= i
;
7514 /* We did find an item for this KEY. Add ITEM to its list of maps. */
7518 old
= AREF (menu_bar_items_vector
, i
+ 2);
7519 /* If the new and the old items are not both keymaps,
7520 the lookup will only find `item'. */
7521 item
= Fcons (item
, KEYMAPP (item
) && KEYMAPP (XCAR (old
)) ? old
: Qnil
);
7522 ASET (menu_bar_items_vector
, i
+ 2, item
);
7526 /* This is used as the handler when calling menu_item_eval_property. */
7528 menu_item_eval_property_1 (Lisp_Object arg
)
7530 /* If we got a quit from within the menu computation,
7531 quit all the way out of it. This takes care of C-] in the debugger. */
7532 if (CONSP (arg
) && EQ (XCAR (arg
), Qquit
))
7533 Fsignal (Qquit
, Qnil
);
7539 eval_dyn (Lisp_Object form
)
7541 return Feval (form
, Qnil
);
7544 /* Evaluate an expression and return the result (or nil if something
7545 went wrong). Used to evaluate dynamic parts of menu items. */
7547 menu_item_eval_property (Lisp_Object sexpr
)
7549 ptrdiff_t count
= SPECPDL_INDEX ();
7551 specbind (Qinhibit_redisplay
, Qt
);
7552 val
= internal_condition_case_1 (eval_dyn
, sexpr
, Qerror
,
7553 menu_item_eval_property_1
);
7554 return unbind_to (count
, val
);
7557 /* This function parses a menu item and leaves the result in the
7558 vector item_properties.
7559 ITEM is a key binding, a possible menu item.
7560 INMENUBAR is > 0 when this is considered for an entry in a menu bar
7562 INMENUBAR is < 0 when this is considered for an entry in a keyboard menu.
7563 parse_menu_item returns true if the item is a menu item and false
7567 parse_menu_item (Lisp_Object item
, int inmenubar
)
7569 Lisp_Object def
, tem
, item_string
, start
;
7571 Lisp_Object keyhint
;
7580 /* Create item_properties vector if necessary. */
7581 if (NILP (item_properties
))
7583 = Fmake_vector (make_number (ITEM_PROPERTY_ENABLE
+ 1), Qnil
);
7585 /* Initialize optional entries. */
7586 for (i
= ITEM_PROPERTY_DEF
; i
< ITEM_PROPERTY_ENABLE
; i
++)
7587 ASET (item_properties
, i
, Qnil
);
7588 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7590 /* Save the item here to protect it from GC. */
7591 ASET (item_properties
, ITEM_PROPERTY_ITEM
, item
);
7593 item_string
= XCAR (item
);
7597 if (STRINGP (item_string
))
7599 /* Old format menu item. */
7600 ASET (item_properties
, ITEM_PROPERTY_NAME
, item_string
);
7602 /* Maybe help string. */
7603 if (CONSP (item
) && STRINGP (XCAR (item
)))
7605 ASET (item_properties
, ITEM_PROPERTY_HELP
, XCAR (item
));
7610 /* Maybe an obsolete key binding cache. */
7611 if (CONSP (item
) && CONSP (XCAR (item
))
7612 && (NILP (XCAR (XCAR (item
)))
7613 || VECTORP (XCAR (XCAR (item
)))))
7616 /* This is the real definition--the function to run. */
7617 ASET (item_properties
, ITEM_PROPERTY_DEF
, item
);
7619 /* Get enable property, if any. */
7622 tem
= Fget (item
, Qmenu_enable
);
7623 if (!NILP (Venable_disabled_menus_and_buttons
))
7624 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7625 else if (!NILP (tem
))
7626 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, tem
);
7629 else if (EQ (item_string
, Qmenu_item
) && CONSP (item
))
7631 /* New format menu item. */
7632 ASET (item_properties
, ITEM_PROPERTY_NAME
, XCAR (item
));
7633 start
= XCDR (item
);
7636 /* We have a real binding. */
7637 ASET (item_properties
, ITEM_PROPERTY_DEF
, XCAR (start
));
7639 item
= XCDR (start
);
7640 /* Is there an obsolete cache list with key equivalences. */
7641 if (CONSP (item
) && CONSP (XCAR (item
)))
7644 /* Parse properties. */
7645 while (CONSP (item
) && CONSP (XCDR (item
)))
7650 if (EQ (tem
, QCenable
))
7652 if (!NILP (Venable_disabled_menus_and_buttons
))
7653 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7655 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, XCAR (item
));
7657 else if (EQ (tem
, QCvisible
))
7659 /* If got a visible property and that evaluates to nil
7660 then ignore this item. */
7661 tem
= menu_item_eval_property (XCAR (item
));
7665 else if (EQ (tem
, QChelp
))
7666 ASET (item_properties
, ITEM_PROPERTY_HELP
, XCAR (item
));
7667 else if (EQ (tem
, QCfilter
))
7669 else if (EQ (tem
, QCkey_sequence
))
7672 if (SYMBOLP (tem
) || STRINGP (tem
) || VECTORP (tem
))
7673 /* Be GC protected. Set keyhint to item instead of tem. */
7676 else if (EQ (tem
, QCkeys
))
7679 if (CONSP (tem
) || STRINGP (tem
))
7680 ASET (item_properties
, ITEM_PROPERTY_KEYEQ
, tem
);
7682 else if (EQ (tem
, QCbutton
) && CONSP (XCAR (item
)))
7687 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
7689 ASET (item_properties
, ITEM_PROPERTY_SELECTED
,
7691 ASET (item_properties
, ITEM_PROPERTY_TYPE
, type
);
7697 else if (inmenubar
|| !NILP (start
))
7701 return 0; /* not a menu item */
7703 /* If item string is not a string, evaluate it to get string.
7704 If we don't get a string, skip this item. */
7705 item_string
= AREF (item_properties
, ITEM_PROPERTY_NAME
);
7706 if (!(STRINGP (item_string
)))
7708 item_string
= menu_item_eval_property (item_string
);
7709 if (!STRINGP (item_string
))
7711 ASET (item_properties
, ITEM_PROPERTY_NAME
, item_string
);
7714 /* If got a filter apply it on definition. */
7715 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7718 def
= menu_item_eval_property (list2 (XCAR (filter
),
7719 list2 (Qquote
, def
)));
7721 ASET (item_properties
, ITEM_PROPERTY_DEF
, def
);
7724 /* Enable or disable selection of item. */
7725 tem
= AREF (item_properties
, ITEM_PROPERTY_ENABLE
);
7728 tem
= menu_item_eval_property (tem
);
7729 if (inmenubar
&& NILP (tem
))
7730 return 0; /* Ignore disabled items in menu bar. */
7731 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, tem
);
7734 /* If we got no definition, this item is just unselectable text which
7735 is OK in a submenu but not in the menubar. */
7737 return (!inmenubar
);
7739 /* See if this is a separate pane or a submenu. */
7740 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7741 tem
= get_keymap (def
, 0, 1);
7742 /* For a subkeymap, just record its details and exit. */
7745 ASET (item_properties
, ITEM_PROPERTY_MAP
, tem
);
7746 ASET (item_properties
, ITEM_PROPERTY_DEF
, tem
);
7750 /* At the top level in the menu bar, do likewise for commands also.
7751 The menu bar does not display equivalent key bindings anyway.
7752 ITEM_PROPERTY_DEF is already set up properly. */
7756 { /* This is a command. See if there is an equivalent key binding. */
7757 Lisp_Object keyeq
= AREF (item_properties
, ITEM_PROPERTY_KEYEQ
);
7759 /* The previous code preferred :key-sequence to :keys, so we
7760 preserve this behavior. */
7761 if (STRINGP (keyeq
) && !CONSP (keyhint
))
7762 keyeq
= concat2 (build_string (" "), Fsubstitute_command_keys (keyeq
));
7765 Lisp_Object prefix
= keyeq
;
7766 Lisp_Object keys
= Qnil
;
7770 def
= XCAR (prefix
);
7771 prefix
= XCDR (prefix
);
7774 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7776 if (CONSP (keyhint
) && !NILP (XCAR (keyhint
)))
7778 keys
= XCAR (keyhint
);
7779 tem
= Fkey_binding (keys
, Qnil
, Qnil
, Qnil
);
7781 /* We have a suggested key. Is it bound to the command? */
7784 /* If the command is an alias for another
7785 (such as lmenu.el set it up), check if the
7786 original command matches the cached command. */
7788 && EQ (tem
, XSYMBOL (def
)->function
))))
7793 keys
= Fwhere_is_internal (def
, Qnil
, Qt
, Qnil
, Qnil
);
7797 tem
= Fkey_description (keys
, Qnil
);
7800 if (STRINGP (XCAR (prefix
)))
7801 tem
= concat2 (XCAR (prefix
), tem
);
7802 if (STRINGP (XCDR (prefix
)))
7803 tem
= concat2 (tem
, XCDR (prefix
));
7805 keyeq
= concat2 (build_string (" "), tem
);
7806 /* keyeq = concat3(build_string(" ("),tem,build_string(")")); */
7812 /* If we have an equivalent key binding, use that. */
7813 ASET (item_properties
, ITEM_PROPERTY_KEYEQ
, keyeq
);
7816 /* Include this when menu help is implemented.
7817 tem = XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP];
7818 if (!(NILP (tem) || STRINGP (tem)))
7820 tem = menu_item_eval_property (tem);
7823 XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP] = tem;
7827 /* Handle radio buttons or toggle boxes. */
7828 tem
= AREF (item_properties
, ITEM_PROPERTY_SELECTED
);
7830 ASET (item_properties
, ITEM_PROPERTY_SELECTED
,
7831 menu_item_eval_property (tem
));
7838 /***********************************************************************
7840 ***********************************************************************/
7842 /* A vector holding tool bar items while they are parsed in function
7843 tool_bar_items. Each item occupies TOOL_BAR_ITEM_NSCLOTS elements
7846 static Lisp_Object tool_bar_items_vector
;
7848 /* A vector holding the result of parse_tool_bar_item. Layout is like
7849 the one for a single item in tool_bar_items_vector. */
7851 static Lisp_Object tool_bar_item_properties
;
7853 /* Next free index in tool_bar_items_vector. */
7855 static int ntool_bar_items
;
7857 /* The symbols `:image' and `:rtl'. */
7859 static Lisp_Object QCimage
;
7860 static Lisp_Object QCrtl
;
7862 /* Function prototypes. */
7864 static void init_tool_bar_items (Lisp_Object
);
7865 static void process_tool_bar_item (Lisp_Object
, Lisp_Object
, Lisp_Object
, void*);
7866 static bool parse_tool_bar_item (Lisp_Object
, Lisp_Object
);
7867 static void append_tool_bar_item (void);
7870 /* Return a vector of tool bar items for keymaps currently in effect.
7871 Reuse vector REUSE if non-nil. Return in *NITEMS the number of
7872 tool bar items found. */
7875 tool_bar_items (Lisp_Object reuse
, int *nitems
)
7884 /* In order to build the menus, we need to call the keymap
7885 accessors. They all call QUIT. But this function is called
7886 during redisplay, during which a quit is fatal. So inhibit
7887 quitting while building the menus. We do this instead of
7888 specbind because (1) errors will clear it anyway and (2) this
7889 avoids risk of specpdl overflow. */
7890 oquit
= Vinhibit_quit
;
7893 /* Initialize tool_bar_items_vector and protect it from GC. */
7894 init_tool_bar_items (reuse
);
7896 /* Build list of keymaps in maps. Set nmaps to the number of maps
7899 /* Should overriding-terminal-local-map and overriding-local-map apply? */
7900 if (!NILP (Voverriding_local_map_menu_flag
))
7902 /* Yes, use them (if non-nil) as well as the global map. */
7903 maps
= alloca (3 * sizeof *maps
);
7905 if (!NILP (KVAR (current_kboard
, Voverriding_terminal_local_map
)))
7906 maps
[nmaps
++] = KVAR (current_kboard
, Voverriding_terminal_local_map
);
7907 if (!NILP (Voverriding_local_map
))
7908 maps
[nmaps
++] = Voverriding_local_map
;
7912 /* No, so use major and minor mode keymaps and keymap property.
7913 Note that tool-bar bindings in the local-map and keymap
7914 properties may not work reliable, as they are only
7915 recognized when the tool-bar (or mode-line) is updated,
7916 which does not normally happen after every command. */
7919 nminor
= current_minor_maps (NULL
, &tmaps
);
7920 maps
= alloca ((nminor
+ 3) * sizeof *maps
);
7922 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
7923 maps
[nmaps
++] = tem
;
7924 memcpy (maps
+ nmaps
, tmaps
, nminor
* sizeof (maps
[0]));
7926 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
7929 /* Add global keymap at the end. */
7930 maps
[nmaps
++] = current_global_map
;
7932 /* Process maps in reverse order and look up in each map the prefix
7934 for (i
= nmaps
- 1; i
>= 0; --i
)
7935 if (!NILP (maps
[i
]))
7939 keymap
= get_keymap (access_keymap (maps
[i
], Qtool_bar
, 1, 0, 1), 0, 1);
7941 map_keymap (keymap
, process_tool_bar_item
, Qnil
, NULL
, 1);
7944 Vinhibit_quit
= oquit
;
7945 *nitems
= ntool_bar_items
/ TOOL_BAR_ITEM_NSLOTS
;
7946 return tool_bar_items_vector
;
7950 /* Process the definition of KEY which is DEF. */
7953 process_tool_bar_item (Lisp_Object key
, Lisp_Object def
, Lisp_Object data
, void *args
)
7956 struct gcpro gcpro1
, gcpro2
;
7958 /* Protect KEY and DEF from GC because parse_tool_bar_item may call
7962 if (EQ (def
, Qundefined
))
7964 /* If a map has an explicit `undefined' as definition,
7965 discard any previously made item. */
7966 for (i
= 0; i
< ntool_bar_items
; i
+= TOOL_BAR_ITEM_NSLOTS
)
7968 Lisp_Object
*v
= XVECTOR (tool_bar_items_vector
)->contents
+ i
;
7970 if (EQ (key
, v
[TOOL_BAR_ITEM_KEY
]))
7972 if (ntool_bar_items
> i
+ TOOL_BAR_ITEM_NSLOTS
)
7973 memmove (v
, v
+ TOOL_BAR_ITEM_NSLOTS
,
7974 ((ntool_bar_items
- i
- TOOL_BAR_ITEM_NSLOTS
)
7976 ntool_bar_items
-= TOOL_BAR_ITEM_NSLOTS
;
7981 else if (parse_tool_bar_item (key
, def
))
7982 /* Append a new tool bar item to tool_bar_items_vector. Accept
7983 more than one definition for the same key. */
7984 append_tool_bar_item ();
7989 /* Access slot with index IDX of vector tool_bar_item_properties. */
7990 #define PROP(IDX) AREF (tool_bar_item_properties, (IDX))
7992 set_prop (ptrdiff_t idx
, Lisp_Object val
)
7994 ASET (tool_bar_item_properties
, idx
, val
);
7998 /* Parse a tool bar item specification ITEM for key KEY and return the
7999 result in tool_bar_item_properties. Value is false if ITEM is
8002 ITEM is a list `(menu-item CAPTION BINDING PROPS...)'.
8004 CAPTION is the caption of the item, If it's not a string, it is
8005 evaluated to get a string.
8007 BINDING is the tool bar item's binding. Tool-bar items with keymaps
8008 as binding are currently ignored.
8010 The following properties are recognized:
8014 FORM is evaluated and specifies whether the tool bar item is
8015 enabled or disabled.
8019 FORM is evaluated and specifies whether the tool bar item is visible.
8021 - `:filter FUNCTION'
8023 FUNCTION is invoked with one parameter `(quote BINDING)'. Its
8024 result is stored as the new binding.
8026 - `:button (TYPE SELECTED)'
8028 TYPE must be one of `:radio' or `:toggle'. SELECTED is evaluated
8029 and specifies whether the button is selected (pressed) or not.
8033 IMAGES is either a single image specification or a vector of four
8034 image specifications. See enum tool_bar_item_images.
8036 - `:help HELP-STRING'.
8038 Gives a help string to display for the tool bar item.
8040 - `:label LABEL-STRING'.
8042 A text label to show with the tool bar button if labels are enabled. */
8045 parse_tool_bar_item (Lisp_Object key
, Lisp_Object item
)
8047 Lisp_Object filter
= Qnil
;
8048 Lisp_Object caption
;
8050 bool have_label
= 0;
8052 /* Definition looks like `(menu-item CAPTION BINDING PROPS...)'.
8053 Rule out items that aren't lists, don't start with
8054 `menu-item' or whose rest following `tool-bar-item' is not a
8059 /* As an exception, allow old-style menu separators. */
8060 if (STRINGP (XCAR (item
)))
8061 item
= Fcons (XCAR (item
), Qnil
);
8062 else if (!EQ (XCAR (item
), Qmenu_item
)
8063 || (item
= XCDR (item
), !CONSP (item
)))
8066 /* Create tool_bar_item_properties vector if necessary. Reset it to
8068 if (VECTORP (tool_bar_item_properties
))
8070 for (i
= 0; i
< TOOL_BAR_ITEM_NSLOTS
; ++i
)
8074 tool_bar_item_properties
8075 = Fmake_vector (make_number (TOOL_BAR_ITEM_NSLOTS
), Qnil
);
8078 set_prop (TOOL_BAR_ITEM_KEY
, key
);
8079 set_prop (TOOL_BAR_ITEM_ENABLED_P
, Qt
);
8081 /* Get the caption of the item. If the caption is not a string,
8082 evaluate it to get a string. If we don't get a string, skip this
8084 caption
= XCAR (item
);
8085 if (!STRINGP (caption
))
8087 caption
= menu_item_eval_property (caption
);
8088 if (!STRINGP (caption
))
8091 set_prop (TOOL_BAR_ITEM_CAPTION
, caption
);
8093 /* If the rest following the caption is not a list, the menu item is
8094 either a separator, or invalid. */
8098 if (menu_separator_name_p (SSDATA (caption
)))
8100 set_prop (TOOL_BAR_ITEM_TYPE
, Qt
);
8101 #if !defined (USE_GTK) && !defined (HAVE_NS)
8102 /* If we use build_desired_tool_bar_string to render the
8103 tool bar, the separator is rendered as an image. */
8104 PROP (TOOL_BAR_ITEM_IMAGES
)
8105 = menu_item_eval_property (Vtool_bar_separator_image_expression
);
8106 PROP (TOOL_BAR_ITEM_ENABLED_P
) = Qnil
;
8107 PROP (TOOL_BAR_ITEM_SELECTED_P
) = Qnil
;
8108 PROP (TOOL_BAR_ITEM_CAPTION
) = Qnil
;
8115 /* Store the binding. */
8116 set_prop (TOOL_BAR_ITEM_BINDING
, XCAR (item
));
8119 /* Ignore cached key binding, if any. */
8120 if (CONSP (item
) && CONSP (XCAR (item
)))
8123 /* Process the rest of the properties. */
8124 for (; CONSP (item
) && CONSP (XCDR (item
)); item
= XCDR (XCDR (item
)))
8126 Lisp_Object ikey
, value
;
8129 value
= XCAR (XCDR (item
));
8131 if (EQ (ikey
, QCenable
))
8133 /* `:enable FORM'. */
8134 if (!NILP (Venable_disabled_menus_and_buttons
))
8135 set_prop (TOOL_BAR_ITEM_ENABLED_P
, Qt
);
8137 set_prop (TOOL_BAR_ITEM_ENABLED_P
, value
);
8139 else if (EQ (ikey
, QCvisible
))
8141 /* `:visible FORM'. If got a visible property and that
8142 evaluates to nil then ignore this item. */
8143 if (NILP (menu_item_eval_property (value
)))
8146 else if (EQ (ikey
, QChelp
))
8147 /* `:help HELP-STRING'. */
8148 set_prop (TOOL_BAR_ITEM_HELP
, value
);
8149 else if (EQ (ikey
, QCvert_only
))
8150 /* `:vert-only t/nil'. */
8151 set_prop (TOOL_BAR_ITEM_VERT_ONLY
, value
);
8152 else if (EQ (ikey
, QClabel
))
8154 const char *bad_label
= "!!?GARBLED ITEM?!!";
8155 /* `:label LABEL-STRING'. */
8156 set_prop (TOOL_BAR_ITEM_LABEL
,
8157 STRINGP (value
) ? value
: build_string (bad_label
));
8160 else if (EQ (ikey
, QCfilter
))
8161 /* ':filter FORM'. */
8163 else if (EQ (ikey
, QCbutton
) && CONSP (value
))
8165 /* `:button (TYPE . SELECTED)'. */
8166 Lisp_Object type
, selected
;
8168 type
= XCAR (value
);
8169 selected
= XCDR (value
);
8170 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
8172 set_prop (TOOL_BAR_ITEM_SELECTED_P
, selected
);
8173 set_prop (TOOL_BAR_ITEM_TYPE
, type
);
8176 else if (EQ (ikey
, QCimage
)
8178 || (VECTORP (value
) && ASIZE (value
) == 4)))
8179 /* Value is either a single image specification or a vector
8180 of 4 such specifications for the different button states. */
8181 set_prop (TOOL_BAR_ITEM_IMAGES
, value
);
8182 else if (EQ (ikey
, QCrtl
))
8184 set_prop (TOOL_BAR_ITEM_RTL_IMAGE
, value
);
8190 /* Try to make one from caption and key. */
8191 Lisp_Object tkey
= PROP (TOOL_BAR_ITEM_KEY
);
8192 Lisp_Object tcapt
= PROP (TOOL_BAR_ITEM_CAPTION
);
8193 const char *label
= SYMBOLP (tkey
) ? SSDATA (SYMBOL_NAME (tkey
)) : "";
8194 const char *capt
= STRINGP (tcapt
) ? SSDATA (tcapt
) : "";
8196 2 * max (0, min (tool_bar_max_label_size
, STRING_BYTES_BOUND
/ 2));
8197 char *buf
= xmalloc (max_lbl
+ 1);
8198 Lisp_Object new_lbl
;
8199 ptrdiff_t caption_len
= strlen (capt
);
8201 if (caption_len
<= max_lbl
&& capt
[0] != '\0')
8204 while (caption_len
> 0 && buf
[caption_len
- 1] == '.')
8206 buf
[caption_len
] = '\0';
8210 if (strlen (label
) <= max_lbl
&& label
[0] != '\0')
8214 strcpy (buf
, label
);
8216 for (j
= 0; buf
[j
] != '\0'; ++j
)
8224 new_lbl
= Fupcase_initials (build_string (label
));
8225 if (SCHARS (new_lbl
) <= tool_bar_max_label_size
)
8226 set_prop (TOOL_BAR_ITEM_LABEL
, new_lbl
);
8228 set_prop (TOOL_BAR_ITEM_LABEL
, empty_unibyte_string
);
8232 /* If got a filter apply it on binding. */
8234 set_prop (TOOL_BAR_ITEM_BINDING
,
8235 (menu_item_eval_property
8238 PROP (TOOL_BAR_ITEM_BINDING
))))));
8240 /* See if the binding is a keymap. Give up if it is. */
8241 if (CONSP (get_keymap (PROP (TOOL_BAR_ITEM_BINDING
), 0, 1)))
8244 /* Enable or disable selection of item. */
8245 if (!EQ (PROP (TOOL_BAR_ITEM_ENABLED_P
), Qt
))
8246 set_prop (TOOL_BAR_ITEM_ENABLED_P
,
8247 menu_item_eval_property (PROP (TOOL_BAR_ITEM_ENABLED_P
)));
8249 /* Handle radio buttons or toggle boxes. */
8250 if (!NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
)))
8251 set_prop (TOOL_BAR_ITEM_SELECTED_P
,
8252 menu_item_eval_property (PROP (TOOL_BAR_ITEM_SELECTED_P
)));
8260 /* Initialize tool_bar_items_vector. REUSE, if non-nil, is a vector
8261 that can be reused. */
8264 init_tool_bar_items (Lisp_Object reuse
)
8266 if (VECTORP (reuse
))
8267 tool_bar_items_vector
= reuse
;
8269 tool_bar_items_vector
= Fmake_vector (make_number (64), Qnil
);
8270 ntool_bar_items
= 0;
8274 /* Append parsed tool bar item properties from
8275 tool_bar_item_properties */
8278 append_tool_bar_item (void)
8282 - (ASIZE (tool_bar_items_vector
) - TOOL_BAR_ITEM_NSLOTS
));
8284 /* Enlarge tool_bar_items_vector if necessary. */
8286 tool_bar_items_vector
8287 = larger_vector (tool_bar_items_vector
, incr
, -1);
8289 /* Append entries from tool_bar_item_properties to the end of
8290 tool_bar_items_vector. */
8291 vcopy (tool_bar_items_vector
, ntool_bar_items
,
8292 XVECTOR (tool_bar_item_properties
)->contents
, TOOL_BAR_ITEM_NSLOTS
);
8293 ntool_bar_items
+= TOOL_BAR_ITEM_NSLOTS
;
8300 /* Read a character using menus based on maps in the array MAPS.
8301 NMAPS is the length of MAPS. Return nil if there are no menus in the maps.
8302 Return t if we displayed a menu but the user rejected it.
8304 PREV_EVENT is the previous input event, or nil if we are reading
8305 the first event of a key sequence.
8307 If USED_MOUSE_MENU is non-null, set *USED_MOUSE_MENU to true
8308 if we used a mouse menu to read the input, or false otherwise. If
8309 USED_MOUSE_MENU is null, don't dereference it.
8311 The prompting is done based on the prompt-string of the map
8312 and the strings associated with various map elements.
8314 This can be done with X menus or with menus put in the minibuf.
8315 These are done in different ways, depending on how the input will be read.
8316 Menus using X are done after auto-saving in read-char, getting the input
8317 event from Fx_popup_menu; menus using the minibuf use read_char recursively
8318 and do auto-saving in the inner call of read_char. */
8321 read_char_x_menu_prompt (ptrdiff_t nmaps
, Lisp_Object
*maps
,
8322 Lisp_Object prev_event
, bool *used_mouse_menu
)
8328 if (used_mouse_menu
)
8329 *used_mouse_menu
= 0;
8331 /* Use local over global Menu maps */
8333 if (! menu_prompting
)
8336 /* Optionally disregard all but the global map. */
8337 if (inhibit_local_menu_bar_menus
)
8339 maps
+= (nmaps
- 1);
8344 /* If we got to this point via a mouse click,
8345 use a real menu for mouse selection. */
8346 if (EVENT_HAS_PARAMETERS (prev_event
)
8347 && !EQ (XCAR (prev_event
), Qmenu_bar
)
8348 && !EQ (XCAR (prev_event
), Qtool_bar
))
8350 /* Display the menu and get the selection. */
8351 Lisp_Object
*realmaps
= alloca (nmaps
* sizeof *realmaps
);
8353 ptrdiff_t nmaps1
= 0;
8355 /* Use the maps that are not nil. */
8356 for (mapno
= 0; mapno
< nmaps
; mapno
++)
8357 if (!NILP (maps
[mapno
]))
8358 realmaps
[nmaps1
++] = maps
[mapno
];
8360 value
= Fx_popup_menu (prev_event
, Flist (nmaps1
, realmaps
));
8365 record_menu_key (XCAR (value
));
8367 /* If we got multiple events, unread all but
8369 There is no way to prevent those unread events
8370 from showing up later in last_nonmenu_event.
8371 So turn symbol and integer events into lists,
8372 to indicate that they came from a mouse menu,
8373 so that when present in last_nonmenu_event
8374 they won't confuse things. */
8375 for (tem
= XCDR (value
); CONSP (tem
); tem
= XCDR (tem
))
8377 record_menu_key (XCAR (tem
));
8378 if (SYMBOLP (XCAR (tem
))
8379 || INTEGERP (XCAR (tem
)))
8380 XSETCAR (tem
, Fcons (XCAR (tem
), Qdisabled
));
8383 /* If we got more than one event, put all but the first
8384 onto this list to be read later.
8385 Return just the first event now. */
8386 Vunread_command_events
8387 = nconc2 (XCDR (value
), Vunread_command_events
);
8388 value
= XCAR (value
);
8390 else if (NILP (value
))
8392 if (used_mouse_menu
)
8393 *used_mouse_menu
= 1;
8396 #endif /* HAVE_MENUS */
8400 /* Buffer in use so far for the minibuf prompts for menu keymaps.
8401 We make this bigger when necessary, and never free it. */
8402 static char *read_char_minibuf_menu_text
;
8403 /* Size of that buffer. */
8404 static ptrdiff_t read_char_minibuf_menu_width
;
8407 read_char_minibuf_menu_prompt (int commandflag
,
8408 ptrdiff_t nmaps
, Lisp_Object
*maps
)
8411 register Lisp_Object name
;
8413 /* FIXME: Use the minibuffer's frame width. */
8414 ptrdiff_t width
= FRAME_COLS (SELECTED_FRAME ()) - 4;
8416 bool nobindings
= 1;
8417 Lisp_Object rest
, vector
;
8423 if (! menu_prompting
)
8426 /* Get the menu name from the first map that has one (a prompt string). */
8427 for (mapno
= 0; mapno
< nmaps
; mapno
++)
8429 name
= Fkeymap_prompt (maps
[mapno
]);
8434 /* If we don't have any menus, just read a character normally. */
8435 if (!STRINGP (name
))
8438 /* Make sure we have a big enough buffer for the menu text. */
8439 width
= max (width
, SBYTES (name
));
8440 if (STRING_BYTES_BOUND
- 4 < width
)
8441 memory_full (SIZE_MAX
);
8442 if (width
+ 4 > read_char_minibuf_menu_width
)
8444 read_char_minibuf_menu_text
8445 = xrealloc (read_char_minibuf_menu_text
, width
+ 4);
8446 read_char_minibuf_menu_width
= width
+ 4;
8448 menu
= read_char_minibuf_menu_text
;
8450 /* Prompt string always starts with map's prompt, and a space. */
8451 strcpy (menu
, SSDATA (name
));
8452 nlength
= SBYTES (name
);
8453 menu
[nlength
++] = ':';
8454 menu
[nlength
++] = ' ';
8457 /* Start prompting at start of first map. */
8461 /* Present the documented bindings, a line at a time. */
8465 ptrdiff_t i
= nlength
;
8467 Lisp_Object orig_defn_macro
;
8469 /* Loop over elements of map. */
8474 /* If reached end of map, start at beginning of next map. */
8478 /* At end of last map, wrap around to first map if just starting,
8479 or end this line if already have something on it. */
8483 if (notfirst
|| nobindings
) break;
8488 /* Look at the next element of the map. */
8490 elt
= AREF (vector
, idx
);
8492 elt
= Fcar_safe (rest
);
8494 if (idx
< 0 && VECTORP (elt
))
8496 /* If we found a dense table in the keymap,
8497 advanced past it, but start scanning its contents. */
8498 rest
= Fcdr_safe (rest
);
8504 /* An ordinary element. */
8505 Lisp_Object event
, tem
;
8509 event
= Fcar_safe (elt
); /* alist */
8510 elt
= Fcdr_safe (elt
);
8514 XSETINT (event
, idx
); /* vector */
8517 /* Ignore the element if it has no prompt string. */
8518 if (INTEGERP (event
) && parse_menu_item (elt
, -1))
8520 /* True if the char to type matches the string. */
8522 Lisp_Object upcased_event
, downcased_event
;
8523 Lisp_Object desc
= Qnil
;
8525 = AREF (item_properties
, ITEM_PROPERTY_NAME
);
8527 upcased_event
= Fupcase (event
);
8528 downcased_event
= Fdowncase (event
);
8529 char_matches
= (XINT (upcased_event
) == SREF (s
, 0)
8530 || XINT (downcased_event
) == SREF (s
, 0));
8532 desc
= Fsingle_key_description (event
, Qnil
);
8534 #if 0 /* It is redundant to list the equivalent key bindings because
8535 the prefix is what the user has already typed. */
8537 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_KEYEQ
];
8539 /* Insert equivalent keybinding. */
8540 s
= concat2 (s
, tem
);
8543 = AREF (item_properties
, ITEM_PROPERTY_TYPE
);
8544 if (EQ (tem
, QCradio
) || EQ (tem
, QCtoggle
))
8546 /* Insert button prefix. */
8547 Lisp_Object selected
8548 = AREF (item_properties
, ITEM_PROPERTY_SELECTED
);
8549 if (EQ (tem
, QCradio
))
8550 tem
= build_string (NILP (selected
) ? "(*) " : "( ) ");
8552 tem
= build_string (NILP (selected
) ? "[X] " : "[ ] ");
8553 s
= concat2 (tem
, s
);
8557 /* If we have room for the prompt string, add it to this line.
8558 If this is the first on the line, always add it. */
8559 if ((SCHARS (s
) + i
+ 2
8560 + (char_matches
? 0 : SCHARS (desc
) + 3))
8564 ptrdiff_t thiswidth
;
8566 /* Punctuate between strings. */
8569 strcpy (menu
+ i
, ", ");
8575 /* If the char to type doesn't match the string's
8576 first char, explicitly show what char to type. */
8579 /* Add as much of string as fits. */
8580 thiswidth
= min (SCHARS (desc
), width
- i
);
8581 memcpy (menu
+ i
, SDATA (desc
), thiswidth
);
8583 strcpy (menu
+ i
, " = ");
8587 /* Add as much of string as fits. */
8588 thiswidth
= min (SCHARS (s
), width
- i
);
8589 memcpy (menu
+ i
, SDATA (s
), thiswidth
);
8595 /* If this element does not fit, end the line now,
8596 and save the element for the next line. */
8597 strcpy (menu
+ i
, "...");
8602 /* Move past this element. */
8603 if (idx
>= 0 && idx
+ 1 >= ASIZE (vector
))
8604 /* Handle reaching end of dense table. */
8609 rest
= Fcdr_safe (rest
);
8613 /* Prompt with that and read response. */
8614 message2_nolog (menu
, strlen (menu
),
8615 ! NILP (BVAR (current_buffer
, enable_multibyte_characters
)));
8617 /* Make believe its not a keyboard macro in case the help char
8618 is pressed. Help characters are not recorded because menu prompting
8619 is not used on replay.
8621 orig_defn_macro
= KVAR (current_kboard
, defining_kbd_macro
);
8622 kset_defining_kbd_macro (current_kboard
, Qnil
);
8624 obj
= read_char (commandflag
, 0, 0, Qt
, 0, NULL
);
8625 while (BUFFERP (obj
));
8626 kset_defining_kbd_macro (current_kboard
, orig_defn_macro
);
8628 if (!INTEGERP (obj
))
8630 else if (XINT (obj
) == -2)
8633 if (! EQ (obj
, menu_prompt_more_char
)
8634 && (!INTEGERP (menu_prompt_more_char
)
8635 || ! EQ (obj
, make_number (Ctl (XINT (menu_prompt_more_char
))))))
8637 if (!NILP (KVAR (current_kboard
, defining_kbd_macro
)))
8638 store_kbd_macro_char (obj
);
8641 /* Help char - go round again */
8645 /* Reading key sequences. */
8647 /* Follow KEY in the maps in CURRENT[0..NMAPS-1], placing its bindings
8648 in DEFS[0..NMAPS-1]. Set NEXT[i] to DEFS[i] if DEFS[i] is a
8649 keymap, or nil otherwise. Return the index of the first keymap in
8650 which KEY has any binding, or NMAPS if no map has a binding.
8652 If KEY is a meta ASCII character, treat it like meta-prefix-char
8653 followed by the corresponding non-meta character. Keymaps in
8654 CURRENT with non-prefix bindings for meta-prefix-char become nil in
8657 If KEY has no bindings in any of the CURRENT maps, NEXT is left
8660 NEXT may be the same array as CURRENT. */
8663 follow_key (Lisp_Object key
, ptrdiff_t nmaps
, Lisp_Object
*current
,
8664 Lisp_Object
*defs
, Lisp_Object
*next
)
8666 ptrdiff_t i
, first_binding
;
8668 first_binding
= nmaps
;
8669 for (i
= nmaps
- 1; i
>= 0; i
--)
8671 if (! NILP (current
[i
]))
8673 defs
[i
] = access_keymap (current
[i
], key
, 1, 0, 1);
8674 if (! NILP (defs
[i
]))
8681 /* Given the set of bindings we've found, produce the next set of maps. */
8682 if (first_binding
< nmaps
)
8683 for (i
= 0; i
< nmaps
; i
++)
8684 next
[i
] = NILP (defs
[i
]) ? Qnil
: get_keymap (defs
[i
], 0, 1);
8686 return first_binding
;
8689 /* Structure used to keep track of partial application of key remapping
8690 such as Vfunction_key_map and Vkey_translation_map. */
8691 typedef struct keyremap
8693 /* This is the map originally specified for this use. */
8695 /* This is a submap reached by looking up, in PARENT,
8696 the events from START to END. */
8698 /* Positions [START, END) in the key sequence buffer
8699 are the key that we have scanned so far.
8700 Those events are the ones that we will replace
8701 if PARENT maps them into a key sequence. */
8705 /* Lookup KEY in MAP.
8706 MAP is a keymap mapping keys to key vectors or functions.
8707 If the mapping is a function and DO_FUNCALL is true,
8708 the function is called with PROMPT as parameter and its return
8709 value is used as the return value of this function (after checking
8710 that it is indeed a vector). */
8713 access_keymap_keyremap (Lisp_Object map
, Lisp_Object key
, Lisp_Object prompt
,
8718 next
= access_keymap (map
, key
, 1, 0, 1);
8720 /* Handle a symbol whose function definition is a keymap
8722 if (SYMBOLP (next
) && !NILP (Ffboundp (next
))
8723 && (ARRAYP (XSYMBOL (next
)->function
)
8724 || KEYMAPP (XSYMBOL (next
)->function
)))
8725 next
= Fautoload_do_load (XSYMBOL (next
)->function
, next
, Qnil
);
8727 /* If the keymap gives a function, not an
8728 array, then call the function with one arg and use
8729 its value instead. */
8730 if (do_funcall
&& FUNCTIONP (next
))
8735 next
= call1 (next
, prompt
);
8736 /* If the function returned something invalid,
8737 barf--don't ignore it.
8738 (To ignore it safely, we would need to gcpro a bunch of
8739 other variables.) */
8740 if (! (VECTORP (next
) || STRINGP (next
)))
8741 error ("Function %s returns invalid key sequence",
8742 SSDATA (SYMBOL_NAME (tem
)));
8747 /* Do one step of the key remapping used for function-key-map and
8748 key-translation-map:
8749 KEYBUF is the buffer holding the input events.
8750 BUFSIZE is its maximum size.
8751 FKEY is a pointer to the keyremap structure to use.
8752 INPUT is the index of the last element in KEYBUF.
8753 DOIT if true says that the remapping can actually take place.
8754 DIFF is used to return the number of keys added/removed by the remapping.
8755 PARENT is the root of the keymap.
8756 PROMPT is the prompt to use if the remapping happens through a function.
8757 Return true if the remapping actually took place. */
8760 keyremap_step (Lisp_Object
*keybuf
, int bufsize
, volatile keyremap
*fkey
,
8761 int input
, bool doit
, int *diff
, Lisp_Object prompt
)
8763 Lisp_Object next
, key
;
8765 key
= keybuf
[fkey
->end
++];
8767 if (KEYMAPP (fkey
->parent
))
8768 next
= access_keymap_keyremap (fkey
->map
, key
, prompt
, doit
);
8772 /* If keybuf[fkey->start..fkey->end] is bound in the
8773 map and we're in a position to do the key remapping, replace it with
8774 the binding and restart with fkey->start at the end. */
8775 if ((VECTORP (next
) || STRINGP (next
)) && doit
)
8777 int len
= XFASTINT (Flength (next
));
8780 *diff
= len
- (fkey
->end
- fkey
->start
);
8782 if (bufsize
- input
<= *diff
)
8783 error ("Key sequence too long");
8785 /* Shift the keys that follow fkey->end. */
8787 for (i
= fkey
->end
; i
< input
; i
++)
8788 keybuf
[i
+ *diff
] = keybuf
[i
];
8790 for (i
= input
- 1; i
>= fkey
->end
; i
--)
8791 keybuf
[i
+ *diff
] = keybuf
[i
];
8792 /* Overwrite the old keys with the new ones. */
8793 for (i
= 0; i
< len
; i
++)
8794 keybuf
[fkey
->start
+ i
]
8795 = Faref (next
, make_number (i
));
8797 fkey
->start
= fkey
->end
+= *diff
;
8798 fkey
->map
= fkey
->parent
;
8803 fkey
->map
= get_keymap (next
, 0, 1);
8805 /* If we no longer have a bound suffix, try a new position for
8807 if (!CONSP (fkey
->map
))
8809 fkey
->end
= ++fkey
->start
;
8810 fkey
->map
= fkey
->parent
;
8816 test_undefined (Lisp_Object binding
)
8818 return (EQ (binding
, Qundefined
)
8819 || (!NILP (binding
) && SYMBOLP (binding
)
8820 && EQ (Fcommand_remapping (binding
, Qnil
, Qnil
), Qundefined
)));
8823 /* Read a sequence of keys that ends with a non prefix character,
8824 storing it in KEYBUF, a buffer of size BUFSIZE.
8826 Return the length of the key sequence stored.
8827 Return -1 if the user rejected a command menu.
8829 Echo starting immediately unless `prompt' is 0.
8831 Where a key sequence ends depends on the currently active keymaps.
8832 These include any minor mode keymaps active in the current buffer,
8833 the current buffer's local map, and the global map.
8835 If a key sequence has no other bindings, we check Vfunction_key_map
8836 to see if some trailing subsequence might be the beginning of a
8837 function key's sequence. If so, we try to read the whole function
8838 key, and substitute its symbolic name into the key sequence.
8840 We ignore unbound `down-' mouse clicks. We turn unbound `drag-' and
8841 `double-' events into similar click events, if that would make them
8842 bound. We try to turn `triple-' events first into `double-' events,
8845 If we get a mouse click in a mode line, vertical divider, or other
8846 non-text area, we treat the click as if it were prefixed by the
8847 symbol denoting that area - `mode-line', `vertical-line', or
8850 If the sequence starts with a mouse click, we read the key sequence
8851 with respect to the buffer clicked on, not the current buffer.
8853 If the user switches frames in the midst of a key sequence, we put
8854 off the switch-frame event until later; the next call to
8855 read_char will return it.
8857 If FIX_CURRENT_BUFFER, we restore current_buffer
8858 from the selected window's buffer. */
8861 read_key_sequence (Lisp_Object
*keybuf
, int bufsize
, Lisp_Object prompt
,
8862 bool dont_downcase_last
, bool can_return_switch_frame
,
8863 bool fix_current_buffer
)
8865 Lisp_Object from_string
;
8866 ptrdiff_t count
= SPECPDL_INDEX ();
8868 /* How many keys there are in the current key sequence. */
8871 /* The length of the echo buffer when we started reading, and
8872 the length of this_command_keys when we started reading. */
8873 ptrdiff_t echo_start
IF_LINT (= 0);
8874 ptrdiff_t keys_start
;
8876 /* The number of keymaps we're scanning right now, and the number of
8877 keymaps we have allocated space for. */
8879 ptrdiff_t nmaps_allocated
= 0;
8881 /* defs[0..nmaps-1] are the definitions of KEYBUF[0..t-1] in
8882 the current keymaps. */
8883 Lisp_Object
*defs
= NULL
;
8885 /* submaps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
8886 in the current keymaps, or nil where it is not a prefix. */
8887 Lisp_Object
*submaps
= NULL
;
8889 /* The local map to start out with at start of key sequence. */
8890 Lisp_Object orig_local_map
;
8892 /* The map from the `keymap' property to start out with at start of
8894 Lisp_Object orig_keymap
;
8896 /* Positive if we have already considered switching to the local-map property
8897 of the place where a mouse click occurred. */
8898 int localized_local_map
= 0;
8900 /* The index in submaps[] of the first keymap that has a binding for
8901 this key sequence. In other words, the lowest i such that
8902 submaps[i] is non-nil. */
8903 ptrdiff_t first_binding
;
8904 /* Index of the first key that has no binding.
8905 It is useless to try fkey.start larger than that. */
8908 /* If t < mock_input, then KEYBUF[t] should be read as the next
8911 We use this to recover after recognizing a function key. Once we
8912 realize that a suffix of the current key sequence is actually a
8913 function key's escape sequence, we replace the suffix with the
8914 function key's binding from Vfunction_key_map. Now keybuf
8915 contains a new and different key sequence, so the echo area,
8916 this_command_keys, and the submaps and defs arrays are wrong. In
8917 this situation, we set mock_input to t, set t to 0, and jump to
8918 restart_sequence; the loop will read keys from keybuf up until
8919 mock_input, thus rebuilding the state; and then it will resume
8920 reading characters from the keyboard. */
8923 /* If the sequence is unbound in submaps[], then
8924 keybuf[fkey.start..fkey.end-1] is a prefix in Vfunction_key_map,
8925 and fkey.map is its binding.
8927 These might be > t, indicating that all function key scanning
8928 should hold off until t reaches them. We do this when we've just
8929 recognized a function key, to avoid searching for the function
8930 key's again in Vfunction_key_map. */
8933 /* Likewise, for key_translation_map and input-decode-map. */
8934 keyremap keytran
, indec
;
8936 /* True if we are trying to map a key by changing an upper-case
8937 letter to lower case, or a shifted function key to an unshifted
8939 bool shift_translated
= 0;
8941 /* If we receive a `switch-frame' or `select-window' event in the middle of
8942 a key sequence, we put it off for later.
8943 While we're reading, we keep the event here. */
8944 Lisp_Object delayed_switch_frame
;
8946 /* See the comment below... */
8947 #if defined (GOBBLE_FIRST_EVENT)
8948 Lisp_Object first_event
;
8951 Lisp_Object original_uppercase
IF_LINT (= Qnil
);
8952 int original_uppercase_position
= -1;
8954 /* Gets around Microsoft compiler limitations. */
8957 struct buffer
*starting_buffer
;
8959 /* List of events for which a fake prefix key has been generated. */
8960 Lisp_Object fake_prefixed_keys
= Qnil
;
8962 #if defined (GOBBLE_FIRST_EVENT)
8966 struct gcpro gcpro1
;
8968 GCPRO1 (fake_prefixed_keys
);
8969 raw_keybuf_count
= 0;
8971 last_nonmenu_event
= Qnil
;
8973 delayed_switch_frame
= Qnil
;
8979 /* Install the string STR as the beginning of the string of
8980 echoing, so that it serves as a prompt for the next
8982 kset_echo_string (current_kboard
, prompt
);
8983 current_kboard
->echo_after_prompt
= SCHARS (prompt
);
8986 else if (cursor_in_echo_area
8987 && (FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
8988 && NILP (Fzerop (Vecho_keystrokes
)))
8989 /* This doesn't put in a dash if the echo buffer is empty, so
8990 you don't always see a dash hanging out in the minibuffer. */
8994 /* Record the initial state of the echo area and this_command_keys;
8995 we will need to restore them if we replay a key sequence. */
8997 echo_start
= echo_length ();
8998 keys_start
= this_command_key_count
;
8999 this_single_command_key_start
= keys_start
;
9001 #if defined (GOBBLE_FIRST_EVENT)
9002 /* This doesn't quite work, because some of the things that read_char
9003 does cannot safely be bypassed. It seems too risky to try to make
9006 /* Read the first char of the sequence specially, before setting
9007 up any keymaps, in case a filter runs and switches buffers on us. */
9008 first_event
= read_char (NILP (prompt
), 0, submaps
, last_nonmenu_event
,
9010 #endif /* GOBBLE_FIRST_EVENT */
9012 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
9013 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9016 /* We jump here when we need to reinitialize fkey and keytran; this
9017 happens if we switch keyboards between rescans. */
9018 replay_entire_sequence
:
9020 indec
.map
= indec
.parent
= KVAR (current_kboard
, Vinput_decode_map
);
9021 fkey
.map
= fkey
.parent
= KVAR (current_kboard
, Vlocal_function_key_map
);
9022 keytran
.map
= keytran
.parent
= Vkey_translation_map
;
9023 indec
.start
= indec
.end
= 0;
9024 fkey
.start
= fkey
.end
= 0;
9025 keytran
.start
= keytran
.end
= 0;
9027 /* We jump here when the key sequence has been thoroughly changed, and
9028 we need to rescan it starting from the beginning. When we jump here,
9029 keybuf[0..mock_input] holds the sequence we should reread. */
9032 starting_buffer
= current_buffer
;
9033 first_unbound
= bufsize
+ 1;
9035 /* Build our list of keymaps.
9036 If we recognize a function key and replace its escape sequence in
9037 keybuf with its symbol, or if the sequence starts with a mouse
9038 click and we need to switch buffers, we jump back here to rebuild
9039 the initial keymaps from the current buffer. */
9042 if (!NILP (KVAR (current_kboard
, Voverriding_terminal_local_map
)))
9044 if (2 > nmaps_allocated
)
9046 submaps
= alloca (2 * sizeof *submaps
);
9047 defs
= alloca (2 * sizeof *defs
);
9048 nmaps_allocated
= 2;
9050 submaps
[nmaps
++] = KVAR (current_kboard
, Voverriding_terminal_local_map
);
9052 else if (!NILP (Voverriding_local_map
))
9054 if (2 > nmaps_allocated
)
9056 submaps
= alloca (2 * sizeof *submaps
);
9057 defs
= alloca (2 * sizeof *defs
);
9058 nmaps_allocated
= 2;
9060 submaps
[nmaps
++] = Voverriding_local_map
;
9068 nminor
= current_minor_maps (0, &maps
);
9069 total
= nminor
+ (!NILP (orig_keymap
) ? 3 : 2);
9071 if (total
> nmaps_allocated
)
9073 submaps
= alloca (total
* sizeof *submaps
);
9074 defs
= alloca (total
* sizeof *defs
);
9075 nmaps_allocated
= total
;
9078 if (!NILP (orig_keymap
))
9079 submaps
[nmaps
++] = orig_keymap
;
9081 memcpy (submaps
+ nmaps
, maps
, nminor
* sizeof (submaps
[0]));
9085 submaps
[nmaps
++] = orig_local_map
;
9087 submaps
[nmaps
++] = current_global_map
;
9089 /* Find an accurate initial value for first_binding. */
9090 for (first_binding
= 0; first_binding
< nmaps
; first_binding
++)
9091 if (! NILP (submaps
[first_binding
]))
9094 /* Start from the beginning in keybuf. */
9097 /* These are no-ops the first time through, but if we restart, they
9098 revert the echo area and this_command_keys to their original state. */
9099 this_command_key_count
= keys_start
;
9100 if (INTERACTIVE
&& t
< mock_input
)
9101 echo_truncate (echo_start
);
9103 /* If the best binding for the current key sequence is a keymap, or
9104 we may be looking at a function key's escape sequence, keep on
9106 while (first_binding
< nmaps
9107 /* Keep reading as long as there's a prefix binding. */
9108 ? !NILP (submaps
[first_binding
])
9109 /* Don't return in the middle of a possible function key sequence,
9110 if the only bindings we found were via case conversion.
9111 Thus, if ESC O a has a function-key-map translation
9112 and ESC o has a binding, don't return after ESC O,
9113 so that we can translate ESC O plus the next character. */
9114 : (/* indec.start < t || fkey.start < t || */ keytran
.start
< t
))
9117 bool used_mouse_menu
= 0;
9119 /* Where the last real key started. If we need to throw away a
9120 key that has expanded into more than one element of keybuf
9121 (say, a mouse click on the mode line which is being treated
9122 as [mode-line (mouse-...)], then we backtrack to this point
9124 int last_real_key_start
;
9126 /* These variables are analogous to echo_start and keys_start;
9127 while those allow us to restart the entire key sequence,
9128 echo_local_start and keys_local_start allow us to throw away
9130 ptrdiff_t echo_local_start
IF_LINT (= 0);
9131 int keys_local_start
;
9132 ptrdiff_t local_first_binding
;
9134 eassert (indec
.end
== t
|| (indec
.end
> t
&& indec
.end
<= mock_input
));
9135 eassert (indec
.start
<= indec
.end
);
9136 eassert (fkey
.start
<= fkey
.end
);
9137 eassert (keytran
.start
<= keytran
.end
);
9138 /* key-translation-map is applied *after* function-key-map
9139 which is itself applied *after* input-decode-map. */
9140 eassert (fkey
.end
<= indec
.start
);
9141 eassert (keytran
.end
<= fkey
.start
);
9143 if (/* first_unbound < indec.start && first_unbound < fkey.start && */
9144 first_unbound
< keytran
.start
)
9145 { /* The prefix upto first_unbound has no binding and has
9146 no translation left to do either, so we know it's unbound.
9147 If we don't stop now, we risk staying here indefinitely
9148 (if the user keeps entering fkey or keytran prefixes
9149 like C-c ESC ESC ESC ESC ...) */
9151 for (i
= first_unbound
+ 1; i
< t
; i
++)
9152 keybuf
[i
- first_unbound
- 1] = keybuf
[i
];
9153 mock_input
= t
- first_unbound
- 1;
9154 indec
.end
= indec
.start
-= first_unbound
+ 1;
9155 indec
.map
= indec
.parent
;
9156 fkey
.end
= fkey
.start
-= first_unbound
+ 1;
9157 fkey
.map
= fkey
.parent
;
9158 keytran
.end
= keytran
.start
-= first_unbound
+ 1;
9159 keytran
.map
= keytran
.parent
;
9160 goto replay_sequence
;
9164 error ("Key sequence too long");
9167 echo_local_start
= echo_length ();
9168 keys_local_start
= this_command_key_count
;
9169 local_first_binding
= first_binding
;
9172 /* These are no-ops, unless we throw away a keystroke below and
9173 jumped back up to replay_key; in that case, these restore the
9174 variables to their original state, allowing us to replay the
9176 if (INTERACTIVE
&& t
< mock_input
)
9177 echo_truncate (echo_local_start
);
9178 this_command_key_count
= keys_local_start
;
9179 first_binding
= local_first_binding
;
9181 /* By default, assume each event is "real". */
9182 last_real_key_start
= t
;
9184 /* Does mock_input indicate that we are re-reading a key sequence? */
9188 add_command_key (key
);
9189 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
9190 && NILP (Fzerop (Vecho_keystrokes
)))
9194 /* If not, we should actually read a character. */
9198 KBOARD
*interrupted_kboard
= current_kboard
;
9199 struct frame
*interrupted_frame
= SELECTED_FRAME ();
9200 key
= read_char (NILP (prompt
), nmaps
,
9201 (Lisp_Object
*) submaps
, last_nonmenu_event
,
9202 &used_mouse_menu
, NULL
);
9203 if ((INTEGERP (key
) && XINT (key
) == -2) /* wrong_kboard_jmpbuf */
9204 /* When switching to a new tty (with a new keyboard),
9205 read_char returns the new buffer, rather than -2
9206 (Bug#5095). This is because `terminal-init-xterm'
9207 calls read-char, which eats the wrong_kboard_jmpbuf
9208 return. Any better way to fix this? -- cyd */
9209 || (interrupted_kboard
!= current_kboard
))
9214 for (k
= all_kboards
; k
; k
= k
->next_kboard
)
9215 if (k
== interrupted_kboard
)
9220 /* Don't touch interrupted_kboard when it's been
9222 delayed_switch_frame
= Qnil
;
9223 goto replay_entire_sequence
;
9226 if (!NILP (delayed_switch_frame
))
9229 (interrupted_kboard
,
9230 Fcons (delayed_switch_frame
,
9231 KVAR (interrupted_kboard
, kbd_queue
)));
9232 delayed_switch_frame
= Qnil
;
9237 (interrupted_kboard
,
9238 Fcons (keybuf
[--t
], KVAR (interrupted_kboard
, kbd_queue
)));
9240 /* If the side queue is non-empty, ensure it begins with a
9241 switch-frame, so we'll replay it in the right context. */
9242 if (CONSP (KVAR (interrupted_kboard
, kbd_queue
))
9243 && (key
= XCAR (KVAR (interrupted_kboard
, kbd_queue
)),
9244 !(EVENT_HAS_PARAMETERS (key
)
9245 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)),
9249 XSETFRAME (frame
, interrupted_frame
);
9251 (interrupted_kboard
,
9252 Fcons (make_lispy_switch_frame (frame
),
9253 KVAR (interrupted_kboard
, kbd_queue
)));
9256 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
9257 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9258 goto replay_entire_sequence
;
9262 /* read_char returns t when it shows a menu and the user rejects it.
9266 unbind_to (count
, Qnil
);
9271 /* read_char returns -1 at the end of a macro.
9272 Emacs 18 handles this by returning immediately with a
9273 zero, so that's what we'll do. */
9274 if (INTEGERP (key
) && XINT (key
) == -1)
9277 /* The Microsoft C compiler can't handle the goto that
9283 /* If the current buffer has been changed from under us, the
9284 keymap may have changed, so replay the sequence. */
9287 timer_resume_idle ();
9290 /* Reset the current buffer from the selected window
9291 in case something changed the former and not the latter.
9292 This is to be more consistent with the behavior
9293 of the command_loop_1. */
9294 if (fix_current_buffer
)
9296 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
9298 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
9299 Fset_buffer (XWINDOW (selected_window
)->buffer
);
9302 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
9303 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9304 goto replay_sequence
;
9307 /* If we have a quit that was typed in another frame, and
9308 quit_throw_to_read_char switched buffers,
9309 replay to get the right keymap. */
9311 && XINT (key
) == quit_char
9312 && current_buffer
!= starting_buffer
)
9315 ASET (raw_keybuf
, raw_keybuf_count
, key
);
9320 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
9321 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9322 goto replay_sequence
;
9327 if (EVENT_HAS_PARAMETERS (key
)
9328 /* Either a `switch-frame' or a `select-window' event. */
9329 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)), Qswitch_frame
))
9331 /* If we're at the beginning of a key sequence, and the caller
9332 says it's okay, go ahead and return this event. If we're
9333 in the midst of a key sequence, delay it until the end. */
9334 if (t
> 0 || !can_return_switch_frame
)
9336 delayed_switch_frame
= key
;
9342 ASET (raw_keybuf
, raw_keybuf_count
, key
);
9346 /* Clicks in non-text areas get prefixed by the symbol
9347 in their CHAR-ADDRESS field. For example, a click on
9348 the mode line is prefixed by the symbol `mode-line'.
9350 Furthermore, key sequences beginning with mouse clicks
9351 are read using the keymaps of the buffer clicked on, not
9352 the current buffer. So we may have to switch the buffer
9355 When we turn one event into two events, we must make sure
9356 that neither of the two looks like the original--so that,
9357 if we replay the events, they won't be expanded again.
9358 If not for this, such reexpansion could happen either here
9359 or when user programs play with this-command-keys. */
9360 if (EVENT_HAS_PARAMETERS (key
))
9365 kind
= EVENT_HEAD_KIND (EVENT_HEAD (key
));
9366 if (EQ (kind
, Qmouse_click
))
9368 Lisp_Object window
, posn
;
9370 window
= POSN_WINDOW (EVENT_START (key
));
9371 posn
= POSN_POSN (EVENT_START (key
));
9374 || (!NILP (fake_prefixed_keys
)
9375 && !NILP (Fmemq (key
, fake_prefixed_keys
))))
9377 /* We're looking a second time at an event for which
9378 we generated a fake prefix key. Set
9379 last_real_key_start appropriately. */
9381 last_real_key_start
= t
- 1;
9384 if (last_real_key_start
== 0)
9386 /* Key sequences beginning with mouse clicks are
9387 read using the keymaps in the buffer clicked on,
9388 not the current buffer. If we're at the
9389 beginning of a key sequence, switch buffers. */
9390 if (WINDOWP (window
)
9391 && BUFFERP (XWINDOW (window
)->buffer
)
9392 && XBUFFER (XWINDOW (window
)->buffer
) != current_buffer
)
9394 ASET (raw_keybuf
, raw_keybuf_count
, key
);
9399 /* Arrange to go back to the original buffer once we're
9400 done reading the key sequence. Note that we can't
9401 use save_excursion_{save,restore} here, because they
9402 save point as well as the current buffer; we don't
9403 want to save point, because redisplay may change it,
9404 to accommodate a Fset_window_start or something. We
9405 don't want to do this at the top of the function,
9406 because we may get input from a subprocess which
9407 wants to change the selected window and stuff (say,
9409 record_unwind_current_buffer ();
9411 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
9413 set_buffer_internal (XBUFFER (XWINDOW (window
)->buffer
));
9414 orig_local_map
= get_local_map (PT
, current_buffer
,
9416 orig_keymap
= get_local_map (PT
, current_buffer
,
9418 goto replay_sequence
;
9421 /* For a mouse click, get the local text-property keymap
9422 of the place clicked on, rather than point. */
9423 if (CONSP (XCDR (key
))
9424 && ! localized_local_map
)
9426 Lisp_Object map_here
, start
, pos
;
9428 localized_local_map
= 1;
9429 start
= EVENT_START (key
);
9431 if (CONSP (start
) && POSN_INBUFFER_P (start
))
9433 pos
= POSN_BUFFER_POSN (start
);
9435 && XINT (pos
) >= BEGV
9436 && XINT (pos
) <= ZV
)
9438 map_here
= get_local_map (XINT (pos
),
9441 if (!EQ (map_here
, orig_local_map
))
9443 orig_local_map
= map_here
;
9444 ++localized_local_map
;
9447 map_here
= get_local_map (XINT (pos
),
9450 if (!EQ (map_here
, orig_keymap
))
9452 orig_keymap
= map_here
;
9453 ++localized_local_map
;
9456 if (localized_local_map
> 1)
9461 goto replay_sequence
;
9468 /* Expand mode-line and scroll-bar events into two events:
9469 use posn as a fake prefix key. */
9471 && (NILP (fake_prefixed_keys
)
9472 || NILP (Fmemq (key
, fake_prefixed_keys
))))
9474 if (bufsize
- t
<= 1)
9475 error ("Key sequence too long");
9478 keybuf
[t
+ 1] = key
;
9481 /* Record that a fake prefix key has been generated
9482 for KEY. Don't modify the event; this would
9483 prevent proper action when the event is pushed
9484 back into unread-command-events. */
9485 fake_prefixed_keys
= Fcons (key
, fake_prefixed_keys
);
9487 /* If on a mode line string with a local keymap,
9488 reconsider the key sequence with that keymap. */
9489 if (string
= POSN_STRING (EVENT_START (key
)),
9490 (CONSP (string
) && STRINGP (XCAR (string
))))
9492 Lisp_Object pos
, map
, map2
;
9494 pos
= XCDR (string
);
9495 string
= XCAR (string
);
9497 && XINT (pos
) < SCHARS (string
))
9499 map
= Fget_text_property (pos
, Qlocal_map
, string
);
9501 orig_local_map
= map
;
9502 map2
= Fget_text_property (pos
, Qkeymap
, string
);
9505 if (!NILP (map
) || !NILP (map2
))
9506 goto replay_sequence
;
9512 else if (NILP (from_string
)
9513 && (string
= POSN_STRING (EVENT_START (key
)),
9514 (CONSP (string
) && STRINGP (XCAR (string
)))))
9516 /* For a click on a string, i.e. overlay string or a
9517 string displayed via the `display' property,
9518 consider `local-map' and `keymap' properties of
9520 Lisp_Object pos
, map
, map2
;
9522 pos
= XCDR (string
);
9523 string
= XCAR (string
);
9525 && XINT (pos
) < SCHARS (string
))
9527 map
= Fget_text_property (pos
, Qlocal_map
, string
);
9529 orig_local_map
= map
;
9530 map2
= Fget_text_property (pos
, Qkeymap
, string
);
9534 if (!NILP (map
) || !NILP (map2
))
9536 from_string
= string
;
9539 goto replay_sequence
;
9544 else if (CONSP (XCDR (key
))
9545 && CONSP (EVENT_START (key
))
9546 && CONSP (XCDR (EVENT_START (key
))))
9550 posn
= POSN_POSN (EVENT_START (key
));
9551 /* Handle menu-bar events:
9552 insert the dummy prefix event `menu-bar'. */
9553 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
9555 if (bufsize
- t
<= 1)
9556 error ("Key sequence too long");
9560 /* Zap the position in key, so we know that we've
9561 expanded it, and don't try to do so again. */
9562 POSN_SET_POSN (EVENT_START (key
),
9563 Fcons (posn
, Qnil
));
9566 goto replay_sequence
;
9568 else if (CONSP (posn
))
9570 /* We're looking at the second event of a
9571 sequence which we expanded before. Set
9572 last_real_key_start appropriately. */
9573 if (last_real_key_start
== t
&& t
> 0)
9574 last_real_key_start
= t
- 1;
9579 /* We have finally decided that KEY is something we might want
9581 first_binding
= (follow_key (key
,
9582 nmaps
- first_binding
,
9583 submaps
+ first_binding
,
9584 defs
+ first_binding
,
9585 submaps
+ first_binding
)
9588 /* If KEY wasn't bound, we'll try some fallbacks. */
9589 if (first_binding
< nmaps
)
9590 /* This is needed for the following scenario:
9591 event 0: a down-event that gets dropped by calling replay_key.
9592 event 1: some normal prefix like C-h.
9593 After event 0, first_unbound is 0, after event 1 indec.start,
9594 fkey.start, and keytran.start are all 1, so when we see that
9595 C-h is bound, we need to update first_unbound. */
9596 first_unbound
= max (t
+ 1, first_unbound
);
9601 /* Remember the position to put an upper bound on indec.start. */
9602 first_unbound
= min (t
, first_unbound
);
9604 head
= EVENT_HEAD (key
);
9605 if (help_char_p (head
) && t
> 0)
9607 read_key_sequence_cmd
= Vprefix_help_command
;
9609 last_nonmenu_event
= key
;
9610 /* The Microsoft C compiler can't handle the goto that
9618 Lisp_Object breakdown
;
9621 breakdown
= parse_modifiers (head
);
9622 modifiers
= XINT (XCAR (XCDR (breakdown
)));
9623 /* Attempt to reduce an unbound mouse event to a simpler
9624 event that is bound:
9625 Drags reduce to clicks.
9626 Double-clicks reduce to clicks.
9627 Triple-clicks reduce to double-clicks, then to clicks.
9628 Down-clicks are eliminated.
9629 Double-downs reduce to downs, then are eliminated.
9630 Triple-downs reduce to double-downs, then to downs,
9631 then are eliminated. */
9632 if (modifiers
& (down_modifier
| drag_modifier
9633 | double_modifier
| triple_modifier
))
9635 while (modifiers
& (down_modifier
| drag_modifier
9636 | double_modifier
| triple_modifier
))
9638 Lisp_Object new_head
, new_click
;
9639 if (modifiers
& triple_modifier
)
9640 modifiers
^= (double_modifier
| triple_modifier
);
9641 else if (modifiers
& double_modifier
)
9642 modifiers
&= ~double_modifier
;
9643 else if (modifiers
& drag_modifier
)
9644 modifiers
&= ~drag_modifier
;
9647 /* Dispose of this `down' event by simply jumping
9648 back to replay_key, to get another event.
9650 Note that if this event came from mock input,
9651 then just jumping back to replay_key will just
9652 hand it to us again. So we have to wipe out any
9655 We could delete keybuf[t] and shift everything
9656 after that to the left by one spot, but we'd also
9657 have to fix up any variable that points into
9658 keybuf, and shifting isn't really necessary
9661 Adding prefixes for non-textual mouse clicks
9662 creates two characters of mock input, and both
9663 must be thrown away. If we're only looking at
9664 the prefix now, we can just jump back to
9665 replay_key. On the other hand, if we've already
9666 processed the prefix, and now the actual click
9667 itself is giving us trouble, then we've lost the
9668 state of the keymaps we want to backtrack to, and
9669 we need to replay the whole sequence to rebuild
9672 Beyond that, only function key expansion could
9673 create more than two keys, but that should never
9674 generate mouse events, so it's okay to zero
9675 mock_input in that case too.
9677 FIXME: The above paragraph seems just plain
9678 wrong, if you consider things like
9679 xterm-mouse-mode. -stef
9681 Isn't this just the most wonderful code ever? */
9683 /* If mock_input > t + 1, the above simplification
9684 will actually end up dropping keys on the floor.
9685 This is probably OK for now, but even
9686 if mock_input <= t + 1, we need to adjust indec,
9688 Typical case [header-line down-mouse-N]:
9689 mock_input = 2, t = 1, fkey.end = 1,
9690 last_real_key_start = 0. */
9691 if (indec
.end
> last_real_key_start
)
9693 indec
.end
= indec
.start
9694 = min (last_real_key_start
, indec
.start
);
9695 indec
.map
= indec
.parent
;
9696 if (fkey
.end
> last_real_key_start
)
9698 fkey
.end
= fkey
.start
9699 = min (last_real_key_start
, fkey
.start
);
9700 fkey
.map
= fkey
.parent
;
9701 if (keytran
.end
> last_real_key_start
)
9703 keytran
.end
= keytran
.start
9704 = min (last_real_key_start
, keytran
.start
);
9705 keytran
.map
= keytran
.parent
;
9709 if (t
== last_real_key_start
)
9716 mock_input
= last_real_key_start
;
9717 goto replay_sequence
;
9722 = apply_modifiers (modifiers
, XCAR (breakdown
));
9724 = Fcons (new_head
, Fcons (EVENT_START (key
), Qnil
));
9726 /* Look for a binding for this new key. follow_key
9727 promises that it didn't munge submaps the
9728 last time we called it, since key was unbound. */
9730 = (follow_key (new_click
,
9731 nmaps
- local_first_binding
,
9732 submaps
+ local_first_binding
,
9733 defs
+ local_first_binding
,
9734 submaps
+ local_first_binding
)
9735 + local_first_binding
);
9737 /* If that click is bound, go for it. */
9738 if (first_binding
< nmaps
)
9743 /* Otherwise, we'll leave key set to the drag event. */
9750 /* Normally, last_nonmenu_event gets the previous key we read.
9751 But when a mouse popup menu is being used,
9752 we don't update last_nonmenu_event; it continues to hold the mouse
9753 event that preceded the first level of menu. */
9754 if (!used_mouse_menu
)
9755 last_nonmenu_event
= key
;
9757 /* Record what part of this_command_keys is the current key sequence. */
9758 this_single_command_key_start
= this_command_key_count
- t
;
9760 /* Look for this sequence in input-decode-map.
9761 Scan from indec.end until we find a bound suffix. */
9762 while (indec
.end
< t
)
9764 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9768 GCPRO4 (indec
.map
, fkey
.map
, keytran
.map
, delayed_switch_frame
);
9769 done
= keyremap_step (keybuf
, bufsize
, &indec
, max (t
, mock_input
),
9774 mock_input
= diff
+ max (t
, mock_input
);
9775 goto replay_sequence
;
9779 if (first_binding
< nmaps
9780 && NILP (submaps
[first_binding
])
9781 && !test_undefined (defs
[first_binding
])
9782 && indec
.start
>= t
)
9783 /* There is a binding and it's not a prefix.
9784 (and it doesn't have any input-decode-map translation pending).
9785 There is thus no function-key in this sequence.
9786 Moving fkey.start is important in this case to allow keytran.start
9787 to go over the sequence before we return (since we keep the
9788 invariant that keytran.end <= fkey.start). */
9791 (fkey
.start
= fkey
.end
= t
, fkey
.map
= fkey
.parent
);
9794 /* If the sequence is unbound, see if we can hang a function key
9795 off the end of it. */
9796 /* Continue scan from fkey.end until we find a bound suffix. */
9797 while (fkey
.end
< indec
.start
)
9799 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9803 GCPRO4 (indec
.map
, fkey
.map
, keytran
.map
, delayed_switch_frame
);
9804 done
= keyremap_step (keybuf
, bufsize
, &fkey
,
9805 max (t
, mock_input
),
9806 /* If there's a binding (i.e.
9807 first_binding >= nmaps) we don't want
9808 to apply this function-key-mapping. */
9810 && (first_binding
>= nmaps
9811 || test_undefined (defs
[first_binding
])),
9816 mock_input
= diff
+ max (t
, mock_input
);
9817 /* Adjust the input-decode-map counters. */
9819 indec
.start
+= diff
;
9821 goto replay_sequence
;
9825 /* Look for this sequence in key-translation-map.
9826 Scan from keytran.end until we find a bound suffix. */
9827 while (keytran
.end
< fkey
.start
)
9829 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9833 GCPRO4 (indec
.map
, fkey
.map
, keytran
.map
, delayed_switch_frame
);
9834 done
= keyremap_step (keybuf
, bufsize
, &keytran
, max (t
, mock_input
),
9839 mock_input
= diff
+ max (t
, mock_input
);
9840 /* Adjust the function-key-map and input-decode-map counters. */
9842 indec
.start
+= diff
;
9846 goto replay_sequence
;
9850 /* If KEY is not defined in any of the keymaps,
9851 and cannot be part of a function key or translation,
9852 and is an upper case letter
9853 use the corresponding lower-case letter instead. */
9854 if (first_binding
>= nmaps
9855 && /* indec.start >= t && fkey.start >= t && */ keytran
.start
>= t
9857 && ((CHARACTERP (make_number (XINT (key
) & ~CHAR_MODIFIER_MASK
))
9858 && uppercasep (XINT (key
) & ~CHAR_MODIFIER_MASK
))
9859 || (XINT (key
) & shift_modifier
)))
9861 Lisp_Object new_key
;
9863 original_uppercase
= key
;
9864 original_uppercase_position
= t
- 1;
9866 if (XINT (key
) & shift_modifier
)
9867 XSETINT (new_key
, XINT (key
) & ~shift_modifier
);
9869 XSETINT (new_key
, (downcase (XINT (key
) & ~CHAR_MODIFIER_MASK
)
9870 | (XINT (key
) & CHAR_MODIFIER_MASK
)));
9872 /* We have to do this unconditionally, regardless of whether
9873 the lower-case char is defined in the keymaps, because they
9874 might get translated through function-key-map. */
9875 keybuf
[t
- 1] = new_key
;
9876 mock_input
= max (t
, mock_input
);
9877 shift_translated
= 1;
9879 goto replay_sequence
;
9881 /* If KEY is not defined in any of the keymaps,
9882 and cannot be part of a function key or translation,
9883 and is a shifted function key,
9884 use the corresponding unshifted function key instead. */
9885 if (first_binding
>= nmaps
9886 && /* indec.start >= t && fkey.start >= t && */ keytran
.start
>= t
)
9888 Lisp_Object breakdown
= parse_modifiers (key
);
9890 = CONSP (breakdown
) ? (XINT (XCAR (XCDR (breakdown
)))) : 0;
9892 if (modifiers
& shift_modifier
9893 /* Treat uppercase keys as shifted. */
9895 && (KEY_TO_CHAR (key
)
9896 < XCHAR_TABLE (BVAR (current_buffer
, downcase_table
))->header
.size
)
9897 && uppercasep (KEY_TO_CHAR (key
))))
9900 = (modifiers
& shift_modifier
9901 ? apply_modifiers (modifiers
& ~shift_modifier
,
9903 : make_number (downcase (KEY_TO_CHAR (key
)) | modifiers
));
9905 original_uppercase
= key
;
9906 original_uppercase_position
= t
- 1;
9908 /* We have to do this unconditionally, regardless of whether
9909 the lower-case char is defined in the keymaps, because they
9910 might get translated through function-key-map. */
9911 keybuf
[t
- 1] = new_key
;
9912 mock_input
= max (t
, mock_input
);
9913 /* Reset fkey (and consequently keytran) to apply
9914 function-key-map on the result, so that S-backspace is
9915 correctly mapped to DEL (via backspace). OTOH,
9916 input-decode-map doesn't need to go through it again. */
9917 fkey
.start
= fkey
.end
= 0;
9918 keytran
.start
= keytran
.end
= 0;
9919 shift_translated
= 1;
9921 goto replay_sequence
;
9926 read_key_sequence_cmd
= (first_binding
< nmaps
9927 ? defs
[first_binding
]
9929 read_key_sequence_remapped
9930 /* Remap command through active keymaps.
9931 Do the remapping here, before the unbind_to so it uses the keymaps
9932 of the appropriate buffer. */
9933 = SYMBOLP (read_key_sequence_cmd
)
9934 ? Fcommand_remapping (read_key_sequence_cmd
, Qnil
, Qnil
)
9937 unread_switch_frame
= delayed_switch_frame
;
9938 unbind_to (count
, Qnil
);
9940 /* Don't downcase the last character if the caller says don't.
9941 Don't downcase it if the result is undefined, either. */
9942 if ((dont_downcase_last
|| first_binding
>= nmaps
)
9944 && t
- 1 == original_uppercase_position
)
9946 keybuf
[t
- 1] = original_uppercase
;
9947 shift_translated
= 0;
9950 if (shift_translated
)
9951 Vthis_command_keys_shift_translated
= Qt
;
9953 /* Occasionally we fabricate events, perhaps by expanding something
9954 according to function-key-map, or by adding a prefix symbol to a
9955 mouse click in the scroll bar or modeline. In this cases, return
9956 the entire generated key sequence, even if we hit an unbound
9957 prefix or a definition before the end. This means that you will
9958 be able to push back the event properly, and also means that
9959 read-key-sequence will always return a logical unit.
9962 for (; t
< mock_input
; t
++)
9964 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
9965 && NILP (Fzerop (Vecho_keystrokes
)))
9966 echo_char (keybuf
[t
]);
9967 add_command_key (keybuf
[t
]);
9974 DEFUN ("read-key-sequence", Fread_key_sequence
, Sread_key_sequence
, 1, 5, 0,
9975 doc
: /* Read a sequence of keystrokes and return as a string or vector.
9976 The sequence is sufficient to specify a non-prefix command in the
9977 current local and global maps.
9979 First arg PROMPT is a prompt string. If nil, do not prompt specially.
9980 Second (optional) arg CONTINUE-ECHO, if non-nil, means this key echos
9981 as a continuation of the previous key.
9983 The third (optional) arg DONT-DOWNCASE-LAST, if non-nil, means do not
9984 convert the last event to lower case. (Normally any upper case event
9985 is converted to lower case if the original event is undefined and the lower
9986 case equivalent is defined.) A non-nil value is appropriate for reading
9987 a key sequence to be defined.
9989 A C-g typed while in this function is treated like any other character,
9990 and `quit-flag' is not set.
9992 If the key sequence starts with a mouse click, then the sequence is read
9993 using the keymaps of the buffer of the window clicked in, not the buffer
9994 of the selected window as normal.
9996 `read-key-sequence' drops unbound button-down events, since you normally
9997 only care about the click or drag events which follow them. If a drag
9998 or multi-click event is unbound, but the corresponding click event would
9999 be bound, `read-key-sequence' turns the event into a click event at the
10000 drag's starting position. This means that you don't have to distinguish
10001 between click and drag, double, or triple events unless you want to.
10003 `read-key-sequence' prefixes mouse events on mode lines, the vertical
10004 lines separating windows, and scroll bars with imaginary keys
10005 `mode-line', `vertical-line', and `vertical-scroll-bar'.
10007 Optional fourth argument CAN-RETURN-SWITCH-FRAME non-nil means that this
10008 function will process a switch-frame event if the user switches frames
10009 before typing anything. If the user switches frames in the middle of a
10010 key sequence, or at the start of the sequence but CAN-RETURN-SWITCH-FRAME
10011 is nil, then the event will be put off until after the current key sequence.
10013 `read-key-sequence' checks `function-key-map' for function key
10014 sequences, where they wouldn't conflict with ordinary bindings. See
10015 `function-key-map' for more details.
10017 The optional fifth argument CMD-LOOP, if non-nil, means
10018 that this key sequence is being read by something that will
10019 read commands one after another. It should be nil if the caller
10020 will read just one key sequence. */)
10021 (Lisp_Object prompt
, Lisp_Object continue_echo
, Lisp_Object dont_downcase_last
, Lisp_Object can_return_switch_frame
, Lisp_Object cmd_loop
)
10023 Lisp_Object keybuf
[30];
10025 struct gcpro gcpro1
;
10026 ptrdiff_t count
= SPECPDL_INDEX ();
10028 if (!NILP (prompt
))
10029 CHECK_STRING (prompt
);
10032 specbind (Qinput_method_exit_on_first_char
,
10033 (NILP (cmd_loop
) ? Qt
: Qnil
));
10034 specbind (Qinput_method_use_echo_area
,
10035 (NILP (cmd_loop
) ? Qt
: Qnil
));
10037 memset (keybuf
, 0, sizeof keybuf
);
10038 GCPRO1 (keybuf
[0]);
10039 gcpro1
.nvars
= (sizeof keybuf
/sizeof (keybuf
[0]));
10041 if (NILP (continue_echo
))
10043 this_command_key_count
= 0;
10044 this_command_key_count_reset
= 0;
10045 this_single_command_key_start
= 0;
10048 #ifdef HAVE_WINDOW_SYSTEM
10049 if (display_hourglass_p
)
10050 cancel_hourglass ();
10053 i
= read_key_sequence (keybuf
, (sizeof keybuf
/sizeof (keybuf
[0])),
10054 prompt
, ! NILP (dont_downcase_last
),
10055 ! NILP (can_return_switch_frame
), 0);
10057 #if 0 /* The following is fine for code reading a key sequence and
10058 then proceeding with a lengthy computation, but it's not good
10059 for code reading keys in a loop, like an input method. */
10060 #ifdef HAVE_WINDOW_SYSTEM
10061 if (display_hourglass_p
)
10062 start_hourglass ();
10072 return unbind_to (count
, make_event_array (i
, keybuf
));
10075 DEFUN ("read-key-sequence-vector", Fread_key_sequence_vector
,
10076 Sread_key_sequence_vector
, 1, 5, 0,
10077 doc
: /* Like `read-key-sequence' but always return a vector. */)
10078 (Lisp_Object prompt
, Lisp_Object continue_echo
, Lisp_Object dont_downcase_last
, Lisp_Object can_return_switch_frame
, Lisp_Object cmd_loop
)
10080 Lisp_Object keybuf
[30];
10082 struct gcpro gcpro1
;
10083 ptrdiff_t count
= SPECPDL_INDEX ();
10085 if (!NILP (prompt
))
10086 CHECK_STRING (prompt
);
10089 specbind (Qinput_method_exit_on_first_char
,
10090 (NILP (cmd_loop
) ? Qt
: Qnil
));
10091 specbind (Qinput_method_use_echo_area
,
10092 (NILP (cmd_loop
) ? Qt
: Qnil
));
10094 memset (keybuf
, 0, sizeof keybuf
);
10095 GCPRO1 (keybuf
[0]);
10096 gcpro1
.nvars
= (sizeof keybuf
/ sizeof (keybuf
[0]));
10098 if (NILP (continue_echo
))
10100 this_command_key_count
= 0;
10101 this_command_key_count_reset
= 0;
10102 this_single_command_key_start
= 0;
10105 #ifdef HAVE_WINDOW_SYSTEM
10106 if (display_hourglass_p
)
10107 cancel_hourglass ();
10110 i
= read_key_sequence (keybuf
, (sizeof keybuf
/ sizeof (keybuf
[0])),
10111 prompt
, ! NILP (dont_downcase_last
),
10112 ! NILP (can_return_switch_frame
), 0);
10114 #ifdef HAVE_WINDOW_SYSTEM
10115 if (display_hourglass_p
)
10116 start_hourglass ();
10125 return unbind_to (count
, Fvector (i
, keybuf
));
10128 DEFUN ("command-execute", Fcommand_execute
, Scommand_execute
, 1, 4, 0,
10129 doc
: /* Execute CMD as an editor command.
10130 CMD must be a symbol that satisfies the `commandp' predicate.
10131 Optional second arg RECORD-FLAG non-nil
10132 means unconditionally put this command in `command-history'.
10133 Otherwise, that is done only if an arg is read using the minibuffer.
10134 The argument KEYS specifies the value to use instead of (this-command-keys)
10135 when reading the arguments; if it is nil, (this-command-keys) is used.
10136 The argument SPECIAL, if non-nil, means that this command is executing
10137 a special event, so ignore the prefix argument and don't clear it. */)
10138 (Lisp_Object cmd
, Lisp_Object record_flag
, Lisp_Object keys
, Lisp_Object special
)
10140 register Lisp_Object final
;
10141 register Lisp_Object tem
;
10142 Lisp_Object prefixarg
;
10144 debug_on_next_call
= 0;
10146 if (NILP (special
))
10148 prefixarg
= KVAR (current_kboard
, Vprefix_arg
);
10149 Vcurrent_prefix_arg
= prefixarg
;
10150 kset_prefix_arg (current_kboard
, Qnil
);
10157 tem
= Fget (cmd
, Qdisabled
);
10160 tem
= Fsymbol_value (Qdisabled_command_function
);
10162 return Frun_hooks (1, &Qdisabled_command_function
);
10168 final
= Findirect_function (cmd
, Qnil
);
10170 if (CONSP (final
) && (tem
= Fcar (final
), EQ (tem
, Qautoload
)))
10172 struct gcpro gcpro1
, gcpro2
;
10174 GCPRO2 (cmd
, prefixarg
);
10175 Fautoload_do_load (final
, cmd
, Qnil
);
10182 if (STRINGP (final
) || VECTORP (final
))
10184 /* If requested, place the macro in the command history. For
10185 other sorts of commands, call-interactively takes care of
10187 if (!NILP (record_flag
))
10190 = Fcons (Fcons (Qexecute_kbd_macro
,
10191 Fcons (final
, Fcons (prefixarg
, Qnil
))),
10194 /* Don't keep command history around forever. */
10195 if (NUMBERP (Vhistory_length
) && XINT (Vhistory_length
) > 0)
10197 tem
= Fnthcdr (Vhistory_length
, Vcommand_history
);
10199 XSETCDR (tem
, Qnil
);
10203 return Fexecute_kbd_macro (final
, prefixarg
, Qnil
);
10206 if (CONSP (final
) || SUBRP (final
) || COMPILEDP (final
))
10207 /* Don't call Fcall_interactively directly because we want to make
10208 sure the backtrace has an entry for `call-interactively'.
10209 For the same reason, pass `cmd' rather than `final'. */
10210 return call3 (Qcall_interactively
, cmd
, record_flag
, keys
);
10217 /* Return true if input events are pending. */
10220 detect_input_pending (void)
10222 return input_pending
|| get_input_pending (0);
10225 /* Return true if input events other than mouse movements are
10229 detect_input_pending_ignore_squeezables (void)
10231 return input_pending
|| get_input_pending (READABLE_EVENTS_IGNORE_SQUEEZABLES
);
10234 /* Return true if input events are pending, and run any pending timers. */
10237 detect_input_pending_run_timers (bool do_display
)
10239 unsigned old_timers_run
= timers_run
;
10241 if (!input_pending
)
10242 get_input_pending (READABLE_EVENTS_DO_TIMERS_NOW
);
10244 if (old_timers_run
!= timers_run
&& do_display
)
10246 redisplay_preserve_echo_area (8);
10247 /* The following fixes a bug when using lazy-lock with
10248 lazy-lock-defer-on-the-fly set to t, i.e. when fontifying
10249 from an idle timer function. The symptom of the bug is that
10250 the cursor sometimes doesn't become visible until the next X
10251 event is processed. --gerd. */
10253 Lisp_Object tail
, frame
;
10254 FOR_EACH_FRAME (tail
, frame
)
10255 if (FRAME_RIF (XFRAME (frame
)))
10256 FRAME_RIF (XFRAME (frame
))->flush_display (XFRAME (frame
));
10260 return input_pending
;
10263 /* This is called in some cases before a possible quit.
10264 It cases the next call to detect_input_pending to recompute input_pending.
10265 So calling this function unnecessarily can't do any harm. */
10268 clear_input_pending (void)
10273 /* Return true if there are pending requeued events.
10274 This isn't used yet. The hope is to make wait_reading_process_output
10275 call it, and return if it runs Lisp code that unreads something.
10276 The problem is, kbd_buffer_get_event needs to be fixed to know what
10277 to do in that case. It isn't trivial. */
10280 requeued_events_pending_p (void)
10282 return (!NILP (Vunread_command_events
));
10286 DEFUN ("input-pending-p", Finput_pending_p
, Sinput_pending_p
, 0, 0, 0,
10287 doc
: /* Return t if command input is currently available with no wait.
10288 Actually, the value is nil only if we can be sure that no input is available;
10289 if there is a doubt, the value is t. */)
10292 if (!NILP (Vunread_command_events
)
10293 || !NILP (Vunread_post_input_method_events
)
10294 || !NILP (Vunread_input_method_events
))
10297 /* Process non-user-visible events (Bug#10195). */
10298 process_special_events ();
10300 return (get_input_pending (READABLE_EVENTS_DO_TIMERS_NOW
10301 | READABLE_EVENTS_FILTER_EVENTS
)
10305 DEFUN ("recent-keys", Frecent_keys
, Srecent_keys
, 0, 0, 0,
10306 doc
: /* Return vector of last 300 events, not counting those from keyboard macros. */)
10309 Lisp_Object
*keys
= XVECTOR (recent_keys
)->contents
;
10312 if (total_keys
< NUM_RECENT_KEYS
)
10313 return Fvector (total_keys
, keys
);
10316 val
= Fvector (NUM_RECENT_KEYS
, keys
);
10317 vcopy (val
, 0, keys
+ recent_keys_index
,
10318 NUM_RECENT_KEYS
- recent_keys_index
);
10319 vcopy (val
, NUM_RECENT_KEYS
- recent_keys_index
,
10320 keys
, recent_keys_index
);
10325 DEFUN ("this-command-keys", Fthis_command_keys
, Sthis_command_keys
, 0, 0, 0,
10326 doc
: /* Return the key sequence that invoked this command.
10327 However, if the command has called `read-key-sequence', it returns
10328 the last key sequence that has been read.
10329 The value is a string or a vector.
10331 See also `this-command-keys-vector'. */)
10334 return make_event_array (this_command_key_count
,
10335 XVECTOR (this_command_keys
)->contents
);
10338 DEFUN ("this-command-keys-vector", Fthis_command_keys_vector
, Sthis_command_keys_vector
, 0, 0, 0,
10339 doc
: /* Return the key sequence that invoked this command, as a vector.
10340 However, if the command has called `read-key-sequence', it returns
10341 the last key sequence that has been read.
10343 See also `this-command-keys'. */)
10346 return Fvector (this_command_key_count
,
10347 XVECTOR (this_command_keys
)->contents
);
10350 DEFUN ("this-single-command-keys", Fthis_single_command_keys
,
10351 Sthis_single_command_keys
, 0, 0, 0,
10352 doc
: /* Return the key sequence that invoked this command.
10353 More generally, it returns the last key sequence read, either by
10354 the command loop or by `read-key-sequence'.
10355 Unlike `this-command-keys', this function's value
10356 does not include prefix arguments.
10357 The value is always a vector. */)
10360 return Fvector (this_command_key_count
10361 - this_single_command_key_start
,
10362 (XVECTOR (this_command_keys
)->contents
10363 + this_single_command_key_start
));
10366 DEFUN ("this-single-command-raw-keys", Fthis_single_command_raw_keys
,
10367 Sthis_single_command_raw_keys
, 0, 0, 0,
10368 doc
: /* Return the raw events that were read for this command.
10369 More generally, it returns the last key sequence read, either by
10370 the command loop or by `read-key-sequence'.
10371 Unlike `this-single-command-keys', this function's value
10372 shows the events before all translations (except for input methods).
10373 The value is always a vector. */)
10376 return Fvector (raw_keybuf_count
,
10377 (XVECTOR (raw_keybuf
)->contents
));
10380 DEFUN ("reset-this-command-lengths", Freset_this_command_lengths
,
10381 Sreset_this_command_lengths
, 0, 0, 0,
10382 doc
: /* Make the unread events replace the last command and echo.
10383 Used in `universal-argument-other-key'.
10385 `universal-argument-other-key' rereads the event just typed.
10386 It then gets translated through `function-key-map'.
10387 The translated event has to replace the real events,
10388 both in the value of (this-command-keys) and in echoing.
10389 To achieve this, `universal-argument-other-key' calls
10390 `reset-this-command-lengths', which discards the record of reading
10391 these events the first time. */)
10394 this_command_key_count
= before_command_key_count
;
10395 if (this_command_key_count
< this_single_command_key_start
)
10396 this_single_command_key_start
= this_command_key_count
;
10398 echo_truncate (before_command_echo_length
);
10400 /* Cause whatever we put into unread-command-events
10401 to echo as if it were being freshly read from the keyboard. */
10402 this_command_key_count_reset
= 1;
10407 DEFUN ("clear-this-command-keys", Fclear_this_command_keys
,
10408 Sclear_this_command_keys
, 0, 1, 0,
10409 doc
: /* Clear out the vector that `this-command-keys' returns.
10410 Also clear the record of the last 100 events, unless optional arg
10411 KEEP-RECORD is non-nil. */)
10412 (Lisp_Object keep_record
)
10416 this_command_key_count
= 0;
10417 this_command_key_count_reset
= 0;
10419 if (NILP (keep_record
))
10421 for (i
= 0; i
< ASIZE (recent_keys
); ++i
)
10422 ASET (recent_keys
, i
, Qnil
);
10424 recent_keys_index
= 0;
10429 DEFUN ("recursion-depth", Frecursion_depth
, Srecursion_depth
, 0, 0, 0,
10430 doc
: /* Return the current depth in recursive edits. */)
10434 /* Wrap around reliably on integer overflow. */
10435 EMACS_INT sum
= (command_loop_level
& INTMASK
) + (minibuf_level
& INTMASK
);
10436 XSETINT (temp
, sum
);
10440 DEFUN ("open-dribble-file", Fopen_dribble_file
, Sopen_dribble_file
, 1, 1,
10441 "FOpen dribble file: ",
10442 doc
: /* Start writing all keyboard characters to a dribble file called FILE.
10443 If FILE is nil, close any open dribble file.
10444 The file will be closed when Emacs exits. */)
10456 file
= Fexpand_file_name (file
, Qnil
);
10457 dribble
= fopen (SSDATA (file
), "w");
10459 report_file_error ("Opening dribble", Fcons (file
, Qnil
));
10464 DEFUN ("discard-input", Fdiscard_input
, Sdiscard_input
, 0, 0, 0,
10465 doc
: /* Discard the contents of the terminal input buffer.
10466 Also end any kbd macro being defined. */)
10469 if (!NILP (KVAR (current_kboard
, defining_kbd_macro
)))
10471 /* Discard the last command from the macro. */
10472 Fcancel_kbd_macro_events ();
10476 update_mode_lines
++;
10478 Vunread_command_events
= Qnil
;
10480 discard_tty_input ();
10482 kbd_fetch_ptr
= kbd_store_ptr
;
10488 DEFUN ("suspend-emacs", Fsuspend_emacs
, Ssuspend_emacs
, 0, 1, "",
10489 doc
: /* Stop Emacs and return to superior process. You can resume later.
10490 If `cannot-suspend' is non-nil, or if the system doesn't support job
10491 control, run a subshell instead.
10493 If optional arg STUFFSTRING is non-nil, its characters are stuffed
10494 to be read as terminal input by Emacs's parent, after suspension.
10496 Before suspending, run the normal hook `suspend-hook'.
10497 After resumption run the normal hook `suspend-resume-hook'.
10499 Some operating systems cannot stop the Emacs process and resume it later.
10500 On such systems, Emacs starts a subshell instead of suspending. */)
10501 (Lisp_Object stuffstring
)
10503 ptrdiff_t count
= SPECPDL_INDEX ();
10504 int old_height
, old_width
;
10506 struct gcpro gcpro1
;
10509 if (tty_list
&& tty_list
->next
)
10510 error ("There are other tty frames open; close them before suspending Emacs");
10512 if (!NILP (stuffstring
))
10513 CHECK_STRING (stuffstring
);
10515 /* Run the functions in suspend-hook. */
10516 hook
= intern ("suspend-hook");
10517 Frun_hooks (1, &hook
);
10519 GCPRO1 (stuffstring
);
10520 get_tty_size (fileno (CURTTY ()->input
), &old_width
, &old_height
);
10521 reset_all_sys_modes ();
10522 /* sys_suspend can get an error if it tries to fork a subshell
10523 and the system resources aren't available for that. */
10524 record_unwind_protect ((Lisp_Object (*) (Lisp_Object
)) init_all_sys_modes
,
10526 stuff_buffered_input (stuffstring
);
10527 if (cannot_suspend
)
10531 unbind_to (count
, Qnil
);
10533 /* Check if terminal/window size has changed.
10534 Note that this is not useful when we are running directly
10535 with a window system; but suspend should be disabled in that case. */
10536 get_tty_size (fileno (CURTTY ()->input
), &width
, &height
);
10537 if (width
!= old_width
|| height
!= old_height
)
10538 change_frame_size (SELECTED_FRAME (), height
, width
, 0, 0, 0);
10540 /* Run suspend-resume-hook. */
10541 hook
= intern ("suspend-resume-hook");
10542 Frun_hooks (1, &hook
);
10548 /* If STUFFSTRING is a string, stuff its contents as pending terminal input.
10549 Then in any case stuff anything Emacs has read ahead and not used. */
10552 stuff_buffered_input (Lisp_Object stuffstring
)
10554 #ifdef SIGTSTP /* stuff_char is defined if SIGTSTP. */
10555 register unsigned char *p
;
10557 if (STRINGP (stuffstring
))
10559 register ptrdiff_t count
;
10561 p
= SDATA (stuffstring
);
10562 count
= SBYTES (stuffstring
);
10563 while (count
-- > 0)
10568 /* Anything we have read ahead, put back for the shell to read. */
10569 /* ?? What should this do when we have multiple keyboards??
10570 Should we ignore anything that was typed in at the "wrong" kboard?
10572 rms: we should stuff everything back into the kboard
10574 for (; kbd_fetch_ptr
!= kbd_store_ptr
; kbd_fetch_ptr
++)
10577 if (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
10578 kbd_fetch_ptr
= kbd_buffer
;
10579 if (kbd_fetch_ptr
->kind
== ASCII_KEYSTROKE_EVENT
)
10580 stuff_char (kbd_fetch_ptr
->code
);
10582 clear_event (kbd_fetch_ptr
);
10586 #endif /* SIGTSTP */
10590 set_waiting_for_input (EMACS_TIME
*time_to_clear
)
10592 input_available_clear_time
= time_to_clear
;
10594 /* Tell handle_interrupt to throw back to read_char, */
10595 waiting_for_input
= 1;
10597 /* If handle_interrupt was called before and buffered a C-g,
10598 make it run again now, to avoid timing error. */
10599 if (!NILP (Vquit_flag
))
10600 quit_throw_to_read_char (0);
10604 clear_waiting_for_input (void)
10606 /* Tell handle_interrupt not to throw back to read_char, */
10607 waiting_for_input
= 0;
10608 input_available_clear_time
= 0;
10611 /* The SIGINT handler.
10613 If we have a frame on the controlling tty, we assume that the
10614 SIGINT was generated by C-g, so we call handle_interrupt.
10615 Otherwise, tell QUIT to kill Emacs. */
10618 handle_interrupt_signal (int sig
)
10620 /* See if we have an active terminal on our controlling tty. */
10621 struct terminal
*terminal
= get_named_tty ("/dev/tty");
10624 /* If there are no frames there, let's pretend that we are a
10625 well-behaving UN*X program and quit. We must not call Lisp
10626 in a signal handler, so tell QUIT to exit when it is
10628 Vquit_flag
= Qkill_emacs
;
10632 /* Otherwise, the SIGINT was probably generated by C-g. */
10634 /* Set internal_last_event_frame to the top frame of the
10635 controlling tty, if we have a frame there. We disable the
10636 interrupt key on secondary ttys, so the SIGINT must have come
10637 from the controlling tty. */
10638 internal_last_event_frame
= terminal
->display_info
.tty
->top_frame
;
10640 handle_interrupt (1);
10645 deliver_interrupt_signal (int sig
)
10647 deliver_process_signal (sig
, handle_interrupt_signal
);
10651 /* If Emacs is stuck because `inhibit-quit' is true, then keep track
10652 of the number of times C-g has been requested. If C-g is pressed
10653 enough times, then quit anyway. See bug#6585. */
10654 static int volatile force_quit_count
;
10656 /* This routine is called at interrupt level in response to C-g.
10658 It is called from the SIGINT handler or kbd_buffer_store_event.
10660 If `waiting_for_input' is non zero, then unless `echoing' is
10661 nonzero, immediately throw back to read_char.
10663 Otherwise it sets the Lisp variable quit-flag not-nil. This causes
10664 eval to throw, when it gets a chance. If quit-flag is already
10665 non-nil, it stops the job right away. */
10668 handle_interrupt (bool in_signal_handler
)
10674 /* XXX This code needs to be revised for multi-tty support. */
10675 if (!NILP (Vquit_flag
) && get_named_tty ("/dev/tty"))
10677 if (! in_signal_handler
)
10679 /* If SIGINT isn't blocked, don't let us be interrupted by
10680 a SIGINT. It might be harmful due to non-reentrancy
10681 in I/O functions. */
10683 sigemptyset (&blocked
);
10684 sigaddset (&blocked
, SIGINT
);
10685 pthread_sigmask (SIG_BLOCK
, &blocked
, 0);
10689 reset_all_sys_modes ();
10691 #ifdef SIGTSTP /* Support possible in later USG versions */
10693 * On systems which can suspend the current process and return to the original
10694 * shell, this command causes the user to end up back at the shell.
10695 * The "Auto-save" and "Abort" questions are not asked until
10696 * the user elects to return to emacs, at which point he can save the current
10697 * job and either dump core or continue.
10701 /* Perhaps should really fork an inferior shell?
10702 But that would not provide any way to get back
10703 to the original shell, ever. */
10704 printf ("No support for stopping a process on this operating system;\n");
10705 printf ("you can continue or abort.\n");
10706 #endif /* not SIGTSTP */
10708 /* We must remain inside the screen area when the internal terminal
10709 is used. Note that [Enter] is not echoed by dos. */
10710 cursor_to (SELECTED_FRAME (), 0, 0);
10712 /* It doesn't work to autosave while GC is in progress;
10713 the code used for auto-saving doesn't cope with the mark bit. */
10714 if (!gc_in_progress
)
10716 printf ("Auto-save? (y or n) ");
10718 if (((c
= getchar ()) & ~040) == 'Y')
10720 Fdo_auto_save (Qt
, Qnil
);
10722 printf ("\r\nAuto-save done");
10723 #else /* not MSDOS */
10724 printf ("Auto-save done\n");
10725 #endif /* not MSDOS */
10727 while (c
!= '\n') c
= getchar ();
10731 /* During GC, it must be safe to reenable quitting again. */
10732 Vinhibit_quit
= Qnil
;
10735 #endif /* not MSDOS */
10736 printf ("Garbage collection in progress; cannot auto-save now\r\n");
10737 printf ("but will instead do a real quit after garbage collection ends\r\n");
10742 printf ("\r\nAbort? (y or n) ");
10743 #else /* not MSDOS */
10744 printf ("Abort (and dump core)? (y or n) ");
10745 #endif /* not MSDOS */
10747 if (((c
= getchar ()) & ~040) == 'Y')
10749 while (c
!= '\n') c
= getchar ();
10751 printf ("\r\nContinuing...\r\n");
10752 #else /* not MSDOS */
10753 printf ("Continuing...\n");
10754 #endif /* not MSDOS */
10756 init_all_sys_modes ();
10760 /* If executing a function that wants to be interrupted out of
10761 and the user has not deferred quitting by binding `inhibit-quit'
10762 then quit right away. */
10763 if (immediate_quit
&& NILP (Vinhibit_quit
))
10765 struct gl_state_s saved
;
10766 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
10768 immediate_quit
= 0;
10769 pthread_sigmask (SIG_SETMASK
, &empty_mask
, 0);
10771 GCPRO4 (saved
.object
, saved
.global_code
,
10772 saved
.current_syntax_table
, saved
.old_prop
);
10773 Fsignal (Qquit
, Qnil
);
10778 { /* Else request quit when it's safe. */
10779 int count
= NILP (Vquit_flag
) ? 1 : force_quit_count
+ 1;
10780 force_quit_count
= count
;
10783 immediate_quit
= 1;
10784 Vinhibit_quit
= Qnil
;
10790 pthread_sigmask (SIG_SETMASK
, &empty_mask
, 0);
10792 /* TODO: The longjmp in this call throws the NS event loop integration off,
10793 and it seems to do fine without this. Probably some attention
10794 needs to be paid to the setting of waiting_for_input in
10795 wait_reading_process_output() under HAVE_NS because of the call
10796 to ns_select there (needed because otherwise events aren't picked up
10797 outside of polling since we don't get SIGIO like X and we don't have a
10798 separate event loop thread like W32. */
10800 if (waiting_for_input
&& !echoing
)
10801 quit_throw_to_read_char (in_signal_handler
);
10805 /* Handle a C-g by making read_char return C-g. */
10808 quit_throw_to_read_char (bool from_signal
)
10810 /* When not called from a signal handler it is safe to call
10812 if (!from_signal
&& EQ (Vquit_flag
, Qkill_emacs
))
10813 Fkill_emacs (Qnil
);
10815 /* Prevent another signal from doing this before we finish. */
10816 clear_waiting_for_input ();
10819 Vunread_command_events
= Qnil
;
10821 if (FRAMEP (internal_last_event_frame
)
10822 && !EQ (internal_last_event_frame
, selected_frame
))
10823 do_switch_frame (make_lispy_switch_frame (internal_last_event_frame
),
10826 sys_longjmp (getcjmp
, 1);
10829 DEFUN ("set-input-interrupt-mode", Fset_input_interrupt_mode
,
10830 Sset_input_interrupt_mode
, 1, 1, 0,
10831 doc
: /* Set interrupt mode of reading keyboard input.
10832 If INTERRUPT is non-nil, Emacs will use input interrupts;
10833 otherwise Emacs uses CBREAK mode.
10835 See also `current-input-mode'. */)
10836 (Lisp_Object interrupt
)
10838 bool new_interrupt_input
;
10839 #ifdef USABLE_SIGIO
10840 #ifdef HAVE_X_WINDOWS
10841 if (x_display_list
!= NULL
)
10843 /* When using X, don't give the user a real choice,
10844 because we haven't implemented the mechanisms to support it. */
10845 new_interrupt_input
= 1;
10848 #endif /* HAVE_X_WINDOWS */
10849 new_interrupt_input
= !NILP (interrupt
);
10850 #else /* not USABLE_SIGIO */
10851 new_interrupt_input
= 0;
10852 #endif /* not USABLE_SIGIO */
10854 if (new_interrupt_input
!= interrupt_input
)
10856 #ifdef POLL_FOR_INPUT
10860 /* this causes startup screen to be restored and messes with the mouse */
10861 reset_all_sys_modes ();
10862 interrupt_input
= new_interrupt_input
;
10863 init_all_sys_modes ();
10865 interrupt_input
= new_interrupt_input
;
10868 #ifdef POLL_FOR_INPUT
10869 poll_suppress_count
= 1;
10876 DEFUN ("set-output-flow-control", Fset_output_flow_control
, Sset_output_flow_control
, 1, 2, 0,
10877 doc
: /* Enable or disable ^S/^Q flow control for output to TERMINAL.
10878 If FLOW is non-nil, flow control is enabled and you cannot use C-s or
10879 C-q in key sequences.
10881 This setting only has an effect on tty terminals and only when
10882 Emacs reads input in CBREAK mode; see `set-input-interrupt-mode'.
10884 See also `current-input-mode'. */)
10885 (Lisp_Object flow
, Lisp_Object terminal
)
10887 struct terminal
*t
= get_terminal (terminal
, 1);
10888 struct tty_display_info
*tty
;
10889 if (t
== NULL
|| (t
->type
!= output_termcap
&& t
->type
!= output_msdos_raw
))
10891 tty
= t
->display_info
.tty
;
10893 if (tty
->flow_control
!= !NILP (flow
))
10896 /* this causes startup screen to be restored and messes with the mouse */
10897 reset_sys_modes (tty
);
10900 tty
->flow_control
= !NILP (flow
);
10903 init_sys_modes (tty
);
10909 DEFUN ("set-input-meta-mode", Fset_input_meta_mode
, Sset_input_meta_mode
, 1, 2, 0,
10910 doc
: /* Enable or disable 8-bit input on TERMINAL.
10911 If META is t, Emacs will accept 8-bit input, and interpret the 8th
10912 bit as the Meta modifier.
10914 If META is nil, Emacs will ignore the top bit, on the assumption it is
10917 Otherwise, Emacs will accept and pass through 8-bit input without
10918 specially interpreting the top bit.
10920 This setting only has an effect on tty terminal devices.
10922 Optional parameter TERMINAL specifies the tty terminal device to use.
10923 It may be a terminal object, a frame, or nil for the terminal used by
10924 the currently selected frame.
10926 See also `current-input-mode'. */)
10927 (Lisp_Object meta
, Lisp_Object terminal
)
10929 struct terminal
*t
= get_terminal (terminal
, 1);
10930 struct tty_display_info
*tty
;
10933 if (t
== NULL
|| (t
->type
!= output_termcap
&& t
->type
!= output_msdos_raw
))
10935 tty
= t
->display_info
.tty
;
10939 else if (EQ (meta
, Qt
))
10944 if (tty
->meta_key
!= new_meta
)
10947 /* this causes startup screen to be restored and messes with the mouse */
10948 reset_sys_modes (tty
);
10951 tty
->meta_key
= new_meta
;
10954 init_sys_modes (tty
);
10960 DEFUN ("set-quit-char", Fset_quit_char
, Sset_quit_char
, 1, 1, 0,
10961 doc
: /* Specify character used for quitting.
10962 QUIT must be an ASCII character.
10964 This function only has an effect on the controlling tty of the Emacs
10967 See also `current-input-mode'. */)
10970 struct terminal
*t
= get_named_tty ("/dev/tty");
10971 struct tty_display_info
*tty
;
10972 if (t
== NULL
|| (t
->type
!= output_termcap
&& t
->type
!= output_msdos_raw
))
10974 tty
= t
->display_info
.tty
;
10976 if (NILP (quit
) || !INTEGERP (quit
) || XINT (quit
) < 0 || XINT (quit
) > 0400)
10977 error ("QUIT must be an ASCII character");
10980 /* this causes startup screen to be restored and messes with the mouse */
10981 reset_sys_modes (tty
);
10984 /* Don't let this value be out of range. */
10985 quit_char
= XINT (quit
) & (tty
->meta_key
== 0 ? 0177 : 0377);
10988 init_sys_modes (tty
);
10994 DEFUN ("set-input-mode", Fset_input_mode
, Sset_input_mode
, 3, 4, 0,
10995 doc
: /* Set mode of reading keyboard input.
10996 First arg INTERRUPT non-nil means use input interrupts;
10997 nil means use CBREAK mode.
10998 Second arg FLOW non-nil means use ^S/^Q flow control for output to terminal
10999 (no effect except in CBREAK mode).
11000 Third arg META t means accept 8-bit input (for a Meta key).
11001 META nil means ignore the top bit, on the assumption it is parity.
11002 Otherwise, accept 8-bit input and don't use the top bit for Meta.
11003 Optional fourth arg QUIT if non-nil specifies character to use for quitting.
11004 See also `current-input-mode'. */)
11005 (Lisp_Object interrupt
, Lisp_Object flow
, Lisp_Object meta
, Lisp_Object quit
)
11007 Fset_input_interrupt_mode (interrupt
);
11008 Fset_output_flow_control (flow
, Qnil
);
11009 Fset_input_meta_mode (meta
, Qnil
);
11011 Fset_quit_char (quit
);
11015 DEFUN ("current-input-mode", Fcurrent_input_mode
, Scurrent_input_mode
, 0, 0, 0,
11016 doc
: /* Return information about the way Emacs currently reads keyboard input.
11017 The value is a list of the form (INTERRUPT FLOW META QUIT), where
11018 INTERRUPT is non-nil if Emacs is using interrupt-driven input; if
11019 nil, Emacs is using CBREAK mode.
11020 FLOW is non-nil if Emacs uses ^S/^Q flow control for output to the
11021 terminal; this does not apply if Emacs uses interrupt-driven input.
11022 META is t if accepting 8-bit input with 8th bit as Meta flag.
11023 META nil means ignoring the top bit, on the assumption it is parity.
11024 META is neither t nor nil if accepting 8-bit input and using
11025 all 8 bits as the character code.
11026 QUIT is the character Emacs currently uses to quit.
11027 The elements of this list correspond to the arguments of
11028 `set-input-mode'. */)
11031 Lisp_Object val
[4];
11032 struct frame
*sf
= XFRAME (selected_frame
);
11034 val
[0] = interrupt_input
? Qt
: Qnil
;
11035 if (FRAME_TERMCAP_P (sf
) || FRAME_MSDOS_P (sf
))
11037 val
[1] = FRAME_TTY (sf
)->flow_control
? Qt
: Qnil
;
11038 val
[2] = (FRAME_TTY (sf
)->meta_key
== 2
11040 : (CURTTY ()->meta_key
== 1 ? Qt
: Qnil
));
11047 XSETFASTINT (val
[3], quit_char
);
11049 return Flist (sizeof (val
) / sizeof (val
[0]), val
);
11052 DEFUN ("posn-at-x-y", Fposn_at_x_y
, Sposn_at_x_y
, 2, 4, 0,
11053 doc
: /* Return position information for pixel coordinates X and Y.
11054 By default, X and Y are relative to text area of the selected window.
11055 Optional third arg FRAME-OR-WINDOW non-nil specifies frame or window.
11056 If optional fourth arg WHOLE is non-nil, X is relative to the left
11057 edge of the window.
11059 The return value is similar to a mouse click position:
11060 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
11061 IMAGE (DX . DY) (WIDTH . HEIGHT))
11062 The `posn-' functions access elements of such lists. */)
11063 (Lisp_Object x
, Lisp_Object y
, Lisp_Object frame_or_window
, Lisp_Object whole
)
11068 if (NILP (frame_or_window
))
11069 frame_or_window
= selected_window
;
11071 if (WINDOWP (frame_or_window
))
11073 struct window
*w
= decode_live_window (frame_or_window
);
11075 XSETINT (x
, (XINT (x
)
11076 + WINDOW_LEFT_EDGE_X (w
)
11078 ? window_box_left_offset (w
, TEXT_AREA
)
11080 XSETINT (y
, WINDOW_TO_FRAME_PIXEL_Y (w
, XINT (y
)));
11081 frame_or_window
= w
->frame
;
11084 CHECK_LIVE_FRAME (frame_or_window
);
11086 return make_lispy_position (XFRAME (frame_or_window
), x
, y
, 0);
11089 DEFUN ("posn-at-point", Fposn_at_point
, Sposn_at_point
, 0, 2, 0,
11090 doc
: /* Return position information for buffer POS in WINDOW.
11091 POS defaults to point in WINDOW; WINDOW defaults to the selected window.
11093 Return nil if position is not visible in window. Otherwise,
11094 the return value is similar to that returned by `event-start' for
11095 a mouse click at the upper left corner of the glyph corresponding
11096 to the given buffer position:
11097 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
11098 IMAGE (DX . DY) (WIDTH . HEIGHT))
11099 The `posn-' functions access elements of such lists. */)
11100 (Lisp_Object pos
, Lisp_Object window
)
11105 window
= selected_window
;
11107 tem
= Fpos_visible_in_window_p (pos
, window
, Qt
);
11110 Lisp_Object x
= XCAR (tem
);
11111 Lisp_Object y
= XCAR (XCDR (tem
));
11113 /* Point invisible due to hscrolling? */
11116 tem
= Fposn_at_x_y (x
, y
, window
, Qnil
);
11124 * Set up a new kboard object with reasonable initial values.
11127 init_kboard (KBOARD
*kb
)
11129 kset_overriding_terminal_local_map (kb
, Qnil
);
11130 kset_last_command (kb
, Qnil
);
11131 kset_real_last_command (kb
, Qnil
);
11132 kset_keyboard_translate_table (kb
, Qnil
);
11133 kset_last_repeatable_command (kb
, Qnil
);
11134 kset_prefix_arg (kb
, Qnil
);
11135 kset_last_prefix_arg (kb
, Qnil
);
11136 kset_kbd_queue (kb
, Qnil
);
11137 kb
->kbd_queue_has_data
= 0;
11138 kb
->immediate_echo
= 0;
11139 kset_echo_string (kb
, Qnil
);
11140 kb
->echo_after_prompt
= -1;
11141 kb
->kbd_macro_buffer
= 0;
11142 kb
->kbd_macro_bufsize
= 0;
11143 kset_defining_kbd_macro (kb
, Qnil
);
11144 kset_last_kbd_macro (kb
, Qnil
);
11145 kb
->reference_count
= 0;
11146 kset_system_key_alist (kb
, Qnil
);
11147 kset_system_key_syms (kb
, Qnil
);
11148 kset_window_system (kb
, Qt
); /* Unset. */
11149 kset_input_decode_map (kb
, Fmake_sparse_keymap (Qnil
));
11150 kset_local_function_key_map (kb
, Fmake_sparse_keymap (Qnil
));
11151 Fset_keymap_parent (KVAR (kb
, Vlocal_function_key_map
), Vfunction_key_map
);
11152 kset_default_minibuffer_frame (kb
, Qnil
);
11156 * Destroy the contents of a kboard object, but not the object itself.
11157 * We use this just before deleting it, or if we're going to initialize
11158 * it a second time.
11161 wipe_kboard (KBOARD
*kb
)
11163 xfree (kb
->kbd_macro_buffer
);
11166 /* Free KB and memory referenced from it. */
11169 delete_kboard (KBOARD
*kb
)
11173 for (kbp
= &all_kboards
; *kbp
!= kb
; kbp
= &(*kbp
)->next_kboard
)
11176 *kbp
= kb
->next_kboard
;
11178 /* Prevent a dangling reference to KB. */
11179 if (kb
== current_kboard
11180 && FRAMEP (selected_frame
)
11181 && FRAME_LIVE_P (XFRAME (selected_frame
)))
11183 current_kboard
= FRAME_KBOARD (XFRAME (selected_frame
));
11185 if (current_kboard
== kb
)
11194 init_keyboard (void)
11196 /* This is correct before outermost invocation of the editor loop. */
11197 command_loop_level
= -1;
11198 immediate_quit
= 0;
11199 quit_char
= Ctl ('g');
11200 Vunread_command_events
= Qnil
;
11201 timer_idleness_start_time
= invalid_emacs_time ();
11203 recent_keys_index
= 0;
11204 kbd_fetch_ptr
= kbd_buffer
;
11205 kbd_store_ptr
= kbd_buffer
;
11206 do_mouse_tracking
= Qnil
;
11208 interrupt_input_blocked
= 0;
11209 pending_signals
= 0;
11211 /* This means that command_loop_1 won't try to select anything the first
11213 internal_last_event_frame
= Qnil
;
11214 Vlast_event_frame
= internal_last_event_frame
;
11216 current_kboard
= initial_kboard
;
11217 /* Re-initialize the keyboard again. */
11218 wipe_kboard (current_kboard
);
11219 init_kboard (current_kboard
);
11220 /* A value of nil for Vwindow_system normally means a tty, but we also use
11221 it for the initial terminal since there is no window system there. */
11222 kset_window_system (current_kboard
, Qnil
);
11224 if (!noninteractive
)
11226 /* Before multi-tty support, these handlers used to be installed
11227 only if the current session was a tty session. Now an Emacs
11228 session may have multiple display types, so we always handle
11229 SIGINT. There is special code in handle_interrupt_signal to exit
11230 Emacs on SIGINT when there are no termcap frames on the
11231 controlling terminal. */
11232 struct sigaction action
;
11233 emacs_sigaction_init (&action
, deliver_interrupt_signal
);
11234 sigaction (SIGINT
, &action
, 0);
11236 /* For systems with SysV TERMIO, C-g is set up for both SIGINT and
11237 SIGQUIT and we can't tell which one it will give us. */
11238 sigaction (SIGQUIT
, &action
, 0);
11239 #endif /* not DOS_NT */
11241 #ifdef USABLE_SIGIO
11242 if (!noninteractive
)
11244 struct sigaction action
;
11245 emacs_sigaction_init (&action
, deliver_input_available_signal
);
11246 sigaction (SIGIO
, &action
, 0);
11250 /* Use interrupt input by default, if it works and noninterrupt input
11251 has deficiencies. */
11253 #ifdef INTERRUPT_INPUT
11254 interrupt_input
= 1;
11256 interrupt_input
= 0;
11259 pthread_sigmask (SIG_SETMASK
, &empty_mask
, 0);
11262 if (keyboard_init_hook
)
11263 (*keyboard_init_hook
) ();
11265 #ifdef POLL_FOR_INPUT
11267 poll_suppress_count
= 1;
11272 /* This type's only use is in syms_of_keyboard, to initialize the
11273 event header symbols and put properties on them. */
11274 struct event_head
{
11280 static const struct event_head head_table
[] = {
11281 {&Qmouse_movement
, "mouse-movement", &Qmouse_movement
},
11282 {&Qscroll_bar_movement
, "scroll-bar-movement", &Qmouse_movement
},
11283 {&Qswitch_frame
, "switch-frame", &Qswitch_frame
},
11284 {&Qdelete_frame
, "delete-frame", &Qdelete_frame
},
11285 {&Qiconify_frame
, "iconify-frame", &Qiconify_frame
},
11286 {&Qmake_frame_visible
, "make-frame-visible", &Qmake_frame_visible
},
11287 /* `select-window' should be handled just like `switch-frame'
11288 in read_key_sequence. */
11289 {&Qselect_window
, "select-window", &Qswitch_frame
}
11293 syms_of_keyboard (void)
11295 pending_funcalls
= Qnil
;
11296 staticpro (&pending_funcalls
);
11298 Vlispy_mouse_stem
= build_pure_c_string ("mouse");
11299 staticpro (&Vlispy_mouse_stem
);
11302 DEFSYM (QCimage
, ":image");
11303 DEFSYM (Qhelp_echo
, "help-echo");
11304 DEFSYM (QCrtl
, ":rtl");
11306 staticpro (&item_properties
);
11307 item_properties
= Qnil
;
11309 staticpro (&tool_bar_item_properties
);
11310 tool_bar_item_properties
= Qnil
;
11311 staticpro (&tool_bar_items_vector
);
11312 tool_bar_items_vector
= Qnil
;
11314 DEFSYM (Qtimer_event_handler
, "timer-event-handler");
11315 DEFSYM (Qdisabled_command_function
, "disabled-command-function");
11316 DEFSYM (Qself_insert_command
, "self-insert-command");
11317 DEFSYM (Qforward_char
, "forward-char");
11318 DEFSYM (Qbackward_char
, "backward-char");
11319 DEFSYM (Qdisabled
, "disabled");
11320 DEFSYM (Qundefined
, "undefined");
11321 DEFSYM (Qpre_command_hook
, "pre-command-hook");
11322 DEFSYM (Qpost_command_hook
, "post-command-hook");
11323 DEFSYM (Qdeferred_action_function
, "deferred-action-function");
11324 DEFSYM (Qdelayed_warnings_hook
, "delayed-warnings-hook");
11325 DEFSYM (Qfunction_key
, "function-key");
11326 DEFSYM (Qmouse_click
, "mouse-click");
11327 DEFSYM (Qdrag_n_drop
, "drag-n-drop");
11328 DEFSYM (Qsave_session
, "save-session");
11329 DEFSYM (Qconfig_changed_event
, "config-changed-event");
11330 DEFSYM (Qmenu_enable
, "menu-enable");
11333 DEFSYM (Qlanguage_change
, "language-change");
11337 DEFSYM (Qdbus_event
, "dbus-event");
11340 DEFSYM (QCenable
, ":enable");
11341 DEFSYM (QCvisible
, ":visible");
11342 DEFSYM (QChelp
, ":help");
11343 DEFSYM (QCfilter
, ":filter");
11344 DEFSYM (QCbutton
, ":button");
11345 DEFSYM (QCkeys
, ":keys");
11346 DEFSYM (QCkey_sequence
, ":key-sequence");
11347 DEFSYM (QCtoggle
, ":toggle");
11348 DEFSYM (QCradio
, ":radio");
11349 DEFSYM (QClabel
, ":label");
11350 DEFSYM (QCvert_only
, ":vert-only");
11352 DEFSYM (Qmode_line
, "mode-line");
11353 DEFSYM (Qvertical_line
, "vertical-line");
11354 DEFSYM (Qvertical_scroll_bar
, "vertical-scroll-bar");
11355 DEFSYM (Qmenu_bar
, "menu-bar");
11357 DEFSYM (Qmouse_fixup_help_message
, "mouse-fixup-help-message");
11359 DEFSYM (Qabove_handle
, "above-handle");
11360 DEFSYM (Qhandle
, "handle");
11361 DEFSYM (Qbelow_handle
, "below-handle");
11362 DEFSYM (Qup
, "up");
11363 DEFSYM (Qdown
, "down");
11364 DEFSYM (Qtop
, "top");
11365 DEFSYM (Qbottom
, "bottom");
11366 DEFSYM (Qend_scroll
, "end-scroll");
11367 DEFSYM (Qratio
, "ratio");
11369 DEFSYM (Qevent_kind
, "event-kind");
11370 DEFSYM (Qevent_symbol_elements
, "event-symbol-elements");
11371 DEFSYM (Qevent_symbol_element_mask
, "event-symbol-element-mask");
11372 DEFSYM (Qmodifier_cache
, "modifier-cache");
11374 DEFSYM (Qrecompute_lucid_menubar
, "recompute-lucid-menubar");
11375 DEFSYM (Qactivate_menubar_hook
, "activate-menubar-hook");
11377 DEFSYM (Qpolling_period
, "polling-period");
11379 DEFSYM (Qx_set_selection
, "x-set-selection");
11380 DEFSYM (QPRIMARY
, "PRIMARY");
11381 DEFSYM (Qhandle_switch_frame
, "handle-switch-frame");
11382 DEFSYM (Qhandle_select_window
, "handle-select-window");
11384 DEFSYM (Qinput_method_function
, "input-method-function");
11385 DEFSYM (Qinput_method_exit_on_first_char
, "input-method-exit-on-first-char");
11386 DEFSYM (Qinput_method_use_echo_area
, "input-method-use-echo-area");
11388 DEFSYM (Qhelp_form_show
, "help-form-show");
11390 Fset (Qinput_method_exit_on_first_char
, Qnil
);
11391 Fset (Qinput_method_use_echo_area
, Qnil
);
11393 last_point_position_buffer
= Qnil
;
11394 last_point_position_window
= Qnil
;
11398 int len
= sizeof (head_table
) / sizeof (head_table
[0]);
11400 for (i
= 0; i
< len
; i
++)
11402 const struct event_head
*p
= &head_table
[i
];
11403 *p
->var
= intern_c_string (p
->name
);
11404 staticpro (p
->var
);
11405 Fput (*p
->var
, Qevent_kind
, *p
->kind
);
11406 Fput (*p
->var
, Qevent_symbol_elements
, Fcons (*p
->var
, Qnil
));
11410 button_down_location
= Fmake_vector (make_number (5), Qnil
);
11411 staticpro (&button_down_location
);
11412 mouse_syms
= Fmake_vector (make_number (5), Qnil
);
11413 staticpro (&mouse_syms
);
11414 wheel_syms
= Fmake_vector (make_number (sizeof (lispy_wheel_names
)
11415 / sizeof (lispy_wheel_names
[0])),
11417 staticpro (&wheel_syms
);
11421 int len
= sizeof (modifier_names
) / sizeof (modifier_names
[0]);
11423 modifier_symbols
= Fmake_vector (make_number (len
), Qnil
);
11424 for (i
= 0; i
< len
; i
++)
11425 if (modifier_names
[i
])
11426 ASET (modifier_symbols
, i
, intern_c_string (modifier_names
[i
]));
11427 staticpro (&modifier_symbols
);
11430 recent_keys
= Fmake_vector (make_number (NUM_RECENT_KEYS
), Qnil
);
11431 staticpro (&recent_keys
);
11433 this_command_keys
= Fmake_vector (make_number (40), Qnil
);
11434 staticpro (&this_command_keys
);
11436 raw_keybuf
= Fmake_vector (make_number (30), Qnil
);
11437 staticpro (&raw_keybuf
);
11439 DEFSYM (Qextended_command_history
, "extended-command-history");
11440 Fset (Qextended_command_history
, Qnil
);
11442 accent_key_syms
= Qnil
;
11443 staticpro (&accent_key_syms
);
11445 func_key_syms
= Qnil
;
11446 staticpro (&func_key_syms
);
11448 drag_n_drop_syms
= Qnil
;
11449 staticpro (&drag_n_drop_syms
);
11451 unread_switch_frame
= Qnil
;
11452 staticpro (&unread_switch_frame
);
11454 internal_last_event_frame
= Qnil
;
11455 staticpro (&internal_last_event_frame
);
11457 read_key_sequence_cmd
= Qnil
;
11458 staticpro (&read_key_sequence_cmd
);
11459 read_key_sequence_remapped
= Qnil
;
11460 staticpro (&read_key_sequence_remapped
);
11462 menu_bar_one_keymap_changed_items
= Qnil
;
11463 staticpro (&menu_bar_one_keymap_changed_items
);
11465 menu_bar_items_vector
= Qnil
;
11466 staticpro (&menu_bar_items_vector
);
11468 help_form_saved_window_configs
= Qnil
;
11469 staticpro (&help_form_saved_window_configs
);
11471 defsubr (&Scurrent_idle_time
);
11472 defsubr (&Sevent_symbol_parse_modifiers
);
11473 defsubr (&Sevent_convert_list
);
11474 defsubr (&Sread_key_sequence
);
11475 defsubr (&Sread_key_sequence_vector
);
11476 defsubr (&Srecursive_edit
);
11477 defsubr (&Strack_mouse
);
11478 defsubr (&Sinput_pending_p
);
11479 defsubr (&Scommand_execute
);
11480 defsubr (&Srecent_keys
);
11481 defsubr (&Sthis_command_keys
);
11482 defsubr (&Sthis_command_keys_vector
);
11483 defsubr (&Sthis_single_command_keys
);
11484 defsubr (&Sthis_single_command_raw_keys
);
11485 defsubr (&Sreset_this_command_lengths
);
11486 defsubr (&Sclear_this_command_keys
);
11487 defsubr (&Ssuspend_emacs
);
11488 defsubr (&Sabort_recursive_edit
);
11489 defsubr (&Sexit_recursive_edit
);
11490 defsubr (&Srecursion_depth
);
11491 defsubr (&Stop_level
);
11492 defsubr (&Sdiscard_input
);
11493 defsubr (&Sopen_dribble_file
);
11494 defsubr (&Sset_input_interrupt_mode
);
11495 defsubr (&Sset_output_flow_control
);
11496 defsubr (&Sset_input_meta_mode
);
11497 defsubr (&Sset_quit_char
);
11498 defsubr (&Sset_input_mode
);
11499 defsubr (&Scurrent_input_mode
);
11500 defsubr (&Sposn_at_point
);
11501 defsubr (&Sposn_at_x_y
);
11503 DEFVAR_LISP ("last-command-event", last_command_event
,
11504 doc
: /* Last input event that was part of a command. */);
11506 DEFVAR_LISP ("last-nonmenu-event", last_nonmenu_event
,
11507 doc
: /* Last input event in a command, except for mouse menu events.
11508 Mouse menus give back keys that don't look like mouse events;
11509 this variable holds the actual mouse event that led to the menu,
11510 so that you can determine whether the command was run by mouse or not. */);
11512 DEFVAR_LISP ("last-input-event", last_input_event
,
11513 doc
: /* Last input event. */);
11515 DEFVAR_LISP ("unread-command-events", Vunread_command_events
,
11516 doc
: /* List of events to be read as the command input.
11517 These events are processed first, before actual keyboard input.
11518 Events read from this list are not normally added to `this-command-keys',
11519 as they will already have been added once as they were read for the first time.
11520 An element of the form (t . EVENT) forces EVENT to be added to that list. */);
11521 Vunread_command_events
= Qnil
;
11523 DEFVAR_LISP ("unread-post-input-method-events", Vunread_post_input_method_events
,
11524 doc
: /* List of events to be processed as input by input methods.
11525 These events are processed before `unread-command-events'
11526 and actual keyboard input, but are not given to `input-method-function'. */);
11527 Vunread_post_input_method_events
= Qnil
;
11529 DEFVAR_LISP ("unread-input-method-events", Vunread_input_method_events
,
11530 doc
: /* List of events to be processed as input by input methods.
11531 These events are processed after `unread-command-events', but
11532 before actual keyboard input.
11533 If there's an active input method, the events are given to
11534 `input-method-function'. */);
11535 Vunread_input_method_events
= Qnil
;
11537 DEFVAR_LISP ("meta-prefix-char", meta_prefix_char
,
11538 doc
: /* Meta-prefix character code.
11539 Meta-foo as command input turns into this character followed by foo. */);
11540 XSETINT (meta_prefix_char
, 033);
11542 DEFVAR_KBOARD ("last-command", Vlast_command
,
11543 doc
: /* The last command executed.
11544 Normally a symbol with a function definition, but can be whatever was found
11545 in the keymap, or whatever the variable `this-command' was set to by that
11548 The value `mode-exit' is special; it means that the previous command
11549 read an event that told it to exit, and it did so and unread that event.
11550 In other words, the present command is the event that made the previous
11553 The value `kill-region' is special; it means that the previous command
11554 was a kill command.
11556 `last-command' has a separate binding for each terminal device.
11557 See Info node `(elisp)Multiple Terminals'. */);
11559 DEFVAR_KBOARD ("real-last-command", Vreal_last_command
,
11560 doc
: /* Same as `last-command', but never altered by Lisp code.
11561 Taken from the previous value of `real-this-command'. */);
11563 DEFVAR_KBOARD ("last-repeatable-command", Vlast_repeatable_command
,
11564 doc
: /* Last command that may be repeated.
11565 The last command executed that was not bound to an input event.
11566 This is the command `repeat' will try to repeat.
11567 Taken from a previous value of `real-this-command'. */);
11569 DEFVAR_LISP ("this-command", Vthis_command
,
11570 doc
: /* The command now being executed.
11571 The command can set this variable; whatever is put here
11572 will be in `last-command' during the following command. */);
11573 Vthis_command
= Qnil
;
11575 DEFVAR_LISP ("real-this-command", Vreal_this_command
,
11576 doc
: /* This is like `this-command', except that commands should never modify it. */);
11577 Vreal_this_command
= Qnil
;
11579 DEFVAR_LISP ("this-command-keys-shift-translated",
11580 Vthis_command_keys_shift_translated
,
11581 doc
: /* Non-nil if the key sequence activating this command was shift-translated.
11582 Shift-translation occurs when there is no binding for the key sequence
11583 as entered, but a binding was found by changing an upper-case letter
11584 to lower-case, or a shifted function key to an unshifted one. */);
11585 Vthis_command_keys_shift_translated
= Qnil
;
11587 DEFVAR_LISP ("this-original-command", Vthis_original_command
,
11588 doc
: /* The command bound to the current key sequence before remapping.
11589 It equals `this-command' if the original command was not remapped through
11590 any of the active keymaps. Otherwise, the value of `this-command' is the
11591 result of looking up the original command in the active keymaps. */);
11592 Vthis_original_command
= Qnil
;
11594 DEFVAR_INT ("auto-save-interval", auto_save_interval
,
11595 doc
: /* Number of input events between auto-saves.
11596 Zero means disable autosaving due to number of characters typed. */);
11597 auto_save_interval
= 300;
11599 DEFVAR_LISP ("auto-save-timeout", Vauto_save_timeout
,
11600 doc
: /* Number of seconds idle time before auto-save.
11601 Zero or nil means disable auto-saving due to idleness.
11602 After auto-saving due to this many seconds of idle time,
11603 Emacs also does a garbage collection if that seems to be warranted. */);
11604 XSETFASTINT (Vauto_save_timeout
, 30);
11606 DEFVAR_LISP ("echo-keystrokes", Vecho_keystrokes
,
11607 doc
: /* Nonzero means echo unfinished commands after this many seconds of pause.
11608 The value may be integer or floating point.
11609 If the value is zero, don't echo at all. */);
11610 Vecho_keystrokes
= make_number (1);
11612 DEFVAR_INT ("polling-period", polling_period
,
11613 doc
: /* Interval between polling for input during Lisp execution.
11614 The reason for polling is to make C-g work to stop a running program.
11615 Polling is needed only when using X windows and SIGIO does not work.
11616 Polling is automatically disabled in all other cases. */);
11617 polling_period
= 2;
11619 DEFVAR_LISP ("double-click-time", Vdouble_click_time
,
11620 doc
: /* Maximum time between mouse clicks to make a double-click.
11621 Measured in milliseconds. The value nil means disable double-click
11622 recognition; t means double-clicks have no time limit and are detected
11623 by position only. */);
11624 Vdouble_click_time
= make_number (500);
11626 DEFVAR_INT ("double-click-fuzz", double_click_fuzz
,
11627 doc
: /* Maximum mouse movement between clicks to make a double-click.
11628 On window-system frames, value is the number of pixels the mouse may have
11629 moved horizontally or vertically between two clicks to make a double-click.
11630 On non window-system frames, value is interpreted in units of 1/8 characters
11633 This variable is also the threshold for motion of the mouse
11634 to count as a drag. */);
11635 double_click_fuzz
= 3;
11637 DEFVAR_BOOL ("inhibit-local-menu-bar-menus", inhibit_local_menu_bar_menus
,
11638 doc
: /* Non-nil means inhibit local map menu bar menus. */);
11639 inhibit_local_menu_bar_menus
= 0;
11641 DEFVAR_INT ("num-input-keys", num_input_keys
,
11642 doc
: /* Number of complete key sequences read as input so far.
11643 This includes key sequences read from keyboard macros.
11644 The number is effectively the number of interactive command invocations. */);
11645 num_input_keys
= 0;
11647 DEFVAR_INT ("num-nonmacro-input-events", num_nonmacro_input_events
,
11648 doc
: /* Number of input events read from the keyboard so far.
11649 This does not include events generated by keyboard macros. */);
11650 num_nonmacro_input_events
= 0;
11652 DEFVAR_LISP ("last-event-frame", Vlast_event_frame
,
11653 doc
: /* The frame in which the most recently read event occurred.
11654 If the last event came from a keyboard macro, this is set to `macro'. */);
11655 Vlast_event_frame
= Qnil
;
11657 /* This variable is set up in sysdep.c. */
11658 DEFVAR_LISP ("tty-erase-char", Vtty_erase_char
,
11659 doc
: /* The ERASE character as set by the user with stty. */);
11661 DEFVAR_LISP ("help-char", Vhelp_char
,
11662 doc
: /* Character to recognize as meaning Help.
11663 When it is read, do `(eval help-form)', and display result if it's a string.
11664 If the value of `help-form' is nil, this char can be read normally. */);
11665 XSETINT (Vhelp_char
, Ctl ('H'));
11667 DEFVAR_LISP ("help-event-list", Vhelp_event_list
,
11668 doc
: /* List of input events to recognize as meaning Help.
11669 These work just like the value of `help-char' (see that). */);
11670 Vhelp_event_list
= Qnil
;
11672 DEFVAR_LISP ("help-form", Vhelp_form
,
11673 doc
: /* Form to execute when character `help-char' is read.
11674 If the form returns a string, that string is displayed.
11675 If `help-form' is nil, the help char is not recognized. */);
11678 DEFVAR_LISP ("prefix-help-command", Vprefix_help_command
,
11679 doc
: /* Command to run when `help-char' character follows a prefix key.
11680 This command is used only when there is no actual binding
11681 for that character after that prefix key. */);
11682 Vprefix_help_command
= Qnil
;
11684 DEFVAR_LISP ("top-level", Vtop_level
,
11685 doc
: /* Form to evaluate when Emacs starts up.
11686 Useful to set before you dump a modified Emacs. */);
11689 DEFVAR_KBOARD ("keyboard-translate-table", Vkeyboard_translate_table
,
11690 doc
: /* Translate table for local keyboard input, or nil.
11691 If non-nil, the value should be a char-table. Each character read
11692 from the keyboard is looked up in this char-table. If the value found
11693 there is non-nil, then it is used instead of the actual input character.
11695 The value can also be a string or vector, but this is considered obsolete.
11696 If it is a string or vector of length N, character codes N and up are left
11697 untranslated. In a vector, an element which is nil means "no translation".
11699 This is applied to the characters supplied to input methods, not their
11700 output. See also `translation-table-for-input'.
11702 This variable has a separate binding for each terminal.
11703 See Info node `(elisp)Multiple Terminals'. */);
11705 DEFVAR_BOOL ("cannot-suspend", cannot_suspend
,
11706 doc
: /* Non-nil means to always spawn a subshell instead of suspending.
11707 \(Even if the operating system has support for stopping a process.\) */);
11708 cannot_suspend
= 0;
11710 DEFVAR_BOOL ("menu-prompting", menu_prompting
,
11711 doc
: /* Non-nil means prompt with menus when appropriate.
11712 This is done when reading from a keymap that has a prompt string,
11713 for elements that have prompt strings.
11714 The menu is displayed on the screen
11715 if X menus were enabled at configuration
11716 time and the previous event was a mouse click prefix key.
11717 Otherwise, menu prompting uses the echo area. */);
11718 menu_prompting
= 1;
11720 DEFVAR_LISP ("menu-prompt-more-char", menu_prompt_more_char
,
11721 doc
: /* Character to see next line of menu prompt.
11722 Type this character while in a menu prompt to rotate around the lines of it. */);
11723 XSETINT (menu_prompt_more_char
, ' ');
11725 DEFVAR_INT ("extra-keyboard-modifiers", extra_keyboard_modifiers
,
11726 doc
: /* A mask of additional modifier keys to use with every keyboard character.
11727 Emacs applies the modifiers of the character stored here to each keyboard
11728 character it reads. For example, after evaluating the expression
11729 (setq extra-keyboard-modifiers ?\\C-x)
11730 all input characters will have the control modifier applied to them.
11732 Note that the character ?\\C-@, equivalent to the integer zero, does
11733 not count as a control character; rather, it counts as a character
11734 with no modifiers; thus, setting `extra-keyboard-modifiers' to zero
11735 cancels any modification. */);
11736 extra_keyboard_modifiers
= 0;
11738 DEFVAR_LISP ("deactivate-mark", Vdeactivate_mark
,
11739 doc
: /* If an editing command sets this to t, deactivate the mark afterward.
11740 The command loop sets this to nil before each command,
11741 and tests the value when the command returns.
11742 Buffer modification stores t in this variable. */);
11743 Vdeactivate_mark
= Qnil
;
11744 DEFSYM (Qdeactivate_mark
, "deactivate-mark");
11746 DEFVAR_LISP ("pre-command-hook", Vpre_command_hook
,
11747 doc
: /* Normal hook run before each command is executed.
11748 If an unhandled error happens in running this hook,
11749 the function in which the error occurred is unconditionally removed, since
11750 otherwise the error might happen repeatedly and make Emacs nonfunctional. */);
11751 Vpre_command_hook
= Qnil
;
11753 DEFVAR_LISP ("post-command-hook", Vpost_command_hook
,
11754 doc
: /* Normal hook run after each command is executed.
11755 If an unhandled error happens in running this hook,
11756 the function in which the error occurred is unconditionally removed, since
11757 otherwise the error might happen repeatedly and make Emacs nonfunctional. */);
11758 Vpost_command_hook
= Qnil
;
11761 DEFVAR_LISP ("echo-area-clear-hook", ...,
11762 doc
: /* Normal hook run when clearing the echo area. */);
11764 DEFSYM (Qecho_area_clear_hook
, "echo-area-clear-hook");
11765 Fset (Qecho_area_clear_hook
, Qnil
);
11767 DEFVAR_LISP ("lucid-menu-bar-dirty-flag", Vlucid_menu_bar_dirty_flag
,
11768 doc
: /* Non-nil means menu bar, specified Lucid style, needs to be recomputed. */);
11769 Vlucid_menu_bar_dirty_flag
= Qnil
;
11771 DEFVAR_LISP ("menu-bar-final-items", Vmenu_bar_final_items
,
11772 doc
: /* List of menu bar items to move to the end of the menu bar.
11773 The elements of the list are event types that may have menu bar bindings. */);
11774 Vmenu_bar_final_items
= Qnil
;
11776 DEFVAR_LISP ("tool-bar-separator-image-expression", Vtool_bar_separator_image_expression
,
11777 doc
: /* Expression evaluating to the image spec for a tool-bar separator.
11778 This is used internally by graphical displays that do not render
11779 tool-bar separators natively. Otherwise it is unused (e.g. on GTK). */);
11780 Vtool_bar_separator_image_expression
= Qnil
;
11782 DEFVAR_KBOARD ("overriding-terminal-local-map",
11783 Voverriding_terminal_local_map
,
11784 doc
: /* Per-terminal keymap that overrides all other local keymaps.
11785 If this variable is non-nil, it is used as a keymap instead of the
11786 buffer's local map, and the minor mode keymaps and text property keymaps.
11787 It also replaces `overriding-local-map'.
11789 This variable is intended to let commands such as `universal-argument'
11790 set up a different keymap for reading the next command.
11792 `overriding-terminal-local-map' has a separate binding for each
11794 See Info node `(elisp)Multiple Terminals'. */);
11796 DEFVAR_LISP ("overriding-local-map", Voverriding_local_map
,
11797 doc
: /* Keymap that overrides all other local keymaps.
11798 If this variable is non-nil, it is used as a keymap--replacing the
11799 buffer's local map, the minor mode keymaps, and char property keymaps. */);
11800 Voverriding_local_map
= Qnil
;
11802 DEFVAR_LISP ("overriding-local-map-menu-flag", Voverriding_local_map_menu_flag
,
11803 doc
: /* Non-nil means `overriding-local-map' applies to the menu bar.
11804 Otherwise, the menu bar continues to reflect the buffer's local map
11805 and the minor mode maps regardless of `overriding-local-map'. */);
11806 Voverriding_local_map_menu_flag
= Qnil
;
11808 DEFVAR_LISP ("special-event-map", Vspecial_event_map
,
11809 doc
: /* Keymap defining bindings for special events to execute at low level. */);
11810 Vspecial_event_map
= Fcons (intern_c_string ("keymap"), Qnil
);
11812 DEFVAR_LISP ("track-mouse", do_mouse_tracking
,
11813 doc
: /* Non-nil means generate motion events for mouse motion. */);
11815 DEFVAR_KBOARD ("system-key-alist", Vsystem_key_alist
,
11816 doc
: /* Alist of system-specific X windows key symbols.
11817 Each element should have the form (N . SYMBOL) where N is the
11818 numeric keysym code (sans the \"system-specific\" bit 1<<28)
11819 and SYMBOL is its name.
11821 `system-key-alist' has a separate binding for each terminal device.
11822 See Info node `(elisp)Multiple Terminals'. */);
11824 DEFVAR_KBOARD ("local-function-key-map", Vlocal_function_key_map
,
11825 doc
: /* Keymap that translates key sequences to key sequences during input.
11826 This is used mainly for mapping key sequences into some preferred
11827 key events (symbols).
11829 The `read-key-sequence' function replaces any subsequence bound by
11830 `local-function-key-map' with its binding. More precisely, when the
11831 active keymaps have no binding for the current key sequence but
11832 `local-function-key-map' binds a suffix of the sequence to a vector or
11833 string, `read-key-sequence' replaces the matching suffix with its
11834 binding, and continues with the new sequence.
11836 If the binding is a function, it is called with one argument (the prompt)
11837 and its return value (a key sequence) is used.
11839 The events that come from bindings in `local-function-key-map' are not
11840 themselves looked up in `local-function-key-map'.
11842 For example, suppose `local-function-key-map' binds `ESC O P' to [f1].
11843 Typing `ESC O P' to `read-key-sequence' would return [f1]. Typing
11844 `C-x ESC O P' would return [?\\C-x f1]. If [f1] were a prefix key,
11845 typing `ESC O P x' would return [f1 x].
11847 `local-function-key-map' has a separate binding for each terminal
11848 device. See Info node `(elisp)Multiple Terminals'. If you need to
11849 define a binding on all terminals, change `function-key-map'
11850 instead. Initially, `local-function-key-map' is an empty keymap that
11851 has `function-key-map' as its parent on all terminal devices. */);
11853 DEFVAR_KBOARD ("input-decode-map", Vinput_decode_map
,
11854 doc
: /* Keymap that decodes input escape sequences.
11855 This is used mainly for mapping ASCII function key sequences into
11856 real Emacs function key events (symbols).
11858 The `read-key-sequence' function replaces any subsequence bound by
11859 `input-decode-map' with its binding. Contrary to `function-key-map',
11860 this map applies its rebinding regardless of the presence of an ordinary
11861 binding. So it is more like `key-translation-map' except that it applies
11862 before `function-key-map' rather than after.
11864 If the binding is a function, it is called with one argument (the prompt)
11865 and its return value (a key sequence) is used.
11867 The events that come from bindings in `input-decode-map' are not
11868 themselves looked up in `input-decode-map'.
11870 This variable is keyboard-local. */);
11872 DEFVAR_LISP ("function-key-map", Vfunction_key_map
,
11873 doc
: /* The parent keymap of all `local-function-key-map' instances.
11874 Function key definitions that apply to all terminal devices should go
11875 here. If a mapping is defined in both the current
11876 `local-function-key-map' binding and this variable, then the local
11877 definition will take precedence. */);
11878 Vfunction_key_map
= Fmake_sparse_keymap (Qnil
);
11880 DEFVAR_LISP ("key-translation-map", Vkey_translation_map
,
11881 doc
: /* Keymap of key translations that can override keymaps.
11882 This keymap works like `function-key-map', but comes after that,
11883 and its non-prefix bindings override ordinary bindings.
11884 Another difference is that it is global rather than keyboard-local. */);
11885 Vkey_translation_map
= Fmake_sparse_keymap (Qnil
);
11887 DEFVAR_LISP ("deferred-action-list", Vdeferred_action_list
,
11888 doc
: /* List of deferred actions to be performed at a later time.
11889 The precise format isn't relevant here; we just check whether it is nil. */);
11890 Vdeferred_action_list
= Qnil
;
11892 DEFVAR_LISP ("deferred-action-function", Vdeferred_action_function
,
11893 doc
: /* Function to call to handle deferred actions, after each command.
11894 This function is called with no arguments after each command
11895 whenever `deferred-action-list' is non-nil. */);
11896 Vdeferred_action_function
= Qnil
;
11898 DEFVAR_LISP ("delayed-warnings-list", Vdelayed_warnings_list
,
11899 doc
: /* List of warnings to be displayed after this command.
11900 Each element must be a list (TYPE MESSAGE [LEVEL [BUFFER-NAME]]),
11901 as per the args of `display-warning' (which see).
11902 If this variable is non-nil, `delayed-warnings-hook' will be run
11903 immediately after running `post-command-hook'. */);
11904 Vdelayed_warnings_list
= Qnil
;
11906 DEFVAR_LISP ("timer-list", Vtimer_list
,
11907 doc
: /* List of active absolute time timers in order of increasing time. */);
11908 Vtimer_list
= Qnil
;
11910 DEFVAR_LISP ("timer-idle-list", Vtimer_idle_list
,
11911 doc
: /* List of active idle-time timers in order of increasing time. */);
11912 Vtimer_idle_list
= Qnil
;
11914 DEFVAR_LISP ("input-method-function", Vinput_method_function
,
11915 doc
: /* If non-nil, the function that implements the current input method.
11916 It's called with one argument, a printing character that was just read.
11917 \(That means a character with code 040...0176.)
11918 Typically this function uses `read-event' to read additional events.
11919 When it does so, it should first bind `input-method-function' to nil
11920 so it will not be called recursively.
11922 The function should return a list of zero or more events
11923 to be used as input. If it wants to put back some events
11924 to be reconsidered, separately, by the input method,
11925 it can add them to the beginning of `unread-command-events'.
11927 The input method function can find in `input-method-previous-message'
11928 the previous echo area message.
11930 The input method function should refer to the variables
11931 `input-method-use-echo-area' and `input-method-exit-on-first-char'
11932 for guidance on what to do. */);
11933 Vinput_method_function
= Qnil
;
11935 DEFVAR_LISP ("input-method-previous-message",
11936 Vinput_method_previous_message
,
11937 doc
: /* When `input-method-function' is called, hold the previous echo area message.
11938 This variable exists because `read-event' clears the echo area
11939 before running the input method. It is nil if there was no message. */);
11940 Vinput_method_previous_message
= Qnil
;
11942 DEFVAR_LISP ("show-help-function", Vshow_help_function
,
11943 doc
: /* If non-nil, the function that implements the display of help.
11944 It's called with one argument, the help string to display. */);
11945 Vshow_help_function
= Qnil
;
11947 DEFVAR_LISP ("disable-point-adjustment", Vdisable_point_adjustment
,
11948 doc
: /* If non-nil, suppress point adjustment after executing a command.
11950 After a command is executed, if point is moved into a region that has
11951 special properties (e.g. composition, display), we adjust point to
11952 the boundary of the region. But, when a command sets this variable to
11953 non-nil, we suppress the point adjustment.
11955 This variable is set to nil before reading a command, and is checked
11956 just after executing the command. */);
11957 Vdisable_point_adjustment
= Qnil
;
11959 DEFVAR_LISP ("global-disable-point-adjustment",
11960 Vglobal_disable_point_adjustment
,
11961 doc
: /* If non-nil, always suppress point adjustment.
11963 The default value is nil, in which case, point adjustment are
11964 suppressed only after special commands that set
11965 `disable-point-adjustment' (which see) to non-nil. */);
11966 Vglobal_disable_point_adjustment
= Qnil
;
11968 DEFVAR_LISP ("minibuffer-message-timeout", Vminibuffer_message_timeout
,
11969 doc
: /* How long to display an echo-area message when the minibuffer is active.
11970 If the value is not a number, such messages don't time out. */);
11971 Vminibuffer_message_timeout
= make_number (2);
11973 DEFVAR_LISP ("throw-on-input", Vthrow_on_input
,
11974 doc
: /* If non-nil, any keyboard input throws to this symbol.
11975 The value of that variable is passed to `quit-flag' and later causes a
11976 peculiar kind of quitting. */);
11977 Vthrow_on_input
= Qnil
;
11979 DEFVAR_LISP ("command-error-function", Vcommand_error_function
,
11980 doc
: /* If non-nil, function to output error messages.
11981 The arguments are the error data, a list of the form
11982 (SIGNALED-CONDITIONS . SIGNAL-DATA)
11983 such as just as `condition-case' would bind its variable to,
11984 the context (a string which normally goes at the start of the message),
11985 and the Lisp function within which the error was signaled. */);
11986 Vcommand_error_function
= Qnil
;
11988 DEFVAR_LISP ("enable-disabled-menus-and-buttons",
11989 Venable_disabled_menus_and_buttons
,
11990 doc
: /* If non-nil, don't ignore events produced by disabled menu items and tool-bar.
11992 Help functions bind this to allow help on disabled menu items
11993 and tool-bar buttons. */);
11994 Venable_disabled_menus_and_buttons
= Qnil
;
11996 DEFVAR_LISP ("select-active-regions",
11997 Vselect_active_regions
,
11998 doc
: /* If non-nil, an active region automatically sets the primary selection.
11999 If the value is `only', only temporarily active regions (usually made
12000 by mouse-dragging or shift-selection) set the window selection.
12002 This takes effect only when Transient Mark mode is enabled. */);
12003 Vselect_active_regions
= Qt
;
12005 DEFVAR_LISP ("saved-region-selection",
12006 Vsaved_region_selection
,
12007 doc
: /* Contents of active region prior to buffer modification.
12008 If `select-active-regions' is non-nil, Emacs sets this to the
12009 text in the region before modifying the buffer. The next
12010 `deactivate-mark' call uses this to set the window selection. */);
12011 Vsaved_region_selection
= Qnil
;
12013 DEFVAR_LISP ("selection-inhibit-update-commands",
12014 Vselection_inhibit_update_commands
,
12015 doc
: /* List of commands which should not update the selection.
12016 Normally, if `select-active-regions' is non-nil and the mark remains
12017 active after a command (i.e. the mark was not deactivated), the Emacs
12018 command loop sets the selection to the text in the region. However,
12019 if the command is in this list, the selection is not updated. */);
12020 Vselection_inhibit_update_commands
12021 = list2 (Qhandle_switch_frame
, Qhandle_select_window
);
12023 DEFVAR_LISP ("debug-on-event",
12025 doc
: /* Enter debugger on this event. When Emacs
12026 receives the special event specified by this variable, it will try to
12027 break into the debugger as soon as possible instead of processing the
12028 event normally through `special-event-map'.
12030 Currently, the only supported values for this
12031 variable are `sigusr1' and `sigusr2'. */);
12032 Vdebug_on_event
= intern_c_string ("sigusr2");
12034 /* Create the initial keyboard. */
12035 initial_kboard
= xmalloc (sizeof *initial_kboard
);
12036 init_kboard (initial_kboard
);
12037 /* Vwindow_system is left at t for now. */
12038 initial_kboard
->next_kboard
= all_kboards
;
12039 all_kboards
= initial_kboard
;
12043 keys_of_keyboard (void)
12045 initial_define_key (global_map
, Ctl ('Z'), "suspend-emacs");
12046 initial_define_key (control_x_map
, Ctl ('Z'), "suspend-emacs");
12047 initial_define_key (meta_map
, Ctl ('C'), "exit-recursive-edit");
12048 initial_define_key (global_map
, Ctl (']'), "abort-recursive-edit");
12049 initial_define_key (meta_map
, 'x', "execute-extended-command");
12051 initial_define_lispy_key (Vspecial_event_map
, "delete-frame",
12052 "handle-delete-frame");
12053 initial_define_lispy_key (Vspecial_event_map
, "ns-put-working-text",
12054 "ns-put-working-text");
12055 initial_define_lispy_key (Vspecial_event_map
, "ns-unput-working-text",
12056 "ns-unput-working-text");
12057 /* Here we used to use `ignore-event' which would simple set prefix-arg to
12058 current-prefix-arg, as is done in `handle-switch-frame'.
12059 But `handle-switch-frame is not run from the special-map.
12060 Commands from that map are run in a special way that automatically
12061 preserves the prefix-arg. Restoring the prefix arg here is not just
12062 redundant but harmful:
12064 - current-prefix-arg is set to non-nil, prefix-arg is set to nil.
12065 - after the first prompt, the exit-minibuffer-hook is run which may
12066 iconify a frame and thus push a `iconify-frame' event.
12067 - after running exit-minibuffer-hook, current-prefix-arg is
12068 restored to the non-nil value it had before the prompt.
12069 - we enter the second prompt.
12070 current-prefix-arg is non-nil, prefix-arg is nil.
12071 - before running the first real event, we run the special iconify-frame
12072 event, but we pass the `special' arg to execute-command so
12073 current-prefix-arg and prefix-arg are left untouched.
12074 - here we foolishly copy the non-nil current-prefix-arg to prefix-arg.
12075 - the next key event will have a spuriously non-nil current-prefix-arg. */
12076 initial_define_lispy_key (Vspecial_event_map
, "iconify-frame",
12078 initial_define_lispy_key (Vspecial_event_map
, "make-frame-visible",
12080 /* Handling it at such a low-level causes read_key_sequence to get
12081 * confused because it doesn't realize that the current_buffer was
12082 * changed by read_char.
12084 * initial_define_lispy_key (Vspecial_event_map, "select-window",
12085 * "handle-select-window"); */
12086 initial_define_lispy_key (Vspecial_event_map
, "save-session",
12087 "handle-save-session");
12090 /* Define a special event which is raised for dbus callback
12092 initial_define_lispy_key (Vspecial_event_map
, "dbus-event",
12093 "dbus-handle-event");
12096 initial_define_lispy_key (Vspecial_event_map
, "config-changed-event",
12098 #if defined (WINDOWSNT)
12099 initial_define_lispy_key (Vspecial_event_map
, "language-change",
12104 /* Mark the pointers in the kboard objects.
12105 Called by Fgarbage_collect. */
12107 mark_kboards (void)
12111 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
12113 if (kb
->kbd_macro_buffer
)
12114 for (p
= kb
->kbd_macro_buffer
; p
< kb
->kbd_macro_ptr
; p
++)
12116 mark_object (KVAR (kb
, Voverriding_terminal_local_map
));
12117 mark_object (KVAR (kb
, Vlast_command
));
12118 mark_object (KVAR (kb
, Vreal_last_command
));
12119 mark_object (KVAR (kb
, Vkeyboard_translate_table
));
12120 mark_object (KVAR (kb
, Vlast_repeatable_command
));
12121 mark_object (KVAR (kb
, Vprefix_arg
));
12122 mark_object (KVAR (kb
, Vlast_prefix_arg
));
12123 mark_object (KVAR (kb
, kbd_queue
));
12124 mark_object (KVAR (kb
, defining_kbd_macro
));
12125 mark_object (KVAR (kb
, Vlast_kbd_macro
));
12126 mark_object (KVAR (kb
, Vsystem_key_alist
));
12127 mark_object (KVAR (kb
, system_key_syms
));
12128 mark_object (KVAR (kb
, Vwindow_system
));
12129 mark_object (KVAR (kb
, Vinput_decode_map
));
12130 mark_object (KVAR (kb
, Vlocal_function_key_map
));
12131 mark_object (KVAR (kb
, Vdefault_minibuffer_frame
));
12132 mark_object (KVAR (kb
, echo_string
));
12135 struct input_event
*event
;
12136 for (event
= kbd_fetch_ptr
; event
!= kbd_store_ptr
; event
++)
12138 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
12139 event
= kbd_buffer
;
12140 /* These two special event types has no Lisp_Objects to mark. */
12141 if (event
->kind
!= SELECTION_REQUEST_EVENT
12142 && event
->kind
!= SELECTION_CLEAR_EVENT
)
12144 mark_object (event
->x
);
12145 mark_object (event
->y
);
12146 mark_object (event
->frame_or_window
);
12147 mark_object (event
->arg
);