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 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
310 static Lisp_Object Qmouse_fixup_help_message
;
313 /* Symbols to denote kinds of events. */
314 static Lisp_Object Qfunction_key
;
315 Lisp_Object Qmouse_click
;
317 Lisp_Object Qlanguage_change
;
319 Lisp_Object Qfile_notify
;
322 static Lisp_Object Qdrag_n_drop
;
323 static Lisp_Object Qsave_session
;
325 static Lisp_Object Qdbus_event
;
327 static Lisp_Object Qconfig_changed_event
;
329 /* Lisp_Object Qmouse_movement; - also an event header */
331 /* Properties of event headers. */
332 Lisp_Object Qevent_kind
;
333 static Lisp_Object Qevent_symbol_elements
;
335 /* Menu and tool bar item parts. */
336 static Lisp_Object Qmenu_enable
;
337 static Lisp_Object QCenable
, QCvisible
, QChelp
, QCkeys
, QCkey_sequence
;
338 Lisp_Object QCfilter
;
340 /* Non-nil disable property on a command means
341 do not execute it; call disabled-command-function's value instead. */
342 Lisp_Object QCtoggle
, QCradio
;
343 static Lisp_Object QCbutton
, QClabel
;
345 static Lisp_Object QCvert_only
;
347 /* An event header symbol HEAD may have a property named
348 Qevent_symbol_element_mask, which is of the form (BASE MODIFIERS);
349 BASE is the base, unmodified version of HEAD, and MODIFIERS is the
350 mask of modifiers applied to it. If present, this is used to help
351 speed up parse_modifiers. */
352 Lisp_Object Qevent_symbol_element_mask
;
354 /* An unmodified event header BASE may have a property named
355 Qmodifier_cache, which is an alist mapping modifier masks onto
356 modified versions of BASE. If present, this helps speed up
358 static Lisp_Object Qmodifier_cache
;
360 /* Symbols to use for parts of windows. */
361 Lisp_Object Qmode_line
;
362 Lisp_Object Qvertical_line
;
363 static Lisp_Object Qvertical_scroll_bar
;
364 Lisp_Object Qmenu_bar
;
366 static Lisp_Object
recursive_edit_unwind (Lisp_Object buffer
);
367 static Lisp_Object
command_loop (void);
368 static Lisp_Object Qextended_command_history
;
369 EMACS_TIME
timer_check (void);
371 static void record_menu_key (Lisp_Object c
);
372 static void echo_now (void);
373 static ptrdiff_t echo_length (void);
375 static Lisp_Object Qpolling_period
;
377 /* Incremented whenever a timer is run. */
380 /* Address (if not 0) of EMACS_TIME to zero out if a SIGIO interrupt
382 EMACS_TIME
*input_available_clear_time
;
384 /* True means use SIGIO interrupts; false means use CBREAK mode.
385 Default is true if INTERRUPT_INPUT is defined. */
386 bool interrupt_input
;
388 /* Nonzero while interrupts are temporarily deferred during redisplay. */
389 bool interrupts_deferred
;
391 /* If we support a window system, turn on the code to poll periodically
392 to detect C-g. It isn't actually used when doing interrupt input. */
393 #ifdef HAVE_WINDOW_SYSTEM
394 #define POLL_FOR_INPUT
397 /* The time when Emacs started being idle. */
399 static EMACS_TIME timer_idleness_start_time
;
401 /* After Emacs stops being idle, this saves the last value
402 of timer_idleness_start_time from when it was idle. */
404 static EMACS_TIME timer_last_idleness_start_time
;
407 /* Global variable declarations. */
409 /* Flags for readable_events. */
410 #define READABLE_EVENTS_DO_TIMERS_NOW (1 << 0)
411 #define READABLE_EVENTS_FILTER_EVENTS (1 << 1)
412 #define READABLE_EVENTS_IGNORE_SQUEEZABLES (1 << 2)
414 /* Function for init_keyboard to call with no args (if nonzero). */
415 static void (*keyboard_init_hook
) (void);
417 static bool get_input_pending (int);
418 static bool readable_events (int);
419 static Lisp_Object
read_char_x_menu_prompt (ptrdiff_t, Lisp_Object
*,
420 Lisp_Object
, bool *);
421 static Lisp_Object
read_char_minibuf_menu_prompt (int, ptrdiff_t,
423 static Lisp_Object
make_lispy_event (struct input_event
*);
424 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
425 static Lisp_Object
make_lispy_movement (struct frame
*, Lisp_Object
,
426 enum scroll_bar_part
,
427 Lisp_Object
, Lisp_Object
,
430 static Lisp_Object
modify_event_symbol (ptrdiff_t, int, Lisp_Object
,
431 Lisp_Object
, const char *const *,
432 Lisp_Object
*, ptrdiff_t);
433 static Lisp_Object
make_lispy_switch_frame (Lisp_Object
);
434 static bool help_char_p (Lisp_Object
);
435 static void save_getcjmp (sys_jmp_buf
);
436 static void restore_getcjmp (sys_jmp_buf
);
437 static Lisp_Object
apply_modifiers (int, Lisp_Object
);
438 static void clear_event (struct input_event
*);
439 static Lisp_Object
restore_kboard_configuration (Lisp_Object
);
441 static void deliver_input_available_signal (int signo
);
443 static void handle_interrupt (bool);
444 static _Noreturn
void quit_throw_to_read_char (bool);
445 static void process_special_events (void);
446 static void timer_start_idle (void);
447 static void timer_stop_idle (void);
448 static void timer_resume_idle (void);
449 static void deliver_user_signal (int);
450 static char *find_user_signal_name (int);
451 static void store_user_signal_events (void);
453 /* These setters are used only in this file, so they can be private. */
455 kset_echo_string (struct kboard
*kb
, Lisp_Object val
)
457 kb
->INTERNAL_FIELD (echo_string
) = val
;
460 kset_kbd_queue (struct kboard
*kb
, Lisp_Object val
)
462 kb
->INTERNAL_FIELD (kbd_queue
) = val
;
465 kset_keyboard_translate_table (struct kboard
*kb
, Lisp_Object val
)
467 kb
->INTERNAL_FIELD (Vkeyboard_translate_table
) = val
;
470 kset_last_prefix_arg (struct kboard
*kb
, Lisp_Object val
)
472 kb
->INTERNAL_FIELD (Vlast_prefix_arg
) = val
;
475 kset_last_repeatable_command (struct kboard
*kb
, Lisp_Object val
)
477 kb
->INTERNAL_FIELD (Vlast_repeatable_command
) = val
;
480 kset_local_function_key_map (struct kboard
*kb
, Lisp_Object val
)
482 kb
->INTERNAL_FIELD (Vlocal_function_key_map
) = val
;
485 kset_overriding_terminal_local_map (struct kboard
*kb
, Lisp_Object val
)
487 kb
->INTERNAL_FIELD (Voverriding_terminal_local_map
) = val
;
490 kset_real_last_command (struct kboard
*kb
, Lisp_Object val
)
492 kb
->INTERNAL_FIELD (Vreal_last_command
) = val
;
495 kset_system_key_syms (struct kboard
*kb
, Lisp_Object val
)
497 kb
->INTERNAL_FIELD (system_key_syms
) = val
;
501 /* Add C to the echo string, if echoing is going on.
502 C can be a character, which is printed prettily ("M-C-x" and all that
503 jazz), or a symbol, whose name is printed. */
506 echo_char (Lisp_Object c
)
508 if (current_kboard
->immediate_echo
)
510 int size
= KEY_DESCRIPTION_SIZE
+ 100;
511 char *buffer
= alloca (size
);
513 Lisp_Object echo_string
;
515 echo_string
= KVAR (current_kboard
, echo_string
);
517 /* If someone has passed us a composite event, use its head symbol. */
522 ptr
= push_key_description (XINT (c
), ptr
);
524 else if (SYMBOLP (c
))
526 Lisp_Object name
= SYMBOL_NAME (c
);
527 int nbytes
= SBYTES (name
);
529 if (size
- (ptr
- buffer
) < nbytes
)
531 int offset
= ptr
- buffer
;
532 size
= max (2 * size
, size
+ nbytes
);
533 buffer
= alloca (size
);
534 ptr
= buffer
+ offset
;
537 ptr
+= copy_text (SDATA (name
), (unsigned char *) ptr
, nbytes
,
538 STRING_MULTIBYTE (name
), 1);
541 if ((NILP (echo_string
) || SCHARS (echo_string
) == 0)
544 const char *text
= " (Type ? for further options)";
545 int len
= strlen (text
);
547 if (size
- (ptr
- buffer
) < len
)
549 int offset
= ptr
- buffer
;
551 buffer
= alloca (size
);
552 ptr
= buffer
+ offset
;
555 memcpy (ptr
, text
, len
);
559 /* Replace a dash from echo_dash with a space, otherwise
560 add a space at the end as a separator between keys. */
561 if (STRINGP (echo_string
)
562 && SCHARS (echo_string
) > 1)
564 Lisp_Object last_char
, prev_char
, idx
;
566 idx
= make_number (SCHARS (echo_string
) - 2);
567 prev_char
= Faref (echo_string
, idx
);
569 idx
= make_number (SCHARS (echo_string
) - 1);
570 last_char
= Faref (echo_string
, idx
);
572 /* We test PREV_CHAR to make sure this isn't the echoing
574 if (XINT (last_char
) == '-' && XINT (prev_char
) != ' ')
575 Faset (echo_string
, idx
, make_number (' '));
577 echo_string
= concat2 (echo_string
, build_string (" "));
579 else if (STRINGP (echo_string
))
580 echo_string
= concat2 (echo_string
, build_string (" "));
584 concat2 (echo_string
, make_string (buffer
, ptr
- buffer
)));
590 /* Temporarily add a dash to the end of the echo string if it's not
591 empty, so that it serves as a mini-prompt for the very next character. */
596 /* Do nothing if not echoing at all. */
597 if (NILP (KVAR (current_kboard
, echo_string
)))
600 if (this_command_key_count
== 0)
603 if (!current_kboard
->immediate_echo
604 && SCHARS (KVAR (current_kboard
, echo_string
)) == 0)
607 /* Do nothing if we just printed a prompt. */
608 if (current_kboard
->echo_after_prompt
609 == SCHARS (KVAR (current_kboard
, echo_string
)))
612 /* Do nothing if we have already put a dash at the end. */
613 if (SCHARS (KVAR (current_kboard
, echo_string
)) > 1)
615 Lisp_Object last_char
, prev_char
, idx
;
617 idx
= make_number (SCHARS (KVAR (current_kboard
, echo_string
)) - 2);
618 prev_char
= Faref (KVAR (current_kboard
, echo_string
), idx
);
620 idx
= make_number (SCHARS (KVAR (current_kboard
, echo_string
)) - 1);
621 last_char
= Faref (KVAR (current_kboard
, echo_string
), idx
);
623 if (XINT (last_char
) == '-' && XINT (prev_char
) != ' ')
627 /* Put a dash at the end of the buffer temporarily,
628 but make it go away when the next character is added. */
631 concat2 (KVAR (current_kboard
, echo_string
), build_string ("-")));
635 /* Display the current echo string, and begin echoing if not already
641 if (!current_kboard
->immediate_echo
)
644 current_kboard
->immediate_echo
= 1;
646 for (i
= 0; i
< this_command_key_count
; i
++)
650 /* Set before_command_echo_length to the value that would
651 have been saved before the start of this subcommand in
652 command_loop_1, if we had already been echoing then. */
653 if (i
== this_single_command_key_start
)
654 before_command_echo_length
= echo_length ();
656 c
= AREF (this_command_keys
, i
);
657 if (! (EVENT_HAS_PARAMETERS (c
)
658 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
662 /* Set before_command_echo_length to the value that would
663 have been saved before the start of this subcommand in
664 command_loop_1, if we had already been echoing then. */
665 if (this_command_key_count
== this_single_command_key_start
)
666 before_command_echo_length
= echo_length ();
668 /* Put a dash at the end to invite the user to type more. */
673 message3_nolog (KVAR (current_kboard
, echo_string
),
674 SBYTES (KVAR (current_kboard
, echo_string
)),
675 STRING_MULTIBYTE (KVAR (current_kboard
, echo_string
)));
678 /* Record in what buffer we echoed, and from which kboard. */
679 echo_message_buffer
= echo_area_buffer
[0];
680 echo_kboard
= current_kboard
;
682 if (waiting_for_input
&& !NILP (Vquit_flag
))
683 quit_throw_to_read_char (0);
686 /* Turn off echoing, for the start of a new command. */
689 cancel_echoing (void)
691 current_kboard
->immediate_echo
= 0;
692 current_kboard
->echo_after_prompt
= -1;
693 kset_echo_string (current_kboard
, Qnil
);
694 ok_to_echo_at_next_pause
= NULL
;
696 echo_message_buffer
= Qnil
;
699 /* Return the length of the current echo string. */
704 return (STRINGP (KVAR (current_kboard
, echo_string
))
705 ? SCHARS (KVAR (current_kboard
, echo_string
))
709 /* Truncate the current echo message to its first LEN chars.
710 This and echo_char get used by read_key_sequence when the user
711 switches frames while entering a key sequence. */
714 echo_truncate (ptrdiff_t nchars
)
716 if (STRINGP (KVAR (current_kboard
, echo_string
)))
717 kset_echo_string (current_kboard
,
718 Fsubstring (KVAR (current_kboard
, echo_string
),
719 make_number (0), make_number (nchars
)));
720 truncate_echo_area (nchars
);
724 /* Functions for manipulating this_command_keys. */
726 add_command_key (Lisp_Object key
)
728 #if 0 /* Not needed after we made Freset_this_command_lengths
729 do the job immediately. */
730 /* If reset-this-command-length was called recently, obey it now.
731 See the doc string of that function for an explanation of why. */
732 if (before_command_restore_flag
)
734 this_command_key_count
= before_command_key_count_1
;
735 if (this_command_key_count
< this_single_command_key_start
)
736 this_single_command_key_start
= this_command_key_count
;
737 echo_truncate (before_command_echo_length_1
);
738 before_command_restore_flag
= 0;
742 if (this_command_key_count
>= ASIZE (this_command_keys
))
743 this_command_keys
= larger_vector (this_command_keys
, 1, -1);
745 ASET (this_command_keys
, this_command_key_count
, key
);
746 ++this_command_key_count
;
751 recursive_edit_1 (void)
753 ptrdiff_t count
= SPECPDL_INDEX ();
756 if (command_loop_level
> 0)
758 specbind (Qstandard_output
, Qt
);
759 specbind (Qstandard_input
, Qt
);
762 #ifdef HAVE_WINDOW_SYSTEM
763 /* The command loop has started an hourglass timer, so we have to
764 cancel it here, otherwise it will fire because the recursive edit
765 can take some time. Do not check for display_hourglass_p here,
766 because it could already be nil. */
770 /* This function may have been called from a debugger called from
771 within redisplay, for instance by Edebugging a function called
772 from fontification-functions. We want to allow redisplay in
773 the debugging session.
775 The recursive edit is left with a `(throw exit ...)'. The `exit'
776 tag is not caught anywhere in redisplay, i.e. when we leave the
777 recursive edit, the original redisplay leading to the recursive
778 edit will be unwound. The outcome should therefore be safe. */
779 specbind (Qinhibit_redisplay
, Qnil
);
782 val
= command_loop ();
784 Fsignal (Qquit
, Qnil
);
785 /* Handle throw from read_minibuf when using minibuffer
786 while it's active but we're in another window. */
788 xsignal1 (Qerror
, val
);
790 return unbind_to (count
, Qnil
);
793 /* When an auto-save happens, record the "time", and don't do again soon. */
796 record_auto_save (void)
798 last_auto_save
= num_nonmacro_input_events
;
801 /* Make an auto save happen as soon as possible at command level. */
805 force_auto_save_soon (void)
807 last_auto_save
= - auto_save_interval
- 1;
809 record_asynch_buffer_change ();
813 DEFUN ("recursive-edit", Frecursive_edit
, Srecursive_edit
, 0, 0, "",
814 doc
: /* Invoke the editor command loop recursively.
815 To get out of the recursive edit, a command can do `(throw 'exit nil)';
816 that tells this function to return.
817 Alternatively, `(throw 'exit t)' makes this function signal an error.
818 This function is called by the editor initialization to begin editing. */)
821 ptrdiff_t count
= SPECPDL_INDEX ();
824 /* If we enter while input is blocked, don't lock up here.
825 This may happen through the debugger during redisplay. */
826 if (input_blocked_p ())
829 command_loop_level
++;
830 update_mode_lines
= 1;
832 if (command_loop_level
833 && current_buffer
!= XBUFFER (XWINDOW (selected_window
)->buffer
))
834 buffer
= Fcurrent_buffer ();
838 /* If we leave recursive_edit_1 below with a `throw' for instance,
839 like it is done in the splash screen display, we have to
840 make sure that we restore single_kboard as command_loop_1
841 would have done if it were left normally. */
842 if (command_loop_level
> 0)
843 temporarily_switch_to_single_kboard (SELECTED_FRAME ());
844 record_unwind_protect (recursive_edit_unwind
, buffer
);
847 return unbind_to (count
, Qnil
);
851 recursive_edit_unwind (Lisp_Object buffer
)
853 if (BUFFERP (buffer
))
854 Fset_buffer (buffer
);
856 command_loop_level
--;
857 update_mode_lines
= 1;
862 #if 0 /* These two functions are now replaced with
863 temporarily_switch_to_single_kboard. */
867 #if 0 /* Theory: if there's anything in Vunread_command_events,
868 it will right away be read by read_key_sequence,
869 and then if we do switch KBOARDS, it will go into the side
870 queue then. So we don't need to do anything special here -- rms. */
871 if (CONSP (Vunread_command_events
))
873 current_kboard
->kbd_queue
874 = nconc2 (Vunread_command_events
, current_kboard
->kbd_queue
);
875 current_kboard
->kbd_queue_has_data
= 1;
877 Vunread_command_events
= Qnil
;
882 /* Switch to the single-kboard state, making current_kboard
883 the only KBOARD from which further input is accepted. */
886 single_kboard_state ()
892 /* If we're in single_kboard state for kboard KBOARD,
896 not_single_kboard_state (KBOARD
*kboard
)
898 if (kboard
== current_kboard
)
902 /* Maintain a stack of kboards, so other parts of Emacs
903 can switch temporarily to the kboard of a given frame
904 and then revert to the previous status. */
909 struct kboard_stack
*next
;
912 static struct kboard_stack
*kboard_stack
;
915 push_kboard (struct kboard
*k
)
917 struct kboard_stack
*p
= xmalloc (sizeof *p
);
919 p
->next
= kboard_stack
;
920 p
->kboard
= current_kboard
;
930 struct kboard_stack
*p
= kboard_stack
;
932 for (t
= terminal_list
; t
; t
= t
->next_terminal
)
934 if (t
->kboard
== p
->kboard
)
936 current_kboard
= p
->kboard
;
943 /* The terminal we remembered has been deleted. */
944 current_kboard
= FRAME_KBOARD (SELECTED_FRAME ());
947 kboard_stack
= p
->next
;
951 /* Switch to single_kboard mode, making current_kboard the only KBOARD
952 from which further input is accepted. If F is non-nil, set its
953 KBOARD as the current keyboard.
955 This function uses record_unwind_protect to return to the previous
958 If Emacs is already in single_kboard mode, and F's keyboard is
959 locked, then this function will throw an error. */
962 temporarily_switch_to_single_kboard (struct frame
*f
)
964 bool was_locked
= single_kboard
;
967 if (f
!= NULL
&& FRAME_KBOARD (f
) != current_kboard
)
968 /* We can not switch keyboards while in single_kboard mode.
969 In rare cases, Lisp code may call `recursive-edit' (or
970 `read-minibuffer' or `y-or-n-p') after it switched to a
971 locked frame. For example, this is likely to happen
972 when server.el connects to a new terminal while Emacs is in
973 single_kboard mode. It is best to throw an error instead
974 of presenting the user with a frozen screen. */
975 error ("Terminal %d is locked, cannot read from it",
976 FRAME_TERMINAL (f
)->id
);
978 /* This call is unnecessary, but helps
979 `restore_kboard_configuration' discover if somebody changed
980 `current_kboard' behind our back. */
981 push_kboard (current_kboard
);
984 current_kboard
= FRAME_KBOARD (f
);
986 record_unwind_protect (restore_kboard_configuration
,
987 (was_locked
? Qt
: Qnil
));
990 #if 0 /* This function is not needed anymore. */
992 record_single_kboard_state ()
995 push_kboard (current_kboard
);
996 record_unwind_protect (restore_kboard_configuration
,
997 (single_kboard
? Qt
: Qnil
));
1002 restore_kboard_configuration (Lisp_Object was_locked
)
1004 if (NILP (was_locked
))
1008 struct kboard
*prev
= current_kboard
;
1011 /* The pop should not change the kboard. */
1012 if (single_kboard
&& current_kboard
!= prev
)
1019 /* Handle errors that are not handled at inner levels
1020 by printing an error message and returning to the editor command loop. */
1023 cmd_error (Lisp_Object data
)
1025 Lisp_Object old_level
, old_length
;
1026 char macroerror
[sizeof "After..kbd macro iterations: "
1027 + INT_STRLEN_BOUND (EMACS_INT
)];
1029 #ifdef HAVE_WINDOW_SYSTEM
1030 if (display_hourglass_p
)
1031 cancel_hourglass ();
1034 if (!NILP (executing_kbd_macro
))
1036 if (executing_kbd_macro_iterations
== 1)
1037 sprintf (macroerror
, "After 1 kbd macro iteration: ");
1039 sprintf (macroerror
, "After %"pI
"d kbd macro iterations: ",
1040 executing_kbd_macro_iterations
);
1045 Vstandard_output
= Qt
;
1046 Vstandard_input
= Qt
;
1047 Vexecuting_kbd_macro
= Qnil
;
1048 executing_kbd_macro
= Qnil
;
1049 kset_prefix_arg (current_kboard
, Qnil
);
1050 kset_last_prefix_arg (current_kboard
, Qnil
);
1053 /* Avoid unquittable loop if data contains a circular list. */
1054 old_level
= Vprint_level
;
1055 old_length
= Vprint_length
;
1056 XSETFASTINT (Vprint_level
, 10);
1057 XSETFASTINT (Vprint_length
, 10);
1058 cmd_error_internal (data
, macroerror
);
1059 Vprint_level
= old_level
;
1060 Vprint_length
= old_length
;
1063 Vinhibit_quit
= Qnil
;
1065 return make_number (0);
1068 /* Take actions on handling an error. DATA is the data that describes
1071 CONTEXT is a C-string containing ASCII characters only which
1072 describes the context in which the error happened. If we need to
1073 generalize CONTEXT to allow multibyte characters, make it a Lisp
1077 cmd_error_internal (Lisp_Object data
, const char *context
)
1079 struct frame
*sf
= SELECTED_FRAME ();
1081 /* The immediate context is not interesting for Quits,
1082 since they are asynchronous. */
1083 if (EQ (XCAR (data
), Qquit
))
1084 Vsignaling_function
= Qnil
;
1089 /* Use user's specified output function if any. */
1090 if (!NILP (Vcommand_error_function
))
1091 call3 (Vcommand_error_function
, data
,
1092 context
? build_string (context
) : empty_unibyte_string
,
1093 Vsignaling_function
);
1094 /* If the window system or terminal frame hasn't been initialized
1095 yet, or we're not interactive, write the message to stderr and exit. */
1096 else if (!sf
->glyphs_initialized_p
1097 /* The initial frame is a special non-displaying frame. It
1098 will be current in daemon mode when there are no frames
1099 to display, and in non-daemon mode before the real frame
1100 has finished initializing. If an error is thrown in the
1101 latter case while creating the frame, then the frame
1102 will never be displayed, so the safest thing to do is
1103 write to stderr and quit. In daemon mode, there are
1104 many other potential errors that do not prevent frames
1105 from being created, so continuing as normal is better in
1107 || (!IS_DAEMON
&& FRAME_INITIAL_P (sf
))
1110 print_error_message (data
, Qexternal_debugging_output
,
1111 context
, Vsignaling_function
);
1112 Fterpri (Qexternal_debugging_output
);
1113 Fkill_emacs (make_number (-1));
1117 clear_message (1, 0);
1119 message_log_maybe_newline ();
1122 print_error_message (data
, Qt
, context
, Vsignaling_function
);
1125 Vsignaling_function
= Qnil
;
1128 Lisp_Object
command_loop_1 (void);
1129 static Lisp_Object
command_loop_2 (Lisp_Object
);
1130 static Lisp_Object
top_level_1 (Lisp_Object
);
1132 /* Entry to editor-command-loop.
1133 This level has the catches for exiting/returning to editor command loop.
1134 It returns nil to exit recursive edit, t to abort it. */
1139 if (command_loop_level
> 0 || minibuf_level
> 0)
1142 val
= internal_catch (Qexit
, command_loop_2
, Qnil
);
1143 executing_kbd_macro
= Qnil
;
1149 internal_catch (Qtop_level
, top_level_1
, Qnil
);
1150 internal_catch (Qtop_level
, command_loop_2
, Qnil
);
1151 executing_kbd_macro
= Qnil
;
1153 /* End of file in -batch run causes exit here. */
1159 /* Here we catch errors in execution of commands within the
1160 editing loop, and reenter the editing loop.
1161 When there is an error, cmd_error runs and returns a non-nil
1162 value to us. A value of nil means that command_loop_1 itself
1163 returned due to end of file (or end of kbd macro). */
1166 command_loop_2 (Lisp_Object ignore
)
1168 register Lisp_Object val
;
1171 val
= internal_condition_case (command_loop_1
, Qerror
, cmd_error
);
1172 while (!NILP (val
));
1180 return Feval (Vtop_level
, Qnil
);
1184 top_level_1 (Lisp_Object ignore
)
1186 /* On entry to the outer level, run the startup file */
1187 if (!NILP (Vtop_level
))
1188 internal_condition_case (top_level_2
, Qerror
, cmd_error
);
1189 else if (!NILP (Vpurify_flag
))
1190 message ("Bare impure Emacs (standard Lisp code not loaded)");
1192 message ("Bare Emacs (standard Lisp code not loaded)");
1196 DEFUN ("top-level", Ftop_level
, Stop_level
, 0, 0, "",
1197 doc
: /* Exit all recursive editing levels.
1198 This also exits all active minibuffers. */)
1201 #ifdef HAVE_WINDOW_SYSTEM
1202 if (display_hourglass_p
)
1203 cancel_hourglass ();
1206 /* Unblock input if we enter with input blocked. This may happen if
1207 redisplay traps e.g. during tool-bar update with input blocked. */
1208 totally_unblock_input ();
1210 Fthrow (Qtop_level
, Qnil
);
1213 static _Noreturn
void
1214 user_error (const char *msg
)
1216 xsignal1 (Quser_error
, build_string (msg
));
1220 DEFUN ("exit-recursive-edit", Fexit_recursive_edit
, Sexit_recursive_edit
, 0, 0, "",
1221 doc
: /* Exit from the innermost recursive edit or minibuffer. */)
1224 if (command_loop_level
> 0 || minibuf_level
> 0)
1225 Fthrow (Qexit
, Qnil
);
1227 user_error ("No recursive edit is in progress");
1231 DEFUN ("abort-recursive-edit", Fabort_recursive_edit
, Sabort_recursive_edit
, 0, 0, "",
1232 doc
: /* Abort the command that requested this recursive edit or minibuffer input. */)
1235 if (command_loop_level
> 0 || minibuf_level
> 0)
1238 user_error ("No recursive edit is in progress");
1241 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
1243 /* Restore mouse tracking enablement. See Ftrack_mouse for the only use
1244 of this function. */
1247 tracking_off (Lisp_Object old_value
)
1249 do_mouse_tracking
= old_value
;
1250 if (NILP (old_value
))
1252 /* Redisplay may have been preempted because there was input
1253 available, and it assumes it will be called again after the
1254 input has been processed. If the only input available was
1255 the sort that we have just disabled, then we need to call
1257 if (!readable_events (READABLE_EVENTS_DO_TIMERS_NOW
))
1259 redisplay_preserve_echo_area (6);
1260 get_input_pending (READABLE_EVENTS_DO_TIMERS_NOW
);
1266 DEFUN ("track-mouse", Ftrack_mouse
, Strack_mouse
, 0, UNEVALLED
, 0,
1267 doc
: /* Evaluate BODY with mouse movement events enabled.
1268 Within a `track-mouse' form, mouse motion generates input events that
1269 you can read with `read-event'.
1270 Normally, mouse motion is ignored.
1271 usage: (track-mouse BODY...) */)
1274 ptrdiff_t count
= SPECPDL_INDEX ();
1277 record_unwind_protect (tracking_off
, do_mouse_tracking
);
1279 do_mouse_tracking
= Qt
;
1281 val
= Fprogn (args
);
1282 return unbind_to (count
, val
);
1285 /* If mouse has moved on some frame, return one of those frames.
1289 If ignore_mouse_drag_p is non-zero, ignore (implicit) mouse movement
1290 after resizing the tool-bar window. */
1292 #if !defined HAVE_WINDOW_SYSTEM || defined USE_GTK || defined HAVE_NS
1295 bool ignore_mouse_drag_p
;
1298 some_mouse_moved (void)
1300 Lisp_Object tail
, frame
;
1302 if (ignore_mouse_drag_p
)
1304 /* ignore_mouse_drag_p = 0; */
1308 FOR_EACH_FRAME (tail
, frame
)
1310 if (XFRAME (frame
)->mouse_moved
)
1311 return XFRAME (frame
);
1317 #endif /* HAVE_MOUSE || HAVE_GPM */
1319 /* This is the actual command reading loop,
1320 sans error-handling encapsulation. */
1322 static int read_key_sequence (Lisp_Object
*, int, Lisp_Object
,
1324 void safe_run_hooks (Lisp_Object
);
1325 static void adjust_point_for_property (ptrdiff_t, bool);
1327 /* Cancel hourglass from protect_unwind.
1329 #ifdef HAVE_WINDOW_SYSTEM
1331 cancel_hourglass_unwind (Lisp_Object arg
)
1333 cancel_hourglass ();
1338 /* The last boundary auto-added to buffer-undo-list. */
1339 Lisp_Object last_undo_boundary
;
1341 /* FIXME: This is wrong rather than test window-system, we should call
1342 a new set-selection, which will then dispatch to x-set-selection, or
1343 tty-set-selection, or w32-set-selection, ... */
1346 command_loop_1 (void)
1349 Lisp_Object keybuf
[30];
1351 EMACS_INT prev_modiff
= 0;
1352 struct buffer
*prev_buffer
= NULL
;
1353 bool already_adjusted
= 0;
1355 kset_prefix_arg (current_kboard
, Qnil
);
1356 kset_last_prefix_arg (current_kboard
, Qnil
);
1357 Vdeactivate_mark
= Qnil
;
1358 waiting_for_input
= 0;
1361 this_command_key_count
= 0;
1362 this_command_key_count_reset
= 0;
1363 this_single_command_key_start
= 0;
1365 if (NILP (Vmemory_full
))
1367 /* Make sure this hook runs after commands that get errors and
1368 throw to top level. */
1369 /* Note that the value cell will never directly contain nil
1370 if the symbol is a local variable. */
1371 if (!NILP (Vpost_command_hook
) && !NILP (Vrun_hooks
))
1372 safe_run_hooks (Qpost_command_hook
);
1374 /* If displaying a message, resize the echo area window to fit
1375 that message's size exactly. */
1376 if (!NILP (echo_area_buffer
[0]))
1377 resize_echo_area_exactly ();
1379 /* If there are warnings waiting, process them. */
1380 if (!NILP (Vdelayed_warnings_list
))
1381 safe_run_hooks (Qdelayed_warnings_hook
);
1383 if (!NILP (Vdeferred_action_list
))
1384 safe_run_hooks (Qdeferred_action_function
);
1387 /* Do this after running Vpost_command_hook, for consistency. */
1388 kset_last_command (current_kboard
, Vthis_command
);
1389 kset_real_last_command (current_kboard
, Vreal_this_command
);
1390 if (!CONSP (last_command_event
))
1391 kset_last_repeatable_command (current_kboard
, Vreal_this_command
);
1395 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1398 /* Make sure the current window's buffer is selected. */
1399 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->buffer
));
1401 /* Display any malloc warning that just came out. Use while because
1402 displaying one warning can cause another. */
1404 while (pending_malloc_warning
)
1405 display_malloc_warning ();
1407 Vdeactivate_mark
= Qnil
;
1409 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
1411 /* Don't ignore mouse movements for more than a single command
1412 loop. (This flag is set in xdisp.c whenever the tool bar is
1413 resized, because the resize moves text up or down, and would
1414 generate false mouse drag events if we don't ignore them.) */
1415 ignore_mouse_drag_p
= 0;
1418 /* If minibuffer on and echo area in use,
1419 wait a short time and redraw minibuffer. */
1422 && !NILP (echo_area_buffer
[0])
1423 && EQ (minibuf_window
, echo_area_window
)
1424 && NUMBERP (Vminibuffer_message_timeout
))
1426 /* Bind inhibit-quit to t so that C-g gets read in
1427 rather than quitting back to the minibuffer. */
1428 ptrdiff_t count
= SPECPDL_INDEX ();
1429 specbind (Qinhibit_quit
, Qt
);
1431 sit_for (Vminibuffer_message_timeout
, 0, 2);
1433 /* Clear the echo area. */
1435 safe_run_hooks (Qecho_area_clear_hook
);
1437 unbind_to (count
, Qnil
);
1439 /* If a C-g came in before, treat it as input now. */
1440 if (!NILP (Vquit_flag
))
1443 Vunread_command_events
= Fcons (make_number (quit_char
), Qnil
);
1447 /* If it has changed current-menubar from previous value,
1448 really recompute the menubar from the value. */
1449 if (! NILP (Vlucid_menu_bar_dirty_flag
)
1450 && !NILP (Ffboundp (Qrecompute_lucid_menubar
)))
1451 call0 (Qrecompute_lucid_menubar
);
1453 before_command_key_count
= this_command_key_count
;
1454 before_command_echo_length
= echo_length ();
1456 Vthis_command
= Qnil
;
1457 Vreal_this_command
= Qnil
;
1458 Vthis_original_command
= Qnil
;
1459 Vthis_command_keys_shift_translated
= Qnil
;
1461 /* Read next key sequence; i gets its length. */
1462 i
= read_key_sequence (keybuf
, sizeof keybuf
/ sizeof keybuf
[0],
1465 /* A filter may have run while we were reading the input. */
1466 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1468 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->buffer
));
1472 /* Now we have read a key sequence of length I,
1473 or else I is 0 and we found end of file. */
1475 if (i
== 0) /* End of file -- happens only in */
1476 return Qnil
; /* a kbd macro, at the end. */
1477 /* -1 means read_key_sequence got a menu that was rejected.
1478 Just loop around and read another command. */
1482 this_command_key_count
= 0;
1483 this_command_key_count_reset
= 0;
1484 this_single_command_key_start
= 0;
1488 last_command_event
= keybuf
[i
- 1];
1490 /* If the previous command tried to force a specific window-start,
1491 forget about that, in case this command moves point far away
1492 from that position. But also throw away beg_unchanged and
1493 end_unchanged information in that case, so that redisplay will
1494 update the whole window properly. */
1495 if (XWINDOW (selected_window
)->force_start
)
1498 XWINDOW (selected_window
)->force_start
= 0;
1499 b
= XBUFFER (XWINDOW (selected_window
)->buffer
);
1500 BUF_BEG_UNCHANGED (b
) = BUF_END_UNCHANGED (b
) = 0;
1503 cmd
= read_key_sequence_cmd
;
1504 if (!NILP (Vexecuting_kbd_macro
))
1506 if (!NILP (Vquit_flag
))
1508 Vexecuting_kbd_macro
= Qt
;
1509 QUIT
; /* Make some noise. */
1510 /* Will return since macro now empty. */
1514 /* Do redisplay processing after this command except in special
1515 cases identified below. */
1516 prev_buffer
= current_buffer
;
1517 prev_modiff
= MODIFF
;
1518 last_point_position
= PT
;
1519 last_point_position_window
= selected_window
;
1520 XSETBUFFER (last_point_position_buffer
, prev_buffer
);
1522 /* By default, we adjust point to a boundary of a region that
1523 has such a property that should be treated intangible
1524 (e.g. composition, display). But, some commands will set
1525 this variable differently. */
1526 Vdisable_point_adjustment
= Qnil
;
1528 /* Process filters and timers may have messed with deactivate-mark.
1529 reset it before we execute the command. */
1530 Vdeactivate_mark
= Qnil
;
1532 /* Remap command through active keymaps. */
1533 Vthis_original_command
= cmd
;
1534 if (!NILP (read_key_sequence_remapped
))
1535 cmd
= read_key_sequence_remapped
;
1537 /* Execute the command. */
1539 Vthis_command
= cmd
;
1540 Vreal_this_command
= cmd
;
1541 safe_run_hooks (Qpre_command_hook
);
1543 already_adjusted
= 0;
1545 if (NILP (Vthis_command
))
1547 /* nil means key is undefined. */
1548 Lisp_Object keys
= Fvector (i
, keybuf
);
1549 keys
= Fkey_description (keys
, Qnil
);
1551 message_with_string ("%s is undefined", keys
, 0);
1552 kset_defining_kbd_macro (current_kboard
, Qnil
);
1553 update_mode_lines
= 1;
1554 /* If this is a down-mouse event, don't reset prefix-arg;
1555 pass it to the command run by the up event. */
1556 if (EVENT_HAS_PARAMETERS (last_command_event
))
1558 Lisp_Object breakdown
1559 = parse_modifiers (EVENT_HEAD (last_command_event
));
1560 int modifiers
= XINT (XCAR (XCDR (breakdown
)));
1561 if (!(modifiers
& down_modifier
))
1562 kset_prefix_arg (current_kboard
, Qnil
);
1565 kset_prefix_arg (current_kboard
, Qnil
);
1569 /* Here for a command that isn't executed directly. */
1571 #ifdef HAVE_WINDOW_SYSTEM
1572 ptrdiff_t scount
= SPECPDL_INDEX ();
1574 if (display_hourglass_p
1575 && NILP (Vexecuting_kbd_macro
))
1577 record_unwind_protect (cancel_hourglass_unwind
, Qnil
);
1582 if (NILP (KVAR (current_kboard
, Vprefix_arg
))) /* FIXME: Why? --Stef */
1584 Lisp_Object undo
= BVAR (current_buffer
, undo_list
);
1587 = (EQ (undo
, BVAR (current_buffer
, undo_list
))
1588 ? Qnil
: BVAR (current_buffer
, undo_list
));
1590 Fcommand_execute (Vthis_command
, Qnil
, Qnil
, Qnil
);
1592 #ifdef HAVE_WINDOW_SYSTEM
1593 /* Do not check display_hourglass_p here, because
1594 Fcommand_execute could change it, but we should cancel
1595 hourglass cursor anyway.
1596 But don't cancel the hourglass within a macro
1597 just because a command in the macro finishes. */
1598 if (NILP (Vexecuting_kbd_macro
))
1599 unbind_to (scount
, Qnil
);
1602 kset_last_prefix_arg (current_kboard
, Vcurrent_prefix_arg
);
1604 safe_run_hooks (Qpost_command_hook
);
1606 /* If displaying a message, resize the echo area window to fit
1607 that message's size exactly. */
1608 if (!NILP (echo_area_buffer
[0]))
1609 resize_echo_area_exactly ();
1611 /* If there are warnings waiting, process them. */
1612 if (!NILP (Vdelayed_warnings_list
))
1613 safe_run_hooks (Qdelayed_warnings_hook
);
1615 safe_run_hooks (Qdeferred_action_function
);
1617 /* If there is a prefix argument,
1618 1) We don't want Vlast_command to be ``universal-argument''
1619 (that would be dumb), so don't set Vlast_command,
1620 2) we want to leave echoing on so that the prefix will be
1621 echoed as part of this key sequence, so don't call
1623 3) we want to leave this_command_key_count non-zero, so that
1624 read_char will realize that it is re-reading a character, and
1625 not echo it a second time.
1627 If the command didn't actually create a prefix arg,
1628 but is merely a frame event that is transparent to prefix args,
1629 then the above doesn't apply. */
1630 if (NILP (KVAR (current_kboard
, Vprefix_arg
))
1631 || CONSP (last_command_event
))
1633 kset_last_command (current_kboard
, Vthis_command
);
1634 kset_real_last_command (current_kboard
, Vreal_this_command
);
1635 if (!CONSP (last_command_event
))
1636 kset_last_repeatable_command (current_kboard
, Vreal_this_command
);
1638 this_command_key_count
= 0;
1639 this_command_key_count_reset
= 0;
1640 this_single_command_key_start
= 0;
1643 if (!NILP (BVAR (current_buffer
, mark_active
))
1644 && !NILP (Vrun_hooks
))
1646 /* In Emacs 22, setting transient-mark-mode to `only' was a
1647 way of turning it on for just one command. This usage is
1648 obsolete, but support it anyway. */
1649 if (EQ (Vtransient_mark_mode
, Qidentity
))
1650 Vtransient_mark_mode
= Qnil
;
1651 else if (EQ (Vtransient_mark_mode
, Qonly
))
1652 Vtransient_mark_mode
= Qidentity
;
1654 if (!NILP (Vdeactivate_mark
))
1655 /* If `select-active-regions' is non-nil, this call to
1656 `deactivate-mark' also sets the PRIMARY selection. */
1657 call0 (Qdeactivate_mark
);
1660 /* Even if not deactivating the mark, set PRIMARY if
1661 `select-active-regions' is non-nil. */
1662 if (!NILP (Fwindow_system (Qnil
))
1663 /* Even if mark_active is non-nil, the actual buffer
1664 marker may not have been set yet (Bug#7044). */
1665 && XMARKER (BVAR (current_buffer
, mark
))->buffer
1666 && (EQ (Vselect_active_regions
, Qonly
)
1667 ? EQ (CAR_SAFE (Vtransient_mark_mode
), Qonly
)
1668 : (!NILP (Vselect_active_regions
)
1669 && !NILP (Vtransient_mark_mode
)))
1670 && NILP (Fmemq (Vthis_command
,
1671 Vselection_inhibit_update_commands
)))
1674 XINT (Fmarker_position (BVAR (current_buffer
, mark
)));
1677 call2 (Qx_set_selection
, QPRIMARY
,
1678 make_buffer_string (beg
, end
, 0));
1680 call2 (Qx_set_selection
, QPRIMARY
,
1681 make_buffer_string (end
, beg
, 0));
1682 /* Don't set empty selections. */
1685 if (current_buffer
!= prev_buffer
|| MODIFF
!= prev_modiff
)
1687 Lisp_Object hook
= intern ("activate-mark-hook");
1688 Frun_hooks (1, &hook
);
1692 Vsaved_region_selection
= Qnil
;
1697 if (current_buffer
== prev_buffer
1698 && last_point_position
!= PT
1699 && NILP (Vdisable_point_adjustment
)
1700 && NILP (Vglobal_disable_point_adjustment
))
1702 if (last_point_position
> BEGV
1703 && last_point_position
< ZV
1704 && (composition_adjust_point (last_point_position
,
1705 last_point_position
)
1706 != last_point_position
))
1707 /* The last point was temporarily set within a grapheme
1708 cluster to prevent automatic composition. To recover
1709 the automatic composition, we must update the
1711 windows_or_buffers_changed
++;
1712 if (!already_adjusted
)
1713 adjust_point_for_property (last_point_position
,
1714 MODIFF
!= prev_modiff
);
1717 /* Install chars successfully executed in kbd macro. */
1719 if (!NILP (KVAR (current_kboard
, defining_kbd_macro
))
1720 && NILP (KVAR (current_kboard
, Vprefix_arg
)))
1721 finalize_kbd_macro_chars ();
1725 /* Adjust point to a boundary of a region that has such a property
1726 that should be treated intangible. For the moment, we check
1727 `composition', `display' and `invisible' properties.
1728 LAST_PT is the last position of point. */
1731 adjust_point_for_property (ptrdiff_t last_pt
, bool modified
)
1734 Lisp_Object val
, overlay
, tmp
;
1735 /* When called after buffer modification, we should temporarily
1736 suppress the point adjustment for automatic composition so that a
1737 user can keep inserting another character at point or keep
1738 deleting characters around point. */
1739 bool check_composition
= ! modified
, check_display
= 1, check_invisible
= 1;
1740 ptrdiff_t orig_pt
= PT
;
1742 /* FIXME: cycling is probably not necessary because these properties
1743 can't be usefully combined anyway. */
1744 while (check_composition
|| check_display
|| check_invisible
)
1746 /* FIXME: check `intangible'. */
1747 if (check_composition
1748 && PT
> BEGV
&& PT
< ZV
1749 && (beg
= composition_adjust_point (last_pt
, PT
)) != PT
)
1752 check_display
= check_invisible
= 1;
1754 check_composition
= 0;
1756 && PT
> BEGV
&& PT
< ZV
1757 && !NILP (val
= get_char_property_and_overlay
1758 (make_number (PT
), Qdisplay
, Qnil
, &overlay
))
1759 && display_prop_intangible_p (val
, overlay
, PT
, PT_BYTE
)
1760 && (!OVERLAYP (overlay
)
1761 ? get_property_and_range (PT
, Qdisplay
, &val
, &beg
, &end
, Qnil
)
1762 : (beg
= OVERLAY_POSITION (OVERLAY_START (overlay
)),
1763 end
= OVERLAY_POSITION (OVERLAY_END (overlay
))))
1764 && (beg
< PT
/* && end > PT <- It's always the case. */
1765 || (beg
<= PT
&& STRINGP (val
) && SCHARS (val
) == 0)))
1768 SET_PT (PT
< last_pt
1769 ? (STRINGP (val
) && SCHARS (val
) == 0
1770 ? max (beg
- 1, BEGV
)
1773 check_composition
= check_invisible
= 1;
1776 if (check_invisible
&& PT
> BEGV
&& PT
< ZV
)
1782 /* Find boundaries `beg' and `end' of the invisible area, if any. */
1785 /* FIXME: We should stop if we find a spot between
1786 two runs of `invisible' where inserted text would
1787 be visible. This is important when we have two
1788 invisible boundaries that enclose an area: if the
1789 area is empty, we need this test in order to make
1790 it possible to place point in the middle rather
1791 than skip both boundaries. However, this code
1792 also stops anywhere in a non-sticky text-property,
1793 which breaks (e.g.) Org mode. */
1794 && (val
= get_pos_property (make_number (end
),
1796 TEXT_PROP_MEANS_INVISIBLE (val
))
1798 && !NILP (val
= get_char_property_and_overlay
1799 (make_number (end
), Qinvisible
, Qnil
, &overlay
))
1800 && (inv
= TEXT_PROP_MEANS_INVISIBLE (val
)))
1802 ellipsis
= ellipsis
|| inv
> 1
1803 || (OVERLAYP (overlay
)
1804 && (!NILP (Foverlay_get (overlay
, Qafter_string
))
1805 || !NILP (Foverlay_get (overlay
, Qbefore_string
))));
1806 tmp
= Fnext_single_char_property_change
1807 (make_number (end
), Qinvisible
, Qnil
, Qnil
);
1808 end
= NATNUMP (tmp
) ? XFASTINT (tmp
) : ZV
;
1812 && (val
= get_pos_property (make_number (beg
),
1814 TEXT_PROP_MEANS_INVISIBLE (val
))
1816 && !NILP (val
= get_char_property_and_overlay
1817 (make_number (beg
- 1), Qinvisible
, Qnil
, &overlay
))
1818 && (inv
= TEXT_PROP_MEANS_INVISIBLE (val
)))
1820 ellipsis
= ellipsis
|| inv
> 1
1821 || (OVERLAYP (overlay
)
1822 && (!NILP (Foverlay_get (overlay
, Qafter_string
))
1823 || !NILP (Foverlay_get (overlay
, Qbefore_string
))));
1824 tmp
= Fprevious_single_char_property_change
1825 (make_number (beg
), Qinvisible
, Qnil
, Qnil
);
1826 beg
= NATNUMP (tmp
) ? XFASTINT (tmp
) : BEGV
;
1829 /* Move away from the inside area. */
1830 if (beg
< PT
&& end
> PT
)
1832 SET_PT ((orig_pt
== PT
&& (last_pt
< beg
|| last_pt
> end
))
1833 /* We haven't moved yet (so we don't need to fear
1834 infinite-looping) and we were outside the range
1835 before (so either end of the range still corresponds
1836 to a move in the right direction): pretend we moved
1837 less than we actually did, so that we still have
1838 more freedom below in choosing which end of the range
1840 ? (orig_pt
= -1, PT
< last_pt
? end
: beg
)
1841 /* We either have moved already or the last point
1842 was already in the range: we don't get to choose
1843 which end of the range we have to go to. */
1844 : (PT
< last_pt
? beg
: end
));
1845 check_composition
= check_display
= 1;
1847 #if 0 /* This assertion isn't correct, because SET_PT may end up setting
1848 the point to something other than its argument, due to
1849 point-motion hooks, intangibility, etc. */
1850 eassert (PT
== beg
|| PT
== end
);
1853 /* Pretend the area doesn't exist if the buffer is not
1855 if (!modified
&& !ellipsis
&& beg
< end
)
1857 if (last_pt
== beg
&& PT
== end
&& end
< ZV
)
1858 (check_composition
= check_display
= 1, SET_PT (end
+ 1));
1859 else if (last_pt
== end
&& PT
== beg
&& beg
> BEGV
)
1860 (check_composition
= check_display
= 1, SET_PT (beg
- 1));
1861 else if (PT
== ((PT
< last_pt
) ? beg
: end
))
1862 /* We've already moved as far as we can. Trying to go
1863 to the other end would mean moving backwards and thus
1864 could lead to an infinite loop. */
1866 else if (val
= get_pos_property (make_number (PT
),
1868 TEXT_PROP_MEANS_INVISIBLE (val
)
1869 && (val
= get_pos_property
1870 (make_number (PT
== beg
? end
: beg
),
1872 !TEXT_PROP_MEANS_INVISIBLE (val
)))
1873 (check_composition
= check_display
= 1,
1874 SET_PT (PT
== beg
? end
: beg
));
1877 check_invisible
= 0;
1881 /* Subroutine for safe_run_hooks: run the hook HOOK. */
1884 safe_run_hooks_1 (void)
1886 eassert (CONSP (Vinhibit_quit
));
1887 return call0 (XCDR (Vinhibit_quit
));
1890 /* Subroutine for safe_run_hooks: handle an error by clearing out the function
1894 safe_run_hooks_error (Lisp_Object error_data
)
1897 = CONSP (Vinhibit_quit
) ? XCAR (Vinhibit_quit
) : Vinhibit_quit
;
1898 Lisp_Object fun
= CONSP (Vinhibit_quit
) ? XCDR (Vinhibit_quit
) : Qnil
;
1899 Lisp_Object args
[4];
1900 args
[0] = build_string ("Error in %s (%s): %S");
1903 args
[3] = error_data
;
1909 Lisp_Object newval
= Qnil
;
1910 for (val
= find_symbol_value (hook
); CONSP (val
); val
= XCDR (val
))
1911 if (EQ (fun
, XCAR (val
)))
1914 newval
= Fcons (XCAR (val
), newval
);
1916 return Fset (hook
, Fnreverse (newval
));
1917 /* Not found in the local part of the hook. Let's look at the global
1920 for (val
= (NILP (Fdefault_boundp (hook
)) ? Qnil
1921 : Fdefault_value (hook
));
1922 CONSP (val
); val
= XCDR (val
))
1923 if (EQ (fun
, XCAR (val
)))
1926 newval
= Fcons (XCAR (val
), newval
);
1928 return Fset_default (hook
, Fnreverse (newval
));
1934 safe_run_hook_funcall (ptrdiff_t nargs
, Lisp_Object
*args
)
1936 eassert (nargs
== 1);
1937 if (CONSP (Vinhibit_quit
))
1938 XSETCDR (Vinhibit_quit
, args
[0]);
1940 Vinhibit_quit
= Fcons (Vinhibit_quit
, args
[0]);
1942 internal_condition_case (safe_run_hooks_1
, Qt
, safe_run_hooks_error
);
1946 /* If we get an error while running the hook, cause the hook variable
1947 to be nil. Also inhibit quits, so that C-g won't cause the hook
1948 to mysteriously evaporate. */
1951 safe_run_hooks (Lisp_Object hook
)
1953 /* FIXME: our `internal_condition_case' does not provide any way to pass data
1954 to its body or to its handlers other than via globals such as
1955 dynamically-bound variables ;-) */
1956 ptrdiff_t count
= SPECPDL_INDEX ();
1957 specbind (Qinhibit_quit
, hook
);
1959 run_hook_with_args (1, &hook
, safe_run_hook_funcall
);
1961 unbind_to (count
, Qnil
);
1965 /* Nonzero means polling for input is temporarily suppressed. */
1967 int poll_suppress_count
;
1969 /* Asynchronous timer for polling. */
1971 static struct atimer
*poll_timer
;
1974 #ifdef POLL_FOR_INPUT
1976 /* Poll for input, so that we catch a C-g if it comes in. This
1977 function is called from x_make_frame_visible, see comment
1981 poll_for_input_1 (void)
1983 if (! input_blocked_p ()
1984 && !waiting_for_input
)
1988 /* Timer callback function for poll_timer. TIMER is equal to
1992 poll_for_input (struct atimer
*timer
)
1994 if (poll_suppress_count
== 0)
1995 pending_signals
= 1;
1998 #endif /* POLL_FOR_INPUT */
2000 /* Begin signals to poll for input, if they are appropriate.
2001 This function is called unconditionally from various places. */
2004 start_polling (void)
2006 #ifdef POLL_FOR_INPUT
2007 /* XXX This condition was (read_socket_hook && !interrupt_input),
2008 but read_socket_hook is not global anymore. Let's pretend that
2010 if (!interrupt_input
)
2012 /* Turn alarm handling on unconditionally. It might have
2013 been turned off in process.c. */
2014 turn_on_atimers (1);
2016 /* If poll timer doesn't exist, are we need one with
2017 a different interval, start a new one. */
2018 if (poll_timer
== NULL
2019 || EMACS_SECS (poll_timer
->interval
) != polling_period
)
2021 time_t period
= max (1, min (polling_period
, TYPE_MAXIMUM (time_t)));
2022 EMACS_TIME interval
= make_emacs_time (period
, 0);
2025 cancel_atimer (poll_timer
);
2027 poll_timer
= start_atimer (ATIMER_CONTINUOUS
, interval
,
2028 poll_for_input
, NULL
);
2031 /* Let the timer's callback function poll for input
2032 if this becomes zero. */
2033 --poll_suppress_count
;
2038 /* True if we are using polling to handle input asynchronously. */
2041 input_polling_used (void)
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 return !interrupt_input
;
2053 /* Turn off polling. */
2058 #ifdef POLL_FOR_INPUT
2059 /* XXX This condition was (read_socket_hook && !interrupt_input),
2060 but read_socket_hook is not global anymore. Let's pretend that
2062 if (!interrupt_input
)
2063 ++poll_suppress_count
;
2067 /* Set the value of poll_suppress_count to COUNT
2068 and start or stop polling accordingly. */
2071 set_poll_suppress_count (int count
)
2073 #ifdef POLL_FOR_INPUT
2074 if (count
== 0 && poll_suppress_count
!= 0)
2076 poll_suppress_count
= 1;
2079 else if (count
!= 0 && poll_suppress_count
== 0)
2083 poll_suppress_count
= count
;
2087 /* Bind polling_period to a value at least N.
2088 But don't decrease it. */
2091 bind_polling_period (int n
)
2093 #ifdef POLL_FOR_INPUT
2094 EMACS_INT
new = polling_period
;
2099 stop_other_atimers (poll_timer
);
2101 specbind (Qpolling_period
, make_number (new));
2102 /* Start a new alarm with the new period. */
2107 /* Apply the control modifier to CHARACTER. */
2110 make_ctrl_char (int c
)
2112 /* Save the upper bits here. */
2113 int upper
= c
& ~0177;
2115 if (! ASCII_BYTE_P (c
))
2116 return c
|= ctrl_modifier
;
2120 /* Everything in the columns containing the upper-case letters
2121 denotes a control character. */
2122 if (c
>= 0100 && c
< 0140)
2126 /* Set the shift modifier for a control char
2127 made from a shifted letter. But only for letters! */
2128 if (oc
>= 'A' && oc
<= 'Z')
2129 c
|= shift_modifier
;
2132 /* The lower-case letters denote control characters too. */
2133 else if (c
>= 'a' && c
<= 'z')
2136 /* Include the bits for control and shift
2137 only if the basic ASCII code can't indicate them. */
2141 /* Replace the high bits. */
2142 c
|= (upper
& ~ctrl_modifier
);
2147 /* Display the help-echo property of the character after the mouse pointer.
2148 Either show it in the echo area, or call show-help-function to display
2149 it by other means (maybe in a tooltip).
2151 If HELP is nil, that means clear the previous help echo.
2153 If HELP is a string, display that string. If HELP is a function,
2154 call it with OBJECT and POS as arguments; the function should
2155 return a help string or nil for none. For all other types of HELP,
2156 evaluate it to obtain a string.
2158 WINDOW is the window in which the help was generated, if any.
2159 It is nil if not in a window.
2161 If OBJECT is a buffer, POS is the position in the buffer where the
2162 `help-echo' text property was found.
2164 If OBJECT is an overlay, that overlay has a `help-echo' property,
2165 and POS is the position in the overlay's buffer under the mouse.
2167 If OBJECT is a string (an overlay string or a string displayed with
2168 the `display' property). POS is the position in that string under
2171 Note: this function may only be called with HELP nil or a string
2172 from X code running asynchronously. */
2175 show_help_echo (Lisp_Object help
, Lisp_Object window
, Lisp_Object object
,
2178 if (!NILP (help
) && !STRINGP (help
))
2180 if (FUNCTIONP (help
))
2181 help
= safe_call (4, help
, window
, object
, pos
);
2183 help
= safe_eval (help
);
2185 if (!STRINGP (help
))
2189 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
2190 if (!noninteractive
&& STRINGP (help
))
2192 /* The mouse-fixup-help-message Lisp function can call
2193 mouse_position_hook, which resets the mouse_moved flags.
2194 This causes trouble if we are trying to read a mouse motion
2195 event (i.e., if we are inside a `track-mouse' form), so we
2196 restore the mouse_moved flag. */
2197 FRAME_PTR f
= NILP (do_mouse_tracking
) ? NULL
: some_mouse_moved ();
2198 help
= call1 (Qmouse_fixup_help_message
, help
);
2204 if (STRINGP (help
) || NILP (help
))
2206 if (!NILP (Vshow_help_function
))
2207 call1 (Vshow_help_function
, help
);
2208 help_echo_showing_p
= STRINGP (help
);
2214 /* Input of single characters from keyboard */
2216 static Lisp_Object
kbd_buffer_get_event (KBOARD
**kbp
, bool *used_mouse_menu
,
2217 EMACS_TIME
*end_time
);
2218 static void record_char (Lisp_Object c
);
2220 static Lisp_Object help_form_saved_window_configs
;
2222 read_char_help_form_unwind (Lisp_Object arg
)
2224 Lisp_Object window_config
= XCAR (help_form_saved_window_configs
);
2225 help_form_saved_window_configs
= XCDR (help_form_saved_window_configs
);
2226 if (!NILP (window_config
))
2227 Fset_window_configuration (window_config
);
2231 #define STOP_POLLING \
2232 do { if (! polling_stopped_here) stop_polling (); \
2233 polling_stopped_here = 1; } while (0)
2235 #define RESUME_POLLING \
2236 do { if (polling_stopped_here) start_polling (); \
2237 polling_stopped_here = 0; } while (0)
2239 /* read a character from the keyboard; call the redisplay if needed */
2240 /* commandflag 0 means do not autosave, but do redisplay.
2241 -1 means do not redisplay, but do autosave.
2244 /* The arguments MAPS and NMAPS are for menu prompting.
2245 MAPS is an array of keymaps; NMAPS is the length of MAPS.
2247 PREV_EVENT is the previous input event, or nil if we are reading
2248 the first event of a key sequence (or not reading a key sequence).
2249 If PREV_EVENT is t, that is a "magic" value that says
2250 not to run input methods, but in other respects to act as if
2251 not reading a key sequence.
2253 If USED_MOUSE_MENU is non-null, then set *USED_MOUSE_MENU to true
2254 if we used a mouse menu to read the input, or false otherwise. If
2255 USED_MOUSE_MENU is null, don't dereference it.
2257 Value is -2 when we find input on another keyboard. A second call
2258 to read_char will read it.
2260 If END_TIME is non-null, it is a pointer to an EMACS_TIME
2261 specifying the maximum time to wait until. If no input arrives by
2262 that time, stop waiting and return nil.
2264 Value is t if we showed a menu and the user rejected it. */
2267 read_char (int commandflag
, ptrdiff_t nmaps
, Lisp_Object
*maps
,
2268 Lisp_Object prev_event
,
2269 bool *used_mouse_menu
, EMACS_TIME
*end_time
)
2273 sys_jmp_buf local_getcjmp
;
2274 sys_jmp_buf save_jump
;
2275 Lisp_Object tem
, save
;
2276 volatile Lisp_Object previous_echo_area_message
;
2277 volatile Lisp_Object also_record
;
2278 volatile bool reread
;
2279 struct gcpro gcpro1
, gcpro2
;
2280 bool volatile polling_stopped_here
= 0;
2281 struct kboard
*orig_kboard
= current_kboard
;
2285 #if 0 /* This was commented out as part of fixing echo for C-u left. */
2286 before_command_key_count
= this_command_key_count
;
2287 before_command_echo_length
= echo_length ();
2290 previous_echo_area_message
= Qnil
;
2292 GCPRO2 (c
, previous_echo_area_message
);
2297 if (CONSP (Vunread_post_input_method_events
))
2299 c
= XCAR (Vunread_post_input_method_events
);
2300 Vunread_post_input_method_events
2301 = XCDR (Vunread_post_input_method_events
);
2303 /* Undo what read_char_x_menu_prompt did when it unread
2304 additional keys returned by Fx_popup_menu. */
2306 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2314 if (CONSP (Vunread_command_events
))
2316 bool was_disabled
= 0;
2318 c
= XCAR (Vunread_command_events
);
2319 Vunread_command_events
= XCDR (Vunread_command_events
);
2323 /* Undo what sit-for did when it unread additional keys
2324 inside universal-argument. */
2327 && EQ (XCAR (c
), Qt
))
2333 /* Undo what read_char_x_menu_prompt did when it unread
2334 additional keys returned by Fx_popup_menu. */
2336 && EQ (XCDR (c
), Qdisabled
)
2337 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
))))
2343 /* If the queued event is something that used the mouse,
2344 set used_mouse_menu accordingly. */
2346 /* Also check was_disabled so last-nonmenu-event won't return
2347 a bad value when submenus are involved. (Bug#447) */
2348 && (EQ (c
, Qtool_bar
) || EQ (c
, Qmenu_bar
) || was_disabled
))
2349 *used_mouse_menu
= 1;
2351 goto reread_for_input_method
;
2354 if (CONSP (Vunread_input_method_events
))
2356 c
= XCAR (Vunread_input_method_events
);
2357 Vunread_input_method_events
= XCDR (Vunread_input_method_events
);
2359 /* Undo what read_char_x_menu_prompt did when it unread
2360 additional keys returned by Fx_popup_menu. */
2362 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2366 goto reread_for_input_method
;
2369 this_command_key_count_reset
= 0;
2371 if (!NILP (Vexecuting_kbd_macro
))
2373 /* We set this to Qmacro; since that's not a frame, nobody will
2374 try to switch frames on us, and the selected window will
2377 Since this event came from a macro, it would be misleading to
2378 leave internal_last_event_frame set to wherever the last
2379 real event came from. Normally, a switch-frame event selects
2380 internal_last_event_frame after each command is read, but
2381 events read from a macro should never cause a new frame to be
2383 Vlast_event_frame
= internal_last_event_frame
= Qmacro
;
2385 /* Exit the macro if we are at the end.
2386 Also, some things replace the macro with t
2387 to force an early exit. */
2388 if (EQ (Vexecuting_kbd_macro
, Qt
)
2389 || executing_kbd_macro_index
>= XFASTINT (Flength (Vexecuting_kbd_macro
)))
2395 c
= Faref (Vexecuting_kbd_macro
, make_number (executing_kbd_macro_index
));
2396 if (STRINGP (Vexecuting_kbd_macro
)
2397 && (XFASTINT (c
) & 0x80) && (XFASTINT (c
) <= 0xff))
2398 XSETFASTINT (c
, CHAR_META
| (XFASTINT (c
) & ~0x80));
2400 executing_kbd_macro_index
++;
2405 if (!NILP (unread_switch_frame
))
2407 c
= unread_switch_frame
;
2408 unread_switch_frame
= Qnil
;
2410 /* This event should make it into this_command_keys, and get echoed
2411 again, so we do not set `reread'. */
2415 /* if redisplay was requested */
2416 if (commandflag
>= 0)
2418 bool echo_current
= EQ (echo_message_buffer
, echo_area_buffer
[0]);
2420 /* If there is pending input, process any events which are not
2421 user-visible, such as X selection_request events. */
2423 || detect_input_pending_run_timers (0))
2424 swallow_events (0); /* may clear input_pending */
2426 /* Redisplay if no pending input. */
2427 while (!input_pending
)
2429 if (help_echo_showing_p
&& !EQ (selected_window
, minibuf_window
))
2430 redisplay_preserve_echo_area (5);
2435 /* Normal case: no input arrived during redisplay. */
2438 /* Input arrived and pre-empted redisplay.
2439 Process any events which are not user-visible. */
2441 /* If that cleared input_pending, try again to redisplay. */
2444 /* Prevent the redisplay we just did
2445 from messing up echoing of the input after the prompt. */
2446 if (commandflag
== 0 && echo_current
)
2447 echo_message_buffer
= echo_area_buffer
[0];
2451 /* Message turns off echoing unless more keystrokes turn it on again.
2453 The code in 20.x for the condition was
2455 1. echo_area_glyphs && *echo_area_glyphs
2456 2. && echo_area_glyphs != current_kboard->echobuf
2457 3. && ok_to_echo_at_next_pause != echo_area_glyphs
2459 (1) means there's a current message displayed
2461 (2) means it's not the message from echoing from the current
2464 (3) There's only one place in 20.x where ok_to_echo_at_next_pause
2465 is set to a non-null value. This is done in read_char and it is
2466 set to echo_area_glyphs after a call to echo_char. That means
2467 ok_to_echo_at_next_pause is either null or
2468 current_kboard->echobuf with the appropriate current_kboard at
2471 So, condition (3) means in clear text ok_to_echo_at_next_pause
2472 must be either null, or the current message isn't from echoing at
2473 all, or it's from echoing from a different kboard than the
2476 if (/* There currently is something in the echo area. */
2477 !NILP (echo_area_buffer
[0])
2478 && (/* And it's either not from echoing. */
2479 !EQ (echo_area_buffer
[0], echo_message_buffer
)
2480 /* Or it's an echo from a different kboard. */
2481 || echo_kboard
!= current_kboard
2482 /* Or we explicitly allow overwriting whatever there is. */
2483 || ok_to_echo_at_next_pause
== NULL
))
2488 /* Try reading a character via menu prompting in the minibuf.
2489 Try this before the sit-for, because the sit-for
2490 would do the wrong thing if we are supposed to do
2491 menu prompting. If EVENT_HAS_PARAMETERS then we are reading
2492 after a mouse event so don't try a minibuf menu. */
2494 if (nmaps
> 0 && INTERACTIVE
2495 && !NILP (prev_event
) && ! EVENT_HAS_PARAMETERS (prev_event
)
2496 /* Don't bring up a menu if we already have another event. */
2497 && NILP (Vunread_command_events
)
2498 && !detect_input_pending_run_timers (0))
2500 c
= read_char_minibuf_menu_prompt (commandflag
, nmaps
, maps
);
2502 if (INTEGERP (c
) && XINT (c
) == -2)
2503 return c
; /* wrong_kboard_jmpbuf */
2509 /* Make a longjmp point for quits to use, but don't alter getcjmp just yet.
2510 We will do that below, temporarily for short sections of code,
2511 when appropriate. local_getcjmp must be in effect
2512 around any call to sit_for or kbd_buffer_get_event;
2513 it *must not* be in effect when we call redisplay. */
2515 jmpcount
= SPECPDL_INDEX ();
2516 if (sys_setjmp (local_getcjmp
))
2518 /* Handle quits while reading the keyboard. */
2519 /* We must have saved the outer value of getcjmp here,
2520 so restore it now. */
2521 restore_getcjmp (save_jump
);
2522 unbind_to (jmpcount
, Qnil
);
2523 XSETINT (c
, quit_char
);
2524 internal_last_event_frame
= selected_frame
;
2525 Vlast_event_frame
= internal_last_event_frame
;
2526 /* If we report the quit char as an event,
2527 don't do so more than once. */
2528 if (!NILP (Vinhibit_quit
))
2532 KBOARD
*kb
= FRAME_KBOARD (XFRAME (selected_frame
));
2533 if (kb
!= current_kboard
)
2535 Lisp_Object last
= KVAR (kb
, kbd_queue
);
2536 /* We shouldn't get here if we were in single-kboard mode! */
2541 while (CONSP (XCDR (last
)))
2543 if (!NILP (XCDR (last
)))
2547 kset_kbd_queue (kb
, Fcons (c
, Qnil
));
2549 XSETCDR (last
, Fcons (c
, Qnil
));
2550 kb
->kbd_queue_has_data
= 1;
2551 current_kboard
= kb
;
2552 /* This is going to exit from read_char
2553 so we had better get rid of this frame's stuff. */
2555 return make_number (-2); /* wrong_kboard_jmpbuf */
2561 /* Start idle timers if no time limit is supplied. We don't do it
2562 if a time limit is supplied to avoid an infinite recursion in the
2563 situation where an idle timer calls `sit-for'. */
2566 timer_start_idle ();
2568 /* If in middle of key sequence and minibuffer not active,
2569 start echoing if enough time elapses. */
2571 if (minibuf_level
== 0
2573 && !current_kboard
->immediate_echo
2574 && this_command_key_count
> 0
2576 && (FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
2577 && NILP (Fzerop (Vecho_keystrokes
))
2578 && (/* No message. */
2579 NILP (echo_area_buffer
[0])
2580 /* Or empty message. */
2581 || (BUF_BEG (XBUFFER (echo_area_buffer
[0]))
2582 == BUF_Z (XBUFFER (echo_area_buffer
[0])))
2583 /* Or already echoing from same kboard. */
2584 || (echo_kboard
&& ok_to_echo_at_next_pause
== echo_kboard
)
2585 /* Or not echoing before and echoing allowed. */
2586 || (!echo_kboard
&& ok_to_echo_at_next_pause
)))
2588 /* After a mouse event, start echoing right away.
2589 This is because we are probably about to display a menu,
2590 and we don't want to delay before doing so. */
2591 if (EVENT_HAS_PARAMETERS (prev_event
))
2597 save_getcjmp (save_jump
);
2598 restore_getcjmp (local_getcjmp
);
2599 tem0
= sit_for (Vecho_keystrokes
, 1, 1);
2600 restore_getcjmp (save_jump
);
2602 && ! CONSP (Vunread_command_events
))
2607 /* Maybe auto save due to number of keystrokes. */
2609 if (commandflag
!= 0
2610 && auto_save_interval
> 0
2611 && num_nonmacro_input_events
- last_auto_save
> max (auto_save_interval
, 20)
2612 && !detect_input_pending_run_timers (0))
2614 Fdo_auto_save (Qnil
, Qnil
);
2615 /* Hooks can actually change some buffers in auto save. */
2619 /* Try reading using an X menu.
2620 This is never confused with reading using the minibuf
2621 because the recursive call of read_char in read_char_minibuf_menu_prompt
2622 does not pass on any keymaps. */
2624 if (nmaps
> 0 && INTERACTIVE
2625 && !NILP (prev_event
)
2626 && EVENT_HAS_PARAMETERS (prev_event
)
2627 && !EQ (XCAR (prev_event
), Qmenu_bar
)
2628 && !EQ (XCAR (prev_event
), Qtool_bar
)
2629 /* Don't bring up a menu if we already have another event. */
2630 && NILP (Vunread_command_events
))
2632 c
= read_char_x_menu_prompt (nmaps
, maps
, prev_event
, used_mouse_menu
);
2634 /* Now that we have read an event, Emacs is not idle. */
2641 /* Maybe autosave and/or garbage collect due to idleness. */
2643 if (INTERACTIVE
&& NILP (c
))
2646 ptrdiff_t buffer_size
;
2648 /* Slow down auto saves logarithmically in size of current buffer,
2649 and garbage collect while we're at it. */
2650 if (! MINI_WINDOW_P (XWINDOW (selected_window
)))
2651 last_non_minibuf_size
= Z
- BEG
;
2652 buffer_size
= (last_non_minibuf_size
>> 8) + 1;
2654 while (buffer_size
> 64)
2655 delay_level
++, buffer_size
-= buffer_size
>> 2;
2656 if (delay_level
< 4) delay_level
= 4;
2657 /* delay_level is 4 for files under around 50k, 7 at 100k,
2658 9 at 200k, 11 at 300k, and 12 at 500k. It is 15 at 1 meg. */
2660 /* Auto save if enough time goes by without input. */
2661 if (commandflag
!= 0
2662 && num_nonmacro_input_events
> last_auto_save
2663 && INTEGERP (Vauto_save_timeout
)
2664 && XINT (Vauto_save_timeout
) > 0)
2667 EMACS_INT timeout
= (delay_level
2668 * min (XFASTINT (Vauto_save_timeout
) / 4,
2669 MOST_POSITIVE_FIXNUM
/ delay_level
));
2670 save_getcjmp (save_jump
);
2671 restore_getcjmp (local_getcjmp
);
2672 tem0
= sit_for (make_number (timeout
), 1, 1);
2673 restore_getcjmp (save_jump
);
2676 && ! CONSP (Vunread_command_events
))
2678 Fdo_auto_save (Qnil
, Qnil
);
2683 /* If there is still no input available, ask for GC. */
2684 if (!detect_input_pending_run_timers (0))
2688 /* Notify the caller if an autosave hook, or a timer, sentinel or
2689 filter in the sit_for calls above have changed the current
2690 kboard. This could happen if they use the minibuffer or start a
2691 recursive edit, like the fancy splash screen in server.el's
2692 filter. If this longjmp wasn't here, read_key_sequence would
2693 interpret the next key sequence using the wrong translation
2694 tables and function keymaps. */
2695 if (NILP (c
) && current_kboard
!= orig_kboard
)
2698 return make_number (-2); /* wrong_kboard_jmpbuf */
2701 /* If this has become non-nil here, it has been set by a timer
2702 or sentinel or filter. */
2703 if (CONSP (Vunread_command_events
))
2705 c
= XCAR (Vunread_command_events
);
2706 Vunread_command_events
= XCDR (Vunread_command_events
);
2709 /* Read something from current KBOARD's side queue, if possible. */
2713 if (current_kboard
->kbd_queue_has_data
)
2715 if (!CONSP (KVAR (current_kboard
, kbd_queue
)))
2717 c
= XCAR (KVAR (current_kboard
, kbd_queue
));
2718 kset_kbd_queue (current_kboard
,
2719 XCDR (KVAR (current_kboard
, kbd_queue
)));
2720 if (NILP (KVAR (current_kboard
, kbd_queue
)))
2721 current_kboard
->kbd_queue_has_data
= 0;
2722 input_pending
= readable_events (0);
2723 if (EVENT_HAS_PARAMETERS (c
)
2724 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qswitch_frame
))
2725 internal_last_event_frame
= XCAR (XCDR (c
));
2726 Vlast_event_frame
= internal_last_event_frame
;
2730 /* If current_kboard's side queue is empty check the other kboards.
2731 If one of them has data that we have not yet seen here,
2732 switch to it and process the data waiting for it.
2734 Note: if the events queued up for another kboard
2735 have already been seen here, and therefore are not a complete command,
2736 the kbd_queue_has_data field is 0, so we skip that kboard here.
2737 That's to avoid an infinite loop switching between kboards here. */
2738 if (NILP (c
) && !single_kboard
)
2741 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
2742 if (kb
->kbd_queue_has_data
)
2744 current_kboard
= kb
;
2745 /* This is going to exit from read_char
2746 so we had better get rid of this frame's stuff. */
2748 return make_number (-2); /* wrong_kboard_jmpbuf */
2756 /* Finally, we read from the main queue,
2757 and if that gives us something we can't use yet, we put it on the
2758 appropriate side queue and try again. */
2762 KBOARD
*kb
IF_LINT (= NULL
);
2764 if (end_time
&& EMACS_TIME_LE (*end_time
, current_emacs_time ()))
2767 /* Actually read a character, waiting if necessary. */
2768 save_getcjmp (save_jump
);
2769 restore_getcjmp (local_getcjmp
);
2771 timer_start_idle ();
2772 c
= kbd_buffer_get_event (&kb
, used_mouse_menu
, end_time
);
2773 restore_getcjmp (save_jump
);
2775 if (! NILP (c
) && (kb
!= current_kboard
))
2777 Lisp_Object last
= KVAR (kb
, kbd_queue
);
2780 while (CONSP (XCDR (last
)))
2782 if (!NILP (XCDR (last
)))
2786 kset_kbd_queue (kb
, Fcons (c
, Qnil
));
2788 XSETCDR (last
, Fcons (c
, Qnil
));
2789 kb
->kbd_queue_has_data
= 1;
2793 current_kboard
= kb
;
2794 /* This is going to exit from read_char
2795 so we had better get rid of this frame's stuff. */
2797 return make_number (-2);
2801 /* Terminate Emacs in batch mode if at eof. */
2802 if (noninteractive
&& INTEGERP (c
) && XINT (c
) < 0)
2803 Fkill_emacs (make_number (1));
2807 /* Add in any extra modifiers, where appropriate. */
2808 if ((extra_keyboard_modifiers
& CHAR_CTL
)
2809 || ((extra_keyboard_modifiers
& 0177) < ' '
2810 && (extra_keyboard_modifiers
& 0177) != 0))
2811 XSETINT (c
, make_ctrl_char (XINT (c
)));
2813 /* Transfer any other modifier bits directly from
2814 extra_keyboard_modifiers to c. Ignore the actual character code
2815 in the low 16 bits of extra_keyboard_modifiers. */
2816 XSETINT (c
, XINT (c
) | (extra_keyboard_modifiers
& ~0xff7f & ~CHAR_CTL
));
2827 if (commandflag
>= 0
2828 && !input_pending
&& !detect_input_pending_run_timers (0))
2834 /* Buffer switch events are only for internal wakeups
2835 so don't show them to the user.
2836 Also, don't record a key if we already did. */
2840 /* Process special events within read_char
2841 and loop around to read another event. */
2844 tem
= access_keymap (get_keymap (Vspecial_event_map
, 0, 1), c
, 0, 0, 1);
2849 struct buffer
*prev_buffer
= current_buffer
;
2850 last_input_event
= c
;
2851 Fcommand_execute (tem
, Qnil
, Fvector (1, &last_input_event
), Qt
);
2853 if (CONSP (c
) && EQ (XCAR (c
), Qselect_window
) && !end_time
)
2854 /* We stopped being idle for this event; undo that. This
2855 prevents automatic window selection (under
2856 mouse_autoselect_window from acting as a real input event, for
2857 example banishing the mouse under mouse-avoidance-mode. */
2858 timer_resume_idle ();
2860 if (current_buffer
!= prev_buffer
)
2862 /* The command may have changed the keymaps. Pretend there
2863 is input in another keyboard and return. This will
2864 recalculate keymaps. */
2865 c
= make_number (-2);
2872 /* Handle things that only apply to characters. */
2875 /* If kbd_buffer_get_event gave us an EOF, return that. */
2879 if ((STRINGP (KVAR (current_kboard
, Vkeyboard_translate_table
))
2880 && UNSIGNED_CMP (XFASTINT (c
), <,
2881 SCHARS (KVAR (current_kboard
,
2882 Vkeyboard_translate_table
))))
2883 || (VECTORP (KVAR (current_kboard
, Vkeyboard_translate_table
))
2884 && UNSIGNED_CMP (XFASTINT (c
), <,
2885 ASIZE (KVAR (current_kboard
,
2886 Vkeyboard_translate_table
))))
2887 || (CHAR_TABLE_P (KVAR (current_kboard
, Vkeyboard_translate_table
))
2891 d
= Faref (KVAR (current_kboard
, Vkeyboard_translate_table
), c
);
2892 /* nil in keyboard-translate-table means no translation. */
2898 /* If this event is a mouse click in the menu bar,
2899 return just menu-bar for now. Modify the mouse click event
2900 so we won't do this twice, then queue it up. */
2901 if (EVENT_HAS_PARAMETERS (c
)
2903 && CONSP (EVENT_START (c
))
2904 && CONSP (XCDR (EVENT_START (c
))))
2908 posn
= POSN_POSN (EVENT_START (c
));
2909 /* Handle menu-bar events:
2910 insert the dummy prefix event `menu-bar'. */
2911 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
2913 /* Change menu-bar to (menu-bar) as the event "position". */
2914 POSN_SET_POSN (EVENT_START (c
), Fcons (posn
, Qnil
));
2917 Vunread_command_events
= Fcons (c
, Vunread_command_events
);
2922 /* Store these characters into recent_keys, the dribble file if any,
2923 and the keyboard macro being defined, if any. */
2925 if (! NILP (also_record
))
2926 record_char (also_record
);
2928 /* Wipe the echo area.
2929 But first, if we are about to use an input method,
2930 save the echo area contents for it to refer to. */
2932 && ! NILP (Vinput_method_function
)
2933 && ' ' <= XINT (c
) && XINT (c
) < 256 && XINT (c
) != 127)
2935 previous_echo_area_message
= Fcurrent_message ();
2936 Vinput_method_previous_message
= previous_echo_area_message
;
2939 /* Now wipe the echo area, except for help events which do their
2940 own stuff with the echo area. */
2942 || (!(EQ (Qhelp_echo
, XCAR (c
)))
2943 && !(EQ (Qswitch_frame
, XCAR (c
)))
2944 /* Don't wipe echo area for select window events: These might
2945 get delayed via `mouse-autoselect-window' (Bug#11304). */
2946 && !(EQ (Qselect_window
, XCAR (c
)))))
2948 if (!NILP (echo_area_buffer
[0]))
2950 safe_run_hooks (Qecho_area_clear_hook
);
2951 clear_message (1, 0);
2955 reread_for_input_method
:
2957 /* Pass this to the input method, if appropriate. */
2959 && ! NILP (Vinput_method_function
)
2960 /* Don't run the input method within a key sequence,
2961 after the first event of the key sequence. */
2962 && NILP (prev_event
)
2963 && ' ' <= XINT (c
) && XINT (c
) < 256 && XINT (c
) != 127)
2966 ptrdiff_t key_count
;
2967 bool key_count_reset
;
2968 struct gcpro gcpro1
;
2969 ptrdiff_t count
= SPECPDL_INDEX ();
2971 /* Save the echo status. */
2972 bool saved_immediate_echo
= current_kboard
->immediate_echo
;
2973 struct kboard
*saved_ok_to_echo
= ok_to_echo_at_next_pause
;
2974 Lisp_Object saved_echo_string
= KVAR (current_kboard
, echo_string
);
2975 ptrdiff_t saved_echo_after_prompt
= current_kboard
->echo_after_prompt
;
2978 if (before_command_restore_flag
)
2980 this_command_key_count
= before_command_key_count_1
;
2981 if (this_command_key_count
< this_single_command_key_start
)
2982 this_single_command_key_start
= this_command_key_count
;
2983 echo_truncate (before_command_echo_length_1
);
2984 before_command_restore_flag
= 0;
2988 /* Save the this_command_keys status. */
2989 key_count
= this_command_key_count
;
2990 key_count_reset
= this_command_key_count_reset
;
2993 keys
= Fcopy_sequence (this_command_keys
);
2998 /* Clear out this_command_keys. */
2999 this_command_key_count
= 0;
3000 this_command_key_count_reset
= 0;
3002 /* Now wipe the echo area. */
3003 if (!NILP (echo_area_buffer
[0]))
3004 safe_run_hooks (Qecho_area_clear_hook
);
3005 clear_message (1, 0);
3008 /* If we are not reading a key sequence,
3009 never use the echo area. */
3012 specbind (Qinput_method_use_echo_area
, Qt
);
3015 /* Call the input method. */
3016 tem
= call1 (Vinput_method_function
, c
);
3018 tem
= unbind_to (count
, tem
);
3020 /* Restore the saved echoing state
3021 and this_command_keys state. */
3022 this_command_key_count
= key_count
;
3023 this_command_key_count_reset
= key_count_reset
;
3025 this_command_keys
= keys
;
3028 ok_to_echo_at_next_pause
= saved_ok_to_echo
;
3029 kset_echo_string (current_kboard
, saved_echo_string
);
3030 current_kboard
->echo_after_prompt
= saved_echo_after_prompt
;
3031 if (saved_immediate_echo
)
3036 /* The input method can return no events. */
3039 /* Bring back the previous message, if any. */
3040 if (! NILP (previous_echo_area_message
))
3041 message_with_string ("%s", previous_echo_area_message
, 0);
3044 /* It returned one event or more. */
3046 Vunread_post_input_method_events
3047 = nconc2 (XCDR (tem
), Vunread_post_input_method_events
);
3052 /* Display help if not echoing. */
3053 if (CONSP (c
) && EQ (XCAR (c
), Qhelp_echo
))
3055 /* (help-echo FRAME HELP WINDOW OBJECT POS). */
3056 Lisp_Object help
, object
, position
, window
, htem
;
3058 htem
= Fcdr (XCDR (c
));
3061 window
= Fcar (htem
);
3063 object
= Fcar (htem
);
3065 position
= Fcar (htem
);
3067 show_help_echo (help
, window
, object
, position
);
3069 /* We stopped being idle for this event; undo that. */
3071 timer_resume_idle ();
3075 if ((! reread
|| this_command_key_count
== 0
3076 || this_command_key_count_reset
)
3080 /* Don't echo mouse motion events. */
3081 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
3082 && NILP (Fzerop (Vecho_keystrokes
))
3083 && ! (EVENT_HAS_PARAMETERS (c
)
3084 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
3087 if (! NILP (also_record
))
3088 echo_char (also_record
);
3089 /* Once we reread a character, echoing can happen
3090 the next time we pause to read a new one. */
3091 ok_to_echo_at_next_pause
= current_kboard
;
3094 /* Record this character as part of the current key. */
3095 add_command_key (c
);
3096 if (! NILP (also_record
))
3097 add_command_key (also_record
);
3100 last_input_event
= c
;
3103 /* Process the help character specially if enabled */
3104 if (!NILP (Vhelp_form
) && help_char_p (c
))
3106 ptrdiff_t count
= SPECPDL_INDEX ();
3108 help_form_saved_window_configs
3109 = Fcons (Fcurrent_window_configuration (Qnil
),
3110 help_form_saved_window_configs
);
3111 record_unwind_protect (read_char_help_form_unwind
, Qnil
);
3112 call0 (Qhelp_form_show
);
3117 c
= read_char (0, 0, 0, Qnil
, 0, NULL
);
3118 if (EVENT_HAS_PARAMETERS (c
)
3119 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_click
))
3120 XSETCAR (help_form_saved_window_configs
, Qnil
);
3122 while (BUFFERP (c
));
3123 /* Remove the help from the frame */
3124 unbind_to (count
, Qnil
);
3127 if (EQ (c
, make_number (040)))
3131 c
= read_char (0, 0, 0, Qnil
, 0, NULL
);
3132 while (BUFFERP (c
));
3141 /* Record a key that came from a mouse menu.
3142 Record it for echoing, for this-command-keys, and so on. */
3145 record_menu_key (Lisp_Object c
)
3147 /* Wipe the echo area. */
3148 clear_message (1, 0);
3153 before_command_key_count
= this_command_key_count
;
3154 before_command_echo_length
= echo_length ();
3157 /* Don't echo mouse motion events. */
3158 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
3159 && NILP (Fzerop (Vecho_keystrokes
)))
3163 /* Once we reread a character, echoing can happen
3164 the next time we pause to read a new one. */
3165 ok_to_echo_at_next_pause
= 0;
3168 /* Record this character as part of the current key. */
3169 add_command_key (c
);
3171 /* Re-reading in the middle of a command */
3172 last_input_event
= c
;
3176 /* Return true if should recognize C as "the help character". */
3179 help_char_p (Lisp_Object c
)
3183 if (EQ (c
, Vhelp_char
))
3185 for (tail
= Vhelp_event_list
; CONSP (tail
); tail
= XCDR (tail
))
3186 if (EQ (c
, XCAR (tail
)))
3191 /* Record the input event C in various ways. */
3194 record_char (Lisp_Object c
)
3198 if (CONSP (c
) && (EQ (XCAR (c
), Qhelp_echo
) || EQ (XCAR (c
), Qmouse_movement
)))
3200 /* To avoid filling recent_keys with help-echo and mouse-movement
3201 events, we filter out repeated help-echo events, only store the
3202 first and last in a series of mouse-movement events, and don't
3203 store repeated help-echo events which are only separated by
3204 mouse-movement events. */
3206 Lisp_Object ev1
, ev2
, ev3
;
3209 if ((ix1
= recent_keys_index
- 1) < 0)
3210 ix1
= NUM_RECENT_KEYS
- 1;
3211 ev1
= AREF (recent_keys
, ix1
);
3213 if ((ix2
= ix1
- 1) < 0)
3214 ix2
= NUM_RECENT_KEYS
- 1;
3215 ev2
= AREF (recent_keys
, ix2
);
3217 if ((ix3
= ix2
- 1) < 0)
3218 ix3
= NUM_RECENT_KEYS
- 1;
3219 ev3
= AREF (recent_keys
, ix3
);
3221 if (EQ (XCAR (c
), Qhelp_echo
))
3223 /* Don't record `help-echo' in recent_keys unless it shows some help
3224 message, and a different help than the previously recorded
3226 Lisp_Object help
, last_help
;
3228 help
= Fcar_safe (Fcdr_safe (XCDR (c
)));
3229 if (!STRINGP (help
))
3231 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qhelp_echo
)
3232 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev1
))), EQ (last_help
, help
)))
3234 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3235 && CONSP (ev2
) && EQ (XCAR (ev2
), Qhelp_echo
)
3236 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev2
))), EQ (last_help
, help
)))
3238 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3239 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3240 && CONSP (ev3
) && EQ (XCAR (ev3
), Qhelp_echo
)
3241 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev3
))), EQ (last_help
, help
)))
3244 else if (EQ (XCAR (c
), Qmouse_movement
))
3246 /* Only record one pair of `mouse-movement' on a window in recent_keys.
3247 So additional mouse movement events replace the last element. */
3248 Lisp_Object last_window
, window
;
3250 window
= Fcar_safe (Fcar_safe (XCDR (c
)));
3251 if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3252 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev1
))), EQ (last_window
, window
))
3253 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3254 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev2
))), EQ (last_window
, window
)))
3256 ASET (recent_keys
, ix1
, c
);
3262 store_kbd_macro_char (c
);
3266 total_keys
+= total_keys
< NUM_RECENT_KEYS
;
3267 ASET (recent_keys
, recent_keys_index
, c
);
3268 if (++recent_keys_index
>= NUM_RECENT_KEYS
)
3269 recent_keys_index
= 0;
3271 else if (recorded
< 0)
3273 /* We need to remove one or two events from recent_keys.
3274 To do this, we simply put nil at those events and move the
3275 recent_keys_index backwards over those events. Usually,
3276 users will never see those nil events, as they will be
3277 overwritten by the command keys entered to see recent_keys
3280 while (recorded
++ < 0 && total_keys
> 0)
3282 if (total_keys
< NUM_RECENT_KEYS
)
3284 if (--recent_keys_index
< 0)
3285 recent_keys_index
= NUM_RECENT_KEYS
- 1;
3286 ASET (recent_keys
, recent_keys_index
, Qnil
);
3290 num_nonmacro_input_events
++;
3292 /* Write c to the dribble file. If c is a lispy event, write
3293 the event's symbol to the dribble file, in <brackets>. Bleaugh.
3294 If you, dear reader, have a better idea, you've got the source. :-) */
3300 if (XUINT (c
) < 0x100)
3301 putc (XUINT (c
), dribble
);
3303 fprintf (dribble
, " 0x%"pI
"x", XUINT (c
));
3307 Lisp_Object dribblee
;
3309 /* If it's a structured event, take the event header. */
3310 dribblee
= EVENT_HEAD (c
);
3312 if (SYMBOLP (dribblee
))
3314 putc ('<', dribble
);
3315 fwrite (SDATA (SYMBOL_NAME (dribblee
)), sizeof (char),
3316 SBYTES (SYMBOL_NAME (dribblee
)),
3318 putc ('>', dribble
);
3327 /* Copy out or in the info on where C-g should throw to.
3328 This is used when running Lisp code from within get_char,
3329 in case get_char is called recursively.
3330 See read_process_output. */
3333 save_getcjmp (sys_jmp_buf temp
)
3335 memcpy (temp
, getcjmp
, sizeof getcjmp
);
3339 restore_getcjmp (sys_jmp_buf temp
)
3341 memcpy (getcjmp
, temp
, sizeof getcjmp
);
3344 /* Low level keyboard/mouse input.
3345 kbd_buffer_store_event places events in kbd_buffer, and
3346 kbd_buffer_get_event retrieves them. */
3348 /* Return true if there are any events in the queue that read-char
3349 would return. If this returns false, a read-char would block. */
3351 readable_events (int flags
)
3353 if (flags
& READABLE_EVENTS_DO_TIMERS_NOW
)
3356 /* If the buffer contains only FOCUS_IN_EVENT events, and
3357 READABLE_EVENTS_FILTER_EVENTS is set, report it as empty. */
3358 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3360 if (flags
& (READABLE_EVENTS_FILTER_EVENTS
3361 #ifdef USE_TOOLKIT_SCROLL_BARS
3362 | READABLE_EVENTS_IGNORE_SQUEEZABLES
3366 struct input_event
*event
;
3368 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
3375 #ifdef USE_TOOLKIT_SCROLL_BARS
3376 (flags
& READABLE_EVENTS_FILTER_EVENTS
) &&
3378 event
->kind
== FOCUS_IN_EVENT
)
3379 #ifdef USE_TOOLKIT_SCROLL_BARS
3380 && !((flags
& READABLE_EVENTS_IGNORE_SQUEEZABLES
)
3381 && event
->kind
== SCROLL_BAR_CLICK_EVENT
3382 && event
->part
== scroll_bar_handle
3383 && event
->modifiers
== 0)
3388 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3391 while (event
!= kbd_store_ptr
);
3397 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
3398 if (!(flags
& READABLE_EVENTS_IGNORE_SQUEEZABLES
)
3399 && !NILP (do_mouse_tracking
) && some_mouse_moved ())
3404 if (current_kboard
->kbd_queue_has_data
)
3410 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
3411 if (kb
->kbd_queue_has_data
)
3417 /* Set this for debugging, to have a way to get out */
3418 int stop_character EXTERNALLY_VISIBLE
;
3421 event_to_kboard (struct input_event
*event
)
3424 frame
= event
->frame_or_window
;
3426 frame
= XCAR (frame
);
3427 else if (WINDOWP (frame
))
3428 frame
= WINDOW_FRAME (XWINDOW (frame
));
3430 /* There are still some events that don't set this field.
3431 For now, just ignore the problem.
3432 Also ignore dead frames here. */
3433 if (!FRAMEP (frame
) || !FRAME_LIVE_P (XFRAME (frame
)))
3436 return FRAME_KBOARD (XFRAME (frame
));
3440 /* Return the number of slots occupied in kbd_buffer. */
3443 kbd_buffer_nr_stored (void)
3445 return kbd_fetch_ptr
== kbd_store_ptr
3447 : (kbd_fetch_ptr
< kbd_store_ptr
3448 ? kbd_store_ptr
- kbd_fetch_ptr
3449 : ((kbd_buffer
+ KBD_BUFFER_SIZE
) - kbd_fetch_ptr
3450 + (kbd_store_ptr
- kbd_buffer
)));
3452 #endif /* Store an event obtained at interrupt level into kbd_buffer, fifo */
3455 kbd_buffer_store_event (register struct input_event
*event
)
3457 kbd_buffer_store_event_hold (event
, 0);
3460 /* Store EVENT obtained at interrupt level into kbd_buffer, fifo.
3462 If HOLD_QUIT is 0, just stuff EVENT into the fifo.
3463 Else, if HOLD_QUIT.kind != NO_EVENT, discard EVENT.
3464 Else, if EVENT is a quit event, store the quit event
3465 in HOLD_QUIT, and return (thus ignoring further events).
3467 This is used to postpone the processing of the quit event until all
3468 subsequent input events have been parsed (and discarded). */
3471 kbd_buffer_store_event_hold (register struct input_event
*event
,
3472 struct input_event
*hold_quit
)
3474 if (event
->kind
== NO_EVENT
)
3477 if (hold_quit
&& hold_quit
->kind
!= NO_EVENT
)
3480 if (event
->kind
== ASCII_KEYSTROKE_EVENT
)
3482 register int c
= event
->code
& 0377;
3484 if (event
->modifiers
& ctrl_modifier
)
3485 c
= make_ctrl_char (c
);
3487 c
|= (event
->modifiers
3488 & (meta_modifier
| alt_modifier
3489 | hyper_modifier
| super_modifier
));
3493 KBOARD
*kb
= FRAME_KBOARD (XFRAME (event
->frame_or_window
));
3494 struct input_event
*sp
;
3496 if (single_kboard
&& kb
!= current_kboard
)
3499 (kb
, Fcons (make_lispy_switch_frame (event
->frame_or_window
),
3500 Fcons (make_number (c
), Qnil
)));
3501 kb
->kbd_queue_has_data
= 1;
3502 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3504 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3507 if (event_to_kboard (sp
) == kb
)
3509 sp
->kind
= NO_EVENT
;
3510 sp
->frame_or_window
= Qnil
;
3519 *hold_quit
= *event
;
3523 /* If this results in a quit_char being returned to Emacs as
3524 input, set Vlast_event_frame properly. If this doesn't
3525 get returned to Emacs as an event, the next event read
3526 will set Vlast_event_frame again, so this is safe to do. */
3530 focus
= FRAME_FOCUS_FRAME (XFRAME (event
->frame_or_window
));
3532 focus
= event
->frame_or_window
;
3533 internal_last_event_frame
= focus
;
3534 Vlast_event_frame
= focus
;
3537 last_event_timestamp
= event
->timestamp
;
3539 handle_interrupt (0);
3543 if (c
&& c
== stop_character
)
3549 /* Don't insert two BUFFER_SWITCH_EVENT's in a row.
3550 Just ignore the second one. */
3551 else if (event
->kind
== BUFFER_SWITCH_EVENT
3552 && kbd_fetch_ptr
!= kbd_store_ptr
3553 && ((kbd_store_ptr
== kbd_buffer
3554 ? kbd_buffer
+ KBD_BUFFER_SIZE
- 1
3555 : kbd_store_ptr
- 1)->kind
) == BUFFER_SWITCH_EVENT
)
3558 if (kbd_store_ptr
- kbd_buffer
== KBD_BUFFER_SIZE
)
3559 kbd_store_ptr
= kbd_buffer
;
3561 /* Don't let the very last slot in the buffer become full,
3562 since that would make the two pointers equal,
3563 and that is indistinguishable from an empty buffer.
3564 Discard the event if it would fill the last slot. */
3565 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
3567 *kbd_store_ptr
= *event
;
3570 if (kbd_buffer_nr_stored () > KBD_BUFFER_SIZE
/2 && ! kbd_on_hold_p ())
3572 /* Don't read keyboard input until we have processed kbd_buffer.
3573 This happens when pasting text longer than KBD_BUFFER_SIZE/2. */
3574 hold_keyboard_input ();
3575 if (!noninteractive
)
3579 #endif /* subprocesses */
3582 /* If we're inside while-no-input, and this event qualifies
3583 as input, set quit-flag to cause an interrupt. */
3584 if (!NILP (Vthrow_on_input
)
3585 && event
->kind
!= FOCUS_IN_EVENT
3586 && event
->kind
!= HELP_EVENT
3587 && event
->kind
!= DEICONIFY_EVENT
)
3589 Vquit_flag
= Vthrow_on_input
;
3590 /* If we're inside a function that wants immediate quits,
3592 if (immediate_quit
&& NILP (Vinhibit_quit
))
3601 /* Put an input event back in the head of the event queue. */
3604 kbd_buffer_unget_event (register struct input_event
*event
)
3606 if (kbd_fetch_ptr
== kbd_buffer
)
3607 kbd_fetch_ptr
= kbd_buffer
+ KBD_BUFFER_SIZE
;
3609 /* Don't let the very last slot in the buffer become full, */
3610 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
3613 *kbd_fetch_ptr
= *event
;
3618 /* Generate a HELP_EVENT input_event and store it in the keyboard
3621 HELP is the help form.
3623 FRAME and WINDOW are the frame and window where the help is
3624 generated. OBJECT is the Lisp object where the help was found (a
3625 buffer, a string, an overlay, or nil if neither from a string nor
3626 from a buffer). POS is the position within OBJECT where the help
3630 gen_help_event (Lisp_Object help
, Lisp_Object frame
, Lisp_Object window
,
3631 Lisp_Object object
, ptrdiff_t pos
)
3633 struct input_event event
;
3637 event
.kind
= HELP_EVENT
;
3638 event
.frame_or_window
= frame
;
3640 event
.x
= WINDOWP (window
) ? window
: frame
;
3643 kbd_buffer_store_event (&event
);
3647 /* Store HELP_EVENTs for HELP on FRAME in the input queue. */
3650 kbd_buffer_store_help_event (Lisp_Object frame
, Lisp_Object help
)
3652 struct input_event event
;
3654 event
.kind
= HELP_EVENT
;
3655 event
.frame_or_window
= frame
;
3660 kbd_buffer_store_event (&event
);
3664 /* Discard any mouse events in the event buffer by setting them to
3667 discard_mouse_events (void)
3669 struct input_event
*sp
;
3670 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3672 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3675 if (sp
->kind
== MOUSE_CLICK_EVENT
3676 || sp
->kind
== WHEEL_EVENT
3677 || sp
->kind
== HORIZ_WHEEL_EVENT
3679 || sp
->kind
== GPM_CLICK_EVENT
3681 || sp
->kind
== SCROLL_BAR_CLICK_EVENT
)
3683 sp
->kind
= NO_EVENT
;
3689 /* Return true if there are any real events waiting in the event
3690 buffer, not counting `NO_EVENT's.
3692 Discard NO_EVENT events at the front of the input queue, possibly
3693 leaving the input queue empty if there are no real input events. */
3696 kbd_buffer_events_waiting (void)
3698 struct input_event
*sp
;
3700 for (sp
= kbd_fetch_ptr
;
3701 sp
!= kbd_store_ptr
&& sp
->kind
== NO_EVENT
;
3704 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3709 return sp
!= kbd_store_ptr
&& sp
->kind
!= NO_EVENT
;
3713 /* Clear input event EVENT. */
3716 clear_event (struct input_event
*event
)
3718 event
->kind
= NO_EVENT
;
3722 /* Read one event from the event buffer, waiting if necessary.
3723 The value is a Lisp object representing the event.
3724 The value is nil for an event that should be ignored,
3725 or that was handled here.
3726 We always read and discard one event. */
3729 kbd_buffer_get_event (KBOARD
**kbp
,
3730 bool *used_mouse_menu
,
3731 EMACS_TIME
*end_time
)
3736 if (kbd_on_hold_p () && kbd_buffer_nr_stored () < KBD_BUFFER_SIZE
/4)
3738 /* Start reading input again because we have processed enough to
3739 be able to accept new events again. */
3740 unhold_keyboard_input ();
3743 #endif /* subprocesses */
3745 #ifndef HAVE_DBUS /* We want to read D-Bus events in batch mode. */
3747 /* In case we are running as a daemon, only do this before
3748 detaching from the terminal. */
3749 || (IS_DAEMON
&& daemon_pipe
[1] >= 0))
3753 *kbp
= current_kboard
;
3756 #endif /* ! HAVE_DBUS */
3758 /* Wait until there is input available. */
3761 /* Break loop if there's an unread command event. Needed in
3762 moused window autoselection which uses a timer to insert such
3764 if (CONSP (Vunread_command_events
))
3767 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3769 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
3770 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3774 /* If the quit flag is set, then read_char will return
3775 quit_char, so that counts as "available input." */
3776 if (!NILP (Vquit_flag
))
3777 quit_throw_to_read_char (0);
3779 /* One way or another, wait until input is available; then, if
3780 interrupt handlers have not read it, read it now. */
3785 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3787 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
3788 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3793 EMACS_TIME now
= current_emacs_time ();
3794 if (EMACS_TIME_LE (*end_time
, now
))
3795 return Qnil
; /* Finished waiting. */
3798 EMACS_TIME duration
= sub_emacs_time (*end_time
, now
);
3799 wait_reading_process_output (min (EMACS_SECS (duration
),
3801 EMACS_NSECS (duration
),
3802 -1, 1, Qnil
, NULL
, 0);
3806 wait_reading_process_output (0, 0, -1, 1, Qnil
, NULL
, 0);
3808 if (!interrupt_input
&& kbd_fetch_ptr
== kbd_store_ptr
)
3812 if (CONSP (Vunread_command_events
))
3815 first
= XCAR (Vunread_command_events
);
3816 Vunread_command_events
= XCDR (Vunread_command_events
);
3817 *kbp
= current_kboard
;
3821 /* At this point, we know that there is a readable event available
3822 somewhere. If the event queue is empty, then there must be a
3823 mouse movement enabled and available. */
3824 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3826 struct input_event
*event
;
3828 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
3832 last_event_timestamp
= event
->timestamp
;
3834 *kbp
= event_to_kboard (event
);
3836 *kbp
= current_kboard
; /* Better than returning null ptr? */
3840 /* These two kinds of events get special handling
3841 and don't actually appear to the command loop.
3842 We return nil for them. */
3843 if (event
->kind
== SELECTION_REQUEST_EVENT
3844 || event
->kind
== SELECTION_CLEAR_EVENT
)
3847 struct input_event copy
;
3849 /* Remove it from the buffer before processing it,
3850 since otherwise swallow_events will see it
3851 and process it again. */
3853 kbd_fetch_ptr
= event
+ 1;
3854 input_pending
= readable_events (0);
3855 x_handle_selection_event (©
);
3857 /* We're getting selection request events, but we don't have
3863 #if defined (HAVE_NS)
3864 else if (event
->kind
== NS_TEXT_EVENT
)
3866 if (event
->code
== KEY_NS_PUT_WORKING_TEXT
)
3867 obj
= Fcons (intern ("ns-put-working-text"), Qnil
);
3869 obj
= Fcons (intern ("ns-unput-working-text"), Qnil
);
3870 kbd_fetch_ptr
= event
+ 1;
3871 if (used_mouse_menu
)
3872 *used_mouse_menu
= 1;
3876 #if defined (HAVE_X11) || defined (HAVE_NTGUI) \
3877 || defined (HAVE_NS)
3878 else if (event
->kind
== DELETE_WINDOW_EVENT
)
3880 /* Make an event (delete-frame (FRAME)). */
3881 obj
= Fcons (event
->frame_or_window
, Qnil
);
3882 obj
= Fcons (Qdelete_frame
, Fcons (obj
, Qnil
));
3883 kbd_fetch_ptr
= event
+ 1;
3886 #if defined (HAVE_X11) || defined (HAVE_NTGUI) \
3887 || defined (HAVE_NS)
3888 else if (event
->kind
== ICONIFY_EVENT
)
3890 /* Make an event (iconify-frame (FRAME)). */
3891 obj
= Fcons (event
->frame_or_window
, Qnil
);
3892 obj
= Fcons (Qiconify_frame
, Fcons (obj
, Qnil
));
3893 kbd_fetch_ptr
= event
+ 1;
3895 else if (event
->kind
== DEICONIFY_EVENT
)
3897 /* Make an event (make-frame-visible (FRAME)). */
3898 obj
= Fcons (event
->frame_or_window
, Qnil
);
3899 obj
= Fcons (Qmake_frame_visible
, Fcons (obj
, Qnil
));
3900 kbd_fetch_ptr
= event
+ 1;
3903 else if (event
->kind
== BUFFER_SWITCH_EVENT
)
3905 /* The value doesn't matter here; only the type is tested. */
3906 XSETBUFFER (obj
, current_buffer
);
3907 kbd_fetch_ptr
= event
+ 1;
3909 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
3910 || defined (HAVE_NS) || defined (USE_GTK)
3911 else if (event
->kind
== MENU_BAR_ACTIVATE_EVENT
)
3913 kbd_fetch_ptr
= event
+ 1;
3914 input_pending
= readable_events (0);
3915 if (FRAME_LIVE_P (XFRAME (event
->frame_or_window
)))
3916 x_activate_menubar (XFRAME (event
->frame_or_window
));
3920 else if (event
->kind
== LANGUAGE_CHANGE_EVENT
)
3922 /* Make an event (language-change (FRAME CODEPAGE LANGUAGE-ID)). */
3923 obj
= Fcons (Qlanguage_change
,
3924 list3 (event
->frame_or_window
,
3925 make_number (event
->code
),
3926 make_number (event
->modifiers
)));
3927 kbd_fetch_ptr
= event
+ 1;
3929 else if (event
->kind
== FILE_NOTIFY_EVENT
)
3931 /* Make an event (file-notify (DESCRIPTOR ACTION FILE) CALLBACK). */
3932 obj
= Fcons (Qfile_notify
,
3933 list2 (list3 (make_number (event
->code
),
3936 event
->frame_or_window
));
3937 kbd_fetch_ptr
= event
+ 1;
3940 else if (event
->kind
== SAVE_SESSION_EVENT
)
3942 obj
= Fcons (Qsave_session
, Fcons (event
->arg
, Qnil
));
3943 kbd_fetch_ptr
= event
+ 1;
3945 /* Just discard these, by returning nil.
3946 With MULTI_KBOARD, these events are used as placeholders
3947 when we need to randomly delete events from the queue.
3948 (They shouldn't otherwise be found in the buffer,
3949 but on some machines it appears they do show up
3950 even without MULTI_KBOARD.) */
3951 /* On Windows NT/9X, NO_EVENT is used to delete extraneous
3952 mouse events during a popup-menu call. */
3953 else if (event
->kind
== NO_EVENT
)
3954 kbd_fetch_ptr
= event
+ 1;
3955 else if (event
->kind
== HELP_EVENT
)
3957 Lisp_Object object
, position
, help
, frame
, window
;
3959 frame
= event
->frame_or_window
;
3960 object
= event
->arg
;
3961 position
= make_number (event
->code
);
3964 clear_event (event
);
3966 kbd_fetch_ptr
= event
+ 1;
3967 if (!WINDOWP (window
))
3969 obj
= Fcons (Qhelp_echo
,
3970 list5 (frame
, help
, window
, object
, position
));
3972 else if (event
->kind
== FOCUS_IN_EVENT
)
3974 /* Notification of a FocusIn event. The frame receiving the
3975 focus is in event->frame_or_window. Generate a
3976 switch-frame event if necessary. */
3977 Lisp_Object frame
, focus
;
3979 frame
= event
->frame_or_window
;
3980 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
3984 if (!EQ (frame
, internal_last_event_frame
)
3985 && !EQ (frame
, selected_frame
))
3986 obj
= make_lispy_switch_frame (frame
);
3987 internal_last_event_frame
= frame
;
3988 kbd_fetch_ptr
= event
+ 1;
3991 else if (event
->kind
== DBUS_EVENT
)
3993 obj
= make_lispy_event (event
);
3994 kbd_fetch_ptr
= event
+ 1;
3997 else if (event
->kind
== CONFIG_CHANGED_EVENT
)
3999 obj
= make_lispy_event (event
);
4000 kbd_fetch_ptr
= event
+ 1;
4004 /* If this event is on a different frame, return a switch-frame this
4005 time, and leave the event in the queue for next time. */
4009 frame
= event
->frame_or_window
;
4011 frame
= XCAR (frame
);
4012 else if (WINDOWP (frame
))
4013 frame
= WINDOW_FRAME (XWINDOW (frame
));
4015 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
4019 if (! EQ (frame
, internal_last_event_frame
)
4020 && !EQ (frame
, selected_frame
))
4021 obj
= make_lispy_switch_frame (frame
);
4022 internal_last_event_frame
= frame
;
4024 /* If we didn't decide to make a switch-frame event, go ahead
4025 and build a real event from the queue entry. */
4029 obj
= make_lispy_event (event
);
4031 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
4032 || defined (HAVE_NS) || defined (USE_GTK)
4033 /* If this was a menu selection, then set the flag to inhibit
4034 writing to last_nonmenu_event. Don't do this if the event
4035 we're returning is (menu-bar), though; that indicates the
4036 beginning of the menu sequence, and we might as well leave
4037 that as the `event with parameters' for this selection. */
4039 && !EQ (event
->frame_or_window
, event
->arg
)
4040 && (event
->kind
== MENU_BAR_EVENT
4041 || event
->kind
== TOOL_BAR_EVENT
))
4042 *used_mouse_menu
= 1;
4045 /* Certain system events are non-key events. */
4047 && event
->kind
== NS_NONKEY_EVENT
)
4048 *used_mouse_menu
= 1;
4051 /* Wipe out this event, to catch bugs. */
4052 clear_event (event
);
4053 kbd_fetch_ptr
= event
+ 1;
4057 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
4058 /* Try generating a mouse motion event. */
4059 else if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
4061 FRAME_PTR f
= some_mouse_moved ();
4062 Lisp_Object bar_window
;
4063 enum scroll_bar_part part
;
4067 *kbp
= current_kboard
;
4068 /* Note that this uses F to determine which terminal to look at.
4069 If there is no valid info, it does not store anything
4070 so x remains nil. */
4073 /* XXX Can f or mouse_position_hook be NULL here? */
4074 if (f
&& FRAME_TERMINAL (f
)->mouse_position_hook
)
4075 (*FRAME_TERMINAL (f
)->mouse_position_hook
) (&f
, 0, &bar_window
,
4080 /* Decide if we should generate a switch-frame event. Don't
4081 generate switch-frame events for motion outside of all Emacs
4087 frame
= FRAME_FOCUS_FRAME (f
);
4089 XSETFRAME (frame
, f
);
4091 if (! EQ (frame
, internal_last_event_frame
)
4092 && !EQ (frame
, selected_frame
))
4093 obj
= make_lispy_switch_frame (frame
);
4094 internal_last_event_frame
= frame
;
4097 /* If we didn't decide to make a switch-frame event, go ahead and
4098 return a mouse-motion event. */
4099 if (!NILP (x
) && NILP (obj
))
4100 obj
= make_lispy_movement (f
, bar_window
, part
, x
, y
, t
);
4102 #endif /* HAVE_MOUSE || HAVE GPM */
4104 /* We were promised by the above while loop that there was
4105 something for us to read! */
4108 input_pending
= readable_events (0);
4110 Vlast_event_frame
= internal_last_event_frame
;
4115 /* Process any non-user-visible events (currently X selection events),
4116 without reading any user-visible events. */
4119 process_special_events (void)
4121 struct input_event
*event
;
4123 for (event
= kbd_fetch_ptr
; event
!= kbd_store_ptr
; ++event
)
4125 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
4128 if (event
== kbd_store_ptr
)
4132 /* If we find a stored X selection request, handle it now. */
4133 if (event
->kind
== SELECTION_REQUEST_EVENT
4134 || event
->kind
== SELECTION_CLEAR_EVENT
)
4138 /* Remove the event from the fifo buffer before processing;
4139 otherwise swallow_events called recursively could see it
4140 and process it again. To do this, we move the events
4141 between kbd_fetch_ptr and EVENT one slot to the right,
4144 struct input_event copy
= *event
;
4145 struct input_event
*beg
4146 = (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
4147 ? kbd_buffer
: kbd_fetch_ptr
;
4150 memmove (beg
+ 1, beg
, (event
- beg
) * sizeof (struct input_event
));
4151 else if (event
< beg
)
4153 if (event
> kbd_buffer
)
4154 memmove (kbd_buffer
+ 1, kbd_buffer
,
4155 (event
- kbd_buffer
) * sizeof (struct input_event
));
4156 *kbd_buffer
= *(kbd_buffer
+ KBD_BUFFER_SIZE
- 1);
4157 if (beg
< kbd_buffer
+ KBD_BUFFER_SIZE
- 1)
4158 memmove (beg
+ 1, beg
,
4159 (kbd_buffer
+ KBD_BUFFER_SIZE
- 1 - beg
)
4160 * sizeof (struct input_event
));
4163 if (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
4164 kbd_fetch_ptr
= kbd_buffer
+ 1;
4168 /* X wants last_event_timestamp for selection ownership. */
4169 last_event_timestamp
= copy
.timestamp
;
4170 input_pending
= readable_events (0);
4171 x_handle_selection_event (©
);
4173 /* We're getting selection request events, but we don't have
4181 /* Process any events that are not user-visible, run timer events that
4182 are ripe, and return, without reading any user-visible events. */
4185 swallow_events (bool do_display
)
4187 unsigned old_timers_run
;
4189 process_special_events ();
4191 old_timers_run
= timers_run
;
4192 get_input_pending (READABLE_EVENTS_DO_TIMERS_NOW
);
4194 if (timers_run
!= old_timers_run
&& do_display
)
4195 redisplay_preserve_echo_area (7);
4198 /* Record the start of when Emacs is idle,
4199 for the sake of running idle-time timers. */
4202 timer_start_idle (void)
4206 /* If we are already in the idle state, do nothing. */
4207 if (EMACS_TIME_VALID_P (timer_idleness_start_time
))
4210 timer_idleness_start_time
= current_emacs_time ();
4211 timer_last_idleness_start_time
= timer_idleness_start_time
;
4213 /* Mark all idle-time timers as once again candidates for running. */
4214 for (timers
= Vtimer_idle_list
; CONSP (timers
); timers
= XCDR (timers
))
4218 timer
= XCAR (timers
);
4220 if (!VECTORP (timer
) || ASIZE (timer
) != 9)
4222 ASET (timer
, 0, Qnil
);
4226 /* Record that Emacs is no longer idle, so stop running idle-time timers. */
4229 timer_stop_idle (void)
4231 timer_idleness_start_time
= invalid_emacs_time ();
4234 /* Resume idle timer from last idle start time. */
4237 timer_resume_idle (void)
4239 if (EMACS_TIME_VALID_P (timer_idleness_start_time
))
4242 timer_idleness_start_time
= timer_last_idleness_start_time
;
4245 /* This is only for debugging. */
4246 struct input_event last_timer_event EXTERNALLY_VISIBLE
;
4248 /* List of elisp functions to call, delayed because they were generated in
4249 a context where Elisp could not be safely run (e.g. redisplay, signal,
4250 ...). Each element has the form (FUN . ARGS). */
4251 Lisp_Object pending_funcalls
;
4253 /* Return true if TIMER is a valid timer, placing its value into *RESULT. */
4255 decode_timer (Lisp_Object timer
, EMACS_TIME
*result
)
4257 Lisp_Object
*vector
;
4259 if (! (VECTORP (timer
) && ASIZE (timer
) == 9))
4261 vector
= XVECTOR (timer
)->contents
;
4262 if (! NILP (vector
[0]))
4265 return decode_time_components (vector
[1], vector
[2], vector
[3], vector
[8],
4270 /* Check whether a timer has fired. To prevent larger problems we simply
4271 disregard elements that are not proper timers. Do not make a circular
4272 timer list for the time being.
4274 Returns the time to wait until the next timer fires. If a
4275 timer is triggering now, return zero.
4276 If no timer is active, return -1.
4278 If a timer is ripe, we run it, with quitting turned off.
4279 In that case we return 0 to indicate that a new timer_check_2 call
4283 timer_check_2 (Lisp_Object timers
, Lisp_Object idle_timers
)
4285 EMACS_TIME nexttime
;
4287 EMACS_TIME idleness_now
;
4288 Lisp_Object chosen_timer
;
4289 struct gcpro gcpro1
;
4291 nexttime
= invalid_emacs_time ();
4293 chosen_timer
= Qnil
;
4294 GCPRO1 (chosen_timer
);
4296 /* First run the code that was delayed. */
4297 while (CONSP (pending_funcalls
))
4299 Lisp_Object funcall
= XCAR (pending_funcalls
);
4300 pending_funcalls
= XCDR (pending_funcalls
);
4301 safe_call2 (Qapply
, XCAR (funcall
), XCDR (funcall
));
4304 if (CONSP (timers
) || CONSP (idle_timers
))
4306 now
= current_emacs_time ();
4307 idleness_now
= (EMACS_TIME_VALID_P (timer_idleness_start_time
)
4308 ? sub_emacs_time (now
, timer_idleness_start_time
)
4309 : make_emacs_time (0, 0));
4312 while (CONSP (timers
) || CONSP (idle_timers
))
4314 Lisp_Object timer
= Qnil
, idle_timer
= Qnil
;
4315 EMACS_TIME timer_time
, idle_timer_time
;
4316 EMACS_TIME difference
;
4317 EMACS_TIME timer_difference
= invalid_emacs_time ();
4318 EMACS_TIME idle_timer_difference
= invalid_emacs_time ();
4319 bool ripe
, timer_ripe
= 0, idle_timer_ripe
= 0;
4321 /* Set TIMER and TIMER_DIFFERENCE
4322 based on the next ordinary timer.
4323 TIMER_DIFFERENCE is the distance in time from NOW to when
4324 this timer becomes ripe (negative if it's already ripe).
4325 Skip past invalid timers and timers already handled. */
4328 timer
= XCAR (timers
);
4329 if (! decode_timer (timer
, &timer_time
))
4331 timers
= XCDR (timers
);
4335 timer_ripe
= EMACS_TIME_LE (timer_time
, now
);
4336 timer_difference
= (timer_ripe
4337 ? sub_emacs_time (now
, timer_time
)
4338 : sub_emacs_time (timer_time
, now
));
4341 /* Likewise for IDLE_TIMER and IDLE_TIMER_DIFFERENCE
4342 based on the next idle timer. */
4343 if (CONSP (idle_timers
))
4345 idle_timer
= XCAR (idle_timers
);
4346 if (! decode_timer (idle_timer
, &idle_timer_time
))
4348 idle_timers
= XCDR (idle_timers
);
4352 idle_timer_ripe
= EMACS_TIME_LE (idle_timer_time
, idleness_now
);
4353 idle_timer_difference
=
4355 ? sub_emacs_time (idleness_now
, idle_timer_time
)
4356 : sub_emacs_time (idle_timer_time
, idleness_now
));
4359 /* Decide which timer is the next timer,
4360 and set CHOSEN_TIMER, DIFFERENCE, and RIPE accordingly.
4361 Also step down the list where we found that timer. */
4363 if (EMACS_TIME_VALID_P (timer_difference
)
4364 && (! EMACS_TIME_VALID_P (idle_timer_difference
)
4365 || idle_timer_ripe
< timer_ripe
4366 || (idle_timer_ripe
== timer_ripe
4368 ? EMACS_TIME_LT (idle_timer_difference
,
4370 : EMACS_TIME_LT (timer_difference
,
4371 idle_timer_difference
)))))
4373 chosen_timer
= timer
;
4374 timers
= XCDR (timers
);
4375 difference
= timer_difference
;
4380 chosen_timer
= idle_timer
;
4381 idle_timers
= XCDR (idle_timers
);
4382 difference
= idle_timer_difference
;
4383 ripe
= idle_timer_ripe
;
4386 /* If timer is ripe, run it if it hasn't been run. */
4389 if (NILP (AREF (chosen_timer
, 0)))
4391 ptrdiff_t count
= SPECPDL_INDEX ();
4392 Lisp_Object old_deactivate_mark
= Vdeactivate_mark
;
4394 /* Mark the timer as triggered to prevent problems if the lisp
4395 code fails to reschedule it right. */
4396 ASET (chosen_timer
, 0, Qt
);
4398 specbind (Qinhibit_quit
, Qt
);
4400 call1 (Qtimer_event_handler
, chosen_timer
);
4401 Vdeactivate_mark
= old_deactivate_mark
;
4403 unbind_to (count
, Qnil
);
4405 /* Since we have handled the event,
4406 we don't need to tell the caller to wake up and do it. */
4407 /* But the caller must still wait for the next timer, so
4408 return 0 to indicate that. */
4411 nexttime
= make_emacs_time (0, 0);
4415 /* When we encounter a timer that is still waiting,
4416 return the amount of time to wait before it is ripe. */
4423 /* No timers are pending in the future. */
4424 /* Return 0 if we generated an event, and -1 if not. */
4430 /* Check whether a timer has fired. To prevent larger problems we simply
4431 disregard elements that are not proper timers. Do not make a circular
4432 timer list for the time being.
4434 Returns the time to wait until the next timer fires.
4435 If no timer is active, return an invalid value.
4437 As long as any timer is ripe, we run it. */
4442 EMACS_TIME nexttime
;
4443 Lisp_Object timers
, idle_timers
;
4444 struct gcpro gcpro1
, gcpro2
;
4446 Lisp_Object tem
= Vinhibit_quit
;
4449 /* We use copies of the timers' lists to allow a timer to add itself
4450 again, without locking up Emacs if the newly added timer is
4451 already ripe when added. */
4453 /* Always consider the ordinary timers. */
4454 timers
= Fcopy_sequence (Vtimer_list
);
4455 /* Consider the idle timers only if Emacs is idle. */
4456 if (EMACS_TIME_VALID_P (timer_idleness_start_time
))
4457 idle_timers
= Fcopy_sequence (Vtimer_idle_list
);
4461 Vinhibit_quit
= tem
;
4463 GCPRO2 (timers
, idle_timers
);
4467 nexttime
= timer_check_2 (timers
, idle_timers
);
4469 while (EMACS_SECS (nexttime
) == 0 && EMACS_NSECS (nexttime
) == 0);
4475 DEFUN ("current-idle-time", Fcurrent_idle_time
, Scurrent_idle_time
, 0, 0, 0,
4476 doc
: /* Return the current length of Emacs idleness, or nil.
4477 The value when Emacs is idle is a list of four integers (HIGH LOW USEC PSEC)
4478 in the same style as (current-time).
4480 The value when Emacs is not idle is nil.
4482 PSEC is a multiple of the system clock resolution. */)
4485 if (EMACS_TIME_VALID_P (timer_idleness_start_time
))
4486 return make_lisp_time (sub_emacs_time (current_emacs_time (),
4487 timer_idleness_start_time
));
4492 /* Caches for modify_event_symbol. */
4493 static Lisp_Object accent_key_syms
;
4494 static Lisp_Object func_key_syms
;
4495 static Lisp_Object mouse_syms
;
4496 static Lisp_Object wheel_syms
;
4497 static Lisp_Object drag_n_drop_syms
;
4499 /* This is a list of keysym codes for special "accent" characters.
4500 It parallels lispy_accent_keys. */
4502 static const int lispy_accent_codes
[] =
4504 #ifdef XK_dead_circumflex
4509 #ifdef XK_dead_grave
4514 #ifdef XK_dead_tilde
4519 #ifdef XK_dead_diaeresis
4524 #ifdef XK_dead_macron
4529 #ifdef XK_dead_degree
4534 #ifdef XK_dead_acute
4539 #ifdef XK_dead_cedilla
4544 #ifdef XK_dead_breve
4549 #ifdef XK_dead_ogonek
4554 #ifdef XK_dead_caron
4559 #ifdef XK_dead_doubleacute
4560 XK_dead_doubleacute
,
4564 #ifdef XK_dead_abovedot
4569 #ifdef XK_dead_abovering
4579 #ifdef XK_dead_belowdot
4584 #ifdef XK_dead_voiced_sound
4585 XK_dead_voiced_sound
,
4589 #ifdef XK_dead_semivoiced_sound
4590 XK_dead_semivoiced_sound
,
4606 /* This is a list of Lisp names for special "accent" characters.
4607 It parallels lispy_accent_codes. */
4609 static const char *const lispy_accent_keys
[] =
4627 "dead-voiced-sound",
4628 "dead-semivoiced-sound",
4634 #define FUNCTION_KEY_OFFSET 0x0
4636 const char *const lispy_function_keys
[] =
4640 0, /* VK_LBUTTON 0x01 */
4641 0, /* VK_RBUTTON 0x02 */
4642 "cancel", /* VK_CANCEL 0x03 */
4643 0, /* VK_MBUTTON 0x04 */
4645 0, 0, 0, /* 0x05 .. 0x07 */
4647 "backspace", /* VK_BACK 0x08 */
4648 "tab", /* VK_TAB 0x09 */
4650 0, 0, /* 0x0A .. 0x0B */
4652 "clear", /* VK_CLEAR 0x0C */
4653 "return", /* VK_RETURN 0x0D */
4655 0, 0, /* 0x0E .. 0x0F */
4657 0, /* VK_SHIFT 0x10 */
4658 0, /* VK_CONTROL 0x11 */
4659 0, /* VK_MENU 0x12 */
4660 "pause", /* VK_PAUSE 0x13 */
4661 "capslock", /* VK_CAPITAL 0x14 */
4662 "kana", /* VK_KANA/VK_HANGUL 0x15 */
4664 "junja", /* VK_JUNJA 0x17 */
4665 "final", /* VK_FINAL 0x18 */
4666 "kanji", /* VK_KANJI/VK_HANJA 0x19 */
4668 "escape", /* VK_ESCAPE 0x1B */
4669 "convert", /* VK_CONVERT 0x1C */
4670 "non-convert", /* VK_NONCONVERT 0x1D */
4671 "accept", /* VK_ACCEPT 0x1E */
4672 "mode-change", /* VK_MODECHANGE 0x1F */
4673 0, /* VK_SPACE 0x20 */
4674 "prior", /* VK_PRIOR 0x21 */
4675 "next", /* VK_NEXT 0x22 */
4676 "end", /* VK_END 0x23 */
4677 "home", /* VK_HOME 0x24 */
4678 "left", /* VK_LEFT 0x25 */
4679 "up", /* VK_UP 0x26 */
4680 "right", /* VK_RIGHT 0x27 */
4681 "down", /* VK_DOWN 0x28 */
4682 "select", /* VK_SELECT 0x29 */
4683 "print", /* VK_PRINT 0x2A */
4684 "execute", /* VK_EXECUTE 0x2B */
4685 "snapshot", /* VK_SNAPSHOT 0x2C */
4686 "insert", /* VK_INSERT 0x2D */
4687 "delete", /* VK_DELETE 0x2E */
4688 "help", /* VK_HELP 0x2F */
4690 /* VK_0 thru VK_9 are the same as ASCII '0' thru '9' (0x30 - 0x39) */
4692 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4694 0, 0, 0, 0, 0, 0, 0, /* 0x3A .. 0x40 */
4696 /* VK_A thru VK_Z are the same as ASCII 'A' thru 'Z' (0x41 - 0x5A) */
4698 0, 0, 0, 0, 0, 0, 0, 0, 0,
4699 0, 0, 0, 0, 0, 0, 0, 0, 0,
4700 0, 0, 0, 0, 0, 0, 0, 0,
4702 "lwindow", /* VK_LWIN 0x5B */
4703 "rwindow", /* VK_RWIN 0x5C */
4704 "apps", /* VK_APPS 0x5D */
4707 "kp-0", /* VK_NUMPAD0 0x60 */
4708 "kp-1", /* VK_NUMPAD1 0x61 */
4709 "kp-2", /* VK_NUMPAD2 0x62 */
4710 "kp-3", /* VK_NUMPAD3 0x63 */
4711 "kp-4", /* VK_NUMPAD4 0x64 */
4712 "kp-5", /* VK_NUMPAD5 0x65 */
4713 "kp-6", /* VK_NUMPAD6 0x66 */
4714 "kp-7", /* VK_NUMPAD7 0x67 */
4715 "kp-8", /* VK_NUMPAD8 0x68 */
4716 "kp-9", /* VK_NUMPAD9 0x69 */
4717 "kp-multiply", /* VK_MULTIPLY 0x6A */
4718 "kp-add", /* VK_ADD 0x6B */
4719 "kp-separator", /* VK_SEPARATOR 0x6C */
4720 "kp-subtract", /* VK_SUBTRACT 0x6D */
4721 "kp-decimal", /* VK_DECIMAL 0x6E */
4722 "kp-divide", /* VK_DIVIDE 0x6F */
4723 "f1", /* VK_F1 0x70 */
4724 "f2", /* VK_F2 0x71 */
4725 "f3", /* VK_F3 0x72 */
4726 "f4", /* VK_F4 0x73 */
4727 "f5", /* VK_F5 0x74 */
4728 "f6", /* VK_F6 0x75 */
4729 "f7", /* VK_F7 0x76 */
4730 "f8", /* VK_F8 0x77 */
4731 "f9", /* VK_F9 0x78 */
4732 "f10", /* VK_F10 0x79 */
4733 "f11", /* VK_F11 0x7A */
4734 "f12", /* VK_F12 0x7B */
4735 "f13", /* VK_F13 0x7C */
4736 "f14", /* VK_F14 0x7D */
4737 "f15", /* VK_F15 0x7E */
4738 "f16", /* VK_F16 0x7F */
4739 "f17", /* VK_F17 0x80 */
4740 "f18", /* VK_F18 0x81 */
4741 "f19", /* VK_F19 0x82 */
4742 "f20", /* VK_F20 0x83 */
4743 "f21", /* VK_F21 0x84 */
4744 "f22", /* VK_F22 0x85 */
4745 "f23", /* VK_F23 0x86 */
4746 "f24", /* VK_F24 0x87 */
4748 0, 0, 0, 0, /* 0x88 .. 0x8B */
4749 0, 0, 0, 0, /* 0x8C .. 0x8F */
4751 "kp-numlock", /* VK_NUMLOCK 0x90 */
4752 "scroll", /* VK_SCROLL 0x91 */
4753 /* Not sure where the following block comes from.
4754 Windows headers have NEC and Fujitsu specific keys in
4755 this block, but nothing generic. */
4756 "kp-space", /* VK_NUMPAD_CLEAR 0x92 */
4757 "kp-enter", /* VK_NUMPAD_ENTER 0x93 */
4758 "kp-prior", /* VK_NUMPAD_PRIOR 0x94 */
4759 "kp-next", /* VK_NUMPAD_NEXT 0x95 */
4760 "kp-end", /* VK_NUMPAD_END 0x96 */
4761 "kp-home", /* VK_NUMPAD_HOME 0x97 */
4762 "kp-left", /* VK_NUMPAD_LEFT 0x98 */
4763 "kp-up", /* VK_NUMPAD_UP 0x99 */
4764 "kp-right", /* VK_NUMPAD_RIGHT 0x9A */
4765 "kp-down", /* VK_NUMPAD_DOWN 0x9B */
4766 "kp-insert", /* VK_NUMPAD_INSERT 0x9C */
4767 "kp-delete", /* VK_NUMPAD_DELETE 0x9D */
4769 0, 0, /* 0x9E .. 0x9F */
4772 * VK_L* & VK_R* - left and right Alt, Ctrl and Shift virtual keys.
4773 * Used only as parameters to GetAsyncKeyState and GetKeyState.
4774 * No other API or message will distinguish left and right keys this way.
4779 /* Multimedia keys. These are handled as WM_APPCOMMAND, which allows us
4780 to enable them selectively, and gives access to a few more functions.
4781 See lispy_multimedia_keys below. */
4782 0, 0, 0, 0, 0, 0, 0, /* 0xA6 .. 0xAC Browser */
4783 0, 0, 0, /* 0xAD .. 0xAF Volume */
4784 0, 0, 0, 0, /* 0xB0 .. 0xB3 Media */
4785 0, 0, 0, 0, /* 0xB4 .. 0xB7 Apps */
4787 /* 0xB8 .. 0xC0 "OEM" keys - all seem to be punctuation. */
4788 0, 0, 0, 0, 0, 0, 0, 0, 0,
4790 /* 0xC1 - 0xDA unallocated, 0xDB-0xDF more OEM keys */
4791 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4792 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4795 "ax", /* VK_OEM_AX 0xE1 */
4796 0, /* VK_OEM_102 0xE2 */
4797 "ico-help", /* VK_ICO_HELP 0xE3 */
4798 "ico-00", /* VK_ICO_00 0xE4 */
4799 0, /* VK_PROCESSKEY 0xE5 - used by IME */
4800 "ico-clear", /* VK_ICO_CLEAR 0xE6 */
4801 0, /* VK_PACKET 0xE7 - used to pass Unicode chars */
4803 "reset", /* VK_OEM_RESET 0xE9 */
4804 "jump", /* VK_OEM_JUMP 0xEA */
4805 "oem-pa1", /* VK_OEM_PA1 0xEB */
4806 "oem-pa2", /* VK_OEM_PA2 0xEC */
4807 "oem-pa3", /* VK_OEM_PA3 0xED */
4808 "wsctrl", /* VK_OEM_WSCTRL 0xEE */
4809 "cusel", /* VK_OEM_CUSEL 0xEF */
4810 "oem-attn", /* VK_OEM_ATTN 0xF0 */
4811 "finish", /* VK_OEM_FINISH 0xF1 */
4812 "copy", /* VK_OEM_COPY 0xF2 */
4813 "auto", /* VK_OEM_AUTO 0xF3 */
4814 "enlw", /* VK_OEM_ENLW 0xF4 */
4815 "backtab", /* VK_OEM_BACKTAB 0xF5 */
4816 "attn", /* VK_ATTN 0xF6 */
4817 "crsel", /* VK_CRSEL 0xF7 */
4818 "exsel", /* VK_EXSEL 0xF8 */
4819 "ereof", /* VK_EREOF 0xF9 */
4820 "play", /* VK_PLAY 0xFA */
4821 "zoom", /* VK_ZOOM 0xFB */
4822 "noname", /* VK_NONAME 0xFC */
4823 "pa1", /* VK_PA1 0xFD */
4824 "oem_clear", /* VK_OEM_CLEAR 0xFE */
4828 /* Some of these duplicate the "Media keys" on newer keyboards,
4829 but they are delivered to the application in a different way. */
4830 static const char *const lispy_multimedia_keys
[] =
4838 "browser-favorites",
4875 "toggle-dictate-command",
4881 "media-fast-forward",
4884 "media-channel-down"
4887 #else /* not HAVE_NTGUI */
4889 /* This should be dealt with in XTread_socket now, and that doesn't
4890 depend on the client system having the Kana syms defined. See also
4891 the XK_kana_A case below. */
4894 static const char *const lispy_kana_keys
[] =
4896 /* X Keysym value */
4897 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x400 .. 0x40f */
4898 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x410 .. 0x41f */
4899 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x420 .. 0x42f */
4900 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x430 .. 0x43f */
4901 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x440 .. 0x44f */
4902 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x450 .. 0x45f */
4903 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x460 .. 0x46f */
4904 0,0,0,0,0,0,0,0,0,0,0,0,0,0,"overline",0,
4905 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x480 .. 0x48f */
4906 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x490 .. 0x49f */
4907 0, "kana-fullstop", "kana-openingbracket", "kana-closingbracket",
4908 "kana-comma", "kana-conjunctive", "kana-WO", "kana-a",
4909 "kana-i", "kana-u", "kana-e", "kana-o",
4910 "kana-ya", "kana-yu", "kana-yo", "kana-tsu",
4911 "prolongedsound", "kana-A", "kana-I", "kana-U",
4912 "kana-E", "kana-O", "kana-KA", "kana-KI",
4913 "kana-KU", "kana-KE", "kana-KO", "kana-SA",
4914 "kana-SHI", "kana-SU", "kana-SE", "kana-SO",
4915 "kana-TA", "kana-CHI", "kana-TSU", "kana-TE",
4916 "kana-TO", "kana-NA", "kana-NI", "kana-NU",
4917 "kana-NE", "kana-NO", "kana-HA", "kana-HI",
4918 "kana-FU", "kana-HE", "kana-HO", "kana-MA",
4919 "kana-MI", "kana-MU", "kana-ME", "kana-MO",
4920 "kana-YA", "kana-YU", "kana-YO", "kana-RA",
4921 "kana-RI", "kana-RU", "kana-RE", "kana-RO",
4922 "kana-WA", "kana-N", "voicedsound", "semivoicedsound",
4923 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4e0 .. 0x4ef */
4924 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4f0 .. 0x4ff */
4926 #endif /* XK_kana_A */
4929 #define FUNCTION_KEY_OFFSET 0xff00
4931 /* You'll notice that this table is arranged to be conveniently
4932 indexed by X Windows keysym values. */
4933 static const char *const lispy_function_keys
[] =
4935 /* X Keysym value */
4937 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff00...0f */
4938 "backspace", "tab", "linefeed", "clear",
4940 0, 0, 0, "pause", /* 0xff10...1f */
4941 0, 0, 0, 0, 0, 0, 0, "escape",
4943 0, "kanji", "muhenkan", "henkan", /* 0xff20...2f */
4944 "romaji", "hiragana", "katakana", "hiragana-katakana",
4945 "zenkaku", "hankaku", "zenkaku-hankaku", "touroku",
4946 "massyo", "kana-lock", "kana-shift", "eisu-shift",
4947 "eisu-toggle", /* 0xff30...3f */
4948 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4949 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff40...4f */
4951 "home", "left", "up", "right", /* 0xff50 */ /* IsCursorKey */
4952 "down", "prior", "next", "end",
4953 "begin", 0, 0, 0, 0, 0, 0, 0,
4954 "select", /* 0xff60 */ /* IsMiscFunctionKey */
4965 "break", /* 0xff6b */
4968 0, 0, 0, 0, "backtab", 0, 0, 0, /* 0xff70... */
4969 0, 0, 0, 0, 0, 0, 0, "kp-numlock", /* 0xff78... */
4970 "kp-space", /* 0xff80 */ /* IsKeypadKey */
4971 0, 0, 0, 0, 0, 0, 0, 0,
4972 "kp-tab", /* 0xff89 */
4974 "kp-enter", /* 0xff8d */
4976 "kp-f1", /* 0xff91 */
4980 "kp-home", /* 0xff95 */
4985 "kp-prior", /* kp-page-up */
4986 "kp-next", /* kp-page-down */
4992 0, 0, 0, 0, 0, 0, 0, 0, 0,
4993 "kp-multiply", /* 0xffaa */
4998 "kp-divide", /* 0xffaf */
4999 "kp-0", /* 0xffb0 */
5000 "kp-1", "kp-2", "kp-3", "kp-4", "kp-5", "kp-6", "kp-7", "kp-8", "kp-9",
5003 "kp-equal", /* 0xffbd */
5004 "f1", /* 0xffbe */ /* IsFunctionKey */
5006 "f3", "f4", "f5", "f6", "f7", "f8", "f9", "f10", /* 0xffc0 */
5007 "f11", "f12", "f13", "f14", "f15", "f16", "f17", "f18",
5008 "f19", "f20", "f21", "f22", "f23", "f24", "f25", "f26", /* 0xffd0 */
5009 "f27", "f28", "f29", "f30", "f31", "f32", "f33", "f34",
5010 "f35", 0, 0, 0, 0, 0, 0, 0, /* 0xffe0 */
5011 0, 0, 0, 0, 0, 0, 0, 0,
5012 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfff0 */
5013 0, 0, 0, 0, 0, 0, 0, "delete"
5016 /* ISO 9995 Function and Modifier Keys; the first byte is 0xFE. */
5017 #define ISO_FUNCTION_KEY_OFFSET 0xfe00
5019 static const char *const iso_lispy_function_keys
[] =
5021 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe00 */
5022 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe08 */
5023 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe10 */
5024 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe18 */
5025 "iso-lefttab", /* 0xfe20 */
5026 "iso-move-line-up", "iso-move-line-down",
5027 "iso-partial-line-up", "iso-partial-line-down",
5028 "iso-partial-space-left", "iso-partial-space-right",
5029 "iso-set-margin-left", "iso-set-margin-right", /* 0xffe27, 28 */
5030 "iso-release-margin-left", "iso-release-margin-right",
5031 "iso-release-both-margins",
5032 "iso-fast-cursor-left", "iso-fast-cursor-right",
5033 "iso-fast-cursor-up", "iso-fast-cursor-down",
5034 "iso-continuous-underline", "iso-discontinuous-underline", /* 0xfe30, 31 */
5035 "iso-emphasize", "iso-center-object", "iso-enter", /* ... 0xfe34 */
5038 #endif /* not HAVE_NTGUI */
5040 static Lisp_Object Vlispy_mouse_stem
;
5042 static const char *const lispy_wheel_names
[] =
5044 "wheel-up", "wheel-down", "wheel-left", "wheel-right"
5047 /* drag-n-drop events are generated when a set of selected files are
5048 dragged from another application and dropped onto an Emacs window. */
5049 static const char *const lispy_drag_n_drop_names
[] =
5054 /* Scroll bar parts. */
5055 static Lisp_Object Qabove_handle
, Qhandle
, Qbelow_handle
;
5056 Lisp_Object Qup
, Qdown
, Qbottom
;
5057 static Lisp_Object Qend_scroll
;
5059 static Lisp_Object Qratio
;
5061 /* An array of scroll bar parts, indexed by an enum scroll_bar_part value. */
5062 static Lisp_Object
*const scroll_bar_parts
[] = {
5063 &Qabove_handle
, &Qhandle
, &Qbelow_handle
,
5064 &Qup
, &Qdown
, &Qtop
, &Qbottom
, &Qend_scroll
, &Qratio
5067 /* A vector, indexed by button number, giving the down-going location
5068 of currently depressed buttons, both scroll bar and non-scroll bar.
5070 The elements have the form
5071 (BUTTON-NUMBER MODIFIER-MASK . REST)
5072 where REST is the cdr of a position as it would be reported in the event.
5074 The make_lispy_event function stores positions here to tell the
5075 difference between click and drag events, and to store the starting
5076 location to be included in drag events. */
5078 static Lisp_Object button_down_location
;
5080 /* Information about the most recent up-going button event: Which
5081 button, what location, and what time. */
5083 static int last_mouse_button
;
5084 static int last_mouse_x
;
5085 static int last_mouse_y
;
5086 static Time button_down_time
;
5088 /* The number of clicks in this multiple-click. */
5090 static int double_click_count
;
5092 /* X and Y are frame-relative coordinates for a click or wheel event.
5093 Return a Lisp-style event list. */
5096 make_lispy_position (struct frame
*f
, Lisp_Object x
, Lisp_Object y
,
5099 enum window_part part
;
5100 Lisp_Object posn
= Qnil
;
5101 Lisp_Object extra_info
= Qnil
;
5102 /* Coordinate pixel positions to return. */
5103 int xret
= 0, yret
= 0;
5104 /* The window under frame pixel coordinates (x,y) */
5105 Lisp_Object window
= f
5106 ? window_from_coordinates (f
, XINT (x
), XINT (y
), &part
, 0)
5109 if (WINDOWP (window
))
5111 /* It's a click in window WINDOW at frame coordinates (X,Y) */
5112 struct window
*w
= XWINDOW (window
);
5113 Lisp_Object string_info
= Qnil
;
5114 ptrdiff_t textpos
= -1;
5115 int col
= -1, row
= -1;
5116 int dx
= -1, dy
= -1;
5117 int width
= -1, height
= -1;
5118 Lisp_Object object
= Qnil
;
5120 /* Pixel coordinates relative to the window corner. */
5121 int wx
= XINT (x
) - WINDOW_LEFT_EDGE_X (w
);
5122 int wy
= XINT (y
) - WINDOW_TOP_EDGE_Y (w
);
5124 /* For text area clicks, return X, Y relative to the corner of
5125 this text area. Note that dX, dY etc are set below, by
5126 buffer_posn_from_coords. */
5127 if (part
== ON_TEXT
)
5129 xret
= XINT (x
) - window_box_left (w
, TEXT_AREA
);
5130 yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5132 /* For mode line and header line clicks, return X, Y relative to
5133 the left window edge. Use mode_line_string to look for a
5134 string on the click position. */
5135 else if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
)
5140 posn
= (part
== ON_MODE_LINE
) ? Qmode_line
: Qheader_line
;
5141 /* Note that mode_line_string takes COL, ROW as pixels and
5142 converts them to characters. */
5145 string
= mode_line_string (w
, part
, &col
, &row
, &charpos
,
5146 &object
, &dx
, &dy
, &width
, &height
);
5147 if (STRINGP (string
))
5148 string_info
= Fcons (string
, make_number (charpos
));
5149 textpos
= (w
== XWINDOW (selected_window
)
5150 && current_buffer
== XBUFFER (w
->buffer
))
5151 ? PT
: XMARKER (w
->pointm
)->charpos
;
5156 /* For fringes and margins, Y is relative to the area's (and the
5157 window's) top edge, while X is meaningless. */
5158 else if (part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
5163 posn
= (part
== ON_LEFT_MARGIN
) ? Qleft_margin
: Qright_margin
;
5166 string
= marginal_area_string (w
, part
, &col
, &row
, &charpos
,
5167 &object
, &dx
, &dy
, &width
, &height
);
5168 if (STRINGP (string
))
5169 string_info
= Fcons (string
, make_number (charpos
));
5170 yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5172 else if (part
== ON_LEFT_FRINGE
)
5174 posn
= Qleft_fringe
;
5177 - (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5178 ? 0 : window_box_width (w
, LEFT_MARGIN_AREA
));
5179 dy
= yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5181 else if (part
== ON_RIGHT_FRINGE
)
5183 posn
= Qright_fringe
;
5186 - window_box_width (w
, LEFT_MARGIN_AREA
)
5187 - window_box_width (w
, TEXT_AREA
)
5188 - (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5189 ? window_box_width (w
, RIGHT_MARGIN_AREA
)
5191 dy
= yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5193 else if (part
== ON_VERTICAL_BORDER
)
5195 posn
= Qvertical_line
;
5200 /* Nothing special for part == ON_SCROLL_BAR. */
5202 /* For clicks in the text area, fringes, or margins, call
5203 buffer_posn_from_coords to extract TEXTPOS, the buffer
5204 position nearest to the click. */
5207 Lisp_Object string2
, object2
= Qnil
;
5208 struct display_pos p
;
5210 int width2
, height2
;
5211 /* The pixel X coordinate passed to buffer_posn_from_coords
5212 is the X coordinate relative to the text area for
5213 text-area and right-margin clicks, zero otherwise. */
5215 = (part
== ON_TEXT
) ? xret
5216 : (part
== ON_RIGHT_FRINGE
|| part
== ON_RIGHT_MARGIN
)
5217 ? (XINT (x
) - window_box_left (w
, TEXT_AREA
))
5221 string2
= buffer_posn_from_coords (w
, &x2
, &y2
, &p
,
5222 &object2
, &dx2
, &dy2
,
5224 textpos
= CHARPOS (p
.pos
);
5225 if (col
< 0) col
= x2
;
5226 if (row
< 0) row
= y2
;
5227 if (dx
< 0) dx
= dx2
;
5228 if (dy
< 0) dy
= dy2
;
5229 if (width
< 0) width
= width2
;
5230 if (height
< 0) height
= height2
;
5234 posn
= make_number (textpos
);
5235 if (STRINGP (string2
))
5236 string_info
= Fcons (string2
,
5237 make_number (CHARPOS (p
.string_pos
)));
5243 #ifdef HAVE_WINDOW_SYSTEM
5244 if (IMAGEP (object
))
5246 Lisp_Object image_map
, hotspot
;
5247 if ((image_map
= Fplist_get (XCDR (object
), QCmap
),
5249 && (hotspot
= find_hot_spot (image_map
, dx
, dy
),
5251 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
5252 posn
= XCAR (hotspot
);
5259 Fcons (make_number (dx
), make_number (dy
)),
5260 Fcons (make_number (width
), make_number (height
)));
5263 extra_info
= Fcons (string_info
,
5264 Fcons (make_number (textpos
),
5265 Fcons (Fcons (make_number (col
),
5270 XSETFRAME (window
, f
);
5274 return Fcons (window
,
5276 Fcons (Fcons (make_number (xret
),
5277 make_number (yret
)),
5278 Fcons (make_number (t
),
5282 /* Given a struct input_event, build the lisp event which represents
5283 it. If EVENT is 0, build a mouse movement event from the mouse
5284 movement buffer, which should have a movement event in it.
5286 Note that events must be passed to this function in the order they
5287 are received; this function stores the location of button presses
5288 in order to build drag events when the button is released. */
5291 make_lispy_event (struct input_event
*event
)
5295 switch (event
->kind
)
5297 /* A simple keystroke. */
5298 case ASCII_KEYSTROKE_EVENT
:
5299 case MULTIBYTE_CHAR_KEYSTROKE_EVENT
:
5301 Lisp_Object lispy_c
;
5302 EMACS_INT c
= event
->code
;
5303 if (event
->kind
== ASCII_KEYSTROKE_EVENT
)
5306 eassert (c
== event
->code
);
5307 /* Turn ASCII characters into control characters
5309 if (event
->modifiers
& ctrl_modifier
)
5311 c
= make_ctrl_char (c
);
5312 event
->modifiers
&= ~ctrl_modifier
;
5316 /* Add in the other modifier bits. The shift key was taken care
5317 of by the X code. */
5318 c
|= (event
->modifiers
5319 & (meta_modifier
| alt_modifier
5320 | hyper_modifier
| super_modifier
| ctrl_modifier
));
5321 /* Distinguish Shift-SPC from SPC. */
5322 if ((event
->code
) == 040
5323 && event
->modifiers
& shift_modifier
)
5324 c
|= shift_modifier
;
5325 button_down_time
= 0;
5326 XSETFASTINT (lispy_c
, c
);
5331 /* NS_NONKEY_EVENTs are just like NON_ASCII_KEYSTROKE_EVENTs,
5332 except that they are non-key events (last-nonmenu-event is nil). */
5333 case NS_NONKEY_EVENT
:
5336 /* A function key. The symbol may need to have modifier prefixes
5338 case NON_ASCII_KEYSTROKE_EVENT
:
5339 button_down_time
= 0;
5341 for (i
= 0; i
< sizeof (lispy_accent_codes
) / sizeof (int); i
++)
5342 if (event
->code
== lispy_accent_codes
[i
])
5343 return modify_event_symbol (i
,
5345 Qfunction_key
, Qnil
,
5346 lispy_accent_keys
, &accent_key_syms
,
5347 (sizeof (lispy_accent_keys
)
5348 / sizeof (lispy_accent_keys
[0])));
5352 if (event
->code
>= 0x400 && event
->code
< 0x500)
5353 return modify_event_symbol (event
->code
- 0x400,
5354 event
->modifiers
& ~shift_modifier
,
5355 Qfunction_key
, Qnil
,
5356 lispy_kana_keys
, &func_key_syms
,
5357 (sizeof (lispy_kana_keys
)
5358 / sizeof (lispy_kana_keys
[0])));
5359 #endif /* XK_kana_A */
5362 #ifdef ISO_FUNCTION_KEY_OFFSET
5363 if (event
->code
< FUNCTION_KEY_OFFSET
5364 && event
->code
>= ISO_FUNCTION_KEY_OFFSET
)
5365 return modify_event_symbol (event
->code
- ISO_FUNCTION_KEY_OFFSET
,
5367 Qfunction_key
, Qnil
,
5368 iso_lispy_function_keys
, &func_key_syms
,
5369 (sizeof (iso_lispy_function_keys
)
5370 / sizeof (iso_lispy_function_keys
[0])));
5373 /* Handle system-specific or unknown keysyms. */
5374 if (event
->code
& (1 << 28)
5375 || event
->code
- FUNCTION_KEY_OFFSET
< 0
5376 || (event
->code
- FUNCTION_KEY_OFFSET
5377 >= sizeof lispy_function_keys
/ sizeof *lispy_function_keys
)
5378 || !lispy_function_keys
[event
->code
- FUNCTION_KEY_OFFSET
])
5380 /* We need to use an alist rather than a vector as the cache
5381 since we can't make a vector long enough. */
5382 if (NILP (KVAR (current_kboard
, system_key_syms
)))
5383 kset_system_key_syms (current_kboard
, Fcons (Qnil
, Qnil
));
5384 return modify_event_symbol (event
->code
,
5387 KVAR (current_kboard
, Vsystem_key_alist
),
5388 0, &KVAR (current_kboard
, system_key_syms
),
5392 return modify_event_symbol (event
->code
- FUNCTION_KEY_OFFSET
,
5394 Qfunction_key
, Qnil
,
5395 lispy_function_keys
, &func_key_syms
,
5396 (sizeof (lispy_function_keys
)
5397 / sizeof (lispy_function_keys
[0])));
5400 case MULTIMEDIA_KEY_EVENT
:
5401 if (event
->code
< (sizeof (lispy_multimedia_keys
)
5402 / sizeof (lispy_multimedia_keys
[0]))
5403 && event
->code
> 0 && lispy_multimedia_keys
[event
->code
])
5405 return modify_event_symbol (event
->code
, event
->modifiers
,
5406 Qfunction_key
, Qnil
,
5407 lispy_multimedia_keys
, &func_key_syms
,
5408 (sizeof (lispy_multimedia_keys
)
5409 / sizeof (lispy_multimedia_keys
[0])));
5415 /* A mouse click. Figure out where it is, decide whether it's
5416 a press, click or drag, and build the appropriate structure. */
5417 case MOUSE_CLICK_EVENT
:
5418 #ifndef USE_TOOLKIT_SCROLL_BARS
5419 case SCROLL_BAR_CLICK_EVENT
:
5422 int button
= event
->code
;
5424 Lisp_Object position
;
5425 Lisp_Object
*start_pos_ptr
;
5426 Lisp_Object start_pos
;
5430 /* Build the position as appropriate for this mouse click. */
5431 if (event
->kind
== MOUSE_CLICK_EVENT
)
5433 struct frame
*f
= XFRAME (event
->frame_or_window
);
5434 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK) && ! defined (HAVE_NS)
5438 /* Ignore mouse events that were made on frame that
5439 have been deleted. */
5440 if (! FRAME_LIVE_P (f
))
5443 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK) && ! defined (HAVE_NS)
5444 /* EVENT->x and EVENT->y are frame-relative pixel
5445 coordinates at this place. Under old redisplay, COLUMN
5446 and ROW are set to frame relative glyph coordinates
5447 which are then used to determine whether this click is
5448 in a menu (non-toolkit version). */
5449 pixel_to_glyph_coords (f
, XINT (event
->x
), XINT (event
->y
),
5450 &column
, &row
, NULL
, 1);
5452 /* In the non-toolkit version, clicks on the menu bar
5453 are ordinary button events in the event buffer.
5454 Distinguish them, and invoke the menu.
5456 (In the toolkit version, the toolkit handles the menu bar
5457 and Emacs doesn't know about it until after the user
5458 makes a selection.) */
5459 if (row
>= 0 && row
< FRAME_MENU_BAR_LINES (f
)
5460 && (event
->modifiers
& down_modifier
))
5462 Lisp_Object items
, item
;
5464 /* Find the menu bar item under `column'. */
5466 items
= FRAME_MENU_BAR_ITEMS (f
);
5467 for (i
= 0; i
< ASIZE (items
); i
+= 4)
5469 Lisp_Object pos
, string
;
5470 string
= AREF (items
, i
+ 1);
5471 pos
= AREF (items
, i
+ 3);
5474 if (column
>= XINT (pos
)
5475 && column
< XINT (pos
) + SCHARS (string
))
5477 item
= AREF (items
, i
);
5482 /* ELisp manual 2.4b says (x y) are window relative but
5483 code says they are frame-relative. */
5485 = Fcons (event
->frame_or_window
,
5487 Fcons (Fcons (event
->x
, event
->y
),
5488 Fcons (make_number (event
->timestamp
),
5491 return Fcons (item
, Fcons (position
, Qnil
));
5493 #endif /* not USE_X_TOOLKIT && not USE_GTK && not HAVE_NS */
5495 position
= make_lispy_position (f
, event
->x
, event
->y
,
5498 #ifndef USE_TOOLKIT_SCROLL_BARS
5501 /* It's a scrollbar click. */
5503 Lisp_Object portion_whole
;
5506 window
= event
->frame_or_window
;
5507 portion_whole
= Fcons (event
->x
, event
->y
);
5508 part
= *scroll_bar_parts
[(int) event
->part
];
5512 Fcons (Qvertical_scroll_bar
,
5513 Fcons (portion_whole
,
5514 Fcons (make_number (event
->timestamp
),
5515 Fcons (part
, Qnil
)))));
5517 #endif /* not USE_TOOLKIT_SCROLL_BARS */
5519 if (button
>= ASIZE (button_down_location
))
5521 ptrdiff_t incr
= button
- ASIZE (button_down_location
) + 1;
5522 button_down_location
= larger_vector (button_down_location
,
5524 mouse_syms
= larger_vector (mouse_syms
, incr
, -1);
5527 start_pos_ptr
= aref_addr (button_down_location
, button
);
5528 start_pos
= *start_pos_ptr
;
5529 *start_pos_ptr
= Qnil
;
5532 /* On window-system frames, use the value of
5533 double-click-fuzz as is. On other frames, interpret it
5534 as a multiple of 1/8 characters. */
5538 if (WINDOWP (event
->frame_or_window
))
5539 f
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5540 else if (FRAMEP (event
->frame_or_window
))
5541 f
= XFRAME (event
->frame_or_window
);
5545 if (FRAME_WINDOW_P (f
))
5546 fuzz
= double_click_fuzz
;
5548 fuzz
= double_click_fuzz
/ 8;
5550 is_double
= (button
== last_mouse_button
5551 && (eabs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5552 && (eabs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5553 && button_down_time
!= 0
5554 && (EQ (Vdouble_click_time
, Qt
)
5555 || (NATNUMP (Vdouble_click_time
)
5556 && (event
->timestamp
- button_down_time
5557 < XFASTINT (Vdouble_click_time
)))));
5560 last_mouse_button
= button
;
5561 last_mouse_x
= XINT (event
->x
);
5562 last_mouse_y
= XINT (event
->y
);
5564 /* If this is a button press, squirrel away the location, so
5565 we can decide later whether it was a click or a drag. */
5566 if (event
->modifiers
& down_modifier
)
5570 double_click_count
++;
5571 event
->modifiers
|= ((double_click_count
> 2)
5576 double_click_count
= 1;
5577 button_down_time
= event
->timestamp
;
5578 *start_pos_ptr
= Fcopy_alist (position
);
5579 ignore_mouse_drag_p
= 0;
5582 /* Now we're releasing a button - check the co-ordinates to
5583 see if this was a click or a drag. */
5584 else if (event
->modifiers
& up_modifier
)
5586 /* If we did not see a down before this up, ignore the up.
5587 Probably this happened because the down event chose a
5588 menu item. It would be an annoyance to treat the
5589 release of the button that chose the menu item as a
5592 if (!CONSP (start_pos
))
5595 event
->modifiers
&= ~up_modifier
;
5598 Lisp_Object new_down
, down
;
5599 EMACS_INT xdiff
= double_click_fuzz
, ydiff
= double_click_fuzz
;
5601 /* The third element of every position
5602 should be the (x,y) pair. */
5603 down
= Fcar (Fcdr (Fcdr (start_pos
)));
5604 new_down
= Fcar (Fcdr (Fcdr (position
)));
5607 && INTEGERP (XCAR (down
)) && INTEGERP (XCDR (down
)))
5609 xdiff
= XINT (XCAR (new_down
)) - XINT (XCAR (down
));
5610 ydiff
= XINT (XCDR (new_down
)) - XINT (XCDR (down
));
5613 if (ignore_mouse_drag_p
)
5615 event
->modifiers
|= click_modifier
;
5616 ignore_mouse_drag_p
= 0;
5618 else if (xdiff
< double_click_fuzz
&& xdiff
> - double_click_fuzz
5619 && ydiff
< double_click_fuzz
&& ydiff
> - double_click_fuzz
5620 /* Maybe the mouse has moved a lot, caused scrolling, and
5621 eventually ended up at the same screen position (but
5622 not buffer position) in which case it is a drag, not
5624 /* FIXME: OTOH if the buffer position has changed
5625 because of a timer or process filter rather than
5626 because of mouse movement, it should be considered as
5627 a click. But mouse-drag-region completely ignores
5628 this case and it hasn't caused any real problem, so
5629 it's probably OK to ignore it as well. */
5630 && EQ (Fcar (Fcdr (start_pos
)), Fcar (Fcdr (position
))))
5631 /* Mouse hasn't moved (much). */
5632 event
->modifiers
|= click_modifier
;
5635 button_down_time
= 0;
5636 event
->modifiers
|= drag_modifier
;
5639 /* Don't check is_double; treat this as multiple
5640 if the down-event was multiple. */
5641 if (double_click_count
> 1)
5642 event
->modifiers
|= ((double_click_count
> 2)
5648 /* Every mouse event should either have the down_modifier or
5649 the up_modifier set. */
5653 /* Get the symbol we should use for the mouse click. */
5656 head
= modify_event_symbol (button
,
5658 Qmouse_click
, Vlispy_mouse_stem
,
5661 ASIZE (mouse_syms
));
5662 if (event
->modifiers
& drag_modifier
)
5667 else if (event
->modifiers
& (double_modifier
| triple_modifier
))
5670 Fcons (make_number (double_click_count
),
5680 case HORIZ_WHEEL_EVENT
:
5682 Lisp_Object position
;
5685 /* Build the position as appropriate for this mouse click. */
5686 struct frame
*f
= XFRAME (event
->frame_or_window
);
5688 /* Ignore wheel events that were made on frame that have been
5690 if (! FRAME_LIVE_P (f
))
5693 position
= make_lispy_position (f
, event
->x
, event
->y
,
5696 /* Set double or triple modifiers to indicate the wheel speed. */
5698 /* On window-system frames, use the value of
5699 double-click-fuzz as is. On other frames, interpret it
5700 as a multiple of 1/8 characters. */
5706 if (WINDOWP (event
->frame_or_window
))
5707 fr
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5708 else if (FRAMEP (event
->frame_or_window
))
5709 fr
= XFRAME (event
->frame_or_window
);
5713 fuzz
= FRAME_WINDOW_P (fr
)
5714 ? double_click_fuzz
: double_click_fuzz
/ 8;
5716 if (event
->modifiers
& up_modifier
)
5718 /* Emit a wheel-up event. */
5719 event
->modifiers
&= ~up_modifier
;
5722 else if (event
->modifiers
& down_modifier
)
5724 /* Emit a wheel-down event. */
5725 event
->modifiers
&= ~down_modifier
;
5729 /* Every wheel event should either have the down_modifier or
5730 the up_modifier set. */
5733 if (event
->kind
== HORIZ_WHEEL_EVENT
)
5736 is_double
= (last_mouse_button
== - (1 + symbol_num
)
5737 && (eabs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5738 && (eabs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5739 && button_down_time
!= 0
5740 && (EQ (Vdouble_click_time
, Qt
)
5741 || (NATNUMP (Vdouble_click_time
)
5742 && (event
->timestamp
- button_down_time
5743 < XFASTINT (Vdouble_click_time
)))));
5746 double_click_count
++;
5747 event
->modifiers
|= ((double_click_count
> 2)
5753 double_click_count
= 1;
5754 event
->modifiers
|= click_modifier
;
5757 button_down_time
= event
->timestamp
;
5758 /* Use a negative value to distinguish wheel from mouse button. */
5759 last_mouse_button
= - (1 + symbol_num
);
5760 last_mouse_x
= XINT (event
->x
);
5761 last_mouse_y
= XINT (event
->y
);
5763 /* Get the symbol we should use for the wheel event. */
5764 head
= modify_event_symbol (symbol_num
,
5770 ASIZE (wheel_syms
));
5773 if (event
->modifiers
& (double_modifier
| triple_modifier
))
5776 Fcons (make_number (double_click_count
),
5785 #ifdef USE_TOOLKIT_SCROLL_BARS
5787 /* We don't have down and up events if using toolkit scroll bars,
5788 so make this always a click event. Store in the `part' of
5789 the Lisp event a symbol which maps to the following actions:
5791 `above_handle' page up
5792 `below_handle' page down
5796 `bottom' bottom of buffer
5797 `handle' thumb has been dragged.
5798 `end-scroll' end of interaction with scroll bar
5800 The incoming input_event contains in its `part' member an
5801 index of type `enum scroll_bar_part' which we can use as an
5802 index in scroll_bar_parts to get the appropriate symbol. */
5804 case SCROLL_BAR_CLICK_EVENT
:
5806 Lisp_Object position
, head
, window
, portion_whole
, part
;
5808 window
= event
->frame_or_window
;
5809 portion_whole
= Fcons (event
->x
, event
->y
);
5810 part
= *scroll_bar_parts
[(int) event
->part
];
5814 Fcons (Qvertical_scroll_bar
,
5815 Fcons (portion_whole
,
5816 Fcons (make_number (event
->timestamp
),
5817 Fcons (part
, Qnil
)))));
5819 /* Always treat scroll bar events as clicks. */
5820 event
->modifiers
|= click_modifier
;
5821 event
->modifiers
&= ~up_modifier
;
5823 if (event
->code
>= ASIZE (mouse_syms
))
5824 mouse_syms
= larger_vector (mouse_syms
,
5825 event
->code
- ASIZE (mouse_syms
) + 1,
5828 /* Get the symbol we should use for the mouse click. */
5829 head
= modify_event_symbol (event
->code
,
5834 ASIZE (mouse_syms
));
5835 return Fcons (head
, Fcons (position
, Qnil
));
5838 #endif /* USE_TOOLKIT_SCROLL_BARS */
5840 case DRAG_N_DROP_EVENT
:
5843 Lisp_Object head
, position
;
5846 f
= XFRAME (event
->frame_or_window
);
5849 /* Ignore mouse events that were made on frames that
5850 have been deleted. */
5851 if (! FRAME_LIVE_P (f
))
5854 position
= make_lispy_position (f
, event
->x
, event
->y
,
5857 head
= modify_event_symbol (0, event
->modifiers
,
5859 lispy_drag_n_drop_names
,
5860 &drag_n_drop_syms
, 1);
5866 #endif /* HAVE_MOUSE */
5868 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
5869 || defined (HAVE_NS) || defined (USE_GTK)
5870 case MENU_BAR_EVENT
:
5871 if (EQ (event
->arg
, event
->frame_or_window
))
5872 /* This is the prefix key. We translate this to
5873 `(menu_bar)' because the code in keyboard.c for menu
5874 events, which we use, relies on this. */
5875 return Fcons (Qmenu_bar
, Qnil
);
5879 case SELECT_WINDOW_EVENT
:
5880 /* Make an event (select-window (WINDOW)). */
5881 return Fcons (Qselect_window
,
5882 Fcons (Fcons (event
->frame_or_window
, Qnil
),
5885 case TOOL_BAR_EVENT
:
5886 if (EQ (event
->arg
, event
->frame_or_window
))
5887 /* This is the prefix key. We translate this to
5888 `(tool_bar)' because the code in keyboard.c for tool bar
5889 events, which we use, relies on this. */
5890 return Fcons (Qtool_bar
, Qnil
);
5891 else if (SYMBOLP (event
->arg
))
5892 return apply_modifiers (event
->modifiers
, event
->arg
);
5895 case USER_SIGNAL_EVENT
:
5896 /* A user signal. */
5898 char *name
= find_user_signal_name (event
->code
);
5901 return intern (name
);
5904 case SAVE_SESSION_EVENT
:
5905 return Qsave_session
;
5910 return Fcons (Qdbus_event
, event
->arg
);
5912 #endif /* HAVE_DBUS */
5914 case CONFIG_CHANGED_EVENT
:
5915 return Fcons (Qconfig_changed_event
,
5917 Fcons (event
->frame_or_window
, Qnil
)));
5919 case GPM_CLICK_EVENT
:
5921 FRAME_PTR f
= XFRAME (event
->frame_or_window
);
5922 Lisp_Object head
, position
;
5923 Lisp_Object
*start_pos_ptr
;
5924 Lisp_Object start_pos
;
5925 int button
= event
->code
;
5927 if (button
>= ASIZE (button_down_location
))
5929 ptrdiff_t incr
= button
- ASIZE (button_down_location
) + 1;
5930 button_down_location
= larger_vector (button_down_location
,
5932 mouse_syms
= larger_vector (mouse_syms
, incr
, -1);
5935 start_pos_ptr
= aref_addr (button_down_location
, button
);
5936 start_pos
= *start_pos_ptr
;
5938 position
= make_lispy_position (f
, event
->x
, event
->y
,
5941 if (event
->modifiers
& down_modifier
)
5942 *start_pos_ptr
= Fcopy_alist (position
);
5943 else if (event
->modifiers
& (up_modifier
| drag_modifier
))
5945 if (!CONSP (start_pos
))
5947 event
->modifiers
&= ~up_modifier
;
5950 head
= modify_event_symbol (button
,
5952 Qmouse_click
, Vlispy_mouse_stem
,
5955 ASIZE (mouse_syms
));
5957 if (event
->modifiers
& drag_modifier
)
5962 else if (event
->modifiers
& double_modifier
)
5965 Fcons (make_number (2),
5967 else if (event
->modifiers
& triple_modifier
)
5970 Fcons (make_number (3),
5977 #endif /* HAVE_GPM */
5979 /* The 'kind' field of the event is something we don't recognize. */
5985 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
5988 make_lispy_movement (FRAME_PTR frame
, Lisp_Object bar_window
, enum scroll_bar_part part
,
5989 Lisp_Object x
, Lisp_Object y
, Time t
)
5991 /* Is it a scroll bar movement? */
5992 if (frame
&& ! NILP (bar_window
))
5994 Lisp_Object part_sym
;
5996 part_sym
= *scroll_bar_parts
[(int) part
];
5997 return Fcons (Qscroll_bar_movement
,
5998 Fcons (list5 (bar_window
,
5999 Qvertical_scroll_bar
,
6005 /* Or is it an ordinary mouse movement? */
6008 Lisp_Object position
;
6009 position
= make_lispy_position (frame
, x
, y
, t
);
6010 return list2 (Qmouse_movement
, position
);
6014 #endif /* HAVE_MOUSE || HAVE GPM */
6016 /* Construct a switch frame event. */
6018 make_lispy_switch_frame (Lisp_Object frame
)
6020 return Fcons (Qswitch_frame
, Fcons (frame
, Qnil
));
6023 /* Manipulating modifiers. */
6025 /* Parse the name of SYMBOL, and return the set of modifiers it contains.
6027 If MODIFIER_END is non-zero, set *MODIFIER_END to the position in
6028 SYMBOL's name of the end of the modifiers; the string from this
6029 position is the unmodified symbol name.
6031 This doesn't use any caches. */
6034 parse_modifiers_uncached (Lisp_Object symbol
, ptrdiff_t *modifier_end
)
6040 CHECK_SYMBOL (symbol
);
6043 name
= SYMBOL_NAME (symbol
);
6045 for (i
= 0; i
< SBYTES (name
) - 1; )
6047 ptrdiff_t this_mod_end
= 0;
6050 /* See if the name continues with a modifier word.
6051 Check that the word appears, but don't check what follows it.
6052 Set this_mod and this_mod_end to record what we find. */
6054 switch (SREF (name
, i
))
6056 #define SINGLE_LETTER_MOD(BIT) \
6057 (this_mod_end = i + 1, this_mod = BIT)
6060 SINGLE_LETTER_MOD (alt_modifier
);
6064 SINGLE_LETTER_MOD (ctrl_modifier
);
6068 SINGLE_LETTER_MOD (hyper_modifier
);
6072 SINGLE_LETTER_MOD (meta_modifier
);
6076 SINGLE_LETTER_MOD (shift_modifier
);
6080 SINGLE_LETTER_MOD (super_modifier
);
6083 #undef SINGLE_LETTER_MOD
6085 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6086 if (i + LEN + 1 <= SBYTES (name) \
6087 && ! memcmp (SDATA (name) + i, NAME, LEN)) \
6089 this_mod_end = i + LEN; \
6094 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
6095 MULTI_LETTER_MOD (down_modifier
, "down", 4);
6096 MULTI_LETTER_MOD (double_modifier
, "double", 6);
6100 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
6102 #undef MULTI_LETTER_MOD
6106 /* If we found no modifier, stop looking for them. */
6107 if (this_mod_end
== 0)
6110 /* Check there is a dash after the modifier, so that it
6111 really is a modifier. */
6112 if (this_mod_end
>= SBYTES (name
)
6113 || SREF (name
, this_mod_end
) != '-')
6116 /* This modifier is real; look for another. */
6117 modifiers
|= this_mod
;
6118 i
= this_mod_end
+ 1;
6121 /* Should we include the `click' modifier? */
6122 if (! (modifiers
& (down_modifier
| drag_modifier
6123 | double_modifier
| triple_modifier
))
6124 && i
+ 7 == SBYTES (name
)
6125 && memcmp (SDATA (name
) + i
, "mouse-", 6) == 0
6126 && ('0' <= SREF (name
, i
+ 6) && SREF (name
, i
+ 6) <= '9'))
6127 modifiers
|= click_modifier
;
6129 if (! (modifiers
& (double_modifier
| triple_modifier
))
6130 && i
+ 6 < SBYTES (name
)
6131 && memcmp (SDATA (name
) + i
, "wheel-", 6) == 0)
6132 modifiers
|= click_modifier
;
6140 /* Return a symbol whose name is the modifier prefixes for MODIFIERS
6141 prepended to the string BASE[0..BASE_LEN-1].
6142 This doesn't use any caches. */
6144 apply_modifiers_uncached (int modifiers
, char *base
, int base_len
, int base_len_byte
)
6146 /* Since BASE could contain nulls, we can't use intern here; we have
6147 to use Fintern, which expects a genuine Lisp_String, and keeps a
6149 char new_mods
[sizeof "A-C-H-M-S-s-down-drag-double-triple-"];
6155 /* Only the event queue may use the `up' modifier; it should always
6156 be turned into a click or drag event before presented to lisp code. */
6157 if (modifiers
& up_modifier
)
6160 if (modifiers
& alt_modifier
) { *p
++ = 'A'; *p
++ = '-'; }
6161 if (modifiers
& ctrl_modifier
) { *p
++ = 'C'; *p
++ = '-'; }
6162 if (modifiers
& hyper_modifier
) { *p
++ = 'H'; *p
++ = '-'; }
6163 if (modifiers
& meta_modifier
) { *p
++ = 'M'; *p
++ = '-'; }
6164 if (modifiers
& shift_modifier
) { *p
++ = 'S'; *p
++ = '-'; }
6165 if (modifiers
& super_modifier
) { *p
++ = 's'; *p
++ = '-'; }
6166 if (modifiers
& double_modifier
) { strcpy (p
, "double-"); p
+= 7; }
6167 if (modifiers
& triple_modifier
) { strcpy (p
, "triple-"); p
+= 7; }
6168 if (modifiers
& down_modifier
) { strcpy (p
, "down-"); p
+= 5; }
6169 if (modifiers
& drag_modifier
) { strcpy (p
, "drag-"); p
+= 5; }
6170 /* The click modifier is denoted by the absence of other modifiers. */
6174 mod_len
= p
- new_mods
;
6178 Lisp_Object new_name
;
6180 new_name
= make_uninit_multibyte_string (mod_len
+ base_len
,
6181 mod_len
+ base_len_byte
);
6182 memcpy (SDATA (new_name
), new_mods
, mod_len
);
6183 memcpy (SDATA (new_name
) + mod_len
, base
, base_len_byte
);
6185 return Fintern (new_name
, Qnil
);
6190 static const char *const modifier_names
[] =
6192 "up", "down", "drag", "click", "double", "triple", 0, 0,
6193 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
6194 0, 0, "alt", "super", "hyper", "shift", "control", "meta"
6196 #define NUM_MOD_NAMES (sizeof (modifier_names) / sizeof (modifier_names[0]))
6198 static Lisp_Object modifier_symbols
;
6200 /* Return the list of modifier symbols corresponding to the mask MODIFIERS. */
6202 lispy_modifier_list (int modifiers
)
6204 Lisp_Object modifier_list
;
6207 modifier_list
= Qnil
;
6208 for (i
= 0; (1<<i
) <= modifiers
&& i
< NUM_MOD_NAMES
; i
++)
6209 if (modifiers
& (1<<i
))
6210 modifier_list
= Fcons (AREF (modifier_symbols
, i
),
6213 return modifier_list
;
6217 /* Parse the modifiers on SYMBOL, and return a list like (UNMODIFIED MASK),
6218 where UNMODIFIED is the unmodified form of SYMBOL,
6219 MASK is the set of modifiers present in SYMBOL's name.
6220 This is similar to parse_modifiers_uncached, but uses the cache in
6221 SYMBOL's Qevent_symbol_element_mask property, and maintains the
6222 Qevent_symbol_elements property. */
6224 #define KEY_TO_CHAR(k) (XINT (k) & ((1 << CHARACTERBITS) - 1))
6227 parse_modifiers (Lisp_Object symbol
)
6229 Lisp_Object elements
;
6231 if (INTEGERP (symbol
))
6232 return (Fcons (make_number (KEY_TO_CHAR (symbol
)),
6233 Fcons (make_number (XINT (symbol
) & CHAR_MODIFIER_MASK
),
6235 else if (!SYMBOLP (symbol
))
6238 elements
= Fget (symbol
, Qevent_symbol_element_mask
);
6239 if (CONSP (elements
))
6244 int modifiers
= parse_modifiers_uncached (symbol
, &end
);
6245 Lisp_Object unmodified
;
6248 unmodified
= Fintern (make_string (SSDATA (SYMBOL_NAME (symbol
)) + end
,
6249 SBYTES (SYMBOL_NAME (symbol
)) - end
),
6252 if (modifiers
& ~INTMASK
)
6254 XSETFASTINT (mask
, modifiers
);
6255 elements
= Fcons (unmodified
, Fcons (mask
, Qnil
));
6257 /* Cache the parsing results on SYMBOL. */
6258 Fput (symbol
, Qevent_symbol_element_mask
,
6260 Fput (symbol
, Qevent_symbol_elements
,
6261 Fcons (unmodified
, lispy_modifier_list (modifiers
)));
6263 /* Since we know that SYMBOL is modifiers applied to unmodified,
6264 it would be nice to put that in unmodified's cache.
6265 But we can't, since we're not sure that parse_modifiers is
6272 DEFUN ("internal-event-symbol-parse-modifiers", Fevent_symbol_parse_modifiers
,
6273 Sevent_symbol_parse_modifiers
, 1, 1, 0,
6274 doc
: /* Parse the event symbol. For internal use. */)
6275 (Lisp_Object symbol
)
6277 /* Fill the cache if needed. */
6278 parse_modifiers (symbol
);
6279 /* Ignore the result (which is stored on Qevent_symbol_element_mask)
6280 and use the Lispier representation stored on Qevent_symbol_elements
6282 return Fget (symbol
, Qevent_symbol_elements
);
6285 /* Apply the modifiers MODIFIERS to the symbol BASE.
6286 BASE must be unmodified.
6288 This is like apply_modifiers_uncached, but uses BASE's
6289 Qmodifier_cache property, if present. It also builds
6290 Qevent_symbol_elements properties, since it has that info anyway.
6292 apply_modifiers copies the value of BASE's Qevent_kind property to
6293 the modified symbol. */
6295 apply_modifiers (int modifiers
, Lisp_Object base
)
6297 Lisp_Object cache
, idx
, entry
, new_symbol
;
6299 /* Mask out upper bits. We don't know where this value's been. */
6300 modifiers
&= INTMASK
;
6302 if (INTEGERP (base
))
6303 return make_number (XINT (base
) | modifiers
);
6305 /* The click modifier never figures into cache indices. */
6306 cache
= Fget (base
, Qmodifier_cache
);
6307 XSETFASTINT (idx
, (modifiers
& ~click_modifier
));
6308 entry
= assq_no_quit (idx
, cache
);
6311 new_symbol
= XCDR (entry
);
6314 /* We have to create the symbol ourselves. */
6315 new_symbol
= apply_modifiers_uncached (modifiers
,
6316 SSDATA (SYMBOL_NAME (base
)),
6317 SCHARS (SYMBOL_NAME (base
)),
6318 SBYTES (SYMBOL_NAME (base
)));
6320 /* Add the new symbol to the base's cache. */
6321 entry
= Fcons (idx
, new_symbol
);
6322 Fput (base
, Qmodifier_cache
, Fcons (entry
, cache
));
6324 /* We have the parsing info now for free, so we could add it to
6326 XSETFASTINT (idx, modifiers);
6327 Fput (new_symbol, Qevent_symbol_element_mask,
6328 Fcons (base, Fcons (idx, Qnil)));
6329 Fput (new_symbol, Qevent_symbol_elements,
6330 Fcons (base, lispy_modifier_list (modifiers)));
6331 Sadly, this is only correct if `base' is indeed a base event,
6332 which is not necessarily the case. -stef */
6335 /* Make sure this symbol is of the same kind as BASE.
6337 You'd think we could just set this once and for all when we
6338 intern the symbol above, but reorder_modifiers may call us when
6339 BASE's property isn't set right; we can't assume that just
6340 because it has a Qmodifier_cache property it must have its
6341 Qevent_kind set right as well. */
6342 if (NILP (Fget (new_symbol
, Qevent_kind
)))
6346 kind
= Fget (base
, Qevent_kind
);
6348 Fput (new_symbol
, Qevent_kind
, kind
);
6355 /* Given a symbol whose name begins with modifiers ("C-", "M-", etc),
6356 return a symbol with the modifiers placed in the canonical order.
6357 Canonical order is alphabetical, except for down and drag, which
6358 always come last. The 'click' modifier is never written out.
6360 Fdefine_key calls this to make sure that (for example) C-M-foo
6361 and M-C-foo end up being equivalent in the keymap. */
6364 reorder_modifiers (Lisp_Object symbol
)
6366 /* It's hopefully okay to write the code this way, since everything
6367 will soon be in caches, and no consing will be done at all. */
6370 parsed
= parse_modifiers (symbol
);
6371 return apply_modifiers (XFASTINT (XCAR (XCDR (parsed
))),
6376 /* For handling events, we often want to produce a symbol whose name
6377 is a series of modifier key prefixes ("M-", "C-", etcetera) attached
6378 to some base, like the name of a function key or mouse button.
6379 modify_event_symbol produces symbols of this sort.
6381 NAME_TABLE should point to an array of strings, such that NAME_TABLE[i]
6382 is the name of the i'th symbol. TABLE_SIZE is the number of elements
6385 Alternatively, NAME_ALIST_OR_STEM is either an alist mapping codes
6386 into symbol names, or a string specifying a name stem used to
6387 construct a symbol name or the form `STEM-N', where N is the decimal
6388 representation of SYMBOL_NUM. NAME_ALIST_OR_STEM is used if it is
6389 non-nil; otherwise NAME_TABLE is used.
6391 SYMBOL_TABLE should be a pointer to a Lisp_Object whose value will
6392 persist between calls to modify_event_symbol that it can use to
6393 store a cache of the symbols it's generated for this NAME_TABLE
6394 before. The object stored there may be a vector or an alist.
6396 SYMBOL_NUM is the number of the base name we want from NAME_TABLE.
6398 MODIFIERS is a set of modifier bits (as given in struct input_events)
6399 whose prefixes should be applied to the symbol name.
6401 SYMBOL_KIND is the value to be placed in the event_kind property of
6402 the returned symbol.
6404 The symbols we create are supposed to have an
6405 `event-symbol-elements' property, which lists the modifiers present
6406 in the symbol's name. */
6409 modify_event_symbol (ptrdiff_t symbol_num
, int modifiers
, Lisp_Object symbol_kind
,
6410 Lisp_Object name_alist_or_stem
, const char *const *name_table
,
6411 Lisp_Object
*symbol_table
, ptrdiff_t table_size
)
6414 Lisp_Object symbol_int
;
6416 /* Get rid of the "vendor-specific" bit here. */
6417 XSETINT (symbol_int
, symbol_num
& 0xffffff);
6419 /* Is this a request for a valid symbol? */
6420 if (symbol_num
< 0 || symbol_num
>= table_size
)
6423 if (CONSP (*symbol_table
))
6424 value
= Fcdr (assq_no_quit (symbol_int
, *symbol_table
));
6426 /* If *symbol_table doesn't seem to be initialized properly, fix that.
6427 *symbol_table should be a lisp vector TABLE_SIZE elements long,
6428 where the Nth element is the symbol for NAME_TABLE[N], or nil if
6429 we've never used that symbol before. */
6432 if (! VECTORP (*symbol_table
)
6433 || ASIZE (*symbol_table
) != table_size
)
6437 XSETFASTINT (size
, table_size
);
6438 *symbol_table
= Fmake_vector (size
, Qnil
);
6441 value
= AREF (*symbol_table
, symbol_num
);
6444 /* Have we already used this symbol before? */
6447 /* No; let's create it. */
6448 if (CONSP (name_alist_or_stem
))
6449 value
= Fcdr_safe (Fassq (symbol_int
, name_alist_or_stem
));
6450 else if (STRINGP (name_alist_or_stem
))
6453 ptrdiff_t len
= (SBYTES (name_alist_or_stem
)
6454 + sizeof "-" + INT_STRLEN_BOUND (EMACS_INT
));
6456 buf
= SAFE_ALLOCA (len
);
6457 esprintf (buf
, "%s-%"pI
"d", SDATA (name_alist_or_stem
),
6458 XINT (symbol_int
) + 1);
6459 value
= intern (buf
);
6462 else if (name_table
!= 0 && name_table
[symbol_num
])
6463 value
= intern (name_table
[symbol_num
]);
6465 #ifdef HAVE_WINDOW_SYSTEM
6468 char *name
= x_get_keysym_name (symbol_num
);
6470 value
= intern (name
);
6476 char buf
[sizeof "key-" + INT_STRLEN_BOUND (EMACS_INT
)];
6477 sprintf (buf
, "key-%"pD
"d", symbol_num
);
6478 value
= intern (buf
);
6481 if (CONSP (*symbol_table
))
6482 *symbol_table
= Fcons (Fcons (symbol_int
, value
), *symbol_table
);
6484 ASET (*symbol_table
, symbol_num
, value
);
6486 /* Fill in the cache entries for this symbol; this also
6487 builds the Qevent_symbol_elements property, which the user
6489 apply_modifiers (modifiers
& click_modifier
, value
);
6490 Fput (value
, Qevent_kind
, symbol_kind
);
6493 /* Apply modifiers to that symbol. */
6494 return apply_modifiers (modifiers
, value
);
6497 /* Convert a list that represents an event type,
6498 such as (ctrl meta backspace), into the usual representation of that
6499 event type as a number or a symbol. */
6501 DEFUN ("event-convert-list", Fevent_convert_list
, Sevent_convert_list
, 1, 1, 0,
6502 doc
: /* Convert the event description list EVENT-DESC to an event type.
6503 EVENT-DESC should contain one base event type (a character or symbol)
6504 and zero or more modifier names (control, meta, hyper, super, shift, alt,
6505 drag, down, double or triple). The base must be last.
6506 The return value is an event type (a character or symbol) which
6507 has the same base event type and all the specified modifiers. */)
6508 (Lisp_Object event_desc
)
6516 while (CONSP (rest
))
6524 /* Given a symbol, see if it is a modifier name. */
6525 if (SYMBOLP (elt
) && CONSP (rest
))
6526 this = parse_solitary_modifier (elt
);
6530 else if (!NILP (base
))
6531 error ("Two bases given in one event");
6537 /* Let the symbol A refer to the character A. */
6538 if (SYMBOLP (base
) && SCHARS (SYMBOL_NAME (base
)) == 1)
6539 XSETINT (base
, SREF (SYMBOL_NAME (base
), 0));
6541 if (INTEGERP (base
))
6543 /* Turn (shift a) into A. */
6544 if ((modifiers
& shift_modifier
) != 0
6545 && (XINT (base
) >= 'a' && XINT (base
) <= 'z'))
6547 XSETINT (base
, XINT (base
) - ('a' - 'A'));
6548 modifiers
&= ~shift_modifier
;
6551 /* Turn (control a) into C-a. */
6552 if (modifiers
& ctrl_modifier
)
6553 return make_number ((modifiers
& ~ctrl_modifier
)
6554 | make_ctrl_char (XINT (base
)));
6556 return make_number (modifiers
| XINT (base
));
6558 else if (SYMBOLP (base
))
6559 return apply_modifiers (modifiers
, base
);
6562 error ("Invalid base event");
6567 /* Try to recognize SYMBOL as a modifier name.
6568 Return the modifier flag bit, or 0 if not recognized. */
6571 parse_solitary_modifier (Lisp_Object symbol
)
6573 Lisp_Object name
= SYMBOL_NAME (symbol
);
6575 switch (SREF (name
, 0))
6577 #define SINGLE_LETTER_MOD(BIT) \
6578 if (SBYTES (name) == 1) \
6581 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6582 if (LEN == SBYTES (name) \
6583 && ! memcmp (SDATA (name), NAME, LEN)) \
6587 SINGLE_LETTER_MOD (alt_modifier
);
6591 MULTI_LETTER_MOD (alt_modifier
, "alt", 3);
6595 SINGLE_LETTER_MOD (ctrl_modifier
);
6599 MULTI_LETTER_MOD (ctrl_modifier
, "ctrl", 4);
6600 MULTI_LETTER_MOD (ctrl_modifier
, "control", 7);
6604 SINGLE_LETTER_MOD (hyper_modifier
);
6608 MULTI_LETTER_MOD (hyper_modifier
, "hyper", 5);
6612 SINGLE_LETTER_MOD (meta_modifier
);
6616 MULTI_LETTER_MOD (meta_modifier
, "meta", 4);
6620 SINGLE_LETTER_MOD (shift_modifier
);
6624 MULTI_LETTER_MOD (shift_modifier
, "shift", 5);
6625 MULTI_LETTER_MOD (super_modifier
, "super", 5);
6626 SINGLE_LETTER_MOD (super_modifier
);
6630 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
6631 MULTI_LETTER_MOD (down_modifier
, "down", 4);
6632 MULTI_LETTER_MOD (double_modifier
, "double", 6);
6636 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
6639 #undef SINGLE_LETTER_MOD
6640 #undef MULTI_LETTER_MOD
6646 /* Return true if EVENT is a list whose elements are all integers or symbols.
6647 Such a list is not valid as an event,
6648 but it can be a Lucid-style event type list. */
6651 lucid_event_type_list_p (Lisp_Object object
)
6655 if (! CONSP (object
))
6658 if (EQ (XCAR (object
), Qhelp_echo
)
6659 || EQ (XCAR (object
), Qvertical_line
)
6660 || EQ (XCAR (object
), Qmode_line
)
6661 || EQ (XCAR (object
), Qheader_line
))
6664 for (tail
= object
; CONSP (tail
); tail
= XCDR (tail
))
6668 if (! (INTEGERP (elt
) || SYMBOLP (elt
)))
6675 /* Return true if terminal input chars are available.
6676 Also, store the return value into INPUT_PENDING.
6678 Serves the purpose of ioctl (0, FIONREAD, ...)
6679 but works even if FIONREAD does not exist.
6680 (In fact, this may actually read some input.)
6682 If READABLE_EVENTS_DO_TIMERS_NOW is set in FLAGS, actually run
6683 timer events that are ripe.
6684 If READABLE_EVENTS_FILTER_EVENTS is set in FLAGS, ignore internal
6685 events (FOCUS_IN_EVENT).
6686 If READABLE_EVENTS_IGNORE_SQUEEZABLES is set in FLAGS, ignore mouse
6687 movements and toolkit scroll bar thumb drags. */
6690 get_input_pending (int flags
)
6692 /* First of all, have we already counted some input? */
6693 input_pending
= (!NILP (Vquit_flag
) || readable_events (flags
));
6695 /* If input is being read as it arrives, and we have none, there is none. */
6696 if (!input_pending
&& (!interrupt_input
|| interrupts_deferred
))
6698 /* Try to read some input and see how much we get. */
6700 input_pending
= (!NILP (Vquit_flag
) || readable_events (flags
));
6703 return input_pending
;
6706 /* Put a BUFFER_SWITCH_EVENT in the buffer
6707 so that read_key_sequence will notice the new current buffer. */
6710 record_asynch_buffer_change (void)
6712 struct input_event event
;
6716 event
.kind
= BUFFER_SWITCH_EVENT
;
6717 event
.frame_or_window
= Qnil
;
6720 /* We don't need a buffer-switch event unless Emacs is waiting for input.
6721 The purpose of the event is to make read_key_sequence look up the
6722 keymaps again. If we aren't in read_key_sequence, we don't need one,
6723 and the event could cause trouble by messing up (input-pending-p).
6724 Note: Fwaiting_for_user_input_p always returns nil when async
6725 subprocesses aren't supported. */
6726 tem
= Fwaiting_for_user_input_p ();
6730 /* Make sure no interrupt happens while storing the event. */
6732 if (interrupt_input
)
6733 kbd_buffer_store_event (&event
);
6738 kbd_buffer_store_event (&event
);
6743 /* Read any terminal input already buffered up by the system
6744 into the kbd_buffer, but do not wait.
6746 Return the number of keyboard chars read, or -1 meaning
6747 this is a bad time to try to read input. */
6756 /* Store pending user signal events, if any. */
6757 store_user_signal_events ();
6759 /* Loop through the available terminals, and call their input hooks. */
6763 struct terminal
*next
= t
->next_terminal
;
6765 if (t
->read_socket_hook
)
6768 struct input_event hold_quit
;
6770 if (input_blocked_p ())
6772 pending_signals
= 1;
6776 EVENT_INIT (hold_quit
);
6777 hold_quit
.kind
= NO_EVENT
;
6779 /* No need for FIONREAD or fcntl; just say don't wait. */
6780 while (0 < (nr
= (*t
->read_socket_hook
) (t
, &hold_quit
)))
6783 if (nr
== -1) /* Not OK to read input now. */
6787 else if (nr
== -2) /* Non-transient error. */
6789 /* The terminal device terminated; it should be closed. */
6791 /* Kill Emacs if this was our last terminal. */
6792 if (!terminal_list
->next_terminal
)
6793 /* Formerly simply reported no input, but that
6794 sometimes led to a failure of Emacs to terminate.
6795 SIGHUP seems appropriate if we can't reach the
6797 /* ??? Is it really right to send the signal just to
6798 this process rather than to the whole process
6799 group? Perhaps on systems with FIONREAD Emacs is
6800 alone in its group. */
6801 terminate_due_to_signal (SIGHUP
, 10);
6803 /* XXX Is calling delete_terminal safe here? It calls delete_frame. */
6806 XSETTERMINAL (tmp
, t
);
6807 Fdelete_terminal (tmp
, Qnoelisp
);
6811 if (hold_quit
.kind
!= NO_EVENT
)
6812 kbd_buffer_store_event (&hold_quit
);
6821 frame_make_pointer_visible ();
6827 decode_keyboard_code (struct tty_display_info
*tty
,
6828 struct coding_system
*coding
,
6829 unsigned char *buf
, int nbytes
)
6831 unsigned char *src
= buf
;
6832 const unsigned char *p
;
6837 if (tty
->meta_key
!= 2)
6838 for (i
= 0; i
< nbytes
; i
++)
6840 if (coding
->carryover_bytes
> 0)
6842 src
= alloca (coding
->carryover_bytes
+ nbytes
);
6843 memcpy (src
, coding
->carryover
, coding
->carryover_bytes
);
6844 memcpy (src
+ coding
->carryover_bytes
, buf
, nbytes
);
6845 nbytes
+= coding
->carryover_bytes
;
6847 coding
->destination
= alloca (nbytes
* 4);
6848 coding
->dst_bytes
= nbytes
* 4;
6849 decode_coding_c_string (coding
, src
, nbytes
, Qnil
);
6850 if (coding
->produced_char
== 0)
6852 for (i
= 0, p
= coding
->destination
; i
< coding
->produced_char
; i
++)
6854 struct input_event event_buf
;
6856 EVENT_INIT (event_buf
);
6857 event_buf
.code
= STRING_CHAR_ADVANCE (p
);
6859 (ASCII_CHAR_P (event_buf
.code
)
6860 ? ASCII_KEYSTROKE_EVENT
: MULTIBYTE_CHAR_KEYSTROKE_EVENT
);
6861 /* See the comment in tty_read_avail_input. */
6862 event_buf
.frame_or_window
= tty
->top_frame
;
6863 event_buf
.arg
= Qnil
;
6864 kbd_buffer_store_event (&event_buf
);
6868 /* This is the tty way of reading available input.
6870 Note that each terminal device has its own `struct terminal' object,
6871 and so this function is called once for each individual termcap
6872 terminal. The first parameter indicates which terminal to read from. */
6875 tty_read_avail_input (struct terminal
*terminal
,
6876 struct input_event
*hold_quit
)
6878 /* Using KBD_BUFFER_SIZE - 1 here avoids reading more than
6879 the kbd_buffer can really hold. That may prevent loss
6880 of characters on some systems when input is stuffed at us. */
6881 unsigned char cbuf
[KBD_BUFFER_SIZE
- 1];
6883 struct tty_display_info
*tty
= terminal
->display_info
.tty
;
6886 int buffer_free
= KBD_BUFFER_SIZE
- kbd_buffer_nr_stored () - 1;
6888 if (kbd_on_hold_p () || buffer_free
<= 0)
6890 #endif /* subprocesses */
6892 if (!terminal
->name
) /* Don't read from a dead terminal. */
6895 if (terminal
->type
!= output_termcap
6896 && terminal
->type
!= output_msdos_raw
)
6899 /* XXX I think the following code should be moved to separate hook
6900 functions in system-dependent files. */
6903 #else /* not WINDOWSNT */
6904 if (! tty
->term_initted
) /* In case we get called during bootstrap. */
6908 return 0; /* The terminal is suspended. */
6911 n_to_read
= dos_keysns ();
6915 cbuf
[0] = dos_keyread ();
6918 #else /* not MSDOS */
6923 struct input_event gpm_hold_quit
;
6924 int gpm
, fd
= gpm_fd
;
6926 EVENT_INIT (gpm_hold_quit
);
6927 gpm_hold_quit
.kind
= NO_EVENT
;
6929 /* gpm==1 if event received.
6930 gpm==0 if the GPM daemon has closed the connection, in which case
6931 Gpm_GetEvent closes gpm_fd and clears it to -1, which is why
6932 we save it in `fd' so close_gpm can remove it from the
6934 gpm==-1 if a protocol error or EWOULDBLOCK; the latter is normal. */
6935 while (gpm
= Gpm_GetEvent (&event
), gpm
== 1) {
6936 nread
+= handle_one_term_event (tty
, &event
, &gpm_hold_quit
);
6939 /* Presumably the GPM daemon has closed the connection. */
6941 if (gpm_hold_quit
.kind
!= NO_EVENT
)
6942 kbd_buffer_store_event (&gpm_hold_quit
);
6946 #endif /* HAVE_GPM */
6948 /* Determine how many characters we should *try* to read. */
6949 #ifdef USABLE_FIONREAD
6950 /* Find out how much input is available. */
6951 if (ioctl (fileno (tty
->input
), FIONREAD
, &n_to_read
) < 0)
6953 if (! noninteractive
)
6954 return -2; /* Close this terminal. */
6960 if (n_to_read
> sizeof cbuf
)
6961 n_to_read
= sizeof cbuf
;
6962 #elif defined USG || defined CYGWIN
6963 /* Read some input if available, but don't wait. */
6964 n_to_read
= sizeof cbuf
;
6965 fcntl (fileno (tty
->input
), F_SETFL
, O_NDELAY
);
6967 # error "Cannot read without possibly delaying"
6971 /* Don't read more than we can store. */
6972 if (n_to_read
> buffer_free
)
6973 n_to_read
= buffer_free
;
6974 #endif /* subprocesses */
6976 /* Now read; for one reason or another, this will not block.
6977 NREAD is set to the number of chars read. */
6980 nread
= emacs_read (fileno (tty
->input
), (char *) cbuf
, n_to_read
);
6981 /* POSIX infers that processes which are not in the session leader's
6982 process group won't get SIGHUP's at logout time. BSDI adheres to
6983 this part standard and returns -1 from read (0) with errno==EIO
6984 when the control tty is taken away.
6985 Jeffrey Honig <jch@bsdi.com> says this is generally safe. */
6986 if (nread
== -1 && errno
== EIO
)
6987 return -2; /* Close this terminal. */
6988 #if defined (AIX) && defined (_BSD)
6989 /* The kernel sometimes fails to deliver SIGHUP for ptys.
6990 This looks incorrect, but it isn't, because _BSD causes
6991 O_NDELAY to be defined in fcntl.h as O_NONBLOCK,
6992 and that causes a value other than 0 when there is no input. */
6994 return -2; /* Close this terminal. */
6998 /* We used to retry the read if it was interrupted.
6999 But this does the wrong thing when O_NDELAY causes
7000 an EAGAIN error. Does anybody know of a situation
7001 where a retry is actually needed? */
7003 nread
< 0 && (errno
== EAGAIN
7016 #ifndef USABLE_FIONREAD
7017 #if defined (USG) || defined (CYGWIN)
7018 fcntl (fileno (tty
->input
), F_SETFL
, 0);
7019 #endif /* USG or CYGWIN */
7020 #endif /* no FIONREAD */
7025 #endif /* not MSDOS */
7026 #endif /* not WINDOWSNT */
7028 if (TERMINAL_KEYBOARD_CODING (terminal
)->common_flags
7029 & CODING_REQUIRE_DECODING_MASK
)
7031 struct coding_system
*coding
= TERMINAL_KEYBOARD_CODING (terminal
);
7034 /* Decode the key sequence except for those with meta
7036 for (i
= from
= 0; ; i
++)
7037 if (i
== nread
|| (tty
->meta_key
== 1 && (cbuf
[i
] & 0x80)))
7039 struct input_event buf
;
7041 decode_keyboard_code (tty
, coding
, cbuf
+ from
, i
- from
);
7046 buf
.kind
= ASCII_KEYSTROKE_EVENT
;
7047 buf
.modifiers
= meta_modifier
;
7048 buf
.code
= cbuf
[i
] & ~0x80;
7049 /* See the comment below. */
7050 buf
.frame_or_window
= tty
->top_frame
;
7052 kbd_buffer_store_event (&buf
);
7058 for (i
= 0; i
< nread
; i
++)
7060 struct input_event buf
;
7062 buf
.kind
= ASCII_KEYSTROKE_EVENT
;
7064 if (tty
->meta_key
== 1 && (cbuf
[i
] & 0x80))
7065 buf
.modifiers
= meta_modifier
;
7066 if (tty
->meta_key
!= 2)
7070 /* Set the frame corresponding to the active tty. Note that the
7071 value of selected_frame is not reliable here, redisplay tends
7072 to temporarily change it. */
7073 buf
.frame_or_window
= tty
->top_frame
;
7076 kbd_buffer_store_event (&buf
);
7077 /* Don't look at input that follows a C-g too closely.
7078 This reduces lossage due to autorepeat on C-g. */
7079 if (buf
.kind
== ASCII_KEYSTROKE_EVENT
7080 && buf
.code
== quit_char
)
7088 handle_async_input (void)
7093 int nread
= gobble_input ();
7094 /* -1 means it's not ok to read the input now.
7095 UNBLOCK_INPUT will read it later; now, avoid infinite loop.
7096 0 means there was no keyboard input available. */
7104 process_pending_signals (void)
7106 pending_signals
= 0;
7107 handle_async_input ();
7108 do_pending_atimers ();
7111 /* Undo any number of BLOCK_INPUT calls down to level LEVEL,
7112 and also (if the level is now 0) reinvoke any pending signal. */
7115 unblock_input_to (int level
)
7117 interrupt_input_blocked
= level
;
7120 if (pending_signals
)
7121 process_pending_signals ();
7127 /* End critical section.
7129 If doing signal-driven input, and a signal came in when input was
7130 blocked, reinvoke the signal handler now to deal with it. */
7133 unblock_input (void)
7135 unblock_input_to (interrupt_input_blocked
- 1);
7138 /* Undo any number of BLOCK_INPUT calls,
7139 and also reinvoke any pending signal. */
7142 totally_unblock_input (void)
7144 unblock_input_to (0);
7150 handle_input_available_signal (int sig
)
7152 pending_signals
= 1;
7154 if (input_available_clear_time
)
7155 *input_available_clear_time
= make_emacs_time (0, 0);
7159 deliver_input_available_signal (int sig
)
7161 deliver_process_signal (sig
, handle_input_available_signal
);
7163 #endif /* USABLE_SIGIO */
7166 /* User signal events. */
7168 struct user_signal_info
7170 /* Signal number. */
7173 /* Name of the signal. */
7176 /* Number of pending signals. */
7179 struct user_signal_info
*next
;
7182 /* List of user signals. */
7183 static struct user_signal_info
*user_signals
= NULL
;
7186 add_user_signal (int sig
, const char *name
)
7188 struct sigaction action
;
7189 struct user_signal_info
*p
;
7191 for (p
= user_signals
; p
; p
= p
->next
)
7193 /* Already added. */
7196 p
= xmalloc (sizeof *p
);
7198 p
->name
= xstrdup (name
);
7200 p
->next
= user_signals
;
7203 emacs_sigaction_init (&action
, deliver_user_signal
);
7204 sigaction (sig
, &action
, 0);
7208 handle_user_signal (int sig
)
7210 struct user_signal_info
*p
;
7211 const char *special_event_name
= NULL
;
7213 if (SYMBOLP (Vdebug_on_event
))
7214 special_event_name
= SSDATA (SYMBOL_NAME (Vdebug_on_event
));
7216 for (p
= user_signals
; p
; p
= p
->next
)
7219 if (special_event_name
7220 && strcmp (special_event_name
, p
->name
) == 0)
7222 /* Enter the debugger in many ways. */
7223 debug_on_next_call
= 1;
7226 Vinhibit_quit
= Qnil
;
7228 /* Eat the event. */
7234 if (interrupt_input
)
7235 handle_input_available_signal (sig
);
7239 /* Tell wait_reading_process_output that it needs to wake
7240 up and look around. */
7241 if (input_available_clear_time
)
7242 *input_available_clear_time
= make_emacs_time (0, 0);
7249 deliver_user_signal (int sig
)
7251 deliver_process_signal (sig
, handle_user_signal
);
7255 find_user_signal_name (int sig
)
7257 struct user_signal_info
*p
;
7259 for (p
= user_signals
; p
; p
= p
->next
)
7267 store_user_signal_events (void)
7269 struct user_signal_info
*p
;
7270 struct input_event buf
;
7271 bool buf_initialized
= 0;
7273 for (p
= user_signals
; p
; p
= p
->next
)
7274 if (p
->npending
> 0)
7276 if (! buf_initialized
)
7278 memset (&buf
, 0, sizeof buf
);
7279 buf
.kind
= USER_SIGNAL_EVENT
;
7280 buf
.frame_or_window
= selected_frame
;
7281 buf_initialized
= 1;
7287 kbd_buffer_store_event (&buf
);
7290 while (p
->npending
> 0);
7295 static void menu_bar_item (Lisp_Object
, Lisp_Object
, Lisp_Object
, void*);
7296 static Lisp_Object menu_bar_one_keymap_changed_items
;
7298 /* These variables hold the vector under construction within
7299 menu_bar_items and its subroutines, and the current index
7300 for storing into that vector. */
7301 static Lisp_Object menu_bar_items_vector
;
7302 static int menu_bar_items_index
;
7305 static const char* separator_names
[] = {
7310 "single-dashed-line",
7311 "double-dashed-line",
7313 "shadow-etched-out",
7314 "shadow-etched-in-dash",
7315 "shadow-etched-out-dash",
7316 "shadow-double-etched-in",
7317 "shadow-double-etched-out",
7318 "shadow-double-etched-in-dash",
7319 "shadow-double-etched-out-dash",
7323 /* Return true if LABEL specifies a separator. */
7326 menu_separator_name_p (const char *label
)
7330 else if (strlen (label
) > 3
7331 && memcmp (label
, "--", 2) == 0
7336 for (i
= 0; separator_names
[i
]; ++i
)
7337 if (strcmp (label
, separator_names
[i
]) == 0)
7342 /* It's a separator if it contains only dashes. */
7343 while (*label
== '-')
7345 return (*label
== 0);
7352 /* Return a vector of menu items for a menu bar, appropriate
7353 to the current buffer. Each item has three elements in the vector:
7356 OLD is an old vector we can optionally reuse, or nil. */
7359 menu_bar_items (Lisp_Object old
)
7361 /* The number of keymaps we're scanning right now, and the number of
7362 keymaps we have allocated space for. */
7365 /* maps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
7366 in the current keymaps, or nil where it is not a prefix. */
7369 Lisp_Object def
, tail
;
7374 /* In order to build the menus, we need to call the keymap
7375 accessors. They all call QUIT. But this function is called
7376 during redisplay, during which a quit is fatal. So inhibit
7377 quitting while building the menus.
7378 We do this instead of specbind because (1) errors will clear it anyway
7379 and (2) this avoids risk of specpdl overflow. */
7380 oquit
= Vinhibit_quit
;
7384 menu_bar_items_vector
= old
;
7386 menu_bar_items_vector
= Fmake_vector (make_number (24), Qnil
);
7387 menu_bar_items_index
= 0;
7389 /* Build our list of keymaps.
7390 If we recognize a function key and replace its escape sequence in
7391 keybuf with its symbol, or if the sequence starts with a mouse
7392 click and we need to switch buffers, we jump back here to rebuild
7393 the initial keymaps from the current buffer. */
7397 /* Should overriding-terminal-local-map and overriding-local-map apply? */
7398 if (!NILP (Voverriding_local_map_menu_flag
))
7400 /* Yes, use them (if non-nil) as well as the global map. */
7401 maps
= alloca (3 * sizeof (maps
[0]));
7403 if (!NILP (KVAR (current_kboard
, Voverriding_terminal_local_map
)))
7404 maps
[nmaps
++] = KVAR (current_kboard
, Voverriding_terminal_local_map
);
7405 if (!NILP (Voverriding_local_map
))
7406 maps
[nmaps
++] = Voverriding_local_map
;
7410 /* No, so use major and minor mode keymaps and keymap property.
7411 Note that menu-bar bindings in the local-map and keymap
7412 properties may not work reliable, as they are only
7413 recognized when the menu-bar (or mode-line) is updated,
7414 which does not normally happen after every command. */
7417 nminor
= current_minor_maps (NULL
, &tmaps
);
7418 maps
= alloca ((nminor
+ 3) * sizeof *maps
);
7420 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
7421 maps
[nmaps
++] = tem
;
7422 memcpy (maps
+ nmaps
, tmaps
, nminor
* sizeof (maps
[0]));
7424 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
7426 maps
[nmaps
++] = current_global_map
;
7429 /* Look up in each map the dummy prefix key `menu-bar'. */
7431 for (mapno
= nmaps
- 1; mapno
>= 0; mapno
--)
7432 if (!NILP (maps
[mapno
]))
7434 def
= get_keymap (access_keymap (maps
[mapno
], Qmenu_bar
, 1, 0, 1),
7438 menu_bar_one_keymap_changed_items
= Qnil
;
7439 map_keymap_canonical (def
, menu_bar_item
, Qnil
, NULL
);
7443 /* Move to the end those items that should be at the end. */
7445 for (tail
= Vmenu_bar_final_items
; CONSP (tail
); tail
= XCDR (tail
))
7448 int end
= menu_bar_items_index
;
7450 for (i
= 0; i
< end
; i
+= 4)
7451 if (EQ (XCAR (tail
), AREF (menu_bar_items_vector
, i
)))
7453 Lisp_Object tem0
, tem1
, tem2
, tem3
;
7454 /* Move the item at index I to the end,
7455 shifting all the others forward. */
7456 tem0
= AREF (menu_bar_items_vector
, i
+ 0);
7457 tem1
= AREF (menu_bar_items_vector
, i
+ 1);
7458 tem2
= AREF (menu_bar_items_vector
, i
+ 2);
7459 tem3
= AREF (menu_bar_items_vector
, i
+ 3);
7461 memmove (aref_addr (menu_bar_items_vector
, i
),
7462 aref_addr (menu_bar_items_vector
, i
+ 4),
7463 (end
- i
- 4) * word_size
);
7464 ASET (menu_bar_items_vector
, end
- 4, tem0
);
7465 ASET (menu_bar_items_vector
, end
- 3, tem1
);
7466 ASET (menu_bar_items_vector
, end
- 2, tem2
);
7467 ASET (menu_bar_items_vector
, end
- 1, tem3
);
7472 /* Add nil, nil, nil, nil at the end. */
7474 int i
= menu_bar_items_index
;
7475 if (i
+ 4 > ASIZE (menu_bar_items_vector
))
7476 menu_bar_items_vector
=
7477 larger_vector (menu_bar_items_vector
, 4, -1);
7478 /* Add this item. */
7479 ASET (menu_bar_items_vector
, i
, Qnil
); i
++;
7480 ASET (menu_bar_items_vector
, i
, Qnil
); i
++;
7481 ASET (menu_bar_items_vector
, i
, Qnil
); i
++;
7482 ASET (menu_bar_items_vector
, i
, Qnil
); i
++;
7483 menu_bar_items_index
= i
;
7486 Vinhibit_quit
= oquit
;
7487 return menu_bar_items_vector
;
7490 /* Add one item to menu_bar_items_vector, for KEY, ITEM_STRING and DEF.
7491 If there's already an item for KEY, add this DEF to it. */
7493 Lisp_Object item_properties
;
7496 menu_bar_item (Lisp_Object key
, Lisp_Object item
, Lisp_Object dummy1
, void *dummy2
)
7498 struct gcpro gcpro1
;
7503 if (EQ (item
, Qundefined
))
7505 /* If a map has an explicit `undefined' as definition,
7506 discard any previously made menu bar item. */
7508 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7509 if (EQ (key
, AREF (menu_bar_items_vector
, i
)))
7511 if (menu_bar_items_index
> i
+ 4)
7512 memmove (aref_addr (menu_bar_items_vector
, i
),
7513 aref_addr (menu_bar_items_vector
, i
+ 4),
7514 (menu_bar_items_index
- i
- 4) * word_size
);
7515 menu_bar_items_index
-= 4;
7519 /* If this keymap has already contributed to this KEY,
7520 don't contribute to it a second time. */
7521 tem
= Fmemq (key
, menu_bar_one_keymap_changed_items
);
7522 if (!NILP (tem
) || NILP (item
))
7525 menu_bar_one_keymap_changed_items
7526 = Fcons (key
, menu_bar_one_keymap_changed_items
);
7528 /* We add to menu_bar_one_keymap_changed_items before doing the
7529 parse_menu_item, so that if it turns out it wasn't a menu item,
7530 it still correctly hides any further menu item. */
7532 parsed
= parse_menu_item (item
, 1);
7537 item
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7539 /* Find any existing item for this KEY. */
7540 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7541 if (EQ (key
, AREF (menu_bar_items_vector
, i
)))
7544 /* If we did not find this KEY, add it at the end. */
7545 if (i
== menu_bar_items_index
)
7547 /* If vector is too small, get a bigger one. */
7548 if (i
+ 4 > ASIZE (menu_bar_items_vector
))
7549 menu_bar_items_vector
= larger_vector (menu_bar_items_vector
, 4, -1);
7550 /* Add this item. */
7551 ASET (menu_bar_items_vector
, i
, key
); i
++;
7552 ASET (menu_bar_items_vector
, i
,
7553 AREF (item_properties
, ITEM_PROPERTY_NAME
)); i
++;
7554 ASET (menu_bar_items_vector
, i
, Fcons (item
, Qnil
)); i
++;
7555 ASET (menu_bar_items_vector
, i
, make_number (0)); i
++;
7556 menu_bar_items_index
= i
;
7558 /* We did find an item for this KEY. Add ITEM to its list of maps. */
7562 old
= AREF (menu_bar_items_vector
, i
+ 2);
7563 /* If the new and the old items are not both keymaps,
7564 the lookup will only find `item'. */
7565 item
= Fcons (item
, KEYMAPP (item
) && KEYMAPP (XCAR (old
)) ? old
: Qnil
);
7566 ASET (menu_bar_items_vector
, i
+ 2, item
);
7570 /* This is used as the handler when calling menu_item_eval_property. */
7572 menu_item_eval_property_1 (Lisp_Object arg
)
7574 /* If we got a quit from within the menu computation,
7575 quit all the way out of it. This takes care of C-] in the debugger. */
7576 if (CONSP (arg
) && EQ (XCAR (arg
), Qquit
))
7577 Fsignal (Qquit
, Qnil
);
7583 eval_dyn (Lisp_Object form
)
7585 return Feval (form
, Qnil
);
7588 /* Evaluate an expression and return the result (or nil if something
7589 went wrong). Used to evaluate dynamic parts of menu items. */
7591 menu_item_eval_property (Lisp_Object sexpr
)
7593 ptrdiff_t count
= SPECPDL_INDEX ();
7595 specbind (Qinhibit_redisplay
, Qt
);
7596 val
= internal_condition_case_1 (eval_dyn
, sexpr
, Qerror
,
7597 menu_item_eval_property_1
);
7598 return unbind_to (count
, val
);
7601 /* This function parses a menu item and leaves the result in the
7602 vector item_properties.
7603 ITEM is a key binding, a possible menu item.
7604 INMENUBAR is > 0 when this is considered for an entry in a menu bar
7606 INMENUBAR is < 0 when this is considered for an entry in a keyboard menu.
7607 parse_menu_item returns true if the item is a menu item and false
7611 parse_menu_item (Lisp_Object item
, int inmenubar
)
7613 Lisp_Object def
, tem
, item_string
, start
;
7615 Lisp_Object keyhint
;
7624 /* Create item_properties vector if necessary. */
7625 if (NILP (item_properties
))
7627 = Fmake_vector (make_number (ITEM_PROPERTY_ENABLE
+ 1), Qnil
);
7629 /* Initialize optional entries. */
7630 for (i
= ITEM_PROPERTY_DEF
; i
< ITEM_PROPERTY_ENABLE
; i
++)
7631 ASET (item_properties
, i
, Qnil
);
7632 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7634 /* Save the item here to protect it from GC. */
7635 ASET (item_properties
, ITEM_PROPERTY_ITEM
, item
);
7637 item_string
= XCAR (item
);
7641 if (STRINGP (item_string
))
7643 /* Old format menu item. */
7644 ASET (item_properties
, ITEM_PROPERTY_NAME
, item_string
);
7646 /* Maybe help string. */
7647 if (CONSP (item
) && STRINGP (XCAR (item
)))
7649 ASET (item_properties
, ITEM_PROPERTY_HELP
, XCAR (item
));
7654 /* Maybe an obsolete key binding cache. */
7655 if (CONSP (item
) && CONSP (XCAR (item
))
7656 && (NILP (XCAR (XCAR (item
)))
7657 || VECTORP (XCAR (XCAR (item
)))))
7660 /* This is the real definition--the function to run. */
7661 ASET (item_properties
, ITEM_PROPERTY_DEF
, item
);
7663 /* Get enable property, if any. */
7666 tem
= Fget (item
, Qmenu_enable
);
7667 if (!NILP (Venable_disabled_menus_and_buttons
))
7668 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7669 else if (!NILP (tem
))
7670 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, tem
);
7673 else if (EQ (item_string
, Qmenu_item
) && CONSP (item
))
7675 /* New format menu item. */
7676 ASET (item_properties
, ITEM_PROPERTY_NAME
, XCAR (item
));
7677 start
= XCDR (item
);
7680 /* We have a real binding. */
7681 ASET (item_properties
, ITEM_PROPERTY_DEF
, XCAR (start
));
7683 item
= XCDR (start
);
7684 /* Is there an obsolete cache list with key equivalences. */
7685 if (CONSP (item
) && CONSP (XCAR (item
)))
7688 /* Parse properties. */
7689 while (CONSP (item
) && CONSP (XCDR (item
)))
7694 if (EQ (tem
, QCenable
))
7696 if (!NILP (Venable_disabled_menus_and_buttons
))
7697 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7699 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, XCAR (item
));
7701 else if (EQ (tem
, QCvisible
))
7703 /* If got a visible property and that evaluates to nil
7704 then ignore this item. */
7705 tem
= menu_item_eval_property (XCAR (item
));
7709 else if (EQ (tem
, QChelp
))
7710 ASET (item_properties
, ITEM_PROPERTY_HELP
, XCAR (item
));
7711 else if (EQ (tem
, QCfilter
))
7713 else if (EQ (tem
, QCkey_sequence
))
7716 if (SYMBOLP (tem
) || STRINGP (tem
) || VECTORP (tem
))
7717 /* Be GC protected. Set keyhint to item instead of tem. */
7720 else if (EQ (tem
, QCkeys
))
7723 if (CONSP (tem
) || STRINGP (tem
))
7724 ASET (item_properties
, ITEM_PROPERTY_KEYEQ
, tem
);
7726 else if (EQ (tem
, QCbutton
) && CONSP (XCAR (item
)))
7731 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
7733 ASET (item_properties
, ITEM_PROPERTY_SELECTED
,
7735 ASET (item_properties
, ITEM_PROPERTY_TYPE
, type
);
7741 else if (inmenubar
|| !NILP (start
))
7745 return 0; /* not a menu item */
7747 /* If item string is not a string, evaluate it to get string.
7748 If we don't get a string, skip this item. */
7749 item_string
= AREF (item_properties
, ITEM_PROPERTY_NAME
);
7750 if (!(STRINGP (item_string
)))
7752 item_string
= menu_item_eval_property (item_string
);
7753 if (!STRINGP (item_string
))
7755 ASET (item_properties
, ITEM_PROPERTY_NAME
, item_string
);
7758 /* If got a filter apply it on definition. */
7759 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7762 def
= menu_item_eval_property (list2 (XCAR (filter
),
7763 list2 (Qquote
, def
)));
7765 ASET (item_properties
, ITEM_PROPERTY_DEF
, def
);
7768 /* Enable or disable selection of item. */
7769 tem
= AREF (item_properties
, ITEM_PROPERTY_ENABLE
);
7772 tem
= menu_item_eval_property (tem
);
7773 if (inmenubar
&& NILP (tem
))
7774 return 0; /* Ignore disabled items in menu bar. */
7775 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, tem
);
7778 /* If we got no definition, this item is just unselectable text which
7779 is OK in a submenu but not in the menubar. */
7781 return (!inmenubar
);
7783 /* See if this is a separate pane or a submenu. */
7784 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7785 tem
= get_keymap (def
, 0, 1);
7786 /* For a subkeymap, just record its details and exit. */
7789 ASET (item_properties
, ITEM_PROPERTY_MAP
, tem
);
7790 ASET (item_properties
, ITEM_PROPERTY_DEF
, tem
);
7794 /* At the top level in the menu bar, do likewise for commands also.
7795 The menu bar does not display equivalent key bindings anyway.
7796 ITEM_PROPERTY_DEF is already set up properly. */
7800 { /* This is a command. See if there is an equivalent key binding. */
7801 Lisp_Object keyeq
= AREF (item_properties
, ITEM_PROPERTY_KEYEQ
);
7803 /* The previous code preferred :key-sequence to :keys, so we
7804 preserve this behavior. */
7805 if (STRINGP (keyeq
) && !CONSP (keyhint
))
7806 keyeq
= concat2 (build_string (" "), Fsubstitute_command_keys (keyeq
));
7809 Lisp_Object prefix
= keyeq
;
7810 Lisp_Object keys
= Qnil
;
7814 def
= XCAR (prefix
);
7815 prefix
= XCDR (prefix
);
7818 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7820 if (CONSP (keyhint
) && !NILP (XCAR (keyhint
)))
7822 keys
= XCAR (keyhint
);
7823 tem
= Fkey_binding (keys
, Qnil
, Qnil
, Qnil
);
7825 /* We have a suggested key. Is it bound to the command? */
7828 /* If the command is an alias for another
7829 (such as lmenu.el set it up), check if the
7830 original command matches the cached command. */
7832 && EQ (tem
, XSYMBOL (def
)->function
))))
7837 keys
= Fwhere_is_internal (def
, Qnil
, Qt
, Qnil
, Qnil
);
7841 tem
= Fkey_description (keys
, Qnil
);
7844 if (STRINGP (XCAR (prefix
)))
7845 tem
= concat2 (XCAR (prefix
), tem
);
7846 if (STRINGP (XCDR (prefix
)))
7847 tem
= concat2 (tem
, XCDR (prefix
));
7849 keyeq
= concat2 (build_string (" "), tem
);
7850 /* keyeq = concat3(build_string(" ("),tem,build_string(")")); */
7856 /* If we have an equivalent key binding, use that. */
7857 ASET (item_properties
, ITEM_PROPERTY_KEYEQ
, keyeq
);
7860 /* Include this when menu help is implemented.
7861 tem = XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP];
7862 if (!(NILP (tem) || STRINGP (tem)))
7864 tem = menu_item_eval_property (tem);
7867 XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP] = tem;
7871 /* Handle radio buttons or toggle boxes. */
7872 tem
= AREF (item_properties
, ITEM_PROPERTY_SELECTED
);
7874 ASET (item_properties
, ITEM_PROPERTY_SELECTED
,
7875 menu_item_eval_property (tem
));
7882 /***********************************************************************
7884 ***********************************************************************/
7886 /* A vector holding tool bar items while they are parsed in function
7887 tool_bar_items. Each item occupies TOOL_BAR_ITEM_NSCLOTS elements
7890 static Lisp_Object tool_bar_items_vector
;
7892 /* A vector holding the result of parse_tool_bar_item. Layout is like
7893 the one for a single item in tool_bar_items_vector. */
7895 static Lisp_Object tool_bar_item_properties
;
7897 /* Next free index in tool_bar_items_vector. */
7899 static int ntool_bar_items
;
7901 /* The symbols `:image' and `:rtl'. */
7903 static Lisp_Object QCimage
;
7904 static Lisp_Object QCrtl
;
7906 /* Function prototypes. */
7908 static void init_tool_bar_items (Lisp_Object
);
7909 static void process_tool_bar_item (Lisp_Object
, Lisp_Object
, Lisp_Object
, void*);
7910 static bool parse_tool_bar_item (Lisp_Object
, Lisp_Object
);
7911 static void append_tool_bar_item (void);
7914 /* Return a vector of tool bar items for keymaps currently in effect.
7915 Reuse vector REUSE if non-nil. Return in *NITEMS the number of
7916 tool bar items found. */
7919 tool_bar_items (Lisp_Object reuse
, int *nitems
)
7928 /* In order to build the menus, we need to call the keymap
7929 accessors. They all call QUIT. But this function is called
7930 during redisplay, during which a quit is fatal. So inhibit
7931 quitting while building the menus. We do this instead of
7932 specbind because (1) errors will clear it anyway and (2) this
7933 avoids risk of specpdl overflow. */
7934 oquit
= Vinhibit_quit
;
7937 /* Initialize tool_bar_items_vector and protect it from GC. */
7938 init_tool_bar_items (reuse
);
7940 /* Build list of keymaps in maps. Set nmaps to the number of maps
7943 /* Should overriding-terminal-local-map and overriding-local-map apply? */
7944 if (!NILP (Voverriding_local_map_menu_flag
))
7946 /* Yes, use them (if non-nil) as well as the global map. */
7947 maps
= alloca (3 * sizeof *maps
);
7949 if (!NILP (KVAR (current_kboard
, Voverriding_terminal_local_map
)))
7950 maps
[nmaps
++] = KVAR (current_kboard
, Voverriding_terminal_local_map
);
7951 if (!NILP (Voverriding_local_map
))
7952 maps
[nmaps
++] = Voverriding_local_map
;
7956 /* No, so use major and minor mode keymaps and keymap property.
7957 Note that tool-bar bindings in the local-map and keymap
7958 properties may not work reliable, as they are only
7959 recognized when the tool-bar (or mode-line) is updated,
7960 which does not normally happen after every command. */
7963 nminor
= current_minor_maps (NULL
, &tmaps
);
7964 maps
= alloca ((nminor
+ 3) * sizeof *maps
);
7966 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
7967 maps
[nmaps
++] = tem
;
7968 memcpy (maps
+ nmaps
, tmaps
, nminor
* sizeof (maps
[0]));
7970 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
7973 /* Add global keymap at the end. */
7974 maps
[nmaps
++] = current_global_map
;
7976 /* Process maps in reverse order and look up in each map the prefix
7978 for (i
= nmaps
- 1; i
>= 0; --i
)
7979 if (!NILP (maps
[i
]))
7983 keymap
= get_keymap (access_keymap (maps
[i
], Qtool_bar
, 1, 0, 1), 0, 1);
7985 map_keymap (keymap
, process_tool_bar_item
, Qnil
, NULL
, 1);
7988 Vinhibit_quit
= oquit
;
7989 *nitems
= ntool_bar_items
/ TOOL_BAR_ITEM_NSLOTS
;
7990 return tool_bar_items_vector
;
7994 /* Process the definition of KEY which is DEF. */
7997 process_tool_bar_item (Lisp_Object key
, Lisp_Object def
, Lisp_Object data
, void *args
)
8000 struct gcpro gcpro1
, gcpro2
;
8002 /* Protect KEY and DEF from GC because parse_tool_bar_item may call
8006 if (EQ (def
, Qundefined
))
8008 /* If a map has an explicit `undefined' as definition,
8009 discard any previously made item. */
8010 for (i
= 0; i
< ntool_bar_items
; i
+= TOOL_BAR_ITEM_NSLOTS
)
8012 Lisp_Object
*v
= XVECTOR (tool_bar_items_vector
)->contents
+ i
;
8014 if (EQ (key
, v
[TOOL_BAR_ITEM_KEY
]))
8016 if (ntool_bar_items
> i
+ TOOL_BAR_ITEM_NSLOTS
)
8017 memmove (v
, v
+ TOOL_BAR_ITEM_NSLOTS
,
8018 ((ntool_bar_items
- i
- TOOL_BAR_ITEM_NSLOTS
)
8020 ntool_bar_items
-= TOOL_BAR_ITEM_NSLOTS
;
8025 else if (parse_tool_bar_item (key
, def
))
8026 /* Append a new tool bar item to tool_bar_items_vector. Accept
8027 more than one definition for the same key. */
8028 append_tool_bar_item ();
8033 /* Access slot with index IDX of vector tool_bar_item_properties. */
8034 #define PROP(IDX) AREF (tool_bar_item_properties, (IDX))
8036 set_prop (ptrdiff_t idx
, Lisp_Object val
)
8038 ASET (tool_bar_item_properties
, idx
, val
);
8042 /* Parse a tool bar item specification ITEM for key KEY and return the
8043 result in tool_bar_item_properties. Value is false if ITEM is
8046 ITEM is a list `(menu-item CAPTION BINDING PROPS...)'.
8048 CAPTION is the caption of the item, If it's not a string, it is
8049 evaluated to get a string.
8051 BINDING is the tool bar item's binding. Tool-bar items with keymaps
8052 as binding are currently ignored.
8054 The following properties are recognized:
8058 FORM is evaluated and specifies whether the tool bar item is
8059 enabled or disabled.
8063 FORM is evaluated and specifies whether the tool bar item is visible.
8065 - `:filter FUNCTION'
8067 FUNCTION is invoked with one parameter `(quote BINDING)'. Its
8068 result is stored as the new binding.
8070 - `:button (TYPE SELECTED)'
8072 TYPE must be one of `:radio' or `:toggle'. SELECTED is evaluated
8073 and specifies whether the button is selected (pressed) or not.
8077 IMAGES is either a single image specification or a vector of four
8078 image specifications. See enum tool_bar_item_images.
8080 - `:help HELP-STRING'.
8082 Gives a help string to display for the tool bar item.
8084 - `:label LABEL-STRING'.
8086 A text label to show with the tool bar button if labels are enabled. */
8089 parse_tool_bar_item (Lisp_Object key
, Lisp_Object item
)
8091 Lisp_Object filter
= Qnil
;
8092 Lisp_Object caption
;
8094 bool have_label
= 0;
8096 /* Definition looks like `(menu-item CAPTION BINDING PROPS...)'.
8097 Rule out items that aren't lists, don't start with
8098 `menu-item' or whose rest following `tool-bar-item' is not a
8103 /* As an exception, allow old-style menu separators. */
8104 if (STRINGP (XCAR (item
)))
8105 item
= Fcons (XCAR (item
), Qnil
);
8106 else if (!EQ (XCAR (item
), Qmenu_item
)
8107 || (item
= XCDR (item
), !CONSP (item
)))
8110 /* Create tool_bar_item_properties vector if necessary. Reset it to
8112 if (VECTORP (tool_bar_item_properties
))
8114 for (i
= 0; i
< TOOL_BAR_ITEM_NSLOTS
; ++i
)
8118 tool_bar_item_properties
8119 = Fmake_vector (make_number (TOOL_BAR_ITEM_NSLOTS
), Qnil
);
8122 set_prop (TOOL_BAR_ITEM_KEY
, key
);
8123 set_prop (TOOL_BAR_ITEM_ENABLED_P
, Qt
);
8125 /* Get the caption of the item. If the caption is not a string,
8126 evaluate it to get a string. If we don't get a string, skip this
8128 caption
= XCAR (item
);
8129 if (!STRINGP (caption
))
8131 caption
= menu_item_eval_property (caption
);
8132 if (!STRINGP (caption
))
8135 set_prop (TOOL_BAR_ITEM_CAPTION
, caption
);
8137 /* If the rest following the caption is not a list, the menu item is
8138 either a separator, or invalid. */
8142 if (menu_separator_name_p (SSDATA (caption
)))
8144 set_prop (TOOL_BAR_ITEM_TYPE
, Qt
);
8145 #if !defined (USE_GTK) && !defined (HAVE_NS)
8146 /* If we use build_desired_tool_bar_string to render the
8147 tool bar, the separator is rendered as an image. */
8148 PROP (TOOL_BAR_ITEM_IMAGES
)
8149 = menu_item_eval_property (Vtool_bar_separator_image_expression
);
8150 PROP (TOOL_BAR_ITEM_ENABLED_P
) = Qnil
;
8151 PROP (TOOL_BAR_ITEM_SELECTED_P
) = Qnil
;
8152 PROP (TOOL_BAR_ITEM_CAPTION
) = Qnil
;
8159 /* Store the binding. */
8160 set_prop (TOOL_BAR_ITEM_BINDING
, XCAR (item
));
8163 /* Ignore cached key binding, if any. */
8164 if (CONSP (item
) && CONSP (XCAR (item
)))
8167 /* Process the rest of the properties. */
8168 for (; CONSP (item
) && CONSP (XCDR (item
)); item
= XCDR (XCDR (item
)))
8170 Lisp_Object ikey
, value
;
8173 value
= XCAR (XCDR (item
));
8175 if (EQ (ikey
, QCenable
))
8177 /* `:enable FORM'. */
8178 if (!NILP (Venable_disabled_menus_and_buttons
))
8179 set_prop (TOOL_BAR_ITEM_ENABLED_P
, Qt
);
8181 set_prop (TOOL_BAR_ITEM_ENABLED_P
, value
);
8183 else if (EQ (ikey
, QCvisible
))
8185 /* `:visible FORM'. If got a visible property and that
8186 evaluates to nil then ignore this item. */
8187 if (NILP (menu_item_eval_property (value
)))
8190 else if (EQ (ikey
, QChelp
))
8191 /* `:help HELP-STRING'. */
8192 set_prop (TOOL_BAR_ITEM_HELP
, value
);
8193 else if (EQ (ikey
, QCvert_only
))
8194 /* `:vert-only t/nil'. */
8195 set_prop (TOOL_BAR_ITEM_VERT_ONLY
, value
);
8196 else if (EQ (ikey
, QClabel
))
8198 const char *bad_label
= "!!?GARBLED ITEM?!!";
8199 /* `:label LABEL-STRING'. */
8200 set_prop (TOOL_BAR_ITEM_LABEL
,
8201 STRINGP (value
) ? value
: build_string (bad_label
));
8204 else if (EQ (ikey
, QCfilter
))
8205 /* ':filter FORM'. */
8207 else if (EQ (ikey
, QCbutton
) && CONSP (value
))
8209 /* `:button (TYPE . SELECTED)'. */
8210 Lisp_Object type
, selected
;
8212 type
= XCAR (value
);
8213 selected
= XCDR (value
);
8214 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
8216 set_prop (TOOL_BAR_ITEM_SELECTED_P
, selected
);
8217 set_prop (TOOL_BAR_ITEM_TYPE
, type
);
8220 else if (EQ (ikey
, QCimage
)
8222 || (VECTORP (value
) && ASIZE (value
) == 4)))
8223 /* Value is either a single image specification or a vector
8224 of 4 such specifications for the different button states. */
8225 set_prop (TOOL_BAR_ITEM_IMAGES
, value
);
8226 else if (EQ (ikey
, QCrtl
))
8228 set_prop (TOOL_BAR_ITEM_RTL_IMAGE
, value
);
8234 /* Try to make one from caption and key. */
8235 Lisp_Object tkey
= PROP (TOOL_BAR_ITEM_KEY
);
8236 Lisp_Object tcapt
= PROP (TOOL_BAR_ITEM_CAPTION
);
8237 const char *label
= SYMBOLP (tkey
) ? SSDATA (SYMBOL_NAME (tkey
)) : "";
8238 const char *capt
= STRINGP (tcapt
) ? SSDATA (tcapt
) : "";
8240 2 * max (0, min (tool_bar_max_label_size
, STRING_BYTES_BOUND
/ 2));
8241 char *buf
= xmalloc (max_lbl
+ 1);
8242 Lisp_Object new_lbl
;
8243 ptrdiff_t caption_len
= strlen (capt
);
8245 if (caption_len
<= max_lbl
&& capt
[0] != '\0')
8248 while (caption_len
> 0 && buf
[caption_len
- 1] == '.')
8250 buf
[caption_len
] = '\0';
8254 if (strlen (label
) <= max_lbl
&& label
[0] != '\0')
8258 strcpy (buf
, label
);
8260 for (j
= 0; buf
[j
] != '\0'; ++j
)
8268 new_lbl
= Fupcase_initials (build_string (label
));
8269 if (SCHARS (new_lbl
) <= tool_bar_max_label_size
)
8270 set_prop (TOOL_BAR_ITEM_LABEL
, new_lbl
);
8272 set_prop (TOOL_BAR_ITEM_LABEL
, empty_unibyte_string
);
8276 /* If got a filter apply it on binding. */
8278 set_prop (TOOL_BAR_ITEM_BINDING
,
8279 (menu_item_eval_property
8282 PROP (TOOL_BAR_ITEM_BINDING
))))));
8284 /* See if the binding is a keymap. Give up if it is. */
8285 if (CONSP (get_keymap (PROP (TOOL_BAR_ITEM_BINDING
), 0, 1)))
8288 /* Enable or disable selection of item. */
8289 if (!EQ (PROP (TOOL_BAR_ITEM_ENABLED_P
), Qt
))
8290 set_prop (TOOL_BAR_ITEM_ENABLED_P
,
8291 menu_item_eval_property (PROP (TOOL_BAR_ITEM_ENABLED_P
)));
8293 /* Handle radio buttons or toggle boxes. */
8294 if (!NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
)))
8295 set_prop (TOOL_BAR_ITEM_SELECTED_P
,
8296 menu_item_eval_property (PROP (TOOL_BAR_ITEM_SELECTED_P
)));
8304 /* Initialize tool_bar_items_vector. REUSE, if non-nil, is a vector
8305 that can be reused. */
8308 init_tool_bar_items (Lisp_Object reuse
)
8310 if (VECTORP (reuse
))
8311 tool_bar_items_vector
= reuse
;
8313 tool_bar_items_vector
= Fmake_vector (make_number (64), Qnil
);
8314 ntool_bar_items
= 0;
8318 /* Append parsed tool bar item properties from
8319 tool_bar_item_properties */
8322 append_tool_bar_item (void)
8326 - (ASIZE (tool_bar_items_vector
) - TOOL_BAR_ITEM_NSLOTS
));
8328 /* Enlarge tool_bar_items_vector if necessary. */
8330 tool_bar_items_vector
8331 = larger_vector (tool_bar_items_vector
, incr
, -1);
8333 /* Append entries from tool_bar_item_properties to the end of
8334 tool_bar_items_vector. */
8335 vcopy (tool_bar_items_vector
, ntool_bar_items
,
8336 XVECTOR (tool_bar_item_properties
)->contents
, TOOL_BAR_ITEM_NSLOTS
);
8337 ntool_bar_items
+= TOOL_BAR_ITEM_NSLOTS
;
8344 /* Read a character using menus based on maps in the array MAPS.
8345 NMAPS is the length of MAPS. Return nil if there are no menus in the maps.
8346 Return t if we displayed a menu but the user rejected it.
8348 PREV_EVENT is the previous input event, or nil if we are reading
8349 the first event of a key sequence.
8351 If USED_MOUSE_MENU is non-null, set *USED_MOUSE_MENU to true
8352 if we used a mouse menu to read the input, or false otherwise. If
8353 USED_MOUSE_MENU is null, don't dereference it.
8355 The prompting is done based on the prompt-string of the map
8356 and the strings associated with various map elements.
8358 This can be done with X menus or with menus put in the minibuf.
8359 These are done in different ways, depending on how the input will be read.
8360 Menus using X are done after auto-saving in read-char, getting the input
8361 event from Fx_popup_menu; menus using the minibuf use read_char recursively
8362 and do auto-saving in the inner call of read_char. */
8365 read_char_x_menu_prompt (ptrdiff_t nmaps
, Lisp_Object
*maps
,
8366 Lisp_Object prev_event
, bool *used_mouse_menu
)
8372 if (used_mouse_menu
)
8373 *used_mouse_menu
= 0;
8375 /* Use local over global Menu maps */
8377 if (! menu_prompting
)
8380 /* Optionally disregard all but the global map. */
8381 if (inhibit_local_menu_bar_menus
)
8383 maps
+= (nmaps
- 1);
8388 /* If we got to this point via a mouse click,
8389 use a real menu for mouse selection. */
8390 if (EVENT_HAS_PARAMETERS (prev_event
)
8391 && !EQ (XCAR (prev_event
), Qmenu_bar
)
8392 && !EQ (XCAR (prev_event
), Qtool_bar
))
8394 /* Display the menu and get the selection. */
8395 Lisp_Object
*realmaps
= alloca (nmaps
* sizeof *realmaps
);
8397 ptrdiff_t nmaps1
= 0;
8399 /* Use the maps that are not nil. */
8400 for (mapno
= 0; mapno
< nmaps
; mapno
++)
8401 if (!NILP (maps
[mapno
]))
8402 realmaps
[nmaps1
++] = maps
[mapno
];
8404 value
= Fx_popup_menu (prev_event
, Flist (nmaps1
, realmaps
));
8409 record_menu_key (XCAR (value
));
8411 /* If we got multiple events, unread all but
8413 There is no way to prevent those unread events
8414 from showing up later in last_nonmenu_event.
8415 So turn symbol and integer events into lists,
8416 to indicate that they came from a mouse menu,
8417 so that when present in last_nonmenu_event
8418 they won't confuse things. */
8419 for (tem
= XCDR (value
); CONSP (tem
); tem
= XCDR (tem
))
8421 record_menu_key (XCAR (tem
));
8422 if (SYMBOLP (XCAR (tem
))
8423 || INTEGERP (XCAR (tem
)))
8424 XSETCAR (tem
, Fcons (XCAR (tem
), Qdisabled
));
8427 /* If we got more than one event, put all but the first
8428 onto this list to be read later.
8429 Return just the first event now. */
8430 Vunread_command_events
8431 = nconc2 (XCDR (value
), Vunread_command_events
);
8432 value
= XCAR (value
);
8434 else if (NILP (value
))
8436 if (used_mouse_menu
)
8437 *used_mouse_menu
= 1;
8440 #endif /* HAVE_MENUS */
8444 /* Buffer in use so far for the minibuf prompts for menu keymaps.
8445 We make this bigger when necessary, and never free it. */
8446 static char *read_char_minibuf_menu_text
;
8447 /* Size of that buffer. */
8448 static ptrdiff_t read_char_minibuf_menu_width
;
8451 read_char_minibuf_menu_prompt (int commandflag
,
8452 ptrdiff_t nmaps
, Lisp_Object
*maps
)
8455 register Lisp_Object name
;
8457 /* FIXME: Use the minibuffer's frame width. */
8458 ptrdiff_t width
= FRAME_COLS (SELECTED_FRAME ()) - 4;
8460 bool nobindings
= 1;
8461 Lisp_Object rest
, vector
;
8467 if (! menu_prompting
)
8470 /* Get the menu name from the first map that has one (a prompt string). */
8471 for (mapno
= 0; mapno
< nmaps
; mapno
++)
8473 name
= Fkeymap_prompt (maps
[mapno
]);
8478 /* If we don't have any menus, just read a character normally. */
8479 if (!STRINGP (name
))
8482 /* Make sure we have a big enough buffer for the menu text. */
8483 width
= max (width
, SBYTES (name
));
8484 if (STRING_BYTES_BOUND
- 4 < width
)
8485 memory_full (SIZE_MAX
);
8486 if (width
+ 4 > read_char_minibuf_menu_width
)
8488 read_char_minibuf_menu_text
8489 = xrealloc (read_char_minibuf_menu_text
, width
+ 4);
8490 read_char_minibuf_menu_width
= width
+ 4;
8492 menu
= read_char_minibuf_menu_text
;
8494 /* Prompt string always starts with map's prompt, and a space. */
8495 strcpy (menu
, SSDATA (name
));
8496 nlength
= SBYTES (name
);
8497 menu
[nlength
++] = ':';
8498 menu
[nlength
++] = ' ';
8501 /* Start prompting at start of first map. */
8505 /* Present the documented bindings, a line at a time. */
8509 ptrdiff_t i
= nlength
;
8511 Lisp_Object orig_defn_macro
;
8513 /* Loop over elements of map. */
8518 /* If reached end of map, start at beginning of next map. */
8522 /* At end of last map, wrap around to first map if just starting,
8523 or end this line if already have something on it. */
8527 if (notfirst
|| nobindings
) break;
8532 /* Look at the next element of the map. */
8534 elt
= AREF (vector
, idx
);
8536 elt
= Fcar_safe (rest
);
8538 if (idx
< 0 && VECTORP (elt
))
8540 /* If we found a dense table in the keymap,
8541 advanced past it, but start scanning its contents. */
8542 rest
= Fcdr_safe (rest
);
8548 /* An ordinary element. */
8549 Lisp_Object event
, tem
;
8553 event
= Fcar_safe (elt
); /* alist */
8554 elt
= Fcdr_safe (elt
);
8558 XSETINT (event
, idx
); /* vector */
8561 /* Ignore the element if it has no prompt string. */
8562 if (INTEGERP (event
) && parse_menu_item (elt
, -1))
8564 /* True if the char to type matches the string. */
8566 Lisp_Object upcased_event
, downcased_event
;
8567 Lisp_Object desc
= Qnil
;
8569 = AREF (item_properties
, ITEM_PROPERTY_NAME
);
8571 upcased_event
= Fupcase (event
);
8572 downcased_event
= Fdowncase (event
);
8573 char_matches
= (XINT (upcased_event
) == SREF (s
, 0)
8574 || XINT (downcased_event
) == SREF (s
, 0));
8576 desc
= Fsingle_key_description (event
, Qnil
);
8578 #if 0 /* It is redundant to list the equivalent key bindings because
8579 the prefix is what the user has already typed. */
8581 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_KEYEQ
];
8583 /* Insert equivalent keybinding. */
8584 s
= concat2 (s
, tem
);
8587 = AREF (item_properties
, ITEM_PROPERTY_TYPE
);
8588 if (EQ (tem
, QCradio
) || EQ (tem
, QCtoggle
))
8590 /* Insert button prefix. */
8591 Lisp_Object selected
8592 = AREF (item_properties
, ITEM_PROPERTY_SELECTED
);
8593 if (EQ (tem
, QCradio
))
8594 tem
= build_string (NILP (selected
) ? "(*) " : "( ) ");
8596 tem
= build_string (NILP (selected
) ? "[X] " : "[ ] ");
8597 s
= concat2 (tem
, s
);
8601 /* If we have room for the prompt string, add it to this line.
8602 If this is the first on the line, always add it. */
8603 if ((SCHARS (s
) + i
+ 2
8604 + (char_matches
? 0 : SCHARS (desc
) + 3))
8608 ptrdiff_t thiswidth
;
8610 /* Punctuate between strings. */
8613 strcpy (menu
+ i
, ", ");
8619 /* If the char to type doesn't match the string's
8620 first char, explicitly show what char to type. */
8623 /* Add as much of string as fits. */
8624 thiswidth
= min (SCHARS (desc
), width
- i
);
8625 memcpy (menu
+ i
, SDATA (desc
), thiswidth
);
8627 strcpy (menu
+ i
, " = ");
8631 /* Add as much of string as fits. */
8632 thiswidth
= min (SCHARS (s
), width
- i
);
8633 memcpy (menu
+ i
, SDATA (s
), thiswidth
);
8639 /* If this element does not fit, end the line now,
8640 and save the element for the next line. */
8641 strcpy (menu
+ i
, "...");
8646 /* Move past this element. */
8647 if (idx
>= 0 && idx
+ 1 >= ASIZE (vector
))
8648 /* Handle reaching end of dense table. */
8653 rest
= Fcdr_safe (rest
);
8657 /* Prompt with that and read response. */
8658 message2_nolog (menu
, strlen (menu
),
8659 ! NILP (BVAR (current_buffer
, enable_multibyte_characters
)));
8661 /* Make believe its not a keyboard macro in case the help char
8662 is pressed. Help characters are not recorded because menu prompting
8663 is not used on replay.
8665 orig_defn_macro
= KVAR (current_kboard
, defining_kbd_macro
);
8666 kset_defining_kbd_macro (current_kboard
, Qnil
);
8668 obj
= read_char (commandflag
, 0, 0, Qt
, 0, NULL
);
8669 while (BUFFERP (obj
));
8670 kset_defining_kbd_macro (current_kboard
, orig_defn_macro
);
8672 if (!INTEGERP (obj
))
8674 else if (XINT (obj
) == -2)
8677 if (! EQ (obj
, menu_prompt_more_char
)
8678 && (!INTEGERP (menu_prompt_more_char
)
8679 || ! EQ (obj
, make_number (Ctl (XINT (menu_prompt_more_char
))))))
8681 if (!NILP (KVAR (current_kboard
, defining_kbd_macro
)))
8682 store_kbd_macro_char (obj
);
8685 /* Help char - go round again */
8689 /* Reading key sequences. */
8691 /* Follow KEY in the maps in CURRENT[0..NMAPS-1], placing its bindings
8692 in DEFS[0..NMAPS-1]. Set NEXT[i] to DEFS[i] if DEFS[i] is a
8693 keymap, or nil otherwise. Return the index of the first keymap in
8694 which KEY has any binding, or NMAPS if no map has a binding.
8696 If KEY is a meta ASCII character, treat it like meta-prefix-char
8697 followed by the corresponding non-meta character. Keymaps in
8698 CURRENT with non-prefix bindings for meta-prefix-char become nil in
8701 If KEY has no bindings in any of the CURRENT maps, NEXT is left
8704 NEXT may be the same array as CURRENT. */
8707 follow_key (Lisp_Object key
, ptrdiff_t nmaps
, Lisp_Object
*current
,
8708 Lisp_Object
*defs
, Lisp_Object
*next
)
8710 ptrdiff_t i
, first_binding
;
8712 first_binding
= nmaps
;
8713 for (i
= nmaps
- 1; i
>= 0; i
--)
8715 if (! NILP (current
[i
]))
8717 defs
[i
] = access_keymap (current
[i
], key
, 1, 0, 1);
8718 if (! NILP (defs
[i
]))
8725 /* Given the set of bindings we've found, produce the next set of maps. */
8726 if (first_binding
< nmaps
)
8727 for (i
= 0; i
< nmaps
; i
++)
8728 next
[i
] = NILP (defs
[i
]) ? Qnil
: get_keymap (defs
[i
], 0, 1);
8730 return first_binding
;
8733 /* Structure used to keep track of partial application of key remapping
8734 such as Vfunction_key_map and Vkey_translation_map. */
8735 typedef struct keyremap
8737 /* This is the map originally specified for this use. */
8739 /* This is a submap reached by looking up, in PARENT,
8740 the events from START to END. */
8742 /* Positions [START, END) in the key sequence buffer
8743 are the key that we have scanned so far.
8744 Those events are the ones that we will replace
8745 if PARENT maps them into a key sequence. */
8749 /* Lookup KEY in MAP.
8750 MAP is a keymap mapping keys to key vectors or functions.
8751 If the mapping is a function and DO_FUNCALL is true,
8752 the function is called with PROMPT as parameter and its return
8753 value is used as the return value of this function (after checking
8754 that it is indeed a vector). */
8757 access_keymap_keyremap (Lisp_Object map
, Lisp_Object key
, Lisp_Object prompt
,
8762 next
= access_keymap (map
, key
, 1, 0, 1);
8764 /* Handle a symbol whose function definition is a keymap
8766 if (SYMBOLP (next
) && !NILP (Ffboundp (next
))
8767 && (ARRAYP (XSYMBOL (next
)->function
)
8768 || KEYMAPP (XSYMBOL (next
)->function
)))
8769 next
= Fautoload_do_load (XSYMBOL (next
)->function
, next
, Qnil
);
8771 /* If the keymap gives a function, not an
8772 array, then call the function with one arg and use
8773 its value instead. */
8774 if (do_funcall
&& FUNCTIONP (next
))
8779 next
= call1 (next
, prompt
);
8780 /* If the function returned something invalid,
8781 barf--don't ignore it.
8782 (To ignore it safely, we would need to gcpro a bunch of
8783 other variables.) */
8784 if (! (VECTORP (next
) || STRINGP (next
)))
8785 error ("Function %s returns invalid key sequence",
8786 SSDATA (SYMBOL_NAME (tem
)));
8791 /* Do one step of the key remapping used for function-key-map and
8792 key-translation-map:
8793 KEYBUF is the buffer holding the input events.
8794 BUFSIZE is its maximum size.
8795 FKEY is a pointer to the keyremap structure to use.
8796 INPUT is the index of the last element in KEYBUF.
8797 DOIT if true says that the remapping can actually take place.
8798 DIFF is used to return the number of keys added/removed by the remapping.
8799 PARENT is the root of the keymap.
8800 PROMPT is the prompt to use if the remapping happens through a function.
8801 Return true if the remapping actually took place. */
8804 keyremap_step (Lisp_Object
*keybuf
, int bufsize
, volatile keyremap
*fkey
,
8805 int input
, bool doit
, int *diff
, Lisp_Object prompt
)
8807 Lisp_Object next
, key
;
8809 key
= keybuf
[fkey
->end
++];
8811 if (KEYMAPP (fkey
->parent
))
8812 next
= access_keymap_keyremap (fkey
->map
, key
, prompt
, doit
);
8816 /* If keybuf[fkey->start..fkey->end] is bound in the
8817 map and we're in a position to do the key remapping, replace it with
8818 the binding and restart with fkey->start at the end. */
8819 if ((VECTORP (next
) || STRINGP (next
)) && doit
)
8821 int len
= XFASTINT (Flength (next
));
8824 *diff
= len
- (fkey
->end
- fkey
->start
);
8826 if (bufsize
- input
<= *diff
)
8827 error ("Key sequence too long");
8829 /* Shift the keys that follow fkey->end. */
8831 for (i
= fkey
->end
; i
< input
; i
++)
8832 keybuf
[i
+ *diff
] = keybuf
[i
];
8834 for (i
= input
- 1; i
>= fkey
->end
; i
--)
8835 keybuf
[i
+ *diff
] = keybuf
[i
];
8836 /* Overwrite the old keys with the new ones. */
8837 for (i
= 0; i
< len
; i
++)
8838 keybuf
[fkey
->start
+ i
]
8839 = Faref (next
, make_number (i
));
8841 fkey
->start
= fkey
->end
+= *diff
;
8842 fkey
->map
= fkey
->parent
;
8847 fkey
->map
= get_keymap (next
, 0, 1);
8849 /* If we no longer have a bound suffix, try a new position for
8851 if (!CONSP (fkey
->map
))
8853 fkey
->end
= ++fkey
->start
;
8854 fkey
->map
= fkey
->parent
;
8860 test_undefined (Lisp_Object binding
)
8862 return (EQ (binding
, Qundefined
)
8863 || (!NILP (binding
) && SYMBOLP (binding
)
8864 && EQ (Fcommand_remapping (binding
, Qnil
, Qnil
), Qundefined
)));
8867 /* Read a sequence of keys that ends with a non prefix character,
8868 storing it in KEYBUF, a buffer of size BUFSIZE.
8870 Return the length of the key sequence stored.
8871 Return -1 if the user rejected a command menu.
8873 Echo starting immediately unless `prompt' is 0.
8875 Where a key sequence ends depends on the currently active keymaps.
8876 These include any minor mode keymaps active in the current buffer,
8877 the current buffer's local map, and the global map.
8879 If a key sequence has no other bindings, we check Vfunction_key_map
8880 to see if some trailing subsequence might be the beginning of a
8881 function key's sequence. If so, we try to read the whole function
8882 key, and substitute its symbolic name into the key sequence.
8884 We ignore unbound `down-' mouse clicks. We turn unbound `drag-' and
8885 `double-' events into similar click events, if that would make them
8886 bound. We try to turn `triple-' events first into `double-' events,
8889 If we get a mouse click in a mode line, vertical divider, or other
8890 non-text area, we treat the click as if it were prefixed by the
8891 symbol denoting that area - `mode-line', `vertical-line', or
8894 If the sequence starts with a mouse click, we read the key sequence
8895 with respect to the buffer clicked on, not the current buffer.
8897 If the user switches frames in the midst of a key sequence, we put
8898 off the switch-frame event until later; the next call to
8899 read_char will return it.
8901 If FIX_CURRENT_BUFFER, we restore current_buffer
8902 from the selected window's buffer. */
8905 read_key_sequence (Lisp_Object
*keybuf
, int bufsize
, Lisp_Object prompt
,
8906 bool dont_downcase_last
, bool can_return_switch_frame
,
8907 bool fix_current_buffer
)
8909 Lisp_Object from_string
;
8910 ptrdiff_t count
= SPECPDL_INDEX ();
8912 /* How many keys there are in the current key sequence. */
8915 /* The length of the echo buffer when we started reading, and
8916 the length of this_command_keys when we started reading. */
8917 ptrdiff_t echo_start
IF_LINT (= 0);
8918 ptrdiff_t keys_start
;
8920 /* The number of keymaps we're scanning right now, and the number of
8921 keymaps we have allocated space for. */
8923 ptrdiff_t nmaps_allocated
= 0;
8925 /* defs[0..nmaps-1] are the definitions of KEYBUF[0..t-1] in
8926 the current keymaps. */
8927 Lisp_Object
*defs
= NULL
;
8929 /* submaps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
8930 in the current keymaps, or nil where it is not a prefix. */
8931 Lisp_Object
*submaps
= NULL
;
8933 /* The local map to start out with at start of key sequence. */
8934 Lisp_Object orig_local_map
;
8936 /* The map from the `keymap' property to start out with at start of
8938 Lisp_Object orig_keymap
;
8940 /* Positive if we have already considered switching to the local-map property
8941 of the place where a mouse click occurred. */
8942 int localized_local_map
= 0;
8944 /* The index in submaps[] of the first keymap that has a binding for
8945 this key sequence. In other words, the lowest i such that
8946 submaps[i] is non-nil. */
8947 ptrdiff_t first_binding
;
8948 /* Index of the first key that has no binding.
8949 It is useless to try fkey.start larger than that. */
8952 /* If t < mock_input, then KEYBUF[t] should be read as the next
8955 We use this to recover after recognizing a function key. Once we
8956 realize that a suffix of the current key sequence is actually a
8957 function key's escape sequence, we replace the suffix with the
8958 function key's binding from Vfunction_key_map. Now keybuf
8959 contains a new and different key sequence, so the echo area,
8960 this_command_keys, and the submaps and defs arrays are wrong. In
8961 this situation, we set mock_input to t, set t to 0, and jump to
8962 restart_sequence; the loop will read keys from keybuf up until
8963 mock_input, thus rebuilding the state; and then it will resume
8964 reading characters from the keyboard. */
8967 /* If the sequence is unbound in submaps[], then
8968 keybuf[fkey.start..fkey.end-1] is a prefix in Vfunction_key_map,
8969 and fkey.map is its binding.
8971 These might be > t, indicating that all function key scanning
8972 should hold off until t reaches them. We do this when we've just
8973 recognized a function key, to avoid searching for the function
8974 key's again in Vfunction_key_map. */
8977 /* Likewise, for key_translation_map and input-decode-map. */
8978 keyremap keytran
, indec
;
8980 /* True if we are trying to map a key by changing an upper-case
8981 letter to lower case, or a shifted function key to an unshifted
8983 bool shift_translated
= 0;
8985 /* If we receive a `switch-frame' or `select-window' event in the middle of
8986 a key sequence, we put it off for later.
8987 While we're reading, we keep the event here. */
8988 Lisp_Object delayed_switch_frame
;
8990 /* See the comment below... */
8991 #if defined (GOBBLE_FIRST_EVENT)
8992 Lisp_Object first_event
;
8995 Lisp_Object original_uppercase
IF_LINT (= Qnil
);
8996 int original_uppercase_position
= -1;
8998 /* Gets around Microsoft compiler limitations. */
9001 struct buffer
*starting_buffer
;
9003 /* List of events for which a fake prefix key has been generated. */
9004 Lisp_Object fake_prefixed_keys
= Qnil
;
9006 #if defined (GOBBLE_FIRST_EVENT)
9010 struct gcpro gcpro1
;
9012 GCPRO1 (fake_prefixed_keys
);
9013 raw_keybuf_count
= 0;
9015 last_nonmenu_event
= Qnil
;
9017 delayed_switch_frame
= Qnil
;
9023 /* Install the string STR as the beginning of the string of
9024 echoing, so that it serves as a prompt for the next
9026 kset_echo_string (current_kboard
, prompt
);
9027 current_kboard
->echo_after_prompt
= SCHARS (prompt
);
9030 else if (cursor_in_echo_area
9031 && (FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
9032 && NILP (Fzerop (Vecho_keystrokes
)))
9033 /* This doesn't put in a dash if the echo buffer is empty, so
9034 you don't always see a dash hanging out in the minibuffer. */
9038 /* Record the initial state of the echo area and this_command_keys;
9039 we will need to restore them if we replay a key sequence. */
9041 echo_start
= echo_length ();
9042 keys_start
= this_command_key_count
;
9043 this_single_command_key_start
= keys_start
;
9045 #if defined (GOBBLE_FIRST_EVENT)
9046 /* This doesn't quite work, because some of the things that read_char
9047 does cannot safely be bypassed. It seems too risky to try to make
9050 /* Read the first char of the sequence specially, before setting
9051 up any keymaps, in case a filter runs and switches buffers on us. */
9052 first_event
= read_char (NILP (prompt
), 0, submaps
, last_nonmenu_event
,
9054 #endif /* GOBBLE_FIRST_EVENT */
9056 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
9057 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9060 /* We jump here when we need to reinitialize fkey and keytran; this
9061 happens if we switch keyboards between rescans. */
9062 replay_entire_sequence
:
9064 indec
.map
= indec
.parent
= KVAR (current_kboard
, Vinput_decode_map
);
9065 fkey
.map
= fkey
.parent
= KVAR (current_kboard
, Vlocal_function_key_map
);
9066 keytran
.map
= keytran
.parent
= Vkey_translation_map
;
9067 indec
.start
= indec
.end
= 0;
9068 fkey
.start
= fkey
.end
= 0;
9069 keytran
.start
= keytran
.end
= 0;
9071 /* We jump here when the key sequence has been thoroughly changed, and
9072 we need to rescan it starting from the beginning. When we jump here,
9073 keybuf[0..mock_input] holds the sequence we should reread. */
9076 starting_buffer
= current_buffer
;
9077 first_unbound
= bufsize
+ 1;
9079 /* Build our list of keymaps.
9080 If we recognize a function key and replace its escape sequence in
9081 keybuf with its symbol, or if the sequence starts with a mouse
9082 click and we need to switch buffers, we jump back here to rebuild
9083 the initial keymaps from the current buffer. */
9086 if (!NILP (KVAR (current_kboard
, Voverriding_terminal_local_map
)))
9088 if (2 > nmaps_allocated
)
9090 submaps
= alloca (2 * sizeof *submaps
);
9091 defs
= alloca (2 * sizeof *defs
);
9092 nmaps_allocated
= 2;
9094 submaps
[nmaps
++] = KVAR (current_kboard
, Voverriding_terminal_local_map
);
9096 else if (!NILP (Voverriding_local_map
))
9098 if (2 > nmaps_allocated
)
9100 submaps
= alloca (2 * sizeof *submaps
);
9101 defs
= alloca (2 * sizeof *defs
);
9102 nmaps_allocated
= 2;
9104 submaps
[nmaps
++] = Voverriding_local_map
;
9112 nminor
= current_minor_maps (0, &maps
);
9113 total
= nminor
+ (!NILP (orig_keymap
) ? 3 : 2);
9115 if (total
> nmaps_allocated
)
9117 submaps
= alloca (total
* sizeof *submaps
);
9118 defs
= alloca (total
* sizeof *defs
);
9119 nmaps_allocated
= total
;
9122 if (!NILP (orig_keymap
))
9123 submaps
[nmaps
++] = orig_keymap
;
9125 memcpy (submaps
+ nmaps
, maps
, nminor
* sizeof (submaps
[0]));
9129 submaps
[nmaps
++] = orig_local_map
;
9131 submaps
[nmaps
++] = current_global_map
;
9133 /* Find an accurate initial value for first_binding. */
9134 for (first_binding
= 0; first_binding
< nmaps
; first_binding
++)
9135 if (! NILP (submaps
[first_binding
]))
9138 /* Start from the beginning in keybuf. */
9141 /* These are no-ops the first time through, but if we restart, they
9142 revert the echo area and this_command_keys to their original state. */
9143 this_command_key_count
= keys_start
;
9144 if (INTERACTIVE
&& t
< mock_input
)
9145 echo_truncate (echo_start
);
9147 /* If the best binding for the current key sequence is a keymap, or
9148 we may be looking at a function key's escape sequence, keep on
9150 while (first_binding
< nmaps
9151 /* Keep reading as long as there's a prefix binding. */
9152 ? !NILP (submaps
[first_binding
])
9153 /* Don't return in the middle of a possible function key sequence,
9154 if the only bindings we found were via case conversion.
9155 Thus, if ESC O a has a function-key-map translation
9156 and ESC o has a binding, don't return after ESC O,
9157 so that we can translate ESC O plus the next character. */
9158 : (/* indec.start < t || fkey.start < t || */ keytran
.start
< t
))
9161 bool used_mouse_menu
= 0;
9163 /* Where the last real key started. If we need to throw away a
9164 key that has expanded into more than one element of keybuf
9165 (say, a mouse click on the mode line which is being treated
9166 as [mode-line (mouse-...)], then we backtrack to this point
9168 int last_real_key_start
;
9170 /* These variables are analogous to echo_start and keys_start;
9171 while those allow us to restart the entire key sequence,
9172 echo_local_start and keys_local_start allow us to throw away
9174 ptrdiff_t echo_local_start
IF_LINT (= 0);
9175 int keys_local_start
;
9176 ptrdiff_t local_first_binding
;
9178 eassert (indec
.end
== t
|| (indec
.end
> t
&& indec
.end
<= mock_input
));
9179 eassert (indec
.start
<= indec
.end
);
9180 eassert (fkey
.start
<= fkey
.end
);
9181 eassert (keytran
.start
<= keytran
.end
);
9182 /* key-translation-map is applied *after* function-key-map
9183 which is itself applied *after* input-decode-map. */
9184 eassert (fkey
.end
<= indec
.start
);
9185 eassert (keytran
.end
<= fkey
.start
);
9187 if (/* first_unbound < indec.start && first_unbound < fkey.start && */
9188 first_unbound
< keytran
.start
)
9189 { /* The prefix upto first_unbound has no binding and has
9190 no translation left to do either, so we know it's unbound.
9191 If we don't stop now, we risk staying here indefinitely
9192 (if the user keeps entering fkey or keytran prefixes
9193 like C-c ESC ESC ESC ESC ...) */
9195 for (i
= first_unbound
+ 1; i
< t
; i
++)
9196 keybuf
[i
- first_unbound
- 1] = keybuf
[i
];
9197 mock_input
= t
- first_unbound
- 1;
9198 indec
.end
= indec
.start
-= first_unbound
+ 1;
9199 indec
.map
= indec
.parent
;
9200 fkey
.end
= fkey
.start
-= first_unbound
+ 1;
9201 fkey
.map
= fkey
.parent
;
9202 keytran
.end
= keytran
.start
-= first_unbound
+ 1;
9203 keytran
.map
= keytran
.parent
;
9204 goto replay_sequence
;
9208 error ("Key sequence too long");
9211 echo_local_start
= echo_length ();
9212 keys_local_start
= this_command_key_count
;
9213 local_first_binding
= first_binding
;
9216 /* These are no-ops, unless we throw away a keystroke below and
9217 jumped back up to replay_key; in that case, these restore the
9218 variables to their original state, allowing us to replay the
9220 if (INTERACTIVE
&& t
< mock_input
)
9221 echo_truncate (echo_local_start
);
9222 this_command_key_count
= keys_local_start
;
9223 first_binding
= local_first_binding
;
9225 /* By default, assume each event is "real". */
9226 last_real_key_start
= t
;
9228 /* Does mock_input indicate that we are re-reading a key sequence? */
9232 add_command_key (key
);
9233 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
9234 && NILP (Fzerop (Vecho_keystrokes
)))
9238 /* If not, we should actually read a character. */
9242 KBOARD
*interrupted_kboard
= current_kboard
;
9243 struct frame
*interrupted_frame
= SELECTED_FRAME ();
9244 key
= read_char (NILP (prompt
), nmaps
,
9245 (Lisp_Object
*) submaps
, last_nonmenu_event
,
9246 &used_mouse_menu
, NULL
);
9247 if ((INTEGERP (key
) && XINT (key
) == -2) /* wrong_kboard_jmpbuf */
9248 /* When switching to a new tty (with a new keyboard),
9249 read_char returns the new buffer, rather than -2
9250 (Bug#5095). This is because `terminal-init-xterm'
9251 calls read-char, which eats the wrong_kboard_jmpbuf
9252 return. Any better way to fix this? -- cyd */
9253 || (interrupted_kboard
!= current_kboard
))
9258 for (k
= all_kboards
; k
; k
= k
->next_kboard
)
9259 if (k
== interrupted_kboard
)
9264 /* Don't touch interrupted_kboard when it's been
9266 delayed_switch_frame
= Qnil
;
9267 goto replay_entire_sequence
;
9270 if (!NILP (delayed_switch_frame
))
9273 (interrupted_kboard
,
9274 Fcons (delayed_switch_frame
,
9275 KVAR (interrupted_kboard
, kbd_queue
)));
9276 delayed_switch_frame
= Qnil
;
9281 (interrupted_kboard
,
9282 Fcons (keybuf
[--t
], KVAR (interrupted_kboard
, kbd_queue
)));
9284 /* If the side queue is non-empty, ensure it begins with a
9285 switch-frame, so we'll replay it in the right context. */
9286 if (CONSP (KVAR (interrupted_kboard
, kbd_queue
))
9287 && (key
= XCAR (KVAR (interrupted_kboard
, kbd_queue
)),
9288 !(EVENT_HAS_PARAMETERS (key
)
9289 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)),
9293 XSETFRAME (frame
, interrupted_frame
);
9295 (interrupted_kboard
,
9296 Fcons (make_lispy_switch_frame (frame
),
9297 KVAR (interrupted_kboard
, kbd_queue
)));
9300 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
9301 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9302 goto replay_entire_sequence
;
9306 /* read_char returns t when it shows a menu and the user rejects it.
9310 unbind_to (count
, Qnil
);
9315 /* read_char returns -1 at the end of a macro.
9316 Emacs 18 handles this by returning immediately with a
9317 zero, so that's what we'll do. */
9318 if (INTEGERP (key
) && XINT (key
) == -1)
9321 /* The Microsoft C compiler can't handle the goto that
9327 /* If the current buffer has been changed from under us, the
9328 keymap may have changed, so replay the sequence. */
9331 timer_resume_idle ();
9334 /* Reset the current buffer from the selected window
9335 in case something changed the former and not the latter.
9336 This is to be more consistent with the behavior
9337 of the command_loop_1. */
9338 if (fix_current_buffer
)
9340 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
9342 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
9343 Fset_buffer (XWINDOW (selected_window
)->buffer
);
9346 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
9347 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9348 goto replay_sequence
;
9351 /* If we have a quit that was typed in another frame, and
9352 quit_throw_to_read_char switched buffers,
9353 replay to get the right keymap. */
9355 && XINT (key
) == quit_char
9356 && current_buffer
!= starting_buffer
)
9359 ASET (raw_keybuf
, raw_keybuf_count
, key
);
9364 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
9365 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9366 goto replay_sequence
;
9371 if (EVENT_HAS_PARAMETERS (key
)
9372 /* Either a `switch-frame' or a `select-window' event. */
9373 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)), Qswitch_frame
))
9375 /* If we're at the beginning of a key sequence, and the caller
9376 says it's okay, go ahead and return this event. If we're
9377 in the midst of a key sequence, delay it until the end. */
9378 if (t
> 0 || !can_return_switch_frame
)
9380 delayed_switch_frame
= key
;
9386 ASET (raw_keybuf
, raw_keybuf_count
, key
);
9390 /* Clicks in non-text areas get prefixed by the symbol
9391 in their CHAR-ADDRESS field. For example, a click on
9392 the mode line is prefixed by the symbol `mode-line'.
9394 Furthermore, key sequences beginning with mouse clicks
9395 are read using the keymaps of the buffer clicked on, not
9396 the current buffer. So we may have to switch the buffer
9399 When we turn one event into two events, we must make sure
9400 that neither of the two looks like the original--so that,
9401 if we replay the events, they won't be expanded again.
9402 If not for this, such reexpansion could happen either here
9403 or when user programs play with this-command-keys. */
9404 if (EVENT_HAS_PARAMETERS (key
))
9409 kind
= EVENT_HEAD_KIND (EVENT_HEAD (key
));
9410 if (EQ (kind
, Qmouse_click
))
9412 Lisp_Object window
, posn
;
9414 window
= POSN_WINDOW (EVENT_START (key
));
9415 posn
= POSN_POSN (EVENT_START (key
));
9418 || (!NILP (fake_prefixed_keys
)
9419 && !NILP (Fmemq (key
, fake_prefixed_keys
))))
9421 /* We're looking a second time at an event for which
9422 we generated a fake prefix key. Set
9423 last_real_key_start appropriately. */
9425 last_real_key_start
= t
- 1;
9428 if (last_real_key_start
== 0)
9430 /* Key sequences beginning with mouse clicks are
9431 read using the keymaps in the buffer clicked on,
9432 not the current buffer. If we're at the
9433 beginning of a key sequence, switch buffers. */
9434 if (WINDOWP (window
)
9435 && BUFFERP (XWINDOW (window
)->buffer
)
9436 && XBUFFER (XWINDOW (window
)->buffer
) != current_buffer
)
9438 ASET (raw_keybuf
, raw_keybuf_count
, key
);
9443 /* Arrange to go back to the original buffer once we're
9444 done reading the key sequence. Note that we can't
9445 use save_excursion_{save,restore} here, because they
9446 save point as well as the current buffer; we don't
9447 want to save point, because redisplay may change it,
9448 to accommodate a Fset_window_start or something. We
9449 don't want to do this at the top of the function,
9450 because we may get input from a subprocess which
9451 wants to change the selected window and stuff (say,
9453 record_unwind_current_buffer ();
9455 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
9457 set_buffer_internal (XBUFFER (XWINDOW (window
)->buffer
));
9458 orig_local_map
= get_local_map (PT
, current_buffer
,
9460 orig_keymap
= get_local_map (PT
, current_buffer
,
9462 goto replay_sequence
;
9465 /* For a mouse click, get the local text-property keymap
9466 of the place clicked on, rather than point. */
9467 if (CONSP (XCDR (key
))
9468 && ! localized_local_map
)
9470 Lisp_Object map_here
, start
, pos
;
9472 localized_local_map
= 1;
9473 start
= EVENT_START (key
);
9475 if (CONSP (start
) && POSN_INBUFFER_P (start
))
9477 pos
= POSN_BUFFER_POSN (start
);
9479 && XINT (pos
) >= BEGV
9480 && XINT (pos
) <= ZV
)
9482 map_here
= get_local_map (XINT (pos
),
9485 if (!EQ (map_here
, orig_local_map
))
9487 orig_local_map
= map_here
;
9488 ++localized_local_map
;
9491 map_here
= get_local_map (XINT (pos
),
9494 if (!EQ (map_here
, orig_keymap
))
9496 orig_keymap
= map_here
;
9497 ++localized_local_map
;
9500 if (localized_local_map
> 1)
9505 goto replay_sequence
;
9512 /* Expand mode-line and scroll-bar events into two events:
9513 use posn as a fake prefix key. */
9515 && (NILP (fake_prefixed_keys
)
9516 || NILP (Fmemq (key
, fake_prefixed_keys
))))
9518 if (bufsize
- t
<= 1)
9519 error ("Key sequence too long");
9522 keybuf
[t
+ 1] = key
;
9525 /* Record that a fake prefix key has been generated
9526 for KEY. Don't modify the event; this would
9527 prevent proper action when the event is pushed
9528 back into unread-command-events. */
9529 fake_prefixed_keys
= Fcons (key
, fake_prefixed_keys
);
9531 /* If on a mode line string with a local keymap,
9532 reconsider the key sequence with that keymap. */
9533 if (string
= POSN_STRING (EVENT_START (key
)),
9534 (CONSP (string
) && STRINGP (XCAR (string
))))
9536 Lisp_Object pos
, map
, map2
;
9538 pos
= XCDR (string
);
9539 string
= XCAR (string
);
9541 && XINT (pos
) < SCHARS (string
))
9543 map
= Fget_text_property (pos
, Qlocal_map
, string
);
9545 orig_local_map
= map
;
9546 map2
= Fget_text_property (pos
, Qkeymap
, string
);
9549 if (!NILP (map
) || !NILP (map2
))
9550 goto replay_sequence
;
9556 else if (NILP (from_string
)
9557 && (string
= POSN_STRING (EVENT_START (key
)),
9558 (CONSP (string
) && STRINGP (XCAR (string
)))))
9560 /* For a click on a string, i.e. overlay string or a
9561 string displayed via the `display' property,
9562 consider `local-map' and `keymap' properties of
9564 Lisp_Object pos
, map
, map2
;
9566 pos
= XCDR (string
);
9567 string
= XCAR (string
);
9569 && XINT (pos
) < SCHARS (string
))
9571 map
= Fget_text_property (pos
, Qlocal_map
, string
);
9573 orig_local_map
= map
;
9574 map2
= Fget_text_property (pos
, Qkeymap
, string
);
9578 if (!NILP (map
) || !NILP (map2
))
9580 from_string
= string
;
9583 goto replay_sequence
;
9588 else if (CONSP (XCDR (key
))
9589 && CONSP (EVENT_START (key
))
9590 && CONSP (XCDR (EVENT_START (key
))))
9594 posn
= POSN_POSN (EVENT_START (key
));
9595 /* Handle menu-bar events:
9596 insert the dummy prefix event `menu-bar'. */
9597 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
9599 if (bufsize
- t
<= 1)
9600 error ("Key sequence too long");
9604 /* Zap the position in key, so we know that we've
9605 expanded it, and don't try to do so again. */
9606 POSN_SET_POSN (EVENT_START (key
),
9607 Fcons (posn
, Qnil
));
9610 goto replay_sequence
;
9612 else if (CONSP (posn
))
9614 /* We're looking at the second event of a
9615 sequence which we expanded before. Set
9616 last_real_key_start appropriately. */
9617 if (last_real_key_start
== t
&& t
> 0)
9618 last_real_key_start
= t
- 1;
9623 /* We have finally decided that KEY is something we might want
9625 first_binding
= (follow_key (key
,
9626 nmaps
- first_binding
,
9627 submaps
+ first_binding
,
9628 defs
+ first_binding
,
9629 submaps
+ first_binding
)
9632 /* If KEY wasn't bound, we'll try some fallbacks. */
9633 if (first_binding
< nmaps
)
9634 /* This is needed for the following scenario:
9635 event 0: a down-event that gets dropped by calling replay_key.
9636 event 1: some normal prefix like C-h.
9637 After event 0, first_unbound is 0, after event 1 indec.start,
9638 fkey.start, and keytran.start are all 1, so when we see that
9639 C-h is bound, we need to update first_unbound. */
9640 first_unbound
= max (t
+ 1, first_unbound
);
9645 /* Remember the position to put an upper bound on indec.start. */
9646 first_unbound
= min (t
, first_unbound
);
9648 head
= EVENT_HEAD (key
);
9649 if (help_char_p (head
) && t
> 0)
9651 read_key_sequence_cmd
= Vprefix_help_command
;
9653 last_nonmenu_event
= key
;
9654 /* The Microsoft C compiler can't handle the goto that
9662 Lisp_Object breakdown
;
9665 breakdown
= parse_modifiers (head
);
9666 modifiers
= XINT (XCAR (XCDR (breakdown
)));
9667 /* Attempt to reduce an unbound mouse event to a simpler
9668 event that is bound:
9669 Drags reduce to clicks.
9670 Double-clicks reduce to clicks.
9671 Triple-clicks reduce to double-clicks, then to clicks.
9672 Down-clicks are eliminated.
9673 Double-downs reduce to downs, then are eliminated.
9674 Triple-downs reduce to double-downs, then to downs,
9675 then are eliminated. */
9676 if (modifiers
& (down_modifier
| drag_modifier
9677 | double_modifier
| triple_modifier
))
9679 while (modifiers
& (down_modifier
| drag_modifier
9680 | double_modifier
| triple_modifier
))
9682 Lisp_Object new_head
, new_click
;
9683 if (modifiers
& triple_modifier
)
9684 modifiers
^= (double_modifier
| triple_modifier
);
9685 else if (modifiers
& double_modifier
)
9686 modifiers
&= ~double_modifier
;
9687 else if (modifiers
& drag_modifier
)
9688 modifiers
&= ~drag_modifier
;
9691 /* Dispose of this `down' event by simply jumping
9692 back to replay_key, to get another event.
9694 Note that if this event came from mock input,
9695 then just jumping back to replay_key will just
9696 hand it to us again. So we have to wipe out any
9699 We could delete keybuf[t] and shift everything
9700 after that to the left by one spot, but we'd also
9701 have to fix up any variable that points into
9702 keybuf, and shifting isn't really necessary
9705 Adding prefixes for non-textual mouse clicks
9706 creates two characters of mock input, and both
9707 must be thrown away. If we're only looking at
9708 the prefix now, we can just jump back to
9709 replay_key. On the other hand, if we've already
9710 processed the prefix, and now the actual click
9711 itself is giving us trouble, then we've lost the
9712 state of the keymaps we want to backtrack to, and
9713 we need to replay the whole sequence to rebuild
9716 Beyond that, only function key expansion could
9717 create more than two keys, but that should never
9718 generate mouse events, so it's okay to zero
9719 mock_input in that case too.
9721 FIXME: The above paragraph seems just plain
9722 wrong, if you consider things like
9723 xterm-mouse-mode. -stef
9725 Isn't this just the most wonderful code ever? */
9727 /* If mock_input > t + 1, the above simplification
9728 will actually end up dropping keys on the floor.
9729 This is probably OK for now, but even
9730 if mock_input <= t + 1, we need to adjust indec,
9732 Typical case [header-line down-mouse-N]:
9733 mock_input = 2, t = 1, fkey.end = 1,
9734 last_real_key_start = 0. */
9735 if (indec
.end
> last_real_key_start
)
9737 indec
.end
= indec
.start
9738 = min (last_real_key_start
, indec
.start
);
9739 indec
.map
= indec
.parent
;
9740 if (fkey
.end
> last_real_key_start
)
9742 fkey
.end
= fkey
.start
9743 = min (last_real_key_start
, fkey
.start
);
9744 fkey
.map
= fkey
.parent
;
9745 if (keytran
.end
> last_real_key_start
)
9747 keytran
.end
= keytran
.start
9748 = min (last_real_key_start
, keytran
.start
);
9749 keytran
.map
= keytran
.parent
;
9753 if (t
== last_real_key_start
)
9760 mock_input
= last_real_key_start
;
9761 goto replay_sequence
;
9766 = apply_modifiers (modifiers
, XCAR (breakdown
));
9768 = Fcons (new_head
, Fcons (EVENT_START (key
), Qnil
));
9770 /* Look for a binding for this new key. follow_key
9771 promises that it didn't munge submaps the
9772 last time we called it, since key was unbound. */
9774 = (follow_key (new_click
,
9775 nmaps
- local_first_binding
,
9776 submaps
+ local_first_binding
,
9777 defs
+ local_first_binding
,
9778 submaps
+ local_first_binding
)
9779 + local_first_binding
);
9781 /* If that click is bound, go for it. */
9782 if (first_binding
< nmaps
)
9787 /* Otherwise, we'll leave key set to the drag event. */
9794 /* Normally, last_nonmenu_event gets the previous key we read.
9795 But when a mouse popup menu is being used,
9796 we don't update last_nonmenu_event; it continues to hold the mouse
9797 event that preceded the first level of menu. */
9798 if (!used_mouse_menu
)
9799 last_nonmenu_event
= key
;
9801 /* Record what part of this_command_keys is the current key sequence. */
9802 this_single_command_key_start
= this_command_key_count
- t
;
9804 /* Look for this sequence in input-decode-map.
9805 Scan from indec.end until we find a bound suffix. */
9806 while (indec
.end
< t
)
9808 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9812 GCPRO4 (indec
.map
, fkey
.map
, keytran
.map
, delayed_switch_frame
);
9813 done
= keyremap_step (keybuf
, bufsize
, &indec
, max (t
, mock_input
),
9818 mock_input
= diff
+ max (t
, mock_input
);
9819 goto replay_sequence
;
9823 if (first_binding
< nmaps
9824 && NILP (submaps
[first_binding
])
9825 && !test_undefined (defs
[first_binding
])
9826 && indec
.start
>= t
)
9827 /* There is a binding and it's not a prefix.
9828 (and it doesn't have any input-decode-map translation pending).
9829 There is thus no function-key in this sequence.
9830 Moving fkey.start is important in this case to allow keytran.start
9831 to go over the sequence before we return (since we keep the
9832 invariant that keytran.end <= fkey.start). */
9835 (fkey
.start
= fkey
.end
= t
, fkey
.map
= fkey
.parent
);
9838 /* If the sequence is unbound, see if we can hang a function key
9839 off the end of it. */
9840 /* Continue scan from fkey.end until we find a bound suffix. */
9841 while (fkey
.end
< indec
.start
)
9843 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9847 GCPRO4 (indec
.map
, fkey
.map
, keytran
.map
, delayed_switch_frame
);
9848 done
= keyremap_step (keybuf
, bufsize
, &fkey
,
9849 max (t
, mock_input
),
9850 /* If there's a binding (i.e.
9851 first_binding >= nmaps) we don't want
9852 to apply this function-key-mapping. */
9854 && (first_binding
>= nmaps
9855 || test_undefined (defs
[first_binding
])),
9860 mock_input
= diff
+ max (t
, mock_input
);
9861 /* Adjust the input-decode-map counters. */
9863 indec
.start
+= diff
;
9865 goto replay_sequence
;
9869 /* Look for this sequence in key-translation-map.
9870 Scan from keytran.end until we find a bound suffix. */
9871 while (keytran
.end
< fkey
.start
)
9873 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9877 GCPRO4 (indec
.map
, fkey
.map
, keytran
.map
, delayed_switch_frame
);
9878 done
= keyremap_step (keybuf
, bufsize
, &keytran
, max (t
, mock_input
),
9883 mock_input
= diff
+ max (t
, mock_input
);
9884 /* Adjust the function-key-map and input-decode-map counters. */
9886 indec
.start
+= diff
;
9890 goto replay_sequence
;
9894 /* If KEY is not defined in any of the keymaps,
9895 and cannot be part of a function key or translation,
9896 and is an upper case letter
9897 use the corresponding lower-case letter instead. */
9898 if (first_binding
>= nmaps
9899 && /* indec.start >= t && fkey.start >= t && */ keytran
.start
>= t
9901 && ((CHARACTERP (make_number (XINT (key
) & ~CHAR_MODIFIER_MASK
))
9902 && uppercasep (XINT (key
) & ~CHAR_MODIFIER_MASK
))
9903 || (XINT (key
) & shift_modifier
)))
9905 Lisp_Object new_key
;
9907 original_uppercase
= key
;
9908 original_uppercase_position
= t
- 1;
9910 if (XINT (key
) & shift_modifier
)
9911 XSETINT (new_key
, XINT (key
) & ~shift_modifier
);
9913 XSETINT (new_key
, (downcase (XINT (key
) & ~CHAR_MODIFIER_MASK
)
9914 | (XINT (key
) & CHAR_MODIFIER_MASK
)));
9916 /* We have to do this unconditionally, regardless of whether
9917 the lower-case char is defined in the keymaps, because they
9918 might get translated through function-key-map. */
9919 keybuf
[t
- 1] = new_key
;
9920 mock_input
= max (t
, mock_input
);
9921 shift_translated
= 1;
9923 goto replay_sequence
;
9925 /* If KEY is not defined in any of the keymaps,
9926 and cannot be part of a function key or translation,
9927 and is a shifted function key,
9928 use the corresponding unshifted function key instead. */
9929 if (first_binding
>= nmaps
9930 && /* indec.start >= t && fkey.start >= t && */ keytran
.start
>= t
)
9932 Lisp_Object breakdown
= parse_modifiers (key
);
9934 = CONSP (breakdown
) ? (XINT (XCAR (XCDR (breakdown
)))) : 0;
9936 if (modifiers
& shift_modifier
9937 /* Treat uppercase keys as shifted. */
9939 && (KEY_TO_CHAR (key
)
9940 < XCHAR_TABLE (BVAR (current_buffer
, downcase_table
))->header
.size
)
9941 && uppercasep (KEY_TO_CHAR (key
))))
9944 = (modifiers
& shift_modifier
9945 ? apply_modifiers (modifiers
& ~shift_modifier
,
9947 : make_number (downcase (KEY_TO_CHAR (key
)) | modifiers
));
9949 original_uppercase
= key
;
9950 original_uppercase_position
= t
- 1;
9952 /* We have to do this unconditionally, regardless of whether
9953 the lower-case char is defined in the keymaps, because they
9954 might get translated through function-key-map. */
9955 keybuf
[t
- 1] = new_key
;
9956 mock_input
= max (t
, mock_input
);
9957 /* Reset fkey (and consequently keytran) to apply
9958 function-key-map on the result, so that S-backspace is
9959 correctly mapped to DEL (via backspace). OTOH,
9960 input-decode-map doesn't need to go through it again. */
9961 fkey
.start
= fkey
.end
= 0;
9962 keytran
.start
= keytran
.end
= 0;
9963 shift_translated
= 1;
9965 goto replay_sequence
;
9970 read_key_sequence_cmd
= (first_binding
< nmaps
9971 ? defs
[first_binding
]
9973 read_key_sequence_remapped
9974 /* Remap command through active keymaps.
9975 Do the remapping here, before the unbind_to so it uses the keymaps
9976 of the appropriate buffer. */
9977 = SYMBOLP (read_key_sequence_cmd
)
9978 ? Fcommand_remapping (read_key_sequence_cmd
, Qnil
, Qnil
)
9981 unread_switch_frame
= delayed_switch_frame
;
9982 unbind_to (count
, Qnil
);
9984 /* Don't downcase the last character if the caller says don't.
9985 Don't downcase it if the result is undefined, either. */
9986 if ((dont_downcase_last
|| first_binding
>= nmaps
)
9988 && t
- 1 == original_uppercase_position
)
9990 keybuf
[t
- 1] = original_uppercase
;
9991 shift_translated
= 0;
9994 if (shift_translated
)
9995 Vthis_command_keys_shift_translated
= Qt
;
9997 /* Occasionally we fabricate events, perhaps by expanding something
9998 according to function-key-map, or by adding a prefix symbol to a
9999 mouse click in the scroll bar or modeline. In this cases, return
10000 the entire generated key sequence, even if we hit an unbound
10001 prefix or a definition before the end. This means that you will
10002 be able to push back the event properly, and also means that
10003 read-key-sequence will always return a logical unit.
10006 for (; t
< mock_input
; t
++)
10008 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
10009 && NILP (Fzerop (Vecho_keystrokes
)))
10010 echo_char (keybuf
[t
]);
10011 add_command_key (keybuf
[t
]);
10018 DEFUN ("read-key-sequence", Fread_key_sequence
, Sread_key_sequence
, 1, 5, 0,
10019 doc
: /* Read a sequence of keystrokes and return as a string or vector.
10020 The sequence is sufficient to specify a non-prefix command in the
10021 current local and global maps.
10023 First arg PROMPT is a prompt string. If nil, do not prompt specially.
10024 Second (optional) arg CONTINUE-ECHO, if non-nil, means this key echos
10025 as a continuation of the previous key.
10027 The third (optional) arg DONT-DOWNCASE-LAST, if non-nil, means do not
10028 convert the last event to lower case. (Normally any upper case event
10029 is converted to lower case if the original event is undefined and the lower
10030 case equivalent is defined.) A non-nil value is appropriate for reading
10031 a key sequence to be defined.
10033 A C-g typed while in this function is treated like any other character,
10034 and `quit-flag' is not set.
10036 If the key sequence starts with a mouse click, then the sequence is read
10037 using the keymaps of the buffer of the window clicked in, not the buffer
10038 of the selected window as normal.
10040 `read-key-sequence' drops unbound button-down events, since you normally
10041 only care about the click or drag events which follow them. If a drag
10042 or multi-click event is unbound, but the corresponding click event would
10043 be bound, `read-key-sequence' turns the event into a click event at the
10044 drag's starting position. This means that you don't have to distinguish
10045 between click and drag, double, or triple events unless you want to.
10047 `read-key-sequence' prefixes mouse events on mode lines, the vertical
10048 lines separating windows, and scroll bars with imaginary keys
10049 `mode-line', `vertical-line', and `vertical-scroll-bar'.
10051 Optional fourth argument CAN-RETURN-SWITCH-FRAME non-nil means that this
10052 function will process a switch-frame event if the user switches frames
10053 before typing anything. If the user switches frames in the middle of a
10054 key sequence, or at the start of the sequence but CAN-RETURN-SWITCH-FRAME
10055 is nil, then the event will be put off until after the current key sequence.
10057 `read-key-sequence' checks `function-key-map' for function key
10058 sequences, where they wouldn't conflict with ordinary bindings. See
10059 `function-key-map' for more details.
10061 The optional fifth argument CMD-LOOP, if non-nil, means
10062 that this key sequence is being read by something that will
10063 read commands one after another. It should be nil if the caller
10064 will read just one key sequence. */)
10065 (Lisp_Object prompt
, Lisp_Object continue_echo
, Lisp_Object dont_downcase_last
, Lisp_Object can_return_switch_frame
, Lisp_Object cmd_loop
)
10067 Lisp_Object keybuf
[30];
10069 struct gcpro gcpro1
;
10070 ptrdiff_t count
= SPECPDL_INDEX ();
10072 if (!NILP (prompt
))
10073 CHECK_STRING (prompt
);
10076 specbind (Qinput_method_exit_on_first_char
,
10077 (NILP (cmd_loop
) ? Qt
: Qnil
));
10078 specbind (Qinput_method_use_echo_area
,
10079 (NILP (cmd_loop
) ? Qt
: Qnil
));
10081 memset (keybuf
, 0, sizeof keybuf
);
10082 GCPRO1 (keybuf
[0]);
10083 gcpro1
.nvars
= (sizeof keybuf
/sizeof (keybuf
[0]));
10085 if (NILP (continue_echo
))
10087 this_command_key_count
= 0;
10088 this_command_key_count_reset
= 0;
10089 this_single_command_key_start
= 0;
10092 #ifdef HAVE_WINDOW_SYSTEM
10093 if (display_hourglass_p
)
10094 cancel_hourglass ();
10097 i
= read_key_sequence (keybuf
, (sizeof keybuf
/sizeof (keybuf
[0])),
10098 prompt
, ! NILP (dont_downcase_last
),
10099 ! NILP (can_return_switch_frame
), 0);
10101 #if 0 /* The following is fine for code reading a key sequence and
10102 then proceeding with a lengthy computation, but it's not good
10103 for code reading keys in a loop, like an input method. */
10104 #ifdef HAVE_WINDOW_SYSTEM
10105 if (display_hourglass_p
)
10106 start_hourglass ();
10116 return unbind_to (count
, make_event_array (i
, keybuf
));
10119 DEFUN ("read-key-sequence-vector", Fread_key_sequence_vector
,
10120 Sread_key_sequence_vector
, 1, 5, 0,
10121 doc
: /* Like `read-key-sequence' but always return a vector. */)
10122 (Lisp_Object prompt
, Lisp_Object continue_echo
, Lisp_Object dont_downcase_last
, Lisp_Object can_return_switch_frame
, Lisp_Object cmd_loop
)
10124 Lisp_Object keybuf
[30];
10126 struct gcpro gcpro1
;
10127 ptrdiff_t count
= SPECPDL_INDEX ();
10129 if (!NILP (prompt
))
10130 CHECK_STRING (prompt
);
10133 specbind (Qinput_method_exit_on_first_char
,
10134 (NILP (cmd_loop
) ? Qt
: Qnil
));
10135 specbind (Qinput_method_use_echo_area
,
10136 (NILP (cmd_loop
) ? Qt
: Qnil
));
10138 memset (keybuf
, 0, sizeof keybuf
);
10139 GCPRO1 (keybuf
[0]);
10140 gcpro1
.nvars
= (sizeof keybuf
/ sizeof (keybuf
[0]));
10142 if (NILP (continue_echo
))
10144 this_command_key_count
= 0;
10145 this_command_key_count_reset
= 0;
10146 this_single_command_key_start
= 0;
10149 #ifdef HAVE_WINDOW_SYSTEM
10150 if (display_hourglass_p
)
10151 cancel_hourglass ();
10154 i
= read_key_sequence (keybuf
, (sizeof keybuf
/ sizeof (keybuf
[0])),
10155 prompt
, ! NILP (dont_downcase_last
),
10156 ! NILP (can_return_switch_frame
), 0);
10158 #ifdef HAVE_WINDOW_SYSTEM
10159 if (display_hourglass_p
)
10160 start_hourglass ();
10169 return unbind_to (count
, Fvector (i
, keybuf
));
10172 DEFUN ("command-execute", Fcommand_execute
, Scommand_execute
, 1, 4, 0,
10173 doc
: /* Execute CMD as an editor command.
10174 CMD must be a symbol that satisfies the `commandp' predicate.
10175 Optional second arg RECORD-FLAG non-nil
10176 means unconditionally put this command in `command-history'.
10177 Otherwise, that is done only if an arg is read using the minibuffer.
10178 The argument KEYS specifies the value to use instead of (this-command-keys)
10179 when reading the arguments; if it is nil, (this-command-keys) is used.
10180 The argument SPECIAL, if non-nil, means that this command is executing
10181 a special event, so ignore the prefix argument and don't clear it. */)
10182 (Lisp_Object cmd
, Lisp_Object record_flag
, Lisp_Object keys
, Lisp_Object special
)
10184 register Lisp_Object final
;
10185 register Lisp_Object tem
;
10186 Lisp_Object prefixarg
;
10188 debug_on_next_call
= 0;
10190 if (NILP (special
))
10192 prefixarg
= KVAR (current_kboard
, Vprefix_arg
);
10193 Vcurrent_prefix_arg
= prefixarg
;
10194 kset_prefix_arg (current_kboard
, Qnil
);
10201 tem
= Fget (cmd
, Qdisabled
);
10204 tem
= Fsymbol_value (Qdisabled_command_function
);
10206 return Frun_hooks (1, &Qdisabled_command_function
);
10212 final
= Findirect_function (cmd
, Qnil
);
10214 if (CONSP (final
) && (tem
= Fcar (final
), EQ (tem
, Qautoload
)))
10216 struct gcpro gcpro1
, gcpro2
;
10218 GCPRO2 (cmd
, prefixarg
);
10219 Fautoload_do_load (final
, cmd
, Qnil
);
10226 if (STRINGP (final
) || VECTORP (final
))
10228 /* If requested, place the macro in the command history. For
10229 other sorts of commands, call-interactively takes care of
10231 if (!NILP (record_flag
))
10234 = Fcons (Fcons (Qexecute_kbd_macro
,
10235 Fcons (final
, Fcons (prefixarg
, Qnil
))),
10238 /* Don't keep command history around forever. */
10239 if (NUMBERP (Vhistory_length
) && XINT (Vhistory_length
) > 0)
10241 tem
= Fnthcdr (Vhistory_length
, Vcommand_history
);
10243 XSETCDR (tem
, Qnil
);
10247 return Fexecute_kbd_macro (final
, prefixarg
, Qnil
);
10250 if (CONSP (final
) || SUBRP (final
) || COMPILEDP (final
))
10251 /* Don't call Fcall_interactively directly because we want to make
10252 sure the backtrace has an entry for `call-interactively'.
10253 For the same reason, pass `cmd' rather than `final'. */
10254 return call3 (Qcall_interactively
, cmd
, record_flag
, keys
);
10261 /* Return true if input events are pending. */
10264 detect_input_pending (void)
10266 return input_pending
|| get_input_pending (0);
10269 /* Return true if input events other than mouse movements are
10273 detect_input_pending_ignore_squeezables (void)
10275 return input_pending
|| get_input_pending (READABLE_EVENTS_IGNORE_SQUEEZABLES
);
10278 /* Return true if input events are pending, and run any pending timers. */
10281 detect_input_pending_run_timers (bool do_display
)
10283 unsigned old_timers_run
= timers_run
;
10285 if (!input_pending
)
10286 get_input_pending (READABLE_EVENTS_DO_TIMERS_NOW
);
10288 if (old_timers_run
!= timers_run
&& do_display
)
10290 redisplay_preserve_echo_area (8);
10291 /* The following fixes a bug when using lazy-lock with
10292 lazy-lock-defer-on-the-fly set to t, i.e. when fontifying
10293 from an idle timer function. The symptom of the bug is that
10294 the cursor sometimes doesn't become visible until the next X
10295 event is processed. --gerd. */
10297 Lisp_Object tail
, frame
;
10298 FOR_EACH_FRAME (tail
, frame
)
10299 if (FRAME_RIF (XFRAME (frame
)))
10300 FRAME_RIF (XFRAME (frame
))->flush_display (XFRAME (frame
));
10304 return input_pending
;
10307 /* This is called in some cases before a possible quit.
10308 It cases the next call to detect_input_pending to recompute input_pending.
10309 So calling this function unnecessarily can't do any harm. */
10312 clear_input_pending (void)
10317 /* Return true if there are pending requeued events.
10318 This isn't used yet. The hope is to make wait_reading_process_output
10319 call it, and return if it runs Lisp code that unreads something.
10320 The problem is, kbd_buffer_get_event needs to be fixed to know what
10321 to do in that case. It isn't trivial. */
10324 requeued_events_pending_p (void)
10326 return (!NILP (Vunread_command_events
));
10330 DEFUN ("input-pending-p", Finput_pending_p
, Sinput_pending_p
, 0, 0, 0,
10331 doc
: /* Return t if command input is currently available with no wait.
10332 Actually, the value is nil only if we can be sure that no input is available;
10333 if there is a doubt, the value is t. */)
10336 if (!NILP (Vunread_command_events
)
10337 || !NILP (Vunread_post_input_method_events
)
10338 || !NILP (Vunread_input_method_events
))
10341 /* Process non-user-visible events (Bug#10195). */
10342 process_special_events ();
10344 return (get_input_pending (READABLE_EVENTS_DO_TIMERS_NOW
10345 | READABLE_EVENTS_FILTER_EVENTS
)
10349 DEFUN ("recent-keys", Frecent_keys
, Srecent_keys
, 0, 0, 0,
10350 doc
: /* Return vector of last 300 events, not counting those from keyboard macros. */)
10353 Lisp_Object
*keys
= XVECTOR (recent_keys
)->contents
;
10356 if (total_keys
< NUM_RECENT_KEYS
)
10357 return Fvector (total_keys
, keys
);
10360 val
= Fvector (NUM_RECENT_KEYS
, keys
);
10361 vcopy (val
, 0, keys
+ recent_keys_index
,
10362 NUM_RECENT_KEYS
- recent_keys_index
);
10363 vcopy (val
, NUM_RECENT_KEYS
- recent_keys_index
,
10364 keys
, recent_keys_index
);
10369 DEFUN ("this-command-keys", Fthis_command_keys
, Sthis_command_keys
, 0, 0, 0,
10370 doc
: /* Return the key sequence that invoked this command.
10371 However, if the command has called `read-key-sequence', it returns
10372 the last key sequence that has been read.
10373 The value is a string or a vector.
10375 See also `this-command-keys-vector'. */)
10378 return make_event_array (this_command_key_count
,
10379 XVECTOR (this_command_keys
)->contents
);
10382 DEFUN ("this-command-keys-vector", Fthis_command_keys_vector
, Sthis_command_keys_vector
, 0, 0, 0,
10383 doc
: /* Return the key sequence that invoked this command, as a vector.
10384 However, if the command has called `read-key-sequence', it returns
10385 the last key sequence that has been read.
10387 See also `this-command-keys'. */)
10390 return Fvector (this_command_key_count
,
10391 XVECTOR (this_command_keys
)->contents
);
10394 DEFUN ("this-single-command-keys", Fthis_single_command_keys
,
10395 Sthis_single_command_keys
, 0, 0, 0,
10396 doc
: /* Return the key sequence that invoked this command.
10397 More generally, it returns the last key sequence read, either by
10398 the command loop or by `read-key-sequence'.
10399 Unlike `this-command-keys', this function's value
10400 does not include prefix arguments.
10401 The value is always a vector. */)
10404 return Fvector (this_command_key_count
10405 - this_single_command_key_start
,
10406 (XVECTOR (this_command_keys
)->contents
10407 + this_single_command_key_start
));
10410 DEFUN ("this-single-command-raw-keys", Fthis_single_command_raw_keys
,
10411 Sthis_single_command_raw_keys
, 0, 0, 0,
10412 doc
: /* Return the raw events that were read for this command.
10413 More generally, it returns the last key sequence read, either by
10414 the command loop or by `read-key-sequence'.
10415 Unlike `this-single-command-keys', this function's value
10416 shows the events before all translations (except for input methods).
10417 The value is always a vector. */)
10420 return Fvector (raw_keybuf_count
,
10421 (XVECTOR (raw_keybuf
)->contents
));
10424 DEFUN ("reset-this-command-lengths", Freset_this_command_lengths
,
10425 Sreset_this_command_lengths
, 0, 0, 0,
10426 doc
: /* Make the unread events replace the last command and echo.
10427 Used in `universal-argument-other-key'.
10429 `universal-argument-other-key' rereads the event just typed.
10430 It then gets translated through `function-key-map'.
10431 The translated event has to replace the real events,
10432 both in the value of (this-command-keys) and in echoing.
10433 To achieve this, `universal-argument-other-key' calls
10434 `reset-this-command-lengths', which discards the record of reading
10435 these events the first time. */)
10438 this_command_key_count
= before_command_key_count
;
10439 if (this_command_key_count
< this_single_command_key_start
)
10440 this_single_command_key_start
= this_command_key_count
;
10442 echo_truncate (before_command_echo_length
);
10444 /* Cause whatever we put into unread-command-events
10445 to echo as if it were being freshly read from the keyboard. */
10446 this_command_key_count_reset
= 1;
10451 DEFUN ("clear-this-command-keys", Fclear_this_command_keys
,
10452 Sclear_this_command_keys
, 0, 1, 0,
10453 doc
: /* Clear out the vector that `this-command-keys' returns.
10454 Also clear the record of the last 100 events, unless optional arg
10455 KEEP-RECORD is non-nil. */)
10456 (Lisp_Object keep_record
)
10460 this_command_key_count
= 0;
10461 this_command_key_count_reset
= 0;
10463 if (NILP (keep_record
))
10465 for (i
= 0; i
< ASIZE (recent_keys
); ++i
)
10466 ASET (recent_keys
, i
, Qnil
);
10468 recent_keys_index
= 0;
10473 DEFUN ("recursion-depth", Frecursion_depth
, Srecursion_depth
, 0, 0, 0,
10474 doc
: /* Return the current depth in recursive edits. */)
10478 /* Wrap around reliably on integer overflow. */
10479 EMACS_INT sum
= (command_loop_level
& INTMASK
) + (minibuf_level
& INTMASK
);
10480 XSETINT (temp
, sum
);
10484 DEFUN ("open-dribble-file", Fopen_dribble_file
, Sopen_dribble_file
, 1, 1,
10485 "FOpen dribble file: ",
10486 doc
: /* Start writing all keyboard characters to a dribble file called FILE.
10487 If FILE is nil, close any open dribble file.
10488 The file will be closed when Emacs exits. */)
10500 file
= Fexpand_file_name (file
, Qnil
);
10501 dribble
= fopen (SSDATA (file
), "w");
10503 report_file_error ("Opening dribble", Fcons (file
, Qnil
));
10508 DEFUN ("discard-input", Fdiscard_input
, Sdiscard_input
, 0, 0, 0,
10509 doc
: /* Discard the contents of the terminal input buffer.
10510 Also end any kbd macro being defined. */)
10513 if (!NILP (KVAR (current_kboard
, defining_kbd_macro
)))
10515 /* Discard the last command from the macro. */
10516 Fcancel_kbd_macro_events ();
10520 update_mode_lines
++;
10522 Vunread_command_events
= Qnil
;
10524 discard_tty_input ();
10526 kbd_fetch_ptr
= kbd_store_ptr
;
10532 DEFUN ("suspend-emacs", Fsuspend_emacs
, Ssuspend_emacs
, 0, 1, "",
10533 doc
: /* Stop Emacs and return to superior process. You can resume later.
10534 If `cannot-suspend' is non-nil, or if the system doesn't support job
10535 control, run a subshell instead.
10537 If optional arg STUFFSTRING is non-nil, its characters are stuffed
10538 to be read as terminal input by Emacs's parent, after suspension.
10540 Before suspending, run the normal hook `suspend-hook'.
10541 After resumption run the normal hook `suspend-resume-hook'.
10543 Some operating systems cannot stop the Emacs process and resume it later.
10544 On such systems, Emacs starts a subshell instead of suspending. */)
10545 (Lisp_Object stuffstring
)
10547 ptrdiff_t count
= SPECPDL_INDEX ();
10548 int old_height
, old_width
;
10550 struct gcpro gcpro1
;
10553 if (tty_list
&& tty_list
->next
)
10554 error ("There are other tty frames open; close them before suspending Emacs");
10556 if (!NILP (stuffstring
))
10557 CHECK_STRING (stuffstring
);
10559 /* Run the functions in suspend-hook. */
10560 hook
= intern ("suspend-hook");
10561 Frun_hooks (1, &hook
);
10563 GCPRO1 (stuffstring
);
10564 get_tty_size (fileno (CURTTY ()->input
), &old_width
, &old_height
);
10565 reset_all_sys_modes ();
10566 /* sys_suspend can get an error if it tries to fork a subshell
10567 and the system resources aren't available for that. */
10568 record_unwind_protect ((Lisp_Object (*) (Lisp_Object
)) init_all_sys_modes
,
10570 stuff_buffered_input (stuffstring
);
10571 if (cannot_suspend
)
10575 unbind_to (count
, Qnil
);
10577 /* Check if terminal/window size has changed.
10578 Note that this is not useful when we are running directly
10579 with a window system; but suspend should be disabled in that case. */
10580 get_tty_size (fileno (CURTTY ()->input
), &width
, &height
);
10581 if (width
!= old_width
|| height
!= old_height
)
10582 change_frame_size (SELECTED_FRAME (), height
, width
, 0, 0, 0);
10584 /* Run suspend-resume-hook. */
10585 hook
= intern ("suspend-resume-hook");
10586 Frun_hooks (1, &hook
);
10592 /* If STUFFSTRING is a string, stuff its contents as pending terminal input.
10593 Then in any case stuff anything Emacs has read ahead and not used. */
10596 stuff_buffered_input (Lisp_Object stuffstring
)
10598 #ifdef SIGTSTP /* stuff_char is defined if SIGTSTP. */
10599 register unsigned char *p
;
10601 if (STRINGP (stuffstring
))
10603 register ptrdiff_t count
;
10605 p
= SDATA (stuffstring
);
10606 count
= SBYTES (stuffstring
);
10607 while (count
-- > 0)
10612 /* Anything we have read ahead, put back for the shell to read. */
10613 /* ?? What should this do when we have multiple keyboards??
10614 Should we ignore anything that was typed in at the "wrong" kboard?
10616 rms: we should stuff everything back into the kboard
10618 for (; kbd_fetch_ptr
!= kbd_store_ptr
; kbd_fetch_ptr
++)
10621 if (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
10622 kbd_fetch_ptr
= kbd_buffer
;
10623 if (kbd_fetch_ptr
->kind
== ASCII_KEYSTROKE_EVENT
)
10624 stuff_char (kbd_fetch_ptr
->code
);
10626 clear_event (kbd_fetch_ptr
);
10630 #endif /* SIGTSTP */
10634 set_waiting_for_input (EMACS_TIME
*time_to_clear
)
10636 input_available_clear_time
= time_to_clear
;
10638 /* Tell handle_interrupt to throw back to read_char, */
10639 waiting_for_input
= 1;
10641 /* If handle_interrupt was called before and buffered a C-g,
10642 make it run again now, to avoid timing error. */
10643 if (!NILP (Vquit_flag
))
10644 quit_throw_to_read_char (0);
10648 clear_waiting_for_input (void)
10650 /* Tell handle_interrupt not to throw back to read_char, */
10651 waiting_for_input
= 0;
10652 input_available_clear_time
= 0;
10655 /* The SIGINT handler.
10657 If we have a frame on the controlling tty, we assume that the
10658 SIGINT was generated by C-g, so we call handle_interrupt.
10659 Otherwise, tell QUIT to kill Emacs. */
10662 handle_interrupt_signal (int sig
)
10664 /* See if we have an active terminal on our controlling tty. */
10665 struct terminal
*terminal
= get_named_tty ("/dev/tty");
10668 /* If there are no frames there, let's pretend that we are a
10669 well-behaving UN*X program and quit. We must not call Lisp
10670 in a signal handler, so tell QUIT to exit when it is
10672 Vquit_flag
= Qkill_emacs
;
10676 /* Otherwise, the SIGINT was probably generated by C-g. */
10678 /* Set internal_last_event_frame to the top frame of the
10679 controlling tty, if we have a frame there. We disable the
10680 interrupt key on secondary ttys, so the SIGINT must have come
10681 from the controlling tty. */
10682 internal_last_event_frame
= terminal
->display_info
.tty
->top_frame
;
10684 handle_interrupt (1);
10689 deliver_interrupt_signal (int sig
)
10691 deliver_process_signal (sig
, handle_interrupt_signal
);
10695 /* If Emacs is stuck because `inhibit-quit' is true, then keep track
10696 of the number of times C-g has been requested. If C-g is pressed
10697 enough times, then quit anyway. See bug#6585. */
10698 static int volatile force_quit_count
;
10700 /* This routine is called at interrupt level in response to C-g.
10702 It is called from the SIGINT handler or kbd_buffer_store_event.
10704 If `waiting_for_input' is non zero, then unless `echoing' is
10705 nonzero, immediately throw back to read_char.
10707 Otherwise it sets the Lisp variable quit-flag not-nil. This causes
10708 eval to throw, when it gets a chance. If quit-flag is already
10709 non-nil, it stops the job right away. */
10712 handle_interrupt (bool in_signal_handler
)
10718 /* XXX This code needs to be revised for multi-tty support. */
10719 if (!NILP (Vquit_flag
) && get_named_tty ("/dev/tty"))
10721 if (! in_signal_handler
)
10723 /* If SIGINT isn't blocked, don't let us be interrupted by
10724 a SIGINT. It might be harmful due to non-reentrancy
10725 in I/O functions. */
10727 sigemptyset (&blocked
);
10728 sigaddset (&blocked
, SIGINT
);
10729 pthread_sigmask (SIG_BLOCK
, &blocked
, 0);
10733 reset_all_sys_modes ();
10735 #ifdef SIGTSTP /* Support possible in later USG versions */
10737 * On systems which can suspend the current process and return to the original
10738 * shell, this command causes the user to end up back at the shell.
10739 * The "Auto-save" and "Abort" questions are not asked until
10740 * the user elects to return to emacs, at which point he can save the current
10741 * job and either dump core or continue.
10745 /* Perhaps should really fork an inferior shell?
10746 But that would not provide any way to get back
10747 to the original shell, ever. */
10748 printf ("No support for stopping a process on this operating system;\n");
10749 printf ("you can continue or abort.\n");
10750 #endif /* not SIGTSTP */
10752 /* We must remain inside the screen area when the internal terminal
10753 is used. Note that [Enter] is not echoed by dos. */
10754 cursor_to (SELECTED_FRAME (), 0, 0);
10756 /* It doesn't work to autosave while GC is in progress;
10757 the code used for auto-saving doesn't cope with the mark bit. */
10758 if (!gc_in_progress
)
10760 printf ("Auto-save? (y or n) ");
10762 if (((c
= getchar ()) & ~040) == 'Y')
10764 Fdo_auto_save (Qt
, Qnil
);
10766 printf ("\r\nAuto-save done");
10767 #else /* not MSDOS */
10768 printf ("Auto-save done\n");
10769 #endif /* not MSDOS */
10771 while (c
!= '\n') c
= getchar ();
10775 /* During GC, it must be safe to reenable quitting again. */
10776 Vinhibit_quit
= Qnil
;
10779 #endif /* not MSDOS */
10780 printf ("Garbage collection in progress; cannot auto-save now\r\n");
10781 printf ("but will instead do a real quit after garbage collection ends\r\n");
10786 printf ("\r\nAbort? (y or n) ");
10787 #else /* not MSDOS */
10788 printf ("Abort (and dump core)? (y or n) ");
10789 #endif /* not MSDOS */
10791 if (((c
= getchar ()) & ~040) == 'Y')
10793 while (c
!= '\n') c
= getchar ();
10795 printf ("\r\nContinuing...\r\n");
10796 #else /* not MSDOS */
10797 printf ("Continuing...\n");
10798 #endif /* not MSDOS */
10800 init_all_sys_modes ();
10804 /* If executing a function that wants to be interrupted out of
10805 and the user has not deferred quitting by binding `inhibit-quit'
10806 then quit right away. */
10807 if (immediate_quit
&& NILP (Vinhibit_quit
))
10809 struct gl_state_s saved
;
10810 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
10812 immediate_quit
= 0;
10813 pthread_sigmask (SIG_SETMASK
, &empty_mask
, 0);
10815 GCPRO4 (saved
.object
, saved
.global_code
,
10816 saved
.current_syntax_table
, saved
.old_prop
);
10817 Fsignal (Qquit
, Qnil
);
10822 { /* Else request quit when it's safe. */
10823 int count
= NILP (Vquit_flag
) ? 1 : force_quit_count
+ 1;
10824 force_quit_count
= count
;
10827 immediate_quit
= 1;
10828 Vinhibit_quit
= Qnil
;
10834 pthread_sigmask (SIG_SETMASK
, &empty_mask
, 0);
10836 /* TODO: The longjmp in this call throws the NS event loop integration off,
10837 and it seems to do fine without this. Probably some attention
10838 needs to be paid to the setting of waiting_for_input in
10839 wait_reading_process_output() under HAVE_NS because of the call
10840 to ns_select there (needed because otherwise events aren't picked up
10841 outside of polling since we don't get SIGIO like X and we don't have a
10842 separate event loop thread like W32. */
10844 if (waiting_for_input
&& !echoing
)
10845 quit_throw_to_read_char (in_signal_handler
);
10849 /* Handle a C-g by making read_char return C-g. */
10852 quit_throw_to_read_char (bool from_signal
)
10854 /* When not called from a signal handler it is safe to call
10856 if (!from_signal
&& EQ (Vquit_flag
, Qkill_emacs
))
10857 Fkill_emacs (Qnil
);
10859 /* Prevent another signal from doing this before we finish. */
10860 clear_waiting_for_input ();
10863 Vunread_command_events
= Qnil
;
10865 if (FRAMEP (internal_last_event_frame
)
10866 && !EQ (internal_last_event_frame
, selected_frame
))
10867 do_switch_frame (make_lispy_switch_frame (internal_last_event_frame
),
10870 sys_longjmp (getcjmp
, 1);
10873 DEFUN ("set-input-interrupt-mode", Fset_input_interrupt_mode
,
10874 Sset_input_interrupt_mode
, 1, 1, 0,
10875 doc
: /* Set interrupt mode of reading keyboard input.
10876 If INTERRUPT is non-nil, Emacs will use input interrupts;
10877 otherwise Emacs uses CBREAK mode.
10879 See also `current-input-mode'. */)
10880 (Lisp_Object interrupt
)
10882 bool new_interrupt_input
;
10883 #ifdef USABLE_SIGIO
10884 #ifdef HAVE_X_WINDOWS
10885 if (x_display_list
!= NULL
)
10887 /* When using X, don't give the user a real choice,
10888 because we haven't implemented the mechanisms to support it. */
10889 new_interrupt_input
= 1;
10892 #endif /* HAVE_X_WINDOWS */
10893 new_interrupt_input
= !NILP (interrupt
);
10894 #else /* not USABLE_SIGIO */
10895 new_interrupt_input
= 0;
10896 #endif /* not USABLE_SIGIO */
10898 if (new_interrupt_input
!= interrupt_input
)
10900 #ifdef POLL_FOR_INPUT
10904 /* this causes startup screen to be restored and messes with the mouse */
10905 reset_all_sys_modes ();
10906 interrupt_input
= new_interrupt_input
;
10907 init_all_sys_modes ();
10909 interrupt_input
= new_interrupt_input
;
10912 #ifdef POLL_FOR_INPUT
10913 poll_suppress_count
= 1;
10920 DEFUN ("set-output-flow-control", Fset_output_flow_control
, Sset_output_flow_control
, 1, 2, 0,
10921 doc
: /* Enable or disable ^S/^Q flow control for output to TERMINAL.
10922 If FLOW is non-nil, flow control is enabled and you cannot use C-s or
10923 C-q in key sequences.
10925 This setting only has an effect on tty terminals and only when
10926 Emacs reads input in CBREAK mode; see `set-input-interrupt-mode'.
10928 See also `current-input-mode'. */)
10929 (Lisp_Object flow
, Lisp_Object terminal
)
10931 struct terminal
*t
= get_terminal (terminal
, 1);
10932 struct tty_display_info
*tty
;
10933 if (t
== NULL
|| (t
->type
!= output_termcap
&& t
->type
!= output_msdos_raw
))
10935 tty
= t
->display_info
.tty
;
10937 if (tty
->flow_control
!= !NILP (flow
))
10940 /* this causes startup screen to be restored and messes with the mouse */
10941 reset_sys_modes (tty
);
10944 tty
->flow_control
= !NILP (flow
);
10947 init_sys_modes (tty
);
10953 DEFUN ("set-input-meta-mode", Fset_input_meta_mode
, Sset_input_meta_mode
, 1, 2, 0,
10954 doc
: /* Enable or disable 8-bit input on TERMINAL.
10955 If META is t, Emacs will accept 8-bit input, and interpret the 8th
10956 bit as the Meta modifier.
10958 If META is nil, Emacs will ignore the top bit, on the assumption it is
10961 Otherwise, Emacs will accept and pass through 8-bit input without
10962 specially interpreting the top bit.
10964 This setting only has an effect on tty terminal devices.
10966 Optional parameter TERMINAL specifies the tty terminal device to use.
10967 It may be a terminal object, a frame, or nil for the terminal used by
10968 the currently selected frame.
10970 See also `current-input-mode'. */)
10971 (Lisp_Object meta
, Lisp_Object terminal
)
10973 struct terminal
*t
= get_terminal (terminal
, 1);
10974 struct tty_display_info
*tty
;
10977 if (t
== NULL
|| (t
->type
!= output_termcap
&& t
->type
!= output_msdos_raw
))
10979 tty
= t
->display_info
.tty
;
10983 else if (EQ (meta
, Qt
))
10988 if (tty
->meta_key
!= new_meta
)
10991 /* this causes startup screen to be restored and messes with the mouse */
10992 reset_sys_modes (tty
);
10995 tty
->meta_key
= new_meta
;
10998 init_sys_modes (tty
);
11004 DEFUN ("set-quit-char", Fset_quit_char
, Sset_quit_char
, 1, 1, 0,
11005 doc
: /* Specify character used for quitting.
11006 QUIT must be an ASCII character.
11008 This function only has an effect on the controlling tty of the Emacs
11011 See also `current-input-mode'. */)
11014 struct terminal
*t
= get_named_tty ("/dev/tty");
11015 struct tty_display_info
*tty
;
11016 if (t
== NULL
|| (t
->type
!= output_termcap
&& t
->type
!= output_msdos_raw
))
11018 tty
= t
->display_info
.tty
;
11020 if (NILP (quit
) || !INTEGERP (quit
) || XINT (quit
) < 0 || XINT (quit
) > 0400)
11021 error ("QUIT must be an ASCII character");
11024 /* this causes startup screen to be restored and messes with the mouse */
11025 reset_sys_modes (tty
);
11028 /* Don't let this value be out of range. */
11029 quit_char
= XINT (quit
) & (tty
->meta_key
== 0 ? 0177 : 0377);
11032 init_sys_modes (tty
);
11038 DEFUN ("set-input-mode", Fset_input_mode
, Sset_input_mode
, 3, 4, 0,
11039 doc
: /* Set mode of reading keyboard input.
11040 First arg INTERRUPT non-nil means use input interrupts;
11041 nil means use CBREAK mode.
11042 Second arg FLOW non-nil means use ^S/^Q flow control for output to terminal
11043 (no effect except in CBREAK mode).
11044 Third arg META t means accept 8-bit input (for a Meta key).
11045 META nil means ignore the top bit, on the assumption it is parity.
11046 Otherwise, accept 8-bit input and don't use the top bit for Meta.
11047 Optional fourth arg QUIT if non-nil specifies character to use for quitting.
11048 See also `current-input-mode'. */)
11049 (Lisp_Object interrupt
, Lisp_Object flow
, Lisp_Object meta
, Lisp_Object quit
)
11051 Fset_input_interrupt_mode (interrupt
);
11052 Fset_output_flow_control (flow
, Qnil
);
11053 Fset_input_meta_mode (meta
, Qnil
);
11055 Fset_quit_char (quit
);
11059 DEFUN ("current-input-mode", Fcurrent_input_mode
, Scurrent_input_mode
, 0, 0, 0,
11060 doc
: /* Return information about the way Emacs currently reads keyboard input.
11061 The value is a list of the form (INTERRUPT FLOW META QUIT), where
11062 INTERRUPT is non-nil if Emacs is using interrupt-driven input; if
11063 nil, Emacs is using CBREAK mode.
11064 FLOW is non-nil if Emacs uses ^S/^Q flow control for output to the
11065 terminal; this does not apply if Emacs uses interrupt-driven input.
11066 META is t if accepting 8-bit input with 8th bit as Meta flag.
11067 META nil means ignoring the top bit, on the assumption it is parity.
11068 META is neither t nor nil if accepting 8-bit input and using
11069 all 8 bits as the character code.
11070 QUIT is the character Emacs currently uses to quit.
11071 The elements of this list correspond to the arguments of
11072 `set-input-mode'. */)
11075 Lisp_Object val
[4];
11076 struct frame
*sf
= XFRAME (selected_frame
);
11078 val
[0] = interrupt_input
? Qt
: Qnil
;
11079 if (FRAME_TERMCAP_P (sf
) || FRAME_MSDOS_P (sf
))
11081 val
[1] = FRAME_TTY (sf
)->flow_control
? Qt
: Qnil
;
11082 val
[2] = (FRAME_TTY (sf
)->meta_key
== 2
11084 : (CURTTY ()->meta_key
== 1 ? Qt
: Qnil
));
11091 XSETFASTINT (val
[3], quit_char
);
11093 return Flist (sizeof (val
) / sizeof (val
[0]), val
);
11096 DEFUN ("posn-at-x-y", Fposn_at_x_y
, Sposn_at_x_y
, 2, 4, 0,
11097 doc
: /* Return position information for pixel coordinates X and Y.
11098 By default, X and Y are relative to text area of the selected window.
11099 Optional third arg FRAME-OR-WINDOW non-nil specifies frame or window.
11100 If optional fourth arg WHOLE is non-nil, X is relative to the left
11101 edge of the window.
11103 The return value is similar to a mouse click position:
11104 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
11105 IMAGE (DX . DY) (WIDTH . HEIGHT))
11106 The `posn-' functions access elements of such lists. */)
11107 (Lisp_Object x
, Lisp_Object y
, Lisp_Object frame_or_window
, Lisp_Object whole
)
11112 if (NILP (frame_or_window
))
11113 frame_or_window
= selected_window
;
11115 if (WINDOWP (frame_or_window
))
11117 struct window
*w
= decode_live_window (frame_or_window
);
11119 XSETINT (x
, (XINT (x
)
11120 + WINDOW_LEFT_EDGE_X (w
)
11122 ? window_box_left_offset (w
, TEXT_AREA
)
11124 XSETINT (y
, WINDOW_TO_FRAME_PIXEL_Y (w
, XINT (y
)));
11125 frame_or_window
= w
->frame
;
11128 CHECK_LIVE_FRAME (frame_or_window
);
11130 return make_lispy_position (XFRAME (frame_or_window
), x
, y
, 0);
11133 DEFUN ("posn-at-point", Fposn_at_point
, Sposn_at_point
, 0, 2, 0,
11134 doc
: /* Return position information for buffer POS in WINDOW.
11135 POS defaults to point in WINDOW; WINDOW defaults to the selected window.
11137 Return nil if position is not visible in window. Otherwise,
11138 the return value is similar to that returned by `event-start' for
11139 a mouse click at the upper left corner of the glyph corresponding
11140 to the given buffer position:
11141 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
11142 IMAGE (DX . DY) (WIDTH . HEIGHT))
11143 The `posn-' functions access elements of such lists. */)
11144 (Lisp_Object pos
, Lisp_Object window
)
11149 window
= selected_window
;
11151 tem
= Fpos_visible_in_window_p (pos
, window
, Qt
);
11154 Lisp_Object x
= XCAR (tem
);
11155 Lisp_Object y
= XCAR (XCDR (tem
));
11157 /* Point invisible due to hscrolling? */
11160 tem
= Fposn_at_x_y (x
, y
, window
, Qnil
);
11168 * Set up a new kboard object with reasonable initial values.
11171 init_kboard (KBOARD
*kb
)
11173 kset_overriding_terminal_local_map (kb
, Qnil
);
11174 kset_last_command (kb
, Qnil
);
11175 kset_real_last_command (kb
, Qnil
);
11176 kset_keyboard_translate_table (kb
, Qnil
);
11177 kset_last_repeatable_command (kb
, Qnil
);
11178 kset_prefix_arg (kb
, Qnil
);
11179 kset_last_prefix_arg (kb
, Qnil
);
11180 kset_kbd_queue (kb
, Qnil
);
11181 kb
->kbd_queue_has_data
= 0;
11182 kb
->immediate_echo
= 0;
11183 kset_echo_string (kb
, Qnil
);
11184 kb
->echo_after_prompt
= -1;
11185 kb
->kbd_macro_buffer
= 0;
11186 kb
->kbd_macro_bufsize
= 0;
11187 kset_defining_kbd_macro (kb
, Qnil
);
11188 kset_last_kbd_macro (kb
, Qnil
);
11189 kb
->reference_count
= 0;
11190 kset_system_key_alist (kb
, Qnil
);
11191 kset_system_key_syms (kb
, Qnil
);
11192 kset_window_system (kb
, Qt
); /* Unset. */
11193 kset_input_decode_map (kb
, Fmake_sparse_keymap (Qnil
));
11194 kset_local_function_key_map (kb
, Fmake_sparse_keymap (Qnil
));
11195 Fset_keymap_parent (KVAR (kb
, Vlocal_function_key_map
), Vfunction_key_map
);
11196 kset_default_minibuffer_frame (kb
, Qnil
);
11200 * Destroy the contents of a kboard object, but not the object itself.
11201 * We use this just before deleting it, or if we're going to initialize
11202 * it a second time.
11205 wipe_kboard (KBOARD
*kb
)
11207 xfree (kb
->kbd_macro_buffer
);
11210 /* Free KB and memory referenced from it. */
11213 delete_kboard (KBOARD
*kb
)
11217 for (kbp
= &all_kboards
; *kbp
!= kb
; kbp
= &(*kbp
)->next_kboard
)
11220 *kbp
= kb
->next_kboard
;
11222 /* Prevent a dangling reference to KB. */
11223 if (kb
== current_kboard
11224 && FRAMEP (selected_frame
)
11225 && FRAME_LIVE_P (XFRAME (selected_frame
)))
11227 current_kboard
= FRAME_KBOARD (XFRAME (selected_frame
));
11229 if (current_kboard
== kb
)
11238 init_keyboard (void)
11240 /* This is correct before outermost invocation of the editor loop. */
11241 command_loop_level
= -1;
11242 immediate_quit
= 0;
11243 quit_char
= Ctl ('g');
11244 Vunread_command_events
= Qnil
;
11245 timer_idleness_start_time
= invalid_emacs_time ();
11247 recent_keys_index
= 0;
11248 kbd_fetch_ptr
= kbd_buffer
;
11249 kbd_store_ptr
= kbd_buffer
;
11250 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
11251 do_mouse_tracking
= Qnil
;
11254 interrupt_input_blocked
= 0;
11255 pending_signals
= 0;
11257 /* This means that command_loop_1 won't try to select anything the first
11259 internal_last_event_frame
= Qnil
;
11260 Vlast_event_frame
= internal_last_event_frame
;
11262 current_kboard
= initial_kboard
;
11263 /* Re-initialize the keyboard again. */
11264 wipe_kboard (current_kboard
);
11265 init_kboard (current_kboard
);
11266 /* A value of nil for Vwindow_system normally means a tty, but we also use
11267 it for the initial terminal since there is no window system there. */
11268 kset_window_system (current_kboard
, Qnil
);
11270 if (!noninteractive
)
11272 /* Before multi-tty support, these handlers used to be installed
11273 only if the current session was a tty session. Now an Emacs
11274 session may have multiple display types, so we always handle
11275 SIGINT. There is special code in handle_interrupt_signal to exit
11276 Emacs on SIGINT when there are no termcap frames on the
11277 controlling terminal. */
11278 struct sigaction action
;
11279 emacs_sigaction_init (&action
, deliver_interrupt_signal
);
11280 sigaction (SIGINT
, &action
, 0);
11282 /* For systems with SysV TERMIO, C-g is set up for both SIGINT and
11283 SIGQUIT and we can't tell which one it will give us. */
11284 sigaction (SIGQUIT
, &action
, 0);
11285 #endif /* not DOS_NT */
11287 #ifdef USABLE_SIGIO
11288 if (!noninteractive
)
11290 struct sigaction action
;
11291 emacs_sigaction_init (&action
, deliver_input_available_signal
);
11292 sigaction (SIGIO
, &action
, 0);
11296 /* Use interrupt input by default, if it works and noninterrupt input
11297 has deficiencies. */
11299 #ifdef INTERRUPT_INPUT
11300 interrupt_input
= 1;
11302 interrupt_input
= 0;
11305 pthread_sigmask (SIG_SETMASK
, &empty_mask
, 0);
11308 if (keyboard_init_hook
)
11309 (*keyboard_init_hook
) ();
11311 #ifdef POLL_FOR_INPUT
11313 poll_suppress_count
= 1;
11318 /* This type's only use is in syms_of_keyboard, to initialize the
11319 event header symbols and put properties on them. */
11320 struct event_head
{
11326 static const struct event_head head_table
[] = {
11327 {&Qmouse_movement
, "mouse-movement", &Qmouse_movement
},
11328 {&Qscroll_bar_movement
, "scroll-bar-movement", &Qmouse_movement
},
11329 {&Qswitch_frame
, "switch-frame", &Qswitch_frame
},
11330 {&Qdelete_frame
, "delete-frame", &Qdelete_frame
},
11331 {&Qiconify_frame
, "iconify-frame", &Qiconify_frame
},
11332 {&Qmake_frame_visible
, "make-frame-visible", &Qmake_frame_visible
},
11333 /* `select-window' should be handled just like `switch-frame'
11334 in read_key_sequence. */
11335 {&Qselect_window
, "select-window", &Qswitch_frame
}
11339 syms_of_keyboard (void)
11341 pending_funcalls
= Qnil
;
11342 staticpro (&pending_funcalls
);
11344 Vlispy_mouse_stem
= build_pure_c_string ("mouse");
11345 staticpro (&Vlispy_mouse_stem
);
11348 DEFSYM (QCimage
, ":image");
11349 DEFSYM (Qhelp_echo
, "help-echo");
11350 DEFSYM (QCrtl
, ":rtl");
11352 staticpro (&item_properties
);
11353 item_properties
= Qnil
;
11355 staticpro (&tool_bar_item_properties
);
11356 tool_bar_item_properties
= Qnil
;
11357 staticpro (&tool_bar_items_vector
);
11358 tool_bar_items_vector
= Qnil
;
11360 DEFSYM (Qtimer_event_handler
, "timer-event-handler");
11361 DEFSYM (Qdisabled_command_function
, "disabled-command-function");
11362 DEFSYM (Qself_insert_command
, "self-insert-command");
11363 DEFSYM (Qforward_char
, "forward-char");
11364 DEFSYM (Qbackward_char
, "backward-char");
11365 DEFSYM (Qdisabled
, "disabled");
11366 DEFSYM (Qundefined
, "undefined");
11367 DEFSYM (Qpre_command_hook
, "pre-command-hook");
11368 DEFSYM (Qpost_command_hook
, "post-command-hook");
11369 DEFSYM (Qdeferred_action_function
, "deferred-action-function");
11370 DEFSYM (Qdelayed_warnings_hook
, "delayed-warnings-hook");
11371 DEFSYM (Qfunction_key
, "function-key");
11372 DEFSYM (Qmouse_click
, "mouse-click");
11373 DEFSYM (Qdrag_n_drop
, "drag-n-drop");
11374 DEFSYM (Qsave_session
, "save-session");
11375 DEFSYM (Qconfig_changed_event
, "config-changed-event");
11376 DEFSYM (Qmenu_enable
, "menu-enable");
11379 DEFSYM (Qlanguage_change
, "language-change");
11380 DEFSYM (Qfile_notify
, "file-notify");
11384 DEFSYM (Qdbus_event
, "dbus-event");
11387 DEFSYM (QCenable
, ":enable");
11388 DEFSYM (QCvisible
, ":visible");
11389 DEFSYM (QChelp
, ":help");
11390 DEFSYM (QCfilter
, ":filter");
11391 DEFSYM (QCbutton
, ":button");
11392 DEFSYM (QCkeys
, ":keys");
11393 DEFSYM (QCkey_sequence
, ":key-sequence");
11394 DEFSYM (QCtoggle
, ":toggle");
11395 DEFSYM (QCradio
, ":radio");
11396 DEFSYM (QClabel
, ":label");
11397 DEFSYM (QCvert_only
, ":vert-only");
11399 DEFSYM (Qmode_line
, "mode-line");
11400 DEFSYM (Qvertical_line
, "vertical-line");
11401 DEFSYM (Qvertical_scroll_bar
, "vertical-scroll-bar");
11402 DEFSYM (Qmenu_bar
, "menu-bar");
11404 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
11405 DEFSYM (Qmouse_fixup_help_message
, "mouse-fixup-help-message");
11408 DEFSYM (Qabove_handle
, "above-handle");
11409 DEFSYM (Qhandle
, "handle");
11410 DEFSYM (Qbelow_handle
, "below-handle");
11411 DEFSYM (Qup
, "up");
11412 DEFSYM (Qdown
, "down");
11413 DEFSYM (Qtop
, "top");
11414 DEFSYM (Qbottom
, "bottom");
11415 DEFSYM (Qend_scroll
, "end-scroll");
11416 DEFSYM (Qratio
, "ratio");
11418 DEFSYM (Qevent_kind
, "event-kind");
11419 DEFSYM (Qevent_symbol_elements
, "event-symbol-elements");
11420 DEFSYM (Qevent_symbol_element_mask
, "event-symbol-element-mask");
11421 DEFSYM (Qmodifier_cache
, "modifier-cache");
11423 DEFSYM (Qrecompute_lucid_menubar
, "recompute-lucid-menubar");
11424 DEFSYM (Qactivate_menubar_hook
, "activate-menubar-hook");
11426 DEFSYM (Qpolling_period
, "polling-period");
11428 DEFSYM (Qx_set_selection
, "x-set-selection");
11429 DEFSYM (QPRIMARY
, "PRIMARY");
11430 DEFSYM (Qhandle_switch_frame
, "handle-switch-frame");
11431 DEFSYM (Qhandle_select_window
, "handle-select-window");
11433 DEFSYM (Qinput_method_function
, "input-method-function");
11434 DEFSYM (Qinput_method_exit_on_first_char
, "input-method-exit-on-first-char");
11435 DEFSYM (Qinput_method_use_echo_area
, "input-method-use-echo-area");
11437 DEFSYM (Qhelp_form_show
, "help-form-show");
11439 Fset (Qinput_method_exit_on_first_char
, Qnil
);
11440 Fset (Qinput_method_use_echo_area
, Qnil
);
11442 last_point_position_buffer
= Qnil
;
11443 last_point_position_window
= Qnil
;
11447 int len
= sizeof (head_table
) / sizeof (head_table
[0]);
11449 for (i
= 0; i
< len
; i
++)
11451 const struct event_head
*p
= &head_table
[i
];
11452 *p
->var
= intern_c_string (p
->name
);
11453 staticpro (p
->var
);
11454 Fput (*p
->var
, Qevent_kind
, *p
->kind
);
11455 Fput (*p
->var
, Qevent_symbol_elements
, Fcons (*p
->var
, Qnil
));
11459 button_down_location
= Fmake_vector (make_number (5), Qnil
);
11460 staticpro (&button_down_location
);
11461 mouse_syms
= Fmake_vector (make_number (5), Qnil
);
11462 staticpro (&mouse_syms
);
11463 wheel_syms
= Fmake_vector (make_number (sizeof (lispy_wheel_names
)
11464 / sizeof (lispy_wheel_names
[0])),
11466 staticpro (&wheel_syms
);
11470 int len
= sizeof (modifier_names
) / sizeof (modifier_names
[0]);
11472 modifier_symbols
= Fmake_vector (make_number (len
), Qnil
);
11473 for (i
= 0; i
< len
; i
++)
11474 if (modifier_names
[i
])
11475 ASET (modifier_symbols
, i
, intern_c_string (modifier_names
[i
]));
11476 staticpro (&modifier_symbols
);
11479 recent_keys
= Fmake_vector (make_number (NUM_RECENT_KEYS
), Qnil
);
11480 staticpro (&recent_keys
);
11482 this_command_keys
= Fmake_vector (make_number (40), Qnil
);
11483 staticpro (&this_command_keys
);
11485 raw_keybuf
= Fmake_vector (make_number (30), Qnil
);
11486 staticpro (&raw_keybuf
);
11488 DEFSYM (Qextended_command_history
, "extended-command-history");
11489 Fset (Qextended_command_history
, Qnil
);
11491 accent_key_syms
= Qnil
;
11492 staticpro (&accent_key_syms
);
11494 func_key_syms
= Qnil
;
11495 staticpro (&func_key_syms
);
11497 drag_n_drop_syms
= Qnil
;
11498 staticpro (&drag_n_drop_syms
);
11500 unread_switch_frame
= Qnil
;
11501 staticpro (&unread_switch_frame
);
11503 internal_last_event_frame
= Qnil
;
11504 staticpro (&internal_last_event_frame
);
11506 read_key_sequence_cmd
= Qnil
;
11507 staticpro (&read_key_sequence_cmd
);
11508 read_key_sequence_remapped
= Qnil
;
11509 staticpro (&read_key_sequence_remapped
);
11511 menu_bar_one_keymap_changed_items
= Qnil
;
11512 staticpro (&menu_bar_one_keymap_changed_items
);
11514 menu_bar_items_vector
= Qnil
;
11515 staticpro (&menu_bar_items_vector
);
11517 help_form_saved_window_configs
= Qnil
;
11518 staticpro (&help_form_saved_window_configs
);
11520 defsubr (&Scurrent_idle_time
);
11521 defsubr (&Sevent_symbol_parse_modifiers
);
11522 defsubr (&Sevent_convert_list
);
11523 defsubr (&Sread_key_sequence
);
11524 defsubr (&Sread_key_sequence_vector
);
11525 defsubr (&Srecursive_edit
);
11526 #if defined (HAVE_MOUSE) || defined (HAVE_GPM)
11527 defsubr (&Strack_mouse
);
11529 defsubr (&Sinput_pending_p
);
11530 defsubr (&Scommand_execute
);
11531 defsubr (&Srecent_keys
);
11532 defsubr (&Sthis_command_keys
);
11533 defsubr (&Sthis_command_keys_vector
);
11534 defsubr (&Sthis_single_command_keys
);
11535 defsubr (&Sthis_single_command_raw_keys
);
11536 defsubr (&Sreset_this_command_lengths
);
11537 defsubr (&Sclear_this_command_keys
);
11538 defsubr (&Ssuspend_emacs
);
11539 defsubr (&Sabort_recursive_edit
);
11540 defsubr (&Sexit_recursive_edit
);
11541 defsubr (&Srecursion_depth
);
11542 defsubr (&Stop_level
);
11543 defsubr (&Sdiscard_input
);
11544 defsubr (&Sopen_dribble_file
);
11545 defsubr (&Sset_input_interrupt_mode
);
11546 defsubr (&Sset_output_flow_control
);
11547 defsubr (&Sset_input_meta_mode
);
11548 defsubr (&Sset_quit_char
);
11549 defsubr (&Sset_input_mode
);
11550 defsubr (&Scurrent_input_mode
);
11551 defsubr (&Sposn_at_point
);
11552 defsubr (&Sposn_at_x_y
);
11554 DEFVAR_LISP ("last-command-event", last_command_event
,
11555 doc
: /* Last input event that was part of a command. */);
11557 DEFVAR_LISP ("last-nonmenu-event", last_nonmenu_event
,
11558 doc
: /* Last input event in a command, except for mouse menu events.
11559 Mouse menus give back keys that don't look like mouse events;
11560 this variable holds the actual mouse event that led to the menu,
11561 so that you can determine whether the command was run by mouse or not. */);
11563 DEFVAR_LISP ("last-input-event", last_input_event
,
11564 doc
: /* Last input event. */);
11566 DEFVAR_LISP ("unread-command-events", Vunread_command_events
,
11567 doc
: /* List of events to be read as the command input.
11568 These events are processed first, before actual keyboard input.
11569 Events read from this list are not normally added to `this-command-keys',
11570 as they will already have been added once as they were read for the first time.
11571 An element of the form (t . EVENT) forces EVENT to be added to that list. */);
11572 Vunread_command_events
= Qnil
;
11574 DEFVAR_LISP ("unread-post-input-method-events", Vunread_post_input_method_events
,
11575 doc
: /* List of events to be processed as input by input methods.
11576 These events are processed before `unread-command-events'
11577 and actual keyboard input, but are not given to `input-method-function'. */);
11578 Vunread_post_input_method_events
= Qnil
;
11580 DEFVAR_LISP ("unread-input-method-events", Vunread_input_method_events
,
11581 doc
: /* List of events to be processed as input by input methods.
11582 These events are processed after `unread-command-events', but
11583 before actual keyboard input.
11584 If there's an active input method, the events are given to
11585 `input-method-function'. */);
11586 Vunread_input_method_events
= Qnil
;
11588 DEFVAR_LISP ("meta-prefix-char", meta_prefix_char
,
11589 doc
: /* Meta-prefix character code.
11590 Meta-foo as command input turns into this character followed by foo. */);
11591 XSETINT (meta_prefix_char
, 033);
11593 DEFVAR_KBOARD ("last-command", Vlast_command
,
11594 doc
: /* The last command executed.
11595 Normally a symbol with a function definition, but can be whatever was found
11596 in the keymap, or whatever the variable `this-command' was set to by that
11599 The value `mode-exit' is special; it means that the previous command
11600 read an event that told it to exit, and it did so and unread that event.
11601 In other words, the present command is the event that made the previous
11604 The value `kill-region' is special; it means that the previous command
11605 was a kill command.
11607 `last-command' has a separate binding for each terminal device.
11608 See Info node `(elisp)Multiple Terminals'. */);
11610 DEFVAR_KBOARD ("real-last-command", Vreal_last_command
,
11611 doc
: /* Same as `last-command', but never altered by Lisp code.
11612 Taken from the previous value of `real-this-command'. */);
11614 DEFVAR_KBOARD ("last-repeatable-command", Vlast_repeatable_command
,
11615 doc
: /* Last command that may be repeated.
11616 The last command executed that was not bound to an input event.
11617 This is the command `repeat' will try to repeat.
11618 Taken from a previous value of `real-this-command'. */);
11620 DEFVAR_LISP ("this-command", Vthis_command
,
11621 doc
: /* The command now being executed.
11622 The command can set this variable; whatever is put here
11623 will be in `last-command' during the following command. */);
11624 Vthis_command
= Qnil
;
11626 DEFVAR_LISP ("real-this-command", Vreal_this_command
,
11627 doc
: /* This is like `this-command', except that commands should never modify it. */);
11628 Vreal_this_command
= Qnil
;
11630 DEFVAR_LISP ("this-command-keys-shift-translated",
11631 Vthis_command_keys_shift_translated
,
11632 doc
: /* Non-nil if the key sequence activating this command was shift-translated.
11633 Shift-translation occurs when there is no binding for the key sequence
11634 as entered, but a binding was found by changing an upper-case letter
11635 to lower-case, or a shifted function key to an unshifted one. */);
11636 Vthis_command_keys_shift_translated
= Qnil
;
11638 DEFVAR_LISP ("this-original-command", Vthis_original_command
,
11639 doc
: /* The command bound to the current key sequence before remapping.
11640 It equals `this-command' if the original command was not remapped through
11641 any of the active keymaps. Otherwise, the value of `this-command' is the
11642 result of looking up the original command in the active keymaps. */);
11643 Vthis_original_command
= Qnil
;
11645 DEFVAR_INT ("auto-save-interval", auto_save_interval
,
11646 doc
: /* Number of input events between auto-saves.
11647 Zero means disable autosaving due to number of characters typed. */);
11648 auto_save_interval
= 300;
11650 DEFVAR_LISP ("auto-save-timeout", Vauto_save_timeout
,
11651 doc
: /* Number of seconds idle time before auto-save.
11652 Zero or nil means disable auto-saving due to idleness.
11653 After auto-saving due to this many seconds of idle time,
11654 Emacs also does a garbage collection if that seems to be warranted. */);
11655 XSETFASTINT (Vauto_save_timeout
, 30);
11657 DEFVAR_LISP ("echo-keystrokes", Vecho_keystrokes
,
11658 doc
: /* Nonzero means echo unfinished commands after this many seconds of pause.
11659 The value may be integer or floating point.
11660 If the value is zero, don't echo at all. */);
11661 Vecho_keystrokes
= make_number (1);
11663 DEFVAR_INT ("polling-period", polling_period
,
11664 doc
: /* Interval between polling for input during Lisp execution.
11665 The reason for polling is to make C-g work to stop a running program.
11666 Polling is needed only when using X windows and SIGIO does not work.
11667 Polling is automatically disabled in all other cases. */);
11668 polling_period
= 2;
11670 DEFVAR_LISP ("double-click-time", Vdouble_click_time
,
11671 doc
: /* Maximum time between mouse clicks to make a double-click.
11672 Measured in milliseconds. The value nil means disable double-click
11673 recognition; t means double-clicks have no time limit and are detected
11674 by position only. */);
11675 Vdouble_click_time
= make_number (500);
11677 DEFVAR_INT ("double-click-fuzz", double_click_fuzz
,
11678 doc
: /* Maximum mouse movement between clicks to make a double-click.
11679 On window-system frames, value is the number of pixels the mouse may have
11680 moved horizontally or vertically between two clicks to make a double-click.
11681 On non window-system frames, value is interpreted in units of 1/8 characters
11684 This variable is also the threshold for motion of the mouse
11685 to count as a drag. */);
11686 double_click_fuzz
= 3;
11688 DEFVAR_BOOL ("inhibit-local-menu-bar-menus", inhibit_local_menu_bar_menus
,
11689 doc
: /* Non-nil means inhibit local map menu bar menus. */);
11690 inhibit_local_menu_bar_menus
= 0;
11692 DEFVAR_INT ("num-input-keys", num_input_keys
,
11693 doc
: /* Number of complete key sequences read as input so far.
11694 This includes key sequences read from keyboard macros.
11695 The number is effectively the number of interactive command invocations. */);
11696 num_input_keys
= 0;
11698 DEFVAR_INT ("num-nonmacro-input-events", num_nonmacro_input_events
,
11699 doc
: /* Number of input events read from the keyboard so far.
11700 This does not include events generated by keyboard macros. */);
11701 num_nonmacro_input_events
= 0;
11703 DEFVAR_LISP ("last-event-frame", Vlast_event_frame
,
11704 doc
: /* The frame in which the most recently read event occurred.
11705 If the last event came from a keyboard macro, this is set to `macro'. */);
11706 Vlast_event_frame
= Qnil
;
11708 /* This variable is set up in sysdep.c. */
11709 DEFVAR_LISP ("tty-erase-char", Vtty_erase_char
,
11710 doc
: /* The ERASE character as set by the user with stty. */);
11712 DEFVAR_LISP ("help-char", Vhelp_char
,
11713 doc
: /* Character to recognize as meaning Help.
11714 When it is read, do `(eval help-form)', and display result if it's a string.
11715 If the value of `help-form' is nil, this char can be read normally. */);
11716 XSETINT (Vhelp_char
, Ctl ('H'));
11718 DEFVAR_LISP ("help-event-list", Vhelp_event_list
,
11719 doc
: /* List of input events to recognize as meaning Help.
11720 These work just like the value of `help-char' (see that). */);
11721 Vhelp_event_list
= Qnil
;
11723 DEFVAR_LISP ("help-form", Vhelp_form
,
11724 doc
: /* Form to execute when character `help-char' is read.
11725 If the form returns a string, that string is displayed.
11726 If `help-form' is nil, the help char is not recognized. */);
11729 DEFVAR_LISP ("prefix-help-command", Vprefix_help_command
,
11730 doc
: /* Command to run when `help-char' character follows a prefix key.
11731 This command is used only when there is no actual binding
11732 for that character after that prefix key. */);
11733 Vprefix_help_command
= Qnil
;
11735 DEFVAR_LISP ("top-level", Vtop_level
,
11736 doc
: /* Form to evaluate when Emacs starts up.
11737 Useful to set before you dump a modified Emacs. */);
11740 DEFVAR_KBOARD ("keyboard-translate-table", Vkeyboard_translate_table
,
11741 doc
: /* Translate table for local keyboard input, or nil.
11742 If non-nil, the value should be a char-table. Each character read
11743 from the keyboard is looked up in this char-table. If the value found
11744 there is non-nil, then it is used instead of the actual input character.
11746 The value can also be a string or vector, but this is considered obsolete.
11747 If it is a string or vector of length N, character codes N and up are left
11748 untranslated. In a vector, an element which is nil means "no translation".
11750 This is applied to the characters supplied to input methods, not their
11751 output. See also `translation-table-for-input'.
11753 This variable has a separate binding for each terminal.
11754 See Info node `(elisp)Multiple Terminals'. */);
11756 DEFVAR_BOOL ("cannot-suspend", cannot_suspend
,
11757 doc
: /* Non-nil means to always spawn a subshell instead of suspending.
11758 \(Even if the operating system has support for stopping a process.\) */);
11759 cannot_suspend
= 0;
11761 DEFVAR_BOOL ("menu-prompting", menu_prompting
,
11762 doc
: /* Non-nil means prompt with menus when appropriate.
11763 This is done when reading from a keymap that has a prompt string,
11764 for elements that have prompt strings.
11765 The menu is displayed on the screen
11766 if X menus were enabled at configuration
11767 time and the previous event was a mouse click prefix key.
11768 Otherwise, menu prompting uses the echo area. */);
11769 menu_prompting
= 1;
11771 DEFVAR_LISP ("menu-prompt-more-char", menu_prompt_more_char
,
11772 doc
: /* Character to see next line of menu prompt.
11773 Type this character while in a menu prompt to rotate around the lines of it. */);
11774 XSETINT (menu_prompt_more_char
, ' ');
11776 DEFVAR_INT ("extra-keyboard-modifiers", extra_keyboard_modifiers
,
11777 doc
: /* A mask of additional modifier keys to use with every keyboard character.
11778 Emacs applies the modifiers of the character stored here to each keyboard
11779 character it reads. For example, after evaluating the expression
11780 (setq extra-keyboard-modifiers ?\\C-x)
11781 all input characters will have the control modifier applied to them.
11783 Note that the character ?\\C-@, equivalent to the integer zero, does
11784 not count as a control character; rather, it counts as a character
11785 with no modifiers; thus, setting `extra-keyboard-modifiers' to zero
11786 cancels any modification. */);
11787 extra_keyboard_modifiers
= 0;
11789 DEFVAR_LISP ("deactivate-mark", Vdeactivate_mark
,
11790 doc
: /* If an editing command sets this to t, deactivate the mark afterward.
11791 The command loop sets this to nil before each command,
11792 and tests the value when the command returns.
11793 Buffer modification stores t in this variable. */);
11794 Vdeactivate_mark
= Qnil
;
11795 DEFSYM (Qdeactivate_mark
, "deactivate-mark");
11797 DEFVAR_LISP ("pre-command-hook", Vpre_command_hook
,
11798 doc
: /* Normal hook run before each command is executed.
11799 If an unhandled error happens in running this hook,
11800 the function in which the error occurred is unconditionally removed, since
11801 otherwise the error might happen repeatedly and make Emacs nonfunctional. */);
11802 Vpre_command_hook
= Qnil
;
11804 DEFVAR_LISP ("post-command-hook", Vpost_command_hook
,
11805 doc
: /* Normal hook run after each command is executed.
11806 If an unhandled error happens in running this hook,
11807 the function in which the error occurred is unconditionally removed, since
11808 otherwise the error might happen repeatedly and make Emacs nonfunctional. */);
11809 Vpost_command_hook
= Qnil
;
11812 DEFVAR_LISP ("echo-area-clear-hook", ...,
11813 doc
: /* Normal hook run when clearing the echo area. */);
11815 DEFSYM (Qecho_area_clear_hook
, "echo-area-clear-hook");
11816 Fset (Qecho_area_clear_hook
, Qnil
);
11818 DEFVAR_LISP ("lucid-menu-bar-dirty-flag", Vlucid_menu_bar_dirty_flag
,
11819 doc
: /* Non-nil means menu bar, specified Lucid style, needs to be recomputed. */);
11820 Vlucid_menu_bar_dirty_flag
= Qnil
;
11822 DEFVAR_LISP ("menu-bar-final-items", Vmenu_bar_final_items
,
11823 doc
: /* List of menu bar items to move to the end of the menu bar.
11824 The elements of the list are event types that may have menu bar bindings. */);
11825 Vmenu_bar_final_items
= Qnil
;
11827 DEFVAR_LISP ("tool-bar-separator-image-expression", Vtool_bar_separator_image_expression
,
11828 doc
: /* Expression evaluating to the image spec for a tool-bar separator.
11829 This is used internally by graphical displays that do not render
11830 tool-bar separators natively. Otherwise it is unused (e.g. on GTK). */);
11831 Vtool_bar_separator_image_expression
= Qnil
;
11833 DEFVAR_KBOARD ("overriding-terminal-local-map",
11834 Voverriding_terminal_local_map
,
11835 doc
: /* Per-terminal keymap that overrides all other local keymaps.
11836 If this variable is non-nil, it is used as a keymap instead of the
11837 buffer's local map, and the minor mode keymaps and text property keymaps.
11838 It also replaces `overriding-local-map'.
11840 This variable is intended to let commands such as `universal-argument'
11841 set up a different keymap for reading the next command.
11843 `overriding-terminal-local-map' has a separate binding for each
11845 See Info node `(elisp)Multiple Terminals'. */);
11847 DEFVAR_LISP ("overriding-local-map", Voverriding_local_map
,
11848 doc
: /* Keymap that overrides all other local keymaps.
11849 If this variable is non-nil, it is used as a keymap--replacing the
11850 buffer's local map, the minor mode keymaps, and char property keymaps. */);
11851 Voverriding_local_map
= Qnil
;
11853 DEFVAR_LISP ("overriding-local-map-menu-flag", Voverriding_local_map_menu_flag
,
11854 doc
: /* Non-nil means `overriding-local-map' applies to the menu bar.
11855 Otherwise, the menu bar continues to reflect the buffer's local map
11856 and the minor mode maps regardless of `overriding-local-map'. */);
11857 Voverriding_local_map_menu_flag
= Qnil
;
11859 DEFVAR_LISP ("special-event-map", Vspecial_event_map
,
11860 doc
: /* Keymap defining bindings for special events to execute at low level. */);
11861 Vspecial_event_map
= Fcons (intern_c_string ("keymap"), Qnil
);
11863 DEFVAR_LISP ("track-mouse", do_mouse_tracking
,
11864 doc
: /* Non-nil means generate motion events for mouse motion. */);
11866 DEFVAR_KBOARD ("system-key-alist", Vsystem_key_alist
,
11867 doc
: /* Alist of system-specific X windows key symbols.
11868 Each element should have the form (N . SYMBOL) where N is the
11869 numeric keysym code (sans the \"system-specific\" bit 1<<28)
11870 and SYMBOL is its name.
11872 `system-key-alist' has a separate binding for each terminal device.
11873 See Info node `(elisp)Multiple Terminals'. */);
11875 DEFVAR_KBOARD ("local-function-key-map", Vlocal_function_key_map
,
11876 doc
: /* Keymap that translates key sequences to key sequences during input.
11877 This is used mainly for mapping key sequences into some preferred
11878 key events (symbols).
11880 The `read-key-sequence' function replaces any subsequence bound by
11881 `local-function-key-map' with its binding. More precisely, when the
11882 active keymaps have no binding for the current key sequence but
11883 `local-function-key-map' binds a suffix of the sequence to a vector or
11884 string, `read-key-sequence' replaces the matching suffix with its
11885 binding, and continues with the new sequence.
11887 If the binding is a function, it is called with one argument (the prompt)
11888 and its return value (a key sequence) is used.
11890 The events that come from bindings in `local-function-key-map' are not
11891 themselves looked up in `local-function-key-map'.
11893 For example, suppose `local-function-key-map' binds `ESC O P' to [f1].
11894 Typing `ESC O P' to `read-key-sequence' would return [f1]. Typing
11895 `C-x ESC O P' would return [?\\C-x f1]. If [f1] were a prefix key,
11896 typing `ESC O P x' would return [f1 x].
11898 `local-function-key-map' has a separate binding for each terminal
11899 device. See Info node `(elisp)Multiple Terminals'. If you need to
11900 define a binding on all terminals, change `function-key-map'
11901 instead. Initially, `local-function-key-map' is an empty keymap that
11902 has `function-key-map' as its parent on all terminal devices. */);
11904 DEFVAR_KBOARD ("input-decode-map", Vinput_decode_map
,
11905 doc
: /* Keymap that decodes input escape sequences.
11906 This is used mainly for mapping ASCII function key sequences into
11907 real Emacs function key events (symbols).
11909 The `read-key-sequence' function replaces any subsequence bound by
11910 `input-decode-map' with its binding. Contrary to `function-key-map',
11911 this map applies its rebinding regardless of the presence of an ordinary
11912 binding. So it is more like `key-translation-map' except that it applies
11913 before `function-key-map' rather than after.
11915 If the binding is a function, it is called with one argument (the prompt)
11916 and its return value (a key sequence) is used.
11918 The events that come from bindings in `input-decode-map' are not
11919 themselves looked up in `input-decode-map'.
11921 This variable is keyboard-local. */);
11923 DEFVAR_LISP ("function-key-map", Vfunction_key_map
,
11924 doc
: /* The parent keymap of all `local-function-key-map' instances.
11925 Function key definitions that apply to all terminal devices should go
11926 here. If a mapping is defined in both the current
11927 `local-function-key-map' binding and this variable, then the local
11928 definition will take precedence. */);
11929 Vfunction_key_map
= Fmake_sparse_keymap (Qnil
);
11931 DEFVAR_LISP ("key-translation-map", Vkey_translation_map
,
11932 doc
: /* Keymap of key translations that can override keymaps.
11933 This keymap works like `function-key-map', but comes after that,
11934 and its non-prefix bindings override ordinary bindings.
11935 Another difference is that it is global rather than keyboard-local. */);
11936 Vkey_translation_map
= Fmake_sparse_keymap (Qnil
);
11938 DEFVAR_LISP ("deferred-action-list", Vdeferred_action_list
,
11939 doc
: /* List of deferred actions to be performed at a later time.
11940 The precise format isn't relevant here; we just check whether it is nil. */);
11941 Vdeferred_action_list
= Qnil
;
11943 DEFVAR_LISP ("deferred-action-function", Vdeferred_action_function
,
11944 doc
: /* Function to call to handle deferred actions, after each command.
11945 This function is called with no arguments after each command
11946 whenever `deferred-action-list' is non-nil. */);
11947 Vdeferred_action_function
= Qnil
;
11949 DEFVAR_LISP ("delayed-warnings-list", Vdelayed_warnings_list
,
11950 doc
: /* List of warnings to be displayed after this command.
11951 Each element must be a list (TYPE MESSAGE [LEVEL [BUFFER-NAME]]),
11952 as per the args of `display-warning' (which see).
11953 If this variable is non-nil, `delayed-warnings-hook' will be run
11954 immediately after running `post-command-hook'. */);
11955 Vdelayed_warnings_list
= Qnil
;
11957 DEFVAR_LISP ("timer-list", Vtimer_list
,
11958 doc
: /* List of active absolute time timers in order of increasing time. */);
11959 Vtimer_list
= Qnil
;
11961 DEFVAR_LISP ("timer-idle-list", Vtimer_idle_list
,
11962 doc
: /* List of active idle-time timers in order of increasing time. */);
11963 Vtimer_idle_list
= Qnil
;
11965 DEFVAR_LISP ("input-method-function", Vinput_method_function
,
11966 doc
: /* If non-nil, the function that implements the current input method.
11967 It's called with one argument, a printing character that was just read.
11968 \(That means a character with code 040...0176.)
11969 Typically this function uses `read-event' to read additional events.
11970 When it does so, it should first bind `input-method-function' to nil
11971 so it will not be called recursively.
11973 The function should return a list of zero or more events
11974 to be used as input. If it wants to put back some events
11975 to be reconsidered, separately, by the input method,
11976 it can add them to the beginning of `unread-command-events'.
11978 The input method function can find in `input-method-previous-message'
11979 the previous echo area message.
11981 The input method function should refer to the variables
11982 `input-method-use-echo-area' and `input-method-exit-on-first-char'
11983 for guidance on what to do. */);
11984 Vinput_method_function
= Qnil
;
11986 DEFVAR_LISP ("input-method-previous-message",
11987 Vinput_method_previous_message
,
11988 doc
: /* When `input-method-function' is called, hold the previous echo area message.
11989 This variable exists because `read-event' clears the echo area
11990 before running the input method. It is nil if there was no message. */);
11991 Vinput_method_previous_message
= Qnil
;
11993 DEFVAR_LISP ("show-help-function", Vshow_help_function
,
11994 doc
: /* If non-nil, the function that implements the display of help.
11995 It's called with one argument, the help string to display. */);
11996 Vshow_help_function
= Qnil
;
11998 DEFVAR_LISP ("disable-point-adjustment", Vdisable_point_adjustment
,
11999 doc
: /* If non-nil, suppress point adjustment after executing a command.
12001 After a command is executed, if point is moved into a region that has
12002 special properties (e.g. composition, display), we adjust point to
12003 the boundary of the region. But, when a command sets this variable to
12004 non-nil, we suppress the point adjustment.
12006 This variable is set to nil before reading a command, and is checked
12007 just after executing the command. */);
12008 Vdisable_point_adjustment
= Qnil
;
12010 DEFVAR_LISP ("global-disable-point-adjustment",
12011 Vglobal_disable_point_adjustment
,
12012 doc
: /* If non-nil, always suppress point adjustment.
12014 The default value is nil, in which case, point adjustment are
12015 suppressed only after special commands that set
12016 `disable-point-adjustment' (which see) to non-nil. */);
12017 Vglobal_disable_point_adjustment
= Qnil
;
12019 DEFVAR_LISP ("minibuffer-message-timeout", Vminibuffer_message_timeout
,
12020 doc
: /* How long to display an echo-area message when the minibuffer is active.
12021 If the value is not a number, such messages don't time out. */);
12022 Vminibuffer_message_timeout
= make_number (2);
12024 DEFVAR_LISP ("throw-on-input", Vthrow_on_input
,
12025 doc
: /* If non-nil, any keyboard input throws to this symbol.
12026 The value of that variable is passed to `quit-flag' and later causes a
12027 peculiar kind of quitting. */);
12028 Vthrow_on_input
= Qnil
;
12030 DEFVAR_LISP ("command-error-function", Vcommand_error_function
,
12031 doc
: /* If non-nil, function to output error messages.
12032 The arguments are the error data, a list of the form
12033 (SIGNALED-CONDITIONS . SIGNAL-DATA)
12034 such as just as `condition-case' would bind its variable to,
12035 the context (a string which normally goes at the start of the message),
12036 and the Lisp function within which the error was signaled. */);
12037 Vcommand_error_function
= Qnil
;
12039 DEFVAR_LISP ("enable-disabled-menus-and-buttons",
12040 Venable_disabled_menus_and_buttons
,
12041 doc
: /* If non-nil, don't ignore events produced by disabled menu items and tool-bar.
12043 Help functions bind this to allow help on disabled menu items
12044 and tool-bar buttons. */);
12045 Venable_disabled_menus_and_buttons
= Qnil
;
12047 DEFVAR_LISP ("select-active-regions",
12048 Vselect_active_regions
,
12049 doc
: /* If non-nil, an active region automatically sets the primary selection.
12050 If the value is `only', only temporarily active regions (usually made
12051 by mouse-dragging or shift-selection) set the window selection.
12053 This takes effect only when Transient Mark mode is enabled. */);
12054 Vselect_active_regions
= Qt
;
12056 DEFVAR_LISP ("saved-region-selection",
12057 Vsaved_region_selection
,
12058 doc
: /* Contents of active region prior to buffer modification.
12059 If `select-active-regions' is non-nil, Emacs sets this to the
12060 text in the region before modifying the buffer. The next
12061 `deactivate-mark' call uses this to set the window selection. */);
12062 Vsaved_region_selection
= Qnil
;
12064 DEFVAR_LISP ("selection-inhibit-update-commands",
12065 Vselection_inhibit_update_commands
,
12066 doc
: /* List of commands which should not update the selection.
12067 Normally, if `select-active-regions' is non-nil and the mark remains
12068 active after a command (i.e. the mark was not deactivated), the Emacs
12069 command loop sets the selection to the text in the region. However,
12070 if the command is in this list, the selection is not updated. */);
12071 Vselection_inhibit_update_commands
12072 = list2 (Qhandle_switch_frame
, Qhandle_select_window
);
12074 DEFVAR_LISP ("debug-on-event",
12076 doc
: /* Enter debugger on this event. When Emacs
12077 receives the special event specified by this variable, it will try to
12078 break into the debugger as soon as possible instead of processing the
12079 event normally through `special-event-map'.
12081 Currently, the only supported values for this
12082 variable are `sigusr1' and `sigusr2'. */);
12083 Vdebug_on_event
= intern_c_string ("sigusr2");
12085 /* Create the initial keyboard. */
12086 initial_kboard
= xmalloc (sizeof *initial_kboard
);
12087 init_kboard (initial_kboard
);
12088 /* Vwindow_system is left at t for now. */
12089 initial_kboard
->next_kboard
= all_kboards
;
12090 all_kboards
= initial_kboard
;
12094 keys_of_keyboard (void)
12096 initial_define_key (global_map
, Ctl ('Z'), "suspend-emacs");
12097 initial_define_key (control_x_map
, Ctl ('Z'), "suspend-emacs");
12098 initial_define_key (meta_map
, Ctl ('C'), "exit-recursive-edit");
12099 initial_define_key (global_map
, Ctl (']'), "abort-recursive-edit");
12100 initial_define_key (meta_map
, 'x', "execute-extended-command");
12102 initial_define_lispy_key (Vspecial_event_map
, "delete-frame",
12103 "handle-delete-frame");
12104 initial_define_lispy_key (Vspecial_event_map
, "ns-put-working-text",
12105 "ns-put-working-text");
12106 initial_define_lispy_key (Vspecial_event_map
, "ns-unput-working-text",
12107 "ns-unput-working-text");
12108 /* Here we used to use `ignore-event' which would simple set prefix-arg to
12109 current-prefix-arg, as is done in `handle-switch-frame'.
12110 But `handle-switch-frame is not run from the special-map.
12111 Commands from that map are run in a special way that automatically
12112 preserves the prefix-arg. Restoring the prefix arg here is not just
12113 redundant but harmful:
12115 - current-prefix-arg is set to non-nil, prefix-arg is set to nil.
12116 - after the first prompt, the exit-minibuffer-hook is run which may
12117 iconify a frame and thus push a `iconify-frame' event.
12118 - after running exit-minibuffer-hook, current-prefix-arg is
12119 restored to the non-nil value it had before the prompt.
12120 - we enter the second prompt.
12121 current-prefix-arg is non-nil, prefix-arg is nil.
12122 - before running the first real event, we run the special iconify-frame
12123 event, but we pass the `special' arg to execute-command so
12124 current-prefix-arg and prefix-arg are left untouched.
12125 - here we foolishly copy the non-nil current-prefix-arg to prefix-arg.
12126 - the next key event will have a spuriously non-nil current-prefix-arg. */
12127 initial_define_lispy_key (Vspecial_event_map
, "iconify-frame",
12129 initial_define_lispy_key (Vspecial_event_map
, "make-frame-visible",
12131 /* Handling it at such a low-level causes read_key_sequence to get
12132 * confused because it doesn't realize that the current_buffer was
12133 * changed by read_char.
12135 * initial_define_lispy_key (Vspecial_event_map, "select-window",
12136 * "handle-select-window"); */
12137 initial_define_lispy_key (Vspecial_event_map
, "save-session",
12138 "handle-save-session");
12141 /* Define a special event which is raised for dbus callback
12143 initial_define_lispy_key (Vspecial_event_map
, "dbus-event",
12144 "dbus-handle-event");
12147 initial_define_lispy_key (Vspecial_event_map
, "config-changed-event",
12149 #if defined (WINDOWSNT)
12150 initial_define_lispy_key (Vspecial_event_map
, "language-change",
12152 initial_define_lispy_key (Vspecial_event_map
, "file-notify",
12153 "w32notify-handle-event");
12157 /* Mark the pointers in the kboard objects.
12158 Called by Fgarbage_collect. */
12160 mark_kboards (void)
12164 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
12166 if (kb
->kbd_macro_buffer
)
12167 for (p
= kb
->kbd_macro_buffer
; p
< kb
->kbd_macro_ptr
; p
++)
12169 mark_object (KVAR (kb
, Voverriding_terminal_local_map
));
12170 mark_object (KVAR (kb
, Vlast_command
));
12171 mark_object (KVAR (kb
, Vreal_last_command
));
12172 mark_object (KVAR (kb
, Vkeyboard_translate_table
));
12173 mark_object (KVAR (kb
, Vlast_repeatable_command
));
12174 mark_object (KVAR (kb
, Vprefix_arg
));
12175 mark_object (KVAR (kb
, Vlast_prefix_arg
));
12176 mark_object (KVAR (kb
, kbd_queue
));
12177 mark_object (KVAR (kb
, defining_kbd_macro
));
12178 mark_object (KVAR (kb
, Vlast_kbd_macro
));
12179 mark_object (KVAR (kb
, Vsystem_key_alist
));
12180 mark_object (KVAR (kb
, system_key_syms
));
12181 mark_object (KVAR (kb
, Vwindow_system
));
12182 mark_object (KVAR (kb
, Vinput_decode_map
));
12183 mark_object (KVAR (kb
, Vlocal_function_key_map
));
12184 mark_object (KVAR (kb
, Vdefault_minibuffer_frame
));
12185 mark_object (KVAR (kb
, echo_string
));
12188 struct input_event
*event
;
12189 for (event
= kbd_fetch_ptr
; event
!= kbd_store_ptr
; event
++)
12191 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
12192 event
= kbd_buffer
;
12193 if (event
->kind
!= SELECTION_REQUEST_EVENT
12194 && event
->kind
!= SELECTION_CLEAR_EVENT
)
12196 mark_object (event
->x
);
12197 mark_object (event
->y
);
12199 mark_object (event
->frame_or_window
);
12200 mark_object (event
->arg
);