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. */
1097 Vinternal__top_level_message
= recover_top_level_message
;
1100 Vinternal__top_level_message
= regular_top_level_message
;
1101 #endif /* HAVE_STACK_OVERFLOW_HANDLING */
1102 if (command_loop_level
> 0 || minibuf_level
> 0)
1105 val
= internal_catch (Qexit
, command_loop_2
, Qnil
);
1106 executing_kbd_macro
= Qnil
;
1112 internal_catch (Qtop_level
, top_level_1
, Qnil
);
1113 internal_catch (Qtop_level
, command_loop_2
, Qnil
);
1114 executing_kbd_macro
= Qnil
;
1116 /* End of file in -batch run causes exit here. */
1122 /* Here we catch errors in execution of commands within the
1123 editing loop, and reenter the editing loop.
1124 When there is an error, cmd_error runs and returns a non-nil
1125 value to us. A value of nil means that command_loop_1 itself
1126 returned due to end of file (or end of kbd macro). */
1129 command_loop_2 (Lisp_Object ignore
)
1131 register Lisp_Object val
;
1134 val
= internal_condition_case (command_loop_1
, Qerror
, cmd_error
);
1135 while (!NILP (val
));
1143 return Feval (Vtop_level
, Qnil
);
1147 top_level_1 (Lisp_Object ignore
)
1149 /* On entry to the outer level, run the startup file. */
1150 if (!NILP (Vtop_level
))
1151 internal_condition_case (top_level_2
, Qerror
, cmd_error
);
1152 else if (!NILP (Vpurify_flag
))
1153 message1 ("Bare impure Emacs (standard Lisp code not loaded)");
1155 message1 ("Bare Emacs (standard Lisp code not loaded)");
1159 DEFUN ("top-level", Ftop_level
, Stop_level
, 0, 0, "",
1160 doc
: /* Exit all recursive editing levels.
1161 This also exits all active minibuffers. */
1162 attributes
: noreturn
)
1165 #ifdef HAVE_WINDOW_SYSTEM
1166 if (display_hourglass_p
)
1167 cancel_hourglass ();
1170 /* Unblock input if we enter with input blocked. This may happen if
1171 redisplay traps e.g. during tool-bar update with input blocked. */
1172 totally_unblock_input ();
1174 Fthrow (Qtop_level
, Qnil
);
1177 static _Noreturn
void
1178 user_error (const char *msg
)
1180 xsignal1 (Quser_error
, build_string (msg
));
1183 /* _Noreturn will be added to prototype by make-docfile. */
1184 DEFUN ("exit-recursive-edit", Fexit_recursive_edit
, Sexit_recursive_edit
, 0, 0, "",
1185 doc
: /* Exit from the innermost recursive edit or minibuffer. */
1186 attributes
: noreturn
)
1189 if (command_loop_level
> 0 || minibuf_level
> 0)
1190 Fthrow (Qexit
, Qnil
);
1192 user_error ("No recursive edit is in progress");
1195 /* _Noreturn will be added to prototype by make-docfile. */
1196 DEFUN ("abort-recursive-edit", Fabort_recursive_edit
, Sabort_recursive_edit
, 0, 0, "",
1197 doc
: /* Abort the command that requested this recursive edit or minibuffer input. */
1198 attributes
: noreturn
)
1201 if (command_loop_level
> 0 || minibuf_level
> 0)
1204 user_error ("No recursive edit is in progress");
1207 /* Restore mouse tracking enablement. See Ftrack_mouse for the only use
1208 of this function. */
1211 tracking_off (Lisp_Object old_value
)
1213 do_mouse_tracking
= old_value
;
1214 if (NILP (old_value
))
1216 /* Redisplay may have been preempted because there was input
1217 available, and it assumes it will be called again after the
1218 input has been processed. If the only input available was
1219 the sort that we have just disabled, then we need to call
1221 if (!readable_events (READABLE_EVENTS_DO_TIMERS_NOW
))
1223 redisplay_preserve_echo_area (6);
1224 get_input_pending (READABLE_EVENTS_DO_TIMERS_NOW
);
1229 DEFUN ("internal--track-mouse", Ftrack_mouse
, Strack_mouse
, 1, 1, 0,
1230 doc
: /* Call BODYFUN with mouse movement events enabled. */)
1231 (Lisp_Object bodyfun
)
1233 ptrdiff_t count
= SPECPDL_INDEX ();
1236 record_unwind_protect (tracking_off
, do_mouse_tracking
);
1238 do_mouse_tracking
= Qt
;
1240 val
= call0 (bodyfun
);
1241 return unbind_to (count
, val
);
1244 /* If mouse has moved on some frame, return one of those frames.
1248 If ignore_mouse_drag_p is non-zero, ignore (implicit) mouse movement
1249 after resizing the tool-bar window. */
1251 bool ignore_mouse_drag_p
;
1253 static struct frame
*
1254 some_mouse_moved (void)
1256 Lisp_Object tail
, frame
;
1258 if (ignore_mouse_drag_p
)
1260 /* ignore_mouse_drag_p = 0; */
1264 FOR_EACH_FRAME (tail
, frame
)
1266 if (XFRAME (frame
)->mouse_moved
)
1267 return XFRAME (frame
);
1274 /* This is the actual command reading loop,
1275 sans error-handling encapsulation. */
1277 static int read_key_sequence (Lisp_Object
*, int, Lisp_Object
,
1278 bool, bool, bool, bool);
1279 static void adjust_point_for_property (ptrdiff_t, bool);
1281 /* FIXME: This is wrong rather than test window-system, we should call
1282 a new set-selection, which will then dispatch to x-set-selection, or
1283 tty-set-selection, or w32-set-selection, ... */
1286 command_loop_1 (void)
1289 Lisp_Object keybuf
[30];
1291 EMACS_INT prev_modiff
= 0;
1292 struct buffer
*prev_buffer
= NULL
;
1293 bool already_adjusted
= 0;
1295 kset_prefix_arg (current_kboard
, Qnil
);
1296 kset_last_prefix_arg (current_kboard
, Qnil
);
1297 Vdeactivate_mark
= Qnil
;
1298 waiting_for_input
= 0;
1301 this_command_key_count
= 0;
1302 this_command_key_count_reset
= 0;
1303 this_single_command_key_start
= 0;
1305 if (NILP (Vmemory_full
))
1307 /* Make sure this hook runs after commands that get errors and
1308 throw to top level. */
1309 /* Note that the value cell will never directly contain nil
1310 if the symbol is a local variable. */
1311 if (!NILP (Vpost_command_hook
) && !NILP (Vrun_hooks
))
1312 safe_run_hooks (Qpost_command_hook
);
1314 /* If displaying a message, resize the echo area window to fit
1315 that message's size exactly. */
1316 if (!NILP (echo_area_buffer
[0]))
1317 resize_echo_area_exactly ();
1319 /* If there are warnings waiting, process them. */
1320 if (!NILP (Vdelayed_warnings_list
))
1321 safe_run_hooks (Qdelayed_warnings_hook
);
1323 if (!NILP (Vdeferred_action_list
))
1324 safe_run_hooks (Qdeferred_action_function
);
1327 /* Do this after running Vpost_command_hook, for consistency. */
1328 kset_last_command (current_kboard
, Vthis_command
);
1329 kset_real_last_command (current_kboard
, Vreal_this_command
);
1330 if (!CONSP (last_command_event
))
1331 kset_last_repeatable_command (current_kboard
, Vreal_this_command
);
1335 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1338 /* Make sure the current window's buffer is selected. */
1339 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->contents
));
1341 /* Display any malloc warning that just came out. Use while because
1342 displaying one warning can cause another. */
1344 while (pending_malloc_warning
)
1345 display_malloc_warning ();
1347 Vdeactivate_mark
= Qnil
;
1349 /* Don't ignore mouse movements for more than a single command
1350 loop. (This flag is set in xdisp.c whenever the tool bar is
1351 resized, because the resize moves text up or down, and would
1352 generate false mouse drag events if we don't ignore them.) */
1353 ignore_mouse_drag_p
= 0;
1355 /* If minibuffer on and echo area in use,
1356 wait a short time and redraw minibuffer. */
1359 && !NILP (echo_area_buffer
[0])
1360 && EQ (minibuf_window
, echo_area_window
)
1361 && NUMBERP (Vminibuffer_message_timeout
))
1363 /* Bind inhibit-quit to t so that C-g gets read in
1364 rather than quitting back to the minibuffer. */
1365 ptrdiff_t count
= SPECPDL_INDEX ();
1366 specbind (Qinhibit_quit
, Qt
);
1368 sit_for (Vminibuffer_message_timeout
, 0, 2);
1370 /* Clear the echo area. */
1372 safe_run_hooks (Qecho_area_clear_hook
);
1374 unbind_to (count
, Qnil
);
1376 /* If a C-g came in before, treat it as input now. */
1377 if (!NILP (Vquit_flag
))
1380 Vunread_command_events
= list1 (make_number (quit_char
));
1384 /* If it has changed current-menubar from previous value,
1385 really recompute the menubar from the value. */
1386 if (! NILP (Vlucid_menu_bar_dirty_flag
)
1387 && !NILP (Ffboundp (Qrecompute_lucid_menubar
)))
1388 call0 (Qrecompute_lucid_menubar
);
1390 before_command_key_count
= this_command_key_count
;
1391 before_command_echo_length
= echo_length ();
1393 Vthis_command
= Qnil
;
1394 Vreal_this_command
= Qnil
;
1395 Vthis_original_command
= Qnil
;
1396 Vthis_command_keys_shift_translated
= Qnil
;
1398 /* Read next key sequence; i gets its length. */
1399 i
= read_key_sequence (keybuf
, ARRAYELTS (keybuf
),
1402 /* A filter may have run while we were reading the input. */
1403 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1405 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->contents
));
1409 /* Now we have read a key sequence of length I,
1410 or else I is 0 and we found end of file. */
1412 if (i
== 0) /* End of file -- happens only in */
1413 return Qnil
; /* a kbd macro, at the end. */
1414 /* -1 means read_key_sequence got a menu that was rejected.
1415 Just loop around and read another command. */
1419 this_command_key_count
= 0;
1420 this_command_key_count_reset
= 0;
1421 this_single_command_key_start
= 0;
1425 last_command_event
= keybuf
[i
- 1];
1427 /* If the previous command tried to force a specific window-start,
1428 forget about that, in case this command moves point far away
1429 from that position. But also throw away beg_unchanged and
1430 end_unchanged information in that case, so that redisplay will
1431 update the whole window properly. */
1432 if (XWINDOW (selected_window
)->force_start
)
1435 XWINDOW (selected_window
)->force_start
= 0;
1436 b
= XBUFFER (XWINDOW (selected_window
)->contents
);
1437 BUF_BEG_UNCHANGED (b
) = BUF_END_UNCHANGED (b
) = 0;
1440 cmd
= read_key_sequence_cmd
;
1441 if (!NILP (Vexecuting_kbd_macro
))
1443 if (!NILP (Vquit_flag
))
1445 Vexecuting_kbd_macro
= Qt
;
1446 QUIT
; /* Make some noise. */
1447 /* Will return since macro now empty. */
1451 /* Do redisplay processing after this command except in special
1452 cases identified below. */
1453 prev_buffer
= current_buffer
;
1454 prev_modiff
= MODIFF
;
1455 last_point_position
= PT
;
1457 /* By default, we adjust point to a boundary of a region that
1458 has such a property that should be treated intangible
1459 (e.g. composition, display). But, some commands will set
1460 this variable differently. */
1461 Vdisable_point_adjustment
= Qnil
;
1463 /* Process filters and timers may have messed with deactivate-mark.
1464 reset it before we execute the command. */
1465 Vdeactivate_mark
= Qnil
;
1467 /* Remap command through active keymaps. */
1468 Vthis_original_command
= cmd
;
1469 if (!NILP (read_key_sequence_remapped
))
1470 cmd
= read_key_sequence_remapped
;
1472 /* Execute the command. */
1475 total_keys
+= total_keys
< NUM_RECENT_KEYS
;
1476 ASET (recent_keys
, recent_keys_index
,
1478 if (++recent_keys_index
>= NUM_RECENT_KEYS
)
1479 recent_keys_index
= 0;
1481 Vthis_command
= cmd
;
1482 Vreal_this_command
= cmd
;
1483 safe_run_hooks (Qpre_command_hook
);
1485 already_adjusted
= 0;
1487 if (NILP (Vthis_command
))
1488 /* nil means key is undefined. */
1492 /* Here for a command that isn't executed directly. */
1494 #ifdef HAVE_WINDOW_SYSTEM
1495 ptrdiff_t scount
= SPECPDL_INDEX ();
1497 if (display_hourglass_p
1498 && NILP (Vexecuting_kbd_macro
))
1500 record_unwind_protect_void (cancel_hourglass
);
1505 /* Ensure that we have added appropriate undo-boundaries as a
1506 result of changes from the last command. */
1507 call0 (Qundo_auto__add_boundary
);
1509 call1 (Qcommand_execute
, Vthis_command
);
1511 #ifdef HAVE_WINDOW_SYSTEM
1512 /* Do not check display_hourglass_p here, because
1513 `command-execute' could change it, but we should cancel
1514 hourglass cursor anyway.
1515 But don't cancel the hourglass within a macro
1516 just because a command in the macro finishes. */
1517 if (NILP (Vexecuting_kbd_macro
))
1518 unbind_to (scount
, Qnil
);
1521 kset_last_prefix_arg (current_kboard
, Vcurrent_prefix_arg
);
1523 safe_run_hooks (Qpost_command_hook
);
1525 /* If displaying a message, resize the echo area window to fit
1526 that message's size exactly. */
1527 if (!NILP (echo_area_buffer
[0]))
1528 resize_echo_area_exactly ();
1530 /* If there are warnings waiting, process them. */
1531 if (!NILP (Vdelayed_warnings_list
))
1532 safe_run_hooks (Qdelayed_warnings_hook
);
1534 safe_run_hooks (Qdeferred_action_function
);
1536 /* If there is a prefix argument,
1537 1) We don't want Vlast_command to be ``universal-argument''
1538 (that would be dumb), so don't set Vlast_command,
1539 2) we want to leave echoing on so that the prefix will be
1540 echoed as part of this key sequence, so don't call
1542 3) we want to leave this_command_key_count non-zero, so that
1543 read_char will realize that it is re-reading a character, and
1544 not echo it a second time.
1546 If the command didn't actually create a prefix arg,
1547 but is merely a frame event that is transparent to prefix args,
1548 then the above doesn't apply. */
1549 if (NILP (KVAR (current_kboard
, Vprefix_arg
))
1550 || CONSP (last_command_event
))
1552 kset_last_command (current_kboard
, Vthis_command
);
1553 kset_real_last_command (current_kboard
, Vreal_this_command
);
1554 if (!CONSP (last_command_event
))
1555 kset_last_repeatable_command (current_kboard
, Vreal_this_command
);
1557 this_command_key_count
= 0;
1558 this_command_key_count_reset
= 0;
1559 this_single_command_key_start
= 0;
1562 if (!NILP (BVAR (current_buffer
, mark_active
))
1563 && !NILP (Vrun_hooks
))
1565 /* In Emacs 22, setting transient-mark-mode to `only' was a
1566 way of turning it on for just one command. This usage is
1567 obsolete, but support it anyway. */
1568 if (EQ (Vtransient_mark_mode
, Qidentity
))
1569 Vtransient_mark_mode
= Qnil
;
1570 else if (EQ (Vtransient_mark_mode
, Qonly
))
1571 Vtransient_mark_mode
= Qidentity
;
1573 if (!NILP (Vdeactivate_mark
))
1574 /* If `select-active-regions' is non-nil, this call to
1575 `deactivate-mark' also sets the PRIMARY selection. */
1576 call0 (Qdeactivate_mark
);
1579 /* Even if not deactivating the mark, set PRIMARY if
1580 `select-active-regions' is non-nil. */
1581 if (!NILP (Fwindow_system (Qnil
))
1582 /* Even if mark_active is non-nil, the actual buffer
1583 marker may not have been set yet (Bug#7044). */
1584 && XMARKER (BVAR (current_buffer
, mark
))->buffer
1585 && (EQ (Vselect_active_regions
, Qonly
)
1586 ? EQ (CAR_SAFE (Vtransient_mark_mode
), Qonly
)
1587 : (!NILP (Vselect_active_regions
)
1588 && !NILP (Vtransient_mark_mode
)))
1589 && NILP (Fmemq (Vthis_command
,
1590 Vselection_inhibit_update_commands
)))
1593 = call1 (Fsymbol_value (Qregion_extract_function
), Qnil
);
1594 if (XINT (Flength (txt
)) > 0)
1595 /* Don't set empty selections. */
1596 call2 (Qgui_set_selection
, QPRIMARY
, txt
);
1599 if (current_buffer
!= prev_buffer
|| MODIFF
!= prev_modiff
)
1600 run_hook (intern ("activate-mark-hook"));
1603 Vsaved_region_selection
= Qnil
;
1608 if (current_buffer
== prev_buffer
1609 && XBUFFER (XWINDOW (selected_window
)->contents
) == current_buffer
1610 && last_point_position
!= PT
1611 && NILP (Vdisable_point_adjustment
)
1612 && NILP (Vglobal_disable_point_adjustment
))
1614 if (last_point_position
> BEGV
1615 && last_point_position
< ZV
1616 && (composition_adjust_point (last_point_position
,
1617 last_point_position
)
1618 != last_point_position
))
1619 /* The last point was temporarily set within a grapheme
1620 cluster to prevent automatic composition. To recover
1621 the automatic composition, we must update the
1623 windows_or_buffers_changed
= 21;
1624 if (!already_adjusted
)
1625 adjust_point_for_property (last_point_position
,
1626 MODIFF
!= prev_modiff
);
1629 /* Install chars successfully executed in kbd macro. */
1631 if (!NILP (KVAR (current_kboard
, defining_kbd_macro
))
1632 && NILP (KVAR (current_kboard
, Vprefix_arg
)))
1633 finalize_kbd_macro_chars ();
1638 read_menu_command (void)
1640 Lisp_Object keybuf
[30];
1641 ptrdiff_t count
= SPECPDL_INDEX ();
1644 /* We don't want to echo the keystrokes while navigating the
1646 specbind (Qecho_keystrokes
, make_number (0));
1648 i
= read_key_sequence (keybuf
, ARRAYELTS (keybuf
),
1651 unbind_to (count
, Qnil
);
1653 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1655 if (i
== 0 || i
== -1)
1658 return read_key_sequence_cmd
;
1661 /* Adjust point to a boundary of a region that has such a property
1662 that should be treated intangible. For the moment, we check
1663 `composition', `display' and `invisible' properties.
1664 LAST_PT is the last position of point. */
1667 adjust_point_for_property (ptrdiff_t last_pt
, bool modified
)
1670 Lisp_Object val
, overlay
, tmp
;
1671 /* When called after buffer modification, we should temporarily
1672 suppress the point adjustment for automatic composition so that a
1673 user can keep inserting another character at point or keep
1674 deleting characters around point. */
1675 bool check_composition
= ! modified
, check_display
= 1, check_invisible
= 1;
1676 ptrdiff_t orig_pt
= PT
;
1678 eassert (XBUFFER (XWINDOW (selected_window
)->contents
) == current_buffer
);
1680 /* FIXME: cycling is probably not necessary because these properties
1681 can't be usefully combined anyway. */
1682 while (check_composition
|| check_display
|| check_invisible
)
1684 /* FIXME: check `intangible'. */
1685 if (check_composition
1686 && PT
> BEGV
&& PT
< ZV
1687 && (beg
= composition_adjust_point (last_pt
, PT
)) != PT
)
1690 check_display
= check_invisible
= 1;
1692 check_composition
= 0;
1694 && PT
> BEGV
&& PT
< ZV
1695 && !NILP (val
= get_char_property_and_overlay
1696 (make_number (PT
), Qdisplay
, selected_window
,
1698 && display_prop_intangible_p (val
, overlay
, PT
, PT_BYTE
)
1699 && (!OVERLAYP (overlay
)
1700 ? get_property_and_range (PT
, Qdisplay
, &val
, &beg
, &end
, Qnil
)
1701 : (beg
= OVERLAY_POSITION (OVERLAY_START (overlay
)),
1702 end
= OVERLAY_POSITION (OVERLAY_END (overlay
))))
1703 && (beg
< PT
/* && end > PT <- It's always the case. */
1704 || (beg
<= PT
&& STRINGP (val
) && SCHARS (val
) == 0)))
1707 SET_PT (PT
< last_pt
1708 ? (STRINGP (val
) && SCHARS (val
) == 0
1709 ? max (beg
- 1, BEGV
)
1712 check_composition
= check_invisible
= 1;
1715 if (check_invisible
&& PT
> BEGV
&& PT
< ZV
)
1721 /* Find boundaries `beg' and `end' of the invisible area, if any. */
1724 /* FIXME: We should stop if we find a spot between
1725 two runs of `invisible' where inserted text would
1726 be visible. This is important when we have two
1727 invisible boundaries that enclose an area: if the
1728 area is empty, we need this test in order to make
1729 it possible to place point in the middle rather
1730 than skip both boundaries. However, this code
1731 also stops anywhere in a non-sticky text-property,
1732 which breaks (e.g.) Org mode. */
1733 && (val
= Fget_pos_property (make_number (end
),
1735 TEXT_PROP_MEANS_INVISIBLE (val
))
1737 && !NILP (val
= get_char_property_and_overlay
1738 (make_number (end
), Qinvisible
, Qnil
, &overlay
))
1739 && (inv
= TEXT_PROP_MEANS_INVISIBLE (val
)))
1741 ellipsis
= ellipsis
|| inv
> 1
1742 || (OVERLAYP (overlay
)
1743 && (!NILP (Foverlay_get (overlay
, Qafter_string
))
1744 || !NILP (Foverlay_get (overlay
, Qbefore_string
))));
1745 tmp
= Fnext_single_char_property_change
1746 (make_number (end
), Qinvisible
, Qnil
, Qnil
);
1747 end
= NATNUMP (tmp
) ? XFASTINT (tmp
) : ZV
;
1751 && (val
= Fget_pos_property (make_number (beg
),
1753 TEXT_PROP_MEANS_INVISIBLE (val
))
1755 && !NILP (val
= get_char_property_and_overlay
1756 (make_number (beg
- 1), Qinvisible
, Qnil
, &overlay
))
1757 && (inv
= TEXT_PROP_MEANS_INVISIBLE (val
)))
1759 ellipsis
= ellipsis
|| inv
> 1
1760 || (OVERLAYP (overlay
)
1761 && (!NILP (Foverlay_get (overlay
, Qafter_string
))
1762 || !NILP (Foverlay_get (overlay
, Qbefore_string
))));
1763 tmp
= Fprevious_single_char_property_change
1764 (make_number (beg
), Qinvisible
, Qnil
, Qnil
);
1765 beg
= NATNUMP (tmp
) ? XFASTINT (tmp
) : BEGV
;
1768 /* Move away from the inside area. */
1769 if (beg
< PT
&& end
> PT
)
1771 SET_PT ((orig_pt
== PT
&& (last_pt
< beg
|| last_pt
> end
))
1772 /* We haven't moved yet (so we don't need to fear
1773 infinite-looping) and we were outside the range
1774 before (so either end of the range still corresponds
1775 to a move in the right direction): pretend we moved
1776 less than we actually did, so that we still have
1777 more freedom below in choosing which end of the range
1779 ? (orig_pt
= -1, PT
< last_pt
? end
: beg
)
1780 /* We either have moved already or the last point
1781 was already in the range: we don't get to choose
1782 which end of the range we have to go to. */
1783 : (PT
< last_pt
? beg
: end
));
1784 check_composition
= check_display
= 1;
1786 #if 0 /* This assertion isn't correct, because SET_PT may end up setting
1787 the point to something other than its argument, due to
1788 point-motion hooks, intangibility, etc. */
1789 eassert (PT
== beg
|| PT
== end
);
1792 /* Pretend the area doesn't exist if the buffer is not
1794 if (!modified
&& !ellipsis
&& beg
< end
)
1796 if (last_pt
== beg
&& PT
== end
&& end
< ZV
)
1797 (check_composition
= check_display
= 1, SET_PT (end
+ 1));
1798 else if (last_pt
== end
&& PT
== beg
&& beg
> BEGV
)
1799 (check_composition
= check_display
= 1, SET_PT (beg
- 1));
1800 else if (PT
== ((PT
< last_pt
) ? beg
: end
))
1801 /* We've already moved as far as we can. Trying to go
1802 to the other end would mean moving backwards and thus
1803 could lead to an infinite loop. */
1805 else if (val
= Fget_pos_property (make_number (PT
),
1807 TEXT_PROP_MEANS_INVISIBLE (val
)
1808 && (val
= (Fget_pos_property
1809 (make_number (PT
== beg
? end
: beg
),
1811 !TEXT_PROP_MEANS_INVISIBLE (val
)))
1812 (check_composition
= check_display
= 1,
1813 SET_PT (PT
== beg
? end
: beg
));
1816 check_invisible
= 0;
1820 /* Subroutine for safe_run_hooks: run the hook, which is ARGS[1]. */
1823 safe_run_hooks_1 (ptrdiff_t nargs
, Lisp_Object
*args
)
1825 eassert (nargs
== 2);
1826 return call0 (args
[1]);
1829 /* Subroutine for safe_run_hooks: handle an error by clearing out the function
1833 safe_run_hooks_error (Lisp_Object error
, ptrdiff_t nargs
, Lisp_Object
*args
)
1835 eassert (nargs
== 2);
1836 AUTO_STRING (format
, "Error in %s (%S): %S");
1837 Lisp_Object hook
= args
[0];
1838 Lisp_Object fun
= args
[1];
1839 CALLN (Fmessage
, format
, hook
, fun
, error
);
1845 Lisp_Object newval
= Qnil
;
1846 for (val
= find_symbol_value (hook
); CONSP (val
); val
= XCDR (val
))
1847 if (EQ (fun
, XCAR (val
)))
1850 newval
= Fcons (XCAR (val
), newval
);
1852 return Fset (hook
, Fnreverse (newval
));
1853 /* Not found in the local part of the hook. Let's look at the global
1856 for (val
= (NILP (Fdefault_boundp (hook
)) ? Qnil
1857 : Fdefault_value (hook
));
1858 CONSP (val
); val
= XCDR (val
))
1859 if (EQ (fun
, XCAR (val
)))
1862 newval
= Fcons (XCAR (val
), newval
);
1864 return Fset_default (hook
, Fnreverse (newval
));
1870 safe_run_hook_funcall (ptrdiff_t nargs
, Lisp_Object
*args
)
1872 eassert (nargs
== 2);
1873 /* Yes, run_hook_with_args works with args in the other order. */
1874 internal_condition_case_n (safe_run_hooks_1
,
1875 2, ((Lisp_Object
[]) {args
[1], args
[0]}),
1876 Qt
, safe_run_hooks_error
);
1880 /* If we get an error while running the hook, cause the hook variable
1881 to be nil. Also inhibit quits, so that C-g won't cause the hook
1882 to mysteriously evaporate. */
1885 safe_run_hooks (Lisp_Object hook
)
1887 struct gcpro gcpro1
;
1888 ptrdiff_t count
= SPECPDL_INDEX ();
1891 specbind (Qinhibit_quit
, Qt
);
1892 run_hook_with_args (2, ((Lisp_Object
[]) {hook
, hook
}), safe_run_hook_funcall
);
1893 unbind_to (count
, Qnil
);
1898 /* Nonzero means polling for input is temporarily suppressed. */
1900 int poll_suppress_count
;
1903 #ifdef POLL_FOR_INPUT
1905 /* Asynchronous timer for polling. */
1907 static struct atimer
*poll_timer
;
1909 /* Poll for input, so that we catch a C-g if it comes in. */
1911 poll_for_input_1 (void)
1913 if (! input_blocked_p ()
1914 && !waiting_for_input
)
1918 /* Timer callback function for poll_timer. TIMER is equal to
1922 poll_for_input (struct atimer
*timer
)
1924 if (poll_suppress_count
== 0)
1925 pending_signals
= 1;
1928 #endif /* POLL_FOR_INPUT */
1930 /* Begin signals to poll for input, if they are appropriate.
1931 This function is called unconditionally from various places. */
1934 start_polling (void)
1936 #ifdef POLL_FOR_INPUT
1937 /* XXX This condition was (read_socket_hook && !interrupt_input),
1938 but read_socket_hook is not global anymore. Let's pretend that
1940 if (!interrupt_input
)
1942 /* Turn alarm handling on unconditionally. It might have
1943 been turned off in process.c. */
1944 turn_on_atimers (1);
1946 /* If poll timer doesn't exist, or we need one with
1947 a different interval, start a new one. */
1948 if (poll_timer
== NULL
1949 || poll_timer
->interval
.tv_sec
!= polling_period
)
1951 time_t period
= max (1, min (polling_period
, TYPE_MAXIMUM (time_t)));
1952 struct timespec interval
= make_timespec (period
, 0);
1955 cancel_atimer (poll_timer
);
1957 poll_timer
= start_atimer (ATIMER_CONTINUOUS
, interval
,
1958 poll_for_input
, NULL
);
1961 /* Let the timer's callback function poll for input
1962 if this becomes zero. */
1963 --poll_suppress_count
;
1968 /* True if we are using polling to handle input asynchronously. */
1971 input_polling_used (void)
1973 #ifdef POLL_FOR_INPUT
1974 /* XXX This condition was (read_socket_hook && !interrupt_input),
1975 but read_socket_hook is not global anymore. Let's pretend that
1977 return !interrupt_input
;
1983 /* Turn off polling. */
1988 #ifdef POLL_FOR_INPUT
1989 /* XXX This condition was (read_socket_hook && !interrupt_input),
1990 but read_socket_hook is not global anymore. Let's pretend that
1992 if (!interrupt_input
)
1993 ++poll_suppress_count
;
1997 /* Set the value of poll_suppress_count to COUNT
1998 and start or stop polling accordingly. */
2001 set_poll_suppress_count (int count
)
2003 #ifdef POLL_FOR_INPUT
2004 if (count
== 0 && poll_suppress_count
!= 0)
2006 poll_suppress_count
= 1;
2009 else if (count
!= 0 && poll_suppress_count
== 0)
2013 poll_suppress_count
= count
;
2017 /* Bind polling_period to a value at least N.
2018 But don't decrease it. */
2021 bind_polling_period (int n
)
2023 #ifdef POLL_FOR_INPUT
2024 EMACS_INT
new = polling_period
;
2029 stop_other_atimers (poll_timer
);
2031 specbind (Qpolling_period
, make_number (new));
2032 /* Start a new alarm with the new period. */
2037 /* Apply the control modifier to CHARACTER. */
2040 make_ctrl_char (int c
)
2042 /* Save the upper bits here. */
2043 int upper
= c
& ~0177;
2045 if (! ASCII_CHAR_P (c
))
2046 return c
|= ctrl_modifier
;
2050 /* Everything in the columns containing the upper-case letters
2051 denotes a control character. */
2052 if (c
>= 0100 && c
< 0140)
2056 /* Set the shift modifier for a control char
2057 made from a shifted letter. But only for letters! */
2058 if (oc
>= 'A' && oc
<= 'Z')
2059 c
|= shift_modifier
;
2062 /* The lower-case letters denote control characters too. */
2063 else if (c
>= 'a' && c
<= 'z')
2066 /* Include the bits for control and shift
2067 only if the basic ASCII code can't indicate them. */
2071 /* Replace the high bits. */
2072 c
|= (upper
& ~ctrl_modifier
);
2077 /* Display the help-echo property of the character after the mouse pointer.
2078 Either show it in the echo area, or call show-help-function to display
2079 it by other means (maybe in a tooltip).
2081 If HELP is nil, that means clear the previous help echo.
2083 If HELP is a string, display that string. If HELP is a function,
2084 call it with OBJECT and POS as arguments; the function should
2085 return a help string or nil for none. For all other types of HELP,
2086 evaluate it to obtain a string.
2088 WINDOW is the window in which the help was generated, if any.
2089 It is nil if not in a window.
2091 If OBJECT is a buffer, POS is the position in the buffer where the
2092 `help-echo' text property was found.
2094 If OBJECT is an overlay, that overlay has a `help-echo' property,
2095 and POS is the position in the overlay's buffer under the mouse.
2097 If OBJECT is a string (an overlay string or a string displayed with
2098 the `display' property). POS is the position in that string under
2101 Note: this function may only be called with HELP nil or a string
2102 from X code running asynchronously. */
2105 show_help_echo (Lisp_Object help
, Lisp_Object window
, Lisp_Object object
,
2108 if (!NILP (help
) && !STRINGP (help
))
2110 if (FUNCTIONP (help
))
2111 help
= safe_call (4, help
, window
, object
, pos
);
2113 help
= safe_eval (help
);
2115 if (!STRINGP (help
))
2119 if (!noninteractive
&& STRINGP (help
))
2121 /* The mouse-fixup-help-message Lisp function can call
2122 mouse_position_hook, which resets the mouse_moved flags.
2123 This causes trouble if we are trying to read a mouse motion
2124 event (i.e., if we are inside a `track-mouse' form), so we
2125 restore the mouse_moved flag. */
2126 struct frame
*f
= NILP (do_mouse_tracking
) ? NULL
: some_mouse_moved ();
2127 help
= call1 (Qmouse_fixup_help_message
, help
);
2132 if (STRINGP (help
) || NILP (help
))
2134 if (!NILP (Vshow_help_function
))
2135 call1 (Vshow_help_function
, Fsubstitute_command_keys (help
));
2136 help_echo_showing_p
= STRINGP (help
);
2142 /* Input of single characters from keyboard. */
2144 static Lisp_Object
kbd_buffer_get_event (KBOARD
**kbp
, bool *used_mouse_menu
,
2145 struct timespec
*end_time
);
2146 static void record_char (Lisp_Object c
);
2148 static Lisp_Object help_form_saved_window_configs
;
2150 read_char_help_form_unwind (void)
2152 Lisp_Object window_config
= XCAR (help_form_saved_window_configs
);
2153 help_form_saved_window_configs
= XCDR (help_form_saved_window_configs
);
2154 if (!NILP (window_config
))
2155 Fset_window_configuration (window_config
);
2158 #define STOP_POLLING \
2159 do { if (! polling_stopped_here) stop_polling (); \
2160 polling_stopped_here = 1; } while (0)
2162 #define RESUME_POLLING \
2163 do { if (polling_stopped_here) start_polling (); \
2164 polling_stopped_here = 0; } while (0)
2167 read_event_from_main_queue (struct timespec
*end_time
,
2168 sys_jmp_buf local_getcjmp
,
2169 bool *used_mouse_menu
)
2171 Lisp_Object c
= Qnil
;
2172 sys_jmp_buf save_jump
;
2173 KBOARD
*kb
IF_LINT (= NULL
);
2177 /* Read from the main queue, and if that gives us something we can't use yet,
2178 we put it on the appropriate side queue and try again. */
2180 if (end_time
&& timespec_cmp (*end_time
, current_timespec ()) <= 0)
2183 /* Actually read a character, waiting if necessary. */
2184 save_getcjmp (save_jump
);
2185 restore_getcjmp (local_getcjmp
);
2187 timer_start_idle ();
2188 c
= kbd_buffer_get_event (&kb
, used_mouse_menu
, end_time
);
2189 restore_getcjmp (save_jump
);
2191 if (! NILP (c
) && (kb
!= current_kboard
))
2193 Lisp_Object last
= KVAR (kb
, kbd_queue
);
2196 while (CONSP (XCDR (last
)))
2198 if (!NILP (XCDR (last
)))
2202 kset_kbd_queue (kb
, list1 (c
));
2204 XSETCDR (last
, list1 (c
));
2205 kb
->kbd_queue_has_data
= 1;
2209 current_kboard
= kb
;
2210 /* This is going to exit from read_char
2211 so we had better get rid of this frame's stuff. */
2212 return make_number (-2);
2215 /* Terminate Emacs in batch mode if at eof. */
2216 if (noninteractive
&& INTEGERP (c
) && XINT (c
) < 0)
2217 Fkill_emacs (make_number (1));
2221 /* Add in any extra modifiers, where appropriate. */
2222 if ((extra_keyboard_modifiers
& CHAR_CTL
)
2223 || ((extra_keyboard_modifiers
& 0177) < ' '
2224 && (extra_keyboard_modifiers
& 0177) != 0))
2225 XSETINT (c
, make_ctrl_char (XINT (c
)));
2227 /* Transfer any other modifier bits directly from
2228 extra_keyboard_modifiers to c. Ignore the actual character code
2229 in the low 16 bits of extra_keyboard_modifiers. */
2230 XSETINT (c
, XINT (c
) | (extra_keyboard_modifiers
& ~0xff7f & ~CHAR_CTL
));
2238 /* Like `read_event_from_main_queue' but applies keyboard-coding-system
2241 read_decoded_event_from_main_queue (struct timespec
*end_time
,
2242 sys_jmp_buf local_getcjmp
,
2243 Lisp_Object prev_event
,
2244 bool *used_mouse_menu
)
2246 #define MAX_ENCODED_BYTES 16
2248 Lisp_Object events
[MAX_ENCODED_BYTES
];
2254 = read_event_from_main_queue (end_time
, local_getcjmp
,
2257 /* w32_console already returns decoded events. It either reads
2258 Unicode characters from the Windows keyboard input, or
2259 converts characters encoded in the current codepage into
2260 Unicode. See w32inevt.c:key_event, near its end. */
2263 struct frame
*frame
= XFRAME (selected_frame
);
2264 struct terminal
*terminal
= frame
->terminal
;
2265 if (!((FRAME_TERMCAP_P (frame
) || FRAME_MSDOS_P (frame
))
2266 /* Don't apply decoding if we're just reading a raw event
2267 (e.g. reading bytes sent by the xterm to specify the position
2268 of a mouse click). */
2269 && (!EQ (prev_event
, Qt
))
2270 && (TERMINAL_KEYBOARD_CODING (terminal
)->common_flags
2271 & CODING_REQUIRE_DECODING_MASK
)))
2272 return nextevt
; /* No decoding needed. */
2275 int meta_key
= terminal
->display_info
.tty
->meta_key
;
2276 eassert (n
< MAX_ENCODED_BYTES
);
2277 events
[n
++] = nextevt
;
2278 if (NATNUMP (nextevt
)
2279 && XINT (nextevt
) < (meta_key
== 1 ? 0x80 : 0x100))
2280 { /* An encoded byte sequence, let's try to decode it. */
2281 struct coding_system
*coding
2282 = TERMINAL_KEYBOARD_CODING (terminal
);
2284 if (raw_text_coding_system_p (coding
))
2288 for (i
= 0; i
< n
; i
++)
2289 events
[i
] = make_number (XINT (events
[i
]) & ~0x80);
2293 unsigned char src
[MAX_ENCODED_BYTES
];
2294 unsigned char dest
[MAX_ENCODED_BYTES
* MAX_MULTIBYTE_LENGTH
];
2296 for (i
= 0; i
< n
; i
++)
2297 src
[i
] = XINT (events
[i
]);
2299 for (i
= 0; i
< n
; i
++)
2301 coding
->destination
= dest
;
2302 coding
->dst_bytes
= sizeof dest
;
2303 decode_coding_c_string (coding
, src
, n
, Qnil
);
2304 eassert (coding
->produced_char
<= n
);
2305 if (coding
->produced_char
== 0)
2306 { /* The encoded sequence is incomplete. */
2307 if (n
< MAX_ENCODED_BYTES
) /* Avoid buffer overflow. */
2308 continue; /* Read on! */
2312 const unsigned char *p
= coding
->destination
;
2313 eassert (coding
->carryover_bytes
== 0);
2315 while (n
< coding
->produced_char
)
2316 events
[n
++] = make_number (STRING_CHAR_ADVANCE (p
));
2320 /* Now `events' should hold decoded events.
2321 Normally, n should be equal to 1, but better not rely on it.
2322 We can only return one event here, so return the first we
2323 had and keep the others (if any) for later. */
2325 Vunread_command_events
2326 = Fcons (events
[--n
], Vunread_command_events
);
2334 echo_keystrokes_p (void)
2336 return (FLOATP (Vecho_keystrokes
) ? XFLOAT_DATA (Vecho_keystrokes
) > 0.0
2337 : INTEGERP (Vecho_keystrokes
) ? XINT (Vecho_keystrokes
) > 0 : false);
2340 /* Read a character from the keyboard; call the redisplay if needed. */
2341 /* commandflag 0 means do not autosave, but do redisplay.
2342 -1 means do not redisplay, but do autosave.
2343 -2 means do neither.
2346 The argument MAP is a keymap for menu prompting.
2348 PREV_EVENT is the previous input event, or nil if we are reading
2349 the first event of a key sequence (or not reading a key sequence).
2350 If PREV_EVENT is t, that is a "magic" value that says
2351 not to run input methods, but in other respects to act as if
2352 not reading a key sequence.
2354 If USED_MOUSE_MENU is non-null, then set *USED_MOUSE_MENU to true
2355 if we used a mouse menu to read the input, or false otherwise. If
2356 USED_MOUSE_MENU is null, don't dereference it.
2358 Value is -2 when we find input on another keyboard. A second call
2359 to read_char will read it.
2361 If END_TIME is non-null, it is a pointer to a struct timespec
2362 specifying the maximum time to wait until. If no input arrives by
2363 that time, stop waiting and return nil.
2365 Value is t if we showed a menu and the user rejected it. */
2368 read_char (int commandflag
, Lisp_Object map
,
2369 Lisp_Object prev_event
,
2370 bool *used_mouse_menu
, struct timespec
*end_time
)
2374 sys_jmp_buf local_getcjmp
;
2375 sys_jmp_buf save_jump
;
2376 Lisp_Object tem
, save
;
2377 volatile Lisp_Object previous_echo_area_message
;
2378 volatile Lisp_Object also_record
;
2379 volatile bool reread
;
2380 struct gcpro gcpro1
, gcpro2
;
2381 bool volatile polling_stopped_here
= 0;
2382 struct kboard
*orig_kboard
= current_kboard
;
2386 #if 0 /* This was commented out as part of fixing echo for C-u left. */
2387 before_command_key_count
= this_command_key_count
;
2388 before_command_echo_length
= echo_length ();
2391 previous_echo_area_message
= Qnil
;
2393 GCPRO2 (c
, previous_echo_area_message
);
2397 if (CONSP (Vunread_post_input_method_events
))
2399 c
= XCAR (Vunread_post_input_method_events
);
2400 Vunread_post_input_method_events
2401 = XCDR (Vunread_post_input_method_events
);
2403 /* Undo what read_char_x_menu_prompt did when it unread
2404 additional keys returned by Fx_popup_menu. */
2406 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2417 if (CONSP (Vunread_command_events
))
2419 bool was_disabled
= 0;
2421 c
= XCAR (Vunread_command_events
);
2422 Vunread_command_events
= XCDR (Vunread_command_events
);
2424 /* Undo what sit-for did when it unread additional keys
2425 inside universal-argument. */
2427 if (CONSP (c
) && EQ (XCAR (c
), Qt
))
2432 /* Undo what read_char_x_menu_prompt did when it unread
2433 additional keys returned by Fx_popup_menu. */
2435 && EQ (XCDR (c
), Qdisabled
)
2436 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
))))
2442 /* If the queued event is something that used the mouse,
2443 set used_mouse_menu accordingly. */
2445 /* Also check was_disabled so last-nonmenu-event won't return
2446 a bad value when submenus are involved. (Bug#447) */
2447 && (EQ (c
, Qtool_bar
) || EQ (c
, Qmenu_bar
) || was_disabled
))
2448 *used_mouse_menu
= 1;
2450 goto reread_for_input_method
;
2453 if (CONSP (Vunread_input_method_events
))
2455 c
= XCAR (Vunread_input_method_events
);
2456 Vunread_input_method_events
= XCDR (Vunread_input_method_events
);
2458 /* Undo what read_char_x_menu_prompt did when it unread
2459 additional keys returned by Fx_popup_menu. */
2461 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2465 goto reread_for_input_method
;
2468 this_command_key_count_reset
= 0;
2470 if (!NILP (Vexecuting_kbd_macro
))
2472 /* We set this to Qmacro; since that's not a frame, nobody will
2473 try to switch frames on us, and the selected window will
2476 Since this event came from a macro, it would be misleading to
2477 leave internal_last_event_frame set to wherever the last
2478 real event came from. Normally, a switch-frame event selects
2479 internal_last_event_frame after each command is read, but
2480 events read from a macro should never cause a new frame to be
2482 Vlast_event_frame
= internal_last_event_frame
= Qmacro
;
2484 /* Exit the macro if we are at the end.
2485 Also, some things replace the macro with t
2486 to force an early exit. */
2487 if (EQ (Vexecuting_kbd_macro
, Qt
)
2488 || executing_kbd_macro_index
>= XFASTINT (Flength (Vexecuting_kbd_macro
)))
2494 c
= Faref (Vexecuting_kbd_macro
, make_number (executing_kbd_macro_index
));
2495 if (STRINGP (Vexecuting_kbd_macro
)
2496 && (XFASTINT (c
) & 0x80) && (XFASTINT (c
) <= 0xff))
2497 XSETFASTINT (c
, CHAR_META
| (XFASTINT (c
) & ~0x80));
2499 executing_kbd_macro_index
++;
2504 if (!NILP (unread_switch_frame
))
2506 c
= unread_switch_frame
;
2507 unread_switch_frame
= Qnil
;
2509 /* This event should make it into this_command_keys, and get echoed
2510 again, so we do not set `reread'. */
2514 /* If redisplay was requested. */
2515 if (commandflag
>= 0)
2517 bool echo_current
= EQ (echo_message_buffer
, echo_area_buffer
[0]);
2519 /* If there is pending input, process any events which are not
2520 user-visible, such as X selection_request events. */
2522 || detect_input_pending_run_timers (0))
2523 swallow_events (false); /* May clear input_pending. */
2525 /* Redisplay if no pending input. */
2526 while (!(input_pending
2527 && (input_was_pending
|| !redisplay_dont_pause
)))
2529 input_was_pending
= input_pending
;
2530 if (help_echo_showing_p
&& !EQ (selected_window
, minibuf_window
))
2531 redisplay_preserve_echo_area (5);
2536 /* Normal case: no input arrived during redisplay. */
2539 /* Input arrived and pre-empted redisplay.
2540 Process any events which are not user-visible. */
2541 swallow_events (false);
2542 /* If that cleared input_pending, try again to redisplay. */
2545 /* Prevent the redisplay we just did
2546 from messing up echoing of the input after the prompt. */
2547 if (commandflag
== 0 && echo_current
)
2548 echo_message_buffer
= echo_area_buffer
[0];
2552 /* Message turns off echoing unless more keystrokes turn it on again.
2554 The code in 20.x for the condition was
2556 1. echo_area_glyphs && *echo_area_glyphs
2557 2. && echo_area_glyphs != current_kboard->echobuf
2558 3. && ok_to_echo_at_next_pause != echo_area_glyphs
2560 (1) means there's a current message displayed
2562 (2) means it's not the message from echoing from the current
2565 (3) There's only one place in 20.x where ok_to_echo_at_next_pause
2566 is set to a non-null value. This is done in read_char and it is
2567 set to echo_area_glyphs after a call to echo_char. That means
2568 ok_to_echo_at_next_pause is either null or
2569 current_kboard->echobuf with the appropriate current_kboard at
2572 So, condition (3) means in clear text ok_to_echo_at_next_pause
2573 must be either null, or the current message isn't from echoing at
2574 all, or it's from echoing from a different kboard than the
2577 if (/* There currently is something in the echo area. */
2578 !NILP (echo_area_buffer
[0])
2579 && (/* It's an echo from a different kboard. */
2580 echo_kboard
!= current_kboard
2581 /* Or we explicitly allow overwriting whatever there is. */
2582 || ok_to_echo_at_next_pause
== NULL
))
2587 /* Try reading a character via menu prompting in the minibuf.
2588 Try this before the sit-for, because the sit-for
2589 would do the wrong thing if we are supposed to do
2590 menu prompting. If EVENT_HAS_PARAMETERS then we are reading
2591 after a mouse event so don't try a minibuf menu. */
2593 if (KEYMAPP (map
) && INTERACTIVE
2594 && !NILP (prev_event
) && ! EVENT_HAS_PARAMETERS (prev_event
)
2595 /* Don't bring up a menu if we already have another event. */
2596 && NILP (Vunread_command_events
)
2597 && !detect_input_pending_run_timers (0))
2599 c
= read_char_minibuf_menu_prompt (commandflag
, map
);
2601 if (INTEGERP (c
) && XINT (c
) == -2)
2602 return c
; /* wrong_kboard_jmpbuf */
2608 /* Make a longjmp point for quits to use, but don't alter getcjmp just yet.
2609 We will do that below, temporarily for short sections of code,
2610 when appropriate. local_getcjmp must be in effect
2611 around any call to sit_for or kbd_buffer_get_event;
2612 it *must not* be in effect when we call redisplay. */
2614 jmpcount
= SPECPDL_INDEX ();
2615 if (sys_setjmp (local_getcjmp
))
2617 /* Handle quits while reading the keyboard. */
2618 /* We must have saved the outer value of getcjmp here,
2619 so restore it now. */
2620 restore_getcjmp (save_jump
);
2621 pthread_sigmask (SIG_SETMASK
, &empty_mask
, 0);
2622 unbind_to (jmpcount
, Qnil
);
2623 XSETINT (c
, quit_char
);
2624 internal_last_event_frame
= selected_frame
;
2625 Vlast_event_frame
= internal_last_event_frame
;
2626 /* If we report the quit char as an event,
2627 don't do so more than once. */
2628 if (!NILP (Vinhibit_quit
))
2632 KBOARD
*kb
= FRAME_KBOARD (XFRAME (selected_frame
));
2633 if (kb
!= current_kboard
)
2635 Lisp_Object last
= KVAR (kb
, kbd_queue
);
2636 /* We shouldn't get here if we were in single-kboard mode! */
2641 while (CONSP (XCDR (last
)))
2643 if (!NILP (XCDR (last
)))
2647 kset_kbd_queue (kb
, list1 (c
));
2649 XSETCDR (last
, list1 (c
));
2650 kb
->kbd_queue_has_data
= 1;
2651 current_kboard
= kb
;
2652 /* This is going to exit from read_char
2653 so we had better get rid of this frame's stuff. */
2655 return make_number (-2); /* wrong_kboard_jmpbuf */
2661 /* Start idle timers if no time limit is supplied. We don't do it
2662 if a time limit is supplied to avoid an infinite recursion in the
2663 situation where an idle timer calls `sit-for'. */
2666 timer_start_idle ();
2668 /* If in middle of key sequence and minibuffer not active,
2669 start echoing if enough time elapses. */
2671 if (minibuf_level
== 0
2673 && !current_kboard
->immediate_echo
2674 && this_command_key_count
> 0
2676 && echo_keystrokes_p ()
2677 && (/* No message. */
2678 NILP (echo_area_buffer
[0])
2679 /* Or empty message. */
2680 || (BUF_BEG (XBUFFER (echo_area_buffer
[0]))
2681 == BUF_Z (XBUFFER (echo_area_buffer
[0])))
2682 /* Or already echoing from same kboard. */
2683 || (echo_kboard
&& ok_to_echo_at_next_pause
== echo_kboard
)
2684 /* Or not echoing before and echoing allowed. */
2685 || (!echo_kboard
&& ok_to_echo_at_next_pause
)))
2687 /* After a mouse event, start echoing right away.
2688 This is because we are probably about to display a menu,
2689 and we don't want to delay before doing so. */
2690 if (EVENT_HAS_PARAMETERS (prev_event
))
2696 save_getcjmp (save_jump
);
2697 restore_getcjmp (local_getcjmp
);
2698 tem0
= sit_for (Vecho_keystrokes
, 1, 1);
2699 restore_getcjmp (save_jump
);
2701 && ! CONSP (Vunread_command_events
))
2706 /* Maybe auto save due to number of keystrokes. */
2708 if (commandflag
!= 0 && commandflag
!= -2
2709 && auto_save_interval
> 0
2710 && num_nonmacro_input_events
- last_auto_save
> max (auto_save_interval
, 20)
2711 && !detect_input_pending_run_timers (0))
2713 Fdo_auto_save (Qnil
, Qnil
);
2714 /* Hooks can actually change some buffers in auto save. */
2718 /* Try reading using an X menu.
2719 This is never confused with reading using the minibuf
2720 because the recursive call of read_char in read_char_minibuf_menu_prompt
2721 does not pass on any keymaps. */
2723 if (KEYMAPP (map
) && INTERACTIVE
2724 && !NILP (prev_event
)
2725 && EVENT_HAS_PARAMETERS (prev_event
)
2726 && !EQ (XCAR (prev_event
), Qmenu_bar
)
2727 && !EQ (XCAR (prev_event
), Qtool_bar
)
2728 /* Don't bring up a menu if we already have another event. */
2729 && NILP (Vunread_command_events
))
2731 c
= read_char_x_menu_prompt (map
, prev_event
, used_mouse_menu
);
2733 /* Now that we have read an event, Emacs is not idle. */
2740 /* Maybe autosave and/or garbage collect due to idleness. */
2742 if (INTERACTIVE
&& NILP (c
))
2745 ptrdiff_t buffer_size
;
2747 /* Slow down auto saves logarithmically in size of current buffer,
2748 and garbage collect while we're at it. */
2749 if (! MINI_WINDOW_P (XWINDOW (selected_window
)))
2750 last_non_minibuf_size
= Z
- BEG
;
2751 buffer_size
= (last_non_minibuf_size
>> 8) + 1;
2753 while (buffer_size
> 64)
2754 delay_level
++, buffer_size
-= buffer_size
>> 2;
2755 if (delay_level
< 4) delay_level
= 4;
2756 /* delay_level is 4 for files under around 50k, 7 at 100k,
2757 9 at 200k, 11 at 300k, and 12 at 500k. It is 15 at 1 meg. */
2759 /* Auto save if enough time goes by without input. */
2760 if (commandflag
!= 0 && commandflag
!= -2
2761 && num_nonmacro_input_events
> last_auto_save
2762 && INTEGERP (Vauto_save_timeout
)
2763 && XINT (Vauto_save_timeout
) > 0)
2766 EMACS_INT timeout
= XFASTINT (Vauto_save_timeout
);
2768 timeout
= min (timeout
, MOST_POSITIVE_FIXNUM
/ delay_level
* 4);
2769 timeout
= delay_level
* timeout
/ 4;
2770 save_getcjmp (save_jump
);
2771 restore_getcjmp (local_getcjmp
);
2772 tem0
= sit_for (make_number (timeout
), 1, 1);
2773 restore_getcjmp (save_jump
);
2776 && ! CONSP (Vunread_command_events
))
2778 Fdo_auto_save (Qnil
, Qnil
);
2783 /* If there is still no input available, ask for GC. */
2784 if (!detect_input_pending_run_timers (0))
2788 /* Notify the caller if an autosave hook, or a timer, sentinel or
2789 filter in the sit_for calls above have changed the current
2790 kboard. This could happen if they use the minibuffer or start a
2791 recursive edit, like the fancy splash screen in server.el's
2792 filter. If this longjmp wasn't here, read_key_sequence would
2793 interpret the next key sequence using the wrong translation
2794 tables and function keymaps. */
2795 if (NILP (c
) && current_kboard
!= orig_kboard
)
2798 return make_number (-2); /* wrong_kboard_jmpbuf */
2801 /* If this has become non-nil here, it has been set by a timer
2802 or sentinel or filter. */
2803 if (CONSP (Vunread_command_events
))
2805 c
= XCAR (Vunread_command_events
);
2806 Vunread_command_events
= XCDR (Vunread_command_events
);
2808 if (CONSP (c
) && EQ (XCAR (c
), Qt
))
2814 /* Read something from current KBOARD's side queue, if possible. */
2818 if (current_kboard
->kbd_queue_has_data
)
2820 if (!CONSP (KVAR (current_kboard
, kbd_queue
)))
2822 c
= XCAR (KVAR (current_kboard
, kbd_queue
));
2823 kset_kbd_queue (current_kboard
,
2824 XCDR (KVAR (current_kboard
, kbd_queue
)));
2825 if (NILP (KVAR (current_kboard
, kbd_queue
)))
2826 current_kboard
->kbd_queue_has_data
= 0;
2827 input_pending
= readable_events (0);
2828 if (EVENT_HAS_PARAMETERS (c
)
2829 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qswitch_frame
))
2830 internal_last_event_frame
= XCAR (XCDR (c
));
2831 Vlast_event_frame
= internal_last_event_frame
;
2835 /* If current_kboard's side queue is empty check the other kboards.
2836 If one of them has data that we have not yet seen here,
2837 switch to it and process the data waiting for it.
2839 Note: if the events queued up for another kboard
2840 have already been seen here, and therefore are not a complete command,
2841 the kbd_queue_has_data field is 0, so we skip that kboard here.
2842 That's to avoid an infinite loop switching between kboards here. */
2843 if (NILP (c
) && !single_kboard
)
2846 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
2847 if (kb
->kbd_queue_has_data
)
2849 current_kboard
= kb
;
2850 /* This is going to exit from read_char
2851 so we had better get rid of this frame's stuff. */
2853 return make_number (-2); /* wrong_kboard_jmpbuf */
2863 c
= read_decoded_event_from_main_queue (end_time
, local_getcjmp
,
2864 prev_event
, used_mouse_menu
);
2865 if (NILP (c
) && end_time
2866 && timespec_cmp (*end_time
, current_timespec ()) <= 0)
2871 if (EQ (c
, make_number (-2)))
2873 /* This is going to exit from read_char
2874 so we had better get rid of this frame's stuff. */
2888 if (commandflag
>= 0
2889 && !input_pending
&& !detect_input_pending_run_timers (0))
2895 /* Buffer switch events are only for internal wakeups
2896 so don't show them to the user.
2897 Also, don't record a key if we already did. */
2901 /* Process special events within read_char
2902 and loop around to read another event. */
2905 tem
= access_keymap (get_keymap (Vspecial_event_map
, 0, 1), c
, 0, 0, 1);
2910 struct buffer
*prev_buffer
= current_buffer
;
2911 last_input_event
= c
;
2912 call4 (Qcommand_execute
, tem
, Qnil
, Fvector (1, &last_input_event
), Qt
);
2914 if (CONSP (c
) && EQ (XCAR (c
), Qselect_window
) && !end_time
)
2915 /* We stopped being idle for this event; undo that. This
2916 prevents automatic window selection (under
2917 mouse_autoselect_window from acting as a real input event, for
2918 example banishing the mouse under mouse-avoidance-mode. */
2919 timer_resume_idle ();
2921 if (current_buffer
!= prev_buffer
)
2923 /* The command may have changed the keymaps. Pretend there
2924 is input in another keyboard and return. This will
2925 recalculate keymaps. */
2926 c
= make_number (-2);
2933 /* Handle things that only apply to characters. */
2936 /* If kbd_buffer_get_event gave us an EOF, return that. */
2940 if ((STRINGP (KVAR (current_kboard
, Vkeyboard_translate_table
))
2941 && UNSIGNED_CMP (XFASTINT (c
), <,
2942 SCHARS (KVAR (current_kboard
,
2943 Vkeyboard_translate_table
))))
2944 || (VECTORP (KVAR (current_kboard
, Vkeyboard_translate_table
))
2945 && UNSIGNED_CMP (XFASTINT (c
), <,
2946 ASIZE (KVAR (current_kboard
,
2947 Vkeyboard_translate_table
))))
2948 || (CHAR_TABLE_P (KVAR (current_kboard
, Vkeyboard_translate_table
))
2952 d
= Faref (KVAR (current_kboard
, Vkeyboard_translate_table
), c
);
2953 /* nil in keyboard-translate-table means no translation. */
2959 /* If this event is a mouse click in the menu bar,
2960 return just menu-bar for now. Modify the mouse click event
2961 so we won't do this twice, then queue it up. */
2962 if (EVENT_HAS_PARAMETERS (c
)
2964 && CONSP (EVENT_START (c
))
2965 && CONSP (XCDR (EVENT_START (c
))))
2969 posn
= POSN_POSN (EVENT_START (c
));
2970 /* Handle menu-bar events:
2971 insert the dummy prefix event `menu-bar'. */
2972 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
2974 /* Change menu-bar to (menu-bar) as the event "position". */
2975 POSN_SET_POSN (EVENT_START (c
), list1 (posn
));
2978 Vunread_command_events
= Fcons (c
, Vunread_command_events
);
2983 /* Store these characters into recent_keys, the dribble file if any,
2984 and the keyboard macro being defined, if any. */
2986 if (! NILP (also_record
))
2987 record_char (also_record
);
2989 /* Wipe the echo area.
2990 But first, if we are about to use an input method,
2991 save the echo area contents for it to refer to. */
2993 && ! NILP (Vinput_method_function
)
2994 && ' ' <= XINT (c
) && XINT (c
) < 256 && XINT (c
) != 127)
2996 previous_echo_area_message
= Fcurrent_message ();
2997 Vinput_method_previous_message
= previous_echo_area_message
;
3000 /* Now wipe the echo area, except for help events which do their
3001 own stuff with the echo area. */
3003 || (!(EQ (Qhelp_echo
, XCAR (c
)))
3004 && !(EQ (Qswitch_frame
, XCAR (c
)))
3005 /* Don't wipe echo area for select window events: These might
3006 get delayed via `mouse-autoselect-window' (Bug#11304). */
3007 && !(EQ (Qselect_window
, XCAR (c
)))))
3009 if (!NILP (echo_area_buffer
[0]))
3011 safe_run_hooks (Qecho_area_clear_hook
);
3012 clear_message (1, 0);
3016 reread_for_input_method
:
3018 /* Pass this to the input method, if appropriate. */
3020 && ! NILP (Vinput_method_function
)
3021 /* Don't run the input method within a key sequence,
3022 after the first event of the key sequence. */
3023 && NILP (prev_event
)
3024 && ' ' <= XINT (c
) && XINT (c
) < 256 && XINT (c
) != 127)
3027 ptrdiff_t key_count
;
3028 bool key_count_reset
;
3029 ptrdiff_t command_key_start
;
3030 struct gcpro gcpro1
;
3031 ptrdiff_t count
= SPECPDL_INDEX ();
3033 /* Save the echo status. */
3034 bool saved_immediate_echo
= current_kboard
->immediate_echo
;
3035 struct kboard
*saved_ok_to_echo
= ok_to_echo_at_next_pause
;
3036 Lisp_Object saved_echo_string
= KVAR (current_kboard
, echo_string
);
3037 ptrdiff_t saved_echo_after_prompt
= current_kboard
->echo_after_prompt
;
3040 if (before_command_restore_flag
)
3042 this_command_key_count
= before_command_key_count_1
;
3043 if (this_command_key_count
< this_single_command_key_start
)
3044 this_single_command_key_start
= this_command_key_count
;
3045 echo_truncate (before_command_echo_length_1
);
3046 before_command_restore_flag
= 0;
3050 /* Save the this_command_keys status. */
3051 key_count
= this_command_key_count
;
3052 key_count_reset
= this_command_key_count_reset
;
3053 command_key_start
= this_single_command_key_start
;
3056 keys
= Fcopy_sequence (this_command_keys
);
3061 /* Clear out this_command_keys. */
3062 this_command_key_count
= 0;
3063 this_command_key_count_reset
= 0;
3064 this_single_command_key_start
= 0;
3066 /* Now wipe the echo area. */
3067 if (!NILP (echo_area_buffer
[0]))
3068 safe_run_hooks (Qecho_area_clear_hook
);
3069 clear_message (1, 0);
3072 /* If we are not reading a key sequence,
3073 never use the echo area. */
3076 specbind (Qinput_method_use_echo_area
, Qt
);
3079 /* Call the input method. */
3080 tem
= call1 (Vinput_method_function
, c
);
3082 tem
= unbind_to (count
, tem
);
3084 /* Restore the saved echoing state
3085 and this_command_keys state. */
3086 this_command_key_count
= key_count
;
3087 this_command_key_count_reset
= key_count_reset
;
3088 this_single_command_key_start
= command_key_start
;
3090 this_command_keys
= keys
;
3093 ok_to_echo_at_next_pause
= saved_ok_to_echo
;
3094 /* Do not restore the echo area string when the user is
3095 introducing a prefix argument. Otherwise we end with
3096 repetitions of the partially introduced prefix
3097 argument. (bug#19875) */
3098 if (NILP (intern ("prefix-arg")))
3100 kset_echo_string (current_kboard
, saved_echo_string
);
3102 current_kboard
->echo_after_prompt
= saved_echo_after_prompt
;
3103 if (saved_immediate_echo
)
3108 /* The input method can return no events. */
3111 /* Bring back the previous message, if any. */
3112 if (! NILP (previous_echo_area_message
))
3113 message_with_string ("%s", previous_echo_area_message
, 0);
3116 /* It returned one event or more. */
3118 Vunread_post_input_method_events
3119 = nconc2 (XCDR (tem
), Vunread_post_input_method_events
);
3124 /* Display help if not echoing. */
3125 if (CONSP (c
) && EQ (XCAR (c
), Qhelp_echo
))
3127 /* (help-echo FRAME HELP WINDOW OBJECT POS). */
3128 Lisp_Object help
, object
, position
, window
, htem
;
3130 htem
= Fcdr (XCDR (c
));
3133 window
= Fcar (htem
);
3135 object
= Fcar (htem
);
3137 position
= Fcar (htem
);
3139 show_help_echo (help
, window
, object
, position
);
3141 /* We stopped being idle for this event; undo that. */
3143 timer_resume_idle ();
3147 if ((! reread
|| this_command_key_count
== 0
3148 || this_command_key_count_reset
)
3152 /* Don't echo mouse motion events. */
3153 if (echo_keystrokes_p ()
3154 && ! (EVENT_HAS_PARAMETERS (c
)
3155 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
3158 if (! NILP (also_record
))
3159 echo_char (also_record
);
3160 /* Once we reread a character, echoing can happen
3161 the next time we pause to read a new one. */
3162 ok_to_echo_at_next_pause
= current_kboard
;
3165 /* Record this character as part of the current key. */
3166 add_command_key (c
);
3167 if (! NILP (also_record
))
3168 add_command_key (also_record
);
3171 last_input_event
= c
;
3174 /* Process the help character specially if enabled. */
3175 if (!NILP (Vhelp_form
) && help_char_p (c
))
3177 ptrdiff_t count
= SPECPDL_INDEX ();
3179 help_form_saved_window_configs
3180 = Fcons (Fcurrent_window_configuration (Qnil
),
3181 help_form_saved_window_configs
);
3182 record_unwind_protect_void (read_char_help_form_unwind
);
3183 call0 (Qhelp_form_show
);
3188 c
= read_char (0, Qnil
, Qnil
, 0, NULL
);
3189 if (EVENT_HAS_PARAMETERS (c
)
3190 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_click
))
3191 XSETCAR (help_form_saved_window_configs
, Qnil
);
3193 while (BUFFERP (c
));
3194 /* Remove the help from the frame. */
3195 unbind_to (count
, Qnil
);
3198 if (EQ (c
, make_number (040)))
3202 c
= read_char (0, Qnil
, Qnil
, 0, NULL
);
3203 while (BUFFERP (c
));
3209 input_was_pending
= input_pending
;
3213 /* Record a key that came from a mouse menu.
3214 Record it for echoing, for this-command-keys, and so on. */
3217 record_menu_key (Lisp_Object c
)
3219 /* Wipe the echo area. */
3220 clear_message (1, 0);
3225 before_command_key_count
= this_command_key_count
;
3226 before_command_echo_length
= echo_length ();
3229 /* Don't echo mouse motion events. */
3230 if (echo_keystrokes_p ())
3234 /* Once we reread a character, echoing can happen
3235 the next time we pause to read a new one. */
3236 ok_to_echo_at_next_pause
= 0;
3239 /* Record this character as part of the current key. */
3240 add_command_key (c
);
3242 /* Re-reading in the middle of a command. */
3243 last_input_event
= c
;
3247 /* Return true if should recognize C as "the help character". */
3250 help_char_p (Lisp_Object c
)
3254 if (EQ (c
, Vhelp_char
))
3256 for (tail
= Vhelp_event_list
; CONSP (tail
); tail
= XCDR (tail
))
3257 if (EQ (c
, XCAR (tail
)))
3262 /* Record the input event C in various ways. */
3265 record_char (Lisp_Object c
)
3269 if (CONSP (c
) && (EQ (XCAR (c
), Qhelp_echo
) || EQ (XCAR (c
), Qmouse_movement
)))
3271 /* To avoid filling recent_keys with help-echo and mouse-movement
3272 events, we filter out repeated help-echo events, only store the
3273 first and last in a series of mouse-movement events, and don't
3274 store repeated help-echo events which are only separated by
3275 mouse-movement events. */
3277 Lisp_Object ev1
, ev2
, ev3
;
3280 if ((ix1
= recent_keys_index
- 1) < 0)
3281 ix1
= NUM_RECENT_KEYS
- 1;
3282 ev1
= AREF (recent_keys
, ix1
);
3284 if ((ix2
= ix1
- 1) < 0)
3285 ix2
= NUM_RECENT_KEYS
- 1;
3286 ev2
= AREF (recent_keys
, ix2
);
3288 if ((ix3
= ix2
- 1) < 0)
3289 ix3
= NUM_RECENT_KEYS
- 1;
3290 ev3
= AREF (recent_keys
, ix3
);
3292 if (EQ (XCAR (c
), Qhelp_echo
))
3294 /* Don't record `help-echo' in recent_keys unless it shows some help
3295 message, and a different help than the previously recorded
3297 Lisp_Object help
, last_help
;
3299 help
= Fcar_safe (Fcdr_safe (XCDR (c
)));
3300 if (!STRINGP (help
))
3302 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qhelp_echo
)
3303 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev1
))), EQ (last_help
, help
)))
3305 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3306 && CONSP (ev2
) && EQ (XCAR (ev2
), Qhelp_echo
)
3307 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev2
))), EQ (last_help
, help
)))
3309 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3310 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3311 && CONSP (ev3
) && EQ (XCAR (ev3
), Qhelp_echo
)
3312 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev3
))), EQ (last_help
, help
)))
3315 else if (EQ (XCAR (c
), Qmouse_movement
))
3317 /* Only record one pair of `mouse-movement' on a window in recent_keys.
3318 So additional mouse movement events replace the last element. */
3319 Lisp_Object last_window
, window
;
3321 window
= Fcar_safe (Fcar_safe (XCDR (c
)));
3322 if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3323 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev1
))), EQ (last_window
, window
))
3324 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3325 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev2
))), EQ (last_window
, window
)))
3327 ASET (recent_keys
, ix1
, c
);
3333 store_kbd_macro_char (c
);
3337 total_keys
+= total_keys
< NUM_RECENT_KEYS
;
3338 ASET (recent_keys
, recent_keys_index
, c
);
3339 if (++recent_keys_index
>= NUM_RECENT_KEYS
)
3340 recent_keys_index
= 0;
3342 else if (recorded
< 0)
3344 /* We need to remove one or two events from recent_keys.
3345 To do this, we simply put nil at those events and move the
3346 recent_keys_index backwards over those events. Usually,
3347 users will never see those nil events, as they will be
3348 overwritten by the command keys entered to see recent_keys
3351 while (recorded
++ < 0 && total_keys
> 0)
3353 if (total_keys
< NUM_RECENT_KEYS
)
3355 if (--recent_keys_index
< 0)
3356 recent_keys_index
= NUM_RECENT_KEYS
- 1;
3357 ASET (recent_keys
, recent_keys_index
, Qnil
);
3361 num_nonmacro_input_events
++;
3363 /* Write c to the dribble file. If c is a lispy event, write
3364 the event's symbol to the dribble file, in <brackets>. Bleaugh.
3365 If you, dear reader, have a better idea, you've got the source. :-) */
3371 if (XUINT (c
) < 0x100)
3372 putc (XUINT (c
), dribble
);
3374 fprintf (dribble
, " 0x%"pI
"x", XUINT (c
));
3378 Lisp_Object dribblee
;
3380 /* If it's a structured event, take the event header. */
3381 dribblee
= EVENT_HEAD (c
);
3383 if (SYMBOLP (dribblee
))
3385 putc ('<', dribble
);
3386 fwrite (SDATA (SYMBOL_NAME (dribblee
)), sizeof (char),
3387 SBYTES (SYMBOL_NAME (dribblee
)),
3389 putc ('>', dribble
);
3398 /* Copy out or in the info on where C-g should throw to.
3399 This is used when running Lisp code from within get_char,
3400 in case get_char is called recursively.
3401 See read_process_output. */
3404 save_getcjmp (sys_jmp_buf temp
)
3406 memcpy (temp
, getcjmp
, sizeof getcjmp
);
3410 restore_getcjmp (sys_jmp_buf temp
)
3412 memcpy (getcjmp
, temp
, sizeof getcjmp
);
3415 /* Low level keyboard/mouse input.
3416 kbd_buffer_store_event places events in kbd_buffer, and
3417 kbd_buffer_get_event retrieves them. */
3419 /* Return true if there are any events in the queue that read-char
3420 would return. If this returns false, a read-char would block. */
3422 readable_events (int flags
)
3424 if (flags
& READABLE_EVENTS_DO_TIMERS_NOW
)
3427 /* If the buffer contains only FOCUS_IN_EVENT events, and
3428 READABLE_EVENTS_FILTER_EVENTS is set, report it as empty. */
3429 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3431 if (flags
& (READABLE_EVENTS_FILTER_EVENTS
3432 #ifdef USE_TOOLKIT_SCROLL_BARS
3433 | READABLE_EVENTS_IGNORE_SQUEEZABLES
3437 union buffered_input_event
*event
;
3439 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
3446 #ifdef USE_TOOLKIT_SCROLL_BARS
3447 (flags
& READABLE_EVENTS_FILTER_EVENTS
) &&
3449 event
->kind
== FOCUS_IN_EVENT
)
3450 #ifdef USE_TOOLKIT_SCROLL_BARS
3451 && !((flags
& READABLE_EVENTS_IGNORE_SQUEEZABLES
)
3452 && (event
->kind
== SCROLL_BAR_CLICK_EVENT
3453 || event
->kind
== HORIZONTAL_SCROLL_BAR_CLICK_EVENT
)
3454 && event
->ie
.part
== scroll_bar_handle
3455 && event
->ie
.modifiers
== 0)
3457 && !((flags
& READABLE_EVENTS_FILTER_EVENTS
)
3458 && event
->kind
== BUFFER_SWITCH_EVENT
))
3461 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3464 while (event
!= kbd_store_ptr
);
3470 if (!(flags
& READABLE_EVENTS_IGNORE_SQUEEZABLES
)
3471 && !NILP (do_mouse_tracking
) && some_mouse_moved ())
3475 if (current_kboard
->kbd_queue_has_data
)
3481 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
3482 if (kb
->kbd_queue_has_data
)
3488 /* Set this for debugging, to have a way to get out */
3489 int stop_character EXTERNALLY_VISIBLE
;
3492 event_to_kboard (struct input_event
*event
)
3494 /* Not applicable for these special events. */
3495 if (event
->kind
== SELECTION_REQUEST_EVENT
3496 || event
->kind
== SELECTION_CLEAR_EVENT
)
3500 Lisp_Object obj
= event
->frame_or_window
;
3501 /* There are some events that set this field to nil or string. */
3503 obj
= WINDOW_FRAME (XWINDOW (obj
));
3504 /* Also ignore dead frames here. */
3505 return ((FRAMEP (obj
) && FRAME_LIVE_P (XFRAME (obj
)))
3506 ? FRAME_KBOARD (XFRAME (obj
)) : NULL
);
3511 /* Return the number of slots occupied in kbd_buffer. */
3514 kbd_buffer_nr_stored (void)
3516 return kbd_fetch_ptr
== kbd_store_ptr
3518 : (kbd_fetch_ptr
< kbd_store_ptr
3519 ? kbd_store_ptr
- kbd_fetch_ptr
3520 : ((kbd_buffer
+ KBD_BUFFER_SIZE
) - kbd_fetch_ptr
3521 + (kbd_store_ptr
- kbd_buffer
)));
3523 #endif /* Store an event obtained at interrupt level into kbd_buffer, fifo */
3526 kbd_buffer_store_event (register struct input_event
*event
)
3528 kbd_buffer_store_event_hold (event
, 0);
3531 /* Store EVENT obtained at interrupt level into kbd_buffer, fifo.
3533 If HOLD_QUIT is 0, just stuff EVENT into the fifo.
3534 Else, if HOLD_QUIT.kind != NO_EVENT, discard EVENT.
3535 Else, if EVENT is a quit event, store the quit event
3536 in HOLD_QUIT, and return (thus ignoring further events).
3538 This is used to postpone the processing of the quit event until all
3539 subsequent input events have been parsed (and discarded). */
3542 kbd_buffer_store_buffered_event (union buffered_input_event
*event
,
3543 struct input_event
*hold_quit
)
3545 if (event
->kind
== NO_EVENT
)
3548 if (hold_quit
&& hold_quit
->kind
!= NO_EVENT
)
3551 if (event
->kind
== ASCII_KEYSTROKE_EVENT
)
3553 int c
= event
->ie
.code
& 0377;
3555 if (event
->ie
.modifiers
& ctrl_modifier
)
3556 c
= make_ctrl_char (c
);
3558 c
|= (event
->ie
.modifiers
3559 & (meta_modifier
| alt_modifier
3560 | hyper_modifier
| super_modifier
));
3564 KBOARD
*kb
= FRAME_KBOARD (XFRAME (event
->ie
.frame_or_window
));
3566 if (single_kboard
&& kb
!= current_kboard
)
3569 (kb
, list2 (make_lispy_switch_frame (event
->ie
.frame_or_window
),
3571 kb
->kbd_queue_has_data
= 1;
3572 union buffered_input_event
*sp
;
3573 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3575 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3578 if (event_to_kboard (&sp
->ie
) == kb
)
3580 sp
->ie
.kind
= NO_EVENT
;
3581 sp
->ie
.frame_or_window
= Qnil
;
3590 *hold_quit
= event
->ie
;
3594 /* If this results in a quit_char being returned to Emacs as
3595 input, set Vlast_event_frame properly. If this doesn't
3596 get returned to Emacs as an event, the next event read
3597 will set Vlast_event_frame again, so this is safe to do. */
3601 focus
= FRAME_FOCUS_FRAME (XFRAME (event
->ie
.frame_or_window
));
3603 focus
= event
->ie
.frame_or_window
;
3604 internal_last_event_frame
= focus
;
3605 Vlast_event_frame
= focus
;
3608 handle_interrupt (0);
3612 if (c
&& c
== stop_character
)
3618 /* Don't insert two BUFFER_SWITCH_EVENT's in a row.
3619 Just ignore the second one. */
3620 else if (event
->kind
== BUFFER_SWITCH_EVENT
3621 && kbd_fetch_ptr
!= kbd_store_ptr
3622 && ((kbd_store_ptr
== kbd_buffer
3623 ? kbd_buffer
+ KBD_BUFFER_SIZE
- 1
3624 : kbd_store_ptr
- 1)->kind
) == BUFFER_SWITCH_EVENT
)
3627 if (kbd_store_ptr
- kbd_buffer
== KBD_BUFFER_SIZE
)
3628 kbd_store_ptr
= kbd_buffer
;
3630 /* Don't let the very last slot in the buffer become full,
3631 since that would make the two pointers equal,
3632 and that is indistinguishable from an empty buffer.
3633 Discard the event if it would fill the last slot. */
3634 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
3636 *kbd_store_ptr
= *event
;
3639 if (kbd_buffer_nr_stored () > KBD_BUFFER_SIZE
/ 2
3640 && ! kbd_on_hold_p ())
3642 /* Don't read keyboard input until we have processed kbd_buffer.
3643 This happens when pasting text longer than KBD_BUFFER_SIZE/2. */
3644 hold_keyboard_input ();
3648 #endif /* subprocesses */
3651 /* If we're inside while-no-input, and this event qualifies
3652 as input, set quit-flag to cause an interrupt. */
3653 if (!NILP (Vthrow_on_input
)
3654 && event
->kind
!= FOCUS_IN_EVENT
3655 && event
->kind
!= FOCUS_OUT_EVENT
3656 && event
->kind
!= HELP_EVENT
3657 && event
->kind
!= ICONIFY_EVENT
3658 && event
->kind
!= DEICONIFY_EVENT
)
3660 Vquit_flag
= Vthrow_on_input
;
3661 /* If we're inside a function that wants immediate quits,
3663 if (immediate_quit
&& NILP (Vinhibit_quit
))
3674 /* Put a selection input event back in the head of the event queue. */
3677 kbd_buffer_unget_event (struct selection_input_event
*event
)
3679 if (kbd_fetch_ptr
== kbd_buffer
)
3680 kbd_fetch_ptr
= kbd_buffer
+ KBD_BUFFER_SIZE
;
3682 /* Don't let the very last slot in the buffer become full, */
3683 union buffered_input_event
*kp
= kbd_fetch_ptr
- 1;
3684 if (kp
!= kbd_store_ptr
)
3693 /* Limit help event positions to this range, to avoid overflow problems. */
3694 #define INPUT_EVENT_POS_MAX \
3695 ((ptrdiff_t) min (PTRDIFF_MAX, min (TYPE_MAXIMUM (Time) / 2, \
3696 MOST_POSITIVE_FIXNUM)))
3697 #define INPUT_EVENT_POS_MIN (-1 - INPUT_EVENT_POS_MAX)
3699 /* Return a Time that encodes position POS. POS must be in range. */
3702 position_to_Time (ptrdiff_t pos
)
3704 eassert (INPUT_EVENT_POS_MIN
<= pos
&& pos
<= INPUT_EVENT_POS_MAX
);
3708 /* Return the position that ENCODED_POS encodes.
3709 Avoid signed integer overflow. */
3712 Time_to_position (Time encoded_pos
)
3714 if (encoded_pos
<= INPUT_EVENT_POS_MAX
)
3716 Time encoded_pos_min
= INPUT_EVENT_POS_MIN
;
3717 eassert (encoded_pos_min
<= encoded_pos
);
3718 ptrdiff_t notpos
= -1 - encoded_pos
;
3722 /* Generate a HELP_EVENT input_event and store it in the keyboard
3725 HELP is the help form.
3727 FRAME and WINDOW are the frame and window where the help is
3728 generated. OBJECT is the Lisp object where the help was found (a
3729 buffer, a string, an overlay, or nil if neither from a string nor
3730 from a buffer). POS is the position within OBJECT where the help
3734 gen_help_event (Lisp_Object help
, Lisp_Object frame
, Lisp_Object window
,
3735 Lisp_Object object
, ptrdiff_t pos
)
3737 struct input_event event
;
3739 event
.kind
= HELP_EVENT
;
3740 event
.frame_or_window
= frame
;
3742 event
.x
= WINDOWP (window
) ? window
: frame
;
3744 event
.timestamp
= position_to_Time (pos
);
3745 kbd_buffer_store_event (&event
);
3749 /* Store HELP_EVENTs for HELP on FRAME in the input queue. */
3752 kbd_buffer_store_help_event (Lisp_Object frame
, Lisp_Object help
)
3754 struct input_event event
;
3756 event
.kind
= HELP_EVENT
;
3757 event
.frame_or_window
= frame
;
3761 event
.timestamp
= 0;
3762 kbd_buffer_store_event (&event
);
3766 /* Discard any mouse events in the event buffer by setting them to
3769 discard_mouse_events (void)
3771 union buffered_input_event
*sp
;
3772 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3774 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3777 if (sp
->kind
== MOUSE_CLICK_EVENT
3778 || sp
->kind
== WHEEL_EVENT
3779 || sp
->kind
== HORIZ_WHEEL_EVENT
3781 || sp
->kind
== GPM_CLICK_EVENT
3783 || sp
->kind
== SCROLL_BAR_CLICK_EVENT
3784 || sp
->kind
== HORIZONTAL_SCROLL_BAR_CLICK_EVENT
)
3786 sp
->kind
= NO_EVENT
;
3792 /* Return true if there are any real events waiting in the event
3793 buffer, not counting `NO_EVENT's.
3795 Discard NO_EVENT events at the front of the input queue, possibly
3796 leaving the input queue empty if there are no real input events. */
3799 kbd_buffer_events_waiting (void)
3801 union buffered_input_event
*sp
;
3803 for (sp
= kbd_fetch_ptr
;
3804 sp
!= kbd_store_ptr
&& sp
->kind
== NO_EVENT
;
3807 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3812 return sp
!= kbd_store_ptr
&& sp
->kind
!= NO_EVENT
;
3816 /* Clear input event EVENT. */
3819 clear_event (union buffered_input_event
*event
)
3821 event
->kind
= NO_EVENT
;
3825 /* Read one event from the event buffer, waiting if necessary.
3826 The value is a Lisp object representing the event.
3827 The value is nil for an event that should be ignored,
3828 or that was handled here.
3829 We always read and discard one event. */
3832 kbd_buffer_get_event (KBOARD
**kbp
,
3833 bool *used_mouse_menu
,
3834 struct timespec
*end_time
)
3839 if (kbd_on_hold_p () && kbd_buffer_nr_stored () < KBD_BUFFER_SIZE
/ 4)
3841 /* Start reading input again because we have processed enough to
3842 be able to accept new events again. */
3843 unhold_keyboard_input ();
3847 #endif /* subprocesses */
3849 #if !defined HAVE_DBUS && !defined USE_FILE_NOTIFY
3851 /* In case we are running as a daemon, only do this before
3852 detaching from the terminal. */
3853 || (IS_DAEMON
&& DAEMON_RUNNING
))
3857 *kbp
= current_kboard
;
3860 #endif /* !defined HAVE_DBUS && !defined USE_FILE_NOTIFY */
3862 /* Wait until there is input available. */
3865 /* Break loop if there's an unread command event. Needed in
3866 moused window autoselection which uses a timer to insert such
3868 if (CONSP (Vunread_command_events
))
3871 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3873 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3876 /* If the quit flag is set, then read_char will return
3877 quit_char, so that counts as "available input." */
3878 if (!NILP (Vquit_flag
))
3879 quit_throw_to_read_char (0);
3881 /* One way or another, wait until input is available; then, if
3882 interrupt handlers have not read it, read it now. */
3887 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3889 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3893 struct timespec now
= current_timespec ();
3894 if (timespec_cmp (*end_time
, now
) <= 0)
3895 return Qnil
; /* Finished waiting. */
3898 struct timespec duration
= timespec_sub (*end_time
, now
);
3899 wait_reading_process_output (min (duration
.tv_sec
,
3902 -1, 1, Qnil
, NULL
, 0);
3907 bool do_display
= true;
3909 if (FRAME_TERMCAP_P (SELECTED_FRAME ()))
3911 struct tty_display_info
*tty
= CURTTY ();
3913 /* When this TTY is displaying a menu, we must prevent
3914 any redisplay, because we modify the frame's glyph
3915 matrix behind the back of the display engine. */
3916 if (tty
->showing_menu
)
3920 wait_reading_process_output (0, 0, -1, do_display
, Qnil
, NULL
, 0);
3923 if (!interrupt_input
&& kbd_fetch_ptr
== kbd_store_ptr
)
3927 if (CONSP (Vunread_command_events
))
3930 first
= XCAR (Vunread_command_events
);
3931 Vunread_command_events
= XCDR (Vunread_command_events
);
3932 *kbp
= current_kboard
;
3936 /* At this point, we know that there is a readable event available
3937 somewhere. If the event queue is empty, then there must be a
3938 mouse movement enabled and available. */
3939 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3941 union buffered_input_event
*event
;
3943 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
3947 *kbp
= event_to_kboard (&event
->ie
);
3949 *kbp
= current_kboard
; /* Better than returning null ptr? */
3953 /* These two kinds of events get special handling
3954 and don't actually appear to the command loop.
3955 We return nil for them. */
3956 if (event
->kind
== SELECTION_REQUEST_EVENT
3957 || event
->kind
== SELECTION_CLEAR_EVENT
)
3960 /* Remove it from the buffer before processing it,
3961 since otherwise swallow_events will see it
3962 and process it again. */
3963 struct selection_input_event copy
= event
->sie
;
3964 kbd_fetch_ptr
= event
+ 1;
3965 input_pending
= readable_events (0);
3966 x_handle_selection_event (©
);
3968 /* We're getting selection request events, but we don't have
3974 #if defined (HAVE_NS)
3975 else if (event
->kind
== NS_TEXT_EVENT
)
3977 if (event
->ie
.code
== KEY_NS_PUT_WORKING_TEXT
)
3978 obj
= list1 (intern ("ns-put-working-text"));
3980 obj
= list1 (intern ("ns-unput-working-text"));
3981 kbd_fetch_ptr
= event
+ 1;
3982 if (used_mouse_menu
)
3983 *used_mouse_menu
= 1;
3987 #if defined (HAVE_X11) || defined (HAVE_NTGUI) \
3988 || defined (HAVE_NS)
3989 else if (event
->kind
== DELETE_WINDOW_EVENT
)
3991 /* Make an event (delete-frame (FRAME)). */
3992 obj
= list2 (Qdelete_frame
, list1 (event
->ie
.frame_or_window
));
3993 kbd_fetch_ptr
= event
+ 1;
3996 #if defined (HAVE_X11) || defined (HAVE_NTGUI) \
3997 || defined (HAVE_NS)
3998 else if (event
->kind
== ICONIFY_EVENT
)
4000 /* Make an event (iconify-frame (FRAME)). */
4001 obj
= list2 (Qiconify_frame
, list1 (event
->ie
.frame_or_window
));
4002 kbd_fetch_ptr
= event
+ 1;
4004 else if (event
->kind
== DEICONIFY_EVENT
)
4006 /* Make an event (make-frame-visible (FRAME)). */
4007 obj
= list2 (Qmake_frame_visible
, list1 (event
->ie
.frame_or_window
));
4008 kbd_fetch_ptr
= event
+ 1;
4011 else if (event
->kind
== BUFFER_SWITCH_EVENT
)
4013 /* The value doesn't matter here; only the type is tested. */
4014 XSETBUFFER (obj
, current_buffer
);
4015 kbd_fetch_ptr
= event
+ 1;
4017 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
4018 || defined (HAVE_NS) || defined (USE_GTK)
4019 else if (event
->kind
== MENU_BAR_ACTIVATE_EVENT
)
4021 kbd_fetch_ptr
= event
+ 1;
4022 input_pending
= readable_events (0);
4023 if (FRAME_LIVE_P (XFRAME (event
->ie
.frame_or_window
)))
4024 x_activate_menubar (XFRAME (event
->ie
.frame_or_window
));
4028 else if (event
->kind
== LANGUAGE_CHANGE_EVENT
)
4030 /* Make an event (language-change FRAME CODEPAGE LANGUAGE-ID). */
4031 obj
= list4 (Qlanguage_change
,
4032 event
->ie
.frame_or_window
,
4033 make_number (event
->ie
.code
),
4034 make_number (event
->ie
.modifiers
));
4035 kbd_fetch_ptr
= event
+ 1;
4038 #ifdef USE_FILE_NOTIFY
4039 else if (event
->kind
== FILE_NOTIFY_EVENT
)
4041 #ifdef HAVE_W32NOTIFY
4042 /* Make an event (file-notify (DESCRIPTOR ACTION FILE) CALLBACK). */
4043 obj
= list3 (Qfile_notify
, event
->ie
.arg
, event
->ie
.frame_or_window
);
4045 obj
= make_lispy_event (&event
->ie
);
4047 kbd_fetch_ptr
= event
+ 1;
4049 #endif /* USE_FILE_NOTIFY */
4050 else if (event
->kind
== SAVE_SESSION_EVENT
)
4052 obj
= list2 (Qsave_session
, event
->ie
.arg
);
4053 kbd_fetch_ptr
= event
+ 1;
4055 /* Just discard these, by returning nil.
4056 With MULTI_KBOARD, these events are used as placeholders
4057 when we need to randomly delete events from the queue.
4058 (They shouldn't otherwise be found in the buffer,
4059 but on some machines it appears they do show up
4060 even without MULTI_KBOARD.) */
4061 /* On Windows NT/9X, NO_EVENT is used to delete extraneous
4062 mouse events during a popup-menu call. */
4063 else if (event
->kind
== NO_EVENT
)
4064 kbd_fetch_ptr
= event
+ 1;
4065 else if (event
->kind
== HELP_EVENT
)
4067 Lisp_Object object
, position
, help
, frame
, window
;
4069 frame
= event
->ie
.frame_or_window
;
4070 object
= event
->ie
.arg
;
4071 position
= make_number (Time_to_position (event
->ie
.timestamp
));
4072 window
= event
->ie
.x
;
4074 clear_event (event
);
4076 kbd_fetch_ptr
= event
+ 1;
4077 if (!WINDOWP (window
))
4079 obj
= Fcons (Qhelp_echo
,
4080 list5 (frame
, help
, window
, object
, position
));
4082 else if (event
->kind
== FOCUS_IN_EVENT
)
4084 /* Notification of a FocusIn event. The frame receiving the
4085 focus is in event->frame_or_window. Generate a
4086 switch-frame event if necessary. */
4087 Lisp_Object frame
, focus
;
4089 frame
= event
->ie
.frame_or_window
;
4090 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
4096 ! NILP (event
->ie
.arg
)
4099 !EQ (frame
, internal_last_event_frame
)
4100 && !EQ (frame
, selected_frame
))
4101 obj
= make_lispy_switch_frame (frame
);
4103 obj
= make_lispy_focus_in (frame
);
4105 internal_last_event_frame
= frame
;
4106 kbd_fetch_ptr
= event
+ 1;
4108 else if (event
->kind
== FOCUS_OUT_EVENT
)
4110 #ifdef HAVE_WINDOW_SYSTEM
4113 Lisp_Object frame
= event
->ie
.frame_or_window
;
4114 bool focused
= false;
4116 for (di
= x_display_list
; di
&& ! focused
; di
= di
->next
)
4117 focused
= di
->x_highlight_frame
!= 0;
4120 obj
= make_lispy_focus_out (frame
);
4122 #endif /* HAVE_WINDOW_SYSTEM */
4124 kbd_fetch_ptr
= event
+ 1;
4127 else if (event
->kind
== DBUS_EVENT
)
4129 obj
= make_lispy_event (&event
->ie
);
4130 kbd_fetch_ptr
= event
+ 1;
4133 else if (event
->kind
== CONFIG_CHANGED_EVENT
)
4135 obj
= make_lispy_event (&event
->ie
);
4136 kbd_fetch_ptr
= event
+ 1;
4140 /* If this event is on a different frame, return a switch-frame this
4141 time, and leave the event in the queue for next time. */
4145 frame
= event
->ie
.frame_or_window
;
4147 frame
= XCAR (frame
);
4148 else if (WINDOWP (frame
))
4149 frame
= WINDOW_FRAME (XWINDOW (frame
));
4151 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
4155 if (! EQ (frame
, internal_last_event_frame
)
4156 && !EQ (frame
, selected_frame
))
4157 obj
= make_lispy_switch_frame (frame
);
4158 internal_last_event_frame
= frame
;
4160 /* If we didn't decide to make a switch-frame event, go ahead
4161 and build a real event from the queue entry. */
4165 obj
= make_lispy_event (&event
->ie
);
4167 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
4168 || defined (HAVE_NS) || defined (USE_GTK)
4169 /* If this was a menu selection, then set the flag to inhibit
4170 writing to last_nonmenu_event. Don't do this if the event
4171 we're returning is (menu-bar), though; that indicates the
4172 beginning of the menu sequence, and we might as well leave
4173 that as the `event with parameters' for this selection. */
4175 && !EQ (event
->ie
.frame_or_window
, event
->ie
.arg
)
4176 && (event
->kind
== MENU_BAR_EVENT
4177 || event
->kind
== TOOL_BAR_EVENT
))
4178 *used_mouse_menu
= 1;
4181 /* Certain system events are non-key events. */
4183 && event
->kind
== NS_NONKEY_EVENT
)
4184 *used_mouse_menu
= 1;
4187 /* Wipe out this event, to catch bugs. */
4188 clear_event (event
);
4189 kbd_fetch_ptr
= event
+ 1;
4193 /* Try generating a mouse motion event. */
4194 else if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
4196 struct frame
*f
= some_mouse_moved ();
4197 Lisp_Object bar_window
;
4198 enum scroll_bar_part part
;
4202 *kbp
= current_kboard
;
4203 /* Note that this uses F to determine which terminal to look at.
4204 If there is no valid info, it does not store anything
4205 so x remains nil. */
4208 /* XXX Can f or mouse_position_hook be NULL here? */
4209 if (f
&& FRAME_TERMINAL (f
)->mouse_position_hook
)
4210 (*FRAME_TERMINAL (f
)->mouse_position_hook
) (&f
, 0, &bar_window
,
4215 /* Decide if we should generate a switch-frame event. Don't
4216 generate switch-frame events for motion outside of all Emacs
4222 frame
= FRAME_FOCUS_FRAME (f
);
4224 XSETFRAME (frame
, f
);
4226 if (! EQ (frame
, internal_last_event_frame
)
4227 && !EQ (frame
, selected_frame
))
4228 obj
= make_lispy_switch_frame (frame
);
4229 internal_last_event_frame
= frame
;
4232 /* If we didn't decide to make a switch-frame event, go ahead and
4233 return a mouse-motion event. */
4234 if (!NILP (x
) && NILP (obj
))
4235 obj
= make_lispy_movement (f
, bar_window
, part
, x
, y
, t
);
4238 /* We were promised by the above while loop that there was
4239 something for us to read! */
4242 input_pending
= readable_events (0);
4244 Vlast_event_frame
= internal_last_event_frame
;
4249 /* Process any non-user-visible events (currently X selection events),
4250 without reading any user-visible events. */
4253 process_special_events (void)
4255 union buffered_input_event
*event
;
4257 for (event
= kbd_fetch_ptr
; event
!= kbd_store_ptr
; ++event
)
4259 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
4262 if (event
== kbd_store_ptr
)
4266 /* If we find a stored X selection request, handle it now. */
4267 if (event
->kind
== SELECTION_REQUEST_EVENT
4268 || event
->kind
== SELECTION_CLEAR_EVENT
)
4272 /* Remove the event from the fifo buffer before processing;
4273 otherwise swallow_events called recursively could see it
4274 and process it again. To do this, we move the events
4275 between kbd_fetch_ptr and EVENT one slot to the right,
4278 struct selection_input_event copy
= event
->sie
;
4279 union buffered_input_event
*beg
4280 = (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
4281 ? kbd_buffer
: kbd_fetch_ptr
;
4284 memmove (beg
+ 1, beg
, (event
- beg
) * sizeof *beg
);
4285 else if (event
< beg
)
4287 if (event
> kbd_buffer
)
4288 memmove (kbd_buffer
+ 1, kbd_buffer
,
4289 (event
- kbd_buffer
) * sizeof *kbd_buffer
);
4290 *kbd_buffer
= *(kbd_buffer
+ KBD_BUFFER_SIZE
- 1);
4291 if (beg
< kbd_buffer
+ KBD_BUFFER_SIZE
- 1)
4292 memmove (beg
+ 1, beg
,
4293 (kbd_buffer
+ KBD_BUFFER_SIZE
- 1 - beg
) * sizeof *beg
);
4296 if (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
4297 kbd_fetch_ptr
= kbd_buffer
+ 1;
4301 input_pending
= readable_events (0);
4302 x_handle_selection_event (©
);
4304 /* We're getting selection request events, but we don't have
4312 /* Process any events that are not user-visible, run timer events that
4313 are ripe, and return, without reading any user-visible events. */
4316 swallow_events (bool do_display
)
4318 unsigned old_timers_run
;
4320 process_special_events ();
4322 old_timers_run
= timers_run
;
4323 get_input_pending (READABLE_EVENTS_DO_TIMERS_NOW
);
4325 if (!input_pending
&& timers_run
!= old_timers_run
&& do_display
)
4326 redisplay_preserve_echo_area (7);
4329 /* Record the start of when Emacs is idle,
4330 for the sake of running idle-time timers. */
4333 timer_start_idle (void)
4335 /* If we are already in the idle state, do nothing. */
4336 if (timespec_valid_p (timer_idleness_start_time
))
4339 timer_idleness_start_time
= current_timespec ();
4340 timer_last_idleness_start_time
= timer_idleness_start_time
;
4342 /* Mark all idle-time timers as once again candidates for running. */
4343 call0 (intern ("internal-timer-start-idle"));
4346 /* Record that Emacs is no longer idle, so stop running idle-time timers. */
4349 timer_stop_idle (void)
4351 timer_idleness_start_time
= invalid_timespec ();
4354 /* Resume idle timer from last idle start time. */
4357 timer_resume_idle (void)
4359 if (timespec_valid_p (timer_idleness_start_time
))
4362 timer_idleness_start_time
= timer_last_idleness_start_time
;
4365 /* List of elisp functions to call, delayed because they were generated in
4366 a context where Elisp could not be safely run (e.g. redisplay, signal,
4367 ...). Each element has the form (FUN . ARGS). */
4368 Lisp_Object pending_funcalls
;
4370 /* Return true if TIMER is a valid timer, placing its value into *RESULT. */
4372 decode_timer (Lisp_Object timer
, struct timespec
*result
)
4376 if (! (VECTORP (timer
) && ASIZE (timer
) == 9))
4378 vec
= XVECTOR (timer
)->contents
;
4379 if (! NILP (vec
[0]))
4381 if (! INTEGERP (vec
[2]))
4385 if (decode_time_components (vec
[1], vec
[2], vec
[3], vec
[8], &t
, 0) <= 0)
4387 *result
= lisp_to_timespec (t
);
4388 return timespec_valid_p (*result
);
4392 /* Check whether a timer has fired. To prevent larger problems we simply
4393 disregard elements that are not proper timers. Do not make a circular
4394 timer list for the time being.
4396 Returns the time to wait until the next timer fires. If a
4397 timer is triggering now, return zero.
4398 If no timer is active, return -1.
4400 If a timer is ripe, we run it, with quitting turned off.
4401 In that case we return 0 to indicate that a new timer_check_2 call
4404 static struct timespec
4405 timer_check_2 (Lisp_Object timers
, Lisp_Object idle_timers
)
4407 struct timespec nexttime
;
4408 struct timespec now
;
4409 struct timespec idleness_now
;
4410 Lisp_Object chosen_timer
;
4411 struct gcpro gcpro1
;
4413 nexttime
= invalid_timespec ();
4415 chosen_timer
= Qnil
;
4416 GCPRO1 (chosen_timer
);
4418 /* First run the code that was delayed. */
4419 while (CONSP (pending_funcalls
))
4421 Lisp_Object funcall
= XCAR (pending_funcalls
);
4422 pending_funcalls
= XCDR (pending_funcalls
);
4423 safe_call2 (Qapply
, XCAR (funcall
), XCDR (funcall
));
4426 if (CONSP (timers
) || CONSP (idle_timers
))
4428 now
= current_timespec ();
4429 idleness_now
= (timespec_valid_p (timer_idleness_start_time
)
4430 ? timespec_sub (now
, timer_idleness_start_time
)
4431 : make_timespec (0, 0));
4434 while (CONSP (timers
) || CONSP (idle_timers
))
4436 Lisp_Object timer
= Qnil
, idle_timer
= Qnil
;
4437 struct timespec timer_time
, idle_timer_time
;
4438 struct timespec difference
;
4439 struct timespec timer_difference
= invalid_timespec ();
4440 struct timespec idle_timer_difference
= invalid_timespec ();
4441 bool ripe
, timer_ripe
= 0, idle_timer_ripe
= 0;
4443 /* Set TIMER and TIMER_DIFFERENCE
4444 based on the next ordinary timer.
4445 TIMER_DIFFERENCE is the distance in time from NOW to when
4446 this timer becomes ripe.
4447 Skip past invalid timers and timers already handled. */
4450 timer
= XCAR (timers
);
4451 if (! decode_timer (timer
, &timer_time
))
4453 timers
= XCDR (timers
);
4457 timer_ripe
= timespec_cmp (timer_time
, now
) <= 0;
4458 timer_difference
= (timer_ripe
4459 ? timespec_sub (now
, timer_time
)
4460 : timespec_sub (timer_time
, now
));
4463 /* Likewise for IDLE_TIMER and IDLE_TIMER_DIFFERENCE
4464 based on the next idle timer. */
4465 if (CONSP (idle_timers
))
4467 idle_timer
= XCAR (idle_timers
);
4468 if (! decode_timer (idle_timer
, &idle_timer_time
))
4470 idle_timers
= XCDR (idle_timers
);
4474 idle_timer_ripe
= timespec_cmp (idle_timer_time
, idleness_now
) <= 0;
4475 idle_timer_difference
4477 ? timespec_sub (idleness_now
, idle_timer_time
)
4478 : timespec_sub (idle_timer_time
, idleness_now
));
4481 /* Decide which timer is the next timer,
4482 and set CHOSEN_TIMER, DIFFERENCE, and RIPE accordingly.
4483 Also step down the list where we found that timer. */
4485 if (timespec_valid_p (timer_difference
)
4486 && (! timespec_valid_p (idle_timer_difference
)
4487 || idle_timer_ripe
< timer_ripe
4488 || (idle_timer_ripe
== timer_ripe
4490 ? timespec_cmp (idle_timer_difference
,
4492 : timespec_cmp (timer_difference
,
4493 idle_timer_difference
))
4496 chosen_timer
= timer
;
4497 timers
= XCDR (timers
);
4498 difference
= timer_difference
;
4503 chosen_timer
= idle_timer
;
4504 idle_timers
= XCDR (idle_timers
);
4505 difference
= idle_timer_difference
;
4506 ripe
= idle_timer_ripe
;
4509 /* If timer is ripe, run it if it hasn't been run. */
4512 if (NILP (AREF (chosen_timer
, 0)))
4514 ptrdiff_t count
= SPECPDL_INDEX ();
4515 Lisp_Object old_deactivate_mark
= Vdeactivate_mark
;
4517 /* Mark the timer as triggered to prevent problems if the lisp
4518 code fails to reschedule it right. */
4519 ASET (chosen_timer
, 0, Qt
);
4521 specbind (Qinhibit_quit
, Qt
);
4523 call1 (Qtimer_event_handler
, chosen_timer
);
4524 Vdeactivate_mark
= old_deactivate_mark
;
4526 unbind_to (count
, Qnil
);
4528 /* Since we have handled the event,
4529 we don't need to tell the caller to wake up and do it. */
4530 /* But the caller must still wait for the next timer, so
4531 return 0 to indicate that. */
4534 nexttime
= make_timespec (0, 0);
4538 /* When we encounter a timer that is still waiting,
4539 return the amount of time to wait before it is ripe. */
4546 /* No timers are pending in the future. */
4547 /* Return 0 if we generated an event, and -1 if not. */
4553 /* Check whether a timer has fired. To prevent larger problems we simply
4554 disregard elements that are not proper timers. Do not make a circular
4555 timer list for the time being.
4557 Returns the time to wait until the next timer fires.
4558 If no timer is active, return an invalid value.
4560 As long as any timer is ripe, we run it. */
4565 struct timespec nexttime
;
4566 Lisp_Object timers
, idle_timers
;
4567 struct gcpro gcpro1
, gcpro2
;
4569 Lisp_Object tem
= Vinhibit_quit
;
4572 /* We use copies of the timers' lists to allow a timer to add itself
4573 again, without locking up Emacs if the newly added timer is
4574 already ripe when added. */
4576 /* Always consider the ordinary timers. */
4577 timers
= Fcopy_sequence (Vtimer_list
);
4578 /* Consider the idle timers only if Emacs is idle. */
4579 if (timespec_valid_p (timer_idleness_start_time
))
4580 idle_timers
= Fcopy_sequence (Vtimer_idle_list
);
4584 Vinhibit_quit
= tem
;
4586 GCPRO2 (timers
, idle_timers
);
4590 nexttime
= timer_check_2 (timers
, idle_timers
);
4592 while (nexttime
.tv_sec
== 0 && nexttime
.tv_nsec
== 0);
4598 DEFUN ("current-idle-time", Fcurrent_idle_time
, Scurrent_idle_time
, 0, 0, 0,
4599 doc
: /* Return the current length of Emacs idleness, or nil.
4600 The value when Emacs is idle is a list of four integers (HIGH LOW USEC PSEC)
4601 in the same style as (current-time).
4603 The value when Emacs is not idle is nil.
4605 PSEC is a multiple of the system clock resolution. */)
4608 if (timespec_valid_p (timer_idleness_start_time
))
4609 return make_lisp_time (timespec_sub (current_timespec (),
4610 timer_idleness_start_time
));
4615 /* Caches for modify_event_symbol. */
4616 static Lisp_Object accent_key_syms
;
4617 static Lisp_Object func_key_syms
;
4618 static Lisp_Object mouse_syms
;
4619 static Lisp_Object wheel_syms
;
4620 static Lisp_Object drag_n_drop_syms
;
4622 /* This is a list of keysym codes for special "accent" characters.
4623 It parallels lispy_accent_keys. */
4625 static const int lispy_accent_codes
[] =
4627 #ifdef XK_dead_circumflex
4632 #ifdef XK_dead_grave
4637 #ifdef XK_dead_tilde
4642 #ifdef XK_dead_diaeresis
4647 #ifdef XK_dead_macron
4652 #ifdef XK_dead_degree
4657 #ifdef XK_dead_acute
4662 #ifdef XK_dead_cedilla
4667 #ifdef XK_dead_breve
4672 #ifdef XK_dead_ogonek
4677 #ifdef XK_dead_caron
4682 #ifdef XK_dead_doubleacute
4683 XK_dead_doubleacute
,
4687 #ifdef XK_dead_abovedot
4692 #ifdef XK_dead_abovering
4702 #ifdef XK_dead_belowdot
4707 #ifdef XK_dead_voiced_sound
4708 XK_dead_voiced_sound
,
4712 #ifdef XK_dead_semivoiced_sound
4713 XK_dead_semivoiced_sound
,
4729 /* This is a list of Lisp names for special "accent" characters.
4730 It parallels lispy_accent_codes. */
4732 static const char *const lispy_accent_keys
[] =
4750 "dead-voiced-sound",
4751 "dead-semivoiced-sound",
4757 #define FUNCTION_KEY_OFFSET 0x0
4759 const char *const lispy_function_keys
[] =
4763 0, /* VK_LBUTTON 0x01 */
4764 0, /* VK_RBUTTON 0x02 */
4765 "cancel", /* VK_CANCEL 0x03 */
4766 0, /* VK_MBUTTON 0x04 */
4768 0, 0, 0, /* 0x05 .. 0x07 */
4770 "backspace", /* VK_BACK 0x08 */
4771 "tab", /* VK_TAB 0x09 */
4773 0, 0, /* 0x0A .. 0x0B */
4775 "clear", /* VK_CLEAR 0x0C */
4776 "return", /* VK_RETURN 0x0D */
4778 0, 0, /* 0x0E .. 0x0F */
4780 0, /* VK_SHIFT 0x10 */
4781 0, /* VK_CONTROL 0x11 */
4782 0, /* VK_MENU 0x12 */
4783 "pause", /* VK_PAUSE 0x13 */
4784 "capslock", /* VK_CAPITAL 0x14 */
4785 "kana", /* VK_KANA/VK_HANGUL 0x15 */
4787 "junja", /* VK_JUNJA 0x17 */
4788 "final", /* VK_FINAL 0x18 */
4789 "kanji", /* VK_KANJI/VK_HANJA 0x19 */
4791 "escape", /* VK_ESCAPE 0x1B */
4792 "convert", /* VK_CONVERT 0x1C */
4793 "non-convert", /* VK_NONCONVERT 0x1D */
4794 "accept", /* VK_ACCEPT 0x1E */
4795 "mode-change", /* VK_MODECHANGE 0x1F */
4796 0, /* VK_SPACE 0x20 */
4797 "prior", /* VK_PRIOR 0x21 */
4798 "next", /* VK_NEXT 0x22 */
4799 "end", /* VK_END 0x23 */
4800 "home", /* VK_HOME 0x24 */
4801 "left", /* VK_LEFT 0x25 */
4802 "up", /* VK_UP 0x26 */
4803 "right", /* VK_RIGHT 0x27 */
4804 "down", /* VK_DOWN 0x28 */
4805 "select", /* VK_SELECT 0x29 */
4806 "print", /* VK_PRINT 0x2A */
4807 "execute", /* VK_EXECUTE 0x2B */
4808 "snapshot", /* VK_SNAPSHOT 0x2C */
4809 "insert", /* VK_INSERT 0x2D */
4810 "delete", /* VK_DELETE 0x2E */
4811 "help", /* VK_HELP 0x2F */
4813 /* VK_0 thru VK_9 are the same as ASCII '0' thru '9' (0x30 - 0x39) */
4815 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4817 0, 0, 0, 0, 0, 0, 0, /* 0x3A .. 0x40 */
4819 /* VK_A thru VK_Z are the same as ASCII 'A' thru 'Z' (0x41 - 0x5A) */
4821 0, 0, 0, 0, 0, 0, 0, 0, 0,
4822 0, 0, 0, 0, 0, 0, 0, 0, 0,
4823 0, 0, 0, 0, 0, 0, 0, 0,
4825 "lwindow", /* VK_LWIN 0x5B */
4826 "rwindow", /* VK_RWIN 0x5C */
4827 "apps", /* VK_APPS 0x5D */
4830 "kp-0", /* VK_NUMPAD0 0x60 */
4831 "kp-1", /* VK_NUMPAD1 0x61 */
4832 "kp-2", /* VK_NUMPAD2 0x62 */
4833 "kp-3", /* VK_NUMPAD3 0x63 */
4834 "kp-4", /* VK_NUMPAD4 0x64 */
4835 "kp-5", /* VK_NUMPAD5 0x65 */
4836 "kp-6", /* VK_NUMPAD6 0x66 */
4837 "kp-7", /* VK_NUMPAD7 0x67 */
4838 "kp-8", /* VK_NUMPAD8 0x68 */
4839 "kp-9", /* VK_NUMPAD9 0x69 */
4840 "kp-multiply", /* VK_MULTIPLY 0x6A */
4841 "kp-add", /* VK_ADD 0x6B */
4842 "kp-separator", /* VK_SEPARATOR 0x6C */
4843 "kp-subtract", /* VK_SUBTRACT 0x6D */
4844 "kp-decimal", /* VK_DECIMAL 0x6E */
4845 "kp-divide", /* VK_DIVIDE 0x6F */
4846 "f1", /* VK_F1 0x70 */
4847 "f2", /* VK_F2 0x71 */
4848 "f3", /* VK_F3 0x72 */
4849 "f4", /* VK_F4 0x73 */
4850 "f5", /* VK_F5 0x74 */
4851 "f6", /* VK_F6 0x75 */
4852 "f7", /* VK_F7 0x76 */
4853 "f8", /* VK_F8 0x77 */
4854 "f9", /* VK_F9 0x78 */
4855 "f10", /* VK_F10 0x79 */
4856 "f11", /* VK_F11 0x7A */
4857 "f12", /* VK_F12 0x7B */
4858 "f13", /* VK_F13 0x7C */
4859 "f14", /* VK_F14 0x7D */
4860 "f15", /* VK_F15 0x7E */
4861 "f16", /* VK_F16 0x7F */
4862 "f17", /* VK_F17 0x80 */
4863 "f18", /* VK_F18 0x81 */
4864 "f19", /* VK_F19 0x82 */
4865 "f20", /* VK_F20 0x83 */
4866 "f21", /* VK_F21 0x84 */
4867 "f22", /* VK_F22 0x85 */
4868 "f23", /* VK_F23 0x86 */
4869 "f24", /* VK_F24 0x87 */
4871 0, 0, 0, 0, /* 0x88 .. 0x8B */
4872 0, 0, 0, 0, /* 0x8C .. 0x8F */
4874 "kp-numlock", /* VK_NUMLOCK 0x90 */
4875 "scroll", /* VK_SCROLL 0x91 */
4876 /* Not sure where the following block comes from.
4877 Windows headers have NEC and Fujitsu specific keys in
4878 this block, but nothing generic. */
4879 "kp-space", /* VK_NUMPAD_CLEAR 0x92 */
4880 "kp-enter", /* VK_NUMPAD_ENTER 0x93 */
4881 "kp-prior", /* VK_NUMPAD_PRIOR 0x94 */
4882 "kp-next", /* VK_NUMPAD_NEXT 0x95 */
4883 "kp-end", /* VK_NUMPAD_END 0x96 */
4884 "kp-home", /* VK_NUMPAD_HOME 0x97 */
4885 "kp-left", /* VK_NUMPAD_LEFT 0x98 */
4886 "kp-up", /* VK_NUMPAD_UP 0x99 */
4887 "kp-right", /* VK_NUMPAD_RIGHT 0x9A */
4888 "kp-down", /* VK_NUMPAD_DOWN 0x9B */
4889 "kp-insert", /* VK_NUMPAD_INSERT 0x9C */
4890 "kp-delete", /* VK_NUMPAD_DELETE 0x9D */
4892 0, 0, /* 0x9E .. 0x9F */
4895 * VK_L* & VK_R* - left and right Alt, Ctrl and Shift virtual keys.
4896 * Used only as parameters to GetAsyncKeyState and GetKeyState.
4897 * No other API or message will distinguish left and right keys this way.
4902 /* Multimedia keys. These are handled as WM_APPCOMMAND, which allows us
4903 to enable them selectively, and gives access to a few more functions.
4904 See lispy_multimedia_keys below. */
4905 0, 0, 0, 0, 0, 0, 0, /* 0xA6 .. 0xAC Browser */
4906 0, 0, 0, /* 0xAD .. 0xAF Volume */
4907 0, 0, 0, 0, /* 0xB0 .. 0xB3 Media */
4908 0, 0, 0, 0, /* 0xB4 .. 0xB7 Apps */
4910 /* 0xB8 .. 0xC0 "OEM" keys - all seem to be punctuation. */
4911 0, 0, 0, 0, 0, 0, 0, 0, 0,
4913 /* 0xC1 - 0xDA unallocated, 0xDB-0xDF more OEM keys */
4914 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4915 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4918 "ax", /* VK_OEM_AX 0xE1 */
4919 0, /* VK_OEM_102 0xE2 */
4920 "ico-help", /* VK_ICO_HELP 0xE3 */
4921 "ico-00", /* VK_ICO_00 0xE4 */
4922 0, /* VK_PROCESSKEY 0xE5 - used by IME */
4923 "ico-clear", /* VK_ICO_CLEAR 0xE6 */
4924 0, /* VK_PACKET 0xE7 - used to pass Unicode chars */
4926 "reset", /* VK_OEM_RESET 0xE9 */
4927 "jump", /* VK_OEM_JUMP 0xEA */
4928 "oem-pa1", /* VK_OEM_PA1 0xEB */
4929 "oem-pa2", /* VK_OEM_PA2 0xEC */
4930 "oem-pa3", /* VK_OEM_PA3 0xED */
4931 "wsctrl", /* VK_OEM_WSCTRL 0xEE */
4932 "cusel", /* VK_OEM_CUSEL 0xEF */
4933 "oem-attn", /* VK_OEM_ATTN 0xF0 */
4934 "finish", /* VK_OEM_FINISH 0xF1 */
4935 "copy", /* VK_OEM_COPY 0xF2 */
4936 "auto", /* VK_OEM_AUTO 0xF3 */
4937 "enlw", /* VK_OEM_ENLW 0xF4 */
4938 "backtab", /* VK_OEM_BACKTAB 0xF5 */
4939 "attn", /* VK_ATTN 0xF6 */
4940 "crsel", /* VK_CRSEL 0xF7 */
4941 "exsel", /* VK_EXSEL 0xF8 */
4942 "ereof", /* VK_EREOF 0xF9 */
4943 "play", /* VK_PLAY 0xFA */
4944 "zoom", /* VK_ZOOM 0xFB */
4945 "noname", /* VK_NONAME 0xFC */
4946 "pa1", /* VK_PA1 0xFD */
4947 "oem_clear", /* VK_OEM_CLEAR 0xFE */
4951 /* Some of these duplicate the "Media keys" on newer keyboards,
4952 but they are delivered to the application in a different way. */
4953 static const char *const lispy_multimedia_keys
[] =
4961 "browser-favorites",
4998 "toggle-dictate-command",
5004 "media-fast-forward",
5007 "media-channel-down"
5010 #else /* not HAVE_NTGUI */
5012 /* This should be dealt with in XTread_socket now, and that doesn't
5013 depend on the client system having the Kana syms defined. See also
5014 the XK_kana_A case below. */
5017 static const char *const lispy_kana_keys
[] =
5019 /* X Keysym value */
5020 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x400 .. 0x40f */
5021 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x410 .. 0x41f */
5022 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x420 .. 0x42f */
5023 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x430 .. 0x43f */
5024 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x440 .. 0x44f */
5025 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x450 .. 0x45f */
5026 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x460 .. 0x46f */
5027 0,0,0,0,0,0,0,0,0,0,0,0,0,0,"overline",0,
5028 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x480 .. 0x48f */
5029 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x490 .. 0x49f */
5030 0, "kana-fullstop", "kana-openingbracket", "kana-closingbracket",
5031 "kana-comma", "kana-conjunctive", "kana-WO", "kana-a",
5032 "kana-i", "kana-u", "kana-e", "kana-o",
5033 "kana-ya", "kana-yu", "kana-yo", "kana-tsu",
5034 "prolongedsound", "kana-A", "kana-I", "kana-U",
5035 "kana-E", "kana-O", "kana-KA", "kana-KI",
5036 "kana-KU", "kana-KE", "kana-KO", "kana-SA",
5037 "kana-SHI", "kana-SU", "kana-SE", "kana-SO",
5038 "kana-TA", "kana-CHI", "kana-TSU", "kana-TE",
5039 "kana-TO", "kana-NA", "kana-NI", "kana-NU",
5040 "kana-NE", "kana-NO", "kana-HA", "kana-HI",
5041 "kana-FU", "kana-HE", "kana-HO", "kana-MA",
5042 "kana-MI", "kana-MU", "kana-ME", "kana-MO",
5043 "kana-YA", "kana-YU", "kana-YO", "kana-RA",
5044 "kana-RI", "kana-RU", "kana-RE", "kana-RO",
5045 "kana-WA", "kana-N", "voicedsound", "semivoicedsound",
5046 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4e0 .. 0x4ef */
5047 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4f0 .. 0x4ff */
5049 #endif /* XK_kana_A */
5052 #define FUNCTION_KEY_OFFSET 0xff00
5054 /* You'll notice that this table is arranged to be conveniently
5055 indexed by X Windows keysym values. */
5056 static const char *const lispy_function_keys
[] =
5058 /* X Keysym value */
5060 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff00...0f */
5061 "backspace", "tab", "linefeed", "clear",
5063 0, 0, 0, "pause", /* 0xff10...1f */
5064 0, 0, 0, 0, 0, 0, 0, "escape",
5066 0, "kanji", "muhenkan", "henkan", /* 0xff20...2f */
5067 "romaji", "hiragana", "katakana", "hiragana-katakana",
5068 "zenkaku", "hankaku", "zenkaku-hankaku", "touroku",
5069 "massyo", "kana-lock", "kana-shift", "eisu-shift",
5070 "eisu-toggle", /* 0xff30...3f */
5071 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
5072 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff40...4f */
5074 "home", "left", "up", "right", /* 0xff50 */ /* IsCursorKey */
5075 "down", "prior", "next", "end",
5076 "begin", 0, 0, 0, 0, 0, 0, 0,
5077 "select", /* 0xff60 */ /* IsMiscFunctionKey */
5088 "break", /* 0xff6b */
5091 0, 0, 0, 0, "backtab", 0, 0, 0, /* 0xff70... */
5092 0, 0, 0, 0, 0, 0, 0, "kp-numlock", /* 0xff78... */
5093 "kp-space", /* 0xff80 */ /* IsKeypadKey */
5094 0, 0, 0, 0, 0, 0, 0, 0,
5095 "kp-tab", /* 0xff89 */
5097 "kp-enter", /* 0xff8d */
5099 "kp-f1", /* 0xff91 */
5103 "kp-home", /* 0xff95 */
5108 "kp-prior", /* kp-page-up */
5109 "kp-next", /* kp-page-down */
5115 0, 0, 0, 0, 0, 0, 0, 0, 0,
5116 "kp-multiply", /* 0xffaa */
5121 "kp-divide", /* 0xffaf */
5122 "kp-0", /* 0xffb0 */
5123 "kp-1", "kp-2", "kp-3", "kp-4", "kp-5", "kp-6", "kp-7", "kp-8", "kp-9",
5126 "kp-equal", /* 0xffbd */
5127 "f1", /* 0xffbe */ /* IsFunctionKey */
5129 "f3", "f4", "f5", "f6", "f7", "f8", "f9", "f10", /* 0xffc0 */
5130 "f11", "f12", "f13", "f14", "f15", "f16", "f17", "f18",
5131 "f19", "f20", "f21", "f22", "f23", "f24", "f25", "f26", /* 0xffd0 */
5132 "f27", "f28", "f29", "f30", "f31", "f32", "f33", "f34",
5133 "f35", 0, 0, 0, 0, 0, 0, 0, /* 0xffe0 */
5134 0, 0, 0, 0, 0, 0, 0, 0,
5135 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfff0 */
5136 0, 0, 0, 0, 0, 0, 0, "delete"
5139 /* ISO 9995 Function and Modifier Keys; the first byte is 0xFE. */
5140 #define ISO_FUNCTION_KEY_OFFSET 0xfe00
5142 static const char *const iso_lispy_function_keys
[] =
5144 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe00 */
5145 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe08 */
5146 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe10 */
5147 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe18 */
5148 "iso-lefttab", /* 0xfe20 */
5149 "iso-move-line-up", "iso-move-line-down",
5150 "iso-partial-line-up", "iso-partial-line-down",
5151 "iso-partial-space-left", "iso-partial-space-right",
5152 "iso-set-margin-left", "iso-set-margin-right", /* 0xffe27, 28 */
5153 "iso-release-margin-left", "iso-release-margin-right",
5154 "iso-release-both-margins",
5155 "iso-fast-cursor-left", "iso-fast-cursor-right",
5156 "iso-fast-cursor-up", "iso-fast-cursor-down",
5157 "iso-continuous-underline", "iso-discontinuous-underline", /* 0xfe30, 31 */
5158 "iso-emphasize", "iso-center-object", "iso-enter", /* ... 0xfe34 */
5161 #endif /* not HAVE_NTGUI */
5163 static Lisp_Object Vlispy_mouse_stem
;
5165 static const char *const lispy_wheel_names
[] =
5167 "wheel-up", "wheel-down", "wheel-left", "wheel-right"
5170 /* drag-n-drop events are generated when a set of selected files are
5171 dragged from another application and dropped onto an Emacs window. */
5172 static const char *const lispy_drag_n_drop_names
[] =
5177 /* An array of symbol indexes of scroll bar parts, indexed by an enum
5178 scroll_bar_part value. Note that Qnil corresponds to
5179 scroll_bar_nowhere and should not appear in Lisp events. */
5180 static short const scroll_bar_parts
[] = {
5181 SYMBOL_INDEX (Qnil
), SYMBOL_INDEX (Qabove_handle
), SYMBOL_INDEX (Qhandle
),
5182 SYMBOL_INDEX (Qbelow_handle
), SYMBOL_INDEX (Qup
), SYMBOL_INDEX (Qdown
),
5183 SYMBOL_INDEX (Qtop
), SYMBOL_INDEX (Qbottom
), SYMBOL_INDEX (Qend_scroll
),
5184 SYMBOL_INDEX (Qratio
), SYMBOL_INDEX (Qbefore_handle
),
5185 SYMBOL_INDEX (Qhorizontal_handle
), SYMBOL_INDEX (Qafter_handle
),
5186 SYMBOL_INDEX (Qleft
), SYMBOL_INDEX (Qright
), SYMBOL_INDEX (Qleftmost
),
5187 SYMBOL_INDEX (Qrightmost
), SYMBOL_INDEX (Qend_scroll
), SYMBOL_INDEX (Qratio
)
5190 /* A vector, indexed by button number, giving the down-going location
5191 of currently depressed buttons, both scroll bar and non-scroll bar.
5193 The elements have the form
5194 (BUTTON-NUMBER MODIFIER-MASK . REST)
5195 where REST is the cdr of a position as it would be reported in the event.
5197 The make_lispy_event function stores positions here to tell the
5198 difference between click and drag events, and to store the starting
5199 location to be included in drag events. */
5201 static Lisp_Object button_down_location
;
5203 /* Information about the most recent up-going button event: Which
5204 button, what location, and what time. */
5206 static int last_mouse_button
;
5207 static int last_mouse_x
;
5208 static int last_mouse_y
;
5209 static Time button_down_time
;
5211 /* The number of clicks in this multiple-click. */
5213 static int double_click_count
;
5215 /* X and Y are frame-relative coordinates for a click or wheel event.
5216 Return a Lisp-style event list. */
5219 make_lispy_position (struct frame
*f
, Lisp_Object x
, Lisp_Object y
,
5222 enum window_part part
;
5223 Lisp_Object posn
= Qnil
;
5224 Lisp_Object extra_info
= Qnil
;
5225 /* Coordinate pixel positions to return. */
5226 int xret
= 0, yret
= 0;
5227 /* The window under frame pixel coordinates (x,y) */
5228 Lisp_Object window
= f
5229 ? window_from_coordinates (f
, XINT (x
), XINT (y
), &part
, 0)
5232 if (WINDOWP (window
))
5234 /* It's a click in window WINDOW at frame coordinates (X,Y) */
5235 struct window
*w
= XWINDOW (window
);
5236 Lisp_Object string_info
= Qnil
;
5237 ptrdiff_t textpos
= 0;
5238 int col
= -1, row
= -1;
5239 int dx
= -1, dy
= -1;
5240 int width
= -1, height
= -1;
5241 Lisp_Object object
= Qnil
;
5243 /* Pixel coordinates relative to the window corner. */
5244 int wx
= XINT (x
) - WINDOW_LEFT_EDGE_X (w
);
5245 int wy
= XINT (y
) - WINDOW_TOP_EDGE_Y (w
);
5247 /* For text area clicks, return X, Y relative to the corner of
5248 this text area. Note that dX, dY etc are set below, by
5249 buffer_posn_from_coords. */
5250 if (part
== ON_TEXT
)
5252 xret
= XINT (x
) - window_box_left (w
, TEXT_AREA
);
5253 yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5255 /* For mode line and header line clicks, return X, Y relative to
5256 the left window edge. Use mode_line_string to look for a
5257 string on the click position. */
5258 else if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
)
5263 posn
= (part
== ON_MODE_LINE
) ? Qmode_line
: Qheader_line
;
5264 /* Note that mode_line_string takes COL, ROW as pixels and
5265 converts them to characters. */
5268 string
= mode_line_string (w
, part
, &col
, &row
, &charpos
,
5269 &object
, &dx
, &dy
, &width
, &height
);
5270 if (STRINGP (string
))
5271 string_info
= Fcons (string
, make_number (charpos
));
5277 /* For fringes and margins, Y is relative to the area's (and the
5278 window's) top edge, while X is meaningless. */
5279 else if (part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
5284 posn
= (part
== ON_LEFT_MARGIN
) ? Qleft_margin
: Qright_margin
;
5287 string
= marginal_area_string (w
, part
, &col
, &row
, &charpos
,
5288 &object
, &dx
, &dy
, &width
, &height
);
5289 if (STRINGP (string
))
5290 string_info
= Fcons (string
, make_number (charpos
));
5292 yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5294 else if (part
== ON_LEFT_FRINGE
)
5296 posn
= Qleft_fringe
;
5300 - (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5301 ? 0 : window_box_width (w
, LEFT_MARGIN_AREA
));
5302 dy
= yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5304 else if (part
== ON_RIGHT_FRINGE
)
5306 posn
= Qright_fringe
;
5310 - window_box_width (w
, LEFT_MARGIN_AREA
)
5311 - window_box_width (w
, TEXT_AREA
)
5312 - (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5313 ? window_box_width (w
, RIGHT_MARGIN_AREA
)
5315 dy
= yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5317 else if (part
== ON_VERTICAL_BORDER
)
5319 posn
= Qvertical_line
;
5325 else if (part
== ON_VERTICAL_SCROLL_BAR
)
5327 posn
= Qvertical_scroll_bar
;
5328 width
= WINDOW_SCROLL_BAR_AREA_WIDTH (w
);
5332 else if (part
== ON_HORIZONTAL_SCROLL_BAR
)
5334 posn
= Qhorizontal_scroll_bar
;
5335 width
= WINDOW_SCROLL_BAR_AREA_HEIGHT (w
);
5339 else if (part
== ON_RIGHT_DIVIDER
)
5341 posn
= Qright_divider
;
5342 width
= WINDOW_RIGHT_DIVIDER_WIDTH (w
);
5346 else if (part
== ON_BOTTOM_DIVIDER
)
5348 posn
= Qbottom_divider
;
5349 width
= WINDOW_BOTTOM_DIVIDER_WIDTH (w
);
5354 /* For clicks in the text area, fringes, margins, or vertical
5355 scroll bar, call buffer_posn_from_coords to extract TEXTPOS,
5356 the buffer position nearest to the click. */
5359 Lisp_Object string2
, object2
= Qnil
;
5360 struct display_pos p
;
5362 int width2
, height2
;
5363 /* The pixel X coordinate passed to buffer_posn_from_coords
5364 is the X coordinate relative to the text area for clicks
5365 in text-area, right-margin/fringe and right-side vertical
5366 scroll bar, zero otherwise. */
5368 = (part
== ON_TEXT
) ? xret
5369 : (part
== ON_RIGHT_FRINGE
|| part
== ON_RIGHT_MARGIN
5370 || (part
== ON_VERTICAL_SCROLL_BAR
5371 && WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_RIGHT (w
)))
5372 ? (XINT (x
) - window_box_left (w
, TEXT_AREA
))
5376 string2
= buffer_posn_from_coords (w
, &x2
, &y2
, &p
,
5377 &object2
, &dx2
, &dy2
,
5379 textpos
= CHARPOS (p
.pos
);
5380 if (col
< 0) col
= x2
;
5381 if (row
< 0) row
= y2
;
5382 if (dx
< 0) dx
= dx2
;
5383 if (dy
< 0) dy
= dy2
;
5384 if (width
< 0) width
= width2
;
5385 if (height
< 0) height
= height2
;
5389 posn
= make_number (textpos
);
5390 if (STRINGP (string2
))
5391 string_info
= Fcons (string2
,
5392 make_number (CHARPOS (p
.string_pos
)));
5398 #ifdef HAVE_WINDOW_SYSTEM
5399 if (IMAGEP (object
))
5401 Lisp_Object image_map
, hotspot
;
5402 if ((image_map
= Fplist_get (XCDR (object
), QCmap
),
5404 && (hotspot
= find_hot_spot (image_map
, dx
, dy
),
5406 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
5407 posn
= XCAR (hotspot
);
5414 Fcons (make_number (dx
), make_number (dy
)),
5415 Fcons (make_number (width
), make_number (height
)));
5418 extra_info
= Fcons (string_info
,
5419 Fcons (textpos
< 0 ? Qnil
: make_number (textpos
),
5420 Fcons (Fcons (make_number (col
),
5426 /* Return mouse pixel coordinates here. */
5427 XSETFRAME (window
, f
);
5434 return Fcons (window
,
5436 Fcons (Fcons (make_number (xret
),
5437 make_number (yret
)),
5438 Fcons (make_number (t
),
5442 /* Return non-zero if F is a GUI frame that uses some toolkit-managed
5443 menu bar. This really means that Emacs draws and manages the menu
5444 bar as part of its normal display, and therefore can compute its
5447 toolkit_menubar_in_use (struct frame
*f
)
5449 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS) || defined (HAVE_NTGUI)
5450 return !(!FRAME_WINDOW_P (f
));
5456 /* Build the part of Lisp event which represents scroll bar state from
5457 EV. TYPE is one of Qvertical_scroll_bar or Qhorizontal_scroll_bar. */
5460 make_scroll_bar_position (struct input_event
*ev
, Lisp_Object type
)
5462 return list5 (ev
->frame_or_window
, type
, Fcons (ev
->x
, ev
->y
),
5463 make_number (ev
->timestamp
),
5464 builtin_lisp_symbol (scroll_bar_parts
[ev
->part
]));
5467 /* Given a struct input_event, build the lisp event which represents
5468 it. If EVENT is 0, build a mouse movement event from the mouse
5469 movement buffer, which should have a movement event in it.
5471 Note that events must be passed to this function in the order they
5472 are received; this function stores the location of button presses
5473 in order to build drag events when the button is released. */
5476 make_lispy_event (struct input_event
*event
)
5480 switch (event
->kind
)
5482 /* A simple keystroke. */
5483 case ASCII_KEYSTROKE_EVENT
:
5484 case MULTIBYTE_CHAR_KEYSTROKE_EVENT
:
5486 Lisp_Object lispy_c
;
5487 EMACS_INT c
= event
->code
;
5488 if (event
->kind
== ASCII_KEYSTROKE_EVENT
)
5491 eassert (c
== event
->code
);
5492 /* Turn ASCII characters into control characters
5494 if (event
->modifiers
& ctrl_modifier
)
5496 c
= make_ctrl_char (c
);
5497 event
->modifiers
&= ~ctrl_modifier
;
5501 /* Add in the other modifier bits. The shift key was taken care
5502 of by the X code. */
5503 c
|= (event
->modifiers
5504 & (meta_modifier
| alt_modifier
5505 | hyper_modifier
| super_modifier
| ctrl_modifier
));
5506 /* Distinguish Shift-SPC from SPC. */
5507 if ((event
->code
) == 040
5508 && event
->modifiers
& shift_modifier
)
5509 c
|= shift_modifier
;
5510 button_down_time
= 0;
5511 XSETFASTINT (lispy_c
, c
);
5516 /* NS_NONKEY_EVENTs are just like NON_ASCII_KEYSTROKE_EVENTs,
5517 except that they are non-key events (last-nonmenu-event is nil). */
5518 case NS_NONKEY_EVENT
:
5521 /* A function key. The symbol may need to have modifier prefixes
5523 case NON_ASCII_KEYSTROKE_EVENT
:
5524 button_down_time
= 0;
5526 for (i
= 0; i
< ARRAYELTS (lispy_accent_codes
); i
++)
5527 if (event
->code
== lispy_accent_codes
[i
])
5528 return modify_event_symbol (i
,
5530 Qfunction_key
, Qnil
,
5531 lispy_accent_keys
, &accent_key_syms
,
5532 ARRAYELTS (lispy_accent_keys
));
5536 if (event
->code
>= 0x400 && event
->code
< 0x500)
5537 return modify_event_symbol (event
->code
- 0x400,
5538 event
->modifiers
& ~shift_modifier
,
5539 Qfunction_key
, Qnil
,
5540 lispy_kana_keys
, &func_key_syms
,
5541 ARRAYELTS (lispy_kana_keys
));
5542 #endif /* XK_kana_A */
5545 #ifdef ISO_FUNCTION_KEY_OFFSET
5546 if (event
->code
< FUNCTION_KEY_OFFSET
5547 && event
->code
>= ISO_FUNCTION_KEY_OFFSET
)
5548 return modify_event_symbol (event
->code
- ISO_FUNCTION_KEY_OFFSET
,
5550 Qfunction_key
, Qnil
,
5551 iso_lispy_function_keys
, &func_key_syms
,
5552 ARRAYELTS (iso_lispy_function_keys
));
5555 if ((FUNCTION_KEY_OFFSET
<= event
->code
5557 < FUNCTION_KEY_OFFSET
+ ARRAYELTS (lispy_function_keys
)))
5558 && lispy_function_keys
[event
->code
- FUNCTION_KEY_OFFSET
])
5559 return modify_event_symbol (event
->code
- FUNCTION_KEY_OFFSET
,
5561 Qfunction_key
, Qnil
,
5562 lispy_function_keys
, &func_key_syms
,
5563 ARRAYELTS (lispy_function_keys
));
5565 /* Handle system-specific or unknown keysyms.
5566 We need to use an alist rather than a vector as the cache
5567 since we can't make a vector long enough. */
5568 if (NILP (KVAR (current_kboard
, system_key_syms
)))
5569 kset_system_key_syms (current_kboard
, Fcons (Qnil
, Qnil
));
5570 return modify_event_symbol (event
->code
,
5573 KVAR (current_kboard
, Vsystem_key_alist
),
5574 0, &KVAR (current_kboard
, system_key_syms
),
5578 case MULTIMEDIA_KEY_EVENT
:
5579 if (event
->code
< ARRAYELTS (lispy_multimedia_keys
)
5580 && event
->code
> 0 && lispy_multimedia_keys
[event
->code
])
5582 return modify_event_symbol (event
->code
, event
->modifiers
,
5583 Qfunction_key
, Qnil
,
5584 lispy_multimedia_keys
, &func_key_syms
,
5585 ARRAYELTS (lispy_multimedia_keys
));
5590 /* A mouse click. Figure out where it is, decide whether it's
5591 a press, click or drag, and build the appropriate structure. */
5592 case MOUSE_CLICK_EVENT
:
5594 case GPM_CLICK_EVENT
:
5596 #ifndef USE_TOOLKIT_SCROLL_BARS
5597 case SCROLL_BAR_CLICK_EVENT
:
5598 case HORIZONTAL_SCROLL_BAR_CLICK_EVENT
:
5601 int button
= event
->code
;
5603 Lisp_Object position
;
5604 Lisp_Object
*start_pos_ptr
;
5605 Lisp_Object start_pos
;
5609 /* Build the position as appropriate for this mouse click. */
5610 if (event
->kind
== MOUSE_CLICK_EVENT
5612 || event
->kind
== GPM_CLICK_EVENT
5616 struct frame
*f
= XFRAME (event
->frame_or_window
);
5619 /* Ignore mouse events that were made on frame that
5620 have been deleted. */
5621 if (! FRAME_LIVE_P (f
))
5624 /* EVENT->x and EVENT->y are frame-relative pixel
5625 coordinates at this place. Under old redisplay, COLUMN
5626 and ROW are set to frame relative glyph coordinates
5627 which are then used to determine whether this click is
5628 in a menu (non-toolkit version). */
5629 if (!toolkit_menubar_in_use (f
))
5631 pixel_to_glyph_coords (f
, XINT (event
->x
), XINT (event
->y
),
5632 &column
, &row
, NULL
, 1);
5634 /* In the non-toolkit version, clicks on the menu bar
5635 are ordinary button events in the event buffer.
5636 Distinguish them, and invoke the menu.
5638 (In the toolkit version, the toolkit handles the
5639 menu bar and Emacs doesn't know about it until
5640 after the user makes a selection.) */
5641 if (row
>= 0 && row
< FRAME_MENU_BAR_LINES (f
)
5642 && (event
->modifiers
& down_modifier
))
5644 Lisp_Object items
, item
;
5646 /* Find the menu bar item under `column'. */
5648 items
= FRAME_MENU_BAR_ITEMS (f
);
5649 for (i
= 0; i
< ASIZE (items
); i
+= 4)
5651 Lisp_Object pos
, string
;
5652 string
= AREF (items
, i
+ 1);
5653 pos
= AREF (items
, i
+ 3);
5656 if (column
>= XINT (pos
)
5657 && column
< XINT (pos
) + SCHARS (string
))
5659 item
= AREF (items
, i
);
5664 /* ELisp manual 2.4b says (x y) are window
5665 relative but code says they are
5667 position
= list4 (event
->frame_or_window
,
5669 Fcons (event
->x
, event
->y
),
5670 make_number (event
->timestamp
));
5672 return list2 (item
, position
);
5676 position
= make_lispy_position (f
, event
->x
, event
->y
,
5679 #ifndef USE_TOOLKIT_SCROLL_BARS
5681 /* It's a scrollbar click. */
5682 position
= make_scroll_bar_position (event
, Qvertical_scroll_bar
);
5683 #endif /* not USE_TOOLKIT_SCROLL_BARS */
5685 if (button
>= ASIZE (button_down_location
))
5687 ptrdiff_t incr
= button
- ASIZE (button_down_location
) + 1;
5688 button_down_location
= larger_vector (button_down_location
,
5690 mouse_syms
= larger_vector (mouse_syms
, incr
, -1);
5693 start_pos_ptr
= aref_addr (button_down_location
, button
);
5694 start_pos
= *start_pos_ptr
;
5695 *start_pos_ptr
= Qnil
;
5698 /* On window-system frames, use the value of
5699 double-click-fuzz as is. On other frames, interpret it
5700 as a multiple of 1/8 characters. */
5704 if (WINDOWP (event
->frame_or_window
))
5705 f
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5706 else if (FRAMEP (event
->frame_or_window
))
5707 f
= XFRAME (event
->frame_or_window
);
5711 if (FRAME_WINDOW_P (f
))
5712 fuzz
= double_click_fuzz
;
5714 fuzz
= double_click_fuzz
/ 8;
5716 is_double
= (button
== last_mouse_button
5717 && (eabs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5718 && (eabs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5719 && button_down_time
!= 0
5720 && (EQ (Vdouble_click_time
, Qt
)
5721 || (NATNUMP (Vdouble_click_time
)
5722 && (event
->timestamp
- button_down_time
5723 < XFASTINT (Vdouble_click_time
)))));
5726 last_mouse_button
= button
;
5727 last_mouse_x
= XINT (event
->x
);
5728 last_mouse_y
= XINT (event
->y
);
5730 /* If this is a button press, squirrel away the location, so
5731 we can decide later whether it was a click or a drag. */
5732 if (event
->modifiers
& down_modifier
)
5736 double_click_count
++;
5737 event
->modifiers
|= ((double_click_count
> 2)
5742 double_click_count
= 1;
5743 button_down_time
= event
->timestamp
;
5744 *start_pos_ptr
= Fcopy_alist (position
);
5745 ignore_mouse_drag_p
= 0;
5748 /* Now we're releasing a button - check the co-ordinates to
5749 see if this was a click or a drag. */
5750 else if (event
->modifiers
& up_modifier
)
5752 /* If we did not see a down before this up, ignore the up.
5753 Probably this happened because the down event chose a
5754 menu item. It would be an annoyance to treat the
5755 release of the button that chose the menu item as a
5758 if (!CONSP (start_pos
))
5761 event
->modifiers
&= ~up_modifier
;
5764 Lisp_Object new_down
, down
;
5765 EMACS_INT xdiff
= double_click_fuzz
, ydiff
= double_click_fuzz
;
5767 /* The third element of every position
5768 should be the (x,y) pair. */
5769 down
= Fcar (Fcdr (Fcdr (start_pos
)));
5770 new_down
= Fcar (Fcdr (Fcdr (position
)));
5773 && INTEGERP (XCAR (down
)) && INTEGERP (XCDR (down
)))
5775 xdiff
= XINT (XCAR (new_down
)) - XINT (XCAR (down
));
5776 ydiff
= XINT (XCDR (new_down
)) - XINT (XCDR (down
));
5779 if (ignore_mouse_drag_p
)
5781 event
->modifiers
|= click_modifier
;
5782 ignore_mouse_drag_p
= 0;
5784 else if (xdiff
< double_click_fuzz
&& xdiff
> - double_click_fuzz
5785 && ydiff
< double_click_fuzz
&& ydiff
> - double_click_fuzz
5786 /* Maybe the mouse has moved a lot, caused scrolling, and
5787 eventually ended up at the same screen position (but
5788 not buffer position) in which case it is a drag, not
5790 /* FIXME: OTOH if the buffer position has changed
5791 because of a timer or process filter rather than
5792 because of mouse movement, it should be considered as
5793 a click. But mouse-drag-region completely ignores
5794 this case and it hasn't caused any real problem, so
5795 it's probably OK to ignore it as well. */
5796 && EQ (Fcar (Fcdr (start_pos
)), Fcar (Fcdr (position
))))
5797 /* Mouse hasn't moved (much). */
5798 event
->modifiers
|= click_modifier
;
5801 button_down_time
= 0;
5802 event
->modifiers
|= drag_modifier
;
5805 /* Don't check is_double; treat this as multiple
5806 if the down-event was multiple. */
5807 if (double_click_count
> 1)
5808 event
->modifiers
|= ((double_click_count
> 2)
5814 /* Every mouse event should either have the down_modifier or
5815 the up_modifier set. */
5819 /* Get the symbol we should use for the mouse click. */
5822 head
= modify_event_symbol (button
,
5824 Qmouse_click
, Vlispy_mouse_stem
,
5827 ASIZE (mouse_syms
));
5828 if (event
->modifiers
& drag_modifier
)
5829 return list3 (head
, start_pos
, position
);
5830 else if (event
->modifiers
& (double_modifier
| triple_modifier
))
5831 return list3 (head
, position
, make_number (double_click_count
));
5833 return list2 (head
, position
);
5838 case HORIZ_WHEEL_EVENT
:
5840 Lisp_Object position
;
5843 /* Build the position as appropriate for this mouse click. */
5844 struct frame
*f
= XFRAME (event
->frame_or_window
);
5846 /* Ignore wheel events that were made on frame that have been
5848 if (! FRAME_LIVE_P (f
))
5851 position
= make_lispy_position (f
, event
->x
, event
->y
,
5854 /* Set double or triple modifiers to indicate the wheel speed. */
5856 /* On window-system frames, use the value of
5857 double-click-fuzz as is. On other frames, interpret it
5858 as a multiple of 1/8 characters. */
5864 if (WINDOWP (event
->frame_or_window
))
5865 fr
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5866 else if (FRAMEP (event
->frame_or_window
))
5867 fr
= XFRAME (event
->frame_or_window
);
5871 fuzz
= FRAME_WINDOW_P (fr
)
5872 ? double_click_fuzz
: double_click_fuzz
/ 8;
5874 if (event
->modifiers
& up_modifier
)
5876 /* Emit a wheel-up event. */
5877 event
->modifiers
&= ~up_modifier
;
5880 else if (event
->modifiers
& down_modifier
)
5882 /* Emit a wheel-down event. */
5883 event
->modifiers
&= ~down_modifier
;
5887 /* Every wheel event should either have the down_modifier or
5888 the up_modifier set. */
5891 if (event
->kind
== HORIZ_WHEEL_EVENT
)
5894 is_double
= (last_mouse_button
== - (1 + symbol_num
)
5895 && (eabs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5896 && (eabs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5897 && button_down_time
!= 0
5898 && (EQ (Vdouble_click_time
, Qt
)
5899 || (NATNUMP (Vdouble_click_time
)
5900 && (event
->timestamp
- button_down_time
5901 < XFASTINT (Vdouble_click_time
)))));
5904 double_click_count
++;
5905 event
->modifiers
|= ((double_click_count
> 2)
5911 double_click_count
= 1;
5912 event
->modifiers
|= click_modifier
;
5915 button_down_time
= event
->timestamp
;
5916 /* Use a negative value to distinguish wheel from mouse button. */
5917 last_mouse_button
= - (1 + symbol_num
);
5918 last_mouse_x
= XINT (event
->x
);
5919 last_mouse_y
= XINT (event
->y
);
5921 /* Get the symbol we should use for the wheel event. */
5922 head
= modify_event_symbol (symbol_num
,
5928 ASIZE (wheel_syms
));
5931 if (event
->modifiers
& (double_modifier
| triple_modifier
))
5932 return list3 (head
, position
, make_number (double_click_count
));
5934 return list2 (head
, position
);
5938 #ifdef USE_TOOLKIT_SCROLL_BARS
5940 /* We don't have down and up events if using toolkit scroll bars,
5941 so make this always a click event. Store in the `part' of
5942 the Lisp event a symbol which maps to the following actions:
5944 `above_handle' page up
5945 `below_handle' page down
5949 `bottom' bottom of buffer
5950 `handle' thumb has been dragged.
5951 `end-scroll' end of interaction with scroll bar
5953 The incoming input_event contains in its `part' member an
5954 index of type `enum scroll_bar_part' which we can use as an
5955 index in scroll_bar_parts to get the appropriate symbol. */
5957 case SCROLL_BAR_CLICK_EVENT
:
5959 Lisp_Object position
, head
;
5961 position
= make_scroll_bar_position (event
, Qvertical_scroll_bar
);
5963 /* Always treat scroll bar events as clicks. */
5964 event
->modifiers
|= click_modifier
;
5965 event
->modifiers
&= ~up_modifier
;
5967 if (event
->code
>= ASIZE (mouse_syms
))
5968 mouse_syms
= larger_vector (mouse_syms
,
5969 event
->code
- ASIZE (mouse_syms
) + 1,
5972 /* Get the symbol we should use for the mouse click. */
5973 head
= modify_event_symbol (event
->code
,
5978 ASIZE (mouse_syms
));
5979 return list2 (head
, position
);
5982 case HORIZONTAL_SCROLL_BAR_CLICK_EVENT
:
5984 Lisp_Object position
, head
;
5986 position
= make_scroll_bar_position (event
, Qhorizontal_scroll_bar
);
5988 /* Always treat scroll bar events as clicks. */
5989 event
->modifiers
|= click_modifier
;
5990 event
->modifiers
&= ~up_modifier
;
5992 if (event
->code
>= ASIZE (mouse_syms
))
5993 mouse_syms
= larger_vector (mouse_syms
,
5994 event
->code
- ASIZE (mouse_syms
) + 1,
5997 /* Get the symbol we should use for the mouse click. */
5998 head
= modify_event_symbol (event
->code
,
6003 ASIZE (mouse_syms
));
6004 return list2 (head
, position
);
6007 #endif /* USE_TOOLKIT_SCROLL_BARS */
6009 case DRAG_N_DROP_EVENT
:
6012 Lisp_Object head
, position
;
6015 f
= XFRAME (event
->frame_or_window
);
6018 /* Ignore mouse events that were made on frames that
6019 have been deleted. */
6020 if (! FRAME_LIVE_P (f
))
6023 position
= make_lispy_position (f
, event
->x
, event
->y
,
6026 head
= modify_event_symbol (0, event
->modifiers
,
6028 lispy_drag_n_drop_names
,
6029 &drag_n_drop_syms
, 1);
6030 return list3 (head
, position
, files
);
6033 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
6034 || defined (HAVE_NS) || defined (USE_GTK)
6035 case MENU_BAR_EVENT
:
6036 if (EQ (event
->arg
, event
->frame_or_window
))
6037 /* This is the prefix key. We translate this to
6038 `(menu_bar)' because the code in keyboard.c for menu
6039 events, which we use, relies on this. */
6040 return list1 (Qmenu_bar
);
6044 case SELECT_WINDOW_EVENT
:
6045 /* Make an event (select-window (WINDOW)). */
6046 return list2 (Qselect_window
, list1 (event
->frame_or_window
));
6048 case TOOL_BAR_EVENT
:
6049 if (EQ (event
->arg
, event
->frame_or_window
))
6050 /* This is the prefix key. We translate this to
6051 `(tool_bar)' because the code in keyboard.c for tool bar
6052 events, which we use, relies on this. */
6053 return list1 (Qtool_bar
);
6054 else if (SYMBOLP (event
->arg
))
6055 return apply_modifiers (event
->modifiers
, event
->arg
);
6058 case USER_SIGNAL_EVENT
:
6059 /* A user signal. */
6061 char *name
= find_user_signal_name (event
->code
);
6064 return intern (name
);
6067 case SAVE_SESSION_EVENT
:
6068 return Qsave_session
;
6073 return Fcons (Qdbus_event
, event
->arg
);
6075 #endif /* HAVE_DBUS */
6077 #if defined HAVE_GFILENOTIFY || defined HAVE_INOTIFY
6078 case FILE_NOTIFY_EVENT
:
6080 return Fcons (Qfile_notify
, event
->arg
);
6082 #endif /* defined HAVE_GFILENOTIFY || defined HAVE_INOTIFY */
6084 case CONFIG_CHANGED_EVENT
:
6085 return list3 (Qconfig_changed_event
,
6086 event
->arg
, event
->frame_or_window
);
6088 /* The 'kind' field of the event is something we don't recognize. */
6095 make_lispy_movement (struct frame
*frame
, Lisp_Object bar_window
, enum scroll_bar_part part
,
6096 Lisp_Object x
, Lisp_Object y
, Time t
)
6098 /* Is it a scroll bar movement? */
6099 if (frame
&& ! NILP (bar_window
))
6101 Lisp_Object part_sym
;
6103 part_sym
= builtin_lisp_symbol (scroll_bar_parts
[part
]);
6104 return list2 (Qscroll_bar_movement
,
6106 Qvertical_scroll_bar
,
6111 /* Or is it an ordinary mouse movement? */
6114 Lisp_Object position
;
6115 position
= make_lispy_position (frame
, x
, y
, t
);
6116 return list2 (Qmouse_movement
, position
);
6120 /* Construct a switch frame event. */
6122 make_lispy_switch_frame (Lisp_Object frame
)
6124 return list2 (Qswitch_frame
, frame
);
6128 make_lispy_focus_in (Lisp_Object frame
)
6130 return list2 (Qfocus_in
, frame
);
6133 #ifdef HAVE_WINDOW_SYSTEM
6136 make_lispy_focus_out (Lisp_Object frame
)
6138 return list2 (Qfocus_out
, frame
);
6141 #endif /* HAVE_WINDOW_SYSTEM */
6143 /* Manipulating modifiers. */
6145 /* Parse the name of SYMBOL, and return the set of modifiers it contains.
6147 If MODIFIER_END is non-zero, set *MODIFIER_END to the position in
6148 SYMBOL's name of the end of the modifiers; the string from this
6149 position is the unmodified symbol name.
6151 This doesn't use any caches. */
6154 parse_modifiers_uncached (Lisp_Object symbol
, ptrdiff_t *modifier_end
)
6160 CHECK_SYMBOL (symbol
);
6163 name
= SYMBOL_NAME (symbol
);
6165 for (i
= 0; i
< SBYTES (name
) - 1; )
6167 ptrdiff_t this_mod_end
= 0;
6170 /* See if the name continues with a modifier word.
6171 Check that the word appears, but don't check what follows it.
6172 Set this_mod and this_mod_end to record what we find. */
6174 switch (SREF (name
, i
))
6176 #define SINGLE_LETTER_MOD(BIT) \
6177 (this_mod_end = i + 1, this_mod = BIT)
6180 SINGLE_LETTER_MOD (alt_modifier
);
6184 SINGLE_LETTER_MOD (ctrl_modifier
);
6188 SINGLE_LETTER_MOD (hyper_modifier
);
6192 SINGLE_LETTER_MOD (meta_modifier
);
6196 SINGLE_LETTER_MOD (shift_modifier
);
6200 SINGLE_LETTER_MOD (super_modifier
);
6203 #undef SINGLE_LETTER_MOD
6205 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6206 if (i + LEN + 1 <= SBYTES (name) \
6207 && ! memcmp (SDATA (name) + i, NAME, LEN)) \
6209 this_mod_end = i + LEN; \
6214 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
6215 MULTI_LETTER_MOD (down_modifier
, "down", 4);
6216 MULTI_LETTER_MOD (double_modifier
, "double", 6);
6220 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
6222 #undef MULTI_LETTER_MOD
6226 /* If we found no modifier, stop looking for them. */
6227 if (this_mod_end
== 0)
6230 /* Check there is a dash after the modifier, so that it
6231 really is a modifier. */
6232 if (this_mod_end
>= SBYTES (name
)
6233 || SREF (name
, this_mod_end
) != '-')
6236 /* This modifier is real; look for another. */
6237 modifiers
|= this_mod
;
6238 i
= this_mod_end
+ 1;
6241 /* Should we include the `click' modifier? */
6242 if (! (modifiers
& (down_modifier
| drag_modifier
6243 | double_modifier
| triple_modifier
))
6244 && i
+ 7 == SBYTES (name
)
6245 && memcmp (SDATA (name
) + i
, "mouse-", 6) == 0
6246 && ('0' <= SREF (name
, i
+ 6) && SREF (name
, i
+ 6) <= '9'))
6247 modifiers
|= click_modifier
;
6249 if (! (modifiers
& (double_modifier
| triple_modifier
))
6250 && i
+ 6 < SBYTES (name
)
6251 && memcmp (SDATA (name
) + i
, "wheel-", 6) == 0)
6252 modifiers
|= click_modifier
;
6260 /* Return a symbol whose name is the modifier prefixes for MODIFIERS
6261 prepended to the string BASE[0..BASE_LEN-1].
6262 This doesn't use any caches. */
6264 apply_modifiers_uncached (int modifiers
, char *base
, int base_len
, int base_len_byte
)
6266 /* Since BASE could contain nulls, we can't use intern here; we have
6267 to use Fintern, which expects a genuine Lisp_String, and keeps a
6269 char new_mods
[sizeof "A-C-H-M-S-s-down-drag-double-triple-"];
6275 /* Only the event queue may use the `up' modifier; it should always
6276 be turned into a click or drag event before presented to lisp code. */
6277 if (modifiers
& up_modifier
)
6280 if (modifiers
& alt_modifier
) { *p
++ = 'A'; *p
++ = '-'; }
6281 if (modifiers
& ctrl_modifier
) { *p
++ = 'C'; *p
++ = '-'; }
6282 if (modifiers
& hyper_modifier
) { *p
++ = 'H'; *p
++ = '-'; }
6283 if (modifiers
& meta_modifier
) { *p
++ = 'M'; *p
++ = '-'; }
6284 if (modifiers
& shift_modifier
) { *p
++ = 'S'; *p
++ = '-'; }
6285 if (modifiers
& super_modifier
) { *p
++ = 's'; *p
++ = '-'; }
6286 if (modifiers
& double_modifier
) p
= stpcpy (p
, "double-");
6287 if (modifiers
& triple_modifier
) p
= stpcpy (p
, "triple-");
6288 if (modifiers
& down_modifier
) p
= stpcpy (p
, "down-");
6289 if (modifiers
& drag_modifier
) p
= stpcpy (p
, "drag-");
6290 /* The click modifier is denoted by the absence of other modifiers. */
6294 mod_len
= p
- new_mods
;
6298 Lisp_Object new_name
;
6300 new_name
= make_uninit_multibyte_string (mod_len
+ base_len
,
6301 mod_len
+ base_len_byte
);
6302 memcpy (SDATA (new_name
), new_mods
, mod_len
);
6303 memcpy (SDATA (new_name
) + mod_len
, base
, base_len_byte
);
6305 return Fintern (new_name
, Qnil
);
6310 static const char *const modifier_names
[] =
6312 "up", "down", "drag", "click", "double", "triple", 0, 0,
6313 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
6314 0, 0, "alt", "super", "hyper", "shift", "control", "meta"
6316 #define NUM_MOD_NAMES ARRAYELTS (modifier_names)
6318 static Lisp_Object modifier_symbols
;
6320 /* Return the list of modifier symbols corresponding to the mask MODIFIERS. */
6322 lispy_modifier_list (int modifiers
)
6324 Lisp_Object modifier_list
;
6327 modifier_list
= Qnil
;
6328 for (i
= 0; (1<<i
) <= modifiers
&& i
< NUM_MOD_NAMES
; i
++)
6329 if (modifiers
& (1<<i
))
6330 modifier_list
= Fcons (AREF (modifier_symbols
, i
),
6333 return modifier_list
;
6337 /* Parse the modifiers on SYMBOL, and return a list like (UNMODIFIED MASK),
6338 where UNMODIFIED is the unmodified form of SYMBOL,
6339 MASK is the set of modifiers present in SYMBOL's name.
6340 This is similar to parse_modifiers_uncached, but uses the cache in
6341 SYMBOL's Qevent_symbol_element_mask property, and maintains the
6342 Qevent_symbol_elements property. */
6344 #define KEY_TO_CHAR(k) (XINT (k) & ((1 << CHARACTERBITS) - 1))
6347 parse_modifiers (Lisp_Object symbol
)
6349 Lisp_Object elements
;
6351 if (INTEGERP (symbol
))
6352 return list2i (KEY_TO_CHAR (symbol
), XINT (symbol
) & CHAR_MODIFIER_MASK
);
6353 else if (!SYMBOLP (symbol
))
6356 elements
= Fget (symbol
, Qevent_symbol_element_mask
);
6357 if (CONSP (elements
))
6362 int modifiers
= parse_modifiers_uncached (symbol
, &end
);
6363 Lisp_Object unmodified
;
6366 unmodified
= Fintern (make_string (SSDATA (SYMBOL_NAME (symbol
)) + end
,
6367 SBYTES (SYMBOL_NAME (symbol
)) - end
),
6370 if (modifiers
& ~INTMASK
)
6372 XSETFASTINT (mask
, modifiers
);
6373 elements
= list2 (unmodified
, mask
);
6375 /* Cache the parsing results on SYMBOL. */
6376 Fput (symbol
, Qevent_symbol_element_mask
,
6378 Fput (symbol
, Qevent_symbol_elements
,
6379 Fcons (unmodified
, lispy_modifier_list (modifiers
)));
6381 /* Since we know that SYMBOL is modifiers applied to unmodified,
6382 it would be nice to put that in unmodified's cache.
6383 But we can't, since we're not sure that parse_modifiers is
6390 DEFUN ("internal-event-symbol-parse-modifiers", Fevent_symbol_parse_modifiers
,
6391 Sevent_symbol_parse_modifiers
, 1, 1, 0,
6392 doc
: /* Parse the event symbol. For internal use. */)
6393 (Lisp_Object symbol
)
6395 /* Fill the cache if needed. */
6396 parse_modifiers (symbol
);
6397 /* Ignore the result (which is stored on Qevent_symbol_element_mask)
6398 and use the Lispier representation stored on Qevent_symbol_elements
6400 return Fget (symbol
, Qevent_symbol_elements
);
6403 /* Apply the modifiers MODIFIERS to the symbol BASE.
6404 BASE must be unmodified.
6406 This is like apply_modifiers_uncached, but uses BASE's
6407 Qmodifier_cache property, if present. It also builds
6408 Qevent_symbol_elements properties, since it has that info anyway.
6410 apply_modifiers copies the value of BASE's Qevent_kind property to
6411 the modified symbol. */
6413 apply_modifiers (int modifiers
, Lisp_Object base
)
6415 Lisp_Object cache
, idx
, entry
, new_symbol
;
6417 /* Mask out upper bits. We don't know where this value's been. */
6418 modifiers
&= INTMASK
;
6420 if (INTEGERP (base
))
6421 return make_number (XINT (base
) | modifiers
);
6423 /* The click modifier never figures into cache indices. */
6424 cache
= Fget (base
, Qmodifier_cache
);
6425 XSETFASTINT (idx
, (modifiers
& ~click_modifier
));
6426 entry
= assq_no_quit (idx
, cache
);
6429 new_symbol
= XCDR (entry
);
6432 /* We have to create the symbol ourselves. */
6433 new_symbol
= apply_modifiers_uncached (modifiers
,
6434 SSDATA (SYMBOL_NAME (base
)),
6435 SCHARS (SYMBOL_NAME (base
)),
6436 SBYTES (SYMBOL_NAME (base
)));
6438 /* Add the new symbol to the base's cache. */
6439 entry
= Fcons (idx
, new_symbol
);
6440 Fput (base
, Qmodifier_cache
, Fcons (entry
, cache
));
6442 /* We have the parsing info now for free, so we could add it to
6444 XSETFASTINT (idx, modifiers);
6445 Fput (new_symbol, Qevent_symbol_element_mask,
6447 Fput (new_symbol, Qevent_symbol_elements,
6448 Fcons (base, lispy_modifier_list (modifiers)));
6449 Sadly, this is only correct if `base' is indeed a base event,
6450 which is not necessarily the case. -stef */
6453 /* Make sure this symbol is of the same kind as BASE.
6455 You'd think we could just set this once and for all when we
6456 intern the symbol above, but reorder_modifiers may call us when
6457 BASE's property isn't set right; we can't assume that just
6458 because it has a Qmodifier_cache property it must have its
6459 Qevent_kind set right as well. */
6460 if (NILP (Fget (new_symbol
, Qevent_kind
)))
6464 kind
= Fget (base
, Qevent_kind
);
6466 Fput (new_symbol
, Qevent_kind
, kind
);
6473 /* Given a symbol whose name begins with modifiers ("C-", "M-", etc),
6474 return a symbol with the modifiers placed in the canonical order.
6475 Canonical order is alphabetical, except for down and drag, which
6476 always come last. The 'click' modifier is never written out.
6478 Fdefine_key calls this to make sure that (for example) C-M-foo
6479 and M-C-foo end up being equivalent in the keymap. */
6482 reorder_modifiers (Lisp_Object symbol
)
6484 /* It's hopefully okay to write the code this way, since everything
6485 will soon be in caches, and no consing will be done at all. */
6488 parsed
= parse_modifiers (symbol
);
6489 return apply_modifiers (XFASTINT (XCAR (XCDR (parsed
))),
6494 /* For handling events, we often want to produce a symbol whose name
6495 is a series of modifier key prefixes ("M-", "C-", etcetera) attached
6496 to some base, like the name of a function key or mouse button.
6497 modify_event_symbol produces symbols of this sort.
6499 NAME_TABLE should point to an array of strings, such that NAME_TABLE[i]
6500 is the name of the i'th symbol. TABLE_SIZE is the number of elements
6503 Alternatively, NAME_ALIST_OR_STEM is either an alist mapping codes
6504 into symbol names, or a string specifying a name stem used to
6505 construct a symbol name or the form `STEM-N', where N is the decimal
6506 representation of SYMBOL_NUM. NAME_ALIST_OR_STEM is used if it is
6507 non-nil; otherwise NAME_TABLE is used.
6509 SYMBOL_TABLE should be a pointer to a Lisp_Object whose value will
6510 persist between calls to modify_event_symbol that it can use to
6511 store a cache of the symbols it's generated for this NAME_TABLE
6512 before. The object stored there may be a vector or an alist.
6514 SYMBOL_NUM is the number of the base name we want from NAME_TABLE.
6516 MODIFIERS is a set of modifier bits (as given in struct input_events)
6517 whose prefixes should be applied to the symbol name.
6519 SYMBOL_KIND is the value to be placed in the event_kind property of
6520 the returned symbol.
6522 The symbols we create are supposed to have an
6523 `event-symbol-elements' property, which lists the modifiers present
6524 in the symbol's name. */
6527 modify_event_symbol (ptrdiff_t symbol_num
, int modifiers
, Lisp_Object symbol_kind
,
6528 Lisp_Object name_alist_or_stem
, const char *const *name_table
,
6529 Lisp_Object
*symbol_table
, ptrdiff_t table_size
)
6532 Lisp_Object symbol_int
;
6534 /* Get rid of the "vendor-specific" bit here. */
6535 XSETINT (symbol_int
, symbol_num
& 0xffffff);
6537 /* Is this a request for a valid symbol? */
6538 if (symbol_num
< 0 || symbol_num
>= table_size
)
6541 if (CONSP (*symbol_table
))
6542 value
= Fcdr (assq_no_quit (symbol_int
, *symbol_table
));
6544 /* If *symbol_table doesn't seem to be initialized properly, fix that.
6545 *symbol_table should be a lisp vector TABLE_SIZE elements long,
6546 where the Nth element is the symbol for NAME_TABLE[N], or nil if
6547 we've never used that symbol before. */
6550 if (! VECTORP (*symbol_table
)
6551 || ASIZE (*symbol_table
) != table_size
)
6555 XSETFASTINT (size
, table_size
);
6556 *symbol_table
= Fmake_vector (size
, Qnil
);
6559 value
= AREF (*symbol_table
, symbol_num
);
6562 /* Have we already used this symbol before? */
6565 /* No; let's create it. */
6566 if (CONSP (name_alist_or_stem
))
6567 value
= Fcdr_safe (Fassq (symbol_int
, name_alist_or_stem
));
6568 else if (STRINGP (name_alist_or_stem
))
6571 ptrdiff_t len
= (SBYTES (name_alist_or_stem
)
6572 + sizeof "-" + INT_STRLEN_BOUND (EMACS_INT
));
6574 buf
= SAFE_ALLOCA (len
);
6575 esprintf (buf
, "%s-%"pI
"d", SDATA (name_alist_or_stem
),
6576 XINT (symbol_int
) + 1);
6577 value
= intern (buf
);
6580 else if (name_table
!= 0 && name_table
[symbol_num
])
6581 value
= intern (name_table
[symbol_num
]);
6583 #ifdef HAVE_WINDOW_SYSTEM
6586 char *name
= x_get_keysym_name (symbol_num
);
6588 value
= intern (name
);
6594 char buf
[sizeof "key-" + INT_STRLEN_BOUND (EMACS_INT
)];
6595 sprintf (buf
, "key-%"pD
"d", symbol_num
);
6596 value
= intern (buf
);
6599 if (CONSP (*symbol_table
))
6600 *symbol_table
= Fcons (Fcons (symbol_int
, value
), *symbol_table
);
6602 ASET (*symbol_table
, symbol_num
, value
);
6604 /* Fill in the cache entries for this symbol; this also
6605 builds the Qevent_symbol_elements property, which the user
6607 apply_modifiers (modifiers
& click_modifier
, value
);
6608 Fput (value
, Qevent_kind
, symbol_kind
);
6611 /* Apply modifiers to that symbol. */
6612 return apply_modifiers (modifiers
, value
);
6615 /* Convert a list that represents an event type,
6616 such as (ctrl meta backspace), into the usual representation of that
6617 event type as a number or a symbol. */
6619 DEFUN ("event-convert-list", Fevent_convert_list
, Sevent_convert_list
, 1, 1, 0,
6620 doc
: /* Convert the event description list EVENT-DESC to an event type.
6621 EVENT-DESC should contain one base event type (a character or symbol)
6622 and zero or more modifier names (control, meta, hyper, super, shift, alt,
6623 drag, down, double or triple). The base must be last.
6624 The return value is an event type (a character or symbol) which
6625 has the same base event type and all the specified modifiers. */)
6626 (Lisp_Object event_desc
)
6634 while (CONSP (rest
))
6642 /* Given a symbol, see if it is a modifier name. */
6643 if (SYMBOLP (elt
) && CONSP (rest
))
6644 this = parse_solitary_modifier (elt
);
6648 else if (!NILP (base
))
6649 error ("Two bases given in one event");
6655 /* Let the symbol A refer to the character A. */
6656 if (SYMBOLP (base
) && SCHARS (SYMBOL_NAME (base
)) == 1)
6657 XSETINT (base
, SREF (SYMBOL_NAME (base
), 0));
6659 if (INTEGERP (base
))
6661 /* Turn (shift a) into A. */
6662 if ((modifiers
& shift_modifier
) != 0
6663 && (XINT (base
) >= 'a' && XINT (base
) <= 'z'))
6665 XSETINT (base
, XINT (base
) - ('a' - 'A'));
6666 modifiers
&= ~shift_modifier
;
6669 /* Turn (control a) into C-a. */
6670 if (modifiers
& ctrl_modifier
)
6671 return make_number ((modifiers
& ~ctrl_modifier
)
6672 | make_ctrl_char (XINT (base
)));
6674 return make_number (modifiers
| XINT (base
));
6676 else if (SYMBOLP (base
))
6677 return apply_modifiers (modifiers
, base
);
6679 error ("Invalid base event");
6682 /* Try to recognize SYMBOL as a modifier name.
6683 Return the modifier flag bit, or 0 if not recognized. */
6686 parse_solitary_modifier (Lisp_Object symbol
)
6688 Lisp_Object name
= SYMBOL_NAME (symbol
);
6690 switch (SREF (name
, 0))
6692 #define SINGLE_LETTER_MOD(BIT) \
6693 if (SBYTES (name) == 1) \
6696 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6697 if (LEN == SBYTES (name) \
6698 && ! memcmp (SDATA (name), NAME, LEN)) \
6702 SINGLE_LETTER_MOD (alt_modifier
);
6706 MULTI_LETTER_MOD (alt_modifier
, "alt", 3);
6710 SINGLE_LETTER_MOD (ctrl_modifier
);
6714 MULTI_LETTER_MOD (ctrl_modifier
, "ctrl", 4);
6715 MULTI_LETTER_MOD (ctrl_modifier
, "control", 7);
6719 SINGLE_LETTER_MOD (hyper_modifier
);
6723 MULTI_LETTER_MOD (hyper_modifier
, "hyper", 5);
6727 SINGLE_LETTER_MOD (meta_modifier
);
6731 MULTI_LETTER_MOD (meta_modifier
, "meta", 4);
6735 SINGLE_LETTER_MOD (shift_modifier
);
6739 MULTI_LETTER_MOD (shift_modifier
, "shift", 5);
6740 MULTI_LETTER_MOD (super_modifier
, "super", 5);
6741 SINGLE_LETTER_MOD (super_modifier
);
6745 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
6746 MULTI_LETTER_MOD (down_modifier
, "down", 4);
6747 MULTI_LETTER_MOD (double_modifier
, "double", 6);
6751 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
6754 #undef SINGLE_LETTER_MOD
6755 #undef MULTI_LETTER_MOD
6761 /* Return true if EVENT is a list whose elements are all integers or symbols.
6762 Such a list is not valid as an event,
6763 but it can be a Lucid-style event type list. */
6766 lucid_event_type_list_p (Lisp_Object object
)
6770 if (! CONSP (object
))
6773 if (EQ (XCAR (object
), Qhelp_echo
)
6774 || EQ (XCAR (object
), Qvertical_line
)
6775 || EQ (XCAR (object
), Qmode_line
)
6776 || EQ (XCAR (object
), Qheader_line
))
6779 for (tail
= object
; CONSP (tail
); tail
= XCDR (tail
))
6783 if (! (INTEGERP (elt
) || SYMBOLP (elt
)))
6790 /* Return true if terminal input chars are available.
6791 Also, store the return value into INPUT_PENDING.
6793 Serves the purpose of ioctl (0, FIONREAD, ...)
6794 but works even if FIONREAD does not exist.
6795 (In fact, this may actually read some input.)
6797 If READABLE_EVENTS_DO_TIMERS_NOW is set in FLAGS, actually run
6798 timer events that are ripe.
6799 If READABLE_EVENTS_FILTER_EVENTS is set in FLAGS, ignore internal
6800 events (FOCUS_IN_EVENT).
6801 If READABLE_EVENTS_IGNORE_SQUEEZABLES is set in FLAGS, ignore mouse
6802 movements and toolkit scroll bar thumb drags. */
6805 get_input_pending (int flags
)
6807 /* First of all, have we already counted some input? */
6808 input_pending
= (!NILP (Vquit_flag
) || readable_events (flags
));
6810 /* If input is being read as it arrives, and we have none, there is none. */
6811 if (!input_pending
&& (!interrupt_input
|| interrupts_deferred
))
6813 /* Try to read some input and see how much we get. */
6815 input_pending
= (!NILP (Vquit_flag
) || readable_events (flags
));
6818 return input_pending
;
6821 /* Put a BUFFER_SWITCH_EVENT in the buffer
6822 so that read_key_sequence will notice the new current buffer. */
6825 record_asynch_buffer_change (void)
6827 /* We don't need a buffer-switch event unless Emacs is waiting for input.
6828 The purpose of the event is to make read_key_sequence look up the
6829 keymaps again. If we aren't in read_key_sequence, we don't need one,
6830 and the event could cause trouble by messing up (input-pending-p).
6831 Note: Fwaiting_for_user_input_p always returns nil when async
6832 subprocesses aren't supported. */
6833 if (!NILP (Fwaiting_for_user_input_p ()))
6835 struct input_event event
;
6838 event
.kind
= BUFFER_SWITCH_EVENT
;
6839 event
.frame_or_window
= Qnil
;
6842 /* Make sure no interrupt happens while storing the event. */
6844 if (interrupt_input
)
6845 kbd_buffer_store_event (&event
);
6850 kbd_buffer_store_event (&event
);
6856 /* Read any terminal input already buffered up by the system
6857 into the kbd_buffer, but do not wait.
6859 Return the number of keyboard chars read, or -1 meaning
6860 this is a bad time to try to read input. */
6869 /* Store pending user signal events, if any. */
6870 store_user_signal_events ();
6872 /* Loop through the available terminals, and call their input hooks. */
6876 struct terminal
*next
= t
->next_terminal
;
6878 if (t
->read_socket_hook
)
6881 struct input_event hold_quit
;
6883 if (input_blocked_p ())
6885 pending_signals
= 1;
6889 EVENT_INIT (hold_quit
);
6890 hold_quit
.kind
= NO_EVENT
;
6892 /* No need for FIONREAD or fcntl; just say don't wait. */
6893 while ((nr
= (*t
->read_socket_hook
) (t
, &hold_quit
)) > 0)
6896 if (nr
== -1) /* Not OK to read input now. */
6900 else if (nr
== -2) /* Non-transient error. */
6902 /* The terminal device terminated; it should be closed. */
6904 /* Kill Emacs if this was our last terminal. */
6905 if (!terminal_list
->next_terminal
)
6906 /* Formerly simply reported no input, but that
6907 sometimes led to a failure of Emacs to terminate.
6908 SIGHUP seems appropriate if we can't reach the
6910 /* ??? Is it really right to send the signal just to
6911 this process rather than to the whole process
6912 group? Perhaps on systems with FIONREAD Emacs is
6913 alone in its group. */
6914 terminate_due_to_signal (SIGHUP
, 10);
6916 /* XXX Is calling delete_terminal safe here? It calls delete_frame. */
6919 XSETTERMINAL (tmp
, t
);
6920 Fdelete_terminal (tmp
, Qnoelisp
);
6924 /* If there was no error, make sure the pointer
6925 is visible for all frames on this terminal. */
6928 Lisp_Object tail
, frame
;
6930 FOR_EACH_FRAME (tail
, frame
)
6932 struct frame
*f
= XFRAME (frame
);
6933 if (FRAME_TERMINAL (f
) == t
)
6934 frame_make_pointer_visible (f
);
6938 if (hold_quit
.kind
!= NO_EVENT
)
6939 kbd_buffer_store_event (&hold_quit
);
6951 /* This is the tty way of reading available input.
6953 Note that each terminal device has its own `struct terminal' object,
6954 and so this function is called once for each individual termcap
6955 terminal. The first parameter indicates which terminal to read from. */
6958 tty_read_avail_input (struct terminal
*terminal
,
6959 struct input_event
*hold_quit
)
6961 /* Using KBD_BUFFER_SIZE - 1 here avoids reading more than
6962 the kbd_buffer can really hold. That may prevent loss
6963 of characters on some systems when input is stuffed at us. */
6964 unsigned char cbuf
[KBD_BUFFER_SIZE
- 1];
6966 struct tty_display_info
*tty
= terminal
->display_info
.tty
;
6969 int buffer_free
= KBD_BUFFER_SIZE
- kbd_buffer_nr_stored () - 1;
6971 if (kbd_on_hold_p () || buffer_free
<= 0)
6973 #endif /* subprocesses */
6975 if (!terminal
->name
) /* Don't read from a dead terminal. */
6978 if (terminal
->type
!= output_termcap
6979 && terminal
->type
!= output_msdos_raw
)
6982 /* XXX I think the following code should be moved to separate hook
6983 functions in system-dependent files. */
6985 /* FIXME: AFAIK, tty_read_avail_input is not used under w32 since the non-GUI
6986 code sets read_socket_hook to w32_console_read_socket instead! */
6988 #else /* not WINDOWSNT */
6989 if (! tty
->term_initted
) /* In case we get called during bootstrap. */
6993 return 0; /* The terminal is suspended. */
6996 n_to_read
= dos_keysns ();
7000 cbuf
[0] = dos_keyread ();
7003 #else /* not MSDOS */
7008 struct input_event gpm_hold_quit
;
7009 int gpm
, fd
= gpm_fd
;
7011 EVENT_INIT (gpm_hold_quit
);
7012 gpm_hold_quit
.kind
= NO_EVENT
;
7014 /* gpm==1 if event received.
7015 gpm==0 if the GPM daemon has closed the connection, in which case
7016 Gpm_GetEvent closes gpm_fd and clears it to -1, which is why
7017 we save it in `fd' so close_gpm can remove it from the
7019 gpm==-1 if a protocol error or EWOULDBLOCK; the latter is normal. */
7020 while (gpm
= Gpm_GetEvent (&event
), gpm
== 1) {
7021 nread
+= handle_one_term_event (tty
, &event
, &gpm_hold_quit
);
7024 /* Presumably the GPM daemon has closed the connection. */
7026 if (gpm_hold_quit
.kind
!= NO_EVENT
)
7027 kbd_buffer_store_event (&gpm_hold_quit
);
7031 #endif /* HAVE_GPM */
7033 /* Determine how many characters we should *try* to read. */
7034 #ifdef USABLE_FIONREAD
7035 /* Find out how much input is available. */
7036 if (ioctl (fileno (tty
->input
), FIONREAD
, &n_to_read
) < 0)
7038 if (! noninteractive
)
7039 return -2; /* Close this terminal. */
7045 if (n_to_read
> sizeof cbuf
)
7046 n_to_read
= sizeof cbuf
;
7047 #elif defined USG || defined CYGWIN
7048 /* Read some input if available, but don't wait. */
7049 n_to_read
= sizeof cbuf
;
7050 fcntl (fileno (tty
->input
), F_SETFL
, O_NONBLOCK
);
7052 # error "Cannot read without possibly delaying"
7056 /* Don't read more than we can store. */
7057 if (n_to_read
> buffer_free
)
7058 n_to_read
= buffer_free
;
7059 #endif /* subprocesses */
7061 /* Now read; for one reason or another, this will not block.
7062 NREAD is set to the number of chars read. */
7065 nread
= emacs_read (fileno (tty
->input
), (char *) cbuf
, n_to_read
);
7066 /* POSIX infers that processes which are not in the session leader's
7067 process group won't get SIGHUPs at logout time. BSDI adheres to
7068 this part standard and returns -1 from read (0) with errno==EIO
7069 when the control tty is taken away.
7070 Jeffrey Honig <jch@bsdi.com> says this is generally safe. */
7071 if (nread
== -1 && errno
== EIO
)
7072 return -2; /* Close this terminal. */
7073 #if defined (AIX) && defined (_BSD)
7074 /* The kernel sometimes fails to deliver SIGHUP for ptys.
7075 This looks incorrect, but it isn't, because _BSD causes
7076 O_NDELAY to be defined in fcntl.h as O_NONBLOCK,
7077 and that causes a value other than 0 when there is no input. */
7079 return -2; /* Close this terminal. */
7083 /* We used to retry the read if it was interrupted.
7084 But this does the wrong thing when O_NONBLOCK causes
7085 an EAGAIN error. Does anybody know of a situation
7086 where a retry is actually needed? */
7088 nread
< 0 && (errno
== EAGAIN
|| errno
== EFAULT
7098 #ifndef USABLE_FIONREAD
7099 #if defined (USG) || defined (CYGWIN)
7100 fcntl (fileno (tty
->input
), F_SETFL
, 0);
7101 #endif /* USG or CYGWIN */
7102 #endif /* no FIONREAD */
7107 #endif /* not MSDOS */
7108 #endif /* not WINDOWSNT */
7110 for (i
= 0; i
< nread
; i
++)
7112 struct input_event buf
;
7114 buf
.kind
= ASCII_KEYSTROKE_EVENT
;
7116 if (tty
->meta_key
== 1 && (cbuf
[i
] & 0x80))
7117 buf
.modifiers
= meta_modifier
;
7118 if (tty
->meta_key
!= 2)
7122 /* Set the frame corresponding to the active tty. Note that the
7123 value of selected_frame is not reliable here, redisplay tends
7124 to temporarily change it. */
7125 buf
.frame_or_window
= tty
->top_frame
;
7128 kbd_buffer_store_event (&buf
);
7129 /* Don't look at input that follows a C-g too closely.
7130 This reduces lossage due to autorepeat on C-g. */
7131 if (buf
.kind
== ASCII_KEYSTROKE_EVENT
7132 && buf
.code
== quit_char
)
7140 handle_async_input (void)
7145 int nread
= gobble_input ();
7146 /* -1 means it's not ok to read the input now.
7147 UNBLOCK_INPUT will read it later; now, avoid infinite loop.
7148 0 means there was no keyboard input available. */
7156 process_pending_signals (void)
7158 pending_signals
= 0;
7159 handle_async_input ();
7160 do_pending_atimers ();
7163 /* Undo any number of BLOCK_INPUT calls down to level LEVEL,
7164 and reinvoke any pending signal if the level is now 0 and
7165 a fatal error is not already in progress. */
7168 unblock_input_to (int level
)
7170 interrupt_input_blocked
= level
;
7173 if (pending_signals
&& !fatal_error_in_progress
)
7174 process_pending_signals ();
7180 /* End critical section.
7182 If doing signal-driven input, and a signal came in when input was
7183 blocked, reinvoke the signal handler now to deal with it.
7185 It will also process queued input, if it was not read before.
7186 When a longer code sequence does not use block/unblock input
7187 at all, the whole input gathered up to the next call to
7188 unblock_input will be processed inside that call. */
7191 unblock_input (void)
7193 unblock_input_to (interrupt_input_blocked
- 1);
7196 /* Undo any number of BLOCK_INPUT calls,
7197 and also reinvoke any pending signal. */
7200 totally_unblock_input (void)
7202 unblock_input_to (0);
7208 handle_input_available_signal (int sig
)
7210 pending_signals
= 1;
7212 if (input_available_clear_time
)
7213 *input_available_clear_time
= make_timespec (0, 0);
7217 deliver_input_available_signal (int sig
)
7219 deliver_process_signal (sig
, handle_input_available_signal
);
7221 #endif /* USABLE_SIGIO */
7224 /* User signal events. */
7226 struct user_signal_info
7228 /* Signal number. */
7231 /* Name of the signal. */
7234 /* Number of pending signals. */
7237 struct user_signal_info
*next
;
7240 /* List of user signals. */
7241 static struct user_signal_info
*user_signals
= NULL
;
7244 add_user_signal (int sig
, const char *name
)
7246 struct sigaction action
;
7247 struct user_signal_info
*p
;
7249 for (p
= user_signals
; p
; p
= p
->next
)
7251 /* Already added. */
7254 p
= xmalloc (sizeof *p
);
7256 p
->name
= xstrdup (name
);
7258 p
->next
= user_signals
;
7261 emacs_sigaction_init (&action
, deliver_user_signal
);
7262 sigaction (sig
, &action
, 0);
7266 handle_user_signal (int sig
)
7268 struct user_signal_info
*p
;
7269 const char *special_event_name
= NULL
;
7271 if (SYMBOLP (Vdebug_on_event
))
7272 special_event_name
= SSDATA (SYMBOL_NAME (Vdebug_on_event
));
7274 for (p
= user_signals
; p
; p
= p
->next
)
7277 if (special_event_name
7278 && strcmp (special_event_name
, p
->name
) == 0)
7280 /* Enter the debugger in many ways. */
7281 debug_on_next_call
= 1;
7284 Vinhibit_quit
= Qnil
;
7286 /* Eat the event. */
7292 if (interrupt_input
)
7293 handle_input_available_signal (sig
);
7297 /* Tell wait_reading_process_output that it needs to wake
7298 up and look around. */
7299 if (input_available_clear_time
)
7300 *input_available_clear_time
= make_timespec (0, 0);
7307 deliver_user_signal (int sig
)
7309 deliver_process_signal (sig
, handle_user_signal
);
7313 find_user_signal_name (int sig
)
7315 struct user_signal_info
*p
;
7317 for (p
= user_signals
; p
; p
= p
->next
)
7325 store_user_signal_events (void)
7327 struct user_signal_info
*p
;
7328 struct input_event buf
;
7329 bool buf_initialized
= 0;
7331 for (p
= user_signals
; p
; p
= p
->next
)
7332 if (p
->npending
> 0)
7334 if (! buf_initialized
)
7336 memset (&buf
, 0, sizeof buf
);
7337 buf
.kind
= USER_SIGNAL_EVENT
;
7338 buf
.frame_or_window
= selected_frame
;
7339 buf_initialized
= 1;
7345 kbd_buffer_store_event (&buf
);
7348 while (p
->npending
> 0);
7353 static void menu_bar_item (Lisp_Object
, Lisp_Object
, Lisp_Object
, void *);
7354 static Lisp_Object menu_bar_one_keymap_changed_items
;
7356 /* These variables hold the vector under construction within
7357 menu_bar_items and its subroutines, and the current index
7358 for storing into that vector. */
7359 static Lisp_Object menu_bar_items_vector
;
7360 static int menu_bar_items_index
;
7363 static const char *separator_names
[] = {
7368 "single-dashed-line",
7369 "double-dashed-line",
7371 "shadow-etched-out",
7372 "shadow-etched-in-dash",
7373 "shadow-etched-out-dash",
7374 "shadow-double-etched-in",
7375 "shadow-double-etched-out",
7376 "shadow-double-etched-in-dash",
7377 "shadow-double-etched-out-dash",
7381 /* Return true if LABEL specifies a separator. */
7384 menu_separator_name_p (const char *label
)
7388 else if (strlen (label
) > 3
7389 && memcmp (label
, "--", 2) == 0
7394 for (i
= 0; separator_names
[i
]; ++i
)
7395 if (strcmp (label
, separator_names
[i
]) == 0)
7400 /* It's a separator if it contains only dashes. */
7401 while (*label
== '-')
7403 return (*label
== 0);
7410 /* Return a vector of menu items for a menu bar, appropriate
7411 to the current buffer. Each item has three elements in the vector:
7414 OLD is an old vector we can optionally reuse, or nil. */
7417 menu_bar_items (Lisp_Object old
)
7419 /* The number of keymaps we're scanning right now, and the number of
7420 keymaps we have allocated space for. */
7423 /* maps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
7424 in the current keymaps, or nil where it is not a prefix. */
7427 Lisp_Object mapsbuf
[3];
7428 Lisp_Object def
, tail
;
7435 /* In order to build the menus, we need to call the keymap
7436 accessors. They all call QUIT. But this function is called
7437 during redisplay, during which a quit is fatal. So inhibit
7438 quitting while building the menus.
7439 We do this instead of specbind because (1) errors will clear it anyway
7440 and (2) this avoids risk of specpdl overflow. */
7441 oquit
= Vinhibit_quit
;
7445 menu_bar_items_vector
= old
;
7447 menu_bar_items_vector
= Fmake_vector (make_number (24), Qnil
);
7448 menu_bar_items_index
= 0;
7450 /* Build our list of keymaps.
7451 If we recognize a function key and replace its escape sequence in
7452 keybuf with its symbol, or if the sequence starts with a mouse
7453 click and we need to switch buffers, we jump back here to rebuild
7454 the initial keymaps from the current buffer. */
7458 /* Should overriding-terminal-local-map and overriding-local-map apply? */
7459 if (!NILP (Voverriding_local_map_menu_flag
)
7460 && !NILP (Voverriding_local_map
))
7462 /* Yes, use them (if non-nil) as well as the global map. */
7465 if (!NILP (KVAR (current_kboard
, Voverriding_terminal_local_map
)))
7466 maps
[nmaps
++] = KVAR (current_kboard
, Voverriding_terminal_local_map
);
7467 if (!NILP (Voverriding_local_map
))
7468 maps
[nmaps
++] = Voverriding_local_map
;
7472 /* No, so use major and minor mode keymaps and keymap property.
7473 Note that menu-bar bindings in the local-map and keymap
7474 properties may not work reliable, as they are only
7475 recognized when the menu-bar (or mode-line) is updated,
7476 which does not normally happen after every command. */
7477 ptrdiff_t nminor
= current_minor_maps (NULL
, &tmaps
);
7478 SAFE_NALLOCA (maps
, 1, nminor
+ 4);
7480 Lisp_Object tem
= KVAR (current_kboard
, Voverriding_terminal_local_map
);
7481 if (!NILP (tem
) && !NILP (Voverriding_local_map_menu_flag
))
7482 maps
[nmaps
++] = tem
;
7483 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
7484 maps
[nmaps
++] = tem
;
7487 memcpy (maps
+ nmaps
, tmaps
, nminor
* sizeof (maps
[0]));
7490 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
7492 maps
[nmaps
++] = current_global_map
;
7495 /* Look up in each map the dummy prefix key `menu-bar'. */
7497 for (mapno
= nmaps
- 1; mapno
>= 0; mapno
--)
7498 if (!NILP (maps
[mapno
]))
7500 def
= get_keymap (access_keymap (maps
[mapno
], Qmenu_bar
, 1, 0, 1),
7504 menu_bar_one_keymap_changed_items
= Qnil
;
7505 map_keymap_canonical (def
, menu_bar_item
, Qnil
, NULL
);
7509 /* Move to the end those items that should be at the end. */
7511 for (tail
= Vmenu_bar_final_items
; CONSP (tail
); tail
= XCDR (tail
))
7514 int end
= menu_bar_items_index
;
7516 for (i
= 0; i
< end
; i
+= 4)
7517 if (EQ (XCAR (tail
), AREF (menu_bar_items_vector
, i
)))
7519 Lisp_Object tem0
, tem1
, tem2
, tem3
;
7520 /* Move the item at index I to the end,
7521 shifting all the others forward. */
7522 tem0
= AREF (menu_bar_items_vector
, i
+ 0);
7523 tem1
= AREF (menu_bar_items_vector
, i
+ 1);
7524 tem2
= AREF (menu_bar_items_vector
, i
+ 2);
7525 tem3
= AREF (menu_bar_items_vector
, i
+ 3);
7527 memmove (aref_addr (menu_bar_items_vector
, i
),
7528 aref_addr (menu_bar_items_vector
, i
+ 4),
7529 (end
- i
- 4) * word_size
);
7530 ASET (menu_bar_items_vector
, end
- 4, tem0
);
7531 ASET (menu_bar_items_vector
, end
- 3, tem1
);
7532 ASET (menu_bar_items_vector
, end
- 2, tem2
);
7533 ASET (menu_bar_items_vector
, end
- 1, tem3
);
7538 /* Add nil, nil, nil, nil at the end. */
7540 int i
= menu_bar_items_index
;
7541 if (i
+ 4 > ASIZE (menu_bar_items_vector
))
7542 menu_bar_items_vector
7543 = larger_vector (menu_bar_items_vector
, 4, -1);
7544 /* Add this item. */
7545 ASET (menu_bar_items_vector
, i
, Qnil
); i
++;
7546 ASET (menu_bar_items_vector
, i
, Qnil
); i
++;
7547 ASET (menu_bar_items_vector
, i
, Qnil
); i
++;
7548 ASET (menu_bar_items_vector
, i
, Qnil
); i
++;
7549 menu_bar_items_index
= i
;
7552 Vinhibit_quit
= oquit
;
7554 return menu_bar_items_vector
;
7557 /* Add one item to menu_bar_items_vector, for KEY, ITEM_STRING and DEF.
7558 If there's already an item for KEY, add this DEF to it. */
7560 Lisp_Object item_properties
;
7563 menu_bar_item (Lisp_Object key
, Lisp_Object item
, Lisp_Object dummy1
, void *dummy2
)
7565 struct gcpro gcpro1
;
7570 if (EQ (item
, Qundefined
))
7572 /* If a map has an explicit `undefined' as definition,
7573 discard any previously made menu bar item. */
7575 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7576 if (EQ (key
, AREF (menu_bar_items_vector
, i
)))
7578 if (menu_bar_items_index
> i
+ 4)
7579 memmove (aref_addr (menu_bar_items_vector
, i
),
7580 aref_addr (menu_bar_items_vector
, i
+ 4),
7581 (menu_bar_items_index
- i
- 4) * word_size
);
7582 menu_bar_items_index
-= 4;
7586 /* If this keymap has already contributed to this KEY,
7587 don't contribute to it a second time. */
7588 tem
= Fmemq (key
, menu_bar_one_keymap_changed_items
);
7589 if (!NILP (tem
) || NILP (item
))
7592 menu_bar_one_keymap_changed_items
7593 = Fcons (key
, menu_bar_one_keymap_changed_items
);
7595 /* We add to menu_bar_one_keymap_changed_items before doing the
7596 parse_menu_item, so that if it turns out it wasn't a menu item,
7597 it still correctly hides any further menu item. */
7599 parsed
= parse_menu_item (item
, 1);
7604 item
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7606 /* Find any existing item for this KEY. */
7607 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7608 if (EQ (key
, AREF (menu_bar_items_vector
, i
)))
7611 /* If we did not find this KEY, add it at the end. */
7612 if (i
== menu_bar_items_index
)
7614 /* If vector is too small, get a bigger one. */
7615 if (i
+ 4 > ASIZE (menu_bar_items_vector
))
7616 menu_bar_items_vector
= larger_vector (menu_bar_items_vector
, 4, -1);
7617 /* Add this item. */
7618 ASET (menu_bar_items_vector
, i
, key
); i
++;
7619 ASET (menu_bar_items_vector
, i
,
7620 AREF (item_properties
, ITEM_PROPERTY_NAME
)); i
++;
7621 ASET (menu_bar_items_vector
, i
, list1 (item
)); i
++;
7622 ASET (menu_bar_items_vector
, i
, make_number (0)); i
++;
7623 menu_bar_items_index
= i
;
7625 /* We did find an item for this KEY. Add ITEM to its list of maps. */
7629 old
= AREF (menu_bar_items_vector
, i
+ 2);
7630 /* If the new and the old items are not both keymaps,
7631 the lookup will only find `item'. */
7632 item
= Fcons (item
, KEYMAPP (item
) && KEYMAPP (XCAR (old
)) ? old
: Qnil
);
7633 ASET (menu_bar_items_vector
, i
+ 2, item
);
7637 /* This is used as the handler when calling menu_item_eval_property. */
7639 menu_item_eval_property_1 (Lisp_Object arg
)
7641 /* If we got a quit from within the menu computation,
7642 quit all the way out of it. This takes care of C-] in the debugger. */
7643 if (CONSP (arg
) && EQ (XCAR (arg
), Qquit
))
7644 Fsignal (Qquit
, Qnil
);
7650 eval_dyn (Lisp_Object form
)
7652 return Feval (form
, Qnil
);
7655 /* Evaluate an expression and return the result (or nil if something
7656 went wrong). Used to evaluate dynamic parts of menu items. */
7658 menu_item_eval_property (Lisp_Object sexpr
)
7660 ptrdiff_t count
= SPECPDL_INDEX ();
7662 specbind (Qinhibit_redisplay
, Qt
);
7663 val
= internal_condition_case_1 (eval_dyn
, sexpr
, Qerror
,
7664 menu_item_eval_property_1
);
7665 return unbind_to (count
, val
);
7668 /* This function parses a menu item and leaves the result in the
7669 vector item_properties.
7670 ITEM is a key binding, a possible menu item.
7671 INMENUBAR is > 0 when this is considered for an entry in a menu bar
7673 INMENUBAR is < 0 when this is considered for an entry in a keyboard menu.
7674 parse_menu_item returns true if the item is a menu item and false
7678 parse_menu_item (Lisp_Object item
, int inmenubar
)
7680 Lisp_Object def
, tem
, item_string
, start
;
7682 Lisp_Object keyhint
;
7691 /* Create item_properties vector if necessary. */
7692 if (NILP (item_properties
))
7694 = Fmake_vector (make_number (ITEM_PROPERTY_ENABLE
+ 1), Qnil
);
7696 /* Initialize optional entries. */
7697 for (i
= ITEM_PROPERTY_DEF
; i
< ITEM_PROPERTY_ENABLE
; i
++)
7698 ASET (item_properties
, i
, Qnil
);
7699 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7701 /* Save the item here to protect it from GC. */
7702 ASET (item_properties
, ITEM_PROPERTY_ITEM
, item
);
7704 item_string
= XCAR (item
);
7708 if (STRINGP (item_string
))
7710 /* Old format menu item. */
7711 ASET (item_properties
, ITEM_PROPERTY_NAME
, item_string
);
7713 /* Maybe help string. */
7714 if (CONSP (item
) && STRINGP (XCAR (item
)))
7716 ASET (item_properties
, ITEM_PROPERTY_HELP
,
7717 Fsubstitute_command_keys (XCAR (item
)));
7722 /* Maybe an obsolete key binding cache. */
7723 if (CONSP (item
) && CONSP (XCAR (item
))
7724 && (NILP (XCAR (XCAR (item
)))
7725 || VECTORP (XCAR (XCAR (item
)))))
7728 /* This is the real definition--the function to run. */
7729 ASET (item_properties
, ITEM_PROPERTY_DEF
, item
);
7731 /* Get enable property, if any. */
7734 tem
= Fget (item
, Qmenu_enable
);
7735 if (!NILP (Venable_disabled_menus_and_buttons
))
7736 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7737 else if (!NILP (tem
))
7738 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, tem
);
7741 else if (EQ (item_string
, Qmenu_item
) && CONSP (item
))
7743 /* New format menu item. */
7744 ASET (item_properties
, ITEM_PROPERTY_NAME
, XCAR (item
));
7745 start
= XCDR (item
);
7748 /* We have a real binding. */
7749 ASET (item_properties
, ITEM_PROPERTY_DEF
, XCAR (start
));
7751 item
= XCDR (start
);
7752 /* Is there an obsolete cache list with key equivalences. */
7753 if (CONSP (item
) && CONSP (XCAR (item
)))
7756 /* Parse properties. */
7757 while (CONSP (item
) && CONSP (XCDR (item
)))
7762 if (EQ (tem
, QCenable
))
7764 if (!NILP (Venable_disabled_menus_and_buttons
))
7765 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7767 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, XCAR (item
));
7769 else if (EQ (tem
, QCvisible
))
7771 /* If got a visible property and that evaluates to nil
7772 then ignore this item. */
7773 tem
= menu_item_eval_property (XCAR (item
));
7777 else if (EQ (tem
, QChelp
))
7779 Lisp_Object help
= XCAR (item
);
7781 help
= Fsubstitute_command_keys (help
);
7782 ASET (item_properties
, ITEM_PROPERTY_HELP
, help
);
7784 else if (EQ (tem
, QCfilter
))
7786 else if (EQ (tem
, QCkey_sequence
))
7789 if (SYMBOLP (tem
) || STRINGP (tem
) || VECTORP (tem
))
7790 /* Be GC protected. Set keyhint to item instead of tem. */
7793 else if (EQ (tem
, QCkeys
))
7796 if (CONSP (tem
) || STRINGP (tem
))
7797 ASET (item_properties
, ITEM_PROPERTY_KEYEQ
, tem
);
7799 else if (EQ (tem
, QCbutton
) && CONSP (XCAR (item
)))
7804 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
7806 ASET (item_properties
, ITEM_PROPERTY_SELECTED
,
7808 ASET (item_properties
, ITEM_PROPERTY_TYPE
, type
);
7814 else if (inmenubar
|| !NILP (start
))
7818 return 0; /* not a menu item */
7820 /* If item string is not a string, evaluate it to get string.
7821 If we don't get a string, skip this item. */
7822 item_string
= AREF (item_properties
, ITEM_PROPERTY_NAME
);
7823 if (!(STRINGP (item_string
)))
7825 item_string
= menu_item_eval_property (item_string
);
7826 if (!STRINGP (item_string
))
7828 ASET (item_properties
, ITEM_PROPERTY_NAME
, item_string
);
7831 /* If got a filter apply it on definition. */
7832 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7835 def
= menu_item_eval_property (list2 (XCAR (filter
),
7836 list2 (Qquote
, def
)));
7838 ASET (item_properties
, ITEM_PROPERTY_DEF
, def
);
7841 /* Enable or disable selection of item. */
7842 tem
= AREF (item_properties
, ITEM_PROPERTY_ENABLE
);
7845 tem
= menu_item_eval_property (tem
);
7846 if (inmenubar
&& NILP (tem
))
7847 return 0; /* Ignore disabled items in menu bar. */
7848 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, tem
);
7851 /* If we got no definition, this item is just unselectable text which
7852 is OK in a submenu but not in the menubar. */
7854 return (!inmenubar
);
7856 /* See if this is a separate pane or a submenu. */
7857 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7858 tem
= get_keymap (def
, 0, 1);
7859 /* For a subkeymap, just record its details and exit. */
7862 ASET (item_properties
, ITEM_PROPERTY_MAP
, tem
);
7863 ASET (item_properties
, ITEM_PROPERTY_DEF
, tem
);
7867 /* At the top level in the menu bar, do likewise for commands also.
7868 The menu bar does not display equivalent key bindings anyway.
7869 ITEM_PROPERTY_DEF is already set up properly. */
7873 { /* This is a command. See if there is an equivalent key binding. */
7874 Lisp_Object keyeq
= AREF (item_properties
, ITEM_PROPERTY_KEYEQ
);
7875 AUTO_STRING (space_space
, " ");
7877 /* The previous code preferred :key-sequence to :keys, so we
7878 preserve this behavior. */
7879 if (STRINGP (keyeq
) && !CONSP (keyhint
))
7880 keyeq
= concat2 (space_space
, Fsubstitute_command_keys (keyeq
));
7883 Lisp_Object prefix
= keyeq
;
7884 Lisp_Object keys
= Qnil
;
7888 def
= XCAR (prefix
);
7889 prefix
= XCDR (prefix
);
7892 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7894 if (CONSP (keyhint
) && !NILP (XCAR (keyhint
)))
7896 keys
= XCAR (keyhint
);
7897 tem
= Fkey_binding (keys
, Qnil
, Qnil
, Qnil
);
7899 /* We have a suggested key. Is it bound to the command? */
7902 /* If the command is an alias for another
7903 (such as lmenu.el set it up), check if the
7904 original command matches the cached command. */
7906 && EQ (tem
, XSYMBOL (def
)->function
))))
7911 keys
= Fwhere_is_internal (def
, Qnil
, Qt
, Qnil
, Qnil
);
7915 tem
= Fkey_description (keys
, Qnil
);
7918 if (STRINGP (XCAR (prefix
)))
7919 tem
= concat2 (XCAR (prefix
), tem
);
7920 if (STRINGP (XCDR (prefix
)))
7921 tem
= concat2 (tem
, XCDR (prefix
));
7923 keyeq
= concat2 (space_space
, tem
);
7929 /* If we have an equivalent key binding, use that. */
7930 ASET (item_properties
, ITEM_PROPERTY_KEYEQ
, keyeq
);
7933 /* Include this when menu help is implemented.
7934 tem = XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP];
7935 if (!(NILP (tem) || STRINGP (tem)))
7937 tem = menu_item_eval_property (tem);
7940 XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP] = tem;
7944 /* Handle radio buttons or toggle boxes. */
7945 tem
= AREF (item_properties
, ITEM_PROPERTY_SELECTED
);
7947 ASET (item_properties
, ITEM_PROPERTY_SELECTED
,
7948 menu_item_eval_property (tem
));
7955 /***********************************************************************
7957 ***********************************************************************/
7959 /* A vector holding tool bar items while they are parsed in function
7960 tool_bar_items. Each item occupies TOOL_BAR_ITEM_NSCLOTS elements
7963 static Lisp_Object tool_bar_items_vector
;
7965 /* A vector holding the result of parse_tool_bar_item. Layout is like
7966 the one for a single item in tool_bar_items_vector. */
7968 static Lisp_Object tool_bar_item_properties
;
7970 /* Next free index in tool_bar_items_vector. */
7972 static int ntool_bar_items
;
7974 /* Function prototypes. */
7976 static void init_tool_bar_items (Lisp_Object
);
7977 static void process_tool_bar_item (Lisp_Object
, Lisp_Object
, Lisp_Object
,
7979 static bool parse_tool_bar_item (Lisp_Object
, Lisp_Object
);
7980 static void append_tool_bar_item (void);
7983 /* Return a vector of tool bar items for keymaps currently in effect.
7984 Reuse vector REUSE if non-nil. Return in *NITEMS the number of
7985 tool bar items found. */
7988 tool_bar_items (Lisp_Object reuse
, int *nitems
)
7991 Lisp_Object mapsbuf
[3];
7999 /* In order to build the menus, we need to call the keymap
8000 accessors. They all call QUIT. But this function is called
8001 during redisplay, during which a quit is fatal. So inhibit
8002 quitting while building the menus. We do this instead of
8003 specbind because (1) errors will clear it anyway and (2) this
8004 avoids risk of specpdl overflow. */
8005 oquit
= Vinhibit_quit
;
8008 /* Initialize tool_bar_items_vector and protect it from GC. */
8009 init_tool_bar_items (reuse
);
8011 /* Build list of keymaps in maps. Set nmaps to the number of maps
8014 /* Should overriding-terminal-local-map and overriding-local-map apply? */
8015 if (!NILP (Voverriding_local_map_menu_flag
)
8016 && !NILP (Voverriding_local_map
))
8018 /* Yes, use them (if non-nil) as well as the global map. */
8021 if (!NILP (KVAR (current_kboard
, Voverriding_terminal_local_map
)))
8022 maps
[nmaps
++] = KVAR (current_kboard
, Voverriding_terminal_local_map
);
8023 if (!NILP (Voverriding_local_map
))
8024 maps
[nmaps
++] = Voverriding_local_map
;
8028 /* No, so use major and minor mode keymaps and keymap property.
8029 Note that tool-bar bindings in the local-map and keymap
8030 properties may not work reliable, as they are only
8031 recognized when the tool-bar (or mode-line) is updated,
8032 which does not normally happen after every command. */
8033 ptrdiff_t nminor
= current_minor_maps (NULL
, &tmaps
);
8034 SAFE_NALLOCA (maps
, 1, nminor
+ 4);
8036 Lisp_Object tem
= KVAR (current_kboard
, Voverriding_terminal_local_map
);
8037 if (!NILP (tem
) && !NILP (Voverriding_local_map_menu_flag
))
8038 maps
[nmaps
++] = tem
;
8039 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
8040 maps
[nmaps
++] = tem
;
8043 memcpy (maps
+ nmaps
, tmaps
, nminor
* sizeof (maps
[0]));
8046 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
8049 /* Add global keymap at the end. */
8050 maps
[nmaps
++] = current_global_map
;
8052 /* Process maps in reverse order and look up in each map the prefix
8054 for (i
= nmaps
- 1; i
>= 0; --i
)
8055 if (!NILP (maps
[i
]))
8059 keymap
= get_keymap (access_keymap (maps
[i
], Qtool_bar
, 1, 0, 1), 0, 1);
8061 map_keymap (keymap
, process_tool_bar_item
, Qnil
, NULL
, 1);
8064 Vinhibit_quit
= oquit
;
8065 *nitems
= ntool_bar_items
/ TOOL_BAR_ITEM_NSLOTS
;
8067 return tool_bar_items_vector
;
8071 /* Process the definition of KEY which is DEF. */
8074 process_tool_bar_item (Lisp_Object key
, Lisp_Object def
, Lisp_Object data
, void *args
)
8077 struct gcpro gcpro1
, gcpro2
;
8079 /* Protect KEY and DEF from GC because parse_tool_bar_item may call
8083 if (EQ (def
, Qundefined
))
8085 /* If a map has an explicit `undefined' as definition,
8086 discard any previously made item. */
8087 for (i
= 0; i
< ntool_bar_items
; i
+= TOOL_BAR_ITEM_NSLOTS
)
8089 Lisp_Object
*v
= XVECTOR (tool_bar_items_vector
)->contents
+ i
;
8091 if (EQ (key
, v
[TOOL_BAR_ITEM_KEY
]))
8093 if (ntool_bar_items
> i
+ TOOL_BAR_ITEM_NSLOTS
)
8094 memmove (v
, v
+ TOOL_BAR_ITEM_NSLOTS
,
8095 ((ntool_bar_items
- i
- TOOL_BAR_ITEM_NSLOTS
)
8097 ntool_bar_items
-= TOOL_BAR_ITEM_NSLOTS
;
8102 else if (parse_tool_bar_item (key
, def
))
8103 /* Append a new tool bar item to tool_bar_items_vector. Accept
8104 more than one definition for the same key. */
8105 append_tool_bar_item ();
8110 /* Access slot with index IDX of vector tool_bar_item_properties. */
8111 #define PROP(IDX) AREF (tool_bar_item_properties, (IDX))
8113 set_prop (ptrdiff_t idx
, Lisp_Object val
)
8115 ASET (tool_bar_item_properties
, idx
, val
);
8119 /* Parse a tool bar item specification ITEM for key KEY and return the
8120 result in tool_bar_item_properties. Value is false if ITEM is
8123 ITEM is a list `(menu-item CAPTION BINDING PROPS...)'.
8125 CAPTION is the caption of the item, If it's not a string, it is
8126 evaluated to get a string.
8128 BINDING is the tool bar item's binding. Tool-bar items with keymaps
8129 as binding are currently ignored.
8131 The following properties are recognized:
8135 FORM is evaluated and specifies whether the tool bar item is
8136 enabled or disabled.
8140 FORM is evaluated and specifies whether the tool bar item is visible.
8142 - `:filter FUNCTION'
8144 FUNCTION is invoked with one parameter `(quote BINDING)'. Its
8145 result is stored as the new binding.
8147 - `:button (TYPE SELECTED)'
8149 TYPE must be one of `:radio' or `:toggle'. SELECTED is evaluated
8150 and specifies whether the button is selected (pressed) or not.
8154 IMAGES is either a single image specification or a vector of four
8155 image specifications. See enum tool_bar_item_images.
8157 - `:help HELP-STRING'.
8159 Gives a help string to display for the tool bar item.
8161 - `:label LABEL-STRING'.
8163 A text label to show with the tool bar button if labels are enabled. */
8166 parse_tool_bar_item (Lisp_Object key
, Lisp_Object item
)
8168 Lisp_Object filter
= Qnil
;
8169 Lisp_Object caption
;
8171 bool have_label
= 0;
8173 /* Definition looks like `(menu-item CAPTION BINDING PROPS...)'.
8174 Rule out items that aren't lists, don't start with
8175 `menu-item' or whose rest following `tool-bar-item' is not a
8180 /* As an exception, allow old-style menu separators. */
8181 if (STRINGP (XCAR (item
)))
8182 item
= list1 (XCAR (item
));
8183 else if (!EQ (XCAR (item
), Qmenu_item
)
8184 || (item
= XCDR (item
), !CONSP (item
)))
8187 /* Create tool_bar_item_properties vector if necessary. Reset it to
8189 if (VECTORP (tool_bar_item_properties
))
8191 for (i
= 0; i
< TOOL_BAR_ITEM_NSLOTS
; ++i
)
8195 tool_bar_item_properties
8196 = Fmake_vector (make_number (TOOL_BAR_ITEM_NSLOTS
), Qnil
);
8199 set_prop (TOOL_BAR_ITEM_KEY
, key
);
8200 set_prop (TOOL_BAR_ITEM_ENABLED_P
, Qt
);
8202 /* Get the caption of the item. If the caption is not a string,
8203 evaluate it to get a string. If we don't get a string, skip this
8205 caption
= XCAR (item
);
8206 if (!STRINGP (caption
))
8208 caption
= menu_item_eval_property (caption
);
8209 if (!STRINGP (caption
))
8212 set_prop (TOOL_BAR_ITEM_CAPTION
, caption
);
8214 /* If the rest following the caption is not a list, the menu item is
8215 either a separator, or invalid. */
8219 if (menu_separator_name_p (SSDATA (caption
)))
8221 set_prop (TOOL_BAR_ITEM_TYPE
, Qt
);
8222 #if !defined (USE_GTK) && !defined (HAVE_NS)
8223 /* If we use build_desired_tool_bar_string to render the
8224 tool bar, the separator is rendered as an image. */
8225 set_prop (TOOL_BAR_ITEM_IMAGES
,
8226 (menu_item_eval_property
8227 (Vtool_bar_separator_image_expression
)));
8228 set_prop (TOOL_BAR_ITEM_ENABLED_P
, Qnil
);
8229 set_prop (TOOL_BAR_ITEM_SELECTED_P
, Qnil
);
8230 set_prop (TOOL_BAR_ITEM_CAPTION
, Qnil
);
8237 /* Store the binding. */
8238 set_prop (TOOL_BAR_ITEM_BINDING
, XCAR (item
));
8241 /* Ignore cached key binding, if any. */
8242 if (CONSP (item
) && CONSP (XCAR (item
)))
8245 /* Process the rest of the properties. */
8246 for (; CONSP (item
) && CONSP (XCDR (item
)); item
= XCDR (XCDR (item
)))
8248 Lisp_Object ikey
, value
;
8251 value
= XCAR (XCDR (item
));
8253 if (EQ (ikey
, QCenable
))
8255 /* `:enable FORM'. */
8256 if (!NILP (Venable_disabled_menus_and_buttons
))
8257 set_prop (TOOL_BAR_ITEM_ENABLED_P
, Qt
);
8259 set_prop (TOOL_BAR_ITEM_ENABLED_P
, value
);
8261 else if (EQ (ikey
, QCvisible
))
8263 /* `:visible FORM'. If got a visible property and that
8264 evaluates to nil then ignore this item. */
8265 if (NILP (menu_item_eval_property (value
)))
8268 else if (EQ (ikey
, QChelp
))
8269 /* `:help HELP-STRING'. */
8270 set_prop (TOOL_BAR_ITEM_HELP
, value
);
8271 else if (EQ (ikey
, QCvert_only
))
8272 /* `:vert-only t/nil'. */
8273 set_prop (TOOL_BAR_ITEM_VERT_ONLY
, value
);
8274 else if (EQ (ikey
, QClabel
))
8276 const char *bad_label
= "!!?GARBLED ITEM?!!";
8277 /* `:label LABEL-STRING'. */
8278 set_prop (TOOL_BAR_ITEM_LABEL
,
8279 STRINGP (value
) ? value
: build_string (bad_label
));
8282 else if (EQ (ikey
, QCfilter
))
8283 /* ':filter FORM'. */
8285 else if (EQ (ikey
, QCbutton
) && CONSP (value
))
8287 /* `:button (TYPE . SELECTED)'. */
8288 Lisp_Object type
, selected
;
8290 type
= XCAR (value
);
8291 selected
= XCDR (value
);
8292 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
8294 set_prop (TOOL_BAR_ITEM_SELECTED_P
, selected
);
8295 set_prop (TOOL_BAR_ITEM_TYPE
, type
);
8298 else if (EQ (ikey
, QCimage
)
8300 || (VECTORP (value
) && ASIZE (value
) == 4)))
8301 /* Value is either a single image specification or a vector
8302 of 4 such specifications for the different button states. */
8303 set_prop (TOOL_BAR_ITEM_IMAGES
, value
);
8304 else if (EQ (ikey
, QCrtl
))
8306 set_prop (TOOL_BAR_ITEM_RTL_IMAGE
, value
);
8312 /* Try to make one from caption and key. */
8313 Lisp_Object tkey
= PROP (TOOL_BAR_ITEM_KEY
);
8314 Lisp_Object tcapt
= PROP (TOOL_BAR_ITEM_CAPTION
);
8315 const char *label
= SYMBOLP (tkey
) ? SSDATA (SYMBOL_NAME (tkey
)) : "";
8316 const char *capt
= STRINGP (tcapt
) ? SSDATA (tcapt
) : "";
8318 2 * max (0, min (tool_bar_max_label_size
, STRING_BYTES_BOUND
/ 2));
8319 char *buf
= xmalloc (max_lbl
+ 1);
8320 Lisp_Object new_lbl
;
8321 ptrdiff_t caption_len
= strlen (capt
);
8323 if (caption_len
<= max_lbl
&& capt
[0] != '\0')
8326 while (caption_len
> 0 && buf
[caption_len
- 1] == '.')
8328 buf
[caption_len
] = '\0';
8332 if (strlen (label
) <= max_lbl
&& label
[0] != '\0')
8336 strcpy (buf
, label
);
8338 for (j
= 0; buf
[j
] != '\0'; ++j
)
8346 new_lbl
= Fupcase_initials (build_string (label
));
8347 if (SCHARS (new_lbl
) <= tool_bar_max_label_size
)
8348 set_prop (TOOL_BAR_ITEM_LABEL
, new_lbl
);
8350 set_prop (TOOL_BAR_ITEM_LABEL
, empty_unibyte_string
);
8354 /* If got a filter apply it on binding. */
8356 set_prop (TOOL_BAR_ITEM_BINDING
,
8357 (menu_item_eval_property
8360 PROP (TOOL_BAR_ITEM_BINDING
))))));
8362 /* See if the binding is a keymap. Give up if it is. */
8363 if (CONSP (get_keymap (PROP (TOOL_BAR_ITEM_BINDING
), 0, 1)))
8366 /* Enable or disable selection of item. */
8367 if (!EQ (PROP (TOOL_BAR_ITEM_ENABLED_P
), Qt
))
8368 set_prop (TOOL_BAR_ITEM_ENABLED_P
,
8369 menu_item_eval_property (PROP (TOOL_BAR_ITEM_ENABLED_P
)));
8371 /* Handle radio buttons or toggle boxes. */
8372 if (!NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
)))
8373 set_prop (TOOL_BAR_ITEM_SELECTED_P
,
8374 menu_item_eval_property (PROP (TOOL_BAR_ITEM_SELECTED_P
)));
8382 /* Initialize tool_bar_items_vector. REUSE, if non-nil, is a vector
8383 that can be reused. */
8386 init_tool_bar_items (Lisp_Object reuse
)
8388 if (VECTORP (reuse
))
8389 tool_bar_items_vector
= reuse
;
8391 tool_bar_items_vector
= Fmake_vector (make_number (64), Qnil
);
8392 ntool_bar_items
= 0;
8396 /* Append parsed tool bar item properties from
8397 tool_bar_item_properties */
8400 append_tool_bar_item (void)
8404 - (ASIZE (tool_bar_items_vector
) - TOOL_BAR_ITEM_NSLOTS
));
8406 /* Enlarge tool_bar_items_vector if necessary. */
8408 tool_bar_items_vector
= larger_vector (tool_bar_items_vector
, incr
, -1);
8410 /* Append entries from tool_bar_item_properties to the end of
8411 tool_bar_items_vector. */
8412 vcopy (tool_bar_items_vector
, ntool_bar_items
,
8413 XVECTOR (tool_bar_item_properties
)->contents
, TOOL_BAR_ITEM_NSLOTS
);
8414 ntool_bar_items
+= TOOL_BAR_ITEM_NSLOTS
;
8421 /* Read a character using menus based on the keymap MAP.
8422 Return nil if there are no menus in the maps.
8423 Return t if we displayed a menu but the user rejected it.
8425 PREV_EVENT is the previous input event, or nil if we are reading
8426 the first event of a key sequence.
8428 If USED_MOUSE_MENU is non-null, set *USED_MOUSE_MENU to true
8429 if we used a mouse menu to read the input, or false otherwise. If
8430 USED_MOUSE_MENU is null, don't dereference it.
8432 The prompting is done based on the prompt-string of the map
8433 and the strings associated with various map elements.
8435 This can be done with X menus or with menus put in the minibuf.
8436 These are done in different ways, depending on how the input will be read.
8437 Menus using X are done after auto-saving in read-char, getting the input
8438 event from Fx_popup_menu; menus using the minibuf use read_char recursively
8439 and do auto-saving in the inner call of read_char. */
8442 read_char_x_menu_prompt (Lisp_Object map
,
8443 Lisp_Object prev_event
, bool *used_mouse_menu
)
8445 if (used_mouse_menu
)
8446 *used_mouse_menu
= 0;
8448 /* Use local over global Menu maps. */
8450 if (! menu_prompting
)
8453 /* If we got to this point via a mouse click,
8454 use a real menu for mouse selection. */
8455 if (EVENT_HAS_PARAMETERS (prev_event
)
8456 && !EQ (XCAR (prev_event
), Qmenu_bar
)
8457 && !EQ (XCAR (prev_event
), Qtool_bar
))
8459 /* Display the menu and get the selection. */
8462 value
= Fx_popup_menu (prev_event
, get_keymap (map
, 0, 1));
8467 record_menu_key (XCAR (value
));
8469 /* If we got multiple events, unread all but
8471 There is no way to prevent those unread events
8472 from showing up later in last_nonmenu_event.
8473 So turn symbol and integer events into lists,
8474 to indicate that they came from a mouse menu,
8475 so that when present in last_nonmenu_event
8476 they won't confuse things. */
8477 for (tem
= XCDR (value
); CONSP (tem
); tem
= XCDR (tem
))
8479 record_menu_key (XCAR (tem
));
8480 if (SYMBOLP (XCAR (tem
))
8481 || INTEGERP (XCAR (tem
)))
8482 XSETCAR (tem
, Fcons (XCAR (tem
), Qdisabled
));
8485 /* If we got more than one event, put all but the first
8486 onto this list to be read later.
8487 Return just the first event now. */
8488 Vunread_command_events
8489 = nconc2 (XCDR (value
), Vunread_command_events
);
8490 value
= XCAR (value
);
8492 else if (NILP (value
))
8494 if (used_mouse_menu
)
8495 *used_mouse_menu
= 1;
8502 read_char_minibuf_menu_prompt (int commandflag
,
8507 /* FIXME: Use the minibuffer's frame width. */
8508 ptrdiff_t width
= FRAME_COLS (SELECTED_FRAME ()) - 4;
8510 bool nobindings
= 1;
8511 Lisp_Object rest
, vector
;
8512 Lisp_Object prompt_strings
= Qnil
;
8516 if (! menu_prompting
)
8519 map
= get_keymap (map
, 0, 1);
8520 name
= Fkeymap_prompt (map
);
8522 /* If we don't have any menus, just read a character normally. */
8523 if (!STRINGP (name
))
8526 #define PUSH_C_STR(str, listvar) \
8527 listvar = Fcons (build_unibyte_string (str), listvar)
8529 /* Prompt string always starts with map's prompt, and a space. */
8530 prompt_strings
= Fcons (name
, prompt_strings
);
8531 PUSH_C_STR (": ", prompt_strings
);
8532 nlength
= SCHARS (name
) + 2;
8536 /* Present the documented bindings, a line at a time. */
8540 Lisp_Object menu_strings
= prompt_strings
;
8541 ptrdiff_t i
= nlength
;
8543 Lisp_Object orig_defn_macro
;
8545 /* Loop over elements of map. */
8550 /* FIXME: Use map_keymap to handle new keymap formats. */
8552 /* At end of map, wrap around if just starting,
8553 or end this line if already have something on it. */
8556 if (notfirst
|| nobindings
)
8562 /* Look at the next element of the map. */
8564 elt
= AREF (vector
, idx
);
8566 elt
= Fcar_safe (rest
);
8568 if (idx
< 0 && VECTORP (elt
))
8570 /* If we found a dense table in the keymap,
8571 advanced past it, but start scanning its contents. */
8572 rest
= Fcdr_safe (rest
);
8578 /* An ordinary element. */
8579 Lisp_Object event
, tem
;
8583 event
= Fcar_safe (elt
); /* alist */
8584 elt
= Fcdr_safe (elt
);
8588 XSETINT (event
, idx
); /* vector */
8591 /* Ignore the element if it has no prompt string. */
8592 if (INTEGERP (event
) && parse_menu_item (elt
, -1))
8594 /* True if the char to type matches the string. */
8596 Lisp_Object upcased_event
, downcased_event
;
8597 Lisp_Object desc
= Qnil
;
8599 = AREF (item_properties
, ITEM_PROPERTY_NAME
);
8601 upcased_event
= Fupcase (event
);
8602 downcased_event
= Fdowncase (event
);
8603 char_matches
= (XINT (upcased_event
) == SREF (s
, 0)
8604 || XINT (downcased_event
) == SREF (s
, 0));
8606 desc
= Fsingle_key_description (event
, Qnil
);
8608 #if 0 /* It is redundant to list the equivalent key bindings because
8609 the prefix is what the user has already typed. */
8611 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_KEYEQ
];
8613 /* Insert equivalent keybinding. */
8614 s
= concat2 (s
, tem
);
8617 = AREF (item_properties
, ITEM_PROPERTY_TYPE
);
8618 if (EQ (tem
, QCradio
) || EQ (tem
, QCtoggle
))
8620 /* Insert button prefix. */
8621 Lisp_Object selected
8622 = AREF (item_properties
, ITEM_PROPERTY_SELECTED
);
8623 AUTO_STRING (radio_yes
, "(*) ");
8624 AUTO_STRING (radio_no
, "( ) ");
8625 AUTO_STRING (check_yes
, "[X] ");
8626 AUTO_STRING (check_no
, "[ ] ");
8627 if (EQ (tem
, QCradio
))
8628 tem
= NILP (selected
) ? radio_yes
: radio_no
;
8630 tem
= NILP (selected
) ? check_yes
: check_no
;
8631 s
= concat2 (tem
, s
);
8635 /* If we have room for the prompt string, add it to this line.
8636 If this is the first on the line, always add it. */
8637 if ((SCHARS (s
) + i
+ 2
8638 + (char_matches
? 0 : SCHARS (desc
) + 3))
8642 ptrdiff_t thiswidth
;
8644 /* Punctuate between strings. */
8647 PUSH_C_STR (", ", menu_strings
);
8653 /* If the char to type doesn't match the string's
8654 first char, explicitly show what char to type. */
8657 /* Add as much of string as fits. */
8658 thiswidth
= min (SCHARS (desc
), width
- i
);
8660 = Fcons (Fsubstring (desc
, make_number (0),
8661 make_number (thiswidth
)),
8664 PUSH_C_STR (" = ", menu_strings
);
8668 /* Add as much of string as fits. */
8669 thiswidth
= min (SCHARS (s
), width
- i
);
8671 = Fcons (Fsubstring (s
, make_number (0),
8672 make_number (thiswidth
)),
8678 /* If this element does not fit, end the line now,
8679 and save the element for the next line. */
8680 PUSH_C_STR ("...", menu_strings
);
8685 /* Move past this element. */
8686 if (idx
>= 0 && idx
+ 1 >= ASIZE (vector
))
8687 /* Handle reaching end of dense table. */
8692 rest
= Fcdr_safe (rest
);
8696 /* Prompt with that and read response. */
8697 message3_nolog (apply1 (intern ("concat"), Fnreverse (menu_strings
)));
8699 /* Make believe it's not a keyboard macro in case the help char
8700 is pressed. Help characters are not recorded because menu prompting
8701 is not used on replay. */
8702 orig_defn_macro
= KVAR (current_kboard
, defining_kbd_macro
);
8703 kset_defining_kbd_macro (current_kboard
, Qnil
);
8705 obj
= read_char (commandflag
, Qnil
, Qt
, 0, NULL
);
8706 while (BUFFERP (obj
));
8707 kset_defining_kbd_macro (current_kboard
, orig_defn_macro
);
8709 if (!INTEGERP (obj
) || XINT (obj
) == -2
8710 || (! EQ (obj
, menu_prompt_more_char
)
8711 && (!INTEGERP (menu_prompt_more_char
)
8712 || ! EQ (obj
, make_number (Ctl (XINT (menu_prompt_more_char
)))))))
8714 if (!NILP (KVAR (current_kboard
, defining_kbd_macro
)))
8715 store_kbd_macro_char (obj
);
8718 /* Help char - go round again. */
8722 /* Reading key sequences. */
8725 follow_key (Lisp_Object keymap
, Lisp_Object key
)
8727 return access_keymap (get_keymap (keymap
, 0, 1),
8732 active_maps (Lisp_Object first_event
)
8734 Lisp_Object position
8735 = CONSP (first_event
) ? CAR_SAFE (XCDR (first_event
)) : Qnil
;
8736 return Fcons (Qkeymap
, Fcurrent_active_maps (Qt
, position
));
8739 /* Structure used to keep track of partial application of key remapping
8740 such as Vfunction_key_map and Vkey_translation_map. */
8741 typedef struct keyremap
8743 /* This is the map originally specified for this use. */
8745 /* This is a submap reached by looking up, in PARENT,
8746 the events from START to END. */
8748 /* Positions [START, END) in the key sequence buffer
8749 are the key that we have scanned so far.
8750 Those events are the ones that we will replace
8751 if PARENT maps them into a key sequence. */
8755 /* Lookup KEY in MAP.
8756 MAP is a keymap mapping keys to key vectors or functions.
8757 If the mapping is a function and DO_FUNCALL is true,
8758 the function is called with PROMPT as parameter and its return
8759 value is used as the return value of this function (after checking
8760 that it is indeed a vector). */
8763 access_keymap_keyremap (Lisp_Object map
, Lisp_Object key
, Lisp_Object prompt
,
8768 next
= access_keymap (map
, key
, 1, 0, 1);
8770 /* Handle a symbol whose function definition is a keymap
8772 if (SYMBOLP (next
) && !NILP (Ffboundp (next
))
8773 && (ARRAYP (XSYMBOL (next
)->function
)
8774 || KEYMAPP (XSYMBOL (next
)->function
)))
8775 next
= Fautoload_do_load (XSYMBOL (next
)->function
, next
, Qnil
);
8777 /* If the keymap gives a function, not an
8778 array, then call the function with one arg and use
8779 its value instead. */
8780 if (do_funcall
&& FUNCTIONP (next
))
8785 next
= call1 (next
, prompt
);
8786 /* If the function returned something invalid,
8787 barf--don't ignore it.
8788 (To ignore it safely, we would need to gcpro a bunch of
8789 other variables.) */
8790 if (! (NILP (next
) || VECTORP (next
) || STRINGP (next
)))
8791 error ("Function %s returns invalid key sequence",
8792 SSDATA (SYMBOL_NAME (tem
)));
8797 /* Do one step of the key remapping used for function-key-map and
8798 key-translation-map:
8799 KEYBUF is the buffer holding the input events.
8800 BUFSIZE is its maximum size.
8801 FKEY is a pointer to the keyremap structure to use.
8802 INPUT is the index of the last element in KEYBUF.
8803 DOIT if true says that the remapping can actually take place.
8804 DIFF is used to return the number of keys added/removed by the remapping.
8805 PARENT is the root of the keymap.
8806 PROMPT is the prompt to use if the remapping happens through a function.
8807 Return true if the remapping actually took place. */
8810 keyremap_step (Lisp_Object
*keybuf
, int bufsize
, volatile keyremap
*fkey
,
8811 int input
, bool doit
, int *diff
, Lisp_Object prompt
)
8813 Lisp_Object next
, key
;
8815 key
= keybuf
[fkey
->end
++];
8817 if (KEYMAPP (fkey
->parent
))
8818 next
= access_keymap_keyremap (fkey
->map
, key
, prompt
, doit
);
8822 /* If keybuf[fkey->start..fkey->end] is bound in the
8823 map and we're in a position to do the key remapping, replace it with
8824 the binding and restart with fkey->start at the end. */
8825 if ((VECTORP (next
) || STRINGP (next
)) && doit
)
8827 int len
= XFASTINT (Flength (next
));
8830 *diff
= len
- (fkey
->end
- fkey
->start
);
8832 if (bufsize
- input
<= *diff
)
8833 error ("Key sequence too long");
8835 /* Shift the keys that follow fkey->end. */
8837 for (i
= fkey
->end
; i
< input
; i
++)
8838 keybuf
[i
+ *diff
] = keybuf
[i
];
8840 for (i
= input
- 1; i
>= fkey
->end
; i
--)
8841 keybuf
[i
+ *diff
] = keybuf
[i
];
8842 /* Overwrite the old keys with the new ones. */
8843 for (i
= 0; i
< len
; i
++)
8844 keybuf
[fkey
->start
+ i
]
8845 = Faref (next
, make_number (i
));
8847 fkey
->start
= fkey
->end
+= *diff
;
8848 fkey
->map
= fkey
->parent
;
8853 fkey
->map
= get_keymap (next
, 0, 1);
8855 /* If we no longer have a bound suffix, try a new position for
8857 if (!CONSP (fkey
->map
))
8859 fkey
->end
= ++fkey
->start
;
8860 fkey
->map
= fkey
->parent
;
8866 test_undefined (Lisp_Object binding
)
8868 return (NILP (binding
)
8869 || EQ (binding
, Qundefined
)
8870 || (SYMBOLP (binding
)
8871 && EQ (Fcommand_remapping (binding
, Qnil
, Qnil
), Qundefined
)));
8874 /* Read a sequence of keys that ends with a non prefix character,
8875 storing it in KEYBUF, a buffer of size BUFSIZE.
8877 Return the length of the key sequence stored.
8878 Return -1 if the user rejected a command menu.
8880 Echo starting immediately unless `prompt' is 0.
8882 If PREVENT_REDISPLAY is non-zero, avoid redisplay by calling
8883 read_char with a suitable COMMANDFLAG argument.
8885 Where a key sequence ends depends on the currently active keymaps.
8886 These include any minor mode keymaps active in the current buffer,
8887 the current buffer's local map, and the global map.
8889 If a key sequence has no other bindings, we check Vfunction_key_map
8890 to see if some trailing subsequence might be the beginning of a
8891 function key's sequence. If so, we try to read the whole function
8892 key, and substitute its symbolic name into the key sequence.
8894 We ignore unbound `down-' mouse clicks. We turn unbound `drag-' and
8895 `double-' events into similar click events, if that would make them
8896 bound. We try to turn `triple-' events first into `double-' events,
8899 If we get a mouse click in a mode line, vertical divider, or other
8900 non-text area, we treat the click as if it were prefixed by the
8901 symbol denoting that area - `mode-line', `vertical-line', or
8904 If the sequence starts with a mouse click, we read the key sequence
8905 with respect to the buffer clicked on, not the current buffer.
8907 If the user switches frames in the midst of a key sequence, we put
8908 off the switch-frame event until later; the next call to
8909 read_char will return it.
8911 If FIX_CURRENT_BUFFER, we restore current_buffer
8912 from the selected window's buffer. */
8915 read_key_sequence (Lisp_Object
*keybuf
, int bufsize
, Lisp_Object prompt
,
8916 bool dont_downcase_last
, bool can_return_switch_frame
,
8917 bool fix_current_buffer
, bool prevent_redisplay
)
8919 ptrdiff_t count
= SPECPDL_INDEX ();
8921 /* How many keys there are in the current key sequence. */
8924 /* The length of the echo buffer when we started reading, and
8925 the length of this_command_keys when we started reading. */
8926 ptrdiff_t echo_start
IF_LINT (= 0);
8927 ptrdiff_t keys_start
;
8929 Lisp_Object current_binding
= Qnil
;
8930 Lisp_Object first_event
= Qnil
;
8932 /* Index of the first key that has no binding.
8933 It is useless to try fkey.start larger than that. */
8936 /* If t < mock_input, then KEYBUF[t] should be read as the next
8939 We use this to recover after recognizing a function key. Once we
8940 realize that a suffix of the current key sequence is actually a
8941 function key's escape sequence, we replace the suffix with the
8942 function key's binding from Vfunction_key_map. Now keybuf
8943 contains a new and different key sequence, so the echo area,
8944 this_command_keys, and the submaps and defs arrays are wrong. In
8945 this situation, we set mock_input to t, set t to 0, and jump to
8946 restart_sequence; the loop will read keys from keybuf up until
8947 mock_input, thus rebuilding the state; and then it will resume
8948 reading characters from the keyboard. */
8951 /* If the sequence is unbound in submaps[], then
8952 keybuf[fkey.start..fkey.end-1] is a prefix in Vfunction_key_map,
8953 and fkey.map is its binding.
8955 These might be > t, indicating that all function key scanning
8956 should hold off until t reaches them. We do this when we've just
8957 recognized a function key, to avoid searching for the function
8958 key's again in Vfunction_key_map. */
8961 /* Likewise, for key_translation_map and input-decode-map. */
8962 keyremap keytran
, indec
;
8964 /* True if we are trying to map a key by changing an upper-case
8965 letter to lower case, or a shifted function key to an unshifted
8967 bool shift_translated
= 0;
8969 /* If we receive a `switch-frame' or `select-window' event in the middle of
8970 a key sequence, we put it off for later.
8971 While we're reading, we keep the event here. */
8972 Lisp_Object delayed_switch_frame
;
8974 Lisp_Object original_uppercase
IF_LINT (= Qnil
);
8975 int original_uppercase_position
= -1;
8977 /* Gets around Microsoft compiler limitations. */
8980 struct buffer
*starting_buffer
;
8982 /* List of events for which a fake prefix key has been generated. */
8983 Lisp_Object fake_prefixed_keys
= Qnil
;
8985 struct gcpro gcpro1
;
8987 GCPRO1 (fake_prefixed_keys
);
8988 raw_keybuf_count
= 0;
8990 last_nonmenu_event
= Qnil
;
8992 delayed_switch_frame
= Qnil
;
8998 /* Install the string PROMPT as the beginning of the string
8999 of echoing, so that it serves as a prompt for the next
9001 kset_echo_string (current_kboard
, prompt
);
9002 current_kboard
->echo_after_prompt
= SCHARS (prompt
);
9005 else if (cursor_in_echo_area
9006 && echo_keystrokes_p ())
9007 /* This doesn't put in a dash if the echo buffer is empty, so
9008 you don't always see a dash hanging out in the minibuffer. */
9012 /* Record the initial state of the echo area and this_command_keys;
9013 we will need to restore them if we replay a key sequence. */
9015 echo_start
= echo_length ();
9016 keys_start
= this_command_key_count
;
9017 this_single_command_key_start
= keys_start
;
9019 /* We jump here when we need to reinitialize fkey and keytran; this
9020 happens if we switch keyboards between rescans. */
9021 replay_entire_sequence
:
9023 indec
.map
= indec
.parent
= KVAR (current_kboard
, Vinput_decode_map
);
9024 fkey
.map
= fkey
.parent
= KVAR (current_kboard
, Vlocal_function_key_map
);
9025 keytran
.map
= keytran
.parent
= Vkey_translation_map
;
9026 indec
.start
= indec
.end
= 0;
9027 fkey
.start
= fkey
.end
= 0;
9028 keytran
.start
= keytran
.end
= 0;
9030 /* We jump here when the key sequence has been thoroughly changed, and
9031 we need to rescan it starting from the beginning. When we jump here,
9032 keybuf[0..mock_input] holds the sequence we should reread. */
9035 starting_buffer
= current_buffer
;
9036 first_unbound
= bufsize
+ 1;
9038 /* Build our list of keymaps.
9039 If we recognize a function key and replace its escape sequence in
9040 keybuf with its symbol, or if the sequence starts with a mouse
9041 click and we need to switch buffers, we jump back here to rebuild
9042 the initial keymaps from the current buffer. */
9043 current_binding
= active_maps (first_event
);
9045 /* Start from the beginning in keybuf. */
9048 /* These are no-ops the first time through, but if we restart, they
9049 revert the echo area and this_command_keys to their original state. */
9050 this_command_key_count
= keys_start
;
9051 if (INTERACTIVE
&& t
< mock_input
)
9052 echo_truncate (echo_start
);
9054 /* If the best binding for the current key sequence is a keymap, or
9055 we may be looking at a function key's escape sequence, keep on
9057 while (!NILP (current_binding
)
9058 /* Keep reading as long as there's a prefix binding. */
9059 ? KEYMAPP (current_binding
)
9060 /* Don't return in the middle of a possible function key sequence,
9061 if the only bindings we found were via case conversion.
9062 Thus, if ESC O a has a function-key-map translation
9063 and ESC o has a binding, don't return after ESC O,
9064 so that we can translate ESC O plus the next character. */
9065 : (/* indec.start < t || fkey.start < t || */ keytran
.start
< t
))
9068 bool used_mouse_menu
= 0;
9070 /* Where the last real key started. If we need to throw away a
9071 key that has expanded into more than one element of keybuf
9072 (say, a mouse click on the mode line which is being treated
9073 as [mode-line (mouse-...)], then we backtrack to this point
9075 int last_real_key_start
;
9077 /* These variables are analogous to echo_start and keys_start;
9078 while those allow us to restart the entire key sequence,
9079 echo_local_start and keys_local_start allow us to throw away
9081 ptrdiff_t echo_local_start
IF_LINT (= 0);
9082 int keys_local_start
;
9083 Lisp_Object new_binding
;
9085 eassert (indec
.end
== t
|| (indec
.end
> t
&& indec
.end
<= mock_input
));
9086 eassert (indec
.start
<= indec
.end
);
9087 eassert (fkey
.start
<= fkey
.end
);
9088 eassert (keytran
.start
<= keytran
.end
);
9089 /* key-translation-map is applied *after* function-key-map
9090 which is itself applied *after* input-decode-map. */
9091 eassert (fkey
.end
<= indec
.start
);
9092 eassert (keytran
.end
<= fkey
.start
);
9094 if (/* first_unbound < indec.start && first_unbound < fkey.start && */
9095 first_unbound
< keytran
.start
)
9096 { /* The prefix upto first_unbound has no binding and has
9097 no translation left to do either, so we know it's unbound.
9098 If we don't stop now, we risk staying here indefinitely
9099 (if the user keeps entering fkey or keytran prefixes
9100 like C-c ESC ESC ESC ESC ...) */
9102 for (i
= first_unbound
+ 1; i
< t
; i
++)
9103 keybuf
[i
- first_unbound
- 1] = keybuf
[i
];
9104 mock_input
= t
- first_unbound
- 1;
9105 indec
.end
= indec
.start
-= first_unbound
+ 1;
9106 indec
.map
= indec
.parent
;
9107 fkey
.end
= fkey
.start
-= first_unbound
+ 1;
9108 fkey
.map
= fkey
.parent
;
9109 keytran
.end
= keytran
.start
-= first_unbound
+ 1;
9110 keytran
.map
= keytran
.parent
;
9111 goto replay_sequence
;
9115 error ("Key sequence too long");
9118 echo_local_start
= echo_length ();
9119 keys_local_start
= this_command_key_count
;
9122 /* These are no-ops, unless we throw away a keystroke below and
9123 jumped back up to replay_key; in that case, these restore the
9124 variables to their original state, allowing us to replay the
9126 if (INTERACTIVE
&& t
< mock_input
)
9127 echo_truncate (echo_local_start
);
9128 this_command_key_count
= keys_local_start
;
9130 /* By default, assume each event is "real". */
9131 last_real_key_start
= t
;
9133 /* Does mock_input indicate that we are re-reading a key sequence? */
9137 add_command_key (key
);
9138 if (echo_keystrokes_p ()
9139 && current_kboard
->immediate_echo
)
9146 /* If not, we should actually read a character. */
9150 KBOARD
*interrupted_kboard
= current_kboard
;
9151 struct frame
*interrupted_frame
= SELECTED_FRAME ();
9152 /* Calling read_char with COMMANDFLAG = -2 avoids
9153 redisplay in read_char and its subroutines. */
9154 key
= read_char (prevent_redisplay
? -2 : NILP (prompt
),
9155 current_binding
, last_nonmenu_event
,
9156 &used_mouse_menu
, NULL
);
9157 if ((INTEGERP (key
) && XINT (key
) == -2) /* wrong_kboard_jmpbuf */
9158 /* When switching to a new tty (with a new keyboard),
9159 read_char returns the new buffer, rather than -2
9160 (Bug#5095). This is because `terminal-init-xterm'
9161 calls read-char, which eats the wrong_kboard_jmpbuf
9162 return. Any better way to fix this? -- cyd */
9163 || (interrupted_kboard
!= current_kboard
))
9168 for (k
= all_kboards
; k
; k
= k
->next_kboard
)
9169 if (k
== interrupted_kboard
)
9174 /* Don't touch interrupted_kboard when it's been
9176 delayed_switch_frame
= Qnil
;
9177 goto replay_entire_sequence
;
9180 if (!NILP (delayed_switch_frame
))
9183 (interrupted_kboard
,
9184 Fcons (delayed_switch_frame
,
9185 KVAR (interrupted_kboard
, kbd_queue
)));
9186 delayed_switch_frame
= Qnil
;
9191 (interrupted_kboard
,
9192 Fcons (keybuf
[--t
], KVAR (interrupted_kboard
, kbd_queue
)));
9194 /* If the side queue is non-empty, ensure it begins with a
9195 switch-frame, so we'll replay it in the right context. */
9196 if (CONSP (KVAR (interrupted_kboard
, kbd_queue
))
9197 && (key
= XCAR (KVAR (interrupted_kboard
, kbd_queue
)),
9198 !(EVENT_HAS_PARAMETERS (key
)
9199 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)),
9203 XSETFRAME (frame
, interrupted_frame
);
9205 (interrupted_kboard
,
9206 Fcons (make_lispy_switch_frame (frame
),
9207 KVAR (interrupted_kboard
, kbd_queue
)));
9210 goto replay_entire_sequence
;
9214 /* read_char returns t when it shows a menu and the user rejects it.
9218 unbind_to (count
, Qnil
);
9223 /* read_char returns -1 at the end of a macro.
9224 Emacs 18 handles this by returning immediately with a
9225 zero, so that's what we'll do. */
9226 if (INTEGERP (key
) && XINT (key
) == -1)
9229 /* The Microsoft C compiler can't handle the goto that
9235 /* If the current buffer has been changed from under us, the
9236 keymap may have changed, so replay the sequence. */
9239 timer_resume_idle ();
9242 /* Reset the current buffer from the selected window
9243 in case something changed the former and not the latter.
9244 This is to be more consistent with the behavior
9245 of the command_loop_1. */
9246 if (fix_current_buffer
)
9248 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
9250 if (XBUFFER (XWINDOW (selected_window
)->contents
)
9252 Fset_buffer (XWINDOW (selected_window
)->contents
);
9255 goto replay_sequence
;
9258 /* If we have a quit that was typed in another frame, and
9259 quit_throw_to_read_char switched buffers,
9260 replay to get the right keymap. */
9262 && XINT (key
) == quit_char
9263 && current_buffer
!= starting_buffer
)
9266 ASET (raw_keybuf
, raw_keybuf_count
, key
);
9271 goto replay_sequence
;
9276 if (EVENT_HAS_PARAMETERS (key
)
9277 /* Either a `switch-frame' or a `select-window' event. */
9278 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)), Qswitch_frame
))
9280 /* If we're at the beginning of a key sequence, and the caller
9281 says it's okay, go ahead and return this event. If we're
9282 in the midst of a key sequence, delay it until the end. */
9283 if (t
> 0 || !can_return_switch_frame
)
9285 delayed_switch_frame
= key
;
9290 if (NILP (first_event
))
9293 /* Even if first_event does not specify a particular
9294 window/position, it's important to recompute the maps here
9295 since a long time might have passed since we entered
9296 read_key_sequence, and a timer (or process-filter or
9297 special-event-map, ...) might have switched the current buffer
9298 or the selected window from under us in the mean time. */
9299 if (fix_current_buffer
9300 && (XBUFFER (XWINDOW (selected_window
)->contents
)
9302 Fset_buffer (XWINDOW (selected_window
)->contents
);
9303 current_binding
= active_maps (first_event
);
9307 ASET (raw_keybuf
, raw_keybuf_count
, key
);
9311 /* Clicks in non-text areas get prefixed by the symbol
9312 in their CHAR-ADDRESS field. For example, a click on
9313 the mode line is prefixed by the symbol `mode-line'.
9315 Furthermore, key sequences beginning with mouse clicks
9316 are read using the keymaps of the buffer clicked on, not
9317 the current buffer. So we may have to switch the buffer
9320 When we turn one event into two events, we must make sure
9321 that neither of the two looks like the original--so that,
9322 if we replay the events, they won't be expanded again.
9323 If not for this, such reexpansion could happen either here
9324 or when user programs play with this-command-keys. */
9325 if (EVENT_HAS_PARAMETERS (key
))
9327 Lisp_Object kind
= EVENT_HEAD_KIND (EVENT_HEAD (key
));
9328 if (EQ (kind
, Qmouse_click
))
9330 Lisp_Object window
= POSN_WINDOW (EVENT_START (key
));
9331 Lisp_Object posn
= POSN_POSN (EVENT_START (key
));
9334 || (!NILP (fake_prefixed_keys
)
9335 && !NILP (Fmemq (key
, fake_prefixed_keys
))))
9337 /* We're looking a second time at an event for which
9338 we generated a fake prefix key. Set
9339 last_real_key_start appropriately. */
9341 last_real_key_start
= t
- 1;
9344 if (last_real_key_start
== 0)
9346 /* Key sequences beginning with mouse clicks are
9347 read using the keymaps in the buffer clicked on,
9348 not the current buffer. If we're at the
9349 beginning of a key sequence, switch buffers. */
9350 if (WINDOWP (window
)
9351 && BUFFERP (XWINDOW (window
)->contents
)
9352 && XBUFFER (XWINDOW (window
)->contents
) != current_buffer
)
9354 ASET (raw_keybuf
, raw_keybuf_count
, key
);
9359 /* Arrange to go back to the original buffer once we're
9360 done reading the key sequence. Note that we can't
9361 use save_excursion_{save,restore} here, because they
9362 save point as well as the current buffer; we don't
9363 want to save point, because redisplay may change it,
9364 to accommodate a Fset_window_start or something. We
9365 don't want to do this at the top of the function,
9366 because we may get input from a subprocess which
9367 wants to change the selected window and stuff (say,
9369 record_unwind_current_buffer ();
9371 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
9373 set_buffer_internal (XBUFFER (XWINDOW (window
)->contents
));
9374 goto replay_sequence
;
9378 /* Expand mode-line and scroll-bar events into two events:
9379 use posn as a fake prefix key. */
9381 && (NILP (fake_prefixed_keys
)
9382 || NILP (Fmemq (key
, fake_prefixed_keys
))))
9384 if (bufsize
- t
<= 1)
9385 error ("Key sequence too long");
9388 keybuf
[t
+ 1] = key
;
9391 /* Record that a fake prefix key has been generated
9392 for KEY. Don't modify the event; this would
9393 prevent proper action when the event is pushed
9394 back into unread-command-events. */
9395 fake_prefixed_keys
= Fcons (key
, fake_prefixed_keys
);
9399 else if (CONSP (XCDR (key
))
9400 && CONSP (EVENT_START (key
))
9401 && CONSP (XCDR (EVENT_START (key
))))
9405 posn
= POSN_POSN (EVENT_START (key
));
9406 /* Handle menu-bar events:
9407 insert the dummy prefix event `menu-bar'. */
9408 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
9410 if (bufsize
- t
<= 1)
9411 error ("Key sequence too long");
9413 keybuf
[t
+ 1] = key
;
9415 /* Zap the position in key, so we know that we've
9416 expanded it, and don't try to do so again. */
9417 POSN_SET_POSN (EVENT_START (key
), list1 (posn
));
9420 goto replay_sequence
;
9422 else if (CONSP (posn
))
9424 /* We're looking at the second event of a
9425 sequence which we expanded before. Set
9426 last_real_key_start appropriately. */
9427 if (last_real_key_start
== t
&& t
> 0)
9428 last_real_key_start
= t
- 1;
9433 /* We have finally decided that KEY is something we might want
9435 new_binding
= follow_key (current_binding
, key
);
9437 /* If KEY wasn't bound, we'll try some fallbacks. */
9438 if (!NILP (new_binding
))
9439 /* This is needed for the following scenario:
9440 event 0: a down-event that gets dropped by calling replay_key.
9441 event 1: some normal prefix like C-h.
9442 After event 0, first_unbound is 0, after event 1 indec.start,
9443 fkey.start, and keytran.start are all 1, so when we see that
9444 C-h is bound, we need to update first_unbound. */
9445 first_unbound
= max (t
+ 1, first_unbound
);
9450 /* Remember the position to put an upper bound on indec.start. */
9451 first_unbound
= min (t
, first_unbound
);
9453 head
= EVENT_HEAD (key
);
9457 Lisp_Object breakdown
;
9460 breakdown
= parse_modifiers (head
);
9461 modifiers
= XINT (XCAR (XCDR (breakdown
)));
9462 /* Attempt to reduce an unbound mouse event to a simpler
9463 event that is bound:
9464 Drags reduce to clicks.
9465 Double-clicks reduce to clicks.
9466 Triple-clicks reduce to double-clicks, then to clicks.
9467 Down-clicks are eliminated.
9468 Double-downs reduce to downs, then are eliminated.
9469 Triple-downs reduce to double-downs, then to downs,
9470 then are eliminated. */
9471 if (modifiers
& (down_modifier
| drag_modifier
9472 | double_modifier
| triple_modifier
))
9474 while (modifiers
& (down_modifier
| drag_modifier
9475 | double_modifier
| triple_modifier
))
9477 Lisp_Object new_head
, new_click
;
9478 if (modifiers
& triple_modifier
)
9479 modifiers
^= (double_modifier
| triple_modifier
);
9480 else if (modifiers
& double_modifier
)
9481 modifiers
&= ~double_modifier
;
9482 else if (modifiers
& drag_modifier
)
9483 modifiers
&= ~drag_modifier
;
9486 /* Dispose of this `down' event by simply jumping
9487 back to replay_key, to get another event.
9489 Note that if this event came from mock input,
9490 then just jumping back to replay_key will just
9491 hand it to us again. So we have to wipe out any
9494 We could delete keybuf[t] and shift everything
9495 after that to the left by one spot, but we'd also
9496 have to fix up any variable that points into
9497 keybuf, and shifting isn't really necessary
9500 Adding prefixes for non-textual mouse clicks
9501 creates two characters of mock input, and both
9502 must be thrown away. If we're only looking at
9503 the prefix now, we can just jump back to
9504 replay_key. On the other hand, if we've already
9505 processed the prefix, and now the actual click
9506 itself is giving us trouble, then we've lost the
9507 state of the keymaps we want to backtrack to, and
9508 we need to replay the whole sequence to rebuild
9511 Beyond that, only function key expansion could
9512 create more than two keys, but that should never
9513 generate mouse events, so it's okay to zero
9514 mock_input in that case too.
9516 FIXME: The above paragraph seems just plain
9517 wrong, if you consider things like
9518 xterm-mouse-mode. -stef
9520 Isn't this just the most wonderful code ever? */
9522 /* If mock_input > t + 1, the above simplification
9523 will actually end up dropping keys on the floor.
9524 This is probably OK for now, but even
9525 if mock_input <= t + 1, we need to adjust indec,
9527 Typical case [header-line down-mouse-N]:
9528 mock_input = 2, t = 1, fkey.end = 1,
9529 last_real_key_start = 0. */
9530 if (indec
.end
> last_real_key_start
)
9532 indec
.end
= indec
.start
9533 = min (last_real_key_start
, indec
.start
);
9534 indec
.map
= indec
.parent
;
9535 if (fkey
.end
> last_real_key_start
)
9537 fkey
.end
= fkey
.start
9538 = min (last_real_key_start
, fkey
.start
);
9539 fkey
.map
= fkey
.parent
;
9540 if (keytran
.end
> last_real_key_start
)
9542 keytran
.end
= keytran
.start
9543 = min (last_real_key_start
, keytran
.start
);
9544 keytran
.map
= keytran
.parent
;
9548 if (t
== last_real_key_start
)
9555 mock_input
= last_real_key_start
;
9556 goto replay_sequence
;
9561 = apply_modifiers (modifiers
, XCAR (breakdown
));
9562 new_click
= list2 (new_head
, EVENT_START (key
));
9564 /* Look for a binding for this new key. */
9565 new_binding
= follow_key (current_binding
, new_click
);
9567 /* If that click is bound, go for it. */
9568 if (!NILP (new_binding
))
9570 current_binding
= new_binding
;
9574 /* Otherwise, we'll leave key set to the drag event. */
9579 current_binding
= new_binding
;
9582 /* Normally, last_nonmenu_event gets the previous key we read.
9583 But when a mouse popup menu is being used,
9584 we don't update last_nonmenu_event; it continues to hold the mouse
9585 event that preceded the first level of menu. */
9586 if (!used_mouse_menu
)
9587 last_nonmenu_event
= key
;
9589 /* Record what part of this_command_keys is the current key sequence. */
9590 this_single_command_key_start
= this_command_key_count
- t
;
9591 /* When 'input-method-function' called above causes events to be
9592 put on 'unread-post-input-method-events', and as result
9593 'reread' is set to 'true', the value of 't' can become larger
9594 than 'this_command_key_count', because 'add_command_key' is
9595 not called to update 'this_command_key_count'. If this
9596 happens, 'this_single_command_key_start' will become negative
9597 above, and any call to 'this-single-command-keys' will return
9598 a garbled vector. See bug #20223 for one such situation.
9599 Here we force 'this_single_command_key_start' to never become
9600 negative, to avoid that. */
9601 if (this_single_command_key_start
< 0)
9602 this_single_command_key_start
= 0;
9604 /* Look for this sequence in input-decode-map.
9605 Scan from indec.end until we find a bound suffix. */
9606 while (indec
.end
< t
)
9608 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9612 GCPRO4 (indec
.map
, fkey
.map
, keytran
.map
, delayed_switch_frame
);
9613 done
= keyremap_step (keybuf
, bufsize
, &indec
, max (t
, mock_input
),
9618 mock_input
= diff
+ max (t
, mock_input
);
9619 goto replay_sequence
;
9623 if (!KEYMAPP (current_binding
)
9624 && !test_undefined (current_binding
)
9625 && indec
.start
>= t
)
9626 /* There is a binding and it's not a prefix.
9627 (and it doesn't have any input-decode-map translation pending).
9628 There is thus no function-key in this sequence.
9629 Moving fkey.start is important in this case to allow keytran.start
9630 to go over the sequence before we return (since we keep the
9631 invariant that keytran.end <= fkey.start). */
9634 (fkey
.start
= fkey
.end
= t
, fkey
.map
= fkey
.parent
);
9637 /* If the sequence is unbound, see if we can hang a function key
9638 off the end of it. */
9639 /* Continue scan from fkey.end until we find a bound suffix. */
9640 while (fkey
.end
< indec
.start
)
9642 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9646 GCPRO4 (indec
.map
, fkey
.map
, keytran
.map
, delayed_switch_frame
);
9647 done
= keyremap_step (keybuf
, bufsize
, &fkey
,
9648 max (t
, mock_input
),
9649 /* If there's a binding (i.e.
9650 first_binding >= nmaps) we don't want
9651 to apply this function-key-mapping. */
9653 && (test_undefined (current_binding
)),
9658 mock_input
= diff
+ max (t
, mock_input
);
9659 /* Adjust the input-decode-map counters. */
9661 indec
.start
+= diff
;
9663 goto replay_sequence
;
9667 /* Look for this sequence in key-translation-map.
9668 Scan from keytran.end until we find a bound suffix. */
9669 while (keytran
.end
< fkey
.start
)
9671 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9675 GCPRO4 (indec
.map
, fkey
.map
, keytran
.map
, delayed_switch_frame
);
9676 done
= keyremap_step (keybuf
, bufsize
, &keytran
, max (t
, mock_input
),
9681 mock_input
= diff
+ max (t
, mock_input
);
9682 /* Adjust the function-key-map and input-decode-map counters. */
9684 indec
.start
+= diff
;
9688 goto replay_sequence
;
9692 /* If KEY is not defined in any of the keymaps,
9693 and cannot be part of a function key or translation,
9694 and is an upper case letter
9695 use the corresponding lower-case letter instead. */
9696 if (NILP (current_binding
)
9697 && /* indec.start >= t && fkey.start >= t && */ keytran
.start
>= t
9699 && ((CHARACTERP (make_number (XINT (key
) & ~CHAR_MODIFIER_MASK
))
9700 && uppercasep (XINT (key
) & ~CHAR_MODIFIER_MASK
))
9701 || (XINT (key
) & shift_modifier
)))
9703 Lisp_Object new_key
;
9705 original_uppercase
= key
;
9706 original_uppercase_position
= t
- 1;
9708 if (XINT (key
) & shift_modifier
)
9709 XSETINT (new_key
, XINT (key
) & ~shift_modifier
);
9711 XSETINT (new_key
, (downcase (XINT (key
) & ~CHAR_MODIFIER_MASK
)
9712 | (XINT (key
) & CHAR_MODIFIER_MASK
)));
9714 /* We have to do this unconditionally, regardless of whether
9715 the lower-case char is defined in the keymaps, because they
9716 might get translated through function-key-map. */
9717 keybuf
[t
- 1] = new_key
;
9718 mock_input
= max (t
, mock_input
);
9719 shift_translated
= 1;
9721 goto replay_sequence
;
9724 if (NILP (current_binding
)
9725 && help_char_p (EVENT_HEAD (key
)) && t
> 1)
9727 read_key_sequence_cmd
= Vprefix_help_command
;
9728 /* The Microsoft C compiler can't handle the goto that
9734 /* If KEY is not defined in any of the keymaps,
9735 and cannot be part of a function key or translation,
9736 and is a shifted function key,
9737 use the corresponding unshifted function key instead. */
9738 if (NILP (current_binding
)
9739 && /* indec.start >= t && fkey.start >= t && */ keytran
.start
>= t
)
9741 Lisp_Object breakdown
= parse_modifiers (key
);
9743 = CONSP (breakdown
) ? (XINT (XCAR (XCDR (breakdown
)))) : 0;
9745 if (modifiers
& shift_modifier
9746 /* Treat uppercase keys as shifted. */
9748 && (KEY_TO_CHAR (key
)
9749 < XCHAR_TABLE (BVAR (current_buffer
, downcase_table
))->header
.size
)
9750 && uppercasep (KEY_TO_CHAR (key
))))
9753 = (modifiers
& shift_modifier
9754 ? apply_modifiers (modifiers
& ~shift_modifier
,
9756 : make_number (downcase (KEY_TO_CHAR (key
)) | modifiers
));
9758 original_uppercase
= key
;
9759 original_uppercase_position
= t
- 1;
9761 /* We have to do this unconditionally, regardless of whether
9762 the lower-case char is defined in the keymaps, because they
9763 might get translated through function-key-map. */
9764 keybuf
[t
- 1] = new_key
;
9765 mock_input
= max (t
, mock_input
);
9766 /* Reset fkey (and consequently keytran) to apply
9767 function-key-map on the result, so that S-backspace is
9768 correctly mapped to DEL (via backspace). OTOH,
9769 input-decode-map doesn't need to go through it again. */
9770 fkey
.start
= fkey
.end
= 0;
9771 keytran
.start
= keytran
.end
= 0;
9772 shift_translated
= 1;
9774 goto replay_sequence
;
9779 read_key_sequence_cmd
= current_binding
;
9780 read_key_sequence_remapped
9781 /* Remap command through active keymaps.
9782 Do the remapping here, before the unbind_to so it uses the keymaps
9783 of the appropriate buffer. */
9784 = SYMBOLP (read_key_sequence_cmd
)
9785 ? Fcommand_remapping (read_key_sequence_cmd
, Qnil
, Qnil
)
9788 unread_switch_frame
= delayed_switch_frame
;
9789 unbind_to (count
, Qnil
);
9791 /* Don't downcase the last character if the caller says don't.
9792 Don't downcase it if the result is undefined, either. */
9793 if ((dont_downcase_last
|| NILP (current_binding
))
9795 && t
- 1 == original_uppercase_position
)
9797 keybuf
[t
- 1] = original_uppercase
;
9798 shift_translated
= 0;
9801 if (shift_translated
)
9802 Vthis_command_keys_shift_translated
= Qt
;
9804 /* Occasionally we fabricate events, perhaps by expanding something
9805 according to function-key-map, or by adding a prefix symbol to a
9806 mouse click in the scroll bar or modeline. In this cases, return
9807 the entire generated key sequence, even if we hit an unbound
9808 prefix or a definition before the end. This means that you will
9809 be able to push back the event properly, and also means that
9810 read-key-sequence will always return a logical unit.
9813 for (; t
< mock_input
; t
++)
9815 if (echo_keystrokes_p ())
9816 echo_char (keybuf
[t
]);
9817 add_command_key (keybuf
[t
]);
9825 read_key_sequence_vs (Lisp_Object prompt
, Lisp_Object continue_echo
,
9826 Lisp_Object dont_downcase_last
,
9827 Lisp_Object can_return_switch_frame
,
9828 Lisp_Object cmd_loop
, bool allow_string
)
9830 Lisp_Object keybuf
[30];
9832 struct gcpro gcpro1
;
9833 ptrdiff_t count
= SPECPDL_INDEX ();
9836 CHECK_STRING (prompt
);
9839 specbind (Qinput_method_exit_on_first_char
,
9840 (NILP (cmd_loop
) ? Qt
: Qnil
));
9841 specbind (Qinput_method_use_echo_area
,
9842 (NILP (cmd_loop
) ? Qt
: Qnil
));
9844 memset (keybuf
, 0, sizeof keybuf
);
9846 gcpro1
.nvars
= ARRAYELTS (keybuf
);
9848 if (NILP (continue_echo
))
9850 this_command_key_count
= 0;
9851 this_command_key_count_reset
= 0;
9852 this_single_command_key_start
= 0;
9855 #ifdef HAVE_WINDOW_SYSTEM
9856 if (display_hourglass_p
)
9857 cancel_hourglass ();
9860 i
= read_key_sequence (keybuf
, ARRAYELTS (keybuf
),
9861 prompt
, ! NILP (dont_downcase_last
),
9862 ! NILP (can_return_switch_frame
), 0, 0);
9864 #if 0 /* The following is fine for code reading a key sequence and
9865 then proceeding with a lengthy computation, but it's not good
9866 for code reading keys in a loop, like an input method. */
9867 #ifdef HAVE_WINDOW_SYSTEM
9868 if (display_hourglass_p
)
9879 return unbind_to (count
,
9880 ((allow_string
? make_event_array
: Fvector
)
9884 DEFUN ("read-key-sequence", Fread_key_sequence
, Sread_key_sequence
, 1, 5, 0,
9885 doc
: /* Read a sequence of keystrokes and return as a string or vector.
9886 The sequence is sufficient to specify a non-prefix command in the
9887 current local and global maps.
9889 First arg PROMPT is a prompt string. If nil, do not prompt specially.
9890 Second (optional) arg CONTINUE-ECHO, if non-nil, means this key echos
9891 as a continuation of the previous key.
9893 The third (optional) arg DONT-DOWNCASE-LAST, if non-nil, means do not
9894 convert the last event to lower case. (Normally any upper case event
9895 is converted to lower case if the original event is undefined and the lower
9896 case equivalent is defined.) A non-nil value is appropriate for reading
9897 a key sequence to be defined.
9899 A C-g typed while in this function is treated like any other character,
9900 and `quit-flag' is not set.
9902 If the key sequence starts with a mouse click, then the sequence is read
9903 using the keymaps of the buffer of the window clicked in, not the buffer
9904 of the selected window as normal.
9906 `read-key-sequence' drops unbound button-down events, since you normally
9907 only care about the click or drag events which follow them. If a drag
9908 or multi-click event is unbound, but the corresponding click event would
9909 be bound, `read-key-sequence' turns the event into a click event at the
9910 drag's starting position. This means that you don't have to distinguish
9911 between click and drag, double, or triple events unless you want to.
9913 `read-key-sequence' prefixes mouse events on mode lines, the vertical
9914 lines separating windows, and scroll bars with imaginary keys
9915 `mode-line', `vertical-line', and `vertical-scroll-bar'.
9917 Optional fourth argument CAN-RETURN-SWITCH-FRAME non-nil means that this
9918 function will process a switch-frame event if the user switches frames
9919 before typing anything. If the user switches frames in the middle of a
9920 key sequence, or at the start of the sequence but CAN-RETURN-SWITCH-FRAME
9921 is nil, then the event will be put off until after the current key sequence.
9923 `read-key-sequence' checks `function-key-map' for function key
9924 sequences, where they wouldn't conflict with ordinary bindings. See
9925 `function-key-map' for more details.
9927 The optional fifth argument CMD-LOOP, if non-nil, means
9928 that this key sequence is being read by something that will
9929 read commands one after another. It should be nil if the caller
9930 will read just one key sequence. */)
9931 (Lisp_Object prompt
, Lisp_Object continue_echo
, Lisp_Object dont_downcase_last
, Lisp_Object can_return_switch_frame
, Lisp_Object cmd_loop
)
9933 return read_key_sequence_vs (prompt
, continue_echo
, dont_downcase_last
,
9934 can_return_switch_frame
, cmd_loop
, true);
9937 DEFUN ("read-key-sequence-vector", Fread_key_sequence_vector
,
9938 Sread_key_sequence_vector
, 1, 5, 0,
9939 doc
: /* Like `read-key-sequence' but always return a vector. */)
9940 (Lisp_Object prompt
, Lisp_Object continue_echo
, Lisp_Object dont_downcase_last
, Lisp_Object can_return_switch_frame
, Lisp_Object cmd_loop
)
9942 return read_key_sequence_vs (prompt
, continue_echo
, dont_downcase_last
,
9943 can_return_switch_frame
, cmd_loop
, false);
9946 /* Return true if input events are pending. */
9949 detect_input_pending (void)
9951 return input_pending
|| get_input_pending (0);
9954 /* Return true if input events other than mouse movements are
9958 detect_input_pending_ignore_squeezables (void)
9960 return input_pending
|| get_input_pending (READABLE_EVENTS_IGNORE_SQUEEZABLES
);
9963 /* Return true if input events are pending, and run any pending timers. */
9966 detect_input_pending_run_timers (bool do_display
)
9968 unsigned old_timers_run
= timers_run
;
9971 get_input_pending (READABLE_EVENTS_DO_TIMERS_NOW
);
9973 if (old_timers_run
!= timers_run
&& do_display
)
9974 redisplay_preserve_echo_area (8);
9976 return input_pending
;
9979 /* This is called in some cases before a possible quit.
9980 It cases the next call to detect_input_pending to recompute input_pending.
9981 So calling this function unnecessarily can't do any harm. */
9984 clear_input_pending (void)
9989 /* Return true if there are pending requeued events.
9990 This isn't used yet. The hope is to make wait_reading_process_output
9991 call it, and return if it runs Lisp code that unreads something.
9992 The problem is, kbd_buffer_get_event needs to be fixed to know what
9993 to do in that case. It isn't trivial. */
9996 requeued_events_pending_p (void)
9998 return (!NILP (Vunread_command_events
));
10001 DEFUN ("input-pending-p", Finput_pending_p
, Sinput_pending_p
, 0, 1, 0,
10002 doc
: /* Return t if command input is currently available with no wait.
10003 Actually, the value is nil only if we can be sure that no input is available;
10004 if there is a doubt, the value is t.
10006 If CHECK-TIMERS is non-nil, timers that are ready to run will do so. */)
10007 (Lisp_Object check_timers
)
10009 if (!NILP (Vunread_command_events
)
10010 || !NILP (Vunread_post_input_method_events
)
10011 || !NILP (Vunread_input_method_events
))
10014 /* Process non-user-visible events (Bug#10195). */
10015 process_special_events ();
10017 return (get_input_pending ((NILP (check_timers
)
10018 ? 0 : READABLE_EVENTS_DO_TIMERS_NOW
)
10019 | READABLE_EVENTS_FILTER_EVENTS
)
10023 DEFUN ("recent-keys", Frecent_keys
, Srecent_keys
, 0, 1, 0,
10024 doc
: /* Return vector of last few events, not counting those from keyboard macros.
10025 If INCLUDE-CMDS is non-nil, include the commands that were run,
10026 represented as events of the form (nil . COMMAND). */)
10027 (Lisp_Object include_cmds
)
10029 bool cmds
= !NILP (include_cmds
);
10032 || (cmds
&& total_keys
< NUM_RECENT_KEYS
))
10033 return Fvector (total_keys
,
10034 XVECTOR (recent_keys
)->contents
);
10037 Lisp_Object es
= Qnil
;
10038 int i
= (total_keys
< NUM_RECENT_KEYS
10039 ? 0 : recent_keys_index
);
10040 eassert (recent_keys_index
< NUM_RECENT_KEYS
);
10043 Lisp_Object e
= AREF (recent_keys
, i
);
10044 if (cmds
|| !CONSP (e
) || !NILP (XCAR (e
)))
10045 es
= Fcons (e
, es
);
10046 if (++i
>= NUM_RECENT_KEYS
)
10048 } while (i
!= recent_keys_index
);
10049 es
= Fnreverse (es
);
10050 return Fvconcat (1, &es
);
10054 DEFUN ("this-command-keys", Fthis_command_keys
, Sthis_command_keys
, 0, 0, 0,
10055 doc
: /* Return the key sequence that invoked this command.
10056 However, if the command has called `read-key-sequence', it returns
10057 the last key sequence that has been read.
10058 The value is a string or a vector.
10060 See also `this-command-keys-vector'. */)
10063 return make_event_array (this_command_key_count
,
10064 XVECTOR (this_command_keys
)->contents
);
10067 DEFUN ("this-command-keys-vector", Fthis_command_keys_vector
, Sthis_command_keys_vector
, 0, 0, 0,
10068 doc
: /* Return the key sequence that invoked this command, as a vector.
10069 However, if the command has called `read-key-sequence', it returns
10070 the last key sequence that has been read.
10072 See also `this-command-keys'. */)
10075 return Fvector (this_command_key_count
,
10076 XVECTOR (this_command_keys
)->contents
);
10079 DEFUN ("this-single-command-keys", Fthis_single_command_keys
,
10080 Sthis_single_command_keys
, 0, 0, 0,
10081 doc
: /* Return the key sequence that invoked this command.
10082 More generally, it returns the last key sequence read, either by
10083 the command loop or by `read-key-sequence'.
10084 Unlike `this-command-keys', this function's value
10085 does not include prefix arguments.
10086 The value is always a vector. */)
10089 return Fvector (this_command_key_count
10090 - this_single_command_key_start
,
10091 (XVECTOR (this_command_keys
)->contents
10092 + this_single_command_key_start
));
10095 DEFUN ("this-single-command-raw-keys", Fthis_single_command_raw_keys
,
10096 Sthis_single_command_raw_keys
, 0, 0, 0,
10097 doc
: /* Return the raw events that were read for this command.
10098 More generally, it returns the last key sequence read, either by
10099 the command loop or by `read-key-sequence'.
10100 Unlike `this-single-command-keys', this function's value
10101 shows the events before all translations (except for input methods).
10102 The value is always a vector. */)
10105 return Fvector (raw_keybuf_count
, XVECTOR (raw_keybuf
)->contents
);
10108 DEFUN ("reset-this-command-lengths", Freset_this_command_lengths
,
10109 Sreset_this_command_lengths
, 0, 0, 0,
10110 doc
: /* Make the unread events replace the last command and echo.
10111 Used in `universal-argument-other-key'.
10113 `universal-argument-other-key' rereads the event just typed.
10114 It then gets translated through `function-key-map'.
10115 The translated event has to replace the real events,
10116 both in the value of (this-command-keys) and in echoing.
10117 To achieve this, `universal-argument-other-key' calls
10118 `reset-this-command-lengths', which discards the record of reading
10119 these events the first time. */)
10122 this_command_key_count
= before_command_key_count
;
10123 if (this_command_key_count
< this_single_command_key_start
)
10124 this_single_command_key_start
= this_command_key_count
;
10126 echo_truncate (before_command_echo_length
);
10128 /* Cause whatever we put into unread-command-events
10129 to echo as if it were being freshly read from the keyboard. */
10130 this_command_key_count_reset
= 1;
10135 DEFUN ("clear-this-command-keys", Fclear_this_command_keys
,
10136 Sclear_this_command_keys
, 0, 1, 0,
10137 doc
: /* Clear out the vector that `this-command-keys' returns.
10138 Also clear the record of the last 100 events, unless optional arg
10139 KEEP-RECORD is non-nil. */)
10140 (Lisp_Object keep_record
)
10144 this_command_key_count
= 0;
10145 this_command_key_count_reset
= 0;
10147 if (NILP (keep_record
))
10149 for (i
= 0; i
< ASIZE (recent_keys
); ++i
)
10150 ASET (recent_keys
, i
, Qnil
);
10152 recent_keys_index
= 0;
10157 DEFUN ("recursion-depth", Frecursion_depth
, Srecursion_depth
, 0, 0, 0,
10158 doc
: /* Return the current depth in recursive edits. */)
10162 /* Wrap around reliably on integer overflow. */
10163 EMACS_INT sum
= (command_loop_level
& INTMASK
) + (minibuf_level
& INTMASK
);
10164 XSETINT (temp
, sum
);
10168 DEFUN ("open-dribble-file", Fopen_dribble_file
, Sopen_dribble_file
, 1, 1,
10169 "FOpen dribble file: ",
10170 doc
: /* Start writing all keyboard characters to a dribble file called FILE.
10171 If FILE is nil, close any open dribble file.
10172 The file will be closed when Emacs exits.
10174 Be aware that this records ALL characters you type!
10175 This may include sensitive information such as passwords. */)
10188 Lisp_Object encfile
;
10190 file
= Fexpand_file_name (file
, Qnil
);
10191 encfile
= ENCODE_FILE (file
);
10192 fd
= emacs_open (SSDATA (encfile
), O_WRONLY
| O_CREAT
| O_EXCL
, 0600);
10193 if (fd
< 0 && errno
== EEXIST
&& unlink (SSDATA (encfile
)) == 0)
10194 fd
= emacs_open (SSDATA (encfile
), O_WRONLY
| O_CREAT
| O_EXCL
, 0600);
10195 dribble
= fd
< 0 ? 0 : fdopen (fd
, "w");
10197 report_file_error ("Opening dribble", file
);
10202 DEFUN ("discard-input", Fdiscard_input
, Sdiscard_input
, 0, 0, 0,
10203 doc
: /* Discard the contents of the terminal input buffer.
10204 Also end any kbd macro being defined. */)
10207 if (!NILP (KVAR (current_kboard
, defining_kbd_macro
)))
10209 /* Discard the last command from the macro. */
10210 Fcancel_kbd_macro_events ();
10214 Vunread_command_events
= Qnil
;
10216 discard_tty_input ();
10218 kbd_fetch_ptr
= kbd_store_ptr
;
10224 DEFUN ("suspend-emacs", Fsuspend_emacs
, Ssuspend_emacs
, 0, 1, "",
10225 doc
: /* Stop Emacs and return to superior process. You can resume later.
10226 If `cannot-suspend' is non-nil, or if the system doesn't support job
10227 control, run a subshell instead.
10229 If optional arg STUFFSTRING is non-nil, its characters are stuffed
10230 to be read as terminal input by Emacs's parent, after suspension.
10232 Before suspending, run the normal hook `suspend-hook'.
10233 After resumption run the normal hook `suspend-resume-hook'.
10235 Some operating systems cannot stop the Emacs process and resume it later.
10236 On such systems, Emacs starts a subshell instead of suspending. */)
10237 (Lisp_Object stuffstring
)
10239 ptrdiff_t count
= SPECPDL_INDEX ();
10240 int old_height
, old_width
;
10242 struct gcpro gcpro1
;
10244 if (tty_list
&& tty_list
->next
)
10245 error ("There are other tty frames open; close them before suspending Emacs");
10247 if (!NILP (stuffstring
))
10248 CHECK_STRING (stuffstring
);
10250 run_hook (intern ("suspend-hook"));
10252 GCPRO1 (stuffstring
);
10253 get_tty_size (fileno (CURTTY ()->input
), &old_width
, &old_height
);
10254 reset_all_sys_modes ();
10255 /* sys_suspend can get an error if it tries to fork a subshell
10256 and the system resources aren't available for that. */
10257 record_unwind_protect_void (init_all_sys_modes
);
10258 stuff_buffered_input (stuffstring
);
10259 if (cannot_suspend
)
10263 unbind_to (count
, Qnil
);
10265 /* Check if terminal/window size has changed.
10266 Note that this is not useful when we are running directly
10267 with a window system; but suspend should be disabled in that case. */
10268 get_tty_size (fileno (CURTTY ()->input
), &width
, &height
);
10269 if (width
!= old_width
|| height
!= old_height
)
10270 change_frame_size (SELECTED_FRAME (), width
,
10271 height
- FRAME_MENU_BAR_LINES (SELECTED_FRAME ()),
10274 run_hook (intern ("suspend-resume-hook"));
10280 /* If STUFFSTRING is a string, stuff its contents as pending terminal input.
10281 Then in any case stuff anything Emacs has read ahead and not used. */
10284 stuff_buffered_input (Lisp_Object stuffstring
)
10286 #ifdef SIGTSTP /* stuff_char is defined if SIGTSTP. */
10287 register unsigned char *p
;
10289 if (STRINGP (stuffstring
))
10291 register ptrdiff_t count
;
10293 p
= SDATA (stuffstring
);
10294 count
= SBYTES (stuffstring
);
10295 while (count
-- > 0)
10300 /* Anything we have read ahead, put back for the shell to read. */
10301 /* ?? What should this do when we have multiple keyboards??
10302 Should we ignore anything that was typed in at the "wrong" kboard?
10304 rms: we should stuff everything back into the kboard
10306 for (; kbd_fetch_ptr
!= kbd_store_ptr
; kbd_fetch_ptr
++)
10309 if (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
10310 kbd_fetch_ptr
= kbd_buffer
;
10311 if (kbd_fetch_ptr
->kind
== ASCII_KEYSTROKE_EVENT
)
10312 stuff_char (kbd_fetch_ptr
->ie
.code
);
10314 clear_event (kbd_fetch_ptr
);
10318 #endif /* SIGTSTP */
10322 set_waiting_for_input (struct timespec
*time_to_clear
)
10324 input_available_clear_time
= time_to_clear
;
10326 /* Tell handle_interrupt to throw back to read_char, */
10327 waiting_for_input
= 1;
10329 /* If handle_interrupt was called before and buffered a C-g,
10330 make it run again now, to avoid timing error. */
10331 if (!NILP (Vquit_flag
))
10332 quit_throw_to_read_char (0);
10336 clear_waiting_for_input (void)
10338 /* Tell handle_interrupt not to throw back to read_char, */
10339 waiting_for_input
= 0;
10340 input_available_clear_time
= 0;
10343 /* The SIGINT handler.
10345 If we have a frame on the controlling tty, we assume that the
10346 SIGINT was generated by C-g, so we call handle_interrupt.
10347 Otherwise, tell QUIT to kill Emacs. */
10350 handle_interrupt_signal (int sig
)
10352 /* See if we have an active terminal on our controlling tty. */
10353 struct terminal
*terminal
= get_named_terminal ("/dev/tty");
10356 /* If there are no frames there, let's pretend that we are a
10357 well-behaving UN*X program and quit. We must not call Lisp
10358 in a signal handler, so tell QUIT to exit when it is
10360 Vquit_flag
= Qkill_emacs
;
10364 /* Otherwise, the SIGINT was probably generated by C-g. */
10366 /* Set internal_last_event_frame to the top frame of the
10367 controlling tty, if we have a frame there. We disable the
10368 interrupt key on secondary ttys, so the SIGINT must have come
10369 from the controlling tty. */
10370 internal_last_event_frame
= terminal
->display_info
.tty
->top_frame
;
10372 handle_interrupt (1);
10377 deliver_interrupt_signal (int sig
)
10379 deliver_process_signal (sig
, handle_interrupt_signal
);
10383 /* If Emacs is stuck because `inhibit-quit' is true, then keep track
10384 of the number of times C-g has been requested. If C-g is pressed
10385 enough times, then quit anyway. See bug#6585. */
10386 static int volatile force_quit_count
;
10388 /* This routine is called at interrupt level in response to C-g.
10390 It is called from the SIGINT handler or kbd_buffer_store_event.
10392 If `waiting_for_input' is non zero, then unless `echoing' is
10393 nonzero, immediately throw back to read_char.
10395 Otherwise it sets the Lisp variable quit-flag not-nil. This causes
10396 eval to throw, when it gets a chance. If quit-flag is already
10397 non-nil, it stops the job right away. */
10400 handle_interrupt (bool in_signal_handler
)
10406 /* XXX This code needs to be revised for multi-tty support. */
10407 if (!NILP (Vquit_flag
) && get_named_terminal ("/dev/tty"))
10409 if (! in_signal_handler
)
10411 /* If SIGINT isn't blocked, don't let us be interrupted by
10412 a SIGINT. It might be harmful due to non-reentrancy
10413 in I/O functions. */
10415 sigemptyset (&blocked
);
10416 sigaddset (&blocked
, SIGINT
);
10417 pthread_sigmask (SIG_BLOCK
, &blocked
, 0);
10421 reset_all_sys_modes ();
10425 * On systems which can suspend the current process and return to the original
10426 * shell, this command causes the user to end up back at the shell.
10427 * The "Auto-save" and "Abort" questions are not asked until
10428 * the user elects to return to emacs, at which point he can save the current
10429 * job and either dump core or continue.
10433 /* Perhaps should really fork an inferior shell?
10434 But that would not provide any way to get back
10435 to the original shell, ever. */
10436 printf ("No support for stopping a process on this operating system;\n");
10437 printf ("you can continue or abort.\n");
10438 #endif /* not SIGTSTP */
10440 /* We must remain inside the screen area when the internal terminal
10441 is used. Note that [Enter] is not echoed by dos. */
10442 cursor_to (SELECTED_FRAME (), 0, 0);
10444 /* It doesn't work to autosave while GC is in progress;
10445 the code used for auto-saving doesn't cope with the mark bit. */
10446 if (!gc_in_progress
)
10448 printf ("Auto-save? (y or n) ");
10450 if (((c
= getchar ()) & ~040) == 'Y')
10452 Fdo_auto_save (Qt
, Qnil
);
10454 printf ("\r\nAuto-save done");
10455 #else /* not MSDOS */
10456 printf ("Auto-save done\n");
10457 #endif /* not MSDOS */
10459 while (c
!= '\n') c
= getchar ();
10463 /* During GC, it must be safe to reenable quitting again. */
10464 Vinhibit_quit
= Qnil
;
10467 #endif /* not MSDOS */
10468 printf ("Garbage collection in progress; cannot auto-save now\r\n");
10469 printf ("but will instead do a real quit after garbage collection ends\r\n");
10474 printf ("\r\nAbort? (y or n) ");
10475 #else /* not MSDOS */
10476 printf ("Abort (and dump core)? (y or n) ");
10477 #endif /* not MSDOS */
10479 if (((c
= getchar ()) & ~040) == 'Y')
10481 while (c
!= '\n') c
= getchar ();
10483 printf ("\r\nContinuing...\r\n");
10484 #else /* not MSDOS */
10485 printf ("Continuing...\n");
10486 #endif /* not MSDOS */
10488 init_all_sys_modes ();
10492 /* If executing a function that wants to be interrupted out of
10493 and the user has not deferred quitting by binding `inhibit-quit'
10494 then quit right away. */
10495 if (immediate_quit
&& NILP (Vinhibit_quit
))
10497 struct gl_state_s saved
;
10498 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
10500 immediate_quit
= 0;
10501 pthread_sigmask (SIG_SETMASK
, &empty_mask
, 0);
10503 GCPRO4 (saved
.object
, saved
.global_code
,
10504 saved
.current_syntax_table
, saved
.old_prop
);
10505 Fsignal (Qquit
, Qnil
);
10510 { /* Else request quit when it's safe. */
10511 int count
= NILP (Vquit_flag
) ? 1 : force_quit_count
+ 1;
10512 force_quit_count
= count
;
10515 immediate_quit
= 1;
10516 Vinhibit_quit
= Qnil
;
10522 pthread_sigmask (SIG_SETMASK
, &empty_mask
, 0);
10524 /* TODO: The longjmp in this call throws the NS event loop integration off,
10525 and it seems to do fine without this. Probably some attention
10526 needs to be paid to the setting of waiting_for_input in
10527 wait_reading_process_output() under HAVE_NS because of the call
10528 to ns_select there (needed because otherwise events aren't picked up
10529 outside of polling since we don't get SIGIO like X and we don't have a
10530 separate event loop thread like W32. */
10532 if (waiting_for_input
&& !echoing
)
10533 quit_throw_to_read_char (in_signal_handler
);
10537 /* Handle a C-g by making read_char return C-g. */
10540 quit_throw_to_read_char (bool from_signal
)
10542 /* When not called from a signal handler it is safe to call
10544 if (!from_signal
&& EQ (Vquit_flag
, Qkill_emacs
))
10545 Fkill_emacs (Qnil
);
10547 /* Prevent another signal from doing this before we finish. */
10548 clear_waiting_for_input ();
10551 Vunread_command_events
= Qnil
;
10553 if (FRAMEP (internal_last_event_frame
)
10554 && !EQ (internal_last_event_frame
, selected_frame
))
10555 do_switch_frame (make_lispy_switch_frame (internal_last_event_frame
),
10558 sys_longjmp (getcjmp
, 1);
10561 DEFUN ("set-input-interrupt-mode", Fset_input_interrupt_mode
,
10562 Sset_input_interrupt_mode
, 1, 1, 0,
10563 doc
: /* Set interrupt mode of reading keyboard input.
10564 If INTERRUPT is non-nil, Emacs will use input interrupts;
10565 otherwise Emacs uses CBREAK mode.
10567 See also `current-input-mode'. */)
10568 (Lisp_Object interrupt
)
10570 bool new_interrupt_input
;
10571 #ifdef USABLE_SIGIO
10572 #ifdef HAVE_X_WINDOWS
10573 if (x_display_list
!= NULL
)
10575 /* When using X, don't give the user a real choice,
10576 because we haven't implemented the mechanisms to support it. */
10577 new_interrupt_input
= 1;
10580 #endif /* HAVE_X_WINDOWS */
10581 new_interrupt_input
= !NILP (interrupt
);
10582 #else /* not USABLE_SIGIO */
10583 new_interrupt_input
= 0;
10584 #endif /* not USABLE_SIGIO */
10586 if (new_interrupt_input
!= interrupt_input
)
10588 #ifdef POLL_FOR_INPUT
10592 /* this causes startup screen to be restored and messes with the mouse */
10593 reset_all_sys_modes ();
10594 interrupt_input
= new_interrupt_input
;
10595 init_all_sys_modes ();
10597 interrupt_input
= new_interrupt_input
;
10600 #ifdef POLL_FOR_INPUT
10601 poll_suppress_count
= 1;
10608 DEFUN ("set-output-flow-control", Fset_output_flow_control
, Sset_output_flow_control
, 1, 2, 0,
10609 doc
: /* Enable or disable ^S/^Q flow control for output to TERMINAL.
10610 If FLOW is non-nil, flow control is enabled and you cannot use C-s or
10611 C-q in key sequences.
10613 This setting only has an effect on tty terminals and only when
10614 Emacs reads input in CBREAK mode; see `set-input-interrupt-mode'.
10616 See also `current-input-mode'. */)
10617 (Lisp_Object flow
, Lisp_Object terminal
)
10619 struct terminal
*t
= decode_tty_terminal (terminal
);
10620 struct tty_display_info
*tty
;
10624 tty
= t
->display_info
.tty
;
10626 if (tty
->flow_control
!= !NILP (flow
))
10629 /* This causes startup screen to be restored and messes with the mouse. */
10630 reset_sys_modes (tty
);
10633 tty
->flow_control
= !NILP (flow
);
10636 init_sys_modes (tty
);
10642 DEFUN ("set-input-meta-mode", Fset_input_meta_mode
, Sset_input_meta_mode
, 1, 2, 0,
10643 doc
: /* Enable or disable 8-bit input on TERMINAL.
10644 If META is t, Emacs will accept 8-bit input, and interpret the 8th
10645 bit as the Meta modifier.
10647 If META is nil, Emacs will ignore the top bit, on the assumption it is
10650 Otherwise, Emacs will accept and pass through 8-bit input without
10651 specially interpreting the top bit.
10653 This setting only has an effect on tty terminal devices.
10655 Optional parameter TERMINAL specifies the tty terminal device to use.
10656 It may be a terminal object, a frame, or nil for the terminal used by
10657 the currently selected frame.
10659 See also `current-input-mode'. */)
10660 (Lisp_Object meta
, Lisp_Object terminal
)
10662 struct terminal
*t
= decode_tty_terminal (terminal
);
10663 struct tty_display_info
*tty
;
10668 tty
= t
->display_info
.tty
;
10672 else if (EQ (meta
, Qt
))
10677 if (tty
->meta_key
!= new_meta
)
10680 /* this causes startup screen to be restored and messes with the mouse */
10681 reset_sys_modes (tty
);
10684 tty
->meta_key
= new_meta
;
10687 init_sys_modes (tty
);
10693 DEFUN ("set-quit-char", Fset_quit_char
, Sset_quit_char
, 1, 1, 0,
10694 doc
: /* Specify character used for quitting.
10695 QUIT must be an ASCII character.
10697 This function only has an effect on the controlling tty of the Emacs
10700 See also `current-input-mode'. */)
10703 struct terminal
*t
= get_named_terminal ("/dev/tty");
10704 struct tty_display_info
*tty
;
10708 tty
= t
->display_info
.tty
;
10710 if (NILP (quit
) || !INTEGERP (quit
) || XINT (quit
) < 0 || XINT (quit
) > 0400)
10711 error ("QUIT must be an ASCII character");
10714 /* this causes startup screen to be restored and messes with the mouse */
10715 reset_sys_modes (tty
);
10718 /* Don't let this value be out of range. */
10719 quit_char
= XINT (quit
) & (tty
->meta_key
== 0 ? 0177 : 0377);
10722 init_sys_modes (tty
);
10728 DEFUN ("set-input-mode", Fset_input_mode
, Sset_input_mode
, 3, 4, 0,
10729 doc
: /* Set mode of reading keyboard input.
10730 First arg INTERRUPT non-nil means use input interrupts;
10731 nil means use CBREAK mode.
10732 Second arg FLOW non-nil means use ^S/^Q flow control for output to terminal
10733 (no effect except in CBREAK mode).
10734 Third arg META t means accept 8-bit input (for a Meta key).
10735 META nil means ignore the top bit, on the assumption it is parity.
10736 Otherwise, accept 8-bit input and don't use the top bit for Meta.
10737 Optional fourth arg QUIT if non-nil specifies character to use for quitting.
10738 See also `current-input-mode'. */)
10739 (Lisp_Object interrupt
, Lisp_Object flow
, Lisp_Object meta
, Lisp_Object quit
)
10741 Fset_input_interrupt_mode (interrupt
);
10742 Fset_output_flow_control (flow
, Qnil
);
10743 Fset_input_meta_mode (meta
, Qnil
);
10745 Fset_quit_char (quit
);
10749 DEFUN ("current-input-mode", Fcurrent_input_mode
, Scurrent_input_mode
, 0, 0, 0,
10750 doc
: /* Return information about the way Emacs currently reads keyboard input.
10751 The value is a list of the form (INTERRUPT FLOW META QUIT), where
10752 INTERRUPT is non-nil if Emacs is using interrupt-driven input; if
10753 nil, Emacs is using CBREAK mode.
10754 FLOW is non-nil if Emacs uses ^S/^Q flow control for output to the
10755 terminal; this does not apply if Emacs uses interrupt-driven input.
10756 META is t if accepting 8-bit input with 8th bit as Meta flag.
10757 META nil means ignoring the top bit, on the assumption it is parity.
10758 META is neither t nor nil if accepting 8-bit input and using
10759 all 8 bits as the character code.
10760 QUIT is the character Emacs currently uses to quit.
10761 The elements of this list correspond to the arguments of
10762 `set-input-mode'. */)
10765 struct frame
*sf
= XFRAME (selected_frame
);
10767 Lisp_Object interrupt
= interrupt_input
? Qt
: Qnil
;
10768 Lisp_Object flow
, meta
;
10769 if (FRAME_TERMCAP_P (sf
) || FRAME_MSDOS_P (sf
))
10771 flow
= FRAME_TTY (sf
)->flow_control
? Qt
: Qnil
;
10772 meta
= (FRAME_TTY (sf
)->meta_key
== 2
10774 : (CURTTY ()->meta_key
== 1 ? Qt
: Qnil
));
10781 Lisp_Object quit
= make_number (quit_char
);
10783 return list4 (interrupt
, flow
, meta
, quit
);
10786 DEFUN ("posn-at-x-y", Fposn_at_x_y
, Sposn_at_x_y
, 2, 4, 0,
10787 doc
: /* Return position information for pixel coordinates X and Y.
10788 By default, X and Y are relative to text area of the selected window.
10789 Optional third arg FRAME-OR-WINDOW non-nil specifies frame or window.
10790 If optional fourth arg WHOLE is non-nil, X is relative to the left
10791 edge of the window.
10793 The return value is similar to a mouse click position:
10794 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
10795 IMAGE (DX . DY) (WIDTH . HEIGHT))
10796 The `posn-' functions access elements of such lists. */)
10797 (Lisp_Object x
, Lisp_Object y
, Lisp_Object frame_or_window
, Lisp_Object whole
)
10800 /* We allow X of -1, for the newline in a R2L line that overflowed
10801 into the left fringe. */
10802 if (XINT (x
) != -1)
10806 if (NILP (frame_or_window
))
10807 frame_or_window
= selected_window
;
10809 if (WINDOWP (frame_or_window
))
10811 struct window
*w
= decode_live_window (frame_or_window
);
10813 XSETINT (x
, (XINT (x
)
10814 + WINDOW_LEFT_EDGE_X (w
)
10816 ? window_box_left_offset (w
, TEXT_AREA
)
10818 XSETINT (y
, WINDOW_TO_FRAME_PIXEL_Y (w
, XINT (y
)));
10819 frame_or_window
= w
->frame
;
10822 CHECK_LIVE_FRAME (frame_or_window
);
10824 return make_lispy_position (XFRAME (frame_or_window
), x
, y
, 0);
10827 DEFUN ("posn-at-point", Fposn_at_point
, Sposn_at_point
, 0, 2, 0,
10828 doc
: /* Return position information for buffer POS in WINDOW.
10829 POS defaults to point in WINDOW; WINDOW defaults to the selected window.
10831 Return nil if position is not visible in window. Otherwise,
10832 the return value is similar to that returned by `event-start' for
10833 a mouse click at the upper left corner of the glyph corresponding
10834 to the given buffer position:
10835 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
10836 IMAGE (DX . DY) (WIDTH . HEIGHT))
10837 The `posn-' functions access elements of such lists. */)
10838 (Lisp_Object pos
, Lisp_Object window
)
10843 window
= selected_window
;
10845 tem
= Fpos_visible_in_window_p (pos
, window
, Qt
);
10848 Lisp_Object x
= XCAR (tem
);
10849 Lisp_Object y
= XCAR (XCDR (tem
));
10851 /* Point invisible due to hscrolling? X can be -1 when a
10852 newline in a R2L line overflows into the left fringe. */
10855 tem
= Fposn_at_x_y (x
, y
, window
, Qnil
);
10861 /* Set up a new kboard object with reasonable initial values.
10862 TYPE is a window system for which this keyboard is used. */
10865 init_kboard (KBOARD
*kb
, Lisp_Object type
)
10867 kset_overriding_terminal_local_map (kb
, Qnil
);
10868 kset_last_command (kb
, Qnil
);
10869 kset_real_last_command (kb
, Qnil
);
10870 kset_keyboard_translate_table (kb
, Qnil
);
10871 kset_last_repeatable_command (kb
, Qnil
);
10872 kset_prefix_arg (kb
, Qnil
);
10873 kset_last_prefix_arg (kb
, Qnil
);
10874 kset_kbd_queue (kb
, Qnil
);
10875 kb
->kbd_queue_has_data
= 0;
10876 kb
->immediate_echo
= 0;
10877 kset_echo_string (kb
, Qnil
);
10878 kb
->echo_after_prompt
= -1;
10879 kb
->kbd_macro_buffer
= 0;
10880 kb
->kbd_macro_bufsize
= 0;
10881 kset_defining_kbd_macro (kb
, Qnil
);
10882 kset_last_kbd_macro (kb
, Qnil
);
10883 kb
->reference_count
= 0;
10884 kset_system_key_alist (kb
, Qnil
);
10885 kset_system_key_syms (kb
, Qnil
);
10886 kset_window_system (kb
, type
);
10887 kset_input_decode_map (kb
, Fmake_sparse_keymap (Qnil
));
10888 kset_local_function_key_map (kb
, Fmake_sparse_keymap (Qnil
));
10889 Fset_keymap_parent (KVAR (kb
, Vlocal_function_key_map
), Vfunction_key_map
);
10890 kset_default_minibuffer_frame (kb
, Qnil
);
10893 /* Allocate and basically initialize keyboard
10894 object to use with window system TYPE. */
10897 allocate_kboard (Lisp_Object type
)
10899 KBOARD
*kb
= xmalloc (sizeof *kb
);
10901 init_kboard (kb
, type
);
10902 kb
->next_kboard
= all_kboards
;
10908 * Destroy the contents of a kboard object, but not the object itself.
10909 * We use this just before deleting it, or if we're going to initialize
10910 * it a second time.
10913 wipe_kboard (KBOARD
*kb
)
10915 xfree (kb
->kbd_macro_buffer
);
10918 /* Free KB and memory referenced from it. */
10921 delete_kboard (KBOARD
*kb
)
10925 for (kbp
= &all_kboards
; *kbp
!= kb
; kbp
= &(*kbp
)->next_kboard
)
10928 *kbp
= kb
->next_kboard
;
10930 /* Prevent a dangling reference to KB. */
10931 if (kb
== current_kboard
10932 && FRAMEP (selected_frame
)
10933 && FRAME_LIVE_P (XFRAME (selected_frame
)))
10935 current_kboard
= FRAME_KBOARD (XFRAME (selected_frame
));
10937 if (current_kboard
== kb
)
10946 init_keyboard (void)
10948 /* This is correct before outermost invocation of the editor loop. */
10949 command_loop_level
= -1;
10950 immediate_quit
= 0;
10951 quit_char
= Ctl ('g');
10952 Vunread_command_events
= Qnil
;
10953 timer_idleness_start_time
= invalid_timespec ();
10955 recent_keys_index
= 0;
10956 kbd_fetch_ptr
= kbd_buffer
;
10957 kbd_store_ptr
= kbd_buffer
;
10958 do_mouse_tracking
= Qnil
;
10960 interrupt_input_blocked
= 0;
10961 pending_signals
= 0;
10963 /* This means that command_loop_1 won't try to select anything the first
10965 internal_last_event_frame
= Qnil
;
10966 Vlast_event_frame
= internal_last_event_frame
;
10968 current_kboard
= initial_kboard
;
10969 /* Re-initialize the keyboard again. */
10970 wipe_kboard (current_kboard
);
10971 /* A value of nil for Vwindow_system normally means a tty, but we also use
10972 it for the initial terminal since there is no window system there. */
10973 init_kboard (current_kboard
, Qnil
);
10975 if (!noninteractive
)
10977 /* Before multi-tty support, these handlers used to be installed
10978 only if the current session was a tty session. Now an Emacs
10979 session may have multiple display types, so we always handle
10980 SIGINT. There is special code in handle_interrupt_signal to exit
10981 Emacs on SIGINT when there are no termcap frames on the
10982 controlling terminal. */
10983 struct sigaction action
;
10984 emacs_sigaction_init (&action
, deliver_interrupt_signal
);
10985 sigaction (SIGINT
, &action
, 0);
10987 /* For systems with SysV TERMIO, C-g is set up for both SIGINT and
10988 SIGQUIT and we can't tell which one it will give us. */
10989 sigaction (SIGQUIT
, &action
, 0);
10990 #endif /* not DOS_NT */
10992 #ifdef USABLE_SIGIO
10993 if (!noninteractive
)
10995 struct sigaction action
;
10996 emacs_sigaction_init (&action
, deliver_input_available_signal
);
10997 sigaction (SIGIO
, &action
, 0);
11001 /* Use interrupt input by default, if it works and noninterrupt input
11002 has deficiencies. */
11004 #ifdef INTERRUPT_INPUT
11005 interrupt_input
= 1;
11007 interrupt_input
= 0;
11010 pthread_sigmask (SIG_SETMASK
, &empty_mask
, 0);
11013 if (keyboard_init_hook
)
11014 (*keyboard_init_hook
) ();
11016 #ifdef POLL_FOR_INPUT
11018 poll_suppress_count
= 1;
11023 /* This type's only use is in syms_of_keyboard, to put properties on the
11024 event header symbols. */
11031 static const struct event_head head_table
[] = {
11032 {SYMBOL_INDEX (Qmouse_movement
), SYMBOL_INDEX (Qmouse_movement
)},
11033 {SYMBOL_INDEX (Qscroll_bar_movement
), SYMBOL_INDEX (Qmouse_movement
)},
11035 /* Some of the event heads. */
11036 {SYMBOL_INDEX (Qswitch_frame
), SYMBOL_INDEX (Qswitch_frame
)},
11038 {SYMBOL_INDEX (Qfocus_in
), SYMBOL_INDEX (Qfocus_in
)},
11039 {SYMBOL_INDEX (Qfocus_out
), SYMBOL_INDEX (Qfocus_out
)},
11040 {SYMBOL_INDEX (Qdelete_frame
), SYMBOL_INDEX (Qdelete_frame
)},
11041 {SYMBOL_INDEX (Qiconify_frame
), SYMBOL_INDEX (Qiconify_frame
)},
11042 {SYMBOL_INDEX (Qmake_frame_visible
), SYMBOL_INDEX (Qmake_frame_visible
)},
11043 /* `select-window' should be handled just like `switch-frame'
11044 in read_key_sequence. */
11045 {SYMBOL_INDEX (Qselect_window
), SYMBOL_INDEX (Qswitch_frame
)}
11049 syms_of_keyboard (void)
11051 pending_funcalls
= Qnil
;
11052 staticpro (&pending_funcalls
);
11054 Vlispy_mouse_stem
= build_pure_c_string ("mouse");
11055 staticpro (&Vlispy_mouse_stem
);
11057 regular_top_level_message
= build_pure_c_string ("Back to top level");
11058 #ifdef HAVE_STACK_OVERFLOW_HANDLING
11059 recover_top_level_message
11060 = build_pure_c_string ("Re-entering top level after C stack overflow");
11062 DEFVAR_LISP ("internal--top-level-message", Vinternal__top_level_message
,
11063 doc
: /* Message displayed by `normal-top-level'. */);
11064 Vinternal__top_level_message
= regular_top_level_message
;
11067 DEFSYM (QCimage
, ":image");
11068 DEFSYM (Qhelp_echo
, "help-echo");
11069 DEFSYM (QCrtl
, ":rtl");
11071 staticpro (&item_properties
);
11072 item_properties
= Qnil
;
11074 staticpro (&tool_bar_item_properties
);
11075 tool_bar_item_properties
= Qnil
;
11076 staticpro (&tool_bar_items_vector
);
11077 tool_bar_items_vector
= Qnil
;
11079 DEFSYM (Qtimer_event_handler
, "timer-event-handler");
11081 /* Non-nil disable property on a command means do not execute it;
11082 call disabled-command-function's value instead. */
11083 DEFSYM (Qdisabled
, "disabled");
11085 DEFSYM (Qundefined
, "undefined");
11087 /* Hooks to run before and after each command. */
11088 DEFSYM (Qpre_command_hook
, "pre-command-hook");
11089 DEFSYM (Qpost_command_hook
, "post-command-hook");
11091 DEFSYM (Qundo_auto__add_boundary
, "undo-auto--add-boundary");
11093 DEFSYM (Qdeferred_action_function
, "deferred-action-function");
11094 DEFSYM (Qdelayed_warnings_hook
, "delayed-warnings-hook");
11095 DEFSYM (Qfunction_key
, "function-key");
11097 /* The values of Qevent_kind properties. */
11098 DEFSYM (Qmouse_click
, "mouse-click");
11100 DEFSYM (Qdrag_n_drop
, "drag-n-drop");
11101 DEFSYM (Qsave_session
, "save-session");
11102 DEFSYM (Qconfig_changed_event
, "config-changed-event");
11104 /* Menu and tool bar item parts. */
11105 DEFSYM (Qmenu_enable
, "menu-enable");
11108 DEFSYM (Qlanguage_change
, "language-change");
11112 DEFSYM (Qdbus_event
, "dbus-event");
11115 #ifdef USE_FILE_NOTIFY
11116 DEFSYM (Qfile_notify
, "file-notify");
11117 #endif /* USE_FILE_NOTIFY */
11119 /* Menu and tool bar item parts. */
11120 DEFSYM (QCenable
, ":enable");
11121 DEFSYM (QCvisible
, ":visible");
11122 DEFSYM (QChelp
, ":help");
11123 DEFSYM (QCfilter
, ":filter");
11124 DEFSYM (QCbutton
, ":button");
11125 DEFSYM (QCkeys
, ":keys");
11126 DEFSYM (QCkey_sequence
, ":key-sequence");
11128 /* Non-nil disable property on a command means
11129 do not execute it; call disabled-command-function's value instead. */
11130 DEFSYM (QCtoggle
, ":toggle");
11131 DEFSYM (QCradio
, ":radio");
11132 DEFSYM (QClabel
, ":label");
11133 DEFSYM (QCvert_only
, ":vert-only");
11135 /* Symbols to use for parts of windows. */
11136 DEFSYM (Qvertical_line
, "vertical-line");
11137 DEFSYM (Qright_divider
, "right-divider");
11138 DEFSYM (Qbottom_divider
, "bottom-divider");
11140 DEFSYM (Qmouse_fixup_help_message
, "mouse-fixup-help-message");
11142 DEFSYM (Qabove_handle
, "above-handle");
11143 DEFSYM (Qhandle
, "handle");
11144 DEFSYM (Qbelow_handle
, "below-handle");
11145 DEFSYM (Qup
, "up");
11146 DEFSYM (Qdown
, "down");
11147 DEFSYM (Qtop
, "top");
11148 DEFSYM (Qbottom
, "bottom");
11149 DEFSYM (Qend_scroll
, "end-scroll");
11150 DEFSYM (Qratio
, "ratio");
11151 DEFSYM (Qbefore_handle
, "before-handle");
11152 DEFSYM (Qhorizontal_handle
, "horizontal-handle");
11153 DEFSYM (Qafter_handle
, "after-handle");
11154 DEFSYM (Qleft
, "left");
11155 DEFSYM (Qright
, "right");
11156 DEFSYM (Qleftmost
, "leftmost");
11157 DEFSYM (Qrightmost
, "rightmost");
11159 /* Properties of event headers. */
11160 DEFSYM (Qevent_kind
, "event-kind");
11161 DEFSYM (Qevent_symbol_elements
, "event-symbol-elements");
11163 /* An event header symbol HEAD may have a property named
11164 Qevent_symbol_element_mask, which is of the form (BASE MODIFIERS);
11165 BASE is the base, unmodified version of HEAD, and MODIFIERS is the
11166 mask of modifiers applied to it. If present, this is used to help
11167 speed up parse_modifiers. */
11168 DEFSYM (Qevent_symbol_element_mask
, "event-symbol-element-mask");
11170 /* An unmodified event header BASE may have a property named
11171 Qmodifier_cache, which is an alist mapping modifier masks onto
11172 modified versions of BASE. If present, this helps speed up
11173 apply_modifiers. */
11174 DEFSYM (Qmodifier_cache
, "modifier-cache");
11176 DEFSYM (Qrecompute_lucid_menubar
, "recompute-lucid-menubar");
11177 DEFSYM (Qactivate_menubar_hook
, "activate-menubar-hook");
11179 DEFSYM (Qpolling_period
, "polling-period");
11181 DEFSYM (Qgui_set_selection
, "gui-set-selection");
11183 /* The primary selection. */
11184 DEFSYM (QPRIMARY
, "PRIMARY");
11186 DEFSYM (Qhandle_switch_frame
, "handle-switch-frame");
11187 DEFSYM (Qhandle_select_window
, "handle-select-window");
11189 DEFSYM (Qinput_method_exit_on_first_char
, "input-method-exit-on-first-char");
11190 DEFSYM (Qinput_method_use_echo_area
, "input-method-use-echo-area");
11192 DEFSYM (Qhelp_form_show
, "help-form-show");
11194 DEFSYM (Qecho_keystrokes
, "echo-keystrokes");
11196 Fset (Qinput_method_exit_on_first_char
, Qnil
);
11197 Fset (Qinput_method_use_echo_area
, Qnil
);
11199 /* Symbols to head events. */
11200 DEFSYM (Qmouse_movement
, "mouse-movement");
11201 DEFSYM (Qscroll_bar_movement
, "scroll-bar-movement");
11202 DEFSYM (Qswitch_frame
, "switch-frame");
11203 DEFSYM (Qfocus_in
, "focus-in");
11204 DEFSYM (Qfocus_out
, "focus-out");
11205 DEFSYM (Qdelete_frame
, "delete-frame");
11206 DEFSYM (Qiconify_frame
, "iconify-frame");
11207 DEFSYM (Qmake_frame_visible
, "make-frame-visible");
11208 DEFSYM (Qselect_window
, "select-window");
11212 for (i
= 0; i
< ARRAYELTS (head_table
); i
++)
11214 const struct event_head
*p
= &head_table
[i
];
11215 Lisp_Object var
= builtin_lisp_symbol (p
->var
);
11216 Lisp_Object kind
= builtin_lisp_symbol (p
->kind
);
11217 Fput (var
, Qevent_kind
, kind
);
11218 Fput (var
, Qevent_symbol_elements
, list1 (var
));
11222 button_down_location
= Fmake_vector (make_number (5), Qnil
);
11223 staticpro (&button_down_location
);
11224 mouse_syms
= Fmake_vector (make_number (5), Qnil
);
11225 staticpro (&mouse_syms
);
11226 wheel_syms
= Fmake_vector (make_number (ARRAYELTS (lispy_wheel_names
)),
11228 staticpro (&wheel_syms
);
11232 int len
= ARRAYELTS (modifier_names
);
11234 modifier_symbols
= Fmake_vector (make_number (len
), Qnil
);
11235 for (i
= 0; i
< len
; i
++)
11236 if (modifier_names
[i
])
11237 ASET (modifier_symbols
, i
, intern_c_string (modifier_names
[i
]));
11238 staticpro (&modifier_symbols
);
11241 recent_keys
= Fmake_vector (make_number (NUM_RECENT_KEYS
), Qnil
);
11242 staticpro (&recent_keys
);
11244 this_command_keys
= Fmake_vector (make_number (40), Qnil
);
11245 staticpro (&this_command_keys
);
11247 raw_keybuf
= Fmake_vector (make_number (30), Qnil
);
11248 staticpro (&raw_keybuf
);
11250 DEFSYM (Qcommand_execute
, "command-execute");
11252 accent_key_syms
= Qnil
;
11253 staticpro (&accent_key_syms
);
11255 func_key_syms
= Qnil
;
11256 staticpro (&func_key_syms
);
11258 drag_n_drop_syms
= Qnil
;
11259 staticpro (&drag_n_drop_syms
);
11261 unread_switch_frame
= Qnil
;
11262 staticpro (&unread_switch_frame
);
11264 internal_last_event_frame
= Qnil
;
11265 staticpro (&internal_last_event_frame
);
11267 read_key_sequence_cmd
= Qnil
;
11268 staticpro (&read_key_sequence_cmd
);
11269 read_key_sequence_remapped
= Qnil
;
11270 staticpro (&read_key_sequence_remapped
);
11272 menu_bar_one_keymap_changed_items
= Qnil
;
11273 staticpro (&menu_bar_one_keymap_changed_items
);
11275 menu_bar_items_vector
= Qnil
;
11276 staticpro (&menu_bar_items_vector
);
11278 help_form_saved_window_configs
= Qnil
;
11279 staticpro (&help_form_saved_window_configs
);
11281 defsubr (&Scurrent_idle_time
);
11282 defsubr (&Sevent_symbol_parse_modifiers
);
11283 defsubr (&Sevent_convert_list
);
11284 defsubr (&Sread_key_sequence
);
11285 defsubr (&Sread_key_sequence_vector
);
11286 defsubr (&Srecursive_edit
);
11287 defsubr (&Strack_mouse
);
11288 defsubr (&Sinput_pending_p
);
11289 defsubr (&Srecent_keys
);
11290 defsubr (&Sthis_command_keys
);
11291 defsubr (&Sthis_command_keys_vector
);
11292 defsubr (&Sthis_single_command_keys
);
11293 defsubr (&Sthis_single_command_raw_keys
);
11294 defsubr (&Sreset_this_command_lengths
);
11295 defsubr (&Sclear_this_command_keys
);
11296 defsubr (&Ssuspend_emacs
);
11297 defsubr (&Sabort_recursive_edit
);
11298 defsubr (&Sexit_recursive_edit
);
11299 defsubr (&Srecursion_depth
);
11300 defsubr (&Scommand_error_default_function
);
11301 defsubr (&Stop_level
);
11302 defsubr (&Sdiscard_input
);
11303 defsubr (&Sopen_dribble_file
);
11304 defsubr (&Sset_input_interrupt_mode
);
11305 defsubr (&Sset_output_flow_control
);
11306 defsubr (&Sset_input_meta_mode
);
11307 defsubr (&Sset_quit_char
);
11308 defsubr (&Sset_input_mode
);
11309 defsubr (&Scurrent_input_mode
);
11310 defsubr (&Sposn_at_point
);
11311 defsubr (&Sposn_at_x_y
);
11313 DEFVAR_LISP ("last-command-event", last_command_event
,
11314 doc
: /* Last input event that was part of a command. */);
11316 DEFVAR_LISP ("last-nonmenu-event", last_nonmenu_event
,
11317 doc
: /* Last input event in a command, except for mouse menu events.
11318 Mouse menus give back keys that don't look like mouse events;
11319 this variable holds the actual mouse event that led to the menu,
11320 so that you can determine whether the command was run by mouse or not. */);
11322 DEFVAR_LISP ("last-input-event", last_input_event
,
11323 doc
: /* Last input event. */);
11325 DEFVAR_LISP ("unread-command-events", Vunread_command_events
,
11326 doc
: /* List of events to be read as the command input.
11327 These events are processed first, before actual keyboard input.
11328 Events read from this list are not normally added to `this-command-keys',
11329 as they will already have been added once as they were read for the first time.
11330 An element of the form (t . EVENT) forces EVENT to be added to that list. */);
11331 Vunread_command_events
= Qnil
;
11333 DEFVAR_LISP ("unread-post-input-method-events", Vunread_post_input_method_events
,
11334 doc
: /* List of events to be processed as input by input methods.
11335 These events are processed before `unread-command-events'
11336 and actual keyboard input, but are not given to `input-method-function'. */);
11337 Vunread_post_input_method_events
= Qnil
;
11339 DEFVAR_LISP ("unread-input-method-events", Vunread_input_method_events
,
11340 doc
: /* List of events to be processed as input by input methods.
11341 These events are processed after `unread-command-events', but
11342 before actual keyboard input.
11343 If there's an active input method, the events are given to
11344 `input-method-function'. */);
11345 Vunread_input_method_events
= Qnil
;
11347 DEFVAR_LISP ("meta-prefix-char", meta_prefix_char
,
11348 doc
: /* Meta-prefix character code.
11349 Meta-foo as command input turns into this character followed by foo. */);
11350 XSETINT (meta_prefix_char
, 033);
11352 DEFVAR_KBOARD ("last-command", Vlast_command
,
11353 doc
: /* The last command executed.
11354 Normally a symbol with a function definition, but can be whatever was found
11355 in the keymap, or whatever the variable `this-command' was set to by that
11358 The value `mode-exit' is special; it means that the previous command
11359 read an event that told it to exit, and it did so and unread that event.
11360 In other words, the present command is the event that made the previous
11363 The value `kill-region' is special; it means that the previous command
11364 was a kill command.
11366 `last-command' has a separate binding for each terminal device.
11367 See Info node `(elisp)Multiple Terminals'. */);
11369 DEFVAR_KBOARD ("real-last-command", Vreal_last_command
,
11370 doc
: /* Same as `last-command', but never altered by Lisp code.
11371 Taken from the previous value of `real-this-command'. */);
11373 DEFVAR_KBOARD ("last-repeatable-command", Vlast_repeatable_command
,
11374 doc
: /* Last command that may be repeated.
11375 The last command executed that was not bound to an input event.
11376 This is the command `repeat' will try to repeat.
11377 Taken from a previous value of `real-this-command'. */);
11379 DEFVAR_LISP ("this-command", Vthis_command
,
11380 doc
: /* The command now being executed.
11381 The command can set this variable; whatever is put here
11382 will be in `last-command' during the following command. */);
11383 Vthis_command
= Qnil
;
11385 DEFVAR_LISP ("real-this-command", Vreal_this_command
,
11386 doc
: /* This is like `this-command', except that commands should never modify it. */);
11387 Vreal_this_command
= Qnil
;
11389 DEFVAR_LISP ("this-command-keys-shift-translated",
11390 Vthis_command_keys_shift_translated
,
11391 doc
: /* Non-nil if the key sequence activating this command was shift-translated.
11392 Shift-translation occurs when there is no binding for the key sequence
11393 as entered, but a binding was found by changing an upper-case letter
11394 to lower-case, or a shifted function key to an unshifted one. */);
11395 Vthis_command_keys_shift_translated
= Qnil
;
11397 DEFVAR_LISP ("this-original-command", Vthis_original_command
,
11398 doc
: /* The command bound to the current key sequence before remapping.
11399 It equals `this-command' if the original command was not remapped through
11400 any of the active keymaps. Otherwise, the value of `this-command' is the
11401 result of looking up the original command in the active keymaps. */);
11402 Vthis_original_command
= Qnil
;
11404 DEFVAR_INT ("auto-save-interval", auto_save_interval
,
11405 doc
: /* Number of input events between auto-saves.
11406 Zero means disable autosaving due to number of characters typed. */);
11407 auto_save_interval
= 300;
11409 DEFVAR_LISP ("auto-save-timeout", Vauto_save_timeout
,
11410 doc
: /* Number of seconds idle time before auto-save.
11411 Zero or nil means disable auto-saving due to idleness.
11412 After auto-saving due to this many seconds of idle time,
11413 Emacs also does a garbage collection if that seems to be warranted. */);
11414 XSETFASTINT (Vauto_save_timeout
, 30);
11416 DEFVAR_LISP ("echo-keystrokes", Vecho_keystrokes
,
11417 doc
: /* Nonzero means echo unfinished commands after this many seconds of pause.
11418 The value may be integer or floating point.
11419 If the value is zero, don't echo at all. */);
11420 Vecho_keystrokes
= make_number (1);
11422 DEFVAR_INT ("polling-period", polling_period
,
11423 doc
: /* Interval between polling for input during Lisp execution.
11424 The reason for polling is to make C-g work to stop a running program.
11425 Polling is needed only when using X windows and SIGIO does not work.
11426 Polling is automatically disabled in all other cases. */);
11427 polling_period
= 2;
11429 DEFVAR_LISP ("double-click-time", Vdouble_click_time
,
11430 doc
: /* Maximum time between mouse clicks to make a double-click.
11431 Measured in milliseconds. The value nil means disable double-click
11432 recognition; t means double-clicks have no time limit and are detected
11433 by position only. */);
11434 Vdouble_click_time
= make_number (500);
11436 DEFVAR_INT ("double-click-fuzz", double_click_fuzz
,
11437 doc
: /* Maximum mouse movement between clicks to make a double-click.
11438 On window-system frames, value is the number of pixels the mouse may have
11439 moved horizontally or vertically between two clicks to make a double-click.
11440 On non window-system frames, value is interpreted in units of 1/8 characters
11443 This variable is also the threshold for motion of the mouse
11444 to count as a drag. */);
11445 double_click_fuzz
= 3;
11447 DEFVAR_INT ("num-input-keys", num_input_keys
,
11448 doc
: /* Number of complete key sequences read as input so far.
11449 This includes key sequences read from keyboard macros.
11450 The number is effectively the number of interactive command invocations. */);
11451 num_input_keys
= 0;
11453 DEFVAR_INT ("num-nonmacro-input-events", num_nonmacro_input_events
,
11454 doc
: /* Number of input events read from the keyboard so far.
11455 This does not include events generated by keyboard macros. */);
11456 num_nonmacro_input_events
= 0;
11458 DEFVAR_LISP ("last-event-frame", Vlast_event_frame
,
11459 doc
: /* The frame in which the most recently read event occurred.
11460 If the last event came from a keyboard macro, this is set to `macro'. */);
11461 Vlast_event_frame
= Qnil
;
11463 /* This variable is set up in sysdep.c. */
11464 DEFVAR_LISP ("tty-erase-char", Vtty_erase_char
,
11465 doc
: /* The ERASE character as set by the user with stty. */);
11467 DEFVAR_LISP ("help-char", Vhelp_char
,
11468 doc
: /* Character to recognize as meaning Help.
11469 When it is read, do `(eval help-form)', and display result if it's a string.
11470 If the value of `help-form' is nil, this char can be read normally. */);
11471 XSETINT (Vhelp_char
, Ctl ('H'));
11473 DEFVAR_LISP ("help-event-list", Vhelp_event_list
,
11474 doc
: /* List of input events to recognize as meaning Help.
11475 These work just like the value of `help-char' (see that). */);
11476 Vhelp_event_list
= Qnil
;
11478 DEFVAR_LISP ("help-form", Vhelp_form
,
11479 doc
: /* Form to execute when character `help-char' is read.
11480 If the form returns a string, that string is displayed.
11481 If `help-form' is nil, the help char is not recognized. */);
11484 DEFVAR_LISP ("prefix-help-command", Vprefix_help_command
,
11485 doc
: /* Command to run when `help-char' character follows a prefix key.
11486 This command is used only when there is no actual binding
11487 for that character after that prefix key. */);
11488 Vprefix_help_command
= Qnil
;
11490 DEFVAR_LISP ("top-level", Vtop_level
,
11491 doc
: /* Form to evaluate when Emacs starts up.
11492 Useful to set before you dump a modified Emacs. */);
11494 XSYMBOL (Qtop_level
)->declared_special
= false;
11496 DEFVAR_KBOARD ("keyboard-translate-table", Vkeyboard_translate_table
,
11497 doc
: /* Translate table for local keyboard input, or nil.
11498 If non-nil, the value should be a char-table. Each character read
11499 from the keyboard is looked up in this char-table. If the value found
11500 there is non-nil, then it is used instead of the actual input character.
11502 The value can also be a string or vector, but this is considered obsolete.
11503 If it is a string or vector of length N, character codes N and up are left
11504 untranslated. In a vector, an element which is nil means "no translation".
11506 This is applied to the characters supplied to input methods, not their
11507 output. See also `translation-table-for-input'.
11509 This variable has a separate binding for each terminal.
11510 See Info node `(elisp)Multiple Terminals'. */);
11512 DEFVAR_BOOL ("cannot-suspend", cannot_suspend
,
11513 doc
: /* Non-nil means to always spawn a subshell instead of suspending.
11514 \(Even if the operating system has support for stopping a process.\) */);
11515 cannot_suspend
= 0;
11517 DEFVAR_BOOL ("menu-prompting", menu_prompting
,
11518 doc
: /* Non-nil means prompt with menus when appropriate.
11519 This is done when reading from a keymap that has a prompt string,
11520 for elements that have prompt strings.
11521 The menu is displayed on the screen
11522 if X menus were enabled at configuration
11523 time and the previous event was a mouse click prefix key.
11524 Otherwise, menu prompting uses the echo area. */);
11525 menu_prompting
= 1;
11527 DEFVAR_LISP ("menu-prompt-more-char", menu_prompt_more_char
,
11528 doc
: /* Character to see next line of menu prompt.
11529 Type this character while in a menu prompt to rotate around the lines of it. */);
11530 XSETINT (menu_prompt_more_char
, ' ');
11532 DEFVAR_INT ("extra-keyboard-modifiers", extra_keyboard_modifiers
,
11533 doc
: /* A mask of additional modifier keys to use with every keyboard character.
11534 Emacs applies the modifiers of the character stored here to each keyboard
11535 character it reads. For example, after evaluating the expression
11536 (setq extra-keyboard-modifiers ?\\C-x)
11537 all input characters will have the control modifier applied to them.
11539 Note that the character ?\\C-@, equivalent to the integer zero, does
11540 not count as a control character; rather, it counts as a character
11541 with no modifiers; thus, setting `extra-keyboard-modifiers' to zero
11542 cancels any modification. */);
11543 extra_keyboard_modifiers
= 0;
11545 DEFSYM (Qdeactivate_mark
, "deactivate-mark");
11546 DEFVAR_LISP ("deactivate-mark", Vdeactivate_mark
,
11547 doc
: /* If an editing command sets this to t, deactivate the mark afterward.
11548 The command loop sets this to nil before each command,
11549 and tests the value when the command returns.
11550 Buffer modification stores t in this variable. */);
11551 Vdeactivate_mark
= Qnil
;
11552 Fmake_variable_buffer_local (Qdeactivate_mark
);
11554 DEFVAR_LISP ("pre-command-hook", Vpre_command_hook
,
11555 doc
: /* Normal hook run before each command is executed.
11556 If an unhandled error happens in running this hook,
11557 the function in which the error occurred is unconditionally removed, since
11558 otherwise the error might happen repeatedly and make Emacs nonfunctional. */);
11559 Vpre_command_hook
= Qnil
;
11561 DEFVAR_LISP ("post-command-hook", Vpost_command_hook
,
11562 doc
: /* Normal hook run after each command is executed.
11563 If an unhandled error happens in running this hook,
11564 the function in which the error occurred is unconditionally removed, since
11565 otherwise the error might happen repeatedly and make Emacs nonfunctional. */);
11566 Vpost_command_hook
= Qnil
;
11569 DEFVAR_LISP ("echo-area-clear-hook", ...,
11570 doc
: /* Normal hook run when clearing the echo area. */);
11572 DEFSYM (Qecho_area_clear_hook
, "echo-area-clear-hook");
11573 Fset (Qecho_area_clear_hook
, Qnil
);
11575 DEFVAR_LISP ("lucid-menu-bar-dirty-flag", Vlucid_menu_bar_dirty_flag
,
11576 doc
: /* Non-nil means menu bar, specified Lucid style, needs to be recomputed. */);
11577 Vlucid_menu_bar_dirty_flag
= Qnil
;
11579 DEFVAR_LISP ("menu-bar-final-items", Vmenu_bar_final_items
,
11580 doc
: /* List of menu bar items to move to the end of the menu bar.
11581 The elements of the list are event types that may have menu bar bindings. */);
11582 Vmenu_bar_final_items
= Qnil
;
11584 DEFVAR_LISP ("tool-bar-separator-image-expression", Vtool_bar_separator_image_expression
,
11585 doc
: /* Expression evaluating to the image spec for a tool-bar separator.
11586 This is used internally by graphical displays that do not render
11587 tool-bar separators natively. Otherwise it is unused (e.g. on GTK). */);
11588 Vtool_bar_separator_image_expression
= Qnil
;
11590 DEFVAR_KBOARD ("overriding-terminal-local-map",
11591 Voverriding_terminal_local_map
,
11592 doc
: /* Per-terminal keymap that takes precedence over all other keymaps.
11593 This variable is intended to let commands such as `universal-argument'
11594 set up a different keymap for reading the next command.
11596 `overriding-terminal-local-map' has a separate binding for each
11597 terminal device. See Info node `(elisp)Multiple Terminals'. */);
11599 DEFVAR_LISP ("overriding-local-map", Voverriding_local_map
,
11600 doc
: /* Keymap that replaces (overrides) local keymaps.
11601 If this variable is non-nil, Emacs looks up key bindings in this
11602 keymap INSTEAD OF the keymap char property, minor mode maps, and the
11603 buffer's local map. Hence, the only active keymaps would be
11604 `overriding-terminal-local-map', this keymap, and `global-keymap', in
11605 order of precedence. */);
11606 Voverriding_local_map
= Qnil
;
11608 DEFVAR_LISP ("overriding-local-map-menu-flag", Voverriding_local_map_menu_flag
,
11609 doc
: /* Non-nil means `overriding-local-map' applies to the menu bar.
11610 Otherwise, the menu bar continues to reflect the buffer's local map
11611 and the minor mode maps regardless of `overriding-local-map'. */);
11612 Voverriding_local_map_menu_flag
= Qnil
;
11614 DEFVAR_LISP ("special-event-map", Vspecial_event_map
,
11615 doc
: /* Keymap defining bindings for special events to execute at low level. */);
11616 Vspecial_event_map
= list1 (Qkeymap
);
11618 DEFVAR_LISP ("track-mouse", do_mouse_tracking
,
11619 doc
: /* Non-nil means generate motion events for mouse motion. */);
11621 DEFVAR_KBOARD ("system-key-alist", Vsystem_key_alist
,
11622 doc
: /* Alist of system-specific X windows key symbols.
11623 Each element should have the form (N . SYMBOL) where N is the
11624 numeric keysym code (sans the \"system-specific\" bit 1<<28)
11625 and SYMBOL is its name.
11627 `system-key-alist' has a separate binding for each terminal device.
11628 See Info node `(elisp)Multiple Terminals'. */);
11630 DEFVAR_KBOARD ("local-function-key-map", Vlocal_function_key_map
,
11631 doc
: /* Keymap that translates key sequences to key sequences during input.
11632 This is used mainly for mapping key sequences into some preferred
11633 key events (symbols).
11635 The `read-key-sequence' function replaces any subsequence bound by
11636 `local-function-key-map' with its binding. More precisely, when the
11637 active keymaps have no binding for the current key sequence but
11638 `local-function-key-map' binds a suffix of the sequence to a vector or
11639 string, `read-key-sequence' replaces the matching suffix with its
11640 binding, and continues with the new sequence.
11642 If the binding is a function, it is called with one argument (the prompt)
11643 and its return value (a key sequence) is used.
11645 The events that come from bindings in `local-function-key-map' are not
11646 themselves looked up in `local-function-key-map'.
11648 For example, suppose `local-function-key-map' binds `ESC O P' to [f1].
11649 Typing `ESC O P' to `read-key-sequence' would return [f1]. Typing
11650 `C-x ESC O P' would return [?\\C-x f1]. If [f1] were a prefix key,
11651 typing `ESC O P x' would return [f1 x].
11653 `local-function-key-map' has a separate binding for each terminal
11654 device. See Info node `(elisp)Multiple Terminals'. If you need to
11655 define a binding on all terminals, change `function-key-map'
11656 instead. Initially, `local-function-key-map' is an empty keymap that
11657 has `function-key-map' as its parent on all terminal devices. */);
11659 DEFVAR_KBOARD ("input-decode-map", Vinput_decode_map
,
11660 doc
: /* Keymap that decodes input escape sequences.
11661 This is used mainly for mapping ASCII function key sequences into
11662 real Emacs function key events (symbols).
11664 The `read-key-sequence' function replaces any subsequence bound by
11665 `input-decode-map' with its binding. Contrary to `function-key-map',
11666 this map applies its rebinding regardless of the presence of an ordinary
11667 binding. So it is more like `key-translation-map' except that it applies
11668 before `function-key-map' rather than after.
11670 If the binding is a function, it is called with one argument (the prompt)
11671 and its return value (a key sequence) is used.
11673 The events that come from bindings in `input-decode-map' are not
11674 themselves looked up in `input-decode-map'. */);
11676 DEFVAR_LISP ("function-key-map", Vfunction_key_map
,
11677 doc
: /* The parent keymap of all `local-function-key-map' instances.
11678 Function key definitions that apply to all terminal devices should go
11679 here. If a mapping is defined in both the current
11680 `local-function-key-map' binding and this variable, then the local
11681 definition will take precedence. */);
11682 Vfunction_key_map
= Fmake_sparse_keymap (Qnil
);
11684 DEFVAR_LISP ("key-translation-map", Vkey_translation_map
,
11685 doc
: /* Keymap of key translations that can override keymaps.
11686 This keymap works like `input-decode-map', but comes after `function-key-map'.
11687 Another difference is that it is global rather than terminal-local. */);
11688 Vkey_translation_map
= Fmake_sparse_keymap (Qnil
);
11690 DEFVAR_LISP ("deferred-action-list", Vdeferred_action_list
,
11691 doc
: /* List of deferred actions to be performed at a later time.
11692 The precise format isn't relevant here; we just check whether it is nil. */);
11693 Vdeferred_action_list
= Qnil
;
11695 DEFVAR_LISP ("deferred-action-function", Vdeferred_action_function
,
11696 doc
: /* Function to call to handle deferred actions, after each command.
11697 This function is called with no arguments after each command
11698 whenever `deferred-action-list' is non-nil. */);
11699 Vdeferred_action_function
= Qnil
;
11701 DEFVAR_LISP ("delayed-warnings-list", Vdelayed_warnings_list
,
11702 doc
: /* List of warnings to be displayed after this command.
11703 Each element must be a list (TYPE MESSAGE [LEVEL [BUFFER-NAME]]),
11704 as per the args of `display-warning' (which see).
11705 If this variable is non-nil, `delayed-warnings-hook' will be run
11706 immediately after running `post-command-hook'. */);
11707 Vdelayed_warnings_list
= Qnil
;
11709 DEFVAR_LISP ("timer-list", Vtimer_list
,
11710 doc
: /* List of active absolute time timers in order of increasing time. */);
11711 Vtimer_list
= Qnil
;
11713 DEFVAR_LISP ("timer-idle-list", Vtimer_idle_list
,
11714 doc
: /* List of active idle-time timers in order of increasing time. */);
11715 Vtimer_idle_list
= Qnil
;
11717 DEFVAR_LISP ("input-method-function", Vinput_method_function
,
11718 doc
: /* If non-nil, the function that implements the current input method.
11719 It's called with one argument, a printing character that was just read.
11720 \(That means a character with code 040...0176.)
11721 Typically this function uses `read-event' to read additional events.
11722 When it does so, it should first bind `input-method-function' to nil
11723 so it will not be called recursively.
11725 The function should return a list of zero or more events
11726 to be used as input. If it wants to put back some events
11727 to be reconsidered, separately, by the input method,
11728 it can add them to the beginning of `unread-command-events'.
11730 The input method function can find in `input-method-previous-message'
11731 the previous echo area message.
11733 The input method function should refer to the variables
11734 `input-method-use-echo-area' and `input-method-exit-on-first-char'
11735 for guidance on what to do. */);
11736 Vinput_method_function
= Qlist
;
11738 DEFVAR_LISP ("input-method-previous-message",
11739 Vinput_method_previous_message
,
11740 doc
: /* When `input-method-function' is called, hold the previous echo area message.
11741 This variable exists because `read-event' clears the echo area
11742 before running the input method. It is nil if there was no message. */);
11743 Vinput_method_previous_message
= Qnil
;
11745 DEFVAR_LISP ("show-help-function", Vshow_help_function
,
11746 doc
: /* If non-nil, the function that implements the display of help.
11747 It's called with one argument, the help string to display. */);
11748 Vshow_help_function
= Qnil
;
11750 DEFVAR_LISP ("disable-point-adjustment", Vdisable_point_adjustment
,
11751 doc
: /* If non-nil, suppress point adjustment after executing a command.
11753 After a command is executed, if point is moved into a region that has
11754 special properties (e.g. composition, display), we adjust point to
11755 the boundary of the region. But, when a command sets this variable to
11756 non-nil, we suppress the point adjustment.
11758 This variable is set to nil before reading a command, and is checked
11759 just after executing the command. */);
11760 Vdisable_point_adjustment
= Qnil
;
11762 DEFVAR_LISP ("global-disable-point-adjustment",
11763 Vglobal_disable_point_adjustment
,
11764 doc
: /* If non-nil, always suppress point adjustment.
11766 The default value is nil, in which case, point adjustment are
11767 suppressed only after special commands that set
11768 `disable-point-adjustment' (which see) to non-nil. */);
11769 Vglobal_disable_point_adjustment
= Qnil
;
11771 DEFVAR_LISP ("minibuffer-message-timeout", Vminibuffer_message_timeout
,
11772 doc
: /* How long to display an echo-area message when the minibuffer is active.
11773 If the value is not a number, such messages don't time out. */);
11774 Vminibuffer_message_timeout
= make_number (2);
11776 DEFVAR_LISP ("throw-on-input", Vthrow_on_input
,
11777 doc
: /* If non-nil, any keyboard input throws to this symbol.
11778 The value of that variable is passed to `quit-flag' and later causes a
11779 peculiar kind of quitting. */);
11780 Vthrow_on_input
= Qnil
;
11782 DEFVAR_LISP ("command-error-function", Vcommand_error_function
,
11783 doc
: /* Function to output error messages.
11784 Called with three arguments:
11785 - the error data, a list of the form (SIGNALED-CONDITION . SIGNAL-DATA)
11786 such as what `condition-case' would bind its variable to,
11787 - the context (a string which normally goes at the start of the message),
11788 - the Lisp function within which the error was signaled. */);
11789 Vcommand_error_function
= intern ("command-error-default-function");
11791 DEFVAR_LISP ("enable-disabled-menus-and-buttons",
11792 Venable_disabled_menus_and_buttons
,
11793 doc
: /* If non-nil, don't ignore events produced by disabled menu items and tool-bar.
11795 Help functions bind this to allow help on disabled menu items
11796 and tool-bar buttons. */);
11797 Venable_disabled_menus_and_buttons
= Qnil
;
11799 DEFVAR_LISP ("select-active-regions",
11800 Vselect_active_regions
,
11801 doc
: /* If non-nil, an active region automatically sets the primary selection.
11802 If the value is `only', only temporarily active regions (usually made
11803 by mouse-dragging or shift-selection) set the window selection.
11805 This takes effect only when Transient Mark mode is enabled. */);
11806 Vselect_active_regions
= Qt
;
11808 DEFVAR_LISP ("saved-region-selection",
11809 Vsaved_region_selection
,
11810 doc
: /* Contents of active region prior to buffer modification.
11811 If `select-active-regions' is non-nil, Emacs sets this to the
11812 text in the region before modifying the buffer. The next call to
11813 the function `deactivate-mark' uses this to set the window selection. */);
11814 Vsaved_region_selection
= Qnil
;
11816 DEFVAR_LISP ("selection-inhibit-update-commands",
11817 Vselection_inhibit_update_commands
,
11818 doc
: /* List of commands which should not update the selection.
11819 Normally, if `select-active-regions' is non-nil and the mark remains
11820 active after a command (i.e. the mark was not deactivated), the Emacs
11821 command loop sets the selection to the text in the region. However,
11822 if the command is in this list, the selection is not updated. */);
11823 Vselection_inhibit_update_commands
11824 = list2 (Qhandle_switch_frame
, Qhandle_select_window
);
11826 DEFVAR_LISP ("debug-on-event",
11828 doc
: /* Enter debugger on this event. When Emacs
11829 receives the special event specified by this variable, it will try to
11830 break into the debugger as soon as possible instead of processing the
11831 event normally through `special-event-map'.
11833 Currently, the only supported values for this
11834 variable are `sigusr1' and `sigusr2'. */);
11835 Vdebug_on_event
= intern_c_string ("sigusr2");
11837 /* Create the initial keyboard. Qt means 'unset'. */
11838 initial_kboard
= allocate_kboard (Qt
);
11842 keys_of_keyboard (void)
11844 initial_define_key (global_map
, Ctl ('Z'), "suspend-emacs");
11845 initial_define_key (control_x_map
, Ctl ('Z'), "suspend-emacs");
11846 initial_define_key (meta_map
, Ctl ('C'), "exit-recursive-edit");
11847 initial_define_key (global_map
, Ctl (']'), "abort-recursive-edit");
11848 initial_define_key (meta_map
, 'x', "execute-extended-command");
11850 initial_define_lispy_key (Vspecial_event_map
, "delete-frame",
11851 "handle-delete-frame");
11852 initial_define_lispy_key (Vspecial_event_map
, "ns-put-working-text",
11853 "ns-put-working-text");
11854 initial_define_lispy_key (Vspecial_event_map
, "ns-unput-working-text",
11855 "ns-unput-working-text");
11856 /* Here we used to use `ignore-event' which would simple set prefix-arg to
11857 current-prefix-arg, as is done in `handle-switch-frame'.
11858 But `handle-switch-frame is not run from the special-map.
11859 Commands from that map are run in a special way that automatically
11860 preserves the prefix-arg. Restoring the prefix arg here is not just
11861 redundant but harmful:
11863 - current-prefix-arg is set to non-nil, prefix-arg is set to nil.
11864 - after the first prompt, the exit-minibuffer-hook is run which may
11865 iconify a frame and thus push a `iconify-frame' event.
11866 - after running exit-minibuffer-hook, current-prefix-arg is
11867 restored to the non-nil value it had before the prompt.
11868 - we enter the second prompt.
11869 current-prefix-arg is non-nil, prefix-arg is nil.
11870 - before running the first real event, we run the special iconify-frame
11871 event, but we pass the `special' arg to command-execute so
11872 current-prefix-arg and prefix-arg are left untouched.
11873 - here we foolishly copy the non-nil current-prefix-arg to prefix-arg.
11874 - the next key event will have a spuriously non-nil current-prefix-arg. */
11875 initial_define_lispy_key (Vspecial_event_map
, "iconify-frame",
11877 initial_define_lispy_key (Vspecial_event_map
, "make-frame-visible",
11879 /* Handling it at such a low-level causes read_key_sequence to get
11880 * confused because it doesn't realize that the current_buffer was
11881 * changed by read_char.
11883 * initial_define_lispy_key (Vspecial_event_map, "select-window",
11884 * "handle-select-window"); */
11885 initial_define_lispy_key (Vspecial_event_map
, "save-session",
11886 "handle-save-session");
11889 /* Define a special event which is raised for dbus callback
11891 initial_define_lispy_key (Vspecial_event_map
, "dbus-event",
11892 "dbus-handle-event");
11895 #ifdef USE_FILE_NOTIFY
11896 /* Define a special event which is raised for notification callback
11898 initial_define_lispy_key (Vspecial_event_map
, "file-notify",
11899 "file-notify-handle-event");
11900 #endif /* USE_FILE_NOTIFY */
11902 initial_define_lispy_key (Vspecial_event_map
, "config-changed-event",
11904 #if defined (WINDOWSNT)
11905 initial_define_lispy_key (Vspecial_event_map
, "language-change",
11908 initial_define_lispy_key (Vspecial_event_map
, "focus-in",
11909 "handle-focus-in");
11910 initial_define_lispy_key (Vspecial_event_map
, "focus-out",
11911 "handle-focus-out");
11914 /* Mark the pointers in the kboard objects.
11915 Called by Fgarbage_collect. */
11917 mark_kboards (void)
11921 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
11923 if (kb
->kbd_macro_buffer
)
11924 for (p
= kb
->kbd_macro_buffer
; p
< kb
->kbd_macro_ptr
; p
++)
11926 mark_object (KVAR (kb
, Voverriding_terminal_local_map
));
11927 mark_object (KVAR (kb
, Vlast_command
));
11928 mark_object (KVAR (kb
, Vreal_last_command
));
11929 mark_object (KVAR (kb
, Vkeyboard_translate_table
));
11930 mark_object (KVAR (kb
, Vlast_repeatable_command
));
11931 mark_object (KVAR (kb
, Vprefix_arg
));
11932 mark_object (KVAR (kb
, Vlast_prefix_arg
));
11933 mark_object (KVAR (kb
, kbd_queue
));
11934 mark_object (KVAR (kb
, defining_kbd_macro
));
11935 mark_object (KVAR (kb
, Vlast_kbd_macro
));
11936 mark_object (KVAR (kb
, Vsystem_key_alist
));
11937 mark_object (KVAR (kb
, system_key_syms
));
11938 mark_object (KVAR (kb
, Vwindow_system
));
11939 mark_object (KVAR (kb
, Vinput_decode_map
));
11940 mark_object (KVAR (kb
, Vlocal_function_key_map
));
11941 mark_object (KVAR (kb
, Vdefault_minibuffer_frame
));
11942 mark_object (KVAR (kb
, echo_string
));
11945 union buffered_input_event
*event
;
11946 for (event
= kbd_fetch_ptr
; event
!= kbd_store_ptr
; event
++)
11948 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
11949 event
= kbd_buffer
;
11950 /* These two special event types has no Lisp_Objects to mark. */
11951 if (event
->kind
!= SELECTION_REQUEST_EVENT
11952 && event
->kind
!= SELECTION_CLEAR_EVENT
)
11954 mark_object (event
->ie
.x
);
11955 mark_object (event
->ie
.y
);
11956 mark_object (event
->ie
.frame_or_window
);
11957 mark_object (event
->ie
.arg
);