1 /* Keyboard and mouse input; editor command loop.
3 Copyright (C) 1985-1989, 1993-1997, 1999-2012 Free Software Foundation, Inc.
5 This file is part of GNU Emacs.
7 GNU Emacs is free software: you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation, either version 3 of the License, or
10 (at your option) any later version.
12 GNU Emacs is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
22 #define BLOCKINPUT_INLINE EXTERN_INLINE
23 #define KEYBOARD_INLINE EXTERN_INLINE
31 #include "termhooks.h"
36 #include "character.h"
39 #include "dispextern.h"
41 #include "intervals.h"
43 #include "blockinput.h"
57 #include <sys/ioctl.h>
58 #endif /* not MSDOS */
60 #if defined USABLE_FIONREAD && defined USG5_4
61 # include <sys/filio.h>
64 #include "syssignal.h"
66 #include <sys/types.h>
70 #ifdef HAVE_WINDOW_SYSTEM
72 #endif /* HAVE_WINDOW_SYSTEM */
74 /* Variables for blockinput.h: */
76 /* Positive if interrupt input is blocked right now. */
77 volatile int interrupt_input_blocked
;
79 /* True means an input interrupt or alarm signal has arrived.
80 The QUIT macro checks this. */
81 volatile bool pending_signals
;
83 #define KBD_BUFFER_SIZE 4096
85 KBOARD
*initial_kboard
;
86 KBOARD
*current_kboard
;
89 /* True in the single-kboard state, false in the any-kboard state. */
90 static bool single_kboard
;
92 /* Non-nil disable property on a command means
93 do not execute it; call disabled-command-function's value instead. */
94 Lisp_Object Qdisabled
;
95 static Lisp_Object Qdisabled_command_function
;
97 #define NUM_RECENT_KEYS (300)
99 /* Index for storing next element into recent_keys. */
100 static int recent_keys_index
;
102 /* Total number of elements stored into recent_keys. */
103 static int total_keys
;
105 /* This vector holds the last NUM_RECENT_KEYS keystrokes. */
106 static Lisp_Object recent_keys
;
108 /* Vector holding the key sequence that invoked the current command.
109 It is reused for each command, and it may be longer than the current
110 sequence; this_command_key_count indicates how many elements
111 actually mean something.
112 It's easier to staticpro a single Lisp_Object than an array. */
113 Lisp_Object this_command_keys
;
114 ptrdiff_t this_command_key_count
;
116 /* True after calling Freset_this_command_lengths.
117 Usually it is false. */
118 static bool this_command_key_count_reset
;
120 /* This vector is used as a buffer to record the events that were actually read
121 by read_key_sequence. */
122 static Lisp_Object raw_keybuf
;
123 static int raw_keybuf_count
;
125 #define GROW_RAW_KEYBUF \
126 if (raw_keybuf_count == ASIZE (raw_keybuf)) \
127 raw_keybuf = larger_vector (raw_keybuf, 1, -1)
129 /* Number of elements of this_command_keys
130 that precede this key sequence. */
131 static ptrdiff_t this_single_command_key_start
;
133 /* Record values of this_command_key_count and echo_length ()
134 before this command was read. */
135 static ptrdiff_t before_command_key_count
;
136 static ptrdiff_t before_command_echo_length
;
138 /* For longjmp to where kbd input is being done. */
140 static sys_jmp_buf getcjmp
;
142 /* True while doing kbd input. */
143 bool waiting_for_input
;
145 /* True while displaying for echoing. Delays C-g throwing. */
149 /* Non-null means we can start echoing at the next input pause even
150 though there is something in the echo area. */
152 static struct kboard
*ok_to_echo_at_next_pause
;
154 /* The kboard last echoing, or null for none. Reset to 0 in
155 cancel_echoing. If non-null, and a current echo area message
156 exists, and echo_message_buffer is eq to the current message
157 buffer, we know that the message comes from echo_kboard. */
159 struct kboard
*echo_kboard
;
161 /* The buffer used for echoing. Set in echo_now, reset in
164 Lisp_Object echo_message_buffer
;
166 /* True means C-g should cause immediate error-signal. */
169 /* Character that causes a quit. Normally C-g.
171 If we are running on an ordinary terminal, this must be an ordinary
172 ASCII char, since we want to make it our interrupt character.
174 If we are not running on an ordinary terminal, it still needs to be
175 an ordinary ASCII char. This character needs to be recognized in
176 the input interrupt handler. At this point, the keystroke is
177 represented as a struct input_event, while the desired quit
178 character is specified as a lispy event. The mapping from struct
179 input_events to lispy events cannot run in an interrupt handler,
180 and the reverse mapping is difficult for anything but ASCII
183 FOR THESE ELABORATE AND UNSATISFYING REASONS, quit_char must be an
187 /* Current depth in recursive edits. */
188 EMACS_INT command_loop_level
;
190 /* If not Qnil, this is a switch-frame event which we decided to put
191 off until the end of a key sequence. This should be read as the
192 next command input, after any unread_command_events.
194 read_key_sequence uses this to delay switch-frame events until the
195 end of the key sequence; Fread_char uses it to put off switch-frame
196 events until a non-ASCII event is acceptable as input. */
197 Lisp_Object unread_switch_frame
;
199 /* Last size recorded for a current buffer which is not a minibuffer. */
200 static ptrdiff_t last_non_minibuf_size
;
202 /* Total number of times read_char has returned, modulo UINTMAX_MAX + 1. */
203 uintmax_t num_input_events
;
205 /* Value of num_nonmacro_input_events as of last auto save. */
207 static EMACS_INT last_auto_save
;
209 /* The value of point when the last command was started. */
210 static ptrdiff_t last_point_position
;
212 /* The buffer that was current when the last command was started. */
213 static Lisp_Object last_point_position_buffer
;
215 /* The window that was selected when the last command was started. */
216 static Lisp_Object last_point_position_window
;
218 /* The frame in which the last input event occurred, or Qmacro if the
219 last event came from a macro. We use this to determine when to
220 generate switch-frame events. This may be cleared by functions
221 like Fselect_frame, to make sure that a switch-frame event is
222 generated by the next character.
224 FIXME: This is modified by a signal handler so it should be volatile.
225 It's exported to Lisp, though, so it can't simply be marked
227 Lisp_Object internal_last_event_frame
;
229 /* The timestamp of the last input event we received from the X server.
230 X Windows wants this for selection ownership. */
231 Time last_event_timestamp
;
233 static Lisp_Object Qx_set_selection
, Qhandle_switch_frame
;
234 static Lisp_Object Qhandle_select_window
;
235 Lisp_Object QPRIMARY
;
237 static Lisp_Object Qself_insert_command
;
238 static Lisp_Object Qforward_char
;
239 static Lisp_Object Qbackward_char
;
240 Lisp_Object Qundefined
;
241 static Lisp_Object Qtimer_event_handler
;
243 /* read_key_sequence stores here the command definition of the
244 key sequence that it reads. */
245 static Lisp_Object read_key_sequence_cmd
;
246 static Lisp_Object read_key_sequence_remapped
;
248 static Lisp_Object Qinput_method_function
;
250 static Lisp_Object Qdeactivate_mark
;
252 Lisp_Object Qrecompute_lucid_menubar
, Qactivate_menubar_hook
;
254 static Lisp_Object Qecho_area_clear_hook
;
256 /* Hooks to run before and after each command. */
257 static Lisp_Object Qpre_command_hook
;
258 static Lisp_Object Qpost_command_hook
;
260 static Lisp_Object Qdeferred_action_function
;
262 static Lisp_Object Qdelayed_warnings_hook
;
264 static Lisp_Object Qinput_method_exit_on_first_char
;
265 static Lisp_Object Qinput_method_use_echo_area
;
267 static Lisp_Object Qhelp_form_show
;
269 /* File in which we write all commands we read. */
270 static FILE *dribble
;
272 /* Nonzero if input is available. */
275 /* Circular buffer for pre-read keyboard input. */
277 static struct input_event kbd_buffer
[KBD_BUFFER_SIZE
];
279 /* Pointer to next available character in kbd_buffer.
280 If kbd_fetch_ptr == kbd_store_ptr, the buffer is empty.
281 This may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the
282 next available char is in kbd_buffer[0]. */
283 static struct input_event
*kbd_fetch_ptr
;
285 /* Pointer to next place to store character in kbd_buffer. This
286 may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the next
287 character should go in kbd_buffer[0]. */
288 static struct input_event
* volatile kbd_store_ptr
;
290 /* The above pair of variables forms a "queue empty" flag. When we
291 enqueue a non-hook event, we increment kbd_store_ptr. When we
292 dequeue a non-hook event, we increment kbd_fetch_ptr. We say that
293 there is input available if the two pointers are not equal.
295 Why not just have a flag set and cleared by the enqueuing and
296 dequeuing functions? Such a flag could be screwed up by interrupts
297 at inopportune times. */
299 /* Symbols to head events. */
300 static Lisp_Object Qmouse_movement
;
301 static Lisp_Object Qscroll_bar_movement
;
302 Lisp_Object Qswitch_frame
;
303 static Lisp_Object Qdelete_frame
;
304 static Lisp_Object Qiconify_frame
;
305 static Lisp_Object Qmake_frame_visible
;
306 static Lisp_Object Qselect_window
;
307 Lisp_Object Qhelp_echo
;
309 static Lisp_Object Qmouse_fixup_help_message
;
311 /* Symbols to denote kinds of events. */
312 static Lisp_Object Qfunction_key
;
313 Lisp_Object Qmouse_click
;
315 Lisp_Object Qlanguage_change
;
317 static Lisp_Object Qdrag_n_drop
;
318 static Lisp_Object Qsave_session
;
320 static Lisp_Object Qdbus_event
;
322 static Lisp_Object Qconfig_changed_event
;
324 /* Lisp_Object Qmouse_movement; - also an event header */
326 /* Properties of event headers. */
327 Lisp_Object Qevent_kind
;
328 static Lisp_Object Qevent_symbol_elements
;
330 /* Menu and tool bar item parts. */
331 static Lisp_Object Qmenu_enable
;
332 static Lisp_Object QCenable
, QCvisible
, QChelp
, QCkeys
, QCkey_sequence
;
333 Lisp_Object QCfilter
;
335 /* Non-nil disable property on a command means
336 do not execute it; call disabled-command-function's value instead. */
337 Lisp_Object QCtoggle
, QCradio
;
338 static Lisp_Object QCbutton
, QClabel
;
340 static Lisp_Object QCvert_only
;
342 /* An event header symbol HEAD may have a property named
343 Qevent_symbol_element_mask, which is of the form (BASE MODIFIERS);
344 BASE is the base, unmodified version of HEAD, and MODIFIERS is the
345 mask of modifiers applied to it. If present, this is used to help
346 speed up parse_modifiers. */
347 Lisp_Object Qevent_symbol_element_mask
;
349 /* An unmodified event header BASE may have a property named
350 Qmodifier_cache, which is an alist mapping modifier masks onto
351 modified versions of BASE. If present, this helps speed up
353 static Lisp_Object Qmodifier_cache
;
355 /* Symbols to use for parts of windows. */
356 Lisp_Object Qmode_line
;
357 Lisp_Object Qvertical_line
;
358 static Lisp_Object Qvertical_scroll_bar
;
359 Lisp_Object Qmenu_bar
;
361 static Lisp_Object
recursive_edit_unwind (Lisp_Object buffer
);
362 static Lisp_Object
command_loop (void);
363 static Lisp_Object Qextended_command_history
;
364 EMACS_TIME
timer_check (void);
366 static void echo_now (void);
367 static ptrdiff_t echo_length (void);
369 static Lisp_Object Qpolling_period
;
371 /* Incremented whenever a timer is run. */
374 /* Address (if not 0) of EMACS_TIME to zero out if a SIGIO interrupt
376 EMACS_TIME
*input_available_clear_time
;
378 /* True means use SIGIO interrupts; false means use CBREAK mode.
379 Default is true if INTERRUPT_INPUT is defined. */
380 bool interrupt_input
;
382 /* Nonzero while interrupts are temporarily deferred during redisplay. */
383 bool interrupts_deferred
;
385 /* If we support a window system, turn on the code to poll periodically
386 to detect C-g. It isn't actually used when doing interrupt input. */
387 #ifdef HAVE_WINDOW_SYSTEM
388 #define POLL_FOR_INPUT
391 /* The time when Emacs started being idle. */
393 static EMACS_TIME timer_idleness_start_time
;
395 /* After Emacs stops being idle, this saves the last value
396 of timer_idleness_start_time from when it was idle. */
398 static EMACS_TIME timer_last_idleness_start_time
;
401 /* Global variable declarations. */
403 /* Flags for readable_events. */
404 #define READABLE_EVENTS_DO_TIMERS_NOW (1 << 0)
405 #define READABLE_EVENTS_FILTER_EVENTS (1 << 1)
406 #define READABLE_EVENTS_IGNORE_SQUEEZABLES (1 << 2)
408 /* Function for init_keyboard to call with no args (if nonzero). */
409 static void (*keyboard_init_hook
) (void);
411 static bool get_input_pending (int);
412 static bool readable_events (int);
413 static Lisp_Object
read_char_x_menu_prompt (ptrdiff_t, Lisp_Object
*,
414 Lisp_Object
, bool *);
415 static Lisp_Object
read_char_minibuf_menu_prompt (int, ptrdiff_t,
417 static Lisp_Object
make_lispy_event (struct input_event
*);
418 static Lisp_Object
make_lispy_movement (struct frame
*, Lisp_Object
,
419 enum scroll_bar_part
,
420 Lisp_Object
, Lisp_Object
,
422 static Lisp_Object
modify_event_symbol (ptrdiff_t, int, Lisp_Object
,
423 Lisp_Object
, const char *const *,
424 Lisp_Object
*, ptrdiff_t);
425 static Lisp_Object
make_lispy_switch_frame (Lisp_Object
);
426 static bool help_char_p (Lisp_Object
);
427 static void save_getcjmp (sys_jmp_buf
);
428 static void restore_getcjmp (sys_jmp_buf
);
429 static Lisp_Object
apply_modifiers (int, Lisp_Object
);
430 static void clear_event (struct input_event
*);
431 static Lisp_Object
restore_kboard_configuration (Lisp_Object
);
433 static void deliver_input_available_signal (int signo
);
435 static void handle_interrupt (bool);
436 static _Noreturn
void quit_throw_to_read_char (bool);
437 static void process_special_events (void);
438 static void timer_start_idle (void);
439 static void timer_stop_idle (void);
440 static void timer_resume_idle (void);
441 static void deliver_user_signal (int);
442 static char *find_user_signal_name (int);
443 static void store_user_signal_events (void);
445 /* These setters are used only in this file, so they can be private. */
447 kset_echo_string (struct kboard
*kb
, Lisp_Object val
)
449 kb
->INTERNAL_FIELD (echo_string
) = val
;
452 kset_kbd_queue (struct kboard
*kb
, Lisp_Object val
)
454 kb
->INTERNAL_FIELD (kbd_queue
) = val
;
457 kset_keyboard_translate_table (struct kboard
*kb
, Lisp_Object val
)
459 kb
->INTERNAL_FIELD (Vkeyboard_translate_table
) = val
;
462 kset_last_prefix_arg (struct kboard
*kb
, Lisp_Object val
)
464 kb
->INTERNAL_FIELD (Vlast_prefix_arg
) = val
;
467 kset_last_repeatable_command (struct kboard
*kb
, Lisp_Object val
)
469 kb
->INTERNAL_FIELD (Vlast_repeatable_command
) = val
;
472 kset_local_function_key_map (struct kboard
*kb
, Lisp_Object val
)
474 kb
->INTERNAL_FIELD (Vlocal_function_key_map
) = val
;
477 kset_overriding_terminal_local_map (struct kboard
*kb
, Lisp_Object val
)
479 kb
->INTERNAL_FIELD (Voverriding_terminal_local_map
) = val
;
482 kset_real_last_command (struct kboard
*kb
, Lisp_Object val
)
484 kb
->INTERNAL_FIELD (Vreal_last_command
) = val
;
487 kset_system_key_syms (struct kboard
*kb
, Lisp_Object val
)
489 kb
->INTERNAL_FIELD (system_key_syms
) = val
;
493 /* Add C to the echo string, if echoing is going on.
494 C can be a character, which is printed prettily ("M-C-x" and all that
495 jazz), or a symbol, whose name is printed. */
498 echo_char (Lisp_Object c
)
500 if (current_kboard
->immediate_echo
)
502 int size
= KEY_DESCRIPTION_SIZE
+ 100;
503 char *buffer
= alloca (size
);
505 Lisp_Object echo_string
;
507 echo_string
= KVAR (current_kboard
, echo_string
);
509 /* If someone has passed us a composite event, use its head symbol. */
514 ptr
= push_key_description (XINT (c
), ptr
);
516 else if (SYMBOLP (c
))
518 Lisp_Object name
= SYMBOL_NAME (c
);
519 int nbytes
= SBYTES (name
);
521 if (size
- (ptr
- buffer
) < nbytes
)
523 int offset
= ptr
- buffer
;
524 size
= max (2 * size
, size
+ nbytes
);
525 buffer
= alloca (size
);
526 ptr
= buffer
+ offset
;
529 ptr
+= copy_text (SDATA (name
), (unsigned char *) ptr
, nbytes
,
530 STRING_MULTIBYTE (name
), 1);
533 if ((NILP (echo_string
) || SCHARS (echo_string
) == 0)
536 const char *text
= " (Type ? for further options)";
537 int len
= strlen (text
);
539 if (size
- (ptr
- buffer
) < len
)
541 int offset
= ptr
- buffer
;
543 buffer
= alloca (size
);
544 ptr
= buffer
+ offset
;
547 memcpy (ptr
, text
, len
);
551 /* Replace a dash from echo_dash with a space, otherwise
552 add a space at the end as a separator between keys. */
553 if (STRINGP (echo_string
)
554 && SCHARS (echo_string
) > 1)
556 Lisp_Object last_char
, prev_char
, idx
;
558 idx
= make_number (SCHARS (echo_string
) - 2);
559 prev_char
= Faref (echo_string
, idx
);
561 idx
= make_number (SCHARS (echo_string
) - 1);
562 last_char
= Faref (echo_string
, idx
);
564 /* We test PREV_CHAR to make sure this isn't the echoing
566 if (XINT (last_char
) == '-' && XINT (prev_char
) != ' ')
567 Faset (echo_string
, idx
, make_number (' '));
569 echo_string
= concat2 (echo_string
, build_string (" "));
571 else if (STRINGP (echo_string
))
572 echo_string
= concat2 (echo_string
, build_string (" "));
576 concat2 (echo_string
, make_string (buffer
, ptr
- buffer
)));
582 /* Temporarily add a dash to the end of the echo string if it's not
583 empty, so that it serves as a mini-prompt for the very next character. */
588 /* Do nothing if not echoing at all. */
589 if (NILP (KVAR (current_kboard
, echo_string
)))
592 if (this_command_key_count
== 0)
595 if (!current_kboard
->immediate_echo
596 && SCHARS (KVAR (current_kboard
, echo_string
)) == 0)
599 /* Do nothing if we just printed a prompt. */
600 if (current_kboard
->echo_after_prompt
601 == SCHARS (KVAR (current_kboard
, echo_string
)))
604 /* Do nothing if we have already put a dash at the end. */
605 if (SCHARS (KVAR (current_kboard
, echo_string
)) > 1)
607 Lisp_Object last_char
, prev_char
, idx
;
609 idx
= make_number (SCHARS (KVAR (current_kboard
, echo_string
)) - 2);
610 prev_char
= Faref (KVAR (current_kboard
, echo_string
), idx
);
612 idx
= make_number (SCHARS (KVAR (current_kboard
, echo_string
)) - 1);
613 last_char
= Faref (KVAR (current_kboard
, echo_string
), idx
);
615 if (XINT (last_char
) == '-' && XINT (prev_char
) != ' ')
619 /* Put a dash at the end of the buffer temporarily,
620 but make it go away when the next character is added. */
623 concat2 (KVAR (current_kboard
, echo_string
), build_string ("-")));
627 /* Display the current echo string, and begin echoing if not already
633 if (!current_kboard
->immediate_echo
)
636 current_kboard
->immediate_echo
= 1;
638 for (i
= 0; i
< this_command_key_count
; i
++)
642 /* Set before_command_echo_length to the value that would
643 have been saved before the start of this subcommand in
644 command_loop_1, if we had already been echoing then. */
645 if (i
== this_single_command_key_start
)
646 before_command_echo_length
= echo_length ();
648 c
= AREF (this_command_keys
, i
);
649 if (! (EVENT_HAS_PARAMETERS (c
)
650 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
654 /* Set before_command_echo_length to the value that would
655 have been saved before the start of this subcommand in
656 command_loop_1, if we had already been echoing then. */
657 if (this_command_key_count
== this_single_command_key_start
)
658 before_command_echo_length
= echo_length ();
660 /* Put a dash at the end to invite the user to type more. */
665 message3_nolog (KVAR (current_kboard
, echo_string
),
666 SBYTES (KVAR (current_kboard
, echo_string
)),
667 STRING_MULTIBYTE (KVAR (current_kboard
, echo_string
)));
670 /* Record in what buffer we echoed, and from which kboard. */
671 echo_message_buffer
= echo_area_buffer
[0];
672 echo_kboard
= current_kboard
;
674 if (waiting_for_input
&& !NILP (Vquit_flag
))
675 quit_throw_to_read_char (0);
678 /* Turn off echoing, for the start of a new command. */
681 cancel_echoing (void)
683 current_kboard
->immediate_echo
= 0;
684 current_kboard
->echo_after_prompt
= -1;
685 kset_echo_string (current_kboard
, Qnil
);
686 ok_to_echo_at_next_pause
= NULL
;
688 echo_message_buffer
= Qnil
;
691 /* Return the length of the current echo string. */
696 return (STRINGP (KVAR (current_kboard
, echo_string
))
697 ? SCHARS (KVAR (current_kboard
, echo_string
))
701 /* Truncate the current echo message to its first LEN chars.
702 This and echo_char get used by read_key_sequence when the user
703 switches frames while entering a key sequence. */
706 echo_truncate (ptrdiff_t nchars
)
708 if (STRINGP (KVAR (current_kboard
, echo_string
)))
709 kset_echo_string (current_kboard
,
710 Fsubstring (KVAR (current_kboard
, echo_string
),
711 make_number (0), make_number (nchars
)));
712 truncate_echo_area (nchars
);
716 /* Functions for manipulating this_command_keys. */
718 add_command_key (Lisp_Object key
)
720 #if 0 /* Not needed after we made Freset_this_command_lengths
721 do the job immediately. */
722 /* If reset-this-command-length was called recently, obey it now.
723 See the doc string of that function for an explanation of why. */
724 if (before_command_restore_flag
)
726 this_command_key_count
= before_command_key_count_1
;
727 if (this_command_key_count
< this_single_command_key_start
)
728 this_single_command_key_start
= this_command_key_count
;
729 echo_truncate (before_command_echo_length_1
);
730 before_command_restore_flag
= 0;
734 if (this_command_key_count
>= ASIZE (this_command_keys
))
735 this_command_keys
= larger_vector (this_command_keys
, 1, -1);
737 ASET (this_command_keys
, this_command_key_count
, key
);
738 ++this_command_key_count
;
743 recursive_edit_1 (void)
745 ptrdiff_t count
= SPECPDL_INDEX ();
748 if (command_loop_level
> 0)
750 specbind (Qstandard_output
, Qt
);
751 specbind (Qstandard_input
, Qt
);
754 #ifdef HAVE_WINDOW_SYSTEM
755 /* The command loop has started an hourglass timer, so we have to
756 cancel it here, otherwise it will fire because the recursive edit
757 can take some time. Do not check for display_hourglass_p here,
758 because it could already be nil. */
762 /* This function may have been called from a debugger called from
763 within redisplay, for instance by Edebugging a function called
764 from fontification-functions. We want to allow redisplay in
765 the debugging session.
767 The recursive edit is left with a `(throw exit ...)'. The `exit'
768 tag is not caught anywhere in redisplay, i.e. when we leave the
769 recursive edit, the original redisplay leading to the recursive
770 edit will be unwound. The outcome should therefore be safe. */
771 specbind (Qinhibit_redisplay
, Qnil
);
774 val
= command_loop ();
776 Fsignal (Qquit
, Qnil
);
777 /* Handle throw from read_minibuf when using minibuffer
778 while it's active but we're in another window. */
780 xsignal1 (Qerror
, val
);
782 return unbind_to (count
, Qnil
);
785 /* When an auto-save happens, record the "time", and don't do again soon. */
788 record_auto_save (void)
790 last_auto_save
= num_nonmacro_input_events
;
793 /* Make an auto save happen as soon as possible at command level. */
797 force_auto_save_soon (void)
799 last_auto_save
= - auto_save_interval
- 1;
801 record_asynch_buffer_change ();
805 DEFUN ("recursive-edit", Frecursive_edit
, Srecursive_edit
, 0, 0, "",
806 doc
: /* Invoke the editor command loop recursively.
807 To get out of the recursive edit, a command can do `(throw 'exit nil)';
808 that tells this function to return.
809 Alternatively, `(throw 'exit t)' makes this function signal an error.
810 This function is called by the editor initialization to begin editing. */)
813 ptrdiff_t count
= SPECPDL_INDEX ();
816 /* If we enter while input is blocked, don't lock up here.
817 This may happen through the debugger during redisplay. */
818 if (input_blocked_p ())
821 command_loop_level
++;
822 update_mode_lines
= 1;
824 if (command_loop_level
825 && current_buffer
!= XBUFFER (XWINDOW (selected_window
)->buffer
))
826 buffer
= Fcurrent_buffer ();
830 /* If we leave recursive_edit_1 below with a `throw' for instance,
831 like it is done in the splash screen display, we have to
832 make sure that we restore single_kboard as command_loop_1
833 would have done if it were left normally. */
834 if (command_loop_level
> 0)
835 temporarily_switch_to_single_kboard (SELECTED_FRAME ());
836 record_unwind_protect (recursive_edit_unwind
, buffer
);
839 return unbind_to (count
, Qnil
);
843 recursive_edit_unwind (Lisp_Object buffer
)
845 if (BUFFERP (buffer
))
846 Fset_buffer (buffer
);
848 command_loop_level
--;
849 update_mode_lines
= 1;
854 #if 0 /* These two functions are now replaced with
855 temporarily_switch_to_single_kboard. */
859 #if 0 /* Theory: if there's anything in Vunread_command_events,
860 it will right away be read by read_key_sequence,
861 and then if we do switch KBOARDS, it will go into the side
862 queue then. So we don't need to do anything special here -- rms. */
863 if (CONSP (Vunread_command_events
))
865 current_kboard
->kbd_queue
866 = nconc2 (Vunread_command_events
, current_kboard
->kbd_queue
);
867 current_kboard
->kbd_queue_has_data
= 1;
869 Vunread_command_events
= Qnil
;
874 /* Switch to the single-kboard state, making current_kboard
875 the only KBOARD from which further input is accepted. */
878 single_kboard_state ()
884 /* If we're in single_kboard state for kboard KBOARD,
888 not_single_kboard_state (KBOARD
*kboard
)
890 if (kboard
== current_kboard
)
894 /* Maintain a stack of kboards, so other parts of Emacs
895 can switch temporarily to the kboard of a given frame
896 and then revert to the previous status. */
901 struct kboard_stack
*next
;
904 static struct kboard_stack
*kboard_stack
;
907 push_kboard (struct kboard
*k
)
909 struct kboard_stack
*p
= xmalloc (sizeof *p
);
911 p
->next
= kboard_stack
;
912 p
->kboard
= current_kboard
;
922 struct kboard_stack
*p
= kboard_stack
;
924 for (t
= terminal_list
; t
; t
= t
->next_terminal
)
926 if (t
->kboard
== p
->kboard
)
928 current_kboard
= p
->kboard
;
935 /* The terminal we remembered has been deleted. */
936 current_kboard
= FRAME_KBOARD (SELECTED_FRAME ());
939 kboard_stack
= p
->next
;
943 /* Switch to single_kboard mode, making current_kboard the only KBOARD
944 from which further input is accepted. If F is non-nil, set its
945 KBOARD as the current keyboard.
947 This function uses record_unwind_protect to return to the previous
950 If Emacs is already in single_kboard mode, and F's keyboard is
951 locked, then this function will throw an error. */
954 temporarily_switch_to_single_kboard (struct frame
*f
)
956 bool was_locked
= single_kboard
;
959 if (f
!= NULL
&& FRAME_KBOARD (f
) != current_kboard
)
960 /* We can not switch keyboards while in single_kboard mode.
961 In rare cases, Lisp code may call `recursive-edit' (or
962 `read-minibuffer' or `y-or-n-p') after it switched to a
963 locked frame. For example, this is likely to happen
964 when server.el connects to a new terminal while Emacs is in
965 single_kboard mode. It is best to throw an error instead
966 of presenting the user with a frozen screen. */
967 error ("Terminal %d is locked, cannot read from it",
968 FRAME_TERMINAL (f
)->id
);
970 /* This call is unnecessary, but helps
971 `restore_kboard_configuration' discover if somebody changed
972 `current_kboard' behind our back. */
973 push_kboard (current_kboard
);
976 current_kboard
= FRAME_KBOARD (f
);
978 record_unwind_protect (restore_kboard_configuration
,
979 (was_locked
? Qt
: Qnil
));
982 #if 0 /* This function is not needed anymore. */
984 record_single_kboard_state ()
987 push_kboard (current_kboard
);
988 record_unwind_protect (restore_kboard_configuration
,
989 (single_kboard
? Qt
: Qnil
));
994 restore_kboard_configuration (Lisp_Object was_locked
)
996 if (NILP (was_locked
))
1000 struct kboard
*prev
= current_kboard
;
1003 /* The pop should not change the kboard. */
1004 if (single_kboard
&& current_kboard
!= prev
)
1011 /* Handle errors that are not handled at inner levels
1012 by printing an error message and returning to the editor command loop. */
1015 cmd_error (Lisp_Object data
)
1017 Lisp_Object old_level
, old_length
;
1018 char macroerror
[sizeof "After..kbd macro iterations: "
1019 + INT_STRLEN_BOUND (EMACS_INT
)];
1021 #ifdef HAVE_WINDOW_SYSTEM
1022 if (display_hourglass_p
)
1023 cancel_hourglass ();
1026 if (!NILP (executing_kbd_macro
))
1028 if (executing_kbd_macro_iterations
== 1)
1029 sprintf (macroerror
, "After 1 kbd macro iteration: ");
1031 sprintf (macroerror
, "After %"pI
"d kbd macro iterations: ",
1032 executing_kbd_macro_iterations
);
1037 Vstandard_output
= Qt
;
1038 Vstandard_input
= Qt
;
1039 Vexecuting_kbd_macro
= Qnil
;
1040 executing_kbd_macro
= Qnil
;
1041 kset_prefix_arg (current_kboard
, Qnil
);
1042 kset_last_prefix_arg (current_kboard
, Qnil
);
1045 /* Avoid unquittable loop if data contains a circular list. */
1046 old_level
= Vprint_level
;
1047 old_length
= Vprint_length
;
1048 XSETFASTINT (Vprint_level
, 10);
1049 XSETFASTINT (Vprint_length
, 10);
1050 cmd_error_internal (data
, macroerror
);
1051 Vprint_level
= old_level
;
1052 Vprint_length
= old_length
;
1055 Vinhibit_quit
= Qnil
;
1057 return make_number (0);
1060 /* Take actions on handling an error. DATA is the data that describes
1063 CONTEXT is a C-string containing ASCII characters only which
1064 describes the context in which the error happened. If we need to
1065 generalize CONTEXT to allow multibyte characters, make it a Lisp
1069 cmd_error_internal (Lisp_Object data
, const char *context
)
1071 struct frame
*sf
= SELECTED_FRAME ();
1073 /* The immediate context is not interesting for Quits,
1074 since they are asynchronous. */
1075 if (EQ (XCAR (data
), Qquit
))
1076 Vsignaling_function
= Qnil
;
1081 /* Use user's specified output function if any. */
1082 if (!NILP (Vcommand_error_function
))
1083 call3 (Vcommand_error_function
, data
,
1084 context
? build_string (context
) : empty_unibyte_string
,
1085 Vsignaling_function
);
1086 /* If the window system or terminal frame hasn't been initialized
1087 yet, or we're not interactive, write the message to stderr and exit. */
1088 else if (!sf
->glyphs_initialized_p
1089 /* The initial frame is a special non-displaying frame. It
1090 will be current in daemon mode when there are no frames
1091 to display, and in non-daemon mode before the real frame
1092 has finished initializing. If an error is thrown in the
1093 latter case while creating the frame, then the frame
1094 will never be displayed, so the safest thing to do is
1095 write to stderr and quit. In daemon mode, there are
1096 many other potential errors that do not prevent frames
1097 from being created, so continuing as normal is better in
1099 || (!IS_DAEMON
&& FRAME_INITIAL_P (sf
))
1102 print_error_message (data
, Qexternal_debugging_output
,
1103 context
, Vsignaling_function
);
1104 Fterpri (Qexternal_debugging_output
);
1105 Fkill_emacs (make_number (-1));
1109 clear_message (1, 0);
1111 message_log_maybe_newline ();
1114 print_error_message (data
, Qt
, context
, Vsignaling_function
);
1117 Vsignaling_function
= Qnil
;
1120 Lisp_Object
command_loop_1 (void);
1121 static Lisp_Object
command_loop_2 (Lisp_Object
);
1122 static Lisp_Object
top_level_1 (Lisp_Object
);
1124 /* Entry to editor-command-loop.
1125 This level has the catches for exiting/returning to editor command loop.
1126 It returns nil to exit recursive edit, t to abort it. */
1131 if (command_loop_level
> 0 || minibuf_level
> 0)
1134 val
= internal_catch (Qexit
, command_loop_2
, Qnil
);
1135 executing_kbd_macro
= Qnil
;
1141 internal_catch (Qtop_level
, top_level_1
, Qnil
);
1142 internal_catch (Qtop_level
, command_loop_2
, Qnil
);
1143 executing_kbd_macro
= Qnil
;
1145 /* End of file in -batch run causes exit here. */
1151 /* Here we catch errors in execution of commands within the
1152 editing loop, and reenter the editing loop.
1153 When there is an error, cmd_error runs and returns a non-nil
1154 value to us. A value of nil means that command_loop_1 itself
1155 returned due to end of file (or end of kbd macro). */
1158 command_loop_2 (Lisp_Object ignore
)
1160 register Lisp_Object val
;
1163 val
= internal_condition_case (command_loop_1
, Qerror
, cmd_error
);
1164 while (!NILP (val
));
1172 return Feval (Vtop_level
, Qnil
);
1176 top_level_1 (Lisp_Object ignore
)
1178 /* On entry to the outer level, run the startup file */
1179 if (!NILP (Vtop_level
))
1180 internal_condition_case (top_level_2
, Qerror
, cmd_error
);
1181 else if (!NILP (Vpurify_flag
))
1182 message ("Bare impure Emacs (standard Lisp code not loaded)");
1184 message ("Bare Emacs (standard Lisp code not loaded)");
1188 DEFUN ("top-level", Ftop_level
, Stop_level
, 0, 0, "",
1189 doc
: /* Exit all recursive editing levels.
1190 This also exits all active minibuffers. */)
1193 #ifdef HAVE_WINDOW_SYSTEM
1194 if (display_hourglass_p
)
1195 cancel_hourglass ();
1198 /* Unblock input if we enter with input blocked. This may happen if
1199 redisplay traps e.g. during tool-bar update with input blocked. */
1200 totally_unblock_input ();
1202 Fthrow (Qtop_level
, Qnil
);
1205 static _Noreturn
void
1206 user_error (const char *msg
)
1208 xsignal1 (Quser_error
, build_string (msg
));
1212 DEFUN ("exit-recursive-edit", Fexit_recursive_edit
, Sexit_recursive_edit
, 0, 0, "",
1213 doc
: /* Exit from the innermost recursive edit or minibuffer. */)
1216 if (command_loop_level
> 0 || minibuf_level
> 0)
1217 Fthrow (Qexit
, Qnil
);
1219 user_error ("No recursive edit is in progress");
1223 DEFUN ("abort-recursive-edit", Fabort_recursive_edit
, Sabort_recursive_edit
, 0, 0, "",
1224 doc
: /* Abort the command that requested this recursive edit or minibuffer input. */)
1227 if (command_loop_level
> 0 || minibuf_level
> 0)
1230 user_error ("No recursive edit is in progress");
1233 /* Restore mouse tracking enablement. See Ftrack_mouse for the only use
1234 of this function. */
1237 tracking_off (Lisp_Object old_value
)
1239 do_mouse_tracking
= old_value
;
1240 if (NILP (old_value
))
1242 /* Redisplay may have been preempted because there was input
1243 available, and it assumes it will be called again after the
1244 input has been processed. If the only input available was
1245 the sort that we have just disabled, then we need to call
1247 if (!readable_events (READABLE_EVENTS_DO_TIMERS_NOW
))
1249 redisplay_preserve_echo_area (6);
1250 get_input_pending (READABLE_EVENTS_DO_TIMERS_NOW
);
1256 DEFUN ("track-mouse", Ftrack_mouse
, Strack_mouse
, 0, UNEVALLED
, 0,
1257 doc
: /* Evaluate BODY with mouse movement events enabled.
1258 Within a `track-mouse' form, mouse motion generates input events that
1259 you can read with `read-event'.
1260 Normally, mouse motion is ignored.
1261 usage: (track-mouse BODY...) */)
1264 ptrdiff_t count
= SPECPDL_INDEX ();
1267 record_unwind_protect (tracking_off
, do_mouse_tracking
);
1269 do_mouse_tracking
= Qt
;
1271 val
= Fprogn (args
);
1272 return unbind_to (count
, val
);
1275 /* If mouse has moved on some frame, return one of those frames.
1279 If ignore_mouse_drag_p is non-zero, ignore (implicit) mouse movement
1280 after resizing the tool-bar window. */
1282 #if !defined HAVE_WINDOW_SYSTEM || defined USE_GTK || defined HAVE_NS
1285 bool ignore_mouse_drag_p
;
1288 some_mouse_moved (void)
1290 Lisp_Object tail
, frame
;
1292 if (ignore_mouse_drag_p
)
1294 /* ignore_mouse_drag_p = 0; */
1298 FOR_EACH_FRAME (tail
, frame
)
1300 if (XFRAME (frame
)->mouse_moved
)
1301 return XFRAME (frame
);
1308 /* This is the actual command reading loop,
1309 sans error-handling encapsulation. */
1311 static int read_key_sequence (Lisp_Object
*, int, Lisp_Object
,
1313 void safe_run_hooks (Lisp_Object
);
1314 static void adjust_point_for_property (ptrdiff_t, bool);
1316 /* Cancel hourglass from protect_unwind.
1318 #ifdef HAVE_WINDOW_SYSTEM
1320 cancel_hourglass_unwind (Lisp_Object arg
)
1322 cancel_hourglass ();
1327 /* The last boundary auto-added to buffer-undo-list. */
1328 Lisp_Object last_undo_boundary
;
1330 /* FIXME: This is wrong rather than test window-system, we should call
1331 a new set-selection, which will then dispatch to x-set-selection, or
1332 tty-set-selection, or w32-set-selection, ... */
1335 command_loop_1 (void)
1338 Lisp_Object keybuf
[30];
1340 EMACS_INT prev_modiff
= 0;
1341 struct buffer
*prev_buffer
= NULL
;
1342 bool already_adjusted
= 0;
1344 kset_prefix_arg (current_kboard
, Qnil
);
1345 kset_last_prefix_arg (current_kboard
, Qnil
);
1346 Vdeactivate_mark
= Qnil
;
1347 waiting_for_input
= 0;
1350 this_command_key_count
= 0;
1351 this_command_key_count_reset
= 0;
1352 this_single_command_key_start
= 0;
1354 if (NILP (Vmemory_full
))
1356 /* Make sure this hook runs after commands that get errors and
1357 throw to top level. */
1358 /* Note that the value cell will never directly contain nil
1359 if the symbol is a local variable. */
1360 if (!NILP (Vpost_command_hook
) && !NILP (Vrun_hooks
))
1361 safe_run_hooks (Qpost_command_hook
);
1363 /* If displaying a message, resize the echo area window to fit
1364 that message's size exactly. */
1365 if (!NILP (echo_area_buffer
[0]))
1366 resize_echo_area_exactly ();
1368 /* If there are warnings waiting, process them. */
1369 if (!NILP (Vdelayed_warnings_list
))
1370 safe_run_hooks (Qdelayed_warnings_hook
);
1372 if (!NILP (Vdeferred_action_list
))
1373 safe_run_hooks (Qdeferred_action_function
);
1376 /* Do this after running Vpost_command_hook, for consistency. */
1377 kset_last_command (current_kboard
, Vthis_command
);
1378 kset_real_last_command (current_kboard
, Vreal_this_command
);
1379 if (!CONSP (last_command_event
))
1380 kset_last_repeatable_command (current_kboard
, Vreal_this_command
);
1384 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1387 /* Make sure the current window's buffer is selected. */
1388 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->buffer
));
1390 /* Display any malloc warning that just came out. Use while because
1391 displaying one warning can cause another. */
1393 while (pending_malloc_warning
)
1394 display_malloc_warning ();
1396 Vdeactivate_mark
= Qnil
;
1398 /* Don't ignore mouse movements for more than a single command
1399 loop. (This flag is set in xdisp.c whenever the tool bar is
1400 resized, because the resize moves text up or down, and would
1401 generate false mouse drag events if we don't ignore them.) */
1402 ignore_mouse_drag_p
= 0;
1404 /* If minibuffer on and echo area in use,
1405 wait a short time and redraw minibuffer. */
1408 && !NILP (echo_area_buffer
[0])
1409 && EQ (minibuf_window
, echo_area_window
)
1410 && NUMBERP (Vminibuffer_message_timeout
))
1412 /* Bind inhibit-quit to t so that C-g gets read in
1413 rather than quitting back to the minibuffer. */
1414 ptrdiff_t count
= SPECPDL_INDEX ();
1415 specbind (Qinhibit_quit
, Qt
);
1417 sit_for (Vminibuffer_message_timeout
, 0, 2);
1419 /* Clear the echo area. */
1421 safe_run_hooks (Qecho_area_clear_hook
);
1423 unbind_to (count
, Qnil
);
1425 /* If a C-g came in before, treat it as input now. */
1426 if (!NILP (Vquit_flag
))
1429 Vunread_command_events
= Fcons (make_number (quit_char
), Qnil
);
1433 /* If it has changed current-menubar from previous value,
1434 really recompute the menubar from the value. */
1435 if (! NILP (Vlucid_menu_bar_dirty_flag
)
1436 && !NILP (Ffboundp (Qrecompute_lucid_menubar
)))
1437 call0 (Qrecompute_lucid_menubar
);
1439 before_command_key_count
= this_command_key_count
;
1440 before_command_echo_length
= echo_length ();
1442 Vthis_command
= Qnil
;
1443 Vreal_this_command
= Qnil
;
1444 Vthis_original_command
= Qnil
;
1445 Vthis_command_keys_shift_translated
= Qnil
;
1447 /* Read next key sequence; i gets its length. */
1448 i
= read_key_sequence (keybuf
, sizeof keybuf
/ sizeof keybuf
[0],
1451 /* A filter may have run while we were reading the input. */
1452 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1454 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->buffer
));
1458 /* Now we have read a key sequence of length I,
1459 or else I is 0 and we found end of file. */
1461 if (i
== 0) /* End of file -- happens only in */
1462 return Qnil
; /* a kbd macro, at the end. */
1463 /* -1 means read_key_sequence got a menu that was rejected.
1464 Just loop around and read another command. */
1468 this_command_key_count
= 0;
1469 this_command_key_count_reset
= 0;
1470 this_single_command_key_start
= 0;
1474 last_command_event
= keybuf
[i
- 1];
1476 /* If the previous command tried to force a specific window-start,
1477 forget about that, in case this command moves point far away
1478 from that position. But also throw away beg_unchanged and
1479 end_unchanged information in that case, so that redisplay will
1480 update the whole window properly. */
1481 if (XWINDOW (selected_window
)->force_start
)
1484 XWINDOW (selected_window
)->force_start
= 0;
1485 b
= XBUFFER (XWINDOW (selected_window
)->buffer
);
1486 BUF_BEG_UNCHANGED (b
) = BUF_END_UNCHANGED (b
) = 0;
1489 cmd
= read_key_sequence_cmd
;
1490 if (!NILP (Vexecuting_kbd_macro
))
1492 if (!NILP (Vquit_flag
))
1494 Vexecuting_kbd_macro
= Qt
;
1495 QUIT
; /* Make some noise. */
1496 /* Will return since macro now empty. */
1500 /* Do redisplay processing after this command except in special
1501 cases identified below. */
1502 prev_buffer
= current_buffer
;
1503 prev_modiff
= MODIFF
;
1504 last_point_position
= PT
;
1505 last_point_position_window
= selected_window
;
1506 XSETBUFFER (last_point_position_buffer
, prev_buffer
);
1508 /* By default, we adjust point to a boundary of a region that
1509 has such a property that should be treated intangible
1510 (e.g. composition, display). But, some commands will set
1511 this variable differently. */
1512 Vdisable_point_adjustment
= Qnil
;
1514 /* Process filters and timers may have messed with deactivate-mark.
1515 reset it before we execute the command. */
1516 Vdeactivate_mark
= Qnil
;
1518 /* Remap command through active keymaps. */
1519 Vthis_original_command
= cmd
;
1520 if (!NILP (read_key_sequence_remapped
))
1521 cmd
= read_key_sequence_remapped
;
1523 /* Execute the command. */
1525 Vthis_command
= cmd
;
1526 Vreal_this_command
= cmd
;
1527 safe_run_hooks (Qpre_command_hook
);
1529 already_adjusted
= 0;
1531 if (NILP (Vthis_command
))
1533 /* nil means key is undefined. */
1534 Lisp_Object keys
= Fvector (i
, keybuf
);
1535 keys
= Fkey_description (keys
, Qnil
);
1537 message_with_string ("%s is undefined", keys
, 0);
1538 kset_defining_kbd_macro (current_kboard
, Qnil
);
1539 update_mode_lines
= 1;
1540 /* If this is a down-mouse event, don't reset prefix-arg;
1541 pass it to the command run by the up event. */
1542 if (EVENT_HAS_PARAMETERS (last_command_event
))
1544 Lisp_Object breakdown
1545 = parse_modifiers (EVENT_HEAD (last_command_event
));
1546 int modifiers
= XINT (XCAR (XCDR (breakdown
)));
1547 if (!(modifiers
& down_modifier
))
1548 kset_prefix_arg (current_kboard
, Qnil
);
1551 kset_prefix_arg (current_kboard
, Qnil
);
1555 /* Here for a command that isn't executed directly. */
1557 #ifdef HAVE_WINDOW_SYSTEM
1558 ptrdiff_t scount
= SPECPDL_INDEX ();
1560 if (display_hourglass_p
1561 && NILP (Vexecuting_kbd_macro
))
1563 record_unwind_protect (cancel_hourglass_unwind
, Qnil
);
1568 if (NILP (KVAR (current_kboard
, Vprefix_arg
))) /* FIXME: Why? --Stef */
1570 Lisp_Object undo
= BVAR (current_buffer
, undo_list
);
1573 = (EQ (undo
, BVAR (current_buffer
, undo_list
))
1574 ? Qnil
: BVAR (current_buffer
, undo_list
));
1576 Fcommand_execute (Vthis_command
, Qnil
, Qnil
, Qnil
);
1578 #ifdef HAVE_WINDOW_SYSTEM
1579 /* Do not check display_hourglass_p here, because
1580 Fcommand_execute could change it, but we should cancel
1581 hourglass cursor anyway.
1582 But don't cancel the hourglass within a macro
1583 just because a command in the macro finishes. */
1584 if (NILP (Vexecuting_kbd_macro
))
1585 unbind_to (scount
, Qnil
);
1588 kset_last_prefix_arg (current_kboard
, Vcurrent_prefix_arg
);
1590 safe_run_hooks (Qpost_command_hook
);
1592 /* If displaying a message, resize the echo area window to fit
1593 that message's size exactly. */
1594 if (!NILP (echo_area_buffer
[0]))
1595 resize_echo_area_exactly ();
1597 /* If there are warnings waiting, process them. */
1598 if (!NILP (Vdelayed_warnings_list
))
1599 safe_run_hooks (Qdelayed_warnings_hook
);
1601 safe_run_hooks (Qdeferred_action_function
);
1603 /* If there is a prefix argument,
1604 1) We don't want Vlast_command to be ``universal-argument''
1605 (that would be dumb), so don't set Vlast_command,
1606 2) we want to leave echoing on so that the prefix will be
1607 echoed as part of this key sequence, so don't call
1609 3) we want to leave this_command_key_count non-zero, so that
1610 read_char will realize that it is re-reading a character, and
1611 not echo it a second time.
1613 If the command didn't actually create a prefix arg,
1614 but is merely a frame event that is transparent to prefix args,
1615 then the above doesn't apply. */
1616 if (NILP (KVAR (current_kboard
, Vprefix_arg
))
1617 || CONSP (last_command_event
))
1619 kset_last_command (current_kboard
, Vthis_command
);
1620 kset_real_last_command (current_kboard
, Vreal_this_command
);
1621 if (!CONSP (last_command_event
))
1622 kset_last_repeatable_command (current_kboard
, Vreal_this_command
);
1624 this_command_key_count
= 0;
1625 this_command_key_count_reset
= 0;
1626 this_single_command_key_start
= 0;
1629 if (!NILP (BVAR (current_buffer
, mark_active
))
1630 && !NILP (Vrun_hooks
))
1632 /* In Emacs 22, setting transient-mark-mode to `only' was a
1633 way of turning it on for just one command. This usage is
1634 obsolete, but support it anyway. */
1635 if (EQ (Vtransient_mark_mode
, Qidentity
))
1636 Vtransient_mark_mode
= Qnil
;
1637 else if (EQ (Vtransient_mark_mode
, Qonly
))
1638 Vtransient_mark_mode
= Qidentity
;
1640 if (!NILP (Vdeactivate_mark
))
1641 /* If `select-active-regions' is non-nil, this call to
1642 `deactivate-mark' also sets the PRIMARY selection. */
1643 call0 (Qdeactivate_mark
);
1646 /* Even if not deactivating the mark, set PRIMARY if
1647 `select-active-regions' is non-nil. */
1648 if (!NILP (Fwindow_system (Qnil
))
1649 /* Even if mark_active is non-nil, the actual buffer
1650 marker may not have been set yet (Bug#7044). */
1651 && XMARKER (BVAR (current_buffer
, mark
))->buffer
1652 && (EQ (Vselect_active_regions
, Qonly
)
1653 ? EQ (CAR_SAFE (Vtransient_mark_mode
), Qonly
)
1654 : (!NILP (Vselect_active_regions
)
1655 && !NILP (Vtransient_mark_mode
)))
1656 && NILP (Fmemq (Vthis_command
,
1657 Vselection_inhibit_update_commands
)))
1660 XINT (Fmarker_position (BVAR (current_buffer
, mark
)));
1663 call2 (Qx_set_selection
, QPRIMARY
,
1664 make_buffer_string (beg
, end
, 0));
1666 call2 (Qx_set_selection
, QPRIMARY
,
1667 make_buffer_string (end
, beg
, 0));
1668 /* Don't set empty selections. */
1671 if (current_buffer
!= prev_buffer
|| MODIFF
!= prev_modiff
)
1673 Lisp_Object hook
= intern ("activate-mark-hook");
1674 Frun_hooks (1, &hook
);
1678 Vsaved_region_selection
= Qnil
;
1683 if (current_buffer
== prev_buffer
1684 && last_point_position
!= PT
1685 && NILP (Vdisable_point_adjustment
)
1686 && NILP (Vglobal_disable_point_adjustment
))
1688 if (last_point_position
> BEGV
1689 && last_point_position
< ZV
1690 && (composition_adjust_point (last_point_position
,
1691 last_point_position
)
1692 != last_point_position
))
1693 /* The last point was temporarily set within a grapheme
1694 cluster to prevent automatic composition. To recover
1695 the automatic composition, we must update the
1697 windows_or_buffers_changed
++;
1698 if (!already_adjusted
)
1699 adjust_point_for_property (last_point_position
,
1700 MODIFF
!= prev_modiff
);
1703 /* Install chars successfully executed in kbd macro. */
1705 if (!NILP (KVAR (current_kboard
, defining_kbd_macro
))
1706 && NILP (KVAR (current_kboard
, Vprefix_arg
)))
1707 finalize_kbd_macro_chars ();
1711 /* Adjust point to a boundary of a region that has such a property
1712 that should be treated intangible. For the moment, we check
1713 `composition', `display' and `invisible' properties.
1714 LAST_PT is the last position of point. */
1717 adjust_point_for_property (ptrdiff_t last_pt
, bool modified
)
1720 Lisp_Object val
, overlay
, tmp
;
1721 /* When called after buffer modification, we should temporarily
1722 suppress the point adjustment for automatic composition so that a
1723 user can keep inserting another character at point or keep
1724 deleting characters around point. */
1725 bool check_composition
= ! modified
, check_display
= 1, check_invisible
= 1;
1726 ptrdiff_t orig_pt
= PT
;
1728 /* FIXME: cycling is probably not necessary because these properties
1729 can't be usefully combined anyway. */
1730 while (check_composition
|| check_display
|| check_invisible
)
1732 /* FIXME: check `intangible'. */
1733 if (check_composition
1734 && PT
> BEGV
&& PT
< ZV
1735 && (beg
= composition_adjust_point (last_pt
, PT
)) != PT
)
1738 check_display
= check_invisible
= 1;
1740 check_composition
= 0;
1742 && PT
> BEGV
&& PT
< ZV
1743 && !NILP (val
= get_char_property_and_overlay
1744 (make_number (PT
), Qdisplay
, Qnil
, &overlay
))
1745 && display_prop_intangible_p (val
, overlay
, PT
, PT_BYTE
)
1746 && (!OVERLAYP (overlay
)
1747 ? get_property_and_range (PT
, Qdisplay
, &val
, &beg
, &end
, Qnil
)
1748 : (beg
= OVERLAY_POSITION (OVERLAY_START (overlay
)),
1749 end
= OVERLAY_POSITION (OVERLAY_END (overlay
))))
1750 && (beg
< PT
/* && end > PT <- It's always the case. */
1751 || (beg
<= PT
&& STRINGP (val
) && SCHARS (val
) == 0)))
1754 SET_PT (PT
< last_pt
1755 ? (STRINGP (val
) && SCHARS (val
) == 0
1756 ? max (beg
- 1, BEGV
)
1759 check_composition
= check_invisible
= 1;
1762 if (check_invisible
&& PT
> BEGV
&& PT
< ZV
)
1768 /* Find boundaries `beg' and `end' of the invisible area, if any. */
1771 /* FIXME: We should stop if we find a spot between
1772 two runs of `invisible' where inserted text would
1773 be visible. This is important when we have two
1774 invisible boundaries that enclose an area: if the
1775 area is empty, we need this test in order to make
1776 it possible to place point in the middle rather
1777 than skip both boundaries. However, this code
1778 also stops anywhere in a non-sticky text-property,
1779 which breaks (e.g.) Org mode. */
1780 && (val
= get_pos_property (make_number (end
),
1782 TEXT_PROP_MEANS_INVISIBLE (val
))
1784 && !NILP (val
= get_char_property_and_overlay
1785 (make_number (end
), Qinvisible
, Qnil
, &overlay
))
1786 && (inv
= TEXT_PROP_MEANS_INVISIBLE (val
)))
1788 ellipsis
= ellipsis
|| inv
> 1
1789 || (OVERLAYP (overlay
)
1790 && (!NILP (Foverlay_get (overlay
, Qafter_string
))
1791 || !NILP (Foverlay_get (overlay
, Qbefore_string
))));
1792 tmp
= Fnext_single_char_property_change
1793 (make_number (end
), Qinvisible
, Qnil
, Qnil
);
1794 end
= NATNUMP (tmp
) ? XFASTINT (tmp
) : ZV
;
1798 && (val
= get_pos_property (make_number (beg
),
1800 TEXT_PROP_MEANS_INVISIBLE (val
))
1802 && !NILP (val
= get_char_property_and_overlay
1803 (make_number (beg
- 1), Qinvisible
, Qnil
, &overlay
))
1804 && (inv
= TEXT_PROP_MEANS_INVISIBLE (val
)))
1806 ellipsis
= ellipsis
|| inv
> 1
1807 || (OVERLAYP (overlay
)
1808 && (!NILP (Foverlay_get (overlay
, Qafter_string
))
1809 || !NILP (Foverlay_get (overlay
, Qbefore_string
))));
1810 tmp
= Fprevious_single_char_property_change
1811 (make_number (beg
), Qinvisible
, Qnil
, Qnil
);
1812 beg
= NATNUMP (tmp
) ? XFASTINT (tmp
) : BEGV
;
1815 /* Move away from the inside area. */
1816 if (beg
< PT
&& end
> PT
)
1818 SET_PT ((orig_pt
== PT
&& (last_pt
< beg
|| last_pt
> end
))
1819 /* We haven't moved yet (so we don't need to fear
1820 infinite-looping) and we were outside the range
1821 before (so either end of the range still corresponds
1822 to a move in the right direction): pretend we moved
1823 less than we actually did, so that we still have
1824 more freedom below in choosing which end of the range
1826 ? (orig_pt
= -1, PT
< last_pt
? end
: beg
)
1827 /* We either have moved already or the last point
1828 was already in the range: we don't get to choose
1829 which end of the range we have to go to. */
1830 : (PT
< last_pt
? beg
: end
));
1831 check_composition
= check_display
= 1;
1833 #if 0 /* This assertion isn't correct, because SET_PT may end up setting
1834 the point to something other than its argument, due to
1835 point-motion hooks, intangibility, etc. */
1836 eassert (PT
== beg
|| PT
== end
);
1839 /* Pretend the area doesn't exist if the buffer is not
1841 if (!modified
&& !ellipsis
&& beg
< end
)
1843 if (last_pt
== beg
&& PT
== end
&& end
< ZV
)
1844 (check_composition
= check_display
= 1, SET_PT (end
+ 1));
1845 else if (last_pt
== end
&& PT
== beg
&& beg
> BEGV
)
1846 (check_composition
= check_display
= 1, SET_PT (beg
- 1));
1847 else if (PT
== ((PT
< last_pt
) ? beg
: end
))
1848 /* We've already moved as far as we can. Trying to go
1849 to the other end would mean moving backwards and thus
1850 could lead to an infinite loop. */
1852 else if (val
= get_pos_property (make_number (PT
),
1854 TEXT_PROP_MEANS_INVISIBLE (val
)
1855 && (val
= get_pos_property
1856 (make_number (PT
== beg
? end
: beg
),
1858 !TEXT_PROP_MEANS_INVISIBLE (val
)))
1859 (check_composition
= check_display
= 1,
1860 SET_PT (PT
== beg
? end
: beg
));
1863 check_invisible
= 0;
1867 /* Subroutine for safe_run_hooks: run the hook HOOK. */
1870 safe_run_hooks_1 (void)
1872 eassert (CONSP (Vinhibit_quit
));
1873 return call0 (XCDR (Vinhibit_quit
));
1876 /* Subroutine for safe_run_hooks: handle an error by clearing out the function
1880 safe_run_hooks_error (Lisp_Object error_data
)
1883 = CONSP (Vinhibit_quit
) ? XCAR (Vinhibit_quit
) : Vinhibit_quit
;
1884 Lisp_Object fun
= CONSP (Vinhibit_quit
) ? XCDR (Vinhibit_quit
) : Qnil
;
1885 Lisp_Object args
[4];
1886 args
[0] = build_string ("Error in %s (%s): %S");
1889 args
[3] = error_data
;
1895 Lisp_Object newval
= Qnil
;
1896 for (val
= find_symbol_value (hook
); CONSP (val
); val
= XCDR (val
))
1897 if (EQ (fun
, XCAR (val
)))
1900 newval
= Fcons (XCAR (val
), newval
);
1902 return Fset (hook
, Fnreverse (newval
));
1903 /* Not found in the local part of the hook. Let's look at the global
1906 for (val
= (NILP (Fdefault_boundp (hook
)) ? Qnil
1907 : Fdefault_value (hook
));
1908 CONSP (val
); val
= XCDR (val
))
1909 if (EQ (fun
, XCAR (val
)))
1912 newval
= Fcons (XCAR (val
), newval
);
1914 return Fset_default (hook
, Fnreverse (newval
));
1920 safe_run_hook_funcall (ptrdiff_t nargs
, Lisp_Object
*args
)
1922 eassert (nargs
== 1);
1923 if (CONSP (Vinhibit_quit
))
1924 XSETCDR (Vinhibit_quit
, args
[0]);
1926 Vinhibit_quit
= Fcons (Vinhibit_quit
, args
[0]);
1928 internal_condition_case (safe_run_hooks_1
, Qt
, safe_run_hooks_error
);
1932 /* If we get an error while running the hook, cause the hook variable
1933 to be nil. Also inhibit quits, so that C-g won't cause the hook
1934 to mysteriously evaporate. */
1937 safe_run_hooks (Lisp_Object hook
)
1939 /* FIXME: our `internal_condition_case' does not provide any way to pass data
1940 to its body or to its handlers other than via globals such as
1941 dynamically-bound variables ;-) */
1942 ptrdiff_t count
= SPECPDL_INDEX ();
1943 specbind (Qinhibit_quit
, hook
);
1945 run_hook_with_args (1, &hook
, safe_run_hook_funcall
);
1947 unbind_to (count
, Qnil
);
1951 /* Nonzero means polling for input is temporarily suppressed. */
1953 int poll_suppress_count
;
1956 #ifdef POLL_FOR_INPUT
1958 /* Asynchronous timer for polling. */
1960 static struct atimer
*poll_timer
;
1962 /* Poll for input, so that we catch a C-g if it comes in. This
1963 function is called from x_make_frame_visible, see comment
1967 poll_for_input_1 (void)
1969 if (! input_blocked_p ()
1970 && !waiting_for_input
)
1974 /* Timer callback function for poll_timer. TIMER is equal to
1978 poll_for_input (struct atimer
*timer
)
1980 if (poll_suppress_count
== 0)
1981 pending_signals
= 1;
1984 #endif /* POLL_FOR_INPUT */
1986 /* Begin signals to poll for input, if they are appropriate.
1987 This function is called unconditionally from various places. */
1990 start_polling (void)
1992 #ifdef POLL_FOR_INPUT
1993 /* XXX This condition was (read_socket_hook && !interrupt_input),
1994 but read_socket_hook is not global anymore. Let's pretend that
1996 if (!interrupt_input
)
1998 /* Turn alarm handling on unconditionally. It might have
1999 been turned off in process.c. */
2000 turn_on_atimers (1);
2002 /* If poll timer doesn't exist, are we need one with
2003 a different interval, start a new one. */
2004 if (poll_timer
== NULL
2005 || EMACS_SECS (poll_timer
->interval
) != polling_period
)
2007 time_t period
= max (1, min (polling_period
, TYPE_MAXIMUM (time_t)));
2008 EMACS_TIME interval
= make_emacs_time (period
, 0);
2011 cancel_atimer (poll_timer
);
2013 poll_timer
= start_atimer (ATIMER_CONTINUOUS
, interval
,
2014 poll_for_input
, NULL
);
2017 /* Let the timer's callback function poll for input
2018 if this becomes zero. */
2019 --poll_suppress_count
;
2024 /* True if we are using polling to handle input asynchronously. */
2027 input_polling_used (void)
2029 #ifdef POLL_FOR_INPUT
2030 /* XXX This condition was (read_socket_hook && !interrupt_input),
2031 but read_socket_hook is not global anymore. Let's pretend that
2033 return !interrupt_input
;
2039 /* Turn off polling. */
2044 #ifdef POLL_FOR_INPUT
2045 /* XXX This condition was (read_socket_hook && !interrupt_input),
2046 but read_socket_hook is not global anymore. Let's pretend that
2048 if (!interrupt_input
)
2049 ++poll_suppress_count
;
2053 /* Set the value of poll_suppress_count to COUNT
2054 and start or stop polling accordingly. */
2057 set_poll_suppress_count (int count
)
2059 #ifdef POLL_FOR_INPUT
2060 if (count
== 0 && poll_suppress_count
!= 0)
2062 poll_suppress_count
= 1;
2065 else if (count
!= 0 && poll_suppress_count
== 0)
2069 poll_suppress_count
= count
;
2073 /* Bind polling_period to a value at least N.
2074 But don't decrease it. */
2077 bind_polling_period (int n
)
2079 #ifdef POLL_FOR_INPUT
2080 EMACS_INT
new = polling_period
;
2085 stop_other_atimers (poll_timer
);
2087 specbind (Qpolling_period
, make_number (new));
2088 /* Start a new alarm with the new period. */
2093 /* Apply the control modifier to CHARACTER. */
2096 make_ctrl_char (int c
)
2098 /* Save the upper bits here. */
2099 int upper
= c
& ~0177;
2101 if (! ASCII_BYTE_P (c
))
2102 return c
|= ctrl_modifier
;
2106 /* Everything in the columns containing the upper-case letters
2107 denotes a control character. */
2108 if (c
>= 0100 && c
< 0140)
2112 /* Set the shift modifier for a control char
2113 made from a shifted letter. But only for letters! */
2114 if (oc
>= 'A' && oc
<= 'Z')
2115 c
|= shift_modifier
;
2118 /* The lower-case letters denote control characters too. */
2119 else if (c
>= 'a' && c
<= 'z')
2122 /* Include the bits for control and shift
2123 only if the basic ASCII code can't indicate them. */
2127 /* Replace the high bits. */
2128 c
|= (upper
& ~ctrl_modifier
);
2133 /* Display the help-echo property of the character after the mouse pointer.
2134 Either show it in the echo area, or call show-help-function to display
2135 it by other means (maybe in a tooltip).
2137 If HELP is nil, that means clear the previous help echo.
2139 If HELP is a string, display that string. If HELP is a function,
2140 call it with OBJECT and POS as arguments; the function should
2141 return a help string or nil for none. For all other types of HELP,
2142 evaluate it to obtain a string.
2144 WINDOW is the window in which the help was generated, if any.
2145 It is nil if not in a window.
2147 If OBJECT is a buffer, POS is the position in the buffer where the
2148 `help-echo' text property was found.
2150 If OBJECT is an overlay, that overlay has a `help-echo' property,
2151 and POS is the position in the overlay's buffer under the mouse.
2153 If OBJECT is a string (an overlay string or a string displayed with
2154 the `display' property). POS is the position in that string under
2157 Note: this function may only be called with HELP nil or a string
2158 from X code running asynchronously. */
2161 show_help_echo (Lisp_Object help
, Lisp_Object window
, Lisp_Object object
,
2164 if (!NILP (help
) && !STRINGP (help
))
2166 if (FUNCTIONP (help
))
2167 help
= safe_call (4, help
, window
, object
, pos
);
2169 help
= safe_eval (help
);
2171 if (!STRINGP (help
))
2175 if (!noninteractive
&& STRINGP (help
))
2177 /* The mouse-fixup-help-message Lisp function can call
2178 mouse_position_hook, which resets the mouse_moved flags.
2179 This causes trouble if we are trying to read a mouse motion
2180 event (i.e., if we are inside a `track-mouse' form), so we
2181 restore the mouse_moved flag. */
2182 FRAME_PTR f
= NILP (do_mouse_tracking
) ? NULL
: some_mouse_moved ();
2183 help
= call1 (Qmouse_fixup_help_message
, help
);
2188 if (STRINGP (help
) || NILP (help
))
2190 if (!NILP (Vshow_help_function
))
2191 call1 (Vshow_help_function
, help
);
2192 help_echo_showing_p
= STRINGP (help
);
2198 /* Input of single characters from keyboard */
2200 static Lisp_Object
kbd_buffer_get_event (KBOARD
**kbp
, bool *used_mouse_menu
,
2201 EMACS_TIME
*end_time
);
2202 static void record_char (Lisp_Object c
);
2204 static Lisp_Object help_form_saved_window_configs
;
2206 read_char_help_form_unwind (Lisp_Object arg
)
2208 Lisp_Object window_config
= XCAR (help_form_saved_window_configs
);
2209 help_form_saved_window_configs
= XCDR (help_form_saved_window_configs
);
2210 if (!NILP (window_config
))
2211 Fset_window_configuration (window_config
);
2215 #define STOP_POLLING \
2216 do { if (! polling_stopped_here) stop_polling (); \
2217 polling_stopped_here = 1; } while (0)
2219 #define RESUME_POLLING \
2220 do { if (polling_stopped_here) start_polling (); \
2221 polling_stopped_here = 0; } while (0)
2223 /* read a character from the keyboard; call the redisplay if needed */
2224 /* commandflag 0 means do not autosave, but do redisplay.
2225 -1 means do not redisplay, but do autosave.
2228 /* The arguments MAPS and NMAPS are for menu prompting.
2229 MAPS is an array of keymaps; NMAPS is the length of MAPS.
2231 PREV_EVENT is the previous input event, or nil if we are reading
2232 the first event of a key sequence (or not reading a key sequence).
2233 If PREV_EVENT is t, that is a "magic" value that says
2234 not to run input methods, but in other respects to act as if
2235 not reading a key sequence.
2237 If USED_MOUSE_MENU is non-null, then set *USED_MOUSE_MENU to true
2238 if we used a mouse menu to read the input, or false otherwise. If
2239 USED_MOUSE_MENU is null, don't dereference it.
2241 Value is -2 when we find input on another keyboard. A second call
2242 to read_char will read it.
2244 If END_TIME is non-null, it is a pointer to an EMACS_TIME
2245 specifying the maximum time to wait until. If no input arrives by
2246 that time, stop waiting and return nil.
2248 Value is t if we showed a menu and the user rejected it. */
2251 read_char (int commandflag
, ptrdiff_t nmaps
, Lisp_Object
*maps
,
2252 Lisp_Object prev_event
,
2253 bool *used_mouse_menu
, EMACS_TIME
*end_time
)
2257 sys_jmp_buf local_getcjmp
;
2258 sys_jmp_buf save_jump
;
2259 Lisp_Object tem
, save
;
2260 volatile Lisp_Object previous_echo_area_message
;
2261 volatile Lisp_Object also_record
;
2262 volatile bool reread
;
2263 struct gcpro gcpro1
, gcpro2
;
2264 bool volatile polling_stopped_here
= 0;
2265 struct kboard
*orig_kboard
= current_kboard
;
2269 #if 0 /* This was commented out as part of fixing echo for C-u left. */
2270 before_command_key_count
= this_command_key_count
;
2271 before_command_echo_length
= echo_length ();
2274 previous_echo_area_message
= Qnil
;
2276 GCPRO2 (c
, previous_echo_area_message
);
2281 if (CONSP (Vunread_post_input_method_events
))
2283 c
= XCAR (Vunread_post_input_method_events
);
2284 Vunread_post_input_method_events
2285 = XCDR (Vunread_post_input_method_events
);
2287 /* Undo what read_char_x_menu_prompt did when it unread
2288 additional keys returned by Fx_popup_menu. */
2290 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2298 if (CONSP (Vunread_command_events
))
2300 bool was_disabled
= 0;
2302 c
= XCAR (Vunread_command_events
);
2303 Vunread_command_events
= XCDR (Vunread_command_events
);
2307 /* Undo what sit-for did when it unread additional keys
2308 inside universal-argument. */
2311 && EQ (XCAR (c
), Qt
))
2317 /* Undo what read_char_x_menu_prompt did when it unread
2318 additional keys returned by Fx_popup_menu. */
2320 && EQ (XCDR (c
), Qdisabled
)
2321 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
))))
2327 /* If the queued event is something that used the mouse,
2328 set used_mouse_menu accordingly. */
2330 /* Also check was_disabled so last-nonmenu-event won't return
2331 a bad value when submenus are involved. (Bug#447) */
2332 && (EQ (c
, Qtool_bar
) || EQ (c
, Qmenu_bar
) || was_disabled
))
2333 *used_mouse_menu
= 1;
2335 goto reread_for_input_method
;
2338 if (CONSP (Vunread_input_method_events
))
2340 c
= XCAR (Vunread_input_method_events
);
2341 Vunread_input_method_events
= XCDR (Vunread_input_method_events
);
2343 /* Undo what read_char_x_menu_prompt did when it unread
2344 additional keys returned by Fx_popup_menu. */
2346 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2350 goto reread_for_input_method
;
2353 this_command_key_count_reset
= 0;
2355 if (!NILP (Vexecuting_kbd_macro
))
2357 /* We set this to Qmacro; since that's not a frame, nobody will
2358 try to switch frames on us, and the selected window will
2361 Since this event came from a macro, it would be misleading to
2362 leave internal_last_event_frame set to wherever the last
2363 real event came from. Normally, a switch-frame event selects
2364 internal_last_event_frame after each command is read, but
2365 events read from a macro should never cause a new frame to be
2367 Vlast_event_frame
= internal_last_event_frame
= Qmacro
;
2369 /* Exit the macro if we are at the end.
2370 Also, some things replace the macro with t
2371 to force an early exit. */
2372 if (EQ (Vexecuting_kbd_macro
, Qt
)
2373 || executing_kbd_macro_index
>= XFASTINT (Flength (Vexecuting_kbd_macro
)))
2379 c
= Faref (Vexecuting_kbd_macro
, make_number (executing_kbd_macro_index
));
2380 if (STRINGP (Vexecuting_kbd_macro
)
2381 && (XFASTINT (c
) & 0x80) && (XFASTINT (c
) <= 0xff))
2382 XSETFASTINT (c
, CHAR_META
| (XFASTINT (c
) & ~0x80));
2384 executing_kbd_macro_index
++;
2389 if (!NILP (unread_switch_frame
))
2391 c
= unread_switch_frame
;
2392 unread_switch_frame
= Qnil
;
2394 /* This event should make it into this_command_keys, and get echoed
2395 again, so we do not set `reread'. */
2399 /* if redisplay was requested */
2400 if (commandflag
>= 0)
2402 bool echo_current
= EQ (echo_message_buffer
, echo_area_buffer
[0]);
2404 /* If there is pending input, process any events which are not
2405 user-visible, such as X selection_request events. */
2407 || detect_input_pending_run_timers (0))
2408 swallow_events (0); /* may clear input_pending */
2410 /* Redisplay if no pending input. */
2411 while (!input_pending
)
2413 if (help_echo_showing_p
&& !EQ (selected_window
, minibuf_window
))
2414 redisplay_preserve_echo_area (5);
2419 /* Normal case: no input arrived during redisplay. */
2422 /* Input arrived and pre-empted redisplay.
2423 Process any events which are not user-visible. */
2425 /* If that cleared input_pending, try again to redisplay. */
2428 /* Prevent the redisplay we just did
2429 from messing up echoing of the input after the prompt. */
2430 if (commandflag
== 0 && echo_current
)
2431 echo_message_buffer
= echo_area_buffer
[0];
2435 /* Message turns off echoing unless more keystrokes turn it on again.
2437 The code in 20.x for the condition was
2439 1. echo_area_glyphs && *echo_area_glyphs
2440 2. && echo_area_glyphs != current_kboard->echobuf
2441 3. && ok_to_echo_at_next_pause != echo_area_glyphs
2443 (1) means there's a current message displayed
2445 (2) means it's not the message from echoing from the current
2448 (3) There's only one place in 20.x where ok_to_echo_at_next_pause
2449 is set to a non-null value. This is done in read_char and it is
2450 set to echo_area_glyphs after a call to echo_char. That means
2451 ok_to_echo_at_next_pause is either null or
2452 current_kboard->echobuf with the appropriate current_kboard at
2455 So, condition (3) means in clear text ok_to_echo_at_next_pause
2456 must be either null, or the current message isn't from echoing at
2457 all, or it's from echoing from a different kboard than the
2460 if (/* There currently is something in the echo area. */
2461 !NILP (echo_area_buffer
[0])
2462 && (/* And it's either not from echoing. */
2463 !EQ (echo_area_buffer
[0], echo_message_buffer
)
2464 /* Or it's an echo from a different kboard. */
2465 || echo_kboard
!= current_kboard
2466 /* Or we explicitly allow overwriting whatever there is. */
2467 || ok_to_echo_at_next_pause
== NULL
))
2472 /* Try reading a character via menu prompting in the minibuf.
2473 Try this before the sit-for, because the sit-for
2474 would do the wrong thing if we are supposed to do
2475 menu prompting. If EVENT_HAS_PARAMETERS then we are reading
2476 after a mouse event so don't try a minibuf menu. */
2478 if (nmaps
> 0 && INTERACTIVE
2479 && !NILP (prev_event
) && ! EVENT_HAS_PARAMETERS (prev_event
)
2480 /* Don't bring up a menu if we already have another event. */
2481 && NILP (Vunread_command_events
)
2482 && !detect_input_pending_run_timers (0))
2484 c
= read_char_minibuf_menu_prompt (commandflag
, nmaps
, maps
);
2486 if (INTEGERP (c
) && XINT (c
) == -2)
2487 return c
; /* wrong_kboard_jmpbuf */
2493 /* Make a longjmp point for quits to use, but don't alter getcjmp just yet.
2494 We will do that below, temporarily for short sections of code,
2495 when appropriate. local_getcjmp must be in effect
2496 around any call to sit_for or kbd_buffer_get_event;
2497 it *must not* be in effect when we call redisplay. */
2499 jmpcount
= SPECPDL_INDEX ();
2500 if (sys_setjmp (local_getcjmp
))
2502 /* Handle quits while reading the keyboard. */
2503 /* We must have saved the outer value of getcjmp here,
2504 so restore it now. */
2505 restore_getcjmp (save_jump
);
2506 unbind_to (jmpcount
, Qnil
);
2507 XSETINT (c
, quit_char
);
2508 internal_last_event_frame
= selected_frame
;
2509 Vlast_event_frame
= internal_last_event_frame
;
2510 /* If we report the quit char as an event,
2511 don't do so more than once. */
2512 if (!NILP (Vinhibit_quit
))
2516 KBOARD
*kb
= FRAME_KBOARD (XFRAME (selected_frame
));
2517 if (kb
!= current_kboard
)
2519 Lisp_Object last
= KVAR (kb
, kbd_queue
);
2520 /* We shouldn't get here if we were in single-kboard mode! */
2525 while (CONSP (XCDR (last
)))
2527 if (!NILP (XCDR (last
)))
2531 kset_kbd_queue (kb
, Fcons (c
, Qnil
));
2533 XSETCDR (last
, Fcons (c
, Qnil
));
2534 kb
->kbd_queue_has_data
= 1;
2535 current_kboard
= kb
;
2536 /* This is going to exit from read_char
2537 so we had better get rid of this frame's stuff. */
2539 return make_number (-2); /* wrong_kboard_jmpbuf */
2545 /* Start idle timers if no time limit is supplied. We don't do it
2546 if a time limit is supplied to avoid an infinite recursion in the
2547 situation where an idle timer calls `sit-for'. */
2550 timer_start_idle ();
2552 /* If in middle of key sequence and minibuffer not active,
2553 start echoing if enough time elapses. */
2555 if (minibuf_level
== 0
2557 && !current_kboard
->immediate_echo
2558 && this_command_key_count
> 0
2560 && (FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
2561 && NILP (Fzerop (Vecho_keystrokes
))
2562 && (/* No message. */
2563 NILP (echo_area_buffer
[0])
2564 /* Or empty message. */
2565 || (BUF_BEG (XBUFFER (echo_area_buffer
[0]))
2566 == BUF_Z (XBUFFER (echo_area_buffer
[0])))
2567 /* Or already echoing from same kboard. */
2568 || (echo_kboard
&& ok_to_echo_at_next_pause
== echo_kboard
)
2569 /* Or not echoing before and echoing allowed. */
2570 || (!echo_kboard
&& ok_to_echo_at_next_pause
)))
2572 /* After a mouse event, start echoing right away.
2573 This is because we are probably about to display a menu,
2574 and we don't want to delay before doing so. */
2575 if (EVENT_HAS_PARAMETERS (prev_event
))
2581 save_getcjmp (save_jump
);
2582 restore_getcjmp (local_getcjmp
);
2583 tem0
= sit_for (Vecho_keystrokes
, 1, 1);
2584 restore_getcjmp (save_jump
);
2586 && ! CONSP (Vunread_command_events
))
2591 /* Maybe auto save due to number of keystrokes. */
2593 if (commandflag
!= 0
2594 && auto_save_interval
> 0
2595 && num_nonmacro_input_events
- last_auto_save
> max (auto_save_interval
, 20)
2596 && !detect_input_pending_run_timers (0))
2598 Fdo_auto_save (Qnil
, Qnil
);
2599 /* Hooks can actually change some buffers in auto save. */
2603 /* Try reading using an X menu.
2604 This is never confused with reading using the minibuf
2605 because the recursive call of read_char in read_char_minibuf_menu_prompt
2606 does not pass on any keymaps. */
2608 if (nmaps
> 0 && INTERACTIVE
2609 && !NILP (prev_event
)
2610 && EVENT_HAS_PARAMETERS (prev_event
)
2611 && !EQ (XCAR (prev_event
), Qmenu_bar
)
2612 && !EQ (XCAR (prev_event
), Qtool_bar
)
2613 /* Don't bring up a menu if we already have another event. */
2614 && NILP (Vunread_command_events
))
2616 c
= read_char_x_menu_prompt (nmaps
, maps
, prev_event
, used_mouse_menu
);
2618 /* Now that we have read an event, Emacs is not idle. */
2625 /* Maybe autosave and/or garbage collect due to idleness. */
2627 if (INTERACTIVE
&& NILP (c
))
2630 ptrdiff_t buffer_size
;
2632 /* Slow down auto saves logarithmically in size of current buffer,
2633 and garbage collect while we're at it. */
2634 if (! MINI_WINDOW_P (XWINDOW (selected_window
)))
2635 last_non_minibuf_size
= Z
- BEG
;
2636 buffer_size
= (last_non_minibuf_size
>> 8) + 1;
2638 while (buffer_size
> 64)
2639 delay_level
++, buffer_size
-= buffer_size
>> 2;
2640 if (delay_level
< 4) delay_level
= 4;
2641 /* delay_level is 4 for files under around 50k, 7 at 100k,
2642 9 at 200k, 11 at 300k, and 12 at 500k. It is 15 at 1 meg. */
2644 /* Auto save if enough time goes by without input. */
2645 if (commandflag
!= 0
2646 && num_nonmacro_input_events
> last_auto_save
2647 && INTEGERP (Vauto_save_timeout
)
2648 && XINT (Vauto_save_timeout
) > 0)
2651 EMACS_INT timeout
= (delay_level
2652 * min (XFASTINT (Vauto_save_timeout
) / 4,
2653 MOST_POSITIVE_FIXNUM
/ delay_level
));
2654 save_getcjmp (save_jump
);
2655 restore_getcjmp (local_getcjmp
);
2656 tem0
= sit_for (make_number (timeout
), 1, 1);
2657 restore_getcjmp (save_jump
);
2660 && ! CONSP (Vunread_command_events
))
2662 Fdo_auto_save (Qnil
, Qnil
);
2667 /* If there is still no input available, ask for GC. */
2668 if (!detect_input_pending_run_timers (0))
2672 /* Notify the caller if an autosave hook, or a timer, sentinel or
2673 filter in the sit_for calls above have changed the current
2674 kboard. This could happen if they use the minibuffer or start a
2675 recursive edit, like the fancy splash screen in server.el's
2676 filter. If this longjmp wasn't here, read_key_sequence would
2677 interpret the next key sequence using the wrong translation
2678 tables and function keymaps. */
2679 if (NILP (c
) && current_kboard
!= orig_kboard
)
2682 return make_number (-2); /* wrong_kboard_jmpbuf */
2685 /* If this has become non-nil here, it has been set by a timer
2686 or sentinel or filter. */
2687 if (CONSP (Vunread_command_events
))
2689 c
= XCAR (Vunread_command_events
);
2690 Vunread_command_events
= XCDR (Vunread_command_events
);
2693 /* Read something from current KBOARD's side queue, if possible. */
2697 if (current_kboard
->kbd_queue_has_data
)
2699 if (!CONSP (KVAR (current_kboard
, kbd_queue
)))
2701 c
= XCAR (KVAR (current_kboard
, kbd_queue
));
2702 kset_kbd_queue (current_kboard
,
2703 XCDR (KVAR (current_kboard
, kbd_queue
)));
2704 if (NILP (KVAR (current_kboard
, kbd_queue
)))
2705 current_kboard
->kbd_queue_has_data
= 0;
2706 input_pending
= readable_events (0);
2707 if (EVENT_HAS_PARAMETERS (c
)
2708 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qswitch_frame
))
2709 internal_last_event_frame
= XCAR (XCDR (c
));
2710 Vlast_event_frame
= internal_last_event_frame
;
2714 /* If current_kboard's side queue is empty check the other kboards.
2715 If one of them has data that we have not yet seen here,
2716 switch to it and process the data waiting for it.
2718 Note: if the events queued up for another kboard
2719 have already been seen here, and therefore are not a complete command,
2720 the kbd_queue_has_data field is 0, so we skip that kboard here.
2721 That's to avoid an infinite loop switching between kboards here. */
2722 if (NILP (c
) && !single_kboard
)
2725 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
2726 if (kb
->kbd_queue_has_data
)
2728 current_kboard
= kb
;
2729 /* This is going to exit from read_char
2730 so we had better get rid of this frame's stuff. */
2732 return make_number (-2); /* wrong_kboard_jmpbuf */
2740 /* Finally, we read from the main queue,
2741 and if that gives us something we can't use yet, we put it on the
2742 appropriate side queue and try again. */
2746 KBOARD
*kb
IF_LINT (= NULL
);
2748 if (end_time
&& EMACS_TIME_LE (*end_time
, current_emacs_time ()))
2751 /* Actually read a character, waiting if necessary. */
2752 save_getcjmp (save_jump
);
2753 restore_getcjmp (local_getcjmp
);
2755 timer_start_idle ();
2756 c
= kbd_buffer_get_event (&kb
, used_mouse_menu
, end_time
);
2757 restore_getcjmp (save_jump
);
2759 if (! NILP (c
) && (kb
!= current_kboard
))
2761 Lisp_Object last
= KVAR (kb
, kbd_queue
);
2764 while (CONSP (XCDR (last
)))
2766 if (!NILP (XCDR (last
)))
2770 kset_kbd_queue (kb
, Fcons (c
, Qnil
));
2772 XSETCDR (last
, Fcons (c
, Qnil
));
2773 kb
->kbd_queue_has_data
= 1;
2777 current_kboard
= kb
;
2778 /* This is going to exit from read_char
2779 so we had better get rid of this frame's stuff. */
2781 return make_number (-2);
2785 /* Terminate Emacs in batch mode if at eof. */
2786 if (noninteractive
&& INTEGERP (c
) && XINT (c
) < 0)
2787 Fkill_emacs (make_number (1));
2791 /* Add in any extra modifiers, where appropriate. */
2792 if ((extra_keyboard_modifiers
& CHAR_CTL
)
2793 || ((extra_keyboard_modifiers
& 0177) < ' '
2794 && (extra_keyboard_modifiers
& 0177) != 0))
2795 XSETINT (c
, make_ctrl_char (XINT (c
)));
2797 /* Transfer any other modifier bits directly from
2798 extra_keyboard_modifiers to c. Ignore the actual character code
2799 in the low 16 bits of extra_keyboard_modifiers. */
2800 XSETINT (c
, XINT (c
) | (extra_keyboard_modifiers
& ~0xff7f & ~CHAR_CTL
));
2811 if (commandflag
>= 0
2812 && !input_pending
&& !detect_input_pending_run_timers (0))
2818 /* Buffer switch events are only for internal wakeups
2819 so don't show them to the user.
2820 Also, don't record a key if we already did. */
2824 /* Process special events within read_char
2825 and loop around to read another event. */
2828 tem
= access_keymap (get_keymap (Vspecial_event_map
, 0, 1), c
, 0, 0, 1);
2833 struct buffer
*prev_buffer
= current_buffer
;
2834 last_input_event
= c
;
2835 Fcommand_execute (tem
, Qnil
, Fvector (1, &last_input_event
), Qt
);
2837 if (CONSP (c
) && EQ (XCAR (c
), Qselect_window
) && !end_time
)
2838 /* We stopped being idle for this event; undo that. This
2839 prevents automatic window selection (under
2840 mouse_autoselect_window from acting as a real input event, for
2841 example banishing the mouse under mouse-avoidance-mode. */
2842 timer_resume_idle ();
2844 if (current_buffer
!= prev_buffer
)
2846 /* The command may have changed the keymaps. Pretend there
2847 is input in another keyboard and return. This will
2848 recalculate keymaps. */
2849 c
= make_number (-2);
2856 /* Handle things that only apply to characters. */
2859 /* If kbd_buffer_get_event gave us an EOF, return that. */
2863 if ((STRINGP (KVAR (current_kboard
, Vkeyboard_translate_table
))
2864 && UNSIGNED_CMP (XFASTINT (c
), <,
2865 SCHARS (KVAR (current_kboard
,
2866 Vkeyboard_translate_table
))))
2867 || (VECTORP (KVAR (current_kboard
, Vkeyboard_translate_table
))
2868 && UNSIGNED_CMP (XFASTINT (c
), <,
2869 ASIZE (KVAR (current_kboard
,
2870 Vkeyboard_translate_table
))))
2871 || (CHAR_TABLE_P (KVAR (current_kboard
, Vkeyboard_translate_table
))
2875 d
= Faref (KVAR (current_kboard
, Vkeyboard_translate_table
), c
);
2876 /* nil in keyboard-translate-table means no translation. */
2882 /* If this event is a mouse click in the menu bar,
2883 return just menu-bar for now. Modify the mouse click event
2884 so we won't do this twice, then queue it up. */
2885 if (EVENT_HAS_PARAMETERS (c
)
2887 && CONSP (EVENT_START (c
))
2888 && CONSP (XCDR (EVENT_START (c
))))
2892 posn
= POSN_POSN (EVENT_START (c
));
2893 /* Handle menu-bar events:
2894 insert the dummy prefix event `menu-bar'. */
2895 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
2897 /* Change menu-bar to (menu-bar) as the event "position". */
2898 POSN_SET_POSN (EVENT_START (c
), Fcons (posn
, Qnil
));
2901 Vunread_command_events
= Fcons (c
, Vunread_command_events
);
2906 /* Store these characters into recent_keys, the dribble file if any,
2907 and the keyboard macro being defined, if any. */
2909 if (! NILP (also_record
))
2910 record_char (also_record
);
2912 /* Wipe the echo area.
2913 But first, if we are about to use an input method,
2914 save the echo area contents for it to refer to. */
2916 && ! NILP (Vinput_method_function
)
2917 && ' ' <= XINT (c
) && XINT (c
) < 256 && XINT (c
) != 127)
2919 previous_echo_area_message
= Fcurrent_message ();
2920 Vinput_method_previous_message
= previous_echo_area_message
;
2923 /* Now wipe the echo area, except for help events which do their
2924 own stuff with the echo area. */
2926 || (!(EQ (Qhelp_echo
, XCAR (c
)))
2927 && !(EQ (Qswitch_frame
, XCAR (c
)))
2928 /* Don't wipe echo area for select window events: These might
2929 get delayed via `mouse-autoselect-window' (Bug#11304). */
2930 && !(EQ (Qselect_window
, XCAR (c
)))))
2932 if (!NILP (echo_area_buffer
[0]))
2934 safe_run_hooks (Qecho_area_clear_hook
);
2935 clear_message (1, 0);
2939 reread_for_input_method
:
2941 /* Pass this to the input method, if appropriate. */
2943 && ! NILP (Vinput_method_function
)
2944 /* Don't run the input method within a key sequence,
2945 after the first event of the key sequence. */
2946 && NILP (prev_event
)
2947 && ' ' <= XINT (c
) && XINT (c
) < 256 && XINT (c
) != 127)
2950 ptrdiff_t key_count
;
2951 bool key_count_reset
;
2952 struct gcpro gcpro1
;
2953 ptrdiff_t count
= SPECPDL_INDEX ();
2955 /* Save the echo status. */
2956 bool saved_immediate_echo
= current_kboard
->immediate_echo
;
2957 struct kboard
*saved_ok_to_echo
= ok_to_echo_at_next_pause
;
2958 Lisp_Object saved_echo_string
= KVAR (current_kboard
, echo_string
);
2959 ptrdiff_t saved_echo_after_prompt
= current_kboard
->echo_after_prompt
;
2962 if (before_command_restore_flag
)
2964 this_command_key_count
= before_command_key_count_1
;
2965 if (this_command_key_count
< this_single_command_key_start
)
2966 this_single_command_key_start
= this_command_key_count
;
2967 echo_truncate (before_command_echo_length_1
);
2968 before_command_restore_flag
= 0;
2972 /* Save the this_command_keys status. */
2973 key_count
= this_command_key_count
;
2974 key_count_reset
= this_command_key_count_reset
;
2977 keys
= Fcopy_sequence (this_command_keys
);
2982 /* Clear out this_command_keys. */
2983 this_command_key_count
= 0;
2984 this_command_key_count_reset
= 0;
2986 /* Now wipe the echo area. */
2987 if (!NILP (echo_area_buffer
[0]))
2988 safe_run_hooks (Qecho_area_clear_hook
);
2989 clear_message (1, 0);
2992 /* If we are not reading a key sequence,
2993 never use the echo area. */
2996 specbind (Qinput_method_use_echo_area
, Qt
);
2999 /* Call the input method. */
3000 tem
= call1 (Vinput_method_function
, c
);
3002 tem
= unbind_to (count
, tem
);
3004 /* Restore the saved echoing state
3005 and this_command_keys state. */
3006 this_command_key_count
= key_count
;
3007 this_command_key_count_reset
= key_count_reset
;
3009 this_command_keys
= keys
;
3012 ok_to_echo_at_next_pause
= saved_ok_to_echo
;
3013 kset_echo_string (current_kboard
, saved_echo_string
);
3014 current_kboard
->echo_after_prompt
= saved_echo_after_prompt
;
3015 if (saved_immediate_echo
)
3020 /* The input method can return no events. */
3023 /* Bring back the previous message, if any. */
3024 if (! NILP (previous_echo_area_message
))
3025 message_with_string ("%s", previous_echo_area_message
, 0);
3028 /* It returned one event or more. */
3030 Vunread_post_input_method_events
3031 = nconc2 (XCDR (tem
), Vunread_post_input_method_events
);
3036 /* Display help if not echoing. */
3037 if (CONSP (c
) && EQ (XCAR (c
), Qhelp_echo
))
3039 /* (help-echo FRAME HELP WINDOW OBJECT POS). */
3040 Lisp_Object help
, object
, position
, window
, htem
;
3042 htem
= Fcdr (XCDR (c
));
3045 window
= Fcar (htem
);
3047 object
= Fcar (htem
);
3049 position
= Fcar (htem
);
3051 show_help_echo (help
, window
, object
, position
);
3053 /* We stopped being idle for this event; undo that. */
3055 timer_resume_idle ();
3059 if ((! reread
|| this_command_key_count
== 0
3060 || this_command_key_count_reset
)
3064 /* Don't echo mouse motion events. */
3065 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
3066 && NILP (Fzerop (Vecho_keystrokes
))
3067 && ! (EVENT_HAS_PARAMETERS (c
)
3068 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
3071 if (! NILP (also_record
))
3072 echo_char (also_record
);
3073 /* Once we reread a character, echoing can happen
3074 the next time we pause to read a new one. */
3075 ok_to_echo_at_next_pause
= current_kboard
;
3078 /* Record this character as part of the current key. */
3079 add_command_key (c
);
3080 if (! NILP (also_record
))
3081 add_command_key (also_record
);
3084 last_input_event
= c
;
3087 /* Process the help character specially if enabled */
3088 if (!NILP (Vhelp_form
) && help_char_p (c
))
3090 ptrdiff_t count
= SPECPDL_INDEX ();
3092 help_form_saved_window_configs
3093 = Fcons (Fcurrent_window_configuration (Qnil
),
3094 help_form_saved_window_configs
);
3095 record_unwind_protect (read_char_help_form_unwind
, Qnil
);
3096 call0 (Qhelp_form_show
);
3101 c
= read_char (0, 0, 0, Qnil
, 0, NULL
);
3102 if (EVENT_HAS_PARAMETERS (c
)
3103 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_click
))
3104 XSETCAR (help_form_saved_window_configs
, Qnil
);
3106 while (BUFFERP (c
));
3107 /* Remove the help from the frame */
3108 unbind_to (count
, Qnil
);
3111 if (EQ (c
, make_number (040)))
3115 c
= read_char (0, 0, 0, Qnil
, 0, NULL
);
3116 while (BUFFERP (c
));
3125 /* Record a key that came from a mouse menu.
3126 Record it for echoing, for this-command-keys, and so on. */
3129 record_menu_key (Lisp_Object c
)
3131 /* Wipe the echo area. */
3132 clear_message (1, 0);
3137 before_command_key_count
= this_command_key_count
;
3138 before_command_echo_length
= echo_length ();
3141 /* Don't echo mouse motion events. */
3142 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
3143 && NILP (Fzerop (Vecho_keystrokes
)))
3147 /* Once we reread a character, echoing can happen
3148 the next time we pause to read a new one. */
3149 ok_to_echo_at_next_pause
= 0;
3152 /* Record this character as part of the current key. */
3153 add_command_key (c
);
3155 /* Re-reading in the middle of a command */
3156 last_input_event
= c
;
3160 /* Return true if should recognize C as "the help character". */
3163 help_char_p (Lisp_Object c
)
3167 if (EQ (c
, Vhelp_char
))
3169 for (tail
= Vhelp_event_list
; CONSP (tail
); tail
= XCDR (tail
))
3170 if (EQ (c
, XCAR (tail
)))
3175 /* Record the input event C in various ways. */
3178 record_char (Lisp_Object c
)
3182 if (CONSP (c
) && (EQ (XCAR (c
), Qhelp_echo
) || EQ (XCAR (c
), Qmouse_movement
)))
3184 /* To avoid filling recent_keys with help-echo and mouse-movement
3185 events, we filter out repeated help-echo events, only store the
3186 first and last in a series of mouse-movement events, and don't
3187 store repeated help-echo events which are only separated by
3188 mouse-movement events. */
3190 Lisp_Object ev1
, ev2
, ev3
;
3193 if ((ix1
= recent_keys_index
- 1) < 0)
3194 ix1
= NUM_RECENT_KEYS
- 1;
3195 ev1
= AREF (recent_keys
, ix1
);
3197 if ((ix2
= ix1
- 1) < 0)
3198 ix2
= NUM_RECENT_KEYS
- 1;
3199 ev2
= AREF (recent_keys
, ix2
);
3201 if ((ix3
= ix2
- 1) < 0)
3202 ix3
= NUM_RECENT_KEYS
- 1;
3203 ev3
= AREF (recent_keys
, ix3
);
3205 if (EQ (XCAR (c
), Qhelp_echo
))
3207 /* Don't record `help-echo' in recent_keys unless it shows some help
3208 message, and a different help than the previously recorded
3210 Lisp_Object help
, last_help
;
3212 help
= Fcar_safe (Fcdr_safe (XCDR (c
)));
3213 if (!STRINGP (help
))
3215 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qhelp_echo
)
3216 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev1
))), EQ (last_help
, help
)))
3218 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3219 && CONSP (ev2
) && EQ (XCAR (ev2
), Qhelp_echo
)
3220 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev2
))), EQ (last_help
, help
)))
3222 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3223 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3224 && CONSP (ev3
) && EQ (XCAR (ev3
), Qhelp_echo
)
3225 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev3
))), EQ (last_help
, help
)))
3228 else if (EQ (XCAR (c
), Qmouse_movement
))
3230 /* Only record one pair of `mouse-movement' on a window in recent_keys.
3231 So additional mouse movement events replace the last element. */
3232 Lisp_Object last_window
, window
;
3234 window
= Fcar_safe (Fcar_safe (XCDR (c
)));
3235 if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3236 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev1
))), EQ (last_window
, window
))
3237 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3238 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev2
))), EQ (last_window
, window
)))
3240 ASET (recent_keys
, ix1
, c
);
3246 store_kbd_macro_char (c
);
3250 total_keys
+= total_keys
< NUM_RECENT_KEYS
;
3251 ASET (recent_keys
, recent_keys_index
, c
);
3252 if (++recent_keys_index
>= NUM_RECENT_KEYS
)
3253 recent_keys_index
= 0;
3255 else if (recorded
< 0)
3257 /* We need to remove one or two events from recent_keys.
3258 To do this, we simply put nil at those events and move the
3259 recent_keys_index backwards over those events. Usually,
3260 users will never see those nil events, as they will be
3261 overwritten by the command keys entered to see recent_keys
3264 while (recorded
++ < 0 && total_keys
> 0)
3266 if (total_keys
< NUM_RECENT_KEYS
)
3268 if (--recent_keys_index
< 0)
3269 recent_keys_index
= NUM_RECENT_KEYS
- 1;
3270 ASET (recent_keys
, recent_keys_index
, Qnil
);
3274 num_nonmacro_input_events
++;
3276 /* Write c to the dribble file. If c is a lispy event, write
3277 the event's symbol to the dribble file, in <brackets>. Bleaugh.
3278 If you, dear reader, have a better idea, you've got the source. :-) */
3284 if (XUINT (c
) < 0x100)
3285 putc (XUINT (c
), dribble
);
3287 fprintf (dribble
, " 0x%"pI
"x", XUINT (c
));
3291 Lisp_Object dribblee
;
3293 /* If it's a structured event, take the event header. */
3294 dribblee
= EVENT_HEAD (c
);
3296 if (SYMBOLP (dribblee
))
3298 putc ('<', dribble
);
3299 fwrite (SDATA (SYMBOL_NAME (dribblee
)), sizeof (char),
3300 SBYTES (SYMBOL_NAME (dribblee
)),
3302 putc ('>', dribble
);
3311 /* Copy out or in the info on where C-g should throw to.
3312 This is used when running Lisp code from within get_char,
3313 in case get_char is called recursively.
3314 See read_process_output. */
3317 save_getcjmp (sys_jmp_buf temp
)
3319 memcpy (temp
, getcjmp
, sizeof getcjmp
);
3323 restore_getcjmp (sys_jmp_buf temp
)
3325 memcpy (getcjmp
, temp
, sizeof getcjmp
);
3328 /* Low level keyboard/mouse input.
3329 kbd_buffer_store_event places events in kbd_buffer, and
3330 kbd_buffer_get_event retrieves them. */
3332 /* Return true if there are any events in the queue that read-char
3333 would return. If this returns false, a read-char would block. */
3335 readable_events (int flags
)
3337 if (flags
& READABLE_EVENTS_DO_TIMERS_NOW
)
3340 /* If the buffer contains only FOCUS_IN_EVENT events, and
3341 READABLE_EVENTS_FILTER_EVENTS is set, report it as empty. */
3342 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3344 if (flags
& (READABLE_EVENTS_FILTER_EVENTS
3345 #ifdef USE_TOOLKIT_SCROLL_BARS
3346 | READABLE_EVENTS_IGNORE_SQUEEZABLES
3350 struct input_event
*event
;
3352 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
3359 #ifdef USE_TOOLKIT_SCROLL_BARS
3360 (flags
& READABLE_EVENTS_FILTER_EVENTS
) &&
3362 event
->kind
== FOCUS_IN_EVENT
)
3363 #ifdef USE_TOOLKIT_SCROLL_BARS
3364 && !((flags
& READABLE_EVENTS_IGNORE_SQUEEZABLES
)
3365 && event
->kind
== SCROLL_BAR_CLICK_EVENT
3366 && event
->part
== scroll_bar_handle
3367 && event
->modifiers
== 0)
3372 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3375 while (event
!= kbd_store_ptr
);
3381 if (!(flags
& READABLE_EVENTS_IGNORE_SQUEEZABLES
)
3382 && !NILP (do_mouse_tracking
) && some_mouse_moved ())
3386 if (current_kboard
->kbd_queue_has_data
)
3392 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
3393 if (kb
->kbd_queue_has_data
)
3399 /* Set this for debugging, to have a way to get out */
3400 int stop_character EXTERNALLY_VISIBLE
;
3403 event_to_kboard (struct input_event
*event
)
3405 /* Not applicable for these special events. */
3406 if (event
->kind
== SELECTION_REQUEST_EVENT
3407 || event
->kind
== SELECTION_CLEAR_EVENT
)
3411 Lisp_Object obj
= event
->frame_or_window
;
3412 /* There are some events that set this field to nil or string. */
3414 obj
= WINDOW_FRAME (XWINDOW (obj
));
3415 /* Also ignore dead frames here. */
3416 return ((FRAMEP (obj
) && FRAME_LIVE_P (XFRAME (obj
)))
3417 ? FRAME_KBOARD (XFRAME (obj
)) : NULL
);
3422 /* Return the number of slots occupied in kbd_buffer. */
3425 kbd_buffer_nr_stored (void)
3427 return kbd_fetch_ptr
== kbd_store_ptr
3429 : (kbd_fetch_ptr
< kbd_store_ptr
3430 ? kbd_store_ptr
- kbd_fetch_ptr
3431 : ((kbd_buffer
+ KBD_BUFFER_SIZE
) - kbd_fetch_ptr
3432 + (kbd_store_ptr
- kbd_buffer
)));
3434 #endif /* Store an event obtained at interrupt level into kbd_buffer, fifo */
3437 kbd_buffer_store_event (register struct input_event
*event
)
3439 kbd_buffer_store_event_hold (event
, 0);
3442 /* Store EVENT obtained at interrupt level into kbd_buffer, fifo.
3444 If HOLD_QUIT is 0, just stuff EVENT into the fifo.
3445 Else, if HOLD_QUIT.kind != NO_EVENT, discard EVENT.
3446 Else, if EVENT is a quit event, store the quit event
3447 in HOLD_QUIT, and return (thus ignoring further events).
3449 This is used to postpone the processing of the quit event until all
3450 subsequent input events have been parsed (and discarded). */
3453 kbd_buffer_store_event_hold (register struct input_event
*event
,
3454 struct input_event
*hold_quit
)
3456 if (event
->kind
== NO_EVENT
)
3459 if (hold_quit
&& hold_quit
->kind
!= NO_EVENT
)
3462 if (event
->kind
== ASCII_KEYSTROKE_EVENT
)
3464 register int c
= event
->code
& 0377;
3466 if (event
->modifiers
& ctrl_modifier
)
3467 c
= make_ctrl_char (c
);
3469 c
|= (event
->modifiers
3470 & (meta_modifier
| alt_modifier
3471 | hyper_modifier
| super_modifier
));
3475 KBOARD
*kb
= FRAME_KBOARD (XFRAME (event
->frame_or_window
));
3476 struct input_event
*sp
;
3478 if (single_kboard
&& kb
!= current_kboard
)
3481 (kb
, Fcons (make_lispy_switch_frame (event
->frame_or_window
),
3482 Fcons (make_number (c
), Qnil
)));
3483 kb
->kbd_queue_has_data
= 1;
3484 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3486 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3489 if (event_to_kboard (sp
) == kb
)
3491 sp
->kind
= NO_EVENT
;
3492 sp
->frame_or_window
= Qnil
;
3501 *hold_quit
= *event
;
3505 /* If this results in a quit_char being returned to Emacs as
3506 input, set Vlast_event_frame properly. If this doesn't
3507 get returned to Emacs as an event, the next event read
3508 will set Vlast_event_frame again, so this is safe to do. */
3512 focus
= FRAME_FOCUS_FRAME (XFRAME (event
->frame_or_window
));
3514 focus
= event
->frame_or_window
;
3515 internal_last_event_frame
= focus
;
3516 Vlast_event_frame
= focus
;
3519 last_event_timestamp
= event
->timestamp
;
3521 handle_interrupt (0);
3525 if (c
&& c
== stop_character
)
3531 /* Don't insert two BUFFER_SWITCH_EVENT's in a row.
3532 Just ignore the second one. */
3533 else if (event
->kind
== BUFFER_SWITCH_EVENT
3534 && kbd_fetch_ptr
!= kbd_store_ptr
3535 && ((kbd_store_ptr
== kbd_buffer
3536 ? kbd_buffer
+ KBD_BUFFER_SIZE
- 1
3537 : kbd_store_ptr
- 1)->kind
) == BUFFER_SWITCH_EVENT
)
3540 if (kbd_store_ptr
- kbd_buffer
== KBD_BUFFER_SIZE
)
3541 kbd_store_ptr
= kbd_buffer
;
3543 /* Don't let the very last slot in the buffer become full,
3544 since that would make the two pointers equal,
3545 and that is indistinguishable from an empty buffer.
3546 Discard the event if it would fill the last slot. */
3547 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
3549 *kbd_store_ptr
= *event
;
3552 if (kbd_buffer_nr_stored () > KBD_BUFFER_SIZE
/2 && ! kbd_on_hold_p ())
3554 /* Don't read keyboard input until we have processed kbd_buffer.
3555 This happens when pasting text longer than KBD_BUFFER_SIZE/2. */
3556 hold_keyboard_input ();
3557 if (!noninteractive
)
3561 #endif /* subprocesses */
3564 /* If we're inside while-no-input, and this event qualifies
3565 as input, set quit-flag to cause an interrupt. */
3566 if (!NILP (Vthrow_on_input
)
3567 && event
->kind
!= FOCUS_IN_EVENT
3568 && event
->kind
!= HELP_EVENT
3569 && event
->kind
!= DEICONIFY_EVENT
)
3571 Vquit_flag
= Vthrow_on_input
;
3572 /* If we're inside a function that wants immediate quits,
3574 if (immediate_quit
&& NILP (Vinhibit_quit
))
3583 /* Put an input event back in the head of the event queue. */
3586 kbd_buffer_unget_event (register struct input_event
*event
)
3588 if (kbd_fetch_ptr
== kbd_buffer
)
3589 kbd_fetch_ptr
= kbd_buffer
+ KBD_BUFFER_SIZE
;
3591 /* Don't let the very last slot in the buffer become full, */
3592 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
3595 *kbd_fetch_ptr
= *event
;
3600 /* Generate a HELP_EVENT input_event and store it in the keyboard
3603 HELP is the help form.
3605 FRAME and WINDOW are the frame and window where the help is
3606 generated. OBJECT is the Lisp object where the help was found (a
3607 buffer, a string, an overlay, or nil if neither from a string nor
3608 from a buffer). POS is the position within OBJECT where the help
3612 gen_help_event (Lisp_Object help
, Lisp_Object frame
, Lisp_Object window
,
3613 Lisp_Object object
, ptrdiff_t pos
)
3615 struct input_event event
;
3619 event
.kind
= HELP_EVENT
;
3620 event
.frame_or_window
= frame
;
3622 event
.x
= WINDOWP (window
) ? window
: frame
;
3625 kbd_buffer_store_event (&event
);
3629 /* Store HELP_EVENTs for HELP on FRAME in the input queue. */
3632 kbd_buffer_store_help_event (Lisp_Object frame
, Lisp_Object help
)
3634 struct input_event event
;
3636 event
.kind
= HELP_EVENT
;
3637 event
.frame_or_window
= frame
;
3642 kbd_buffer_store_event (&event
);
3646 /* Discard any mouse events in the event buffer by setting them to
3649 discard_mouse_events (void)
3651 struct input_event
*sp
;
3652 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3654 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3657 if (sp
->kind
== MOUSE_CLICK_EVENT
3658 || sp
->kind
== WHEEL_EVENT
3659 || sp
->kind
== HORIZ_WHEEL_EVENT
3661 || sp
->kind
== GPM_CLICK_EVENT
3663 || sp
->kind
== SCROLL_BAR_CLICK_EVENT
)
3665 sp
->kind
= NO_EVENT
;
3671 /* Return true if there are any real events waiting in the event
3672 buffer, not counting `NO_EVENT's.
3674 Discard NO_EVENT events at the front of the input queue, possibly
3675 leaving the input queue empty if there are no real input events. */
3678 kbd_buffer_events_waiting (void)
3680 struct input_event
*sp
;
3682 for (sp
= kbd_fetch_ptr
;
3683 sp
!= kbd_store_ptr
&& sp
->kind
== NO_EVENT
;
3686 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3691 return sp
!= kbd_store_ptr
&& sp
->kind
!= NO_EVENT
;
3695 /* Clear input event EVENT. */
3698 clear_event (struct input_event
*event
)
3700 event
->kind
= NO_EVENT
;
3704 /* Read one event from the event buffer, waiting if necessary.
3705 The value is a Lisp object representing the event.
3706 The value is nil for an event that should be ignored,
3707 or that was handled here.
3708 We always read and discard one event. */
3711 kbd_buffer_get_event (KBOARD
**kbp
,
3712 bool *used_mouse_menu
,
3713 EMACS_TIME
*end_time
)
3718 if (kbd_on_hold_p () && kbd_buffer_nr_stored () < KBD_BUFFER_SIZE
/4)
3720 /* Start reading input again because we have processed enough to
3721 be able to accept new events again. */
3722 unhold_keyboard_input ();
3725 #endif /* subprocesses */
3727 #ifndef HAVE_DBUS /* We want to read D-Bus events in batch mode. */
3729 /* In case we are running as a daemon, only do this before
3730 detaching from the terminal. */
3731 || (IS_DAEMON
&& daemon_pipe
[1] >= 0))
3735 *kbp
= current_kboard
;
3738 #endif /* ! HAVE_DBUS */
3740 /* Wait until there is input available. */
3743 /* Break loop if there's an unread command event. Needed in
3744 moused window autoselection which uses a timer to insert such
3746 if (CONSP (Vunread_command_events
))
3749 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3751 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3754 /* If the quit flag is set, then read_char will return
3755 quit_char, so that counts as "available input." */
3756 if (!NILP (Vquit_flag
))
3757 quit_throw_to_read_char (0);
3759 /* One way or another, wait until input is available; then, if
3760 interrupt handlers have not read it, read it now. */
3765 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3767 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3771 EMACS_TIME now
= current_emacs_time ();
3772 if (EMACS_TIME_LE (*end_time
, now
))
3773 return Qnil
; /* Finished waiting. */
3776 EMACS_TIME duration
= sub_emacs_time (*end_time
, now
);
3777 wait_reading_process_output (min (EMACS_SECS (duration
),
3779 EMACS_NSECS (duration
),
3780 -1, 1, Qnil
, NULL
, 0);
3784 wait_reading_process_output (0, 0, -1, 1, Qnil
, NULL
, 0);
3786 if (!interrupt_input
&& kbd_fetch_ptr
== kbd_store_ptr
)
3790 if (CONSP (Vunread_command_events
))
3793 first
= XCAR (Vunread_command_events
);
3794 Vunread_command_events
= XCDR (Vunread_command_events
);
3795 *kbp
= current_kboard
;
3799 /* At this point, we know that there is a readable event available
3800 somewhere. If the event queue is empty, then there must be a
3801 mouse movement enabled and available. */
3802 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3804 struct input_event
*event
;
3806 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
3810 last_event_timestamp
= event
->timestamp
;
3812 *kbp
= event_to_kboard (event
);
3814 *kbp
= current_kboard
; /* Better than returning null ptr? */
3818 /* These two kinds of events get special handling
3819 and don't actually appear to the command loop.
3820 We return nil for them. */
3821 if (event
->kind
== SELECTION_REQUEST_EVENT
3822 || event
->kind
== SELECTION_CLEAR_EVENT
)
3825 struct input_event copy
;
3827 /* Remove it from the buffer before processing it,
3828 since otherwise swallow_events will see it
3829 and process it again. */
3831 kbd_fetch_ptr
= event
+ 1;
3832 input_pending
= readable_events (0);
3833 x_handle_selection_event (©
);
3835 /* We're getting selection request events, but we don't have
3841 #if defined (HAVE_NS)
3842 else if (event
->kind
== NS_TEXT_EVENT
)
3844 if (event
->code
== KEY_NS_PUT_WORKING_TEXT
)
3845 obj
= Fcons (intern ("ns-put-working-text"), Qnil
);
3847 obj
= Fcons (intern ("ns-unput-working-text"), Qnil
);
3848 kbd_fetch_ptr
= event
+ 1;
3849 if (used_mouse_menu
)
3850 *used_mouse_menu
= 1;
3854 #if defined (HAVE_X11) || defined (HAVE_NTGUI) \
3855 || defined (HAVE_NS)
3856 else if (event
->kind
== DELETE_WINDOW_EVENT
)
3858 /* Make an event (delete-frame (FRAME)). */
3859 obj
= Fcons (event
->frame_or_window
, Qnil
);
3860 obj
= Fcons (Qdelete_frame
, Fcons (obj
, Qnil
));
3861 kbd_fetch_ptr
= event
+ 1;
3864 #if defined (HAVE_X11) || defined (HAVE_NTGUI) \
3865 || defined (HAVE_NS)
3866 else if (event
->kind
== ICONIFY_EVENT
)
3868 /* Make an event (iconify-frame (FRAME)). */
3869 obj
= Fcons (event
->frame_or_window
, Qnil
);
3870 obj
= Fcons (Qiconify_frame
, Fcons (obj
, Qnil
));
3871 kbd_fetch_ptr
= event
+ 1;
3873 else if (event
->kind
== DEICONIFY_EVENT
)
3875 /* Make an event (make-frame-visible (FRAME)). */
3876 obj
= Fcons (event
->frame_or_window
, Qnil
);
3877 obj
= Fcons (Qmake_frame_visible
, Fcons (obj
, Qnil
));
3878 kbd_fetch_ptr
= event
+ 1;
3881 else if (event
->kind
== BUFFER_SWITCH_EVENT
)
3883 /* The value doesn't matter here; only the type is tested. */
3884 XSETBUFFER (obj
, current_buffer
);
3885 kbd_fetch_ptr
= event
+ 1;
3887 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
3888 || defined (HAVE_NS) || defined (USE_GTK)
3889 else if (event
->kind
== MENU_BAR_ACTIVATE_EVENT
)
3891 kbd_fetch_ptr
= event
+ 1;
3892 input_pending
= readable_events (0);
3893 if (FRAME_LIVE_P (XFRAME (event
->frame_or_window
)))
3894 x_activate_menubar (XFRAME (event
->frame_or_window
));
3898 else if (event
->kind
== LANGUAGE_CHANGE_EVENT
)
3900 /* Make an event (language-change (FRAME CODEPAGE LANGUAGE-ID)). */
3901 obj
= Fcons (Qlanguage_change
,
3902 list3 (event
->frame_or_window
,
3903 make_number (event
->code
),
3904 make_number (event
->modifiers
)));
3905 kbd_fetch_ptr
= event
+ 1;
3908 else if (event
->kind
== SAVE_SESSION_EVENT
)
3910 obj
= Fcons (Qsave_session
, Fcons (event
->arg
, Qnil
));
3911 kbd_fetch_ptr
= event
+ 1;
3913 /* Just discard these, by returning nil.
3914 With MULTI_KBOARD, these events are used as placeholders
3915 when we need to randomly delete events from the queue.
3916 (They shouldn't otherwise be found in the buffer,
3917 but on some machines it appears they do show up
3918 even without MULTI_KBOARD.) */
3919 /* On Windows NT/9X, NO_EVENT is used to delete extraneous
3920 mouse events during a popup-menu call. */
3921 else if (event
->kind
== NO_EVENT
)
3922 kbd_fetch_ptr
= event
+ 1;
3923 else if (event
->kind
== HELP_EVENT
)
3925 Lisp_Object object
, position
, help
, frame
, window
;
3927 frame
= event
->frame_or_window
;
3928 object
= event
->arg
;
3929 position
= make_number (event
->code
);
3932 clear_event (event
);
3934 kbd_fetch_ptr
= event
+ 1;
3935 if (!WINDOWP (window
))
3937 obj
= Fcons (Qhelp_echo
,
3938 list5 (frame
, help
, window
, object
, position
));
3940 else if (event
->kind
== FOCUS_IN_EVENT
)
3942 /* Notification of a FocusIn event. The frame receiving the
3943 focus is in event->frame_or_window. Generate a
3944 switch-frame event if necessary. */
3945 Lisp_Object frame
, focus
;
3947 frame
= event
->frame_or_window
;
3948 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
3952 if (!EQ (frame
, internal_last_event_frame
)
3953 && !EQ (frame
, selected_frame
))
3954 obj
= make_lispy_switch_frame (frame
);
3955 internal_last_event_frame
= frame
;
3956 kbd_fetch_ptr
= event
+ 1;
3959 else if (event
->kind
== DBUS_EVENT
)
3961 obj
= make_lispy_event (event
);
3962 kbd_fetch_ptr
= event
+ 1;
3965 else if (event
->kind
== CONFIG_CHANGED_EVENT
)
3967 obj
= make_lispy_event (event
);
3968 kbd_fetch_ptr
= event
+ 1;
3972 /* If this event is on a different frame, return a switch-frame this
3973 time, and leave the event in the queue for next time. */
3977 frame
= event
->frame_or_window
;
3979 frame
= XCAR (frame
);
3980 else if (WINDOWP (frame
))
3981 frame
= WINDOW_FRAME (XWINDOW (frame
));
3983 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
3987 if (! EQ (frame
, internal_last_event_frame
)
3988 && !EQ (frame
, selected_frame
))
3989 obj
= make_lispy_switch_frame (frame
);
3990 internal_last_event_frame
= frame
;
3992 /* If we didn't decide to make a switch-frame event, go ahead
3993 and build a real event from the queue entry. */
3997 obj
= make_lispy_event (event
);
3999 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
4000 || defined (HAVE_NS) || defined (USE_GTK)
4001 /* If this was a menu selection, then set the flag to inhibit
4002 writing to last_nonmenu_event. Don't do this if the event
4003 we're returning is (menu-bar), though; that indicates the
4004 beginning of the menu sequence, and we might as well leave
4005 that as the `event with parameters' for this selection. */
4007 && !EQ (event
->frame_or_window
, event
->arg
)
4008 && (event
->kind
== MENU_BAR_EVENT
4009 || event
->kind
== TOOL_BAR_EVENT
))
4010 *used_mouse_menu
= 1;
4013 /* Certain system events are non-key events. */
4015 && event
->kind
== NS_NONKEY_EVENT
)
4016 *used_mouse_menu
= 1;
4019 /* Wipe out this event, to catch bugs. */
4020 clear_event (event
);
4021 kbd_fetch_ptr
= event
+ 1;
4025 /* Try generating a mouse motion event. */
4026 else if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
4028 FRAME_PTR f
= some_mouse_moved ();
4029 Lisp_Object bar_window
;
4030 enum scroll_bar_part part
;
4034 *kbp
= current_kboard
;
4035 /* Note that this uses F to determine which terminal to look at.
4036 If there is no valid info, it does not store anything
4037 so x remains nil. */
4040 /* XXX Can f or mouse_position_hook be NULL here? */
4041 if (f
&& FRAME_TERMINAL (f
)->mouse_position_hook
)
4042 (*FRAME_TERMINAL (f
)->mouse_position_hook
) (&f
, 0, &bar_window
,
4047 /* Decide if we should generate a switch-frame event. Don't
4048 generate switch-frame events for motion outside of all Emacs
4054 frame
= FRAME_FOCUS_FRAME (f
);
4056 XSETFRAME (frame
, f
);
4058 if (! EQ (frame
, internal_last_event_frame
)
4059 && !EQ (frame
, selected_frame
))
4060 obj
= make_lispy_switch_frame (frame
);
4061 internal_last_event_frame
= frame
;
4064 /* If we didn't decide to make a switch-frame event, go ahead and
4065 return a mouse-motion event. */
4066 if (!NILP (x
) && NILP (obj
))
4067 obj
= make_lispy_movement (f
, bar_window
, part
, x
, y
, t
);
4070 /* We were promised by the above while loop that there was
4071 something for us to read! */
4074 input_pending
= readable_events (0);
4076 Vlast_event_frame
= internal_last_event_frame
;
4081 /* Process any non-user-visible events (currently X selection events),
4082 without reading any user-visible events. */
4085 process_special_events (void)
4087 struct input_event
*event
;
4089 for (event
= kbd_fetch_ptr
; event
!= kbd_store_ptr
; ++event
)
4091 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
4094 if (event
== kbd_store_ptr
)
4098 /* If we find a stored X selection request, handle it now. */
4099 if (event
->kind
== SELECTION_REQUEST_EVENT
4100 || event
->kind
== SELECTION_CLEAR_EVENT
)
4104 /* Remove the event from the fifo buffer before processing;
4105 otherwise swallow_events called recursively could see it
4106 and process it again. To do this, we move the events
4107 between kbd_fetch_ptr and EVENT one slot to the right,
4110 struct input_event copy
= *event
;
4111 struct input_event
*beg
4112 = (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
4113 ? kbd_buffer
: kbd_fetch_ptr
;
4116 memmove (beg
+ 1, beg
, (event
- beg
) * sizeof (struct input_event
));
4117 else if (event
< beg
)
4119 if (event
> kbd_buffer
)
4120 memmove (kbd_buffer
+ 1, kbd_buffer
,
4121 (event
- kbd_buffer
) * sizeof (struct input_event
));
4122 *kbd_buffer
= *(kbd_buffer
+ KBD_BUFFER_SIZE
- 1);
4123 if (beg
< kbd_buffer
+ KBD_BUFFER_SIZE
- 1)
4124 memmove (beg
+ 1, beg
,
4125 (kbd_buffer
+ KBD_BUFFER_SIZE
- 1 - beg
)
4126 * sizeof (struct input_event
));
4129 if (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
4130 kbd_fetch_ptr
= kbd_buffer
+ 1;
4134 /* X wants last_event_timestamp for selection ownership. */
4135 last_event_timestamp
= copy
.timestamp
;
4136 input_pending
= readable_events (0);
4137 x_handle_selection_event (©
);
4139 /* We're getting selection request events, but we don't have
4147 /* Process any events that are not user-visible, run timer events that
4148 are ripe, and return, without reading any user-visible events. */
4151 swallow_events (bool do_display
)
4153 unsigned old_timers_run
;
4155 process_special_events ();
4157 old_timers_run
= timers_run
;
4158 get_input_pending (READABLE_EVENTS_DO_TIMERS_NOW
);
4160 if (timers_run
!= old_timers_run
&& do_display
)
4161 redisplay_preserve_echo_area (7);
4164 /* Record the start of when Emacs is idle,
4165 for the sake of running idle-time timers. */
4168 timer_start_idle (void)
4172 /* If we are already in the idle state, do nothing. */
4173 if (EMACS_TIME_VALID_P (timer_idleness_start_time
))
4176 timer_idleness_start_time
= current_emacs_time ();
4177 timer_last_idleness_start_time
= timer_idleness_start_time
;
4179 /* Mark all idle-time timers as once again candidates for running. */
4180 for (timers
= Vtimer_idle_list
; CONSP (timers
); timers
= XCDR (timers
))
4184 timer
= XCAR (timers
);
4186 if (!VECTORP (timer
) || ASIZE (timer
) != 9)
4188 ASET (timer
, 0, Qnil
);
4192 /* Record that Emacs is no longer idle, so stop running idle-time timers. */
4195 timer_stop_idle (void)
4197 timer_idleness_start_time
= invalid_emacs_time ();
4200 /* Resume idle timer from last idle start time. */
4203 timer_resume_idle (void)
4205 if (EMACS_TIME_VALID_P (timer_idleness_start_time
))
4208 timer_idleness_start_time
= timer_last_idleness_start_time
;
4211 /* This is only for debugging. */
4212 struct input_event last_timer_event EXTERNALLY_VISIBLE
;
4214 /* List of elisp functions to call, delayed because they were generated in
4215 a context where Elisp could not be safely run (e.g. redisplay, signal,
4216 ...). Each element has the form (FUN . ARGS). */
4217 Lisp_Object pending_funcalls
;
4219 /* Return true if TIMER is a valid timer, placing its value into *RESULT. */
4221 decode_timer (Lisp_Object timer
, EMACS_TIME
*result
)
4223 Lisp_Object
*vector
;
4225 if (! (VECTORP (timer
) && ASIZE (timer
) == 9))
4227 vector
= XVECTOR (timer
)->contents
;
4228 if (! NILP (vector
[0]))
4231 return decode_time_components (vector
[1], vector
[2], vector
[3], vector
[8],
4236 /* Check whether a timer has fired. To prevent larger problems we simply
4237 disregard elements that are not proper timers. Do not make a circular
4238 timer list for the time being.
4240 Returns the time to wait until the next timer fires. If a
4241 timer is triggering now, return zero.
4242 If no timer is active, return -1.
4244 If a timer is ripe, we run it, with quitting turned off.
4245 In that case we return 0 to indicate that a new timer_check_2 call
4249 timer_check_2 (Lisp_Object timers
, Lisp_Object idle_timers
)
4251 EMACS_TIME nexttime
;
4253 EMACS_TIME idleness_now
;
4254 Lisp_Object chosen_timer
;
4255 struct gcpro gcpro1
;
4257 nexttime
= invalid_emacs_time ();
4259 chosen_timer
= Qnil
;
4260 GCPRO1 (chosen_timer
);
4262 /* First run the code that was delayed. */
4263 while (CONSP (pending_funcalls
))
4265 Lisp_Object funcall
= XCAR (pending_funcalls
);
4266 pending_funcalls
= XCDR (pending_funcalls
);
4267 safe_call2 (Qapply
, XCAR (funcall
), XCDR (funcall
));
4270 if (CONSP (timers
) || CONSP (idle_timers
))
4272 now
= current_emacs_time ();
4273 idleness_now
= (EMACS_TIME_VALID_P (timer_idleness_start_time
)
4274 ? sub_emacs_time (now
, timer_idleness_start_time
)
4275 : make_emacs_time (0, 0));
4278 while (CONSP (timers
) || CONSP (idle_timers
))
4280 Lisp_Object timer
= Qnil
, idle_timer
= Qnil
;
4281 EMACS_TIME timer_time
, idle_timer_time
;
4282 EMACS_TIME difference
;
4283 EMACS_TIME timer_difference
= invalid_emacs_time ();
4284 EMACS_TIME idle_timer_difference
= invalid_emacs_time ();
4285 bool ripe
, timer_ripe
= 0, idle_timer_ripe
= 0;
4287 /* Set TIMER and TIMER_DIFFERENCE
4288 based on the next ordinary timer.
4289 TIMER_DIFFERENCE is the distance in time from NOW to when
4290 this timer becomes ripe (negative if it's already ripe).
4291 Skip past invalid timers and timers already handled. */
4294 timer
= XCAR (timers
);
4295 if (! decode_timer (timer
, &timer_time
))
4297 timers
= XCDR (timers
);
4301 timer_ripe
= EMACS_TIME_LE (timer_time
, now
);
4302 timer_difference
= (timer_ripe
4303 ? sub_emacs_time (now
, timer_time
)
4304 : sub_emacs_time (timer_time
, now
));
4307 /* Likewise for IDLE_TIMER and IDLE_TIMER_DIFFERENCE
4308 based on the next idle timer. */
4309 if (CONSP (idle_timers
))
4311 idle_timer
= XCAR (idle_timers
);
4312 if (! decode_timer (idle_timer
, &idle_timer_time
))
4314 idle_timers
= XCDR (idle_timers
);
4318 idle_timer_ripe
= EMACS_TIME_LE (idle_timer_time
, idleness_now
);
4319 idle_timer_difference
=
4321 ? sub_emacs_time (idleness_now
, idle_timer_time
)
4322 : sub_emacs_time (idle_timer_time
, idleness_now
));
4325 /* Decide which timer is the next timer,
4326 and set CHOSEN_TIMER, DIFFERENCE, and RIPE accordingly.
4327 Also step down the list where we found that timer. */
4329 if (EMACS_TIME_VALID_P (timer_difference
)
4330 && (! EMACS_TIME_VALID_P (idle_timer_difference
)
4331 || idle_timer_ripe
< timer_ripe
4332 || (idle_timer_ripe
== timer_ripe
4334 ? EMACS_TIME_LT (idle_timer_difference
,
4336 : EMACS_TIME_LT (timer_difference
,
4337 idle_timer_difference
)))))
4339 chosen_timer
= timer
;
4340 timers
= XCDR (timers
);
4341 difference
= timer_difference
;
4346 chosen_timer
= idle_timer
;
4347 idle_timers
= XCDR (idle_timers
);
4348 difference
= idle_timer_difference
;
4349 ripe
= idle_timer_ripe
;
4352 /* If timer is ripe, run it if it hasn't been run. */
4355 if (NILP (AREF (chosen_timer
, 0)))
4357 ptrdiff_t count
= SPECPDL_INDEX ();
4358 Lisp_Object old_deactivate_mark
= Vdeactivate_mark
;
4360 /* Mark the timer as triggered to prevent problems if the lisp
4361 code fails to reschedule it right. */
4362 ASET (chosen_timer
, 0, Qt
);
4364 specbind (Qinhibit_quit
, Qt
);
4366 call1 (Qtimer_event_handler
, chosen_timer
);
4367 Vdeactivate_mark
= old_deactivate_mark
;
4369 unbind_to (count
, Qnil
);
4371 /* Since we have handled the event,
4372 we don't need to tell the caller to wake up and do it. */
4373 /* But the caller must still wait for the next timer, so
4374 return 0 to indicate that. */
4377 nexttime
= make_emacs_time (0, 0);
4381 /* When we encounter a timer that is still waiting,
4382 return the amount of time to wait before it is ripe. */
4389 /* No timers are pending in the future. */
4390 /* Return 0 if we generated an event, and -1 if not. */
4396 /* Check whether a timer has fired. To prevent larger problems we simply
4397 disregard elements that are not proper timers. Do not make a circular
4398 timer list for the time being.
4400 Returns the time to wait until the next timer fires.
4401 If no timer is active, return an invalid value.
4403 As long as any timer is ripe, we run it. */
4408 EMACS_TIME nexttime
;
4409 Lisp_Object timers
, idle_timers
;
4410 struct gcpro gcpro1
, gcpro2
;
4412 Lisp_Object tem
= Vinhibit_quit
;
4415 /* We use copies of the timers' lists to allow a timer to add itself
4416 again, without locking up Emacs if the newly added timer is
4417 already ripe when added. */
4419 /* Always consider the ordinary timers. */
4420 timers
= Fcopy_sequence (Vtimer_list
);
4421 /* Consider the idle timers only if Emacs is idle. */
4422 if (EMACS_TIME_VALID_P (timer_idleness_start_time
))
4423 idle_timers
= Fcopy_sequence (Vtimer_idle_list
);
4427 Vinhibit_quit
= tem
;
4429 GCPRO2 (timers
, idle_timers
);
4433 nexttime
= timer_check_2 (timers
, idle_timers
);
4435 while (EMACS_SECS (nexttime
) == 0 && EMACS_NSECS (nexttime
) == 0);
4441 DEFUN ("current-idle-time", Fcurrent_idle_time
, Scurrent_idle_time
, 0, 0, 0,
4442 doc
: /* Return the current length of Emacs idleness, or nil.
4443 The value when Emacs is idle is a list of four integers (HIGH LOW USEC PSEC)
4444 in the same style as (current-time).
4446 The value when Emacs is not idle is nil.
4448 PSEC is a multiple of the system clock resolution. */)
4451 if (EMACS_TIME_VALID_P (timer_idleness_start_time
))
4452 return make_lisp_time (sub_emacs_time (current_emacs_time (),
4453 timer_idleness_start_time
));
4458 /* Caches for modify_event_symbol. */
4459 static Lisp_Object accent_key_syms
;
4460 static Lisp_Object func_key_syms
;
4461 static Lisp_Object mouse_syms
;
4462 static Lisp_Object wheel_syms
;
4463 static Lisp_Object drag_n_drop_syms
;
4465 /* This is a list of keysym codes for special "accent" characters.
4466 It parallels lispy_accent_keys. */
4468 static const int lispy_accent_codes
[] =
4470 #ifdef XK_dead_circumflex
4475 #ifdef XK_dead_grave
4480 #ifdef XK_dead_tilde
4485 #ifdef XK_dead_diaeresis
4490 #ifdef XK_dead_macron
4495 #ifdef XK_dead_degree
4500 #ifdef XK_dead_acute
4505 #ifdef XK_dead_cedilla
4510 #ifdef XK_dead_breve
4515 #ifdef XK_dead_ogonek
4520 #ifdef XK_dead_caron
4525 #ifdef XK_dead_doubleacute
4526 XK_dead_doubleacute
,
4530 #ifdef XK_dead_abovedot
4535 #ifdef XK_dead_abovering
4545 #ifdef XK_dead_belowdot
4550 #ifdef XK_dead_voiced_sound
4551 XK_dead_voiced_sound
,
4555 #ifdef XK_dead_semivoiced_sound
4556 XK_dead_semivoiced_sound
,
4572 /* This is a list of Lisp names for special "accent" characters.
4573 It parallels lispy_accent_codes. */
4575 static const char *const lispy_accent_keys
[] =
4593 "dead-voiced-sound",
4594 "dead-semivoiced-sound",
4600 #define FUNCTION_KEY_OFFSET 0x0
4602 const char *const lispy_function_keys
[] =
4606 0, /* VK_LBUTTON 0x01 */
4607 0, /* VK_RBUTTON 0x02 */
4608 "cancel", /* VK_CANCEL 0x03 */
4609 0, /* VK_MBUTTON 0x04 */
4611 0, 0, 0, /* 0x05 .. 0x07 */
4613 "backspace", /* VK_BACK 0x08 */
4614 "tab", /* VK_TAB 0x09 */
4616 0, 0, /* 0x0A .. 0x0B */
4618 "clear", /* VK_CLEAR 0x0C */
4619 "return", /* VK_RETURN 0x0D */
4621 0, 0, /* 0x0E .. 0x0F */
4623 0, /* VK_SHIFT 0x10 */
4624 0, /* VK_CONTROL 0x11 */
4625 0, /* VK_MENU 0x12 */
4626 "pause", /* VK_PAUSE 0x13 */
4627 "capslock", /* VK_CAPITAL 0x14 */
4628 "kana", /* VK_KANA/VK_HANGUL 0x15 */
4630 "junja", /* VK_JUNJA 0x17 */
4631 "final", /* VK_FINAL 0x18 */
4632 "kanji", /* VK_KANJI/VK_HANJA 0x19 */
4634 "escape", /* VK_ESCAPE 0x1B */
4635 "convert", /* VK_CONVERT 0x1C */
4636 "non-convert", /* VK_NONCONVERT 0x1D */
4637 "accept", /* VK_ACCEPT 0x1E */
4638 "mode-change", /* VK_MODECHANGE 0x1F */
4639 0, /* VK_SPACE 0x20 */
4640 "prior", /* VK_PRIOR 0x21 */
4641 "next", /* VK_NEXT 0x22 */
4642 "end", /* VK_END 0x23 */
4643 "home", /* VK_HOME 0x24 */
4644 "left", /* VK_LEFT 0x25 */
4645 "up", /* VK_UP 0x26 */
4646 "right", /* VK_RIGHT 0x27 */
4647 "down", /* VK_DOWN 0x28 */
4648 "select", /* VK_SELECT 0x29 */
4649 "print", /* VK_PRINT 0x2A */
4650 "execute", /* VK_EXECUTE 0x2B */
4651 "snapshot", /* VK_SNAPSHOT 0x2C */
4652 "insert", /* VK_INSERT 0x2D */
4653 "delete", /* VK_DELETE 0x2E */
4654 "help", /* VK_HELP 0x2F */
4656 /* VK_0 thru VK_9 are the same as ASCII '0' thru '9' (0x30 - 0x39) */
4658 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4660 0, 0, 0, 0, 0, 0, 0, /* 0x3A .. 0x40 */
4662 /* VK_A thru VK_Z are the same as ASCII 'A' thru 'Z' (0x41 - 0x5A) */
4664 0, 0, 0, 0, 0, 0, 0, 0, 0,
4665 0, 0, 0, 0, 0, 0, 0, 0, 0,
4666 0, 0, 0, 0, 0, 0, 0, 0,
4668 "lwindow", /* VK_LWIN 0x5B */
4669 "rwindow", /* VK_RWIN 0x5C */
4670 "apps", /* VK_APPS 0x5D */
4673 "kp-0", /* VK_NUMPAD0 0x60 */
4674 "kp-1", /* VK_NUMPAD1 0x61 */
4675 "kp-2", /* VK_NUMPAD2 0x62 */
4676 "kp-3", /* VK_NUMPAD3 0x63 */
4677 "kp-4", /* VK_NUMPAD4 0x64 */
4678 "kp-5", /* VK_NUMPAD5 0x65 */
4679 "kp-6", /* VK_NUMPAD6 0x66 */
4680 "kp-7", /* VK_NUMPAD7 0x67 */
4681 "kp-8", /* VK_NUMPAD8 0x68 */
4682 "kp-9", /* VK_NUMPAD9 0x69 */
4683 "kp-multiply", /* VK_MULTIPLY 0x6A */
4684 "kp-add", /* VK_ADD 0x6B */
4685 "kp-separator", /* VK_SEPARATOR 0x6C */
4686 "kp-subtract", /* VK_SUBTRACT 0x6D */
4687 "kp-decimal", /* VK_DECIMAL 0x6E */
4688 "kp-divide", /* VK_DIVIDE 0x6F */
4689 "f1", /* VK_F1 0x70 */
4690 "f2", /* VK_F2 0x71 */
4691 "f3", /* VK_F3 0x72 */
4692 "f4", /* VK_F4 0x73 */
4693 "f5", /* VK_F5 0x74 */
4694 "f6", /* VK_F6 0x75 */
4695 "f7", /* VK_F7 0x76 */
4696 "f8", /* VK_F8 0x77 */
4697 "f9", /* VK_F9 0x78 */
4698 "f10", /* VK_F10 0x79 */
4699 "f11", /* VK_F11 0x7A */
4700 "f12", /* VK_F12 0x7B */
4701 "f13", /* VK_F13 0x7C */
4702 "f14", /* VK_F14 0x7D */
4703 "f15", /* VK_F15 0x7E */
4704 "f16", /* VK_F16 0x7F */
4705 "f17", /* VK_F17 0x80 */
4706 "f18", /* VK_F18 0x81 */
4707 "f19", /* VK_F19 0x82 */
4708 "f20", /* VK_F20 0x83 */
4709 "f21", /* VK_F21 0x84 */
4710 "f22", /* VK_F22 0x85 */
4711 "f23", /* VK_F23 0x86 */
4712 "f24", /* VK_F24 0x87 */
4714 0, 0, 0, 0, /* 0x88 .. 0x8B */
4715 0, 0, 0, 0, /* 0x8C .. 0x8F */
4717 "kp-numlock", /* VK_NUMLOCK 0x90 */
4718 "scroll", /* VK_SCROLL 0x91 */
4719 /* Not sure where the following block comes from.
4720 Windows headers have NEC and Fujitsu specific keys in
4721 this block, but nothing generic. */
4722 "kp-space", /* VK_NUMPAD_CLEAR 0x92 */
4723 "kp-enter", /* VK_NUMPAD_ENTER 0x93 */
4724 "kp-prior", /* VK_NUMPAD_PRIOR 0x94 */
4725 "kp-next", /* VK_NUMPAD_NEXT 0x95 */
4726 "kp-end", /* VK_NUMPAD_END 0x96 */
4727 "kp-home", /* VK_NUMPAD_HOME 0x97 */
4728 "kp-left", /* VK_NUMPAD_LEFT 0x98 */
4729 "kp-up", /* VK_NUMPAD_UP 0x99 */
4730 "kp-right", /* VK_NUMPAD_RIGHT 0x9A */
4731 "kp-down", /* VK_NUMPAD_DOWN 0x9B */
4732 "kp-insert", /* VK_NUMPAD_INSERT 0x9C */
4733 "kp-delete", /* VK_NUMPAD_DELETE 0x9D */
4735 0, 0, /* 0x9E .. 0x9F */
4738 * VK_L* & VK_R* - left and right Alt, Ctrl and Shift virtual keys.
4739 * Used only as parameters to GetAsyncKeyState and GetKeyState.
4740 * No other API or message will distinguish left and right keys this way.
4745 /* Multimedia keys. These are handled as WM_APPCOMMAND, which allows us
4746 to enable them selectively, and gives access to a few more functions.
4747 See lispy_multimedia_keys below. */
4748 0, 0, 0, 0, 0, 0, 0, /* 0xA6 .. 0xAC Browser */
4749 0, 0, 0, /* 0xAD .. 0xAF Volume */
4750 0, 0, 0, 0, /* 0xB0 .. 0xB3 Media */
4751 0, 0, 0, 0, /* 0xB4 .. 0xB7 Apps */
4753 /* 0xB8 .. 0xC0 "OEM" keys - all seem to be punctuation. */
4754 0, 0, 0, 0, 0, 0, 0, 0, 0,
4756 /* 0xC1 - 0xDA unallocated, 0xDB-0xDF more OEM keys */
4757 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4758 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4761 "ax", /* VK_OEM_AX 0xE1 */
4762 0, /* VK_OEM_102 0xE2 */
4763 "ico-help", /* VK_ICO_HELP 0xE3 */
4764 "ico-00", /* VK_ICO_00 0xE4 */
4765 0, /* VK_PROCESSKEY 0xE5 - used by IME */
4766 "ico-clear", /* VK_ICO_CLEAR 0xE6 */
4767 0, /* VK_PACKET 0xE7 - used to pass Unicode chars */
4769 "reset", /* VK_OEM_RESET 0xE9 */
4770 "jump", /* VK_OEM_JUMP 0xEA */
4771 "oem-pa1", /* VK_OEM_PA1 0xEB */
4772 "oem-pa2", /* VK_OEM_PA2 0xEC */
4773 "oem-pa3", /* VK_OEM_PA3 0xED */
4774 "wsctrl", /* VK_OEM_WSCTRL 0xEE */
4775 "cusel", /* VK_OEM_CUSEL 0xEF */
4776 "oem-attn", /* VK_OEM_ATTN 0xF0 */
4777 "finish", /* VK_OEM_FINISH 0xF1 */
4778 "copy", /* VK_OEM_COPY 0xF2 */
4779 "auto", /* VK_OEM_AUTO 0xF3 */
4780 "enlw", /* VK_OEM_ENLW 0xF4 */
4781 "backtab", /* VK_OEM_BACKTAB 0xF5 */
4782 "attn", /* VK_ATTN 0xF6 */
4783 "crsel", /* VK_CRSEL 0xF7 */
4784 "exsel", /* VK_EXSEL 0xF8 */
4785 "ereof", /* VK_EREOF 0xF9 */
4786 "play", /* VK_PLAY 0xFA */
4787 "zoom", /* VK_ZOOM 0xFB */
4788 "noname", /* VK_NONAME 0xFC */
4789 "pa1", /* VK_PA1 0xFD */
4790 "oem_clear", /* VK_OEM_CLEAR 0xFE */
4794 /* Some of these duplicate the "Media keys" on newer keyboards,
4795 but they are delivered to the application in a different way. */
4796 static const char *const lispy_multimedia_keys
[] =
4804 "browser-favorites",
4841 "toggle-dictate-command",
4847 "media-fast-forward",
4850 "media-channel-down"
4853 #else /* not HAVE_NTGUI */
4855 /* This should be dealt with in XTread_socket now, and that doesn't
4856 depend on the client system having the Kana syms defined. See also
4857 the XK_kana_A case below. */
4860 static const char *const lispy_kana_keys
[] =
4862 /* X Keysym value */
4863 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x400 .. 0x40f */
4864 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x410 .. 0x41f */
4865 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x420 .. 0x42f */
4866 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x430 .. 0x43f */
4867 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x440 .. 0x44f */
4868 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x450 .. 0x45f */
4869 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x460 .. 0x46f */
4870 0,0,0,0,0,0,0,0,0,0,0,0,0,0,"overline",0,
4871 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x480 .. 0x48f */
4872 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x490 .. 0x49f */
4873 0, "kana-fullstop", "kana-openingbracket", "kana-closingbracket",
4874 "kana-comma", "kana-conjunctive", "kana-WO", "kana-a",
4875 "kana-i", "kana-u", "kana-e", "kana-o",
4876 "kana-ya", "kana-yu", "kana-yo", "kana-tsu",
4877 "prolongedsound", "kana-A", "kana-I", "kana-U",
4878 "kana-E", "kana-O", "kana-KA", "kana-KI",
4879 "kana-KU", "kana-KE", "kana-KO", "kana-SA",
4880 "kana-SHI", "kana-SU", "kana-SE", "kana-SO",
4881 "kana-TA", "kana-CHI", "kana-TSU", "kana-TE",
4882 "kana-TO", "kana-NA", "kana-NI", "kana-NU",
4883 "kana-NE", "kana-NO", "kana-HA", "kana-HI",
4884 "kana-FU", "kana-HE", "kana-HO", "kana-MA",
4885 "kana-MI", "kana-MU", "kana-ME", "kana-MO",
4886 "kana-YA", "kana-YU", "kana-YO", "kana-RA",
4887 "kana-RI", "kana-RU", "kana-RE", "kana-RO",
4888 "kana-WA", "kana-N", "voicedsound", "semivoicedsound",
4889 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4e0 .. 0x4ef */
4890 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4f0 .. 0x4ff */
4892 #endif /* XK_kana_A */
4895 #define FUNCTION_KEY_OFFSET 0xff00
4897 /* You'll notice that this table is arranged to be conveniently
4898 indexed by X Windows keysym values. */
4899 static const char *const lispy_function_keys
[] =
4901 /* X Keysym value */
4903 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff00...0f */
4904 "backspace", "tab", "linefeed", "clear",
4906 0, 0, 0, "pause", /* 0xff10...1f */
4907 0, 0, 0, 0, 0, 0, 0, "escape",
4909 0, "kanji", "muhenkan", "henkan", /* 0xff20...2f */
4910 "romaji", "hiragana", "katakana", "hiragana-katakana",
4911 "zenkaku", "hankaku", "zenkaku-hankaku", "touroku",
4912 "massyo", "kana-lock", "kana-shift", "eisu-shift",
4913 "eisu-toggle", /* 0xff30...3f */
4914 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4915 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff40...4f */
4917 "home", "left", "up", "right", /* 0xff50 */ /* IsCursorKey */
4918 "down", "prior", "next", "end",
4919 "begin", 0, 0, 0, 0, 0, 0, 0,
4920 "select", /* 0xff60 */ /* IsMiscFunctionKey */
4931 "break", /* 0xff6b */
4934 0, 0, 0, 0, "backtab", 0, 0, 0, /* 0xff70... */
4935 0, 0, 0, 0, 0, 0, 0, "kp-numlock", /* 0xff78... */
4936 "kp-space", /* 0xff80 */ /* IsKeypadKey */
4937 0, 0, 0, 0, 0, 0, 0, 0,
4938 "kp-tab", /* 0xff89 */
4940 "kp-enter", /* 0xff8d */
4942 "kp-f1", /* 0xff91 */
4946 "kp-home", /* 0xff95 */
4951 "kp-prior", /* kp-page-up */
4952 "kp-next", /* kp-page-down */
4958 0, 0, 0, 0, 0, 0, 0, 0, 0,
4959 "kp-multiply", /* 0xffaa */
4964 "kp-divide", /* 0xffaf */
4965 "kp-0", /* 0xffb0 */
4966 "kp-1", "kp-2", "kp-3", "kp-4", "kp-5", "kp-6", "kp-7", "kp-8", "kp-9",
4969 "kp-equal", /* 0xffbd */
4970 "f1", /* 0xffbe */ /* IsFunctionKey */
4972 "f3", "f4", "f5", "f6", "f7", "f8", "f9", "f10", /* 0xffc0 */
4973 "f11", "f12", "f13", "f14", "f15", "f16", "f17", "f18",
4974 "f19", "f20", "f21", "f22", "f23", "f24", "f25", "f26", /* 0xffd0 */
4975 "f27", "f28", "f29", "f30", "f31", "f32", "f33", "f34",
4976 "f35", 0, 0, 0, 0, 0, 0, 0, /* 0xffe0 */
4977 0, 0, 0, 0, 0, 0, 0, 0,
4978 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfff0 */
4979 0, 0, 0, 0, 0, 0, 0, "delete"
4982 /* ISO 9995 Function and Modifier Keys; the first byte is 0xFE. */
4983 #define ISO_FUNCTION_KEY_OFFSET 0xfe00
4985 static const char *const iso_lispy_function_keys
[] =
4987 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe00 */
4988 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe08 */
4989 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe10 */
4990 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe18 */
4991 "iso-lefttab", /* 0xfe20 */
4992 "iso-move-line-up", "iso-move-line-down",
4993 "iso-partial-line-up", "iso-partial-line-down",
4994 "iso-partial-space-left", "iso-partial-space-right",
4995 "iso-set-margin-left", "iso-set-margin-right", /* 0xffe27, 28 */
4996 "iso-release-margin-left", "iso-release-margin-right",
4997 "iso-release-both-margins",
4998 "iso-fast-cursor-left", "iso-fast-cursor-right",
4999 "iso-fast-cursor-up", "iso-fast-cursor-down",
5000 "iso-continuous-underline", "iso-discontinuous-underline", /* 0xfe30, 31 */
5001 "iso-emphasize", "iso-center-object", "iso-enter", /* ... 0xfe34 */
5004 #endif /* not HAVE_NTGUI */
5006 static Lisp_Object Vlispy_mouse_stem
;
5008 static const char *const lispy_wheel_names
[] =
5010 "wheel-up", "wheel-down", "wheel-left", "wheel-right"
5013 /* drag-n-drop events are generated when a set of selected files are
5014 dragged from another application and dropped onto an Emacs window. */
5015 static const char *const lispy_drag_n_drop_names
[] =
5020 /* Scroll bar parts. */
5021 static Lisp_Object Qabove_handle
, Qhandle
, Qbelow_handle
;
5022 Lisp_Object Qup
, Qdown
, Qbottom
;
5023 static Lisp_Object Qend_scroll
;
5025 static Lisp_Object Qratio
;
5027 /* An array of scroll bar parts, indexed by an enum scroll_bar_part value. */
5028 static Lisp_Object
*const scroll_bar_parts
[] = {
5029 &Qabove_handle
, &Qhandle
, &Qbelow_handle
,
5030 &Qup
, &Qdown
, &Qtop
, &Qbottom
, &Qend_scroll
, &Qratio
5033 /* A vector, indexed by button number, giving the down-going location
5034 of currently depressed buttons, both scroll bar and non-scroll bar.
5036 The elements have the form
5037 (BUTTON-NUMBER MODIFIER-MASK . REST)
5038 where REST is the cdr of a position as it would be reported in the event.
5040 The make_lispy_event function stores positions here to tell the
5041 difference between click and drag events, and to store the starting
5042 location to be included in drag events. */
5044 static Lisp_Object button_down_location
;
5046 /* Information about the most recent up-going button event: Which
5047 button, what location, and what time. */
5049 static int last_mouse_button
;
5050 static int last_mouse_x
;
5051 static int last_mouse_y
;
5052 static Time button_down_time
;
5054 /* The number of clicks in this multiple-click. */
5056 static int double_click_count
;
5058 /* X and Y are frame-relative coordinates for a click or wheel event.
5059 Return a Lisp-style event list. */
5062 make_lispy_position (struct frame
*f
, Lisp_Object x
, Lisp_Object y
,
5065 enum window_part part
;
5066 Lisp_Object posn
= Qnil
;
5067 Lisp_Object extra_info
= Qnil
;
5068 /* Coordinate pixel positions to return. */
5069 int xret
= 0, yret
= 0;
5070 /* The window under frame pixel coordinates (x,y) */
5071 Lisp_Object window
= f
5072 ? window_from_coordinates (f
, XINT (x
), XINT (y
), &part
, 0)
5075 if (WINDOWP (window
))
5077 /* It's a click in window WINDOW at frame coordinates (X,Y) */
5078 struct window
*w
= XWINDOW (window
);
5079 Lisp_Object string_info
= Qnil
;
5080 ptrdiff_t textpos
= -1;
5081 int col
= -1, row
= -1;
5082 int dx
= -1, dy
= -1;
5083 int width
= -1, height
= -1;
5084 Lisp_Object object
= Qnil
;
5086 /* Pixel coordinates relative to the window corner. */
5087 int wx
= XINT (x
) - WINDOW_LEFT_EDGE_X (w
);
5088 int wy
= XINT (y
) - WINDOW_TOP_EDGE_Y (w
);
5090 /* For text area clicks, return X, Y relative to the corner of
5091 this text area. Note that dX, dY etc are set below, by
5092 buffer_posn_from_coords. */
5093 if (part
== ON_TEXT
)
5095 xret
= XINT (x
) - window_box_left (w
, TEXT_AREA
);
5096 yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5098 /* For mode line and header line clicks, return X, Y relative to
5099 the left window edge. Use mode_line_string to look for a
5100 string on the click position. */
5101 else if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
)
5106 posn
= (part
== ON_MODE_LINE
) ? Qmode_line
: Qheader_line
;
5107 /* Note that mode_line_string takes COL, ROW as pixels and
5108 converts them to characters. */
5111 string
= mode_line_string (w
, part
, &col
, &row
, &charpos
,
5112 &object
, &dx
, &dy
, &width
, &height
);
5113 if (STRINGP (string
))
5114 string_info
= Fcons (string
, make_number (charpos
));
5115 textpos
= (w
== XWINDOW (selected_window
)
5116 && current_buffer
== XBUFFER (w
->buffer
))
5117 ? PT
: XMARKER (w
->pointm
)->charpos
;
5122 /* For fringes and margins, Y is relative to the area's (and the
5123 window's) top edge, while X is meaningless. */
5124 else if (part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
5129 posn
= (part
== ON_LEFT_MARGIN
) ? Qleft_margin
: Qright_margin
;
5132 string
= marginal_area_string (w
, part
, &col
, &row
, &charpos
,
5133 &object
, &dx
, &dy
, &width
, &height
);
5134 if (STRINGP (string
))
5135 string_info
= Fcons (string
, make_number (charpos
));
5136 yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5138 else if (part
== ON_LEFT_FRINGE
)
5140 posn
= Qleft_fringe
;
5143 - (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5144 ? 0 : window_box_width (w
, LEFT_MARGIN_AREA
));
5145 dy
= yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5147 else if (part
== ON_RIGHT_FRINGE
)
5149 posn
= Qright_fringe
;
5152 - window_box_width (w
, LEFT_MARGIN_AREA
)
5153 - window_box_width (w
, TEXT_AREA
)
5154 - (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5155 ? window_box_width (w
, RIGHT_MARGIN_AREA
)
5157 dy
= yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5159 else if (part
== ON_VERTICAL_BORDER
)
5161 posn
= Qvertical_line
;
5166 /* Nothing special for part == ON_SCROLL_BAR. */
5168 /* For clicks in the text area, fringes, or margins, call
5169 buffer_posn_from_coords to extract TEXTPOS, the buffer
5170 position nearest to the click. */
5173 Lisp_Object string2
, object2
= Qnil
;
5174 struct display_pos p
;
5176 int width2
, height2
;
5177 /* The pixel X coordinate passed to buffer_posn_from_coords
5178 is the X coordinate relative to the text area for
5179 text-area and right-margin clicks, zero otherwise. */
5181 = (part
== ON_TEXT
) ? xret
5182 : (part
== ON_RIGHT_FRINGE
|| part
== ON_RIGHT_MARGIN
)
5183 ? (XINT (x
) - window_box_left (w
, TEXT_AREA
))
5187 string2
= buffer_posn_from_coords (w
, &x2
, &y2
, &p
,
5188 &object2
, &dx2
, &dy2
,
5190 textpos
= CHARPOS (p
.pos
);
5191 if (col
< 0) col
= x2
;
5192 if (row
< 0) row
= y2
;
5193 if (dx
< 0) dx
= dx2
;
5194 if (dy
< 0) dy
= dy2
;
5195 if (width
< 0) width
= width2
;
5196 if (height
< 0) height
= height2
;
5200 posn
= make_number (textpos
);
5201 if (STRINGP (string2
))
5202 string_info
= Fcons (string2
,
5203 make_number (CHARPOS (p
.string_pos
)));
5209 #ifdef HAVE_WINDOW_SYSTEM
5210 if (IMAGEP (object
))
5212 Lisp_Object image_map
, hotspot
;
5213 if ((image_map
= Fplist_get (XCDR (object
), QCmap
),
5215 && (hotspot
= find_hot_spot (image_map
, dx
, dy
),
5217 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
5218 posn
= XCAR (hotspot
);
5225 Fcons (make_number (dx
), make_number (dy
)),
5226 Fcons (make_number (width
), make_number (height
)));
5229 extra_info
= Fcons (string_info
,
5230 Fcons (make_number (textpos
),
5231 Fcons (Fcons (make_number (col
),
5236 XSETFRAME (window
, f
);
5240 return Fcons (window
,
5242 Fcons (Fcons (make_number (xret
),
5243 make_number (yret
)),
5244 Fcons (make_number (t
),
5248 /* Given a struct input_event, build the lisp event which represents
5249 it. If EVENT is 0, build a mouse movement event from the mouse
5250 movement buffer, which should have a movement event in it.
5252 Note that events must be passed to this function in the order they
5253 are received; this function stores the location of button presses
5254 in order to build drag events when the button is released. */
5257 make_lispy_event (struct input_event
*event
)
5261 switch (event
->kind
)
5263 /* A simple keystroke. */
5264 case ASCII_KEYSTROKE_EVENT
:
5265 case MULTIBYTE_CHAR_KEYSTROKE_EVENT
:
5267 Lisp_Object lispy_c
;
5268 EMACS_INT c
= event
->code
;
5269 if (event
->kind
== ASCII_KEYSTROKE_EVENT
)
5272 eassert (c
== event
->code
);
5273 /* Turn ASCII characters into control characters
5275 if (event
->modifiers
& ctrl_modifier
)
5277 c
= make_ctrl_char (c
);
5278 event
->modifiers
&= ~ctrl_modifier
;
5282 /* Add in the other modifier bits. The shift key was taken care
5283 of by the X code. */
5284 c
|= (event
->modifiers
5285 & (meta_modifier
| alt_modifier
5286 | hyper_modifier
| super_modifier
| ctrl_modifier
));
5287 /* Distinguish Shift-SPC from SPC. */
5288 if ((event
->code
) == 040
5289 && event
->modifiers
& shift_modifier
)
5290 c
|= shift_modifier
;
5291 button_down_time
= 0;
5292 XSETFASTINT (lispy_c
, c
);
5297 /* NS_NONKEY_EVENTs are just like NON_ASCII_KEYSTROKE_EVENTs,
5298 except that they are non-key events (last-nonmenu-event is nil). */
5299 case NS_NONKEY_EVENT
:
5302 /* A function key. The symbol may need to have modifier prefixes
5304 case NON_ASCII_KEYSTROKE_EVENT
:
5305 button_down_time
= 0;
5307 for (i
= 0; i
< sizeof (lispy_accent_codes
) / sizeof (int); i
++)
5308 if (event
->code
== lispy_accent_codes
[i
])
5309 return modify_event_symbol (i
,
5311 Qfunction_key
, Qnil
,
5312 lispy_accent_keys
, &accent_key_syms
,
5313 (sizeof (lispy_accent_keys
)
5314 / sizeof (lispy_accent_keys
[0])));
5318 if (event
->code
>= 0x400 && event
->code
< 0x500)
5319 return modify_event_symbol (event
->code
- 0x400,
5320 event
->modifiers
& ~shift_modifier
,
5321 Qfunction_key
, Qnil
,
5322 lispy_kana_keys
, &func_key_syms
,
5323 (sizeof (lispy_kana_keys
)
5324 / sizeof (lispy_kana_keys
[0])));
5325 #endif /* XK_kana_A */
5328 #ifdef ISO_FUNCTION_KEY_OFFSET
5329 if (event
->code
< FUNCTION_KEY_OFFSET
5330 && event
->code
>= ISO_FUNCTION_KEY_OFFSET
)
5331 return modify_event_symbol (event
->code
- ISO_FUNCTION_KEY_OFFSET
,
5333 Qfunction_key
, Qnil
,
5334 iso_lispy_function_keys
, &func_key_syms
,
5335 (sizeof (iso_lispy_function_keys
)
5336 / sizeof (iso_lispy_function_keys
[0])));
5339 /* Handle system-specific or unknown keysyms. */
5340 if (event
->code
& (1 << 28)
5341 || event
->code
- FUNCTION_KEY_OFFSET
< 0
5342 || (event
->code
- FUNCTION_KEY_OFFSET
5343 >= sizeof lispy_function_keys
/ sizeof *lispy_function_keys
)
5344 || !lispy_function_keys
[event
->code
- FUNCTION_KEY_OFFSET
])
5346 /* We need to use an alist rather than a vector as the cache
5347 since we can't make a vector long enough. */
5348 if (NILP (KVAR (current_kboard
, system_key_syms
)))
5349 kset_system_key_syms (current_kboard
, Fcons (Qnil
, Qnil
));
5350 return modify_event_symbol (event
->code
,
5353 KVAR (current_kboard
, Vsystem_key_alist
),
5354 0, &KVAR (current_kboard
, system_key_syms
),
5358 return modify_event_symbol (event
->code
- FUNCTION_KEY_OFFSET
,
5360 Qfunction_key
, Qnil
,
5361 lispy_function_keys
, &func_key_syms
,
5362 (sizeof (lispy_function_keys
)
5363 / sizeof (lispy_function_keys
[0])));
5366 case MULTIMEDIA_KEY_EVENT
:
5367 if (event
->code
< (sizeof (lispy_multimedia_keys
)
5368 / sizeof (lispy_multimedia_keys
[0]))
5369 && event
->code
> 0 && lispy_multimedia_keys
[event
->code
])
5371 return modify_event_symbol (event
->code
, event
->modifiers
,
5372 Qfunction_key
, Qnil
,
5373 lispy_multimedia_keys
, &func_key_syms
,
5374 (sizeof (lispy_multimedia_keys
)
5375 / sizeof (lispy_multimedia_keys
[0])));
5380 /* A mouse click. Figure out where it is, decide whether it's
5381 a press, click or drag, and build the appropriate structure. */
5382 case MOUSE_CLICK_EVENT
:
5383 #ifndef USE_TOOLKIT_SCROLL_BARS
5384 case SCROLL_BAR_CLICK_EVENT
:
5387 int button
= event
->code
;
5389 Lisp_Object position
;
5390 Lisp_Object
*start_pos_ptr
;
5391 Lisp_Object start_pos
;
5395 /* Build the position as appropriate for this mouse click. */
5396 if (event
->kind
== MOUSE_CLICK_EVENT
)
5398 struct frame
*f
= XFRAME (event
->frame_or_window
);
5399 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK) && ! defined (HAVE_NS)
5403 /* Ignore mouse events that were made on frame that
5404 have been deleted. */
5405 if (! FRAME_LIVE_P (f
))
5408 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK) && ! defined (HAVE_NS)
5409 /* EVENT->x and EVENT->y are frame-relative pixel
5410 coordinates at this place. Under old redisplay, COLUMN
5411 and ROW are set to frame relative glyph coordinates
5412 which are then used to determine whether this click is
5413 in a menu (non-toolkit version). */
5414 pixel_to_glyph_coords (f
, XINT (event
->x
), XINT (event
->y
),
5415 &column
, &row
, NULL
, 1);
5417 /* In the non-toolkit version, clicks on the menu bar
5418 are ordinary button events in the event buffer.
5419 Distinguish them, and invoke the menu.
5421 (In the toolkit version, the toolkit handles the menu bar
5422 and Emacs doesn't know about it until after the user
5423 makes a selection.) */
5424 if (row
>= 0 && row
< FRAME_MENU_BAR_LINES (f
)
5425 && (event
->modifiers
& down_modifier
))
5427 Lisp_Object items
, item
;
5429 /* Find the menu bar item under `column'. */
5431 items
= FRAME_MENU_BAR_ITEMS (f
);
5432 for (i
= 0; i
< ASIZE (items
); i
+= 4)
5434 Lisp_Object pos
, string
;
5435 string
= AREF (items
, i
+ 1);
5436 pos
= AREF (items
, i
+ 3);
5439 if (column
>= XINT (pos
)
5440 && column
< XINT (pos
) + SCHARS (string
))
5442 item
= AREF (items
, i
);
5447 /* ELisp manual 2.4b says (x y) are window relative but
5448 code says they are frame-relative. */
5450 = Fcons (event
->frame_or_window
,
5452 Fcons (Fcons (event
->x
, event
->y
),
5453 Fcons (make_number (event
->timestamp
),
5456 return Fcons (item
, Fcons (position
, Qnil
));
5458 #endif /* not USE_X_TOOLKIT && not USE_GTK && not HAVE_NS */
5460 position
= make_lispy_position (f
, event
->x
, event
->y
,
5463 #ifndef USE_TOOLKIT_SCROLL_BARS
5466 /* It's a scrollbar click. */
5468 Lisp_Object portion_whole
;
5471 window
= event
->frame_or_window
;
5472 portion_whole
= Fcons (event
->x
, event
->y
);
5473 part
= *scroll_bar_parts
[(int) event
->part
];
5477 Fcons (Qvertical_scroll_bar
,
5478 Fcons (portion_whole
,
5479 Fcons (make_number (event
->timestamp
),
5480 Fcons (part
, Qnil
)))));
5482 #endif /* not USE_TOOLKIT_SCROLL_BARS */
5484 if (button
>= ASIZE (button_down_location
))
5486 ptrdiff_t incr
= button
- ASIZE (button_down_location
) + 1;
5487 button_down_location
= larger_vector (button_down_location
,
5489 mouse_syms
= larger_vector (mouse_syms
, incr
, -1);
5492 start_pos_ptr
= aref_addr (button_down_location
, button
);
5493 start_pos
= *start_pos_ptr
;
5494 *start_pos_ptr
= Qnil
;
5497 /* On window-system frames, use the value of
5498 double-click-fuzz as is. On other frames, interpret it
5499 as a multiple of 1/8 characters. */
5503 if (WINDOWP (event
->frame_or_window
))
5504 f
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5505 else if (FRAMEP (event
->frame_or_window
))
5506 f
= XFRAME (event
->frame_or_window
);
5510 if (FRAME_WINDOW_P (f
))
5511 fuzz
= double_click_fuzz
;
5513 fuzz
= double_click_fuzz
/ 8;
5515 is_double
= (button
== last_mouse_button
5516 && (eabs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5517 && (eabs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5518 && button_down_time
!= 0
5519 && (EQ (Vdouble_click_time
, Qt
)
5520 || (NATNUMP (Vdouble_click_time
)
5521 && (event
->timestamp
- button_down_time
5522 < XFASTINT (Vdouble_click_time
)))));
5525 last_mouse_button
= button
;
5526 last_mouse_x
= XINT (event
->x
);
5527 last_mouse_y
= XINT (event
->y
);
5529 /* If this is a button press, squirrel away the location, so
5530 we can decide later whether it was a click or a drag. */
5531 if (event
->modifiers
& down_modifier
)
5535 double_click_count
++;
5536 event
->modifiers
|= ((double_click_count
> 2)
5541 double_click_count
= 1;
5542 button_down_time
= event
->timestamp
;
5543 *start_pos_ptr
= Fcopy_alist (position
);
5544 ignore_mouse_drag_p
= 0;
5547 /* Now we're releasing a button - check the co-ordinates to
5548 see if this was a click or a drag. */
5549 else if (event
->modifiers
& up_modifier
)
5551 /* If we did not see a down before this up, ignore the up.
5552 Probably this happened because the down event chose a
5553 menu item. It would be an annoyance to treat the
5554 release of the button that chose the menu item as a
5557 if (!CONSP (start_pos
))
5560 event
->modifiers
&= ~up_modifier
;
5563 Lisp_Object new_down
, down
;
5564 EMACS_INT xdiff
= double_click_fuzz
, ydiff
= double_click_fuzz
;
5566 /* The third element of every position
5567 should be the (x,y) pair. */
5568 down
= Fcar (Fcdr (Fcdr (start_pos
)));
5569 new_down
= Fcar (Fcdr (Fcdr (position
)));
5572 && INTEGERP (XCAR (down
)) && INTEGERP (XCDR (down
)))
5574 xdiff
= XINT (XCAR (new_down
)) - XINT (XCAR (down
));
5575 ydiff
= XINT (XCDR (new_down
)) - XINT (XCDR (down
));
5578 if (ignore_mouse_drag_p
)
5580 event
->modifiers
|= click_modifier
;
5581 ignore_mouse_drag_p
= 0;
5583 else if (xdiff
< double_click_fuzz
&& xdiff
> - double_click_fuzz
5584 && ydiff
< double_click_fuzz
&& ydiff
> - double_click_fuzz
5585 /* Maybe the mouse has moved a lot, caused scrolling, and
5586 eventually ended up at the same screen position (but
5587 not buffer position) in which case it is a drag, not
5589 /* FIXME: OTOH if the buffer position has changed
5590 because of a timer or process filter rather than
5591 because of mouse movement, it should be considered as
5592 a click. But mouse-drag-region completely ignores
5593 this case and it hasn't caused any real problem, so
5594 it's probably OK to ignore it as well. */
5595 && EQ (Fcar (Fcdr (start_pos
)), Fcar (Fcdr (position
))))
5596 /* Mouse hasn't moved (much). */
5597 event
->modifiers
|= click_modifier
;
5600 button_down_time
= 0;
5601 event
->modifiers
|= drag_modifier
;
5604 /* Don't check is_double; treat this as multiple
5605 if the down-event was multiple. */
5606 if (double_click_count
> 1)
5607 event
->modifiers
|= ((double_click_count
> 2)
5613 /* Every mouse event should either have the down_modifier or
5614 the up_modifier set. */
5618 /* Get the symbol we should use for the mouse click. */
5621 head
= modify_event_symbol (button
,
5623 Qmouse_click
, Vlispy_mouse_stem
,
5626 ASIZE (mouse_syms
));
5627 if (event
->modifiers
& drag_modifier
)
5632 else if (event
->modifiers
& (double_modifier
| triple_modifier
))
5635 Fcons (make_number (double_click_count
),
5645 case HORIZ_WHEEL_EVENT
:
5647 Lisp_Object position
;
5650 /* Build the position as appropriate for this mouse click. */
5651 struct frame
*f
= XFRAME (event
->frame_or_window
);
5653 /* Ignore wheel events that were made on frame that have been
5655 if (! FRAME_LIVE_P (f
))
5658 position
= make_lispy_position (f
, event
->x
, event
->y
,
5661 /* Set double or triple modifiers to indicate the wheel speed. */
5663 /* On window-system frames, use the value of
5664 double-click-fuzz as is. On other frames, interpret it
5665 as a multiple of 1/8 characters. */
5671 if (WINDOWP (event
->frame_or_window
))
5672 fr
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5673 else if (FRAMEP (event
->frame_or_window
))
5674 fr
= XFRAME (event
->frame_or_window
);
5678 fuzz
= FRAME_WINDOW_P (fr
)
5679 ? double_click_fuzz
: double_click_fuzz
/ 8;
5681 if (event
->modifiers
& up_modifier
)
5683 /* Emit a wheel-up event. */
5684 event
->modifiers
&= ~up_modifier
;
5687 else if (event
->modifiers
& down_modifier
)
5689 /* Emit a wheel-down event. */
5690 event
->modifiers
&= ~down_modifier
;
5694 /* Every wheel event should either have the down_modifier or
5695 the up_modifier set. */
5698 if (event
->kind
== HORIZ_WHEEL_EVENT
)
5701 is_double
= (last_mouse_button
== - (1 + symbol_num
)
5702 && (eabs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5703 && (eabs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5704 && button_down_time
!= 0
5705 && (EQ (Vdouble_click_time
, Qt
)
5706 || (NATNUMP (Vdouble_click_time
)
5707 && (event
->timestamp
- button_down_time
5708 < XFASTINT (Vdouble_click_time
)))));
5711 double_click_count
++;
5712 event
->modifiers
|= ((double_click_count
> 2)
5718 double_click_count
= 1;
5719 event
->modifiers
|= click_modifier
;
5722 button_down_time
= event
->timestamp
;
5723 /* Use a negative value to distinguish wheel from mouse button. */
5724 last_mouse_button
= - (1 + symbol_num
);
5725 last_mouse_x
= XINT (event
->x
);
5726 last_mouse_y
= XINT (event
->y
);
5728 /* Get the symbol we should use for the wheel event. */
5729 head
= modify_event_symbol (symbol_num
,
5735 ASIZE (wheel_syms
));
5738 if (event
->modifiers
& (double_modifier
| triple_modifier
))
5741 Fcons (make_number (double_click_count
),
5750 #ifdef USE_TOOLKIT_SCROLL_BARS
5752 /* We don't have down and up events if using toolkit scroll bars,
5753 so make this always a click event. Store in the `part' of
5754 the Lisp event a symbol which maps to the following actions:
5756 `above_handle' page up
5757 `below_handle' page down
5761 `bottom' bottom of buffer
5762 `handle' thumb has been dragged.
5763 `end-scroll' end of interaction with scroll bar
5765 The incoming input_event contains in its `part' member an
5766 index of type `enum scroll_bar_part' which we can use as an
5767 index in scroll_bar_parts to get the appropriate symbol. */
5769 case SCROLL_BAR_CLICK_EVENT
:
5771 Lisp_Object position
, head
, window
, portion_whole
, part
;
5773 window
= event
->frame_or_window
;
5774 portion_whole
= Fcons (event
->x
, event
->y
);
5775 part
= *scroll_bar_parts
[(int) event
->part
];
5779 Fcons (Qvertical_scroll_bar
,
5780 Fcons (portion_whole
,
5781 Fcons (make_number (event
->timestamp
),
5782 Fcons (part
, Qnil
)))));
5784 /* Always treat scroll bar events as clicks. */
5785 event
->modifiers
|= click_modifier
;
5786 event
->modifiers
&= ~up_modifier
;
5788 if (event
->code
>= ASIZE (mouse_syms
))
5789 mouse_syms
= larger_vector (mouse_syms
,
5790 event
->code
- ASIZE (mouse_syms
) + 1,
5793 /* Get the symbol we should use for the mouse click. */
5794 head
= modify_event_symbol (event
->code
,
5799 ASIZE (mouse_syms
));
5800 return Fcons (head
, Fcons (position
, Qnil
));
5803 #endif /* USE_TOOLKIT_SCROLL_BARS */
5805 case DRAG_N_DROP_EVENT
:
5808 Lisp_Object head
, position
;
5811 f
= XFRAME (event
->frame_or_window
);
5814 /* Ignore mouse events that were made on frames that
5815 have been deleted. */
5816 if (! FRAME_LIVE_P (f
))
5819 position
= make_lispy_position (f
, event
->x
, event
->y
,
5822 head
= modify_event_symbol (0, event
->modifiers
,
5824 lispy_drag_n_drop_names
,
5825 &drag_n_drop_syms
, 1);
5832 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
5833 || defined (HAVE_NS) || defined (USE_GTK)
5834 case MENU_BAR_EVENT
:
5835 if (EQ (event
->arg
, event
->frame_or_window
))
5836 /* This is the prefix key. We translate this to
5837 `(menu_bar)' because the code in keyboard.c for menu
5838 events, which we use, relies on this. */
5839 return Fcons (Qmenu_bar
, Qnil
);
5843 case SELECT_WINDOW_EVENT
:
5844 /* Make an event (select-window (WINDOW)). */
5845 return Fcons (Qselect_window
,
5846 Fcons (Fcons (event
->frame_or_window
, Qnil
),
5849 case TOOL_BAR_EVENT
:
5850 if (EQ (event
->arg
, event
->frame_or_window
))
5851 /* This is the prefix key. We translate this to
5852 `(tool_bar)' because the code in keyboard.c for tool bar
5853 events, which we use, relies on this. */
5854 return Fcons (Qtool_bar
, Qnil
);
5855 else if (SYMBOLP (event
->arg
))
5856 return apply_modifiers (event
->modifiers
, event
->arg
);
5859 case USER_SIGNAL_EVENT
:
5860 /* A user signal. */
5862 char *name
= find_user_signal_name (event
->code
);
5865 return intern (name
);
5868 case SAVE_SESSION_EVENT
:
5869 return Qsave_session
;
5874 return Fcons (Qdbus_event
, event
->arg
);
5876 #endif /* HAVE_DBUS */
5878 case CONFIG_CHANGED_EVENT
:
5879 return Fcons (Qconfig_changed_event
,
5881 Fcons (event
->frame_or_window
, Qnil
)));
5883 case GPM_CLICK_EVENT
:
5885 FRAME_PTR f
= XFRAME (event
->frame_or_window
);
5886 Lisp_Object head
, position
;
5887 Lisp_Object
*start_pos_ptr
;
5888 Lisp_Object start_pos
;
5889 int button
= event
->code
;
5891 if (button
>= ASIZE (button_down_location
))
5893 ptrdiff_t incr
= button
- ASIZE (button_down_location
) + 1;
5894 button_down_location
= larger_vector (button_down_location
,
5896 mouse_syms
= larger_vector (mouse_syms
, incr
, -1);
5899 start_pos_ptr
= aref_addr (button_down_location
, button
);
5900 start_pos
= *start_pos_ptr
;
5902 position
= make_lispy_position (f
, event
->x
, event
->y
,
5905 if (event
->modifiers
& down_modifier
)
5906 *start_pos_ptr
= Fcopy_alist (position
);
5907 else if (event
->modifiers
& (up_modifier
| drag_modifier
))
5909 if (!CONSP (start_pos
))
5911 event
->modifiers
&= ~up_modifier
;
5914 head
= modify_event_symbol (button
,
5916 Qmouse_click
, Vlispy_mouse_stem
,
5919 ASIZE (mouse_syms
));
5921 if (event
->modifiers
& drag_modifier
)
5926 else if (event
->modifiers
& double_modifier
)
5929 Fcons (make_number (2),
5931 else if (event
->modifiers
& triple_modifier
)
5934 Fcons (make_number (3),
5941 #endif /* HAVE_GPM */
5943 /* The 'kind' field of the event is something we don't recognize. */
5950 make_lispy_movement (FRAME_PTR frame
, Lisp_Object bar_window
, enum scroll_bar_part part
,
5951 Lisp_Object x
, Lisp_Object y
, Time t
)
5953 /* Is it a scroll bar movement? */
5954 if (frame
&& ! NILP (bar_window
))
5956 Lisp_Object part_sym
;
5958 part_sym
= *scroll_bar_parts
[(int) part
];
5959 return Fcons (Qscroll_bar_movement
,
5960 Fcons (list5 (bar_window
,
5961 Qvertical_scroll_bar
,
5967 /* Or is it an ordinary mouse movement? */
5970 Lisp_Object position
;
5971 position
= make_lispy_position (frame
, x
, y
, t
);
5972 return list2 (Qmouse_movement
, position
);
5976 /* Construct a switch frame event. */
5978 make_lispy_switch_frame (Lisp_Object frame
)
5980 return Fcons (Qswitch_frame
, Fcons (frame
, Qnil
));
5983 /* Manipulating modifiers. */
5985 /* Parse the name of SYMBOL, and return the set of modifiers it contains.
5987 If MODIFIER_END is non-zero, set *MODIFIER_END to the position in
5988 SYMBOL's name of the end of the modifiers; the string from this
5989 position is the unmodified symbol name.
5991 This doesn't use any caches. */
5994 parse_modifiers_uncached (Lisp_Object symbol
, ptrdiff_t *modifier_end
)
6000 CHECK_SYMBOL (symbol
);
6003 name
= SYMBOL_NAME (symbol
);
6005 for (i
= 0; i
< SBYTES (name
) - 1; )
6007 ptrdiff_t this_mod_end
= 0;
6010 /* See if the name continues with a modifier word.
6011 Check that the word appears, but don't check what follows it.
6012 Set this_mod and this_mod_end to record what we find. */
6014 switch (SREF (name
, i
))
6016 #define SINGLE_LETTER_MOD(BIT) \
6017 (this_mod_end = i + 1, this_mod = BIT)
6020 SINGLE_LETTER_MOD (alt_modifier
);
6024 SINGLE_LETTER_MOD (ctrl_modifier
);
6028 SINGLE_LETTER_MOD (hyper_modifier
);
6032 SINGLE_LETTER_MOD (meta_modifier
);
6036 SINGLE_LETTER_MOD (shift_modifier
);
6040 SINGLE_LETTER_MOD (super_modifier
);
6043 #undef SINGLE_LETTER_MOD
6045 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6046 if (i + LEN + 1 <= SBYTES (name) \
6047 && ! memcmp (SDATA (name) + i, NAME, LEN)) \
6049 this_mod_end = i + LEN; \
6054 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
6055 MULTI_LETTER_MOD (down_modifier
, "down", 4);
6056 MULTI_LETTER_MOD (double_modifier
, "double", 6);
6060 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
6062 #undef MULTI_LETTER_MOD
6066 /* If we found no modifier, stop looking for them. */
6067 if (this_mod_end
== 0)
6070 /* Check there is a dash after the modifier, so that it
6071 really is a modifier. */
6072 if (this_mod_end
>= SBYTES (name
)
6073 || SREF (name
, this_mod_end
) != '-')
6076 /* This modifier is real; look for another. */
6077 modifiers
|= this_mod
;
6078 i
= this_mod_end
+ 1;
6081 /* Should we include the `click' modifier? */
6082 if (! (modifiers
& (down_modifier
| drag_modifier
6083 | double_modifier
| triple_modifier
))
6084 && i
+ 7 == SBYTES (name
)
6085 && memcmp (SDATA (name
) + i
, "mouse-", 6) == 0
6086 && ('0' <= SREF (name
, i
+ 6) && SREF (name
, i
+ 6) <= '9'))
6087 modifiers
|= click_modifier
;
6089 if (! (modifiers
& (double_modifier
| triple_modifier
))
6090 && i
+ 6 < SBYTES (name
)
6091 && memcmp (SDATA (name
) + i
, "wheel-", 6) == 0)
6092 modifiers
|= click_modifier
;
6100 /* Return a symbol whose name is the modifier prefixes for MODIFIERS
6101 prepended to the string BASE[0..BASE_LEN-1].
6102 This doesn't use any caches. */
6104 apply_modifiers_uncached (int modifiers
, char *base
, int base_len
, int base_len_byte
)
6106 /* Since BASE could contain nulls, we can't use intern here; we have
6107 to use Fintern, which expects a genuine Lisp_String, and keeps a
6109 char new_mods
[sizeof "A-C-H-M-S-s-down-drag-double-triple-"];
6115 /* Only the event queue may use the `up' modifier; it should always
6116 be turned into a click or drag event before presented to lisp code. */
6117 if (modifiers
& up_modifier
)
6120 if (modifiers
& alt_modifier
) { *p
++ = 'A'; *p
++ = '-'; }
6121 if (modifiers
& ctrl_modifier
) { *p
++ = 'C'; *p
++ = '-'; }
6122 if (modifiers
& hyper_modifier
) { *p
++ = 'H'; *p
++ = '-'; }
6123 if (modifiers
& meta_modifier
) { *p
++ = 'M'; *p
++ = '-'; }
6124 if (modifiers
& shift_modifier
) { *p
++ = 'S'; *p
++ = '-'; }
6125 if (modifiers
& super_modifier
) { *p
++ = 's'; *p
++ = '-'; }
6126 if (modifiers
& double_modifier
) { strcpy (p
, "double-"); p
+= 7; }
6127 if (modifiers
& triple_modifier
) { strcpy (p
, "triple-"); p
+= 7; }
6128 if (modifiers
& down_modifier
) { strcpy (p
, "down-"); p
+= 5; }
6129 if (modifiers
& drag_modifier
) { strcpy (p
, "drag-"); p
+= 5; }
6130 /* The click modifier is denoted by the absence of other modifiers. */
6134 mod_len
= p
- new_mods
;
6138 Lisp_Object new_name
;
6140 new_name
= make_uninit_multibyte_string (mod_len
+ base_len
,
6141 mod_len
+ base_len_byte
);
6142 memcpy (SDATA (new_name
), new_mods
, mod_len
);
6143 memcpy (SDATA (new_name
) + mod_len
, base
, base_len_byte
);
6145 return Fintern (new_name
, Qnil
);
6150 static const char *const modifier_names
[] =
6152 "up", "down", "drag", "click", "double", "triple", 0, 0,
6153 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
6154 0, 0, "alt", "super", "hyper", "shift", "control", "meta"
6156 #define NUM_MOD_NAMES (sizeof (modifier_names) / sizeof (modifier_names[0]))
6158 static Lisp_Object modifier_symbols
;
6160 /* Return the list of modifier symbols corresponding to the mask MODIFIERS. */
6162 lispy_modifier_list (int modifiers
)
6164 Lisp_Object modifier_list
;
6167 modifier_list
= Qnil
;
6168 for (i
= 0; (1<<i
) <= modifiers
&& i
< NUM_MOD_NAMES
; i
++)
6169 if (modifiers
& (1<<i
))
6170 modifier_list
= Fcons (AREF (modifier_symbols
, i
),
6173 return modifier_list
;
6177 /* Parse the modifiers on SYMBOL, and return a list like (UNMODIFIED MASK),
6178 where UNMODIFIED is the unmodified form of SYMBOL,
6179 MASK is the set of modifiers present in SYMBOL's name.
6180 This is similar to parse_modifiers_uncached, but uses the cache in
6181 SYMBOL's Qevent_symbol_element_mask property, and maintains the
6182 Qevent_symbol_elements property. */
6184 #define KEY_TO_CHAR(k) (XINT (k) & ((1 << CHARACTERBITS) - 1))
6187 parse_modifiers (Lisp_Object symbol
)
6189 Lisp_Object elements
;
6191 if (INTEGERP (symbol
))
6192 return (Fcons (make_number (KEY_TO_CHAR (symbol
)),
6193 Fcons (make_number (XINT (symbol
) & CHAR_MODIFIER_MASK
),
6195 else if (!SYMBOLP (symbol
))
6198 elements
= Fget (symbol
, Qevent_symbol_element_mask
);
6199 if (CONSP (elements
))
6204 int modifiers
= parse_modifiers_uncached (symbol
, &end
);
6205 Lisp_Object unmodified
;
6208 unmodified
= Fintern (make_string (SSDATA (SYMBOL_NAME (symbol
)) + end
,
6209 SBYTES (SYMBOL_NAME (symbol
)) - end
),
6212 if (modifiers
& ~INTMASK
)
6214 XSETFASTINT (mask
, modifiers
);
6215 elements
= Fcons (unmodified
, Fcons (mask
, Qnil
));
6217 /* Cache the parsing results on SYMBOL. */
6218 Fput (symbol
, Qevent_symbol_element_mask
,
6220 Fput (symbol
, Qevent_symbol_elements
,
6221 Fcons (unmodified
, lispy_modifier_list (modifiers
)));
6223 /* Since we know that SYMBOL is modifiers applied to unmodified,
6224 it would be nice to put that in unmodified's cache.
6225 But we can't, since we're not sure that parse_modifiers is
6232 DEFUN ("internal-event-symbol-parse-modifiers", Fevent_symbol_parse_modifiers
,
6233 Sevent_symbol_parse_modifiers
, 1, 1, 0,
6234 doc
: /* Parse the event symbol. For internal use. */)
6235 (Lisp_Object symbol
)
6237 /* Fill the cache if needed. */
6238 parse_modifiers (symbol
);
6239 /* Ignore the result (which is stored on Qevent_symbol_element_mask)
6240 and use the Lispier representation stored on Qevent_symbol_elements
6242 return Fget (symbol
, Qevent_symbol_elements
);
6245 /* Apply the modifiers MODIFIERS to the symbol BASE.
6246 BASE must be unmodified.
6248 This is like apply_modifiers_uncached, but uses BASE's
6249 Qmodifier_cache property, if present. It also builds
6250 Qevent_symbol_elements properties, since it has that info anyway.
6252 apply_modifiers copies the value of BASE's Qevent_kind property to
6253 the modified symbol. */
6255 apply_modifiers (int modifiers
, Lisp_Object base
)
6257 Lisp_Object cache
, idx
, entry
, new_symbol
;
6259 /* Mask out upper bits. We don't know where this value's been. */
6260 modifiers
&= INTMASK
;
6262 if (INTEGERP (base
))
6263 return make_number (XINT (base
) | modifiers
);
6265 /* The click modifier never figures into cache indices. */
6266 cache
= Fget (base
, Qmodifier_cache
);
6267 XSETFASTINT (idx
, (modifiers
& ~click_modifier
));
6268 entry
= assq_no_quit (idx
, cache
);
6271 new_symbol
= XCDR (entry
);
6274 /* We have to create the symbol ourselves. */
6275 new_symbol
= apply_modifiers_uncached (modifiers
,
6276 SSDATA (SYMBOL_NAME (base
)),
6277 SCHARS (SYMBOL_NAME (base
)),
6278 SBYTES (SYMBOL_NAME (base
)));
6280 /* Add the new symbol to the base's cache. */
6281 entry
= Fcons (idx
, new_symbol
);
6282 Fput (base
, Qmodifier_cache
, Fcons (entry
, cache
));
6284 /* We have the parsing info now for free, so we could add it to
6286 XSETFASTINT (idx, modifiers);
6287 Fput (new_symbol, Qevent_symbol_element_mask,
6288 Fcons (base, Fcons (idx, Qnil)));
6289 Fput (new_symbol, Qevent_symbol_elements,
6290 Fcons (base, lispy_modifier_list (modifiers)));
6291 Sadly, this is only correct if `base' is indeed a base event,
6292 which is not necessarily the case. -stef */
6295 /* Make sure this symbol is of the same kind as BASE.
6297 You'd think we could just set this once and for all when we
6298 intern the symbol above, but reorder_modifiers may call us when
6299 BASE's property isn't set right; we can't assume that just
6300 because it has a Qmodifier_cache property it must have its
6301 Qevent_kind set right as well. */
6302 if (NILP (Fget (new_symbol
, Qevent_kind
)))
6306 kind
= Fget (base
, Qevent_kind
);
6308 Fput (new_symbol
, Qevent_kind
, kind
);
6315 /* Given a symbol whose name begins with modifiers ("C-", "M-", etc),
6316 return a symbol with the modifiers placed in the canonical order.
6317 Canonical order is alphabetical, except for down and drag, which
6318 always come last. The 'click' modifier is never written out.
6320 Fdefine_key calls this to make sure that (for example) C-M-foo
6321 and M-C-foo end up being equivalent in the keymap. */
6324 reorder_modifiers (Lisp_Object symbol
)
6326 /* It's hopefully okay to write the code this way, since everything
6327 will soon be in caches, and no consing will be done at all. */
6330 parsed
= parse_modifiers (symbol
);
6331 return apply_modifiers (XFASTINT (XCAR (XCDR (parsed
))),
6336 /* For handling events, we often want to produce a symbol whose name
6337 is a series of modifier key prefixes ("M-", "C-", etcetera) attached
6338 to some base, like the name of a function key or mouse button.
6339 modify_event_symbol produces symbols of this sort.
6341 NAME_TABLE should point to an array of strings, such that NAME_TABLE[i]
6342 is the name of the i'th symbol. TABLE_SIZE is the number of elements
6345 Alternatively, NAME_ALIST_OR_STEM is either an alist mapping codes
6346 into symbol names, or a string specifying a name stem used to
6347 construct a symbol name or the form `STEM-N', where N is the decimal
6348 representation of SYMBOL_NUM. NAME_ALIST_OR_STEM is used if it is
6349 non-nil; otherwise NAME_TABLE is used.
6351 SYMBOL_TABLE should be a pointer to a Lisp_Object whose value will
6352 persist between calls to modify_event_symbol that it can use to
6353 store a cache of the symbols it's generated for this NAME_TABLE
6354 before. The object stored there may be a vector or an alist.
6356 SYMBOL_NUM is the number of the base name we want from NAME_TABLE.
6358 MODIFIERS is a set of modifier bits (as given in struct input_events)
6359 whose prefixes should be applied to the symbol name.
6361 SYMBOL_KIND is the value to be placed in the event_kind property of
6362 the returned symbol.
6364 The symbols we create are supposed to have an
6365 `event-symbol-elements' property, which lists the modifiers present
6366 in the symbol's name. */
6369 modify_event_symbol (ptrdiff_t symbol_num
, int modifiers
, Lisp_Object symbol_kind
,
6370 Lisp_Object name_alist_or_stem
, const char *const *name_table
,
6371 Lisp_Object
*symbol_table
, ptrdiff_t table_size
)
6374 Lisp_Object symbol_int
;
6376 /* Get rid of the "vendor-specific" bit here. */
6377 XSETINT (symbol_int
, symbol_num
& 0xffffff);
6379 /* Is this a request for a valid symbol? */
6380 if (symbol_num
< 0 || symbol_num
>= table_size
)
6383 if (CONSP (*symbol_table
))
6384 value
= Fcdr (assq_no_quit (symbol_int
, *symbol_table
));
6386 /* If *symbol_table doesn't seem to be initialized properly, fix that.
6387 *symbol_table should be a lisp vector TABLE_SIZE elements long,
6388 where the Nth element is the symbol for NAME_TABLE[N], or nil if
6389 we've never used that symbol before. */
6392 if (! VECTORP (*symbol_table
)
6393 || ASIZE (*symbol_table
) != table_size
)
6397 XSETFASTINT (size
, table_size
);
6398 *symbol_table
= Fmake_vector (size
, Qnil
);
6401 value
= AREF (*symbol_table
, symbol_num
);
6404 /* Have we already used this symbol before? */
6407 /* No; let's create it. */
6408 if (CONSP (name_alist_or_stem
))
6409 value
= Fcdr_safe (Fassq (symbol_int
, name_alist_or_stem
));
6410 else if (STRINGP (name_alist_or_stem
))
6413 ptrdiff_t len
= (SBYTES (name_alist_or_stem
)
6414 + sizeof "-" + INT_STRLEN_BOUND (EMACS_INT
));
6416 buf
= SAFE_ALLOCA (len
);
6417 esprintf (buf
, "%s-%"pI
"d", SDATA (name_alist_or_stem
),
6418 XINT (symbol_int
) + 1);
6419 value
= intern (buf
);
6422 else if (name_table
!= 0 && name_table
[symbol_num
])
6423 value
= intern (name_table
[symbol_num
]);
6425 #ifdef HAVE_WINDOW_SYSTEM
6428 char *name
= x_get_keysym_name (symbol_num
);
6430 value
= intern (name
);
6436 char buf
[sizeof "key-" + INT_STRLEN_BOUND (EMACS_INT
)];
6437 sprintf (buf
, "key-%"pD
"d", symbol_num
);
6438 value
= intern (buf
);
6441 if (CONSP (*symbol_table
))
6442 *symbol_table
= Fcons (Fcons (symbol_int
, value
), *symbol_table
);
6444 ASET (*symbol_table
, symbol_num
, value
);
6446 /* Fill in the cache entries for this symbol; this also
6447 builds the Qevent_symbol_elements property, which the user
6449 apply_modifiers (modifiers
& click_modifier
, value
);
6450 Fput (value
, Qevent_kind
, symbol_kind
);
6453 /* Apply modifiers to that symbol. */
6454 return apply_modifiers (modifiers
, value
);
6457 /* Convert a list that represents an event type,
6458 such as (ctrl meta backspace), into the usual representation of that
6459 event type as a number or a symbol. */
6461 DEFUN ("event-convert-list", Fevent_convert_list
, Sevent_convert_list
, 1, 1, 0,
6462 doc
: /* Convert the event description list EVENT-DESC to an event type.
6463 EVENT-DESC should contain one base event type (a character or symbol)
6464 and zero or more modifier names (control, meta, hyper, super, shift, alt,
6465 drag, down, double or triple). The base must be last.
6466 The return value is an event type (a character or symbol) which
6467 has the same base event type and all the specified modifiers. */)
6468 (Lisp_Object event_desc
)
6476 while (CONSP (rest
))
6484 /* Given a symbol, see if it is a modifier name. */
6485 if (SYMBOLP (elt
) && CONSP (rest
))
6486 this = parse_solitary_modifier (elt
);
6490 else if (!NILP (base
))
6491 error ("Two bases given in one event");
6497 /* Let the symbol A refer to the character A. */
6498 if (SYMBOLP (base
) && SCHARS (SYMBOL_NAME (base
)) == 1)
6499 XSETINT (base
, SREF (SYMBOL_NAME (base
), 0));
6501 if (INTEGERP (base
))
6503 /* Turn (shift a) into A. */
6504 if ((modifiers
& shift_modifier
) != 0
6505 && (XINT (base
) >= 'a' && XINT (base
) <= 'z'))
6507 XSETINT (base
, XINT (base
) - ('a' - 'A'));
6508 modifiers
&= ~shift_modifier
;
6511 /* Turn (control a) into C-a. */
6512 if (modifiers
& ctrl_modifier
)
6513 return make_number ((modifiers
& ~ctrl_modifier
)
6514 | make_ctrl_char (XINT (base
)));
6516 return make_number (modifiers
| XINT (base
));
6518 else if (SYMBOLP (base
))
6519 return apply_modifiers (modifiers
, base
);
6522 error ("Invalid base event");
6527 /* Try to recognize SYMBOL as a modifier name.
6528 Return the modifier flag bit, or 0 if not recognized. */
6531 parse_solitary_modifier (Lisp_Object symbol
)
6533 Lisp_Object name
= SYMBOL_NAME (symbol
);
6535 switch (SREF (name
, 0))
6537 #define SINGLE_LETTER_MOD(BIT) \
6538 if (SBYTES (name) == 1) \
6541 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6542 if (LEN == SBYTES (name) \
6543 && ! memcmp (SDATA (name), NAME, LEN)) \
6547 SINGLE_LETTER_MOD (alt_modifier
);
6551 MULTI_LETTER_MOD (alt_modifier
, "alt", 3);
6555 SINGLE_LETTER_MOD (ctrl_modifier
);
6559 MULTI_LETTER_MOD (ctrl_modifier
, "ctrl", 4);
6560 MULTI_LETTER_MOD (ctrl_modifier
, "control", 7);
6564 SINGLE_LETTER_MOD (hyper_modifier
);
6568 MULTI_LETTER_MOD (hyper_modifier
, "hyper", 5);
6572 SINGLE_LETTER_MOD (meta_modifier
);
6576 MULTI_LETTER_MOD (meta_modifier
, "meta", 4);
6580 SINGLE_LETTER_MOD (shift_modifier
);
6584 MULTI_LETTER_MOD (shift_modifier
, "shift", 5);
6585 MULTI_LETTER_MOD (super_modifier
, "super", 5);
6586 SINGLE_LETTER_MOD (super_modifier
);
6590 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
6591 MULTI_LETTER_MOD (down_modifier
, "down", 4);
6592 MULTI_LETTER_MOD (double_modifier
, "double", 6);
6596 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
6599 #undef SINGLE_LETTER_MOD
6600 #undef MULTI_LETTER_MOD
6606 /* Return true if EVENT is a list whose elements are all integers or symbols.
6607 Such a list is not valid as an event,
6608 but it can be a Lucid-style event type list. */
6611 lucid_event_type_list_p (Lisp_Object object
)
6615 if (! CONSP (object
))
6618 if (EQ (XCAR (object
), Qhelp_echo
)
6619 || EQ (XCAR (object
), Qvertical_line
)
6620 || EQ (XCAR (object
), Qmode_line
)
6621 || EQ (XCAR (object
), Qheader_line
))
6624 for (tail
= object
; CONSP (tail
); tail
= XCDR (tail
))
6628 if (! (INTEGERP (elt
) || SYMBOLP (elt
)))
6635 /* Return true if terminal input chars are available.
6636 Also, store the return value into INPUT_PENDING.
6638 Serves the purpose of ioctl (0, FIONREAD, ...)
6639 but works even if FIONREAD does not exist.
6640 (In fact, this may actually read some input.)
6642 If READABLE_EVENTS_DO_TIMERS_NOW is set in FLAGS, actually run
6643 timer events that are ripe.
6644 If READABLE_EVENTS_FILTER_EVENTS is set in FLAGS, ignore internal
6645 events (FOCUS_IN_EVENT).
6646 If READABLE_EVENTS_IGNORE_SQUEEZABLES is set in FLAGS, ignore mouse
6647 movements and toolkit scroll bar thumb drags. */
6650 get_input_pending (int flags
)
6652 /* First of all, have we already counted some input? */
6653 input_pending
= (!NILP (Vquit_flag
) || readable_events (flags
));
6655 /* If input is being read as it arrives, and we have none, there is none. */
6656 if (!input_pending
&& (!interrupt_input
|| interrupts_deferred
))
6658 /* Try to read some input and see how much we get. */
6660 input_pending
= (!NILP (Vquit_flag
) || readable_events (flags
));
6663 return input_pending
;
6666 /* Put a BUFFER_SWITCH_EVENT in the buffer
6667 so that read_key_sequence will notice the new current buffer. */
6670 record_asynch_buffer_change (void)
6672 struct input_event event
;
6676 event
.kind
= BUFFER_SWITCH_EVENT
;
6677 event
.frame_or_window
= Qnil
;
6680 /* We don't need a buffer-switch event unless Emacs is waiting for input.
6681 The purpose of the event is to make read_key_sequence look up the
6682 keymaps again. If we aren't in read_key_sequence, we don't need one,
6683 and the event could cause trouble by messing up (input-pending-p).
6684 Note: Fwaiting_for_user_input_p always returns nil when async
6685 subprocesses aren't supported. */
6686 tem
= Fwaiting_for_user_input_p ();
6690 /* Make sure no interrupt happens while storing the event. */
6692 if (interrupt_input
)
6693 kbd_buffer_store_event (&event
);
6698 kbd_buffer_store_event (&event
);
6703 /* Read any terminal input already buffered up by the system
6704 into the kbd_buffer, but do not wait.
6706 Return the number of keyboard chars read, or -1 meaning
6707 this is a bad time to try to read input. */
6716 /* Store pending user signal events, if any. */
6717 store_user_signal_events ();
6719 /* Loop through the available terminals, and call their input hooks. */
6723 struct terminal
*next
= t
->next_terminal
;
6725 if (t
->read_socket_hook
)
6728 struct input_event hold_quit
;
6730 if (input_blocked_p ())
6732 pending_signals
= 1;
6736 EVENT_INIT (hold_quit
);
6737 hold_quit
.kind
= NO_EVENT
;
6739 /* No need for FIONREAD or fcntl; just say don't wait. */
6740 while (0 < (nr
= (*t
->read_socket_hook
) (t
, &hold_quit
)))
6743 if (nr
== -1) /* Not OK to read input now. */
6747 else if (nr
== -2) /* Non-transient error. */
6749 /* The terminal device terminated; it should be closed. */
6751 /* Kill Emacs if this was our last terminal. */
6752 if (!terminal_list
->next_terminal
)
6753 /* Formerly simply reported no input, but that
6754 sometimes led to a failure of Emacs to terminate.
6755 SIGHUP seems appropriate if we can't reach the
6757 /* ??? Is it really right to send the signal just to
6758 this process rather than to the whole process
6759 group? Perhaps on systems with FIONREAD Emacs is
6760 alone in its group. */
6761 terminate_due_to_signal (SIGHUP
, 10);
6763 /* XXX Is calling delete_terminal safe here? It calls delete_frame. */
6766 XSETTERMINAL (tmp
, t
);
6767 Fdelete_terminal (tmp
, Qnoelisp
);
6771 if (hold_quit
.kind
!= NO_EVENT
)
6772 kbd_buffer_store_event (&hold_quit
);
6781 frame_make_pointer_visible ();
6787 decode_keyboard_code (struct tty_display_info
*tty
,
6788 struct coding_system
*coding
,
6789 unsigned char *buf
, int nbytes
)
6791 unsigned char *src
= buf
;
6792 const unsigned char *p
;
6797 if (tty
->meta_key
!= 2)
6798 for (i
= 0; i
< nbytes
; i
++)
6800 if (coding
->carryover_bytes
> 0)
6802 src
= alloca (coding
->carryover_bytes
+ nbytes
);
6803 memcpy (src
, coding
->carryover
, coding
->carryover_bytes
);
6804 memcpy (src
+ coding
->carryover_bytes
, buf
, nbytes
);
6805 nbytes
+= coding
->carryover_bytes
;
6807 coding
->destination
= alloca (nbytes
* 4);
6808 coding
->dst_bytes
= nbytes
* 4;
6809 decode_coding_c_string (coding
, src
, nbytes
, Qnil
);
6810 if (coding
->produced_char
== 0)
6812 for (i
= 0, p
= coding
->destination
; i
< coding
->produced_char
; i
++)
6814 struct input_event event_buf
;
6816 EVENT_INIT (event_buf
);
6817 event_buf
.code
= STRING_CHAR_ADVANCE (p
);
6819 (ASCII_CHAR_P (event_buf
.code
)
6820 ? ASCII_KEYSTROKE_EVENT
: MULTIBYTE_CHAR_KEYSTROKE_EVENT
);
6821 /* See the comment in tty_read_avail_input. */
6822 event_buf
.frame_or_window
= tty
->top_frame
;
6823 event_buf
.arg
= Qnil
;
6824 kbd_buffer_store_event (&event_buf
);
6828 /* This is the tty way of reading available input.
6830 Note that each terminal device has its own `struct terminal' object,
6831 and so this function is called once for each individual termcap
6832 terminal. The first parameter indicates which terminal to read from. */
6835 tty_read_avail_input (struct terminal
*terminal
,
6836 struct input_event
*hold_quit
)
6838 /* Using KBD_BUFFER_SIZE - 1 here avoids reading more than
6839 the kbd_buffer can really hold. That may prevent loss
6840 of characters on some systems when input is stuffed at us. */
6841 unsigned char cbuf
[KBD_BUFFER_SIZE
- 1];
6843 struct tty_display_info
*tty
= terminal
->display_info
.tty
;
6846 int buffer_free
= KBD_BUFFER_SIZE
- kbd_buffer_nr_stored () - 1;
6848 if (kbd_on_hold_p () || buffer_free
<= 0)
6850 #endif /* subprocesses */
6852 if (!terminal
->name
) /* Don't read from a dead terminal. */
6855 if (terminal
->type
!= output_termcap
6856 && terminal
->type
!= output_msdos_raw
)
6859 /* XXX I think the following code should be moved to separate hook
6860 functions in system-dependent files. */
6863 #else /* not WINDOWSNT */
6864 if (! tty
->term_initted
) /* In case we get called during bootstrap. */
6868 return 0; /* The terminal is suspended. */
6871 n_to_read
= dos_keysns ();
6875 cbuf
[0] = dos_keyread ();
6878 #else /* not MSDOS */
6883 struct input_event gpm_hold_quit
;
6884 int gpm
, fd
= gpm_fd
;
6886 EVENT_INIT (gpm_hold_quit
);
6887 gpm_hold_quit
.kind
= NO_EVENT
;
6889 /* gpm==1 if event received.
6890 gpm==0 if the GPM daemon has closed the connection, in which case
6891 Gpm_GetEvent closes gpm_fd and clears it to -1, which is why
6892 we save it in `fd' so close_gpm can remove it from the
6894 gpm==-1 if a protocol error or EWOULDBLOCK; the latter is normal. */
6895 while (gpm
= Gpm_GetEvent (&event
), gpm
== 1) {
6896 nread
+= handle_one_term_event (tty
, &event
, &gpm_hold_quit
);
6899 /* Presumably the GPM daemon has closed the connection. */
6901 if (gpm_hold_quit
.kind
!= NO_EVENT
)
6902 kbd_buffer_store_event (&gpm_hold_quit
);
6906 #endif /* HAVE_GPM */
6908 /* Determine how many characters we should *try* to read. */
6909 #ifdef USABLE_FIONREAD
6910 /* Find out how much input is available. */
6911 if (ioctl (fileno (tty
->input
), FIONREAD
, &n_to_read
) < 0)
6913 if (! noninteractive
)
6914 return -2; /* Close this terminal. */
6920 if (n_to_read
> sizeof cbuf
)
6921 n_to_read
= sizeof cbuf
;
6922 #elif defined USG || defined CYGWIN
6923 /* Read some input if available, but don't wait. */
6924 n_to_read
= sizeof cbuf
;
6925 fcntl (fileno (tty
->input
), F_SETFL
, O_NONBLOCK
);
6927 # error "Cannot read without possibly delaying"
6931 /* Don't read more than we can store. */
6932 if (n_to_read
> buffer_free
)
6933 n_to_read
= buffer_free
;
6934 #endif /* subprocesses */
6936 /* Now read; for one reason or another, this will not block.
6937 NREAD is set to the number of chars read. */
6940 nread
= emacs_read (fileno (tty
->input
), (char *) cbuf
, n_to_read
);
6941 /* POSIX infers that processes which are not in the session leader's
6942 process group won't get SIGHUP's at logout time. BSDI adheres to
6943 this part standard and returns -1 from read (0) with errno==EIO
6944 when the control tty is taken away.
6945 Jeffrey Honig <jch@bsdi.com> says this is generally safe. */
6946 if (nread
== -1 && errno
== EIO
)
6947 return -2; /* Close this terminal. */
6948 #if defined (AIX) && defined (_BSD)
6949 /* The kernel sometimes fails to deliver SIGHUP for ptys.
6950 This looks incorrect, but it isn't, because _BSD causes
6951 O_NDELAY to be defined in fcntl.h as O_NONBLOCK,
6952 and that causes a value other than 0 when there is no input. */
6954 return -2; /* Close this terminal. */
6958 /* We used to retry the read if it was interrupted.
6959 But this does the wrong thing when O_NONBLOCK causes
6960 an EAGAIN error. Does anybody know of a situation
6961 where a retry is actually needed? */
6963 nread
< 0 && (errno
== EAGAIN
6976 #ifndef USABLE_FIONREAD
6977 #if defined (USG) || defined (CYGWIN)
6978 fcntl (fileno (tty
->input
), F_SETFL
, 0);
6979 #endif /* USG or CYGWIN */
6980 #endif /* no FIONREAD */
6985 #endif /* not MSDOS */
6986 #endif /* not WINDOWSNT */
6988 if (TERMINAL_KEYBOARD_CODING (terminal
)->common_flags
6989 & CODING_REQUIRE_DECODING_MASK
)
6991 struct coding_system
*coding
= TERMINAL_KEYBOARD_CODING (terminal
);
6994 /* Decode the key sequence except for those with meta
6996 for (i
= from
= 0; ; i
++)
6997 if (i
== nread
|| (tty
->meta_key
== 1 && (cbuf
[i
] & 0x80)))
6999 struct input_event buf
;
7001 decode_keyboard_code (tty
, coding
, cbuf
+ from
, i
- from
);
7006 buf
.kind
= ASCII_KEYSTROKE_EVENT
;
7007 buf
.modifiers
= meta_modifier
;
7008 buf
.code
= cbuf
[i
] & ~0x80;
7009 /* See the comment below. */
7010 buf
.frame_or_window
= tty
->top_frame
;
7012 kbd_buffer_store_event (&buf
);
7018 for (i
= 0; i
< nread
; i
++)
7020 struct input_event buf
;
7022 buf
.kind
= ASCII_KEYSTROKE_EVENT
;
7024 if (tty
->meta_key
== 1 && (cbuf
[i
] & 0x80))
7025 buf
.modifiers
= meta_modifier
;
7026 if (tty
->meta_key
!= 2)
7030 /* Set the frame corresponding to the active tty. Note that the
7031 value of selected_frame is not reliable here, redisplay tends
7032 to temporarily change it. */
7033 buf
.frame_or_window
= tty
->top_frame
;
7036 kbd_buffer_store_event (&buf
);
7037 /* Don't look at input that follows a C-g too closely.
7038 This reduces lossage due to autorepeat on C-g. */
7039 if (buf
.kind
== ASCII_KEYSTROKE_EVENT
7040 && buf
.code
== quit_char
)
7048 handle_async_input (void)
7053 int nread
= gobble_input ();
7054 /* -1 means it's not ok to read the input now.
7055 UNBLOCK_INPUT will read it later; now, avoid infinite loop.
7056 0 means there was no keyboard input available. */
7064 process_pending_signals (void)
7066 pending_signals
= 0;
7067 handle_async_input ();
7068 do_pending_atimers ();
7071 /* Undo any number of BLOCK_INPUT calls down to level LEVEL,
7072 and also (if the level is now 0) reinvoke any pending signal. */
7075 unblock_input_to (int level
)
7077 interrupt_input_blocked
= level
;
7080 if (pending_signals
)
7081 process_pending_signals ();
7087 /* End critical section.
7089 If doing signal-driven input, and a signal came in when input was
7090 blocked, reinvoke the signal handler now to deal with it. */
7093 unblock_input (void)
7095 unblock_input_to (interrupt_input_blocked
- 1);
7098 /* Undo any number of BLOCK_INPUT calls,
7099 and also reinvoke any pending signal. */
7102 totally_unblock_input (void)
7104 unblock_input_to (0);
7110 handle_input_available_signal (int sig
)
7112 pending_signals
= 1;
7114 if (input_available_clear_time
)
7115 *input_available_clear_time
= make_emacs_time (0, 0);
7119 deliver_input_available_signal (int sig
)
7121 deliver_process_signal (sig
, handle_input_available_signal
);
7123 #endif /* USABLE_SIGIO */
7126 /* User signal events. */
7128 struct user_signal_info
7130 /* Signal number. */
7133 /* Name of the signal. */
7136 /* Number of pending signals. */
7139 struct user_signal_info
*next
;
7142 /* List of user signals. */
7143 static struct user_signal_info
*user_signals
= NULL
;
7146 add_user_signal (int sig
, const char *name
)
7148 struct sigaction action
;
7149 struct user_signal_info
*p
;
7151 for (p
= user_signals
; p
; p
= p
->next
)
7153 /* Already added. */
7156 p
= xmalloc (sizeof *p
);
7158 p
->name
= xstrdup (name
);
7160 p
->next
= user_signals
;
7163 emacs_sigaction_init (&action
, deliver_user_signal
);
7164 sigaction (sig
, &action
, 0);
7168 handle_user_signal (int sig
)
7170 struct user_signal_info
*p
;
7171 const char *special_event_name
= NULL
;
7173 if (SYMBOLP (Vdebug_on_event
))
7174 special_event_name
= SSDATA (SYMBOL_NAME (Vdebug_on_event
));
7176 for (p
= user_signals
; p
; p
= p
->next
)
7179 if (special_event_name
7180 && strcmp (special_event_name
, p
->name
) == 0)
7182 /* Enter the debugger in many ways. */
7183 debug_on_next_call
= 1;
7186 Vinhibit_quit
= Qnil
;
7188 /* Eat the event. */
7194 if (interrupt_input
)
7195 handle_input_available_signal (sig
);
7199 /* Tell wait_reading_process_output that it needs to wake
7200 up and look around. */
7201 if (input_available_clear_time
)
7202 *input_available_clear_time
= make_emacs_time (0, 0);
7209 deliver_user_signal (int sig
)
7211 deliver_process_signal (sig
, handle_user_signal
);
7215 find_user_signal_name (int sig
)
7217 struct user_signal_info
*p
;
7219 for (p
= user_signals
; p
; p
= p
->next
)
7227 store_user_signal_events (void)
7229 struct user_signal_info
*p
;
7230 struct input_event buf
;
7231 bool buf_initialized
= 0;
7233 for (p
= user_signals
; p
; p
= p
->next
)
7234 if (p
->npending
> 0)
7236 if (! buf_initialized
)
7238 memset (&buf
, 0, sizeof buf
);
7239 buf
.kind
= USER_SIGNAL_EVENT
;
7240 buf
.frame_or_window
= selected_frame
;
7241 buf_initialized
= 1;
7247 kbd_buffer_store_event (&buf
);
7250 while (p
->npending
> 0);
7255 static void menu_bar_item (Lisp_Object
, Lisp_Object
, Lisp_Object
, void*);
7256 static Lisp_Object menu_bar_one_keymap_changed_items
;
7258 /* These variables hold the vector under construction within
7259 menu_bar_items and its subroutines, and the current index
7260 for storing into that vector. */
7261 static Lisp_Object menu_bar_items_vector
;
7262 static int menu_bar_items_index
;
7265 static const char* separator_names
[] = {
7270 "single-dashed-line",
7271 "double-dashed-line",
7273 "shadow-etched-out",
7274 "shadow-etched-in-dash",
7275 "shadow-etched-out-dash",
7276 "shadow-double-etched-in",
7277 "shadow-double-etched-out",
7278 "shadow-double-etched-in-dash",
7279 "shadow-double-etched-out-dash",
7283 /* Return true if LABEL specifies a separator. */
7286 menu_separator_name_p (const char *label
)
7290 else if (strlen (label
) > 3
7291 && memcmp (label
, "--", 2) == 0
7296 for (i
= 0; separator_names
[i
]; ++i
)
7297 if (strcmp (label
, separator_names
[i
]) == 0)
7302 /* It's a separator if it contains only dashes. */
7303 while (*label
== '-')
7305 return (*label
== 0);
7312 /* Return a vector of menu items for a menu bar, appropriate
7313 to the current buffer. Each item has three elements in the vector:
7316 OLD is an old vector we can optionally reuse, or nil. */
7319 menu_bar_items (Lisp_Object old
)
7321 /* The number of keymaps we're scanning right now, and the number of
7322 keymaps we have allocated space for. */
7325 /* maps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
7326 in the current keymaps, or nil where it is not a prefix. */
7329 Lisp_Object def
, tail
;
7334 /* In order to build the menus, we need to call the keymap
7335 accessors. They all call QUIT. But this function is called
7336 during redisplay, during which a quit is fatal. So inhibit
7337 quitting while building the menus.
7338 We do this instead of specbind because (1) errors will clear it anyway
7339 and (2) this avoids risk of specpdl overflow. */
7340 oquit
= Vinhibit_quit
;
7344 menu_bar_items_vector
= old
;
7346 menu_bar_items_vector
= Fmake_vector (make_number (24), Qnil
);
7347 menu_bar_items_index
= 0;
7349 /* Build our list of keymaps.
7350 If we recognize a function key and replace its escape sequence in
7351 keybuf with its symbol, or if the sequence starts with a mouse
7352 click and we need to switch buffers, we jump back here to rebuild
7353 the initial keymaps from the current buffer. */
7357 /* Should overriding-terminal-local-map and overriding-local-map apply? */
7358 if (!NILP (Voverriding_local_map_menu_flag
))
7360 /* Yes, use them (if non-nil) as well as the global map. */
7361 maps
= alloca (3 * sizeof (maps
[0]));
7363 if (!NILP (KVAR (current_kboard
, Voverriding_terminal_local_map
)))
7364 maps
[nmaps
++] = KVAR (current_kboard
, Voverriding_terminal_local_map
);
7365 if (!NILP (Voverriding_local_map
))
7366 maps
[nmaps
++] = Voverriding_local_map
;
7370 /* No, so use major and minor mode keymaps and keymap property.
7371 Note that menu-bar bindings in the local-map and keymap
7372 properties may not work reliable, as they are only
7373 recognized when the menu-bar (or mode-line) is updated,
7374 which does not normally happen after every command. */
7377 nminor
= current_minor_maps (NULL
, &tmaps
);
7378 maps
= alloca ((nminor
+ 3) * sizeof *maps
);
7380 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
7381 maps
[nmaps
++] = tem
;
7382 memcpy (maps
+ nmaps
, tmaps
, nminor
* sizeof (maps
[0]));
7384 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
7386 maps
[nmaps
++] = current_global_map
;
7389 /* Look up in each map the dummy prefix key `menu-bar'. */
7391 for (mapno
= nmaps
- 1; mapno
>= 0; mapno
--)
7392 if (!NILP (maps
[mapno
]))
7394 def
= get_keymap (access_keymap (maps
[mapno
], Qmenu_bar
, 1, 0, 1),
7398 menu_bar_one_keymap_changed_items
= Qnil
;
7399 map_keymap_canonical (def
, menu_bar_item
, Qnil
, NULL
);
7403 /* Move to the end those items that should be at the end. */
7405 for (tail
= Vmenu_bar_final_items
; CONSP (tail
); tail
= XCDR (tail
))
7408 int end
= menu_bar_items_index
;
7410 for (i
= 0; i
< end
; i
+= 4)
7411 if (EQ (XCAR (tail
), AREF (menu_bar_items_vector
, i
)))
7413 Lisp_Object tem0
, tem1
, tem2
, tem3
;
7414 /* Move the item at index I to the end,
7415 shifting all the others forward. */
7416 tem0
= AREF (menu_bar_items_vector
, i
+ 0);
7417 tem1
= AREF (menu_bar_items_vector
, i
+ 1);
7418 tem2
= AREF (menu_bar_items_vector
, i
+ 2);
7419 tem3
= AREF (menu_bar_items_vector
, i
+ 3);
7421 memmove (aref_addr (menu_bar_items_vector
, i
),
7422 aref_addr (menu_bar_items_vector
, i
+ 4),
7423 (end
- i
- 4) * word_size
);
7424 ASET (menu_bar_items_vector
, end
- 4, tem0
);
7425 ASET (menu_bar_items_vector
, end
- 3, tem1
);
7426 ASET (menu_bar_items_vector
, end
- 2, tem2
);
7427 ASET (menu_bar_items_vector
, end
- 1, tem3
);
7432 /* Add nil, nil, nil, nil at the end. */
7434 int i
= menu_bar_items_index
;
7435 if (i
+ 4 > ASIZE (menu_bar_items_vector
))
7436 menu_bar_items_vector
=
7437 larger_vector (menu_bar_items_vector
, 4, -1);
7438 /* Add this item. */
7439 ASET (menu_bar_items_vector
, i
, Qnil
); i
++;
7440 ASET (menu_bar_items_vector
, i
, Qnil
); i
++;
7441 ASET (menu_bar_items_vector
, i
, Qnil
); i
++;
7442 ASET (menu_bar_items_vector
, i
, Qnil
); i
++;
7443 menu_bar_items_index
= i
;
7446 Vinhibit_quit
= oquit
;
7447 return menu_bar_items_vector
;
7450 /* Add one item to menu_bar_items_vector, for KEY, ITEM_STRING and DEF.
7451 If there's already an item for KEY, add this DEF to it. */
7453 Lisp_Object item_properties
;
7456 menu_bar_item (Lisp_Object key
, Lisp_Object item
, Lisp_Object dummy1
, void *dummy2
)
7458 struct gcpro gcpro1
;
7463 if (EQ (item
, Qundefined
))
7465 /* If a map has an explicit `undefined' as definition,
7466 discard any previously made menu bar item. */
7468 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7469 if (EQ (key
, AREF (menu_bar_items_vector
, i
)))
7471 if (menu_bar_items_index
> i
+ 4)
7472 memmove (aref_addr (menu_bar_items_vector
, i
),
7473 aref_addr (menu_bar_items_vector
, i
+ 4),
7474 (menu_bar_items_index
- i
- 4) * word_size
);
7475 menu_bar_items_index
-= 4;
7479 /* If this keymap has already contributed to this KEY,
7480 don't contribute to it a second time. */
7481 tem
= Fmemq (key
, menu_bar_one_keymap_changed_items
);
7482 if (!NILP (tem
) || NILP (item
))
7485 menu_bar_one_keymap_changed_items
7486 = Fcons (key
, menu_bar_one_keymap_changed_items
);
7488 /* We add to menu_bar_one_keymap_changed_items before doing the
7489 parse_menu_item, so that if it turns out it wasn't a menu item,
7490 it still correctly hides any further menu item. */
7492 parsed
= parse_menu_item (item
, 1);
7497 item
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7499 /* Find any existing item for this KEY. */
7500 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7501 if (EQ (key
, AREF (menu_bar_items_vector
, i
)))
7504 /* If we did not find this KEY, add it at the end. */
7505 if (i
== menu_bar_items_index
)
7507 /* If vector is too small, get a bigger one. */
7508 if (i
+ 4 > ASIZE (menu_bar_items_vector
))
7509 menu_bar_items_vector
= larger_vector (menu_bar_items_vector
, 4, -1);
7510 /* Add this item. */
7511 ASET (menu_bar_items_vector
, i
, key
); i
++;
7512 ASET (menu_bar_items_vector
, i
,
7513 AREF (item_properties
, ITEM_PROPERTY_NAME
)); i
++;
7514 ASET (menu_bar_items_vector
, i
, Fcons (item
, Qnil
)); i
++;
7515 ASET (menu_bar_items_vector
, i
, make_number (0)); i
++;
7516 menu_bar_items_index
= i
;
7518 /* We did find an item for this KEY. Add ITEM to its list of maps. */
7522 old
= AREF (menu_bar_items_vector
, i
+ 2);
7523 /* If the new and the old items are not both keymaps,
7524 the lookup will only find `item'. */
7525 item
= Fcons (item
, KEYMAPP (item
) && KEYMAPP (XCAR (old
)) ? old
: Qnil
);
7526 ASET (menu_bar_items_vector
, i
+ 2, item
);
7530 /* This is used as the handler when calling menu_item_eval_property. */
7532 menu_item_eval_property_1 (Lisp_Object arg
)
7534 /* If we got a quit from within the menu computation,
7535 quit all the way out of it. This takes care of C-] in the debugger. */
7536 if (CONSP (arg
) && EQ (XCAR (arg
), Qquit
))
7537 Fsignal (Qquit
, Qnil
);
7543 eval_dyn (Lisp_Object form
)
7545 return Feval (form
, Qnil
);
7548 /* Evaluate an expression and return the result (or nil if something
7549 went wrong). Used to evaluate dynamic parts of menu items. */
7551 menu_item_eval_property (Lisp_Object sexpr
)
7553 ptrdiff_t count
= SPECPDL_INDEX ();
7555 specbind (Qinhibit_redisplay
, Qt
);
7556 val
= internal_condition_case_1 (eval_dyn
, sexpr
, Qerror
,
7557 menu_item_eval_property_1
);
7558 return unbind_to (count
, val
);
7561 /* This function parses a menu item and leaves the result in the
7562 vector item_properties.
7563 ITEM is a key binding, a possible menu item.
7564 INMENUBAR is > 0 when this is considered for an entry in a menu bar
7566 INMENUBAR is < 0 when this is considered for an entry in a keyboard menu.
7567 parse_menu_item returns true if the item is a menu item and false
7571 parse_menu_item (Lisp_Object item
, int inmenubar
)
7573 Lisp_Object def
, tem
, item_string
, start
;
7575 Lisp_Object keyhint
;
7584 /* Create item_properties vector if necessary. */
7585 if (NILP (item_properties
))
7587 = Fmake_vector (make_number (ITEM_PROPERTY_ENABLE
+ 1), Qnil
);
7589 /* Initialize optional entries. */
7590 for (i
= ITEM_PROPERTY_DEF
; i
< ITEM_PROPERTY_ENABLE
; i
++)
7591 ASET (item_properties
, i
, Qnil
);
7592 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7594 /* Save the item here to protect it from GC. */
7595 ASET (item_properties
, ITEM_PROPERTY_ITEM
, item
);
7597 item_string
= XCAR (item
);
7601 if (STRINGP (item_string
))
7603 /* Old format menu item. */
7604 ASET (item_properties
, ITEM_PROPERTY_NAME
, item_string
);
7606 /* Maybe help string. */
7607 if (CONSP (item
) && STRINGP (XCAR (item
)))
7609 ASET (item_properties
, ITEM_PROPERTY_HELP
, XCAR (item
));
7614 /* Maybe an obsolete key binding cache. */
7615 if (CONSP (item
) && CONSP (XCAR (item
))
7616 && (NILP (XCAR (XCAR (item
)))
7617 || VECTORP (XCAR (XCAR (item
)))))
7620 /* This is the real definition--the function to run. */
7621 ASET (item_properties
, ITEM_PROPERTY_DEF
, item
);
7623 /* Get enable property, if any. */
7626 tem
= Fget (item
, Qmenu_enable
);
7627 if (!NILP (Venable_disabled_menus_and_buttons
))
7628 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7629 else if (!NILP (tem
))
7630 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, tem
);
7633 else if (EQ (item_string
, Qmenu_item
) && CONSP (item
))
7635 /* New format menu item. */
7636 ASET (item_properties
, ITEM_PROPERTY_NAME
, XCAR (item
));
7637 start
= XCDR (item
);
7640 /* We have a real binding. */
7641 ASET (item_properties
, ITEM_PROPERTY_DEF
, XCAR (start
));
7643 item
= XCDR (start
);
7644 /* Is there an obsolete cache list with key equivalences. */
7645 if (CONSP (item
) && CONSP (XCAR (item
)))
7648 /* Parse properties. */
7649 while (CONSP (item
) && CONSP (XCDR (item
)))
7654 if (EQ (tem
, QCenable
))
7656 if (!NILP (Venable_disabled_menus_and_buttons
))
7657 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7659 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, XCAR (item
));
7661 else if (EQ (tem
, QCvisible
))
7663 /* If got a visible property and that evaluates to nil
7664 then ignore this item. */
7665 tem
= menu_item_eval_property (XCAR (item
));
7669 else if (EQ (tem
, QChelp
))
7670 ASET (item_properties
, ITEM_PROPERTY_HELP
, XCAR (item
));
7671 else if (EQ (tem
, QCfilter
))
7673 else if (EQ (tem
, QCkey_sequence
))
7676 if (SYMBOLP (tem
) || STRINGP (tem
) || VECTORP (tem
))
7677 /* Be GC protected. Set keyhint to item instead of tem. */
7680 else if (EQ (tem
, QCkeys
))
7683 if (CONSP (tem
) || STRINGP (tem
))
7684 ASET (item_properties
, ITEM_PROPERTY_KEYEQ
, tem
);
7686 else if (EQ (tem
, QCbutton
) && CONSP (XCAR (item
)))
7691 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
7693 ASET (item_properties
, ITEM_PROPERTY_SELECTED
,
7695 ASET (item_properties
, ITEM_PROPERTY_TYPE
, type
);
7701 else if (inmenubar
|| !NILP (start
))
7705 return 0; /* not a menu item */
7707 /* If item string is not a string, evaluate it to get string.
7708 If we don't get a string, skip this item. */
7709 item_string
= AREF (item_properties
, ITEM_PROPERTY_NAME
);
7710 if (!(STRINGP (item_string
)))
7712 item_string
= menu_item_eval_property (item_string
);
7713 if (!STRINGP (item_string
))
7715 ASET (item_properties
, ITEM_PROPERTY_NAME
, item_string
);
7718 /* If got a filter apply it on definition. */
7719 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7722 def
= menu_item_eval_property (list2 (XCAR (filter
),
7723 list2 (Qquote
, def
)));
7725 ASET (item_properties
, ITEM_PROPERTY_DEF
, def
);
7728 /* Enable or disable selection of item. */
7729 tem
= AREF (item_properties
, ITEM_PROPERTY_ENABLE
);
7732 tem
= menu_item_eval_property (tem
);
7733 if (inmenubar
&& NILP (tem
))
7734 return 0; /* Ignore disabled items in menu bar. */
7735 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, tem
);
7738 /* If we got no definition, this item is just unselectable text which
7739 is OK in a submenu but not in the menubar. */
7741 return (!inmenubar
);
7743 /* See if this is a separate pane or a submenu. */
7744 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7745 tem
= get_keymap (def
, 0, 1);
7746 /* For a subkeymap, just record its details and exit. */
7749 ASET (item_properties
, ITEM_PROPERTY_MAP
, tem
);
7750 ASET (item_properties
, ITEM_PROPERTY_DEF
, tem
);
7754 /* At the top level in the menu bar, do likewise for commands also.
7755 The menu bar does not display equivalent key bindings anyway.
7756 ITEM_PROPERTY_DEF is already set up properly. */
7760 { /* This is a command. See if there is an equivalent key binding. */
7761 Lisp_Object keyeq
= AREF (item_properties
, ITEM_PROPERTY_KEYEQ
);
7763 /* The previous code preferred :key-sequence to :keys, so we
7764 preserve this behavior. */
7765 if (STRINGP (keyeq
) && !CONSP (keyhint
))
7766 keyeq
= concat2 (build_string (" "), Fsubstitute_command_keys (keyeq
));
7769 Lisp_Object prefix
= keyeq
;
7770 Lisp_Object keys
= Qnil
;
7774 def
= XCAR (prefix
);
7775 prefix
= XCDR (prefix
);
7778 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7780 if (CONSP (keyhint
) && !NILP (XCAR (keyhint
)))
7782 keys
= XCAR (keyhint
);
7783 tem
= Fkey_binding (keys
, Qnil
, Qnil
, Qnil
);
7785 /* We have a suggested key. Is it bound to the command? */
7788 /* If the command is an alias for another
7789 (such as lmenu.el set it up), check if the
7790 original command matches the cached command. */
7792 && EQ (tem
, XSYMBOL (def
)->function
))))
7797 keys
= Fwhere_is_internal (def
, Qnil
, Qt
, Qnil
, Qnil
);
7801 tem
= Fkey_description (keys
, Qnil
);
7804 if (STRINGP (XCAR (prefix
)))
7805 tem
= concat2 (XCAR (prefix
), tem
);
7806 if (STRINGP (XCDR (prefix
)))
7807 tem
= concat2 (tem
, XCDR (prefix
));
7809 keyeq
= concat2 (build_string (" "), tem
);
7810 /* keyeq = concat3(build_string(" ("),tem,build_string(")")); */
7816 /* If we have an equivalent key binding, use that. */
7817 ASET (item_properties
, ITEM_PROPERTY_KEYEQ
, keyeq
);
7820 /* Include this when menu help is implemented.
7821 tem = XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP];
7822 if (!(NILP (tem) || STRINGP (tem)))
7824 tem = menu_item_eval_property (tem);
7827 XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP] = tem;
7831 /* Handle radio buttons or toggle boxes. */
7832 tem
= AREF (item_properties
, ITEM_PROPERTY_SELECTED
);
7834 ASET (item_properties
, ITEM_PROPERTY_SELECTED
,
7835 menu_item_eval_property (tem
));
7842 /***********************************************************************
7844 ***********************************************************************/
7846 /* A vector holding tool bar items while they are parsed in function
7847 tool_bar_items. Each item occupies TOOL_BAR_ITEM_NSCLOTS elements
7850 static Lisp_Object tool_bar_items_vector
;
7852 /* A vector holding the result of parse_tool_bar_item. Layout is like
7853 the one for a single item in tool_bar_items_vector. */
7855 static Lisp_Object tool_bar_item_properties
;
7857 /* Next free index in tool_bar_items_vector. */
7859 static int ntool_bar_items
;
7861 /* The symbols `:image' and `:rtl'. */
7863 static Lisp_Object QCimage
;
7864 static Lisp_Object QCrtl
;
7866 /* Function prototypes. */
7868 static void init_tool_bar_items (Lisp_Object
);
7869 static void process_tool_bar_item (Lisp_Object
, Lisp_Object
, Lisp_Object
, void*);
7870 static bool parse_tool_bar_item (Lisp_Object
, Lisp_Object
);
7871 static void append_tool_bar_item (void);
7874 /* Return a vector of tool bar items for keymaps currently in effect.
7875 Reuse vector REUSE if non-nil. Return in *NITEMS the number of
7876 tool bar items found. */
7879 tool_bar_items (Lisp_Object reuse
, int *nitems
)
7888 /* In order to build the menus, we need to call the keymap
7889 accessors. They all call QUIT. But this function is called
7890 during redisplay, during which a quit is fatal. So inhibit
7891 quitting while building the menus. We do this instead of
7892 specbind because (1) errors will clear it anyway and (2) this
7893 avoids risk of specpdl overflow. */
7894 oquit
= Vinhibit_quit
;
7897 /* Initialize tool_bar_items_vector and protect it from GC. */
7898 init_tool_bar_items (reuse
);
7900 /* Build list of keymaps in maps. Set nmaps to the number of maps
7903 /* Should overriding-terminal-local-map and overriding-local-map apply? */
7904 if (!NILP (Voverriding_local_map_menu_flag
))
7906 /* Yes, use them (if non-nil) as well as the global map. */
7907 maps
= alloca (3 * sizeof *maps
);
7909 if (!NILP (KVAR (current_kboard
, Voverriding_terminal_local_map
)))
7910 maps
[nmaps
++] = KVAR (current_kboard
, Voverriding_terminal_local_map
);
7911 if (!NILP (Voverriding_local_map
))
7912 maps
[nmaps
++] = Voverriding_local_map
;
7916 /* No, so use major and minor mode keymaps and keymap property.
7917 Note that tool-bar bindings in the local-map and keymap
7918 properties may not work reliable, as they are only
7919 recognized when the tool-bar (or mode-line) is updated,
7920 which does not normally happen after every command. */
7923 nminor
= current_minor_maps (NULL
, &tmaps
);
7924 maps
= alloca ((nminor
+ 3) * sizeof *maps
);
7926 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
7927 maps
[nmaps
++] = tem
;
7928 memcpy (maps
+ nmaps
, tmaps
, nminor
* sizeof (maps
[0]));
7930 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
7933 /* Add global keymap at the end. */
7934 maps
[nmaps
++] = current_global_map
;
7936 /* Process maps in reverse order and look up in each map the prefix
7938 for (i
= nmaps
- 1; i
>= 0; --i
)
7939 if (!NILP (maps
[i
]))
7943 keymap
= get_keymap (access_keymap (maps
[i
], Qtool_bar
, 1, 0, 1), 0, 1);
7945 map_keymap (keymap
, process_tool_bar_item
, Qnil
, NULL
, 1);
7948 Vinhibit_quit
= oquit
;
7949 *nitems
= ntool_bar_items
/ TOOL_BAR_ITEM_NSLOTS
;
7950 return tool_bar_items_vector
;
7954 /* Process the definition of KEY which is DEF. */
7957 process_tool_bar_item (Lisp_Object key
, Lisp_Object def
, Lisp_Object data
, void *args
)
7960 struct gcpro gcpro1
, gcpro2
;
7962 /* Protect KEY and DEF from GC because parse_tool_bar_item may call
7966 if (EQ (def
, Qundefined
))
7968 /* If a map has an explicit `undefined' as definition,
7969 discard any previously made item. */
7970 for (i
= 0; i
< ntool_bar_items
; i
+= TOOL_BAR_ITEM_NSLOTS
)
7972 Lisp_Object
*v
= XVECTOR (tool_bar_items_vector
)->contents
+ i
;
7974 if (EQ (key
, v
[TOOL_BAR_ITEM_KEY
]))
7976 if (ntool_bar_items
> i
+ TOOL_BAR_ITEM_NSLOTS
)
7977 memmove (v
, v
+ TOOL_BAR_ITEM_NSLOTS
,
7978 ((ntool_bar_items
- i
- TOOL_BAR_ITEM_NSLOTS
)
7980 ntool_bar_items
-= TOOL_BAR_ITEM_NSLOTS
;
7985 else if (parse_tool_bar_item (key
, def
))
7986 /* Append a new tool bar item to tool_bar_items_vector. Accept
7987 more than one definition for the same key. */
7988 append_tool_bar_item ();
7993 /* Access slot with index IDX of vector tool_bar_item_properties. */
7994 #define PROP(IDX) AREF (tool_bar_item_properties, (IDX))
7996 set_prop (ptrdiff_t idx
, Lisp_Object val
)
7998 ASET (tool_bar_item_properties
, idx
, val
);
8002 /* Parse a tool bar item specification ITEM for key KEY and return the
8003 result in tool_bar_item_properties. Value is false if ITEM is
8006 ITEM is a list `(menu-item CAPTION BINDING PROPS...)'.
8008 CAPTION is the caption of the item, If it's not a string, it is
8009 evaluated to get a string.
8011 BINDING is the tool bar item's binding. Tool-bar items with keymaps
8012 as binding are currently ignored.
8014 The following properties are recognized:
8018 FORM is evaluated and specifies whether the tool bar item is
8019 enabled or disabled.
8023 FORM is evaluated and specifies whether the tool bar item is visible.
8025 - `:filter FUNCTION'
8027 FUNCTION is invoked with one parameter `(quote BINDING)'. Its
8028 result is stored as the new binding.
8030 - `:button (TYPE SELECTED)'
8032 TYPE must be one of `:radio' or `:toggle'. SELECTED is evaluated
8033 and specifies whether the button is selected (pressed) or not.
8037 IMAGES is either a single image specification or a vector of four
8038 image specifications. See enum tool_bar_item_images.
8040 - `:help HELP-STRING'.
8042 Gives a help string to display for the tool bar item.
8044 - `:label LABEL-STRING'.
8046 A text label to show with the tool bar button if labels are enabled. */
8049 parse_tool_bar_item (Lisp_Object key
, Lisp_Object item
)
8051 Lisp_Object filter
= Qnil
;
8052 Lisp_Object caption
;
8054 bool have_label
= 0;
8056 /* Definition looks like `(menu-item CAPTION BINDING PROPS...)'.
8057 Rule out items that aren't lists, don't start with
8058 `menu-item' or whose rest following `tool-bar-item' is not a
8063 /* As an exception, allow old-style menu separators. */
8064 if (STRINGP (XCAR (item
)))
8065 item
= Fcons (XCAR (item
), Qnil
);
8066 else if (!EQ (XCAR (item
), Qmenu_item
)
8067 || (item
= XCDR (item
), !CONSP (item
)))
8070 /* Create tool_bar_item_properties vector if necessary. Reset it to
8072 if (VECTORP (tool_bar_item_properties
))
8074 for (i
= 0; i
< TOOL_BAR_ITEM_NSLOTS
; ++i
)
8078 tool_bar_item_properties
8079 = Fmake_vector (make_number (TOOL_BAR_ITEM_NSLOTS
), Qnil
);
8082 set_prop (TOOL_BAR_ITEM_KEY
, key
);
8083 set_prop (TOOL_BAR_ITEM_ENABLED_P
, Qt
);
8085 /* Get the caption of the item. If the caption is not a string,
8086 evaluate it to get a string. If we don't get a string, skip this
8088 caption
= XCAR (item
);
8089 if (!STRINGP (caption
))
8091 caption
= menu_item_eval_property (caption
);
8092 if (!STRINGP (caption
))
8095 set_prop (TOOL_BAR_ITEM_CAPTION
, caption
);
8097 /* If the rest following the caption is not a list, the menu item is
8098 either a separator, or invalid. */
8102 if (menu_separator_name_p (SSDATA (caption
)))
8104 set_prop (TOOL_BAR_ITEM_TYPE
, Qt
);
8105 #if !defined (USE_GTK) && !defined (HAVE_NS)
8106 /* If we use build_desired_tool_bar_string to render the
8107 tool bar, the separator is rendered as an image. */
8108 PROP (TOOL_BAR_ITEM_IMAGES
)
8109 = menu_item_eval_property (Vtool_bar_separator_image_expression
);
8110 PROP (TOOL_BAR_ITEM_ENABLED_P
) = Qnil
;
8111 PROP (TOOL_BAR_ITEM_SELECTED_P
) = Qnil
;
8112 PROP (TOOL_BAR_ITEM_CAPTION
) = Qnil
;
8119 /* Store the binding. */
8120 set_prop (TOOL_BAR_ITEM_BINDING
, XCAR (item
));
8123 /* Ignore cached key binding, if any. */
8124 if (CONSP (item
) && CONSP (XCAR (item
)))
8127 /* Process the rest of the properties. */
8128 for (; CONSP (item
) && CONSP (XCDR (item
)); item
= XCDR (XCDR (item
)))
8130 Lisp_Object ikey
, value
;
8133 value
= XCAR (XCDR (item
));
8135 if (EQ (ikey
, QCenable
))
8137 /* `:enable FORM'. */
8138 if (!NILP (Venable_disabled_menus_and_buttons
))
8139 set_prop (TOOL_BAR_ITEM_ENABLED_P
, Qt
);
8141 set_prop (TOOL_BAR_ITEM_ENABLED_P
, value
);
8143 else if (EQ (ikey
, QCvisible
))
8145 /* `:visible FORM'. If got a visible property and that
8146 evaluates to nil then ignore this item. */
8147 if (NILP (menu_item_eval_property (value
)))
8150 else if (EQ (ikey
, QChelp
))
8151 /* `:help HELP-STRING'. */
8152 set_prop (TOOL_BAR_ITEM_HELP
, value
);
8153 else if (EQ (ikey
, QCvert_only
))
8154 /* `:vert-only t/nil'. */
8155 set_prop (TOOL_BAR_ITEM_VERT_ONLY
, value
);
8156 else if (EQ (ikey
, QClabel
))
8158 const char *bad_label
= "!!?GARBLED ITEM?!!";
8159 /* `:label LABEL-STRING'. */
8160 set_prop (TOOL_BAR_ITEM_LABEL
,
8161 STRINGP (value
) ? value
: build_string (bad_label
));
8164 else if (EQ (ikey
, QCfilter
))
8165 /* ':filter FORM'. */
8167 else if (EQ (ikey
, QCbutton
) && CONSP (value
))
8169 /* `:button (TYPE . SELECTED)'. */
8170 Lisp_Object type
, selected
;
8172 type
= XCAR (value
);
8173 selected
= XCDR (value
);
8174 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
8176 set_prop (TOOL_BAR_ITEM_SELECTED_P
, selected
);
8177 set_prop (TOOL_BAR_ITEM_TYPE
, type
);
8180 else if (EQ (ikey
, QCimage
)
8182 || (VECTORP (value
) && ASIZE (value
) == 4)))
8183 /* Value is either a single image specification or a vector
8184 of 4 such specifications for the different button states. */
8185 set_prop (TOOL_BAR_ITEM_IMAGES
, value
);
8186 else if (EQ (ikey
, QCrtl
))
8188 set_prop (TOOL_BAR_ITEM_RTL_IMAGE
, value
);
8194 /* Try to make one from caption and key. */
8195 Lisp_Object tkey
= PROP (TOOL_BAR_ITEM_KEY
);
8196 Lisp_Object tcapt
= PROP (TOOL_BAR_ITEM_CAPTION
);
8197 const char *label
= SYMBOLP (tkey
) ? SSDATA (SYMBOL_NAME (tkey
)) : "";
8198 const char *capt
= STRINGP (tcapt
) ? SSDATA (tcapt
) : "";
8200 2 * max (0, min (tool_bar_max_label_size
, STRING_BYTES_BOUND
/ 2));
8201 char *buf
= xmalloc (max_lbl
+ 1);
8202 Lisp_Object new_lbl
;
8203 ptrdiff_t caption_len
= strlen (capt
);
8205 if (caption_len
<= max_lbl
&& capt
[0] != '\0')
8208 while (caption_len
> 0 && buf
[caption_len
- 1] == '.')
8210 buf
[caption_len
] = '\0';
8214 if (strlen (label
) <= max_lbl
&& label
[0] != '\0')
8218 strcpy (buf
, label
);
8220 for (j
= 0; buf
[j
] != '\0'; ++j
)
8228 new_lbl
= Fupcase_initials (build_string (label
));
8229 if (SCHARS (new_lbl
) <= tool_bar_max_label_size
)
8230 set_prop (TOOL_BAR_ITEM_LABEL
, new_lbl
);
8232 set_prop (TOOL_BAR_ITEM_LABEL
, empty_unibyte_string
);
8236 /* If got a filter apply it on binding. */
8238 set_prop (TOOL_BAR_ITEM_BINDING
,
8239 (menu_item_eval_property
8242 PROP (TOOL_BAR_ITEM_BINDING
))))));
8244 /* See if the binding is a keymap. Give up if it is. */
8245 if (CONSP (get_keymap (PROP (TOOL_BAR_ITEM_BINDING
), 0, 1)))
8248 /* Enable or disable selection of item. */
8249 if (!EQ (PROP (TOOL_BAR_ITEM_ENABLED_P
), Qt
))
8250 set_prop (TOOL_BAR_ITEM_ENABLED_P
,
8251 menu_item_eval_property (PROP (TOOL_BAR_ITEM_ENABLED_P
)));
8253 /* Handle radio buttons or toggle boxes. */
8254 if (!NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
)))
8255 set_prop (TOOL_BAR_ITEM_SELECTED_P
,
8256 menu_item_eval_property (PROP (TOOL_BAR_ITEM_SELECTED_P
)));
8264 /* Initialize tool_bar_items_vector. REUSE, if non-nil, is a vector
8265 that can be reused. */
8268 init_tool_bar_items (Lisp_Object reuse
)
8270 if (VECTORP (reuse
))
8271 tool_bar_items_vector
= reuse
;
8273 tool_bar_items_vector
= Fmake_vector (make_number (64), Qnil
);
8274 ntool_bar_items
= 0;
8278 /* Append parsed tool bar item properties from
8279 tool_bar_item_properties */
8282 append_tool_bar_item (void)
8286 - (ASIZE (tool_bar_items_vector
) - TOOL_BAR_ITEM_NSLOTS
));
8288 /* Enlarge tool_bar_items_vector if necessary. */
8290 tool_bar_items_vector
8291 = larger_vector (tool_bar_items_vector
, incr
, -1);
8293 /* Append entries from tool_bar_item_properties to the end of
8294 tool_bar_items_vector. */
8295 vcopy (tool_bar_items_vector
, ntool_bar_items
,
8296 XVECTOR (tool_bar_item_properties
)->contents
, TOOL_BAR_ITEM_NSLOTS
);
8297 ntool_bar_items
+= TOOL_BAR_ITEM_NSLOTS
;
8304 /* Read a character using menus based on maps in the array MAPS.
8305 NMAPS is the length of MAPS. Return nil if there are no menus in the maps.
8306 Return t if we displayed a menu but the user rejected it.
8308 PREV_EVENT is the previous input event, or nil if we are reading
8309 the first event of a key sequence.
8311 If USED_MOUSE_MENU is non-null, set *USED_MOUSE_MENU to true
8312 if we used a mouse menu to read the input, or false otherwise. If
8313 USED_MOUSE_MENU is null, don't dereference it.
8315 The prompting is done based on the prompt-string of the map
8316 and the strings associated with various map elements.
8318 This can be done with X menus or with menus put in the minibuf.
8319 These are done in different ways, depending on how the input will be read.
8320 Menus using X are done after auto-saving in read-char, getting the input
8321 event from Fx_popup_menu; menus using the minibuf use read_char recursively
8322 and do auto-saving in the inner call of read_char. */
8325 read_char_x_menu_prompt (ptrdiff_t nmaps
, Lisp_Object
*maps
,
8326 Lisp_Object prev_event
, bool *used_mouse_menu
)
8332 if (used_mouse_menu
)
8333 *used_mouse_menu
= 0;
8335 /* Use local over global Menu maps */
8337 if (! menu_prompting
)
8340 /* Optionally disregard all but the global map. */
8341 if (inhibit_local_menu_bar_menus
)
8343 maps
+= (nmaps
- 1);
8348 /* If we got to this point via a mouse click,
8349 use a real menu for mouse selection. */
8350 if (EVENT_HAS_PARAMETERS (prev_event
)
8351 && !EQ (XCAR (prev_event
), Qmenu_bar
)
8352 && !EQ (XCAR (prev_event
), Qtool_bar
))
8354 /* Display the menu and get the selection. */
8355 Lisp_Object
*realmaps
= alloca (nmaps
* sizeof *realmaps
);
8357 ptrdiff_t nmaps1
= 0;
8359 /* Use the maps that are not nil. */
8360 for (mapno
= 0; mapno
< nmaps
; mapno
++)
8361 if (!NILP (maps
[mapno
]))
8362 realmaps
[nmaps1
++] = maps
[mapno
];
8364 value
= Fx_popup_menu (prev_event
, Flist (nmaps1
, realmaps
));
8369 record_menu_key (XCAR (value
));
8371 /* If we got multiple events, unread all but
8373 There is no way to prevent those unread events
8374 from showing up later in last_nonmenu_event.
8375 So turn symbol and integer events into lists,
8376 to indicate that they came from a mouse menu,
8377 so that when present in last_nonmenu_event
8378 they won't confuse things. */
8379 for (tem
= XCDR (value
); CONSP (tem
); tem
= XCDR (tem
))
8381 record_menu_key (XCAR (tem
));
8382 if (SYMBOLP (XCAR (tem
))
8383 || INTEGERP (XCAR (tem
)))
8384 XSETCAR (tem
, Fcons (XCAR (tem
), Qdisabled
));
8387 /* If we got more than one event, put all but the first
8388 onto this list to be read later.
8389 Return just the first event now. */
8390 Vunread_command_events
8391 = nconc2 (XCDR (value
), Vunread_command_events
);
8392 value
= XCAR (value
);
8394 else if (NILP (value
))
8396 if (used_mouse_menu
)
8397 *used_mouse_menu
= 1;
8400 #endif /* HAVE_MENUS */
8404 /* Buffer in use so far for the minibuf prompts for menu keymaps.
8405 We make this bigger when necessary, and never free it. */
8406 static char *read_char_minibuf_menu_text
;
8407 /* Size of that buffer. */
8408 static ptrdiff_t read_char_minibuf_menu_width
;
8411 read_char_minibuf_menu_prompt (int commandflag
,
8412 ptrdiff_t nmaps
, Lisp_Object
*maps
)
8415 register Lisp_Object name
;
8417 /* FIXME: Use the minibuffer's frame width. */
8418 ptrdiff_t width
= FRAME_COLS (SELECTED_FRAME ()) - 4;
8420 bool nobindings
= 1;
8421 Lisp_Object rest
, vector
;
8427 if (! menu_prompting
)
8430 /* Get the menu name from the first map that has one (a prompt string). */
8431 for (mapno
= 0; mapno
< nmaps
; mapno
++)
8433 name
= Fkeymap_prompt (maps
[mapno
]);
8438 /* If we don't have any menus, just read a character normally. */
8439 if (!STRINGP (name
))
8442 /* Make sure we have a big enough buffer for the menu text. */
8443 width
= max (width
, SBYTES (name
));
8444 if (STRING_BYTES_BOUND
- 4 < width
)
8445 memory_full (SIZE_MAX
);
8446 if (width
+ 4 > read_char_minibuf_menu_width
)
8448 read_char_minibuf_menu_text
8449 = xrealloc (read_char_minibuf_menu_text
, width
+ 4);
8450 read_char_minibuf_menu_width
= width
+ 4;
8452 menu
= read_char_minibuf_menu_text
;
8454 /* Prompt string always starts with map's prompt, and a space. */
8455 strcpy (menu
, SSDATA (name
));
8456 nlength
= SBYTES (name
);
8457 menu
[nlength
++] = ':';
8458 menu
[nlength
++] = ' ';
8461 /* Start prompting at start of first map. */
8465 /* Present the documented bindings, a line at a time. */
8469 ptrdiff_t i
= nlength
;
8471 Lisp_Object orig_defn_macro
;
8473 /* Loop over elements of map. */
8478 /* If reached end of map, start at beginning of next map. */
8482 /* At end of last map, wrap around to first map if just starting,
8483 or end this line if already have something on it. */
8487 if (notfirst
|| nobindings
) break;
8492 /* Look at the next element of the map. */
8494 elt
= AREF (vector
, idx
);
8496 elt
= Fcar_safe (rest
);
8498 if (idx
< 0 && VECTORP (elt
))
8500 /* If we found a dense table in the keymap,
8501 advanced past it, but start scanning its contents. */
8502 rest
= Fcdr_safe (rest
);
8508 /* An ordinary element. */
8509 Lisp_Object event
, tem
;
8513 event
= Fcar_safe (elt
); /* alist */
8514 elt
= Fcdr_safe (elt
);
8518 XSETINT (event
, idx
); /* vector */
8521 /* Ignore the element if it has no prompt string. */
8522 if (INTEGERP (event
) && parse_menu_item (elt
, -1))
8524 /* True if the char to type matches the string. */
8526 Lisp_Object upcased_event
, downcased_event
;
8527 Lisp_Object desc
= Qnil
;
8529 = AREF (item_properties
, ITEM_PROPERTY_NAME
);
8531 upcased_event
= Fupcase (event
);
8532 downcased_event
= Fdowncase (event
);
8533 char_matches
= (XINT (upcased_event
) == SREF (s
, 0)
8534 || XINT (downcased_event
) == SREF (s
, 0));
8536 desc
= Fsingle_key_description (event
, Qnil
);
8538 #if 0 /* It is redundant to list the equivalent key bindings because
8539 the prefix is what the user has already typed. */
8541 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_KEYEQ
];
8543 /* Insert equivalent keybinding. */
8544 s
= concat2 (s
, tem
);
8547 = AREF (item_properties
, ITEM_PROPERTY_TYPE
);
8548 if (EQ (tem
, QCradio
) || EQ (tem
, QCtoggle
))
8550 /* Insert button prefix. */
8551 Lisp_Object selected
8552 = AREF (item_properties
, ITEM_PROPERTY_SELECTED
);
8553 if (EQ (tem
, QCradio
))
8554 tem
= build_string (NILP (selected
) ? "(*) " : "( ) ");
8556 tem
= build_string (NILP (selected
) ? "[X] " : "[ ] ");
8557 s
= concat2 (tem
, s
);
8561 /* If we have room for the prompt string, add it to this line.
8562 If this is the first on the line, always add it. */
8563 if ((SCHARS (s
) + i
+ 2
8564 + (char_matches
? 0 : SCHARS (desc
) + 3))
8568 ptrdiff_t thiswidth
;
8570 /* Punctuate between strings. */
8573 strcpy (menu
+ i
, ", ");
8579 /* If the char to type doesn't match the string's
8580 first char, explicitly show what char to type. */
8583 /* Add as much of string as fits. */
8584 thiswidth
= min (SCHARS (desc
), width
- i
);
8585 memcpy (menu
+ i
, SDATA (desc
), thiswidth
);
8587 strcpy (menu
+ i
, " = ");
8591 /* Add as much of string as fits. */
8592 thiswidth
= min (SCHARS (s
), width
- i
);
8593 memcpy (menu
+ i
, SDATA (s
), thiswidth
);
8599 /* If this element does not fit, end the line now,
8600 and save the element for the next line. */
8601 strcpy (menu
+ i
, "...");
8606 /* Move past this element. */
8607 if (idx
>= 0 && idx
+ 1 >= ASIZE (vector
))
8608 /* Handle reaching end of dense table. */
8613 rest
= Fcdr_safe (rest
);
8617 /* Prompt with that and read response. */
8618 message2_nolog (menu
, strlen (menu
),
8619 ! NILP (BVAR (current_buffer
, enable_multibyte_characters
)));
8621 /* Make believe its not a keyboard macro in case the help char
8622 is pressed. Help characters are not recorded because menu prompting
8623 is not used on replay.
8625 orig_defn_macro
= KVAR (current_kboard
, defining_kbd_macro
);
8626 kset_defining_kbd_macro (current_kboard
, Qnil
);
8628 obj
= read_char (commandflag
, 0, 0, Qt
, 0, NULL
);
8629 while (BUFFERP (obj
));
8630 kset_defining_kbd_macro (current_kboard
, orig_defn_macro
);
8632 if (!INTEGERP (obj
))
8634 else if (XINT (obj
) == -2)
8637 if (! EQ (obj
, menu_prompt_more_char
)
8638 && (!INTEGERP (menu_prompt_more_char
)
8639 || ! EQ (obj
, make_number (Ctl (XINT (menu_prompt_more_char
))))))
8641 if (!NILP (KVAR (current_kboard
, defining_kbd_macro
)))
8642 store_kbd_macro_char (obj
);
8645 /* Help char - go round again */
8649 /* Reading key sequences. */
8651 /* Follow KEY in the maps in CURRENT[0..NMAPS-1], placing its bindings
8652 in DEFS[0..NMAPS-1]. Set NEXT[i] to DEFS[i] if DEFS[i] is a
8653 keymap, or nil otherwise. Return the index of the first keymap in
8654 which KEY has any binding, or NMAPS if no map has a binding.
8656 If KEY is a meta ASCII character, treat it like meta-prefix-char
8657 followed by the corresponding non-meta character. Keymaps in
8658 CURRENT with non-prefix bindings for meta-prefix-char become nil in
8661 If KEY has no bindings in any of the CURRENT maps, NEXT is left
8664 NEXT may be the same array as CURRENT. */
8667 follow_key (Lisp_Object key
, ptrdiff_t nmaps
, Lisp_Object
*current
,
8668 Lisp_Object
*defs
, Lisp_Object
*next
)
8670 ptrdiff_t i
, first_binding
;
8672 first_binding
= nmaps
;
8673 for (i
= nmaps
- 1; i
>= 0; i
--)
8675 if (! NILP (current
[i
]))
8677 defs
[i
] = access_keymap (current
[i
], key
, 1, 0, 1);
8678 if (! NILP (defs
[i
]))
8685 /* Given the set of bindings we've found, produce the next set of maps. */
8686 if (first_binding
< nmaps
)
8687 for (i
= 0; i
< nmaps
; i
++)
8688 next
[i
] = NILP (defs
[i
]) ? Qnil
: get_keymap (defs
[i
], 0, 1);
8690 return first_binding
;
8693 /* Structure used to keep track of partial application of key remapping
8694 such as Vfunction_key_map and Vkey_translation_map. */
8695 typedef struct keyremap
8697 /* This is the map originally specified for this use. */
8699 /* This is a submap reached by looking up, in PARENT,
8700 the events from START to END. */
8702 /* Positions [START, END) in the key sequence buffer
8703 are the key that we have scanned so far.
8704 Those events are the ones that we will replace
8705 if PARENT maps them into a key sequence. */
8709 /* Lookup KEY in MAP.
8710 MAP is a keymap mapping keys to key vectors or functions.
8711 If the mapping is a function and DO_FUNCALL is true,
8712 the function is called with PROMPT as parameter and its return
8713 value is used as the return value of this function (after checking
8714 that it is indeed a vector). */
8717 access_keymap_keyremap (Lisp_Object map
, Lisp_Object key
, Lisp_Object prompt
,
8722 next
= access_keymap (map
, key
, 1, 0, 1);
8724 /* Handle a symbol whose function definition is a keymap
8726 if (SYMBOLP (next
) && !NILP (Ffboundp (next
))
8727 && (ARRAYP (XSYMBOL (next
)->function
)
8728 || KEYMAPP (XSYMBOL (next
)->function
)))
8729 next
= Fautoload_do_load (XSYMBOL (next
)->function
, next
, Qnil
);
8731 /* If the keymap gives a function, not an
8732 array, then call the function with one arg and use
8733 its value instead. */
8734 if (do_funcall
&& FUNCTIONP (next
))
8739 next
= call1 (next
, prompt
);
8740 /* If the function returned something invalid,
8741 barf--don't ignore it.
8742 (To ignore it safely, we would need to gcpro a bunch of
8743 other variables.) */
8744 if (! (VECTORP (next
) || STRINGP (next
)))
8745 error ("Function %s returns invalid key sequence",
8746 SSDATA (SYMBOL_NAME (tem
)));
8751 /* Do one step of the key remapping used for function-key-map and
8752 key-translation-map:
8753 KEYBUF is the buffer holding the input events.
8754 BUFSIZE is its maximum size.
8755 FKEY is a pointer to the keyremap structure to use.
8756 INPUT is the index of the last element in KEYBUF.
8757 DOIT if true says that the remapping can actually take place.
8758 DIFF is used to return the number of keys added/removed by the remapping.
8759 PARENT is the root of the keymap.
8760 PROMPT is the prompt to use if the remapping happens through a function.
8761 Return true if the remapping actually took place. */
8764 keyremap_step (Lisp_Object
*keybuf
, int bufsize
, volatile keyremap
*fkey
,
8765 int input
, bool doit
, int *diff
, Lisp_Object prompt
)
8767 Lisp_Object next
, key
;
8769 key
= keybuf
[fkey
->end
++];
8771 if (KEYMAPP (fkey
->parent
))
8772 next
= access_keymap_keyremap (fkey
->map
, key
, prompt
, doit
);
8776 /* If keybuf[fkey->start..fkey->end] is bound in the
8777 map and we're in a position to do the key remapping, replace it with
8778 the binding and restart with fkey->start at the end. */
8779 if ((VECTORP (next
) || STRINGP (next
)) && doit
)
8781 int len
= XFASTINT (Flength (next
));
8784 *diff
= len
- (fkey
->end
- fkey
->start
);
8786 if (bufsize
- input
<= *diff
)
8787 error ("Key sequence too long");
8789 /* Shift the keys that follow fkey->end. */
8791 for (i
= fkey
->end
; i
< input
; i
++)
8792 keybuf
[i
+ *diff
] = keybuf
[i
];
8794 for (i
= input
- 1; i
>= fkey
->end
; i
--)
8795 keybuf
[i
+ *diff
] = keybuf
[i
];
8796 /* Overwrite the old keys with the new ones. */
8797 for (i
= 0; i
< len
; i
++)
8798 keybuf
[fkey
->start
+ i
]
8799 = Faref (next
, make_number (i
));
8801 fkey
->start
= fkey
->end
+= *diff
;
8802 fkey
->map
= fkey
->parent
;
8807 fkey
->map
= get_keymap (next
, 0, 1);
8809 /* If we no longer have a bound suffix, try a new position for
8811 if (!CONSP (fkey
->map
))
8813 fkey
->end
= ++fkey
->start
;
8814 fkey
->map
= fkey
->parent
;
8820 test_undefined (Lisp_Object binding
)
8822 return (EQ (binding
, Qundefined
)
8823 || (!NILP (binding
) && SYMBOLP (binding
)
8824 && EQ (Fcommand_remapping (binding
, Qnil
, Qnil
), Qundefined
)));
8827 /* Read a sequence of keys that ends with a non prefix character,
8828 storing it in KEYBUF, a buffer of size BUFSIZE.
8830 Return the length of the key sequence stored.
8831 Return -1 if the user rejected a command menu.
8833 Echo starting immediately unless `prompt' is 0.
8835 Where a key sequence ends depends on the currently active keymaps.
8836 These include any minor mode keymaps active in the current buffer,
8837 the current buffer's local map, and the global map.
8839 If a key sequence has no other bindings, we check Vfunction_key_map
8840 to see if some trailing subsequence might be the beginning of a
8841 function key's sequence. If so, we try to read the whole function
8842 key, and substitute its symbolic name into the key sequence.
8844 We ignore unbound `down-' mouse clicks. We turn unbound `drag-' and
8845 `double-' events into similar click events, if that would make them
8846 bound. We try to turn `triple-' events first into `double-' events,
8849 If we get a mouse click in a mode line, vertical divider, or other
8850 non-text area, we treat the click as if it were prefixed by the
8851 symbol denoting that area - `mode-line', `vertical-line', or
8854 If the sequence starts with a mouse click, we read the key sequence
8855 with respect to the buffer clicked on, not the current buffer.
8857 If the user switches frames in the midst of a key sequence, we put
8858 off the switch-frame event until later; the next call to
8859 read_char will return it.
8861 If FIX_CURRENT_BUFFER, we restore current_buffer
8862 from the selected window's buffer. */
8865 read_key_sequence (Lisp_Object
*keybuf
, int bufsize
, Lisp_Object prompt
,
8866 bool dont_downcase_last
, bool can_return_switch_frame
,
8867 bool fix_current_buffer
)
8869 Lisp_Object from_string
;
8870 ptrdiff_t count
= SPECPDL_INDEX ();
8872 /* How many keys there are in the current key sequence. */
8875 /* The length of the echo buffer when we started reading, and
8876 the length of this_command_keys when we started reading. */
8877 ptrdiff_t echo_start
IF_LINT (= 0);
8878 ptrdiff_t keys_start
;
8880 /* The number of keymaps we're scanning right now, and the number of
8881 keymaps we have allocated space for. */
8883 ptrdiff_t nmaps_allocated
= 0;
8885 /* defs[0..nmaps-1] are the definitions of KEYBUF[0..t-1] in
8886 the current keymaps. */
8887 Lisp_Object
*defs
= NULL
;
8889 /* submaps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
8890 in the current keymaps, or nil where it is not a prefix. */
8891 Lisp_Object
*submaps
= NULL
;
8893 /* The local map to start out with at start of key sequence. */
8894 Lisp_Object orig_local_map
;
8896 /* The map from the `keymap' property to start out with at start of
8898 Lisp_Object orig_keymap
;
8900 /* Positive if we have already considered switching to the local-map property
8901 of the place where a mouse click occurred. */
8902 int localized_local_map
= 0;
8904 /* The index in submaps[] of the first keymap that has a binding for
8905 this key sequence. In other words, the lowest i such that
8906 submaps[i] is non-nil. */
8907 ptrdiff_t first_binding
;
8908 /* Index of the first key that has no binding.
8909 It is useless to try fkey.start larger than that. */
8912 /* If t < mock_input, then KEYBUF[t] should be read as the next
8915 We use this to recover after recognizing a function key. Once we
8916 realize that a suffix of the current key sequence is actually a
8917 function key's escape sequence, we replace the suffix with the
8918 function key's binding from Vfunction_key_map. Now keybuf
8919 contains a new and different key sequence, so the echo area,
8920 this_command_keys, and the submaps and defs arrays are wrong. In
8921 this situation, we set mock_input to t, set t to 0, and jump to
8922 restart_sequence; the loop will read keys from keybuf up until
8923 mock_input, thus rebuilding the state; and then it will resume
8924 reading characters from the keyboard. */
8927 /* If the sequence is unbound in submaps[], then
8928 keybuf[fkey.start..fkey.end-1] is a prefix in Vfunction_key_map,
8929 and fkey.map is its binding.
8931 These might be > t, indicating that all function key scanning
8932 should hold off until t reaches them. We do this when we've just
8933 recognized a function key, to avoid searching for the function
8934 key's again in Vfunction_key_map. */
8937 /* Likewise, for key_translation_map and input-decode-map. */
8938 keyremap keytran
, indec
;
8940 /* True if we are trying to map a key by changing an upper-case
8941 letter to lower case, or a shifted function key to an unshifted
8943 bool shift_translated
= 0;
8945 /* If we receive a `switch-frame' or `select-window' event in the middle of
8946 a key sequence, we put it off for later.
8947 While we're reading, we keep the event here. */
8948 Lisp_Object delayed_switch_frame
;
8950 /* See the comment below... */
8951 #if defined (GOBBLE_FIRST_EVENT)
8952 Lisp_Object first_event
;
8955 Lisp_Object original_uppercase
IF_LINT (= Qnil
);
8956 int original_uppercase_position
= -1;
8958 /* Gets around Microsoft compiler limitations. */
8961 struct buffer
*starting_buffer
;
8963 /* List of events for which a fake prefix key has been generated. */
8964 Lisp_Object fake_prefixed_keys
= Qnil
;
8966 #if defined (GOBBLE_FIRST_EVENT)
8970 struct gcpro gcpro1
;
8972 GCPRO1 (fake_prefixed_keys
);
8973 raw_keybuf_count
= 0;
8975 last_nonmenu_event
= Qnil
;
8977 delayed_switch_frame
= Qnil
;
8983 /* Install the string STR as the beginning of the string of
8984 echoing, so that it serves as a prompt for the next
8986 kset_echo_string (current_kboard
, prompt
);
8987 current_kboard
->echo_after_prompt
= SCHARS (prompt
);
8990 else if (cursor_in_echo_area
8991 && (FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
8992 && NILP (Fzerop (Vecho_keystrokes
)))
8993 /* This doesn't put in a dash if the echo buffer is empty, so
8994 you don't always see a dash hanging out in the minibuffer. */
8998 /* Record the initial state of the echo area and this_command_keys;
8999 we will need to restore them if we replay a key sequence. */
9001 echo_start
= echo_length ();
9002 keys_start
= this_command_key_count
;
9003 this_single_command_key_start
= keys_start
;
9005 #if defined (GOBBLE_FIRST_EVENT)
9006 /* This doesn't quite work, because some of the things that read_char
9007 does cannot safely be bypassed. It seems too risky to try to make
9010 /* Read the first char of the sequence specially, before setting
9011 up any keymaps, in case a filter runs and switches buffers on us. */
9012 first_event
= read_char (NILP (prompt
), 0, submaps
, last_nonmenu_event
,
9014 #endif /* GOBBLE_FIRST_EVENT */
9016 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
9017 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9020 /* We jump here when we need to reinitialize fkey and keytran; this
9021 happens if we switch keyboards between rescans. */
9022 replay_entire_sequence
:
9024 indec
.map
= indec
.parent
= KVAR (current_kboard
, Vinput_decode_map
);
9025 fkey
.map
= fkey
.parent
= KVAR (current_kboard
, Vlocal_function_key_map
);
9026 keytran
.map
= keytran
.parent
= Vkey_translation_map
;
9027 indec
.start
= indec
.end
= 0;
9028 fkey
.start
= fkey
.end
= 0;
9029 keytran
.start
= keytran
.end
= 0;
9031 /* We jump here when the key sequence has been thoroughly changed, and
9032 we need to rescan it starting from the beginning. When we jump here,
9033 keybuf[0..mock_input] holds the sequence we should reread. */
9036 starting_buffer
= current_buffer
;
9037 first_unbound
= bufsize
+ 1;
9039 /* Build our list of keymaps.
9040 If we recognize a function key and replace its escape sequence in
9041 keybuf with its symbol, or if the sequence starts with a mouse
9042 click and we need to switch buffers, we jump back here to rebuild
9043 the initial keymaps from the current buffer. */
9046 if (!NILP (KVAR (current_kboard
, Voverriding_terminal_local_map
)))
9048 if (2 > nmaps_allocated
)
9050 submaps
= alloca (2 * sizeof *submaps
);
9051 defs
= alloca (2 * sizeof *defs
);
9052 nmaps_allocated
= 2;
9054 submaps
[nmaps
++] = KVAR (current_kboard
, Voverriding_terminal_local_map
);
9056 else if (!NILP (Voverriding_local_map
))
9058 if (2 > nmaps_allocated
)
9060 submaps
= alloca (2 * sizeof *submaps
);
9061 defs
= alloca (2 * sizeof *defs
);
9062 nmaps_allocated
= 2;
9064 submaps
[nmaps
++] = Voverriding_local_map
;
9072 nminor
= current_minor_maps (0, &maps
);
9073 total
= nminor
+ (!NILP (orig_keymap
) ? 3 : 2);
9075 if (total
> nmaps_allocated
)
9077 submaps
= alloca (total
* sizeof *submaps
);
9078 defs
= alloca (total
* sizeof *defs
);
9079 nmaps_allocated
= total
;
9082 if (!NILP (orig_keymap
))
9083 submaps
[nmaps
++] = orig_keymap
;
9085 memcpy (submaps
+ nmaps
, maps
, nminor
* sizeof (submaps
[0]));
9089 submaps
[nmaps
++] = orig_local_map
;
9091 submaps
[nmaps
++] = current_global_map
;
9093 /* Find an accurate initial value for first_binding. */
9094 for (first_binding
= 0; first_binding
< nmaps
; first_binding
++)
9095 if (! NILP (submaps
[first_binding
]))
9098 /* Start from the beginning in keybuf. */
9101 /* These are no-ops the first time through, but if we restart, they
9102 revert the echo area and this_command_keys to their original state. */
9103 this_command_key_count
= keys_start
;
9104 if (INTERACTIVE
&& t
< mock_input
)
9105 echo_truncate (echo_start
);
9107 /* If the best binding for the current key sequence is a keymap, or
9108 we may be looking at a function key's escape sequence, keep on
9110 while (first_binding
< nmaps
9111 /* Keep reading as long as there's a prefix binding. */
9112 ? !NILP (submaps
[first_binding
])
9113 /* Don't return in the middle of a possible function key sequence,
9114 if the only bindings we found were via case conversion.
9115 Thus, if ESC O a has a function-key-map translation
9116 and ESC o has a binding, don't return after ESC O,
9117 so that we can translate ESC O plus the next character. */
9118 : (/* indec.start < t || fkey.start < t || */ keytran
.start
< t
))
9121 bool used_mouse_menu
= 0;
9123 /* Where the last real key started. If we need to throw away a
9124 key that has expanded into more than one element of keybuf
9125 (say, a mouse click on the mode line which is being treated
9126 as [mode-line (mouse-...)], then we backtrack to this point
9128 int last_real_key_start
;
9130 /* These variables are analogous to echo_start and keys_start;
9131 while those allow us to restart the entire key sequence,
9132 echo_local_start and keys_local_start allow us to throw away
9134 ptrdiff_t echo_local_start
IF_LINT (= 0);
9135 int keys_local_start
;
9136 ptrdiff_t local_first_binding
;
9138 eassert (indec
.end
== t
|| (indec
.end
> t
&& indec
.end
<= mock_input
));
9139 eassert (indec
.start
<= indec
.end
);
9140 eassert (fkey
.start
<= fkey
.end
);
9141 eassert (keytran
.start
<= keytran
.end
);
9142 /* key-translation-map is applied *after* function-key-map
9143 which is itself applied *after* input-decode-map. */
9144 eassert (fkey
.end
<= indec
.start
);
9145 eassert (keytran
.end
<= fkey
.start
);
9147 if (/* first_unbound < indec.start && first_unbound < fkey.start && */
9148 first_unbound
< keytran
.start
)
9149 { /* The prefix upto first_unbound has no binding and has
9150 no translation left to do either, so we know it's unbound.
9151 If we don't stop now, we risk staying here indefinitely
9152 (if the user keeps entering fkey or keytran prefixes
9153 like C-c ESC ESC ESC ESC ...) */
9155 for (i
= first_unbound
+ 1; i
< t
; i
++)
9156 keybuf
[i
- first_unbound
- 1] = keybuf
[i
];
9157 mock_input
= t
- first_unbound
- 1;
9158 indec
.end
= indec
.start
-= first_unbound
+ 1;
9159 indec
.map
= indec
.parent
;
9160 fkey
.end
= fkey
.start
-= first_unbound
+ 1;
9161 fkey
.map
= fkey
.parent
;
9162 keytran
.end
= keytran
.start
-= first_unbound
+ 1;
9163 keytran
.map
= keytran
.parent
;
9164 goto replay_sequence
;
9168 error ("Key sequence too long");
9171 echo_local_start
= echo_length ();
9172 keys_local_start
= this_command_key_count
;
9173 local_first_binding
= first_binding
;
9176 /* These are no-ops, unless we throw away a keystroke below and
9177 jumped back up to replay_key; in that case, these restore the
9178 variables to their original state, allowing us to replay the
9180 if (INTERACTIVE
&& t
< mock_input
)
9181 echo_truncate (echo_local_start
);
9182 this_command_key_count
= keys_local_start
;
9183 first_binding
= local_first_binding
;
9185 /* By default, assume each event is "real". */
9186 last_real_key_start
= t
;
9188 /* Does mock_input indicate that we are re-reading a key sequence? */
9192 add_command_key (key
);
9193 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
9194 && NILP (Fzerop (Vecho_keystrokes
)))
9198 /* If not, we should actually read a character. */
9202 KBOARD
*interrupted_kboard
= current_kboard
;
9203 struct frame
*interrupted_frame
= SELECTED_FRAME ();
9204 key
= read_char (NILP (prompt
), nmaps
,
9205 (Lisp_Object
*) submaps
, last_nonmenu_event
,
9206 &used_mouse_menu
, NULL
);
9207 if ((INTEGERP (key
) && XINT (key
) == -2) /* wrong_kboard_jmpbuf */
9208 /* When switching to a new tty (with a new keyboard),
9209 read_char returns the new buffer, rather than -2
9210 (Bug#5095). This is because `terminal-init-xterm'
9211 calls read-char, which eats the wrong_kboard_jmpbuf
9212 return. Any better way to fix this? -- cyd */
9213 || (interrupted_kboard
!= current_kboard
))
9218 for (k
= all_kboards
; k
; k
= k
->next_kboard
)
9219 if (k
== interrupted_kboard
)
9224 /* Don't touch interrupted_kboard when it's been
9226 delayed_switch_frame
= Qnil
;
9227 goto replay_entire_sequence
;
9230 if (!NILP (delayed_switch_frame
))
9233 (interrupted_kboard
,
9234 Fcons (delayed_switch_frame
,
9235 KVAR (interrupted_kboard
, kbd_queue
)));
9236 delayed_switch_frame
= Qnil
;
9241 (interrupted_kboard
,
9242 Fcons (keybuf
[--t
], KVAR (interrupted_kboard
, kbd_queue
)));
9244 /* If the side queue is non-empty, ensure it begins with a
9245 switch-frame, so we'll replay it in the right context. */
9246 if (CONSP (KVAR (interrupted_kboard
, kbd_queue
))
9247 && (key
= XCAR (KVAR (interrupted_kboard
, kbd_queue
)),
9248 !(EVENT_HAS_PARAMETERS (key
)
9249 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)),
9253 XSETFRAME (frame
, interrupted_frame
);
9255 (interrupted_kboard
,
9256 Fcons (make_lispy_switch_frame (frame
),
9257 KVAR (interrupted_kboard
, kbd_queue
)));
9260 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
9261 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9262 goto replay_entire_sequence
;
9266 /* read_char returns t when it shows a menu and the user rejects it.
9270 unbind_to (count
, Qnil
);
9275 /* read_char returns -1 at the end of a macro.
9276 Emacs 18 handles this by returning immediately with a
9277 zero, so that's what we'll do. */
9278 if (INTEGERP (key
) && XINT (key
) == -1)
9281 /* The Microsoft C compiler can't handle the goto that
9287 /* If the current buffer has been changed from under us, the
9288 keymap may have changed, so replay the sequence. */
9291 timer_resume_idle ();
9294 /* Reset the current buffer from the selected window
9295 in case something changed the former and not the latter.
9296 This is to be more consistent with the behavior
9297 of the command_loop_1. */
9298 if (fix_current_buffer
)
9300 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
9302 if (XBUFFER (XWINDOW (selected_window
)->buffer
) != current_buffer
)
9303 Fset_buffer (XWINDOW (selected_window
)->buffer
);
9306 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
9307 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9308 goto replay_sequence
;
9311 /* If we have a quit that was typed in another frame, and
9312 quit_throw_to_read_char switched buffers,
9313 replay to get the right keymap. */
9315 && XINT (key
) == quit_char
9316 && current_buffer
!= starting_buffer
)
9319 ASET (raw_keybuf
, raw_keybuf_count
, key
);
9324 orig_local_map
= get_local_map (PT
, current_buffer
, Qlocal_map
);
9325 orig_keymap
= get_local_map (PT
, current_buffer
, Qkeymap
);
9326 goto replay_sequence
;
9331 if (EVENT_HAS_PARAMETERS (key
)
9332 /* Either a `switch-frame' or a `select-window' event. */
9333 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)), Qswitch_frame
))
9335 /* If we're at the beginning of a key sequence, and the caller
9336 says it's okay, go ahead and return this event. If we're
9337 in the midst of a key sequence, delay it until the end. */
9338 if (t
> 0 || !can_return_switch_frame
)
9340 delayed_switch_frame
= key
;
9346 ASET (raw_keybuf
, raw_keybuf_count
, key
);
9350 /* Clicks in non-text areas get prefixed by the symbol
9351 in their CHAR-ADDRESS field. For example, a click on
9352 the mode line is prefixed by the symbol `mode-line'.
9354 Furthermore, key sequences beginning with mouse clicks
9355 are read using the keymaps of the buffer clicked on, not
9356 the current buffer. So we may have to switch the buffer
9359 When we turn one event into two events, we must make sure
9360 that neither of the two looks like the original--so that,
9361 if we replay the events, they won't be expanded again.
9362 If not for this, such reexpansion could happen either here
9363 or when user programs play with this-command-keys. */
9364 if (EVENT_HAS_PARAMETERS (key
))
9369 kind
= EVENT_HEAD_KIND (EVENT_HEAD (key
));
9370 if (EQ (kind
, Qmouse_click
))
9372 Lisp_Object window
, posn
;
9374 window
= POSN_WINDOW (EVENT_START (key
));
9375 posn
= POSN_POSN (EVENT_START (key
));
9378 || (!NILP (fake_prefixed_keys
)
9379 && !NILP (Fmemq (key
, fake_prefixed_keys
))))
9381 /* We're looking a second time at an event for which
9382 we generated a fake prefix key. Set
9383 last_real_key_start appropriately. */
9385 last_real_key_start
= t
- 1;
9388 if (last_real_key_start
== 0)
9390 /* Key sequences beginning with mouse clicks are
9391 read using the keymaps in the buffer clicked on,
9392 not the current buffer. If we're at the
9393 beginning of a key sequence, switch buffers. */
9394 if (WINDOWP (window
)
9395 && BUFFERP (XWINDOW (window
)->buffer
)
9396 && XBUFFER (XWINDOW (window
)->buffer
) != current_buffer
)
9398 ASET (raw_keybuf
, raw_keybuf_count
, key
);
9403 /* Arrange to go back to the original buffer once we're
9404 done reading the key sequence. Note that we can't
9405 use save_excursion_{save,restore} here, because they
9406 save point as well as the current buffer; we don't
9407 want to save point, because redisplay may change it,
9408 to accommodate a Fset_window_start or something. We
9409 don't want to do this at the top of the function,
9410 because we may get input from a subprocess which
9411 wants to change the selected window and stuff (say,
9413 record_unwind_current_buffer ();
9415 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
9417 set_buffer_internal (XBUFFER (XWINDOW (window
)->buffer
));
9418 orig_local_map
= get_local_map (PT
, current_buffer
,
9420 orig_keymap
= get_local_map (PT
, current_buffer
,
9422 goto replay_sequence
;
9425 /* For a mouse click, get the local text-property keymap
9426 of the place clicked on, rather than point. */
9427 if (CONSP (XCDR (key
))
9428 && ! localized_local_map
)
9430 Lisp_Object map_here
, start
, pos
;
9432 localized_local_map
= 1;
9433 start
= EVENT_START (key
);
9435 if (CONSP (start
) && POSN_INBUFFER_P (start
))
9437 pos
= POSN_BUFFER_POSN (start
);
9439 && XINT (pos
) >= BEGV
9440 && XINT (pos
) <= ZV
)
9442 map_here
= get_local_map (XINT (pos
),
9445 if (!EQ (map_here
, orig_local_map
))
9447 orig_local_map
= map_here
;
9448 ++localized_local_map
;
9451 map_here
= get_local_map (XINT (pos
),
9454 if (!EQ (map_here
, orig_keymap
))
9456 orig_keymap
= map_here
;
9457 ++localized_local_map
;
9460 if (localized_local_map
> 1)
9465 goto replay_sequence
;
9472 /* Expand mode-line and scroll-bar events into two events:
9473 use posn as a fake prefix key. */
9475 && (NILP (fake_prefixed_keys
)
9476 || NILP (Fmemq (key
, fake_prefixed_keys
))))
9478 if (bufsize
- t
<= 1)
9479 error ("Key sequence too long");
9482 keybuf
[t
+ 1] = key
;
9485 /* Record that a fake prefix key has been generated
9486 for KEY. Don't modify the event; this would
9487 prevent proper action when the event is pushed
9488 back into unread-command-events. */
9489 fake_prefixed_keys
= Fcons (key
, fake_prefixed_keys
);
9491 /* If on a mode line string with a local keymap,
9492 reconsider the key sequence with that keymap. */
9493 if (string
= POSN_STRING (EVENT_START (key
)),
9494 (CONSP (string
) && STRINGP (XCAR (string
))))
9496 Lisp_Object pos
, map
, map2
;
9498 pos
= XCDR (string
);
9499 string
= XCAR (string
);
9501 && XINT (pos
) < SCHARS (string
))
9503 map
= Fget_text_property (pos
, Qlocal_map
, string
);
9505 orig_local_map
= map
;
9506 map2
= Fget_text_property (pos
, Qkeymap
, string
);
9509 if (!NILP (map
) || !NILP (map2
))
9510 goto replay_sequence
;
9516 else if (NILP (from_string
)
9517 && (string
= POSN_STRING (EVENT_START (key
)),
9518 (CONSP (string
) && STRINGP (XCAR (string
)))))
9520 /* For a click on a string, i.e. overlay string or a
9521 string displayed via the `display' property,
9522 consider `local-map' and `keymap' properties of
9524 Lisp_Object pos
, map
, map2
;
9526 pos
= XCDR (string
);
9527 string
= XCAR (string
);
9529 && XINT (pos
) < SCHARS (string
))
9531 map
= Fget_text_property (pos
, Qlocal_map
, string
);
9533 orig_local_map
= map
;
9534 map2
= Fget_text_property (pos
, Qkeymap
, string
);
9538 if (!NILP (map
) || !NILP (map2
))
9540 from_string
= string
;
9543 goto replay_sequence
;
9548 else if (CONSP (XCDR (key
))
9549 && CONSP (EVENT_START (key
))
9550 && CONSP (XCDR (EVENT_START (key
))))
9554 posn
= POSN_POSN (EVENT_START (key
));
9555 /* Handle menu-bar events:
9556 insert the dummy prefix event `menu-bar'. */
9557 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
9559 if (bufsize
- t
<= 1)
9560 error ("Key sequence too long");
9564 /* Zap the position in key, so we know that we've
9565 expanded it, and don't try to do so again. */
9566 POSN_SET_POSN (EVENT_START (key
),
9567 Fcons (posn
, Qnil
));
9570 goto replay_sequence
;
9572 else if (CONSP (posn
))
9574 /* We're looking at the second event of a
9575 sequence which we expanded before. Set
9576 last_real_key_start appropriately. */
9577 if (last_real_key_start
== t
&& t
> 0)
9578 last_real_key_start
= t
- 1;
9583 /* We have finally decided that KEY is something we might want
9585 first_binding
= (follow_key (key
,
9586 nmaps
- first_binding
,
9587 submaps
+ first_binding
,
9588 defs
+ first_binding
,
9589 submaps
+ first_binding
)
9592 /* If KEY wasn't bound, we'll try some fallbacks. */
9593 if (first_binding
< nmaps
)
9594 /* This is needed for the following scenario:
9595 event 0: a down-event that gets dropped by calling replay_key.
9596 event 1: some normal prefix like C-h.
9597 After event 0, first_unbound is 0, after event 1 indec.start,
9598 fkey.start, and keytran.start are all 1, so when we see that
9599 C-h is bound, we need to update first_unbound. */
9600 first_unbound
= max (t
+ 1, first_unbound
);
9605 /* Remember the position to put an upper bound on indec.start. */
9606 first_unbound
= min (t
, first_unbound
);
9608 head
= EVENT_HEAD (key
);
9609 if (help_char_p (head
) && t
> 0)
9611 read_key_sequence_cmd
= Vprefix_help_command
;
9613 last_nonmenu_event
= key
;
9614 /* The Microsoft C compiler can't handle the goto that
9622 Lisp_Object breakdown
;
9625 breakdown
= parse_modifiers (head
);
9626 modifiers
= XINT (XCAR (XCDR (breakdown
)));
9627 /* Attempt to reduce an unbound mouse event to a simpler
9628 event that is bound:
9629 Drags reduce to clicks.
9630 Double-clicks reduce to clicks.
9631 Triple-clicks reduce to double-clicks, then to clicks.
9632 Down-clicks are eliminated.
9633 Double-downs reduce to downs, then are eliminated.
9634 Triple-downs reduce to double-downs, then to downs,
9635 then are eliminated. */
9636 if (modifiers
& (down_modifier
| drag_modifier
9637 | double_modifier
| triple_modifier
))
9639 while (modifiers
& (down_modifier
| drag_modifier
9640 | double_modifier
| triple_modifier
))
9642 Lisp_Object new_head
, new_click
;
9643 if (modifiers
& triple_modifier
)
9644 modifiers
^= (double_modifier
| triple_modifier
);
9645 else if (modifiers
& double_modifier
)
9646 modifiers
&= ~double_modifier
;
9647 else if (modifiers
& drag_modifier
)
9648 modifiers
&= ~drag_modifier
;
9651 /* Dispose of this `down' event by simply jumping
9652 back to replay_key, to get another event.
9654 Note that if this event came from mock input,
9655 then just jumping back to replay_key will just
9656 hand it to us again. So we have to wipe out any
9659 We could delete keybuf[t] and shift everything
9660 after that to the left by one spot, but we'd also
9661 have to fix up any variable that points into
9662 keybuf, and shifting isn't really necessary
9665 Adding prefixes for non-textual mouse clicks
9666 creates two characters of mock input, and both
9667 must be thrown away. If we're only looking at
9668 the prefix now, we can just jump back to
9669 replay_key. On the other hand, if we've already
9670 processed the prefix, and now the actual click
9671 itself is giving us trouble, then we've lost the
9672 state of the keymaps we want to backtrack to, and
9673 we need to replay the whole sequence to rebuild
9676 Beyond that, only function key expansion could
9677 create more than two keys, but that should never
9678 generate mouse events, so it's okay to zero
9679 mock_input in that case too.
9681 FIXME: The above paragraph seems just plain
9682 wrong, if you consider things like
9683 xterm-mouse-mode. -stef
9685 Isn't this just the most wonderful code ever? */
9687 /* If mock_input > t + 1, the above simplification
9688 will actually end up dropping keys on the floor.
9689 This is probably OK for now, but even
9690 if mock_input <= t + 1, we need to adjust indec,
9692 Typical case [header-line down-mouse-N]:
9693 mock_input = 2, t = 1, fkey.end = 1,
9694 last_real_key_start = 0. */
9695 if (indec
.end
> last_real_key_start
)
9697 indec
.end
= indec
.start
9698 = min (last_real_key_start
, indec
.start
);
9699 indec
.map
= indec
.parent
;
9700 if (fkey
.end
> last_real_key_start
)
9702 fkey
.end
= fkey
.start
9703 = min (last_real_key_start
, fkey
.start
);
9704 fkey
.map
= fkey
.parent
;
9705 if (keytran
.end
> last_real_key_start
)
9707 keytran
.end
= keytran
.start
9708 = min (last_real_key_start
, keytran
.start
);
9709 keytran
.map
= keytran
.parent
;
9713 if (t
== last_real_key_start
)
9720 mock_input
= last_real_key_start
;
9721 goto replay_sequence
;
9726 = apply_modifiers (modifiers
, XCAR (breakdown
));
9728 = Fcons (new_head
, Fcons (EVENT_START (key
), Qnil
));
9730 /* Look for a binding for this new key. follow_key
9731 promises that it didn't munge submaps the
9732 last time we called it, since key was unbound. */
9734 = (follow_key (new_click
,
9735 nmaps
- local_first_binding
,
9736 submaps
+ local_first_binding
,
9737 defs
+ local_first_binding
,
9738 submaps
+ local_first_binding
)
9739 + local_first_binding
);
9741 /* If that click is bound, go for it. */
9742 if (first_binding
< nmaps
)
9747 /* Otherwise, we'll leave key set to the drag event. */
9754 /* Normally, last_nonmenu_event gets the previous key we read.
9755 But when a mouse popup menu is being used,
9756 we don't update last_nonmenu_event; it continues to hold the mouse
9757 event that preceded the first level of menu. */
9758 if (!used_mouse_menu
)
9759 last_nonmenu_event
= key
;
9761 /* Record what part of this_command_keys is the current key sequence. */
9762 this_single_command_key_start
= this_command_key_count
- t
;
9764 /* Look for this sequence in input-decode-map.
9765 Scan from indec.end until we find a bound suffix. */
9766 while (indec
.end
< t
)
9768 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9772 GCPRO4 (indec
.map
, fkey
.map
, keytran
.map
, delayed_switch_frame
);
9773 done
= keyremap_step (keybuf
, bufsize
, &indec
, max (t
, mock_input
),
9778 mock_input
= diff
+ max (t
, mock_input
);
9779 goto replay_sequence
;
9783 if (first_binding
< nmaps
9784 && NILP (submaps
[first_binding
])
9785 && !test_undefined (defs
[first_binding
])
9786 && indec
.start
>= t
)
9787 /* There is a binding and it's not a prefix.
9788 (and it doesn't have any input-decode-map translation pending).
9789 There is thus no function-key in this sequence.
9790 Moving fkey.start is important in this case to allow keytran.start
9791 to go over the sequence before we return (since we keep the
9792 invariant that keytran.end <= fkey.start). */
9795 (fkey
.start
= fkey
.end
= t
, fkey
.map
= fkey
.parent
);
9798 /* If the sequence is unbound, see if we can hang a function key
9799 off the end of it. */
9800 /* Continue scan from fkey.end until we find a bound suffix. */
9801 while (fkey
.end
< indec
.start
)
9803 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9807 GCPRO4 (indec
.map
, fkey
.map
, keytran
.map
, delayed_switch_frame
);
9808 done
= keyremap_step (keybuf
, bufsize
, &fkey
,
9809 max (t
, mock_input
),
9810 /* If there's a binding (i.e.
9811 first_binding >= nmaps) we don't want
9812 to apply this function-key-mapping. */
9814 && (first_binding
>= nmaps
9815 || test_undefined (defs
[first_binding
])),
9820 mock_input
= diff
+ max (t
, mock_input
);
9821 /* Adjust the input-decode-map counters. */
9823 indec
.start
+= diff
;
9825 goto replay_sequence
;
9829 /* Look for this sequence in key-translation-map.
9830 Scan from keytran.end until we find a bound suffix. */
9831 while (keytran
.end
< fkey
.start
)
9833 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9837 GCPRO4 (indec
.map
, fkey
.map
, keytran
.map
, delayed_switch_frame
);
9838 done
= keyremap_step (keybuf
, bufsize
, &keytran
, max (t
, mock_input
),
9843 mock_input
= diff
+ max (t
, mock_input
);
9844 /* Adjust the function-key-map and input-decode-map counters. */
9846 indec
.start
+= diff
;
9850 goto replay_sequence
;
9854 /* If KEY is not defined in any of the keymaps,
9855 and cannot be part of a function key or translation,
9856 and is an upper case letter
9857 use the corresponding lower-case letter instead. */
9858 if (first_binding
>= nmaps
9859 && /* indec.start >= t && fkey.start >= t && */ keytran
.start
>= t
9861 && ((CHARACTERP (make_number (XINT (key
) & ~CHAR_MODIFIER_MASK
))
9862 && uppercasep (XINT (key
) & ~CHAR_MODIFIER_MASK
))
9863 || (XINT (key
) & shift_modifier
)))
9865 Lisp_Object new_key
;
9867 original_uppercase
= key
;
9868 original_uppercase_position
= t
- 1;
9870 if (XINT (key
) & shift_modifier
)
9871 XSETINT (new_key
, XINT (key
) & ~shift_modifier
);
9873 XSETINT (new_key
, (downcase (XINT (key
) & ~CHAR_MODIFIER_MASK
)
9874 | (XINT (key
) & CHAR_MODIFIER_MASK
)));
9876 /* We have to do this unconditionally, regardless of whether
9877 the lower-case char is defined in the keymaps, because they
9878 might get translated through function-key-map. */
9879 keybuf
[t
- 1] = new_key
;
9880 mock_input
= max (t
, mock_input
);
9881 shift_translated
= 1;
9883 goto replay_sequence
;
9885 /* If KEY is not defined in any of the keymaps,
9886 and cannot be part of a function key or translation,
9887 and is a shifted function key,
9888 use the corresponding unshifted function key instead. */
9889 if (first_binding
>= nmaps
9890 && /* indec.start >= t && fkey.start >= t && */ keytran
.start
>= t
)
9892 Lisp_Object breakdown
= parse_modifiers (key
);
9894 = CONSP (breakdown
) ? (XINT (XCAR (XCDR (breakdown
)))) : 0;
9896 if (modifiers
& shift_modifier
9897 /* Treat uppercase keys as shifted. */
9899 && (KEY_TO_CHAR (key
)
9900 < XCHAR_TABLE (BVAR (current_buffer
, downcase_table
))->header
.size
)
9901 && uppercasep (KEY_TO_CHAR (key
))))
9904 = (modifiers
& shift_modifier
9905 ? apply_modifiers (modifiers
& ~shift_modifier
,
9907 : make_number (downcase (KEY_TO_CHAR (key
)) | modifiers
));
9909 original_uppercase
= key
;
9910 original_uppercase_position
= t
- 1;
9912 /* We have to do this unconditionally, regardless of whether
9913 the lower-case char is defined in the keymaps, because they
9914 might get translated through function-key-map. */
9915 keybuf
[t
- 1] = new_key
;
9916 mock_input
= max (t
, mock_input
);
9917 /* Reset fkey (and consequently keytran) to apply
9918 function-key-map on the result, so that S-backspace is
9919 correctly mapped to DEL (via backspace). OTOH,
9920 input-decode-map doesn't need to go through it again. */
9921 fkey
.start
= fkey
.end
= 0;
9922 keytran
.start
= keytran
.end
= 0;
9923 shift_translated
= 1;
9925 goto replay_sequence
;
9930 read_key_sequence_cmd
= (first_binding
< nmaps
9931 ? defs
[first_binding
]
9933 read_key_sequence_remapped
9934 /* Remap command through active keymaps.
9935 Do the remapping here, before the unbind_to so it uses the keymaps
9936 of the appropriate buffer. */
9937 = SYMBOLP (read_key_sequence_cmd
)
9938 ? Fcommand_remapping (read_key_sequence_cmd
, Qnil
, Qnil
)
9941 unread_switch_frame
= delayed_switch_frame
;
9942 unbind_to (count
, Qnil
);
9944 /* Don't downcase the last character if the caller says don't.
9945 Don't downcase it if the result is undefined, either. */
9946 if ((dont_downcase_last
|| first_binding
>= nmaps
)
9948 && t
- 1 == original_uppercase_position
)
9950 keybuf
[t
- 1] = original_uppercase
;
9951 shift_translated
= 0;
9954 if (shift_translated
)
9955 Vthis_command_keys_shift_translated
= Qt
;
9957 /* Occasionally we fabricate events, perhaps by expanding something
9958 according to function-key-map, or by adding a prefix symbol to a
9959 mouse click in the scroll bar or modeline. In this cases, return
9960 the entire generated key sequence, even if we hit an unbound
9961 prefix or a definition before the end. This means that you will
9962 be able to push back the event properly, and also means that
9963 read-key-sequence will always return a logical unit.
9966 for (; t
< mock_input
; t
++)
9968 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
9969 && NILP (Fzerop (Vecho_keystrokes
)))
9970 echo_char (keybuf
[t
]);
9971 add_command_key (keybuf
[t
]);
9978 DEFUN ("read-key-sequence", Fread_key_sequence
, Sread_key_sequence
, 1, 5, 0,
9979 doc
: /* Read a sequence of keystrokes and return as a string or vector.
9980 The sequence is sufficient to specify a non-prefix command in the
9981 current local and global maps.
9983 First arg PROMPT is a prompt string. If nil, do not prompt specially.
9984 Second (optional) arg CONTINUE-ECHO, if non-nil, means this key echos
9985 as a continuation of the previous key.
9987 The third (optional) arg DONT-DOWNCASE-LAST, if non-nil, means do not
9988 convert the last event to lower case. (Normally any upper case event
9989 is converted to lower case if the original event is undefined and the lower
9990 case equivalent is defined.) A non-nil value is appropriate for reading
9991 a key sequence to be defined.
9993 A C-g typed while in this function is treated like any other character,
9994 and `quit-flag' is not set.
9996 If the key sequence starts with a mouse click, then the sequence is read
9997 using the keymaps of the buffer of the window clicked in, not the buffer
9998 of the selected window as normal.
10000 `read-key-sequence' drops unbound button-down events, since you normally
10001 only care about the click or drag events which follow them. If a drag
10002 or multi-click event is unbound, but the corresponding click event would
10003 be bound, `read-key-sequence' turns the event into a click event at the
10004 drag's starting position. This means that you don't have to distinguish
10005 between click and drag, double, or triple events unless you want to.
10007 `read-key-sequence' prefixes mouse events on mode lines, the vertical
10008 lines separating windows, and scroll bars with imaginary keys
10009 `mode-line', `vertical-line', and `vertical-scroll-bar'.
10011 Optional fourth argument CAN-RETURN-SWITCH-FRAME non-nil means that this
10012 function will process a switch-frame event if the user switches frames
10013 before typing anything. If the user switches frames in the middle of a
10014 key sequence, or at the start of the sequence but CAN-RETURN-SWITCH-FRAME
10015 is nil, then the event will be put off until after the current key sequence.
10017 `read-key-sequence' checks `function-key-map' for function key
10018 sequences, where they wouldn't conflict with ordinary bindings. See
10019 `function-key-map' for more details.
10021 The optional fifth argument CMD-LOOP, if non-nil, means
10022 that this key sequence is being read by something that will
10023 read commands one after another. It should be nil if the caller
10024 will read just one key sequence. */)
10025 (Lisp_Object prompt
, Lisp_Object continue_echo
, Lisp_Object dont_downcase_last
, Lisp_Object can_return_switch_frame
, Lisp_Object cmd_loop
)
10027 Lisp_Object keybuf
[30];
10029 struct gcpro gcpro1
;
10030 ptrdiff_t count
= SPECPDL_INDEX ();
10032 if (!NILP (prompt
))
10033 CHECK_STRING (prompt
);
10036 specbind (Qinput_method_exit_on_first_char
,
10037 (NILP (cmd_loop
) ? Qt
: Qnil
));
10038 specbind (Qinput_method_use_echo_area
,
10039 (NILP (cmd_loop
) ? Qt
: Qnil
));
10041 memset (keybuf
, 0, sizeof keybuf
);
10042 GCPRO1 (keybuf
[0]);
10043 gcpro1
.nvars
= (sizeof keybuf
/sizeof (keybuf
[0]));
10045 if (NILP (continue_echo
))
10047 this_command_key_count
= 0;
10048 this_command_key_count_reset
= 0;
10049 this_single_command_key_start
= 0;
10052 #ifdef HAVE_WINDOW_SYSTEM
10053 if (display_hourglass_p
)
10054 cancel_hourglass ();
10057 i
= read_key_sequence (keybuf
, (sizeof keybuf
/sizeof (keybuf
[0])),
10058 prompt
, ! NILP (dont_downcase_last
),
10059 ! NILP (can_return_switch_frame
), 0);
10061 #if 0 /* The following is fine for code reading a key sequence and
10062 then proceeding with a lengthy computation, but it's not good
10063 for code reading keys in a loop, like an input method. */
10064 #ifdef HAVE_WINDOW_SYSTEM
10065 if (display_hourglass_p
)
10066 start_hourglass ();
10076 return unbind_to (count
, make_event_array (i
, keybuf
));
10079 DEFUN ("read-key-sequence-vector", Fread_key_sequence_vector
,
10080 Sread_key_sequence_vector
, 1, 5, 0,
10081 doc
: /* Like `read-key-sequence' but always return a vector. */)
10082 (Lisp_Object prompt
, Lisp_Object continue_echo
, Lisp_Object dont_downcase_last
, Lisp_Object can_return_switch_frame
, Lisp_Object cmd_loop
)
10084 Lisp_Object keybuf
[30];
10086 struct gcpro gcpro1
;
10087 ptrdiff_t count
= SPECPDL_INDEX ();
10089 if (!NILP (prompt
))
10090 CHECK_STRING (prompt
);
10093 specbind (Qinput_method_exit_on_first_char
,
10094 (NILP (cmd_loop
) ? Qt
: Qnil
));
10095 specbind (Qinput_method_use_echo_area
,
10096 (NILP (cmd_loop
) ? Qt
: Qnil
));
10098 memset (keybuf
, 0, sizeof keybuf
);
10099 GCPRO1 (keybuf
[0]);
10100 gcpro1
.nvars
= (sizeof keybuf
/ sizeof (keybuf
[0]));
10102 if (NILP (continue_echo
))
10104 this_command_key_count
= 0;
10105 this_command_key_count_reset
= 0;
10106 this_single_command_key_start
= 0;
10109 #ifdef HAVE_WINDOW_SYSTEM
10110 if (display_hourglass_p
)
10111 cancel_hourglass ();
10114 i
= read_key_sequence (keybuf
, (sizeof keybuf
/ sizeof (keybuf
[0])),
10115 prompt
, ! NILP (dont_downcase_last
),
10116 ! NILP (can_return_switch_frame
), 0);
10118 #ifdef HAVE_WINDOW_SYSTEM
10119 if (display_hourglass_p
)
10120 start_hourglass ();
10129 return unbind_to (count
, Fvector (i
, keybuf
));
10132 DEFUN ("command-execute", Fcommand_execute
, Scommand_execute
, 1, 4, 0,
10133 doc
: /* Execute CMD as an editor command.
10134 CMD must be a symbol that satisfies the `commandp' predicate.
10135 Optional second arg RECORD-FLAG non-nil
10136 means unconditionally put this command in `command-history'.
10137 Otherwise, that is done only if an arg is read using the minibuffer.
10138 The argument KEYS specifies the value to use instead of (this-command-keys)
10139 when reading the arguments; if it is nil, (this-command-keys) is used.
10140 The argument SPECIAL, if non-nil, means that this command is executing
10141 a special event, so ignore the prefix argument and don't clear it. */)
10142 (Lisp_Object cmd
, Lisp_Object record_flag
, Lisp_Object keys
, Lisp_Object special
)
10144 register Lisp_Object final
;
10145 register Lisp_Object tem
;
10146 Lisp_Object prefixarg
;
10148 debug_on_next_call
= 0;
10150 if (NILP (special
))
10152 prefixarg
= KVAR (current_kboard
, Vprefix_arg
);
10153 Vcurrent_prefix_arg
= prefixarg
;
10154 kset_prefix_arg (current_kboard
, Qnil
);
10161 tem
= Fget (cmd
, Qdisabled
);
10164 tem
= Fsymbol_value (Qdisabled_command_function
);
10166 return Frun_hooks (1, &Qdisabled_command_function
);
10172 final
= Findirect_function (cmd
, Qnil
);
10174 if (CONSP (final
) && (tem
= Fcar (final
), EQ (tem
, Qautoload
)))
10176 struct gcpro gcpro1
, gcpro2
;
10178 GCPRO2 (cmd
, prefixarg
);
10179 Fautoload_do_load (final
, cmd
, Qnil
);
10186 if (STRINGP (final
) || VECTORP (final
))
10188 /* If requested, place the macro in the command history. For
10189 other sorts of commands, call-interactively takes care of
10191 if (!NILP (record_flag
))
10194 = Fcons (Fcons (Qexecute_kbd_macro
,
10195 Fcons (final
, Fcons (prefixarg
, Qnil
))),
10198 /* Don't keep command history around forever. */
10199 if (NUMBERP (Vhistory_length
) && XINT (Vhistory_length
) > 0)
10201 tem
= Fnthcdr (Vhistory_length
, Vcommand_history
);
10203 XSETCDR (tem
, Qnil
);
10207 return Fexecute_kbd_macro (final
, prefixarg
, Qnil
);
10210 if (CONSP (final
) || SUBRP (final
) || COMPILEDP (final
))
10211 /* Don't call Fcall_interactively directly because we want to make
10212 sure the backtrace has an entry for `call-interactively'.
10213 For the same reason, pass `cmd' rather than `final'. */
10214 return call3 (Qcall_interactively
, cmd
, record_flag
, keys
);
10221 /* Return true if input events are pending. */
10224 detect_input_pending (void)
10226 return input_pending
|| get_input_pending (0);
10229 /* Return true if input events other than mouse movements are
10233 detect_input_pending_ignore_squeezables (void)
10235 return input_pending
|| get_input_pending (READABLE_EVENTS_IGNORE_SQUEEZABLES
);
10238 /* Return true if input events are pending, and run any pending timers. */
10241 detect_input_pending_run_timers (bool do_display
)
10243 unsigned old_timers_run
= timers_run
;
10245 if (!input_pending
)
10246 get_input_pending (READABLE_EVENTS_DO_TIMERS_NOW
);
10248 if (old_timers_run
!= timers_run
&& do_display
)
10250 redisplay_preserve_echo_area (8);
10251 /* The following fixes a bug when using lazy-lock with
10252 lazy-lock-defer-on-the-fly set to t, i.e. when fontifying
10253 from an idle timer function. The symptom of the bug is that
10254 the cursor sometimes doesn't become visible until the next X
10255 event is processed. --gerd. */
10257 Lisp_Object tail
, frame
;
10258 FOR_EACH_FRAME (tail
, frame
)
10259 if (FRAME_RIF (XFRAME (frame
)))
10260 FRAME_RIF (XFRAME (frame
))->flush_display (XFRAME (frame
));
10264 return input_pending
;
10267 /* This is called in some cases before a possible quit.
10268 It cases the next call to detect_input_pending to recompute input_pending.
10269 So calling this function unnecessarily can't do any harm. */
10272 clear_input_pending (void)
10277 /* Return true if there are pending requeued events.
10278 This isn't used yet. The hope is to make wait_reading_process_output
10279 call it, and return if it runs Lisp code that unreads something.
10280 The problem is, kbd_buffer_get_event needs to be fixed to know what
10281 to do in that case. It isn't trivial. */
10284 requeued_events_pending_p (void)
10286 return (!NILP (Vunread_command_events
));
10290 DEFUN ("input-pending-p", Finput_pending_p
, Sinput_pending_p
, 0, 0, 0,
10291 doc
: /* Return t if command input is currently available with no wait.
10292 Actually, the value is nil only if we can be sure that no input is available;
10293 if there is a doubt, the value is t. */)
10296 if (!NILP (Vunread_command_events
)
10297 || !NILP (Vunread_post_input_method_events
)
10298 || !NILP (Vunread_input_method_events
))
10301 /* Process non-user-visible events (Bug#10195). */
10302 process_special_events ();
10304 return (get_input_pending (READABLE_EVENTS_DO_TIMERS_NOW
10305 | READABLE_EVENTS_FILTER_EVENTS
)
10309 DEFUN ("recent-keys", Frecent_keys
, Srecent_keys
, 0, 0, 0,
10310 doc
: /* Return vector of last 300 events, not counting those from keyboard macros. */)
10313 Lisp_Object
*keys
= XVECTOR (recent_keys
)->contents
;
10316 if (total_keys
< NUM_RECENT_KEYS
)
10317 return Fvector (total_keys
, keys
);
10320 val
= Fvector (NUM_RECENT_KEYS
, keys
);
10321 vcopy (val
, 0, keys
+ recent_keys_index
,
10322 NUM_RECENT_KEYS
- recent_keys_index
);
10323 vcopy (val
, NUM_RECENT_KEYS
- recent_keys_index
,
10324 keys
, recent_keys_index
);
10329 DEFUN ("this-command-keys", Fthis_command_keys
, Sthis_command_keys
, 0, 0, 0,
10330 doc
: /* Return the key sequence that invoked this command.
10331 However, if the command has called `read-key-sequence', it returns
10332 the last key sequence that has been read.
10333 The value is a string or a vector.
10335 See also `this-command-keys-vector'. */)
10338 return make_event_array (this_command_key_count
,
10339 XVECTOR (this_command_keys
)->contents
);
10342 DEFUN ("this-command-keys-vector", Fthis_command_keys_vector
, Sthis_command_keys_vector
, 0, 0, 0,
10343 doc
: /* Return the key sequence that invoked this command, as a vector.
10344 However, if the command has called `read-key-sequence', it returns
10345 the last key sequence that has been read.
10347 See also `this-command-keys'. */)
10350 return Fvector (this_command_key_count
,
10351 XVECTOR (this_command_keys
)->contents
);
10354 DEFUN ("this-single-command-keys", Fthis_single_command_keys
,
10355 Sthis_single_command_keys
, 0, 0, 0,
10356 doc
: /* Return the key sequence that invoked this command.
10357 More generally, it returns the last key sequence read, either by
10358 the command loop or by `read-key-sequence'.
10359 Unlike `this-command-keys', this function's value
10360 does not include prefix arguments.
10361 The value is always a vector. */)
10364 return Fvector (this_command_key_count
10365 - this_single_command_key_start
,
10366 (XVECTOR (this_command_keys
)->contents
10367 + this_single_command_key_start
));
10370 DEFUN ("this-single-command-raw-keys", Fthis_single_command_raw_keys
,
10371 Sthis_single_command_raw_keys
, 0, 0, 0,
10372 doc
: /* Return the raw events that were read for this command.
10373 More generally, it returns the last key sequence read, either by
10374 the command loop or by `read-key-sequence'.
10375 Unlike `this-single-command-keys', this function's value
10376 shows the events before all translations (except for input methods).
10377 The value is always a vector. */)
10380 return Fvector (raw_keybuf_count
,
10381 (XVECTOR (raw_keybuf
)->contents
));
10384 DEFUN ("reset-this-command-lengths", Freset_this_command_lengths
,
10385 Sreset_this_command_lengths
, 0, 0, 0,
10386 doc
: /* Make the unread events replace the last command and echo.
10387 Used in `universal-argument-other-key'.
10389 `universal-argument-other-key' rereads the event just typed.
10390 It then gets translated through `function-key-map'.
10391 The translated event has to replace the real events,
10392 both in the value of (this-command-keys) and in echoing.
10393 To achieve this, `universal-argument-other-key' calls
10394 `reset-this-command-lengths', which discards the record of reading
10395 these events the first time. */)
10398 this_command_key_count
= before_command_key_count
;
10399 if (this_command_key_count
< this_single_command_key_start
)
10400 this_single_command_key_start
= this_command_key_count
;
10402 echo_truncate (before_command_echo_length
);
10404 /* Cause whatever we put into unread-command-events
10405 to echo as if it were being freshly read from the keyboard. */
10406 this_command_key_count_reset
= 1;
10411 DEFUN ("clear-this-command-keys", Fclear_this_command_keys
,
10412 Sclear_this_command_keys
, 0, 1, 0,
10413 doc
: /* Clear out the vector that `this-command-keys' returns.
10414 Also clear the record of the last 100 events, unless optional arg
10415 KEEP-RECORD is non-nil. */)
10416 (Lisp_Object keep_record
)
10420 this_command_key_count
= 0;
10421 this_command_key_count_reset
= 0;
10423 if (NILP (keep_record
))
10425 for (i
= 0; i
< ASIZE (recent_keys
); ++i
)
10426 ASET (recent_keys
, i
, Qnil
);
10428 recent_keys_index
= 0;
10433 DEFUN ("recursion-depth", Frecursion_depth
, Srecursion_depth
, 0, 0, 0,
10434 doc
: /* Return the current depth in recursive edits. */)
10438 /* Wrap around reliably on integer overflow. */
10439 EMACS_INT sum
= (command_loop_level
& INTMASK
) + (minibuf_level
& INTMASK
);
10440 XSETINT (temp
, sum
);
10444 DEFUN ("open-dribble-file", Fopen_dribble_file
, Sopen_dribble_file
, 1, 1,
10445 "FOpen dribble file: ",
10446 doc
: /* Start writing all keyboard characters to a dribble file called FILE.
10447 If FILE is nil, close any open dribble file.
10448 The file will be closed when Emacs exits. */)
10460 file
= Fexpand_file_name (file
, Qnil
);
10461 dribble
= fopen (SSDATA (file
), "w");
10463 report_file_error ("Opening dribble", Fcons (file
, Qnil
));
10468 DEFUN ("discard-input", Fdiscard_input
, Sdiscard_input
, 0, 0, 0,
10469 doc
: /* Discard the contents of the terminal input buffer.
10470 Also end any kbd macro being defined. */)
10473 if (!NILP (KVAR (current_kboard
, defining_kbd_macro
)))
10475 /* Discard the last command from the macro. */
10476 Fcancel_kbd_macro_events ();
10480 update_mode_lines
++;
10482 Vunread_command_events
= Qnil
;
10484 discard_tty_input ();
10486 kbd_fetch_ptr
= kbd_store_ptr
;
10492 DEFUN ("suspend-emacs", Fsuspend_emacs
, Ssuspend_emacs
, 0, 1, "",
10493 doc
: /* Stop Emacs and return to superior process. You can resume later.
10494 If `cannot-suspend' is non-nil, or if the system doesn't support job
10495 control, run a subshell instead.
10497 If optional arg STUFFSTRING is non-nil, its characters are stuffed
10498 to be read as terminal input by Emacs's parent, after suspension.
10500 Before suspending, run the normal hook `suspend-hook'.
10501 After resumption run the normal hook `suspend-resume-hook'.
10503 Some operating systems cannot stop the Emacs process and resume it later.
10504 On such systems, Emacs starts a subshell instead of suspending. */)
10505 (Lisp_Object stuffstring
)
10507 ptrdiff_t count
= SPECPDL_INDEX ();
10508 int old_height
, old_width
;
10510 struct gcpro gcpro1
;
10513 if (tty_list
&& tty_list
->next
)
10514 error ("There are other tty frames open; close them before suspending Emacs");
10516 if (!NILP (stuffstring
))
10517 CHECK_STRING (stuffstring
);
10519 /* Run the functions in suspend-hook. */
10520 hook
= intern ("suspend-hook");
10521 Frun_hooks (1, &hook
);
10523 GCPRO1 (stuffstring
);
10524 get_tty_size (fileno (CURTTY ()->input
), &old_width
, &old_height
);
10525 reset_all_sys_modes ();
10526 /* sys_suspend can get an error if it tries to fork a subshell
10527 and the system resources aren't available for that. */
10528 record_unwind_protect ((Lisp_Object (*) (Lisp_Object
)) init_all_sys_modes
,
10530 stuff_buffered_input (stuffstring
);
10531 if (cannot_suspend
)
10535 unbind_to (count
, Qnil
);
10537 /* Check if terminal/window size has changed.
10538 Note that this is not useful when we are running directly
10539 with a window system; but suspend should be disabled in that case. */
10540 get_tty_size (fileno (CURTTY ()->input
), &width
, &height
);
10541 if (width
!= old_width
|| height
!= old_height
)
10542 change_frame_size (SELECTED_FRAME (), height
, width
, 0, 0, 0);
10544 /* Run suspend-resume-hook. */
10545 hook
= intern ("suspend-resume-hook");
10546 Frun_hooks (1, &hook
);
10552 /* If STUFFSTRING is a string, stuff its contents as pending terminal input.
10553 Then in any case stuff anything Emacs has read ahead and not used. */
10556 stuff_buffered_input (Lisp_Object stuffstring
)
10558 #ifdef SIGTSTP /* stuff_char is defined if SIGTSTP. */
10559 register unsigned char *p
;
10561 if (STRINGP (stuffstring
))
10563 register ptrdiff_t count
;
10565 p
= SDATA (stuffstring
);
10566 count
= SBYTES (stuffstring
);
10567 while (count
-- > 0)
10572 /* Anything we have read ahead, put back for the shell to read. */
10573 /* ?? What should this do when we have multiple keyboards??
10574 Should we ignore anything that was typed in at the "wrong" kboard?
10576 rms: we should stuff everything back into the kboard
10578 for (; kbd_fetch_ptr
!= kbd_store_ptr
; kbd_fetch_ptr
++)
10581 if (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
10582 kbd_fetch_ptr
= kbd_buffer
;
10583 if (kbd_fetch_ptr
->kind
== ASCII_KEYSTROKE_EVENT
)
10584 stuff_char (kbd_fetch_ptr
->code
);
10586 clear_event (kbd_fetch_ptr
);
10590 #endif /* SIGTSTP */
10594 set_waiting_for_input (EMACS_TIME
*time_to_clear
)
10596 input_available_clear_time
= time_to_clear
;
10598 /* Tell handle_interrupt to throw back to read_char, */
10599 waiting_for_input
= 1;
10601 /* If handle_interrupt was called before and buffered a C-g,
10602 make it run again now, to avoid timing error. */
10603 if (!NILP (Vquit_flag
))
10604 quit_throw_to_read_char (0);
10608 clear_waiting_for_input (void)
10610 /* Tell handle_interrupt not to throw back to read_char, */
10611 waiting_for_input
= 0;
10612 input_available_clear_time
= 0;
10615 /* The SIGINT handler.
10617 If we have a frame on the controlling tty, we assume that the
10618 SIGINT was generated by C-g, so we call handle_interrupt.
10619 Otherwise, tell QUIT to kill Emacs. */
10622 handle_interrupt_signal (int sig
)
10624 /* See if we have an active terminal on our controlling tty. */
10625 struct terminal
*terminal
= get_named_tty ("/dev/tty");
10628 /* If there are no frames there, let's pretend that we are a
10629 well-behaving UN*X program and quit. We must not call Lisp
10630 in a signal handler, so tell QUIT to exit when it is
10632 Vquit_flag
= Qkill_emacs
;
10636 /* Otherwise, the SIGINT was probably generated by C-g. */
10638 /* Set internal_last_event_frame to the top frame of the
10639 controlling tty, if we have a frame there. We disable the
10640 interrupt key on secondary ttys, so the SIGINT must have come
10641 from the controlling tty. */
10642 internal_last_event_frame
= terminal
->display_info
.tty
->top_frame
;
10644 handle_interrupt (1);
10649 deliver_interrupt_signal (int sig
)
10651 deliver_process_signal (sig
, handle_interrupt_signal
);
10655 /* If Emacs is stuck because `inhibit-quit' is true, then keep track
10656 of the number of times C-g has been requested. If C-g is pressed
10657 enough times, then quit anyway. See bug#6585. */
10658 static int volatile force_quit_count
;
10660 /* This routine is called at interrupt level in response to C-g.
10662 It is called from the SIGINT handler or kbd_buffer_store_event.
10664 If `waiting_for_input' is non zero, then unless `echoing' is
10665 nonzero, immediately throw back to read_char.
10667 Otherwise it sets the Lisp variable quit-flag not-nil. This causes
10668 eval to throw, when it gets a chance. If quit-flag is already
10669 non-nil, it stops the job right away. */
10672 handle_interrupt (bool in_signal_handler
)
10678 /* XXX This code needs to be revised for multi-tty support. */
10679 if (!NILP (Vquit_flag
) && get_named_tty ("/dev/tty"))
10681 if (! in_signal_handler
)
10683 /* If SIGINT isn't blocked, don't let us be interrupted by
10684 a SIGINT. It might be harmful due to non-reentrancy
10685 in I/O functions. */
10687 sigemptyset (&blocked
);
10688 sigaddset (&blocked
, SIGINT
);
10689 pthread_sigmask (SIG_BLOCK
, &blocked
, 0);
10693 reset_all_sys_modes ();
10695 #ifdef SIGTSTP /* Support possible in later USG versions */
10697 * On systems which can suspend the current process and return to the original
10698 * shell, this command causes the user to end up back at the shell.
10699 * The "Auto-save" and "Abort" questions are not asked until
10700 * the user elects to return to emacs, at which point he can save the current
10701 * job and either dump core or continue.
10705 /* Perhaps should really fork an inferior shell?
10706 But that would not provide any way to get back
10707 to the original shell, ever. */
10708 printf ("No support for stopping a process on this operating system;\n");
10709 printf ("you can continue or abort.\n");
10710 #endif /* not SIGTSTP */
10712 /* We must remain inside the screen area when the internal terminal
10713 is used. Note that [Enter] is not echoed by dos. */
10714 cursor_to (SELECTED_FRAME (), 0, 0);
10716 /* It doesn't work to autosave while GC is in progress;
10717 the code used for auto-saving doesn't cope with the mark bit. */
10718 if (!gc_in_progress
)
10720 printf ("Auto-save? (y or n) ");
10722 if (((c
= getchar ()) & ~040) == 'Y')
10724 Fdo_auto_save (Qt
, Qnil
);
10726 printf ("\r\nAuto-save done");
10727 #else /* not MSDOS */
10728 printf ("Auto-save done\n");
10729 #endif /* not MSDOS */
10731 while (c
!= '\n') c
= getchar ();
10735 /* During GC, it must be safe to reenable quitting again. */
10736 Vinhibit_quit
= Qnil
;
10739 #endif /* not MSDOS */
10740 printf ("Garbage collection in progress; cannot auto-save now\r\n");
10741 printf ("but will instead do a real quit after garbage collection ends\r\n");
10746 printf ("\r\nAbort? (y or n) ");
10747 #else /* not MSDOS */
10748 printf ("Abort (and dump core)? (y or n) ");
10749 #endif /* not MSDOS */
10751 if (((c
= getchar ()) & ~040) == 'Y')
10753 while (c
!= '\n') c
= getchar ();
10755 printf ("\r\nContinuing...\r\n");
10756 #else /* not MSDOS */
10757 printf ("Continuing...\n");
10758 #endif /* not MSDOS */
10760 init_all_sys_modes ();
10764 /* If executing a function that wants to be interrupted out of
10765 and the user has not deferred quitting by binding `inhibit-quit'
10766 then quit right away. */
10767 if (immediate_quit
&& NILP (Vinhibit_quit
))
10769 struct gl_state_s saved
;
10770 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
10772 immediate_quit
= 0;
10773 pthread_sigmask (SIG_SETMASK
, &empty_mask
, 0);
10775 GCPRO4 (saved
.object
, saved
.global_code
,
10776 saved
.current_syntax_table
, saved
.old_prop
);
10777 Fsignal (Qquit
, Qnil
);
10782 { /* Else request quit when it's safe. */
10783 int count
= NILP (Vquit_flag
) ? 1 : force_quit_count
+ 1;
10784 force_quit_count
= count
;
10787 immediate_quit
= 1;
10788 Vinhibit_quit
= Qnil
;
10794 pthread_sigmask (SIG_SETMASK
, &empty_mask
, 0);
10796 /* TODO: The longjmp in this call throws the NS event loop integration off,
10797 and it seems to do fine without this. Probably some attention
10798 needs to be paid to the setting of waiting_for_input in
10799 wait_reading_process_output() under HAVE_NS because of the call
10800 to ns_select there (needed because otherwise events aren't picked up
10801 outside of polling since we don't get SIGIO like X and we don't have a
10802 separate event loop thread like W32. */
10804 if (waiting_for_input
&& !echoing
)
10805 quit_throw_to_read_char (in_signal_handler
);
10809 /* Handle a C-g by making read_char return C-g. */
10812 quit_throw_to_read_char (bool from_signal
)
10814 /* When not called from a signal handler it is safe to call
10816 if (!from_signal
&& EQ (Vquit_flag
, Qkill_emacs
))
10817 Fkill_emacs (Qnil
);
10819 /* Prevent another signal from doing this before we finish. */
10820 clear_waiting_for_input ();
10823 Vunread_command_events
= Qnil
;
10825 if (FRAMEP (internal_last_event_frame
)
10826 && !EQ (internal_last_event_frame
, selected_frame
))
10827 do_switch_frame (make_lispy_switch_frame (internal_last_event_frame
),
10830 sys_longjmp (getcjmp
, 1);
10833 DEFUN ("set-input-interrupt-mode", Fset_input_interrupt_mode
,
10834 Sset_input_interrupt_mode
, 1, 1, 0,
10835 doc
: /* Set interrupt mode of reading keyboard input.
10836 If INTERRUPT is non-nil, Emacs will use input interrupts;
10837 otherwise Emacs uses CBREAK mode.
10839 See also `current-input-mode'. */)
10840 (Lisp_Object interrupt
)
10842 bool new_interrupt_input
;
10843 #ifdef USABLE_SIGIO
10844 #ifdef HAVE_X_WINDOWS
10845 if (x_display_list
!= NULL
)
10847 /* When using X, don't give the user a real choice,
10848 because we haven't implemented the mechanisms to support it. */
10849 new_interrupt_input
= 1;
10852 #endif /* HAVE_X_WINDOWS */
10853 new_interrupt_input
= !NILP (interrupt
);
10854 #else /* not USABLE_SIGIO */
10855 new_interrupt_input
= 0;
10856 #endif /* not USABLE_SIGIO */
10858 if (new_interrupt_input
!= interrupt_input
)
10860 #ifdef POLL_FOR_INPUT
10864 /* this causes startup screen to be restored and messes with the mouse */
10865 reset_all_sys_modes ();
10866 interrupt_input
= new_interrupt_input
;
10867 init_all_sys_modes ();
10869 interrupt_input
= new_interrupt_input
;
10872 #ifdef POLL_FOR_INPUT
10873 poll_suppress_count
= 1;
10880 DEFUN ("set-output-flow-control", Fset_output_flow_control
, Sset_output_flow_control
, 1, 2, 0,
10881 doc
: /* Enable or disable ^S/^Q flow control for output to TERMINAL.
10882 If FLOW is non-nil, flow control is enabled and you cannot use C-s or
10883 C-q in key sequences.
10885 This setting only has an effect on tty terminals and only when
10886 Emacs reads input in CBREAK mode; see `set-input-interrupt-mode'.
10888 See also `current-input-mode'. */)
10889 (Lisp_Object flow
, Lisp_Object terminal
)
10891 struct terminal
*t
= get_terminal (terminal
, 1);
10892 struct tty_display_info
*tty
;
10893 if (t
== NULL
|| (t
->type
!= output_termcap
&& t
->type
!= output_msdos_raw
))
10895 tty
= t
->display_info
.tty
;
10897 if (tty
->flow_control
!= !NILP (flow
))
10900 /* this causes startup screen to be restored and messes with the mouse */
10901 reset_sys_modes (tty
);
10904 tty
->flow_control
= !NILP (flow
);
10907 init_sys_modes (tty
);
10913 DEFUN ("set-input-meta-mode", Fset_input_meta_mode
, Sset_input_meta_mode
, 1, 2, 0,
10914 doc
: /* Enable or disable 8-bit input on TERMINAL.
10915 If META is t, Emacs will accept 8-bit input, and interpret the 8th
10916 bit as the Meta modifier.
10918 If META is nil, Emacs will ignore the top bit, on the assumption it is
10921 Otherwise, Emacs will accept and pass through 8-bit input without
10922 specially interpreting the top bit.
10924 This setting only has an effect on tty terminal devices.
10926 Optional parameter TERMINAL specifies the tty terminal device to use.
10927 It may be a terminal object, a frame, or nil for the terminal used by
10928 the currently selected frame.
10930 See also `current-input-mode'. */)
10931 (Lisp_Object meta
, Lisp_Object terminal
)
10933 struct terminal
*t
= get_terminal (terminal
, 1);
10934 struct tty_display_info
*tty
;
10937 if (t
== NULL
|| (t
->type
!= output_termcap
&& t
->type
!= output_msdos_raw
))
10939 tty
= t
->display_info
.tty
;
10943 else if (EQ (meta
, Qt
))
10948 if (tty
->meta_key
!= new_meta
)
10951 /* this causes startup screen to be restored and messes with the mouse */
10952 reset_sys_modes (tty
);
10955 tty
->meta_key
= new_meta
;
10958 init_sys_modes (tty
);
10964 DEFUN ("set-quit-char", Fset_quit_char
, Sset_quit_char
, 1, 1, 0,
10965 doc
: /* Specify character used for quitting.
10966 QUIT must be an ASCII character.
10968 This function only has an effect on the controlling tty of the Emacs
10971 See also `current-input-mode'. */)
10974 struct terminal
*t
= get_named_tty ("/dev/tty");
10975 struct tty_display_info
*tty
;
10976 if (t
== NULL
|| (t
->type
!= output_termcap
&& t
->type
!= output_msdos_raw
))
10978 tty
= t
->display_info
.tty
;
10980 if (NILP (quit
) || !INTEGERP (quit
) || XINT (quit
) < 0 || XINT (quit
) > 0400)
10981 error ("QUIT must be an ASCII character");
10984 /* this causes startup screen to be restored and messes with the mouse */
10985 reset_sys_modes (tty
);
10988 /* Don't let this value be out of range. */
10989 quit_char
= XINT (quit
) & (tty
->meta_key
== 0 ? 0177 : 0377);
10992 init_sys_modes (tty
);
10998 DEFUN ("set-input-mode", Fset_input_mode
, Sset_input_mode
, 3, 4, 0,
10999 doc
: /* Set mode of reading keyboard input.
11000 First arg INTERRUPT non-nil means use input interrupts;
11001 nil means use CBREAK mode.
11002 Second arg FLOW non-nil means use ^S/^Q flow control for output to terminal
11003 (no effect except in CBREAK mode).
11004 Third arg META t means accept 8-bit input (for a Meta key).
11005 META nil means ignore the top bit, on the assumption it is parity.
11006 Otherwise, accept 8-bit input and don't use the top bit for Meta.
11007 Optional fourth arg QUIT if non-nil specifies character to use for quitting.
11008 See also `current-input-mode'. */)
11009 (Lisp_Object interrupt
, Lisp_Object flow
, Lisp_Object meta
, Lisp_Object quit
)
11011 Fset_input_interrupt_mode (interrupt
);
11012 Fset_output_flow_control (flow
, Qnil
);
11013 Fset_input_meta_mode (meta
, Qnil
);
11015 Fset_quit_char (quit
);
11019 DEFUN ("current-input-mode", Fcurrent_input_mode
, Scurrent_input_mode
, 0, 0, 0,
11020 doc
: /* Return information about the way Emacs currently reads keyboard input.
11021 The value is a list of the form (INTERRUPT FLOW META QUIT), where
11022 INTERRUPT is non-nil if Emacs is using interrupt-driven input; if
11023 nil, Emacs is using CBREAK mode.
11024 FLOW is non-nil if Emacs uses ^S/^Q flow control for output to the
11025 terminal; this does not apply if Emacs uses interrupt-driven input.
11026 META is t if accepting 8-bit input with 8th bit as Meta flag.
11027 META nil means ignoring the top bit, on the assumption it is parity.
11028 META is neither t nor nil if accepting 8-bit input and using
11029 all 8 bits as the character code.
11030 QUIT is the character Emacs currently uses to quit.
11031 The elements of this list correspond to the arguments of
11032 `set-input-mode'. */)
11035 Lisp_Object val
[4];
11036 struct frame
*sf
= XFRAME (selected_frame
);
11038 val
[0] = interrupt_input
? Qt
: Qnil
;
11039 if (FRAME_TERMCAP_P (sf
) || FRAME_MSDOS_P (sf
))
11041 val
[1] = FRAME_TTY (sf
)->flow_control
? Qt
: Qnil
;
11042 val
[2] = (FRAME_TTY (sf
)->meta_key
== 2
11044 : (CURTTY ()->meta_key
== 1 ? Qt
: Qnil
));
11051 XSETFASTINT (val
[3], quit_char
);
11053 return Flist (sizeof (val
) / sizeof (val
[0]), val
);
11056 DEFUN ("posn-at-x-y", Fposn_at_x_y
, Sposn_at_x_y
, 2, 4, 0,
11057 doc
: /* Return position information for pixel coordinates X and Y.
11058 By default, X and Y are relative to text area of the selected window.
11059 Optional third arg FRAME-OR-WINDOW non-nil specifies frame or window.
11060 If optional fourth arg WHOLE is non-nil, X is relative to the left
11061 edge of the window.
11063 The return value is similar to a mouse click position:
11064 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
11065 IMAGE (DX . DY) (WIDTH . HEIGHT))
11066 The `posn-' functions access elements of such lists. */)
11067 (Lisp_Object x
, Lisp_Object y
, Lisp_Object frame_or_window
, Lisp_Object whole
)
11072 if (NILP (frame_or_window
))
11073 frame_or_window
= selected_window
;
11075 if (WINDOWP (frame_or_window
))
11077 struct window
*w
= decode_live_window (frame_or_window
);
11079 XSETINT (x
, (XINT (x
)
11080 + WINDOW_LEFT_EDGE_X (w
)
11082 ? window_box_left_offset (w
, TEXT_AREA
)
11084 XSETINT (y
, WINDOW_TO_FRAME_PIXEL_Y (w
, XINT (y
)));
11085 frame_or_window
= w
->frame
;
11088 CHECK_LIVE_FRAME (frame_or_window
);
11090 return make_lispy_position (XFRAME (frame_or_window
), x
, y
, 0);
11093 DEFUN ("posn-at-point", Fposn_at_point
, Sposn_at_point
, 0, 2, 0,
11094 doc
: /* Return position information for buffer POS in WINDOW.
11095 POS defaults to point in WINDOW; WINDOW defaults to the selected window.
11097 Return nil if position is not visible in window. Otherwise,
11098 the return value is similar to that returned by `event-start' for
11099 a mouse click at the upper left corner of the glyph corresponding
11100 to the given buffer position:
11101 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
11102 IMAGE (DX . DY) (WIDTH . HEIGHT))
11103 The `posn-' functions access elements of such lists. */)
11104 (Lisp_Object pos
, Lisp_Object window
)
11109 window
= selected_window
;
11111 tem
= Fpos_visible_in_window_p (pos
, window
, Qt
);
11114 Lisp_Object x
= XCAR (tem
);
11115 Lisp_Object y
= XCAR (XCDR (tem
));
11117 /* Point invisible due to hscrolling? */
11120 tem
= Fposn_at_x_y (x
, y
, window
, Qnil
);
11128 * Set up a new kboard object with reasonable initial values.
11131 init_kboard (KBOARD
*kb
)
11133 kset_overriding_terminal_local_map (kb
, Qnil
);
11134 kset_last_command (kb
, Qnil
);
11135 kset_real_last_command (kb
, Qnil
);
11136 kset_keyboard_translate_table (kb
, Qnil
);
11137 kset_last_repeatable_command (kb
, Qnil
);
11138 kset_prefix_arg (kb
, Qnil
);
11139 kset_last_prefix_arg (kb
, Qnil
);
11140 kset_kbd_queue (kb
, Qnil
);
11141 kb
->kbd_queue_has_data
= 0;
11142 kb
->immediate_echo
= 0;
11143 kset_echo_string (kb
, Qnil
);
11144 kb
->echo_after_prompt
= -1;
11145 kb
->kbd_macro_buffer
= 0;
11146 kb
->kbd_macro_bufsize
= 0;
11147 kset_defining_kbd_macro (kb
, Qnil
);
11148 kset_last_kbd_macro (kb
, Qnil
);
11149 kb
->reference_count
= 0;
11150 kset_system_key_alist (kb
, Qnil
);
11151 kset_system_key_syms (kb
, Qnil
);
11152 kset_window_system (kb
, Qt
); /* Unset. */
11153 kset_input_decode_map (kb
, Fmake_sparse_keymap (Qnil
));
11154 kset_local_function_key_map (kb
, Fmake_sparse_keymap (Qnil
));
11155 Fset_keymap_parent (KVAR (kb
, Vlocal_function_key_map
), Vfunction_key_map
);
11156 kset_default_minibuffer_frame (kb
, Qnil
);
11160 * Destroy the contents of a kboard object, but not the object itself.
11161 * We use this just before deleting it, or if we're going to initialize
11162 * it a second time.
11165 wipe_kboard (KBOARD
*kb
)
11167 xfree (kb
->kbd_macro_buffer
);
11170 /* Free KB and memory referenced from it. */
11173 delete_kboard (KBOARD
*kb
)
11177 for (kbp
= &all_kboards
; *kbp
!= kb
; kbp
= &(*kbp
)->next_kboard
)
11180 *kbp
= kb
->next_kboard
;
11182 /* Prevent a dangling reference to KB. */
11183 if (kb
== current_kboard
11184 && FRAMEP (selected_frame
)
11185 && FRAME_LIVE_P (XFRAME (selected_frame
)))
11187 current_kboard
= FRAME_KBOARD (XFRAME (selected_frame
));
11189 if (current_kboard
== kb
)
11198 init_keyboard (void)
11200 /* This is correct before outermost invocation of the editor loop. */
11201 command_loop_level
= -1;
11202 immediate_quit
= 0;
11203 quit_char
= Ctl ('g');
11204 Vunread_command_events
= Qnil
;
11205 timer_idleness_start_time
= invalid_emacs_time ();
11207 recent_keys_index
= 0;
11208 kbd_fetch_ptr
= kbd_buffer
;
11209 kbd_store_ptr
= kbd_buffer
;
11210 do_mouse_tracking
= Qnil
;
11212 interrupt_input_blocked
= 0;
11213 pending_signals
= 0;
11215 /* This means that command_loop_1 won't try to select anything the first
11217 internal_last_event_frame
= Qnil
;
11218 Vlast_event_frame
= internal_last_event_frame
;
11220 current_kboard
= initial_kboard
;
11221 /* Re-initialize the keyboard again. */
11222 wipe_kboard (current_kboard
);
11223 init_kboard (current_kboard
);
11224 /* A value of nil for Vwindow_system normally means a tty, but we also use
11225 it for the initial terminal since there is no window system there. */
11226 kset_window_system (current_kboard
, Qnil
);
11228 if (!noninteractive
)
11230 /* Before multi-tty support, these handlers used to be installed
11231 only if the current session was a tty session. Now an Emacs
11232 session may have multiple display types, so we always handle
11233 SIGINT. There is special code in handle_interrupt_signal to exit
11234 Emacs on SIGINT when there are no termcap frames on the
11235 controlling terminal. */
11236 struct sigaction action
;
11237 emacs_sigaction_init (&action
, deliver_interrupt_signal
);
11238 sigaction (SIGINT
, &action
, 0);
11240 /* For systems with SysV TERMIO, C-g is set up for both SIGINT and
11241 SIGQUIT and we can't tell which one it will give us. */
11242 sigaction (SIGQUIT
, &action
, 0);
11243 #endif /* not DOS_NT */
11245 #ifdef USABLE_SIGIO
11246 if (!noninteractive
)
11248 struct sigaction action
;
11249 emacs_sigaction_init (&action
, deliver_input_available_signal
);
11250 sigaction (SIGIO
, &action
, 0);
11254 /* Use interrupt input by default, if it works and noninterrupt input
11255 has deficiencies. */
11257 #ifdef INTERRUPT_INPUT
11258 interrupt_input
= 1;
11260 interrupt_input
= 0;
11263 pthread_sigmask (SIG_SETMASK
, &empty_mask
, 0);
11266 if (keyboard_init_hook
)
11267 (*keyboard_init_hook
) ();
11269 #ifdef POLL_FOR_INPUT
11271 poll_suppress_count
= 1;
11276 /* This type's only use is in syms_of_keyboard, to initialize the
11277 event header symbols and put properties on them. */
11278 struct event_head
{
11284 static const struct event_head head_table
[] = {
11285 {&Qmouse_movement
, "mouse-movement", &Qmouse_movement
},
11286 {&Qscroll_bar_movement
, "scroll-bar-movement", &Qmouse_movement
},
11287 {&Qswitch_frame
, "switch-frame", &Qswitch_frame
},
11288 {&Qdelete_frame
, "delete-frame", &Qdelete_frame
},
11289 {&Qiconify_frame
, "iconify-frame", &Qiconify_frame
},
11290 {&Qmake_frame_visible
, "make-frame-visible", &Qmake_frame_visible
},
11291 /* `select-window' should be handled just like `switch-frame'
11292 in read_key_sequence. */
11293 {&Qselect_window
, "select-window", &Qswitch_frame
}
11297 syms_of_keyboard (void)
11299 pending_funcalls
= Qnil
;
11300 staticpro (&pending_funcalls
);
11302 Vlispy_mouse_stem
= build_pure_c_string ("mouse");
11303 staticpro (&Vlispy_mouse_stem
);
11306 DEFSYM (QCimage
, ":image");
11307 DEFSYM (Qhelp_echo
, "help-echo");
11308 DEFSYM (QCrtl
, ":rtl");
11310 staticpro (&item_properties
);
11311 item_properties
= Qnil
;
11313 staticpro (&tool_bar_item_properties
);
11314 tool_bar_item_properties
= Qnil
;
11315 staticpro (&tool_bar_items_vector
);
11316 tool_bar_items_vector
= Qnil
;
11318 DEFSYM (Qtimer_event_handler
, "timer-event-handler");
11319 DEFSYM (Qdisabled_command_function
, "disabled-command-function");
11320 DEFSYM (Qself_insert_command
, "self-insert-command");
11321 DEFSYM (Qforward_char
, "forward-char");
11322 DEFSYM (Qbackward_char
, "backward-char");
11323 DEFSYM (Qdisabled
, "disabled");
11324 DEFSYM (Qundefined
, "undefined");
11325 DEFSYM (Qpre_command_hook
, "pre-command-hook");
11326 DEFSYM (Qpost_command_hook
, "post-command-hook");
11327 DEFSYM (Qdeferred_action_function
, "deferred-action-function");
11328 DEFSYM (Qdelayed_warnings_hook
, "delayed-warnings-hook");
11329 DEFSYM (Qfunction_key
, "function-key");
11330 DEFSYM (Qmouse_click
, "mouse-click");
11331 DEFSYM (Qdrag_n_drop
, "drag-n-drop");
11332 DEFSYM (Qsave_session
, "save-session");
11333 DEFSYM (Qconfig_changed_event
, "config-changed-event");
11334 DEFSYM (Qmenu_enable
, "menu-enable");
11337 DEFSYM (Qlanguage_change
, "language-change");
11341 DEFSYM (Qdbus_event
, "dbus-event");
11344 DEFSYM (QCenable
, ":enable");
11345 DEFSYM (QCvisible
, ":visible");
11346 DEFSYM (QChelp
, ":help");
11347 DEFSYM (QCfilter
, ":filter");
11348 DEFSYM (QCbutton
, ":button");
11349 DEFSYM (QCkeys
, ":keys");
11350 DEFSYM (QCkey_sequence
, ":key-sequence");
11351 DEFSYM (QCtoggle
, ":toggle");
11352 DEFSYM (QCradio
, ":radio");
11353 DEFSYM (QClabel
, ":label");
11354 DEFSYM (QCvert_only
, ":vert-only");
11356 DEFSYM (Qmode_line
, "mode-line");
11357 DEFSYM (Qvertical_line
, "vertical-line");
11358 DEFSYM (Qvertical_scroll_bar
, "vertical-scroll-bar");
11359 DEFSYM (Qmenu_bar
, "menu-bar");
11361 DEFSYM (Qmouse_fixup_help_message
, "mouse-fixup-help-message");
11363 DEFSYM (Qabove_handle
, "above-handle");
11364 DEFSYM (Qhandle
, "handle");
11365 DEFSYM (Qbelow_handle
, "below-handle");
11366 DEFSYM (Qup
, "up");
11367 DEFSYM (Qdown
, "down");
11368 DEFSYM (Qtop
, "top");
11369 DEFSYM (Qbottom
, "bottom");
11370 DEFSYM (Qend_scroll
, "end-scroll");
11371 DEFSYM (Qratio
, "ratio");
11373 DEFSYM (Qevent_kind
, "event-kind");
11374 DEFSYM (Qevent_symbol_elements
, "event-symbol-elements");
11375 DEFSYM (Qevent_symbol_element_mask
, "event-symbol-element-mask");
11376 DEFSYM (Qmodifier_cache
, "modifier-cache");
11378 DEFSYM (Qrecompute_lucid_menubar
, "recompute-lucid-menubar");
11379 DEFSYM (Qactivate_menubar_hook
, "activate-menubar-hook");
11381 DEFSYM (Qpolling_period
, "polling-period");
11383 DEFSYM (Qx_set_selection
, "x-set-selection");
11384 DEFSYM (QPRIMARY
, "PRIMARY");
11385 DEFSYM (Qhandle_switch_frame
, "handle-switch-frame");
11386 DEFSYM (Qhandle_select_window
, "handle-select-window");
11388 DEFSYM (Qinput_method_function
, "input-method-function");
11389 DEFSYM (Qinput_method_exit_on_first_char
, "input-method-exit-on-first-char");
11390 DEFSYM (Qinput_method_use_echo_area
, "input-method-use-echo-area");
11392 DEFSYM (Qhelp_form_show
, "help-form-show");
11394 Fset (Qinput_method_exit_on_first_char
, Qnil
);
11395 Fset (Qinput_method_use_echo_area
, Qnil
);
11397 last_point_position_buffer
= Qnil
;
11398 last_point_position_window
= Qnil
;
11402 int len
= sizeof (head_table
) / sizeof (head_table
[0]);
11404 for (i
= 0; i
< len
; i
++)
11406 const struct event_head
*p
= &head_table
[i
];
11407 *p
->var
= intern_c_string (p
->name
);
11408 staticpro (p
->var
);
11409 Fput (*p
->var
, Qevent_kind
, *p
->kind
);
11410 Fput (*p
->var
, Qevent_symbol_elements
, Fcons (*p
->var
, Qnil
));
11414 button_down_location
= Fmake_vector (make_number (5), Qnil
);
11415 staticpro (&button_down_location
);
11416 mouse_syms
= Fmake_vector (make_number (5), Qnil
);
11417 staticpro (&mouse_syms
);
11418 wheel_syms
= Fmake_vector (make_number (sizeof (lispy_wheel_names
)
11419 / sizeof (lispy_wheel_names
[0])),
11421 staticpro (&wheel_syms
);
11425 int len
= sizeof (modifier_names
) / sizeof (modifier_names
[0]);
11427 modifier_symbols
= Fmake_vector (make_number (len
), Qnil
);
11428 for (i
= 0; i
< len
; i
++)
11429 if (modifier_names
[i
])
11430 ASET (modifier_symbols
, i
, intern_c_string (modifier_names
[i
]));
11431 staticpro (&modifier_symbols
);
11434 recent_keys
= Fmake_vector (make_number (NUM_RECENT_KEYS
), Qnil
);
11435 staticpro (&recent_keys
);
11437 this_command_keys
= Fmake_vector (make_number (40), Qnil
);
11438 staticpro (&this_command_keys
);
11440 raw_keybuf
= Fmake_vector (make_number (30), Qnil
);
11441 staticpro (&raw_keybuf
);
11443 DEFSYM (Qextended_command_history
, "extended-command-history");
11444 Fset (Qextended_command_history
, Qnil
);
11446 accent_key_syms
= Qnil
;
11447 staticpro (&accent_key_syms
);
11449 func_key_syms
= Qnil
;
11450 staticpro (&func_key_syms
);
11452 drag_n_drop_syms
= Qnil
;
11453 staticpro (&drag_n_drop_syms
);
11455 unread_switch_frame
= Qnil
;
11456 staticpro (&unread_switch_frame
);
11458 internal_last_event_frame
= Qnil
;
11459 staticpro (&internal_last_event_frame
);
11461 read_key_sequence_cmd
= Qnil
;
11462 staticpro (&read_key_sequence_cmd
);
11463 read_key_sequence_remapped
= Qnil
;
11464 staticpro (&read_key_sequence_remapped
);
11466 menu_bar_one_keymap_changed_items
= Qnil
;
11467 staticpro (&menu_bar_one_keymap_changed_items
);
11469 menu_bar_items_vector
= Qnil
;
11470 staticpro (&menu_bar_items_vector
);
11472 help_form_saved_window_configs
= Qnil
;
11473 staticpro (&help_form_saved_window_configs
);
11475 defsubr (&Scurrent_idle_time
);
11476 defsubr (&Sevent_symbol_parse_modifiers
);
11477 defsubr (&Sevent_convert_list
);
11478 defsubr (&Sread_key_sequence
);
11479 defsubr (&Sread_key_sequence_vector
);
11480 defsubr (&Srecursive_edit
);
11481 defsubr (&Strack_mouse
);
11482 defsubr (&Sinput_pending_p
);
11483 defsubr (&Scommand_execute
);
11484 defsubr (&Srecent_keys
);
11485 defsubr (&Sthis_command_keys
);
11486 defsubr (&Sthis_command_keys_vector
);
11487 defsubr (&Sthis_single_command_keys
);
11488 defsubr (&Sthis_single_command_raw_keys
);
11489 defsubr (&Sreset_this_command_lengths
);
11490 defsubr (&Sclear_this_command_keys
);
11491 defsubr (&Ssuspend_emacs
);
11492 defsubr (&Sabort_recursive_edit
);
11493 defsubr (&Sexit_recursive_edit
);
11494 defsubr (&Srecursion_depth
);
11495 defsubr (&Stop_level
);
11496 defsubr (&Sdiscard_input
);
11497 defsubr (&Sopen_dribble_file
);
11498 defsubr (&Sset_input_interrupt_mode
);
11499 defsubr (&Sset_output_flow_control
);
11500 defsubr (&Sset_input_meta_mode
);
11501 defsubr (&Sset_quit_char
);
11502 defsubr (&Sset_input_mode
);
11503 defsubr (&Scurrent_input_mode
);
11504 defsubr (&Sposn_at_point
);
11505 defsubr (&Sposn_at_x_y
);
11507 DEFVAR_LISP ("last-command-event", last_command_event
,
11508 doc
: /* Last input event that was part of a command. */);
11510 DEFVAR_LISP ("last-nonmenu-event", last_nonmenu_event
,
11511 doc
: /* Last input event in a command, except for mouse menu events.
11512 Mouse menus give back keys that don't look like mouse events;
11513 this variable holds the actual mouse event that led to the menu,
11514 so that you can determine whether the command was run by mouse or not. */);
11516 DEFVAR_LISP ("last-input-event", last_input_event
,
11517 doc
: /* Last input event. */);
11519 DEFVAR_LISP ("unread-command-events", Vunread_command_events
,
11520 doc
: /* List of events to be read as the command input.
11521 These events are processed first, before actual keyboard input.
11522 Events read from this list are not normally added to `this-command-keys',
11523 as they will already have been added once as they were read for the first time.
11524 An element of the form (t . EVENT) forces EVENT to be added to that list. */);
11525 Vunread_command_events
= Qnil
;
11527 DEFVAR_LISP ("unread-post-input-method-events", Vunread_post_input_method_events
,
11528 doc
: /* List of events to be processed as input by input methods.
11529 These events are processed before `unread-command-events'
11530 and actual keyboard input, but are not given to `input-method-function'. */);
11531 Vunread_post_input_method_events
= Qnil
;
11533 DEFVAR_LISP ("unread-input-method-events", Vunread_input_method_events
,
11534 doc
: /* List of events to be processed as input by input methods.
11535 These events are processed after `unread-command-events', but
11536 before actual keyboard input.
11537 If there's an active input method, the events are given to
11538 `input-method-function'. */);
11539 Vunread_input_method_events
= Qnil
;
11541 DEFVAR_LISP ("meta-prefix-char", meta_prefix_char
,
11542 doc
: /* Meta-prefix character code.
11543 Meta-foo as command input turns into this character followed by foo. */);
11544 XSETINT (meta_prefix_char
, 033);
11546 DEFVAR_KBOARD ("last-command", Vlast_command
,
11547 doc
: /* The last command executed.
11548 Normally a symbol with a function definition, but can be whatever was found
11549 in the keymap, or whatever the variable `this-command' was set to by that
11552 The value `mode-exit' is special; it means that the previous command
11553 read an event that told it to exit, and it did so and unread that event.
11554 In other words, the present command is the event that made the previous
11557 The value `kill-region' is special; it means that the previous command
11558 was a kill command.
11560 `last-command' has a separate binding for each terminal device.
11561 See Info node `(elisp)Multiple Terminals'. */);
11563 DEFVAR_KBOARD ("real-last-command", Vreal_last_command
,
11564 doc
: /* Same as `last-command', but never altered by Lisp code.
11565 Taken from the previous value of `real-this-command'. */);
11567 DEFVAR_KBOARD ("last-repeatable-command", Vlast_repeatable_command
,
11568 doc
: /* Last command that may be repeated.
11569 The last command executed that was not bound to an input event.
11570 This is the command `repeat' will try to repeat.
11571 Taken from a previous value of `real-this-command'. */);
11573 DEFVAR_LISP ("this-command", Vthis_command
,
11574 doc
: /* The command now being executed.
11575 The command can set this variable; whatever is put here
11576 will be in `last-command' during the following command. */);
11577 Vthis_command
= Qnil
;
11579 DEFVAR_LISP ("real-this-command", Vreal_this_command
,
11580 doc
: /* This is like `this-command', except that commands should never modify it. */);
11581 Vreal_this_command
= Qnil
;
11583 DEFVAR_LISP ("this-command-keys-shift-translated",
11584 Vthis_command_keys_shift_translated
,
11585 doc
: /* Non-nil if the key sequence activating this command was shift-translated.
11586 Shift-translation occurs when there is no binding for the key sequence
11587 as entered, but a binding was found by changing an upper-case letter
11588 to lower-case, or a shifted function key to an unshifted one. */);
11589 Vthis_command_keys_shift_translated
= Qnil
;
11591 DEFVAR_LISP ("this-original-command", Vthis_original_command
,
11592 doc
: /* The command bound to the current key sequence before remapping.
11593 It equals `this-command' if the original command was not remapped through
11594 any of the active keymaps. Otherwise, the value of `this-command' is the
11595 result of looking up the original command in the active keymaps. */);
11596 Vthis_original_command
= Qnil
;
11598 DEFVAR_INT ("auto-save-interval", auto_save_interval
,
11599 doc
: /* Number of input events between auto-saves.
11600 Zero means disable autosaving due to number of characters typed. */);
11601 auto_save_interval
= 300;
11603 DEFVAR_LISP ("auto-save-timeout", Vauto_save_timeout
,
11604 doc
: /* Number of seconds idle time before auto-save.
11605 Zero or nil means disable auto-saving due to idleness.
11606 After auto-saving due to this many seconds of idle time,
11607 Emacs also does a garbage collection if that seems to be warranted. */);
11608 XSETFASTINT (Vauto_save_timeout
, 30);
11610 DEFVAR_LISP ("echo-keystrokes", Vecho_keystrokes
,
11611 doc
: /* Nonzero means echo unfinished commands after this many seconds of pause.
11612 The value may be integer or floating point.
11613 If the value is zero, don't echo at all. */);
11614 Vecho_keystrokes
= make_number (1);
11616 DEFVAR_INT ("polling-period", polling_period
,
11617 doc
: /* Interval between polling for input during Lisp execution.
11618 The reason for polling is to make C-g work to stop a running program.
11619 Polling is needed only when using X windows and SIGIO does not work.
11620 Polling is automatically disabled in all other cases. */);
11621 polling_period
= 2;
11623 DEFVAR_LISP ("double-click-time", Vdouble_click_time
,
11624 doc
: /* Maximum time between mouse clicks to make a double-click.
11625 Measured in milliseconds. The value nil means disable double-click
11626 recognition; t means double-clicks have no time limit and are detected
11627 by position only. */);
11628 Vdouble_click_time
= make_number (500);
11630 DEFVAR_INT ("double-click-fuzz", double_click_fuzz
,
11631 doc
: /* Maximum mouse movement between clicks to make a double-click.
11632 On window-system frames, value is the number of pixels the mouse may have
11633 moved horizontally or vertically between two clicks to make a double-click.
11634 On non window-system frames, value is interpreted in units of 1/8 characters
11637 This variable is also the threshold for motion of the mouse
11638 to count as a drag. */);
11639 double_click_fuzz
= 3;
11641 DEFVAR_BOOL ("inhibit-local-menu-bar-menus", inhibit_local_menu_bar_menus
,
11642 doc
: /* Non-nil means inhibit local map menu bar menus. */);
11643 inhibit_local_menu_bar_menus
= 0;
11645 DEFVAR_INT ("num-input-keys", num_input_keys
,
11646 doc
: /* Number of complete key sequences read as input so far.
11647 This includes key sequences read from keyboard macros.
11648 The number is effectively the number of interactive command invocations. */);
11649 num_input_keys
= 0;
11651 DEFVAR_INT ("num-nonmacro-input-events", num_nonmacro_input_events
,
11652 doc
: /* Number of input events read from the keyboard so far.
11653 This does not include events generated by keyboard macros. */);
11654 num_nonmacro_input_events
= 0;
11656 DEFVAR_LISP ("last-event-frame", Vlast_event_frame
,
11657 doc
: /* The frame in which the most recently read event occurred.
11658 If the last event came from a keyboard macro, this is set to `macro'. */);
11659 Vlast_event_frame
= Qnil
;
11661 /* This variable is set up in sysdep.c. */
11662 DEFVAR_LISP ("tty-erase-char", Vtty_erase_char
,
11663 doc
: /* The ERASE character as set by the user with stty. */);
11665 DEFVAR_LISP ("help-char", Vhelp_char
,
11666 doc
: /* Character to recognize as meaning Help.
11667 When it is read, do `(eval help-form)', and display result if it's a string.
11668 If the value of `help-form' is nil, this char can be read normally. */);
11669 XSETINT (Vhelp_char
, Ctl ('H'));
11671 DEFVAR_LISP ("help-event-list", Vhelp_event_list
,
11672 doc
: /* List of input events to recognize as meaning Help.
11673 These work just like the value of `help-char' (see that). */);
11674 Vhelp_event_list
= Qnil
;
11676 DEFVAR_LISP ("help-form", Vhelp_form
,
11677 doc
: /* Form to execute when character `help-char' is read.
11678 If the form returns a string, that string is displayed.
11679 If `help-form' is nil, the help char is not recognized. */);
11682 DEFVAR_LISP ("prefix-help-command", Vprefix_help_command
,
11683 doc
: /* Command to run when `help-char' character follows a prefix key.
11684 This command is used only when there is no actual binding
11685 for that character after that prefix key. */);
11686 Vprefix_help_command
= Qnil
;
11688 DEFVAR_LISP ("top-level", Vtop_level
,
11689 doc
: /* Form to evaluate when Emacs starts up.
11690 Useful to set before you dump a modified Emacs. */);
11693 DEFVAR_KBOARD ("keyboard-translate-table", Vkeyboard_translate_table
,
11694 doc
: /* Translate table for local keyboard input, or nil.
11695 If non-nil, the value should be a char-table. Each character read
11696 from the keyboard is looked up in this char-table. If the value found
11697 there is non-nil, then it is used instead of the actual input character.
11699 The value can also be a string or vector, but this is considered obsolete.
11700 If it is a string or vector of length N, character codes N and up are left
11701 untranslated. In a vector, an element which is nil means "no translation".
11703 This is applied to the characters supplied to input methods, not their
11704 output. See also `translation-table-for-input'.
11706 This variable has a separate binding for each terminal.
11707 See Info node `(elisp)Multiple Terminals'. */);
11709 DEFVAR_BOOL ("cannot-suspend", cannot_suspend
,
11710 doc
: /* Non-nil means to always spawn a subshell instead of suspending.
11711 \(Even if the operating system has support for stopping a process.\) */);
11712 cannot_suspend
= 0;
11714 DEFVAR_BOOL ("menu-prompting", menu_prompting
,
11715 doc
: /* Non-nil means prompt with menus when appropriate.
11716 This is done when reading from a keymap that has a prompt string,
11717 for elements that have prompt strings.
11718 The menu is displayed on the screen
11719 if X menus were enabled at configuration
11720 time and the previous event was a mouse click prefix key.
11721 Otherwise, menu prompting uses the echo area. */);
11722 menu_prompting
= 1;
11724 DEFVAR_LISP ("menu-prompt-more-char", menu_prompt_more_char
,
11725 doc
: /* Character to see next line of menu prompt.
11726 Type this character while in a menu prompt to rotate around the lines of it. */);
11727 XSETINT (menu_prompt_more_char
, ' ');
11729 DEFVAR_INT ("extra-keyboard-modifiers", extra_keyboard_modifiers
,
11730 doc
: /* A mask of additional modifier keys to use with every keyboard character.
11731 Emacs applies the modifiers of the character stored here to each keyboard
11732 character it reads. For example, after evaluating the expression
11733 (setq extra-keyboard-modifiers ?\\C-x)
11734 all input characters will have the control modifier applied to them.
11736 Note that the character ?\\C-@, equivalent to the integer zero, does
11737 not count as a control character; rather, it counts as a character
11738 with no modifiers; thus, setting `extra-keyboard-modifiers' to zero
11739 cancels any modification. */);
11740 extra_keyboard_modifiers
= 0;
11742 DEFVAR_LISP ("deactivate-mark", Vdeactivate_mark
,
11743 doc
: /* If an editing command sets this to t, deactivate the mark afterward.
11744 The command loop sets this to nil before each command,
11745 and tests the value when the command returns.
11746 Buffer modification stores t in this variable. */);
11747 Vdeactivate_mark
= Qnil
;
11748 DEFSYM (Qdeactivate_mark
, "deactivate-mark");
11750 DEFVAR_LISP ("pre-command-hook", Vpre_command_hook
,
11751 doc
: /* Normal hook run before each command is executed.
11752 If an unhandled error happens in running this hook,
11753 the function in which the error occurred is unconditionally removed, since
11754 otherwise the error might happen repeatedly and make Emacs nonfunctional. */);
11755 Vpre_command_hook
= Qnil
;
11757 DEFVAR_LISP ("post-command-hook", Vpost_command_hook
,
11758 doc
: /* Normal hook run after each command is executed.
11759 If an unhandled error happens in running this hook,
11760 the function in which the error occurred is unconditionally removed, since
11761 otherwise the error might happen repeatedly and make Emacs nonfunctional. */);
11762 Vpost_command_hook
= Qnil
;
11765 DEFVAR_LISP ("echo-area-clear-hook", ...,
11766 doc
: /* Normal hook run when clearing the echo area. */);
11768 DEFSYM (Qecho_area_clear_hook
, "echo-area-clear-hook");
11769 Fset (Qecho_area_clear_hook
, Qnil
);
11771 DEFVAR_LISP ("lucid-menu-bar-dirty-flag", Vlucid_menu_bar_dirty_flag
,
11772 doc
: /* Non-nil means menu bar, specified Lucid style, needs to be recomputed. */);
11773 Vlucid_menu_bar_dirty_flag
= Qnil
;
11775 DEFVAR_LISP ("menu-bar-final-items", Vmenu_bar_final_items
,
11776 doc
: /* List of menu bar items to move to the end of the menu bar.
11777 The elements of the list are event types that may have menu bar bindings. */);
11778 Vmenu_bar_final_items
= Qnil
;
11780 DEFVAR_LISP ("tool-bar-separator-image-expression", Vtool_bar_separator_image_expression
,
11781 doc
: /* Expression evaluating to the image spec for a tool-bar separator.
11782 This is used internally by graphical displays that do not render
11783 tool-bar separators natively. Otherwise it is unused (e.g. on GTK). */);
11784 Vtool_bar_separator_image_expression
= Qnil
;
11786 DEFVAR_KBOARD ("overriding-terminal-local-map",
11787 Voverriding_terminal_local_map
,
11788 doc
: /* Per-terminal keymap that overrides all other local keymaps.
11789 If this variable is non-nil, it is used as a keymap instead of the
11790 buffer's local map, and the minor mode keymaps and text property keymaps.
11791 It also replaces `overriding-local-map'.
11793 This variable is intended to let commands such as `universal-argument'
11794 set up a different keymap for reading the next command.
11796 `overriding-terminal-local-map' has a separate binding for each
11798 See Info node `(elisp)Multiple Terminals'. */);
11800 DEFVAR_LISP ("overriding-local-map", Voverriding_local_map
,
11801 doc
: /* Keymap that overrides all other local keymaps.
11802 If this variable is non-nil, it is used as a keymap--replacing the
11803 buffer's local map, the minor mode keymaps, and char property keymaps. */);
11804 Voverriding_local_map
= Qnil
;
11806 DEFVAR_LISP ("overriding-local-map-menu-flag", Voverriding_local_map_menu_flag
,
11807 doc
: /* Non-nil means `overriding-local-map' applies to the menu bar.
11808 Otherwise, the menu bar continues to reflect the buffer's local map
11809 and the minor mode maps regardless of `overriding-local-map'. */);
11810 Voverriding_local_map_menu_flag
= Qnil
;
11812 DEFVAR_LISP ("special-event-map", Vspecial_event_map
,
11813 doc
: /* Keymap defining bindings for special events to execute at low level. */);
11814 Vspecial_event_map
= Fcons (intern_c_string ("keymap"), Qnil
);
11816 DEFVAR_LISP ("track-mouse", do_mouse_tracking
,
11817 doc
: /* Non-nil means generate motion events for mouse motion. */);
11819 DEFVAR_KBOARD ("system-key-alist", Vsystem_key_alist
,
11820 doc
: /* Alist of system-specific X windows key symbols.
11821 Each element should have the form (N . SYMBOL) where N is the
11822 numeric keysym code (sans the \"system-specific\" bit 1<<28)
11823 and SYMBOL is its name.
11825 `system-key-alist' has a separate binding for each terminal device.
11826 See Info node `(elisp)Multiple Terminals'. */);
11828 DEFVAR_KBOARD ("local-function-key-map", Vlocal_function_key_map
,
11829 doc
: /* Keymap that translates key sequences to key sequences during input.
11830 This is used mainly for mapping key sequences into some preferred
11831 key events (symbols).
11833 The `read-key-sequence' function replaces any subsequence bound by
11834 `local-function-key-map' with its binding. More precisely, when the
11835 active keymaps have no binding for the current key sequence but
11836 `local-function-key-map' binds a suffix of the sequence to a vector or
11837 string, `read-key-sequence' replaces the matching suffix with its
11838 binding, and continues with the new sequence.
11840 If the binding is a function, it is called with one argument (the prompt)
11841 and its return value (a key sequence) is used.
11843 The events that come from bindings in `local-function-key-map' are not
11844 themselves looked up in `local-function-key-map'.
11846 For example, suppose `local-function-key-map' binds `ESC O P' to [f1].
11847 Typing `ESC O P' to `read-key-sequence' would return [f1]. Typing
11848 `C-x ESC O P' would return [?\\C-x f1]. If [f1] were a prefix key,
11849 typing `ESC O P x' would return [f1 x].
11851 `local-function-key-map' has a separate binding for each terminal
11852 device. See Info node `(elisp)Multiple Terminals'. If you need to
11853 define a binding on all terminals, change `function-key-map'
11854 instead. Initially, `local-function-key-map' is an empty keymap that
11855 has `function-key-map' as its parent on all terminal devices. */);
11857 DEFVAR_KBOARD ("input-decode-map", Vinput_decode_map
,
11858 doc
: /* Keymap that decodes input escape sequences.
11859 This is used mainly for mapping ASCII function key sequences into
11860 real Emacs function key events (symbols).
11862 The `read-key-sequence' function replaces any subsequence bound by
11863 `input-decode-map' with its binding. Contrary to `function-key-map',
11864 this map applies its rebinding regardless of the presence of an ordinary
11865 binding. So it is more like `key-translation-map' except that it applies
11866 before `function-key-map' rather than after.
11868 If the binding is a function, it is called with one argument (the prompt)
11869 and its return value (a key sequence) is used.
11871 The events that come from bindings in `input-decode-map' are not
11872 themselves looked up in `input-decode-map'.
11874 This variable is keyboard-local. */);
11876 DEFVAR_LISP ("function-key-map", Vfunction_key_map
,
11877 doc
: /* The parent keymap of all `local-function-key-map' instances.
11878 Function key definitions that apply to all terminal devices should go
11879 here. If a mapping is defined in both the current
11880 `local-function-key-map' binding and this variable, then the local
11881 definition will take precedence. */);
11882 Vfunction_key_map
= Fmake_sparse_keymap (Qnil
);
11884 DEFVAR_LISP ("key-translation-map", Vkey_translation_map
,
11885 doc
: /* Keymap of key translations that can override keymaps.
11886 This keymap works like `function-key-map', but comes after that,
11887 and its non-prefix bindings override ordinary bindings.
11888 Another difference is that it is global rather than keyboard-local. */);
11889 Vkey_translation_map
= Fmake_sparse_keymap (Qnil
);
11891 DEFVAR_LISP ("deferred-action-list", Vdeferred_action_list
,
11892 doc
: /* List of deferred actions to be performed at a later time.
11893 The precise format isn't relevant here; we just check whether it is nil. */);
11894 Vdeferred_action_list
= Qnil
;
11896 DEFVAR_LISP ("deferred-action-function", Vdeferred_action_function
,
11897 doc
: /* Function to call to handle deferred actions, after each command.
11898 This function is called with no arguments after each command
11899 whenever `deferred-action-list' is non-nil. */);
11900 Vdeferred_action_function
= Qnil
;
11902 DEFVAR_LISP ("delayed-warnings-list", Vdelayed_warnings_list
,
11903 doc
: /* List of warnings to be displayed after this command.
11904 Each element must be a list (TYPE MESSAGE [LEVEL [BUFFER-NAME]]),
11905 as per the args of `display-warning' (which see).
11906 If this variable is non-nil, `delayed-warnings-hook' will be run
11907 immediately after running `post-command-hook'. */);
11908 Vdelayed_warnings_list
= Qnil
;
11910 DEFVAR_LISP ("timer-list", Vtimer_list
,
11911 doc
: /* List of active absolute time timers in order of increasing time. */);
11912 Vtimer_list
= Qnil
;
11914 DEFVAR_LISP ("timer-idle-list", Vtimer_idle_list
,
11915 doc
: /* List of active idle-time timers in order of increasing time. */);
11916 Vtimer_idle_list
= Qnil
;
11918 DEFVAR_LISP ("input-method-function", Vinput_method_function
,
11919 doc
: /* If non-nil, the function that implements the current input method.
11920 It's called with one argument, a printing character that was just read.
11921 \(That means a character with code 040...0176.)
11922 Typically this function uses `read-event' to read additional events.
11923 When it does so, it should first bind `input-method-function' to nil
11924 so it will not be called recursively.
11926 The function should return a list of zero or more events
11927 to be used as input. If it wants to put back some events
11928 to be reconsidered, separately, by the input method,
11929 it can add them to the beginning of `unread-command-events'.
11931 The input method function can find in `input-method-previous-message'
11932 the previous echo area message.
11934 The input method function should refer to the variables
11935 `input-method-use-echo-area' and `input-method-exit-on-first-char'
11936 for guidance on what to do. */);
11937 Vinput_method_function
= Qnil
;
11939 DEFVAR_LISP ("input-method-previous-message",
11940 Vinput_method_previous_message
,
11941 doc
: /* When `input-method-function' is called, hold the previous echo area message.
11942 This variable exists because `read-event' clears the echo area
11943 before running the input method. It is nil if there was no message. */);
11944 Vinput_method_previous_message
= Qnil
;
11946 DEFVAR_LISP ("show-help-function", Vshow_help_function
,
11947 doc
: /* If non-nil, the function that implements the display of help.
11948 It's called with one argument, the help string to display. */);
11949 Vshow_help_function
= Qnil
;
11951 DEFVAR_LISP ("disable-point-adjustment", Vdisable_point_adjustment
,
11952 doc
: /* If non-nil, suppress point adjustment after executing a command.
11954 After a command is executed, if point is moved into a region that has
11955 special properties (e.g. composition, display), we adjust point to
11956 the boundary of the region. But, when a command sets this variable to
11957 non-nil, we suppress the point adjustment.
11959 This variable is set to nil before reading a command, and is checked
11960 just after executing the command. */);
11961 Vdisable_point_adjustment
= Qnil
;
11963 DEFVAR_LISP ("global-disable-point-adjustment",
11964 Vglobal_disable_point_adjustment
,
11965 doc
: /* If non-nil, always suppress point adjustment.
11967 The default value is nil, in which case, point adjustment are
11968 suppressed only after special commands that set
11969 `disable-point-adjustment' (which see) to non-nil. */);
11970 Vglobal_disable_point_adjustment
= Qnil
;
11972 DEFVAR_LISP ("minibuffer-message-timeout", Vminibuffer_message_timeout
,
11973 doc
: /* How long to display an echo-area message when the minibuffer is active.
11974 If the value is not a number, such messages don't time out. */);
11975 Vminibuffer_message_timeout
= make_number (2);
11977 DEFVAR_LISP ("throw-on-input", Vthrow_on_input
,
11978 doc
: /* If non-nil, any keyboard input throws to this symbol.
11979 The value of that variable is passed to `quit-flag' and later causes a
11980 peculiar kind of quitting. */);
11981 Vthrow_on_input
= Qnil
;
11983 DEFVAR_LISP ("command-error-function", Vcommand_error_function
,
11984 doc
: /* If non-nil, function to output error messages.
11985 The arguments are the error data, a list of the form
11986 (SIGNALED-CONDITIONS . SIGNAL-DATA)
11987 such as just as `condition-case' would bind its variable to,
11988 the context (a string which normally goes at the start of the message),
11989 and the Lisp function within which the error was signaled. */);
11990 Vcommand_error_function
= Qnil
;
11992 DEFVAR_LISP ("enable-disabled-menus-and-buttons",
11993 Venable_disabled_menus_and_buttons
,
11994 doc
: /* If non-nil, don't ignore events produced by disabled menu items and tool-bar.
11996 Help functions bind this to allow help on disabled menu items
11997 and tool-bar buttons. */);
11998 Venable_disabled_menus_and_buttons
= Qnil
;
12000 DEFVAR_LISP ("select-active-regions",
12001 Vselect_active_regions
,
12002 doc
: /* If non-nil, an active region automatically sets the primary selection.
12003 If the value is `only', only temporarily active regions (usually made
12004 by mouse-dragging or shift-selection) set the window selection.
12006 This takes effect only when Transient Mark mode is enabled. */);
12007 Vselect_active_regions
= Qt
;
12009 DEFVAR_LISP ("saved-region-selection",
12010 Vsaved_region_selection
,
12011 doc
: /* Contents of active region prior to buffer modification.
12012 If `select-active-regions' is non-nil, Emacs sets this to the
12013 text in the region before modifying the buffer. The next
12014 `deactivate-mark' call uses this to set the window selection. */);
12015 Vsaved_region_selection
= Qnil
;
12017 DEFVAR_LISP ("selection-inhibit-update-commands",
12018 Vselection_inhibit_update_commands
,
12019 doc
: /* List of commands which should not update the selection.
12020 Normally, if `select-active-regions' is non-nil and the mark remains
12021 active after a command (i.e. the mark was not deactivated), the Emacs
12022 command loop sets the selection to the text in the region. However,
12023 if the command is in this list, the selection is not updated. */);
12024 Vselection_inhibit_update_commands
12025 = list2 (Qhandle_switch_frame
, Qhandle_select_window
);
12027 DEFVAR_LISP ("debug-on-event",
12029 doc
: /* Enter debugger on this event. When Emacs
12030 receives the special event specified by this variable, it will try to
12031 break into the debugger as soon as possible instead of processing the
12032 event normally through `special-event-map'.
12034 Currently, the only supported values for this
12035 variable are `sigusr1' and `sigusr2'. */);
12036 Vdebug_on_event
= intern_c_string ("sigusr2");
12038 /* Create the initial keyboard. */
12039 initial_kboard
= xmalloc (sizeof *initial_kboard
);
12040 init_kboard (initial_kboard
);
12041 /* Vwindow_system is left at t for now. */
12042 initial_kboard
->next_kboard
= all_kboards
;
12043 all_kboards
= initial_kboard
;
12047 keys_of_keyboard (void)
12049 initial_define_key (global_map
, Ctl ('Z'), "suspend-emacs");
12050 initial_define_key (control_x_map
, Ctl ('Z'), "suspend-emacs");
12051 initial_define_key (meta_map
, Ctl ('C'), "exit-recursive-edit");
12052 initial_define_key (global_map
, Ctl (']'), "abort-recursive-edit");
12053 initial_define_key (meta_map
, 'x', "execute-extended-command");
12055 initial_define_lispy_key (Vspecial_event_map
, "delete-frame",
12056 "handle-delete-frame");
12057 initial_define_lispy_key (Vspecial_event_map
, "ns-put-working-text",
12058 "ns-put-working-text");
12059 initial_define_lispy_key (Vspecial_event_map
, "ns-unput-working-text",
12060 "ns-unput-working-text");
12061 /* Here we used to use `ignore-event' which would simple set prefix-arg to
12062 current-prefix-arg, as is done in `handle-switch-frame'.
12063 But `handle-switch-frame is not run from the special-map.
12064 Commands from that map are run in a special way that automatically
12065 preserves the prefix-arg. Restoring the prefix arg here is not just
12066 redundant but harmful:
12068 - current-prefix-arg is set to non-nil, prefix-arg is set to nil.
12069 - after the first prompt, the exit-minibuffer-hook is run which may
12070 iconify a frame and thus push a `iconify-frame' event.
12071 - after running exit-minibuffer-hook, current-prefix-arg is
12072 restored to the non-nil value it had before the prompt.
12073 - we enter the second prompt.
12074 current-prefix-arg is non-nil, prefix-arg is nil.
12075 - before running the first real event, we run the special iconify-frame
12076 event, but we pass the `special' arg to execute-command so
12077 current-prefix-arg and prefix-arg are left untouched.
12078 - here we foolishly copy the non-nil current-prefix-arg to prefix-arg.
12079 - the next key event will have a spuriously non-nil current-prefix-arg. */
12080 initial_define_lispy_key (Vspecial_event_map
, "iconify-frame",
12082 initial_define_lispy_key (Vspecial_event_map
, "make-frame-visible",
12084 /* Handling it at such a low-level causes read_key_sequence to get
12085 * confused because it doesn't realize that the current_buffer was
12086 * changed by read_char.
12088 * initial_define_lispy_key (Vspecial_event_map, "select-window",
12089 * "handle-select-window"); */
12090 initial_define_lispy_key (Vspecial_event_map
, "save-session",
12091 "handle-save-session");
12094 /* Define a special event which is raised for dbus callback
12096 initial_define_lispy_key (Vspecial_event_map
, "dbus-event",
12097 "dbus-handle-event");
12100 initial_define_lispy_key (Vspecial_event_map
, "config-changed-event",
12102 #if defined (WINDOWSNT)
12103 initial_define_lispy_key (Vspecial_event_map
, "language-change",
12108 /* Mark the pointers in the kboard objects.
12109 Called by Fgarbage_collect. */
12111 mark_kboards (void)
12115 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
12117 if (kb
->kbd_macro_buffer
)
12118 for (p
= kb
->kbd_macro_buffer
; p
< kb
->kbd_macro_ptr
; p
++)
12120 mark_object (KVAR (kb
, Voverriding_terminal_local_map
));
12121 mark_object (KVAR (kb
, Vlast_command
));
12122 mark_object (KVAR (kb
, Vreal_last_command
));
12123 mark_object (KVAR (kb
, Vkeyboard_translate_table
));
12124 mark_object (KVAR (kb
, Vlast_repeatable_command
));
12125 mark_object (KVAR (kb
, Vprefix_arg
));
12126 mark_object (KVAR (kb
, Vlast_prefix_arg
));
12127 mark_object (KVAR (kb
, kbd_queue
));
12128 mark_object (KVAR (kb
, defining_kbd_macro
));
12129 mark_object (KVAR (kb
, Vlast_kbd_macro
));
12130 mark_object (KVAR (kb
, Vsystem_key_alist
));
12131 mark_object (KVAR (kb
, system_key_syms
));
12132 mark_object (KVAR (kb
, Vwindow_system
));
12133 mark_object (KVAR (kb
, Vinput_decode_map
));
12134 mark_object (KVAR (kb
, Vlocal_function_key_map
));
12135 mark_object (KVAR (kb
, Vdefault_minibuffer_frame
));
12136 mark_object (KVAR (kb
, echo_string
));
12139 struct input_event
*event
;
12140 for (event
= kbd_fetch_ptr
; event
!= kbd_store_ptr
; event
++)
12142 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
12143 event
= kbd_buffer
;
12144 /* These two special event types has no Lisp_Objects to mark. */
12145 if (event
->kind
!= SELECTION_REQUEST_EVENT
12146 && event
->kind
!= SELECTION_CLEAR_EVENT
)
12148 mark_object (event
->x
);
12149 mark_object (event
->y
);
12150 mark_object (event
->frame_or_window
);
12151 mark_object (event
->arg
);