1 /* Keyboard and mouse input; editor command loop.
3 Copyright (C) 1985-1989, 1993-1997, 1999-2015 Free Software Foundation,
6 This file is part of GNU Emacs.
8 GNU Emacs is free software: you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation, either version 3 of the License, or
11 (at your option) any later version.
13 GNU Emacs is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
30 #include "termhooks.h"
35 #include "character.h"
38 #include "dispextern.h"
40 #include "intervals.h"
42 #include "blockinput.h"
56 #include <sys/ioctl.h>
57 #endif /* not MSDOS */
59 #if defined USABLE_FIONREAD && defined USG5_4
60 # include <sys/filio.h>
63 #include "syssignal.h"
65 #include <sys/types.h>
69 #ifdef HAVE_WINDOW_SYSTEM
71 #endif /* HAVE_WINDOW_SYSTEM */
73 /* Variables for blockinput.h: */
75 /* Positive if interrupt input is blocked right now. */
76 volatile int interrupt_input_blocked
;
78 /* True means an input interrupt or alarm signal has arrived.
79 The QUIT macro checks this. */
80 volatile bool pending_signals
;
82 #define KBD_BUFFER_SIZE 4096
84 KBOARD
*initial_kboard
;
85 KBOARD
*current_kboard
;
86 static KBOARD
*all_kboards
;
88 /* True in the single-kboard state, false in the any-kboard state. */
89 static bool single_kboard
;
91 #define NUM_RECENT_KEYS (300)
93 /* Index for storing next element into recent_keys. */
94 static int recent_keys_index
;
96 /* Total number of elements stored into recent_keys. */
97 static int total_keys
;
99 /* This vector holds the last NUM_RECENT_KEYS keystrokes. */
100 static Lisp_Object recent_keys
;
102 /* Vector holding the key sequence that invoked the current command.
103 It is reused for each command, and it may be longer than the current
104 sequence; this_command_key_count indicates how many elements
105 actually mean something.
106 It's easier to staticpro a single Lisp_Object than an array. */
107 Lisp_Object this_command_keys
;
108 ptrdiff_t this_command_key_count
;
110 /* True after calling Freset_this_command_lengths.
111 Usually it is false. */
112 static bool this_command_key_count_reset
;
114 /* This vector is used as a buffer to record the events that were actually read
115 by read_key_sequence. */
116 static Lisp_Object raw_keybuf
;
117 static int raw_keybuf_count
;
119 #define GROW_RAW_KEYBUF \
120 if (raw_keybuf_count == ASIZE (raw_keybuf)) \
121 raw_keybuf = larger_vector (raw_keybuf, 1, -1)
123 /* Number of elements of this_command_keys
124 that precede this key sequence. */
125 static ptrdiff_t this_single_command_key_start
;
127 /* Record values of this_command_key_count and echo_length ()
128 before this command was read. */
129 static ptrdiff_t before_command_key_count
;
130 static ptrdiff_t before_command_echo_length
;
132 #ifdef HAVE_STACK_OVERFLOW_HANDLING
134 /* For longjmp to recover from C stack overflow. */
135 sigjmp_buf return_to_command_loop
;
137 /* Message displayed by Vtop_level when recovering from C stack overflow. */
138 static Lisp_Object recover_top_level_message
;
140 #endif /* HAVE_STACK_OVERFLOW_HANDLING */
142 /* Message normally displayed by Vtop_level. */
143 static Lisp_Object regular_top_level_message
;
145 /* For longjmp to where kbd input is being done. */
147 static sys_jmp_buf getcjmp
;
149 /* True while doing kbd input. */
150 bool waiting_for_input
;
152 /* True while displaying for echoing. Delays C-g throwing. */
156 /* Non-null means we can start echoing at the next input pause even
157 though there is something in the echo area. */
159 static struct kboard
*ok_to_echo_at_next_pause
;
161 /* The kboard last echoing, or null for none. Reset to 0 in
162 cancel_echoing. If non-null, and a current echo area message
163 exists, and echo_message_buffer is eq to the current message
164 buffer, we know that the message comes from echo_kboard. */
166 struct kboard
*echo_kboard
;
168 /* The buffer used for echoing. Set in echo_now, reset in
171 Lisp_Object echo_message_buffer
;
173 /* True means C-g should cause immediate error-signal. */
176 /* Character that causes a quit. Normally C-g.
178 If we are running on an ordinary terminal, this must be an ordinary
179 ASCII char, since we want to make it our interrupt character.
181 If we are not running on an ordinary terminal, it still needs to be
182 an ordinary ASCII char. This character needs to be recognized in
183 the input interrupt handler. At this point, the keystroke is
184 represented as a struct input_event, while the desired quit
185 character is specified as a lispy event. The mapping from struct
186 input_events to lispy events cannot run in an interrupt handler,
187 and the reverse mapping is difficult for anything but ASCII
190 FOR THESE ELABORATE AND UNSATISFYING REASONS, quit_char must be an
194 /* Current depth in recursive edits. */
195 EMACS_INT command_loop_level
;
197 /* If not Qnil, this is a switch-frame event which we decided to put
198 off until the end of a key sequence. This should be read as the
199 next command input, after any unread_command_events.
201 read_key_sequence uses this to delay switch-frame events until the
202 end of the key sequence; Fread_char uses it to put off switch-frame
203 events until a non-ASCII event is acceptable as input. */
204 Lisp_Object unread_switch_frame
;
206 /* Last size recorded for a current buffer which is not a minibuffer. */
207 static ptrdiff_t last_non_minibuf_size
;
209 /* Total number of times read_char has returned, modulo UINTMAX_MAX + 1. */
210 uintmax_t num_input_events
;
212 /* Value of num_nonmacro_input_events as of last auto save. */
214 static EMACS_INT last_auto_save
;
216 /* The value of point when the last command was started. */
217 static ptrdiff_t last_point_position
;
219 /* The frame in which the last input event occurred, or Qmacro if the
220 last event came from a macro. We use this to determine when to
221 generate switch-frame events. This may be cleared by functions
222 like Fselect_frame, to make sure that a switch-frame event is
223 generated by the next character.
225 FIXME: This is modified by a signal handler so it should be volatile.
226 It's exported to Lisp, though, so it can't simply be marked
228 Lisp_Object internal_last_event_frame
;
230 /* `read_key_sequence' stores here the command definition of the
231 key sequence that it reads. */
232 static Lisp_Object read_key_sequence_cmd
;
233 static Lisp_Object read_key_sequence_remapped
;
235 /* File in which we write all commands we read. */
236 static FILE *dribble
;
238 /* True if input is available. */
241 /* True if more input was available last time we read an event.
243 Since redisplay can take a significant amount of time and is not
244 indispensable to perform the user's commands, when input arrives
245 "too fast", Emacs skips redisplay. More specifically, if the next
246 command has already been input when we finish the previous command,
247 we skip the intermediate redisplay.
249 This is useful to try and make sure Emacs keeps up with fast input
250 rates, such as auto-repeating keys. But in some cases, this proves
251 too conservative: we may end up disabling redisplay for the whole
252 duration of a key repetition, even though we could afford to
253 redisplay every once in a while.
255 So we "sample" the input_pending flag before running a command and
256 use *that* value after running the command to decide whether to
257 skip redisplay or not. This way, we only skip redisplay if we
258 really can't keep up with the repeat rate.
260 This only makes a difference if the next input arrives while running the
261 command, which is very unlikely if the command is executed quickly.
262 IOW this tends to avoid skipping redisplay after a long running command
263 (which is a case where skipping redisplay is not very useful since the
264 redisplay time is small compared to the time it took to run the command).
266 A typical use case is when scrolling. Scrolling time can be split into:
267 - Time to do jit-lock on the newly displayed portion of buffer.
268 - Time to run the actual scroll command.
269 - Time to perform the redisplay.
270 Jit-lock can happen either during the command or during the redisplay.
271 In the most painful cases, the jit-lock time is the one that dominates.
272 Also jit-lock can be tweaked (via jit-lock-defer) to delay its job, at the
273 cost of temporary inaccuracy in display and scrolling.
274 So without input_was_pending, what typically happens is the following:
275 - when the command starts, there's no pending input (yet).
276 - the scroll command triggers jit-lock.
277 - during the long jit-lock time the next input arrives.
278 - at the end of the command, we check input_pending and hence decide to
280 - we read the next input and start over.
281 End result: all the hard work of jit-locking is "wasted" since redisplay
282 doesn't actually happens (at least not before the input rate slows down).
283 With input_was_pending redisplay is still skipped if Emacs can't keep up
284 with the input rate, but if it can keep up just enough that there's no
285 input_pending when we begin the command, then redisplay is not skipped
286 which results in better feedback to the user. */
287 static bool input_was_pending
;
289 /* Circular buffer for pre-read keyboard input. */
291 static union buffered_input_event kbd_buffer
[KBD_BUFFER_SIZE
];
293 /* Pointer to next available character in kbd_buffer.
294 If kbd_fetch_ptr == kbd_store_ptr, the buffer is empty.
295 This may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the
296 next available char is in kbd_buffer[0]. */
297 static union buffered_input_event
*kbd_fetch_ptr
;
299 /* Pointer to next place to store character in kbd_buffer. This
300 may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the next
301 character should go in kbd_buffer[0]. */
302 static union buffered_input_event
*volatile kbd_store_ptr
;
304 /* The above pair of variables forms a "queue empty" flag. When we
305 enqueue a non-hook event, we increment kbd_store_ptr. When we
306 dequeue a non-hook event, we increment kbd_fetch_ptr. We say that
307 there is input available if the two pointers are not equal.
309 Why not just have a flag set and cleared by the enqueuing and
310 dequeuing functions? Such a flag could be screwed up by interrupts
311 at inopportune times. */
313 static void recursive_edit_unwind (Lisp_Object buffer
);
314 static Lisp_Object
command_loop (void);
316 static void echo_now (void);
317 static ptrdiff_t echo_length (void);
319 /* Incremented whenever a timer is run. */
322 /* Address (if not 0) of struct timespec to zero out if a SIGIO interrupt
324 struct timespec
*input_available_clear_time
;
326 /* True means use SIGIO interrupts; false means use CBREAK mode.
327 Default is true if INTERRUPT_INPUT is defined. */
328 bool interrupt_input
;
330 /* Nonzero while interrupts are temporarily deferred during redisplay. */
331 bool interrupts_deferred
;
333 /* The time when Emacs started being idle. */
335 static struct timespec timer_idleness_start_time
;
337 /* After Emacs stops being idle, this saves the last value
338 of timer_idleness_start_time from when it was idle. */
340 static struct timespec timer_last_idleness_start_time
;
343 /* Global variable declarations. */
345 /* Flags for readable_events. */
346 #define READABLE_EVENTS_DO_TIMERS_NOW (1 << 0)
347 #define READABLE_EVENTS_FILTER_EVENTS (1 << 1)
348 #define READABLE_EVENTS_IGNORE_SQUEEZABLES (1 << 2)
350 /* Function for init_keyboard to call with no args (if nonzero). */
351 static void (*keyboard_init_hook
) (void);
353 static bool get_input_pending (int);
354 static bool readable_events (int);
355 static Lisp_Object
read_char_x_menu_prompt (Lisp_Object
,
356 Lisp_Object
, bool *);
357 static Lisp_Object
read_char_minibuf_menu_prompt (int, Lisp_Object
);
358 static Lisp_Object
make_lispy_event (struct input_event
*);
359 static Lisp_Object
make_lispy_movement (struct frame
*, Lisp_Object
,
360 enum scroll_bar_part
,
361 Lisp_Object
, Lisp_Object
,
363 static Lisp_Object
modify_event_symbol (ptrdiff_t, int, Lisp_Object
,
364 Lisp_Object
, const char *const *,
365 Lisp_Object
*, ptrdiff_t);
366 static Lisp_Object
make_lispy_switch_frame (Lisp_Object
);
367 static Lisp_Object
make_lispy_focus_in (Lisp_Object
);
368 #ifdef HAVE_WINDOW_SYSTEM
369 static Lisp_Object
make_lispy_focus_out (Lisp_Object
);
370 #endif /* HAVE_WINDOW_SYSTEM */
371 static bool help_char_p (Lisp_Object
);
372 static void save_getcjmp (sys_jmp_buf
);
373 static void restore_getcjmp (sys_jmp_buf
);
374 static Lisp_Object
apply_modifiers (int, Lisp_Object
);
375 static void restore_kboard_configuration (int);
376 static void handle_interrupt (bool);
377 static _Noreturn
void quit_throw_to_read_char (bool);
378 static void timer_start_idle (void);
379 static void timer_stop_idle (void);
380 static void timer_resume_idle (void);
381 static void deliver_user_signal (int);
382 static char *find_user_signal_name (int);
383 static void store_user_signal_events (void);
385 /* These setters are used only in this file, so they can be private. */
387 kset_echo_string (struct kboard
*kb
, Lisp_Object val
)
389 kb
->echo_string_
= val
;
392 kset_kbd_queue (struct kboard
*kb
, Lisp_Object val
)
394 kb
->kbd_queue_
= val
;
397 kset_keyboard_translate_table (struct kboard
*kb
, Lisp_Object val
)
399 kb
->Vkeyboard_translate_table_
= val
;
402 kset_last_prefix_arg (struct kboard
*kb
, Lisp_Object val
)
404 kb
->Vlast_prefix_arg_
= val
;
407 kset_last_repeatable_command (struct kboard
*kb
, Lisp_Object val
)
409 kb
->Vlast_repeatable_command_
= val
;
412 kset_local_function_key_map (struct kboard
*kb
, Lisp_Object val
)
414 kb
->Vlocal_function_key_map_
= val
;
417 kset_overriding_terminal_local_map (struct kboard
*kb
, Lisp_Object val
)
419 kb
->Voverriding_terminal_local_map_
= val
;
422 kset_real_last_command (struct kboard
*kb
, Lisp_Object val
)
424 kb
->Vreal_last_command_
= val
;
427 kset_system_key_syms (struct kboard
*kb
, Lisp_Object val
)
429 kb
->system_key_syms_
= val
;
433 /* Add C to the echo string, without echoing it immediately. C can be
434 a character, which is pretty-printed, or a symbol, whose name is
438 echo_add_key (Lisp_Object c
)
440 char initbuf
[KEY_DESCRIPTION_SIZE
+ 100];
441 ptrdiff_t size
= sizeof initbuf
;
442 char *buffer
= initbuf
;
444 Lisp_Object echo_string
;
447 echo_string
= KVAR (current_kboard
, echo_string
);
449 /* If someone has passed us a composite event, use its head symbol. */
453 ptr
= push_key_description (XINT (c
), ptr
);
454 else if (SYMBOLP (c
))
456 Lisp_Object name
= SYMBOL_NAME (c
);
457 ptrdiff_t nbytes
= SBYTES (name
);
459 if (size
- (ptr
- buffer
) < nbytes
)
461 ptrdiff_t offset
= ptr
- buffer
;
462 size
= max (2 * size
, size
+ nbytes
);
463 buffer
= SAFE_ALLOCA (size
);
464 ptr
= buffer
+ offset
;
467 ptr
+= copy_text (SDATA (name
), (unsigned char *) ptr
, nbytes
,
468 STRING_MULTIBYTE (name
), 1);
471 if ((NILP (echo_string
) || SCHARS (echo_string
) == 0)
474 static const char text
[] = " (Type ? for further options)";
475 int len
= sizeof text
- 1;
477 if (size
- (ptr
- buffer
) < len
)
479 ptrdiff_t offset
= ptr
- buffer
;
481 buffer
= SAFE_ALLOCA (size
);
482 ptr
= buffer
+ offset
;
485 memcpy (ptr
, text
, len
);
489 /* Replace a dash from echo_dash with a space, otherwise add a space
490 at the end as a separator between keys. */
491 AUTO_STRING (space
, " ");
492 if (STRINGP (echo_string
) && SCHARS (echo_string
) > 1)
494 Lisp_Object last_char
, prev_char
, idx
;
496 idx
= make_number (SCHARS (echo_string
) - 2);
497 prev_char
= Faref (echo_string
, idx
);
499 idx
= make_number (SCHARS (echo_string
) - 1);
500 last_char
= Faref (echo_string
, idx
);
502 /* We test PREV_CHAR to make sure this isn't the echoing of a
504 if (XINT (last_char
) == '-' && XINT (prev_char
) != ' ')
505 Faset (echo_string
, idx
, make_number (' '));
507 echo_string
= concat2 (echo_string
, space
);
509 else if (STRINGP (echo_string
) && SCHARS (echo_string
) > 0)
510 echo_string
= concat2 (echo_string
, space
);
514 concat2 (echo_string
, make_string (buffer
, ptr
- buffer
)));
518 /* Add C to the echo string, if echoing is going on. C can be a
519 character or a symbol. */
522 echo_char (Lisp_Object c
)
524 if (current_kboard
->immediate_echo
)
531 /* Temporarily add a dash to the end of the echo string if it's not
532 empty, so that it serves as a mini-prompt for the very next
538 /* Do nothing if not echoing at all. */
539 if (NILP (KVAR (current_kboard
, echo_string
)))
542 if (this_command_key_count
== 0)
545 if (!current_kboard
->immediate_echo
546 && SCHARS (KVAR (current_kboard
, echo_string
)) == 0)
549 /* Do nothing if we just printed a prompt. */
550 if (current_kboard
->echo_after_prompt
551 == SCHARS (KVAR (current_kboard
, echo_string
)))
554 /* Do nothing if we have already put a dash at the end. */
555 if (SCHARS (KVAR (current_kboard
, echo_string
)) > 1)
557 Lisp_Object last_char
, prev_char
, idx
;
559 idx
= make_number (SCHARS (KVAR (current_kboard
, echo_string
)) - 2);
560 prev_char
= Faref (KVAR (current_kboard
, echo_string
), idx
);
562 idx
= make_number (SCHARS (KVAR (current_kboard
, echo_string
)) - 1);
563 last_char
= Faref (KVAR (current_kboard
, echo_string
), idx
);
565 if (XINT (last_char
) == '-' && XINT (prev_char
) != ' ')
569 /* Put a dash at the end of the buffer temporarily,
570 but make it go away when the next character is added. */
571 AUTO_STRING (dash
, "-");
572 kset_echo_string (current_kboard
,
573 concat2 (KVAR (current_kboard
, echo_string
), dash
));
577 /* Display the current echo string, and begin echoing if not already
583 if (!current_kboard
->immediate_echo
)
586 current_kboard
->immediate_echo
= 1;
588 for (i
= 0; i
< this_command_key_count
; i
++)
592 /* Set before_command_echo_length to the value that would
593 have been saved before the start of this subcommand in
594 command_loop_1, if we had already been echoing then. */
595 if (i
== this_single_command_key_start
)
596 before_command_echo_length
= echo_length ();
598 c
= AREF (this_command_keys
, i
);
599 if (! (EVENT_HAS_PARAMETERS (c
)
600 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
604 /* Set before_command_echo_length to the value that would
605 have been saved before the start of this subcommand in
606 command_loop_1, if we had already been echoing then. */
607 if (this_command_key_count
== this_single_command_key_start
)
608 before_command_echo_length
= echo_length ();
610 /* Put a dash at the end to invite the user to type more. */
615 /* FIXME: Use call (Qmessage) so it can be advised (e.g. emacspeak). */
616 message3_nolog (KVAR (current_kboard
, echo_string
));
619 /* Record in what buffer we echoed, and from which kboard. */
620 echo_message_buffer
= echo_area_buffer
[0];
621 echo_kboard
= current_kboard
;
623 if (waiting_for_input
&& !NILP (Vquit_flag
))
624 quit_throw_to_read_char (0);
627 /* Turn off echoing, for the start of a new command. */
630 cancel_echoing (void)
632 current_kboard
->immediate_echo
= 0;
633 current_kboard
->echo_after_prompt
= -1;
634 kset_echo_string (current_kboard
, Qnil
);
635 ok_to_echo_at_next_pause
= NULL
;
637 echo_message_buffer
= Qnil
;
640 /* Return the length of the current echo string. */
645 return (STRINGP (KVAR (current_kboard
, echo_string
))
646 ? SCHARS (KVAR (current_kboard
, echo_string
))
650 /* Truncate the current echo message to its first LEN chars.
651 This and echo_char get used by read_key_sequence when the user
652 switches frames while entering a key sequence. */
655 echo_truncate (ptrdiff_t nchars
)
657 if (STRINGP (KVAR (current_kboard
, echo_string
)))
658 kset_echo_string (current_kboard
,
659 Fsubstring (KVAR (current_kboard
, echo_string
),
660 make_number (0), make_number (nchars
)));
661 truncate_echo_area (nchars
);
665 /* Functions for manipulating this_command_keys. */
667 add_command_key (Lisp_Object key
)
669 #if 0 /* Not needed after we made Freset_this_command_lengths
670 do the job immediately. */
671 /* If reset-this-command-length was called recently, obey it now.
672 See the doc string of that function for an explanation of why. */
673 if (before_command_restore_flag
)
675 this_command_key_count
= before_command_key_count_1
;
676 if (this_command_key_count
< this_single_command_key_start
)
677 this_single_command_key_start
= this_command_key_count
;
678 echo_truncate (before_command_echo_length_1
);
679 before_command_restore_flag
= 0;
683 if (this_command_key_count
>= ASIZE (this_command_keys
))
684 this_command_keys
= larger_vector (this_command_keys
, 1, -1);
686 ASET (this_command_keys
, this_command_key_count
, key
);
687 ++this_command_key_count
;
692 recursive_edit_1 (void)
694 ptrdiff_t count
= SPECPDL_INDEX ();
697 if (command_loop_level
> 0)
699 specbind (Qstandard_output
, Qt
);
700 specbind (Qstandard_input
, Qt
);
703 #ifdef HAVE_WINDOW_SYSTEM
704 /* The command loop has started an hourglass timer, so we have to
705 cancel it here, otherwise it will fire because the recursive edit
706 can take some time. Do not check for display_hourglass_p here,
707 because it could already be nil. */
711 /* This function may have been called from a debugger called from
712 within redisplay, for instance by Edebugging a function called
713 from fontification-functions. We want to allow redisplay in
714 the debugging session.
716 The recursive edit is left with a `(throw exit ...)'. The `exit'
717 tag is not caught anywhere in redisplay, i.e. when we leave the
718 recursive edit, the original redisplay leading to the recursive
719 edit will be unwound. The outcome should therefore be safe. */
720 specbind (Qinhibit_redisplay
, Qnil
);
723 val
= command_loop ();
725 Fsignal (Qquit
, Qnil
);
726 /* Handle throw from read_minibuf when using minibuffer
727 while it's active but we're in another window. */
729 xsignal1 (Qerror
, val
);
731 return unbind_to (count
, Qnil
);
734 /* When an auto-save happens, record the "time", and don't do again soon. */
737 record_auto_save (void)
739 last_auto_save
= num_nonmacro_input_events
;
742 /* Make an auto save happen as soon as possible at command level. */
746 force_auto_save_soon (void)
748 last_auto_save
= - auto_save_interval
- 1;
750 record_asynch_buffer_change ();
754 DEFUN ("recursive-edit", Frecursive_edit
, Srecursive_edit
, 0, 0, "",
755 doc
: /* Invoke the editor command loop recursively.
756 To get out of the recursive edit, a command can throw to ‘exit’ -- for
757 instance ‘(throw 'exit nil)’.
758 If you throw a value other than t, ‘recursive-edit’ returns normally
759 to the function that called it. Throwing a t value causes
760 ‘recursive-edit’ to quit, so that control returns to the command loop
763 This function is called by the editor initialization to begin editing. */)
766 ptrdiff_t count
= SPECPDL_INDEX ();
769 /* If we enter while input is blocked, don't lock up here.
770 This may happen through the debugger during redisplay. */
771 if (input_blocked_p ())
774 if (command_loop_level
>= 0
775 && current_buffer
!= XBUFFER (XWINDOW (selected_window
)->contents
))
776 buffer
= Fcurrent_buffer ();
780 /* Don't do anything interesting between the increment and the
781 record_unwind_protect! Otherwise, we could get distracted and
782 never decrement the counter again. */
783 command_loop_level
++;
784 update_mode_lines
= 17;
785 record_unwind_protect (recursive_edit_unwind
, buffer
);
787 /* If we leave recursive_edit_1 below with a `throw' for instance,
788 like it is done in the splash screen display, we have to
789 make sure that we restore single_kboard as command_loop_1
790 would have done if it were left normally. */
791 if (command_loop_level
> 0)
792 temporarily_switch_to_single_kboard (SELECTED_FRAME ());
795 return unbind_to (count
, Qnil
);
799 recursive_edit_unwind (Lisp_Object buffer
)
801 if (BUFFERP (buffer
))
802 Fset_buffer (buffer
);
804 command_loop_level
--;
805 update_mode_lines
= 18;
809 #if 0 /* These two functions are now replaced with
810 temporarily_switch_to_single_kboard. */
814 #if 0 /* Theory: if there's anything in Vunread_command_events,
815 it will right away be read by read_key_sequence,
816 and then if we do switch KBOARDS, it will go into the side
817 queue then. So we don't need to do anything special here -- rms. */
818 if (CONSP (Vunread_command_events
))
820 current_kboard
->kbd_queue
821 = nconc2 (Vunread_command_events
, current_kboard
->kbd_queue
);
822 current_kboard
->kbd_queue_has_data
= 1;
824 Vunread_command_events
= Qnil
;
829 /* Switch to the single-kboard state, making current_kboard
830 the only KBOARD from which further input is accepted. */
833 single_kboard_state ()
839 /* If we're in single_kboard state for kboard KBOARD,
843 not_single_kboard_state (KBOARD
*kboard
)
845 if (kboard
== current_kboard
)
849 /* Maintain a stack of kboards, so other parts of Emacs
850 can switch temporarily to the kboard of a given frame
851 and then revert to the previous status. */
856 struct kboard_stack
*next
;
859 static struct kboard_stack
*kboard_stack
;
862 push_kboard (struct kboard
*k
)
864 struct kboard_stack
*p
= xmalloc (sizeof *p
);
866 p
->next
= kboard_stack
;
867 p
->kboard
= current_kboard
;
877 struct kboard_stack
*p
= kboard_stack
;
879 for (t
= terminal_list
; t
; t
= t
->next_terminal
)
881 if (t
->kboard
== p
->kboard
)
883 current_kboard
= p
->kboard
;
890 /* The terminal we remembered has been deleted. */
891 current_kboard
= FRAME_KBOARD (SELECTED_FRAME ());
894 kboard_stack
= p
->next
;
898 /* Switch to single_kboard mode, making current_kboard the only KBOARD
899 from which further input is accepted. If F is non-nil, set its
900 KBOARD as the current keyboard.
902 This function uses record_unwind_protect_int to return to the previous
905 If Emacs is already in single_kboard mode, and F's keyboard is
906 locked, then this function will throw an error. */
909 temporarily_switch_to_single_kboard (struct frame
*f
)
911 bool was_locked
= single_kboard
;
914 if (f
!= NULL
&& FRAME_KBOARD (f
) != current_kboard
)
915 /* We can not switch keyboards while in single_kboard mode.
916 In rare cases, Lisp code may call `recursive-edit' (or
917 `read-minibuffer' or `y-or-n-p') after it switched to a
918 locked frame. For example, this is likely to happen
919 when server.el connects to a new terminal while Emacs is in
920 single_kboard mode. It is best to throw an error instead
921 of presenting the user with a frozen screen. */
922 error ("Terminal %d is locked, cannot read from it",
923 FRAME_TERMINAL (f
)->id
);
925 /* This call is unnecessary, but helps
926 `restore_kboard_configuration' discover if somebody changed
927 `current_kboard' behind our back. */
928 push_kboard (current_kboard
);
931 current_kboard
= FRAME_KBOARD (f
);
933 record_unwind_protect_int (restore_kboard_configuration
, was_locked
);
936 #if 0 /* This function is not needed anymore. */
938 record_single_kboard_state ()
941 push_kboard (current_kboard
);
942 record_unwind_protect_int (restore_kboard_configuration
, single_kboard
);
947 restore_kboard_configuration (int was_locked
)
949 single_kboard
= was_locked
;
952 struct kboard
*prev
= current_kboard
;
954 /* The pop should not change the kboard. */
955 if (single_kboard
&& current_kboard
!= prev
)
961 /* Handle errors that are not handled at inner levels
962 by printing an error message and returning to the editor command loop. */
965 cmd_error (Lisp_Object data
)
967 Lisp_Object old_level
, old_length
;
968 char macroerror
[sizeof "After..kbd macro iterations: "
969 + INT_STRLEN_BOUND (EMACS_INT
)];
971 #ifdef HAVE_WINDOW_SYSTEM
972 if (display_hourglass_p
)
976 if (!NILP (executing_kbd_macro
))
978 if (executing_kbd_macro_iterations
== 1)
979 sprintf (macroerror
, "After 1 kbd macro iteration: ");
981 sprintf (macroerror
, "After %"pI
"d kbd macro iterations: ",
982 executing_kbd_macro_iterations
);
987 Vstandard_output
= Qt
;
988 Vstandard_input
= Qt
;
989 Vexecuting_kbd_macro
= Qnil
;
990 executing_kbd_macro
= Qnil
;
991 kset_prefix_arg (current_kboard
, Qnil
);
992 kset_last_prefix_arg (current_kboard
, Qnil
);
995 /* Avoid unquittable loop if data contains a circular list. */
996 old_level
= Vprint_level
;
997 old_length
= Vprint_length
;
998 XSETFASTINT (Vprint_level
, 10);
999 XSETFASTINT (Vprint_length
, 10);
1000 cmd_error_internal (data
, macroerror
);
1001 Vprint_level
= old_level
;
1002 Vprint_length
= old_length
;
1005 Vinhibit_quit
= Qnil
;
1007 return make_number (0);
1010 /* Take actions on handling an error. DATA is the data that describes
1013 CONTEXT is a C-string containing ASCII characters only which
1014 describes the context in which the error happened. If we need to
1015 generalize CONTEXT to allow multibyte characters, make it a Lisp
1019 cmd_error_internal (Lisp_Object data
, const char *context
)
1021 /* The immediate context is not interesting for Quits,
1022 since they are asynchronous. */
1023 if (EQ (XCAR (data
), Qquit
))
1024 Vsignaling_function
= Qnil
;
1029 /* Use user's specified output function if any. */
1030 if (!NILP (Vcommand_error_function
))
1031 call3 (Vcommand_error_function
, data
,
1032 context
? build_string (context
) : empty_unibyte_string
,
1033 Vsignaling_function
);
1035 Vsignaling_function
= Qnil
;
1038 DEFUN ("command-error-default-function", Fcommand_error_default_function
,
1039 Scommand_error_default_function
, 3, 3, 0,
1040 doc
: /* Produce default output for unhandled error message.
1041 Default value of `command-error-function'. */)
1042 (Lisp_Object data
, Lisp_Object context
, Lisp_Object signal
)
1044 struct frame
*sf
= SELECTED_FRAME ();
1046 CHECK_STRING (context
);
1048 /* If the window system or terminal frame hasn't been initialized
1049 yet, or we're not interactive, write the message to stderr and exit. */
1050 if (!sf
->glyphs_initialized_p
1051 /* The initial frame is a special non-displaying frame. It
1052 will be current in daemon mode when there are no frames
1053 to display, and in non-daemon mode before the real frame
1054 has finished initializing. If an error is thrown in the
1055 latter case while creating the frame, then the frame
1056 will never be displayed, so the safest thing to do is
1057 write to stderr and quit. In daemon mode, there are
1058 many other potential errors that do not prevent frames
1059 from being created, so continuing as normal is better in
1061 || (!IS_DAEMON
&& FRAME_INITIAL_P (sf
))
1064 print_error_message (data
, Qexternal_debugging_output
,
1065 SSDATA (context
), signal
);
1066 Fterpri (Qexternal_debugging_output
, Qnil
);
1067 Fkill_emacs (make_number (-1));
1071 clear_message (1, 0);
1073 message_log_maybe_newline ();
1076 print_error_message (data
, Qt
, SSDATA (context
), signal
);
1081 static Lisp_Object
command_loop_2 (Lisp_Object
);
1082 static Lisp_Object
top_level_1 (Lisp_Object
);
1084 /* Entry to editor-command-loop.
1085 This level has the catches for exiting/returning to editor command loop.
1086 It returns nil to exit recursive edit, t to abort it. */
1091 #ifdef HAVE_STACK_OVERFLOW_HANDLING
1092 /* At least on GNU/Linux, saving signal mask is important here. */
1093 if (sigsetjmp (return_to_command_loop
, 1) != 0)
1095 /* Comes here from handle_sigsegv (see sysdep.c) and
1096 stack_overflow_handler (see w32fns.c). */
1098 w32_reset_stack_overflow_guard ();
1101 Vinternal__top_level_message
= recover_top_level_message
;
1104 Vinternal__top_level_message
= regular_top_level_message
;
1105 #endif /* HAVE_STACK_OVERFLOW_HANDLING */
1106 if (command_loop_level
> 0 || minibuf_level
> 0)
1109 val
= internal_catch (Qexit
, command_loop_2
, Qnil
);
1110 executing_kbd_macro
= Qnil
;
1116 internal_catch (Qtop_level
, top_level_1
, Qnil
);
1117 internal_catch (Qtop_level
, command_loop_2
, Qnil
);
1118 executing_kbd_macro
= Qnil
;
1120 /* End of file in -batch run causes exit here. */
1126 /* Here we catch errors in execution of commands within the
1127 editing loop, and reenter the editing loop.
1128 When there is an error, cmd_error runs and returns a non-nil
1129 value to us. A value of nil means that command_loop_1 itself
1130 returned due to end of file (or end of kbd macro). */
1133 command_loop_2 (Lisp_Object ignore
)
1135 register Lisp_Object val
;
1138 val
= internal_condition_case (command_loop_1
, Qerror
, cmd_error
);
1139 while (!NILP (val
));
1147 return Feval (Vtop_level
, Qnil
);
1151 top_level_1 (Lisp_Object ignore
)
1153 /* On entry to the outer level, run the startup file. */
1154 if (!NILP (Vtop_level
))
1155 internal_condition_case (top_level_2
, Qerror
, cmd_error
);
1156 else if (!NILP (Vpurify_flag
))
1157 message1 ("Bare impure Emacs (standard Lisp code not loaded)");
1159 message1 ("Bare Emacs (standard Lisp code not loaded)");
1163 DEFUN ("top-level", Ftop_level
, Stop_level
, 0, 0, "",
1164 doc
: /* Exit all recursive editing levels.
1165 This also exits all active minibuffers. */
1166 attributes
: noreturn
)
1169 #ifdef HAVE_WINDOW_SYSTEM
1170 if (display_hourglass_p
)
1171 cancel_hourglass ();
1174 /* Unblock input if we enter with input blocked. This may happen if
1175 redisplay traps e.g. during tool-bar update with input blocked. */
1176 totally_unblock_input ();
1178 Fthrow (Qtop_level
, Qnil
);
1181 static _Noreturn
void
1182 user_error (const char *msg
)
1184 xsignal1 (Quser_error
, build_string (msg
));
1187 /* _Noreturn will be added to prototype by make-docfile. */
1188 DEFUN ("exit-recursive-edit", Fexit_recursive_edit
, Sexit_recursive_edit
, 0, 0, "",
1189 doc
: /* Exit from the innermost recursive edit or minibuffer. */
1190 attributes
: noreturn
)
1193 if (command_loop_level
> 0 || minibuf_level
> 0)
1194 Fthrow (Qexit
, Qnil
);
1196 user_error ("No recursive edit is in progress");
1199 /* _Noreturn will be added to prototype by make-docfile. */
1200 DEFUN ("abort-recursive-edit", Fabort_recursive_edit
, Sabort_recursive_edit
, 0, 0, "",
1201 doc
: /* Abort the command that requested this recursive edit or minibuffer input. */
1202 attributes
: noreturn
)
1205 if (command_loop_level
> 0 || minibuf_level
> 0)
1208 user_error ("No recursive edit is in progress");
1211 /* Restore mouse tracking enablement. See Ftrack_mouse for the only use
1212 of this function. */
1215 tracking_off (Lisp_Object old_value
)
1217 do_mouse_tracking
= old_value
;
1218 if (NILP (old_value
))
1220 /* Redisplay may have been preempted because there was input
1221 available, and it assumes it will be called again after the
1222 input has been processed. If the only input available was
1223 the sort that we have just disabled, then we need to call
1225 if (!readable_events (READABLE_EVENTS_DO_TIMERS_NOW
))
1227 redisplay_preserve_echo_area (6);
1228 get_input_pending (READABLE_EVENTS_DO_TIMERS_NOW
);
1233 DEFUN ("internal--track-mouse", Ftrack_mouse
, Strack_mouse
, 1, 1, 0,
1234 doc
: /* Call BODYFUN with mouse movement events enabled. */)
1235 (Lisp_Object bodyfun
)
1237 ptrdiff_t count
= SPECPDL_INDEX ();
1240 record_unwind_protect (tracking_off
, do_mouse_tracking
);
1242 do_mouse_tracking
= Qt
;
1244 val
= call0 (bodyfun
);
1245 return unbind_to (count
, val
);
1248 /* If mouse has moved on some frame, return one of those frames.
1252 If ignore_mouse_drag_p is non-zero, ignore (implicit) mouse movement
1253 after resizing the tool-bar window. */
1255 bool ignore_mouse_drag_p
;
1257 static struct frame
*
1258 some_mouse_moved (void)
1260 Lisp_Object tail
, frame
;
1262 if (ignore_mouse_drag_p
)
1264 /* ignore_mouse_drag_p = 0; */
1268 FOR_EACH_FRAME (tail
, frame
)
1270 if (XFRAME (frame
)->mouse_moved
)
1271 return XFRAME (frame
);
1278 /* This is the actual command reading loop,
1279 sans error-handling encapsulation. */
1281 static int read_key_sequence (Lisp_Object
*, int, Lisp_Object
,
1282 bool, bool, bool, bool);
1283 static void adjust_point_for_property (ptrdiff_t, bool);
1285 /* The last boundary auto-added to buffer-undo-list. */
1286 Lisp_Object last_undo_boundary
;
1288 /* FIXME: This is wrong rather than test window-system, we should call
1289 a new set-selection, which will then dispatch to x-set-selection, or
1290 tty-set-selection, or w32-set-selection, ... */
1293 command_loop_1 (void)
1296 Lisp_Object keybuf
[30];
1298 EMACS_INT prev_modiff
= 0;
1299 struct buffer
*prev_buffer
= NULL
;
1300 bool already_adjusted
= 0;
1302 kset_prefix_arg (current_kboard
, Qnil
);
1303 kset_last_prefix_arg (current_kboard
, Qnil
);
1304 Vdeactivate_mark
= Qnil
;
1305 waiting_for_input
= 0;
1308 this_command_key_count
= 0;
1309 this_command_key_count_reset
= 0;
1310 this_single_command_key_start
= 0;
1312 if (NILP (Vmemory_full
))
1314 /* Make sure this hook runs after commands that get errors and
1315 throw to top level. */
1316 /* Note that the value cell will never directly contain nil
1317 if the symbol is a local variable. */
1318 if (!NILP (Vpost_command_hook
) && !NILP (Vrun_hooks
))
1319 safe_run_hooks (Qpost_command_hook
);
1321 /* If displaying a message, resize the echo area window to fit
1322 that message's size exactly. */
1323 if (!NILP (echo_area_buffer
[0]))
1324 resize_echo_area_exactly ();
1326 /* If there are warnings waiting, process them. */
1327 if (!NILP (Vdelayed_warnings_list
))
1328 safe_run_hooks (Qdelayed_warnings_hook
);
1330 if (!NILP (Vdeferred_action_list
))
1331 safe_run_hooks (Qdeferred_action_function
);
1334 /* Do this after running Vpost_command_hook, for consistency. */
1335 kset_last_command (current_kboard
, Vthis_command
);
1336 kset_real_last_command (current_kboard
, Vreal_this_command
);
1337 if (!CONSP (last_command_event
))
1338 kset_last_repeatable_command (current_kboard
, Vreal_this_command
);
1342 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1345 /* Make sure the current window's buffer is selected. */
1346 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->contents
));
1348 /* Display any malloc warning that just came out. Use while because
1349 displaying one warning can cause another. */
1351 while (pending_malloc_warning
)
1352 display_malloc_warning ();
1354 Vdeactivate_mark
= Qnil
;
1356 /* Don't ignore mouse movements for more than a single command
1357 loop. (This flag is set in xdisp.c whenever the tool bar is
1358 resized, because the resize moves text up or down, and would
1359 generate false mouse drag events if we don't ignore them.) */
1360 ignore_mouse_drag_p
= 0;
1362 /* If minibuffer on and echo area in use,
1363 wait a short time and redraw minibuffer. */
1366 && !NILP (echo_area_buffer
[0])
1367 && EQ (minibuf_window
, echo_area_window
)
1368 && NUMBERP (Vminibuffer_message_timeout
))
1370 /* Bind inhibit-quit to t so that C-g gets read in
1371 rather than quitting back to the minibuffer. */
1372 ptrdiff_t count
= SPECPDL_INDEX ();
1373 specbind (Qinhibit_quit
, Qt
);
1375 sit_for (Vminibuffer_message_timeout
, 0, 2);
1377 /* Clear the echo area. */
1379 safe_run_hooks (Qecho_area_clear_hook
);
1381 unbind_to (count
, Qnil
);
1383 /* If a C-g came in before, treat it as input now. */
1384 if (!NILP (Vquit_flag
))
1387 Vunread_command_events
= list1 (make_number (quit_char
));
1391 /* If it has changed current-menubar from previous value,
1392 really recompute the menubar from the value. */
1393 if (! NILP (Vlucid_menu_bar_dirty_flag
)
1394 && !NILP (Ffboundp (Qrecompute_lucid_menubar
)))
1395 call0 (Qrecompute_lucid_menubar
);
1397 before_command_key_count
= this_command_key_count
;
1398 before_command_echo_length
= echo_length ();
1400 Vthis_command
= Qnil
;
1401 Vreal_this_command
= Qnil
;
1402 Vthis_original_command
= Qnil
;
1403 Vthis_command_keys_shift_translated
= Qnil
;
1405 /* Read next key sequence; i gets its length. */
1406 i
= read_key_sequence (keybuf
, ARRAYELTS (keybuf
),
1409 /* A filter may have run while we were reading the input. */
1410 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1412 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->contents
));
1416 /* Now we have read a key sequence of length I,
1417 or else I is 0 and we found end of file. */
1419 if (i
== 0) /* End of file -- happens only in */
1420 return Qnil
; /* a kbd macro, at the end. */
1421 /* -1 means read_key_sequence got a menu that was rejected.
1422 Just loop around and read another command. */
1426 this_command_key_count
= 0;
1427 this_command_key_count_reset
= 0;
1428 this_single_command_key_start
= 0;
1432 last_command_event
= keybuf
[i
- 1];
1434 /* If the previous command tried to force a specific window-start,
1435 forget about that, in case this command moves point far away
1436 from that position. But also throw away beg_unchanged and
1437 end_unchanged information in that case, so that redisplay will
1438 update the whole window properly. */
1439 if (XWINDOW (selected_window
)->force_start
)
1442 XWINDOW (selected_window
)->force_start
= 0;
1443 b
= XBUFFER (XWINDOW (selected_window
)->contents
);
1444 BUF_BEG_UNCHANGED (b
) = BUF_END_UNCHANGED (b
) = 0;
1447 cmd
= read_key_sequence_cmd
;
1448 if (!NILP (Vexecuting_kbd_macro
))
1450 if (!NILP (Vquit_flag
))
1452 Vexecuting_kbd_macro
= Qt
;
1453 QUIT
; /* Make some noise. */
1454 /* Will return since macro now empty. */
1458 /* Do redisplay processing after this command except in special
1459 cases identified below. */
1460 prev_buffer
= current_buffer
;
1461 prev_modiff
= MODIFF
;
1462 last_point_position
= PT
;
1464 /* By default, we adjust point to a boundary of a region that
1465 has such a property that should be treated intangible
1466 (e.g. composition, display). But, some commands will set
1467 this variable differently. */
1468 Vdisable_point_adjustment
= Qnil
;
1470 /* Process filters and timers may have messed with deactivate-mark.
1471 reset it before we execute the command. */
1472 Vdeactivate_mark
= Qnil
;
1474 /* Remap command through active keymaps. */
1475 Vthis_original_command
= cmd
;
1476 if (!NILP (read_key_sequence_remapped
))
1477 cmd
= read_key_sequence_remapped
;
1479 /* Execute the command. */
1482 total_keys
+= total_keys
< NUM_RECENT_KEYS
;
1483 ASET (recent_keys
, recent_keys_index
,
1485 if (++recent_keys_index
>= NUM_RECENT_KEYS
)
1486 recent_keys_index
= 0;
1488 Vthis_command
= cmd
;
1489 Vreal_this_command
= cmd
;
1490 safe_run_hooks (Qpre_command_hook
);
1492 already_adjusted
= 0;
1494 if (NILP (Vthis_command
))
1495 /* nil means key is undefined. */
1499 /* Here for a command that isn't executed directly. */
1501 #ifdef HAVE_WINDOW_SYSTEM
1502 ptrdiff_t scount
= SPECPDL_INDEX ();
1504 if (display_hourglass_p
1505 && NILP (Vexecuting_kbd_macro
))
1507 record_unwind_protect_void (cancel_hourglass
);
1512 if (NILP (KVAR (current_kboard
, Vprefix_arg
))) /* FIXME: Why? --Stef */
1514 Lisp_Object undo
= BVAR (current_buffer
, undo_list
);
1517 = (EQ (undo
, BVAR (current_buffer
, undo_list
))
1518 ? Qnil
: BVAR (current_buffer
, undo_list
));
1520 call1 (Qcommand_execute
, Vthis_command
);
1522 #ifdef HAVE_WINDOW_SYSTEM
1523 /* Do not check display_hourglass_p here, because
1524 `command-execute' could change it, but we should cancel
1525 hourglass cursor anyway.
1526 But don't cancel the hourglass within a macro
1527 just because a command in the macro finishes. */
1528 if (NILP (Vexecuting_kbd_macro
))
1529 unbind_to (scount
, Qnil
);
1532 kset_last_prefix_arg (current_kboard
, Vcurrent_prefix_arg
);
1534 safe_run_hooks (Qpost_command_hook
);
1536 /* If displaying a message, resize the echo area window to fit
1537 that message's size exactly. */
1538 if (!NILP (echo_area_buffer
[0]))
1539 resize_echo_area_exactly ();
1541 /* If there are warnings waiting, process them. */
1542 if (!NILP (Vdelayed_warnings_list
))
1543 safe_run_hooks (Qdelayed_warnings_hook
);
1545 safe_run_hooks (Qdeferred_action_function
);
1547 /* If there is a prefix argument,
1548 1) We don't want Vlast_command to be ``universal-argument''
1549 (that would be dumb), so don't set Vlast_command,
1550 2) we want to leave echoing on so that the prefix will be
1551 echoed as part of this key sequence, so don't call
1553 3) we want to leave this_command_key_count non-zero, so that
1554 read_char will realize that it is re-reading a character, and
1555 not echo it a second time.
1557 If the command didn't actually create a prefix arg,
1558 but is merely a frame event that is transparent to prefix args,
1559 then the above doesn't apply. */
1560 if (NILP (KVAR (current_kboard
, Vprefix_arg
))
1561 || CONSP (last_command_event
))
1563 kset_last_command (current_kboard
, Vthis_command
);
1564 kset_real_last_command (current_kboard
, Vreal_this_command
);
1565 if (!CONSP (last_command_event
))
1566 kset_last_repeatable_command (current_kboard
, Vreal_this_command
);
1568 this_command_key_count
= 0;
1569 this_command_key_count_reset
= 0;
1570 this_single_command_key_start
= 0;
1573 if (!NILP (BVAR (current_buffer
, mark_active
))
1574 && !NILP (Vrun_hooks
))
1576 /* In Emacs 22, setting transient-mark-mode to `only' was a
1577 way of turning it on for just one command. This usage is
1578 obsolete, but support it anyway. */
1579 if (EQ (Vtransient_mark_mode
, Qidentity
))
1580 Vtransient_mark_mode
= Qnil
;
1581 else if (EQ (Vtransient_mark_mode
, Qonly
))
1582 Vtransient_mark_mode
= Qidentity
;
1584 if (!NILP (Vdeactivate_mark
))
1585 /* If `select-active-regions' is non-nil, this call to
1586 `deactivate-mark' also sets the PRIMARY selection. */
1587 call0 (Qdeactivate_mark
);
1590 /* Even if not deactivating the mark, set PRIMARY if
1591 `select-active-regions' is non-nil. */
1592 if (!NILP (Fwindow_system (Qnil
))
1593 /* Even if mark_active is non-nil, the actual buffer
1594 marker may not have been set yet (Bug#7044). */
1595 && XMARKER (BVAR (current_buffer
, mark
))->buffer
1596 && (EQ (Vselect_active_regions
, Qonly
)
1597 ? EQ (CAR_SAFE (Vtransient_mark_mode
), Qonly
)
1598 : (!NILP (Vselect_active_regions
)
1599 && !NILP (Vtransient_mark_mode
)))
1600 && NILP (Fmemq (Vthis_command
,
1601 Vselection_inhibit_update_commands
)))
1604 = call1 (Fsymbol_value (Qregion_extract_function
), Qnil
);
1605 if (XINT (Flength (txt
)) > 0)
1606 /* Don't set empty selections. */
1607 call2 (Qgui_set_selection
, QPRIMARY
, txt
);
1610 if (current_buffer
!= prev_buffer
|| MODIFF
!= prev_modiff
)
1611 run_hook (intern ("activate-mark-hook"));
1614 Vsaved_region_selection
= Qnil
;
1619 if (current_buffer
== prev_buffer
1620 && XBUFFER (XWINDOW (selected_window
)->contents
) == current_buffer
1621 && last_point_position
!= PT
1622 && NILP (Vdisable_point_adjustment
)
1623 && NILP (Vglobal_disable_point_adjustment
))
1625 if (last_point_position
> BEGV
1626 && last_point_position
< ZV
1627 && (composition_adjust_point (last_point_position
,
1628 last_point_position
)
1629 != last_point_position
))
1630 /* The last point was temporarily set within a grapheme
1631 cluster to prevent automatic composition. To recover
1632 the automatic composition, we must update the
1634 windows_or_buffers_changed
= 21;
1635 if (!already_adjusted
)
1636 adjust_point_for_property (last_point_position
,
1637 MODIFF
!= prev_modiff
);
1640 /* Install chars successfully executed in kbd macro. */
1642 if (!NILP (KVAR (current_kboard
, defining_kbd_macro
))
1643 && NILP (KVAR (current_kboard
, Vprefix_arg
)))
1644 finalize_kbd_macro_chars ();
1649 read_menu_command (void)
1651 Lisp_Object keybuf
[30];
1652 ptrdiff_t count
= SPECPDL_INDEX ();
1655 /* We don't want to echo the keystrokes while navigating the
1657 specbind (Qecho_keystrokes
, make_number (0));
1659 i
= read_key_sequence (keybuf
, ARRAYELTS (keybuf
),
1662 unbind_to (count
, Qnil
);
1664 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1666 if (i
== 0 || i
== -1)
1669 return read_key_sequence_cmd
;
1672 /* Adjust point to a boundary of a region that has such a property
1673 that should be treated intangible. For the moment, we check
1674 `composition', `display' and `invisible' properties.
1675 LAST_PT is the last position of point. */
1678 adjust_point_for_property (ptrdiff_t last_pt
, bool modified
)
1681 Lisp_Object val
, overlay
, tmp
;
1682 /* When called after buffer modification, we should temporarily
1683 suppress the point adjustment for automatic composition so that a
1684 user can keep inserting another character at point or keep
1685 deleting characters around point. */
1686 bool check_composition
= ! modified
, check_display
= 1, check_invisible
= 1;
1687 ptrdiff_t orig_pt
= PT
;
1689 eassert (XBUFFER (XWINDOW (selected_window
)->contents
) == current_buffer
);
1691 /* FIXME: cycling is probably not necessary because these properties
1692 can't be usefully combined anyway. */
1693 while (check_composition
|| check_display
|| check_invisible
)
1695 /* FIXME: check `intangible'. */
1696 if (check_composition
1697 && PT
> BEGV
&& PT
< ZV
1698 && (beg
= composition_adjust_point (last_pt
, PT
)) != PT
)
1701 check_display
= check_invisible
= 1;
1703 check_composition
= 0;
1705 && PT
> BEGV
&& PT
< ZV
1706 && !NILP (val
= get_char_property_and_overlay
1707 (make_number (PT
), Qdisplay
, selected_window
,
1709 && display_prop_intangible_p (val
, overlay
, PT
, PT_BYTE
)
1710 && (!OVERLAYP (overlay
)
1711 ? get_property_and_range (PT
, Qdisplay
, &val
, &beg
, &end
, Qnil
)
1712 : (beg
= OVERLAY_POSITION (OVERLAY_START (overlay
)),
1713 end
= OVERLAY_POSITION (OVERLAY_END (overlay
))))
1714 && (beg
< PT
/* && end > PT <- It's always the case. */
1715 || (beg
<= PT
&& STRINGP (val
) && SCHARS (val
) == 0)))
1718 SET_PT (PT
< last_pt
1719 ? (STRINGP (val
) && SCHARS (val
) == 0
1720 ? max (beg
- 1, BEGV
)
1723 check_composition
= check_invisible
= 1;
1726 if (check_invisible
&& PT
> BEGV
&& PT
< ZV
)
1732 /* Find boundaries `beg' and `end' of the invisible area, if any. */
1735 /* FIXME: We should stop if we find a spot between
1736 two runs of `invisible' where inserted text would
1737 be visible. This is important when we have two
1738 invisible boundaries that enclose an area: if the
1739 area is empty, we need this test in order to make
1740 it possible to place point in the middle rather
1741 than skip both boundaries. However, this code
1742 also stops anywhere in a non-sticky text-property,
1743 which breaks (e.g.) Org mode. */
1744 && (val
= Fget_pos_property (make_number (end
),
1746 TEXT_PROP_MEANS_INVISIBLE (val
))
1748 && !NILP (val
= get_char_property_and_overlay
1749 (make_number (end
), Qinvisible
, Qnil
, &overlay
))
1750 && (inv
= TEXT_PROP_MEANS_INVISIBLE (val
)))
1752 ellipsis
= ellipsis
|| inv
> 1
1753 || (OVERLAYP (overlay
)
1754 && (!NILP (Foverlay_get (overlay
, Qafter_string
))
1755 || !NILP (Foverlay_get (overlay
, Qbefore_string
))));
1756 tmp
= Fnext_single_char_property_change
1757 (make_number (end
), Qinvisible
, Qnil
, Qnil
);
1758 end
= NATNUMP (tmp
) ? XFASTINT (tmp
) : ZV
;
1762 && (val
= Fget_pos_property (make_number (beg
),
1764 TEXT_PROP_MEANS_INVISIBLE (val
))
1766 && !NILP (val
= get_char_property_and_overlay
1767 (make_number (beg
- 1), Qinvisible
, Qnil
, &overlay
))
1768 && (inv
= TEXT_PROP_MEANS_INVISIBLE (val
)))
1770 ellipsis
= ellipsis
|| inv
> 1
1771 || (OVERLAYP (overlay
)
1772 && (!NILP (Foverlay_get (overlay
, Qafter_string
))
1773 || !NILP (Foverlay_get (overlay
, Qbefore_string
))));
1774 tmp
= Fprevious_single_char_property_change
1775 (make_number (beg
), Qinvisible
, Qnil
, Qnil
);
1776 beg
= NATNUMP (tmp
) ? XFASTINT (tmp
) : BEGV
;
1779 /* Move away from the inside area. */
1780 if (beg
< PT
&& end
> PT
)
1782 SET_PT ((orig_pt
== PT
&& (last_pt
< beg
|| last_pt
> end
))
1783 /* We haven't moved yet (so we don't need to fear
1784 infinite-looping) and we were outside the range
1785 before (so either end of the range still corresponds
1786 to a move in the right direction): pretend we moved
1787 less than we actually did, so that we still have
1788 more freedom below in choosing which end of the range
1790 ? (orig_pt
= -1, PT
< last_pt
? end
: beg
)
1791 /* We either have moved already or the last point
1792 was already in the range: we don't get to choose
1793 which end of the range we have to go to. */
1794 : (PT
< last_pt
? beg
: end
));
1795 check_composition
= check_display
= 1;
1797 #if 0 /* This assertion isn't correct, because SET_PT may end up setting
1798 the point to something other than its argument, due to
1799 point-motion hooks, intangibility, etc. */
1800 eassert (PT
== beg
|| PT
== end
);
1803 /* Pretend the area doesn't exist if the buffer is not
1805 if (!modified
&& !ellipsis
&& beg
< end
)
1807 if (last_pt
== beg
&& PT
== end
&& end
< ZV
)
1808 (check_composition
= check_display
= 1, SET_PT (end
+ 1));
1809 else if (last_pt
== end
&& PT
== beg
&& beg
> BEGV
)
1810 (check_composition
= check_display
= 1, SET_PT (beg
- 1));
1811 else if (PT
== ((PT
< last_pt
) ? beg
: end
))
1812 /* We've already moved as far as we can. Trying to go
1813 to the other end would mean moving backwards and thus
1814 could lead to an infinite loop. */
1816 else if (val
= Fget_pos_property (make_number (PT
),
1818 TEXT_PROP_MEANS_INVISIBLE (val
)
1819 && (val
= (Fget_pos_property
1820 (make_number (PT
== beg
? end
: beg
),
1822 !TEXT_PROP_MEANS_INVISIBLE (val
)))
1823 (check_composition
= check_display
= 1,
1824 SET_PT (PT
== beg
? end
: beg
));
1827 check_invisible
= 0;
1831 /* Subroutine for safe_run_hooks: run the hook, which is ARGS[1]. */
1834 safe_run_hooks_1 (ptrdiff_t nargs
, Lisp_Object
*args
)
1836 eassert (nargs
== 2);
1837 return call0 (args
[1]);
1840 /* Subroutine for safe_run_hooks: handle an error by clearing out the function
1844 safe_run_hooks_error (Lisp_Object error
, ptrdiff_t nargs
, Lisp_Object
*args
)
1846 eassert (nargs
== 2);
1847 AUTO_STRING (format
, "Error in %s (%S): %S");
1848 Lisp_Object hook
= args
[0];
1849 Lisp_Object fun
= args
[1];
1850 CALLN (Fmessage
, format
, hook
, fun
, error
);
1856 Lisp_Object newval
= Qnil
;
1857 for (val
= find_symbol_value (hook
); CONSP (val
); val
= XCDR (val
))
1858 if (EQ (fun
, XCAR (val
)))
1861 newval
= Fcons (XCAR (val
), newval
);
1863 return Fset (hook
, Fnreverse (newval
));
1864 /* Not found in the local part of the hook. Let's look at the global
1867 for (val
= (NILP (Fdefault_boundp (hook
)) ? Qnil
1868 : Fdefault_value (hook
));
1869 CONSP (val
); val
= XCDR (val
))
1870 if (EQ (fun
, XCAR (val
)))
1873 newval
= Fcons (XCAR (val
), newval
);
1875 return Fset_default (hook
, Fnreverse (newval
));
1881 safe_run_hook_funcall (ptrdiff_t nargs
, Lisp_Object
*args
)
1883 eassert (nargs
== 2);
1884 /* Yes, run_hook_with_args works with args in the other order. */
1885 internal_condition_case_n (safe_run_hooks_1
,
1886 2, ((Lisp_Object
[]) {args
[1], args
[0]}),
1887 Qt
, safe_run_hooks_error
);
1891 /* If we get an error while running the hook, cause the hook variable
1892 to be nil. Also inhibit quits, so that C-g won't cause the hook
1893 to mysteriously evaporate. */
1896 safe_run_hooks (Lisp_Object hook
)
1898 struct gcpro gcpro1
;
1899 ptrdiff_t count
= SPECPDL_INDEX ();
1902 specbind (Qinhibit_quit
, Qt
);
1903 run_hook_with_args (2, ((Lisp_Object
[]) {hook
, hook
}), safe_run_hook_funcall
);
1904 unbind_to (count
, Qnil
);
1909 /* Nonzero means polling for input is temporarily suppressed. */
1911 int poll_suppress_count
;
1914 #ifdef POLL_FOR_INPUT
1916 /* Asynchronous timer for polling. */
1918 static struct atimer
*poll_timer
;
1920 /* Poll for input, so that we catch a C-g if it comes in. */
1922 poll_for_input_1 (void)
1924 if (! input_blocked_p ()
1925 && !waiting_for_input
)
1929 /* Timer callback function for poll_timer. TIMER is equal to
1933 poll_for_input (struct atimer
*timer
)
1935 if (poll_suppress_count
== 0)
1936 pending_signals
= 1;
1939 #endif /* POLL_FOR_INPUT */
1941 /* Begin signals to poll for input, if they are appropriate.
1942 This function is called unconditionally from various places. */
1945 start_polling (void)
1947 #ifdef POLL_FOR_INPUT
1948 /* XXX This condition was (read_socket_hook && !interrupt_input),
1949 but read_socket_hook is not global anymore. Let's pretend that
1951 if (!interrupt_input
)
1953 /* Turn alarm handling on unconditionally. It might have
1954 been turned off in process.c. */
1955 turn_on_atimers (1);
1957 /* If poll timer doesn't exist, or we need one with
1958 a different interval, start a new one. */
1959 if (poll_timer
== NULL
1960 || poll_timer
->interval
.tv_sec
!= polling_period
)
1962 time_t period
= max (1, min (polling_period
, TYPE_MAXIMUM (time_t)));
1963 struct timespec interval
= make_timespec (period
, 0);
1966 cancel_atimer (poll_timer
);
1968 poll_timer
= start_atimer (ATIMER_CONTINUOUS
, interval
,
1969 poll_for_input
, NULL
);
1972 /* Let the timer's callback function poll for input
1973 if this becomes zero. */
1974 --poll_suppress_count
;
1979 /* True if we are using polling to handle input asynchronously. */
1982 input_polling_used (void)
1984 #ifdef POLL_FOR_INPUT
1985 /* XXX This condition was (read_socket_hook && !interrupt_input),
1986 but read_socket_hook is not global anymore. Let's pretend that
1988 return !interrupt_input
;
1994 /* Turn off polling. */
1999 #ifdef POLL_FOR_INPUT
2000 /* XXX This condition was (read_socket_hook && !interrupt_input),
2001 but read_socket_hook is not global anymore. Let's pretend that
2003 if (!interrupt_input
)
2004 ++poll_suppress_count
;
2008 /* Set the value of poll_suppress_count to COUNT
2009 and start or stop polling accordingly. */
2012 set_poll_suppress_count (int count
)
2014 #ifdef POLL_FOR_INPUT
2015 if (count
== 0 && poll_suppress_count
!= 0)
2017 poll_suppress_count
= 1;
2020 else if (count
!= 0 && poll_suppress_count
== 0)
2024 poll_suppress_count
= count
;
2028 /* Bind polling_period to a value at least N.
2029 But don't decrease it. */
2032 bind_polling_period (int n
)
2034 #ifdef POLL_FOR_INPUT
2035 EMACS_INT
new = polling_period
;
2040 stop_other_atimers (poll_timer
);
2042 specbind (Qpolling_period
, make_number (new));
2043 /* Start a new alarm with the new period. */
2048 /* Apply the control modifier to CHARACTER. */
2051 make_ctrl_char (int c
)
2053 /* Save the upper bits here. */
2054 int upper
= c
& ~0177;
2056 if (! ASCII_CHAR_P (c
))
2057 return c
|= ctrl_modifier
;
2061 /* Everything in the columns containing the upper-case letters
2062 denotes a control character. */
2063 if (c
>= 0100 && c
< 0140)
2067 /* Set the shift modifier for a control char
2068 made from a shifted letter. But only for letters! */
2069 if (oc
>= 'A' && oc
<= 'Z')
2070 c
|= shift_modifier
;
2073 /* The lower-case letters denote control characters too. */
2074 else if (c
>= 'a' && c
<= 'z')
2077 /* Include the bits for control and shift
2078 only if the basic ASCII code can't indicate them. */
2082 /* Replace the high bits. */
2083 c
|= (upper
& ~ctrl_modifier
);
2088 /* Display the help-echo property of the character after the mouse pointer.
2089 Either show it in the echo area, or call show-help-function to display
2090 it by other means (maybe in a tooltip).
2092 If HELP is nil, that means clear the previous help echo.
2094 If HELP is a string, display that string. If HELP is a function,
2095 call it with OBJECT and POS as arguments; the function should
2096 return a help string or nil for none. For all other types of HELP,
2097 evaluate it to obtain a string.
2099 WINDOW is the window in which the help was generated, if any.
2100 It is nil if not in a window.
2102 If OBJECT is a buffer, POS is the position in the buffer where the
2103 `help-echo' text property was found.
2105 If OBJECT is an overlay, that overlay has a `help-echo' property,
2106 and POS is the position in the overlay's buffer under the mouse.
2108 If OBJECT is a string (an overlay string or a string displayed with
2109 the `display' property). POS is the position in that string under
2112 Note: this function may only be called with HELP nil or a string
2113 from X code running asynchronously. */
2116 show_help_echo (Lisp_Object help
, Lisp_Object window
, Lisp_Object object
,
2119 if (!NILP (help
) && !STRINGP (help
))
2121 if (FUNCTIONP (help
))
2122 help
= safe_call (4, help
, window
, object
, pos
);
2124 help
= safe_eval (help
);
2126 if (!STRINGP (help
))
2130 if (!noninteractive
&& STRINGP (help
))
2132 /* The mouse-fixup-help-message Lisp function can call
2133 mouse_position_hook, which resets the mouse_moved flags.
2134 This causes trouble if we are trying to read a mouse motion
2135 event (i.e., if we are inside a `track-mouse' form), so we
2136 restore the mouse_moved flag. */
2137 struct frame
*f
= NILP (do_mouse_tracking
) ? NULL
: some_mouse_moved ();
2138 help
= call1 (Qmouse_fixup_help_message
, help
);
2143 if (STRINGP (help
) || NILP (help
))
2145 if (!NILP (Vshow_help_function
))
2146 call1 (Vshow_help_function
, Fsubstitute_command_keys (help
));
2147 help_echo_showing_p
= STRINGP (help
);
2153 /* Input of single characters from keyboard. */
2155 static Lisp_Object
kbd_buffer_get_event (KBOARD
**kbp
, bool *used_mouse_menu
,
2156 struct timespec
*end_time
);
2157 static void record_char (Lisp_Object c
);
2159 static Lisp_Object help_form_saved_window_configs
;
2161 read_char_help_form_unwind (void)
2163 Lisp_Object window_config
= XCAR (help_form_saved_window_configs
);
2164 help_form_saved_window_configs
= XCDR (help_form_saved_window_configs
);
2165 if (!NILP (window_config
))
2166 Fset_window_configuration (window_config
);
2169 #define STOP_POLLING \
2170 do { if (! polling_stopped_here) stop_polling (); \
2171 polling_stopped_here = 1; } while (0)
2173 #define RESUME_POLLING \
2174 do { if (polling_stopped_here) start_polling (); \
2175 polling_stopped_here = 0; } while (0)
2178 read_event_from_main_queue (struct timespec
*end_time
,
2179 sys_jmp_buf local_getcjmp
,
2180 bool *used_mouse_menu
)
2182 Lisp_Object c
= Qnil
;
2183 sys_jmp_buf save_jump
;
2184 KBOARD
*kb
IF_LINT (= NULL
);
2188 /* Read from the main queue, and if that gives us something we can't use yet,
2189 we put it on the appropriate side queue and try again. */
2191 if (end_time
&& timespec_cmp (*end_time
, current_timespec ()) <= 0)
2194 /* Actually read a character, waiting if necessary. */
2195 save_getcjmp (save_jump
);
2196 restore_getcjmp (local_getcjmp
);
2198 timer_start_idle ();
2199 c
= kbd_buffer_get_event (&kb
, used_mouse_menu
, end_time
);
2200 restore_getcjmp (save_jump
);
2202 if (! NILP (c
) && (kb
!= current_kboard
))
2204 Lisp_Object last
= KVAR (kb
, kbd_queue
);
2207 while (CONSP (XCDR (last
)))
2209 if (!NILP (XCDR (last
)))
2213 kset_kbd_queue (kb
, list1 (c
));
2215 XSETCDR (last
, list1 (c
));
2216 kb
->kbd_queue_has_data
= 1;
2220 current_kboard
= kb
;
2221 /* This is going to exit from read_char
2222 so we had better get rid of this frame's stuff. */
2223 return make_number (-2);
2226 /* Terminate Emacs in batch mode if at eof. */
2227 if (noninteractive
&& INTEGERP (c
) && XINT (c
) < 0)
2228 Fkill_emacs (make_number (1));
2232 /* Add in any extra modifiers, where appropriate. */
2233 if ((extra_keyboard_modifiers
& CHAR_CTL
)
2234 || ((extra_keyboard_modifiers
& 0177) < ' '
2235 && (extra_keyboard_modifiers
& 0177) != 0))
2236 XSETINT (c
, make_ctrl_char (XINT (c
)));
2238 /* Transfer any other modifier bits directly from
2239 extra_keyboard_modifiers to c. Ignore the actual character code
2240 in the low 16 bits of extra_keyboard_modifiers. */
2241 XSETINT (c
, XINT (c
) | (extra_keyboard_modifiers
& ~0xff7f & ~CHAR_CTL
));
2249 /* Like `read_event_from_main_queue' but applies keyboard-coding-system
2252 read_decoded_event_from_main_queue (struct timespec
*end_time
,
2253 sys_jmp_buf local_getcjmp
,
2254 Lisp_Object prev_event
,
2255 bool *used_mouse_menu
)
2257 #define MAX_ENCODED_BYTES 16
2259 Lisp_Object events
[MAX_ENCODED_BYTES
];
2265 = read_event_from_main_queue (end_time
, local_getcjmp
,
2268 /* w32_console already returns decoded events. It either reads
2269 Unicode characters from the Windows keyboard input, or
2270 converts characters encoded in the current codepage into
2271 Unicode. See w32inevt.c:key_event, near its end. */
2274 struct frame
*frame
= XFRAME (selected_frame
);
2275 struct terminal
*terminal
= frame
->terminal
;
2276 if (!((FRAME_TERMCAP_P (frame
) || FRAME_MSDOS_P (frame
))
2277 /* Don't apply decoding if we're just reading a raw event
2278 (e.g. reading bytes sent by the xterm to specify the position
2279 of a mouse click). */
2280 && (!EQ (prev_event
, Qt
))
2281 && (TERMINAL_KEYBOARD_CODING (terminal
)->common_flags
2282 & CODING_REQUIRE_DECODING_MASK
)))
2283 return nextevt
; /* No decoding needed. */
2286 int meta_key
= terminal
->display_info
.tty
->meta_key
;
2287 eassert (n
< MAX_ENCODED_BYTES
);
2288 events
[n
++] = nextevt
;
2289 if (NATNUMP (nextevt
)
2290 && XINT (nextevt
) < (meta_key
== 1 ? 0x80 : 0x100))
2291 { /* An encoded byte sequence, let's try to decode it. */
2292 struct coding_system
*coding
2293 = TERMINAL_KEYBOARD_CODING (terminal
);
2295 if (raw_text_coding_system_p (coding
))
2299 for (i
= 0; i
< n
; i
++)
2300 events
[i
] = make_number (XINT (events
[i
]) & ~0x80);
2304 unsigned char src
[MAX_ENCODED_BYTES
];
2305 unsigned char dest
[MAX_ENCODED_BYTES
* MAX_MULTIBYTE_LENGTH
];
2307 for (i
= 0; i
< n
; i
++)
2308 src
[i
] = XINT (events
[i
]);
2310 for (i
= 0; i
< n
; i
++)
2312 coding
->destination
= dest
;
2313 coding
->dst_bytes
= sizeof dest
;
2314 decode_coding_c_string (coding
, src
, n
, Qnil
);
2315 eassert (coding
->produced_char
<= n
);
2316 if (coding
->produced_char
== 0)
2317 { /* The encoded sequence is incomplete. */
2318 if (n
< MAX_ENCODED_BYTES
) /* Avoid buffer overflow. */
2319 continue; /* Read on! */
2323 const unsigned char *p
= coding
->destination
;
2324 eassert (coding
->carryover_bytes
== 0);
2326 while (n
< coding
->produced_char
)
2327 events
[n
++] = make_number (STRING_CHAR_ADVANCE (p
));
2331 /* Now `events' should hold decoded events.
2332 Normally, n should be equal to 1, but better not rely on it.
2333 We can only return one event here, so return the first we
2334 had and keep the others (if any) for later. */
2336 Vunread_command_events
2337 = Fcons (events
[--n
], Vunread_command_events
);
2345 echo_keystrokes_p (void)
2347 return (FLOATP (Vecho_keystrokes
) ? XFLOAT_DATA (Vecho_keystrokes
) > 0.0
2348 : INTEGERP (Vecho_keystrokes
) ? XINT (Vecho_keystrokes
) > 0 : false);
2351 /* Read a character from the keyboard; call the redisplay if needed. */
2352 /* commandflag 0 means do not autosave, but do redisplay.
2353 -1 means do not redisplay, but do autosave.
2354 -2 means do neither.
2357 The argument MAP is a keymap for menu prompting.
2359 PREV_EVENT is the previous input event, or nil if we are reading
2360 the first event of a key sequence (or not reading a key sequence).
2361 If PREV_EVENT is t, that is a "magic" value that says
2362 not to run input methods, but in other respects to act as if
2363 not reading a key sequence.
2365 If USED_MOUSE_MENU is non-null, then set *USED_MOUSE_MENU to true
2366 if we used a mouse menu to read the input, or false otherwise. If
2367 USED_MOUSE_MENU is null, don't dereference it.
2369 Value is -2 when we find input on another keyboard. A second call
2370 to read_char will read it.
2372 If END_TIME is non-null, it is a pointer to a struct timespec
2373 specifying the maximum time to wait until. If no input arrives by
2374 that time, stop waiting and return nil.
2376 Value is t if we showed a menu and the user rejected it. */
2379 read_char (int commandflag
, Lisp_Object map
,
2380 Lisp_Object prev_event
,
2381 bool *used_mouse_menu
, struct timespec
*end_time
)
2385 sys_jmp_buf local_getcjmp
;
2386 sys_jmp_buf save_jump
;
2387 Lisp_Object tem
, save
;
2388 volatile Lisp_Object previous_echo_area_message
;
2389 volatile Lisp_Object also_record
;
2390 volatile bool reread
;
2391 struct gcpro gcpro1
, gcpro2
;
2392 bool volatile polling_stopped_here
= 0;
2393 struct kboard
*orig_kboard
= current_kboard
;
2397 #if 0 /* This was commented out as part of fixing echo for C-u left. */
2398 before_command_key_count
= this_command_key_count
;
2399 before_command_echo_length
= echo_length ();
2402 previous_echo_area_message
= Qnil
;
2404 GCPRO2 (c
, previous_echo_area_message
);
2408 if (CONSP (Vunread_post_input_method_events
))
2410 c
= XCAR (Vunread_post_input_method_events
);
2411 Vunread_post_input_method_events
2412 = XCDR (Vunread_post_input_method_events
);
2414 /* Undo what read_char_x_menu_prompt did when it unread
2415 additional keys returned by Fx_popup_menu. */
2417 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2428 if (CONSP (Vunread_command_events
))
2430 bool was_disabled
= 0;
2432 c
= XCAR (Vunread_command_events
);
2433 Vunread_command_events
= XCDR (Vunread_command_events
);
2435 /* Undo what sit-for did when it unread additional keys
2436 inside universal-argument. */
2438 if (CONSP (c
) && EQ (XCAR (c
), Qt
))
2443 /* Undo what read_char_x_menu_prompt did when it unread
2444 additional keys returned by Fx_popup_menu. */
2446 && EQ (XCDR (c
), Qdisabled
)
2447 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
))))
2453 /* If the queued event is something that used the mouse,
2454 set used_mouse_menu accordingly. */
2456 /* Also check was_disabled so last-nonmenu-event won't return
2457 a bad value when submenus are involved. (Bug#447) */
2458 && (EQ (c
, Qtool_bar
) || EQ (c
, Qmenu_bar
) || was_disabled
))
2459 *used_mouse_menu
= 1;
2461 goto reread_for_input_method
;
2464 if (CONSP (Vunread_input_method_events
))
2466 c
= XCAR (Vunread_input_method_events
);
2467 Vunread_input_method_events
= XCDR (Vunread_input_method_events
);
2469 /* Undo what read_char_x_menu_prompt did when it unread
2470 additional keys returned by Fx_popup_menu. */
2472 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2476 goto reread_for_input_method
;
2479 this_command_key_count_reset
= 0;
2481 if (!NILP (Vexecuting_kbd_macro
))
2483 /* We set this to Qmacro; since that's not a frame, nobody will
2484 try to switch frames on us, and the selected window will
2487 Since this event came from a macro, it would be misleading to
2488 leave internal_last_event_frame set to wherever the last
2489 real event came from. Normally, a switch-frame event selects
2490 internal_last_event_frame after each command is read, but
2491 events read from a macro should never cause a new frame to be
2493 Vlast_event_frame
= internal_last_event_frame
= Qmacro
;
2495 /* Exit the macro if we are at the end.
2496 Also, some things replace the macro with t
2497 to force an early exit. */
2498 if (EQ (Vexecuting_kbd_macro
, Qt
)
2499 || executing_kbd_macro_index
>= XFASTINT (Flength (Vexecuting_kbd_macro
)))
2505 c
= Faref (Vexecuting_kbd_macro
, make_number (executing_kbd_macro_index
));
2506 if (STRINGP (Vexecuting_kbd_macro
)
2507 && (XFASTINT (c
) & 0x80) && (XFASTINT (c
) <= 0xff))
2508 XSETFASTINT (c
, CHAR_META
| (XFASTINT (c
) & ~0x80));
2510 executing_kbd_macro_index
++;
2515 if (!NILP (unread_switch_frame
))
2517 c
= unread_switch_frame
;
2518 unread_switch_frame
= Qnil
;
2520 /* This event should make it into this_command_keys, and get echoed
2521 again, so we do not set `reread'. */
2525 /* If redisplay was requested. */
2526 if (commandflag
>= 0)
2528 bool echo_current
= EQ (echo_message_buffer
, echo_area_buffer
[0]);
2530 /* If there is pending input, process any events which are not
2531 user-visible, such as X selection_request events. */
2533 || detect_input_pending_run_timers (0))
2534 swallow_events (false); /* May clear input_pending. */
2536 /* Redisplay if no pending input. */
2537 while (!(input_pending
2538 && (input_was_pending
|| !redisplay_dont_pause
)))
2540 input_was_pending
= input_pending
;
2541 if (help_echo_showing_p
&& !EQ (selected_window
, minibuf_window
))
2542 redisplay_preserve_echo_area (5);
2547 /* Normal case: no input arrived during redisplay. */
2550 /* Input arrived and pre-empted redisplay.
2551 Process any events which are not user-visible. */
2552 swallow_events (false);
2553 /* If that cleared input_pending, try again to redisplay. */
2556 /* Prevent the redisplay we just did
2557 from messing up echoing of the input after the prompt. */
2558 if (commandflag
== 0 && echo_current
)
2559 echo_message_buffer
= echo_area_buffer
[0];
2563 /* Message turns off echoing unless more keystrokes turn it on again.
2565 The code in 20.x for the condition was
2567 1. echo_area_glyphs && *echo_area_glyphs
2568 2. && echo_area_glyphs != current_kboard->echobuf
2569 3. && ok_to_echo_at_next_pause != echo_area_glyphs
2571 (1) means there's a current message displayed
2573 (2) means it's not the message from echoing from the current
2576 (3) There's only one place in 20.x where ok_to_echo_at_next_pause
2577 is set to a non-null value. This is done in read_char and it is
2578 set to echo_area_glyphs after a call to echo_char. That means
2579 ok_to_echo_at_next_pause is either null or
2580 current_kboard->echobuf with the appropriate current_kboard at
2583 So, condition (3) means in clear text ok_to_echo_at_next_pause
2584 must be either null, or the current message isn't from echoing at
2585 all, or it's from echoing from a different kboard than the
2588 if (/* There currently is something in the echo area. */
2589 !NILP (echo_area_buffer
[0])
2590 && (/* It's an echo from a different kboard. */
2591 echo_kboard
!= current_kboard
2592 /* Or we explicitly allow overwriting whatever there is. */
2593 || ok_to_echo_at_next_pause
== NULL
))
2598 /* Try reading a character via menu prompting in the minibuf.
2599 Try this before the sit-for, because the sit-for
2600 would do the wrong thing if we are supposed to do
2601 menu prompting. If EVENT_HAS_PARAMETERS then we are reading
2602 after a mouse event so don't try a minibuf menu. */
2604 if (KEYMAPP (map
) && INTERACTIVE
2605 && !NILP (prev_event
) && ! EVENT_HAS_PARAMETERS (prev_event
)
2606 /* Don't bring up a menu if we already have another event. */
2607 && NILP (Vunread_command_events
)
2608 && !detect_input_pending_run_timers (0))
2610 c
= read_char_minibuf_menu_prompt (commandflag
, map
);
2612 if (INTEGERP (c
) && XINT (c
) == -2)
2613 return c
; /* wrong_kboard_jmpbuf */
2619 /* Make a longjmp point for quits to use, but don't alter getcjmp just yet.
2620 We will do that below, temporarily for short sections of code,
2621 when appropriate. local_getcjmp must be in effect
2622 around any call to sit_for or kbd_buffer_get_event;
2623 it *must not* be in effect when we call redisplay. */
2625 jmpcount
= SPECPDL_INDEX ();
2626 if (sys_setjmp (local_getcjmp
))
2628 /* Handle quits while reading the keyboard. */
2629 /* We must have saved the outer value of getcjmp here,
2630 so restore it now. */
2631 restore_getcjmp (save_jump
);
2632 pthread_sigmask (SIG_SETMASK
, &empty_mask
, 0);
2633 unbind_to (jmpcount
, Qnil
);
2634 XSETINT (c
, quit_char
);
2635 internal_last_event_frame
= selected_frame
;
2636 Vlast_event_frame
= internal_last_event_frame
;
2637 /* If we report the quit char as an event,
2638 don't do so more than once. */
2639 if (!NILP (Vinhibit_quit
))
2643 KBOARD
*kb
= FRAME_KBOARD (XFRAME (selected_frame
));
2644 if (kb
!= current_kboard
)
2646 Lisp_Object last
= KVAR (kb
, kbd_queue
);
2647 /* We shouldn't get here if we were in single-kboard mode! */
2652 while (CONSP (XCDR (last
)))
2654 if (!NILP (XCDR (last
)))
2658 kset_kbd_queue (kb
, list1 (c
));
2660 XSETCDR (last
, list1 (c
));
2661 kb
->kbd_queue_has_data
= 1;
2662 current_kboard
= kb
;
2663 /* This is going to exit from read_char
2664 so we had better get rid of this frame's stuff. */
2666 return make_number (-2); /* wrong_kboard_jmpbuf */
2672 /* Start idle timers if no time limit is supplied. We don't do it
2673 if a time limit is supplied to avoid an infinite recursion in the
2674 situation where an idle timer calls `sit-for'. */
2677 timer_start_idle ();
2679 /* If in middle of key sequence and minibuffer not active,
2680 start echoing if enough time elapses. */
2682 if (minibuf_level
== 0
2684 && !current_kboard
->immediate_echo
2685 && this_command_key_count
> 0
2687 && echo_keystrokes_p ()
2688 && (/* No message. */
2689 NILP (echo_area_buffer
[0])
2690 /* Or empty message. */
2691 || (BUF_BEG (XBUFFER (echo_area_buffer
[0]))
2692 == BUF_Z (XBUFFER (echo_area_buffer
[0])))
2693 /* Or already echoing from same kboard. */
2694 || (echo_kboard
&& ok_to_echo_at_next_pause
== echo_kboard
)
2695 /* Or not echoing before and echoing allowed. */
2696 || (!echo_kboard
&& ok_to_echo_at_next_pause
)))
2698 /* After a mouse event, start echoing right away.
2699 This is because we are probably about to display a menu,
2700 and we don't want to delay before doing so. */
2701 if (EVENT_HAS_PARAMETERS (prev_event
))
2707 save_getcjmp (save_jump
);
2708 restore_getcjmp (local_getcjmp
);
2709 tem0
= sit_for (Vecho_keystrokes
, 1, 1);
2710 restore_getcjmp (save_jump
);
2712 && ! CONSP (Vunread_command_events
))
2717 /* Maybe auto save due to number of keystrokes. */
2719 if (commandflag
!= 0 && commandflag
!= -2
2720 && auto_save_interval
> 0
2721 && num_nonmacro_input_events
- last_auto_save
> max (auto_save_interval
, 20)
2722 && !detect_input_pending_run_timers (0))
2724 Fdo_auto_save (Qnil
, Qnil
);
2725 /* Hooks can actually change some buffers in auto save. */
2729 /* Try reading using an X menu.
2730 This is never confused with reading using the minibuf
2731 because the recursive call of read_char in read_char_minibuf_menu_prompt
2732 does not pass on any keymaps. */
2734 if (KEYMAPP (map
) && INTERACTIVE
2735 && !NILP (prev_event
)
2736 && EVENT_HAS_PARAMETERS (prev_event
)
2737 && !EQ (XCAR (prev_event
), Qmenu_bar
)
2738 && !EQ (XCAR (prev_event
), Qtool_bar
)
2739 /* Don't bring up a menu if we already have another event. */
2740 && NILP (Vunread_command_events
))
2742 c
= read_char_x_menu_prompt (map
, prev_event
, used_mouse_menu
);
2744 /* Now that we have read an event, Emacs is not idle. */
2751 /* Maybe autosave and/or garbage collect due to idleness. */
2753 if (INTERACTIVE
&& NILP (c
))
2756 ptrdiff_t buffer_size
;
2758 /* Slow down auto saves logarithmically in size of current buffer,
2759 and garbage collect while we're at it. */
2760 if (! MINI_WINDOW_P (XWINDOW (selected_window
)))
2761 last_non_minibuf_size
= Z
- BEG
;
2762 buffer_size
= (last_non_minibuf_size
>> 8) + 1;
2764 while (buffer_size
> 64)
2765 delay_level
++, buffer_size
-= buffer_size
>> 2;
2766 if (delay_level
< 4) delay_level
= 4;
2767 /* delay_level is 4 for files under around 50k, 7 at 100k,
2768 9 at 200k, 11 at 300k, and 12 at 500k. It is 15 at 1 meg. */
2770 /* Auto save if enough time goes by without input. */
2771 if (commandflag
!= 0 && commandflag
!= -2
2772 && num_nonmacro_input_events
> last_auto_save
2773 && INTEGERP (Vauto_save_timeout
)
2774 && XINT (Vauto_save_timeout
) > 0)
2777 EMACS_INT timeout
= XFASTINT (Vauto_save_timeout
);
2779 timeout
= min (timeout
, MOST_POSITIVE_FIXNUM
/ delay_level
* 4);
2780 timeout
= delay_level
* timeout
/ 4;
2781 save_getcjmp (save_jump
);
2782 restore_getcjmp (local_getcjmp
);
2783 tem0
= sit_for (make_number (timeout
), 1, 1);
2784 restore_getcjmp (save_jump
);
2787 && ! CONSP (Vunread_command_events
))
2789 Fdo_auto_save (Qnil
, Qnil
);
2794 /* If there is still no input available, ask for GC. */
2795 if (!detect_input_pending_run_timers (0))
2799 /* Notify the caller if an autosave hook, or a timer, sentinel or
2800 filter in the sit_for calls above have changed the current
2801 kboard. This could happen if they use the minibuffer or start a
2802 recursive edit, like the fancy splash screen in server.el's
2803 filter. If this longjmp wasn't here, read_key_sequence would
2804 interpret the next key sequence using the wrong translation
2805 tables and function keymaps. */
2806 if (NILP (c
) && current_kboard
!= orig_kboard
)
2809 return make_number (-2); /* wrong_kboard_jmpbuf */
2812 /* If this has become non-nil here, it has been set by a timer
2813 or sentinel or filter. */
2814 if (CONSP (Vunread_command_events
))
2816 c
= XCAR (Vunread_command_events
);
2817 Vunread_command_events
= XCDR (Vunread_command_events
);
2819 if (CONSP (c
) && EQ (XCAR (c
), Qt
))
2825 /* Read something from current KBOARD's side queue, if possible. */
2829 if (current_kboard
->kbd_queue_has_data
)
2831 if (!CONSP (KVAR (current_kboard
, kbd_queue
)))
2833 c
= XCAR (KVAR (current_kboard
, kbd_queue
));
2834 kset_kbd_queue (current_kboard
,
2835 XCDR (KVAR (current_kboard
, kbd_queue
)));
2836 if (NILP (KVAR (current_kboard
, kbd_queue
)))
2837 current_kboard
->kbd_queue_has_data
= 0;
2838 input_pending
= readable_events (0);
2839 if (EVENT_HAS_PARAMETERS (c
)
2840 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qswitch_frame
))
2841 internal_last_event_frame
= XCAR (XCDR (c
));
2842 Vlast_event_frame
= internal_last_event_frame
;
2846 /* If current_kboard's side queue is empty check the other kboards.
2847 If one of them has data that we have not yet seen here,
2848 switch to it and process the data waiting for it.
2850 Note: if the events queued up for another kboard
2851 have already been seen here, and therefore are not a complete command,
2852 the kbd_queue_has_data field is 0, so we skip that kboard here.
2853 That's to avoid an infinite loop switching between kboards here. */
2854 if (NILP (c
) && !single_kboard
)
2857 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
2858 if (kb
->kbd_queue_has_data
)
2860 current_kboard
= kb
;
2861 /* This is going to exit from read_char
2862 so we had better get rid of this frame's stuff. */
2864 return make_number (-2); /* wrong_kboard_jmpbuf */
2874 c
= read_decoded_event_from_main_queue (end_time
, local_getcjmp
,
2875 prev_event
, used_mouse_menu
);
2876 if (NILP (c
) && end_time
2877 && timespec_cmp (*end_time
, current_timespec ()) <= 0)
2882 if (EQ (c
, make_number (-2)))
2884 /* This is going to exit from read_char
2885 so we had better get rid of this frame's stuff. */
2899 if (commandflag
>= 0
2900 && !input_pending
&& !detect_input_pending_run_timers (0))
2906 /* Buffer switch events are only for internal wakeups
2907 so don't show them to the user.
2908 Also, don't record a key if we already did. */
2912 /* Process special events within read_char
2913 and loop around to read another event. */
2916 tem
= access_keymap (get_keymap (Vspecial_event_map
, 0, 1), c
, 0, 0, 1);
2921 struct buffer
*prev_buffer
= current_buffer
;
2922 last_input_event
= c
;
2923 call4 (Qcommand_execute
, tem
, Qnil
, Fvector (1, &last_input_event
), Qt
);
2925 if (CONSP (c
) && EQ (XCAR (c
), Qselect_window
) && !end_time
)
2926 /* We stopped being idle for this event; undo that. This
2927 prevents automatic window selection (under
2928 mouse_autoselect_window from acting as a real input event, for
2929 example banishing the mouse under mouse-avoidance-mode. */
2930 timer_resume_idle ();
2932 if (current_buffer
!= prev_buffer
)
2934 /* The command may have changed the keymaps. Pretend there
2935 is input in another keyboard and return. This will
2936 recalculate keymaps. */
2937 c
= make_number (-2);
2944 /* Handle things that only apply to characters. */
2947 /* If kbd_buffer_get_event gave us an EOF, return that. */
2951 if ((STRINGP (KVAR (current_kboard
, Vkeyboard_translate_table
))
2952 && UNSIGNED_CMP (XFASTINT (c
), <,
2953 SCHARS (KVAR (current_kboard
,
2954 Vkeyboard_translate_table
))))
2955 || (VECTORP (KVAR (current_kboard
, Vkeyboard_translate_table
))
2956 && UNSIGNED_CMP (XFASTINT (c
), <,
2957 ASIZE (KVAR (current_kboard
,
2958 Vkeyboard_translate_table
))))
2959 || (CHAR_TABLE_P (KVAR (current_kboard
, Vkeyboard_translate_table
))
2963 d
= Faref (KVAR (current_kboard
, Vkeyboard_translate_table
), c
);
2964 /* nil in keyboard-translate-table means no translation. */
2970 /* If this event is a mouse click in the menu bar,
2971 return just menu-bar for now. Modify the mouse click event
2972 so we won't do this twice, then queue it up. */
2973 if (EVENT_HAS_PARAMETERS (c
)
2975 && CONSP (EVENT_START (c
))
2976 && CONSP (XCDR (EVENT_START (c
))))
2980 posn
= POSN_POSN (EVENT_START (c
));
2981 /* Handle menu-bar events:
2982 insert the dummy prefix event `menu-bar'. */
2983 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
2985 /* Change menu-bar to (menu-bar) as the event "position". */
2986 POSN_SET_POSN (EVENT_START (c
), list1 (posn
));
2989 Vunread_command_events
= Fcons (c
, Vunread_command_events
);
2994 /* Store these characters into recent_keys, the dribble file if any,
2995 and the keyboard macro being defined, if any. */
2997 if (! NILP (also_record
))
2998 record_char (also_record
);
3000 /* Wipe the echo area.
3001 But first, if we are about to use an input method,
3002 save the echo area contents for it to refer to. */
3004 && ! NILP (Vinput_method_function
)
3005 && ' ' <= XINT (c
) && XINT (c
) < 256 && XINT (c
) != 127)
3007 previous_echo_area_message
= Fcurrent_message ();
3008 Vinput_method_previous_message
= previous_echo_area_message
;
3011 /* Now wipe the echo area, except for help events which do their
3012 own stuff with the echo area. */
3014 || (!(EQ (Qhelp_echo
, XCAR (c
)))
3015 && !(EQ (Qswitch_frame
, XCAR (c
)))
3016 /* Don't wipe echo area for select window events: These might
3017 get delayed via `mouse-autoselect-window' (Bug#11304). */
3018 && !(EQ (Qselect_window
, XCAR (c
)))))
3020 if (!NILP (echo_area_buffer
[0]))
3022 safe_run_hooks (Qecho_area_clear_hook
);
3023 clear_message (1, 0);
3027 reread_for_input_method
:
3029 /* Pass this to the input method, if appropriate. */
3031 && ! NILP (Vinput_method_function
)
3032 /* Don't run the input method within a key sequence,
3033 after the first event of the key sequence. */
3034 && NILP (prev_event
)
3035 && ' ' <= XINT (c
) && XINT (c
) < 256 && XINT (c
) != 127)
3038 ptrdiff_t key_count
;
3039 bool key_count_reset
;
3040 ptrdiff_t command_key_start
;
3041 struct gcpro gcpro1
;
3042 ptrdiff_t count
= SPECPDL_INDEX ();
3044 /* Save the echo status. */
3045 bool saved_immediate_echo
= current_kboard
->immediate_echo
;
3046 struct kboard
*saved_ok_to_echo
= ok_to_echo_at_next_pause
;
3047 Lisp_Object saved_echo_string
= KVAR (current_kboard
, echo_string
);
3048 ptrdiff_t saved_echo_after_prompt
= current_kboard
->echo_after_prompt
;
3051 if (before_command_restore_flag
)
3053 this_command_key_count
= before_command_key_count_1
;
3054 if (this_command_key_count
< this_single_command_key_start
)
3055 this_single_command_key_start
= this_command_key_count
;
3056 echo_truncate (before_command_echo_length_1
);
3057 before_command_restore_flag
= 0;
3061 /* Save the this_command_keys status. */
3062 key_count
= this_command_key_count
;
3063 key_count_reset
= this_command_key_count_reset
;
3064 command_key_start
= this_single_command_key_start
;
3067 keys
= Fcopy_sequence (this_command_keys
);
3072 /* Clear out this_command_keys. */
3073 this_command_key_count
= 0;
3074 this_command_key_count_reset
= 0;
3075 this_single_command_key_start
= 0;
3077 /* Now wipe the echo area. */
3078 if (!NILP (echo_area_buffer
[0]))
3079 safe_run_hooks (Qecho_area_clear_hook
);
3080 clear_message (1, 0);
3083 /* If we are not reading a key sequence,
3084 never use the echo area. */
3087 specbind (Qinput_method_use_echo_area
, Qt
);
3090 /* Call the input method. */
3091 tem
= call1 (Vinput_method_function
, c
);
3093 tem
= unbind_to (count
, tem
);
3095 /* Restore the saved echoing state
3096 and this_command_keys state. */
3097 this_command_key_count
= key_count
;
3098 this_command_key_count_reset
= key_count_reset
;
3099 this_single_command_key_start
= command_key_start
;
3101 this_command_keys
= keys
;
3104 ok_to_echo_at_next_pause
= saved_ok_to_echo
;
3105 /* Do not restore the echo area string when the user is
3106 introducing a prefix argument. Otherwise we end with
3107 repetitions of the partially introduced prefix
3108 argument. (bug#19875) */
3109 if (NILP (intern ("prefix-arg")))
3111 kset_echo_string (current_kboard
, saved_echo_string
);
3113 current_kboard
->echo_after_prompt
= saved_echo_after_prompt
;
3114 if (saved_immediate_echo
)
3119 /* The input method can return no events. */
3122 /* Bring back the previous message, if any. */
3123 if (! NILP (previous_echo_area_message
))
3124 message_with_string ("%s", previous_echo_area_message
, 0);
3127 /* It returned one event or more. */
3129 Vunread_post_input_method_events
3130 = nconc2 (XCDR (tem
), Vunread_post_input_method_events
);
3135 /* Display help if not echoing. */
3136 if (CONSP (c
) && EQ (XCAR (c
), Qhelp_echo
))
3138 /* (help-echo FRAME HELP WINDOW OBJECT POS). */
3139 Lisp_Object help
, object
, position
, window
, htem
;
3141 htem
= Fcdr (XCDR (c
));
3144 window
= Fcar (htem
);
3146 object
= Fcar (htem
);
3148 position
= Fcar (htem
);
3150 show_help_echo (help
, window
, object
, position
);
3152 /* We stopped being idle for this event; undo that. */
3154 timer_resume_idle ();
3158 if ((! reread
|| this_command_key_count
== 0
3159 || this_command_key_count_reset
)
3163 /* Don't echo mouse motion events. */
3164 if (echo_keystrokes_p ()
3165 && ! (EVENT_HAS_PARAMETERS (c
)
3166 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
3169 if (! NILP (also_record
))
3170 echo_char (also_record
);
3171 /* Once we reread a character, echoing can happen
3172 the next time we pause to read a new one. */
3173 ok_to_echo_at_next_pause
= current_kboard
;
3176 /* Record this character as part of the current key. */
3177 add_command_key (c
);
3178 if (! NILP (also_record
))
3179 add_command_key (also_record
);
3182 last_input_event
= c
;
3185 /* Process the help character specially if enabled. */
3186 if (!NILP (Vhelp_form
) && help_char_p (c
))
3188 ptrdiff_t count
= SPECPDL_INDEX ();
3190 help_form_saved_window_configs
3191 = Fcons (Fcurrent_window_configuration (Qnil
),
3192 help_form_saved_window_configs
);
3193 record_unwind_protect_void (read_char_help_form_unwind
);
3194 call0 (Qhelp_form_show
);
3199 c
= read_char (0, Qnil
, Qnil
, 0, NULL
);
3200 if (EVENT_HAS_PARAMETERS (c
)
3201 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_click
))
3202 XSETCAR (help_form_saved_window_configs
, Qnil
);
3204 while (BUFFERP (c
));
3205 /* Remove the help from the frame. */
3206 unbind_to (count
, Qnil
);
3209 if (EQ (c
, make_number (040)))
3213 c
= read_char (0, Qnil
, Qnil
, 0, NULL
);
3214 while (BUFFERP (c
));
3220 input_was_pending
= input_pending
;
3224 /* Record a key that came from a mouse menu.
3225 Record it for echoing, for this-command-keys, and so on. */
3228 record_menu_key (Lisp_Object c
)
3230 /* Wipe the echo area. */
3231 clear_message (1, 0);
3236 before_command_key_count
= this_command_key_count
;
3237 before_command_echo_length
= echo_length ();
3240 /* Don't echo mouse motion events. */
3241 if (echo_keystrokes_p ())
3245 /* Once we reread a character, echoing can happen
3246 the next time we pause to read a new one. */
3247 ok_to_echo_at_next_pause
= 0;
3250 /* Record this character as part of the current key. */
3251 add_command_key (c
);
3253 /* Re-reading in the middle of a command. */
3254 last_input_event
= c
;
3258 /* Return true if should recognize C as "the help character". */
3261 help_char_p (Lisp_Object c
)
3265 if (EQ (c
, Vhelp_char
))
3267 for (tail
= Vhelp_event_list
; CONSP (tail
); tail
= XCDR (tail
))
3268 if (EQ (c
, XCAR (tail
)))
3273 /* Record the input event C in various ways. */
3276 record_char (Lisp_Object c
)
3280 if (CONSP (c
) && (EQ (XCAR (c
), Qhelp_echo
) || EQ (XCAR (c
), Qmouse_movement
)))
3282 /* To avoid filling recent_keys with help-echo and mouse-movement
3283 events, we filter out repeated help-echo events, only store the
3284 first and last in a series of mouse-movement events, and don't
3285 store repeated help-echo events which are only separated by
3286 mouse-movement events. */
3288 Lisp_Object ev1
, ev2
, ev3
;
3291 if ((ix1
= recent_keys_index
- 1) < 0)
3292 ix1
= NUM_RECENT_KEYS
- 1;
3293 ev1
= AREF (recent_keys
, ix1
);
3295 if ((ix2
= ix1
- 1) < 0)
3296 ix2
= NUM_RECENT_KEYS
- 1;
3297 ev2
= AREF (recent_keys
, ix2
);
3299 if ((ix3
= ix2
- 1) < 0)
3300 ix3
= NUM_RECENT_KEYS
- 1;
3301 ev3
= AREF (recent_keys
, ix3
);
3303 if (EQ (XCAR (c
), Qhelp_echo
))
3305 /* Don't record `help-echo' in recent_keys unless it shows some help
3306 message, and a different help than the previously recorded
3308 Lisp_Object help
, last_help
;
3310 help
= Fcar_safe (Fcdr_safe (XCDR (c
)));
3311 if (!STRINGP (help
))
3313 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qhelp_echo
)
3314 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev1
))), EQ (last_help
, help
)))
3316 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3317 && CONSP (ev2
) && EQ (XCAR (ev2
), Qhelp_echo
)
3318 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev2
))), EQ (last_help
, help
)))
3320 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3321 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3322 && CONSP (ev3
) && EQ (XCAR (ev3
), Qhelp_echo
)
3323 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev3
))), EQ (last_help
, help
)))
3326 else if (EQ (XCAR (c
), Qmouse_movement
))
3328 /* Only record one pair of `mouse-movement' on a window in recent_keys.
3329 So additional mouse movement events replace the last element. */
3330 Lisp_Object last_window
, window
;
3332 window
= Fcar_safe (Fcar_safe (XCDR (c
)));
3333 if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3334 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev1
))), EQ (last_window
, window
))
3335 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3336 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev2
))), EQ (last_window
, window
)))
3338 ASET (recent_keys
, ix1
, c
);
3344 store_kbd_macro_char (c
);
3348 total_keys
+= total_keys
< NUM_RECENT_KEYS
;
3349 ASET (recent_keys
, recent_keys_index
, c
);
3350 if (++recent_keys_index
>= NUM_RECENT_KEYS
)
3351 recent_keys_index
= 0;
3353 else if (recorded
< 0)
3355 /* We need to remove one or two events from recent_keys.
3356 To do this, we simply put nil at those events and move the
3357 recent_keys_index backwards over those events. Usually,
3358 users will never see those nil events, as they will be
3359 overwritten by the command keys entered to see recent_keys
3362 while (recorded
++ < 0 && total_keys
> 0)
3364 if (total_keys
< NUM_RECENT_KEYS
)
3366 if (--recent_keys_index
< 0)
3367 recent_keys_index
= NUM_RECENT_KEYS
- 1;
3368 ASET (recent_keys
, recent_keys_index
, Qnil
);
3372 num_nonmacro_input_events
++;
3374 /* Write c to the dribble file. If c is a lispy event, write
3375 the event's symbol to the dribble file, in <brackets>. Bleaugh.
3376 If you, dear reader, have a better idea, you've got the source. :-) */
3382 if (XUINT (c
) < 0x100)
3383 putc (XUINT (c
), dribble
);
3385 fprintf (dribble
, " 0x%"pI
"x", XUINT (c
));
3389 Lisp_Object dribblee
;
3391 /* If it's a structured event, take the event header. */
3392 dribblee
= EVENT_HEAD (c
);
3394 if (SYMBOLP (dribblee
))
3396 putc ('<', dribble
);
3397 fwrite (SDATA (SYMBOL_NAME (dribblee
)), sizeof (char),
3398 SBYTES (SYMBOL_NAME (dribblee
)),
3400 putc ('>', dribble
);
3409 /* Copy out or in the info on where C-g should throw to.
3410 This is used when running Lisp code from within get_char,
3411 in case get_char is called recursively.
3412 See read_process_output. */
3415 save_getcjmp (sys_jmp_buf temp
)
3417 memcpy (temp
, getcjmp
, sizeof getcjmp
);
3421 restore_getcjmp (sys_jmp_buf temp
)
3423 memcpy (getcjmp
, temp
, sizeof getcjmp
);
3426 /* Low level keyboard/mouse input.
3427 kbd_buffer_store_event places events in kbd_buffer, and
3428 kbd_buffer_get_event retrieves them. */
3430 /* Return true if there are any events in the queue that read-char
3431 would return. If this returns false, a read-char would block. */
3433 readable_events (int flags
)
3435 if (flags
& READABLE_EVENTS_DO_TIMERS_NOW
)
3438 /* If the buffer contains only FOCUS_IN_EVENT events, and
3439 READABLE_EVENTS_FILTER_EVENTS is set, report it as empty. */
3440 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3442 if (flags
& (READABLE_EVENTS_FILTER_EVENTS
3443 #ifdef USE_TOOLKIT_SCROLL_BARS
3444 | READABLE_EVENTS_IGNORE_SQUEEZABLES
3448 union buffered_input_event
*event
;
3450 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
3457 #ifdef USE_TOOLKIT_SCROLL_BARS
3458 (flags
& READABLE_EVENTS_FILTER_EVENTS
) &&
3460 event
->kind
== FOCUS_IN_EVENT
)
3461 #ifdef USE_TOOLKIT_SCROLL_BARS
3462 && !((flags
& READABLE_EVENTS_IGNORE_SQUEEZABLES
)
3463 && (event
->kind
== SCROLL_BAR_CLICK_EVENT
3464 || event
->kind
== HORIZONTAL_SCROLL_BAR_CLICK_EVENT
)
3465 && event
->ie
.part
== scroll_bar_handle
3466 && event
->ie
.modifiers
== 0)
3468 && !((flags
& READABLE_EVENTS_FILTER_EVENTS
)
3469 && event
->kind
== BUFFER_SWITCH_EVENT
))
3472 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3475 while (event
!= kbd_store_ptr
);
3481 if (!(flags
& READABLE_EVENTS_IGNORE_SQUEEZABLES
)
3482 && !NILP (do_mouse_tracking
) && some_mouse_moved ())
3486 if (current_kboard
->kbd_queue_has_data
)
3492 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
3493 if (kb
->kbd_queue_has_data
)
3499 /* Set this for debugging, to have a way to get out */
3500 int stop_character EXTERNALLY_VISIBLE
;
3503 event_to_kboard (struct input_event
*event
)
3505 /* Not applicable for these special events. */
3506 if (event
->kind
== SELECTION_REQUEST_EVENT
3507 || event
->kind
== SELECTION_CLEAR_EVENT
)
3511 Lisp_Object obj
= event
->frame_or_window
;
3512 /* There are some events that set this field to nil or string. */
3514 obj
= WINDOW_FRAME (XWINDOW (obj
));
3515 /* Also ignore dead frames here. */
3516 return ((FRAMEP (obj
) && FRAME_LIVE_P (XFRAME (obj
)))
3517 ? FRAME_KBOARD (XFRAME (obj
)) : NULL
);
3522 /* Return the number of slots occupied in kbd_buffer. */
3525 kbd_buffer_nr_stored (void)
3527 return kbd_fetch_ptr
== kbd_store_ptr
3529 : (kbd_fetch_ptr
< kbd_store_ptr
3530 ? kbd_store_ptr
- kbd_fetch_ptr
3531 : ((kbd_buffer
+ KBD_BUFFER_SIZE
) - kbd_fetch_ptr
3532 + (kbd_store_ptr
- kbd_buffer
)));
3534 #endif /* Store an event obtained at interrupt level into kbd_buffer, fifo */
3537 kbd_buffer_store_event (register struct input_event
*event
)
3539 kbd_buffer_store_event_hold (event
, 0);
3542 /* Store EVENT obtained at interrupt level into kbd_buffer, fifo.
3544 If HOLD_QUIT is 0, just stuff EVENT into the fifo.
3545 Else, if HOLD_QUIT.kind != NO_EVENT, discard EVENT.
3546 Else, if EVENT is a quit event, store the quit event
3547 in HOLD_QUIT, and return (thus ignoring further events).
3549 This is used to postpone the processing of the quit event until all
3550 subsequent input events have been parsed (and discarded). */
3553 kbd_buffer_store_buffered_event (union buffered_input_event
*event
,
3554 struct input_event
*hold_quit
)
3556 if (event
->kind
== NO_EVENT
)
3559 if (hold_quit
&& hold_quit
->kind
!= NO_EVENT
)
3562 if (event
->kind
== ASCII_KEYSTROKE_EVENT
)
3564 int c
= event
->ie
.code
& 0377;
3566 if (event
->ie
.modifiers
& ctrl_modifier
)
3567 c
= make_ctrl_char (c
);
3569 c
|= (event
->ie
.modifiers
3570 & (meta_modifier
| alt_modifier
3571 | hyper_modifier
| super_modifier
));
3575 KBOARD
*kb
= FRAME_KBOARD (XFRAME (event
->ie
.frame_or_window
));
3577 if (single_kboard
&& kb
!= current_kboard
)
3580 (kb
, list2 (make_lispy_switch_frame (event
->ie
.frame_or_window
),
3582 kb
->kbd_queue_has_data
= 1;
3583 union buffered_input_event
*sp
;
3584 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3586 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3589 if (event_to_kboard (&sp
->ie
) == kb
)
3591 sp
->ie
.kind
= NO_EVENT
;
3592 sp
->ie
.frame_or_window
= Qnil
;
3601 *hold_quit
= event
->ie
;
3605 /* If this results in a quit_char being returned to Emacs as
3606 input, set Vlast_event_frame properly. If this doesn't
3607 get returned to Emacs as an event, the next event read
3608 will set Vlast_event_frame again, so this is safe to do. */
3612 focus
= FRAME_FOCUS_FRAME (XFRAME (event
->ie
.frame_or_window
));
3614 focus
= event
->ie
.frame_or_window
;
3615 internal_last_event_frame
= focus
;
3616 Vlast_event_frame
= focus
;
3619 handle_interrupt (0);
3623 if (c
&& c
== stop_character
)
3629 /* Don't insert two BUFFER_SWITCH_EVENT's in a row.
3630 Just ignore the second one. */
3631 else if (event
->kind
== BUFFER_SWITCH_EVENT
3632 && kbd_fetch_ptr
!= kbd_store_ptr
3633 && ((kbd_store_ptr
== kbd_buffer
3634 ? kbd_buffer
+ KBD_BUFFER_SIZE
- 1
3635 : kbd_store_ptr
- 1)->kind
) == BUFFER_SWITCH_EVENT
)
3638 if (kbd_store_ptr
- kbd_buffer
== KBD_BUFFER_SIZE
)
3639 kbd_store_ptr
= kbd_buffer
;
3641 /* Don't let the very last slot in the buffer become full,
3642 since that would make the two pointers equal,
3643 and that is indistinguishable from an empty buffer.
3644 Discard the event if it would fill the last slot. */
3645 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
3647 *kbd_store_ptr
= *event
;
3650 if (kbd_buffer_nr_stored () > KBD_BUFFER_SIZE
/ 2
3651 && ! kbd_on_hold_p ())
3653 /* Don't read keyboard input until we have processed kbd_buffer.
3654 This happens when pasting text longer than KBD_BUFFER_SIZE/2. */
3655 hold_keyboard_input ();
3659 #endif /* subprocesses */
3662 /* If we're inside while-no-input, and this event qualifies
3663 as input, set quit-flag to cause an interrupt. */
3664 if (!NILP (Vthrow_on_input
)
3665 && event
->kind
!= FOCUS_IN_EVENT
3666 && event
->kind
!= FOCUS_OUT_EVENT
3667 && event
->kind
!= HELP_EVENT
3668 && event
->kind
!= ICONIFY_EVENT
3669 && event
->kind
!= DEICONIFY_EVENT
)
3671 Vquit_flag
= Vthrow_on_input
;
3672 /* If we're inside a function that wants immediate quits,
3674 if (immediate_quit
&& NILP (Vinhibit_quit
))
3685 /* Put a selection input event back in the head of the event queue. */
3688 kbd_buffer_unget_event (struct selection_input_event
*event
)
3690 if (kbd_fetch_ptr
== kbd_buffer
)
3691 kbd_fetch_ptr
= kbd_buffer
+ KBD_BUFFER_SIZE
;
3693 /* Don't let the very last slot in the buffer become full, */
3694 union buffered_input_event
*kp
= kbd_fetch_ptr
- 1;
3695 if (kp
!= kbd_store_ptr
)
3704 /* Limit help event positions to this range, to avoid overflow problems. */
3705 #define INPUT_EVENT_POS_MAX \
3706 ((ptrdiff_t) min (PTRDIFF_MAX, min (TYPE_MAXIMUM (Time) / 2, \
3707 MOST_POSITIVE_FIXNUM)))
3708 #define INPUT_EVENT_POS_MIN (-1 - INPUT_EVENT_POS_MAX)
3710 /* Return a Time that encodes position POS. POS must be in range. */
3713 position_to_Time (ptrdiff_t pos
)
3715 eassert (INPUT_EVENT_POS_MIN
<= pos
&& pos
<= INPUT_EVENT_POS_MAX
);
3719 /* Return the position that ENCODED_POS encodes.
3720 Avoid signed integer overflow. */
3723 Time_to_position (Time encoded_pos
)
3725 if (encoded_pos
<= INPUT_EVENT_POS_MAX
)
3727 Time encoded_pos_min
= INPUT_EVENT_POS_MIN
;
3728 eassert (encoded_pos_min
<= encoded_pos
);
3729 ptrdiff_t notpos
= -1 - encoded_pos
;
3733 /* Generate a HELP_EVENT input_event and store it in the keyboard
3736 HELP is the help form.
3738 FRAME and WINDOW are the frame and window where the help is
3739 generated. OBJECT is the Lisp object where the help was found (a
3740 buffer, a string, an overlay, or nil if neither from a string nor
3741 from a buffer). POS is the position within OBJECT where the help
3745 gen_help_event (Lisp_Object help
, Lisp_Object frame
, Lisp_Object window
,
3746 Lisp_Object object
, ptrdiff_t pos
)
3748 struct input_event event
;
3750 event
.kind
= HELP_EVENT
;
3751 event
.frame_or_window
= frame
;
3753 event
.x
= WINDOWP (window
) ? window
: frame
;
3755 event
.timestamp
= position_to_Time (pos
);
3756 kbd_buffer_store_event (&event
);
3760 /* Store HELP_EVENTs for HELP on FRAME in the input queue. */
3763 kbd_buffer_store_help_event (Lisp_Object frame
, Lisp_Object help
)
3765 struct input_event event
;
3767 event
.kind
= HELP_EVENT
;
3768 event
.frame_or_window
= frame
;
3772 event
.timestamp
= 0;
3773 kbd_buffer_store_event (&event
);
3777 /* Discard any mouse events in the event buffer by setting them to
3780 discard_mouse_events (void)
3782 union buffered_input_event
*sp
;
3783 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3785 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3788 if (sp
->kind
== MOUSE_CLICK_EVENT
3789 || sp
->kind
== WHEEL_EVENT
3790 || sp
->kind
== HORIZ_WHEEL_EVENT
3792 || sp
->kind
== GPM_CLICK_EVENT
3794 || sp
->kind
== SCROLL_BAR_CLICK_EVENT
3795 || sp
->kind
== HORIZONTAL_SCROLL_BAR_CLICK_EVENT
)
3797 sp
->kind
= NO_EVENT
;
3803 /* Return true if there are any real events waiting in the event
3804 buffer, not counting `NO_EVENT's.
3806 Discard NO_EVENT events at the front of the input queue, possibly
3807 leaving the input queue empty if there are no real input events. */
3810 kbd_buffer_events_waiting (void)
3812 union buffered_input_event
*sp
;
3814 for (sp
= kbd_fetch_ptr
;
3815 sp
!= kbd_store_ptr
&& sp
->kind
== NO_EVENT
;
3818 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3823 return sp
!= kbd_store_ptr
&& sp
->kind
!= NO_EVENT
;
3827 /* Clear input event EVENT. */
3830 clear_event (union buffered_input_event
*event
)
3832 event
->kind
= NO_EVENT
;
3836 /* Read one event from the event buffer, waiting if necessary.
3837 The value is a Lisp object representing the event.
3838 The value is nil for an event that should be ignored,
3839 or that was handled here.
3840 We always read and discard one event. */
3843 kbd_buffer_get_event (KBOARD
**kbp
,
3844 bool *used_mouse_menu
,
3845 struct timespec
*end_time
)
3850 if (kbd_on_hold_p () && kbd_buffer_nr_stored () < KBD_BUFFER_SIZE
/ 4)
3852 /* Start reading input again because we have processed enough to
3853 be able to accept new events again. */
3854 unhold_keyboard_input ();
3858 #endif /* subprocesses */
3860 #if !defined HAVE_DBUS && !defined USE_FILE_NOTIFY
3862 /* In case we are running as a daemon, only do this before
3863 detaching from the terminal. */
3864 || (IS_DAEMON
&& DAEMON_RUNNING
))
3868 *kbp
= current_kboard
;
3871 #endif /* !defined HAVE_DBUS && !defined USE_FILE_NOTIFY */
3873 /* Wait until there is input available. */
3876 /* Break loop if there's an unread command event. Needed in
3877 moused window autoselection which uses a timer to insert such
3879 if (CONSP (Vunread_command_events
))
3882 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3884 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3887 /* If the quit flag is set, then read_char will return
3888 quit_char, so that counts as "available input." */
3889 if (!NILP (Vquit_flag
))
3890 quit_throw_to_read_char (0);
3892 /* One way or another, wait until input is available; then, if
3893 interrupt handlers have not read it, read it now. */
3898 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3900 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3904 struct timespec now
= current_timespec ();
3905 if (timespec_cmp (*end_time
, now
) <= 0)
3906 return Qnil
; /* Finished waiting. */
3909 struct timespec duration
= timespec_sub (*end_time
, now
);
3910 wait_reading_process_output (min (duration
.tv_sec
,
3913 -1, 1, Qnil
, NULL
, 0);
3918 bool do_display
= true;
3920 if (FRAME_TERMCAP_P (SELECTED_FRAME ()))
3922 struct tty_display_info
*tty
= CURTTY ();
3924 /* When this TTY is displaying a menu, we must prevent
3925 any redisplay, because we modify the frame's glyph
3926 matrix behind the back of the display engine. */
3927 if (tty
->showing_menu
)
3931 wait_reading_process_output (0, 0, -1, do_display
, Qnil
, NULL
, 0);
3934 if (!interrupt_input
&& kbd_fetch_ptr
== kbd_store_ptr
)
3938 if (CONSP (Vunread_command_events
))
3941 first
= XCAR (Vunread_command_events
);
3942 Vunread_command_events
= XCDR (Vunread_command_events
);
3943 *kbp
= current_kboard
;
3947 /* At this point, we know that there is a readable event available
3948 somewhere. If the event queue is empty, then there must be a
3949 mouse movement enabled and available. */
3950 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3952 union buffered_input_event
*event
;
3954 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
3958 *kbp
= event_to_kboard (&event
->ie
);
3960 *kbp
= current_kboard
; /* Better than returning null ptr? */
3964 /* These two kinds of events get special handling
3965 and don't actually appear to the command loop.
3966 We return nil for them. */
3967 if (event
->kind
== SELECTION_REQUEST_EVENT
3968 || event
->kind
== SELECTION_CLEAR_EVENT
)
3971 /* Remove it from the buffer before processing it,
3972 since otherwise swallow_events will see it
3973 and process it again. */
3974 struct selection_input_event copy
= event
->sie
;
3975 kbd_fetch_ptr
= event
+ 1;
3976 input_pending
= readable_events (0);
3977 x_handle_selection_event (©
);
3979 /* We're getting selection request events, but we don't have
3985 #if defined (HAVE_NS)
3986 else if (event
->kind
== NS_TEXT_EVENT
)
3988 if (event
->ie
.code
== KEY_NS_PUT_WORKING_TEXT
)
3989 obj
= list1 (intern ("ns-put-working-text"));
3991 obj
= list1 (intern ("ns-unput-working-text"));
3992 kbd_fetch_ptr
= event
+ 1;
3993 if (used_mouse_menu
)
3994 *used_mouse_menu
= 1;
3998 #if defined (HAVE_X11) || defined (HAVE_NTGUI) \
3999 || defined (HAVE_NS)
4000 else if (event
->kind
== DELETE_WINDOW_EVENT
)
4002 /* Make an event (delete-frame (FRAME)). */
4003 obj
= list2 (Qdelete_frame
, list1 (event
->ie
.frame_or_window
));
4004 kbd_fetch_ptr
= event
+ 1;
4007 #if defined (HAVE_X11) || defined (HAVE_NTGUI) \
4008 || defined (HAVE_NS)
4009 else if (event
->kind
== ICONIFY_EVENT
)
4011 /* Make an event (iconify-frame (FRAME)). */
4012 obj
= list2 (Qiconify_frame
, list1 (event
->ie
.frame_or_window
));
4013 kbd_fetch_ptr
= event
+ 1;
4015 else if (event
->kind
== DEICONIFY_EVENT
)
4017 /* Make an event (make-frame-visible (FRAME)). */
4018 obj
= list2 (Qmake_frame_visible
, list1 (event
->ie
.frame_or_window
));
4019 kbd_fetch_ptr
= event
+ 1;
4022 else if (event
->kind
== BUFFER_SWITCH_EVENT
)
4024 /* The value doesn't matter here; only the type is tested. */
4025 XSETBUFFER (obj
, current_buffer
);
4026 kbd_fetch_ptr
= event
+ 1;
4028 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
4029 || defined (HAVE_NS) || defined (USE_GTK)
4030 else if (event
->kind
== MENU_BAR_ACTIVATE_EVENT
)
4032 kbd_fetch_ptr
= event
+ 1;
4033 input_pending
= readable_events (0);
4034 if (FRAME_LIVE_P (XFRAME (event
->ie
.frame_or_window
)))
4035 x_activate_menubar (XFRAME (event
->ie
.frame_or_window
));
4039 else if (event
->kind
== LANGUAGE_CHANGE_EVENT
)
4041 /* Make an event (language-change FRAME CODEPAGE LANGUAGE-ID). */
4042 obj
= list4 (Qlanguage_change
,
4043 event
->ie
.frame_or_window
,
4044 make_number (event
->ie
.code
),
4045 make_number (event
->ie
.modifiers
));
4046 kbd_fetch_ptr
= event
+ 1;
4049 #ifdef USE_FILE_NOTIFY
4050 else if (event
->kind
== FILE_NOTIFY_EVENT
)
4052 #ifdef HAVE_W32NOTIFY
4053 /* Make an event (file-notify (DESCRIPTOR ACTION FILE) CALLBACK). */
4054 obj
= list3 (Qfile_notify
, event
->ie
.arg
, event
->ie
.frame_or_window
);
4056 obj
= make_lispy_event (&event
->ie
);
4058 kbd_fetch_ptr
= event
+ 1;
4060 #endif /* USE_FILE_NOTIFY */
4061 else if (event
->kind
== SAVE_SESSION_EVENT
)
4063 obj
= list2 (Qsave_session
, event
->ie
.arg
);
4064 kbd_fetch_ptr
= event
+ 1;
4066 /* Just discard these, by returning nil.
4067 With MULTI_KBOARD, these events are used as placeholders
4068 when we need to randomly delete events from the queue.
4069 (They shouldn't otherwise be found in the buffer,
4070 but on some machines it appears they do show up
4071 even without MULTI_KBOARD.) */
4072 /* On Windows NT/9X, NO_EVENT is used to delete extraneous
4073 mouse events during a popup-menu call. */
4074 else if (event
->kind
== NO_EVENT
)
4075 kbd_fetch_ptr
= event
+ 1;
4076 else if (event
->kind
== HELP_EVENT
)
4078 Lisp_Object object
, position
, help
, frame
, window
;
4080 frame
= event
->ie
.frame_or_window
;
4081 object
= event
->ie
.arg
;
4082 position
= make_number (Time_to_position (event
->ie
.timestamp
));
4083 window
= event
->ie
.x
;
4085 clear_event (event
);
4087 kbd_fetch_ptr
= event
+ 1;
4088 if (!WINDOWP (window
))
4090 obj
= Fcons (Qhelp_echo
,
4091 list5 (frame
, help
, window
, object
, position
));
4093 else if (event
->kind
== FOCUS_IN_EVENT
)
4095 /* Notification of a FocusIn event. The frame receiving the
4096 focus is in event->frame_or_window. Generate a
4097 switch-frame event if necessary. */
4098 Lisp_Object frame
, focus
;
4100 frame
= event
->ie
.frame_or_window
;
4101 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
4107 ! NILP (event
->ie
.arg
)
4110 !EQ (frame
, internal_last_event_frame
)
4111 && !EQ (frame
, selected_frame
))
4112 obj
= make_lispy_switch_frame (frame
);
4114 obj
= make_lispy_focus_in (frame
);
4116 internal_last_event_frame
= frame
;
4117 kbd_fetch_ptr
= event
+ 1;
4119 else if (event
->kind
== FOCUS_OUT_EVENT
)
4121 #ifdef HAVE_WINDOW_SYSTEM
4124 Lisp_Object frame
= event
->ie
.frame_or_window
;
4125 bool focused
= false;
4127 for (di
= x_display_list
; di
&& ! focused
; di
= di
->next
)
4128 focused
= di
->x_highlight_frame
!= 0;
4131 obj
= make_lispy_focus_out (frame
);
4133 #endif /* HAVE_WINDOW_SYSTEM */
4135 kbd_fetch_ptr
= event
+ 1;
4138 else if (event
->kind
== DBUS_EVENT
)
4140 obj
= make_lispy_event (&event
->ie
);
4141 kbd_fetch_ptr
= event
+ 1;
4144 else if (event
->kind
== CONFIG_CHANGED_EVENT
)
4146 obj
= make_lispy_event (&event
->ie
);
4147 kbd_fetch_ptr
= event
+ 1;
4151 /* If this event is on a different frame, return a switch-frame this
4152 time, and leave the event in the queue for next time. */
4156 frame
= event
->ie
.frame_or_window
;
4158 frame
= XCAR (frame
);
4159 else if (WINDOWP (frame
))
4160 frame
= WINDOW_FRAME (XWINDOW (frame
));
4162 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
4166 if (! EQ (frame
, internal_last_event_frame
)
4167 && !EQ (frame
, selected_frame
))
4168 obj
= make_lispy_switch_frame (frame
);
4169 internal_last_event_frame
= frame
;
4171 /* If we didn't decide to make a switch-frame event, go ahead
4172 and build a real event from the queue entry. */
4176 obj
= make_lispy_event (&event
->ie
);
4178 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
4179 || defined (HAVE_NS) || defined (USE_GTK)
4180 /* If this was a menu selection, then set the flag to inhibit
4181 writing to last_nonmenu_event. Don't do this if the event
4182 we're returning is (menu-bar), though; that indicates the
4183 beginning of the menu sequence, and we might as well leave
4184 that as the `event with parameters' for this selection. */
4186 && !EQ (event
->ie
.frame_or_window
, event
->ie
.arg
)
4187 && (event
->kind
== MENU_BAR_EVENT
4188 || event
->kind
== TOOL_BAR_EVENT
))
4189 *used_mouse_menu
= 1;
4192 /* Certain system events are non-key events. */
4194 && event
->kind
== NS_NONKEY_EVENT
)
4195 *used_mouse_menu
= 1;
4198 /* Wipe out this event, to catch bugs. */
4199 clear_event (event
);
4200 kbd_fetch_ptr
= event
+ 1;
4204 /* Try generating a mouse motion event. */
4205 else if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
4207 struct frame
*f
= some_mouse_moved ();
4208 Lisp_Object bar_window
;
4209 enum scroll_bar_part part
;
4213 *kbp
= current_kboard
;
4214 /* Note that this uses F to determine which terminal to look at.
4215 If there is no valid info, it does not store anything
4216 so x remains nil. */
4219 /* XXX Can f or mouse_position_hook be NULL here? */
4220 if (f
&& FRAME_TERMINAL (f
)->mouse_position_hook
)
4221 (*FRAME_TERMINAL (f
)->mouse_position_hook
) (&f
, 0, &bar_window
,
4226 /* Decide if we should generate a switch-frame event. Don't
4227 generate switch-frame events for motion outside of all Emacs
4233 frame
= FRAME_FOCUS_FRAME (f
);
4235 XSETFRAME (frame
, f
);
4237 if (! EQ (frame
, internal_last_event_frame
)
4238 && !EQ (frame
, selected_frame
))
4239 obj
= make_lispy_switch_frame (frame
);
4240 internal_last_event_frame
= frame
;
4243 /* If we didn't decide to make a switch-frame event, go ahead and
4244 return a mouse-motion event. */
4245 if (!NILP (x
) && NILP (obj
))
4246 obj
= make_lispy_movement (f
, bar_window
, part
, x
, y
, t
);
4249 /* We were promised by the above while loop that there was
4250 something for us to read! */
4253 input_pending
= readable_events (0);
4255 Vlast_event_frame
= internal_last_event_frame
;
4260 /* Process any non-user-visible events (currently X selection events),
4261 without reading any user-visible events. */
4264 process_special_events (void)
4266 union buffered_input_event
*event
;
4268 for (event
= kbd_fetch_ptr
; event
!= kbd_store_ptr
; ++event
)
4270 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
4273 if (event
== kbd_store_ptr
)
4277 /* If we find a stored X selection request, handle it now. */
4278 if (event
->kind
== SELECTION_REQUEST_EVENT
4279 || event
->kind
== SELECTION_CLEAR_EVENT
)
4283 /* Remove the event from the fifo buffer before processing;
4284 otherwise swallow_events called recursively could see it
4285 and process it again. To do this, we move the events
4286 between kbd_fetch_ptr and EVENT one slot to the right,
4289 struct selection_input_event copy
= event
->sie
;
4290 union buffered_input_event
*beg
4291 = (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
4292 ? kbd_buffer
: kbd_fetch_ptr
;
4295 memmove (beg
+ 1, beg
, (event
- beg
) * sizeof *beg
);
4296 else if (event
< beg
)
4298 if (event
> kbd_buffer
)
4299 memmove (kbd_buffer
+ 1, kbd_buffer
,
4300 (event
- kbd_buffer
) * sizeof *kbd_buffer
);
4301 *kbd_buffer
= *(kbd_buffer
+ KBD_BUFFER_SIZE
- 1);
4302 if (beg
< kbd_buffer
+ KBD_BUFFER_SIZE
- 1)
4303 memmove (beg
+ 1, beg
,
4304 (kbd_buffer
+ KBD_BUFFER_SIZE
- 1 - beg
) * sizeof *beg
);
4307 if (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
4308 kbd_fetch_ptr
= kbd_buffer
+ 1;
4312 input_pending
= readable_events (0);
4313 x_handle_selection_event (©
);
4315 /* We're getting selection request events, but we don't have
4323 /* Process any events that are not user-visible, run timer events that
4324 are ripe, and return, without reading any user-visible events. */
4327 swallow_events (bool do_display
)
4329 unsigned old_timers_run
;
4331 process_special_events ();
4333 old_timers_run
= timers_run
;
4334 get_input_pending (READABLE_EVENTS_DO_TIMERS_NOW
);
4336 if (!input_pending
&& timers_run
!= old_timers_run
&& do_display
)
4337 redisplay_preserve_echo_area (7);
4340 /* Record the start of when Emacs is idle,
4341 for the sake of running idle-time timers. */
4344 timer_start_idle (void)
4346 /* If we are already in the idle state, do nothing. */
4347 if (timespec_valid_p (timer_idleness_start_time
))
4350 timer_idleness_start_time
= current_timespec ();
4351 timer_last_idleness_start_time
= timer_idleness_start_time
;
4353 /* Mark all idle-time timers as once again candidates for running. */
4354 call0 (intern ("internal-timer-start-idle"));
4357 /* Record that Emacs is no longer idle, so stop running idle-time timers. */
4360 timer_stop_idle (void)
4362 timer_idleness_start_time
= invalid_timespec ();
4365 /* Resume idle timer from last idle start time. */
4368 timer_resume_idle (void)
4370 if (timespec_valid_p (timer_idleness_start_time
))
4373 timer_idleness_start_time
= timer_last_idleness_start_time
;
4376 /* List of elisp functions to call, delayed because they were generated in
4377 a context where Elisp could not be safely run (e.g. redisplay, signal,
4378 ...). Each element has the form (FUN . ARGS). */
4379 Lisp_Object pending_funcalls
;
4381 /* Return true if TIMER is a valid timer, placing its value into *RESULT. */
4383 decode_timer (Lisp_Object timer
, struct timespec
*result
)
4387 if (! (VECTORP (timer
) && ASIZE (timer
) == 9))
4389 vec
= XVECTOR (timer
)->contents
;
4390 if (! NILP (vec
[0]))
4392 if (! INTEGERP (vec
[2]))
4396 if (decode_time_components (vec
[1], vec
[2], vec
[3], vec
[8], &t
, 0) <= 0)
4398 *result
= lisp_to_timespec (t
);
4399 return timespec_valid_p (*result
);
4403 /* Check whether a timer has fired. To prevent larger problems we simply
4404 disregard elements that are not proper timers. Do not make a circular
4405 timer list for the time being.
4407 Returns the time to wait until the next timer fires. If a
4408 timer is triggering now, return zero.
4409 If no timer is active, return -1.
4411 If a timer is ripe, we run it, with quitting turned off.
4412 In that case we return 0 to indicate that a new timer_check_2 call
4415 static struct timespec
4416 timer_check_2 (Lisp_Object timers
, Lisp_Object idle_timers
)
4418 struct timespec nexttime
;
4419 struct timespec now
;
4420 struct timespec idleness_now
;
4421 Lisp_Object chosen_timer
;
4422 struct gcpro gcpro1
;
4424 nexttime
= invalid_timespec ();
4426 chosen_timer
= Qnil
;
4427 GCPRO1 (chosen_timer
);
4429 /* First run the code that was delayed. */
4430 while (CONSP (pending_funcalls
))
4432 Lisp_Object funcall
= XCAR (pending_funcalls
);
4433 pending_funcalls
= XCDR (pending_funcalls
);
4434 safe_call2 (Qapply
, XCAR (funcall
), XCDR (funcall
));
4437 if (CONSP (timers
) || CONSP (idle_timers
))
4439 now
= current_timespec ();
4440 idleness_now
= (timespec_valid_p (timer_idleness_start_time
)
4441 ? timespec_sub (now
, timer_idleness_start_time
)
4442 : make_timespec (0, 0));
4445 while (CONSP (timers
) || CONSP (idle_timers
))
4447 Lisp_Object timer
= Qnil
, idle_timer
= Qnil
;
4448 struct timespec timer_time
, idle_timer_time
;
4449 struct timespec difference
;
4450 struct timespec timer_difference
= invalid_timespec ();
4451 struct timespec idle_timer_difference
= invalid_timespec ();
4452 bool ripe
, timer_ripe
= 0, idle_timer_ripe
= 0;
4454 /* Set TIMER and TIMER_DIFFERENCE
4455 based on the next ordinary timer.
4456 TIMER_DIFFERENCE is the distance in time from NOW to when
4457 this timer becomes ripe.
4458 Skip past invalid timers and timers already handled. */
4461 timer
= XCAR (timers
);
4462 if (! decode_timer (timer
, &timer_time
))
4464 timers
= XCDR (timers
);
4468 timer_ripe
= timespec_cmp (timer_time
, now
) <= 0;
4469 timer_difference
= (timer_ripe
4470 ? timespec_sub (now
, timer_time
)
4471 : timespec_sub (timer_time
, now
));
4474 /* Likewise for IDLE_TIMER and IDLE_TIMER_DIFFERENCE
4475 based on the next idle timer. */
4476 if (CONSP (idle_timers
))
4478 idle_timer
= XCAR (idle_timers
);
4479 if (! decode_timer (idle_timer
, &idle_timer_time
))
4481 idle_timers
= XCDR (idle_timers
);
4485 idle_timer_ripe
= timespec_cmp (idle_timer_time
, idleness_now
) <= 0;
4486 idle_timer_difference
4488 ? timespec_sub (idleness_now
, idle_timer_time
)
4489 : timespec_sub (idle_timer_time
, idleness_now
));
4492 /* Decide which timer is the next timer,
4493 and set CHOSEN_TIMER, DIFFERENCE, and RIPE accordingly.
4494 Also step down the list where we found that timer. */
4496 if (timespec_valid_p (timer_difference
)
4497 && (! timespec_valid_p (idle_timer_difference
)
4498 || idle_timer_ripe
< timer_ripe
4499 || (idle_timer_ripe
== timer_ripe
4501 ? timespec_cmp (idle_timer_difference
,
4503 : timespec_cmp (timer_difference
,
4504 idle_timer_difference
))
4507 chosen_timer
= timer
;
4508 timers
= XCDR (timers
);
4509 difference
= timer_difference
;
4514 chosen_timer
= idle_timer
;
4515 idle_timers
= XCDR (idle_timers
);
4516 difference
= idle_timer_difference
;
4517 ripe
= idle_timer_ripe
;
4520 /* If timer is ripe, run it if it hasn't been run. */
4523 if (NILP (AREF (chosen_timer
, 0)))
4525 ptrdiff_t count
= SPECPDL_INDEX ();
4526 Lisp_Object old_deactivate_mark
= Vdeactivate_mark
;
4528 /* Mark the timer as triggered to prevent problems if the lisp
4529 code fails to reschedule it right. */
4530 ASET (chosen_timer
, 0, Qt
);
4532 specbind (Qinhibit_quit
, Qt
);
4534 call1 (Qtimer_event_handler
, chosen_timer
);
4535 Vdeactivate_mark
= old_deactivate_mark
;
4537 unbind_to (count
, Qnil
);
4539 /* Since we have handled the event,
4540 we don't need to tell the caller to wake up and do it. */
4541 /* But the caller must still wait for the next timer, so
4542 return 0 to indicate that. */
4545 nexttime
= make_timespec (0, 0);
4549 /* When we encounter a timer that is still waiting,
4550 return the amount of time to wait before it is ripe. */
4557 /* No timers are pending in the future. */
4558 /* Return 0 if we generated an event, and -1 if not. */
4564 /* Check whether a timer has fired. To prevent larger problems we simply
4565 disregard elements that are not proper timers. Do not make a circular
4566 timer list for the time being.
4568 Returns the time to wait until the next timer fires.
4569 If no timer is active, return an invalid value.
4571 As long as any timer is ripe, we run it. */
4576 struct timespec nexttime
;
4577 Lisp_Object timers
, idle_timers
;
4578 struct gcpro gcpro1
, gcpro2
;
4580 Lisp_Object tem
= Vinhibit_quit
;
4583 /* We use copies of the timers' lists to allow a timer to add itself
4584 again, without locking up Emacs if the newly added timer is
4585 already ripe when added. */
4587 /* Always consider the ordinary timers. */
4588 timers
= Fcopy_sequence (Vtimer_list
);
4589 /* Consider the idle timers only if Emacs is idle. */
4590 if (timespec_valid_p (timer_idleness_start_time
))
4591 idle_timers
= Fcopy_sequence (Vtimer_idle_list
);
4595 Vinhibit_quit
= tem
;
4597 GCPRO2 (timers
, idle_timers
);
4601 nexttime
= timer_check_2 (timers
, idle_timers
);
4603 while (nexttime
.tv_sec
== 0 && nexttime
.tv_nsec
== 0);
4609 DEFUN ("current-idle-time", Fcurrent_idle_time
, Scurrent_idle_time
, 0, 0, 0,
4610 doc
: /* Return the current length of Emacs idleness, or nil.
4611 The value when Emacs is idle is a list of four integers (HIGH LOW USEC PSEC)
4612 in the same style as (current-time).
4614 The value when Emacs is not idle is nil.
4616 PSEC is a multiple of the system clock resolution. */)
4619 if (timespec_valid_p (timer_idleness_start_time
))
4620 return make_lisp_time (timespec_sub (current_timespec (),
4621 timer_idleness_start_time
));
4626 /* Caches for modify_event_symbol. */
4627 static Lisp_Object accent_key_syms
;
4628 static Lisp_Object func_key_syms
;
4629 static Lisp_Object mouse_syms
;
4630 static Lisp_Object wheel_syms
;
4631 static Lisp_Object drag_n_drop_syms
;
4633 /* This is a list of keysym codes for special "accent" characters.
4634 It parallels lispy_accent_keys. */
4636 static const int lispy_accent_codes
[] =
4638 #ifdef XK_dead_circumflex
4643 #ifdef XK_dead_grave
4648 #ifdef XK_dead_tilde
4653 #ifdef XK_dead_diaeresis
4658 #ifdef XK_dead_macron
4663 #ifdef XK_dead_degree
4668 #ifdef XK_dead_acute
4673 #ifdef XK_dead_cedilla
4678 #ifdef XK_dead_breve
4683 #ifdef XK_dead_ogonek
4688 #ifdef XK_dead_caron
4693 #ifdef XK_dead_doubleacute
4694 XK_dead_doubleacute
,
4698 #ifdef XK_dead_abovedot
4703 #ifdef XK_dead_abovering
4713 #ifdef XK_dead_belowdot
4718 #ifdef XK_dead_voiced_sound
4719 XK_dead_voiced_sound
,
4723 #ifdef XK_dead_semivoiced_sound
4724 XK_dead_semivoiced_sound
,
4740 /* This is a list of Lisp names for special "accent" characters.
4741 It parallels lispy_accent_codes. */
4743 static const char *const lispy_accent_keys
[] =
4761 "dead-voiced-sound",
4762 "dead-semivoiced-sound",
4768 #define FUNCTION_KEY_OFFSET 0x0
4770 const char *const lispy_function_keys
[] =
4774 0, /* VK_LBUTTON 0x01 */
4775 0, /* VK_RBUTTON 0x02 */
4776 "cancel", /* VK_CANCEL 0x03 */
4777 0, /* VK_MBUTTON 0x04 */
4779 0, 0, 0, /* 0x05 .. 0x07 */
4781 "backspace", /* VK_BACK 0x08 */
4782 "tab", /* VK_TAB 0x09 */
4784 0, 0, /* 0x0A .. 0x0B */
4786 "clear", /* VK_CLEAR 0x0C */
4787 "return", /* VK_RETURN 0x0D */
4789 0, 0, /* 0x0E .. 0x0F */
4791 0, /* VK_SHIFT 0x10 */
4792 0, /* VK_CONTROL 0x11 */
4793 0, /* VK_MENU 0x12 */
4794 "pause", /* VK_PAUSE 0x13 */
4795 "capslock", /* VK_CAPITAL 0x14 */
4796 "kana", /* VK_KANA/VK_HANGUL 0x15 */
4798 "junja", /* VK_JUNJA 0x17 */
4799 "final", /* VK_FINAL 0x18 */
4800 "kanji", /* VK_KANJI/VK_HANJA 0x19 */
4802 "escape", /* VK_ESCAPE 0x1B */
4803 "convert", /* VK_CONVERT 0x1C */
4804 "non-convert", /* VK_NONCONVERT 0x1D */
4805 "accept", /* VK_ACCEPT 0x1E */
4806 "mode-change", /* VK_MODECHANGE 0x1F */
4807 0, /* VK_SPACE 0x20 */
4808 "prior", /* VK_PRIOR 0x21 */
4809 "next", /* VK_NEXT 0x22 */
4810 "end", /* VK_END 0x23 */
4811 "home", /* VK_HOME 0x24 */
4812 "left", /* VK_LEFT 0x25 */
4813 "up", /* VK_UP 0x26 */
4814 "right", /* VK_RIGHT 0x27 */
4815 "down", /* VK_DOWN 0x28 */
4816 "select", /* VK_SELECT 0x29 */
4817 "print", /* VK_PRINT 0x2A */
4818 "execute", /* VK_EXECUTE 0x2B */
4819 "snapshot", /* VK_SNAPSHOT 0x2C */
4820 "insert", /* VK_INSERT 0x2D */
4821 "delete", /* VK_DELETE 0x2E */
4822 "help", /* VK_HELP 0x2F */
4824 /* VK_0 thru VK_9 are the same as ASCII '0' thru '9' (0x30 - 0x39) */
4826 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4828 0, 0, 0, 0, 0, 0, 0, /* 0x3A .. 0x40 */
4830 /* VK_A thru VK_Z are the same as ASCII 'A' thru 'Z' (0x41 - 0x5A) */
4832 0, 0, 0, 0, 0, 0, 0, 0, 0,
4833 0, 0, 0, 0, 0, 0, 0, 0, 0,
4834 0, 0, 0, 0, 0, 0, 0, 0,
4836 "lwindow", /* VK_LWIN 0x5B */
4837 "rwindow", /* VK_RWIN 0x5C */
4838 "apps", /* VK_APPS 0x5D */
4841 "kp-0", /* VK_NUMPAD0 0x60 */
4842 "kp-1", /* VK_NUMPAD1 0x61 */
4843 "kp-2", /* VK_NUMPAD2 0x62 */
4844 "kp-3", /* VK_NUMPAD3 0x63 */
4845 "kp-4", /* VK_NUMPAD4 0x64 */
4846 "kp-5", /* VK_NUMPAD5 0x65 */
4847 "kp-6", /* VK_NUMPAD6 0x66 */
4848 "kp-7", /* VK_NUMPAD7 0x67 */
4849 "kp-8", /* VK_NUMPAD8 0x68 */
4850 "kp-9", /* VK_NUMPAD9 0x69 */
4851 "kp-multiply", /* VK_MULTIPLY 0x6A */
4852 "kp-add", /* VK_ADD 0x6B */
4853 "kp-separator", /* VK_SEPARATOR 0x6C */
4854 "kp-subtract", /* VK_SUBTRACT 0x6D */
4855 "kp-decimal", /* VK_DECIMAL 0x6E */
4856 "kp-divide", /* VK_DIVIDE 0x6F */
4857 "f1", /* VK_F1 0x70 */
4858 "f2", /* VK_F2 0x71 */
4859 "f3", /* VK_F3 0x72 */
4860 "f4", /* VK_F4 0x73 */
4861 "f5", /* VK_F5 0x74 */
4862 "f6", /* VK_F6 0x75 */
4863 "f7", /* VK_F7 0x76 */
4864 "f8", /* VK_F8 0x77 */
4865 "f9", /* VK_F9 0x78 */
4866 "f10", /* VK_F10 0x79 */
4867 "f11", /* VK_F11 0x7A */
4868 "f12", /* VK_F12 0x7B */
4869 "f13", /* VK_F13 0x7C */
4870 "f14", /* VK_F14 0x7D */
4871 "f15", /* VK_F15 0x7E */
4872 "f16", /* VK_F16 0x7F */
4873 "f17", /* VK_F17 0x80 */
4874 "f18", /* VK_F18 0x81 */
4875 "f19", /* VK_F19 0x82 */
4876 "f20", /* VK_F20 0x83 */
4877 "f21", /* VK_F21 0x84 */
4878 "f22", /* VK_F22 0x85 */
4879 "f23", /* VK_F23 0x86 */
4880 "f24", /* VK_F24 0x87 */
4882 0, 0, 0, 0, /* 0x88 .. 0x8B */
4883 0, 0, 0, 0, /* 0x8C .. 0x8F */
4885 "kp-numlock", /* VK_NUMLOCK 0x90 */
4886 "scroll", /* VK_SCROLL 0x91 */
4887 /* Not sure where the following block comes from.
4888 Windows headers have NEC and Fujitsu specific keys in
4889 this block, but nothing generic. */
4890 "kp-space", /* VK_NUMPAD_CLEAR 0x92 */
4891 "kp-enter", /* VK_NUMPAD_ENTER 0x93 */
4892 "kp-prior", /* VK_NUMPAD_PRIOR 0x94 */
4893 "kp-next", /* VK_NUMPAD_NEXT 0x95 */
4894 "kp-end", /* VK_NUMPAD_END 0x96 */
4895 "kp-home", /* VK_NUMPAD_HOME 0x97 */
4896 "kp-left", /* VK_NUMPAD_LEFT 0x98 */
4897 "kp-up", /* VK_NUMPAD_UP 0x99 */
4898 "kp-right", /* VK_NUMPAD_RIGHT 0x9A */
4899 "kp-down", /* VK_NUMPAD_DOWN 0x9B */
4900 "kp-insert", /* VK_NUMPAD_INSERT 0x9C */
4901 "kp-delete", /* VK_NUMPAD_DELETE 0x9D */
4903 0, 0, /* 0x9E .. 0x9F */
4906 * VK_L* & VK_R* - left and right Alt, Ctrl and Shift virtual keys.
4907 * Used only as parameters to GetAsyncKeyState and GetKeyState.
4908 * No other API or message will distinguish left and right keys this way.
4913 /* Multimedia keys. These are handled as WM_APPCOMMAND, which allows us
4914 to enable them selectively, and gives access to a few more functions.
4915 See lispy_multimedia_keys below. */
4916 0, 0, 0, 0, 0, 0, 0, /* 0xA6 .. 0xAC Browser */
4917 0, 0, 0, /* 0xAD .. 0xAF Volume */
4918 0, 0, 0, 0, /* 0xB0 .. 0xB3 Media */
4919 0, 0, 0, 0, /* 0xB4 .. 0xB7 Apps */
4921 /* 0xB8 .. 0xC0 "OEM" keys - all seem to be punctuation. */
4922 0, 0, 0, 0, 0, 0, 0, 0, 0,
4924 /* 0xC1 - 0xDA unallocated, 0xDB-0xDF more OEM keys */
4925 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4926 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4929 "ax", /* VK_OEM_AX 0xE1 */
4930 0, /* VK_OEM_102 0xE2 */
4931 "ico-help", /* VK_ICO_HELP 0xE3 */
4932 "ico-00", /* VK_ICO_00 0xE4 */
4933 0, /* VK_PROCESSKEY 0xE5 - used by IME */
4934 "ico-clear", /* VK_ICO_CLEAR 0xE6 */
4935 0, /* VK_PACKET 0xE7 - used to pass Unicode chars */
4937 "reset", /* VK_OEM_RESET 0xE9 */
4938 "jump", /* VK_OEM_JUMP 0xEA */
4939 "oem-pa1", /* VK_OEM_PA1 0xEB */
4940 "oem-pa2", /* VK_OEM_PA2 0xEC */
4941 "oem-pa3", /* VK_OEM_PA3 0xED */
4942 "wsctrl", /* VK_OEM_WSCTRL 0xEE */
4943 "cusel", /* VK_OEM_CUSEL 0xEF */
4944 "oem-attn", /* VK_OEM_ATTN 0xF0 */
4945 "finish", /* VK_OEM_FINISH 0xF1 */
4946 "copy", /* VK_OEM_COPY 0xF2 */
4947 "auto", /* VK_OEM_AUTO 0xF3 */
4948 "enlw", /* VK_OEM_ENLW 0xF4 */
4949 "backtab", /* VK_OEM_BACKTAB 0xF5 */
4950 "attn", /* VK_ATTN 0xF6 */
4951 "crsel", /* VK_CRSEL 0xF7 */
4952 "exsel", /* VK_EXSEL 0xF8 */
4953 "ereof", /* VK_EREOF 0xF9 */
4954 "play", /* VK_PLAY 0xFA */
4955 "zoom", /* VK_ZOOM 0xFB */
4956 "noname", /* VK_NONAME 0xFC */
4957 "pa1", /* VK_PA1 0xFD */
4958 "oem_clear", /* VK_OEM_CLEAR 0xFE */
4962 /* Some of these duplicate the "Media keys" on newer keyboards,
4963 but they are delivered to the application in a different way. */
4964 static const char *const lispy_multimedia_keys
[] =
4972 "browser-favorites",
5009 "toggle-dictate-command",
5015 "media-fast-forward",
5018 "media-channel-down"
5021 #else /* not HAVE_NTGUI */
5023 /* This should be dealt with in XTread_socket now, and that doesn't
5024 depend on the client system having the Kana syms defined. See also
5025 the XK_kana_A case below. */
5028 static const char *const lispy_kana_keys
[] =
5030 /* X Keysym value */
5031 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x400 .. 0x40f */
5032 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x410 .. 0x41f */
5033 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x420 .. 0x42f */
5034 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x430 .. 0x43f */
5035 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x440 .. 0x44f */
5036 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x450 .. 0x45f */
5037 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x460 .. 0x46f */
5038 0,0,0,0,0,0,0,0,0,0,0,0,0,0,"overline",0,
5039 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x480 .. 0x48f */
5040 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x490 .. 0x49f */
5041 0, "kana-fullstop", "kana-openingbracket", "kana-closingbracket",
5042 "kana-comma", "kana-conjunctive", "kana-WO", "kana-a",
5043 "kana-i", "kana-u", "kana-e", "kana-o",
5044 "kana-ya", "kana-yu", "kana-yo", "kana-tsu",
5045 "prolongedsound", "kana-A", "kana-I", "kana-U",
5046 "kana-E", "kana-O", "kana-KA", "kana-KI",
5047 "kana-KU", "kana-KE", "kana-KO", "kana-SA",
5048 "kana-SHI", "kana-SU", "kana-SE", "kana-SO",
5049 "kana-TA", "kana-CHI", "kana-TSU", "kana-TE",
5050 "kana-TO", "kana-NA", "kana-NI", "kana-NU",
5051 "kana-NE", "kana-NO", "kana-HA", "kana-HI",
5052 "kana-FU", "kana-HE", "kana-HO", "kana-MA",
5053 "kana-MI", "kana-MU", "kana-ME", "kana-MO",
5054 "kana-YA", "kana-YU", "kana-YO", "kana-RA",
5055 "kana-RI", "kana-RU", "kana-RE", "kana-RO",
5056 "kana-WA", "kana-N", "voicedsound", "semivoicedsound",
5057 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4e0 .. 0x4ef */
5058 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4f0 .. 0x4ff */
5060 #endif /* XK_kana_A */
5063 #define FUNCTION_KEY_OFFSET 0xff00
5065 /* You'll notice that this table is arranged to be conveniently
5066 indexed by X Windows keysym values. */
5067 static const char *const lispy_function_keys
[] =
5069 /* X Keysym value */
5071 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff00...0f */
5072 "backspace", "tab", "linefeed", "clear",
5074 0, 0, 0, "pause", /* 0xff10...1f */
5075 0, 0, 0, 0, 0, 0, 0, "escape",
5077 0, "kanji", "muhenkan", "henkan", /* 0xff20...2f */
5078 "romaji", "hiragana", "katakana", "hiragana-katakana",
5079 "zenkaku", "hankaku", "zenkaku-hankaku", "touroku",
5080 "massyo", "kana-lock", "kana-shift", "eisu-shift",
5081 "eisu-toggle", /* 0xff30...3f */
5082 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
5083 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff40...4f */
5085 "home", "left", "up", "right", /* 0xff50 */ /* IsCursorKey */
5086 "down", "prior", "next", "end",
5087 "begin", 0, 0, 0, 0, 0, 0, 0,
5088 "select", /* 0xff60 */ /* IsMiscFunctionKey */
5099 "break", /* 0xff6b */
5102 0, 0, 0, 0, "backtab", 0, 0, 0, /* 0xff70... */
5103 0, 0, 0, 0, 0, 0, 0, "kp-numlock", /* 0xff78... */
5104 "kp-space", /* 0xff80 */ /* IsKeypadKey */
5105 0, 0, 0, 0, 0, 0, 0, 0,
5106 "kp-tab", /* 0xff89 */
5108 "kp-enter", /* 0xff8d */
5110 "kp-f1", /* 0xff91 */
5114 "kp-home", /* 0xff95 */
5119 "kp-prior", /* kp-page-up */
5120 "kp-next", /* kp-page-down */
5126 0, 0, 0, 0, 0, 0, 0, 0, 0,
5127 "kp-multiply", /* 0xffaa */
5132 "kp-divide", /* 0xffaf */
5133 "kp-0", /* 0xffb0 */
5134 "kp-1", "kp-2", "kp-3", "kp-4", "kp-5", "kp-6", "kp-7", "kp-8", "kp-9",
5137 "kp-equal", /* 0xffbd */
5138 "f1", /* 0xffbe */ /* IsFunctionKey */
5140 "f3", "f4", "f5", "f6", "f7", "f8", "f9", "f10", /* 0xffc0 */
5141 "f11", "f12", "f13", "f14", "f15", "f16", "f17", "f18",
5142 "f19", "f20", "f21", "f22", "f23", "f24", "f25", "f26", /* 0xffd0 */
5143 "f27", "f28", "f29", "f30", "f31", "f32", "f33", "f34",
5144 "f35", 0, 0, 0, 0, 0, 0, 0, /* 0xffe0 */
5145 0, 0, 0, 0, 0, 0, 0, 0,
5146 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfff0 */
5147 0, 0, 0, 0, 0, 0, 0, "delete"
5150 /* ISO 9995 Function and Modifier Keys; the first byte is 0xFE. */
5151 #define ISO_FUNCTION_KEY_OFFSET 0xfe00
5153 static const char *const iso_lispy_function_keys
[] =
5155 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe00 */
5156 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe08 */
5157 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe10 */
5158 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe18 */
5159 "iso-lefttab", /* 0xfe20 */
5160 "iso-move-line-up", "iso-move-line-down",
5161 "iso-partial-line-up", "iso-partial-line-down",
5162 "iso-partial-space-left", "iso-partial-space-right",
5163 "iso-set-margin-left", "iso-set-margin-right", /* 0xffe27, 28 */
5164 "iso-release-margin-left", "iso-release-margin-right",
5165 "iso-release-both-margins",
5166 "iso-fast-cursor-left", "iso-fast-cursor-right",
5167 "iso-fast-cursor-up", "iso-fast-cursor-down",
5168 "iso-continuous-underline", "iso-discontinuous-underline", /* 0xfe30, 31 */
5169 "iso-emphasize", "iso-center-object", "iso-enter", /* ... 0xfe34 */
5172 #endif /* not HAVE_NTGUI */
5174 static Lisp_Object Vlispy_mouse_stem
;
5176 static const char *const lispy_wheel_names
[] =
5178 "wheel-up", "wheel-down", "wheel-left", "wheel-right"
5181 /* drag-n-drop events are generated when a set of selected files are
5182 dragged from another application and dropped onto an Emacs window. */
5183 static const char *const lispy_drag_n_drop_names
[] =
5188 /* An array of symbol indexes of scroll bar parts, indexed by an enum
5189 scroll_bar_part value. Note that Qnil corresponds to
5190 scroll_bar_nowhere and should not appear in Lisp events. */
5191 static short const scroll_bar_parts
[] = {
5192 SYMBOL_INDEX (Qnil
), SYMBOL_INDEX (Qabove_handle
), SYMBOL_INDEX (Qhandle
),
5193 SYMBOL_INDEX (Qbelow_handle
), SYMBOL_INDEX (Qup
), SYMBOL_INDEX (Qdown
),
5194 SYMBOL_INDEX (Qtop
), SYMBOL_INDEX (Qbottom
), SYMBOL_INDEX (Qend_scroll
),
5195 SYMBOL_INDEX (Qratio
), SYMBOL_INDEX (Qbefore_handle
),
5196 SYMBOL_INDEX (Qhorizontal_handle
), SYMBOL_INDEX (Qafter_handle
),
5197 SYMBOL_INDEX (Qleft
), SYMBOL_INDEX (Qright
), SYMBOL_INDEX (Qleftmost
),
5198 SYMBOL_INDEX (Qrightmost
), SYMBOL_INDEX (Qend_scroll
), SYMBOL_INDEX (Qratio
)
5201 /* A vector, indexed by button number, giving the down-going location
5202 of currently depressed buttons, both scroll bar and non-scroll bar.
5204 The elements have the form
5205 (BUTTON-NUMBER MODIFIER-MASK . REST)
5206 where REST is the cdr of a position as it would be reported in the event.
5208 The make_lispy_event function stores positions here to tell the
5209 difference between click and drag events, and to store the starting
5210 location to be included in drag events. */
5212 static Lisp_Object button_down_location
;
5214 /* Information about the most recent up-going button event: Which
5215 button, what location, and what time. */
5217 static int last_mouse_button
;
5218 static int last_mouse_x
;
5219 static int last_mouse_y
;
5220 static Time button_down_time
;
5222 /* The number of clicks in this multiple-click. */
5224 static int double_click_count
;
5226 /* X and Y are frame-relative coordinates for a click or wheel event.
5227 Return a Lisp-style event list. */
5230 make_lispy_position (struct frame
*f
, Lisp_Object x
, Lisp_Object y
,
5233 enum window_part part
;
5234 Lisp_Object posn
= Qnil
;
5235 Lisp_Object extra_info
= Qnil
;
5236 /* Coordinate pixel positions to return. */
5237 int xret
= 0, yret
= 0;
5238 /* The window under frame pixel coordinates (x,y) */
5239 Lisp_Object window
= f
5240 ? window_from_coordinates (f
, XINT (x
), XINT (y
), &part
, 0)
5243 if (WINDOWP (window
))
5245 /* It's a click in window WINDOW at frame coordinates (X,Y) */
5246 struct window
*w
= XWINDOW (window
);
5247 Lisp_Object string_info
= Qnil
;
5248 ptrdiff_t textpos
= 0;
5249 int col
= -1, row
= -1;
5250 int dx
= -1, dy
= -1;
5251 int width
= -1, height
= -1;
5252 Lisp_Object object
= Qnil
;
5254 /* Pixel coordinates relative to the window corner. */
5255 int wx
= XINT (x
) - WINDOW_LEFT_EDGE_X (w
);
5256 int wy
= XINT (y
) - WINDOW_TOP_EDGE_Y (w
);
5258 /* For text area clicks, return X, Y relative to the corner of
5259 this text area. Note that dX, dY etc are set below, by
5260 buffer_posn_from_coords. */
5261 if (part
== ON_TEXT
)
5263 xret
= XINT (x
) - window_box_left (w
, TEXT_AREA
);
5264 yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5266 /* For mode line and header line clicks, return X, Y relative to
5267 the left window edge. Use mode_line_string to look for a
5268 string on the click position. */
5269 else if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
)
5274 posn
= (part
== ON_MODE_LINE
) ? Qmode_line
: Qheader_line
;
5275 /* Note that mode_line_string takes COL, ROW as pixels and
5276 converts them to characters. */
5279 string
= mode_line_string (w
, part
, &col
, &row
, &charpos
,
5280 &object
, &dx
, &dy
, &width
, &height
);
5281 if (STRINGP (string
))
5282 string_info
= Fcons (string
, make_number (charpos
));
5288 /* For fringes and margins, Y is relative to the area's (and the
5289 window's) top edge, while X is meaningless. */
5290 else if (part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
5295 posn
= (part
== ON_LEFT_MARGIN
) ? Qleft_margin
: Qright_margin
;
5298 string
= marginal_area_string (w
, part
, &col
, &row
, &charpos
,
5299 &object
, &dx
, &dy
, &width
, &height
);
5300 if (STRINGP (string
))
5301 string_info
= Fcons (string
, make_number (charpos
));
5303 yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5305 else if (part
== ON_LEFT_FRINGE
)
5307 posn
= Qleft_fringe
;
5311 - (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5312 ? 0 : window_box_width (w
, LEFT_MARGIN_AREA
));
5313 dy
= yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5315 else if (part
== ON_RIGHT_FRINGE
)
5317 posn
= Qright_fringe
;
5321 - window_box_width (w
, LEFT_MARGIN_AREA
)
5322 - window_box_width (w
, TEXT_AREA
)
5323 - (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5324 ? window_box_width (w
, RIGHT_MARGIN_AREA
)
5326 dy
= yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5328 else if (part
== ON_VERTICAL_BORDER
)
5330 posn
= Qvertical_line
;
5336 else if (part
== ON_VERTICAL_SCROLL_BAR
)
5338 posn
= Qvertical_scroll_bar
;
5339 width
= WINDOW_SCROLL_BAR_AREA_WIDTH (w
);
5343 else if (part
== ON_HORIZONTAL_SCROLL_BAR
)
5345 posn
= Qhorizontal_scroll_bar
;
5346 width
= WINDOW_SCROLL_BAR_AREA_HEIGHT (w
);
5350 else if (part
== ON_RIGHT_DIVIDER
)
5352 posn
= Qright_divider
;
5353 width
= WINDOW_RIGHT_DIVIDER_WIDTH (w
);
5357 else if (part
== ON_BOTTOM_DIVIDER
)
5359 posn
= Qbottom_divider
;
5360 width
= WINDOW_BOTTOM_DIVIDER_WIDTH (w
);
5365 /* For clicks in the text area, fringes, margins, or vertical
5366 scroll bar, call buffer_posn_from_coords to extract TEXTPOS,
5367 the buffer position nearest to the click. */
5370 Lisp_Object string2
, object2
= Qnil
;
5371 struct display_pos p
;
5373 int width2
, height2
;
5374 /* The pixel X coordinate passed to buffer_posn_from_coords
5375 is the X coordinate relative to the text area for clicks
5376 in text-area, right-margin/fringe and right-side vertical
5377 scroll bar, zero otherwise. */
5379 = (part
== ON_TEXT
) ? xret
5380 : (part
== ON_RIGHT_FRINGE
|| part
== ON_RIGHT_MARGIN
5381 || (part
== ON_VERTICAL_SCROLL_BAR
5382 && WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_RIGHT (w
)))
5383 ? (XINT (x
) - window_box_left (w
, TEXT_AREA
))
5387 string2
= buffer_posn_from_coords (w
, &x2
, &y2
, &p
,
5388 &object2
, &dx2
, &dy2
,
5390 textpos
= CHARPOS (p
.pos
);
5391 if (col
< 0) col
= x2
;
5392 if (row
< 0) row
= y2
;
5393 if (dx
< 0) dx
= dx2
;
5394 if (dy
< 0) dy
= dy2
;
5395 if (width
< 0) width
= width2
;
5396 if (height
< 0) height
= height2
;
5400 posn
= make_number (textpos
);
5401 if (STRINGP (string2
))
5402 string_info
= Fcons (string2
,
5403 make_number (CHARPOS (p
.string_pos
)));
5409 #ifdef HAVE_WINDOW_SYSTEM
5410 if (IMAGEP (object
))
5412 Lisp_Object image_map
, hotspot
;
5413 if ((image_map
= Fplist_get (XCDR (object
), QCmap
),
5415 && (hotspot
= find_hot_spot (image_map
, dx
, dy
),
5417 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
5418 posn
= XCAR (hotspot
);
5425 Fcons (make_number (dx
), make_number (dy
)),
5426 Fcons (make_number (width
), make_number (height
)));
5429 extra_info
= Fcons (string_info
,
5430 Fcons (textpos
< 0 ? Qnil
: make_number (textpos
),
5431 Fcons (Fcons (make_number (col
),
5437 /* Return mouse pixel coordinates here. */
5438 XSETFRAME (window
, f
);
5445 return Fcons (window
,
5447 Fcons (Fcons (make_number (xret
),
5448 make_number (yret
)),
5449 Fcons (make_number (t
),
5453 /* Return non-zero if F is a GUI frame that uses some toolkit-managed
5454 menu bar. This really means that Emacs draws and manages the menu
5455 bar as part of its normal display, and therefore can compute its
5458 toolkit_menubar_in_use (struct frame
*f
)
5460 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS) || defined (HAVE_NTGUI)
5461 return !(!FRAME_WINDOW_P (f
));
5467 /* Build the part of Lisp event which represents scroll bar state from
5468 EV. TYPE is one of Qvertical_scroll_bar or Qhorizontal_scroll_bar. */
5471 make_scroll_bar_position (struct input_event
*ev
, Lisp_Object type
)
5473 return list5 (ev
->frame_or_window
, type
, Fcons (ev
->x
, ev
->y
),
5474 make_number (ev
->timestamp
),
5475 builtin_lisp_symbol (scroll_bar_parts
[ev
->part
]));
5478 /* Given a struct input_event, build the lisp event which represents
5479 it. If EVENT is 0, build a mouse movement event from the mouse
5480 movement buffer, which should have a movement event in it.
5482 Note that events must be passed to this function in the order they
5483 are received; this function stores the location of button presses
5484 in order to build drag events when the button is released. */
5487 make_lispy_event (struct input_event
*event
)
5491 switch (event
->kind
)
5493 /* A simple keystroke. */
5494 case ASCII_KEYSTROKE_EVENT
:
5495 case MULTIBYTE_CHAR_KEYSTROKE_EVENT
:
5497 Lisp_Object lispy_c
;
5498 EMACS_INT c
= event
->code
;
5499 if (event
->kind
== ASCII_KEYSTROKE_EVENT
)
5502 eassert (c
== event
->code
);
5503 /* Turn ASCII characters into control characters
5505 if (event
->modifiers
& ctrl_modifier
)
5507 c
= make_ctrl_char (c
);
5508 event
->modifiers
&= ~ctrl_modifier
;
5512 /* Add in the other modifier bits. The shift key was taken care
5513 of by the X code. */
5514 c
|= (event
->modifiers
5515 & (meta_modifier
| alt_modifier
5516 | hyper_modifier
| super_modifier
| ctrl_modifier
));
5517 /* Distinguish Shift-SPC from SPC. */
5518 if ((event
->code
) == 040
5519 && event
->modifiers
& shift_modifier
)
5520 c
|= shift_modifier
;
5521 button_down_time
= 0;
5522 XSETFASTINT (lispy_c
, c
);
5527 /* NS_NONKEY_EVENTs are just like NON_ASCII_KEYSTROKE_EVENTs,
5528 except that they are non-key events (last-nonmenu-event is nil). */
5529 case NS_NONKEY_EVENT
:
5532 /* A function key. The symbol may need to have modifier prefixes
5534 case NON_ASCII_KEYSTROKE_EVENT
:
5535 button_down_time
= 0;
5537 for (i
= 0; i
< ARRAYELTS (lispy_accent_codes
); i
++)
5538 if (event
->code
== lispy_accent_codes
[i
])
5539 return modify_event_symbol (i
,
5541 Qfunction_key
, Qnil
,
5542 lispy_accent_keys
, &accent_key_syms
,
5543 ARRAYELTS (lispy_accent_keys
));
5547 if (event
->code
>= 0x400 && event
->code
< 0x500)
5548 return modify_event_symbol (event
->code
- 0x400,
5549 event
->modifiers
& ~shift_modifier
,
5550 Qfunction_key
, Qnil
,
5551 lispy_kana_keys
, &func_key_syms
,
5552 ARRAYELTS (lispy_kana_keys
));
5553 #endif /* XK_kana_A */
5556 #ifdef ISO_FUNCTION_KEY_OFFSET
5557 if (event
->code
< FUNCTION_KEY_OFFSET
5558 && event
->code
>= ISO_FUNCTION_KEY_OFFSET
)
5559 return modify_event_symbol (event
->code
- ISO_FUNCTION_KEY_OFFSET
,
5561 Qfunction_key
, Qnil
,
5562 iso_lispy_function_keys
, &func_key_syms
,
5563 ARRAYELTS (iso_lispy_function_keys
));
5566 if ((FUNCTION_KEY_OFFSET
<= event
->code
5568 < FUNCTION_KEY_OFFSET
+ ARRAYELTS (lispy_function_keys
)))
5569 && lispy_function_keys
[event
->code
- FUNCTION_KEY_OFFSET
])
5570 return modify_event_symbol (event
->code
- FUNCTION_KEY_OFFSET
,
5572 Qfunction_key
, Qnil
,
5573 lispy_function_keys
, &func_key_syms
,
5574 ARRAYELTS (lispy_function_keys
));
5576 /* Handle system-specific or unknown keysyms.
5577 We need to use an alist rather than a vector as the cache
5578 since we can't make a vector long enough. */
5579 if (NILP (KVAR (current_kboard
, system_key_syms
)))
5580 kset_system_key_syms (current_kboard
, Fcons (Qnil
, Qnil
));
5581 return modify_event_symbol (event
->code
,
5584 KVAR (current_kboard
, Vsystem_key_alist
),
5585 0, &KVAR (current_kboard
, system_key_syms
),
5589 case MULTIMEDIA_KEY_EVENT
:
5590 if (event
->code
< ARRAYELTS (lispy_multimedia_keys
)
5591 && event
->code
> 0 && lispy_multimedia_keys
[event
->code
])
5593 return modify_event_symbol (event
->code
, event
->modifiers
,
5594 Qfunction_key
, Qnil
,
5595 lispy_multimedia_keys
, &func_key_syms
,
5596 ARRAYELTS (lispy_multimedia_keys
));
5601 /* A mouse click. Figure out where it is, decide whether it's
5602 a press, click or drag, and build the appropriate structure. */
5603 case MOUSE_CLICK_EVENT
:
5605 case GPM_CLICK_EVENT
:
5607 #ifndef USE_TOOLKIT_SCROLL_BARS
5608 case SCROLL_BAR_CLICK_EVENT
:
5609 case HORIZONTAL_SCROLL_BAR_CLICK_EVENT
:
5612 int button
= event
->code
;
5614 Lisp_Object position
;
5615 Lisp_Object
*start_pos_ptr
;
5616 Lisp_Object start_pos
;
5620 /* Build the position as appropriate for this mouse click. */
5621 if (event
->kind
== MOUSE_CLICK_EVENT
5623 || event
->kind
== GPM_CLICK_EVENT
5627 struct frame
*f
= XFRAME (event
->frame_or_window
);
5630 /* Ignore mouse events that were made on frame that
5631 have been deleted. */
5632 if (! FRAME_LIVE_P (f
))
5635 /* EVENT->x and EVENT->y are frame-relative pixel
5636 coordinates at this place. Under old redisplay, COLUMN
5637 and ROW are set to frame relative glyph coordinates
5638 which are then used to determine whether this click is
5639 in a menu (non-toolkit version). */
5640 if (!toolkit_menubar_in_use (f
))
5642 pixel_to_glyph_coords (f
, XINT (event
->x
), XINT (event
->y
),
5643 &column
, &row
, NULL
, 1);
5645 /* In the non-toolkit version, clicks on the menu bar
5646 are ordinary button events in the event buffer.
5647 Distinguish them, and invoke the menu.
5649 (In the toolkit version, the toolkit handles the
5650 menu bar and Emacs doesn't know about it until
5651 after the user makes a selection.) */
5652 if (row
>= 0 && row
< FRAME_MENU_BAR_LINES (f
)
5653 && (event
->modifiers
& down_modifier
))
5655 Lisp_Object items
, item
;
5657 /* Find the menu bar item under `column'. */
5659 items
= FRAME_MENU_BAR_ITEMS (f
);
5660 for (i
= 0; i
< ASIZE (items
); i
+= 4)
5662 Lisp_Object pos
, string
;
5663 string
= AREF (items
, i
+ 1);
5664 pos
= AREF (items
, i
+ 3);
5667 if (column
>= XINT (pos
)
5668 && column
< XINT (pos
) + SCHARS (string
))
5670 item
= AREF (items
, i
);
5675 /* ELisp manual 2.4b says (x y) are window
5676 relative but code says they are
5678 position
= list4 (event
->frame_or_window
,
5680 Fcons (event
->x
, event
->y
),
5681 make_number (event
->timestamp
));
5683 return list2 (item
, position
);
5687 position
= make_lispy_position (f
, event
->x
, event
->y
,
5690 #ifndef USE_TOOLKIT_SCROLL_BARS
5692 /* It's a scrollbar click. */
5693 position
= make_scroll_bar_position (event
, Qvertical_scroll_bar
);
5694 #endif /* not USE_TOOLKIT_SCROLL_BARS */
5696 if (button
>= ASIZE (button_down_location
))
5698 ptrdiff_t incr
= button
- ASIZE (button_down_location
) + 1;
5699 button_down_location
= larger_vector (button_down_location
,
5701 mouse_syms
= larger_vector (mouse_syms
, incr
, -1);
5704 start_pos_ptr
= aref_addr (button_down_location
, button
);
5705 start_pos
= *start_pos_ptr
;
5706 *start_pos_ptr
= Qnil
;
5709 /* On window-system frames, use the value of
5710 double-click-fuzz as is. On other frames, interpret it
5711 as a multiple of 1/8 characters. */
5715 if (WINDOWP (event
->frame_or_window
))
5716 f
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5717 else if (FRAMEP (event
->frame_or_window
))
5718 f
= XFRAME (event
->frame_or_window
);
5722 if (FRAME_WINDOW_P (f
))
5723 fuzz
= double_click_fuzz
;
5725 fuzz
= double_click_fuzz
/ 8;
5727 is_double
= (button
== last_mouse_button
5728 && (eabs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5729 && (eabs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5730 && button_down_time
!= 0
5731 && (EQ (Vdouble_click_time
, Qt
)
5732 || (NATNUMP (Vdouble_click_time
)
5733 && (event
->timestamp
- button_down_time
5734 < XFASTINT (Vdouble_click_time
)))));
5737 last_mouse_button
= button
;
5738 last_mouse_x
= XINT (event
->x
);
5739 last_mouse_y
= XINT (event
->y
);
5741 /* If this is a button press, squirrel away the location, so
5742 we can decide later whether it was a click or a drag. */
5743 if (event
->modifiers
& down_modifier
)
5747 double_click_count
++;
5748 event
->modifiers
|= ((double_click_count
> 2)
5753 double_click_count
= 1;
5754 button_down_time
= event
->timestamp
;
5755 *start_pos_ptr
= Fcopy_alist (position
);
5756 ignore_mouse_drag_p
= 0;
5759 /* Now we're releasing a button - check the co-ordinates to
5760 see if this was a click or a drag. */
5761 else if (event
->modifiers
& up_modifier
)
5763 /* If we did not see a down before this up, ignore the up.
5764 Probably this happened because the down event chose a
5765 menu item. It would be an annoyance to treat the
5766 release of the button that chose the menu item as a
5769 if (!CONSP (start_pos
))
5772 event
->modifiers
&= ~up_modifier
;
5775 Lisp_Object new_down
, down
;
5776 EMACS_INT xdiff
= double_click_fuzz
, ydiff
= double_click_fuzz
;
5778 /* The third element of every position
5779 should be the (x,y) pair. */
5780 down
= Fcar (Fcdr (Fcdr (start_pos
)));
5781 new_down
= Fcar (Fcdr (Fcdr (position
)));
5784 && INTEGERP (XCAR (down
)) && INTEGERP (XCDR (down
)))
5786 xdiff
= XINT (XCAR (new_down
)) - XINT (XCAR (down
));
5787 ydiff
= XINT (XCDR (new_down
)) - XINT (XCDR (down
));
5790 if (ignore_mouse_drag_p
)
5792 event
->modifiers
|= click_modifier
;
5793 ignore_mouse_drag_p
= 0;
5795 else if (xdiff
< double_click_fuzz
&& xdiff
> - double_click_fuzz
5796 && ydiff
< double_click_fuzz
&& ydiff
> - double_click_fuzz
5797 /* Maybe the mouse has moved a lot, caused scrolling, and
5798 eventually ended up at the same screen position (but
5799 not buffer position) in which case it is a drag, not
5801 /* FIXME: OTOH if the buffer position has changed
5802 because of a timer or process filter rather than
5803 because of mouse movement, it should be considered as
5804 a click. But mouse-drag-region completely ignores
5805 this case and it hasn't caused any real problem, so
5806 it's probably OK to ignore it as well. */
5807 && EQ (Fcar (Fcdr (start_pos
)), Fcar (Fcdr (position
))))
5808 /* Mouse hasn't moved (much). */
5809 event
->modifiers
|= click_modifier
;
5812 button_down_time
= 0;
5813 event
->modifiers
|= drag_modifier
;
5816 /* Don't check is_double; treat this as multiple
5817 if the down-event was multiple. */
5818 if (double_click_count
> 1)
5819 event
->modifiers
|= ((double_click_count
> 2)
5825 /* Every mouse event should either have the down_modifier or
5826 the up_modifier set. */
5830 /* Get the symbol we should use for the mouse click. */
5833 head
= modify_event_symbol (button
,
5835 Qmouse_click
, Vlispy_mouse_stem
,
5838 ASIZE (mouse_syms
));
5839 if (event
->modifiers
& drag_modifier
)
5840 return list3 (head
, start_pos
, position
);
5841 else if (event
->modifiers
& (double_modifier
| triple_modifier
))
5842 return list3 (head
, position
, make_number (double_click_count
));
5844 return list2 (head
, position
);
5849 case HORIZ_WHEEL_EVENT
:
5851 Lisp_Object position
;
5854 /* Build the position as appropriate for this mouse click. */
5855 struct frame
*f
= XFRAME (event
->frame_or_window
);
5857 /* Ignore wheel events that were made on frame that have been
5859 if (! FRAME_LIVE_P (f
))
5862 position
= make_lispy_position (f
, event
->x
, event
->y
,
5865 /* Set double or triple modifiers to indicate the wheel speed. */
5867 /* On window-system frames, use the value of
5868 double-click-fuzz as is. On other frames, interpret it
5869 as a multiple of 1/8 characters. */
5875 if (WINDOWP (event
->frame_or_window
))
5876 fr
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5877 else if (FRAMEP (event
->frame_or_window
))
5878 fr
= XFRAME (event
->frame_or_window
);
5882 fuzz
= FRAME_WINDOW_P (fr
)
5883 ? double_click_fuzz
: double_click_fuzz
/ 8;
5885 if (event
->modifiers
& up_modifier
)
5887 /* Emit a wheel-up event. */
5888 event
->modifiers
&= ~up_modifier
;
5891 else if (event
->modifiers
& down_modifier
)
5893 /* Emit a wheel-down event. */
5894 event
->modifiers
&= ~down_modifier
;
5898 /* Every wheel event should either have the down_modifier or
5899 the up_modifier set. */
5902 if (event
->kind
== HORIZ_WHEEL_EVENT
)
5905 is_double
= (last_mouse_button
== - (1 + symbol_num
)
5906 && (eabs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5907 && (eabs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5908 && button_down_time
!= 0
5909 && (EQ (Vdouble_click_time
, Qt
)
5910 || (NATNUMP (Vdouble_click_time
)
5911 && (event
->timestamp
- button_down_time
5912 < XFASTINT (Vdouble_click_time
)))));
5915 double_click_count
++;
5916 event
->modifiers
|= ((double_click_count
> 2)
5922 double_click_count
= 1;
5923 event
->modifiers
|= click_modifier
;
5926 button_down_time
= event
->timestamp
;
5927 /* Use a negative value to distinguish wheel from mouse button. */
5928 last_mouse_button
= - (1 + symbol_num
);
5929 last_mouse_x
= XINT (event
->x
);
5930 last_mouse_y
= XINT (event
->y
);
5932 /* Get the symbol we should use for the wheel event. */
5933 head
= modify_event_symbol (symbol_num
,
5939 ASIZE (wheel_syms
));
5942 if (event
->modifiers
& (double_modifier
| triple_modifier
))
5943 return list3 (head
, position
, make_number (double_click_count
));
5945 return list2 (head
, position
);
5949 #ifdef USE_TOOLKIT_SCROLL_BARS
5951 /* We don't have down and up events if using toolkit scroll bars,
5952 so make this always a click event. Store in the `part' of
5953 the Lisp event a symbol which maps to the following actions:
5955 `above_handle' page up
5956 `below_handle' page down
5960 `bottom' bottom of buffer
5961 `handle' thumb has been dragged.
5962 `end-scroll' end of interaction with scroll bar
5964 The incoming input_event contains in its `part' member an
5965 index of type `enum scroll_bar_part' which we can use as an
5966 index in scroll_bar_parts to get the appropriate symbol. */
5968 case SCROLL_BAR_CLICK_EVENT
:
5970 Lisp_Object position
, head
;
5972 position
= make_scroll_bar_position (event
, Qvertical_scroll_bar
);
5974 /* Always treat scroll bar events as clicks. */
5975 event
->modifiers
|= click_modifier
;
5976 event
->modifiers
&= ~up_modifier
;
5978 if (event
->code
>= ASIZE (mouse_syms
))
5979 mouse_syms
= larger_vector (mouse_syms
,
5980 event
->code
- ASIZE (mouse_syms
) + 1,
5983 /* Get the symbol we should use for the mouse click. */
5984 head
= modify_event_symbol (event
->code
,
5989 ASIZE (mouse_syms
));
5990 return list2 (head
, position
);
5993 case HORIZONTAL_SCROLL_BAR_CLICK_EVENT
:
5995 Lisp_Object position
, head
;
5997 position
= make_scroll_bar_position (event
, Qhorizontal_scroll_bar
);
5999 /* Always treat scroll bar events as clicks. */
6000 event
->modifiers
|= click_modifier
;
6001 event
->modifiers
&= ~up_modifier
;
6003 if (event
->code
>= ASIZE (mouse_syms
))
6004 mouse_syms
= larger_vector (mouse_syms
,
6005 event
->code
- ASIZE (mouse_syms
) + 1,
6008 /* Get the symbol we should use for the mouse click. */
6009 head
= modify_event_symbol (event
->code
,
6014 ASIZE (mouse_syms
));
6015 return list2 (head
, position
);
6018 #endif /* USE_TOOLKIT_SCROLL_BARS */
6020 case DRAG_N_DROP_EVENT
:
6023 Lisp_Object head
, position
;
6026 f
= XFRAME (event
->frame_or_window
);
6029 /* Ignore mouse events that were made on frames that
6030 have been deleted. */
6031 if (! FRAME_LIVE_P (f
))
6034 position
= make_lispy_position (f
, event
->x
, event
->y
,
6037 head
= modify_event_symbol (0, event
->modifiers
,
6039 lispy_drag_n_drop_names
,
6040 &drag_n_drop_syms
, 1);
6041 return list3 (head
, position
, files
);
6044 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
6045 || defined (HAVE_NS) || defined (USE_GTK)
6046 case MENU_BAR_EVENT
:
6047 if (EQ (event
->arg
, event
->frame_or_window
))
6048 /* This is the prefix key. We translate this to
6049 `(menu_bar)' because the code in keyboard.c for menu
6050 events, which we use, relies on this. */
6051 return list1 (Qmenu_bar
);
6055 case SELECT_WINDOW_EVENT
:
6056 /* Make an event (select-window (WINDOW)). */
6057 return list2 (Qselect_window
, list1 (event
->frame_or_window
));
6059 case TOOL_BAR_EVENT
:
6060 if (EQ (event
->arg
, event
->frame_or_window
))
6061 /* This is the prefix key. We translate this to
6062 `(tool_bar)' because the code in keyboard.c for tool bar
6063 events, which we use, relies on this. */
6064 return list1 (Qtool_bar
);
6065 else if (SYMBOLP (event
->arg
))
6066 return apply_modifiers (event
->modifiers
, event
->arg
);
6069 case USER_SIGNAL_EVENT
:
6070 /* A user signal. */
6072 char *name
= find_user_signal_name (event
->code
);
6075 return intern (name
);
6078 case SAVE_SESSION_EVENT
:
6079 return Qsave_session
;
6084 return Fcons (Qdbus_event
, event
->arg
);
6086 #endif /* HAVE_DBUS */
6088 #if defined HAVE_GFILENOTIFY || defined HAVE_INOTIFY
6089 case FILE_NOTIFY_EVENT
:
6091 return Fcons (Qfile_notify
, event
->arg
);
6093 #endif /* defined HAVE_GFILENOTIFY || defined HAVE_INOTIFY */
6095 case CONFIG_CHANGED_EVENT
:
6096 return list3 (Qconfig_changed_event
,
6097 event
->arg
, event
->frame_or_window
);
6099 /* The 'kind' field of the event is something we don't recognize. */
6106 make_lispy_movement (struct frame
*frame
, Lisp_Object bar_window
, enum scroll_bar_part part
,
6107 Lisp_Object x
, Lisp_Object y
, Time t
)
6109 /* Is it a scroll bar movement? */
6110 if (frame
&& ! NILP (bar_window
))
6112 Lisp_Object part_sym
;
6114 part_sym
= builtin_lisp_symbol (scroll_bar_parts
[part
]);
6115 return list2 (Qscroll_bar_movement
,
6117 Qvertical_scroll_bar
,
6122 /* Or is it an ordinary mouse movement? */
6125 Lisp_Object position
;
6126 position
= make_lispy_position (frame
, x
, y
, t
);
6127 return list2 (Qmouse_movement
, position
);
6131 /* Construct a switch frame event. */
6133 make_lispy_switch_frame (Lisp_Object frame
)
6135 return list2 (Qswitch_frame
, frame
);
6139 make_lispy_focus_in (Lisp_Object frame
)
6141 return list2 (Qfocus_in
, frame
);
6144 #ifdef HAVE_WINDOW_SYSTEM
6147 make_lispy_focus_out (Lisp_Object frame
)
6149 return list2 (Qfocus_out
, frame
);
6152 #endif /* HAVE_WINDOW_SYSTEM */
6154 /* Manipulating modifiers. */
6156 /* Parse the name of SYMBOL, and return the set of modifiers it contains.
6158 If MODIFIER_END is non-zero, set *MODIFIER_END to the position in
6159 SYMBOL's name of the end of the modifiers; the string from this
6160 position is the unmodified symbol name.
6162 This doesn't use any caches. */
6165 parse_modifiers_uncached (Lisp_Object symbol
, ptrdiff_t *modifier_end
)
6171 CHECK_SYMBOL (symbol
);
6174 name
= SYMBOL_NAME (symbol
);
6176 for (i
= 0; i
< SBYTES (name
) - 1; )
6178 ptrdiff_t this_mod_end
= 0;
6181 /* See if the name continues with a modifier word.
6182 Check that the word appears, but don't check what follows it.
6183 Set this_mod and this_mod_end to record what we find. */
6185 switch (SREF (name
, i
))
6187 #define SINGLE_LETTER_MOD(BIT) \
6188 (this_mod_end = i + 1, this_mod = BIT)
6191 SINGLE_LETTER_MOD (alt_modifier
);
6195 SINGLE_LETTER_MOD (ctrl_modifier
);
6199 SINGLE_LETTER_MOD (hyper_modifier
);
6203 SINGLE_LETTER_MOD (meta_modifier
);
6207 SINGLE_LETTER_MOD (shift_modifier
);
6211 SINGLE_LETTER_MOD (super_modifier
);
6214 #undef SINGLE_LETTER_MOD
6216 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6217 if (i + LEN + 1 <= SBYTES (name) \
6218 && ! memcmp (SDATA (name) + i, NAME, LEN)) \
6220 this_mod_end = i + LEN; \
6225 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
6226 MULTI_LETTER_MOD (down_modifier
, "down", 4);
6227 MULTI_LETTER_MOD (double_modifier
, "double", 6);
6231 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
6233 #undef MULTI_LETTER_MOD
6237 /* If we found no modifier, stop looking for them. */
6238 if (this_mod_end
== 0)
6241 /* Check there is a dash after the modifier, so that it
6242 really is a modifier. */
6243 if (this_mod_end
>= SBYTES (name
)
6244 || SREF (name
, this_mod_end
) != '-')
6247 /* This modifier is real; look for another. */
6248 modifiers
|= this_mod
;
6249 i
= this_mod_end
+ 1;
6252 /* Should we include the `click' modifier? */
6253 if (! (modifiers
& (down_modifier
| drag_modifier
6254 | double_modifier
| triple_modifier
))
6255 && i
+ 7 == SBYTES (name
)
6256 && memcmp (SDATA (name
) + i
, "mouse-", 6) == 0
6257 && ('0' <= SREF (name
, i
+ 6) && SREF (name
, i
+ 6) <= '9'))
6258 modifiers
|= click_modifier
;
6260 if (! (modifiers
& (double_modifier
| triple_modifier
))
6261 && i
+ 6 < SBYTES (name
)
6262 && memcmp (SDATA (name
) + i
, "wheel-", 6) == 0)
6263 modifiers
|= click_modifier
;
6271 /* Return a symbol whose name is the modifier prefixes for MODIFIERS
6272 prepended to the string BASE[0..BASE_LEN-1].
6273 This doesn't use any caches. */
6275 apply_modifiers_uncached (int modifiers
, char *base
, int base_len
, int base_len_byte
)
6277 /* Since BASE could contain nulls, we can't use intern here; we have
6278 to use Fintern, which expects a genuine Lisp_String, and keeps a
6280 char new_mods
[sizeof "A-C-H-M-S-s-down-drag-double-triple-"];
6286 /* Only the event queue may use the `up' modifier; it should always
6287 be turned into a click or drag event before presented to lisp code. */
6288 if (modifiers
& up_modifier
)
6291 if (modifiers
& alt_modifier
) { *p
++ = 'A'; *p
++ = '-'; }
6292 if (modifiers
& ctrl_modifier
) { *p
++ = 'C'; *p
++ = '-'; }
6293 if (modifiers
& hyper_modifier
) { *p
++ = 'H'; *p
++ = '-'; }
6294 if (modifiers
& meta_modifier
) { *p
++ = 'M'; *p
++ = '-'; }
6295 if (modifiers
& shift_modifier
) { *p
++ = 'S'; *p
++ = '-'; }
6296 if (modifiers
& super_modifier
) { *p
++ = 's'; *p
++ = '-'; }
6297 if (modifiers
& double_modifier
) p
= stpcpy (p
, "double-");
6298 if (modifiers
& triple_modifier
) p
= stpcpy (p
, "triple-");
6299 if (modifiers
& down_modifier
) p
= stpcpy (p
, "down-");
6300 if (modifiers
& drag_modifier
) p
= stpcpy (p
, "drag-");
6301 /* The click modifier is denoted by the absence of other modifiers. */
6305 mod_len
= p
- new_mods
;
6309 Lisp_Object new_name
;
6311 new_name
= make_uninit_multibyte_string (mod_len
+ base_len
,
6312 mod_len
+ base_len_byte
);
6313 memcpy (SDATA (new_name
), new_mods
, mod_len
);
6314 memcpy (SDATA (new_name
) + mod_len
, base
, base_len_byte
);
6316 return Fintern (new_name
, Qnil
);
6321 static const char *const modifier_names
[] =
6323 "up", "down", "drag", "click", "double", "triple", 0, 0,
6324 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
6325 0, 0, "alt", "super", "hyper", "shift", "control", "meta"
6327 #define NUM_MOD_NAMES ARRAYELTS (modifier_names)
6329 static Lisp_Object modifier_symbols
;
6331 /* Return the list of modifier symbols corresponding to the mask MODIFIERS. */
6333 lispy_modifier_list (int modifiers
)
6335 Lisp_Object modifier_list
;
6338 modifier_list
= Qnil
;
6339 for (i
= 0; (1<<i
) <= modifiers
&& i
< NUM_MOD_NAMES
; i
++)
6340 if (modifiers
& (1<<i
))
6341 modifier_list
= Fcons (AREF (modifier_symbols
, i
),
6344 return modifier_list
;
6348 /* Parse the modifiers on SYMBOL, and return a list like (UNMODIFIED MASK),
6349 where UNMODIFIED is the unmodified form of SYMBOL,
6350 MASK is the set of modifiers present in SYMBOL's name.
6351 This is similar to parse_modifiers_uncached, but uses the cache in
6352 SYMBOL's Qevent_symbol_element_mask property, and maintains the
6353 Qevent_symbol_elements property. */
6355 #define KEY_TO_CHAR(k) (XINT (k) & ((1 << CHARACTERBITS) - 1))
6358 parse_modifiers (Lisp_Object symbol
)
6360 Lisp_Object elements
;
6362 if (INTEGERP (symbol
))
6363 return list2i (KEY_TO_CHAR (symbol
), XINT (symbol
) & CHAR_MODIFIER_MASK
);
6364 else if (!SYMBOLP (symbol
))
6367 elements
= Fget (symbol
, Qevent_symbol_element_mask
);
6368 if (CONSP (elements
))
6373 int modifiers
= parse_modifiers_uncached (symbol
, &end
);
6374 Lisp_Object unmodified
;
6377 unmodified
= Fintern (make_string (SSDATA (SYMBOL_NAME (symbol
)) + end
,
6378 SBYTES (SYMBOL_NAME (symbol
)) - end
),
6381 if (modifiers
& ~INTMASK
)
6383 XSETFASTINT (mask
, modifiers
);
6384 elements
= list2 (unmodified
, mask
);
6386 /* Cache the parsing results on SYMBOL. */
6387 Fput (symbol
, Qevent_symbol_element_mask
,
6389 Fput (symbol
, Qevent_symbol_elements
,
6390 Fcons (unmodified
, lispy_modifier_list (modifiers
)));
6392 /* Since we know that SYMBOL is modifiers applied to unmodified,
6393 it would be nice to put that in unmodified's cache.
6394 But we can't, since we're not sure that parse_modifiers is
6401 DEFUN ("internal-event-symbol-parse-modifiers", Fevent_symbol_parse_modifiers
,
6402 Sevent_symbol_parse_modifiers
, 1, 1, 0,
6403 doc
: /* Parse the event symbol. For internal use. */)
6404 (Lisp_Object symbol
)
6406 /* Fill the cache if needed. */
6407 parse_modifiers (symbol
);
6408 /* Ignore the result (which is stored on Qevent_symbol_element_mask)
6409 and use the Lispier representation stored on Qevent_symbol_elements
6411 return Fget (symbol
, Qevent_symbol_elements
);
6414 /* Apply the modifiers MODIFIERS to the symbol BASE.
6415 BASE must be unmodified.
6417 This is like apply_modifiers_uncached, but uses BASE's
6418 Qmodifier_cache property, if present. It also builds
6419 Qevent_symbol_elements properties, since it has that info anyway.
6421 apply_modifiers copies the value of BASE's Qevent_kind property to
6422 the modified symbol. */
6424 apply_modifiers (int modifiers
, Lisp_Object base
)
6426 Lisp_Object cache
, idx
, entry
, new_symbol
;
6428 /* Mask out upper bits. We don't know where this value's been. */
6429 modifiers
&= INTMASK
;
6431 if (INTEGERP (base
))
6432 return make_number (XINT (base
) | modifiers
);
6434 /* The click modifier never figures into cache indices. */
6435 cache
= Fget (base
, Qmodifier_cache
);
6436 XSETFASTINT (idx
, (modifiers
& ~click_modifier
));
6437 entry
= assq_no_quit (idx
, cache
);
6440 new_symbol
= XCDR (entry
);
6443 /* We have to create the symbol ourselves. */
6444 new_symbol
= apply_modifiers_uncached (modifiers
,
6445 SSDATA (SYMBOL_NAME (base
)),
6446 SCHARS (SYMBOL_NAME (base
)),
6447 SBYTES (SYMBOL_NAME (base
)));
6449 /* Add the new symbol to the base's cache. */
6450 entry
= Fcons (idx
, new_symbol
);
6451 Fput (base
, Qmodifier_cache
, Fcons (entry
, cache
));
6453 /* We have the parsing info now for free, so we could add it to
6455 XSETFASTINT (idx, modifiers);
6456 Fput (new_symbol, Qevent_symbol_element_mask,
6458 Fput (new_symbol, Qevent_symbol_elements,
6459 Fcons (base, lispy_modifier_list (modifiers)));
6460 Sadly, this is only correct if `base' is indeed a base event,
6461 which is not necessarily the case. -stef */
6464 /* Make sure this symbol is of the same kind as BASE.
6466 You'd think we could just set this once and for all when we
6467 intern the symbol above, but reorder_modifiers may call us when
6468 BASE's property isn't set right; we can't assume that just
6469 because it has a Qmodifier_cache property it must have its
6470 Qevent_kind set right as well. */
6471 if (NILP (Fget (new_symbol
, Qevent_kind
)))
6475 kind
= Fget (base
, Qevent_kind
);
6477 Fput (new_symbol
, Qevent_kind
, kind
);
6484 /* Given a symbol whose name begins with modifiers ("C-", "M-", etc),
6485 return a symbol with the modifiers placed in the canonical order.
6486 Canonical order is alphabetical, except for down and drag, which
6487 always come last. The 'click' modifier is never written out.
6489 Fdefine_key calls this to make sure that (for example) C-M-foo
6490 and M-C-foo end up being equivalent in the keymap. */
6493 reorder_modifiers (Lisp_Object symbol
)
6495 /* It's hopefully okay to write the code this way, since everything
6496 will soon be in caches, and no consing will be done at all. */
6499 parsed
= parse_modifiers (symbol
);
6500 return apply_modifiers (XFASTINT (XCAR (XCDR (parsed
))),
6505 /* For handling events, we often want to produce a symbol whose name
6506 is a series of modifier key prefixes ("M-", "C-", etcetera) attached
6507 to some base, like the name of a function key or mouse button.
6508 modify_event_symbol produces symbols of this sort.
6510 NAME_TABLE should point to an array of strings, such that NAME_TABLE[i]
6511 is the name of the i'th symbol. TABLE_SIZE is the number of elements
6514 Alternatively, NAME_ALIST_OR_STEM is either an alist mapping codes
6515 into symbol names, or a string specifying a name stem used to
6516 construct a symbol name or the form `STEM-N', where N is the decimal
6517 representation of SYMBOL_NUM. NAME_ALIST_OR_STEM is used if it is
6518 non-nil; otherwise NAME_TABLE is used.
6520 SYMBOL_TABLE should be a pointer to a Lisp_Object whose value will
6521 persist between calls to modify_event_symbol that it can use to
6522 store a cache of the symbols it's generated for this NAME_TABLE
6523 before. The object stored there may be a vector or an alist.
6525 SYMBOL_NUM is the number of the base name we want from NAME_TABLE.
6527 MODIFIERS is a set of modifier bits (as given in struct input_events)
6528 whose prefixes should be applied to the symbol name.
6530 SYMBOL_KIND is the value to be placed in the event_kind property of
6531 the returned symbol.
6533 The symbols we create are supposed to have an
6534 `event-symbol-elements' property, which lists the modifiers present
6535 in the symbol's name. */
6538 modify_event_symbol (ptrdiff_t symbol_num
, int modifiers
, Lisp_Object symbol_kind
,
6539 Lisp_Object name_alist_or_stem
, const char *const *name_table
,
6540 Lisp_Object
*symbol_table
, ptrdiff_t table_size
)
6543 Lisp_Object symbol_int
;
6545 /* Get rid of the "vendor-specific" bit here. */
6546 XSETINT (symbol_int
, symbol_num
& 0xffffff);
6548 /* Is this a request for a valid symbol? */
6549 if (symbol_num
< 0 || symbol_num
>= table_size
)
6552 if (CONSP (*symbol_table
))
6553 value
= Fcdr (assq_no_quit (symbol_int
, *symbol_table
));
6555 /* If *symbol_table doesn't seem to be initialized properly, fix that.
6556 *symbol_table should be a lisp vector TABLE_SIZE elements long,
6557 where the Nth element is the symbol for NAME_TABLE[N], or nil if
6558 we've never used that symbol before. */
6561 if (! VECTORP (*symbol_table
)
6562 || ASIZE (*symbol_table
) != table_size
)
6566 XSETFASTINT (size
, table_size
);
6567 *symbol_table
= Fmake_vector (size
, Qnil
);
6570 value
= AREF (*symbol_table
, symbol_num
);
6573 /* Have we already used this symbol before? */
6576 /* No; let's create it. */
6577 if (CONSP (name_alist_or_stem
))
6578 value
= Fcdr_safe (Fassq (symbol_int
, name_alist_or_stem
));
6579 else if (STRINGP (name_alist_or_stem
))
6582 ptrdiff_t len
= (SBYTES (name_alist_or_stem
)
6583 + sizeof "-" + INT_STRLEN_BOUND (EMACS_INT
));
6585 buf
= SAFE_ALLOCA (len
);
6586 esprintf (buf
, "%s-%"pI
"d", SDATA (name_alist_or_stem
),
6587 XINT (symbol_int
) + 1);
6588 value
= intern (buf
);
6591 else if (name_table
!= 0 && name_table
[symbol_num
])
6592 value
= intern (name_table
[symbol_num
]);
6594 #ifdef HAVE_WINDOW_SYSTEM
6597 char *name
= x_get_keysym_name (symbol_num
);
6599 value
= intern (name
);
6605 char buf
[sizeof "key-" + INT_STRLEN_BOUND (EMACS_INT
)];
6606 sprintf (buf
, "key-%"pD
"d", symbol_num
);
6607 value
= intern (buf
);
6610 if (CONSP (*symbol_table
))
6611 *symbol_table
= Fcons (Fcons (symbol_int
, value
), *symbol_table
);
6613 ASET (*symbol_table
, symbol_num
, value
);
6615 /* Fill in the cache entries for this symbol; this also
6616 builds the Qevent_symbol_elements property, which the user
6618 apply_modifiers (modifiers
& click_modifier
, value
);
6619 Fput (value
, Qevent_kind
, symbol_kind
);
6622 /* Apply modifiers to that symbol. */
6623 return apply_modifiers (modifiers
, value
);
6626 /* Convert a list that represents an event type,
6627 such as (ctrl meta backspace), into the usual representation of that
6628 event type as a number or a symbol. */
6630 DEFUN ("event-convert-list", Fevent_convert_list
, Sevent_convert_list
, 1, 1, 0,
6631 doc
: /* Convert the event description list EVENT-DESC to an event type.
6632 EVENT-DESC should contain one base event type (a character or symbol)
6633 and zero or more modifier names (control, meta, hyper, super, shift, alt,
6634 drag, down, double or triple). The base must be last.
6635 The return value is an event type (a character or symbol) which
6636 has the same base event type and all the specified modifiers. */)
6637 (Lisp_Object event_desc
)
6645 while (CONSP (rest
))
6653 /* Given a symbol, see if it is a modifier name. */
6654 if (SYMBOLP (elt
) && CONSP (rest
))
6655 this = parse_solitary_modifier (elt
);
6659 else if (!NILP (base
))
6660 error ("Two bases given in one event");
6666 /* Let the symbol A refer to the character A. */
6667 if (SYMBOLP (base
) && SCHARS (SYMBOL_NAME (base
)) == 1)
6668 XSETINT (base
, SREF (SYMBOL_NAME (base
), 0));
6670 if (INTEGERP (base
))
6672 /* Turn (shift a) into A. */
6673 if ((modifiers
& shift_modifier
) != 0
6674 && (XINT (base
) >= 'a' && XINT (base
) <= 'z'))
6676 XSETINT (base
, XINT (base
) - ('a' - 'A'));
6677 modifiers
&= ~shift_modifier
;
6680 /* Turn (control a) into C-a. */
6681 if (modifiers
& ctrl_modifier
)
6682 return make_number ((modifiers
& ~ctrl_modifier
)
6683 | make_ctrl_char (XINT (base
)));
6685 return make_number (modifiers
| XINT (base
));
6687 else if (SYMBOLP (base
))
6688 return apply_modifiers (modifiers
, base
);
6690 error ("Invalid base event");
6693 /* Try to recognize SYMBOL as a modifier name.
6694 Return the modifier flag bit, or 0 if not recognized. */
6697 parse_solitary_modifier (Lisp_Object symbol
)
6699 Lisp_Object name
= SYMBOL_NAME (symbol
);
6701 switch (SREF (name
, 0))
6703 #define SINGLE_LETTER_MOD(BIT) \
6704 if (SBYTES (name) == 1) \
6707 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6708 if (LEN == SBYTES (name) \
6709 && ! memcmp (SDATA (name), NAME, LEN)) \
6713 SINGLE_LETTER_MOD (alt_modifier
);
6717 MULTI_LETTER_MOD (alt_modifier
, "alt", 3);
6721 SINGLE_LETTER_MOD (ctrl_modifier
);
6725 MULTI_LETTER_MOD (ctrl_modifier
, "ctrl", 4);
6726 MULTI_LETTER_MOD (ctrl_modifier
, "control", 7);
6730 SINGLE_LETTER_MOD (hyper_modifier
);
6734 MULTI_LETTER_MOD (hyper_modifier
, "hyper", 5);
6738 SINGLE_LETTER_MOD (meta_modifier
);
6742 MULTI_LETTER_MOD (meta_modifier
, "meta", 4);
6746 SINGLE_LETTER_MOD (shift_modifier
);
6750 MULTI_LETTER_MOD (shift_modifier
, "shift", 5);
6751 MULTI_LETTER_MOD (super_modifier
, "super", 5);
6752 SINGLE_LETTER_MOD (super_modifier
);
6756 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
6757 MULTI_LETTER_MOD (down_modifier
, "down", 4);
6758 MULTI_LETTER_MOD (double_modifier
, "double", 6);
6762 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
6765 #undef SINGLE_LETTER_MOD
6766 #undef MULTI_LETTER_MOD
6772 /* Return true if EVENT is a list whose elements are all integers or symbols.
6773 Such a list is not valid as an event,
6774 but it can be a Lucid-style event type list. */
6777 lucid_event_type_list_p (Lisp_Object object
)
6781 if (! CONSP (object
))
6784 if (EQ (XCAR (object
), Qhelp_echo
)
6785 || EQ (XCAR (object
), Qvertical_line
)
6786 || EQ (XCAR (object
), Qmode_line
)
6787 || EQ (XCAR (object
), Qheader_line
))
6790 for (tail
= object
; CONSP (tail
); tail
= XCDR (tail
))
6794 if (! (INTEGERP (elt
) || SYMBOLP (elt
)))
6801 /* Return true if terminal input chars are available.
6802 Also, store the return value into INPUT_PENDING.
6804 Serves the purpose of ioctl (0, FIONREAD, ...)
6805 but works even if FIONREAD does not exist.
6806 (In fact, this may actually read some input.)
6808 If READABLE_EVENTS_DO_TIMERS_NOW is set in FLAGS, actually run
6809 timer events that are ripe.
6810 If READABLE_EVENTS_FILTER_EVENTS is set in FLAGS, ignore internal
6811 events (FOCUS_IN_EVENT).
6812 If READABLE_EVENTS_IGNORE_SQUEEZABLES is set in FLAGS, ignore mouse
6813 movements and toolkit scroll bar thumb drags. */
6816 get_input_pending (int flags
)
6818 /* First of all, have we already counted some input? */
6819 input_pending
= (!NILP (Vquit_flag
) || readable_events (flags
));
6821 /* If input is being read as it arrives, and we have none, there is none. */
6822 if (!input_pending
&& (!interrupt_input
|| interrupts_deferred
))
6824 /* Try to read some input and see how much we get. */
6826 input_pending
= (!NILP (Vquit_flag
) || readable_events (flags
));
6829 return input_pending
;
6832 /* Put a BUFFER_SWITCH_EVENT in the buffer
6833 so that read_key_sequence will notice the new current buffer. */
6836 record_asynch_buffer_change (void)
6838 /* We don't need a buffer-switch event unless Emacs is waiting for input.
6839 The purpose of the event is to make read_key_sequence look up the
6840 keymaps again. If we aren't in read_key_sequence, we don't need one,
6841 and the event could cause trouble by messing up (input-pending-p).
6842 Note: Fwaiting_for_user_input_p always returns nil when async
6843 subprocesses aren't supported. */
6844 if (!NILP (Fwaiting_for_user_input_p ()))
6846 struct input_event event
;
6849 event
.kind
= BUFFER_SWITCH_EVENT
;
6850 event
.frame_or_window
= Qnil
;
6853 /* Make sure no interrupt happens while storing the event. */
6855 if (interrupt_input
)
6856 kbd_buffer_store_event (&event
);
6861 kbd_buffer_store_event (&event
);
6867 /* Read any terminal input already buffered up by the system
6868 into the kbd_buffer, but do not wait.
6870 Return the number of keyboard chars read, or -1 meaning
6871 this is a bad time to try to read input. */
6880 /* Store pending user signal events, if any. */
6881 store_user_signal_events ();
6883 /* Loop through the available terminals, and call their input hooks. */
6887 struct terminal
*next
= t
->next_terminal
;
6889 if (t
->read_socket_hook
)
6892 struct input_event hold_quit
;
6894 if (input_blocked_p ())
6896 pending_signals
= 1;
6900 EVENT_INIT (hold_quit
);
6901 hold_quit
.kind
= NO_EVENT
;
6903 /* No need for FIONREAD or fcntl; just say don't wait. */
6904 while ((nr
= (*t
->read_socket_hook
) (t
, &hold_quit
)) > 0)
6907 if (nr
== -1) /* Not OK to read input now. */
6911 else if (nr
== -2) /* Non-transient error. */
6913 /* The terminal device terminated; it should be closed. */
6915 /* Kill Emacs if this was our last terminal. */
6916 if (!terminal_list
->next_terminal
)
6917 /* Formerly simply reported no input, but that
6918 sometimes led to a failure of Emacs to terminate.
6919 SIGHUP seems appropriate if we can't reach the
6921 /* ??? Is it really right to send the signal just to
6922 this process rather than to the whole process
6923 group? Perhaps on systems with FIONREAD Emacs is
6924 alone in its group. */
6925 terminate_due_to_signal (SIGHUP
, 10);
6927 /* XXX Is calling delete_terminal safe here? It calls delete_frame. */
6930 XSETTERMINAL (tmp
, t
);
6931 Fdelete_terminal (tmp
, Qnoelisp
);
6935 /* If there was no error, make sure the pointer
6936 is visible for all frames on this terminal. */
6939 Lisp_Object tail
, frame
;
6941 FOR_EACH_FRAME (tail
, frame
)
6943 struct frame
*f
= XFRAME (frame
);
6944 if (FRAME_TERMINAL (f
) == t
)
6945 frame_make_pointer_visible (f
);
6949 if (hold_quit
.kind
!= NO_EVENT
)
6950 kbd_buffer_store_event (&hold_quit
);
6962 /* This is the tty way of reading available input.
6964 Note that each terminal device has its own `struct terminal' object,
6965 and so this function is called once for each individual termcap
6966 terminal. The first parameter indicates which terminal to read from. */
6969 tty_read_avail_input (struct terminal
*terminal
,
6970 struct input_event
*hold_quit
)
6972 /* Using KBD_BUFFER_SIZE - 1 here avoids reading more than
6973 the kbd_buffer can really hold. That may prevent loss
6974 of characters on some systems when input is stuffed at us. */
6975 unsigned char cbuf
[KBD_BUFFER_SIZE
- 1];
6977 struct tty_display_info
*tty
= terminal
->display_info
.tty
;
6980 int buffer_free
= KBD_BUFFER_SIZE
- kbd_buffer_nr_stored () - 1;
6982 if (kbd_on_hold_p () || buffer_free
<= 0)
6984 #endif /* subprocesses */
6986 if (!terminal
->name
) /* Don't read from a dead terminal. */
6989 if (terminal
->type
!= output_termcap
6990 && terminal
->type
!= output_msdos_raw
)
6993 /* XXX I think the following code should be moved to separate hook
6994 functions in system-dependent files. */
6996 /* FIXME: AFAIK, tty_read_avail_input is not used under w32 since the non-GUI
6997 code sets read_socket_hook to w32_console_read_socket instead! */
6999 #else /* not WINDOWSNT */
7000 if (! tty
->term_initted
) /* In case we get called during bootstrap. */
7004 return 0; /* The terminal is suspended. */
7007 n_to_read
= dos_keysns ();
7011 cbuf
[0] = dos_keyread ();
7014 #else /* not MSDOS */
7019 struct input_event gpm_hold_quit
;
7020 int gpm
, fd
= gpm_fd
;
7022 EVENT_INIT (gpm_hold_quit
);
7023 gpm_hold_quit
.kind
= NO_EVENT
;
7025 /* gpm==1 if event received.
7026 gpm==0 if the GPM daemon has closed the connection, in which case
7027 Gpm_GetEvent closes gpm_fd and clears it to -1, which is why
7028 we save it in `fd' so close_gpm can remove it from the
7030 gpm==-1 if a protocol error or EWOULDBLOCK; the latter is normal. */
7031 while (gpm
= Gpm_GetEvent (&event
), gpm
== 1) {
7032 nread
+= handle_one_term_event (tty
, &event
, &gpm_hold_quit
);
7035 /* Presumably the GPM daemon has closed the connection. */
7037 if (gpm_hold_quit
.kind
!= NO_EVENT
)
7038 kbd_buffer_store_event (&gpm_hold_quit
);
7042 #endif /* HAVE_GPM */
7044 /* Determine how many characters we should *try* to read. */
7045 #ifdef USABLE_FIONREAD
7046 /* Find out how much input is available. */
7047 if (ioctl (fileno (tty
->input
), FIONREAD
, &n_to_read
) < 0)
7049 if (! noninteractive
)
7050 return -2; /* Close this terminal. */
7056 if (n_to_read
> sizeof cbuf
)
7057 n_to_read
= sizeof cbuf
;
7058 #elif defined USG || defined CYGWIN
7059 /* Read some input if available, but don't wait. */
7060 n_to_read
= sizeof cbuf
;
7061 fcntl (fileno (tty
->input
), F_SETFL
, O_NONBLOCK
);
7063 # error "Cannot read without possibly delaying"
7067 /* Don't read more than we can store. */
7068 if (n_to_read
> buffer_free
)
7069 n_to_read
= buffer_free
;
7070 #endif /* subprocesses */
7072 /* Now read; for one reason or another, this will not block.
7073 NREAD is set to the number of chars read. */
7076 nread
= emacs_read (fileno (tty
->input
), (char *) cbuf
, n_to_read
);
7077 /* POSIX infers that processes which are not in the session leader's
7078 process group won't get SIGHUPs at logout time. BSDI adheres to
7079 this part standard and returns -1 from read (0) with errno==EIO
7080 when the control tty is taken away.
7081 Jeffrey Honig <jch@bsdi.com> says this is generally safe. */
7082 if (nread
== -1 && errno
== EIO
)
7083 return -2; /* Close this terminal. */
7084 #if defined (AIX) && defined (_BSD)
7085 /* The kernel sometimes fails to deliver SIGHUP for ptys.
7086 This looks incorrect, but it isn't, because _BSD causes
7087 O_NDELAY to be defined in fcntl.h as O_NONBLOCK,
7088 and that causes a value other than 0 when there is no input. */
7090 return -2; /* Close this terminal. */
7094 /* We used to retry the read if it was interrupted.
7095 But this does the wrong thing when O_NONBLOCK causes
7096 an EAGAIN error. Does anybody know of a situation
7097 where a retry is actually needed? */
7099 nread
< 0 && (errno
== EAGAIN
|| errno
== EFAULT
7109 #ifndef USABLE_FIONREAD
7110 #if defined (USG) || defined (CYGWIN)
7111 fcntl (fileno (tty
->input
), F_SETFL
, 0);
7112 #endif /* USG or CYGWIN */
7113 #endif /* no FIONREAD */
7118 #endif /* not MSDOS */
7119 #endif /* not WINDOWSNT */
7121 for (i
= 0; i
< nread
; i
++)
7123 struct input_event buf
;
7125 buf
.kind
= ASCII_KEYSTROKE_EVENT
;
7127 if (tty
->meta_key
== 1 && (cbuf
[i
] & 0x80))
7128 buf
.modifiers
= meta_modifier
;
7129 if (tty
->meta_key
!= 2)
7133 /* Set the frame corresponding to the active tty. Note that the
7134 value of selected_frame is not reliable here, redisplay tends
7135 to temporarily change it. */
7136 buf
.frame_or_window
= tty
->top_frame
;
7139 kbd_buffer_store_event (&buf
);
7140 /* Don't look at input that follows a C-g too closely.
7141 This reduces lossage due to autorepeat on C-g. */
7142 if (buf
.kind
== ASCII_KEYSTROKE_EVENT
7143 && buf
.code
== quit_char
)
7151 handle_async_input (void)
7156 int nread
= gobble_input ();
7157 /* -1 means it's not ok to read the input now.
7158 UNBLOCK_INPUT will read it later; now, avoid infinite loop.
7159 0 means there was no keyboard input available. */
7167 process_pending_signals (void)
7169 pending_signals
= 0;
7170 handle_async_input ();
7171 do_pending_atimers ();
7174 /* Undo any number of BLOCK_INPUT calls down to level LEVEL,
7175 and reinvoke any pending signal if the level is now 0 and
7176 a fatal error is not already in progress. */
7179 unblock_input_to (int level
)
7181 interrupt_input_blocked
= level
;
7184 if (pending_signals
&& !fatal_error_in_progress
)
7185 process_pending_signals ();
7191 /* End critical section.
7193 If doing signal-driven input, and a signal came in when input was
7194 blocked, reinvoke the signal handler now to deal with it.
7196 It will also process queued input, if it was not read before.
7197 When a longer code sequence does not use block/unblock input
7198 at all, the whole input gathered up to the next call to
7199 unblock_input will be processed inside that call. */
7202 unblock_input (void)
7204 unblock_input_to (interrupt_input_blocked
- 1);
7207 /* Undo any number of BLOCK_INPUT calls,
7208 and also reinvoke any pending signal. */
7211 totally_unblock_input (void)
7213 unblock_input_to (0);
7219 handle_input_available_signal (int sig
)
7221 pending_signals
= 1;
7223 if (input_available_clear_time
)
7224 *input_available_clear_time
= make_timespec (0, 0);
7228 deliver_input_available_signal (int sig
)
7230 deliver_process_signal (sig
, handle_input_available_signal
);
7232 #endif /* USABLE_SIGIO */
7235 /* User signal events. */
7237 struct user_signal_info
7239 /* Signal number. */
7242 /* Name of the signal. */
7245 /* Number of pending signals. */
7248 struct user_signal_info
*next
;
7251 /* List of user signals. */
7252 static struct user_signal_info
*user_signals
= NULL
;
7255 add_user_signal (int sig
, const char *name
)
7257 struct sigaction action
;
7258 struct user_signal_info
*p
;
7260 for (p
= user_signals
; p
; p
= p
->next
)
7262 /* Already added. */
7265 p
= xmalloc (sizeof *p
);
7267 p
->name
= xstrdup (name
);
7269 p
->next
= user_signals
;
7272 emacs_sigaction_init (&action
, deliver_user_signal
);
7273 sigaction (sig
, &action
, 0);
7277 handle_user_signal (int sig
)
7279 struct user_signal_info
*p
;
7280 const char *special_event_name
= NULL
;
7282 if (SYMBOLP (Vdebug_on_event
))
7283 special_event_name
= SSDATA (SYMBOL_NAME (Vdebug_on_event
));
7285 for (p
= user_signals
; p
; p
= p
->next
)
7288 if (special_event_name
7289 && strcmp (special_event_name
, p
->name
) == 0)
7291 /* Enter the debugger in many ways. */
7292 debug_on_next_call
= 1;
7295 Vinhibit_quit
= Qnil
;
7297 /* Eat the event. */
7303 if (interrupt_input
)
7304 handle_input_available_signal (sig
);
7308 /* Tell wait_reading_process_output that it needs to wake
7309 up and look around. */
7310 if (input_available_clear_time
)
7311 *input_available_clear_time
= make_timespec (0, 0);
7318 deliver_user_signal (int sig
)
7320 deliver_process_signal (sig
, handle_user_signal
);
7324 find_user_signal_name (int sig
)
7326 struct user_signal_info
*p
;
7328 for (p
= user_signals
; p
; p
= p
->next
)
7336 store_user_signal_events (void)
7338 struct user_signal_info
*p
;
7339 struct input_event buf
;
7340 bool buf_initialized
= 0;
7342 for (p
= user_signals
; p
; p
= p
->next
)
7343 if (p
->npending
> 0)
7345 if (! buf_initialized
)
7347 memset (&buf
, 0, sizeof buf
);
7348 buf
.kind
= USER_SIGNAL_EVENT
;
7349 buf
.frame_or_window
= selected_frame
;
7350 buf_initialized
= 1;
7356 kbd_buffer_store_event (&buf
);
7359 while (p
->npending
> 0);
7364 static void menu_bar_item (Lisp_Object
, Lisp_Object
, Lisp_Object
, void *);
7365 static Lisp_Object menu_bar_one_keymap_changed_items
;
7367 /* These variables hold the vector under construction within
7368 menu_bar_items and its subroutines, and the current index
7369 for storing into that vector. */
7370 static Lisp_Object menu_bar_items_vector
;
7371 static int menu_bar_items_index
;
7374 static const char *separator_names
[] = {
7379 "single-dashed-line",
7380 "double-dashed-line",
7382 "shadow-etched-out",
7383 "shadow-etched-in-dash",
7384 "shadow-etched-out-dash",
7385 "shadow-double-etched-in",
7386 "shadow-double-etched-out",
7387 "shadow-double-etched-in-dash",
7388 "shadow-double-etched-out-dash",
7392 /* Return true if LABEL specifies a separator. */
7395 menu_separator_name_p (const char *label
)
7399 else if (strlen (label
) > 3
7400 && memcmp (label
, "--", 2) == 0
7405 for (i
= 0; separator_names
[i
]; ++i
)
7406 if (strcmp (label
, separator_names
[i
]) == 0)
7411 /* It's a separator if it contains only dashes. */
7412 while (*label
== '-')
7414 return (*label
== 0);
7421 /* Return a vector of menu items for a menu bar, appropriate
7422 to the current buffer. Each item has three elements in the vector:
7425 OLD is an old vector we can optionally reuse, or nil. */
7428 menu_bar_items (Lisp_Object old
)
7430 /* The number of keymaps we're scanning right now, and the number of
7431 keymaps we have allocated space for. */
7434 /* maps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
7435 in the current keymaps, or nil where it is not a prefix. */
7438 Lisp_Object mapsbuf
[3];
7439 Lisp_Object def
, tail
;
7446 /* In order to build the menus, we need to call the keymap
7447 accessors. They all call QUIT. But this function is called
7448 during redisplay, during which a quit is fatal. So inhibit
7449 quitting while building the menus.
7450 We do this instead of specbind because (1) errors will clear it anyway
7451 and (2) this avoids risk of specpdl overflow. */
7452 oquit
= Vinhibit_quit
;
7456 menu_bar_items_vector
= old
;
7458 menu_bar_items_vector
= Fmake_vector (make_number (24), Qnil
);
7459 menu_bar_items_index
= 0;
7461 /* Build our list of keymaps.
7462 If we recognize a function key and replace its escape sequence in
7463 keybuf with its symbol, or if the sequence starts with a mouse
7464 click and we need to switch buffers, we jump back here to rebuild
7465 the initial keymaps from the current buffer. */
7469 /* Should overriding-terminal-local-map and overriding-local-map apply? */
7470 if (!NILP (Voverriding_local_map_menu_flag
)
7471 && !NILP (Voverriding_local_map
))
7473 /* Yes, use them (if non-nil) as well as the global map. */
7476 if (!NILP (KVAR (current_kboard
, Voverriding_terminal_local_map
)))
7477 maps
[nmaps
++] = KVAR (current_kboard
, Voverriding_terminal_local_map
);
7478 if (!NILP (Voverriding_local_map
))
7479 maps
[nmaps
++] = Voverriding_local_map
;
7483 /* No, so use major and minor mode keymaps and keymap property.
7484 Note that menu-bar bindings in the local-map and keymap
7485 properties may not work reliable, as they are only
7486 recognized when the menu-bar (or mode-line) is updated,
7487 which does not normally happen after every command. */
7488 ptrdiff_t nminor
= current_minor_maps (NULL
, &tmaps
);
7489 SAFE_NALLOCA (maps
, 1, nminor
+ 4);
7491 Lisp_Object tem
= KVAR (current_kboard
, Voverriding_terminal_local_map
);
7492 if (!NILP (tem
) && !NILP (Voverriding_local_map_menu_flag
))
7493 maps
[nmaps
++] = tem
;
7494 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
7495 maps
[nmaps
++] = tem
;
7498 memcpy (maps
+ nmaps
, tmaps
, nminor
* sizeof (maps
[0]));
7501 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
7503 maps
[nmaps
++] = current_global_map
;
7506 /* Look up in each map the dummy prefix key `menu-bar'. */
7508 for (mapno
= nmaps
- 1; mapno
>= 0; mapno
--)
7509 if (!NILP (maps
[mapno
]))
7511 def
= get_keymap (access_keymap (maps
[mapno
], Qmenu_bar
, 1, 0, 1),
7515 menu_bar_one_keymap_changed_items
= Qnil
;
7516 map_keymap_canonical (def
, menu_bar_item
, Qnil
, NULL
);
7520 /* Move to the end those items that should be at the end. */
7522 for (tail
= Vmenu_bar_final_items
; CONSP (tail
); tail
= XCDR (tail
))
7525 int end
= menu_bar_items_index
;
7527 for (i
= 0; i
< end
; i
+= 4)
7528 if (EQ (XCAR (tail
), AREF (menu_bar_items_vector
, i
)))
7530 Lisp_Object tem0
, tem1
, tem2
, tem3
;
7531 /* Move the item at index I to the end,
7532 shifting all the others forward. */
7533 tem0
= AREF (menu_bar_items_vector
, i
+ 0);
7534 tem1
= AREF (menu_bar_items_vector
, i
+ 1);
7535 tem2
= AREF (menu_bar_items_vector
, i
+ 2);
7536 tem3
= AREF (menu_bar_items_vector
, i
+ 3);
7538 memmove (aref_addr (menu_bar_items_vector
, i
),
7539 aref_addr (menu_bar_items_vector
, i
+ 4),
7540 (end
- i
- 4) * word_size
);
7541 ASET (menu_bar_items_vector
, end
- 4, tem0
);
7542 ASET (menu_bar_items_vector
, end
- 3, tem1
);
7543 ASET (menu_bar_items_vector
, end
- 2, tem2
);
7544 ASET (menu_bar_items_vector
, end
- 1, tem3
);
7549 /* Add nil, nil, nil, nil at the end. */
7551 int i
= menu_bar_items_index
;
7552 if (i
+ 4 > ASIZE (menu_bar_items_vector
))
7553 menu_bar_items_vector
7554 = larger_vector (menu_bar_items_vector
, 4, -1);
7555 /* Add this item. */
7556 ASET (menu_bar_items_vector
, i
, Qnil
); i
++;
7557 ASET (menu_bar_items_vector
, i
, Qnil
); i
++;
7558 ASET (menu_bar_items_vector
, i
, Qnil
); i
++;
7559 ASET (menu_bar_items_vector
, i
, Qnil
); i
++;
7560 menu_bar_items_index
= i
;
7563 Vinhibit_quit
= oquit
;
7565 return menu_bar_items_vector
;
7568 /* Add one item to menu_bar_items_vector, for KEY, ITEM_STRING and DEF.
7569 If there's already an item for KEY, add this DEF to it. */
7571 Lisp_Object item_properties
;
7574 menu_bar_item (Lisp_Object key
, Lisp_Object item
, Lisp_Object dummy1
, void *dummy2
)
7576 struct gcpro gcpro1
;
7581 if (EQ (item
, Qundefined
))
7583 /* If a map has an explicit `undefined' as definition,
7584 discard any previously made menu bar item. */
7586 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7587 if (EQ (key
, AREF (menu_bar_items_vector
, i
)))
7589 if (menu_bar_items_index
> i
+ 4)
7590 memmove (aref_addr (menu_bar_items_vector
, i
),
7591 aref_addr (menu_bar_items_vector
, i
+ 4),
7592 (menu_bar_items_index
- i
- 4) * word_size
);
7593 menu_bar_items_index
-= 4;
7597 /* If this keymap has already contributed to this KEY,
7598 don't contribute to it a second time. */
7599 tem
= Fmemq (key
, menu_bar_one_keymap_changed_items
);
7600 if (!NILP (tem
) || NILP (item
))
7603 menu_bar_one_keymap_changed_items
7604 = Fcons (key
, menu_bar_one_keymap_changed_items
);
7606 /* We add to menu_bar_one_keymap_changed_items before doing the
7607 parse_menu_item, so that if it turns out it wasn't a menu item,
7608 it still correctly hides any further menu item. */
7610 parsed
= parse_menu_item (item
, 1);
7615 item
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7617 /* Find any existing item for this KEY. */
7618 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7619 if (EQ (key
, AREF (menu_bar_items_vector
, i
)))
7622 /* If we did not find this KEY, add it at the end. */
7623 if (i
== menu_bar_items_index
)
7625 /* If vector is too small, get a bigger one. */
7626 if (i
+ 4 > ASIZE (menu_bar_items_vector
))
7627 menu_bar_items_vector
= larger_vector (menu_bar_items_vector
, 4, -1);
7628 /* Add this item. */
7629 ASET (menu_bar_items_vector
, i
, key
); i
++;
7630 ASET (menu_bar_items_vector
, i
,
7631 AREF (item_properties
, ITEM_PROPERTY_NAME
)); i
++;
7632 ASET (menu_bar_items_vector
, i
, list1 (item
)); i
++;
7633 ASET (menu_bar_items_vector
, i
, make_number (0)); i
++;
7634 menu_bar_items_index
= i
;
7636 /* We did find an item for this KEY. Add ITEM to its list of maps. */
7640 old
= AREF (menu_bar_items_vector
, i
+ 2);
7641 /* If the new and the old items are not both keymaps,
7642 the lookup will only find `item'. */
7643 item
= Fcons (item
, KEYMAPP (item
) && KEYMAPP (XCAR (old
)) ? old
: Qnil
);
7644 ASET (menu_bar_items_vector
, i
+ 2, item
);
7648 /* This is used as the handler when calling menu_item_eval_property. */
7650 menu_item_eval_property_1 (Lisp_Object arg
)
7652 /* If we got a quit from within the menu computation,
7653 quit all the way out of it. This takes care of C-] in the debugger. */
7654 if (CONSP (arg
) && EQ (XCAR (arg
), Qquit
))
7655 Fsignal (Qquit
, Qnil
);
7661 eval_dyn (Lisp_Object form
)
7663 return Feval (form
, Qnil
);
7666 /* Evaluate an expression and return the result (or nil if something
7667 went wrong). Used to evaluate dynamic parts of menu items. */
7669 menu_item_eval_property (Lisp_Object sexpr
)
7671 ptrdiff_t count
= SPECPDL_INDEX ();
7673 specbind (Qinhibit_redisplay
, Qt
);
7674 val
= internal_condition_case_1 (eval_dyn
, sexpr
, Qerror
,
7675 menu_item_eval_property_1
);
7676 return unbind_to (count
, val
);
7679 /* This function parses a menu item and leaves the result in the
7680 vector item_properties.
7681 ITEM is a key binding, a possible menu item.
7682 INMENUBAR is > 0 when this is considered for an entry in a menu bar
7684 INMENUBAR is < 0 when this is considered for an entry in a keyboard menu.
7685 parse_menu_item returns true if the item is a menu item and false
7689 parse_menu_item (Lisp_Object item
, int inmenubar
)
7691 Lisp_Object def
, tem
, item_string
, start
;
7693 Lisp_Object keyhint
;
7702 /* Create item_properties vector if necessary. */
7703 if (NILP (item_properties
))
7705 = Fmake_vector (make_number (ITEM_PROPERTY_ENABLE
+ 1), Qnil
);
7707 /* Initialize optional entries. */
7708 for (i
= ITEM_PROPERTY_DEF
; i
< ITEM_PROPERTY_ENABLE
; i
++)
7709 ASET (item_properties
, i
, Qnil
);
7710 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7712 /* Save the item here to protect it from GC. */
7713 ASET (item_properties
, ITEM_PROPERTY_ITEM
, item
);
7715 item_string
= XCAR (item
);
7719 if (STRINGP (item_string
))
7721 /* Old format menu item. */
7722 ASET (item_properties
, ITEM_PROPERTY_NAME
, item_string
);
7724 /* Maybe help string. */
7725 if (CONSP (item
) && STRINGP (XCAR (item
)))
7727 ASET (item_properties
, ITEM_PROPERTY_HELP
,
7728 Fsubstitute_command_keys (XCAR (item
)));
7733 /* Maybe an obsolete key binding cache. */
7734 if (CONSP (item
) && CONSP (XCAR (item
))
7735 && (NILP (XCAR (XCAR (item
)))
7736 || VECTORP (XCAR (XCAR (item
)))))
7739 /* This is the real definition--the function to run. */
7740 ASET (item_properties
, ITEM_PROPERTY_DEF
, item
);
7742 /* Get enable property, if any. */
7745 tem
= Fget (item
, Qmenu_enable
);
7746 if (!NILP (Venable_disabled_menus_and_buttons
))
7747 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7748 else if (!NILP (tem
))
7749 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, tem
);
7752 else if (EQ (item_string
, Qmenu_item
) && CONSP (item
))
7754 /* New format menu item. */
7755 ASET (item_properties
, ITEM_PROPERTY_NAME
, XCAR (item
));
7756 start
= XCDR (item
);
7759 /* We have a real binding. */
7760 ASET (item_properties
, ITEM_PROPERTY_DEF
, XCAR (start
));
7762 item
= XCDR (start
);
7763 /* Is there an obsolete cache list with key equivalences. */
7764 if (CONSP (item
) && CONSP (XCAR (item
)))
7767 /* Parse properties. */
7768 while (CONSP (item
) && CONSP (XCDR (item
)))
7773 if (EQ (tem
, QCenable
))
7775 if (!NILP (Venable_disabled_menus_and_buttons
))
7776 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7778 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, XCAR (item
));
7780 else if (EQ (tem
, QCvisible
))
7782 /* If got a visible property and that evaluates to nil
7783 then ignore this item. */
7784 tem
= menu_item_eval_property (XCAR (item
));
7788 else if (EQ (tem
, QChelp
))
7790 Lisp_Object help
= XCAR (item
);
7792 help
= Fsubstitute_command_keys (help
);
7793 ASET (item_properties
, ITEM_PROPERTY_HELP
, help
);
7795 else if (EQ (tem
, QCfilter
))
7797 else if (EQ (tem
, QCkey_sequence
))
7800 if (SYMBOLP (tem
) || STRINGP (tem
) || VECTORP (tem
))
7801 /* Be GC protected. Set keyhint to item instead of tem. */
7804 else if (EQ (tem
, QCkeys
))
7807 if (CONSP (tem
) || STRINGP (tem
))
7808 ASET (item_properties
, ITEM_PROPERTY_KEYEQ
, tem
);
7810 else if (EQ (tem
, QCbutton
) && CONSP (XCAR (item
)))
7815 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
7817 ASET (item_properties
, ITEM_PROPERTY_SELECTED
,
7819 ASET (item_properties
, ITEM_PROPERTY_TYPE
, type
);
7825 else if (inmenubar
|| !NILP (start
))
7829 return 0; /* not a menu item */
7831 /* If item string is not a string, evaluate it to get string.
7832 If we don't get a string, skip this item. */
7833 item_string
= AREF (item_properties
, ITEM_PROPERTY_NAME
);
7834 if (!(STRINGP (item_string
)))
7836 item_string
= menu_item_eval_property (item_string
);
7837 if (!STRINGP (item_string
))
7839 ASET (item_properties
, ITEM_PROPERTY_NAME
, item_string
);
7842 /* If got a filter apply it on definition. */
7843 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7846 def
= menu_item_eval_property (list2 (XCAR (filter
),
7847 list2 (Qquote
, def
)));
7849 ASET (item_properties
, ITEM_PROPERTY_DEF
, def
);
7852 /* Enable or disable selection of item. */
7853 tem
= AREF (item_properties
, ITEM_PROPERTY_ENABLE
);
7856 tem
= menu_item_eval_property (tem
);
7857 if (inmenubar
&& NILP (tem
))
7858 return 0; /* Ignore disabled items in menu bar. */
7859 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, tem
);
7862 /* If we got no definition, this item is just unselectable text which
7863 is OK in a submenu but not in the menubar. */
7865 return (!inmenubar
);
7867 /* See if this is a separate pane or a submenu. */
7868 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7869 tem
= get_keymap (def
, 0, 1);
7870 /* For a subkeymap, just record its details and exit. */
7873 ASET (item_properties
, ITEM_PROPERTY_MAP
, tem
);
7874 ASET (item_properties
, ITEM_PROPERTY_DEF
, tem
);
7878 /* At the top level in the menu bar, do likewise for commands also.
7879 The menu bar does not display equivalent key bindings anyway.
7880 ITEM_PROPERTY_DEF is already set up properly. */
7884 { /* This is a command. See if there is an equivalent key binding. */
7885 Lisp_Object keyeq
= AREF (item_properties
, ITEM_PROPERTY_KEYEQ
);
7886 AUTO_STRING (space_space
, " ");
7888 /* The previous code preferred :key-sequence to :keys, so we
7889 preserve this behavior. */
7890 if (STRINGP (keyeq
) && !CONSP (keyhint
))
7891 keyeq
= concat2 (space_space
, Fsubstitute_command_keys (keyeq
));
7894 Lisp_Object prefix
= keyeq
;
7895 Lisp_Object keys
= Qnil
;
7899 def
= XCAR (prefix
);
7900 prefix
= XCDR (prefix
);
7903 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7905 if (CONSP (keyhint
) && !NILP (XCAR (keyhint
)))
7907 keys
= XCAR (keyhint
);
7908 tem
= Fkey_binding (keys
, Qnil
, Qnil
, Qnil
);
7910 /* We have a suggested key. Is it bound to the command? */
7913 /* If the command is an alias for another
7914 (such as lmenu.el set it up), check if the
7915 original command matches the cached command. */
7917 && EQ (tem
, XSYMBOL (def
)->function
))))
7922 keys
= Fwhere_is_internal (def
, Qnil
, Qt
, Qnil
, Qnil
);
7926 tem
= Fkey_description (keys
, Qnil
);
7929 if (STRINGP (XCAR (prefix
)))
7930 tem
= concat2 (XCAR (prefix
), tem
);
7931 if (STRINGP (XCDR (prefix
)))
7932 tem
= concat2 (tem
, XCDR (prefix
));
7934 keyeq
= concat2 (space_space
, tem
);
7940 /* If we have an equivalent key binding, use that. */
7941 ASET (item_properties
, ITEM_PROPERTY_KEYEQ
, keyeq
);
7944 /* Include this when menu help is implemented.
7945 tem = XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP];
7946 if (!(NILP (tem) || STRINGP (tem)))
7948 tem = menu_item_eval_property (tem);
7951 XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP] = tem;
7955 /* Handle radio buttons or toggle boxes. */
7956 tem
= AREF (item_properties
, ITEM_PROPERTY_SELECTED
);
7958 ASET (item_properties
, ITEM_PROPERTY_SELECTED
,
7959 menu_item_eval_property (tem
));
7966 /***********************************************************************
7968 ***********************************************************************/
7970 /* A vector holding tool bar items while they are parsed in function
7971 tool_bar_items. Each item occupies TOOL_BAR_ITEM_NSCLOTS elements
7974 static Lisp_Object tool_bar_items_vector
;
7976 /* A vector holding the result of parse_tool_bar_item. Layout is like
7977 the one for a single item in tool_bar_items_vector. */
7979 static Lisp_Object tool_bar_item_properties
;
7981 /* Next free index in tool_bar_items_vector. */
7983 static int ntool_bar_items
;
7985 /* Function prototypes. */
7987 static void init_tool_bar_items (Lisp_Object
);
7988 static void process_tool_bar_item (Lisp_Object
, Lisp_Object
, Lisp_Object
,
7990 static bool parse_tool_bar_item (Lisp_Object
, Lisp_Object
);
7991 static void append_tool_bar_item (void);
7994 /* Return a vector of tool bar items for keymaps currently in effect.
7995 Reuse vector REUSE if non-nil. Return in *NITEMS the number of
7996 tool bar items found. */
7999 tool_bar_items (Lisp_Object reuse
, int *nitems
)
8002 Lisp_Object mapsbuf
[3];
8010 /* In order to build the menus, we need to call the keymap
8011 accessors. They all call QUIT. But this function is called
8012 during redisplay, during which a quit is fatal. So inhibit
8013 quitting while building the menus. We do this instead of
8014 specbind because (1) errors will clear it anyway and (2) this
8015 avoids risk of specpdl overflow. */
8016 oquit
= Vinhibit_quit
;
8019 /* Initialize tool_bar_items_vector and protect it from GC. */
8020 init_tool_bar_items (reuse
);
8022 /* Build list of keymaps in maps. Set nmaps to the number of maps
8025 /* Should overriding-terminal-local-map and overriding-local-map apply? */
8026 if (!NILP (Voverriding_local_map_menu_flag
)
8027 && !NILP (Voverriding_local_map
))
8029 /* Yes, use them (if non-nil) as well as the global map. */
8032 if (!NILP (KVAR (current_kboard
, Voverriding_terminal_local_map
)))
8033 maps
[nmaps
++] = KVAR (current_kboard
, Voverriding_terminal_local_map
);
8034 if (!NILP (Voverriding_local_map
))
8035 maps
[nmaps
++] = Voverriding_local_map
;
8039 /* No, so use major and minor mode keymaps and keymap property.
8040 Note that tool-bar bindings in the local-map and keymap
8041 properties may not work reliable, as they are only
8042 recognized when the tool-bar (or mode-line) is updated,
8043 which does not normally happen after every command. */
8044 ptrdiff_t nminor
= current_minor_maps (NULL
, &tmaps
);
8045 SAFE_NALLOCA (maps
, 1, nminor
+ 4);
8047 Lisp_Object tem
= KVAR (current_kboard
, Voverriding_terminal_local_map
);
8048 if (!NILP (tem
) && !NILP (Voverriding_local_map_menu_flag
))
8049 maps
[nmaps
++] = tem
;
8050 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
8051 maps
[nmaps
++] = tem
;
8054 memcpy (maps
+ nmaps
, tmaps
, nminor
* sizeof (maps
[0]));
8057 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
8060 /* Add global keymap at the end. */
8061 maps
[nmaps
++] = current_global_map
;
8063 /* Process maps in reverse order and look up in each map the prefix
8065 for (i
= nmaps
- 1; i
>= 0; --i
)
8066 if (!NILP (maps
[i
]))
8070 keymap
= get_keymap (access_keymap (maps
[i
], Qtool_bar
, 1, 0, 1), 0, 1);
8072 map_keymap (keymap
, process_tool_bar_item
, Qnil
, NULL
, 1);
8075 Vinhibit_quit
= oquit
;
8076 *nitems
= ntool_bar_items
/ TOOL_BAR_ITEM_NSLOTS
;
8078 return tool_bar_items_vector
;
8082 /* Process the definition of KEY which is DEF. */
8085 process_tool_bar_item (Lisp_Object key
, Lisp_Object def
, Lisp_Object data
, void *args
)
8088 struct gcpro gcpro1
, gcpro2
;
8090 /* Protect KEY and DEF from GC because parse_tool_bar_item may call
8094 if (EQ (def
, Qundefined
))
8096 /* If a map has an explicit `undefined' as definition,
8097 discard any previously made item. */
8098 for (i
= 0; i
< ntool_bar_items
; i
+= TOOL_BAR_ITEM_NSLOTS
)
8100 Lisp_Object
*v
= XVECTOR (tool_bar_items_vector
)->contents
+ i
;
8102 if (EQ (key
, v
[TOOL_BAR_ITEM_KEY
]))
8104 if (ntool_bar_items
> i
+ TOOL_BAR_ITEM_NSLOTS
)
8105 memmove (v
, v
+ TOOL_BAR_ITEM_NSLOTS
,
8106 ((ntool_bar_items
- i
- TOOL_BAR_ITEM_NSLOTS
)
8108 ntool_bar_items
-= TOOL_BAR_ITEM_NSLOTS
;
8113 else if (parse_tool_bar_item (key
, def
))
8114 /* Append a new tool bar item to tool_bar_items_vector. Accept
8115 more than one definition for the same key. */
8116 append_tool_bar_item ();
8121 /* Access slot with index IDX of vector tool_bar_item_properties. */
8122 #define PROP(IDX) AREF (tool_bar_item_properties, (IDX))
8124 set_prop (ptrdiff_t idx
, Lisp_Object val
)
8126 ASET (tool_bar_item_properties
, idx
, val
);
8130 /* Parse a tool bar item specification ITEM for key KEY and return the
8131 result in tool_bar_item_properties. Value is false if ITEM is
8134 ITEM is a list `(menu-item CAPTION BINDING PROPS...)'.
8136 CAPTION is the caption of the item, If it's not a string, it is
8137 evaluated to get a string.
8139 BINDING is the tool bar item's binding. Tool-bar items with keymaps
8140 as binding are currently ignored.
8142 The following properties are recognized:
8146 FORM is evaluated and specifies whether the tool bar item is
8147 enabled or disabled.
8151 FORM is evaluated and specifies whether the tool bar item is visible.
8153 - `:filter FUNCTION'
8155 FUNCTION is invoked with one parameter `(quote BINDING)'. Its
8156 result is stored as the new binding.
8158 - `:button (TYPE SELECTED)'
8160 TYPE must be one of `:radio' or `:toggle'. SELECTED is evaluated
8161 and specifies whether the button is selected (pressed) or not.
8165 IMAGES is either a single image specification or a vector of four
8166 image specifications. See enum tool_bar_item_images.
8168 - `:help HELP-STRING'.
8170 Gives a help string to display for the tool bar item.
8172 - `:label LABEL-STRING'.
8174 A text label to show with the tool bar button if labels are enabled. */
8177 parse_tool_bar_item (Lisp_Object key
, Lisp_Object item
)
8179 Lisp_Object filter
= Qnil
;
8180 Lisp_Object caption
;
8182 bool have_label
= 0;
8184 /* Definition looks like `(menu-item CAPTION BINDING PROPS...)'.
8185 Rule out items that aren't lists, don't start with
8186 `menu-item' or whose rest following `tool-bar-item' is not a
8191 /* As an exception, allow old-style menu separators. */
8192 if (STRINGP (XCAR (item
)))
8193 item
= list1 (XCAR (item
));
8194 else if (!EQ (XCAR (item
), Qmenu_item
)
8195 || (item
= XCDR (item
), !CONSP (item
)))
8198 /* Create tool_bar_item_properties vector if necessary. Reset it to
8200 if (VECTORP (tool_bar_item_properties
))
8202 for (i
= 0; i
< TOOL_BAR_ITEM_NSLOTS
; ++i
)
8206 tool_bar_item_properties
8207 = Fmake_vector (make_number (TOOL_BAR_ITEM_NSLOTS
), Qnil
);
8210 set_prop (TOOL_BAR_ITEM_KEY
, key
);
8211 set_prop (TOOL_BAR_ITEM_ENABLED_P
, Qt
);
8213 /* Get the caption of the item. If the caption is not a string,
8214 evaluate it to get a string. If we don't get a string, skip this
8216 caption
= XCAR (item
);
8217 if (!STRINGP (caption
))
8219 caption
= menu_item_eval_property (caption
);
8220 if (!STRINGP (caption
))
8223 set_prop (TOOL_BAR_ITEM_CAPTION
, caption
);
8225 /* If the rest following the caption is not a list, the menu item is
8226 either a separator, or invalid. */
8230 if (menu_separator_name_p (SSDATA (caption
)))
8232 set_prop (TOOL_BAR_ITEM_TYPE
, Qt
);
8233 #if !defined (USE_GTK) && !defined (HAVE_NS)
8234 /* If we use build_desired_tool_bar_string to render the
8235 tool bar, the separator is rendered as an image. */
8236 set_prop (TOOL_BAR_ITEM_IMAGES
,
8237 (menu_item_eval_property
8238 (Vtool_bar_separator_image_expression
)));
8239 set_prop (TOOL_BAR_ITEM_ENABLED_P
, Qnil
);
8240 set_prop (TOOL_BAR_ITEM_SELECTED_P
, Qnil
);
8241 set_prop (TOOL_BAR_ITEM_CAPTION
, Qnil
);
8248 /* Store the binding. */
8249 set_prop (TOOL_BAR_ITEM_BINDING
, XCAR (item
));
8252 /* Ignore cached key binding, if any. */
8253 if (CONSP (item
) && CONSP (XCAR (item
)))
8256 /* Process the rest of the properties. */
8257 for (; CONSP (item
) && CONSP (XCDR (item
)); item
= XCDR (XCDR (item
)))
8259 Lisp_Object ikey
, value
;
8262 value
= XCAR (XCDR (item
));
8264 if (EQ (ikey
, QCenable
))
8266 /* `:enable FORM'. */
8267 if (!NILP (Venable_disabled_menus_and_buttons
))
8268 set_prop (TOOL_BAR_ITEM_ENABLED_P
, Qt
);
8270 set_prop (TOOL_BAR_ITEM_ENABLED_P
, value
);
8272 else if (EQ (ikey
, QCvisible
))
8274 /* `:visible FORM'. If got a visible property and that
8275 evaluates to nil then ignore this item. */
8276 if (NILP (menu_item_eval_property (value
)))
8279 else if (EQ (ikey
, QChelp
))
8280 /* `:help HELP-STRING'. */
8281 set_prop (TOOL_BAR_ITEM_HELP
, value
);
8282 else if (EQ (ikey
, QCvert_only
))
8283 /* `:vert-only t/nil'. */
8284 set_prop (TOOL_BAR_ITEM_VERT_ONLY
, value
);
8285 else if (EQ (ikey
, QClabel
))
8287 const char *bad_label
= "!!?GARBLED ITEM?!!";
8288 /* `:label LABEL-STRING'. */
8289 set_prop (TOOL_BAR_ITEM_LABEL
,
8290 STRINGP (value
) ? value
: build_string (bad_label
));
8293 else if (EQ (ikey
, QCfilter
))
8294 /* ':filter FORM'. */
8296 else if (EQ (ikey
, QCbutton
) && CONSP (value
))
8298 /* `:button (TYPE . SELECTED)'. */
8299 Lisp_Object type
, selected
;
8301 type
= XCAR (value
);
8302 selected
= XCDR (value
);
8303 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
8305 set_prop (TOOL_BAR_ITEM_SELECTED_P
, selected
);
8306 set_prop (TOOL_BAR_ITEM_TYPE
, type
);
8309 else if (EQ (ikey
, QCimage
)
8311 || (VECTORP (value
) && ASIZE (value
) == 4)))
8312 /* Value is either a single image specification or a vector
8313 of 4 such specifications for the different button states. */
8314 set_prop (TOOL_BAR_ITEM_IMAGES
, value
);
8315 else if (EQ (ikey
, QCrtl
))
8317 set_prop (TOOL_BAR_ITEM_RTL_IMAGE
, value
);
8323 /* Try to make one from caption and key. */
8324 Lisp_Object tkey
= PROP (TOOL_BAR_ITEM_KEY
);
8325 Lisp_Object tcapt
= PROP (TOOL_BAR_ITEM_CAPTION
);
8326 const char *label
= SYMBOLP (tkey
) ? SSDATA (SYMBOL_NAME (tkey
)) : "";
8327 const char *capt
= STRINGP (tcapt
) ? SSDATA (tcapt
) : "";
8329 2 * max (0, min (tool_bar_max_label_size
, STRING_BYTES_BOUND
/ 2));
8330 char *buf
= xmalloc (max_lbl
+ 1);
8331 Lisp_Object new_lbl
;
8332 ptrdiff_t caption_len
= strlen (capt
);
8334 if (caption_len
<= max_lbl
&& capt
[0] != '\0')
8337 while (caption_len
> 0 && buf
[caption_len
- 1] == '.')
8339 buf
[caption_len
] = '\0';
8343 if (strlen (label
) <= max_lbl
&& label
[0] != '\0')
8347 strcpy (buf
, label
);
8349 for (j
= 0; buf
[j
] != '\0'; ++j
)
8357 new_lbl
= Fupcase_initials (build_string (label
));
8358 if (SCHARS (new_lbl
) <= tool_bar_max_label_size
)
8359 set_prop (TOOL_BAR_ITEM_LABEL
, new_lbl
);
8361 set_prop (TOOL_BAR_ITEM_LABEL
, empty_unibyte_string
);
8365 /* If got a filter apply it on binding. */
8367 set_prop (TOOL_BAR_ITEM_BINDING
,
8368 (menu_item_eval_property
8371 PROP (TOOL_BAR_ITEM_BINDING
))))));
8373 /* See if the binding is a keymap. Give up if it is. */
8374 if (CONSP (get_keymap (PROP (TOOL_BAR_ITEM_BINDING
), 0, 1)))
8377 /* Enable or disable selection of item. */
8378 if (!EQ (PROP (TOOL_BAR_ITEM_ENABLED_P
), Qt
))
8379 set_prop (TOOL_BAR_ITEM_ENABLED_P
,
8380 menu_item_eval_property (PROP (TOOL_BAR_ITEM_ENABLED_P
)));
8382 /* Handle radio buttons or toggle boxes. */
8383 if (!NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
)))
8384 set_prop (TOOL_BAR_ITEM_SELECTED_P
,
8385 menu_item_eval_property (PROP (TOOL_BAR_ITEM_SELECTED_P
)));
8393 /* Initialize tool_bar_items_vector. REUSE, if non-nil, is a vector
8394 that can be reused. */
8397 init_tool_bar_items (Lisp_Object reuse
)
8399 if (VECTORP (reuse
))
8400 tool_bar_items_vector
= reuse
;
8402 tool_bar_items_vector
= Fmake_vector (make_number (64), Qnil
);
8403 ntool_bar_items
= 0;
8407 /* Append parsed tool bar item properties from
8408 tool_bar_item_properties */
8411 append_tool_bar_item (void)
8415 - (ASIZE (tool_bar_items_vector
) - TOOL_BAR_ITEM_NSLOTS
));
8417 /* Enlarge tool_bar_items_vector if necessary. */
8419 tool_bar_items_vector
= larger_vector (tool_bar_items_vector
, incr
, -1);
8421 /* Append entries from tool_bar_item_properties to the end of
8422 tool_bar_items_vector. */
8423 vcopy (tool_bar_items_vector
, ntool_bar_items
,
8424 XVECTOR (tool_bar_item_properties
)->contents
, TOOL_BAR_ITEM_NSLOTS
);
8425 ntool_bar_items
+= TOOL_BAR_ITEM_NSLOTS
;
8432 /* Read a character using menus based on the keymap MAP.
8433 Return nil if there are no menus in the maps.
8434 Return t if we displayed a menu but the user rejected it.
8436 PREV_EVENT is the previous input event, or nil if we are reading
8437 the first event of a key sequence.
8439 If USED_MOUSE_MENU is non-null, set *USED_MOUSE_MENU to true
8440 if we used a mouse menu to read the input, or false otherwise. If
8441 USED_MOUSE_MENU is null, don't dereference it.
8443 The prompting is done based on the prompt-string of the map
8444 and the strings associated with various map elements.
8446 This can be done with X menus or with menus put in the minibuf.
8447 These are done in different ways, depending on how the input will be read.
8448 Menus using X are done after auto-saving in read-char, getting the input
8449 event from Fx_popup_menu; menus using the minibuf use read_char recursively
8450 and do auto-saving in the inner call of read_char. */
8453 read_char_x_menu_prompt (Lisp_Object map
,
8454 Lisp_Object prev_event
, bool *used_mouse_menu
)
8456 if (used_mouse_menu
)
8457 *used_mouse_menu
= 0;
8459 /* Use local over global Menu maps. */
8461 if (! menu_prompting
)
8464 /* If we got to this point via a mouse click,
8465 use a real menu for mouse selection. */
8466 if (EVENT_HAS_PARAMETERS (prev_event
)
8467 && !EQ (XCAR (prev_event
), Qmenu_bar
)
8468 && !EQ (XCAR (prev_event
), Qtool_bar
))
8470 /* Display the menu and get the selection. */
8473 value
= Fx_popup_menu (prev_event
, get_keymap (map
, 0, 1));
8478 record_menu_key (XCAR (value
));
8480 /* If we got multiple events, unread all but
8482 There is no way to prevent those unread events
8483 from showing up later in last_nonmenu_event.
8484 So turn symbol and integer events into lists,
8485 to indicate that they came from a mouse menu,
8486 so that when present in last_nonmenu_event
8487 they won't confuse things. */
8488 for (tem
= XCDR (value
); CONSP (tem
); tem
= XCDR (tem
))
8490 record_menu_key (XCAR (tem
));
8491 if (SYMBOLP (XCAR (tem
))
8492 || INTEGERP (XCAR (tem
)))
8493 XSETCAR (tem
, Fcons (XCAR (tem
), Qdisabled
));
8496 /* If we got more than one event, put all but the first
8497 onto this list to be read later.
8498 Return just the first event now. */
8499 Vunread_command_events
8500 = nconc2 (XCDR (value
), Vunread_command_events
);
8501 value
= XCAR (value
);
8503 else if (NILP (value
))
8505 if (used_mouse_menu
)
8506 *used_mouse_menu
= 1;
8513 read_char_minibuf_menu_prompt (int commandflag
,
8518 /* FIXME: Use the minibuffer's frame width. */
8519 ptrdiff_t width
= FRAME_COLS (SELECTED_FRAME ()) - 4;
8521 bool nobindings
= 1;
8522 Lisp_Object rest
, vector
;
8523 Lisp_Object prompt_strings
= Qnil
;
8527 if (! menu_prompting
)
8530 map
= get_keymap (map
, 0, 1);
8531 name
= Fkeymap_prompt (map
);
8533 /* If we don't have any menus, just read a character normally. */
8534 if (!STRINGP (name
))
8537 #define PUSH_C_STR(str, listvar) \
8538 listvar = Fcons (build_unibyte_string (str), listvar)
8540 /* Prompt string always starts with map's prompt, and a space. */
8541 prompt_strings
= Fcons (name
, prompt_strings
);
8542 PUSH_C_STR (": ", prompt_strings
);
8543 nlength
= SCHARS (name
) + 2;
8547 /* Present the documented bindings, a line at a time. */
8551 Lisp_Object menu_strings
= prompt_strings
;
8552 ptrdiff_t i
= nlength
;
8554 Lisp_Object orig_defn_macro
;
8556 /* Loop over elements of map. */
8561 /* FIXME: Use map_keymap to handle new keymap formats. */
8563 /* At end of map, wrap around if just starting,
8564 or end this line if already have something on it. */
8567 if (notfirst
|| nobindings
)
8573 /* Look at the next element of the map. */
8575 elt
= AREF (vector
, idx
);
8577 elt
= Fcar_safe (rest
);
8579 if (idx
< 0 && VECTORP (elt
))
8581 /* If we found a dense table in the keymap,
8582 advanced past it, but start scanning its contents. */
8583 rest
= Fcdr_safe (rest
);
8589 /* An ordinary element. */
8590 Lisp_Object event
, tem
;
8594 event
= Fcar_safe (elt
); /* alist */
8595 elt
= Fcdr_safe (elt
);
8599 XSETINT (event
, idx
); /* vector */
8602 /* Ignore the element if it has no prompt string. */
8603 if (INTEGERP (event
) && parse_menu_item (elt
, -1))
8605 /* True if the char to type matches the string. */
8607 Lisp_Object upcased_event
, downcased_event
;
8608 Lisp_Object desc
= Qnil
;
8610 = AREF (item_properties
, ITEM_PROPERTY_NAME
);
8612 upcased_event
= Fupcase (event
);
8613 downcased_event
= Fdowncase (event
);
8614 char_matches
= (XINT (upcased_event
) == SREF (s
, 0)
8615 || XINT (downcased_event
) == SREF (s
, 0));
8617 desc
= Fsingle_key_description (event
, Qnil
);
8619 #if 0 /* It is redundant to list the equivalent key bindings because
8620 the prefix is what the user has already typed. */
8622 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_KEYEQ
];
8624 /* Insert equivalent keybinding. */
8625 s
= concat2 (s
, tem
);
8628 = AREF (item_properties
, ITEM_PROPERTY_TYPE
);
8629 if (EQ (tem
, QCradio
) || EQ (tem
, QCtoggle
))
8631 /* Insert button prefix. */
8632 Lisp_Object selected
8633 = AREF (item_properties
, ITEM_PROPERTY_SELECTED
);
8634 AUTO_STRING (radio_yes
, "(*) ");
8635 AUTO_STRING (radio_no
, "( ) ");
8636 AUTO_STRING (check_yes
, "[X] ");
8637 AUTO_STRING (check_no
, "[ ] ");
8638 if (EQ (tem
, QCradio
))
8639 tem
= NILP (selected
) ? radio_yes
: radio_no
;
8641 tem
= NILP (selected
) ? check_yes
: check_no
;
8642 s
= concat2 (tem
, s
);
8646 /* If we have room for the prompt string, add it to this line.
8647 If this is the first on the line, always add it. */
8648 if ((SCHARS (s
) + i
+ 2
8649 + (char_matches
? 0 : SCHARS (desc
) + 3))
8653 ptrdiff_t thiswidth
;
8655 /* Punctuate between strings. */
8658 PUSH_C_STR (", ", menu_strings
);
8664 /* If the char to type doesn't match the string's
8665 first char, explicitly show what char to type. */
8668 /* Add as much of string as fits. */
8669 thiswidth
= min (SCHARS (desc
), width
- i
);
8671 = Fcons (Fsubstring (desc
, make_number (0),
8672 make_number (thiswidth
)),
8675 PUSH_C_STR (" = ", menu_strings
);
8679 /* Add as much of string as fits. */
8680 thiswidth
= min (SCHARS (s
), width
- i
);
8682 = Fcons (Fsubstring (s
, make_number (0),
8683 make_number (thiswidth
)),
8689 /* If this element does not fit, end the line now,
8690 and save the element for the next line. */
8691 PUSH_C_STR ("...", menu_strings
);
8696 /* Move past this element. */
8697 if (idx
>= 0 && idx
+ 1 >= ASIZE (vector
))
8698 /* Handle reaching end of dense table. */
8703 rest
= Fcdr_safe (rest
);
8707 /* Prompt with that and read response. */
8708 message3_nolog (apply1 (intern ("concat"), Fnreverse (menu_strings
)));
8710 /* Make believe it's not a keyboard macro in case the help char
8711 is pressed. Help characters are not recorded because menu prompting
8712 is not used on replay. */
8713 orig_defn_macro
= KVAR (current_kboard
, defining_kbd_macro
);
8714 kset_defining_kbd_macro (current_kboard
, Qnil
);
8716 obj
= read_char (commandflag
, Qnil
, Qt
, 0, NULL
);
8717 while (BUFFERP (obj
));
8718 kset_defining_kbd_macro (current_kboard
, orig_defn_macro
);
8720 if (!INTEGERP (obj
) || XINT (obj
) == -2
8721 || (! EQ (obj
, menu_prompt_more_char
)
8722 && (!INTEGERP (menu_prompt_more_char
)
8723 || ! EQ (obj
, make_number (Ctl (XINT (menu_prompt_more_char
)))))))
8725 if (!NILP (KVAR (current_kboard
, defining_kbd_macro
)))
8726 store_kbd_macro_char (obj
);
8729 /* Help char - go round again. */
8733 /* Reading key sequences. */
8736 follow_key (Lisp_Object keymap
, Lisp_Object key
)
8738 return access_keymap (get_keymap (keymap
, 0, 1),
8743 active_maps (Lisp_Object first_event
)
8745 Lisp_Object position
8746 = CONSP (first_event
) ? CAR_SAFE (XCDR (first_event
)) : Qnil
;
8747 return Fcons (Qkeymap
, Fcurrent_active_maps (Qt
, position
));
8750 /* Structure used to keep track of partial application of key remapping
8751 such as Vfunction_key_map and Vkey_translation_map. */
8752 typedef struct keyremap
8754 /* This is the map originally specified for this use. */
8756 /* This is a submap reached by looking up, in PARENT,
8757 the events from START to END. */
8759 /* Positions [START, END) in the key sequence buffer
8760 are the key that we have scanned so far.
8761 Those events are the ones that we will replace
8762 if PARENT maps them into a key sequence. */
8766 /* Lookup KEY in MAP.
8767 MAP is a keymap mapping keys to key vectors or functions.
8768 If the mapping is a function and DO_FUNCALL is true,
8769 the function is called with PROMPT as parameter and its return
8770 value is used as the return value of this function (after checking
8771 that it is indeed a vector). */
8774 access_keymap_keyremap (Lisp_Object map
, Lisp_Object key
, Lisp_Object prompt
,
8779 next
= access_keymap (map
, key
, 1, 0, 1);
8781 /* Handle a symbol whose function definition is a keymap
8783 if (SYMBOLP (next
) && !NILP (Ffboundp (next
))
8784 && (ARRAYP (XSYMBOL (next
)->function
)
8785 || KEYMAPP (XSYMBOL (next
)->function
)))
8786 next
= Fautoload_do_load (XSYMBOL (next
)->function
, next
, Qnil
);
8788 /* If the keymap gives a function, not an
8789 array, then call the function with one arg and use
8790 its value instead. */
8791 if (do_funcall
&& FUNCTIONP (next
))
8796 next
= call1 (next
, prompt
);
8797 /* If the function returned something invalid,
8798 barf--don't ignore it.
8799 (To ignore it safely, we would need to gcpro a bunch of
8800 other variables.) */
8801 if (! (NILP (next
) || VECTORP (next
) || STRINGP (next
)))
8802 error ("Function %s returns invalid key sequence",
8803 SSDATA (SYMBOL_NAME (tem
)));
8808 /* Do one step of the key remapping used for function-key-map and
8809 key-translation-map:
8810 KEYBUF is the buffer holding the input events.
8811 BUFSIZE is its maximum size.
8812 FKEY is a pointer to the keyremap structure to use.
8813 INPUT is the index of the last element in KEYBUF.
8814 DOIT if true says that the remapping can actually take place.
8815 DIFF is used to return the number of keys added/removed by the remapping.
8816 PARENT is the root of the keymap.
8817 PROMPT is the prompt to use if the remapping happens through a function.
8818 Return true if the remapping actually took place. */
8821 keyremap_step (Lisp_Object
*keybuf
, int bufsize
, volatile keyremap
*fkey
,
8822 int input
, bool doit
, int *diff
, Lisp_Object prompt
)
8824 Lisp_Object next
, key
;
8826 key
= keybuf
[fkey
->end
++];
8828 if (KEYMAPP (fkey
->parent
))
8829 next
= access_keymap_keyremap (fkey
->map
, key
, prompt
, doit
);
8833 /* If keybuf[fkey->start..fkey->end] is bound in the
8834 map and we're in a position to do the key remapping, replace it with
8835 the binding and restart with fkey->start at the end. */
8836 if ((VECTORP (next
) || STRINGP (next
)) && doit
)
8838 int len
= XFASTINT (Flength (next
));
8841 *diff
= len
- (fkey
->end
- fkey
->start
);
8843 if (bufsize
- input
<= *diff
)
8844 error ("Key sequence too long");
8846 /* Shift the keys that follow fkey->end. */
8848 for (i
= fkey
->end
; i
< input
; i
++)
8849 keybuf
[i
+ *diff
] = keybuf
[i
];
8851 for (i
= input
- 1; i
>= fkey
->end
; i
--)
8852 keybuf
[i
+ *diff
] = keybuf
[i
];
8853 /* Overwrite the old keys with the new ones. */
8854 for (i
= 0; i
< len
; i
++)
8855 keybuf
[fkey
->start
+ i
]
8856 = Faref (next
, make_number (i
));
8858 fkey
->start
= fkey
->end
+= *diff
;
8859 fkey
->map
= fkey
->parent
;
8864 fkey
->map
= get_keymap (next
, 0, 1);
8866 /* If we no longer have a bound suffix, try a new position for
8868 if (!CONSP (fkey
->map
))
8870 fkey
->end
= ++fkey
->start
;
8871 fkey
->map
= fkey
->parent
;
8877 test_undefined (Lisp_Object binding
)
8879 return (NILP (binding
)
8880 || EQ (binding
, Qundefined
)
8881 || (SYMBOLP (binding
)
8882 && EQ (Fcommand_remapping (binding
, Qnil
, Qnil
), Qundefined
)));
8885 /* Read a sequence of keys that ends with a non prefix character,
8886 storing it in KEYBUF, a buffer of size BUFSIZE.
8888 Return the length of the key sequence stored.
8889 Return -1 if the user rejected a command menu.
8891 Echo starting immediately unless `prompt' is 0.
8893 If PREVENT_REDISPLAY is non-zero, avoid redisplay by calling
8894 read_char with a suitable COMMANDFLAG argument.
8896 Where a key sequence ends depends on the currently active keymaps.
8897 These include any minor mode keymaps active in the current buffer,
8898 the current buffer's local map, and the global map.
8900 If a key sequence has no other bindings, we check Vfunction_key_map
8901 to see if some trailing subsequence might be the beginning of a
8902 function key's sequence. If so, we try to read the whole function
8903 key, and substitute its symbolic name into the key sequence.
8905 We ignore unbound `down-' mouse clicks. We turn unbound `drag-' and
8906 `double-' events into similar click events, if that would make them
8907 bound. We try to turn `triple-' events first into `double-' events,
8910 If we get a mouse click in a mode line, vertical divider, or other
8911 non-text area, we treat the click as if it were prefixed by the
8912 symbol denoting that area - `mode-line', `vertical-line', or
8915 If the sequence starts with a mouse click, we read the key sequence
8916 with respect to the buffer clicked on, not the current buffer.
8918 If the user switches frames in the midst of a key sequence, we put
8919 off the switch-frame event until later; the next call to
8920 read_char will return it.
8922 If FIX_CURRENT_BUFFER, we restore current_buffer
8923 from the selected window's buffer. */
8926 read_key_sequence (Lisp_Object
*keybuf
, int bufsize
, Lisp_Object prompt
,
8927 bool dont_downcase_last
, bool can_return_switch_frame
,
8928 bool fix_current_buffer
, bool prevent_redisplay
)
8930 ptrdiff_t count
= SPECPDL_INDEX ();
8932 /* How many keys there are in the current key sequence. */
8935 /* The length of the echo buffer when we started reading, and
8936 the length of this_command_keys when we started reading. */
8937 ptrdiff_t echo_start
IF_LINT (= 0);
8938 ptrdiff_t keys_start
;
8940 Lisp_Object current_binding
= Qnil
;
8941 Lisp_Object first_event
= Qnil
;
8943 /* Index of the first key that has no binding.
8944 It is useless to try fkey.start larger than that. */
8947 /* If t < mock_input, then KEYBUF[t] should be read as the next
8950 We use this to recover after recognizing a function key. Once we
8951 realize that a suffix of the current key sequence is actually a
8952 function key's escape sequence, we replace the suffix with the
8953 function key's binding from Vfunction_key_map. Now keybuf
8954 contains a new and different key sequence, so the echo area,
8955 this_command_keys, and the submaps and defs arrays are wrong. In
8956 this situation, we set mock_input to t, set t to 0, and jump to
8957 restart_sequence; the loop will read keys from keybuf up until
8958 mock_input, thus rebuilding the state; and then it will resume
8959 reading characters from the keyboard. */
8962 /* If the sequence is unbound in submaps[], then
8963 keybuf[fkey.start..fkey.end-1] is a prefix in Vfunction_key_map,
8964 and fkey.map is its binding.
8966 These might be > t, indicating that all function key scanning
8967 should hold off until t reaches them. We do this when we've just
8968 recognized a function key, to avoid searching for the function
8969 key's again in Vfunction_key_map. */
8972 /* Likewise, for key_translation_map and input-decode-map. */
8973 keyremap keytran
, indec
;
8975 /* True if we are trying to map a key by changing an upper-case
8976 letter to lower case, or a shifted function key to an unshifted
8978 bool shift_translated
= 0;
8980 /* If we receive a `switch-frame' or `select-window' event in the middle of
8981 a key sequence, we put it off for later.
8982 While we're reading, we keep the event here. */
8983 Lisp_Object delayed_switch_frame
;
8985 Lisp_Object original_uppercase
IF_LINT (= Qnil
);
8986 int original_uppercase_position
= -1;
8988 /* Gets around Microsoft compiler limitations. */
8991 struct buffer
*starting_buffer
;
8993 /* List of events for which a fake prefix key has been generated. */
8994 Lisp_Object fake_prefixed_keys
= Qnil
;
8996 struct gcpro gcpro1
;
8998 GCPRO1 (fake_prefixed_keys
);
8999 raw_keybuf_count
= 0;
9001 last_nonmenu_event
= Qnil
;
9003 delayed_switch_frame
= Qnil
;
9009 /* Install the string PROMPT as the beginning of the string
9010 of echoing, so that it serves as a prompt for the next
9012 kset_echo_string (current_kboard
, prompt
);
9013 current_kboard
->echo_after_prompt
= SCHARS (prompt
);
9016 else if (cursor_in_echo_area
9017 && echo_keystrokes_p ())
9018 /* This doesn't put in a dash if the echo buffer is empty, so
9019 you don't always see a dash hanging out in the minibuffer. */
9023 /* Record the initial state of the echo area and this_command_keys;
9024 we will need to restore them if we replay a key sequence. */
9026 echo_start
= echo_length ();
9027 keys_start
= this_command_key_count
;
9028 this_single_command_key_start
= keys_start
;
9030 /* We jump here when we need to reinitialize fkey and keytran; this
9031 happens if we switch keyboards between rescans. */
9032 replay_entire_sequence
:
9034 indec
.map
= indec
.parent
= KVAR (current_kboard
, Vinput_decode_map
);
9035 fkey
.map
= fkey
.parent
= KVAR (current_kboard
, Vlocal_function_key_map
);
9036 keytran
.map
= keytran
.parent
= Vkey_translation_map
;
9037 indec
.start
= indec
.end
= 0;
9038 fkey
.start
= fkey
.end
= 0;
9039 keytran
.start
= keytran
.end
= 0;
9041 /* We jump here when the key sequence has been thoroughly changed, and
9042 we need to rescan it starting from the beginning. When we jump here,
9043 keybuf[0..mock_input] holds the sequence we should reread. */
9046 starting_buffer
= current_buffer
;
9047 first_unbound
= bufsize
+ 1;
9049 /* Build our list of keymaps.
9050 If we recognize a function key and replace its escape sequence in
9051 keybuf with its symbol, or if the sequence starts with a mouse
9052 click and we need to switch buffers, we jump back here to rebuild
9053 the initial keymaps from the current buffer. */
9054 current_binding
= active_maps (first_event
);
9056 /* Start from the beginning in keybuf. */
9059 /* These are no-ops the first time through, but if we restart, they
9060 revert the echo area and this_command_keys to their original state. */
9061 this_command_key_count
= keys_start
;
9062 if (INTERACTIVE
&& t
< mock_input
)
9063 echo_truncate (echo_start
);
9065 /* If the best binding for the current key sequence is a keymap, or
9066 we may be looking at a function key's escape sequence, keep on
9068 while (!NILP (current_binding
)
9069 /* Keep reading as long as there's a prefix binding. */
9070 ? KEYMAPP (current_binding
)
9071 /* Don't return in the middle of a possible function key sequence,
9072 if the only bindings we found were via case conversion.
9073 Thus, if ESC O a has a function-key-map translation
9074 and ESC o has a binding, don't return after ESC O,
9075 so that we can translate ESC O plus the next character. */
9076 : (/* indec.start < t || fkey.start < t || */ keytran
.start
< t
))
9079 bool used_mouse_menu
= 0;
9081 /* Where the last real key started. If we need to throw away a
9082 key that has expanded into more than one element of keybuf
9083 (say, a mouse click on the mode line which is being treated
9084 as [mode-line (mouse-...)], then we backtrack to this point
9086 int last_real_key_start
;
9088 /* These variables are analogous to echo_start and keys_start;
9089 while those allow us to restart the entire key sequence,
9090 echo_local_start and keys_local_start allow us to throw away
9092 ptrdiff_t echo_local_start
IF_LINT (= 0);
9093 int keys_local_start
;
9094 Lisp_Object new_binding
;
9096 eassert (indec
.end
== t
|| (indec
.end
> t
&& indec
.end
<= mock_input
));
9097 eassert (indec
.start
<= indec
.end
);
9098 eassert (fkey
.start
<= fkey
.end
);
9099 eassert (keytran
.start
<= keytran
.end
);
9100 /* key-translation-map is applied *after* function-key-map
9101 which is itself applied *after* input-decode-map. */
9102 eassert (fkey
.end
<= indec
.start
);
9103 eassert (keytran
.end
<= fkey
.start
);
9105 if (/* first_unbound < indec.start && first_unbound < fkey.start && */
9106 first_unbound
< keytran
.start
)
9107 { /* The prefix upto first_unbound has no binding and has
9108 no translation left to do either, so we know it's unbound.
9109 If we don't stop now, we risk staying here indefinitely
9110 (if the user keeps entering fkey or keytran prefixes
9111 like C-c ESC ESC ESC ESC ...) */
9113 for (i
= first_unbound
+ 1; i
< t
; i
++)
9114 keybuf
[i
- first_unbound
- 1] = keybuf
[i
];
9115 mock_input
= t
- first_unbound
- 1;
9116 indec
.end
= indec
.start
-= first_unbound
+ 1;
9117 indec
.map
= indec
.parent
;
9118 fkey
.end
= fkey
.start
-= first_unbound
+ 1;
9119 fkey
.map
= fkey
.parent
;
9120 keytran
.end
= keytran
.start
-= first_unbound
+ 1;
9121 keytran
.map
= keytran
.parent
;
9122 goto replay_sequence
;
9126 error ("Key sequence too long");
9129 echo_local_start
= echo_length ();
9130 keys_local_start
= this_command_key_count
;
9133 /* These are no-ops, unless we throw away a keystroke below and
9134 jumped back up to replay_key; in that case, these restore the
9135 variables to their original state, allowing us to replay the
9137 if (INTERACTIVE
&& t
< mock_input
)
9138 echo_truncate (echo_local_start
);
9139 this_command_key_count
= keys_local_start
;
9141 /* By default, assume each event is "real". */
9142 last_real_key_start
= t
;
9144 /* Does mock_input indicate that we are re-reading a key sequence? */
9148 add_command_key (key
);
9149 if (echo_keystrokes_p ()
9150 && current_kboard
->immediate_echo
)
9157 /* If not, we should actually read a character. */
9161 KBOARD
*interrupted_kboard
= current_kboard
;
9162 struct frame
*interrupted_frame
= SELECTED_FRAME ();
9163 /* Calling read_char with COMMANDFLAG = -2 avoids
9164 redisplay in read_char and its subroutines. */
9165 key
= read_char (prevent_redisplay
? -2 : NILP (prompt
),
9166 current_binding
, last_nonmenu_event
,
9167 &used_mouse_menu
, NULL
);
9168 if ((INTEGERP (key
) && XINT (key
) == -2) /* wrong_kboard_jmpbuf */
9169 /* When switching to a new tty (with a new keyboard),
9170 read_char returns the new buffer, rather than -2
9171 (Bug#5095). This is because `terminal-init-xterm'
9172 calls read-char, which eats the wrong_kboard_jmpbuf
9173 return. Any better way to fix this? -- cyd */
9174 || (interrupted_kboard
!= current_kboard
))
9179 for (k
= all_kboards
; k
; k
= k
->next_kboard
)
9180 if (k
== interrupted_kboard
)
9185 /* Don't touch interrupted_kboard when it's been
9187 delayed_switch_frame
= Qnil
;
9188 goto replay_entire_sequence
;
9191 if (!NILP (delayed_switch_frame
))
9194 (interrupted_kboard
,
9195 Fcons (delayed_switch_frame
,
9196 KVAR (interrupted_kboard
, kbd_queue
)));
9197 delayed_switch_frame
= Qnil
;
9202 (interrupted_kboard
,
9203 Fcons (keybuf
[--t
], KVAR (interrupted_kboard
, kbd_queue
)));
9205 /* If the side queue is non-empty, ensure it begins with a
9206 switch-frame, so we'll replay it in the right context. */
9207 if (CONSP (KVAR (interrupted_kboard
, kbd_queue
))
9208 && (key
= XCAR (KVAR (interrupted_kboard
, kbd_queue
)),
9209 !(EVENT_HAS_PARAMETERS (key
)
9210 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)),
9214 XSETFRAME (frame
, interrupted_frame
);
9216 (interrupted_kboard
,
9217 Fcons (make_lispy_switch_frame (frame
),
9218 KVAR (interrupted_kboard
, kbd_queue
)));
9221 goto replay_entire_sequence
;
9225 /* read_char returns t when it shows a menu and the user rejects it.
9229 unbind_to (count
, Qnil
);
9234 /* read_char returns -1 at the end of a macro.
9235 Emacs 18 handles this by returning immediately with a
9236 zero, so that's what we'll do. */
9237 if (INTEGERP (key
) && XINT (key
) == -1)
9240 /* The Microsoft C compiler can't handle the goto that
9246 /* If the current buffer has been changed from under us, the
9247 keymap may have changed, so replay the sequence. */
9250 timer_resume_idle ();
9253 /* Reset the current buffer from the selected window
9254 in case something changed the former and not the latter.
9255 This is to be more consistent with the behavior
9256 of the command_loop_1. */
9257 if (fix_current_buffer
)
9259 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
9261 if (XBUFFER (XWINDOW (selected_window
)->contents
)
9263 Fset_buffer (XWINDOW (selected_window
)->contents
);
9266 goto replay_sequence
;
9269 /* If we have a quit that was typed in another frame, and
9270 quit_throw_to_read_char switched buffers,
9271 replay to get the right keymap. */
9273 && XINT (key
) == quit_char
9274 && current_buffer
!= starting_buffer
)
9277 ASET (raw_keybuf
, raw_keybuf_count
, key
);
9282 goto replay_sequence
;
9287 if (EVENT_HAS_PARAMETERS (key
)
9288 /* Either a `switch-frame' or a `select-window' event. */
9289 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)), Qswitch_frame
))
9291 /* If we're at the beginning of a key sequence, and the caller
9292 says it's okay, go ahead and return this event. If we're
9293 in the midst of a key sequence, delay it until the end. */
9294 if (t
> 0 || !can_return_switch_frame
)
9296 delayed_switch_frame
= key
;
9301 if (NILP (first_event
))
9304 /* Even if first_event does not specify a particular
9305 window/position, it's important to recompute the maps here
9306 since a long time might have passed since we entered
9307 read_key_sequence, and a timer (or process-filter or
9308 special-event-map, ...) might have switched the current buffer
9309 or the selected window from under us in the mean time. */
9310 if (fix_current_buffer
9311 && (XBUFFER (XWINDOW (selected_window
)->contents
)
9313 Fset_buffer (XWINDOW (selected_window
)->contents
);
9314 current_binding
= active_maps (first_event
);
9318 ASET (raw_keybuf
, raw_keybuf_count
, key
);
9322 /* Clicks in non-text areas get prefixed by the symbol
9323 in their CHAR-ADDRESS field. For example, a click on
9324 the mode line is prefixed by the symbol `mode-line'.
9326 Furthermore, key sequences beginning with mouse clicks
9327 are read using the keymaps of the buffer clicked on, not
9328 the current buffer. So we may have to switch the buffer
9331 When we turn one event into two events, we must make sure
9332 that neither of the two looks like the original--so that,
9333 if we replay the events, they won't be expanded again.
9334 If not for this, such reexpansion could happen either here
9335 or when user programs play with this-command-keys. */
9336 if (EVENT_HAS_PARAMETERS (key
))
9338 Lisp_Object kind
= EVENT_HEAD_KIND (EVENT_HEAD (key
));
9339 if (EQ (kind
, Qmouse_click
))
9341 Lisp_Object window
= POSN_WINDOW (EVENT_START (key
));
9342 Lisp_Object posn
= POSN_POSN (EVENT_START (key
));
9345 || (!NILP (fake_prefixed_keys
)
9346 && !NILP (Fmemq (key
, fake_prefixed_keys
))))
9348 /* We're looking a second time at an event for which
9349 we generated a fake prefix key. Set
9350 last_real_key_start appropriately. */
9352 last_real_key_start
= t
- 1;
9355 if (last_real_key_start
== 0)
9357 /* Key sequences beginning with mouse clicks are
9358 read using the keymaps in the buffer clicked on,
9359 not the current buffer. If we're at the
9360 beginning of a key sequence, switch buffers. */
9361 if (WINDOWP (window
)
9362 && BUFFERP (XWINDOW (window
)->contents
)
9363 && XBUFFER (XWINDOW (window
)->contents
) != current_buffer
)
9365 ASET (raw_keybuf
, raw_keybuf_count
, key
);
9370 /* Arrange to go back to the original buffer once we're
9371 done reading the key sequence. Note that we can't
9372 use save_excursion_{save,restore} here, because they
9373 save point as well as the current buffer; we don't
9374 want to save point, because redisplay may change it,
9375 to accommodate a Fset_window_start or something. We
9376 don't want to do this at the top of the function,
9377 because we may get input from a subprocess which
9378 wants to change the selected window and stuff (say,
9380 record_unwind_current_buffer ();
9382 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
9384 set_buffer_internal (XBUFFER (XWINDOW (window
)->contents
));
9385 goto replay_sequence
;
9389 /* Expand mode-line and scroll-bar events into two events:
9390 use posn as a fake prefix key. */
9392 && (NILP (fake_prefixed_keys
)
9393 || NILP (Fmemq (key
, fake_prefixed_keys
))))
9395 if (bufsize
- t
<= 1)
9396 error ("Key sequence too long");
9399 keybuf
[t
+ 1] = key
;
9402 /* Record that a fake prefix key has been generated
9403 for KEY. Don't modify the event; this would
9404 prevent proper action when the event is pushed
9405 back into unread-command-events. */
9406 fake_prefixed_keys
= Fcons (key
, fake_prefixed_keys
);
9410 else if (CONSP (XCDR (key
))
9411 && CONSP (EVENT_START (key
))
9412 && CONSP (XCDR (EVENT_START (key
))))
9416 posn
= POSN_POSN (EVENT_START (key
));
9417 /* Handle menu-bar events:
9418 insert the dummy prefix event `menu-bar'. */
9419 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
9421 if (bufsize
- t
<= 1)
9422 error ("Key sequence too long");
9424 keybuf
[t
+ 1] = key
;
9426 /* Zap the position in key, so we know that we've
9427 expanded it, and don't try to do so again. */
9428 POSN_SET_POSN (EVENT_START (key
), list1 (posn
));
9431 goto replay_sequence
;
9433 else if (CONSP (posn
))
9435 /* We're looking at the second event of a
9436 sequence which we expanded before. Set
9437 last_real_key_start appropriately. */
9438 if (last_real_key_start
== t
&& t
> 0)
9439 last_real_key_start
= t
- 1;
9444 /* We have finally decided that KEY is something we might want
9446 new_binding
= follow_key (current_binding
, key
);
9448 /* If KEY wasn't bound, we'll try some fallbacks. */
9449 if (!NILP (new_binding
))
9450 /* This is needed for the following scenario:
9451 event 0: a down-event that gets dropped by calling replay_key.
9452 event 1: some normal prefix like C-h.
9453 After event 0, first_unbound is 0, after event 1 indec.start,
9454 fkey.start, and keytran.start are all 1, so when we see that
9455 C-h is bound, we need to update first_unbound. */
9456 first_unbound
= max (t
+ 1, first_unbound
);
9461 /* Remember the position to put an upper bound on indec.start. */
9462 first_unbound
= min (t
, first_unbound
);
9464 head
= EVENT_HEAD (key
);
9468 Lisp_Object breakdown
;
9471 breakdown
= parse_modifiers (head
);
9472 modifiers
= XINT (XCAR (XCDR (breakdown
)));
9473 /* Attempt to reduce an unbound mouse event to a simpler
9474 event that is bound:
9475 Drags reduce to clicks.
9476 Double-clicks reduce to clicks.
9477 Triple-clicks reduce to double-clicks, then to clicks.
9478 Down-clicks are eliminated.
9479 Double-downs reduce to downs, then are eliminated.
9480 Triple-downs reduce to double-downs, then to downs,
9481 then are eliminated. */
9482 if (modifiers
& (down_modifier
| drag_modifier
9483 | double_modifier
| triple_modifier
))
9485 while (modifiers
& (down_modifier
| drag_modifier
9486 | double_modifier
| triple_modifier
))
9488 Lisp_Object new_head
, new_click
;
9489 if (modifiers
& triple_modifier
)
9490 modifiers
^= (double_modifier
| triple_modifier
);
9491 else if (modifiers
& double_modifier
)
9492 modifiers
&= ~double_modifier
;
9493 else if (modifiers
& drag_modifier
)
9494 modifiers
&= ~drag_modifier
;
9497 /* Dispose of this `down' event by simply jumping
9498 back to replay_key, to get another event.
9500 Note that if this event came from mock input,
9501 then just jumping back to replay_key will just
9502 hand it to us again. So we have to wipe out any
9505 We could delete keybuf[t] and shift everything
9506 after that to the left by one spot, but we'd also
9507 have to fix up any variable that points into
9508 keybuf, and shifting isn't really necessary
9511 Adding prefixes for non-textual mouse clicks
9512 creates two characters of mock input, and both
9513 must be thrown away. If we're only looking at
9514 the prefix now, we can just jump back to
9515 replay_key. On the other hand, if we've already
9516 processed the prefix, and now the actual click
9517 itself is giving us trouble, then we've lost the
9518 state of the keymaps we want to backtrack to, and
9519 we need to replay the whole sequence to rebuild
9522 Beyond that, only function key expansion could
9523 create more than two keys, but that should never
9524 generate mouse events, so it's okay to zero
9525 mock_input in that case too.
9527 FIXME: The above paragraph seems just plain
9528 wrong, if you consider things like
9529 xterm-mouse-mode. -stef
9531 Isn't this just the most wonderful code ever? */
9533 /* If mock_input > t + 1, the above simplification
9534 will actually end up dropping keys on the floor.
9535 This is probably OK for now, but even
9536 if mock_input <= t + 1, we need to adjust indec,
9538 Typical case [header-line down-mouse-N]:
9539 mock_input = 2, t = 1, fkey.end = 1,
9540 last_real_key_start = 0. */
9541 if (indec
.end
> last_real_key_start
)
9543 indec
.end
= indec
.start
9544 = min (last_real_key_start
, indec
.start
);
9545 indec
.map
= indec
.parent
;
9546 if (fkey
.end
> last_real_key_start
)
9548 fkey
.end
= fkey
.start
9549 = min (last_real_key_start
, fkey
.start
);
9550 fkey
.map
= fkey
.parent
;
9551 if (keytran
.end
> last_real_key_start
)
9553 keytran
.end
= keytran
.start
9554 = min (last_real_key_start
, keytran
.start
);
9555 keytran
.map
= keytran
.parent
;
9559 if (t
== last_real_key_start
)
9566 mock_input
= last_real_key_start
;
9567 goto replay_sequence
;
9572 = apply_modifiers (modifiers
, XCAR (breakdown
));
9573 new_click
= list2 (new_head
, EVENT_START (key
));
9575 /* Look for a binding for this new key. */
9576 new_binding
= follow_key (current_binding
, new_click
);
9578 /* If that click is bound, go for it. */
9579 if (!NILP (new_binding
))
9581 current_binding
= new_binding
;
9585 /* Otherwise, we'll leave key set to the drag event. */
9590 current_binding
= new_binding
;
9593 /* Normally, last_nonmenu_event gets the previous key we read.
9594 But when a mouse popup menu is being used,
9595 we don't update last_nonmenu_event; it continues to hold the mouse
9596 event that preceded the first level of menu. */
9597 if (!used_mouse_menu
)
9598 last_nonmenu_event
= key
;
9600 /* Record what part of this_command_keys is the current key sequence. */
9601 this_single_command_key_start
= this_command_key_count
- t
;
9602 /* When 'input-method-function' called above causes events to be
9603 put on 'unread-post-input-method-events', and as result
9604 'reread' is set to 'true', the value of 't' can become larger
9605 than 'this_command_key_count', because 'add_command_key' is
9606 not called to update 'this_command_key_count'. If this
9607 happens, 'this_single_command_key_start' will become negative
9608 above, and any call to 'this-single-command-keys' will return
9609 a garbled vector. See bug #20223 for one such situation.
9610 Here we force 'this_single_command_key_start' to never become
9611 negative, to avoid that. */
9612 if (this_single_command_key_start
< 0)
9613 this_single_command_key_start
= 0;
9615 /* Look for this sequence in input-decode-map.
9616 Scan from indec.end until we find a bound suffix. */
9617 while (indec
.end
< t
)
9619 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9623 GCPRO4 (indec
.map
, fkey
.map
, keytran
.map
, delayed_switch_frame
);
9624 done
= keyremap_step (keybuf
, bufsize
, &indec
, max (t
, mock_input
),
9629 mock_input
= diff
+ max (t
, mock_input
);
9630 goto replay_sequence
;
9634 if (!KEYMAPP (current_binding
)
9635 && !test_undefined (current_binding
)
9636 && indec
.start
>= t
)
9637 /* There is a binding and it's not a prefix.
9638 (and it doesn't have any input-decode-map translation pending).
9639 There is thus no function-key in this sequence.
9640 Moving fkey.start is important in this case to allow keytran.start
9641 to go over the sequence before we return (since we keep the
9642 invariant that keytran.end <= fkey.start). */
9645 (fkey
.start
= fkey
.end
= t
, fkey
.map
= fkey
.parent
);
9648 /* If the sequence is unbound, see if we can hang a function key
9649 off the end of it. */
9650 /* Continue scan from fkey.end until we find a bound suffix. */
9651 while (fkey
.end
< indec
.start
)
9653 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9657 GCPRO4 (indec
.map
, fkey
.map
, keytran
.map
, delayed_switch_frame
);
9658 done
= keyremap_step (keybuf
, bufsize
, &fkey
,
9659 max (t
, mock_input
),
9660 /* If there's a binding (i.e.
9661 first_binding >= nmaps) we don't want
9662 to apply this function-key-mapping. */
9664 && (test_undefined (current_binding
)),
9669 mock_input
= diff
+ max (t
, mock_input
);
9670 /* Adjust the input-decode-map counters. */
9672 indec
.start
+= diff
;
9674 goto replay_sequence
;
9678 /* Look for this sequence in key-translation-map.
9679 Scan from keytran.end until we find a bound suffix. */
9680 while (keytran
.end
< fkey
.start
)
9682 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9686 GCPRO4 (indec
.map
, fkey
.map
, keytran
.map
, delayed_switch_frame
);
9687 done
= keyremap_step (keybuf
, bufsize
, &keytran
, max (t
, mock_input
),
9692 mock_input
= diff
+ max (t
, mock_input
);
9693 /* Adjust the function-key-map and input-decode-map counters. */
9695 indec
.start
+= diff
;
9699 goto replay_sequence
;
9703 /* If KEY is not defined in any of the keymaps,
9704 and cannot be part of a function key or translation,
9705 and is an upper case letter
9706 use the corresponding lower-case letter instead. */
9707 if (NILP (current_binding
)
9708 && /* indec.start >= t && fkey.start >= t && */ keytran
.start
>= t
9710 && ((CHARACTERP (make_number (XINT (key
) & ~CHAR_MODIFIER_MASK
))
9711 && uppercasep (XINT (key
) & ~CHAR_MODIFIER_MASK
))
9712 || (XINT (key
) & shift_modifier
)))
9714 Lisp_Object new_key
;
9716 original_uppercase
= key
;
9717 original_uppercase_position
= t
- 1;
9719 if (XINT (key
) & shift_modifier
)
9720 XSETINT (new_key
, XINT (key
) & ~shift_modifier
);
9722 XSETINT (new_key
, (downcase (XINT (key
) & ~CHAR_MODIFIER_MASK
)
9723 | (XINT (key
) & CHAR_MODIFIER_MASK
)));
9725 /* We have to do this unconditionally, regardless of whether
9726 the lower-case char is defined in the keymaps, because they
9727 might get translated through function-key-map. */
9728 keybuf
[t
- 1] = new_key
;
9729 mock_input
= max (t
, mock_input
);
9730 shift_translated
= 1;
9732 goto replay_sequence
;
9735 if (NILP (current_binding
)
9736 && help_char_p (EVENT_HEAD (key
)) && t
> 1)
9738 read_key_sequence_cmd
= Vprefix_help_command
;
9739 /* The Microsoft C compiler can't handle the goto that
9745 /* If KEY is not defined in any of the keymaps,
9746 and cannot be part of a function key or translation,
9747 and is a shifted function key,
9748 use the corresponding unshifted function key instead. */
9749 if (NILP (current_binding
)
9750 && /* indec.start >= t && fkey.start >= t && */ keytran
.start
>= t
)
9752 Lisp_Object breakdown
= parse_modifiers (key
);
9754 = CONSP (breakdown
) ? (XINT (XCAR (XCDR (breakdown
)))) : 0;
9756 if (modifiers
& shift_modifier
9757 /* Treat uppercase keys as shifted. */
9759 && (KEY_TO_CHAR (key
)
9760 < XCHAR_TABLE (BVAR (current_buffer
, downcase_table
))->header
.size
)
9761 && uppercasep (KEY_TO_CHAR (key
))))
9764 = (modifiers
& shift_modifier
9765 ? apply_modifiers (modifiers
& ~shift_modifier
,
9767 : make_number (downcase (KEY_TO_CHAR (key
)) | modifiers
));
9769 original_uppercase
= key
;
9770 original_uppercase_position
= t
- 1;
9772 /* We have to do this unconditionally, regardless of whether
9773 the lower-case char is defined in the keymaps, because they
9774 might get translated through function-key-map. */
9775 keybuf
[t
- 1] = new_key
;
9776 mock_input
= max (t
, mock_input
);
9777 /* Reset fkey (and consequently keytran) to apply
9778 function-key-map on the result, so that S-backspace is
9779 correctly mapped to DEL (via backspace). OTOH,
9780 input-decode-map doesn't need to go through it again. */
9781 fkey
.start
= fkey
.end
= 0;
9782 keytran
.start
= keytran
.end
= 0;
9783 shift_translated
= 1;
9785 goto replay_sequence
;
9790 read_key_sequence_cmd
= current_binding
;
9791 read_key_sequence_remapped
9792 /* Remap command through active keymaps.
9793 Do the remapping here, before the unbind_to so it uses the keymaps
9794 of the appropriate buffer. */
9795 = SYMBOLP (read_key_sequence_cmd
)
9796 ? Fcommand_remapping (read_key_sequence_cmd
, Qnil
, Qnil
)
9799 unread_switch_frame
= delayed_switch_frame
;
9800 unbind_to (count
, Qnil
);
9802 /* Don't downcase the last character if the caller says don't.
9803 Don't downcase it if the result is undefined, either. */
9804 if ((dont_downcase_last
|| NILP (current_binding
))
9806 && t
- 1 == original_uppercase_position
)
9808 keybuf
[t
- 1] = original_uppercase
;
9809 shift_translated
= 0;
9812 if (shift_translated
)
9813 Vthis_command_keys_shift_translated
= Qt
;
9815 /* Occasionally we fabricate events, perhaps by expanding something
9816 according to function-key-map, or by adding a prefix symbol to a
9817 mouse click in the scroll bar or modeline. In this cases, return
9818 the entire generated key sequence, even if we hit an unbound
9819 prefix or a definition before the end. This means that you will
9820 be able to push back the event properly, and also means that
9821 read-key-sequence will always return a logical unit.
9824 for (; t
< mock_input
; t
++)
9826 if (echo_keystrokes_p ())
9827 echo_char (keybuf
[t
]);
9828 add_command_key (keybuf
[t
]);
9836 read_key_sequence_vs (Lisp_Object prompt
, Lisp_Object continue_echo
,
9837 Lisp_Object dont_downcase_last
,
9838 Lisp_Object can_return_switch_frame
,
9839 Lisp_Object cmd_loop
, bool allow_string
)
9841 Lisp_Object keybuf
[30];
9843 struct gcpro gcpro1
;
9844 ptrdiff_t count
= SPECPDL_INDEX ();
9847 CHECK_STRING (prompt
);
9850 specbind (Qinput_method_exit_on_first_char
,
9851 (NILP (cmd_loop
) ? Qt
: Qnil
));
9852 specbind (Qinput_method_use_echo_area
,
9853 (NILP (cmd_loop
) ? Qt
: Qnil
));
9855 memset (keybuf
, 0, sizeof keybuf
);
9857 gcpro1
.nvars
= ARRAYELTS (keybuf
);
9859 if (NILP (continue_echo
))
9861 this_command_key_count
= 0;
9862 this_command_key_count_reset
= 0;
9863 this_single_command_key_start
= 0;
9866 #ifdef HAVE_WINDOW_SYSTEM
9867 if (display_hourglass_p
)
9868 cancel_hourglass ();
9871 i
= read_key_sequence (keybuf
, ARRAYELTS (keybuf
),
9872 prompt
, ! NILP (dont_downcase_last
),
9873 ! NILP (can_return_switch_frame
), 0, 0);
9875 #if 0 /* The following is fine for code reading a key sequence and
9876 then proceeding with a lengthy computation, but it's not good
9877 for code reading keys in a loop, like an input method. */
9878 #ifdef HAVE_WINDOW_SYSTEM
9879 if (display_hourglass_p
)
9890 return unbind_to (count
,
9891 ((allow_string
? make_event_array
: Fvector
)
9895 DEFUN ("read-key-sequence", Fread_key_sequence
, Sread_key_sequence
, 1, 5, 0,
9896 doc
: /* Read a sequence of keystrokes and return as a string or vector.
9897 The sequence is sufficient to specify a non-prefix command in the
9898 current local and global maps.
9900 First arg PROMPT is a prompt string. If nil, do not prompt specially.
9901 Second (optional) arg CONTINUE-ECHO, if non-nil, means this key echos
9902 as a continuation of the previous key.
9904 The third (optional) arg DONT-DOWNCASE-LAST, if non-nil, means do not
9905 convert the last event to lower case. (Normally any upper case event
9906 is converted to lower case if the original event is undefined and the lower
9907 case equivalent is defined.) A non-nil value is appropriate for reading
9908 a key sequence to be defined.
9910 A C-g typed while in this function is treated like any other character,
9911 and `quit-flag' is not set.
9913 If the key sequence starts with a mouse click, then the sequence is read
9914 using the keymaps of the buffer of the window clicked in, not the buffer
9915 of the selected window as normal.
9917 `read-key-sequence' drops unbound button-down events, since you normally
9918 only care about the click or drag events which follow them. If a drag
9919 or multi-click event is unbound, but the corresponding click event would
9920 be bound, `read-key-sequence' turns the event into a click event at the
9921 drag's starting position. This means that you don't have to distinguish
9922 between click and drag, double, or triple events unless you want to.
9924 `read-key-sequence' prefixes mouse events on mode lines, the vertical
9925 lines separating windows, and scroll bars with imaginary keys
9926 `mode-line', `vertical-line', and `vertical-scroll-bar'.
9928 Optional fourth argument CAN-RETURN-SWITCH-FRAME non-nil means that this
9929 function will process a switch-frame event if the user switches frames
9930 before typing anything. If the user switches frames in the middle of a
9931 key sequence, or at the start of the sequence but CAN-RETURN-SWITCH-FRAME
9932 is nil, then the event will be put off until after the current key sequence.
9934 `read-key-sequence' checks `function-key-map' for function key
9935 sequences, where they wouldn't conflict with ordinary bindings. See
9936 `function-key-map' for more details.
9938 The optional fifth argument CMD-LOOP, if non-nil, means
9939 that this key sequence is being read by something that will
9940 read commands one after another. It should be nil if the caller
9941 will read just one key sequence. */)
9942 (Lisp_Object prompt
, Lisp_Object continue_echo
, Lisp_Object dont_downcase_last
, Lisp_Object can_return_switch_frame
, Lisp_Object cmd_loop
)
9944 return read_key_sequence_vs (prompt
, continue_echo
, dont_downcase_last
,
9945 can_return_switch_frame
, cmd_loop
, true);
9948 DEFUN ("read-key-sequence-vector", Fread_key_sequence_vector
,
9949 Sread_key_sequence_vector
, 1, 5, 0,
9950 doc
: /* Like `read-key-sequence' but always return a vector. */)
9951 (Lisp_Object prompt
, Lisp_Object continue_echo
, Lisp_Object dont_downcase_last
, Lisp_Object can_return_switch_frame
, Lisp_Object cmd_loop
)
9953 return read_key_sequence_vs (prompt
, continue_echo
, dont_downcase_last
,
9954 can_return_switch_frame
, cmd_loop
, false);
9957 /* Return true if input events are pending. */
9960 detect_input_pending (void)
9962 return input_pending
|| get_input_pending (0);
9965 /* Return true if input events other than mouse movements are
9969 detect_input_pending_ignore_squeezables (void)
9971 return input_pending
|| get_input_pending (READABLE_EVENTS_IGNORE_SQUEEZABLES
);
9974 /* Return true if input events are pending, and run any pending timers. */
9977 detect_input_pending_run_timers (bool do_display
)
9979 unsigned old_timers_run
= timers_run
;
9982 get_input_pending (READABLE_EVENTS_DO_TIMERS_NOW
);
9984 if (old_timers_run
!= timers_run
&& do_display
)
9985 redisplay_preserve_echo_area (8);
9987 return input_pending
;
9990 /* This is called in some cases before a possible quit.
9991 It cases the next call to detect_input_pending to recompute input_pending.
9992 So calling this function unnecessarily can't do any harm. */
9995 clear_input_pending (void)
10000 /* Return true if there are pending requeued events.
10001 This isn't used yet. The hope is to make wait_reading_process_output
10002 call it, and return if it runs Lisp code that unreads something.
10003 The problem is, kbd_buffer_get_event needs to be fixed to know what
10004 to do in that case. It isn't trivial. */
10007 requeued_events_pending_p (void)
10009 return (!NILP (Vunread_command_events
));
10012 DEFUN ("input-pending-p", Finput_pending_p
, Sinput_pending_p
, 0, 1, 0,
10013 doc
: /* Return t if command input is currently available with no wait.
10014 Actually, the value is nil only if we can be sure that no input is available;
10015 if there is a doubt, the value is t.
10017 If CHECK-TIMERS is non-nil, timers that are ready to run will do so. */)
10018 (Lisp_Object check_timers
)
10020 if (!NILP (Vunread_command_events
)
10021 || !NILP (Vunread_post_input_method_events
)
10022 || !NILP (Vunread_input_method_events
))
10025 /* Process non-user-visible events (Bug#10195). */
10026 process_special_events ();
10028 return (get_input_pending ((NILP (check_timers
)
10029 ? 0 : READABLE_EVENTS_DO_TIMERS_NOW
)
10030 | READABLE_EVENTS_FILTER_EVENTS
)
10034 DEFUN ("recent-keys", Frecent_keys
, Srecent_keys
, 0, 1, 0,
10035 doc
: /* Return vector of last few events, not counting those from keyboard macros.
10036 If INCLUDE-CMDS is non-nil, include the commands that were run,
10037 represented as events of the form (nil . COMMAND). */)
10038 (Lisp_Object include_cmds
)
10040 bool cmds
= !NILP (include_cmds
);
10043 || (cmds
&& total_keys
< NUM_RECENT_KEYS
))
10044 return Fvector (total_keys
,
10045 XVECTOR (recent_keys
)->contents
);
10048 Lisp_Object es
= Qnil
;
10049 int i
= (total_keys
< NUM_RECENT_KEYS
10050 ? 0 : recent_keys_index
);
10051 eassert (recent_keys_index
< NUM_RECENT_KEYS
);
10054 Lisp_Object e
= AREF (recent_keys
, i
);
10055 if (cmds
|| !CONSP (e
) || !NILP (XCAR (e
)))
10056 es
= Fcons (e
, es
);
10057 if (++i
>= NUM_RECENT_KEYS
)
10059 } while (i
!= recent_keys_index
);
10060 es
= Fnreverse (es
);
10061 return Fvconcat (1, &es
);
10065 DEFUN ("this-command-keys", Fthis_command_keys
, Sthis_command_keys
, 0, 0, 0,
10066 doc
: /* Return the key sequence that invoked this command.
10067 However, if the command has called `read-key-sequence', it returns
10068 the last key sequence that has been read.
10069 The value is a string or a vector.
10071 See also `this-command-keys-vector'. */)
10074 return make_event_array (this_command_key_count
,
10075 XVECTOR (this_command_keys
)->contents
);
10078 DEFUN ("this-command-keys-vector", Fthis_command_keys_vector
, Sthis_command_keys_vector
, 0, 0, 0,
10079 doc
: /* Return the key sequence that invoked this command, as a vector.
10080 However, if the command has called `read-key-sequence', it returns
10081 the last key sequence that has been read.
10083 See also `this-command-keys'. */)
10086 return Fvector (this_command_key_count
,
10087 XVECTOR (this_command_keys
)->contents
);
10090 DEFUN ("this-single-command-keys", Fthis_single_command_keys
,
10091 Sthis_single_command_keys
, 0, 0, 0,
10092 doc
: /* Return the key sequence that invoked this command.
10093 More generally, it returns the last key sequence read, either by
10094 the command loop or by `read-key-sequence'.
10095 Unlike `this-command-keys', this function's value
10096 does not include prefix arguments.
10097 The value is always a vector. */)
10100 return Fvector (this_command_key_count
10101 - this_single_command_key_start
,
10102 (XVECTOR (this_command_keys
)->contents
10103 + this_single_command_key_start
));
10106 DEFUN ("this-single-command-raw-keys", Fthis_single_command_raw_keys
,
10107 Sthis_single_command_raw_keys
, 0, 0, 0,
10108 doc
: /* Return the raw events that were read for this command.
10109 More generally, it returns the last key sequence read, either by
10110 the command loop or by `read-key-sequence'.
10111 Unlike `this-single-command-keys', this function's value
10112 shows the events before all translations (except for input methods).
10113 The value is always a vector. */)
10116 return Fvector (raw_keybuf_count
, XVECTOR (raw_keybuf
)->contents
);
10119 DEFUN ("reset-this-command-lengths", Freset_this_command_lengths
,
10120 Sreset_this_command_lengths
, 0, 0, 0,
10121 doc
: /* Make the unread events replace the last command and echo.
10122 Used in `universal-argument-other-key'.
10124 `universal-argument-other-key' rereads the event just typed.
10125 It then gets translated through `function-key-map'.
10126 The translated event has to replace the real events,
10127 both in the value of (this-command-keys) and in echoing.
10128 To achieve this, `universal-argument-other-key' calls
10129 `reset-this-command-lengths', which discards the record of reading
10130 these events the first time. */)
10133 this_command_key_count
= before_command_key_count
;
10134 if (this_command_key_count
< this_single_command_key_start
)
10135 this_single_command_key_start
= this_command_key_count
;
10137 echo_truncate (before_command_echo_length
);
10139 /* Cause whatever we put into unread-command-events
10140 to echo as if it were being freshly read from the keyboard. */
10141 this_command_key_count_reset
= 1;
10146 DEFUN ("clear-this-command-keys", Fclear_this_command_keys
,
10147 Sclear_this_command_keys
, 0, 1, 0,
10148 doc
: /* Clear out the vector that `this-command-keys' returns.
10149 Also clear the record of the last 100 events, unless optional arg
10150 KEEP-RECORD is non-nil. */)
10151 (Lisp_Object keep_record
)
10155 this_command_key_count
= 0;
10156 this_command_key_count_reset
= 0;
10158 if (NILP (keep_record
))
10160 for (i
= 0; i
< ASIZE (recent_keys
); ++i
)
10161 ASET (recent_keys
, i
, Qnil
);
10163 recent_keys_index
= 0;
10168 DEFUN ("recursion-depth", Frecursion_depth
, Srecursion_depth
, 0, 0, 0,
10169 doc
: /* Return the current depth in recursive edits. */)
10173 /* Wrap around reliably on integer overflow. */
10174 EMACS_INT sum
= (command_loop_level
& INTMASK
) + (minibuf_level
& INTMASK
);
10175 XSETINT (temp
, sum
);
10179 DEFUN ("open-dribble-file", Fopen_dribble_file
, Sopen_dribble_file
, 1, 1,
10180 "FOpen dribble file: ",
10181 doc
: /* Start writing all keyboard characters to a dribble file called FILE.
10182 If FILE is nil, close any open dribble file.
10183 The file will be closed when Emacs exits.
10185 Be aware that this records ALL characters you type!
10186 This may include sensitive information such as passwords. */)
10199 Lisp_Object encfile
;
10201 file
= Fexpand_file_name (file
, Qnil
);
10202 encfile
= ENCODE_FILE (file
);
10203 fd
= emacs_open (SSDATA (encfile
), O_WRONLY
| O_CREAT
| O_EXCL
, 0600);
10204 if (fd
< 0 && errno
== EEXIST
&& unlink (SSDATA (encfile
)) == 0)
10205 fd
= emacs_open (SSDATA (encfile
), O_WRONLY
| O_CREAT
| O_EXCL
, 0600);
10206 dribble
= fd
< 0 ? 0 : fdopen (fd
, "w");
10208 report_file_error ("Opening dribble", file
);
10213 DEFUN ("discard-input", Fdiscard_input
, Sdiscard_input
, 0, 0, 0,
10214 doc
: /* Discard the contents of the terminal input buffer.
10215 Also end any kbd macro being defined. */)
10218 if (!NILP (KVAR (current_kboard
, defining_kbd_macro
)))
10220 /* Discard the last command from the macro. */
10221 Fcancel_kbd_macro_events ();
10225 Vunread_command_events
= Qnil
;
10227 discard_tty_input ();
10229 kbd_fetch_ptr
= kbd_store_ptr
;
10235 DEFUN ("suspend-emacs", Fsuspend_emacs
, Ssuspend_emacs
, 0, 1, "",
10236 doc
: /* Stop Emacs and return to superior process. You can resume later.
10237 If `cannot-suspend' is non-nil, or if the system doesn't support job
10238 control, run a subshell instead.
10240 If optional arg STUFFSTRING is non-nil, its characters are stuffed
10241 to be read as terminal input by Emacs's parent, after suspension.
10243 Before suspending, run the normal hook `suspend-hook'.
10244 After resumption run the normal hook `suspend-resume-hook'.
10246 Some operating systems cannot stop the Emacs process and resume it later.
10247 On such systems, Emacs starts a subshell instead of suspending. */)
10248 (Lisp_Object stuffstring
)
10250 ptrdiff_t count
= SPECPDL_INDEX ();
10251 int old_height
, old_width
;
10253 struct gcpro gcpro1
;
10255 if (tty_list
&& tty_list
->next
)
10256 error ("There are other tty frames open; close them before suspending Emacs");
10258 if (!NILP (stuffstring
))
10259 CHECK_STRING (stuffstring
);
10261 run_hook (intern ("suspend-hook"));
10263 GCPRO1 (stuffstring
);
10264 get_tty_size (fileno (CURTTY ()->input
), &old_width
, &old_height
);
10265 reset_all_sys_modes ();
10266 /* sys_suspend can get an error if it tries to fork a subshell
10267 and the system resources aren't available for that. */
10268 record_unwind_protect_void (init_all_sys_modes
);
10269 stuff_buffered_input (stuffstring
);
10270 if (cannot_suspend
)
10274 unbind_to (count
, Qnil
);
10276 /* Check if terminal/window size has changed.
10277 Note that this is not useful when we are running directly
10278 with a window system; but suspend should be disabled in that case. */
10279 get_tty_size (fileno (CURTTY ()->input
), &width
, &height
);
10280 if (width
!= old_width
|| height
!= old_height
)
10281 change_frame_size (SELECTED_FRAME (), width
,
10282 height
- FRAME_MENU_BAR_LINES (SELECTED_FRAME ()),
10285 run_hook (intern ("suspend-resume-hook"));
10291 /* If STUFFSTRING is a string, stuff its contents as pending terminal input.
10292 Then in any case stuff anything Emacs has read ahead and not used. */
10295 stuff_buffered_input (Lisp_Object stuffstring
)
10297 #ifdef SIGTSTP /* stuff_char is defined if SIGTSTP. */
10298 register unsigned char *p
;
10300 if (STRINGP (stuffstring
))
10302 register ptrdiff_t count
;
10304 p
= SDATA (stuffstring
);
10305 count
= SBYTES (stuffstring
);
10306 while (count
-- > 0)
10311 /* Anything we have read ahead, put back for the shell to read. */
10312 /* ?? What should this do when we have multiple keyboards??
10313 Should we ignore anything that was typed in at the "wrong" kboard?
10315 rms: we should stuff everything back into the kboard
10317 for (; kbd_fetch_ptr
!= kbd_store_ptr
; kbd_fetch_ptr
++)
10320 if (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
10321 kbd_fetch_ptr
= kbd_buffer
;
10322 if (kbd_fetch_ptr
->kind
== ASCII_KEYSTROKE_EVENT
)
10323 stuff_char (kbd_fetch_ptr
->ie
.code
);
10325 clear_event (kbd_fetch_ptr
);
10329 #endif /* SIGTSTP */
10333 set_waiting_for_input (struct timespec
*time_to_clear
)
10335 input_available_clear_time
= time_to_clear
;
10337 /* Tell handle_interrupt to throw back to read_char, */
10338 waiting_for_input
= 1;
10340 /* If handle_interrupt was called before and buffered a C-g,
10341 make it run again now, to avoid timing error. */
10342 if (!NILP (Vquit_flag
))
10343 quit_throw_to_read_char (0);
10347 clear_waiting_for_input (void)
10349 /* Tell handle_interrupt not to throw back to read_char, */
10350 waiting_for_input
= 0;
10351 input_available_clear_time
= 0;
10354 /* The SIGINT handler.
10356 If we have a frame on the controlling tty, we assume that the
10357 SIGINT was generated by C-g, so we call handle_interrupt.
10358 Otherwise, tell QUIT to kill Emacs. */
10361 handle_interrupt_signal (int sig
)
10363 /* See if we have an active terminal on our controlling tty. */
10364 struct terminal
*terminal
= get_named_terminal ("/dev/tty");
10367 /* If there are no frames there, let's pretend that we are a
10368 well-behaving UN*X program and quit. We must not call Lisp
10369 in a signal handler, so tell QUIT to exit when it is
10371 Vquit_flag
= Qkill_emacs
;
10375 /* Otherwise, the SIGINT was probably generated by C-g. */
10377 /* Set internal_last_event_frame to the top frame of the
10378 controlling tty, if we have a frame there. We disable the
10379 interrupt key on secondary ttys, so the SIGINT must have come
10380 from the controlling tty. */
10381 internal_last_event_frame
= terminal
->display_info
.tty
->top_frame
;
10383 handle_interrupt (1);
10388 deliver_interrupt_signal (int sig
)
10390 deliver_process_signal (sig
, handle_interrupt_signal
);
10394 /* If Emacs is stuck because `inhibit-quit' is true, then keep track
10395 of the number of times C-g has been requested. If C-g is pressed
10396 enough times, then quit anyway. See bug#6585. */
10397 static int volatile force_quit_count
;
10399 /* This routine is called at interrupt level in response to C-g.
10401 It is called from the SIGINT handler or kbd_buffer_store_event.
10403 If `waiting_for_input' is non zero, then unless `echoing' is
10404 nonzero, immediately throw back to read_char.
10406 Otherwise it sets the Lisp variable quit-flag not-nil. This causes
10407 eval to throw, when it gets a chance. If quit-flag is already
10408 non-nil, it stops the job right away. */
10411 handle_interrupt (bool in_signal_handler
)
10417 /* XXX This code needs to be revised for multi-tty support. */
10418 if (!NILP (Vquit_flag
) && get_named_terminal ("/dev/tty"))
10420 if (! in_signal_handler
)
10422 /* If SIGINT isn't blocked, don't let us be interrupted by
10423 a SIGINT. It might be harmful due to non-reentrancy
10424 in I/O functions. */
10426 sigemptyset (&blocked
);
10427 sigaddset (&blocked
, SIGINT
);
10428 pthread_sigmask (SIG_BLOCK
, &blocked
, 0);
10432 reset_all_sys_modes ();
10436 * On systems which can suspend the current process and return to the original
10437 * shell, this command causes the user to end up back at the shell.
10438 * The "Auto-save" and "Abort" questions are not asked until
10439 * the user elects to return to emacs, at which point he can save the current
10440 * job and either dump core or continue.
10444 /* Perhaps should really fork an inferior shell?
10445 But that would not provide any way to get back
10446 to the original shell, ever. */
10447 printf ("No support for stopping a process on this operating system;\n");
10448 printf ("you can continue or abort.\n");
10449 #endif /* not SIGTSTP */
10451 /* We must remain inside the screen area when the internal terminal
10452 is used. Note that [Enter] is not echoed by dos. */
10453 cursor_to (SELECTED_FRAME (), 0, 0);
10455 /* It doesn't work to autosave while GC is in progress;
10456 the code used for auto-saving doesn't cope with the mark bit. */
10457 if (!gc_in_progress
)
10459 printf ("Auto-save? (y or n) ");
10461 if (((c
= getchar ()) & ~040) == 'Y')
10463 Fdo_auto_save (Qt
, Qnil
);
10465 printf ("\r\nAuto-save done");
10466 #else /* not MSDOS */
10467 printf ("Auto-save done\n");
10468 #endif /* not MSDOS */
10470 while (c
!= '\n') c
= getchar ();
10474 /* During GC, it must be safe to reenable quitting again. */
10475 Vinhibit_quit
= Qnil
;
10478 #endif /* not MSDOS */
10479 printf ("Garbage collection in progress; cannot auto-save now\r\n");
10480 printf ("but will instead do a real quit after garbage collection ends\r\n");
10485 printf ("\r\nAbort? (y or n) ");
10486 #else /* not MSDOS */
10487 printf ("Abort (and dump core)? (y or n) ");
10488 #endif /* not MSDOS */
10490 if (((c
= getchar ()) & ~040) == 'Y')
10492 while (c
!= '\n') c
= getchar ();
10494 printf ("\r\nContinuing...\r\n");
10495 #else /* not MSDOS */
10496 printf ("Continuing...\n");
10497 #endif /* not MSDOS */
10499 init_all_sys_modes ();
10503 /* If executing a function that wants to be interrupted out of
10504 and the user has not deferred quitting by binding `inhibit-quit'
10505 then quit right away. */
10506 if (immediate_quit
&& NILP (Vinhibit_quit
))
10508 struct gl_state_s saved
;
10509 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
10511 immediate_quit
= 0;
10512 pthread_sigmask (SIG_SETMASK
, &empty_mask
, 0);
10514 GCPRO4 (saved
.object
, saved
.global_code
,
10515 saved
.current_syntax_table
, saved
.old_prop
);
10516 Fsignal (Qquit
, Qnil
);
10521 { /* Else request quit when it's safe. */
10522 int count
= NILP (Vquit_flag
) ? 1 : force_quit_count
+ 1;
10523 force_quit_count
= count
;
10526 immediate_quit
= 1;
10527 Vinhibit_quit
= Qnil
;
10533 pthread_sigmask (SIG_SETMASK
, &empty_mask
, 0);
10535 /* TODO: The longjmp in this call throws the NS event loop integration off,
10536 and it seems to do fine without this. Probably some attention
10537 needs to be paid to the setting of waiting_for_input in
10538 wait_reading_process_output() under HAVE_NS because of the call
10539 to ns_select there (needed because otherwise events aren't picked up
10540 outside of polling since we don't get SIGIO like X and we don't have a
10541 separate event loop thread like W32. */
10543 if (waiting_for_input
&& !echoing
)
10544 quit_throw_to_read_char (in_signal_handler
);
10548 /* Handle a C-g by making read_char return C-g. */
10551 quit_throw_to_read_char (bool from_signal
)
10553 /* When not called from a signal handler it is safe to call
10555 if (!from_signal
&& EQ (Vquit_flag
, Qkill_emacs
))
10556 Fkill_emacs (Qnil
);
10558 /* Prevent another signal from doing this before we finish. */
10559 clear_waiting_for_input ();
10562 Vunread_command_events
= Qnil
;
10564 if (FRAMEP (internal_last_event_frame
)
10565 && !EQ (internal_last_event_frame
, selected_frame
))
10566 do_switch_frame (make_lispy_switch_frame (internal_last_event_frame
),
10569 sys_longjmp (getcjmp
, 1);
10572 DEFUN ("set-input-interrupt-mode", Fset_input_interrupt_mode
,
10573 Sset_input_interrupt_mode
, 1, 1, 0,
10574 doc
: /* Set interrupt mode of reading keyboard input.
10575 If INTERRUPT is non-nil, Emacs will use input interrupts;
10576 otherwise Emacs uses CBREAK mode.
10578 See also `current-input-mode'. */)
10579 (Lisp_Object interrupt
)
10581 bool new_interrupt_input
;
10582 #ifdef USABLE_SIGIO
10583 #ifdef HAVE_X_WINDOWS
10584 if (x_display_list
!= NULL
)
10586 /* When using X, don't give the user a real choice,
10587 because we haven't implemented the mechanisms to support it. */
10588 new_interrupt_input
= 1;
10591 #endif /* HAVE_X_WINDOWS */
10592 new_interrupt_input
= !NILP (interrupt
);
10593 #else /* not USABLE_SIGIO */
10594 new_interrupt_input
= 0;
10595 #endif /* not USABLE_SIGIO */
10597 if (new_interrupt_input
!= interrupt_input
)
10599 #ifdef POLL_FOR_INPUT
10603 /* this causes startup screen to be restored and messes with the mouse */
10604 reset_all_sys_modes ();
10605 interrupt_input
= new_interrupt_input
;
10606 init_all_sys_modes ();
10608 interrupt_input
= new_interrupt_input
;
10611 #ifdef POLL_FOR_INPUT
10612 poll_suppress_count
= 1;
10619 DEFUN ("set-output-flow-control", Fset_output_flow_control
, Sset_output_flow_control
, 1, 2, 0,
10620 doc
: /* Enable or disable ^S/^Q flow control for output to TERMINAL.
10621 If FLOW is non-nil, flow control is enabled and you cannot use C-s or
10622 C-q in key sequences.
10624 This setting only has an effect on tty terminals and only when
10625 Emacs reads input in CBREAK mode; see `set-input-interrupt-mode'.
10627 See also `current-input-mode'. */)
10628 (Lisp_Object flow
, Lisp_Object terminal
)
10630 struct terminal
*t
= decode_tty_terminal (terminal
);
10631 struct tty_display_info
*tty
;
10635 tty
= t
->display_info
.tty
;
10637 if (tty
->flow_control
!= !NILP (flow
))
10640 /* This causes startup screen to be restored and messes with the mouse. */
10641 reset_sys_modes (tty
);
10644 tty
->flow_control
= !NILP (flow
);
10647 init_sys_modes (tty
);
10653 DEFUN ("set-input-meta-mode", Fset_input_meta_mode
, Sset_input_meta_mode
, 1, 2, 0,
10654 doc
: /* Enable or disable 8-bit input on TERMINAL.
10655 If META is t, Emacs will accept 8-bit input, and interpret the 8th
10656 bit as the Meta modifier.
10658 If META is nil, Emacs will ignore the top bit, on the assumption it is
10661 Otherwise, Emacs will accept and pass through 8-bit input without
10662 specially interpreting the top bit.
10664 This setting only has an effect on tty terminal devices.
10666 Optional parameter TERMINAL specifies the tty terminal device to use.
10667 It may be a terminal object, a frame, or nil for the terminal used by
10668 the currently selected frame.
10670 See also `current-input-mode'. */)
10671 (Lisp_Object meta
, Lisp_Object terminal
)
10673 struct terminal
*t
= decode_tty_terminal (terminal
);
10674 struct tty_display_info
*tty
;
10679 tty
= t
->display_info
.tty
;
10683 else if (EQ (meta
, Qt
))
10688 if (tty
->meta_key
!= new_meta
)
10691 /* this causes startup screen to be restored and messes with the mouse */
10692 reset_sys_modes (tty
);
10695 tty
->meta_key
= new_meta
;
10698 init_sys_modes (tty
);
10704 DEFUN ("set-quit-char", Fset_quit_char
, Sset_quit_char
, 1, 1, 0,
10705 doc
: /* Specify character used for quitting.
10706 QUIT must be an ASCII character.
10708 This function only has an effect on the controlling tty of the Emacs
10711 See also `current-input-mode'. */)
10714 struct terminal
*t
= get_named_terminal ("/dev/tty");
10715 struct tty_display_info
*tty
;
10719 tty
= t
->display_info
.tty
;
10721 if (NILP (quit
) || !INTEGERP (quit
) || XINT (quit
) < 0 || XINT (quit
) > 0400)
10722 error ("QUIT must be an ASCII character");
10725 /* this causes startup screen to be restored and messes with the mouse */
10726 reset_sys_modes (tty
);
10729 /* Don't let this value be out of range. */
10730 quit_char
= XINT (quit
) & (tty
->meta_key
== 0 ? 0177 : 0377);
10733 init_sys_modes (tty
);
10739 DEFUN ("set-input-mode", Fset_input_mode
, Sset_input_mode
, 3, 4, 0,
10740 doc
: /* Set mode of reading keyboard input.
10741 First arg INTERRUPT non-nil means use input interrupts;
10742 nil means use CBREAK mode.
10743 Second arg FLOW non-nil means use ^S/^Q flow control for output to terminal
10744 (no effect except in CBREAK mode).
10745 Third arg META t means accept 8-bit input (for a Meta key).
10746 META nil means ignore the top bit, on the assumption it is parity.
10747 Otherwise, accept 8-bit input and don't use the top bit for Meta.
10748 Optional fourth arg QUIT if non-nil specifies character to use for quitting.
10749 See also `current-input-mode'. */)
10750 (Lisp_Object interrupt
, Lisp_Object flow
, Lisp_Object meta
, Lisp_Object quit
)
10752 Fset_input_interrupt_mode (interrupt
);
10753 Fset_output_flow_control (flow
, Qnil
);
10754 Fset_input_meta_mode (meta
, Qnil
);
10756 Fset_quit_char (quit
);
10760 DEFUN ("current-input-mode", Fcurrent_input_mode
, Scurrent_input_mode
, 0, 0, 0,
10761 doc
: /* Return information about the way Emacs currently reads keyboard input.
10762 The value is a list of the form (INTERRUPT FLOW META QUIT), where
10763 INTERRUPT is non-nil if Emacs is using interrupt-driven input; if
10764 nil, Emacs is using CBREAK mode.
10765 FLOW is non-nil if Emacs uses ^S/^Q flow control for output to the
10766 terminal; this does not apply if Emacs uses interrupt-driven input.
10767 META is t if accepting 8-bit input with 8th bit as Meta flag.
10768 META nil means ignoring the top bit, on the assumption it is parity.
10769 META is neither t nor nil if accepting 8-bit input and using
10770 all 8 bits as the character code.
10771 QUIT is the character Emacs currently uses to quit.
10772 The elements of this list correspond to the arguments of
10773 `set-input-mode'. */)
10776 struct frame
*sf
= XFRAME (selected_frame
);
10778 Lisp_Object interrupt
= interrupt_input
? Qt
: Qnil
;
10779 Lisp_Object flow
, meta
;
10780 if (FRAME_TERMCAP_P (sf
) || FRAME_MSDOS_P (sf
))
10782 flow
= FRAME_TTY (sf
)->flow_control
? Qt
: Qnil
;
10783 meta
= (FRAME_TTY (sf
)->meta_key
== 2
10785 : (CURTTY ()->meta_key
== 1 ? Qt
: Qnil
));
10792 Lisp_Object quit
= make_number (quit_char
);
10794 return list4 (interrupt
, flow
, meta
, quit
);
10797 DEFUN ("posn-at-x-y", Fposn_at_x_y
, Sposn_at_x_y
, 2, 4, 0,
10798 doc
: /* Return position information for pixel coordinates X and Y.
10799 By default, X and Y are relative to text area of the selected window.
10800 Optional third arg FRAME-OR-WINDOW non-nil specifies frame or window.
10801 If optional fourth arg WHOLE is non-nil, X is relative to the left
10802 edge of the window.
10804 The return value is similar to a mouse click position:
10805 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
10806 IMAGE (DX . DY) (WIDTH . HEIGHT))
10807 The `posn-' functions access elements of such lists. */)
10808 (Lisp_Object x
, Lisp_Object y
, Lisp_Object frame_or_window
, Lisp_Object whole
)
10811 /* We allow X of -1, for the newline in a R2L line that overflowed
10812 into the left fringe. */
10813 if (XINT (x
) != -1)
10817 if (NILP (frame_or_window
))
10818 frame_or_window
= selected_window
;
10820 if (WINDOWP (frame_or_window
))
10822 struct window
*w
= decode_live_window (frame_or_window
);
10824 XSETINT (x
, (XINT (x
)
10825 + WINDOW_LEFT_EDGE_X (w
)
10827 ? window_box_left_offset (w
, TEXT_AREA
)
10829 XSETINT (y
, WINDOW_TO_FRAME_PIXEL_Y (w
, XINT (y
)));
10830 frame_or_window
= w
->frame
;
10833 CHECK_LIVE_FRAME (frame_or_window
);
10835 return make_lispy_position (XFRAME (frame_or_window
), x
, y
, 0);
10838 DEFUN ("posn-at-point", Fposn_at_point
, Sposn_at_point
, 0, 2, 0,
10839 doc
: /* Return position information for buffer POS in WINDOW.
10840 POS defaults to point in WINDOW; WINDOW defaults to the selected window.
10842 Return nil if position is not visible in window. Otherwise,
10843 the return value is similar to that returned by `event-start' for
10844 a mouse click at the upper left corner of the glyph corresponding
10845 to the given buffer position:
10846 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
10847 IMAGE (DX . DY) (WIDTH . HEIGHT))
10848 The `posn-' functions access elements of such lists. */)
10849 (Lisp_Object pos
, Lisp_Object window
)
10854 window
= selected_window
;
10856 tem
= Fpos_visible_in_window_p (pos
, window
, Qt
);
10859 Lisp_Object x
= XCAR (tem
);
10860 Lisp_Object y
= XCAR (XCDR (tem
));
10862 /* Point invisible due to hscrolling? X can be -1 when a
10863 newline in a R2L line overflows into the left fringe. */
10866 tem
= Fposn_at_x_y (x
, y
, window
, Qnil
);
10872 /* Set up a new kboard object with reasonable initial values.
10873 TYPE is a window system for which this keyboard is used. */
10876 init_kboard (KBOARD
*kb
, Lisp_Object type
)
10878 kset_overriding_terminal_local_map (kb
, Qnil
);
10879 kset_last_command (kb
, Qnil
);
10880 kset_real_last_command (kb
, Qnil
);
10881 kset_keyboard_translate_table (kb
, Qnil
);
10882 kset_last_repeatable_command (kb
, Qnil
);
10883 kset_prefix_arg (kb
, Qnil
);
10884 kset_last_prefix_arg (kb
, Qnil
);
10885 kset_kbd_queue (kb
, Qnil
);
10886 kb
->kbd_queue_has_data
= 0;
10887 kb
->immediate_echo
= 0;
10888 kset_echo_string (kb
, Qnil
);
10889 kb
->echo_after_prompt
= -1;
10890 kb
->kbd_macro_buffer
= 0;
10891 kb
->kbd_macro_bufsize
= 0;
10892 kset_defining_kbd_macro (kb
, Qnil
);
10893 kset_last_kbd_macro (kb
, Qnil
);
10894 kb
->reference_count
= 0;
10895 kset_system_key_alist (kb
, Qnil
);
10896 kset_system_key_syms (kb
, Qnil
);
10897 kset_window_system (kb
, type
);
10898 kset_input_decode_map (kb
, Fmake_sparse_keymap (Qnil
));
10899 kset_local_function_key_map (kb
, Fmake_sparse_keymap (Qnil
));
10900 Fset_keymap_parent (KVAR (kb
, Vlocal_function_key_map
), Vfunction_key_map
);
10901 kset_default_minibuffer_frame (kb
, Qnil
);
10904 /* Allocate and basically initialize keyboard
10905 object to use with window system TYPE. */
10908 allocate_kboard (Lisp_Object type
)
10910 KBOARD
*kb
= xmalloc (sizeof *kb
);
10912 init_kboard (kb
, type
);
10913 kb
->next_kboard
= all_kboards
;
10919 * Destroy the contents of a kboard object, but not the object itself.
10920 * We use this just before deleting it, or if we're going to initialize
10921 * it a second time.
10924 wipe_kboard (KBOARD
*kb
)
10926 xfree (kb
->kbd_macro_buffer
);
10929 /* Free KB and memory referenced from it. */
10932 delete_kboard (KBOARD
*kb
)
10936 for (kbp
= &all_kboards
; *kbp
!= kb
; kbp
= &(*kbp
)->next_kboard
)
10939 *kbp
= kb
->next_kboard
;
10941 /* Prevent a dangling reference to KB. */
10942 if (kb
== current_kboard
10943 && FRAMEP (selected_frame
)
10944 && FRAME_LIVE_P (XFRAME (selected_frame
)))
10946 current_kboard
= FRAME_KBOARD (XFRAME (selected_frame
));
10948 if (current_kboard
== kb
)
10957 init_keyboard (void)
10959 /* This is correct before outermost invocation of the editor loop. */
10960 command_loop_level
= -1;
10961 immediate_quit
= 0;
10962 quit_char
= Ctl ('g');
10963 Vunread_command_events
= Qnil
;
10964 timer_idleness_start_time
= invalid_timespec ();
10966 recent_keys_index
= 0;
10967 kbd_fetch_ptr
= kbd_buffer
;
10968 kbd_store_ptr
= kbd_buffer
;
10969 do_mouse_tracking
= Qnil
;
10971 interrupt_input_blocked
= 0;
10972 pending_signals
= 0;
10974 /* This means that command_loop_1 won't try to select anything the first
10976 internal_last_event_frame
= Qnil
;
10977 Vlast_event_frame
= internal_last_event_frame
;
10979 current_kboard
= initial_kboard
;
10980 /* Re-initialize the keyboard again. */
10981 wipe_kboard (current_kboard
);
10982 /* A value of nil for Vwindow_system normally means a tty, but we also use
10983 it for the initial terminal since there is no window system there. */
10984 init_kboard (current_kboard
, Qnil
);
10986 if (!noninteractive
)
10988 /* Before multi-tty support, these handlers used to be installed
10989 only if the current session was a tty session. Now an Emacs
10990 session may have multiple display types, so we always handle
10991 SIGINT. There is special code in handle_interrupt_signal to exit
10992 Emacs on SIGINT when there are no termcap frames on the
10993 controlling terminal. */
10994 struct sigaction action
;
10995 emacs_sigaction_init (&action
, deliver_interrupt_signal
);
10996 sigaction (SIGINT
, &action
, 0);
10998 /* For systems with SysV TERMIO, C-g is set up for both SIGINT and
10999 SIGQUIT and we can't tell which one it will give us. */
11000 sigaction (SIGQUIT
, &action
, 0);
11001 #endif /* not DOS_NT */
11003 #ifdef USABLE_SIGIO
11004 if (!noninteractive
)
11006 struct sigaction action
;
11007 emacs_sigaction_init (&action
, deliver_input_available_signal
);
11008 sigaction (SIGIO
, &action
, 0);
11012 /* Use interrupt input by default, if it works and noninterrupt input
11013 has deficiencies. */
11015 #ifdef INTERRUPT_INPUT
11016 interrupt_input
= 1;
11018 interrupt_input
= 0;
11021 pthread_sigmask (SIG_SETMASK
, &empty_mask
, 0);
11024 if (keyboard_init_hook
)
11025 (*keyboard_init_hook
) ();
11027 #ifdef POLL_FOR_INPUT
11029 poll_suppress_count
= 1;
11034 /* This type's only use is in syms_of_keyboard, to put properties on the
11035 event header symbols. */
11042 static const struct event_head head_table
[] = {
11043 {SYMBOL_INDEX (Qmouse_movement
), SYMBOL_INDEX (Qmouse_movement
)},
11044 {SYMBOL_INDEX (Qscroll_bar_movement
), SYMBOL_INDEX (Qmouse_movement
)},
11046 /* Some of the event heads. */
11047 {SYMBOL_INDEX (Qswitch_frame
), SYMBOL_INDEX (Qswitch_frame
)},
11049 {SYMBOL_INDEX (Qfocus_in
), SYMBOL_INDEX (Qfocus_in
)},
11050 {SYMBOL_INDEX (Qfocus_out
), SYMBOL_INDEX (Qfocus_out
)},
11051 {SYMBOL_INDEX (Qdelete_frame
), SYMBOL_INDEX (Qdelete_frame
)},
11052 {SYMBOL_INDEX (Qiconify_frame
), SYMBOL_INDEX (Qiconify_frame
)},
11053 {SYMBOL_INDEX (Qmake_frame_visible
), SYMBOL_INDEX (Qmake_frame_visible
)},
11054 /* `select-window' should be handled just like `switch-frame'
11055 in read_key_sequence. */
11056 {SYMBOL_INDEX (Qselect_window
), SYMBOL_INDEX (Qswitch_frame
)}
11060 syms_of_keyboard (void)
11062 pending_funcalls
= Qnil
;
11063 staticpro (&pending_funcalls
);
11065 Vlispy_mouse_stem
= build_pure_c_string ("mouse");
11066 staticpro (&Vlispy_mouse_stem
);
11068 regular_top_level_message
= build_pure_c_string ("Back to top level");
11069 #ifdef HAVE_STACK_OVERFLOW_HANDLING
11070 recover_top_level_message
11071 = build_pure_c_string ("Re-entering top level after C stack overflow");
11073 DEFVAR_LISP ("internal--top-level-message", Vinternal__top_level_message
,
11074 doc
: /* Message displayed by `normal-top-level'. */);
11075 Vinternal__top_level_message
= regular_top_level_message
;
11078 DEFSYM (QCimage
, ":image");
11079 DEFSYM (Qhelp_echo
, "help-echo");
11080 DEFSYM (QCrtl
, ":rtl");
11082 staticpro (&item_properties
);
11083 item_properties
= Qnil
;
11085 staticpro (&tool_bar_item_properties
);
11086 tool_bar_item_properties
= Qnil
;
11087 staticpro (&tool_bar_items_vector
);
11088 tool_bar_items_vector
= Qnil
;
11090 DEFSYM (Qtimer_event_handler
, "timer-event-handler");
11092 /* Non-nil disable property on a command means do not execute it;
11093 call disabled-command-function's value instead. */
11094 DEFSYM (Qdisabled
, "disabled");
11096 DEFSYM (Qundefined
, "undefined");
11098 /* Hooks to run before and after each command. */
11099 DEFSYM (Qpre_command_hook
, "pre-command-hook");
11100 DEFSYM (Qpost_command_hook
, "post-command-hook");
11102 DEFSYM (Qdeferred_action_function
, "deferred-action-function");
11103 DEFSYM (Qdelayed_warnings_hook
, "delayed-warnings-hook");
11104 DEFSYM (Qfunction_key
, "function-key");
11106 /* The values of Qevent_kind properties. */
11107 DEFSYM (Qmouse_click
, "mouse-click");
11109 DEFSYM (Qdrag_n_drop
, "drag-n-drop");
11110 DEFSYM (Qsave_session
, "save-session");
11111 DEFSYM (Qconfig_changed_event
, "config-changed-event");
11113 /* Menu and tool bar item parts. */
11114 DEFSYM (Qmenu_enable
, "menu-enable");
11117 DEFSYM (Qlanguage_change
, "language-change");
11121 DEFSYM (Qdbus_event
, "dbus-event");
11124 #ifdef USE_FILE_NOTIFY
11125 DEFSYM (Qfile_notify
, "file-notify");
11126 #endif /* USE_FILE_NOTIFY */
11128 /* Menu and tool bar item parts. */
11129 DEFSYM (QCenable
, ":enable");
11130 DEFSYM (QCvisible
, ":visible");
11131 DEFSYM (QChelp
, ":help");
11132 DEFSYM (QCfilter
, ":filter");
11133 DEFSYM (QCbutton
, ":button");
11134 DEFSYM (QCkeys
, ":keys");
11135 DEFSYM (QCkey_sequence
, ":key-sequence");
11137 /* Non-nil disable property on a command means
11138 do not execute it; call disabled-command-function's value instead. */
11139 DEFSYM (QCtoggle
, ":toggle");
11140 DEFSYM (QCradio
, ":radio");
11141 DEFSYM (QClabel
, ":label");
11142 DEFSYM (QCvert_only
, ":vert-only");
11144 /* Symbols to use for parts of windows. */
11145 DEFSYM (Qvertical_line
, "vertical-line");
11146 DEFSYM (Qright_divider
, "right-divider");
11147 DEFSYM (Qbottom_divider
, "bottom-divider");
11149 DEFSYM (Qmouse_fixup_help_message
, "mouse-fixup-help-message");
11151 DEFSYM (Qabove_handle
, "above-handle");
11152 DEFSYM (Qhandle
, "handle");
11153 DEFSYM (Qbelow_handle
, "below-handle");
11154 DEFSYM (Qup
, "up");
11155 DEFSYM (Qdown
, "down");
11156 DEFSYM (Qtop
, "top");
11157 DEFSYM (Qbottom
, "bottom");
11158 DEFSYM (Qend_scroll
, "end-scroll");
11159 DEFSYM (Qratio
, "ratio");
11160 DEFSYM (Qbefore_handle
, "before-handle");
11161 DEFSYM (Qhorizontal_handle
, "horizontal-handle");
11162 DEFSYM (Qafter_handle
, "after-handle");
11163 DEFSYM (Qleft
, "left");
11164 DEFSYM (Qright
, "right");
11165 DEFSYM (Qleftmost
, "leftmost");
11166 DEFSYM (Qrightmost
, "rightmost");
11168 /* Properties of event headers. */
11169 DEFSYM (Qevent_kind
, "event-kind");
11170 DEFSYM (Qevent_symbol_elements
, "event-symbol-elements");
11172 /* An event header symbol HEAD may have a property named
11173 Qevent_symbol_element_mask, which is of the form (BASE MODIFIERS);
11174 BASE is the base, unmodified version of HEAD, and MODIFIERS is the
11175 mask of modifiers applied to it. If present, this is used to help
11176 speed up parse_modifiers. */
11177 DEFSYM (Qevent_symbol_element_mask
, "event-symbol-element-mask");
11179 /* An unmodified event header BASE may have a property named
11180 Qmodifier_cache, which is an alist mapping modifier masks onto
11181 modified versions of BASE. If present, this helps speed up
11182 apply_modifiers. */
11183 DEFSYM (Qmodifier_cache
, "modifier-cache");
11185 DEFSYM (Qrecompute_lucid_menubar
, "recompute-lucid-menubar");
11186 DEFSYM (Qactivate_menubar_hook
, "activate-menubar-hook");
11188 DEFSYM (Qpolling_period
, "polling-period");
11190 DEFSYM (Qgui_set_selection
, "gui-set-selection");
11192 /* The primary selection. */
11193 DEFSYM (QPRIMARY
, "PRIMARY");
11195 DEFSYM (Qhandle_switch_frame
, "handle-switch-frame");
11196 DEFSYM (Qhandle_select_window
, "handle-select-window");
11198 DEFSYM (Qinput_method_exit_on_first_char
, "input-method-exit-on-first-char");
11199 DEFSYM (Qinput_method_use_echo_area
, "input-method-use-echo-area");
11201 DEFSYM (Qhelp_form_show
, "help-form-show");
11203 DEFSYM (Qecho_keystrokes
, "echo-keystrokes");
11205 Fset (Qinput_method_exit_on_first_char
, Qnil
);
11206 Fset (Qinput_method_use_echo_area
, Qnil
);
11208 /* Symbols to head events. */
11209 DEFSYM (Qmouse_movement
, "mouse-movement");
11210 DEFSYM (Qscroll_bar_movement
, "scroll-bar-movement");
11211 DEFSYM (Qswitch_frame
, "switch-frame");
11212 DEFSYM (Qfocus_in
, "focus-in");
11213 DEFSYM (Qfocus_out
, "focus-out");
11214 DEFSYM (Qdelete_frame
, "delete-frame");
11215 DEFSYM (Qiconify_frame
, "iconify-frame");
11216 DEFSYM (Qmake_frame_visible
, "make-frame-visible");
11217 DEFSYM (Qselect_window
, "select-window");
11221 for (i
= 0; i
< ARRAYELTS (head_table
); i
++)
11223 const struct event_head
*p
= &head_table
[i
];
11224 Lisp_Object var
= builtin_lisp_symbol (p
->var
);
11225 Lisp_Object kind
= builtin_lisp_symbol (p
->kind
);
11226 Fput (var
, Qevent_kind
, kind
);
11227 Fput (var
, Qevent_symbol_elements
, list1 (var
));
11231 button_down_location
= Fmake_vector (make_number (5), Qnil
);
11232 staticpro (&button_down_location
);
11233 mouse_syms
= Fmake_vector (make_number (5), Qnil
);
11234 staticpro (&mouse_syms
);
11235 wheel_syms
= Fmake_vector (make_number (ARRAYELTS (lispy_wheel_names
)),
11237 staticpro (&wheel_syms
);
11241 int len
= ARRAYELTS (modifier_names
);
11243 modifier_symbols
= Fmake_vector (make_number (len
), Qnil
);
11244 for (i
= 0; i
< len
; i
++)
11245 if (modifier_names
[i
])
11246 ASET (modifier_symbols
, i
, intern_c_string (modifier_names
[i
]));
11247 staticpro (&modifier_symbols
);
11250 recent_keys
= Fmake_vector (make_number (NUM_RECENT_KEYS
), Qnil
);
11251 staticpro (&recent_keys
);
11253 this_command_keys
= Fmake_vector (make_number (40), Qnil
);
11254 staticpro (&this_command_keys
);
11256 raw_keybuf
= Fmake_vector (make_number (30), Qnil
);
11257 staticpro (&raw_keybuf
);
11259 DEFSYM (Qcommand_execute
, "command-execute");
11261 accent_key_syms
= Qnil
;
11262 staticpro (&accent_key_syms
);
11264 func_key_syms
= Qnil
;
11265 staticpro (&func_key_syms
);
11267 drag_n_drop_syms
= Qnil
;
11268 staticpro (&drag_n_drop_syms
);
11270 unread_switch_frame
= Qnil
;
11271 staticpro (&unread_switch_frame
);
11273 internal_last_event_frame
= Qnil
;
11274 staticpro (&internal_last_event_frame
);
11276 read_key_sequence_cmd
= Qnil
;
11277 staticpro (&read_key_sequence_cmd
);
11278 read_key_sequence_remapped
= Qnil
;
11279 staticpro (&read_key_sequence_remapped
);
11281 menu_bar_one_keymap_changed_items
= Qnil
;
11282 staticpro (&menu_bar_one_keymap_changed_items
);
11284 menu_bar_items_vector
= Qnil
;
11285 staticpro (&menu_bar_items_vector
);
11287 help_form_saved_window_configs
= Qnil
;
11288 staticpro (&help_form_saved_window_configs
);
11290 defsubr (&Scurrent_idle_time
);
11291 defsubr (&Sevent_symbol_parse_modifiers
);
11292 defsubr (&Sevent_convert_list
);
11293 defsubr (&Sread_key_sequence
);
11294 defsubr (&Sread_key_sequence_vector
);
11295 defsubr (&Srecursive_edit
);
11296 defsubr (&Strack_mouse
);
11297 defsubr (&Sinput_pending_p
);
11298 defsubr (&Srecent_keys
);
11299 defsubr (&Sthis_command_keys
);
11300 defsubr (&Sthis_command_keys_vector
);
11301 defsubr (&Sthis_single_command_keys
);
11302 defsubr (&Sthis_single_command_raw_keys
);
11303 defsubr (&Sreset_this_command_lengths
);
11304 defsubr (&Sclear_this_command_keys
);
11305 defsubr (&Ssuspend_emacs
);
11306 defsubr (&Sabort_recursive_edit
);
11307 defsubr (&Sexit_recursive_edit
);
11308 defsubr (&Srecursion_depth
);
11309 defsubr (&Scommand_error_default_function
);
11310 defsubr (&Stop_level
);
11311 defsubr (&Sdiscard_input
);
11312 defsubr (&Sopen_dribble_file
);
11313 defsubr (&Sset_input_interrupt_mode
);
11314 defsubr (&Sset_output_flow_control
);
11315 defsubr (&Sset_input_meta_mode
);
11316 defsubr (&Sset_quit_char
);
11317 defsubr (&Sset_input_mode
);
11318 defsubr (&Scurrent_input_mode
);
11319 defsubr (&Sposn_at_point
);
11320 defsubr (&Sposn_at_x_y
);
11322 DEFVAR_LISP ("last-command-event", last_command_event
,
11323 doc
: /* Last input event that was part of a command. */);
11325 DEFVAR_LISP ("last-nonmenu-event", last_nonmenu_event
,
11326 doc
: /* Last input event in a command, except for mouse menu events.
11327 Mouse menus give back keys that don't look like mouse events;
11328 this variable holds the actual mouse event that led to the menu,
11329 so that you can determine whether the command was run by mouse or not. */);
11331 DEFVAR_LISP ("last-input-event", last_input_event
,
11332 doc
: /* Last input event. */);
11334 DEFVAR_LISP ("unread-command-events", Vunread_command_events
,
11335 doc
: /* List of events to be read as the command input.
11336 These events are processed first, before actual keyboard input.
11337 Events read from this list are not normally added to `this-command-keys',
11338 as they will already have been added once as they were read for the first time.
11339 An element of the form (t . EVENT) forces EVENT to be added to that list. */);
11340 Vunread_command_events
= Qnil
;
11342 DEFVAR_LISP ("unread-post-input-method-events", Vunread_post_input_method_events
,
11343 doc
: /* List of events to be processed as input by input methods.
11344 These events are processed before `unread-command-events'
11345 and actual keyboard input, but are not given to `input-method-function'. */);
11346 Vunread_post_input_method_events
= Qnil
;
11348 DEFVAR_LISP ("unread-input-method-events", Vunread_input_method_events
,
11349 doc
: /* List of events to be processed as input by input methods.
11350 These events are processed after `unread-command-events', but
11351 before actual keyboard input.
11352 If there's an active input method, the events are given to
11353 `input-method-function'. */);
11354 Vunread_input_method_events
= Qnil
;
11356 DEFVAR_LISP ("meta-prefix-char", meta_prefix_char
,
11357 doc
: /* Meta-prefix character code.
11358 Meta-foo as command input turns into this character followed by foo. */);
11359 XSETINT (meta_prefix_char
, 033);
11361 DEFVAR_KBOARD ("last-command", Vlast_command
,
11362 doc
: /* The last command executed.
11363 Normally a symbol with a function definition, but can be whatever was found
11364 in the keymap, or whatever the variable `this-command' was set to by that
11367 The value `mode-exit' is special; it means that the previous command
11368 read an event that told it to exit, and it did so and unread that event.
11369 In other words, the present command is the event that made the previous
11372 The value `kill-region' is special; it means that the previous command
11373 was a kill command.
11375 `last-command' has a separate binding for each terminal device.
11376 See Info node `(elisp)Multiple Terminals'. */);
11378 DEFVAR_KBOARD ("real-last-command", Vreal_last_command
,
11379 doc
: /* Same as `last-command', but never altered by Lisp code.
11380 Taken from the previous value of `real-this-command'. */);
11382 DEFVAR_KBOARD ("last-repeatable-command", Vlast_repeatable_command
,
11383 doc
: /* Last command that may be repeated.
11384 The last command executed that was not bound to an input event.
11385 This is the command `repeat' will try to repeat.
11386 Taken from a previous value of `real-this-command'. */);
11388 DEFVAR_LISP ("this-command", Vthis_command
,
11389 doc
: /* The command now being executed.
11390 The command can set this variable; whatever is put here
11391 will be in `last-command' during the following command. */);
11392 Vthis_command
= Qnil
;
11394 DEFVAR_LISP ("real-this-command", Vreal_this_command
,
11395 doc
: /* This is like `this-command', except that commands should never modify it. */);
11396 Vreal_this_command
= Qnil
;
11398 DEFVAR_LISP ("this-command-keys-shift-translated",
11399 Vthis_command_keys_shift_translated
,
11400 doc
: /* Non-nil if the key sequence activating this command was shift-translated.
11401 Shift-translation occurs when there is no binding for the key sequence
11402 as entered, but a binding was found by changing an upper-case letter
11403 to lower-case, or a shifted function key to an unshifted one. */);
11404 Vthis_command_keys_shift_translated
= Qnil
;
11406 DEFVAR_LISP ("this-original-command", Vthis_original_command
,
11407 doc
: /* The command bound to the current key sequence before remapping.
11408 It equals `this-command' if the original command was not remapped through
11409 any of the active keymaps. Otherwise, the value of `this-command' is the
11410 result of looking up the original command in the active keymaps. */);
11411 Vthis_original_command
= Qnil
;
11413 DEFVAR_INT ("auto-save-interval", auto_save_interval
,
11414 doc
: /* Number of input events between auto-saves.
11415 Zero means disable autosaving due to number of characters typed. */);
11416 auto_save_interval
= 300;
11418 DEFVAR_LISP ("auto-save-timeout", Vauto_save_timeout
,
11419 doc
: /* Number of seconds idle time before auto-save.
11420 Zero or nil means disable auto-saving due to idleness.
11421 After auto-saving due to this many seconds of idle time,
11422 Emacs also does a garbage collection if that seems to be warranted. */);
11423 XSETFASTINT (Vauto_save_timeout
, 30);
11425 DEFVAR_LISP ("echo-keystrokes", Vecho_keystrokes
,
11426 doc
: /* Nonzero means echo unfinished commands after this many seconds of pause.
11427 The value may be integer or floating point.
11428 If the value is zero, don't echo at all. */);
11429 Vecho_keystrokes
= make_number (1);
11431 DEFVAR_INT ("polling-period", polling_period
,
11432 doc
: /* Interval between polling for input during Lisp execution.
11433 The reason for polling is to make C-g work to stop a running program.
11434 Polling is needed only when using X windows and SIGIO does not work.
11435 Polling is automatically disabled in all other cases. */);
11436 polling_period
= 2;
11438 DEFVAR_LISP ("double-click-time", Vdouble_click_time
,
11439 doc
: /* Maximum time between mouse clicks to make a double-click.
11440 Measured in milliseconds. The value nil means disable double-click
11441 recognition; t means double-clicks have no time limit and are detected
11442 by position only. */);
11443 Vdouble_click_time
= make_number (500);
11445 DEFVAR_INT ("double-click-fuzz", double_click_fuzz
,
11446 doc
: /* Maximum mouse movement between clicks to make a double-click.
11447 On window-system frames, value is the number of pixels the mouse may have
11448 moved horizontally or vertically between two clicks to make a double-click.
11449 On non window-system frames, value is interpreted in units of 1/8 characters
11452 This variable is also the threshold for motion of the mouse
11453 to count as a drag. */);
11454 double_click_fuzz
= 3;
11456 DEFVAR_INT ("num-input-keys", num_input_keys
,
11457 doc
: /* Number of complete key sequences read as input so far.
11458 This includes key sequences read from keyboard macros.
11459 The number is effectively the number of interactive command invocations. */);
11460 num_input_keys
= 0;
11462 DEFVAR_INT ("num-nonmacro-input-events", num_nonmacro_input_events
,
11463 doc
: /* Number of input events read from the keyboard so far.
11464 This does not include events generated by keyboard macros. */);
11465 num_nonmacro_input_events
= 0;
11467 DEFVAR_LISP ("last-event-frame", Vlast_event_frame
,
11468 doc
: /* The frame in which the most recently read event occurred.
11469 If the last event came from a keyboard macro, this is set to `macro'. */);
11470 Vlast_event_frame
= Qnil
;
11472 /* This variable is set up in sysdep.c. */
11473 DEFVAR_LISP ("tty-erase-char", Vtty_erase_char
,
11474 doc
: /* The ERASE character as set by the user with stty. */);
11476 DEFVAR_LISP ("help-char", Vhelp_char
,
11477 doc
: /* Character to recognize as meaning Help.
11478 When it is read, do `(eval help-form)', and display result if it's a string.
11479 If the value of `help-form' is nil, this char can be read normally. */);
11480 XSETINT (Vhelp_char
, Ctl ('H'));
11482 DEFVAR_LISP ("help-event-list", Vhelp_event_list
,
11483 doc
: /* List of input events to recognize as meaning Help.
11484 These work just like the value of `help-char' (see that). */);
11485 Vhelp_event_list
= Qnil
;
11487 DEFVAR_LISP ("help-form", Vhelp_form
,
11488 doc
: /* Form to execute when character `help-char' is read.
11489 If the form returns a string, that string is displayed.
11490 If `help-form' is nil, the help char is not recognized. */);
11493 DEFVAR_LISP ("prefix-help-command", Vprefix_help_command
,
11494 doc
: /* Command to run when `help-char' character follows a prefix key.
11495 This command is used only when there is no actual binding
11496 for that character after that prefix key. */);
11497 Vprefix_help_command
= Qnil
;
11499 DEFVAR_LISP ("top-level", Vtop_level
,
11500 doc
: /* Form to evaluate when Emacs starts up.
11501 Useful to set before you dump a modified Emacs. */);
11503 XSYMBOL (Qtop_level
)->declared_special
= false;
11505 DEFVAR_KBOARD ("keyboard-translate-table", Vkeyboard_translate_table
,
11506 doc
: /* Translate table for local keyboard input, or nil.
11507 If non-nil, the value should be a char-table. Each character read
11508 from the keyboard is looked up in this char-table. If the value found
11509 there is non-nil, then it is used instead of the actual input character.
11511 The value can also be a string or vector, but this is considered obsolete.
11512 If it is a string or vector of length N, character codes N and up are left
11513 untranslated. In a vector, an element which is nil means "no translation".
11515 This is applied to the characters supplied to input methods, not their
11516 output. See also `translation-table-for-input'.
11518 This variable has a separate binding for each terminal.
11519 See Info node `(elisp)Multiple Terminals'. */);
11521 DEFVAR_BOOL ("cannot-suspend", cannot_suspend
,
11522 doc
: /* Non-nil means to always spawn a subshell instead of suspending.
11523 \(Even if the operating system has support for stopping a process.\) */);
11524 cannot_suspend
= 0;
11526 DEFVAR_BOOL ("menu-prompting", menu_prompting
,
11527 doc
: /* Non-nil means prompt with menus when appropriate.
11528 This is done when reading from a keymap that has a prompt string,
11529 for elements that have prompt strings.
11530 The menu is displayed on the screen
11531 if X menus were enabled at configuration
11532 time and the previous event was a mouse click prefix key.
11533 Otherwise, menu prompting uses the echo area. */);
11534 menu_prompting
= 1;
11536 DEFVAR_LISP ("menu-prompt-more-char", menu_prompt_more_char
,
11537 doc
: /* Character to see next line of menu prompt.
11538 Type this character while in a menu prompt to rotate around the lines of it. */);
11539 XSETINT (menu_prompt_more_char
, ' ');
11541 DEFVAR_INT ("extra-keyboard-modifiers", extra_keyboard_modifiers
,
11542 doc
: /* A mask of additional modifier keys to use with every keyboard character.
11543 Emacs applies the modifiers of the character stored here to each keyboard
11544 character it reads. For example, after evaluating the expression
11545 (setq extra-keyboard-modifiers ?\\C-x)
11546 all input characters will have the control modifier applied to them.
11548 Note that the character ?\\C-@, equivalent to the integer zero, does
11549 not count as a control character; rather, it counts as a character
11550 with no modifiers; thus, setting `extra-keyboard-modifiers' to zero
11551 cancels any modification. */);
11552 extra_keyboard_modifiers
= 0;
11554 DEFSYM (Qdeactivate_mark
, "deactivate-mark");
11555 DEFVAR_LISP ("deactivate-mark", Vdeactivate_mark
,
11556 doc
: /* If an editing command sets this to t, deactivate the mark afterward.
11557 The command loop sets this to nil before each command,
11558 and tests the value when the command returns.
11559 Buffer modification stores t in this variable. */);
11560 Vdeactivate_mark
= Qnil
;
11561 Fmake_variable_buffer_local (Qdeactivate_mark
);
11563 DEFVAR_LISP ("pre-command-hook", Vpre_command_hook
,
11564 doc
: /* Normal hook run before each command is executed.
11565 If an unhandled error happens in running this hook,
11566 the function in which the error occurred is unconditionally removed, since
11567 otherwise the error might happen repeatedly and make Emacs nonfunctional. */);
11568 Vpre_command_hook
= Qnil
;
11570 DEFVAR_LISP ("post-command-hook", Vpost_command_hook
,
11571 doc
: /* Normal hook run after each command is executed.
11572 If an unhandled error happens in running this hook,
11573 the function in which the error occurred is unconditionally removed, since
11574 otherwise the error might happen repeatedly and make Emacs nonfunctional. */);
11575 Vpost_command_hook
= Qnil
;
11578 DEFVAR_LISP ("echo-area-clear-hook", ...,
11579 doc
: /* Normal hook run when clearing the echo area. */);
11581 DEFSYM (Qecho_area_clear_hook
, "echo-area-clear-hook");
11582 Fset (Qecho_area_clear_hook
, Qnil
);
11584 DEFVAR_LISP ("lucid-menu-bar-dirty-flag", Vlucid_menu_bar_dirty_flag
,
11585 doc
: /* Non-nil means menu bar, specified Lucid style, needs to be recomputed. */);
11586 Vlucid_menu_bar_dirty_flag
= Qnil
;
11588 DEFVAR_LISP ("menu-bar-final-items", Vmenu_bar_final_items
,
11589 doc
: /* List of menu bar items to move to the end of the menu bar.
11590 The elements of the list are event types that may have menu bar bindings. */);
11591 Vmenu_bar_final_items
= Qnil
;
11593 DEFVAR_LISP ("tool-bar-separator-image-expression", Vtool_bar_separator_image_expression
,
11594 doc
: /* Expression evaluating to the image spec for a tool-bar separator.
11595 This is used internally by graphical displays that do not render
11596 tool-bar separators natively. Otherwise it is unused (e.g. on GTK). */);
11597 Vtool_bar_separator_image_expression
= Qnil
;
11599 DEFVAR_KBOARD ("overriding-terminal-local-map",
11600 Voverriding_terminal_local_map
,
11601 doc
: /* Per-terminal keymap that takes precedence over all other keymaps.
11602 This variable is intended to let commands such as `universal-argument'
11603 set up a different keymap for reading the next command.
11605 `overriding-terminal-local-map' has a separate binding for each
11606 terminal device. See Info node `(elisp)Multiple Terminals'. */);
11608 DEFVAR_LISP ("overriding-local-map", Voverriding_local_map
,
11609 doc
: /* Keymap that replaces (overrides) local keymaps.
11610 If this variable is non-nil, Emacs looks up key bindings in this
11611 keymap INSTEAD OF the keymap char property, minor mode maps, and the
11612 buffer's local map. Hence, the only active keymaps would be
11613 `overriding-terminal-local-map', this keymap, and `global-keymap', in
11614 order of precedence. */);
11615 Voverriding_local_map
= Qnil
;
11617 DEFVAR_LISP ("overriding-local-map-menu-flag", Voverriding_local_map_menu_flag
,
11618 doc
: /* Non-nil means `overriding-local-map' applies to the menu bar.
11619 Otherwise, the menu bar continues to reflect the buffer's local map
11620 and the minor mode maps regardless of `overriding-local-map'. */);
11621 Voverriding_local_map_menu_flag
= Qnil
;
11623 DEFVAR_LISP ("special-event-map", Vspecial_event_map
,
11624 doc
: /* Keymap defining bindings for special events to execute at low level. */);
11625 Vspecial_event_map
= list1 (Qkeymap
);
11627 DEFVAR_LISP ("track-mouse", do_mouse_tracking
,
11628 doc
: /* Non-nil means generate motion events for mouse motion. */);
11630 DEFVAR_KBOARD ("system-key-alist", Vsystem_key_alist
,
11631 doc
: /* Alist of system-specific X windows key symbols.
11632 Each element should have the form (N . SYMBOL) where N is the
11633 numeric keysym code (sans the \"system-specific\" bit 1<<28)
11634 and SYMBOL is its name.
11636 `system-key-alist' has a separate binding for each terminal device.
11637 See Info node `(elisp)Multiple Terminals'. */);
11639 DEFVAR_KBOARD ("local-function-key-map", Vlocal_function_key_map
,
11640 doc
: /* Keymap that translates key sequences to key sequences during input.
11641 This is used mainly for mapping key sequences into some preferred
11642 key events (symbols).
11644 The `read-key-sequence' function replaces any subsequence bound by
11645 `local-function-key-map' with its binding. More precisely, when the
11646 active keymaps have no binding for the current key sequence but
11647 `local-function-key-map' binds a suffix of the sequence to a vector or
11648 string, `read-key-sequence' replaces the matching suffix with its
11649 binding, and continues with the new sequence.
11651 If the binding is a function, it is called with one argument (the prompt)
11652 and its return value (a key sequence) is used.
11654 The events that come from bindings in `local-function-key-map' are not
11655 themselves looked up in `local-function-key-map'.
11657 For example, suppose `local-function-key-map' binds `ESC O P' to [f1].
11658 Typing `ESC O P' to `read-key-sequence' would return [f1]. Typing
11659 `C-x ESC O P' would return [?\\C-x f1]. If [f1] were a prefix key,
11660 typing `ESC O P x' would return [f1 x].
11662 `local-function-key-map' has a separate binding for each terminal
11663 device. See Info node `(elisp)Multiple Terminals'. If you need to
11664 define a binding on all terminals, change `function-key-map'
11665 instead. Initially, `local-function-key-map' is an empty keymap that
11666 has `function-key-map' as its parent on all terminal devices. */);
11668 DEFVAR_KBOARD ("input-decode-map", Vinput_decode_map
,
11669 doc
: /* Keymap that decodes input escape sequences.
11670 This is used mainly for mapping ASCII function key sequences into
11671 real Emacs function key events (symbols).
11673 The `read-key-sequence' function replaces any subsequence bound by
11674 `input-decode-map' with its binding. Contrary to `function-key-map',
11675 this map applies its rebinding regardless of the presence of an ordinary
11676 binding. So it is more like `key-translation-map' except that it applies
11677 before `function-key-map' rather than after.
11679 If the binding is a function, it is called with one argument (the prompt)
11680 and its return value (a key sequence) is used.
11682 The events that come from bindings in `input-decode-map' are not
11683 themselves looked up in `input-decode-map'. */);
11685 DEFVAR_LISP ("function-key-map", Vfunction_key_map
,
11686 doc
: /* The parent keymap of all `local-function-key-map' instances.
11687 Function key definitions that apply to all terminal devices should go
11688 here. If a mapping is defined in both the current
11689 `local-function-key-map' binding and this variable, then the local
11690 definition will take precedence. */);
11691 Vfunction_key_map
= Fmake_sparse_keymap (Qnil
);
11693 DEFVAR_LISP ("key-translation-map", Vkey_translation_map
,
11694 doc
: /* Keymap of key translations that can override keymaps.
11695 This keymap works like `input-decode-map', but comes after `function-key-map'.
11696 Another difference is that it is global rather than terminal-local. */);
11697 Vkey_translation_map
= Fmake_sparse_keymap (Qnil
);
11699 DEFVAR_LISP ("deferred-action-list", Vdeferred_action_list
,
11700 doc
: /* List of deferred actions to be performed at a later time.
11701 The precise format isn't relevant here; we just check whether it is nil. */);
11702 Vdeferred_action_list
= Qnil
;
11704 DEFVAR_LISP ("deferred-action-function", Vdeferred_action_function
,
11705 doc
: /* Function to call to handle deferred actions, after each command.
11706 This function is called with no arguments after each command
11707 whenever `deferred-action-list' is non-nil. */);
11708 Vdeferred_action_function
= Qnil
;
11710 DEFVAR_LISP ("delayed-warnings-list", Vdelayed_warnings_list
,
11711 doc
: /* List of warnings to be displayed after this command.
11712 Each element must be a list (TYPE MESSAGE [LEVEL [BUFFER-NAME]]),
11713 as per the args of `display-warning' (which see).
11714 If this variable is non-nil, `delayed-warnings-hook' will be run
11715 immediately after running `post-command-hook'. */);
11716 Vdelayed_warnings_list
= Qnil
;
11718 DEFVAR_LISP ("timer-list", Vtimer_list
,
11719 doc
: /* List of active absolute time timers in order of increasing time. */);
11720 Vtimer_list
= Qnil
;
11722 DEFVAR_LISP ("timer-idle-list", Vtimer_idle_list
,
11723 doc
: /* List of active idle-time timers in order of increasing time. */);
11724 Vtimer_idle_list
= Qnil
;
11726 DEFVAR_LISP ("input-method-function", Vinput_method_function
,
11727 doc
: /* If non-nil, the function that implements the current input method.
11728 It's called with one argument, a printing character that was just read.
11729 \(That means a character with code 040...0176.)
11730 Typically this function uses `read-event' to read additional events.
11731 When it does so, it should first bind `input-method-function' to nil
11732 so it will not be called recursively.
11734 The function should return a list of zero or more events
11735 to be used as input. If it wants to put back some events
11736 to be reconsidered, separately, by the input method,
11737 it can add them to the beginning of `unread-command-events'.
11739 The input method function can find in `input-method-previous-message'
11740 the previous echo area message.
11742 The input method function should refer to the variables
11743 `input-method-use-echo-area' and `input-method-exit-on-first-char'
11744 for guidance on what to do. */);
11745 Vinput_method_function
= Qlist
;
11747 DEFVAR_LISP ("input-method-previous-message",
11748 Vinput_method_previous_message
,
11749 doc
: /* When `input-method-function' is called, hold the previous echo area message.
11750 This variable exists because `read-event' clears the echo area
11751 before running the input method. It is nil if there was no message. */);
11752 Vinput_method_previous_message
= Qnil
;
11754 DEFVAR_LISP ("show-help-function", Vshow_help_function
,
11755 doc
: /* If non-nil, the function that implements the display of help.
11756 It's called with one argument, the help string to display. */);
11757 Vshow_help_function
= Qnil
;
11759 DEFVAR_LISP ("disable-point-adjustment", Vdisable_point_adjustment
,
11760 doc
: /* If non-nil, suppress point adjustment after executing a command.
11762 After a command is executed, if point is moved into a region that has
11763 special properties (e.g. composition, display), we adjust point to
11764 the boundary of the region. But, when a command sets this variable to
11765 non-nil, we suppress the point adjustment.
11767 This variable is set to nil before reading a command, and is checked
11768 just after executing the command. */);
11769 Vdisable_point_adjustment
= Qnil
;
11771 DEFVAR_LISP ("global-disable-point-adjustment",
11772 Vglobal_disable_point_adjustment
,
11773 doc
: /* If non-nil, always suppress point adjustment.
11775 The default value is nil, in which case, point adjustment are
11776 suppressed only after special commands that set
11777 `disable-point-adjustment' (which see) to non-nil. */);
11778 Vglobal_disable_point_adjustment
= Qnil
;
11780 DEFVAR_LISP ("minibuffer-message-timeout", Vminibuffer_message_timeout
,
11781 doc
: /* How long to display an echo-area message when the minibuffer is active.
11782 If the value is not a number, such messages don't time out. */);
11783 Vminibuffer_message_timeout
= make_number (2);
11785 DEFVAR_LISP ("throw-on-input", Vthrow_on_input
,
11786 doc
: /* If non-nil, any keyboard input throws to this symbol.
11787 The value of that variable is passed to `quit-flag' and later causes a
11788 peculiar kind of quitting. */);
11789 Vthrow_on_input
= Qnil
;
11791 DEFVAR_LISP ("command-error-function", Vcommand_error_function
,
11792 doc
: /* Function to output error messages.
11793 Called with three arguments:
11794 - the error data, a list of the form (SIGNALED-CONDITION . SIGNAL-DATA)
11795 such as what `condition-case' would bind its variable to,
11796 - the context (a string which normally goes at the start of the message),
11797 - the Lisp function within which the error was signaled. */);
11798 Vcommand_error_function
= intern ("command-error-default-function");
11800 DEFVAR_LISP ("enable-disabled-menus-and-buttons",
11801 Venable_disabled_menus_and_buttons
,
11802 doc
: /* If non-nil, don't ignore events produced by disabled menu items and tool-bar.
11804 Help functions bind this to allow help on disabled menu items
11805 and tool-bar buttons. */);
11806 Venable_disabled_menus_and_buttons
= Qnil
;
11808 DEFVAR_LISP ("select-active-regions",
11809 Vselect_active_regions
,
11810 doc
: /* If non-nil, an active region automatically sets the primary selection.
11811 If the value is `only', only temporarily active regions (usually made
11812 by mouse-dragging or shift-selection) set the window selection.
11814 This takes effect only when Transient Mark mode is enabled. */);
11815 Vselect_active_regions
= Qt
;
11817 DEFVAR_LISP ("saved-region-selection",
11818 Vsaved_region_selection
,
11819 doc
: /* Contents of active region prior to buffer modification.
11820 If `select-active-regions' is non-nil, Emacs sets this to the
11821 text in the region before modifying the buffer. The next call to
11822 the function `deactivate-mark' uses this to set the window selection. */);
11823 Vsaved_region_selection
= Qnil
;
11825 DEFVAR_LISP ("selection-inhibit-update-commands",
11826 Vselection_inhibit_update_commands
,
11827 doc
: /* List of commands which should not update the selection.
11828 Normally, if `select-active-regions' is non-nil and the mark remains
11829 active after a command (i.e. the mark was not deactivated), the Emacs
11830 command loop sets the selection to the text in the region. However,
11831 if the command is in this list, the selection is not updated. */);
11832 Vselection_inhibit_update_commands
11833 = list2 (Qhandle_switch_frame
, Qhandle_select_window
);
11835 DEFVAR_LISP ("debug-on-event",
11837 doc
: /* Enter debugger on this event. When Emacs
11838 receives the special event specified by this variable, it will try to
11839 break into the debugger as soon as possible instead of processing the
11840 event normally through `special-event-map'.
11842 Currently, the only supported values for this
11843 variable are `sigusr1' and `sigusr2'. */);
11844 Vdebug_on_event
= intern_c_string ("sigusr2");
11846 /* Create the initial keyboard. Qt means 'unset'. */
11847 initial_kboard
= allocate_kboard (Qt
);
11851 keys_of_keyboard (void)
11853 initial_define_key (global_map
, Ctl ('Z'), "suspend-emacs");
11854 initial_define_key (control_x_map
, Ctl ('Z'), "suspend-emacs");
11855 initial_define_key (meta_map
, Ctl ('C'), "exit-recursive-edit");
11856 initial_define_key (global_map
, Ctl (']'), "abort-recursive-edit");
11857 initial_define_key (meta_map
, 'x', "execute-extended-command");
11859 initial_define_lispy_key (Vspecial_event_map
, "delete-frame",
11860 "handle-delete-frame");
11861 initial_define_lispy_key (Vspecial_event_map
, "ns-put-working-text",
11862 "ns-put-working-text");
11863 initial_define_lispy_key (Vspecial_event_map
, "ns-unput-working-text",
11864 "ns-unput-working-text");
11865 /* Here we used to use `ignore-event' which would simple set prefix-arg to
11866 current-prefix-arg, as is done in `handle-switch-frame'.
11867 But `handle-switch-frame is not run from the special-map.
11868 Commands from that map are run in a special way that automatically
11869 preserves the prefix-arg. Restoring the prefix arg here is not just
11870 redundant but harmful:
11872 - current-prefix-arg is set to non-nil, prefix-arg is set to nil.
11873 - after the first prompt, the exit-minibuffer-hook is run which may
11874 iconify a frame and thus push a `iconify-frame' event.
11875 - after running exit-minibuffer-hook, current-prefix-arg is
11876 restored to the non-nil value it had before the prompt.
11877 - we enter the second prompt.
11878 current-prefix-arg is non-nil, prefix-arg is nil.
11879 - before running the first real event, we run the special iconify-frame
11880 event, but we pass the `special' arg to command-execute so
11881 current-prefix-arg and prefix-arg are left untouched.
11882 - here we foolishly copy the non-nil current-prefix-arg to prefix-arg.
11883 - the next key event will have a spuriously non-nil current-prefix-arg. */
11884 initial_define_lispy_key (Vspecial_event_map
, "iconify-frame",
11886 initial_define_lispy_key (Vspecial_event_map
, "make-frame-visible",
11888 /* Handling it at such a low-level causes read_key_sequence to get
11889 * confused because it doesn't realize that the current_buffer was
11890 * changed by read_char.
11892 * initial_define_lispy_key (Vspecial_event_map, "select-window",
11893 * "handle-select-window"); */
11894 initial_define_lispy_key (Vspecial_event_map
, "save-session",
11895 "handle-save-session");
11898 /* Define a special event which is raised for dbus callback
11900 initial_define_lispy_key (Vspecial_event_map
, "dbus-event",
11901 "dbus-handle-event");
11904 #ifdef USE_FILE_NOTIFY
11905 /* Define a special event which is raised for notification callback
11907 initial_define_lispy_key (Vspecial_event_map
, "file-notify",
11908 "file-notify-handle-event");
11909 #endif /* USE_FILE_NOTIFY */
11911 initial_define_lispy_key (Vspecial_event_map
, "config-changed-event",
11913 #if defined (WINDOWSNT)
11914 initial_define_lispy_key (Vspecial_event_map
, "language-change",
11917 initial_define_lispy_key (Vspecial_event_map
, "focus-in",
11918 "handle-focus-in");
11919 initial_define_lispy_key (Vspecial_event_map
, "focus-out",
11920 "handle-focus-out");
11923 /* Mark the pointers in the kboard objects.
11924 Called by Fgarbage_collect. */
11926 mark_kboards (void)
11930 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
11932 if (kb
->kbd_macro_buffer
)
11933 for (p
= kb
->kbd_macro_buffer
; p
< kb
->kbd_macro_ptr
; p
++)
11935 mark_object (KVAR (kb
, Voverriding_terminal_local_map
));
11936 mark_object (KVAR (kb
, Vlast_command
));
11937 mark_object (KVAR (kb
, Vreal_last_command
));
11938 mark_object (KVAR (kb
, Vkeyboard_translate_table
));
11939 mark_object (KVAR (kb
, Vlast_repeatable_command
));
11940 mark_object (KVAR (kb
, Vprefix_arg
));
11941 mark_object (KVAR (kb
, Vlast_prefix_arg
));
11942 mark_object (KVAR (kb
, kbd_queue
));
11943 mark_object (KVAR (kb
, defining_kbd_macro
));
11944 mark_object (KVAR (kb
, Vlast_kbd_macro
));
11945 mark_object (KVAR (kb
, Vsystem_key_alist
));
11946 mark_object (KVAR (kb
, system_key_syms
));
11947 mark_object (KVAR (kb
, Vwindow_system
));
11948 mark_object (KVAR (kb
, Vinput_decode_map
));
11949 mark_object (KVAR (kb
, Vlocal_function_key_map
));
11950 mark_object (KVAR (kb
, Vdefault_minibuffer_frame
));
11951 mark_object (KVAR (kb
, echo_string
));
11954 union buffered_input_event
*event
;
11955 for (event
= kbd_fetch_ptr
; event
!= kbd_store_ptr
; event
++)
11957 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
11958 event
= kbd_buffer
;
11959 /* These two special event types has no Lisp_Objects to mark. */
11960 if (event
->kind
!= SELECTION_REQUEST_EVENT
11961 && event
->kind
!= SELECTION_CLEAR_EVENT
)
11963 mark_object (event
->ie
.x
);
11964 mark_object (event
->ie
.y
);
11965 mark_object (event
->ie
.frame_or_window
);
11966 mark_object (event
->ie
.arg
);