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 struct 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 struct 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 struct 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 clear_event (struct input_event
*);
376 static void restore_kboard_configuration (int);
378 static void deliver_input_available_signal (int signo
);
380 static void handle_interrupt (bool);
381 static _Noreturn
void quit_throw_to_read_char (bool);
382 static void process_special_events (void);
383 static void timer_start_idle (void);
384 static void timer_stop_idle (void);
385 static void timer_resume_idle (void);
386 static void deliver_user_signal (int);
387 static char *find_user_signal_name (int);
388 static void store_user_signal_events (void);
390 /* These setters are used only in this file, so they can be private. */
392 kset_echo_string (struct kboard
*kb
, Lisp_Object val
)
394 kb
->INTERNAL_FIELD (echo_string
) = val
;
397 kset_kbd_queue (struct kboard
*kb
, Lisp_Object val
)
399 kb
->INTERNAL_FIELD (kbd_queue
) = val
;
402 kset_keyboard_translate_table (struct kboard
*kb
, Lisp_Object val
)
404 kb
->INTERNAL_FIELD (Vkeyboard_translate_table
) = val
;
407 kset_last_prefix_arg (struct kboard
*kb
, Lisp_Object val
)
409 kb
->INTERNAL_FIELD (Vlast_prefix_arg
) = val
;
412 kset_last_repeatable_command (struct kboard
*kb
, Lisp_Object val
)
414 kb
->INTERNAL_FIELD (Vlast_repeatable_command
) = val
;
417 kset_local_function_key_map (struct kboard
*kb
, Lisp_Object val
)
419 kb
->INTERNAL_FIELD (Vlocal_function_key_map
) = val
;
422 kset_overriding_terminal_local_map (struct kboard
*kb
, Lisp_Object val
)
424 kb
->INTERNAL_FIELD (Voverriding_terminal_local_map
) = val
;
427 kset_real_last_command (struct kboard
*kb
, Lisp_Object val
)
429 kb
->INTERNAL_FIELD (Vreal_last_command
) = val
;
432 kset_system_key_syms (struct kboard
*kb
, Lisp_Object val
)
434 kb
->INTERNAL_FIELD (system_key_syms
) = val
;
438 /* Add C to the echo string, without echoing it immediately. C can be
439 a character, which is pretty-printed, or a symbol, whose name is
443 echo_add_key (Lisp_Object c
)
445 char initbuf
[KEY_DESCRIPTION_SIZE
+ 100];
446 ptrdiff_t size
= sizeof initbuf
;
447 char *buffer
= initbuf
;
449 Lisp_Object echo_string
;
452 echo_string
= KVAR (current_kboard
, echo_string
);
454 /* If someone has passed us a composite event, use its head symbol. */
458 ptr
= push_key_description (XINT (c
), ptr
);
459 else if (SYMBOLP (c
))
461 Lisp_Object name
= SYMBOL_NAME (c
);
462 ptrdiff_t nbytes
= SBYTES (name
);
464 if (size
- (ptr
- buffer
) < nbytes
)
466 ptrdiff_t offset
= ptr
- buffer
;
467 size
= max (2 * size
, size
+ nbytes
);
468 buffer
= SAFE_ALLOCA (size
);
469 ptr
= buffer
+ offset
;
472 ptr
+= copy_text (SDATA (name
), (unsigned char *) ptr
, nbytes
,
473 STRING_MULTIBYTE (name
), 1);
476 if ((NILP (echo_string
) || SCHARS (echo_string
) == 0)
479 static const char text
[] = " (Type ? for further options)";
480 int len
= sizeof text
- 1;
482 if (size
- (ptr
- buffer
) < len
)
484 ptrdiff_t offset
= ptr
- buffer
;
486 buffer
= SAFE_ALLOCA (size
);
487 ptr
= buffer
+ offset
;
490 memcpy (ptr
, text
, len
);
494 /* Replace a dash from echo_dash with a space, otherwise add a space
495 at the end as a separator between keys. */
496 AUTO_STRING (space
, " ");
497 if (STRINGP (echo_string
) && SCHARS (echo_string
) > 1)
499 Lisp_Object last_char
, prev_char
, idx
;
501 idx
= make_number (SCHARS (echo_string
) - 2);
502 prev_char
= Faref (echo_string
, idx
);
504 idx
= make_number (SCHARS (echo_string
) - 1);
505 last_char
= Faref (echo_string
, idx
);
507 /* We test PREV_CHAR to make sure this isn't the echoing of a
509 if (XINT (last_char
) == '-' && XINT (prev_char
) != ' ')
510 Faset (echo_string
, idx
, make_number (' '));
512 echo_string
= concat2 (echo_string
, space
);
514 else if (STRINGP (echo_string
) && SCHARS (echo_string
) > 0)
515 echo_string
= concat2 (echo_string
, space
);
519 concat2 (echo_string
, make_string (buffer
, ptr
- buffer
)));
523 /* Add C to the echo string, if echoing is going on. C can be a
524 character or a symbol. */
527 echo_char (Lisp_Object c
)
529 if (current_kboard
->immediate_echo
)
536 /* Temporarily add a dash to the end of the echo string if it's not
537 empty, so that it serves as a mini-prompt for the very next
543 /* Do nothing if not echoing at all. */
544 if (NILP (KVAR (current_kboard
, echo_string
)))
547 if (this_command_key_count
== 0)
550 if (!current_kboard
->immediate_echo
551 && SCHARS (KVAR (current_kboard
, echo_string
)) == 0)
554 /* Do nothing if we just printed a prompt. */
555 if (current_kboard
->echo_after_prompt
556 == SCHARS (KVAR (current_kboard
, echo_string
)))
559 /* Do nothing if we have already put a dash at the end. */
560 if (SCHARS (KVAR (current_kboard
, echo_string
)) > 1)
562 Lisp_Object last_char
, prev_char
, idx
;
564 idx
= make_number (SCHARS (KVAR (current_kboard
, echo_string
)) - 2);
565 prev_char
= Faref (KVAR (current_kboard
, echo_string
), idx
);
567 idx
= make_number (SCHARS (KVAR (current_kboard
, echo_string
)) - 1);
568 last_char
= Faref (KVAR (current_kboard
, echo_string
), idx
);
570 if (XINT (last_char
) == '-' && XINT (prev_char
) != ' ')
574 /* Put a dash at the end of the buffer temporarily,
575 but make it go away when the next character is added. */
576 AUTO_STRING (dash
, "-");
577 kset_echo_string (current_kboard
,
578 concat2 (KVAR (current_kboard
, echo_string
), dash
));
582 /* Display the current echo string, and begin echoing if not already
588 if (!current_kboard
->immediate_echo
)
591 current_kboard
->immediate_echo
= 1;
593 for (i
= 0; i
< this_command_key_count
; i
++)
597 /* Set before_command_echo_length to the value that would
598 have been saved before the start of this subcommand in
599 command_loop_1, if we had already been echoing then. */
600 if (i
== this_single_command_key_start
)
601 before_command_echo_length
= echo_length ();
603 c
= AREF (this_command_keys
, i
);
604 if (! (EVENT_HAS_PARAMETERS (c
)
605 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
609 /* Set before_command_echo_length to the value that would
610 have been saved before the start of this subcommand in
611 command_loop_1, if we had already been echoing then. */
612 if (this_command_key_count
== this_single_command_key_start
)
613 before_command_echo_length
= echo_length ();
615 /* Put a dash at the end to invite the user to type more. */
620 /* FIXME: Use call (Qmessage) so it can be advised (e.g. emacspeak). */
621 message3_nolog (KVAR (current_kboard
, echo_string
));
624 /* Record in what buffer we echoed, and from which kboard. */
625 echo_message_buffer
= echo_area_buffer
[0];
626 echo_kboard
= current_kboard
;
628 if (waiting_for_input
&& !NILP (Vquit_flag
))
629 quit_throw_to_read_char (0);
632 /* Turn off echoing, for the start of a new command. */
635 cancel_echoing (void)
637 current_kboard
->immediate_echo
= 0;
638 current_kboard
->echo_after_prompt
= -1;
639 kset_echo_string (current_kboard
, Qnil
);
640 ok_to_echo_at_next_pause
= NULL
;
642 echo_message_buffer
= Qnil
;
645 /* Return the length of the current echo string. */
650 return (STRINGP (KVAR (current_kboard
, echo_string
))
651 ? SCHARS (KVAR (current_kboard
, echo_string
))
655 /* Truncate the current echo message to its first LEN chars.
656 This and echo_char get used by read_key_sequence when the user
657 switches frames while entering a key sequence. */
660 echo_truncate (ptrdiff_t nchars
)
662 if (STRINGP (KVAR (current_kboard
, echo_string
)))
663 kset_echo_string (current_kboard
,
664 Fsubstring (KVAR (current_kboard
, echo_string
),
665 make_number (0), make_number (nchars
)));
666 truncate_echo_area (nchars
);
670 /* Functions for manipulating this_command_keys. */
672 add_command_key (Lisp_Object key
)
674 #if 0 /* Not needed after we made Freset_this_command_lengths
675 do the job immediately. */
676 /* If reset-this-command-length was called recently, obey it now.
677 See the doc string of that function for an explanation of why. */
678 if (before_command_restore_flag
)
680 this_command_key_count
= before_command_key_count_1
;
681 if (this_command_key_count
< this_single_command_key_start
)
682 this_single_command_key_start
= this_command_key_count
;
683 echo_truncate (before_command_echo_length_1
);
684 before_command_restore_flag
= 0;
688 if (this_command_key_count
>= ASIZE (this_command_keys
))
689 this_command_keys
= larger_vector (this_command_keys
, 1, -1);
691 ASET (this_command_keys
, this_command_key_count
, key
);
692 ++this_command_key_count
;
697 recursive_edit_1 (void)
699 ptrdiff_t count
= SPECPDL_INDEX ();
702 if (command_loop_level
> 0)
704 specbind (Qstandard_output
, Qt
);
705 specbind (Qstandard_input
, Qt
);
708 #ifdef HAVE_WINDOW_SYSTEM
709 /* The command loop has started an hourglass timer, so we have to
710 cancel it here, otherwise it will fire because the recursive edit
711 can take some time. Do not check for display_hourglass_p here,
712 because it could already be nil. */
716 /* This function may have been called from a debugger called from
717 within redisplay, for instance by Edebugging a function called
718 from fontification-functions. We want to allow redisplay in
719 the debugging session.
721 The recursive edit is left with a `(throw exit ...)'. The `exit'
722 tag is not caught anywhere in redisplay, i.e. when we leave the
723 recursive edit, the original redisplay leading to the recursive
724 edit will be unwound. The outcome should therefore be safe. */
725 specbind (Qinhibit_redisplay
, Qnil
);
728 val
= command_loop ();
730 Fsignal (Qquit
, Qnil
);
731 /* Handle throw from read_minibuf when using minibuffer
732 while it's active but we're in another window. */
734 xsignal1 (Qerror
, val
);
736 return unbind_to (count
, Qnil
);
739 /* When an auto-save happens, record the "time", and don't do again soon. */
742 record_auto_save (void)
744 last_auto_save
= num_nonmacro_input_events
;
747 /* Make an auto save happen as soon as possible at command level. */
751 force_auto_save_soon (void)
753 last_auto_save
= - auto_save_interval
- 1;
755 record_asynch_buffer_change ();
759 DEFUN ("recursive-edit", Frecursive_edit
, Srecursive_edit
, 0, 0, "",
760 doc
: /* Invoke the editor command loop recursively.
761 To get out of the recursive edit, a command can throw to `exit' -- for
762 instance `(throw 'exit nil)'.
763 If you throw a value other than t, `recursive-edit' returns normally
764 to the function that called it. Throwing a t value causes
765 `recursive-edit' to quit, so that control returns to the command loop
768 This function is called by the editor initialization to begin editing. */)
771 ptrdiff_t count
= SPECPDL_INDEX ();
774 /* If we enter while input is blocked, don't lock up here.
775 This may happen through the debugger during redisplay. */
776 if (input_blocked_p ())
779 if (command_loop_level
>= 0
780 && current_buffer
!= XBUFFER (XWINDOW (selected_window
)->contents
))
781 buffer
= Fcurrent_buffer ();
785 /* Don't do anything interesting between the increment and the
786 record_unwind_protect! Otherwise, we could get distracted and
787 never decrement the counter again. */
788 command_loop_level
++;
789 update_mode_lines
= 17;
790 record_unwind_protect (recursive_edit_unwind
, buffer
);
792 /* If we leave recursive_edit_1 below with a `throw' for instance,
793 like it is done in the splash screen display, we have to
794 make sure that we restore single_kboard as command_loop_1
795 would have done if it were left normally. */
796 if (command_loop_level
> 0)
797 temporarily_switch_to_single_kboard (SELECTED_FRAME ());
800 return unbind_to (count
, Qnil
);
804 recursive_edit_unwind (Lisp_Object buffer
)
806 if (BUFFERP (buffer
))
807 Fset_buffer (buffer
);
809 command_loop_level
--;
810 update_mode_lines
= 18;
814 #if 0 /* These two functions are now replaced with
815 temporarily_switch_to_single_kboard. */
819 #if 0 /* Theory: if there's anything in Vunread_command_events,
820 it will right away be read by read_key_sequence,
821 and then if we do switch KBOARDS, it will go into the side
822 queue then. So we don't need to do anything special here -- rms. */
823 if (CONSP (Vunread_command_events
))
825 current_kboard
->kbd_queue
826 = nconc2 (Vunread_command_events
, current_kboard
->kbd_queue
);
827 current_kboard
->kbd_queue_has_data
= 1;
829 Vunread_command_events
= Qnil
;
834 /* Switch to the single-kboard state, making current_kboard
835 the only KBOARD from which further input is accepted. */
838 single_kboard_state ()
844 /* If we're in single_kboard state for kboard KBOARD,
848 not_single_kboard_state (KBOARD
*kboard
)
850 if (kboard
== current_kboard
)
854 /* Maintain a stack of kboards, so other parts of Emacs
855 can switch temporarily to the kboard of a given frame
856 and then revert to the previous status. */
861 struct kboard_stack
*next
;
864 static struct kboard_stack
*kboard_stack
;
867 push_kboard (struct kboard
*k
)
869 struct kboard_stack
*p
= xmalloc (sizeof *p
);
871 p
->next
= kboard_stack
;
872 p
->kboard
= current_kboard
;
882 struct kboard_stack
*p
= kboard_stack
;
884 for (t
= terminal_list
; t
; t
= t
->next_terminal
)
886 if (t
->kboard
== p
->kboard
)
888 current_kboard
= p
->kboard
;
895 /* The terminal we remembered has been deleted. */
896 current_kboard
= FRAME_KBOARD (SELECTED_FRAME ());
899 kboard_stack
= p
->next
;
903 /* Switch to single_kboard mode, making current_kboard the only KBOARD
904 from which further input is accepted. If F is non-nil, set its
905 KBOARD as the current keyboard.
907 This function uses record_unwind_protect_int to return to the previous
910 If Emacs is already in single_kboard mode, and F's keyboard is
911 locked, then this function will throw an error. */
914 temporarily_switch_to_single_kboard (struct frame
*f
)
916 bool was_locked
= single_kboard
;
919 if (f
!= NULL
&& FRAME_KBOARD (f
) != current_kboard
)
920 /* We can not switch keyboards while in single_kboard mode.
921 In rare cases, Lisp code may call `recursive-edit' (or
922 `read-minibuffer' or `y-or-n-p') after it switched to a
923 locked frame. For example, this is likely to happen
924 when server.el connects to a new terminal while Emacs is in
925 single_kboard mode. It is best to throw an error instead
926 of presenting the user with a frozen screen. */
927 error ("Terminal %d is locked, cannot read from it",
928 FRAME_TERMINAL (f
)->id
);
930 /* This call is unnecessary, but helps
931 `restore_kboard_configuration' discover if somebody changed
932 `current_kboard' behind our back. */
933 push_kboard (current_kboard
);
936 current_kboard
= FRAME_KBOARD (f
);
938 record_unwind_protect_int (restore_kboard_configuration
, was_locked
);
941 #if 0 /* This function is not needed anymore. */
943 record_single_kboard_state ()
946 push_kboard (current_kboard
);
947 record_unwind_protect_int (restore_kboard_configuration
, single_kboard
);
952 restore_kboard_configuration (int was_locked
)
954 single_kboard
= was_locked
;
957 struct kboard
*prev
= current_kboard
;
959 /* The pop should not change the kboard. */
960 if (single_kboard
&& current_kboard
!= prev
)
966 /* Handle errors that are not handled at inner levels
967 by printing an error message and returning to the editor command loop. */
970 cmd_error (Lisp_Object data
)
972 Lisp_Object old_level
, old_length
;
973 char macroerror
[sizeof "After..kbd macro iterations: "
974 + INT_STRLEN_BOUND (EMACS_INT
)];
976 #ifdef HAVE_WINDOW_SYSTEM
977 if (display_hourglass_p
)
981 if (!NILP (executing_kbd_macro
))
983 if (executing_kbd_macro_iterations
== 1)
984 sprintf (macroerror
, "After 1 kbd macro iteration: ");
986 sprintf (macroerror
, "After %"pI
"d kbd macro iterations: ",
987 executing_kbd_macro_iterations
);
992 Vstandard_output
= Qt
;
993 Vstandard_input
= Qt
;
994 Vexecuting_kbd_macro
= Qnil
;
995 executing_kbd_macro
= Qnil
;
996 kset_prefix_arg (current_kboard
, Qnil
);
997 kset_last_prefix_arg (current_kboard
, Qnil
);
1000 /* Avoid unquittable loop if data contains a circular list. */
1001 old_level
= Vprint_level
;
1002 old_length
= Vprint_length
;
1003 XSETFASTINT (Vprint_level
, 10);
1004 XSETFASTINT (Vprint_length
, 10);
1005 cmd_error_internal (data
, macroerror
);
1006 Vprint_level
= old_level
;
1007 Vprint_length
= old_length
;
1010 Vinhibit_quit
= Qnil
;
1012 return make_number (0);
1015 /* Take actions on handling an error. DATA is the data that describes
1018 CONTEXT is a C-string containing ASCII characters only which
1019 describes the context in which the error happened. If we need to
1020 generalize CONTEXT to allow multibyte characters, make it a Lisp
1024 cmd_error_internal (Lisp_Object data
, const char *context
)
1026 /* The immediate context is not interesting for Quits,
1027 since they are asynchronous. */
1028 if (EQ (XCAR (data
), Qquit
))
1029 Vsignaling_function
= Qnil
;
1034 /* Use user's specified output function if any. */
1035 if (!NILP (Vcommand_error_function
))
1036 call3 (Vcommand_error_function
, data
,
1037 context
? build_string (context
) : empty_unibyte_string
,
1038 Vsignaling_function
);
1040 Vsignaling_function
= Qnil
;
1043 DEFUN ("command-error-default-function", Fcommand_error_default_function
,
1044 Scommand_error_default_function
, 3, 3, 0,
1045 doc
: /* Produce default output for unhandled error message.
1046 Default value of `command-error-function'. */)
1047 (Lisp_Object data
, Lisp_Object context
, Lisp_Object signal
)
1049 struct frame
*sf
= SELECTED_FRAME ();
1051 CHECK_STRING (context
);
1053 /* If the window system or terminal frame hasn't been initialized
1054 yet, or we're not interactive, write the message to stderr and exit. */
1055 if (!sf
->glyphs_initialized_p
1056 /* The initial frame is a special non-displaying frame. It
1057 will be current in daemon mode when there are no frames
1058 to display, and in non-daemon mode before the real frame
1059 has finished initializing. If an error is thrown in the
1060 latter case while creating the frame, then the frame
1061 will never be displayed, so the safest thing to do is
1062 write to stderr and quit. In daemon mode, there are
1063 many other potential errors that do not prevent frames
1064 from being created, so continuing as normal is better in
1066 || (!IS_DAEMON
&& FRAME_INITIAL_P (sf
))
1069 print_error_message (data
, Qexternal_debugging_output
,
1070 SSDATA (context
), signal
);
1071 Fterpri (Qexternal_debugging_output
, Qnil
);
1072 Fkill_emacs (make_number (-1));
1076 clear_message (1, 0);
1078 message_log_maybe_newline ();
1081 print_error_message (data
, Qt
, SSDATA (context
), signal
);
1086 static Lisp_Object
command_loop_2 (Lisp_Object
);
1087 static Lisp_Object
top_level_1 (Lisp_Object
);
1089 /* Entry to editor-command-loop.
1090 This level has the catches for exiting/returning to editor command loop.
1091 It returns nil to exit recursive edit, t to abort it. */
1096 #ifdef HAVE_STACK_OVERFLOW_HANDLING
1097 /* At least on GNU/Linux, saving signal mask is important here. */
1098 if (sigsetjmp (return_to_command_loop
, 1) != 0)
1100 /* Comes here from handle_sigsegv, see sysdep.c. */
1102 Vinternal__top_level_message
= recover_top_level_message
;
1105 Vinternal__top_level_message
= regular_top_level_message
;
1106 #endif /* HAVE_STACK_OVERFLOW_HANDLING */
1107 if (command_loop_level
> 0 || minibuf_level
> 0)
1110 val
= internal_catch (Qexit
, command_loop_2
, Qnil
);
1111 executing_kbd_macro
= Qnil
;
1117 internal_catch (Qtop_level
, top_level_1
, Qnil
);
1118 internal_catch (Qtop_level
, command_loop_2
, Qnil
);
1119 executing_kbd_macro
= Qnil
;
1121 /* End of file in -batch run causes exit here. */
1127 /* Here we catch errors in execution of commands within the
1128 editing loop, and reenter the editing loop.
1129 When there is an error, cmd_error runs and returns a non-nil
1130 value to us. A value of nil means that command_loop_1 itself
1131 returned due to end of file (or end of kbd macro). */
1134 command_loop_2 (Lisp_Object ignore
)
1136 register Lisp_Object val
;
1139 val
= internal_condition_case (command_loop_1
, Qerror
, cmd_error
);
1140 while (!NILP (val
));
1148 return Feval (Vtop_level
, Qnil
);
1152 top_level_1 (Lisp_Object ignore
)
1154 /* On entry to the outer level, run the startup file. */
1155 if (!NILP (Vtop_level
))
1156 internal_condition_case (top_level_2
, Qerror
, cmd_error
);
1157 else if (!NILP (Vpurify_flag
))
1158 message1 ("Bare impure Emacs (standard Lisp code not loaded)");
1160 message1 ("Bare Emacs (standard Lisp code not loaded)");
1164 DEFUN ("top-level", Ftop_level
, Stop_level
, 0, 0, "",
1165 doc
: /* Exit all recursive editing levels.
1166 This also exits all active minibuffers. */)
1169 #ifdef HAVE_WINDOW_SYSTEM
1170 if (display_hourglass_p
)
1171 cancel_hourglass ();
1174 /* Unblock input if we enter with input blocked. This may happen if
1175 redisplay traps e.g. during tool-bar update with input blocked. */
1176 totally_unblock_input ();
1178 Fthrow (Qtop_level
, Qnil
);
1181 static _Noreturn
void
1182 user_error (const char *msg
)
1184 xsignal1 (Quser_error
, build_string (msg
));
1187 /* _Noreturn will be added to prototype by make-docfile. */
1188 DEFUN ("exit-recursive-edit", Fexit_recursive_edit
, Sexit_recursive_edit
, 0, 0, "",
1189 doc
: /* Exit from the innermost recursive edit or minibuffer. */)
1192 if (command_loop_level
> 0 || minibuf_level
> 0)
1193 Fthrow (Qexit
, Qnil
);
1195 user_error ("No recursive edit is in progress");
1198 /* _Noreturn will be added to prototype by make-docfile. */
1199 DEFUN ("abort-recursive-edit", Fabort_recursive_edit
, Sabort_recursive_edit
, 0, 0, "",
1200 doc
: /* Abort the command that requested this recursive edit or minibuffer input. */)
1203 if (command_loop_level
> 0 || minibuf_level
> 0)
1206 user_error ("No recursive edit is in progress");
1209 /* Restore mouse tracking enablement. See Ftrack_mouse for the only use
1210 of this function. */
1213 tracking_off (Lisp_Object old_value
)
1215 do_mouse_tracking
= old_value
;
1216 if (NILP (old_value
))
1218 /* Redisplay may have been preempted because there was input
1219 available, and it assumes it will be called again after the
1220 input has been processed. If the only input available was
1221 the sort that we have just disabled, then we need to call
1223 if (!readable_events (READABLE_EVENTS_DO_TIMERS_NOW
))
1225 redisplay_preserve_echo_area (6);
1226 get_input_pending (READABLE_EVENTS_DO_TIMERS_NOW
);
1231 DEFUN ("internal--track-mouse", Ftrack_mouse
, Strack_mouse
, 1, 1, 0,
1232 doc
: /* Call BODYFUN with mouse movement events enabled. */)
1233 (Lisp_Object bodyfun
)
1235 ptrdiff_t count
= SPECPDL_INDEX ();
1238 record_unwind_protect (tracking_off
, do_mouse_tracking
);
1240 do_mouse_tracking
= Qt
;
1242 val
= call0 (bodyfun
);
1243 return unbind_to (count
, val
);
1246 /* If mouse has moved on some frame, return one of those frames.
1250 If ignore_mouse_drag_p is non-zero, ignore (implicit) mouse movement
1251 after resizing the tool-bar window. */
1253 bool ignore_mouse_drag_p
;
1255 static struct frame
*
1256 some_mouse_moved (void)
1258 Lisp_Object tail
, frame
;
1260 if (ignore_mouse_drag_p
)
1262 /* ignore_mouse_drag_p = 0; */
1266 FOR_EACH_FRAME (tail
, frame
)
1268 if (XFRAME (frame
)->mouse_moved
)
1269 return XFRAME (frame
);
1276 /* This is the actual command reading loop,
1277 sans error-handling encapsulation. */
1279 static int read_key_sequence (Lisp_Object
*, int, Lisp_Object
,
1280 bool, bool, bool, bool);
1281 static void adjust_point_for_property (ptrdiff_t, bool);
1283 /* The last boundary auto-added to buffer-undo-list. */
1284 Lisp_Object last_undo_boundary
;
1286 /* FIXME: This is wrong rather than test window-system, we should call
1287 a new set-selection, which will then dispatch to x-set-selection, or
1288 tty-set-selection, or w32-set-selection, ... */
1291 command_loop_1 (void)
1294 Lisp_Object keybuf
[30];
1296 EMACS_INT prev_modiff
= 0;
1297 struct buffer
*prev_buffer
= NULL
;
1298 bool already_adjusted
= 0;
1300 kset_prefix_arg (current_kboard
, Qnil
);
1301 kset_last_prefix_arg (current_kboard
, Qnil
);
1302 Vdeactivate_mark
= Qnil
;
1303 waiting_for_input
= 0;
1306 this_command_key_count
= 0;
1307 this_command_key_count_reset
= 0;
1308 this_single_command_key_start
= 0;
1310 if (NILP (Vmemory_full
))
1312 /* Make sure this hook runs after commands that get errors and
1313 throw to top level. */
1314 /* Note that the value cell will never directly contain nil
1315 if the symbol is a local variable. */
1316 if (!NILP (Vpost_command_hook
) && !NILP (Vrun_hooks
))
1317 safe_run_hooks (Qpost_command_hook
);
1319 /* If displaying a message, resize the echo area window to fit
1320 that message's size exactly. */
1321 if (!NILP (echo_area_buffer
[0]))
1322 resize_echo_area_exactly ();
1324 /* If there are warnings waiting, process them. */
1325 if (!NILP (Vdelayed_warnings_list
))
1326 safe_run_hooks (Qdelayed_warnings_hook
);
1328 if (!NILP (Vdeferred_action_list
))
1329 safe_run_hooks (Qdeferred_action_function
);
1332 /* Do this after running Vpost_command_hook, for consistency. */
1333 kset_last_command (current_kboard
, Vthis_command
);
1334 kset_real_last_command (current_kboard
, Vreal_this_command
);
1335 if (!CONSP (last_command_event
))
1336 kset_last_repeatable_command (current_kboard
, Vreal_this_command
);
1340 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1343 /* Make sure the current window's buffer is selected. */
1344 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->contents
));
1346 /* Display any malloc warning that just came out. Use while because
1347 displaying one warning can cause another. */
1349 while (pending_malloc_warning
)
1350 display_malloc_warning ();
1352 Vdeactivate_mark
= Qnil
;
1354 /* Don't ignore mouse movements for more than a single command
1355 loop. (This flag is set in xdisp.c whenever the tool bar is
1356 resized, because the resize moves text up or down, and would
1357 generate false mouse drag events if we don't ignore them.) */
1358 ignore_mouse_drag_p
= 0;
1360 /* If minibuffer on and echo area in use,
1361 wait a short time and redraw minibuffer. */
1364 && !NILP (echo_area_buffer
[0])
1365 && EQ (minibuf_window
, echo_area_window
)
1366 && NUMBERP (Vminibuffer_message_timeout
))
1368 /* Bind inhibit-quit to t so that C-g gets read in
1369 rather than quitting back to the minibuffer. */
1370 ptrdiff_t count
= SPECPDL_INDEX ();
1371 specbind (Qinhibit_quit
, Qt
);
1373 sit_for (Vminibuffer_message_timeout
, 0, 2);
1375 /* Clear the echo area. */
1377 safe_run_hooks (Qecho_area_clear_hook
);
1379 unbind_to (count
, Qnil
);
1381 /* If a C-g came in before, treat it as input now. */
1382 if (!NILP (Vquit_flag
))
1385 Vunread_command_events
= list1 (make_number (quit_char
));
1389 /* If it has changed current-menubar from previous value,
1390 really recompute the menubar from the value. */
1391 if (! NILP (Vlucid_menu_bar_dirty_flag
)
1392 && !NILP (Ffboundp (Qrecompute_lucid_menubar
)))
1393 call0 (Qrecompute_lucid_menubar
);
1395 before_command_key_count
= this_command_key_count
;
1396 before_command_echo_length
= echo_length ();
1398 Vthis_command
= Qnil
;
1399 Vreal_this_command
= Qnil
;
1400 Vthis_original_command
= Qnil
;
1401 Vthis_command_keys_shift_translated
= Qnil
;
1403 /* Read next key sequence; i gets its length. */
1404 i
= read_key_sequence (keybuf
, ARRAYELTS (keybuf
),
1407 /* A filter may have run while we were reading the input. */
1408 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1410 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->contents
));
1414 /* Now we have read a key sequence of length I,
1415 or else I is 0 and we found end of file. */
1417 if (i
== 0) /* End of file -- happens only in */
1418 return Qnil
; /* a kbd macro, at the end. */
1419 /* -1 means read_key_sequence got a menu that was rejected.
1420 Just loop around and read another command. */
1424 this_command_key_count
= 0;
1425 this_command_key_count_reset
= 0;
1426 this_single_command_key_start
= 0;
1430 last_command_event
= keybuf
[i
- 1];
1432 /* If the previous command tried to force a specific window-start,
1433 forget about that, in case this command moves point far away
1434 from that position. But also throw away beg_unchanged and
1435 end_unchanged information in that case, so that redisplay will
1436 update the whole window properly. */
1437 if (XWINDOW (selected_window
)->force_start
)
1440 XWINDOW (selected_window
)->force_start
= 0;
1441 b
= XBUFFER (XWINDOW (selected_window
)->contents
);
1442 BUF_BEG_UNCHANGED (b
) = BUF_END_UNCHANGED (b
) = 0;
1445 cmd
= read_key_sequence_cmd
;
1446 if (!NILP (Vexecuting_kbd_macro
))
1448 if (!NILP (Vquit_flag
))
1450 Vexecuting_kbd_macro
= Qt
;
1451 QUIT
; /* Make some noise. */
1452 /* Will return since macro now empty. */
1456 /* Do redisplay processing after this command except in special
1457 cases identified below. */
1458 prev_buffer
= current_buffer
;
1459 prev_modiff
= MODIFF
;
1460 last_point_position
= PT
;
1462 /* By default, we adjust point to a boundary of a region that
1463 has such a property that should be treated intangible
1464 (e.g. composition, display). But, some commands will set
1465 this variable differently. */
1466 Vdisable_point_adjustment
= Qnil
;
1468 /* Process filters and timers may have messed with deactivate-mark.
1469 reset it before we execute the command. */
1470 Vdeactivate_mark
= Qnil
;
1472 /* Remap command through active keymaps. */
1473 Vthis_original_command
= cmd
;
1474 if (!NILP (read_key_sequence_remapped
))
1475 cmd
= read_key_sequence_remapped
;
1477 /* Execute the command. */
1480 total_keys
+= total_keys
< NUM_RECENT_KEYS
;
1481 ASET (recent_keys
, recent_keys_index
,
1483 if (++recent_keys_index
>= NUM_RECENT_KEYS
)
1484 recent_keys_index
= 0;
1486 Vthis_command
= cmd
;
1487 Vreal_this_command
= cmd
;
1488 safe_run_hooks (Qpre_command_hook
);
1490 already_adjusted
= 0;
1492 if (NILP (Vthis_command
))
1493 /* nil means key is undefined. */
1497 /* Here for a command that isn't executed directly. */
1499 #ifdef HAVE_WINDOW_SYSTEM
1500 ptrdiff_t scount
= SPECPDL_INDEX ();
1502 if (display_hourglass_p
1503 && NILP (Vexecuting_kbd_macro
))
1505 record_unwind_protect_void (cancel_hourglass
);
1510 if (NILP (KVAR (current_kboard
, Vprefix_arg
))) /* FIXME: Why? --Stef */
1512 Lisp_Object undo
= BVAR (current_buffer
, undo_list
);
1515 = (EQ (undo
, BVAR (current_buffer
, undo_list
))
1516 ? Qnil
: BVAR (current_buffer
, undo_list
));
1518 call1 (Qcommand_execute
, Vthis_command
);
1520 #ifdef HAVE_WINDOW_SYSTEM
1521 /* Do not check display_hourglass_p here, because
1522 `command-execute' could change it, but we should cancel
1523 hourglass cursor anyway.
1524 But don't cancel the hourglass within a macro
1525 just because a command in the macro finishes. */
1526 if (NILP (Vexecuting_kbd_macro
))
1527 unbind_to (scount
, Qnil
);
1530 kset_last_prefix_arg (current_kboard
, Vcurrent_prefix_arg
);
1532 safe_run_hooks (Qpost_command_hook
);
1534 /* If displaying a message, resize the echo area window to fit
1535 that message's size exactly. */
1536 if (!NILP (echo_area_buffer
[0]))
1537 resize_echo_area_exactly ();
1539 /* If there are warnings waiting, process them. */
1540 if (!NILP (Vdelayed_warnings_list
))
1541 safe_run_hooks (Qdelayed_warnings_hook
);
1543 safe_run_hooks (Qdeferred_action_function
);
1545 /* If there is a prefix argument,
1546 1) We don't want Vlast_command to be ``universal-argument''
1547 (that would be dumb), so don't set Vlast_command,
1548 2) we want to leave echoing on so that the prefix will be
1549 echoed as part of this key sequence, so don't call
1551 3) we want to leave this_command_key_count non-zero, so that
1552 read_char will realize that it is re-reading a character, and
1553 not echo it a second time.
1555 If the command didn't actually create a prefix arg,
1556 but is merely a frame event that is transparent to prefix args,
1557 then the above doesn't apply. */
1558 if (NILP (KVAR (current_kboard
, Vprefix_arg
))
1559 || CONSP (last_command_event
))
1561 kset_last_command (current_kboard
, Vthis_command
);
1562 kset_real_last_command (current_kboard
, Vreal_this_command
);
1563 if (!CONSP (last_command_event
))
1564 kset_last_repeatable_command (current_kboard
, Vreal_this_command
);
1566 this_command_key_count
= 0;
1567 this_command_key_count_reset
= 0;
1568 this_single_command_key_start
= 0;
1571 if (!NILP (BVAR (current_buffer
, mark_active
))
1572 && !NILP (Vrun_hooks
))
1574 /* In Emacs 22, setting transient-mark-mode to `only' was a
1575 way of turning it on for just one command. This usage is
1576 obsolete, but support it anyway. */
1577 if (EQ (Vtransient_mark_mode
, Qidentity
))
1578 Vtransient_mark_mode
= Qnil
;
1579 else if (EQ (Vtransient_mark_mode
, Qonly
))
1580 Vtransient_mark_mode
= Qidentity
;
1582 if (!NILP (Vdeactivate_mark
))
1583 /* If `select-active-regions' is non-nil, this call to
1584 `deactivate-mark' also sets the PRIMARY selection. */
1585 call0 (Qdeactivate_mark
);
1588 /* Even if not deactivating the mark, set PRIMARY if
1589 `select-active-regions' is non-nil. */
1590 if (!NILP (Fwindow_system (Qnil
))
1591 /* Even if mark_active is non-nil, the actual buffer
1592 marker may not have been set yet (Bug#7044). */
1593 && XMARKER (BVAR (current_buffer
, mark
))->buffer
1594 && (EQ (Vselect_active_regions
, Qonly
)
1595 ? EQ (CAR_SAFE (Vtransient_mark_mode
), Qonly
)
1596 : (!NILP (Vselect_active_regions
)
1597 && !NILP (Vtransient_mark_mode
)))
1598 && NILP (Fmemq (Vthis_command
,
1599 Vselection_inhibit_update_commands
)))
1602 = call1 (Fsymbol_value (Qregion_extract_function
), Qnil
);
1603 if (XINT (Flength (txt
)) > 0)
1604 /* Don't set empty selections. */
1605 call2 (Qgui_set_selection
, QPRIMARY
, txt
);
1608 if (current_buffer
!= prev_buffer
|| MODIFF
!= prev_modiff
)
1609 run_hook (intern ("activate-mark-hook"));
1612 Vsaved_region_selection
= Qnil
;
1617 if (current_buffer
== prev_buffer
1618 && last_point_position
!= PT
1619 && NILP (Vdisable_point_adjustment
)
1620 && NILP (Vglobal_disable_point_adjustment
))
1622 if (last_point_position
> BEGV
1623 && last_point_position
< ZV
1624 && (composition_adjust_point (last_point_position
,
1625 last_point_position
)
1626 != last_point_position
))
1627 /* The last point was temporarily set within a grapheme
1628 cluster to prevent automatic composition. To recover
1629 the automatic composition, we must update the
1631 windows_or_buffers_changed
= 21;
1632 if (!already_adjusted
)
1633 adjust_point_for_property (last_point_position
,
1634 MODIFF
!= prev_modiff
);
1637 /* Install chars successfully executed in kbd macro. */
1639 if (!NILP (KVAR (current_kboard
, defining_kbd_macro
))
1640 && NILP (KVAR (current_kboard
, Vprefix_arg
)))
1641 finalize_kbd_macro_chars ();
1646 read_menu_command (void)
1648 Lisp_Object keybuf
[30];
1649 ptrdiff_t count
= SPECPDL_INDEX ();
1652 /* We don't want to echo the keystrokes while navigating the
1654 specbind (Qecho_keystrokes
, make_number (0));
1656 i
= read_key_sequence (keybuf
, ARRAYELTS (keybuf
),
1659 unbind_to (count
, Qnil
);
1661 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1663 if (i
== 0 || i
== -1)
1666 return read_key_sequence_cmd
;
1669 /* Adjust point to a boundary of a region that has such a property
1670 that should be treated intangible. For the moment, we check
1671 `composition', `display' and `invisible' properties.
1672 LAST_PT is the last position of point. */
1675 adjust_point_for_property (ptrdiff_t last_pt
, bool modified
)
1678 Lisp_Object val
, overlay
, tmp
;
1679 /* When called after buffer modification, we should temporarily
1680 suppress the point adjustment for automatic composition so that a
1681 user can keep inserting another character at point or keep
1682 deleting characters around point. */
1683 bool check_composition
= ! modified
, check_display
= 1, check_invisible
= 1;
1684 ptrdiff_t orig_pt
= PT
;
1686 /* FIXME: cycling is probably not necessary because these properties
1687 can't be usefully combined anyway. */
1688 while (check_composition
|| check_display
|| check_invisible
)
1690 /* FIXME: check `intangible'. */
1691 if (check_composition
1692 && PT
> BEGV
&& PT
< ZV
1693 && (beg
= composition_adjust_point (last_pt
, PT
)) != PT
)
1696 check_display
= check_invisible
= 1;
1698 check_composition
= 0;
1700 && PT
> BEGV
&& PT
< ZV
1701 && !NILP (val
= get_char_property_and_overlay
1702 (make_number (PT
), Qdisplay
, Qnil
, &overlay
))
1703 && display_prop_intangible_p (val
, overlay
, PT
, PT_BYTE
)
1704 && (!OVERLAYP (overlay
)
1705 ? get_property_and_range (PT
, Qdisplay
, &val
, &beg
, &end
, Qnil
)
1706 : (beg
= OVERLAY_POSITION (OVERLAY_START (overlay
)),
1707 end
= OVERLAY_POSITION (OVERLAY_END (overlay
))))
1708 && (beg
< PT
/* && end > PT <- It's always the case. */
1709 || (beg
<= PT
&& STRINGP (val
) && SCHARS (val
) == 0)))
1712 SET_PT (PT
< last_pt
1713 ? (STRINGP (val
) && SCHARS (val
) == 0
1714 ? max (beg
- 1, BEGV
)
1717 check_composition
= check_invisible
= 1;
1720 if (check_invisible
&& PT
> BEGV
&& PT
< ZV
)
1726 /* Find boundaries `beg' and `end' of the invisible area, if any. */
1729 /* FIXME: We should stop if we find a spot between
1730 two runs of `invisible' where inserted text would
1731 be visible. This is important when we have two
1732 invisible boundaries that enclose an area: if the
1733 area is empty, we need this test in order to make
1734 it possible to place point in the middle rather
1735 than skip both boundaries. However, this code
1736 also stops anywhere in a non-sticky text-property,
1737 which breaks (e.g.) Org mode. */
1738 && (val
= Fget_pos_property (make_number (end
),
1740 TEXT_PROP_MEANS_INVISIBLE (val
))
1742 && !NILP (val
= get_char_property_and_overlay
1743 (make_number (end
), Qinvisible
, Qnil
, &overlay
))
1744 && (inv
= TEXT_PROP_MEANS_INVISIBLE (val
)))
1746 ellipsis
= ellipsis
|| inv
> 1
1747 || (OVERLAYP (overlay
)
1748 && (!NILP (Foverlay_get (overlay
, Qafter_string
))
1749 || !NILP (Foverlay_get (overlay
, Qbefore_string
))));
1750 tmp
= Fnext_single_char_property_change
1751 (make_number (end
), Qinvisible
, Qnil
, Qnil
);
1752 end
= NATNUMP (tmp
) ? XFASTINT (tmp
) : ZV
;
1756 && (val
= Fget_pos_property (make_number (beg
),
1758 TEXT_PROP_MEANS_INVISIBLE (val
))
1760 && !NILP (val
= get_char_property_and_overlay
1761 (make_number (beg
- 1), Qinvisible
, Qnil
, &overlay
))
1762 && (inv
= TEXT_PROP_MEANS_INVISIBLE (val
)))
1764 ellipsis
= ellipsis
|| inv
> 1
1765 || (OVERLAYP (overlay
)
1766 && (!NILP (Foverlay_get (overlay
, Qafter_string
))
1767 || !NILP (Foverlay_get (overlay
, Qbefore_string
))));
1768 tmp
= Fprevious_single_char_property_change
1769 (make_number (beg
), Qinvisible
, Qnil
, Qnil
);
1770 beg
= NATNUMP (tmp
) ? XFASTINT (tmp
) : BEGV
;
1773 /* Move away from the inside area. */
1774 if (beg
< PT
&& end
> PT
)
1776 SET_PT ((orig_pt
== PT
&& (last_pt
< beg
|| last_pt
> end
))
1777 /* We haven't moved yet (so we don't need to fear
1778 infinite-looping) and we were outside the range
1779 before (so either end of the range still corresponds
1780 to a move in the right direction): pretend we moved
1781 less than we actually did, so that we still have
1782 more freedom below in choosing which end of the range
1784 ? (orig_pt
= -1, PT
< last_pt
? end
: beg
)
1785 /* We either have moved already or the last point
1786 was already in the range: we don't get to choose
1787 which end of the range we have to go to. */
1788 : (PT
< last_pt
? beg
: end
));
1789 check_composition
= check_display
= 1;
1791 #if 0 /* This assertion isn't correct, because SET_PT may end up setting
1792 the point to something other than its argument, due to
1793 point-motion hooks, intangibility, etc. */
1794 eassert (PT
== beg
|| PT
== end
);
1797 /* Pretend the area doesn't exist if the buffer is not
1799 if (!modified
&& !ellipsis
&& beg
< end
)
1801 if (last_pt
== beg
&& PT
== end
&& end
< ZV
)
1802 (check_composition
= check_display
= 1, SET_PT (end
+ 1));
1803 else if (last_pt
== end
&& PT
== beg
&& beg
> BEGV
)
1804 (check_composition
= check_display
= 1, SET_PT (beg
- 1));
1805 else if (PT
== ((PT
< last_pt
) ? beg
: end
))
1806 /* We've already moved as far as we can. Trying to go
1807 to the other end would mean moving backwards and thus
1808 could lead to an infinite loop. */
1810 else if (val
= Fget_pos_property (make_number (PT
),
1812 TEXT_PROP_MEANS_INVISIBLE (val
)
1813 && (val
= (Fget_pos_property
1814 (make_number (PT
== beg
? end
: beg
),
1816 !TEXT_PROP_MEANS_INVISIBLE (val
)))
1817 (check_composition
= check_display
= 1,
1818 SET_PT (PT
== beg
? end
: beg
));
1821 check_invisible
= 0;
1825 /* Subroutine for safe_run_hooks: run the hook, which is ARGS[1]. */
1828 safe_run_hooks_1 (ptrdiff_t nargs
, Lisp_Object
*args
)
1830 eassert (nargs
== 2);
1831 return call0 (args
[1]);
1834 /* Subroutine for safe_run_hooks: handle an error by clearing out the function
1838 safe_run_hooks_error (Lisp_Object error
, ptrdiff_t nargs
, Lisp_Object
*args
)
1840 eassert (nargs
== 2);
1841 AUTO_STRING (format
, "Error in %s (%S): %S");
1842 Lisp_Object hook
= args
[0];
1843 Lisp_Object fun
= args
[1];
1844 Fmessage (4, (Lisp_Object
[]) {format
, hook
, fun
, error
});
1850 Lisp_Object newval
= Qnil
;
1851 for (val
= find_symbol_value (hook
); CONSP (val
); val
= XCDR (val
))
1852 if (EQ (fun
, XCAR (val
)))
1855 newval
= Fcons (XCAR (val
), newval
);
1857 return Fset (hook
, Fnreverse (newval
));
1858 /* Not found in the local part of the hook. Let's look at the global
1861 for (val
= (NILP (Fdefault_boundp (hook
)) ? Qnil
1862 : Fdefault_value (hook
));
1863 CONSP (val
); val
= XCDR (val
))
1864 if (EQ (fun
, XCAR (val
)))
1867 newval
= Fcons (XCAR (val
), newval
);
1869 return Fset_default (hook
, Fnreverse (newval
));
1875 safe_run_hook_funcall (ptrdiff_t nargs
, Lisp_Object
*args
)
1877 Lisp_Object iargs
[2];
1879 eassert (nargs
== 2);
1880 /* Yes, run_hook_with_args works this way. */
1883 internal_condition_case_n (safe_run_hooks_1
, 2, iargs
,
1884 Qt
, safe_run_hooks_error
);
1888 /* If we get an error while running the hook, cause the hook variable
1889 to be nil. Also inhibit quits, so that C-g won't cause the hook
1890 to mysteriously evaporate. */
1893 safe_run_hooks (Lisp_Object hook
)
1895 Lisp_Object args
[2];
1896 struct gcpro gcpro1
;
1897 ptrdiff_t count
= SPECPDL_INDEX ();
1903 specbind (Qinhibit_quit
, Qt
);
1904 run_hook_with_args (2, args
, safe_run_hook_funcall
);
1905 unbind_to (count
, Qnil
);
1910 /* Nonzero means polling for input is temporarily suppressed. */
1912 int poll_suppress_count
;
1915 #ifdef POLL_FOR_INPUT
1917 /* Asynchronous timer for polling. */
1919 static struct atimer
*poll_timer
;
1921 /* Poll for input, so that we catch a C-g if it comes in. */
1923 poll_for_input_1 (void)
1925 if (! input_blocked_p ()
1926 && !waiting_for_input
)
1930 /* Timer callback function for poll_timer. TIMER is equal to
1934 poll_for_input (struct atimer
*timer
)
1936 if (poll_suppress_count
== 0)
1937 pending_signals
= 1;
1940 #endif /* POLL_FOR_INPUT */
1942 /* Begin signals to poll for input, if they are appropriate.
1943 This function is called unconditionally from various places. */
1946 start_polling (void)
1948 #ifdef POLL_FOR_INPUT
1949 /* XXX This condition was (read_socket_hook && !interrupt_input),
1950 but read_socket_hook is not global anymore. Let's pretend that
1952 if (!interrupt_input
)
1954 /* Turn alarm handling on unconditionally. It might have
1955 been turned off in process.c. */
1956 turn_on_atimers (1);
1958 /* If poll timer doesn't exist, or we need one with
1959 a different interval, start a new one. */
1960 if (poll_timer
== NULL
1961 || poll_timer
->interval
.tv_sec
!= polling_period
)
1963 time_t period
= max (1, min (polling_period
, TYPE_MAXIMUM (time_t)));
1964 struct timespec interval
= make_timespec (period
, 0);
1967 cancel_atimer (poll_timer
);
1969 poll_timer
= start_atimer (ATIMER_CONTINUOUS
, interval
,
1970 poll_for_input
, NULL
);
1973 /* Let the timer's callback function poll for input
1974 if this becomes zero. */
1975 --poll_suppress_count
;
1980 /* True if we are using polling to handle input asynchronously. */
1983 input_polling_used (void)
1985 #ifdef POLL_FOR_INPUT
1986 /* XXX This condition was (read_socket_hook && !interrupt_input),
1987 but read_socket_hook is not global anymore. Let's pretend that
1989 return !interrupt_input
;
1995 /* Turn off polling. */
2000 #ifdef POLL_FOR_INPUT
2001 /* XXX This condition was (read_socket_hook && !interrupt_input),
2002 but read_socket_hook is not global anymore. Let's pretend that
2004 if (!interrupt_input
)
2005 ++poll_suppress_count
;
2009 /* Set the value of poll_suppress_count to COUNT
2010 and start or stop polling accordingly. */
2013 set_poll_suppress_count (int count
)
2015 #ifdef POLL_FOR_INPUT
2016 if (count
== 0 && poll_suppress_count
!= 0)
2018 poll_suppress_count
= 1;
2021 else if (count
!= 0 && poll_suppress_count
== 0)
2025 poll_suppress_count
= count
;
2029 /* Bind polling_period to a value at least N.
2030 But don't decrease it. */
2033 bind_polling_period (int n
)
2035 #ifdef POLL_FOR_INPUT
2036 EMACS_INT
new = polling_period
;
2041 stop_other_atimers (poll_timer
);
2043 specbind (Qpolling_period
, make_number (new));
2044 /* Start a new alarm with the new period. */
2049 /* Apply the control modifier to CHARACTER. */
2052 make_ctrl_char (int c
)
2054 /* Save the upper bits here. */
2055 int upper
= c
& ~0177;
2057 if (! ASCII_CHAR_P (c
))
2058 return c
|= ctrl_modifier
;
2062 /* Everything in the columns containing the upper-case letters
2063 denotes a control character. */
2064 if (c
>= 0100 && c
< 0140)
2068 /* Set the shift modifier for a control char
2069 made from a shifted letter. But only for letters! */
2070 if (oc
>= 'A' && oc
<= 'Z')
2071 c
|= shift_modifier
;
2074 /* The lower-case letters denote control characters too. */
2075 else if (c
>= 'a' && c
<= 'z')
2078 /* Include the bits for control and shift
2079 only if the basic ASCII code can't indicate them. */
2083 /* Replace the high bits. */
2084 c
|= (upper
& ~ctrl_modifier
);
2089 /* Display the help-echo property of the character after the mouse pointer.
2090 Either show it in the echo area, or call show-help-function to display
2091 it by other means (maybe in a tooltip).
2093 If HELP is nil, that means clear the previous help echo.
2095 If HELP is a string, display that string. If HELP is a function,
2096 call it with OBJECT and POS as arguments; the function should
2097 return a help string or nil for none. For all other types of HELP,
2098 evaluate it to obtain a string.
2100 WINDOW is the window in which the help was generated, if any.
2101 It is nil if not in a window.
2103 If OBJECT is a buffer, POS is the position in the buffer where the
2104 `help-echo' text property was found.
2106 If OBJECT is an overlay, that overlay has a `help-echo' property,
2107 and POS is the position in the overlay's buffer under the mouse.
2109 If OBJECT is a string (an overlay string or a string displayed with
2110 the `display' property). POS is the position in that string under
2113 Note: this function may only be called with HELP nil or a string
2114 from X code running asynchronously. */
2117 show_help_echo (Lisp_Object help
, Lisp_Object window
, Lisp_Object object
,
2120 if (!NILP (help
) && !STRINGP (help
))
2122 if (FUNCTIONP (help
))
2123 help
= safe_call (4, help
, window
, object
, pos
);
2125 help
= safe_eval (help
);
2127 if (!STRINGP (help
))
2131 if (!noninteractive
&& STRINGP (help
))
2133 /* The mouse-fixup-help-message Lisp function can call
2134 mouse_position_hook, which resets the mouse_moved flags.
2135 This causes trouble if we are trying to read a mouse motion
2136 event (i.e., if we are inside a `track-mouse' form), so we
2137 restore the mouse_moved flag. */
2138 struct frame
*f
= NILP (do_mouse_tracking
) ? NULL
: some_mouse_moved ();
2139 help
= call1 (Qmouse_fixup_help_message
, help
);
2144 if (STRINGP (help
) || NILP (help
))
2146 if (!NILP (Vshow_help_function
))
2147 call1 (Vshow_help_function
, help
);
2148 help_echo_showing_p
= STRINGP (help
);
2154 /* Input of single characters from keyboard. */
2156 static Lisp_Object
kbd_buffer_get_event (KBOARD
**kbp
, bool *used_mouse_menu
,
2157 struct timespec
*end_time
);
2158 static void record_char (Lisp_Object c
);
2160 static Lisp_Object help_form_saved_window_configs
;
2162 read_char_help_form_unwind (void)
2164 Lisp_Object window_config
= XCAR (help_form_saved_window_configs
);
2165 help_form_saved_window_configs
= XCDR (help_form_saved_window_configs
);
2166 if (!NILP (window_config
))
2167 Fset_window_configuration (window_config
);
2170 #define STOP_POLLING \
2171 do { if (! polling_stopped_here) stop_polling (); \
2172 polling_stopped_here = 1; } while (0)
2174 #define RESUME_POLLING \
2175 do { if (polling_stopped_here) start_polling (); \
2176 polling_stopped_here = 0; } while (0)
2179 read_event_from_main_queue (struct timespec
*end_time
,
2180 sys_jmp_buf local_getcjmp
,
2181 bool *used_mouse_menu
)
2183 Lisp_Object c
= Qnil
;
2184 sys_jmp_buf save_jump
;
2185 KBOARD
*kb
IF_LINT (= NULL
);
2189 /* Read from the main queue, and if that gives us something we can't use yet,
2190 we put it on the appropriate side queue and try again. */
2192 if (end_time
&& timespec_cmp (*end_time
, current_timespec ()) <= 0)
2195 /* Actually read a character, waiting if necessary. */
2196 save_getcjmp (save_jump
);
2197 restore_getcjmp (local_getcjmp
);
2199 timer_start_idle ();
2200 c
= kbd_buffer_get_event (&kb
, used_mouse_menu
, end_time
);
2201 restore_getcjmp (save_jump
);
2203 if (! NILP (c
) && (kb
!= current_kboard
))
2205 Lisp_Object last
= KVAR (kb
, kbd_queue
);
2208 while (CONSP (XCDR (last
)))
2210 if (!NILP (XCDR (last
)))
2214 kset_kbd_queue (kb
, list1 (c
));
2216 XSETCDR (last
, list1 (c
));
2217 kb
->kbd_queue_has_data
= 1;
2221 current_kboard
= kb
;
2222 /* This is going to exit from read_char
2223 so we had better get rid of this frame's stuff. */
2224 return make_number (-2);
2227 /* Terminate Emacs in batch mode if at eof. */
2228 if (noninteractive
&& INTEGERP (c
) && XINT (c
) < 0)
2229 Fkill_emacs (make_number (1));
2233 /* Add in any extra modifiers, where appropriate. */
2234 if ((extra_keyboard_modifiers
& CHAR_CTL
)
2235 || ((extra_keyboard_modifiers
& 0177) < ' '
2236 && (extra_keyboard_modifiers
& 0177) != 0))
2237 XSETINT (c
, make_ctrl_char (XINT (c
)));
2239 /* Transfer any other modifier bits directly from
2240 extra_keyboard_modifiers to c. Ignore the actual character code
2241 in the low 16 bits of extra_keyboard_modifiers. */
2242 XSETINT (c
, XINT (c
) | (extra_keyboard_modifiers
& ~0xff7f & ~CHAR_CTL
));
2250 /* Like `read_event_from_main_queue' but applies keyboard-coding-system
2253 read_decoded_event_from_main_queue (struct timespec
*end_time
,
2254 sys_jmp_buf local_getcjmp
,
2255 Lisp_Object prev_event
,
2256 bool *used_mouse_menu
)
2258 #define MAX_ENCODED_BYTES 16
2260 Lisp_Object events
[MAX_ENCODED_BYTES
];
2266 = read_event_from_main_queue (end_time
, local_getcjmp
,
2269 /* w32_console already returns decoded events. It either reads
2270 Unicode characters from the Windows keyboard input, or
2271 converts characters encoded in the current codepage into
2272 Unicode. See w32inevt.c:key_event, near its end. */
2275 struct frame
*frame
= XFRAME (selected_frame
);
2276 struct terminal
*terminal
= frame
->terminal
;
2277 if (!((FRAME_TERMCAP_P (frame
) || FRAME_MSDOS_P (frame
))
2278 /* Don't apply decoding if we're just reading a raw event
2279 (e.g. reading bytes sent by the xterm to specify the position
2280 of a mouse click). */
2281 && (!EQ (prev_event
, Qt
))
2282 && (TERMINAL_KEYBOARD_CODING (terminal
)->common_flags
2283 & CODING_REQUIRE_DECODING_MASK
)))
2284 return nextevt
; /* No decoding needed. */
2287 int meta_key
= terminal
->display_info
.tty
->meta_key
;
2288 eassert (n
< MAX_ENCODED_BYTES
);
2289 events
[n
++] = nextevt
;
2290 if (NATNUMP (nextevt
)
2291 && XINT (nextevt
) < (meta_key
== 1 ? 0x80 : 0x100))
2292 { /* An encoded byte sequence, let's try to decode it. */
2293 struct coding_system
*coding
2294 = TERMINAL_KEYBOARD_CODING (terminal
);
2295 unsigned char src
[MAX_ENCODED_BYTES
];
2296 unsigned char dest
[MAX_ENCODED_BYTES
* MAX_MULTIBYTE_LENGTH
];
2298 for (i
= 0; i
< n
; i
++)
2299 src
[i
] = XINT (events
[i
]);
2301 for (i
= 0; i
< n
; i
++)
2303 coding
->destination
= dest
;
2304 coding
->dst_bytes
= sizeof dest
;
2305 decode_coding_c_string (coding
, src
, n
, Qnil
);
2306 eassert (coding
->produced_char
<= n
);
2307 if (coding
->produced_char
== 0)
2308 { /* The encoded sequence is incomplete. */
2309 if (n
< MAX_ENCODED_BYTES
) /* Avoid buffer overflow. */
2310 continue; /* Read on! */
2314 const unsigned char *p
= coding
->destination
;
2315 eassert (coding
->carryover_bytes
== 0);
2317 while (n
< coding
->produced_char
)
2318 events
[n
++] = make_number (STRING_CHAR_ADVANCE (p
));
2321 /* Now `events' should hold decoded events.
2322 Normally, n should be equal to 1, but better not rely on it.
2323 We can only return one event here, so return the first we
2324 had and keep the others (if any) for later. */
2326 Vunread_command_events
2327 = Fcons (events
[--n
], Vunread_command_events
);
2335 echo_keystrokes_p (void)
2337 return (FLOATP (Vecho_keystrokes
) ? XFLOAT_DATA (Vecho_keystrokes
) > 0.0
2338 : INTEGERP (Vecho_keystrokes
) ? XINT (Vecho_keystrokes
) > 0 : false);
2341 /* Read a character from the keyboard; call the redisplay if needed. */
2342 /* commandflag 0 means do not autosave, but do redisplay.
2343 -1 means do not redisplay, but do autosave.
2344 -2 means do neither.
2347 The argument MAP is a keymap for menu prompting.
2349 PREV_EVENT is the previous input event, or nil if we are reading
2350 the first event of a key sequence (or not reading a key sequence).
2351 If PREV_EVENT is t, that is a "magic" value that says
2352 not to run input methods, but in other respects to act as if
2353 not reading a key sequence.
2355 If USED_MOUSE_MENU is non-null, then set *USED_MOUSE_MENU to true
2356 if we used a mouse menu to read the input, or false otherwise. If
2357 USED_MOUSE_MENU is null, don't dereference it.
2359 Value is -2 when we find input on another keyboard. A second call
2360 to read_char will read it.
2362 If END_TIME is non-null, it is a pointer to a struct timespec
2363 specifying the maximum time to wait until. If no input arrives by
2364 that time, stop waiting and return nil.
2366 Value is t if we showed a menu and the user rejected it. */
2369 read_char (int commandflag
, Lisp_Object map
,
2370 Lisp_Object prev_event
,
2371 bool *used_mouse_menu
, struct timespec
*end_time
)
2375 sys_jmp_buf local_getcjmp
;
2376 sys_jmp_buf save_jump
;
2377 Lisp_Object tem
, save
;
2378 volatile Lisp_Object previous_echo_area_message
;
2379 volatile Lisp_Object also_record
;
2380 volatile bool reread
;
2381 struct gcpro gcpro1
, gcpro2
;
2382 bool volatile polling_stopped_here
= 0;
2383 struct kboard
*orig_kboard
= current_kboard
;
2387 #if 0 /* This was commented out as part of fixing echo for C-u left. */
2388 before_command_key_count
= this_command_key_count
;
2389 before_command_echo_length
= echo_length ();
2392 previous_echo_area_message
= Qnil
;
2394 GCPRO2 (c
, previous_echo_area_message
);
2398 if (CONSP (Vunread_post_input_method_events
))
2400 c
= XCAR (Vunread_post_input_method_events
);
2401 Vunread_post_input_method_events
2402 = XCDR (Vunread_post_input_method_events
);
2404 /* Undo what read_char_x_menu_prompt did when it unread
2405 additional keys returned by Fx_popup_menu. */
2407 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2418 if (CONSP (Vunread_command_events
))
2420 bool was_disabled
= 0;
2422 c
= XCAR (Vunread_command_events
);
2423 Vunread_command_events
= XCDR (Vunread_command_events
);
2425 /* Undo what sit-for did when it unread additional keys
2426 inside universal-argument. */
2428 if (CONSP (c
) && EQ (XCAR (c
), Qt
))
2433 /* Undo what read_char_x_menu_prompt did when it unread
2434 additional keys returned by Fx_popup_menu. */
2436 && EQ (XCDR (c
), Qdisabled
)
2437 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
))))
2443 /* If the queued event is something that used the mouse,
2444 set used_mouse_menu accordingly. */
2446 /* Also check was_disabled so last-nonmenu-event won't return
2447 a bad value when submenus are involved. (Bug#447) */
2448 && (EQ (c
, Qtool_bar
) || EQ (c
, Qmenu_bar
) || was_disabled
))
2449 *used_mouse_menu
= 1;
2451 goto reread_for_input_method
;
2454 if (CONSP (Vunread_input_method_events
))
2456 c
= XCAR (Vunread_input_method_events
);
2457 Vunread_input_method_events
= XCDR (Vunread_input_method_events
);
2459 /* Undo what read_char_x_menu_prompt did when it unread
2460 additional keys returned by Fx_popup_menu. */
2462 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2466 goto reread_for_input_method
;
2469 this_command_key_count_reset
= 0;
2471 if (!NILP (Vexecuting_kbd_macro
))
2473 /* We set this to Qmacro; since that's not a frame, nobody will
2474 try to switch frames on us, and the selected window will
2477 Since this event came from a macro, it would be misleading to
2478 leave internal_last_event_frame set to wherever the last
2479 real event came from. Normally, a switch-frame event selects
2480 internal_last_event_frame after each command is read, but
2481 events read from a macro should never cause a new frame to be
2483 Vlast_event_frame
= internal_last_event_frame
= Qmacro
;
2485 /* Exit the macro if we are at the end.
2486 Also, some things replace the macro with t
2487 to force an early exit. */
2488 if (EQ (Vexecuting_kbd_macro
, Qt
)
2489 || executing_kbd_macro_index
>= XFASTINT (Flength (Vexecuting_kbd_macro
)))
2495 c
= Faref (Vexecuting_kbd_macro
, make_number (executing_kbd_macro_index
));
2496 if (STRINGP (Vexecuting_kbd_macro
)
2497 && (XFASTINT (c
) & 0x80) && (XFASTINT (c
) <= 0xff))
2498 XSETFASTINT (c
, CHAR_META
| (XFASTINT (c
) & ~0x80));
2500 executing_kbd_macro_index
++;
2505 if (!NILP (unread_switch_frame
))
2507 c
= unread_switch_frame
;
2508 unread_switch_frame
= Qnil
;
2510 /* This event should make it into this_command_keys, and get echoed
2511 again, so we do not set `reread'. */
2515 /* If redisplay was requested. */
2516 if (commandflag
>= 0)
2518 bool echo_current
= EQ (echo_message_buffer
, echo_area_buffer
[0]);
2520 /* If there is pending input, process any events which are not
2521 user-visible, such as X selection_request events. */
2523 || detect_input_pending_run_timers (0))
2524 swallow_events (false); /* May clear input_pending. */
2526 /* Redisplay if no pending input. */
2527 while (!(input_pending
2528 && (input_was_pending
|| !redisplay_dont_pause
)))
2530 input_was_pending
= input_pending
;
2531 if (help_echo_showing_p
&& !EQ (selected_window
, minibuf_window
))
2532 redisplay_preserve_echo_area (5);
2537 /* Normal case: no input arrived during redisplay. */
2540 /* Input arrived and pre-empted redisplay.
2541 Process any events which are not user-visible. */
2542 swallow_events (false);
2543 /* If that cleared input_pending, try again to redisplay. */
2546 /* Prevent the redisplay we just did
2547 from messing up echoing of the input after the prompt. */
2548 if (commandflag
== 0 && echo_current
)
2549 echo_message_buffer
= echo_area_buffer
[0];
2553 /* Message turns off echoing unless more keystrokes turn it on again.
2555 The code in 20.x for the condition was
2557 1. echo_area_glyphs && *echo_area_glyphs
2558 2. && echo_area_glyphs != current_kboard->echobuf
2559 3. && ok_to_echo_at_next_pause != echo_area_glyphs
2561 (1) means there's a current message displayed
2563 (2) means it's not the message from echoing from the current
2566 (3) There's only one place in 20.x where ok_to_echo_at_next_pause
2567 is set to a non-null value. This is done in read_char and it is
2568 set to echo_area_glyphs after a call to echo_char. That means
2569 ok_to_echo_at_next_pause is either null or
2570 current_kboard->echobuf with the appropriate current_kboard at
2573 So, condition (3) means in clear text ok_to_echo_at_next_pause
2574 must be either null, or the current message isn't from echoing at
2575 all, or it's from echoing from a different kboard than the
2578 if (/* There currently is something in the echo area. */
2579 !NILP (echo_area_buffer
[0])
2580 && (/* It's an echo from a different kboard. */
2581 echo_kboard
!= current_kboard
2582 /* Or we explicitly allow overwriting whatever there is. */
2583 || ok_to_echo_at_next_pause
== NULL
))
2588 /* Try reading a character via menu prompting in the minibuf.
2589 Try this before the sit-for, because the sit-for
2590 would do the wrong thing if we are supposed to do
2591 menu prompting. If EVENT_HAS_PARAMETERS then we are reading
2592 after a mouse event so don't try a minibuf menu. */
2594 if (KEYMAPP (map
) && INTERACTIVE
2595 && !NILP (prev_event
) && ! EVENT_HAS_PARAMETERS (prev_event
)
2596 /* Don't bring up a menu if we already have another event. */
2597 && NILP (Vunread_command_events
)
2598 && !detect_input_pending_run_timers (0))
2600 c
= read_char_minibuf_menu_prompt (commandflag
, map
);
2602 if (INTEGERP (c
) && XINT (c
) == -2)
2603 return c
; /* wrong_kboard_jmpbuf */
2609 /* Make a longjmp point for quits to use, but don't alter getcjmp just yet.
2610 We will do that below, temporarily for short sections of code,
2611 when appropriate. local_getcjmp must be in effect
2612 around any call to sit_for or kbd_buffer_get_event;
2613 it *must not* be in effect when we call redisplay. */
2615 jmpcount
= SPECPDL_INDEX ();
2616 if (sys_setjmp (local_getcjmp
))
2618 /* Handle quits while reading the keyboard. */
2619 /* We must have saved the outer value of getcjmp here,
2620 so restore it now. */
2621 restore_getcjmp (save_jump
);
2622 pthread_sigmask (SIG_SETMASK
, &empty_mask
, 0);
2623 unbind_to (jmpcount
, Qnil
);
2624 XSETINT (c
, quit_char
);
2625 internal_last_event_frame
= selected_frame
;
2626 Vlast_event_frame
= internal_last_event_frame
;
2627 /* If we report the quit char as an event,
2628 don't do so more than once. */
2629 if (!NILP (Vinhibit_quit
))
2633 KBOARD
*kb
= FRAME_KBOARD (XFRAME (selected_frame
));
2634 if (kb
!= current_kboard
)
2636 Lisp_Object last
= KVAR (kb
, kbd_queue
);
2637 /* We shouldn't get here if we were in single-kboard mode! */
2642 while (CONSP (XCDR (last
)))
2644 if (!NILP (XCDR (last
)))
2648 kset_kbd_queue (kb
, list1 (c
));
2650 XSETCDR (last
, list1 (c
));
2651 kb
->kbd_queue_has_data
= 1;
2652 current_kboard
= kb
;
2653 /* This is going to exit from read_char
2654 so we had better get rid of this frame's stuff. */
2656 return make_number (-2); /* wrong_kboard_jmpbuf */
2662 /* Start idle timers if no time limit is supplied. We don't do it
2663 if a time limit is supplied to avoid an infinite recursion in the
2664 situation where an idle timer calls `sit-for'. */
2667 timer_start_idle ();
2669 /* If in middle of key sequence and minibuffer not active,
2670 start echoing if enough time elapses. */
2672 if (minibuf_level
== 0
2674 && !current_kboard
->immediate_echo
2675 && this_command_key_count
> 0
2677 && echo_keystrokes_p ()
2678 && (/* No message. */
2679 NILP (echo_area_buffer
[0])
2680 /* Or empty message. */
2681 || (BUF_BEG (XBUFFER (echo_area_buffer
[0]))
2682 == BUF_Z (XBUFFER (echo_area_buffer
[0])))
2683 /* Or already echoing from same kboard. */
2684 || (echo_kboard
&& ok_to_echo_at_next_pause
== echo_kboard
)
2685 /* Or not echoing before and echoing allowed. */
2686 || (!echo_kboard
&& ok_to_echo_at_next_pause
)))
2688 /* After a mouse event, start echoing right away.
2689 This is because we are probably about to display a menu,
2690 and we don't want to delay before doing so. */
2691 if (EVENT_HAS_PARAMETERS (prev_event
))
2697 save_getcjmp (save_jump
);
2698 restore_getcjmp (local_getcjmp
);
2699 tem0
= sit_for (Vecho_keystrokes
, 1, 1);
2700 restore_getcjmp (save_jump
);
2702 && ! CONSP (Vunread_command_events
))
2707 /* Maybe auto save due to number of keystrokes. */
2709 if (commandflag
!= 0 && commandflag
!= -2
2710 && auto_save_interval
> 0
2711 && num_nonmacro_input_events
- last_auto_save
> max (auto_save_interval
, 20)
2712 && !detect_input_pending_run_timers (0))
2714 Fdo_auto_save (Qnil
, Qnil
);
2715 /* Hooks can actually change some buffers in auto save. */
2719 /* Try reading using an X menu.
2720 This is never confused with reading using the minibuf
2721 because the recursive call of read_char in read_char_minibuf_menu_prompt
2722 does not pass on any keymaps. */
2724 if (KEYMAPP (map
) && INTERACTIVE
2725 && !NILP (prev_event
)
2726 && EVENT_HAS_PARAMETERS (prev_event
)
2727 && !EQ (XCAR (prev_event
), Qmenu_bar
)
2728 && !EQ (XCAR (prev_event
), Qtool_bar
)
2729 /* Don't bring up a menu if we already have another event. */
2730 && NILP (Vunread_command_events
))
2732 c
= read_char_x_menu_prompt (map
, prev_event
, used_mouse_menu
);
2734 /* Now that we have read an event, Emacs is not idle. */
2741 /* Maybe autosave and/or garbage collect due to idleness. */
2743 if (INTERACTIVE
&& NILP (c
))
2746 ptrdiff_t buffer_size
;
2748 /* Slow down auto saves logarithmically in size of current buffer,
2749 and garbage collect while we're at it. */
2750 if (! MINI_WINDOW_P (XWINDOW (selected_window
)))
2751 last_non_minibuf_size
= Z
- BEG
;
2752 buffer_size
= (last_non_minibuf_size
>> 8) + 1;
2754 while (buffer_size
> 64)
2755 delay_level
++, buffer_size
-= buffer_size
>> 2;
2756 if (delay_level
< 4) delay_level
= 4;
2757 /* delay_level is 4 for files under around 50k, 7 at 100k,
2758 9 at 200k, 11 at 300k, and 12 at 500k. It is 15 at 1 meg. */
2760 /* Auto save if enough time goes by without input. */
2761 if (commandflag
!= 0 && commandflag
!= -2
2762 && num_nonmacro_input_events
> last_auto_save
2763 && INTEGERP (Vauto_save_timeout
)
2764 && XINT (Vauto_save_timeout
) > 0)
2767 EMACS_INT timeout
= XFASTINT (Vauto_save_timeout
);
2769 timeout
= min (timeout
, MOST_POSITIVE_FIXNUM
/ delay_level
* 4);
2770 timeout
= delay_level
* timeout
/ 4;
2771 save_getcjmp (save_jump
);
2772 restore_getcjmp (local_getcjmp
);
2773 tem0
= sit_for (make_number (timeout
), 1, 1);
2774 restore_getcjmp (save_jump
);
2777 && ! CONSP (Vunread_command_events
))
2779 Fdo_auto_save (Qnil
, Qnil
);
2784 /* If there is still no input available, ask for GC. */
2785 if (!detect_input_pending_run_timers (0))
2789 /* Notify the caller if an autosave hook, or a timer, sentinel or
2790 filter in the sit_for calls above have changed the current
2791 kboard. This could happen if they use the minibuffer or start a
2792 recursive edit, like the fancy splash screen in server.el's
2793 filter. If this longjmp wasn't here, read_key_sequence would
2794 interpret the next key sequence using the wrong translation
2795 tables and function keymaps. */
2796 if (NILP (c
) && current_kboard
!= orig_kboard
)
2799 return make_number (-2); /* wrong_kboard_jmpbuf */
2802 /* If this has become non-nil here, it has been set by a timer
2803 or sentinel or filter. */
2804 if (CONSP (Vunread_command_events
))
2806 c
= XCAR (Vunread_command_events
);
2807 Vunread_command_events
= XCDR (Vunread_command_events
);
2809 if (CONSP (c
) && EQ (XCAR (c
), Qt
))
2815 /* Read something from current KBOARD's side queue, if possible. */
2819 if (current_kboard
->kbd_queue_has_data
)
2821 if (!CONSP (KVAR (current_kboard
, kbd_queue
)))
2823 c
= XCAR (KVAR (current_kboard
, kbd_queue
));
2824 kset_kbd_queue (current_kboard
,
2825 XCDR (KVAR (current_kboard
, kbd_queue
)));
2826 if (NILP (KVAR (current_kboard
, kbd_queue
)))
2827 current_kboard
->kbd_queue_has_data
= 0;
2828 input_pending
= readable_events (0);
2829 if (EVENT_HAS_PARAMETERS (c
)
2830 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qswitch_frame
))
2831 internal_last_event_frame
= XCAR (XCDR (c
));
2832 Vlast_event_frame
= internal_last_event_frame
;
2836 /* If current_kboard's side queue is empty check the other kboards.
2837 If one of them has data that we have not yet seen here,
2838 switch to it and process the data waiting for it.
2840 Note: if the events queued up for another kboard
2841 have already been seen here, and therefore are not a complete command,
2842 the kbd_queue_has_data field is 0, so we skip that kboard here.
2843 That's to avoid an infinite loop switching between kboards here. */
2844 if (NILP (c
) && !single_kboard
)
2847 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
2848 if (kb
->kbd_queue_has_data
)
2850 current_kboard
= kb
;
2851 /* This is going to exit from read_char
2852 so we had better get rid of this frame's stuff. */
2854 return make_number (-2); /* wrong_kboard_jmpbuf */
2864 c
= read_decoded_event_from_main_queue (end_time
, local_getcjmp
,
2865 prev_event
, used_mouse_menu
);
2866 if (NILP (c
) && end_time
2867 && timespec_cmp (*end_time
, current_timespec ()) <= 0)
2872 if (EQ (c
, make_number (-2)))
2874 /* This is going to exit from read_char
2875 so we had better get rid of this frame's stuff. */
2889 if (commandflag
>= 0
2890 && !input_pending
&& !detect_input_pending_run_timers (0))
2896 /* Buffer switch events are only for internal wakeups
2897 so don't show them to the user.
2898 Also, don't record a key if we already did. */
2902 /* Process special events within read_char
2903 and loop around to read another event. */
2906 tem
= access_keymap (get_keymap (Vspecial_event_map
, 0, 1), c
, 0, 0, 1);
2911 struct buffer
*prev_buffer
= current_buffer
;
2912 last_input_event
= c
;
2913 call4 (Qcommand_execute
, tem
, Qnil
, Fvector (1, &last_input_event
), Qt
);
2915 if (CONSP (c
) && EQ (XCAR (c
), Qselect_window
) && !end_time
)
2916 /* We stopped being idle for this event; undo that. This
2917 prevents automatic window selection (under
2918 mouse_autoselect_window from acting as a real input event, for
2919 example banishing the mouse under mouse-avoidance-mode. */
2920 timer_resume_idle ();
2922 if (current_buffer
!= prev_buffer
)
2924 /* The command may have changed the keymaps. Pretend there
2925 is input in another keyboard and return. This will
2926 recalculate keymaps. */
2927 c
= make_number (-2);
2934 /* Handle things that only apply to characters. */
2937 /* If kbd_buffer_get_event gave us an EOF, return that. */
2941 if ((STRINGP (KVAR (current_kboard
, Vkeyboard_translate_table
))
2942 && UNSIGNED_CMP (XFASTINT (c
), <,
2943 SCHARS (KVAR (current_kboard
,
2944 Vkeyboard_translate_table
))))
2945 || (VECTORP (KVAR (current_kboard
, Vkeyboard_translate_table
))
2946 && UNSIGNED_CMP (XFASTINT (c
), <,
2947 ASIZE (KVAR (current_kboard
,
2948 Vkeyboard_translate_table
))))
2949 || (CHAR_TABLE_P (KVAR (current_kboard
, Vkeyboard_translate_table
))
2953 d
= Faref (KVAR (current_kboard
, Vkeyboard_translate_table
), c
);
2954 /* nil in keyboard-translate-table means no translation. */
2960 /* If this event is a mouse click in the menu bar,
2961 return just menu-bar for now. Modify the mouse click event
2962 so we won't do this twice, then queue it up. */
2963 if (EVENT_HAS_PARAMETERS (c
)
2965 && CONSP (EVENT_START (c
))
2966 && CONSP (XCDR (EVENT_START (c
))))
2970 posn
= POSN_POSN (EVENT_START (c
));
2971 /* Handle menu-bar events:
2972 insert the dummy prefix event `menu-bar'. */
2973 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
2975 /* Change menu-bar to (menu-bar) as the event "position". */
2976 POSN_SET_POSN (EVENT_START (c
), list1 (posn
));
2979 Vunread_command_events
= Fcons (c
, Vunread_command_events
);
2984 /* Store these characters into recent_keys, the dribble file if any,
2985 and the keyboard macro being defined, if any. */
2987 if (! NILP (also_record
))
2988 record_char (also_record
);
2990 /* Wipe the echo area.
2991 But first, if we are about to use an input method,
2992 save the echo area contents for it to refer to. */
2994 && ! NILP (Vinput_method_function
)
2995 && ' ' <= XINT (c
) && XINT (c
) < 256 && XINT (c
) != 127)
2997 previous_echo_area_message
= Fcurrent_message ();
2998 Vinput_method_previous_message
= previous_echo_area_message
;
3001 /* Now wipe the echo area, except for help events which do their
3002 own stuff with the echo area. */
3004 || (!(EQ (Qhelp_echo
, XCAR (c
)))
3005 && !(EQ (Qswitch_frame
, XCAR (c
)))
3006 /* Don't wipe echo area for select window events: These might
3007 get delayed via `mouse-autoselect-window' (Bug#11304). */
3008 && !(EQ (Qselect_window
, XCAR (c
)))))
3010 if (!NILP (echo_area_buffer
[0]))
3012 safe_run_hooks (Qecho_area_clear_hook
);
3013 clear_message (1, 0);
3017 reread_for_input_method
:
3019 /* Pass this to the input method, if appropriate. */
3021 && ! NILP (Vinput_method_function
)
3022 /* Don't run the input method within a key sequence,
3023 after the first event of the key sequence. */
3024 && NILP (prev_event
)
3025 && ' ' <= XINT (c
) && XINT (c
) < 256 && XINT (c
) != 127)
3028 ptrdiff_t key_count
;
3029 bool key_count_reset
;
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
;
3055 keys
= Fcopy_sequence (this_command_keys
);
3060 /* Clear out this_command_keys. */
3061 this_command_key_count
= 0;
3062 this_command_key_count_reset
= 0;
3064 /* Now wipe the echo area. */
3065 if (!NILP (echo_area_buffer
[0]))
3066 safe_run_hooks (Qecho_area_clear_hook
);
3067 clear_message (1, 0);
3070 /* If we are not reading a key sequence,
3071 never use the echo area. */
3074 specbind (Qinput_method_use_echo_area
, Qt
);
3077 /* Call the input method. */
3078 tem
= call1 (Vinput_method_function
, c
);
3080 tem
= unbind_to (count
, tem
);
3082 /* Restore the saved echoing state
3083 and this_command_keys state. */
3084 this_command_key_count
= key_count
;
3085 this_command_key_count_reset
= key_count_reset
;
3087 this_command_keys
= keys
;
3090 ok_to_echo_at_next_pause
= saved_ok_to_echo
;
3091 kset_echo_string (current_kboard
, saved_echo_string
);
3092 current_kboard
->echo_after_prompt
= saved_echo_after_prompt
;
3093 if (saved_immediate_echo
)
3098 /* The input method can return no events. */
3101 /* Bring back the previous message, if any. */
3102 if (! NILP (previous_echo_area_message
))
3103 message_with_string ("%s", previous_echo_area_message
, 0);
3106 /* It returned one event or more. */
3108 Vunread_post_input_method_events
3109 = nconc2 (XCDR (tem
), Vunread_post_input_method_events
);
3114 /* Display help if not echoing. */
3115 if (CONSP (c
) && EQ (XCAR (c
), Qhelp_echo
))
3117 /* (help-echo FRAME HELP WINDOW OBJECT POS). */
3118 Lisp_Object help
, object
, position
, window
, htem
;
3120 htem
= Fcdr (XCDR (c
));
3123 window
= Fcar (htem
);
3125 object
= Fcar (htem
);
3127 position
= Fcar (htem
);
3129 show_help_echo (help
, window
, object
, position
);
3131 /* We stopped being idle for this event; undo that. */
3133 timer_resume_idle ();
3137 if ((! reread
|| this_command_key_count
== 0
3138 || this_command_key_count_reset
)
3142 /* Don't echo mouse motion events. */
3143 if (echo_keystrokes_p ()
3144 && ! (EVENT_HAS_PARAMETERS (c
)
3145 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
3148 if (! NILP (also_record
))
3149 echo_char (also_record
);
3150 /* Once we reread a character, echoing can happen
3151 the next time we pause to read a new one. */
3152 ok_to_echo_at_next_pause
= current_kboard
;
3155 /* Record this character as part of the current key. */
3156 add_command_key (c
);
3157 if (! NILP (also_record
))
3158 add_command_key (also_record
);
3161 last_input_event
= c
;
3164 /* Process the help character specially if enabled. */
3165 if (!NILP (Vhelp_form
) && help_char_p (c
))
3167 ptrdiff_t count
= SPECPDL_INDEX ();
3169 help_form_saved_window_configs
3170 = Fcons (Fcurrent_window_configuration (Qnil
),
3171 help_form_saved_window_configs
);
3172 record_unwind_protect_void (read_char_help_form_unwind
);
3173 call0 (Qhelp_form_show
);
3178 c
= read_char (0, Qnil
, Qnil
, 0, NULL
);
3179 if (EVENT_HAS_PARAMETERS (c
)
3180 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_click
))
3181 XSETCAR (help_form_saved_window_configs
, Qnil
);
3183 while (BUFFERP (c
));
3184 /* Remove the help from the frame. */
3185 unbind_to (count
, Qnil
);
3188 if (EQ (c
, make_number (040)))
3192 c
= read_char (0, Qnil
, Qnil
, 0, NULL
);
3193 while (BUFFERP (c
));
3199 input_was_pending
= input_pending
;
3203 /* Record a key that came from a mouse menu.
3204 Record it for echoing, for this-command-keys, and so on. */
3207 record_menu_key (Lisp_Object c
)
3209 /* Wipe the echo area. */
3210 clear_message (1, 0);
3215 before_command_key_count
= this_command_key_count
;
3216 before_command_echo_length
= echo_length ();
3219 /* Don't echo mouse motion events. */
3220 if (echo_keystrokes_p ())
3224 /* Once we reread a character, echoing can happen
3225 the next time we pause to read a new one. */
3226 ok_to_echo_at_next_pause
= 0;
3229 /* Record this character as part of the current key. */
3230 add_command_key (c
);
3232 /* Re-reading in the middle of a command. */
3233 last_input_event
= c
;
3237 /* Return true if should recognize C as "the help character". */
3240 help_char_p (Lisp_Object c
)
3244 if (EQ (c
, Vhelp_char
))
3246 for (tail
= Vhelp_event_list
; CONSP (tail
); tail
= XCDR (tail
))
3247 if (EQ (c
, XCAR (tail
)))
3252 /* Record the input event C in various ways. */
3255 record_char (Lisp_Object c
)
3259 if (CONSP (c
) && (EQ (XCAR (c
), Qhelp_echo
) || EQ (XCAR (c
), Qmouse_movement
)))
3261 /* To avoid filling recent_keys with help-echo and mouse-movement
3262 events, we filter out repeated help-echo events, only store the
3263 first and last in a series of mouse-movement events, and don't
3264 store repeated help-echo events which are only separated by
3265 mouse-movement events. */
3267 Lisp_Object ev1
, ev2
, ev3
;
3270 if ((ix1
= recent_keys_index
- 1) < 0)
3271 ix1
= NUM_RECENT_KEYS
- 1;
3272 ev1
= AREF (recent_keys
, ix1
);
3274 if ((ix2
= ix1
- 1) < 0)
3275 ix2
= NUM_RECENT_KEYS
- 1;
3276 ev2
= AREF (recent_keys
, ix2
);
3278 if ((ix3
= ix2
- 1) < 0)
3279 ix3
= NUM_RECENT_KEYS
- 1;
3280 ev3
= AREF (recent_keys
, ix3
);
3282 if (EQ (XCAR (c
), Qhelp_echo
))
3284 /* Don't record `help-echo' in recent_keys unless it shows some help
3285 message, and a different help than the previously recorded
3287 Lisp_Object help
, last_help
;
3289 help
= Fcar_safe (Fcdr_safe (XCDR (c
)));
3290 if (!STRINGP (help
))
3292 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qhelp_echo
)
3293 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev1
))), EQ (last_help
, help
)))
3295 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3296 && CONSP (ev2
) && EQ (XCAR (ev2
), Qhelp_echo
)
3297 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev2
))), EQ (last_help
, help
)))
3299 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3300 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3301 && CONSP (ev3
) && EQ (XCAR (ev3
), Qhelp_echo
)
3302 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev3
))), EQ (last_help
, help
)))
3305 else if (EQ (XCAR (c
), Qmouse_movement
))
3307 /* Only record one pair of `mouse-movement' on a window in recent_keys.
3308 So additional mouse movement events replace the last element. */
3309 Lisp_Object last_window
, window
;
3311 window
= Fcar_safe (Fcar_safe (XCDR (c
)));
3312 if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3313 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev1
))), EQ (last_window
, window
))
3314 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3315 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev2
))), EQ (last_window
, window
)))
3317 ASET (recent_keys
, ix1
, c
);
3323 store_kbd_macro_char (c
);
3327 total_keys
+= total_keys
< NUM_RECENT_KEYS
;
3328 ASET (recent_keys
, recent_keys_index
, c
);
3329 if (++recent_keys_index
>= NUM_RECENT_KEYS
)
3330 recent_keys_index
= 0;
3332 else if (recorded
< 0)
3334 /* We need to remove one or two events from recent_keys.
3335 To do this, we simply put nil at those events and move the
3336 recent_keys_index backwards over those events. Usually,
3337 users will never see those nil events, as they will be
3338 overwritten by the command keys entered to see recent_keys
3341 while (recorded
++ < 0 && total_keys
> 0)
3343 if (total_keys
< NUM_RECENT_KEYS
)
3345 if (--recent_keys_index
< 0)
3346 recent_keys_index
= NUM_RECENT_KEYS
- 1;
3347 ASET (recent_keys
, recent_keys_index
, Qnil
);
3351 num_nonmacro_input_events
++;
3353 /* Write c to the dribble file. If c is a lispy event, write
3354 the event's symbol to the dribble file, in <brackets>. Bleaugh.
3355 If you, dear reader, have a better idea, you've got the source. :-) */
3361 if (XUINT (c
) < 0x100)
3362 putc (XUINT (c
), dribble
);
3364 fprintf (dribble
, " 0x%"pI
"x", XUINT (c
));
3368 Lisp_Object dribblee
;
3370 /* If it's a structured event, take the event header. */
3371 dribblee
= EVENT_HEAD (c
);
3373 if (SYMBOLP (dribblee
))
3375 putc ('<', dribble
);
3376 fwrite (SDATA (SYMBOL_NAME (dribblee
)), sizeof (char),
3377 SBYTES (SYMBOL_NAME (dribblee
)),
3379 putc ('>', dribble
);
3388 /* Copy out or in the info on where C-g should throw to.
3389 This is used when running Lisp code from within get_char,
3390 in case get_char is called recursively.
3391 See read_process_output. */
3394 save_getcjmp (sys_jmp_buf temp
)
3396 memcpy (temp
, getcjmp
, sizeof getcjmp
);
3400 restore_getcjmp (sys_jmp_buf temp
)
3402 memcpy (getcjmp
, temp
, sizeof getcjmp
);
3405 /* Low level keyboard/mouse input.
3406 kbd_buffer_store_event places events in kbd_buffer, and
3407 kbd_buffer_get_event retrieves them. */
3409 /* Return true if there are any events in the queue that read-char
3410 would return. If this returns false, a read-char would block. */
3412 readable_events (int flags
)
3414 if (flags
& READABLE_EVENTS_DO_TIMERS_NOW
)
3417 /* If the buffer contains only FOCUS_IN_EVENT events, and
3418 READABLE_EVENTS_FILTER_EVENTS is set, report it as empty. */
3419 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3421 if (flags
& (READABLE_EVENTS_FILTER_EVENTS
3422 #ifdef USE_TOOLKIT_SCROLL_BARS
3423 | READABLE_EVENTS_IGNORE_SQUEEZABLES
3427 struct input_event
*event
;
3429 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
3436 #ifdef USE_TOOLKIT_SCROLL_BARS
3437 (flags
& READABLE_EVENTS_FILTER_EVENTS
) &&
3439 event
->kind
== FOCUS_IN_EVENT
)
3440 #ifdef USE_TOOLKIT_SCROLL_BARS
3441 && !((flags
& READABLE_EVENTS_IGNORE_SQUEEZABLES
)
3442 && (event
->kind
== SCROLL_BAR_CLICK_EVENT
3443 || event
->kind
== HORIZONTAL_SCROLL_BAR_CLICK_EVENT
)
3444 && event
->part
== scroll_bar_handle
3445 && event
->modifiers
== 0)
3447 && !((flags
& READABLE_EVENTS_FILTER_EVENTS
)
3448 && event
->kind
== BUFFER_SWITCH_EVENT
))
3451 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3454 while (event
!= kbd_store_ptr
);
3460 if (!(flags
& READABLE_EVENTS_IGNORE_SQUEEZABLES
)
3461 && !NILP (do_mouse_tracking
) && some_mouse_moved ())
3465 if (current_kboard
->kbd_queue_has_data
)
3471 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
3472 if (kb
->kbd_queue_has_data
)
3478 /* Set this for debugging, to have a way to get out */
3479 int stop_character EXTERNALLY_VISIBLE
;
3482 event_to_kboard (struct input_event
*event
)
3484 /* Not applicable for these special events. */
3485 if (event
->kind
== SELECTION_REQUEST_EVENT
3486 || event
->kind
== SELECTION_CLEAR_EVENT
)
3490 Lisp_Object obj
= event
->frame_or_window
;
3491 /* There are some events that set this field to nil or string. */
3493 obj
= WINDOW_FRAME (XWINDOW (obj
));
3494 /* Also ignore dead frames here. */
3495 return ((FRAMEP (obj
) && FRAME_LIVE_P (XFRAME (obj
)))
3496 ? FRAME_KBOARD (XFRAME (obj
)) : NULL
);
3501 /* Return the number of slots occupied in kbd_buffer. */
3504 kbd_buffer_nr_stored (void)
3506 return kbd_fetch_ptr
== kbd_store_ptr
3508 : (kbd_fetch_ptr
< kbd_store_ptr
3509 ? kbd_store_ptr
- kbd_fetch_ptr
3510 : ((kbd_buffer
+ KBD_BUFFER_SIZE
) - kbd_fetch_ptr
3511 + (kbd_store_ptr
- kbd_buffer
)));
3513 #endif /* Store an event obtained at interrupt level into kbd_buffer, fifo */
3516 kbd_buffer_store_event (register struct input_event
*event
)
3518 kbd_buffer_store_event_hold (event
, 0);
3521 /* Store EVENT obtained at interrupt level into kbd_buffer, fifo.
3523 If HOLD_QUIT is 0, just stuff EVENT into the fifo.
3524 Else, if HOLD_QUIT.kind != NO_EVENT, discard EVENT.
3525 Else, if EVENT is a quit event, store the quit event
3526 in HOLD_QUIT, and return (thus ignoring further events).
3528 This is used to postpone the processing of the quit event until all
3529 subsequent input events have been parsed (and discarded). */
3532 kbd_buffer_store_event_hold (register struct input_event
*event
,
3533 struct input_event
*hold_quit
)
3535 if (event
->kind
== NO_EVENT
)
3538 if (hold_quit
&& hold_quit
->kind
!= NO_EVENT
)
3541 if (event
->kind
== ASCII_KEYSTROKE_EVENT
)
3543 register int c
= event
->code
& 0377;
3545 if (event
->modifiers
& ctrl_modifier
)
3546 c
= make_ctrl_char (c
);
3548 c
|= (event
->modifiers
3549 & (meta_modifier
| alt_modifier
3550 | hyper_modifier
| super_modifier
));
3554 KBOARD
*kb
= FRAME_KBOARD (XFRAME (event
->frame_or_window
));
3555 struct input_event
*sp
;
3557 if (single_kboard
&& kb
!= current_kboard
)
3560 (kb
, list2 (make_lispy_switch_frame (event
->frame_or_window
),
3562 kb
->kbd_queue_has_data
= 1;
3563 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3565 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3568 if (event_to_kboard (sp
) == kb
)
3570 sp
->kind
= NO_EVENT
;
3571 sp
->frame_or_window
= Qnil
;
3580 *hold_quit
= *event
;
3584 /* If this results in a quit_char being returned to Emacs as
3585 input, set Vlast_event_frame properly. If this doesn't
3586 get returned to Emacs as an event, the next event read
3587 will set Vlast_event_frame again, so this is safe to do. */
3591 focus
= FRAME_FOCUS_FRAME (XFRAME (event
->frame_or_window
));
3593 focus
= event
->frame_or_window
;
3594 internal_last_event_frame
= focus
;
3595 Vlast_event_frame
= focus
;
3598 handle_interrupt (0);
3602 if (c
&& c
== stop_character
)
3608 /* Don't insert two BUFFER_SWITCH_EVENT's in a row.
3609 Just ignore the second one. */
3610 else if (event
->kind
== BUFFER_SWITCH_EVENT
3611 && kbd_fetch_ptr
!= kbd_store_ptr
3612 && ((kbd_store_ptr
== kbd_buffer
3613 ? kbd_buffer
+ KBD_BUFFER_SIZE
- 1
3614 : kbd_store_ptr
- 1)->kind
) == BUFFER_SWITCH_EVENT
)
3617 if (kbd_store_ptr
- kbd_buffer
== KBD_BUFFER_SIZE
)
3618 kbd_store_ptr
= kbd_buffer
;
3620 /* Don't let the very last slot in the buffer become full,
3621 since that would make the two pointers equal,
3622 and that is indistinguishable from an empty buffer.
3623 Discard the event if it would fill the last slot. */
3624 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
3626 *kbd_store_ptr
= *event
;
3629 if (kbd_buffer_nr_stored () > KBD_BUFFER_SIZE
/ 2
3630 && ! kbd_on_hold_p ())
3632 /* Don't read keyboard input until we have processed kbd_buffer.
3633 This happens when pasting text longer than KBD_BUFFER_SIZE/2. */
3634 hold_keyboard_input ();
3635 if (!noninteractive
)
3639 #endif /* subprocesses */
3642 /* If we're inside while-no-input, and this event qualifies
3643 as input, set quit-flag to cause an interrupt. */
3644 if (!NILP (Vthrow_on_input
)
3645 && event
->kind
!= FOCUS_IN_EVENT
3646 && event
->kind
!= HELP_EVENT
3647 && event
->kind
!= DEICONIFY_EVENT
)
3649 Vquit_flag
= Vthrow_on_input
;
3650 /* If we're inside a function that wants immediate quits,
3652 if (immediate_quit
&& NILP (Vinhibit_quit
))
3661 /* Put an input event back in the head of the event queue. */
3664 kbd_buffer_unget_event (register struct input_event
*event
)
3666 if (kbd_fetch_ptr
== kbd_buffer
)
3667 kbd_fetch_ptr
= kbd_buffer
+ KBD_BUFFER_SIZE
;
3669 /* Don't let the very last slot in the buffer become full, */
3670 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
3673 *kbd_fetch_ptr
= *event
;
3677 /* Limit help event positions to this range, to avoid overflow problems. */
3678 #define INPUT_EVENT_POS_MAX \
3679 ((ptrdiff_t) min (PTRDIFF_MAX, min (TYPE_MAXIMUM (Time) / 2, \
3680 MOST_POSITIVE_FIXNUM)))
3681 #define INPUT_EVENT_POS_MIN (-1 - INPUT_EVENT_POS_MAX)
3683 /* Return a Time that encodes position POS. POS must be in range. */
3686 position_to_Time (ptrdiff_t pos
)
3688 eassert (INPUT_EVENT_POS_MIN
<= pos
&& pos
<= INPUT_EVENT_POS_MAX
);
3692 /* Return the position that ENCODED_POS encodes.
3693 Avoid signed integer overflow. */
3696 Time_to_position (Time encoded_pos
)
3698 if (encoded_pos
<= INPUT_EVENT_POS_MAX
)
3700 Time encoded_pos_min
= INPUT_EVENT_POS_MIN
;
3701 eassert (encoded_pos_min
<= encoded_pos
);
3702 ptrdiff_t notpos
= -1 - encoded_pos
;
3706 /* Generate a HELP_EVENT input_event and store it in the keyboard
3709 HELP is the help form.
3711 FRAME and WINDOW are the frame and window where the help is
3712 generated. OBJECT is the Lisp object where the help was found (a
3713 buffer, a string, an overlay, or nil if neither from a string nor
3714 from a buffer). POS is the position within OBJECT where the help
3718 gen_help_event (Lisp_Object help
, Lisp_Object frame
, Lisp_Object window
,
3719 Lisp_Object object
, ptrdiff_t pos
)
3721 struct input_event event
;
3723 event
.kind
= HELP_EVENT
;
3724 event
.frame_or_window
= frame
;
3726 event
.x
= WINDOWP (window
) ? window
: frame
;
3728 event
.timestamp
= position_to_Time (pos
);
3729 kbd_buffer_store_event (&event
);
3733 /* Store HELP_EVENTs for HELP on FRAME in the input queue. */
3736 kbd_buffer_store_help_event (Lisp_Object frame
, Lisp_Object help
)
3738 struct input_event event
;
3740 event
.kind
= HELP_EVENT
;
3741 event
.frame_or_window
= frame
;
3745 event
.timestamp
= 0;
3746 kbd_buffer_store_event (&event
);
3750 /* Discard any mouse events in the event buffer by setting them to
3753 discard_mouse_events (void)
3755 struct input_event
*sp
;
3756 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3758 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3761 if (sp
->kind
== MOUSE_CLICK_EVENT
3762 || sp
->kind
== WHEEL_EVENT
3763 || sp
->kind
== HORIZ_WHEEL_EVENT
3765 || sp
->kind
== GPM_CLICK_EVENT
3767 || sp
->kind
== SCROLL_BAR_CLICK_EVENT
3768 || sp
->kind
== HORIZONTAL_SCROLL_BAR_CLICK_EVENT
)
3770 sp
->kind
= NO_EVENT
;
3776 /* Return true if there are any real events waiting in the event
3777 buffer, not counting `NO_EVENT's.
3779 Discard NO_EVENT events at the front of the input queue, possibly
3780 leaving the input queue empty if there are no real input events. */
3783 kbd_buffer_events_waiting (void)
3785 struct input_event
*sp
;
3787 for (sp
= kbd_fetch_ptr
;
3788 sp
!= kbd_store_ptr
&& sp
->kind
== NO_EVENT
;
3791 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3796 return sp
!= kbd_store_ptr
&& sp
->kind
!= NO_EVENT
;
3800 /* Clear input event EVENT. */
3803 clear_event (struct input_event
*event
)
3805 event
->kind
= NO_EVENT
;
3809 /* Read one event from the event buffer, waiting if necessary.
3810 The value is a Lisp object representing the event.
3811 The value is nil for an event that should be ignored,
3812 or that was handled here.
3813 We always read and discard one event. */
3816 kbd_buffer_get_event (KBOARD
**kbp
,
3817 bool *used_mouse_menu
,
3818 struct timespec
*end_time
)
3823 if (kbd_on_hold_p () && kbd_buffer_nr_stored () < KBD_BUFFER_SIZE
/ 4)
3825 /* Start reading input again because we have processed enough to
3826 be able to accept new events again. */
3827 unhold_keyboard_input ();
3830 #endif /* subprocesses */
3832 #if !defined HAVE_DBUS && !defined USE_FILE_NOTIFY
3834 /* In case we are running as a daemon, only do this before
3835 detaching from the terminal. */
3836 || (IS_DAEMON
&& daemon_pipe
[1] >= 0))
3840 *kbp
= current_kboard
;
3843 #endif /* !defined HAVE_DBUS && !defined USE_FILE_NOTIFY */
3845 /* Wait until there is input available. */
3848 /* Break loop if there's an unread command event. Needed in
3849 moused window autoselection which uses a timer to insert such
3851 if (CONSP (Vunread_command_events
))
3854 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3856 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3859 /* If the quit flag is set, then read_char will return
3860 quit_char, so that counts as "available input." */
3861 if (!NILP (Vquit_flag
))
3862 quit_throw_to_read_char (0);
3864 /* One way or another, wait until input is available; then, if
3865 interrupt handlers have not read it, read it now. */
3870 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3872 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3876 struct timespec now
= current_timespec ();
3877 if (timespec_cmp (*end_time
, now
) <= 0)
3878 return Qnil
; /* Finished waiting. */
3881 struct timespec duration
= timespec_sub (*end_time
, now
);
3882 wait_reading_process_output (min (duration
.tv_sec
,
3885 -1, 1, Qnil
, NULL
, 0);
3890 bool do_display
= true;
3892 if (FRAME_TERMCAP_P (SELECTED_FRAME ()))
3894 struct tty_display_info
*tty
= CURTTY ();
3896 /* When this TTY is displaying a menu, we must prevent
3897 any redisplay, because we modify the frame's glyph
3898 matrix behind the back of the display engine. */
3899 if (tty
->showing_menu
)
3903 wait_reading_process_output (0, 0, -1, do_display
, Qnil
, NULL
, 0);
3906 if (!interrupt_input
&& kbd_fetch_ptr
== kbd_store_ptr
)
3910 if (CONSP (Vunread_command_events
))
3913 first
= XCAR (Vunread_command_events
);
3914 Vunread_command_events
= XCDR (Vunread_command_events
);
3915 *kbp
= current_kboard
;
3919 /* At this point, we know that there is a readable event available
3920 somewhere. If the event queue is empty, then there must be a
3921 mouse movement enabled and available. */
3922 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3924 struct input_event
*event
;
3926 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
3930 *kbp
= event_to_kboard (event
);
3932 *kbp
= current_kboard
; /* Better than returning null ptr? */
3936 /* These two kinds of events get special handling
3937 and don't actually appear to the command loop.
3938 We return nil for them. */
3939 if (event
->kind
== SELECTION_REQUEST_EVENT
3940 || event
->kind
== SELECTION_CLEAR_EVENT
)
3943 struct input_event copy
;
3945 /* Remove it from the buffer before processing it,
3946 since otherwise swallow_events will see it
3947 and process it again. */
3949 kbd_fetch_ptr
= event
+ 1;
3950 input_pending
= readable_events (0);
3951 x_handle_selection_event (©
);
3953 /* We're getting selection request events, but we don't have
3959 #if defined (HAVE_NS)
3960 else if (event
->kind
== NS_TEXT_EVENT
)
3962 if (event
->code
== KEY_NS_PUT_WORKING_TEXT
)
3963 obj
= list1 (intern ("ns-put-working-text"));
3965 obj
= list1 (intern ("ns-unput-working-text"));
3966 kbd_fetch_ptr
= event
+ 1;
3967 if (used_mouse_menu
)
3968 *used_mouse_menu
= 1;
3972 #if defined (HAVE_X11) || defined (HAVE_NTGUI) \
3973 || defined (HAVE_NS)
3974 else if (event
->kind
== DELETE_WINDOW_EVENT
)
3976 /* Make an event (delete-frame (FRAME)). */
3977 obj
= list2 (Qdelete_frame
, list1 (event
->frame_or_window
));
3978 kbd_fetch_ptr
= event
+ 1;
3981 #if defined (HAVE_X11) || defined (HAVE_NTGUI) \
3982 || defined (HAVE_NS)
3983 else if (event
->kind
== ICONIFY_EVENT
)
3985 /* Make an event (iconify-frame (FRAME)). */
3986 obj
= list2 (Qiconify_frame
, list1 (event
->frame_or_window
));
3987 kbd_fetch_ptr
= event
+ 1;
3989 else if (event
->kind
== DEICONIFY_EVENT
)
3991 /* Make an event (make-frame-visible (FRAME)). */
3992 obj
= list2 (Qmake_frame_visible
, list1 (event
->frame_or_window
));
3993 kbd_fetch_ptr
= event
+ 1;
3996 else if (event
->kind
== BUFFER_SWITCH_EVENT
)
3998 /* The value doesn't matter here; only the type is tested. */
3999 XSETBUFFER (obj
, current_buffer
);
4000 kbd_fetch_ptr
= event
+ 1;
4002 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
4003 || defined (HAVE_NS) || defined (USE_GTK)
4004 else if (event
->kind
== MENU_BAR_ACTIVATE_EVENT
)
4006 kbd_fetch_ptr
= event
+ 1;
4007 input_pending
= readable_events (0);
4008 if (FRAME_LIVE_P (XFRAME (event
->frame_or_window
)))
4009 x_activate_menubar (XFRAME (event
->frame_or_window
));
4013 else if (event
->kind
== LANGUAGE_CHANGE_EVENT
)
4015 /* Make an event (language-change FRAME CODEPAGE LANGUAGE-ID). */
4016 obj
= list4 (Qlanguage_change
,
4017 event
->frame_or_window
,
4018 make_number (event
->code
),
4019 make_number (event
->modifiers
));
4020 kbd_fetch_ptr
= event
+ 1;
4023 #ifdef USE_FILE_NOTIFY
4024 else if (event
->kind
== FILE_NOTIFY_EVENT
)
4026 #ifdef HAVE_W32NOTIFY
4027 /* Make an event (file-notify (DESCRIPTOR ACTION FILE) CALLBACK). */
4028 obj
= list3 (Qfile_notify
,
4029 list3 (make_number (event
->code
),
4032 event
->frame_or_window
);
4034 obj
= make_lispy_event (event
);
4036 kbd_fetch_ptr
= event
+ 1;
4038 #endif /* USE_FILE_NOTIFY */
4039 else if (event
->kind
== SAVE_SESSION_EVENT
)
4041 obj
= list2 (Qsave_session
, event
->arg
);
4042 kbd_fetch_ptr
= event
+ 1;
4044 /* Just discard these, by returning nil.
4045 With MULTI_KBOARD, these events are used as placeholders
4046 when we need to randomly delete events from the queue.
4047 (They shouldn't otherwise be found in the buffer,
4048 but on some machines it appears they do show up
4049 even without MULTI_KBOARD.) */
4050 /* On Windows NT/9X, NO_EVENT is used to delete extraneous
4051 mouse events during a popup-menu call. */
4052 else if (event
->kind
== NO_EVENT
)
4053 kbd_fetch_ptr
= event
+ 1;
4054 else if (event
->kind
== HELP_EVENT
)
4056 Lisp_Object object
, position
, help
, frame
, window
;
4058 frame
= event
->frame_or_window
;
4059 object
= event
->arg
;
4060 position
= make_number (Time_to_position (event
->timestamp
));
4063 clear_event (event
);
4065 kbd_fetch_ptr
= event
+ 1;
4066 if (!WINDOWP (window
))
4068 obj
= Fcons (Qhelp_echo
,
4069 list5 (frame
, help
, window
, object
, position
));
4071 else if (event
->kind
== FOCUS_IN_EVENT
)
4073 /* Notification of a FocusIn event. The frame receiving the
4074 focus is in event->frame_or_window. Generate a
4075 switch-frame event if necessary. */
4076 Lisp_Object frame
, focus
;
4078 frame
= event
->frame_or_window
;
4079 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
4088 !EQ (frame
, internal_last_event_frame
)
4089 && !EQ (frame
, selected_frame
))
4090 obj
= make_lispy_switch_frame (frame
);
4092 obj
= make_lispy_focus_in (frame
);
4094 internal_last_event_frame
= frame
;
4095 kbd_fetch_ptr
= event
+ 1;
4097 else if (event
->kind
== FOCUS_OUT_EVENT
)
4099 #ifdef HAVE_WINDOW_SYSTEM
4102 Lisp_Object frame
= event
->frame_or_window
;
4103 bool focused
= false;
4105 for (di
= x_display_list
; di
&& ! focused
; di
= di
->next
)
4106 focused
= di
->x_highlight_frame
!= 0;
4109 obj
= make_lispy_focus_out (frame
);
4111 #endif /* HAVE_WINDOW_SYSTEM */
4113 kbd_fetch_ptr
= event
+ 1;
4116 else if (event
->kind
== DBUS_EVENT
)
4118 obj
= make_lispy_event (event
);
4119 kbd_fetch_ptr
= event
+ 1;
4122 else if (event
->kind
== CONFIG_CHANGED_EVENT
)
4124 obj
= make_lispy_event (event
);
4125 kbd_fetch_ptr
= event
+ 1;
4129 /* If this event is on a different frame, return a switch-frame this
4130 time, and leave the event in the queue for next time. */
4134 frame
= event
->frame_or_window
;
4136 frame
= XCAR (frame
);
4137 else if (WINDOWP (frame
))
4138 frame
= WINDOW_FRAME (XWINDOW (frame
));
4140 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
4144 if (! EQ (frame
, internal_last_event_frame
)
4145 && !EQ (frame
, selected_frame
))
4146 obj
= make_lispy_switch_frame (frame
);
4147 internal_last_event_frame
= frame
;
4149 /* If we didn't decide to make a switch-frame event, go ahead
4150 and build a real event from the queue entry. */
4154 obj
= make_lispy_event (event
);
4156 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
4157 || defined (HAVE_NS) || defined (USE_GTK)
4158 /* If this was a menu selection, then set the flag to inhibit
4159 writing to last_nonmenu_event. Don't do this if the event
4160 we're returning is (menu-bar), though; that indicates the
4161 beginning of the menu sequence, and we might as well leave
4162 that as the `event with parameters' for this selection. */
4164 && !EQ (event
->frame_or_window
, event
->arg
)
4165 && (event
->kind
== MENU_BAR_EVENT
4166 || event
->kind
== TOOL_BAR_EVENT
))
4167 *used_mouse_menu
= 1;
4170 /* Certain system events are non-key events. */
4172 && event
->kind
== NS_NONKEY_EVENT
)
4173 *used_mouse_menu
= 1;
4176 /* Wipe out this event, to catch bugs. */
4177 clear_event (event
);
4178 kbd_fetch_ptr
= event
+ 1;
4182 /* Try generating a mouse motion event. */
4183 else if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
4185 struct frame
*f
= some_mouse_moved ();
4186 Lisp_Object bar_window
;
4187 enum scroll_bar_part part
;
4191 *kbp
= current_kboard
;
4192 /* Note that this uses F to determine which terminal to look at.
4193 If there is no valid info, it does not store anything
4194 so x remains nil. */
4197 /* XXX Can f or mouse_position_hook be NULL here? */
4198 if (f
&& FRAME_TERMINAL (f
)->mouse_position_hook
)
4199 (*FRAME_TERMINAL (f
)->mouse_position_hook
) (&f
, 0, &bar_window
,
4204 /* Decide if we should generate a switch-frame event. Don't
4205 generate switch-frame events for motion outside of all Emacs
4211 frame
= FRAME_FOCUS_FRAME (f
);
4213 XSETFRAME (frame
, f
);
4215 if (! EQ (frame
, internal_last_event_frame
)
4216 && !EQ (frame
, selected_frame
))
4217 obj
= make_lispy_switch_frame (frame
);
4218 internal_last_event_frame
= frame
;
4221 /* If we didn't decide to make a switch-frame event, go ahead and
4222 return a mouse-motion event. */
4223 if (!NILP (x
) && NILP (obj
))
4224 obj
= make_lispy_movement (f
, bar_window
, part
, x
, y
, t
);
4227 /* We were promised by the above while loop that there was
4228 something for us to read! */
4231 input_pending
= readable_events (0);
4233 Vlast_event_frame
= internal_last_event_frame
;
4238 /* Process any non-user-visible events (currently X selection events),
4239 without reading any user-visible events. */
4242 process_special_events (void)
4244 struct input_event
*event
;
4246 for (event
= kbd_fetch_ptr
; event
!= kbd_store_ptr
; ++event
)
4248 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
4251 if (event
== kbd_store_ptr
)
4255 /* If we find a stored X selection request, handle it now. */
4256 if (event
->kind
== SELECTION_REQUEST_EVENT
4257 || event
->kind
== SELECTION_CLEAR_EVENT
)
4261 /* Remove the event from the fifo buffer before processing;
4262 otherwise swallow_events called recursively could see it
4263 and process it again. To do this, we move the events
4264 between kbd_fetch_ptr and EVENT one slot to the right,
4267 struct input_event copy
= *event
;
4268 struct input_event
*beg
4269 = (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
4270 ? kbd_buffer
: kbd_fetch_ptr
;
4273 memmove (beg
+ 1, beg
, (event
- beg
) * sizeof (struct input_event
));
4274 else if (event
< beg
)
4276 if (event
> kbd_buffer
)
4277 memmove (kbd_buffer
+ 1, kbd_buffer
,
4278 (event
- kbd_buffer
) * sizeof (struct input_event
));
4279 *kbd_buffer
= *(kbd_buffer
+ KBD_BUFFER_SIZE
- 1);
4280 if (beg
< kbd_buffer
+ KBD_BUFFER_SIZE
- 1)
4281 memmove (beg
+ 1, beg
,
4282 (kbd_buffer
+ KBD_BUFFER_SIZE
- 1 - beg
)
4283 * sizeof (struct input_event
));
4286 if (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
4287 kbd_fetch_ptr
= kbd_buffer
+ 1;
4291 input_pending
= readable_events (0);
4292 x_handle_selection_event (©
);
4294 /* We're getting selection request events, but we don't have
4302 /* Process any events that are not user-visible, run timer events that
4303 are ripe, and return, without reading any user-visible events. */
4306 swallow_events (bool do_display
)
4308 unsigned old_timers_run
;
4310 process_special_events ();
4312 old_timers_run
= timers_run
;
4313 get_input_pending (READABLE_EVENTS_DO_TIMERS_NOW
);
4315 if (!input_pending
&& timers_run
!= old_timers_run
&& do_display
)
4316 redisplay_preserve_echo_area (7);
4319 /* Record the start of when Emacs is idle,
4320 for the sake of running idle-time timers. */
4323 timer_start_idle (void)
4325 /* If we are already in the idle state, do nothing. */
4326 if (timespec_valid_p (timer_idleness_start_time
))
4329 timer_idleness_start_time
= current_timespec ();
4330 timer_last_idleness_start_time
= timer_idleness_start_time
;
4332 /* Mark all idle-time timers as once again candidates for running. */
4333 call0 (intern ("internal-timer-start-idle"));
4336 /* Record that Emacs is no longer idle, so stop running idle-time timers. */
4339 timer_stop_idle (void)
4341 timer_idleness_start_time
= invalid_timespec ();
4344 /* Resume idle timer from last idle start time. */
4347 timer_resume_idle (void)
4349 if (timespec_valid_p (timer_idleness_start_time
))
4352 timer_idleness_start_time
= timer_last_idleness_start_time
;
4355 /* This is only for debugging. */
4356 struct input_event last_timer_event EXTERNALLY_VISIBLE
;
4358 /* List of elisp functions to call, delayed because they were generated in
4359 a context where Elisp could not be safely run (e.g. redisplay, signal,
4360 ...). Each element has the form (FUN . ARGS). */
4361 Lisp_Object pending_funcalls
;
4363 /* Return true if TIMER is a valid timer, placing its value into *RESULT. */
4365 decode_timer (Lisp_Object timer
, struct timespec
*result
)
4367 Lisp_Object
*vector
;
4369 if (! (VECTORP (timer
) && ASIZE (timer
) == 9))
4371 vector
= XVECTOR (timer
)->contents
;
4372 if (! NILP (vector
[0]))
4374 if (! INTEGERP (vector
[2]))
4378 if (! decode_time_components (vector
[1], vector
[2], vector
[3], vector
[8],
4381 *result
= lisp_to_timespec (t
);
4382 return timespec_valid_p (*result
);
4386 /* Check whether a timer has fired. To prevent larger problems we simply
4387 disregard elements that are not proper timers. Do not make a circular
4388 timer list for the time being.
4390 Returns the time to wait until the next timer fires. If a
4391 timer is triggering now, return zero.
4392 If no timer is active, return -1.
4394 If a timer is ripe, we run it, with quitting turned off.
4395 In that case we return 0 to indicate that a new timer_check_2 call
4398 static struct timespec
4399 timer_check_2 (Lisp_Object timers
, Lisp_Object idle_timers
)
4401 struct timespec nexttime
;
4402 struct timespec now
;
4403 struct timespec idleness_now
;
4404 Lisp_Object chosen_timer
;
4405 struct gcpro gcpro1
;
4407 nexttime
= invalid_timespec ();
4409 chosen_timer
= Qnil
;
4410 GCPRO1 (chosen_timer
);
4412 /* First run the code that was delayed. */
4413 while (CONSP (pending_funcalls
))
4415 Lisp_Object funcall
= XCAR (pending_funcalls
);
4416 pending_funcalls
= XCDR (pending_funcalls
);
4417 safe_call2 (Qapply
, XCAR (funcall
), XCDR (funcall
));
4420 if (CONSP (timers
) || CONSP (idle_timers
))
4422 now
= current_timespec ();
4423 idleness_now
= (timespec_valid_p (timer_idleness_start_time
)
4424 ? timespec_sub (now
, timer_idleness_start_time
)
4425 : make_timespec (0, 0));
4428 while (CONSP (timers
) || CONSP (idle_timers
))
4430 Lisp_Object timer
= Qnil
, idle_timer
= Qnil
;
4431 struct timespec timer_time
, idle_timer_time
;
4432 struct timespec difference
;
4433 struct timespec timer_difference
= invalid_timespec ();
4434 struct timespec idle_timer_difference
= invalid_timespec ();
4435 bool ripe
, timer_ripe
= 0, idle_timer_ripe
= 0;
4437 /* Set TIMER and TIMER_DIFFERENCE
4438 based on the next ordinary timer.
4439 TIMER_DIFFERENCE is the distance in time from NOW to when
4440 this timer becomes ripe (negative if it's already ripe).
4441 Skip past invalid timers and timers already handled. */
4444 timer
= XCAR (timers
);
4445 if (! decode_timer (timer
, &timer_time
))
4447 timers
= XCDR (timers
);
4451 timer_ripe
= timespec_cmp (timer_time
, now
) <= 0;
4452 timer_difference
= (timer_ripe
4453 ? timespec_sub (now
, timer_time
)
4454 : timespec_sub (timer_time
, now
));
4457 /* Likewise for IDLE_TIMER and IDLE_TIMER_DIFFERENCE
4458 based on the next idle timer. */
4459 if (CONSP (idle_timers
))
4461 idle_timer
= XCAR (idle_timers
);
4462 if (! decode_timer (idle_timer
, &idle_timer_time
))
4464 idle_timers
= XCDR (idle_timers
);
4468 idle_timer_ripe
= timespec_cmp (idle_timer_time
, idleness_now
) <= 0;
4469 idle_timer_difference
4471 ? timespec_sub (idleness_now
, idle_timer_time
)
4472 : timespec_sub (idle_timer_time
, idleness_now
));
4475 /* Decide which timer is the next timer,
4476 and set CHOSEN_TIMER, DIFFERENCE, and RIPE accordingly.
4477 Also step down the list where we found that timer. */
4479 if (timespec_valid_p (timer_difference
)
4480 && (! timespec_valid_p (idle_timer_difference
)
4481 || idle_timer_ripe
< timer_ripe
4482 || (idle_timer_ripe
== timer_ripe
4484 ? timespec_cmp (idle_timer_difference
,
4486 : timespec_cmp (timer_difference
,
4487 idle_timer_difference
))
4490 chosen_timer
= timer
;
4491 timers
= XCDR (timers
);
4492 difference
= timer_difference
;
4497 chosen_timer
= idle_timer
;
4498 idle_timers
= XCDR (idle_timers
);
4499 difference
= idle_timer_difference
;
4500 ripe
= idle_timer_ripe
;
4503 /* If timer is ripe, run it if it hasn't been run. */
4506 if (NILP (AREF (chosen_timer
, 0)))
4508 ptrdiff_t count
= SPECPDL_INDEX ();
4509 Lisp_Object old_deactivate_mark
= Vdeactivate_mark
;
4511 /* Mark the timer as triggered to prevent problems if the lisp
4512 code fails to reschedule it right. */
4513 ASET (chosen_timer
, 0, Qt
);
4515 specbind (Qinhibit_quit
, Qt
);
4517 call1 (Qtimer_event_handler
, chosen_timer
);
4518 Vdeactivate_mark
= old_deactivate_mark
;
4520 unbind_to (count
, Qnil
);
4522 /* Since we have handled the event,
4523 we don't need to tell the caller to wake up and do it. */
4524 /* But the caller must still wait for the next timer, so
4525 return 0 to indicate that. */
4528 nexttime
= make_timespec (0, 0);
4532 /* When we encounter a timer that is still waiting,
4533 return the amount of time to wait before it is ripe. */
4540 /* No timers are pending in the future. */
4541 /* Return 0 if we generated an event, and -1 if not. */
4547 /* Check whether a timer has fired. To prevent larger problems we simply
4548 disregard elements that are not proper timers. Do not make a circular
4549 timer list for the time being.
4551 Returns the time to wait until the next timer fires.
4552 If no timer is active, return an invalid value.
4554 As long as any timer is ripe, we run it. */
4559 struct timespec nexttime
;
4560 Lisp_Object timers
, idle_timers
;
4561 struct gcpro gcpro1
, gcpro2
;
4563 Lisp_Object tem
= Vinhibit_quit
;
4566 /* We use copies of the timers' lists to allow a timer to add itself
4567 again, without locking up Emacs if the newly added timer is
4568 already ripe when added. */
4570 /* Always consider the ordinary timers. */
4571 timers
= Fcopy_sequence (Vtimer_list
);
4572 /* Consider the idle timers only if Emacs is idle. */
4573 if (timespec_valid_p (timer_idleness_start_time
))
4574 idle_timers
= Fcopy_sequence (Vtimer_idle_list
);
4578 Vinhibit_quit
= tem
;
4580 GCPRO2 (timers
, idle_timers
);
4584 nexttime
= timer_check_2 (timers
, idle_timers
);
4586 while (nexttime
.tv_sec
== 0 && nexttime
.tv_nsec
== 0);
4592 DEFUN ("current-idle-time", Fcurrent_idle_time
, Scurrent_idle_time
, 0, 0, 0,
4593 doc
: /* Return the current length of Emacs idleness, or nil.
4594 The value when Emacs is idle is a list of four integers (HIGH LOW USEC PSEC)
4595 in the same style as (current-time).
4597 The value when Emacs is not idle is nil.
4599 PSEC is a multiple of the system clock resolution. */)
4602 if (timespec_valid_p (timer_idleness_start_time
))
4603 return make_lisp_time (timespec_sub (current_timespec (),
4604 timer_idleness_start_time
));
4609 /* Caches for modify_event_symbol. */
4610 static Lisp_Object accent_key_syms
;
4611 static Lisp_Object func_key_syms
;
4612 static Lisp_Object mouse_syms
;
4613 static Lisp_Object wheel_syms
;
4614 static Lisp_Object drag_n_drop_syms
;
4616 /* This is a list of keysym codes for special "accent" characters.
4617 It parallels lispy_accent_keys. */
4619 static const int lispy_accent_codes
[] =
4621 #ifdef XK_dead_circumflex
4626 #ifdef XK_dead_grave
4631 #ifdef XK_dead_tilde
4636 #ifdef XK_dead_diaeresis
4641 #ifdef XK_dead_macron
4646 #ifdef XK_dead_degree
4651 #ifdef XK_dead_acute
4656 #ifdef XK_dead_cedilla
4661 #ifdef XK_dead_breve
4666 #ifdef XK_dead_ogonek
4671 #ifdef XK_dead_caron
4676 #ifdef XK_dead_doubleacute
4677 XK_dead_doubleacute
,
4681 #ifdef XK_dead_abovedot
4686 #ifdef XK_dead_abovering
4696 #ifdef XK_dead_belowdot
4701 #ifdef XK_dead_voiced_sound
4702 XK_dead_voiced_sound
,
4706 #ifdef XK_dead_semivoiced_sound
4707 XK_dead_semivoiced_sound
,
4723 /* This is a list of Lisp names for special "accent" characters.
4724 It parallels lispy_accent_codes. */
4726 static const char *const lispy_accent_keys
[] =
4744 "dead-voiced-sound",
4745 "dead-semivoiced-sound",
4751 #define FUNCTION_KEY_OFFSET 0x0
4753 const char *const lispy_function_keys
[] =
4757 0, /* VK_LBUTTON 0x01 */
4758 0, /* VK_RBUTTON 0x02 */
4759 "cancel", /* VK_CANCEL 0x03 */
4760 0, /* VK_MBUTTON 0x04 */
4762 0, 0, 0, /* 0x05 .. 0x07 */
4764 "backspace", /* VK_BACK 0x08 */
4765 "tab", /* VK_TAB 0x09 */
4767 0, 0, /* 0x0A .. 0x0B */
4769 "clear", /* VK_CLEAR 0x0C */
4770 "return", /* VK_RETURN 0x0D */
4772 0, 0, /* 0x0E .. 0x0F */
4774 0, /* VK_SHIFT 0x10 */
4775 0, /* VK_CONTROL 0x11 */
4776 0, /* VK_MENU 0x12 */
4777 "pause", /* VK_PAUSE 0x13 */
4778 "capslock", /* VK_CAPITAL 0x14 */
4779 "kana", /* VK_KANA/VK_HANGUL 0x15 */
4781 "junja", /* VK_JUNJA 0x17 */
4782 "final", /* VK_FINAL 0x18 */
4783 "kanji", /* VK_KANJI/VK_HANJA 0x19 */
4785 "escape", /* VK_ESCAPE 0x1B */
4786 "convert", /* VK_CONVERT 0x1C */
4787 "non-convert", /* VK_NONCONVERT 0x1D */
4788 "accept", /* VK_ACCEPT 0x1E */
4789 "mode-change", /* VK_MODECHANGE 0x1F */
4790 0, /* VK_SPACE 0x20 */
4791 "prior", /* VK_PRIOR 0x21 */
4792 "next", /* VK_NEXT 0x22 */
4793 "end", /* VK_END 0x23 */
4794 "home", /* VK_HOME 0x24 */
4795 "left", /* VK_LEFT 0x25 */
4796 "up", /* VK_UP 0x26 */
4797 "right", /* VK_RIGHT 0x27 */
4798 "down", /* VK_DOWN 0x28 */
4799 "select", /* VK_SELECT 0x29 */
4800 "print", /* VK_PRINT 0x2A */
4801 "execute", /* VK_EXECUTE 0x2B */
4802 "snapshot", /* VK_SNAPSHOT 0x2C */
4803 "insert", /* VK_INSERT 0x2D */
4804 "delete", /* VK_DELETE 0x2E */
4805 "help", /* VK_HELP 0x2F */
4807 /* VK_0 thru VK_9 are the same as ASCII '0' thru '9' (0x30 - 0x39) */
4809 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4811 0, 0, 0, 0, 0, 0, 0, /* 0x3A .. 0x40 */
4813 /* VK_A thru VK_Z are the same as ASCII 'A' thru 'Z' (0x41 - 0x5A) */
4815 0, 0, 0, 0, 0, 0, 0, 0, 0,
4816 0, 0, 0, 0, 0, 0, 0, 0, 0,
4817 0, 0, 0, 0, 0, 0, 0, 0,
4819 "lwindow", /* VK_LWIN 0x5B */
4820 "rwindow", /* VK_RWIN 0x5C */
4821 "apps", /* VK_APPS 0x5D */
4824 "kp-0", /* VK_NUMPAD0 0x60 */
4825 "kp-1", /* VK_NUMPAD1 0x61 */
4826 "kp-2", /* VK_NUMPAD2 0x62 */
4827 "kp-3", /* VK_NUMPAD3 0x63 */
4828 "kp-4", /* VK_NUMPAD4 0x64 */
4829 "kp-5", /* VK_NUMPAD5 0x65 */
4830 "kp-6", /* VK_NUMPAD6 0x66 */
4831 "kp-7", /* VK_NUMPAD7 0x67 */
4832 "kp-8", /* VK_NUMPAD8 0x68 */
4833 "kp-9", /* VK_NUMPAD9 0x69 */
4834 "kp-multiply", /* VK_MULTIPLY 0x6A */
4835 "kp-add", /* VK_ADD 0x6B */
4836 "kp-separator", /* VK_SEPARATOR 0x6C */
4837 "kp-subtract", /* VK_SUBTRACT 0x6D */
4838 "kp-decimal", /* VK_DECIMAL 0x6E */
4839 "kp-divide", /* VK_DIVIDE 0x6F */
4840 "f1", /* VK_F1 0x70 */
4841 "f2", /* VK_F2 0x71 */
4842 "f3", /* VK_F3 0x72 */
4843 "f4", /* VK_F4 0x73 */
4844 "f5", /* VK_F5 0x74 */
4845 "f6", /* VK_F6 0x75 */
4846 "f7", /* VK_F7 0x76 */
4847 "f8", /* VK_F8 0x77 */
4848 "f9", /* VK_F9 0x78 */
4849 "f10", /* VK_F10 0x79 */
4850 "f11", /* VK_F11 0x7A */
4851 "f12", /* VK_F12 0x7B */
4852 "f13", /* VK_F13 0x7C */
4853 "f14", /* VK_F14 0x7D */
4854 "f15", /* VK_F15 0x7E */
4855 "f16", /* VK_F16 0x7F */
4856 "f17", /* VK_F17 0x80 */
4857 "f18", /* VK_F18 0x81 */
4858 "f19", /* VK_F19 0x82 */
4859 "f20", /* VK_F20 0x83 */
4860 "f21", /* VK_F21 0x84 */
4861 "f22", /* VK_F22 0x85 */
4862 "f23", /* VK_F23 0x86 */
4863 "f24", /* VK_F24 0x87 */
4865 0, 0, 0, 0, /* 0x88 .. 0x8B */
4866 0, 0, 0, 0, /* 0x8C .. 0x8F */
4868 "kp-numlock", /* VK_NUMLOCK 0x90 */
4869 "scroll", /* VK_SCROLL 0x91 */
4870 /* Not sure where the following block comes from.
4871 Windows headers have NEC and Fujitsu specific keys in
4872 this block, but nothing generic. */
4873 "kp-space", /* VK_NUMPAD_CLEAR 0x92 */
4874 "kp-enter", /* VK_NUMPAD_ENTER 0x93 */
4875 "kp-prior", /* VK_NUMPAD_PRIOR 0x94 */
4876 "kp-next", /* VK_NUMPAD_NEXT 0x95 */
4877 "kp-end", /* VK_NUMPAD_END 0x96 */
4878 "kp-home", /* VK_NUMPAD_HOME 0x97 */
4879 "kp-left", /* VK_NUMPAD_LEFT 0x98 */
4880 "kp-up", /* VK_NUMPAD_UP 0x99 */
4881 "kp-right", /* VK_NUMPAD_RIGHT 0x9A */
4882 "kp-down", /* VK_NUMPAD_DOWN 0x9B */
4883 "kp-insert", /* VK_NUMPAD_INSERT 0x9C */
4884 "kp-delete", /* VK_NUMPAD_DELETE 0x9D */
4886 0, 0, /* 0x9E .. 0x9F */
4889 * VK_L* & VK_R* - left and right Alt, Ctrl and Shift virtual keys.
4890 * Used only as parameters to GetAsyncKeyState and GetKeyState.
4891 * No other API or message will distinguish left and right keys this way.
4896 /* Multimedia keys. These are handled as WM_APPCOMMAND, which allows us
4897 to enable them selectively, and gives access to a few more functions.
4898 See lispy_multimedia_keys below. */
4899 0, 0, 0, 0, 0, 0, 0, /* 0xA6 .. 0xAC Browser */
4900 0, 0, 0, /* 0xAD .. 0xAF Volume */
4901 0, 0, 0, 0, /* 0xB0 .. 0xB3 Media */
4902 0, 0, 0, 0, /* 0xB4 .. 0xB7 Apps */
4904 /* 0xB8 .. 0xC0 "OEM" keys - all seem to be punctuation. */
4905 0, 0, 0, 0, 0, 0, 0, 0, 0,
4907 /* 0xC1 - 0xDA unallocated, 0xDB-0xDF more OEM keys */
4908 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4909 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4912 "ax", /* VK_OEM_AX 0xE1 */
4913 0, /* VK_OEM_102 0xE2 */
4914 "ico-help", /* VK_ICO_HELP 0xE3 */
4915 "ico-00", /* VK_ICO_00 0xE4 */
4916 0, /* VK_PROCESSKEY 0xE5 - used by IME */
4917 "ico-clear", /* VK_ICO_CLEAR 0xE6 */
4918 0, /* VK_PACKET 0xE7 - used to pass Unicode chars */
4920 "reset", /* VK_OEM_RESET 0xE9 */
4921 "jump", /* VK_OEM_JUMP 0xEA */
4922 "oem-pa1", /* VK_OEM_PA1 0xEB */
4923 "oem-pa2", /* VK_OEM_PA2 0xEC */
4924 "oem-pa3", /* VK_OEM_PA3 0xED */
4925 "wsctrl", /* VK_OEM_WSCTRL 0xEE */
4926 "cusel", /* VK_OEM_CUSEL 0xEF */
4927 "oem-attn", /* VK_OEM_ATTN 0xF0 */
4928 "finish", /* VK_OEM_FINISH 0xF1 */
4929 "copy", /* VK_OEM_COPY 0xF2 */
4930 "auto", /* VK_OEM_AUTO 0xF3 */
4931 "enlw", /* VK_OEM_ENLW 0xF4 */
4932 "backtab", /* VK_OEM_BACKTAB 0xF5 */
4933 "attn", /* VK_ATTN 0xF6 */
4934 "crsel", /* VK_CRSEL 0xF7 */
4935 "exsel", /* VK_EXSEL 0xF8 */
4936 "ereof", /* VK_EREOF 0xF9 */
4937 "play", /* VK_PLAY 0xFA */
4938 "zoom", /* VK_ZOOM 0xFB */
4939 "noname", /* VK_NONAME 0xFC */
4940 "pa1", /* VK_PA1 0xFD */
4941 "oem_clear", /* VK_OEM_CLEAR 0xFE */
4945 /* Some of these duplicate the "Media keys" on newer keyboards,
4946 but they are delivered to the application in a different way. */
4947 static const char *const lispy_multimedia_keys
[] =
4955 "browser-favorites",
4992 "toggle-dictate-command",
4998 "media-fast-forward",
5001 "media-channel-down"
5004 #else /* not HAVE_NTGUI */
5006 /* This should be dealt with in XTread_socket now, and that doesn't
5007 depend on the client system having the Kana syms defined. See also
5008 the XK_kana_A case below. */
5011 static const char *const lispy_kana_keys
[] =
5013 /* X Keysym value */
5014 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x400 .. 0x40f */
5015 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x410 .. 0x41f */
5016 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x420 .. 0x42f */
5017 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x430 .. 0x43f */
5018 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x440 .. 0x44f */
5019 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x450 .. 0x45f */
5020 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x460 .. 0x46f */
5021 0,0,0,0,0,0,0,0,0,0,0,0,0,0,"overline",0,
5022 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x480 .. 0x48f */
5023 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x490 .. 0x49f */
5024 0, "kana-fullstop", "kana-openingbracket", "kana-closingbracket",
5025 "kana-comma", "kana-conjunctive", "kana-WO", "kana-a",
5026 "kana-i", "kana-u", "kana-e", "kana-o",
5027 "kana-ya", "kana-yu", "kana-yo", "kana-tsu",
5028 "prolongedsound", "kana-A", "kana-I", "kana-U",
5029 "kana-E", "kana-O", "kana-KA", "kana-KI",
5030 "kana-KU", "kana-KE", "kana-KO", "kana-SA",
5031 "kana-SHI", "kana-SU", "kana-SE", "kana-SO",
5032 "kana-TA", "kana-CHI", "kana-TSU", "kana-TE",
5033 "kana-TO", "kana-NA", "kana-NI", "kana-NU",
5034 "kana-NE", "kana-NO", "kana-HA", "kana-HI",
5035 "kana-FU", "kana-HE", "kana-HO", "kana-MA",
5036 "kana-MI", "kana-MU", "kana-ME", "kana-MO",
5037 "kana-YA", "kana-YU", "kana-YO", "kana-RA",
5038 "kana-RI", "kana-RU", "kana-RE", "kana-RO",
5039 "kana-WA", "kana-N", "voicedsound", "semivoicedsound",
5040 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4e0 .. 0x4ef */
5041 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4f0 .. 0x4ff */
5043 #endif /* XK_kana_A */
5046 #define FUNCTION_KEY_OFFSET 0xff00
5048 /* You'll notice that this table is arranged to be conveniently
5049 indexed by X Windows keysym values. */
5050 static const char *const lispy_function_keys
[] =
5052 /* X Keysym value */
5054 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff00...0f */
5055 "backspace", "tab", "linefeed", "clear",
5057 0, 0, 0, "pause", /* 0xff10...1f */
5058 0, 0, 0, 0, 0, 0, 0, "escape",
5060 0, "kanji", "muhenkan", "henkan", /* 0xff20...2f */
5061 "romaji", "hiragana", "katakana", "hiragana-katakana",
5062 "zenkaku", "hankaku", "zenkaku-hankaku", "touroku",
5063 "massyo", "kana-lock", "kana-shift", "eisu-shift",
5064 "eisu-toggle", /* 0xff30...3f */
5065 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
5066 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff40...4f */
5068 "home", "left", "up", "right", /* 0xff50 */ /* IsCursorKey */
5069 "down", "prior", "next", "end",
5070 "begin", 0, 0, 0, 0, 0, 0, 0,
5071 "select", /* 0xff60 */ /* IsMiscFunctionKey */
5082 "break", /* 0xff6b */
5085 0, 0, 0, 0, "backtab", 0, 0, 0, /* 0xff70... */
5086 0, 0, 0, 0, 0, 0, 0, "kp-numlock", /* 0xff78... */
5087 "kp-space", /* 0xff80 */ /* IsKeypadKey */
5088 0, 0, 0, 0, 0, 0, 0, 0,
5089 "kp-tab", /* 0xff89 */
5091 "kp-enter", /* 0xff8d */
5093 "kp-f1", /* 0xff91 */
5097 "kp-home", /* 0xff95 */
5102 "kp-prior", /* kp-page-up */
5103 "kp-next", /* kp-page-down */
5109 0, 0, 0, 0, 0, 0, 0, 0, 0,
5110 "kp-multiply", /* 0xffaa */
5115 "kp-divide", /* 0xffaf */
5116 "kp-0", /* 0xffb0 */
5117 "kp-1", "kp-2", "kp-3", "kp-4", "kp-5", "kp-6", "kp-7", "kp-8", "kp-9",
5120 "kp-equal", /* 0xffbd */
5121 "f1", /* 0xffbe */ /* IsFunctionKey */
5123 "f3", "f4", "f5", "f6", "f7", "f8", "f9", "f10", /* 0xffc0 */
5124 "f11", "f12", "f13", "f14", "f15", "f16", "f17", "f18",
5125 "f19", "f20", "f21", "f22", "f23", "f24", "f25", "f26", /* 0xffd0 */
5126 "f27", "f28", "f29", "f30", "f31", "f32", "f33", "f34",
5127 "f35", 0, 0, 0, 0, 0, 0, 0, /* 0xffe0 */
5128 0, 0, 0, 0, 0, 0, 0, 0,
5129 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfff0 */
5130 0, 0, 0, 0, 0, 0, 0, "delete"
5133 /* ISO 9995 Function and Modifier Keys; the first byte is 0xFE. */
5134 #define ISO_FUNCTION_KEY_OFFSET 0xfe00
5136 static const char *const iso_lispy_function_keys
[] =
5138 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe00 */
5139 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe08 */
5140 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe10 */
5141 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe18 */
5142 "iso-lefttab", /* 0xfe20 */
5143 "iso-move-line-up", "iso-move-line-down",
5144 "iso-partial-line-up", "iso-partial-line-down",
5145 "iso-partial-space-left", "iso-partial-space-right",
5146 "iso-set-margin-left", "iso-set-margin-right", /* 0xffe27, 28 */
5147 "iso-release-margin-left", "iso-release-margin-right",
5148 "iso-release-both-margins",
5149 "iso-fast-cursor-left", "iso-fast-cursor-right",
5150 "iso-fast-cursor-up", "iso-fast-cursor-down",
5151 "iso-continuous-underline", "iso-discontinuous-underline", /* 0xfe30, 31 */
5152 "iso-emphasize", "iso-center-object", "iso-enter", /* ... 0xfe34 */
5155 #endif /* not HAVE_NTGUI */
5157 static Lisp_Object Vlispy_mouse_stem
;
5159 static const char *const lispy_wheel_names
[] =
5161 "wheel-up", "wheel-down", "wheel-left", "wheel-right"
5164 /* drag-n-drop events are generated when a set of selected files are
5165 dragged from another application and dropped onto an Emacs window. */
5166 static const char *const lispy_drag_n_drop_names
[] =
5171 /* An array of scroll bar parts, indexed by an enum scroll_bar_part value.
5172 Note that Qnil corresponds to scroll_bar_nowhere and should not appear
5174 static struct Lisp_Symbol
*const scroll_bar_parts
[] = {
5175 XSYMBOL_INIT (Qnil
), XSYMBOL_INIT (Qabove_handle
), XSYMBOL_INIT (Qhandle
),
5176 XSYMBOL_INIT (Qbelow_handle
), XSYMBOL_INIT (Qup
), XSYMBOL_INIT (Qdown
),
5177 XSYMBOL_INIT (Qtop
), XSYMBOL_INIT (Qbottom
), XSYMBOL_INIT (Qend_scroll
),
5178 XSYMBOL_INIT (Qratio
), XSYMBOL_INIT (Qbefore_handle
),
5179 XSYMBOL_INIT (Qhorizontal_handle
), XSYMBOL_INIT (Qafter_handle
),
5180 XSYMBOL_INIT (Qleft
), XSYMBOL_INIT (Qright
), XSYMBOL_INIT (Qleftmost
),
5181 XSYMBOL_INIT (Qrightmost
), XSYMBOL_INIT (Qend_scroll
), XSYMBOL_INIT (Qratio
)
5184 /* A vector, indexed by button number, giving the down-going location
5185 of currently depressed buttons, both scroll bar and non-scroll bar.
5187 The elements have the form
5188 (BUTTON-NUMBER MODIFIER-MASK . REST)
5189 where REST is the cdr of a position as it would be reported in the event.
5191 The make_lispy_event function stores positions here to tell the
5192 difference between click and drag events, and to store the starting
5193 location to be included in drag events. */
5195 static Lisp_Object button_down_location
;
5197 /* Information about the most recent up-going button event: Which
5198 button, what location, and what time. */
5200 static int last_mouse_button
;
5201 static int last_mouse_x
;
5202 static int last_mouse_y
;
5203 static Time button_down_time
;
5205 /* The number of clicks in this multiple-click. */
5207 static int double_click_count
;
5209 /* X and Y are frame-relative coordinates for a click or wheel event.
5210 Return a Lisp-style event list. */
5213 make_lispy_position (struct frame
*f
, Lisp_Object x
, Lisp_Object y
,
5216 enum window_part part
;
5217 Lisp_Object posn
= Qnil
;
5218 Lisp_Object extra_info
= Qnil
;
5219 /* Coordinate pixel positions to return. */
5220 int xret
= 0, yret
= 0;
5221 /* The window under frame pixel coordinates (x,y) */
5222 Lisp_Object window
= f
5223 ? window_from_coordinates (f
, XINT (x
), XINT (y
), &part
, 0)
5226 if (WINDOWP (window
))
5228 /* It's a click in window WINDOW at frame coordinates (X,Y) */
5229 struct window
*w
= XWINDOW (window
);
5230 Lisp_Object string_info
= Qnil
;
5231 ptrdiff_t textpos
= 0;
5232 int col
= -1, row
= -1;
5233 int dx
= -1, dy
= -1;
5234 int width
= -1, height
= -1;
5235 Lisp_Object object
= Qnil
;
5237 /* Pixel coordinates relative to the window corner. */
5238 int wx
= XINT (x
) - WINDOW_LEFT_EDGE_X (w
);
5239 int wy
= XINT (y
) - WINDOW_TOP_EDGE_Y (w
);
5241 /* For text area clicks, return X, Y relative to the corner of
5242 this text area. Note that dX, dY etc are set below, by
5243 buffer_posn_from_coords. */
5244 if (part
== ON_TEXT
)
5246 xret
= XINT (x
) - window_box_left (w
, TEXT_AREA
);
5247 yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5249 /* For mode line and header line clicks, return X, Y relative to
5250 the left window edge. Use mode_line_string to look for a
5251 string on the click position. */
5252 else if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
)
5257 posn
= (part
== ON_MODE_LINE
) ? Qmode_line
: Qheader_line
;
5258 /* Note that mode_line_string takes COL, ROW as pixels and
5259 converts them to characters. */
5262 string
= mode_line_string (w
, part
, &col
, &row
, &charpos
,
5263 &object
, &dx
, &dy
, &width
, &height
);
5264 if (STRINGP (string
))
5265 string_info
= Fcons (string
, make_number (charpos
));
5271 /* For fringes and margins, Y is relative to the area's (and the
5272 window's) top edge, while X is meaningless. */
5273 else if (part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
5278 posn
= (part
== ON_LEFT_MARGIN
) ? Qleft_margin
: Qright_margin
;
5281 string
= marginal_area_string (w
, part
, &col
, &row
, &charpos
,
5282 &object
, &dx
, &dy
, &width
, &height
);
5283 if (STRINGP (string
))
5284 string_info
= Fcons (string
, make_number (charpos
));
5286 yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5288 else if (part
== ON_LEFT_FRINGE
)
5290 posn
= Qleft_fringe
;
5294 - (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5295 ? 0 : window_box_width (w
, LEFT_MARGIN_AREA
));
5296 dy
= yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5298 else if (part
== ON_RIGHT_FRINGE
)
5300 posn
= Qright_fringe
;
5304 - window_box_width (w
, LEFT_MARGIN_AREA
)
5305 - window_box_width (w
, TEXT_AREA
)
5306 - (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5307 ? window_box_width (w
, RIGHT_MARGIN_AREA
)
5309 dy
= yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5311 else if (part
== ON_VERTICAL_BORDER
)
5313 posn
= Qvertical_line
;
5319 else if (part
== ON_VERTICAL_SCROLL_BAR
)
5321 posn
= Qvertical_scroll_bar
;
5322 width
= WINDOW_SCROLL_BAR_AREA_WIDTH (w
);
5326 else if (part
== ON_HORIZONTAL_SCROLL_BAR
)
5328 posn
= Qhorizontal_scroll_bar
;
5329 width
= WINDOW_SCROLL_BAR_AREA_HEIGHT (w
);
5333 else if (part
== ON_RIGHT_DIVIDER
)
5335 posn
= Qright_divider
;
5336 width
= WINDOW_RIGHT_DIVIDER_WIDTH (w
);
5340 else if (part
== ON_BOTTOM_DIVIDER
)
5342 posn
= Qbottom_divider
;
5343 width
= WINDOW_BOTTOM_DIVIDER_WIDTH (w
);
5348 /* For clicks in the text area, fringes, or margins, call
5349 buffer_posn_from_coords to extract TEXTPOS, the buffer
5350 position nearest to the click. */
5353 Lisp_Object string2
, object2
= Qnil
;
5354 struct display_pos p
;
5356 int width2
, height2
;
5357 /* The pixel X coordinate passed to buffer_posn_from_coords
5358 is the X coordinate relative to the text area for
5359 text-area and right-margin clicks, zero otherwise. */
5361 = (part
== ON_TEXT
) ? xret
5362 : (part
== ON_RIGHT_FRINGE
|| part
== ON_RIGHT_MARGIN
)
5363 ? (XINT (x
) - window_box_left (w
, TEXT_AREA
))
5367 string2
= buffer_posn_from_coords (w
, &x2
, &y2
, &p
,
5368 &object2
, &dx2
, &dy2
,
5370 textpos
= CHARPOS (p
.pos
);
5371 if (col
< 0) col
= x2
;
5372 if (row
< 0) row
= y2
;
5373 if (dx
< 0) dx
= dx2
;
5374 if (dy
< 0) dy
= dy2
;
5375 if (width
< 0) width
= width2
;
5376 if (height
< 0) height
= height2
;
5380 posn
= make_number (textpos
);
5381 if (STRINGP (string2
))
5382 string_info
= Fcons (string2
,
5383 make_number (CHARPOS (p
.string_pos
)));
5389 #ifdef HAVE_WINDOW_SYSTEM
5390 if (IMAGEP (object
))
5392 Lisp_Object image_map
, hotspot
;
5393 if ((image_map
= Fplist_get (XCDR (object
), QCmap
),
5395 && (hotspot
= find_hot_spot (image_map
, dx
, dy
),
5397 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
5398 posn
= XCAR (hotspot
);
5405 Fcons (make_number (dx
), make_number (dy
)),
5406 Fcons (make_number (width
), make_number (height
)));
5409 extra_info
= Fcons (string_info
,
5410 Fcons (textpos
< 0 ? Qnil
: make_number (textpos
),
5411 Fcons (Fcons (make_number (col
),
5417 /* Return mouse pixel coordinates here. */
5418 XSETFRAME (window
, f
);
5425 return Fcons (window
,
5427 Fcons (Fcons (make_number (xret
),
5428 make_number (yret
)),
5429 Fcons (make_number (t
),
5433 /* Return non-zero if F is a GUI frame that uses some toolkit-managed
5434 menu bar. This really means that Emacs draws and manages the menu
5435 bar as part of its normal display, and therefore can compute its
5438 toolkit_menubar_in_use (struct frame
*f
)
5440 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS) || defined (HAVE_NTGUI)
5441 return !(!FRAME_WINDOW_P (f
));
5447 /* Build the part of Lisp event which represents scroll bar state from
5448 EV. TYPE is one of Qvertical_scroll_bar or Qhorizontal_scroll_bar. */
5451 make_scroll_bar_position (struct input_event
*ev
, Lisp_Object type
)
5453 return list5 (ev
->frame_or_window
, type
, Fcons (ev
->x
, ev
->y
),
5454 make_number (ev
->timestamp
),
5455 make_lisp_symbol (scroll_bar_parts
[ev
->part
]));
5458 /* Given a struct input_event, build the lisp event which represents
5459 it. If EVENT is 0, build a mouse movement event from the mouse
5460 movement buffer, which should have a movement event in it.
5462 Note that events must be passed to this function in the order they
5463 are received; this function stores the location of button presses
5464 in order to build drag events when the button is released. */
5467 make_lispy_event (struct input_event
*event
)
5471 switch (event
->kind
)
5473 /* A simple keystroke. */
5474 case ASCII_KEYSTROKE_EVENT
:
5475 case MULTIBYTE_CHAR_KEYSTROKE_EVENT
:
5477 Lisp_Object lispy_c
;
5478 EMACS_INT c
= event
->code
;
5479 if (event
->kind
== ASCII_KEYSTROKE_EVENT
)
5482 eassert (c
== event
->code
);
5483 /* Turn ASCII characters into control characters
5485 if (event
->modifiers
& ctrl_modifier
)
5487 c
= make_ctrl_char (c
);
5488 event
->modifiers
&= ~ctrl_modifier
;
5492 /* Add in the other modifier bits. The shift key was taken care
5493 of by the X code. */
5494 c
|= (event
->modifiers
5495 & (meta_modifier
| alt_modifier
5496 | hyper_modifier
| super_modifier
| ctrl_modifier
));
5497 /* Distinguish Shift-SPC from SPC. */
5498 if ((event
->code
) == 040
5499 && event
->modifiers
& shift_modifier
)
5500 c
|= shift_modifier
;
5501 button_down_time
= 0;
5502 XSETFASTINT (lispy_c
, c
);
5507 /* NS_NONKEY_EVENTs are just like NON_ASCII_KEYSTROKE_EVENTs,
5508 except that they are non-key events (last-nonmenu-event is nil). */
5509 case NS_NONKEY_EVENT
:
5512 /* A function key. The symbol may need to have modifier prefixes
5514 case NON_ASCII_KEYSTROKE_EVENT
:
5515 button_down_time
= 0;
5517 for (i
= 0; i
< ARRAYELTS (lispy_accent_codes
); i
++)
5518 if (event
->code
== lispy_accent_codes
[i
])
5519 return modify_event_symbol (i
,
5521 Qfunction_key
, Qnil
,
5522 lispy_accent_keys
, &accent_key_syms
,
5523 ARRAYELTS (lispy_accent_keys
));
5527 if (event
->code
>= 0x400 && event
->code
< 0x500)
5528 return modify_event_symbol (event
->code
- 0x400,
5529 event
->modifiers
& ~shift_modifier
,
5530 Qfunction_key
, Qnil
,
5531 lispy_kana_keys
, &func_key_syms
,
5532 ARRAYELTS (lispy_kana_keys
));
5533 #endif /* XK_kana_A */
5536 #ifdef ISO_FUNCTION_KEY_OFFSET
5537 if (event
->code
< FUNCTION_KEY_OFFSET
5538 && event
->code
>= ISO_FUNCTION_KEY_OFFSET
)
5539 return modify_event_symbol (event
->code
- ISO_FUNCTION_KEY_OFFSET
,
5541 Qfunction_key
, Qnil
,
5542 iso_lispy_function_keys
, &func_key_syms
,
5543 ARRAYELTS (iso_lispy_function_keys
));
5546 if ((FUNCTION_KEY_OFFSET
<= event
->code
5548 < FUNCTION_KEY_OFFSET
+ ARRAYELTS (lispy_function_keys
)))
5549 && lispy_function_keys
[event
->code
- FUNCTION_KEY_OFFSET
])
5550 return modify_event_symbol (event
->code
- FUNCTION_KEY_OFFSET
,
5552 Qfunction_key
, Qnil
,
5553 lispy_function_keys
, &func_key_syms
,
5554 ARRAYELTS (lispy_function_keys
));
5556 /* Handle system-specific or unknown keysyms.
5557 We need to use an alist rather than a vector as the cache
5558 since we can't make a vector long enough. */
5559 if (NILP (KVAR (current_kboard
, system_key_syms
)))
5560 kset_system_key_syms (current_kboard
, Fcons (Qnil
, Qnil
));
5561 return modify_event_symbol (event
->code
,
5564 KVAR (current_kboard
, Vsystem_key_alist
),
5565 0, &KVAR (current_kboard
, system_key_syms
),
5569 case MULTIMEDIA_KEY_EVENT
:
5570 if (event
->code
< ARRAYELTS (lispy_multimedia_keys
)
5571 && event
->code
> 0 && lispy_multimedia_keys
[event
->code
])
5573 return modify_event_symbol (event
->code
, event
->modifiers
,
5574 Qfunction_key
, Qnil
,
5575 lispy_multimedia_keys
, &func_key_syms
,
5576 ARRAYELTS (lispy_multimedia_keys
));
5581 /* A mouse click. Figure out where it is, decide whether it's
5582 a press, click or drag, and build the appropriate structure. */
5583 case MOUSE_CLICK_EVENT
:
5585 case GPM_CLICK_EVENT
:
5587 #ifndef USE_TOOLKIT_SCROLL_BARS
5588 case SCROLL_BAR_CLICK_EVENT
:
5589 case HORIZONTAL_SCROLL_BAR_CLICK_EVENT
:
5592 int button
= event
->code
;
5594 Lisp_Object position
;
5595 Lisp_Object
*start_pos_ptr
;
5596 Lisp_Object start_pos
;
5600 /* Build the position as appropriate for this mouse click. */
5601 if (event
->kind
== MOUSE_CLICK_EVENT
5603 || event
->kind
== GPM_CLICK_EVENT
5607 struct frame
*f
= XFRAME (event
->frame_or_window
);
5610 /* Ignore mouse events that were made on frame that
5611 have been deleted. */
5612 if (! FRAME_LIVE_P (f
))
5615 /* EVENT->x and EVENT->y are frame-relative pixel
5616 coordinates at this place. Under old redisplay, COLUMN
5617 and ROW are set to frame relative glyph coordinates
5618 which are then used to determine whether this click is
5619 in a menu (non-toolkit version). */
5620 if (!toolkit_menubar_in_use (f
))
5622 pixel_to_glyph_coords (f
, XINT (event
->x
), XINT (event
->y
),
5623 &column
, &row
, NULL
, 1);
5625 /* In the non-toolkit version, clicks on the menu bar
5626 are ordinary button events in the event buffer.
5627 Distinguish them, and invoke the menu.
5629 (In the toolkit version, the toolkit handles the
5630 menu bar and Emacs doesn't know about it until
5631 after the user makes a selection.) */
5632 if (row
>= 0 && row
< FRAME_MENU_BAR_LINES (f
)
5633 && (event
->modifiers
& down_modifier
))
5635 Lisp_Object items
, item
;
5637 /* Find the menu bar item under `column'. */
5639 items
= FRAME_MENU_BAR_ITEMS (f
);
5640 for (i
= 0; i
< ASIZE (items
); i
+= 4)
5642 Lisp_Object pos
, string
;
5643 string
= AREF (items
, i
+ 1);
5644 pos
= AREF (items
, i
+ 3);
5647 if (column
>= XINT (pos
)
5648 && column
< XINT (pos
) + SCHARS (string
))
5650 item
= AREF (items
, i
);
5655 /* ELisp manual 2.4b says (x y) are window
5656 relative but code says they are
5658 position
= list4 (event
->frame_or_window
,
5660 Fcons (event
->x
, event
->y
),
5661 make_number (event
->timestamp
));
5663 return list2 (item
, position
);
5667 position
= make_lispy_position (f
, event
->x
, event
->y
,
5670 #ifndef USE_TOOLKIT_SCROLL_BARS
5672 /* It's a scrollbar click. */
5673 position
= make_scroll_bar_position (event
, Qvertical_scroll_bar
);
5674 #endif /* not USE_TOOLKIT_SCROLL_BARS */
5676 if (button
>= ASIZE (button_down_location
))
5678 ptrdiff_t incr
= button
- ASIZE (button_down_location
) + 1;
5679 button_down_location
= larger_vector (button_down_location
,
5681 mouse_syms
= larger_vector (mouse_syms
, incr
, -1);
5684 start_pos_ptr
= aref_addr (button_down_location
, button
);
5685 start_pos
= *start_pos_ptr
;
5686 *start_pos_ptr
= Qnil
;
5689 /* On window-system frames, use the value of
5690 double-click-fuzz as is. On other frames, interpret it
5691 as a multiple of 1/8 characters. */
5695 if (WINDOWP (event
->frame_or_window
))
5696 f
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5697 else if (FRAMEP (event
->frame_or_window
))
5698 f
= XFRAME (event
->frame_or_window
);
5702 if (FRAME_WINDOW_P (f
))
5703 fuzz
= double_click_fuzz
;
5705 fuzz
= double_click_fuzz
/ 8;
5707 is_double
= (button
== last_mouse_button
5708 && (eabs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5709 && (eabs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5710 && button_down_time
!= 0
5711 && (EQ (Vdouble_click_time
, Qt
)
5712 || (NATNUMP (Vdouble_click_time
)
5713 && (event
->timestamp
- button_down_time
5714 < XFASTINT (Vdouble_click_time
)))));
5717 last_mouse_button
= button
;
5718 last_mouse_x
= XINT (event
->x
);
5719 last_mouse_y
= XINT (event
->y
);
5721 /* If this is a button press, squirrel away the location, so
5722 we can decide later whether it was a click or a drag. */
5723 if (event
->modifiers
& down_modifier
)
5727 double_click_count
++;
5728 event
->modifiers
|= ((double_click_count
> 2)
5733 double_click_count
= 1;
5734 button_down_time
= event
->timestamp
;
5735 *start_pos_ptr
= Fcopy_alist (position
);
5736 ignore_mouse_drag_p
= 0;
5739 /* Now we're releasing a button - check the co-ordinates to
5740 see if this was a click or a drag. */
5741 else if (event
->modifiers
& up_modifier
)
5743 /* If we did not see a down before this up, ignore the up.
5744 Probably this happened because the down event chose a
5745 menu item. It would be an annoyance to treat the
5746 release of the button that chose the menu item as a
5749 if (!CONSP (start_pos
))
5752 event
->modifiers
&= ~up_modifier
;
5755 Lisp_Object new_down
, down
;
5756 EMACS_INT xdiff
= double_click_fuzz
, ydiff
= double_click_fuzz
;
5758 /* The third element of every position
5759 should be the (x,y) pair. */
5760 down
= Fcar (Fcdr (Fcdr (start_pos
)));
5761 new_down
= Fcar (Fcdr (Fcdr (position
)));
5764 && INTEGERP (XCAR (down
)) && INTEGERP (XCDR (down
)))
5766 xdiff
= XINT (XCAR (new_down
)) - XINT (XCAR (down
));
5767 ydiff
= XINT (XCDR (new_down
)) - XINT (XCDR (down
));
5770 if (ignore_mouse_drag_p
)
5772 event
->modifiers
|= click_modifier
;
5773 ignore_mouse_drag_p
= 0;
5775 else if (xdiff
< double_click_fuzz
&& xdiff
> - double_click_fuzz
5776 && ydiff
< double_click_fuzz
&& ydiff
> - double_click_fuzz
5777 /* Maybe the mouse has moved a lot, caused scrolling, and
5778 eventually ended up at the same screen position (but
5779 not buffer position) in which case it is a drag, not
5781 /* FIXME: OTOH if the buffer position has changed
5782 because of a timer or process filter rather than
5783 because of mouse movement, it should be considered as
5784 a click. But mouse-drag-region completely ignores
5785 this case and it hasn't caused any real problem, so
5786 it's probably OK to ignore it as well. */
5787 && EQ (Fcar (Fcdr (start_pos
)), Fcar (Fcdr (position
))))
5788 /* Mouse hasn't moved (much). */
5789 event
->modifiers
|= click_modifier
;
5792 button_down_time
= 0;
5793 event
->modifiers
|= drag_modifier
;
5796 /* Don't check is_double; treat this as multiple
5797 if the down-event was multiple. */
5798 if (double_click_count
> 1)
5799 event
->modifiers
|= ((double_click_count
> 2)
5805 /* Every mouse event should either have the down_modifier or
5806 the up_modifier set. */
5810 /* Get the symbol we should use for the mouse click. */
5813 head
= modify_event_symbol (button
,
5815 Qmouse_click
, Vlispy_mouse_stem
,
5818 ASIZE (mouse_syms
));
5819 if (event
->modifiers
& drag_modifier
)
5820 return list3 (head
, start_pos
, position
);
5821 else if (event
->modifiers
& (double_modifier
| triple_modifier
))
5822 return list3 (head
, position
, make_number (double_click_count
));
5824 return list2 (head
, position
);
5829 case HORIZ_WHEEL_EVENT
:
5831 Lisp_Object position
;
5834 /* Build the position as appropriate for this mouse click. */
5835 struct frame
*f
= XFRAME (event
->frame_or_window
);
5837 /* Ignore wheel events that were made on frame that have been
5839 if (! FRAME_LIVE_P (f
))
5842 position
= make_lispy_position (f
, event
->x
, event
->y
,
5845 /* Set double or triple modifiers to indicate the wheel speed. */
5847 /* On window-system frames, use the value of
5848 double-click-fuzz as is. On other frames, interpret it
5849 as a multiple of 1/8 characters. */
5855 if (WINDOWP (event
->frame_or_window
))
5856 fr
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5857 else if (FRAMEP (event
->frame_or_window
))
5858 fr
= XFRAME (event
->frame_or_window
);
5862 fuzz
= FRAME_WINDOW_P (fr
)
5863 ? double_click_fuzz
: double_click_fuzz
/ 8;
5865 if (event
->modifiers
& up_modifier
)
5867 /* Emit a wheel-up event. */
5868 event
->modifiers
&= ~up_modifier
;
5871 else if (event
->modifiers
& down_modifier
)
5873 /* Emit a wheel-down event. */
5874 event
->modifiers
&= ~down_modifier
;
5878 /* Every wheel event should either have the down_modifier or
5879 the up_modifier set. */
5882 if (event
->kind
== HORIZ_WHEEL_EVENT
)
5885 is_double
= (last_mouse_button
== - (1 + symbol_num
)
5886 && (eabs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5887 && (eabs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5888 && button_down_time
!= 0
5889 && (EQ (Vdouble_click_time
, Qt
)
5890 || (NATNUMP (Vdouble_click_time
)
5891 && (event
->timestamp
- button_down_time
5892 < XFASTINT (Vdouble_click_time
)))));
5895 double_click_count
++;
5896 event
->modifiers
|= ((double_click_count
> 2)
5902 double_click_count
= 1;
5903 event
->modifiers
|= click_modifier
;
5906 button_down_time
= event
->timestamp
;
5907 /* Use a negative value to distinguish wheel from mouse button. */
5908 last_mouse_button
= - (1 + symbol_num
);
5909 last_mouse_x
= XINT (event
->x
);
5910 last_mouse_y
= XINT (event
->y
);
5912 /* Get the symbol we should use for the wheel event. */
5913 head
= modify_event_symbol (symbol_num
,
5919 ASIZE (wheel_syms
));
5922 if (event
->modifiers
& (double_modifier
| triple_modifier
))
5923 return list3 (head
, position
, make_number (double_click_count
));
5925 return list2 (head
, position
);
5929 #ifdef USE_TOOLKIT_SCROLL_BARS
5931 /* We don't have down and up events if using toolkit scroll bars,
5932 so make this always a click event. Store in the `part' of
5933 the Lisp event a symbol which maps to the following actions:
5935 `above_handle' page up
5936 `below_handle' page down
5940 `bottom' bottom of buffer
5941 `handle' thumb has been dragged.
5942 `end-scroll' end of interaction with scroll bar
5944 The incoming input_event contains in its `part' member an
5945 index of type `enum scroll_bar_part' which we can use as an
5946 index in scroll_bar_parts to get the appropriate symbol. */
5948 case SCROLL_BAR_CLICK_EVENT
:
5950 Lisp_Object position
, head
;
5952 position
= make_scroll_bar_position (event
, Qvertical_scroll_bar
);
5954 /* Always treat scroll bar events as clicks. */
5955 event
->modifiers
|= click_modifier
;
5956 event
->modifiers
&= ~up_modifier
;
5958 if (event
->code
>= ASIZE (mouse_syms
))
5959 mouse_syms
= larger_vector (mouse_syms
,
5960 event
->code
- ASIZE (mouse_syms
) + 1,
5963 /* Get the symbol we should use for the mouse click. */
5964 head
= modify_event_symbol (event
->code
,
5969 ASIZE (mouse_syms
));
5970 return list2 (head
, position
);
5973 case HORIZONTAL_SCROLL_BAR_CLICK_EVENT
:
5975 Lisp_Object position
, head
;
5977 position
= make_scroll_bar_position (event
, Qhorizontal_scroll_bar
);
5979 /* Always treat scroll bar events as clicks. */
5980 event
->modifiers
|= click_modifier
;
5981 event
->modifiers
&= ~up_modifier
;
5983 if (event
->code
>= ASIZE (mouse_syms
))
5984 mouse_syms
= larger_vector (mouse_syms
,
5985 event
->code
- ASIZE (mouse_syms
) + 1,
5988 /* Get the symbol we should use for the mouse click. */
5989 head
= modify_event_symbol (event
->code
,
5994 ASIZE (mouse_syms
));
5995 return list2 (head
, position
);
5998 #endif /* USE_TOOLKIT_SCROLL_BARS */
6000 case DRAG_N_DROP_EVENT
:
6003 Lisp_Object head
, position
;
6006 f
= XFRAME (event
->frame_or_window
);
6009 /* Ignore mouse events that were made on frames that
6010 have been deleted. */
6011 if (! FRAME_LIVE_P (f
))
6014 position
= make_lispy_position (f
, event
->x
, event
->y
,
6017 head
= modify_event_symbol (0, event
->modifiers
,
6019 lispy_drag_n_drop_names
,
6020 &drag_n_drop_syms
, 1);
6021 return list3 (head
, position
, files
);
6024 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
6025 || defined (HAVE_NS) || defined (USE_GTK)
6026 case MENU_BAR_EVENT
:
6027 if (EQ (event
->arg
, event
->frame_or_window
))
6028 /* This is the prefix key. We translate this to
6029 `(menu_bar)' because the code in keyboard.c for menu
6030 events, which we use, relies on this. */
6031 return list1 (Qmenu_bar
);
6035 case SELECT_WINDOW_EVENT
:
6036 /* Make an event (select-window (WINDOW)). */
6037 return list2 (Qselect_window
, list1 (event
->frame_or_window
));
6039 case TOOL_BAR_EVENT
:
6040 if (EQ (event
->arg
, event
->frame_or_window
))
6041 /* This is the prefix key. We translate this to
6042 `(tool_bar)' because the code in keyboard.c for tool bar
6043 events, which we use, relies on this. */
6044 return list1 (Qtool_bar
);
6045 else if (SYMBOLP (event
->arg
))
6046 return apply_modifiers (event
->modifiers
, event
->arg
);
6049 case USER_SIGNAL_EVENT
:
6050 /* A user signal. */
6052 char *name
= find_user_signal_name (event
->code
);
6055 return intern (name
);
6058 case SAVE_SESSION_EVENT
:
6059 return Qsave_session
;
6064 return Fcons (Qdbus_event
, event
->arg
);
6066 #endif /* HAVE_DBUS */
6068 #if defined HAVE_GFILENOTIFY || defined HAVE_INOTIFY
6069 case FILE_NOTIFY_EVENT
:
6071 return Fcons (Qfile_notify
, event
->arg
);
6073 #endif /* defined HAVE_GFILENOTIFY || defined HAVE_INOTIFY */
6075 case CONFIG_CHANGED_EVENT
:
6076 return list3 (Qconfig_changed_event
,
6077 event
->arg
, event
->frame_or_window
);
6079 /* The 'kind' field of the event is something we don't recognize. */
6086 make_lispy_movement (struct frame
*frame
, Lisp_Object bar_window
, enum scroll_bar_part part
,
6087 Lisp_Object x
, Lisp_Object y
, Time t
)
6089 /* Is it a scroll bar movement? */
6090 if (frame
&& ! NILP (bar_window
))
6092 Lisp_Object part_sym
;
6094 part_sym
= make_lisp_symbol (scroll_bar_parts
[part
]);
6095 return list2 (Qscroll_bar_movement
,
6097 Qvertical_scroll_bar
,
6102 /* Or is it an ordinary mouse movement? */
6105 Lisp_Object position
;
6106 position
= make_lispy_position (frame
, x
, y
, t
);
6107 return list2 (Qmouse_movement
, position
);
6111 /* Construct a switch frame event. */
6113 make_lispy_switch_frame (Lisp_Object frame
)
6115 return list2 (Qswitch_frame
, frame
);
6119 make_lispy_focus_in (Lisp_Object frame
)
6121 return list2 (Qfocus_in
, frame
);
6124 #ifdef HAVE_WINDOW_SYSTEM
6127 make_lispy_focus_out (Lisp_Object frame
)
6129 return list2 (Qfocus_out
, frame
);
6132 #endif /* HAVE_WINDOW_SYSTEM */
6134 /* Manipulating modifiers. */
6136 /* Parse the name of SYMBOL, and return the set of modifiers it contains.
6138 If MODIFIER_END is non-zero, set *MODIFIER_END to the position in
6139 SYMBOL's name of the end of the modifiers; the string from this
6140 position is the unmodified symbol name.
6142 This doesn't use any caches. */
6145 parse_modifiers_uncached (Lisp_Object symbol
, ptrdiff_t *modifier_end
)
6151 CHECK_SYMBOL (symbol
);
6154 name
= SYMBOL_NAME (symbol
);
6156 for (i
= 0; i
< SBYTES (name
) - 1; )
6158 ptrdiff_t this_mod_end
= 0;
6161 /* See if the name continues with a modifier word.
6162 Check that the word appears, but don't check what follows it.
6163 Set this_mod and this_mod_end to record what we find. */
6165 switch (SREF (name
, i
))
6167 #define SINGLE_LETTER_MOD(BIT) \
6168 (this_mod_end = i + 1, this_mod = BIT)
6171 SINGLE_LETTER_MOD (alt_modifier
);
6175 SINGLE_LETTER_MOD (ctrl_modifier
);
6179 SINGLE_LETTER_MOD (hyper_modifier
);
6183 SINGLE_LETTER_MOD (meta_modifier
);
6187 SINGLE_LETTER_MOD (shift_modifier
);
6191 SINGLE_LETTER_MOD (super_modifier
);
6194 #undef SINGLE_LETTER_MOD
6196 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6197 if (i + LEN + 1 <= SBYTES (name) \
6198 && ! memcmp (SDATA (name) + i, NAME, LEN)) \
6200 this_mod_end = i + LEN; \
6205 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
6206 MULTI_LETTER_MOD (down_modifier
, "down", 4);
6207 MULTI_LETTER_MOD (double_modifier
, "double", 6);
6211 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
6213 #undef MULTI_LETTER_MOD
6217 /* If we found no modifier, stop looking for them. */
6218 if (this_mod_end
== 0)
6221 /* Check there is a dash after the modifier, so that it
6222 really is a modifier. */
6223 if (this_mod_end
>= SBYTES (name
)
6224 || SREF (name
, this_mod_end
) != '-')
6227 /* This modifier is real; look for another. */
6228 modifiers
|= this_mod
;
6229 i
= this_mod_end
+ 1;
6232 /* Should we include the `click' modifier? */
6233 if (! (modifiers
& (down_modifier
| drag_modifier
6234 | double_modifier
| triple_modifier
))
6235 && i
+ 7 == SBYTES (name
)
6236 && memcmp (SDATA (name
) + i
, "mouse-", 6) == 0
6237 && ('0' <= SREF (name
, i
+ 6) && SREF (name
, i
+ 6) <= '9'))
6238 modifiers
|= click_modifier
;
6240 if (! (modifiers
& (double_modifier
| triple_modifier
))
6241 && i
+ 6 < SBYTES (name
)
6242 && memcmp (SDATA (name
) + i
, "wheel-", 6) == 0)
6243 modifiers
|= click_modifier
;
6251 /* Return a symbol whose name is the modifier prefixes for MODIFIERS
6252 prepended to the string BASE[0..BASE_LEN-1].
6253 This doesn't use any caches. */
6255 apply_modifiers_uncached (int modifiers
, char *base
, int base_len
, int base_len_byte
)
6257 /* Since BASE could contain nulls, we can't use intern here; we have
6258 to use Fintern, which expects a genuine Lisp_String, and keeps a
6260 char new_mods
[sizeof "A-C-H-M-S-s-down-drag-double-triple-"];
6266 /* Only the event queue may use the `up' modifier; it should always
6267 be turned into a click or drag event before presented to lisp code. */
6268 if (modifiers
& up_modifier
)
6271 if (modifiers
& alt_modifier
) { *p
++ = 'A'; *p
++ = '-'; }
6272 if (modifiers
& ctrl_modifier
) { *p
++ = 'C'; *p
++ = '-'; }
6273 if (modifiers
& hyper_modifier
) { *p
++ = 'H'; *p
++ = '-'; }
6274 if (modifiers
& meta_modifier
) { *p
++ = 'M'; *p
++ = '-'; }
6275 if (modifiers
& shift_modifier
) { *p
++ = 'S'; *p
++ = '-'; }
6276 if (modifiers
& super_modifier
) { *p
++ = 's'; *p
++ = '-'; }
6277 if (modifiers
& double_modifier
) { strcpy (p
, "double-"); p
+= 7; }
6278 if (modifiers
& triple_modifier
) { strcpy (p
, "triple-"); p
+= 7; }
6279 if (modifiers
& down_modifier
) { strcpy (p
, "down-"); p
+= 5; }
6280 if (modifiers
& drag_modifier
) { strcpy (p
, "drag-"); p
+= 5; }
6281 /* The click modifier is denoted by the absence of other modifiers. */
6285 mod_len
= p
- new_mods
;
6289 Lisp_Object new_name
;
6291 new_name
= make_uninit_multibyte_string (mod_len
+ base_len
,
6292 mod_len
+ base_len_byte
);
6293 memcpy (SDATA (new_name
), new_mods
, mod_len
);
6294 memcpy (SDATA (new_name
) + mod_len
, base
, base_len_byte
);
6296 return Fintern (new_name
, Qnil
);
6301 static const char *const modifier_names
[] =
6303 "up", "down", "drag", "click", "double", "triple", 0, 0,
6304 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
6305 0, 0, "alt", "super", "hyper", "shift", "control", "meta"
6307 #define NUM_MOD_NAMES ARRAYELTS (modifier_names)
6309 static Lisp_Object modifier_symbols
;
6311 /* Return the list of modifier symbols corresponding to the mask MODIFIERS. */
6313 lispy_modifier_list (int modifiers
)
6315 Lisp_Object modifier_list
;
6318 modifier_list
= Qnil
;
6319 for (i
= 0; (1<<i
) <= modifiers
&& i
< NUM_MOD_NAMES
; i
++)
6320 if (modifiers
& (1<<i
))
6321 modifier_list
= Fcons (AREF (modifier_symbols
, i
),
6324 return modifier_list
;
6328 /* Parse the modifiers on SYMBOL, and return a list like (UNMODIFIED MASK),
6329 where UNMODIFIED is the unmodified form of SYMBOL,
6330 MASK is the set of modifiers present in SYMBOL's name.
6331 This is similar to parse_modifiers_uncached, but uses the cache in
6332 SYMBOL's Qevent_symbol_element_mask property, and maintains the
6333 Qevent_symbol_elements property. */
6335 #define KEY_TO_CHAR(k) (XINT (k) & ((1 << CHARACTERBITS) - 1))
6338 parse_modifiers (Lisp_Object symbol
)
6340 Lisp_Object elements
;
6342 if (INTEGERP (symbol
))
6343 return list2i (KEY_TO_CHAR (symbol
), XINT (symbol
) & CHAR_MODIFIER_MASK
);
6344 else if (!SYMBOLP (symbol
))
6347 elements
= Fget (symbol
, Qevent_symbol_element_mask
);
6348 if (CONSP (elements
))
6353 int modifiers
= parse_modifiers_uncached (symbol
, &end
);
6354 Lisp_Object unmodified
;
6357 unmodified
= Fintern (make_string (SSDATA (SYMBOL_NAME (symbol
)) + end
,
6358 SBYTES (SYMBOL_NAME (symbol
)) - end
),
6361 if (modifiers
& ~INTMASK
)
6363 XSETFASTINT (mask
, modifiers
);
6364 elements
= list2 (unmodified
, mask
);
6366 /* Cache the parsing results on SYMBOL. */
6367 Fput (symbol
, Qevent_symbol_element_mask
,
6369 Fput (symbol
, Qevent_symbol_elements
,
6370 Fcons (unmodified
, lispy_modifier_list (modifiers
)));
6372 /* Since we know that SYMBOL is modifiers applied to unmodified,
6373 it would be nice to put that in unmodified's cache.
6374 But we can't, since we're not sure that parse_modifiers is
6381 DEFUN ("internal-event-symbol-parse-modifiers", Fevent_symbol_parse_modifiers
,
6382 Sevent_symbol_parse_modifiers
, 1, 1, 0,
6383 doc
: /* Parse the event symbol. For internal use. */)
6384 (Lisp_Object symbol
)
6386 /* Fill the cache if needed. */
6387 parse_modifiers (symbol
);
6388 /* Ignore the result (which is stored on Qevent_symbol_element_mask)
6389 and use the Lispier representation stored on Qevent_symbol_elements
6391 return Fget (symbol
, Qevent_symbol_elements
);
6394 /* Apply the modifiers MODIFIERS to the symbol BASE.
6395 BASE must be unmodified.
6397 This is like apply_modifiers_uncached, but uses BASE's
6398 Qmodifier_cache property, if present. It also builds
6399 Qevent_symbol_elements properties, since it has that info anyway.
6401 apply_modifiers copies the value of BASE's Qevent_kind property to
6402 the modified symbol. */
6404 apply_modifiers (int modifiers
, Lisp_Object base
)
6406 Lisp_Object cache
, idx
, entry
, new_symbol
;
6408 /* Mask out upper bits. We don't know where this value's been. */
6409 modifiers
&= INTMASK
;
6411 if (INTEGERP (base
))
6412 return make_number (XINT (base
) | modifiers
);
6414 /* The click modifier never figures into cache indices. */
6415 cache
= Fget (base
, Qmodifier_cache
);
6416 XSETFASTINT (idx
, (modifiers
& ~click_modifier
));
6417 entry
= assq_no_quit (idx
, cache
);
6420 new_symbol
= XCDR (entry
);
6423 /* We have to create the symbol ourselves. */
6424 new_symbol
= apply_modifiers_uncached (modifiers
,
6425 SSDATA (SYMBOL_NAME (base
)),
6426 SCHARS (SYMBOL_NAME (base
)),
6427 SBYTES (SYMBOL_NAME (base
)));
6429 /* Add the new symbol to the base's cache. */
6430 entry
= Fcons (idx
, new_symbol
);
6431 Fput (base
, Qmodifier_cache
, Fcons (entry
, cache
));
6433 /* We have the parsing info now for free, so we could add it to
6435 XSETFASTINT (idx, modifiers);
6436 Fput (new_symbol, Qevent_symbol_element_mask,
6438 Fput (new_symbol, Qevent_symbol_elements,
6439 Fcons (base, lispy_modifier_list (modifiers)));
6440 Sadly, this is only correct if `base' is indeed a base event,
6441 which is not necessarily the case. -stef */
6444 /* Make sure this symbol is of the same kind as BASE.
6446 You'd think we could just set this once and for all when we
6447 intern the symbol above, but reorder_modifiers may call us when
6448 BASE's property isn't set right; we can't assume that just
6449 because it has a Qmodifier_cache property it must have its
6450 Qevent_kind set right as well. */
6451 if (NILP (Fget (new_symbol
, Qevent_kind
)))
6455 kind
= Fget (base
, Qevent_kind
);
6457 Fput (new_symbol
, Qevent_kind
, kind
);
6464 /* Given a symbol whose name begins with modifiers ("C-", "M-", etc),
6465 return a symbol with the modifiers placed in the canonical order.
6466 Canonical order is alphabetical, except for down and drag, which
6467 always come last. The 'click' modifier is never written out.
6469 Fdefine_key calls this to make sure that (for example) C-M-foo
6470 and M-C-foo end up being equivalent in the keymap. */
6473 reorder_modifiers (Lisp_Object symbol
)
6475 /* It's hopefully okay to write the code this way, since everything
6476 will soon be in caches, and no consing will be done at all. */
6479 parsed
= parse_modifiers (symbol
);
6480 return apply_modifiers (XFASTINT (XCAR (XCDR (parsed
))),
6485 /* For handling events, we often want to produce a symbol whose name
6486 is a series of modifier key prefixes ("M-", "C-", etcetera) attached
6487 to some base, like the name of a function key or mouse button.
6488 modify_event_symbol produces symbols of this sort.
6490 NAME_TABLE should point to an array of strings, such that NAME_TABLE[i]
6491 is the name of the i'th symbol. TABLE_SIZE is the number of elements
6494 Alternatively, NAME_ALIST_OR_STEM is either an alist mapping codes
6495 into symbol names, or a string specifying a name stem used to
6496 construct a symbol name or the form `STEM-N', where N is the decimal
6497 representation of SYMBOL_NUM. NAME_ALIST_OR_STEM is used if it is
6498 non-nil; otherwise NAME_TABLE is used.
6500 SYMBOL_TABLE should be a pointer to a Lisp_Object whose value will
6501 persist between calls to modify_event_symbol that it can use to
6502 store a cache of the symbols it's generated for this NAME_TABLE
6503 before. The object stored there may be a vector or an alist.
6505 SYMBOL_NUM is the number of the base name we want from NAME_TABLE.
6507 MODIFIERS is a set of modifier bits (as given in struct input_events)
6508 whose prefixes should be applied to the symbol name.
6510 SYMBOL_KIND is the value to be placed in the event_kind property of
6511 the returned symbol.
6513 The symbols we create are supposed to have an
6514 `event-symbol-elements' property, which lists the modifiers present
6515 in the symbol's name. */
6518 modify_event_symbol (ptrdiff_t symbol_num
, int modifiers
, Lisp_Object symbol_kind
,
6519 Lisp_Object name_alist_or_stem
, const char *const *name_table
,
6520 Lisp_Object
*symbol_table
, ptrdiff_t table_size
)
6523 Lisp_Object symbol_int
;
6525 /* Get rid of the "vendor-specific" bit here. */
6526 XSETINT (symbol_int
, symbol_num
& 0xffffff);
6528 /* Is this a request for a valid symbol? */
6529 if (symbol_num
< 0 || symbol_num
>= table_size
)
6532 if (CONSP (*symbol_table
))
6533 value
= Fcdr (assq_no_quit (symbol_int
, *symbol_table
));
6535 /* If *symbol_table doesn't seem to be initialized properly, fix that.
6536 *symbol_table should be a lisp vector TABLE_SIZE elements long,
6537 where the Nth element is the symbol for NAME_TABLE[N], or nil if
6538 we've never used that symbol before. */
6541 if (! VECTORP (*symbol_table
)
6542 || ASIZE (*symbol_table
) != table_size
)
6546 XSETFASTINT (size
, table_size
);
6547 *symbol_table
= Fmake_vector (size
, Qnil
);
6550 value
= AREF (*symbol_table
, symbol_num
);
6553 /* Have we already used this symbol before? */
6556 /* No; let's create it. */
6557 if (CONSP (name_alist_or_stem
))
6558 value
= Fcdr_safe (Fassq (symbol_int
, name_alist_or_stem
));
6559 else if (STRINGP (name_alist_or_stem
))
6562 ptrdiff_t len
= (SBYTES (name_alist_or_stem
)
6563 + sizeof "-" + INT_STRLEN_BOUND (EMACS_INT
));
6565 buf
= SAFE_ALLOCA (len
);
6566 esprintf (buf
, "%s-%"pI
"d", SDATA (name_alist_or_stem
),
6567 XINT (symbol_int
) + 1);
6568 value
= intern (buf
);
6571 else if (name_table
!= 0 && name_table
[symbol_num
])
6572 value
= intern (name_table
[symbol_num
]);
6574 #ifdef HAVE_WINDOW_SYSTEM
6577 char *name
= x_get_keysym_name (symbol_num
);
6579 value
= intern (name
);
6585 char buf
[sizeof "key-" + INT_STRLEN_BOUND (EMACS_INT
)];
6586 sprintf (buf
, "key-%"pD
"d", symbol_num
);
6587 value
= intern (buf
);
6590 if (CONSP (*symbol_table
))
6591 *symbol_table
= Fcons (Fcons (symbol_int
, value
), *symbol_table
);
6593 ASET (*symbol_table
, symbol_num
, value
);
6595 /* Fill in the cache entries for this symbol; this also
6596 builds the Qevent_symbol_elements property, which the user
6598 apply_modifiers (modifiers
& click_modifier
, value
);
6599 Fput (value
, Qevent_kind
, symbol_kind
);
6602 /* Apply modifiers to that symbol. */
6603 return apply_modifiers (modifiers
, value
);
6606 /* Convert a list that represents an event type,
6607 such as (ctrl meta backspace), into the usual representation of that
6608 event type as a number or a symbol. */
6610 DEFUN ("event-convert-list", Fevent_convert_list
, Sevent_convert_list
, 1, 1, 0,
6611 doc
: /* Convert the event description list EVENT-DESC to an event type.
6612 EVENT-DESC should contain one base event type (a character or symbol)
6613 and zero or more modifier names (control, meta, hyper, super, shift, alt,
6614 drag, down, double or triple). The base must be last.
6615 The return value is an event type (a character or symbol) which
6616 has the same base event type and all the specified modifiers. */)
6617 (Lisp_Object event_desc
)
6625 while (CONSP (rest
))
6633 /* Given a symbol, see if it is a modifier name. */
6634 if (SYMBOLP (elt
) && CONSP (rest
))
6635 this = parse_solitary_modifier (elt
);
6639 else if (!NILP (base
))
6640 error ("Two bases given in one event");
6646 /* Let the symbol A refer to the character A. */
6647 if (SYMBOLP (base
) && SCHARS (SYMBOL_NAME (base
)) == 1)
6648 XSETINT (base
, SREF (SYMBOL_NAME (base
), 0));
6650 if (INTEGERP (base
))
6652 /* Turn (shift a) into A. */
6653 if ((modifiers
& shift_modifier
) != 0
6654 && (XINT (base
) >= 'a' && XINT (base
) <= 'z'))
6656 XSETINT (base
, XINT (base
) - ('a' - 'A'));
6657 modifiers
&= ~shift_modifier
;
6660 /* Turn (control a) into C-a. */
6661 if (modifiers
& ctrl_modifier
)
6662 return make_number ((modifiers
& ~ctrl_modifier
)
6663 | make_ctrl_char (XINT (base
)));
6665 return make_number (modifiers
| XINT (base
));
6667 else if (SYMBOLP (base
))
6668 return apply_modifiers (modifiers
, base
);
6670 error ("Invalid base event");
6673 /* Try to recognize SYMBOL as a modifier name.
6674 Return the modifier flag bit, or 0 if not recognized. */
6677 parse_solitary_modifier (Lisp_Object symbol
)
6679 Lisp_Object name
= SYMBOL_NAME (symbol
);
6681 switch (SREF (name
, 0))
6683 #define SINGLE_LETTER_MOD(BIT) \
6684 if (SBYTES (name) == 1) \
6687 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6688 if (LEN == SBYTES (name) \
6689 && ! memcmp (SDATA (name), NAME, LEN)) \
6693 SINGLE_LETTER_MOD (alt_modifier
);
6697 MULTI_LETTER_MOD (alt_modifier
, "alt", 3);
6701 SINGLE_LETTER_MOD (ctrl_modifier
);
6705 MULTI_LETTER_MOD (ctrl_modifier
, "ctrl", 4);
6706 MULTI_LETTER_MOD (ctrl_modifier
, "control", 7);
6710 SINGLE_LETTER_MOD (hyper_modifier
);
6714 MULTI_LETTER_MOD (hyper_modifier
, "hyper", 5);
6718 SINGLE_LETTER_MOD (meta_modifier
);
6722 MULTI_LETTER_MOD (meta_modifier
, "meta", 4);
6726 SINGLE_LETTER_MOD (shift_modifier
);
6730 MULTI_LETTER_MOD (shift_modifier
, "shift", 5);
6731 MULTI_LETTER_MOD (super_modifier
, "super", 5);
6732 SINGLE_LETTER_MOD (super_modifier
);
6736 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
6737 MULTI_LETTER_MOD (down_modifier
, "down", 4);
6738 MULTI_LETTER_MOD (double_modifier
, "double", 6);
6742 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
6745 #undef SINGLE_LETTER_MOD
6746 #undef MULTI_LETTER_MOD
6752 /* Return true if EVENT is a list whose elements are all integers or symbols.
6753 Such a list is not valid as an event,
6754 but it can be a Lucid-style event type list. */
6757 lucid_event_type_list_p (Lisp_Object object
)
6761 if (! CONSP (object
))
6764 if (EQ (XCAR (object
), Qhelp_echo
)
6765 || EQ (XCAR (object
), Qvertical_line
)
6766 || EQ (XCAR (object
), Qmode_line
)
6767 || EQ (XCAR (object
), Qheader_line
))
6770 for (tail
= object
; CONSP (tail
); tail
= XCDR (tail
))
6774 if (! (INTEGERP (elt
) || SYMBOLP (elt
)))
6781 /* Return true if terminal input chars are available.
6782 Also, store the return value into INPUT_PENDING.
6784 Serves the purpose of ioctl (0, FIONREAD, ...)
6785 but works even if FIONREAD does not exist.
6786 (In fact, this may actually read some input.)
6788 If READABLE_EVENTS_DO_TIMERS_NOW is set in FLAGS, actually run
6789 timer events that are ripe.
6790 If READABLE_EVENTS_FILTER_EVENTS is set in FLAGS, ignore internal
6791 events (FOCUS_IN_EVENT).
6792 If READABLE_EVENTS_IGNORE_SQUEEZABLES is set in FLAGS, ignore mouse
6793 movements and toolkit scroll bar thumb drags. */
6796 get_input_pending (int flags
)
6798 /* First of all, have we already counted some input? */
6799 input_pending
= (!NILP (Vquit_flag
) || readable_events (flags
));
6801 /* If input is being read as it arrives, and we have none, there is none. */
6802 if (!input_pending
&& (!interrupt_input
|| interrupts_deferred
))
6804 /* Try to read some input and see how much we get. */
6806 input_pending
= (!NILP (Vquit_flag
) || readable_events (flags
));
6809 return input_pending
;
6812 /* Put a BUFFER_SWITCH_EVENT in the buffer
6813 so that read_key_sequence will notice the new current buffer. */
6816 record_asynch_buffer_change (void)
6818 /* We don't need a buffer-switch event unless Emacs is waiting for input.
6819 The purpose of the event is to make read_key_sequence look up the
6820 keymaps again. If we aren't in read_key_sequence, we don't need one,
6821 and the event could cause trouble by messing up (input-pending-p).
6822 Note: Fwaiting_for_user_input_p always returns nil when async
6823 subprocesses aren't supported. */
6824 if (!NILP (Fwaiting_for_user_input_p ()))
6826 struct input_event event
;
6829 event
.kind
= BUFFER_SWITCH_EVENT
;
6830 event
.frame_or_window
= Qnil
;
6833 /* Make sure no interrupt happens while storing the event. */
6835 if (interrupt_input
)
6836 kbd_buffer_store_event (&event
);
6841 kbd_buffer_store_event (&event
);
6847 /* Read any terminal input already buffered up by the system
6848 into the kbd_buffer, but do not wait.
6850 Return the number of keyboard chars read, or -1 meaning
6851 this is a bad time to try to read input. */
6860 /* Store pending user signal events, if any. */
6861 store_user_signal_events ();
6863 /* Loop through the available terminals, and call their input hooks. */
6867 struct terminal
*next
= t
->next_terminal
;
6869 if (t
->read_socket_hook
)
6872 struct input_event hold_quit
;
6874 if (input_blocked_p ())
6876 pending_signals
= 1;
6880 EVENT_INIT (hold_quit
);
6881 hold_quit
.kind
= NO_EVENT
;
6883 /* No need for FIONREAD or fcntl; just say don't wait. */
6884 while ((nr
= (*t
->read_socket_hook
) (t
, &hold_quit
)) > 0)
6887 if (nr
== -1) /* Not OK to read input now. */
6891 else if (nr
== -2) /* Non-transient error. */
6893 /* The terminal device terminated; it should be closed. */
6895 /* Kill Emacs if this was our last terminal. */
6896 if (!terminal_list
->next_terminal
)
6897 /* Formerly simply reported no input, but that
6898 sometimes led to a failure of Emacs to terminate.
6899 SIGHUP seems appropriate if we can't reach the
6901 /* ??? Is it really right to send the signal just to
6902 this process rather than to the whole process
6903 group? Perhaps on systems with FIONREAD Emacs is
6904 alone in its group. */
6905 terminate_due_to_signal (SIGHUP
, 10);
6907 /* XXX Is calling delete_terminal safe here? It calls delete_frame. */
6910 XSETTERMINAL (tmp
, t
);
6911 Fdelete_terminal (tmp
, Qnoelisp
);
6915 /* If there was no error, make sure the pointer
6916 is visible for all frames on this terminal. */
6919 Lisp_Object tail
, frame
;
6921 FOR_EACH_FRAME (tail
, frame
)
6923 struct frame
*f
= XFRAME (frame
);
6924 if (FRAME_TERMINAL (f
) == t
)
6925 frame_make_pointer_visible (f
);
6929 if (hold_quit
.kind
!= NO_EVENT
)
6930 kbd_buffer_store_event (&hold_quit
);
6942 /* This is the tty way of reading available input.
6944 Note that each terminal device has its own `struct terminal' object,
6945 and so this function is called once for each individual termcap
6946 terminal. The first parameter indicates which terminal to read from. */
6949 tty_read_avail_input (struct terminal
*terminal
,
6950 struct input_event
*hold_quit
)
6952 /* Using KBD_BUFFER_SIZE - 1 here avoids reading more than
6953 the kbd_buffer can really hold. That may prevent loss
6954 of characters on some systems when input is stuffed at us. */
6955 unsigned char cbuf
[KBD_BUFFER_SIZE
- 1];
6957 struct tty_display_info
*tty
= terminal
->display_info
.tty
;
6960 int buffer_free
= KBD_BUFFER_SIZE
- kbd_buffer_nr_stored () - 1;
6962 if (kbd_on_hold_p () || buffer_free
<= 0)
6964 #endif /* subprocesses */
6966 if (!terminal
->name
) /* Don't read from a dead terminal. */
6969 if (terminal
->type
!= output_termcap
6970 && terminal
->type
!= output_msdos_raw
)
6973 /* XXX I think the following code should be moved to separate hook
6974 functions in system-dependent files. */
6976 /* FIXME: AFAIK, tty_read_avail_input is not used under w32 since the non-GUI
6977 code sets read_socket_hook to w32_console_read_socket instead! */
6979 #else /* not WINDOWSNT */
6980 if (! tty
->term_initted
) /* In case we get called during bootstrap. */
6984 return 0; /* The terminal is suspended. */
6987 n_to_read
= dos_keysns ();
6991 cbuf
[0] = dos_keyread ();
6994 #else /* not MSDOS */
6999 struct input_event gpm_hold_quit
;
7000 int gpm
, fd
= gpm_fd
;
7002 EVENT_INIT (gpm_hold_quit
);
7003 gpm_hold_quit
.kind
= NO_EVENT
;
7005 /* gpm==1 if event received.
7006 gpm==0 if the GPM daemon has closed the connection, in which case
7007 Gpm_GetEvent closes gpm_fd and clears it to -1, which is why
7008 we save it in `fd' so close_gpm can remove it from the
7010 gpm==-1 if a protocol error or EWOULDBLOCK; the latter is normal. */
7011 while (gpm
= Gpm_GetEvent (&event
), gpm
== 1) {
7012 nread
+= handle_one_term_event (tty
, &event
, &gpm_hold_quit
);
7015 /* Presumably the GPM daemon has closed the connection. */
7017 if (gpm_hold_quit
.kind
!= NO_EVENT
)
7018 kbd_buffer_store_event (&gpm_hold_quit
);
7022 #endif /* HAVE_GPM */
7024 /* Determine how many characters we should *try* to read. */
7025 #ifdef USABLE_FIONREAD
7026 /* Find out how much input is available. */
7027 if (ioctl (fileno (tty
->input
), FIONREAD
, &n_to_read
) < 0)
7029 if (! noninteractive
)
7030 return -2; /* Close this terminal. */
7036 if (n_to_read
> sizeof cbuf
)
7037 n_to_read
= sizeof cbuf
;
7038 #elif defined USG || defined CYGWIN
7039 /* Read some input if available, but don't wait. */
7040 n_to_read
= sizeof cbuf
;
7041 fcntl (fileno (tty
->input
), F_SETFL
, O_NONBLOCK
);
7043 # error "Cannot read without possibly delaying"
7047 /* Don't read more than we can store. */
7048 if (n_to_read
> buffer_free
)
7049 n_to_read
= buffer_free
;
7050 #endif /* subprocesses */
7052 /* Now read; for one reason or another, this will not block.
7053 NREAD is set to the number of chars read. */
7056 nread
= emacs_read (fileno (tty
->input
), (char *) cbuf
, n_to_read
);
7057 /* POSIX infers that processes which are not in the session leader's
7058 process group won't get SIGHUPs at logout time. BSDI adheres to
7059 this part standard and returns -1 from read (0) with errno==EIO
7060 when the control tty is taken away.
7061 Jeffrey Honig <jch@bsdi.com> says this is generally safe. */
7062 if (nread
== -1 && errno
== EIO
)
7063 return -2; /* Close this terminal. */
7064 #if defined (AIX) && defined (_BSD)
7065 /* The kernel sometimes fails to deliver SIGHUP for ptys.
7066 This looks incorrect, but it isn't, because _BSD causes
7067 O_NDELAY to be defined in fcntl.h as O_NONBLOCK,
7068 and that causes a value other than 0 when there is no input. */
7070 return -2; /* Close this terminal. */
7074 /* We used to retry the read if it was interrupted.
7075 But this does the wrong thing when O_NONBLOCK causes
7076 an EAGAIN error. Does anybody know of a situation
7077 where a retry is actually needed? */
7079 nread
< 0 && (errno
== EAGAIN
|| errno
== EFAULT
7089 #ifndef USABLE_FIONREAD
7090 #if defined (USG) || defined (CYGWIN)
7091 fcntl (fileno (tty
->input
), F_SETFL
, 0);
7092 #endif /* USG or CYGWIN */
7093 #endif /* no FIONREAD */
7098 #endif /* not MSDOS */
7099 #endif /* not WINDOWSNT */
7101 for (i
= 0; i
< nread
; i
++)
7103 struct input_event buf
;
7105 buf
.kind
= ASCII_KEYSTROKE_EVENT
;
7107 if (tty
->meta_key
== 1 && (cbuf
[i
] & 0x80))
7108 buf
.modifiers
= meta_modifier
;
7109 if (tty
->meta_key
!= 2)
7113 /* Set the frame corresponding to the active tty. Note that the
7114 value of selected_frame is not reliable here, redisplay tends
7115 to temporarily change it. */
7116 buf
.frame_or_window
= tty
->top_frame
;
7119 kbd_buffer_store_event (&buf
);
7120 /* Don't look at input that follows a C-g too closely.
7121 This reduces lossage due to autorepeat on C-g. */
7122 if (buf
.kind
== ASCII_KEYSTROKE_EVENT
7123 && buf
.code
== quit_char
)
7131 handle_async_input (void)
7136 int nread
= gobble_input ();
7137 /* -1 means it's not ok to read the input now.
7138 UNBLOCK_INPUT will read it later; now, avoid infinite loop.
7139 0 means there was no keyboard input available. */
7147 process_pending_signals (void)
7149 pending_signals
= 0;
7150 handle_async_input ();
7151 do_pending_atimers ();
7154 /* Undo any number of BLOCK_INPUT calls down to level LEVEL,
7155 and reinvoke any pending signal if the level is now 0 and
7156 a fatal error is not already in progress. */
7159 unblock_input_to (int level
)
7161 interrupt_input_blocked
= level
;
7164 if (pending_signals
&& !fatal_error_in_progress
)
7165 process_pending_signals ();
7171 /* End critical section.
7173 If doing signal-driven input, and a signal came in when input was
7174 blocked, reinvoke the signal handler now to deal with it.
7176 It will also process queued input, if it was not read before.
7177 When a longer code sequence does not use block/unblock input
7178 at all, the whole input gathered up to the next call to
7179 unblock_input will be processed inside that call. */
7182 unblock_input (void)
7184 unblock_input_to (interrupt_input_blocked
- 1);
7187 /* Undo any number of BLOCK_INPUT calls,
7188 and also reinvoke any pending signal. */
7191 totally_unblock_input (void)
7193 unblock_input_to (0);
7199 handle_input_available_signal (int sig
)
7201 pending_signals
= 1;
7203 if (input_available_clear_time
)
7204 *input_available_clear_time
= make_timespec (0, 0);
7208 deliver_input_available_signal (int sig
)
7210 deliver_process_signal (sig
, handle_input_available_signal
);
7212 #endif /* USABLE_SIGIO */
7215 /* User signal events. */
7217 struct user_signal_info
7219 /* Signal number. */
7222 /* Name of the signal. */
7225 /* Number of pending signals. */
7228 struct user_signal_info
*next
;
7231 /* List of user signals. */
7232 static struct user_signal_info
*user_signals
= NULL
;
7235 add_user_signal (int sig
, const char *name
)
7237 struct sigaction action
;
7238 struct user_signal_info
*p
;
7240 for (p
= user_signals
; p
; p
= p
->next
)
7242 /* Already added. */
7245 p
= xmalloc (sizeof *p
);
7247 p
->name
= xstrdup (name
);
7249 p
->next
= user_signals
;
7252 emacs_sigaction_init (&action
, deliver_user_signal
);
7253 sigaction (sig
, &action
, 0);
7257 handle_user_signal (int sig
)
7259 struct user_signal_info
*p
;
7260 const char *special_event_name
= NULL
;
7262 if (SYMBOLP (Vdebug_on_event
))
7263 special_event_name
= SSDATA (SYMBOL_NAME (Vdebug_on_event
));
7265 for (p
= user_signals
; p
; p
= p
->next
)
7268 if (special_event_name
7269 && strcmp (special_event_name
, p
->name
) == 0)
7271 /* Enter the debugger in many ways. */
7272 debug_on_next_call
= 1;
7275 Vinhibit_quit
= Qnil
;
7277 /* Eat the event. */
7283 if (interrupt_input
)
7284 handle_input_available_signal (sig
);
7288 /* Tell wait_reading_process_output that it needs to wake
7289 up and look around. */
7290 if (input_available_clear_time
)
7291 *input_available_clear_time
= make_timespec (0, 0);
7298 deliver_user_signal (int sig
)
7300 deliver_process_signal (sig
, handle_user_signal
);
7304 find_user_signal_name (int sig
)
7306 struct user_signal_info
*p
;
7308 for (p
= user_signals
; p
; p
= p
->next
)
7316 store_user_signal_events (void)
7318 struct user_signal_info
*p
;
7319 struct input_event buf
;
7320 bool buf_initialized
= 0;
7322 for (p
= user_signals
; p
; p
= p
->next
)
7323 if (p
->npending
> 0)
7325 if (! buf_initialized
)
7327 memset (&buf
, 0, sizeof buf
);
7328 buf
.kind
= USER_SIGNAL_EVENT
;
7329 buf
.frame_or_window
= selected_frame
;
7330 buf_initialized
= 1;
7336 kbd_buffer_store_event (&buf
);
7339 while (p
->npending
> 0);
7344 static void menu_bar_item (Lisp_Object
, Lisp_Object
, Lisp_Object
, void *);
7345 static Lisp_Object menu_bar_one_keymap_changed_items
;
7347 /* These variables hold the vector under construction within
7348 menu_bar_items and its subroutines, and the current index
7349 for storing into that vector. */
7350 static Lisp_Object menu_bar_items_vector
;
7351 static int menu_bar_items_index
;
7354 static const char *separator_names
[] = {
7359 "single-dashed-line",
7360 "double-dashed-line",
7362 "shadow-etched-out",
7363 "shadow-etched-in-dash",
7364 "shadow-etched-out-dash",
7365 "shadow-double-etched-in",
7366 "shadow-double-etched-out",
7367 "shadow-double-etched-in-dash",
7368 "shadow-double-etched-out-dash",
7372 /* Return true if LABEL specifies a separator. */
7375 menu_separator_name_p (const char *label
)
7379 else if (strlen (label
) > 3
7380 && memcmp (label
, "--", 2) == 0
7385 for (i
= 0; separator_names
[i
]; ++i
)
7386 if (strcmp (label
, separator_names
[i
]) == 0)
7391 /* It's a separator if it contains only dashes. */
7392 while (*label
== '-')
7394 return (*label
== 0);
7401 /* Return a vector of menu items for a menu bar, appropriate
7402 to the current buffer. Each item has three elements in the vector:
7405 OLD is an old vector we can optionally reuse, or nil. */
7408 menu_bar_items (Lisp_Object old
)
7410 /* The number of keymaps we're scanning right now, and the number of
7411 keymaps we have allocated space for. */
7414 /* maps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
7415 in the current keymaps, or nil where it is not a prefix. */
7418 Lisp_Object mapsbuf
[3];
7419 Lisp_Object def
, tail
;
7426 /* In order to build the menus, we need to call the keymap
7427 accessors. They all call QUIT. But this function is called
7428 during redisplay, during which a quit is fatal. So inhibit
7429 quitting while building the menus.
7430 We do this instead of specbind because (1) errors will clear it anyway
7431 and (2) this avoids risk of specpdl overflow. */
7432 oquit
= Vinhibit_quit
;
7436 menu_bar_items_vector
= old
;
7438 menu_bar_items_vector
= Fmake_vector (make_number (24), Qnil
);
7439 menu_bar_items_index
= 0;
7441 /* Build our list of keymaps.
7442 If we recognize a function key and replace its escape sequence in
7443 keybuf with its symbol, or if the sequence starts with a mouse
7444 click and we need to switch buffers, we jump back here to rebuild
7445 the initial keymaps from the current buffer. */
7449 /* Should overriding-terminal-local-map and overriding-local-map apply? */
7450 if (!NILP (Voverriding_local_map_menu_flag
)
7451 && !NILP (Voverriding_local_map
))
7453 /* Yes, use them (if non-nil) as well as the global map. */
7456 if (!NILP (KVAR (current_kboard
, Voverriding_terminal_local_map
)))
7457 maps
[nmaps
++] = KVAR (current_kboard
, Voverriding_terminal_local_map
);
7458 if (!NILP (Voverriding_local_map
))
7459 maps
[nmaps
++] = Voverriding_local_map
;
7463 /* No, so use major and minor mode keymaps and keymap property.
7464 Note that menu-bar bindings in the local-map and keymap
7465 properties may not work reliable, as they are only
7466 recognized when the menu-bar (or mode-line) is updated,
7467 which does not normally happen after every command. */
7470 nminor
= current_minor_maps (NULL
, &tmaps
);
7471 SAFE_NALLOCA (maps
, 1, nminor
+ 4);
7473 tem
= KVAR (current_kboard
, Voverriding_terminal_local_map
);
7474 if (!NILP (tem
) && !NILP (Voverriding_local_map_menu_flag
))
7475 maps
[nmaps
++] = tem
;
7476 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
7477 maps
[nmaps
++] = tem
;
7478 memcpy (maps
+ nmaps
, tmaps
, nminor
* sizeof (maps
[0]));
7480 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
7482 maps
[nmaps
++] = current_global_map
;
7485 /* Look up in each map the dummy prefix key `menu-bar'. */
7487 for (mapno
= nmaps
- 1; mapno
>= 0; mapno
--)
7488 if (!NILP (maps
[mapno
]))
7490 def
= get_keymap (access_keymap (maps
[mapno
], Qmenu_bar
, 1, 0, 1),
7494 menu_bar_one_keymap_changed_items
= Qnil
;
7495 map_keymap_canonical (def
, menu_bar_item
, Qnil
, NULL
);
7499 /* Move to the end those items that should be at the end. */
7501 for (tail
= Vmenu_bar_final_items
; CONSP (tail
); tail
= XCDR (tail
))
7504 int end
= menu_bar_items_index
;
7506 for (i
= 0; i
< end
; i
+= 4)
7507 if (EQ (XCAR (tail
), AREF (menu_bar_items_vector
, i
)))
7509 Lisp_Object tem0
, tem1
, tem2
, tem3
;
7510 /* Move the item at index I to the end,
7511 shifting all the others forward. */
7512 tem0
= AREF (menu_bar_items_vector
, i
+ 0);
7513 tem1
= AREF (menu_bar_items_vector
, i
+ 1);
7514 tem2
= AREF (menu_bar_items_vector
, i
+ 2);
7515 tem3
= AREF (menu_bar_items_vector
, i
+ 3);
7517 memmove (aref_addr (menu_bar_items_vector
, i
),
7518 aref_addr (menu_bar_items_vector
, i
+ 4),
7519 (end
- i
- 4) * word_size
);
7520 ASET (menu_bar_items_vector
, end
- 4, tem0
);
7521 ASET (menu_bar_items_vector
, end
- 3, tem1
);
7522 ASET (menu_bar_items_vector
, end
- 2, tem2
);
7523 ASET (menu_bar_items_vector
, end
- 1, tem3
);
7528 /* Add nil, nil, nil, nil at the end. */
7530 int i
= menu_bar_items_index
;
7531 if (i
+ 4 > ASIZE (menu_bar_items_vector
))
7532 menu_bar_items_vector
7533 = larger_vector (menu_bar_items_vector
, 4, -1);
7534 /* Add this item. */
7535 ASET (menu_bar_items_vector
, i
, Qnil
); i
++;
7536 ASET (menu_bar_items_vector
, i
, Qnil
); i
++;
7537 ASET (menu_bar_items_vector
, i
, Qnil
); i
++;
7538 ASET (menu_bar_items_vector
, i
, Qnil
); i
++;
7539 menu_bar_items_index
= i
;
7542 Vinhibit_quit
= oquit
;
7544 return menu_bar_items_vector
;
7547 /* Add one item to menu_bar_items_vector, for KEY, ITEM_STRING and DEF.
7548 If there's already an item for KEY, add this DEF to it. */
7550 Lisp_Object item_properties
;
7553 menu_bar_item (Lisp_Object key
, Lisp_Object item
, Lisp_Object dummy1
, void *dummy2
)
7555 struct gcpro gcpro1
;
7560 if (EQ (item
, Qundefined
))
7562 /* If a map has an explicit `undefined' as definition,
7563 discard any previously made menu bar item. */
7565 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7566 if (EQ (key
, AREF (menu_bar_items_vector
, i
)))
7568 if (menu_bar_items_index
> i
+ 4)
7569 memmove (aref_addr (menu_bar_items_vector
, i
),
7570 aref_addr (menu_bar_items_vector
, i
+ 4),
7571 (menu_bar_items_index
- i
- 4) * word_size
);
7572 menu_bar_items_index
-= 4;
7576 /* If this keymap has already contributed to this KEY,
7577 don't contribute to it a second time. */
7578 tem
= Fmemq (key
, menu_bar_one_keymap_changed_items
);
7579 if (!NILP (tem
) || NILP (item
))
7582 menu_bar_one_keymap_changed_items
7583 = Fcons (key
, menu_bar_one_keymap_changed_items
);
7585 /* We add to menu_bar_one_keymap_changed_items before doing the
7586 parse_menu_item, so that if it turns out it wasn't a menu item,
7587 it still correctly hides any further menu item. */
7589 parsed
= parse_menu_item (item
, 1);
7594 item
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7596 /* Find any existing item for this KEY. */
7597 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7598 if (EQ (key
, AREF (menu_bar_items_vector
, i
)))
7601 /* If we did not find this KEY, add it at the end. */
7602 if (i
== menu_bar_items_index
)
7604 /* If vector is too small, get a bigger one. */
7605 if (i
+ 4 > ASIZE (menu_bar_items_vector
))
7606 menu_bar_items_vector
= larger_vector (menu_bar_items_vector
, 4, -1);
7607 /* Add this item. */
7608 ASET (menu_bar_items_vector
, i
, key
); i
++;
7609 ASET (menu_bar_items_vector
, i
,
7610 AREF (item_properties
, ITEM_PROPERTY_NAME
)); i
++;
7611 ASET (menu_bar_items_vector
, i
, list1 (item
)); i
++;
7612 ASET (menu_bar_items_vector
, i
, make_number (0)); i
++;
7613 menu_bar_items_index
= i
;
7615 /* We did find an item for this KEY. Add ITEM to its list of maps. */
7619 old
= AREF (menu_bar_items_vector
, i
+ 2);
7620 /* If the new and the old items are not both keymaps,
7621 the lookup will only find `item'. */
7622 item
= Fcons (item
, KEYMAPP (item
) && KEYMAPP (XCAR (old
)) ? old
: Qnil
);
7623 ASET (menu_bar_items_vector
, i
+ 2, item
);
7627 /* This is used as the handler when calling menu_item_eval_property. */
7629 menu_item_eval_property_1 (Lisp_Object arg
)
7631 /* If we got a quit from within the menu computation,
7632 quit all the way out of it. This takes care of C-] in the debugger. */
7633 if (CONSP (arg
) && EQ (XCAR (arg
), Qquit
))
7634 Fsignal (Qquit
, Qnil
);
7640 eval_dyn (Lisp_Object form
)
7642 return Feval (form
, Qnil
);
7645 /* Evaluate an expression and return the result (or nil if something
7646 went wrong). Used to evaluate dynamic parts of menu items. */
7648 menu_item_eval_property (Lisp_Object sexpr
)
7650 ptrdiff_t count
= SPECPDL_INDEX ();
7652 specbind (Qinhibit_redisplay
, Qt
);
7653 val
= internal_condition_case_1 (eval_dyn
, sexpr
, Qerror
,
7654 menu_item_eval_property_1
);
7655 return unbind_to (count
, val
);
7658 /* This function parses a menu item and leaves the result in the
7659 vector item_properties.
7660 ITEM is a key binding, a possible menu item.
7661 INMENUBAR is > 0 when this is considered for an entry in a menu bar
7663 INMENUBAR is < 0 when this is considered for an entry in a keyboard menu.
7664 parse_menu_item returns true if the item is a menu item and false
7668 parse_menu_item (Lisp_Object item
, int inmenubar
)
7670 Lisp_Object def
, tem
, item_string
, start
;
7672 Lisp_Object keyhint
;
7681 /* Create item_properties vector if necessary. */
7682 if (NILP (item_properties
))
7684 = Fmake_vector (make_number (ITEM_PROPERTY_ENABLE
+ 1), Qnil
);
7686 /* Initialize optional entries. */
7687 for (i
= ITEM_PROPERTY_DEF
; i
< ITEM_PROPERTY_ENABLE
; i
++)
7688 ASET (item_properties
, i
, Qnil
);
7689 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7691 /* Save the item here to protect it from GC. */
7692 ASET (item_properties
, ITEM_PROPERTY_ITEM
, item
);
7694 item_string
= XCAR (item
);
7698 if (STRINGP (item_string
))
7700 /* Old format menu item. */
7701 ASET (item_properties
, ITEM_PROPERTY_NAME
, item_string
);
7703 /* Maybe help string. */
7704 if (CONSP (item
) && STRINGP (XCAR (item
)))
7706 ASET (item_properties
, ITEM_PROPERTY_HELP
, XCAR (item
));
7711 /* Maybe an obsolete key binding cache. */
7712 if (CONSP (item
) && CONSP (XCAR (item
))
7713 && (NILP (XCAR (XCAR (item
)))
7714 || VECTORP (XCAR (XCAR (item
)))))
7717 /* This is the real definition--the function to run. */
7718 ASET (item_properties
, ITEM_PROPERTY_DEF
, item
);
7720 /* Get enable property, if any. */
7723 tem
= Fget (item
, Qmenu_enable
);
7724 if (!NILP (Venable_disabled_menus_and_buttons
))
7725 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7726 else if (!NILP (tem
))
7727 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, tem
);
7730 else if (EQ (item_string
, Qmenu_item
) && CONSP (item
))
7732 /* New format menu item. */
7733 ASET (item_properties
, ITEM_PROPERTY_NAME
, XCAR (item
));
7734 start
= XCDR (item
);
7737 /* We have a real binding. */
7738 ASET (item_properties
, ITEM_PROPERTY_DEF
, XCAR (start
));
7740 item
= XCDR (start
);
7741 /* Is there an obsolete cache list with key equivalences. */
7742 if (CONSP (item
) && CONSP (XCAR (item
)))
7745 /* Parse properties. */
7746 while (CONSP (item
) && CONSP (XCDR (item
)))
7751 if (EQ (tem
, QCenable
))
7753 if (!NILP (Venable_disabled_menus_and_buttons
))
7754 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7756 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, XCAR (item
));
7758 else if (EQ (tem
, QCvisible
))
7760 /* If got a visible property and that evaluates to nil
7761 then ignore this item. */
7762 tem
= menu_item_eval_property (XCAR (item
));
7766 else if (EQ (tem
, QChelp
))
7767 ASET (item_properties
, ITEM_PROPERTY_HELP
, XCAR (item
));
7768 else if (EQ (tem
, QCfilter
))
7770 else if (EQ (tem
, QCkey_sequence
))
7773 if (SYMBOLP (tem
) || STRINGP (tem
) || VECTORP (tem
))
7774 /* Be GC protected. Set keyhint to item instead of tem. */
7777 else if (EQ (tem
, QCkeys
))
7780 if (CONSP (tem
) || STRINGP (tem
))
7781 ASET (item_properties
, ITEM_PROPERTY_KEYEQ
, tem
);
7783 else if (EQ (tem
, QCbutton
) && CONSP (XCAR (item
)))
7788 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
7790 ASET (item_properties
, ITEM_PROPERTY_SELECTED
,
7792 ASET (item_properties
, ITEM_PROPERTY_TYPE
, type
);
7798 else if (inmenubar
|| !NILP (start
))
7802 return 0; /* not a menu item */
7804 /* If item string is not a string, evaluate it to get string.
7805 If we don't get a string, skip this item. */
7806 item_string
= AREF (item_properties
, ITEM_PROPERTY_NAME
);
7807 if (!(STRINGP (item_string
)))
7809 item_string
= menu_item_eval_property (item_string
);
7810 if (!STRINGP (item_string
))
7812 ASET (item_properties
, ITEM_PROPERTY_NAME
, item_string
);
7815 /* If got a filter apply it on definition. */
7816 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7819 def
= menu_item_eval_property (list2 (XCAR (filter
),
7820 list2 (Qquote
, def
)));
7822 ASET (item_properties
, ITEM_PROPERTY_DEF
, def
);
7825 /* Enable or disable selection of item. */
7826 tem
= AREF (item_properties
, ITEM_PROPERTY_ENABLE
);
7829 tem
= menu_item_eval_property (tem
);
7830 if (inmenubar
&& NILP (tem
))
7831 return 0; /* Ignore disabled items in menu bar. */
7832 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, tem
);
7835 /* If we got no definition, this item is just unselectable text which
7836 is OK in a submenu but not in the menubar. */
7838 return (!inmenubar
);
7840 /* See if this is a separate pane or a submenu. */
7841 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7842 tem
= get_keymap (def
, 0, 1);
7843 /* For a subkeymap, just record its details and exit. */
7846 ASET (item_properties
, ITEM_PROPERTY_MAP
, tem
);
7847 ASET (item_properties
, ITEM_PROPERTY_DEF
, tem
);
7851 /* At the top level in the menu bar, do likewise for commands also.
7852 The menu bar does not display equivalent key bindings anyway.
7853 ITEM_PROPERTY_DEF is already set up properly. */
7857 { /* This is a command. See if there is an equivalent key binding. */
7858 Lisp_Object keyeq
= AREF (item_properties
, ITEM_PROPERTY_KEYEQ
);
7859 AUTO_STRING (space_space
, " ");
7861 /* The previous code preferred :key-sequence to :keys, so we
7862 preserve this behavior. */
7863 if (STRINGP (keyeq
) && !CONSP (keyhint
))
7864 keyeq
= concat2 (space_space
, Fsubstitute_command_keys (keyeq
));
7867 Lisp_Object prefix
= keyeq
;
7868 Lisp_Object keys
= Qnil
;
7872 def
= XCAR (prefix
);
7873 prefix
= XCDR (prefix
);
7876 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7878 if (CONSP (keyhint
) && !NILP (XCAR (keyhint
)))
7880 keys
= XCAR (keyhint
);
7881 tem
= Fkey_binding (keys
, Qnil
, Qnil
, Qnil
);
7883 /* We have a suggested key. Is it bound to the command? */
7886 /* If the command is an alias for another
7887 (such as lmenu.el set it up), check if the
7888 original command matches the cached command. */
7890 && EQ (tem
, XSYMBOL (def
)->function
))))
7895 keys
= Fwhere_is_internal (def
, Qnil
, Qt
, Qnil
, Qnil
);
7899 tem
= Fkey_description (keys
, Qnil
);
7902 if (STRINGP (XCAR (prefix
)))
7903 tem
= concat2 (XCAR (prefix
), tem
);
7904 if (STRINGP (XCDR (prefix
)))
7905 tem
= concat2 (tem
, XCDR (prefix
));
7907 keyeq
= concat2 (space_space
, tem
);
7913 /* If we have an equivalent key binding, use that. */
7914 ASET (item_properties
, ITEM_PROPERTY_KEYEQ
, keyeq
);
7917 /* Include this when menu help is implemented.
7918 tem = XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP];
7919 if (!(NILP (tem) || STRINGP (tem)))
7921 tem = menu_item_eval_property (tem);
7924 XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP] = tem;
7928 /* Handle radio buttons or toggle boxes. */
7929 tem
= AREF (item_properties
, ITEM_PROPERTY_SELECTED
);
7931 ASET (item_properties
, ITEM_PROPERTY_SELECTED
,
7932 menu_item_eval_property (tem
));
7939 /***********************************************************************
7941 ***********************************************************************/
7943 /* A vector holding tool bar items while they are parsed in function
7944 tool_bar_items. Each item occupies TOOL_BAR_ITEM_NSCLOTS elements
7947 static Lisp_Object tool_bar_items_vector
;
7949 /* A vector holding the result of parse_tool_bar_item. Layout is like
7950 the one for a single item in tool_bar_items_vector. */
7952 static Lisp_Object tool_bar_item_properties
;
7954 /* Next free index in tool_bar_items_vector. */
7956 static int ntool_bar_items
;
7958 /* Function prototypes. */
7960 static void init_tool_bar_items (Lisp_Object
);
7961 static void process_tool_bar_item (Lisp_Object
, Lisp_Object
, Lisp_Object
,
7963 static bool parse_tool_bar_item (Lisp_Object
, Lisp_Object
);
7964 static void append_tool_bar_item (void);
7967 /* Return a vector of tool bar items for keymaps currently in effect.
7968 Reuse vector REUSE if non-nil. Return in *NITEMS the number of
7969 tool bar items found. */
7972 tool_bar_items (Lisp_Object reuse
, int *nitems
)
7975 Lisp_Object mapsbuf
[3];
7983 /* In order to build the menus, we need to call the keymap
7984 accessors. They all call QUIT. But this function is called
7985 during redisplay, during which a quit is fatal. So inhibit
7986 quitting while building the menus. We do this instead of
7987 specbind because (1) errors will clear it anyway and (2) this
7988 avoids risk of specpdl overflow. */
7989 oquit
= Vinhibit_quit
;
7992 /* Initialize tool_bar_items_vector and protect it from GC. */
7993 init_tool_bar_items (reuse
);
7995 /* Build list of keymaps in maps. Set nmaps to the number of maps
7998 /* Should overriding-terminal-local-map and overriding-local-map apply? */
7999 if (!NILP (Voverriding_local_map_menu_flag
)
8000 && !NILP (Voverriding_local_map
))
8002 /* Yes, use them (if non-nil) as well as the global map. */
8005 if (!NILP (KVAR (current_kboard
, Voverriding_terminal_local_map
)))
8006 maps
[nmaps
++] = KVAR (current_kboard
, Voverriding_terminal_local_map
);
8007 if (!NILP (Voverriding_local_map
))
8008 maps
[nmaps
++] = Voverriding_local_map
;
8012 /* No, so use major and minor mode keymaps and keymap property.
8013 Note that tool-bar bindings in the local-map and keymap
8014 properties may not work reliable, as they are only
8015 recognized when the tool-bar (or mode-line) is updated,
8016 which does not normally happen after every command. */
8019 nminor
= current_minor_maps (NULL
, &tmaps
);
8020 SAFE_NALLOCA (maps
, 1, nminor
+ 4);
8022 tem
= KVAR (current_kboard
, Voverriding_terminal_local_map
);
8023 if (!NILP (tem
) && !NILP (Voverriding_local_map_menu_flag
))
8024 maps
[nmaps
++] = tem
;
8025 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
8026 maps
[nmaps
++] = tem
;
8027 memcpy (maps
+ nmaps
, tmaps
, nminor
* sizeof (maps
[0]));
8029 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
8032 /* Add global keymap at the end. */
8033 maps
[nmaps
++] = current_global_map
;
8035 /* Process maps in reverse order and look up in each map the prefix
8037 for (i
= nmaps
- 1; i
>= 0; --i
)
8038 if (!NILP (maps
[i
]))
8042 keymap
= get_keymap (access_keymap (maps
[i
], Qtool_bar
, 1, 0, 1), 0, 1);
8044 map_keymap (keymap
, process_tool_bar_item
, Qnil
, NULL
, 1);
8047 Vinhibit_quit
= oquit
;
8048 *nitems
= ntool_bar_items
/ TOOL_BAR_ITEM_NSLOTS
;
8050 return tool_bar_items_vector
;
8054 /* Process the definition of KEY which is DEF. */
8057 process_tool_bar_item (Lisp_Object key
, Lisp_Object def
, Lisp_Object data
, void *args
)
8060 struct gcpro gcpro1
, gcpro2
;
8062 /* Protect KEY and DEF from GC because parse_tool_bar_item may call
8066 if (EQ (def
, Qundefined
))
8068 /* If a map has an explicit `undefined' as definition,
8069 discard any previously made item. */
8070 for (i
= 0; i
< ntool_bar_items
; i
+= TOOL_BAR_ITEM_NSLOTS
)
8072 Lisp_Object
*v
= XVECTOR (tool_bar_items_vector
)->contents
+ i
;
8074 if (EQ (key
, v
[TOOL_BAR_ITEM_KEY
]))
8076 if (ntool_bar_items
> i
+ TOOL_BAR_ITEM_NSLOTS
)
8077 memmove (v
, v
+ TOOL_BAR_ITEM_NSLOTS
,
8078 ((ntool_bar_items
- i
- TOOL_BAR_ITEM_NSLOTS
)
8080 ntool_bar_items
-= TOOL_BAR_ITEM_NSLOTS
;
8085 else if (parse_tool_bar_item (key
, def
))
8086 /* Append a new tool bar item to tool_bar_items_vector. Accept
8087 more than one definition for the same key. */
8088 append_tool_bar_item ();
8093 /* Access slot with index IDX of vector tool_bar_item_properties. */
8094 #define PROP(IDX) AREF (tool_bar_item_properties, (IDX))
8096 set_prop (ptrdiff_t idx
, Lisp_Object val
)
8098 ASET (tool_bar_item_properties
, idx
, val
);
8102 /* Parse a tool bar item specification ITEM for key KEY and return the
8103 result in tool_bar_item_properties. Value is false if ITEM is
8106 ITEM is a list `(menu-item CAPTION BINDING PROPS...)'.
8108 CAPTION is the caption of the item, If it's not a string, it is
8109 evaluated to get a string.
8111 BINDING is the tool bar item's binding. Tool-bar items with keymaps
8112 as binding are currently ignored.
8114 The following properties are recognized:
8118 FORM is evaluated and specifies whether the tool bar item is
8119 enabled or disabled.
8123 FORM is evaluated and specifies whether the tool bar item is visible.
8125 - `:filter FUNCTION'
8127 FUNCTION is invoked with one parameter `(quote BINDING)'. Its
8128 result is stored as the new binding.
8130 - `:button (TYPE SELECTED)'
8132 TYPE must be one of `:radio' or `:toggle'. SELECTED is evaluated
8133 and specifies whether the button is selected (pressed) or not.
8137 IMAGES is either a single image specification or a vector of four
8138 image specifications. See enum tool_bar_item_images.
8140 - `:help HELP-STRING'.
8142 Gives a help string to display for the tool bar item.
8144 - `:label LABEL-STRING'.
8146 A text label to show with the tool bar button if labels are enabled. */
8149 parse_tool_bar_item (Lisp_Object key
, Lisp_Object item
)
8151 Lisp_Object filter
= Qnil
;
8152 Lisp_Object caption
;
8154 bool have_label
= 0;
8156 /* Definition looks like `(menu-item CAPTION BINDING PROPS...)'.
8157 Rule out items that aren't lists, don't start with
8158 `menu-item' or whose rest following `tool-bar-item' is not a
8163 /* As an exception, allow old-style menu separators. */
8164 if (STRINGP (XCAR (item
)))
8165 item
= list1 (XCAR (item
));
8166 else if (!EQ (XCAR (item
), Qmenu_item
)
8167 || (item
= XCDR (item
), !CONSP (item
)))
8170 /* Create tool_bar_item_properties vector if necessary. Reset it to
8172 if (VECTORP (tool_bar_item_properties
))
8174 for (i
= 0; i
< TOOL_BAR_ITEM_NSLOTS
; ++i
)
8178 tool_bar_item_properties
8179 = Fmake_vector (make_number (TOOL_BAR_ITEM_NSLOTS
), Qnil
);
8182 set_prop (TOOL_BAR_ITEM_KEY
, key
);
8183 set_prop (TOOL_BAR_ITEM_ENABLED_P
, Qt
);
8185 /* Get the caption of the item. If the caption is not a string,
8186 evaluate it to get a string. If we don't get a string, skip this
8188 caption
= XCAR (item
);
8189 if (!STRINGP (caption
))
8191 caption
= menu_item_eval_property (caption
);
8192 if (!STRINGP (caption
))
8195 set_prop (TOOL_BAR_ITEM_CAPTION
, caption
);
8197 /* If the rest following the caption is not a list, the menu item is
8198 either a separator, or invalid. */
8202 if (menu_separator_name_p (SSDATA (caption
)))
8204 set_prop (TOOL_BAR_ITEM_TYPE
, Qt
);
8205 #if !defined (USE_GTK) && !defined (HAVE_NS)
8206 /* If we use build_desired_tool_bar_string to render the
8207 tool bar, the separator is rendered as an image. */
8208 set_prop (TOOL_BAR_ITEM_IMAGES
,
8209 (menu_item_eval_property
8210 (Vtool_bar_separator_image_expression
)));
8211 set_prop (TOOL_BAR_ITEM_ENABLED_P
, Qnil
);
8212 set_prop (TOOL_BAR_ITEM_SELECTED_P
, Qnil
);
8213 set_prop (TOOL_BAR_ITEM_CAPTION
, Qnil
);
8220 /* Store the binding. */
8221 set_prop (TOOL_BAR_ITEM_BINDING
, XCAR (item
));
8224 /* Ignore cached key binding, if any. */
8225 if (CONSP (item
) && CONSP (XCAR (item
)))
8228 /* Process the rest of the properties. */
8229 for (; CONSP (item
) && CONSP (XCDR (item
)); item
= XCDR (XCDR (item
)))
8231 Lisp_Object ikey
, value
;
8234 value
= XCAR (XCDR (item
));
8236 if (EQ (ikey
, QCenable
))
8238 /* `:enable FORM'. */
8239 if (!NILP (Venable_disabled_menus_and_buttons
))
8240 set_prop (TOOL_BAR_ITEM_ENABLED_P
, Qt
);
8242 set_prop (TOOL_BAR_ITEM_ENABLED_P
, value
);
8244 else if (EQ (ikey
, QCvisible
))
8246 /* `:visible FORM'. If got a visible property and that
8247 evaluates to nil then ignore this item. */
8248 if (NILP (menu_item_eval_property (value
)))
8251 else if (EQ (ikey
, QChelp
))
8252 /* `:help HELP-STRING'. */
8253 set_prop (TOOL_BAR_ITEM_HELP
, value
);
8254 else if (EQ (ikey
, QCvert_only
))
8255 /* `:vert-only t/nil'. */
8256 set_prop (TOOL_BAR_ITEM_VERT_ONLY
, value
);
8257 else if (EQ (ikey
, QClabel
))
8259 const char *bad_label
= "!!?GARBLED ITEM?!!";
8260 /* `:label LABEL-STRING'. */
8261 set_prop (TOOL_BAR_ITEM_LABEL
,
8262 STRINGP (value
) ? value
: build_string (bad_label
));
8265 else if (EQ (ikey
, QCfilter
))
8266 /* ':filter FORM'. */
8268 else if (EQ (ikey
, QCbutton
) && CONSP (value
))
8270 /* `:button (TYPE . SELECTED)'. */
8271 Lisp_Object type
, selected
;
8273 type
= XCAR (value
);
8274 selected
= XCDR (value
);
8275 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
8277 set_prop (TOOL_BAR_ITEM_SELECTED_P
, selected
);
8278 set_prop (TOOL_BAR_ITEM_TYPE
, type
);
8281 else if (EQ (ikey
, QCimage
)
8283 || (VECTORP (value
) && ASIZE (value
) == 4)))
8284 /* Value is either a single image specification or a vector
8285 of 4 such specifications for the different button states. */
8286 set_prop (TOOL_BAR_ITEM_IMAGES
, value
);
8287 else if (EQ (ikey
, QCrtl
))
8289 set_prop (TOOL_BAR_ITEM_RTL_IMAGE
, value
);
8295 /* Try to make one from caption and key. */
8296 Lisp_Object tkey
= PROP (TOOL_BAR_ITEM_KEY
);
8297 Lisp_Object tcapt
= PROP (TOOL_BAR_ITEM_CAPTION
);
8298 const char *label
= SYMBOLP (tkey
) ? SSDATA (SYMBOL_NAME (tkey
)) : "";
8299 const char *capt
= STRINGP (tcapt
) ? SSDATA (tcapt
) : "";
8301 2 * max (0, min (tool_bar_max_label_size
, STRING_BYTES_BOUND
/ 2));
8302 char *buf
= xmalloc (max_lbl
+ 1);
8303 Lisp_Object new_lbl
;
8304 ptrdiff_t caption_len
= strlen (capt
);
8306 if (caption_len
<= max_lbl
&& capt
[0] != '\0')
8309 while (caption_len
> 0 && buf
[caption_len
- 1] == '.')
8311 buf
[caption_len
] = '\0';
8315 if (strlen (label
) <= max_lbl
&& label
[0] != '\0')
8319 strcpy (buf
, label
);
8321 for (j
= 0; buf
[j
] != '\0'; ++j
)
8329 new_lbl
= Fupcase_initials (build_string (label
));
8330 if (SCHARS (new_lbl
) <= tool_bar_max_label_size
)
8331 set_prop (TOOL_BAR_ITEM_LABEL
, new_lbl
);
8333 set_prop (TOOL_BAR_ITEM_LABEL
, empty_unibyte_string
);
8337 /* If got a filter apply it on binding. */
8339 set_prop (TOOL_BAR_ITEM_BINDING
,
8340 (menu_item_eval_property
8343 PROP (TOOL_BAR_ITEM_BINDING
))))));
8345 /* See if the binding is a keymap. Give up if it is. */
8346 if (CONSP (get_keymap (PROP (TOOL_BAR_ITEM_BINDING
), 0, 1)))
8349 /* Enable or disable selection of item. */
8350 if (!EQ (PROP (TOOL_BAR_ITEM_ENABLED_P
), Qt
))
8351 set_prop (TOOL_BAR_ITEM_ENABLED_P
,
8352 menu_item_eval_property (PROP (TOOL_BAR_ITEM_ENABLED_P
)));
8354 /* Handle radio buttons or toggle boxes. */
8355 if (!NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
)))
8356 set_prop (TOOL_BAR_ITEM_SELECTED_P
,
8357 menu_item_eval_property (PROP (TOOL_BAR_ITEM_SELECTED_P
)));
8365 /* Initialize tool_bar_items_vector. REUSE, if non-nil, is a vector
8366 that can be reused. */
8369 init_tool_bar_items (Lisp_Object reuse
)
8371 if (VECTORP (reuse
))
8372 tool_bar_items_vector
= reuse
;
8374 tool_bar_items_vector
= Fmake_vector (make_number (64), Qnil
);
8375 ntool_bar_items
= 0;
8379 /* Append parsed tool bar item properties from
8380 tool_bar_item_properties */
8383 append_tool_bar_item (void)
8387 - (ASIZE (tool_bar_items_vector
) - TOOL_BAR_ITEM_NSLOTS
));
8389 /* Enlarge tool_bar_items_vector if necessary. */
8391 tool_bar_items_vector
= larger_vector (tool_bar_items_vector
, incr
, -1);
8393 /* Append entries from tool_bar_item_properties to the end of
8394 tool_bar_items_vector. */
8395 vcopy (tool_bar_items_vector
, ntool_bar_items
,
8396 XVECTOR (tool_bar_item_properties
)->contents
, TOOL_BAR_ITEM_NSLOTS
);
8397 ntool_bar_items
+= TOOL_BAR_ITEM_NSLOTS
;
8404 /* Read a character using menus based on the keymap MAP.
8405 Return nil if there are no menus in the maps.
8406 Return t if we displayed a menu but the user rejected it.
8408 PREV_EVENT is the previous input event, or nil if we are reading
8409 the first event of a key sequence.
8411 If USED_MOUSE_MENU is non-null, set *USED_MOUSE_MENU to true
8412 if we used a mouse menu to read the input, or false otherwise. If
8413 USED_MOUSE_MENU is null, don't dereference it.
8415 The prompting is done based on the prompt-string of the map
8416 and the strings associated with various map elements.
8418 This can be done with X menus or with menus put in the minibuf.
8419 These are done in different ways, depending on how the input will be read.
8420 Menus using X are done after auto-saving in read-char, getting the input
8421 event from Fx_popup_menu; menus using the minibuf use read_char recursively
8422 and do auto-saving in the inner call of read_char. */
8425 read_char_x_menu_prompt (Lisp_Object map
,
8426 Lisp_Object prev_event
, bool *used_mouse_menu
)
8428 if (used_mouse_menu
)
8429 *used_mouse_menu
= 0;
8431 /* Use local over global Menu maps. */
8433 if (! menu_prompting
)
8436 /* If we got to this point via a mouse click,
8437 use a real menu for mouse selection. */
8438 if (EVENT_HAS_PARAMETERS (prev_event
)
8439 && !EQ (XCAR (prev_event
), Qmenu_bar
)
8440 && !EQ (XCAR (prev_event
), Qtool_bar
))
8442 /* Display the menu and get the selection. */
8445 value
= Fx_popup_menu (prev_event
, get_keymap (map
, 0, 1));
8450 record_menu_key (XCAR (value
));
8452 /* If we got multiple events, unread all but
8454 There is no way to prevent those unread events
8455 from showing up later in last_nonmenu_event.
8456 So turn symbol and integer events into lists,
8457 to indicate that they came from a mouse menu,
8458 so that when present in last_nonmenu_event
8459 they won't confuse things. */
8460 for (tem
= XCDR (value
); CONSP (tem
); tem
= XCDR (tem
))
8462 record_menu_key (XCAR (tem
));
8463 if (SYMBOLP (XCAR (tem
))
8464 || INTEGERP (XCAR (tem
)))
8465 XSETCAR (tem
, Fcons (XCAR (tem
), Qdisabled
));
8468 /* If we got more than one event, put all but the first
8469 onto this list to be read later.
8470 Return just the first event now. */
8471 Vunread_command_events
8472 = nconc2 (XCDR (value
), Vunread_command_events
);
8473 value
= XCAR (value
);
8475 else if (NILP (value
))
8477 if (used_mouse_menu
)
8478 *used_mouse_menu
= 1;
8485 read_char_minibuf_menu_prompt (int commandflag
,
8490 /* FIXME: Use the minibuffer's frame width. */
8491 ptrdiff_t width
= FRAME_COLS (SELECTED_FRAME ()) - 4;
8493 bool nobindings
= 1;
8494 Lisp_Object rest
, vector
;
8495 Lisp_Object prompt_strings
= Qnil
;
8499 if (! menu_prompting
)
8502 map
= get_keymap (map
, 0, 1);
8503 name
= Fkeymap_prompt (map
);
8505 /* If we don't have any menus, just read a character normally. */
8506 if (!STRINGP (name
))
8509 #define PUSH_C_STR(str, listvar) \
8510 listvar = Fcons (build_unibyte_string (str), listvar)
8512 /* Prompt string always starts with map's prompt, and a space. */
8513 prompt_strings
= Fcons (name
, prompt_strings
);
8514 PUSH_C_STR (": ", prompt_strings
);
8515 nlength
= SCHARS (name
) + 2;
8519 /* Present the documented bindings, a line at a time. */
8523 Lisp_Object menu_strings
= prompt_strings
;
8524 ptrdiff_t i
= nlength
;
8526 Lisp_Object orig_defn_macro
;
8528 /* Loop over elements of map. */
8533 /* FIXME: Use map_keymap to handle new keymap formats. */
8535 /* At end of map, wrap around if just starting,
8536 or end this line if already have something on it. */
8539 if (notfirst
|| nobindings
)
8545 /* Look at the next element of the map. */
8547 elt
= AREF (vector
, idx
);
8549 elt
= Fcar_safe (rest
);
8551 if (idx
< 0 && VECTORP (elt
))
8553 /* If we found a dense table in the keymap,
8554 advanced past it, but start scanning its contents. */
8555 rest
= Fcdr_safe (rest
);
8561 /* An ordinary element. */
8562 Lisp_Object event
, tem
;
8566 event
= Fcar_safe (elt
); /* alist */
8567 elt
= Fcdr_safe (elt
);
8571 XSETINT (event
, idx
); /* vector */
8574 /* Ignore the element if it has no prompt string. */
8575 if (INTEGERP (event
) && parse_menu_item (elt
, -1))
8577 /* True if the char to type matches the string. */
8579 Lisp_Object upcased_event
, downcased_event
;
8580 Lisp_Object desc
= Qnil
;
8582 = AREF (item_properties
, ITEM_PROPERTY_NAME
);
8584 upcased_event
= Fupcase (event
);
8585 downcased_event
= Fdowncase (event
);
8586 char_matches
= (XINT (upcased_event
) == SREF (s
, 0)
8587 || XINT (downcased_event
) == SREF (s
, 0));
8589 desc
= Fsingle_key_description (event
, Qnil
);
8591 #if 0 /* It is redundant to list the equivalent key bindings because
8592 the prefix is what the user has already typed. */
8594 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_KEYEQ
];
8596 /* Insert equivalent keybinding. */
8597 s
= concat2 (s
, tem
);
8600 = AREF (item_properties
, ITEM_PROPERTY_TYPE
);
8601 if (EQ (tem
, QCradio
) || EQ (tem
, QCtoggle
))
8603 /* Insert button prefix. */
8604 Lisp_Object selected
8605 = AREF (item_properties
, ITEM_PROPERTY_SELECTED
);
8606 AUTO_STRING (radio_yes
, "(*) ");
8607 AUTO_STRING (radio_no
, "( ) ");
8608 AUTO_STRING (check_yes
, "[X] ");
8609 AUTO_STRING (check_no
, "[ ] ");
8610 if (EQ (tem
, QCradio
))
8611 tem
= NILP (selected
) ? radio_yes
: radio_no
;
8613 tem
= NILP (selected
) ? check_yes
: check_no
;
8614 s
= concat2 (tem
, s
);
8618 /* If we have room for the prompt string, add it to this line.
8619 If this is the first on the line, always add it. */
8620 if ((SCHARS (s
) + i
+ 2
8621 + (char_matches
? 0 : SCHARS (desc
) + 3))
8625 ptrdiff_t thiswidth
;
8627 /* Punctuate between strings. */
8630 PUSH_C_STR (", ", menu_strings
);
8636 /* If the char to type doesn't match the string's
8637 first char, explicitly show what char to type. */
8640 /* Add as much of string as fits. */
8641 thiswidth
= min (SCHARS (desc
), width
- i
);
8643 = Fcons (Fsubstring (desc
, make_number (0),
8644 make_number (thiswidth
)),
8647 PUSH_C_STR (" = ", menu_strings
);
8651 /* Add as much of string as fits. */
8652 thiswidth
= min (SCHARS (s
), width
- i
);
8654 = Fcons (Fsubstring (s
, make_number (0),
8655 make_number (thiswidth
)),
8661 /* If this element does not fit, end the line now,
8662 and save the element for the next line. */
8663 PUSH_C_STR ("...", menu_strings
);
8668 /* Move past this element. */
8669 if (idx
>= 0 && idx
+ 1 >= ASIZE (vector
))
8670 /* Handle reaching end of dense table. */
8675 rest
= Fcdr_safe (rest
);
8679 /* Prompt with that and read response. */
8680 message3_nolog (apply1 (intern ("concat"), Fnreverse (menu_strings
)));
8682 /* Make believe it's not a keyboard macro in case the help char
8683 is pressed. Help characters are not recorded because menu prompting
8684 is not used on replay. */
8685 orig_defn_macro
= KVAR (current_kboard
, defining_kbd_macro
);
8686 kset_defining_kbd_macro (current_kboard
, Qnil
);
8688 obj
= read_char (commandflag
, Qnil
, Qt
, 0, NULL
);
8689 while (BUFFERP (obj
));
8690 kset_defining_kbd_macro (current_kboard
, orig_defn_macro
);
8692 if (!INTEGERP (obj
) || XINT (obj
) == -2)
8695 if (! EQ (obj
, menu_prompt_more_char
)
8696 && (!INTEGERP (menu_prompt_more_char
)
8697 || ! EQ (obj
, make_number (Ctl (XINT (menu_prompt_more_char
))))))
8699 if (!NILP (KVAR (current_kboard
, defining_kbd_macro
)))
8700 store_kbd_macro_char (obj
);
8703 /* Help char - go round again. */
8707 /* Reading key sequences. */
8710 follow_key (Lisp_Object keymap
, Lisp_Object key
)
8712 return access_keymap (get_keymap (keymap
, 0, 1),
8717 active_maps (Lisp_Object first_event
)
8719 Lisp_Object position
8720 = CONSP (first_event
) ? CAR_SAFE (XCDR (first_event
)) : Qnil
;
8721 return Fcons (Qkeymap
, Fcurrent_active_maps (Qt
, position
));
8724 /* Structure used to keep track of partial application of key remapping
8725 such as Vfunction_key_map and Vkey_translation_map. */
8726 typedef struct keyremap
8728 /* This is the map originally specified for this use. */
8730 /* This is a submap reached by looking up, in PARENT,
8731 the events from START to END. */
8733 /* Positions [START, END) in the key sequence buffer
8734 are the key that we have scanned so far.
8735 Those events are the ones that we will replace
8736 if PARENT maps them into a key sequence. */
8740 /* Lookup KEY in MAP.
8741 MAP is a keymap mapping keys to key vectors or functions.
8742 If the mapping is a function and DO_FUNCALL is true,
8743 the function is called with PROMPT as parameter and its return
8744 value is used as the return value of this function (after checking
8745 that it is indeed a vector). */
8748 access_keymap_keyremap (Lisp_Object map
, Lisp_Object key
, Lisp_Object prompt
,
8753 next
= access_keymap (map
, key
, 1, 0, 1);
8755 /* Handle a symbol whose function definition is a keymap
8757 if (SYMBOLP (next
) && !NILP (Ffboundp (next
))
8758 && (ARRAYP (XSYMBOL (next
)->function
)
8759 || KEYMAPP (XSYMBOL (next
)->function
)))
8760 next
= Fautoload_do_load (XSYMBOL (next
)->function
, next
, Qnil
);
8762 /* If the keymap gives a function, not an
8763 array, then call the function with one arg and use
8764 its value instead. */
8765 if (do_funcall
&& FUNCTIONP (next
))
8770 next
= call1 (next
, prompt
);
8771 /* If the function returned something invalid,
8772 barf--don't ignore it.
8773 (To ignore it safely, we would need to gcpro a bunch of
8774 other variables.) */
8775 if (! (NILP (next
) || VECTORP (next
) || STRINGP (next
)))
8776 error ("Function %s returns invalid key sequence",
8777 SSDATA (SYMBOL_NAME (tem
)));
8782 /* Do one step of the key remapping used for function-key-map and
8783 key-translation-map:
8784 KEYBUF is the buffer holding the input events.
8785 BUFSIZE is its maximum size.
8786 FKEY is a pointer to the keyremap structure to use.
8787 INPUT is the index of the last element in KEYBUF.
8788 DOIT if true says that the remapping can actually take place.
8789 DIFF is used to return the number of keys added/removed by the remapping.
8790 PARENT is the root of the keymap.
8791 PROMPT is the prompt to use if the remapping happens through a function.
8792 Return true if the remapping actually took place. */
8795 keyremap_step (Lisp_Object
*keybuf
, int bufsize
, volatile keyremap
*fkey
,
8796 int input
, bool doit
, int *diff
, Lisp_Object prompt
)
8798 Lisp_Object next
, key
;
8800 key
= keybuf
[fkey
->end
++];
8802 if (KEYMAPP (fkey
->parent
))
8803 next
= access_keymap_keyremap (fkey
->map
, key
, prompt
, doit
);
8807 /* If keybuf[fkey->start..fkey->end] is bound in the
8808 map and we're in a position to do the key remapping, replace it with
8809 the binding and restart with fkey->start at the end. */
8810 if ((VECTORP (next
) || STRINGP (next
)) && doit
)
8812 int len
= XFASTINT (Flength (next
));
8815 *diff
= len
- (fkey
->end
- fkey
->start
);
8817 if (bufsize
- input
<= *diff
)
8818 error ("Key sequence too long");
8820 /* Shift the keys that follow fkey->end. */
8822 for (i
= fkey
->end
; i
< input
; i
++)
8823 keybuf
[i
+ *diff
] = keybuf
[i
];
8825 for (i
= input
- 1; i
>= fkey
->end
; i
--)
8826 keybuf
[i
+ *diff
] = keybuf
[i
];
8827 /* Overwrite the old keys with the new ones. */
8828 for (i
= 0; i
< len
; i
++)
8829 keybuf
[fkey
->start
+ i
]
8830 = Faref (next
, make_number (i
));
8832 fkey
->start
= fkey
->end
+= *diff
;
8833 fkey
->map
= fkey
->parent
;
8838 fkey
->map
= get_keymap (next
, 0, 1);
8840 /* If we no longer have a bound suffix, try a new position for
8842 if (!CONSP (fkey
->map
))
8844 fkey
->end
= ++fkey
->start
;
8845 fkey
->map
= fkey
->parent
;
8851 test_undefined (Lisp_Object binding
)
8853 return (NILP (binding
)
8854 || EQ (binding
, Qundefined
)
8855 || (SYMBOLP (binding
)
8856 && EQ (Fcommand_remapping (binding
, Qnil
, Qnil
), Qundefined
)));
8859 /* Read a sequence of keys that ends with a non prefix character,
8860 storing it in KEYBUF, a buffer of size BUFSIZE.
8862 Return the length of the key sequence stored.
8863 Return -1 if the user rejected a command menu.
8865 Echo starting immediately unless `prompt' is 0.
8867 If PREVENT_REDISPLAY is non-zero, avoid redisplay by calling
8868 read_char with a suitable COMMANDFLAG argument.
8870 Where a key sequence ends depends on the currently active keymaps.
8871 These include any minor mode keymaps active in the current buffer,
8872 the current buffer's local map, and the global map.
8874 If a key sequence has no other bindings, we check Vfunction_key_map
8875 to see if some trailing subsequence might be the beginning of a
8876 function key's sequence. If so, we try to read the whole function
8877 key, and substitute its symbolic name into the key sequence.
8879 We ignore unbound `down-' mouse clicks. We turn unbound `drag-' and
8880 `double-' events into similar click events, if that would make them
8881 bound. We try to turn `triple-' events first into `double-' events,
8884 If we get a mouse click in a mode line, vertical divider, or other
8885 non-text area, we treat the click as if it were prefixed by the
8886 symbol denoting that area - `mode-line', `vertical-line', or
8889 If the sequence starts with a mouse click, we read the key sequence
8890 with respect to the buffer clicked on, not the current buffer.
8892 If the user switches frames in the midst of a key sequence, we put
8893 off the switch-frame event until later; the next call to
8894 read_char will return it.
8896 If FIX_CURRENT_BUFFER, we restore current_buffer
8897 from the selected window's buffer. */
8900 read_key_sequence (Lisp_Object
*keybuf
, int bufsize
, Lisp_Object prompt
,
8901 bool dont_downcase_last
, bool can_return_switch_frame
,
8902 bool fix_current_buffer
, bool prevent_redisplay
)
8904 ptrdiff_t count
= SPECPDL_INDEX ();
8906 /* How many keys there are in the current key sequence. */
8909 /* The length of the echo buffer when we started reading, and
8910 the length of this_command_keys when we started reading. */
8911 ptrdiff_t echo_start
IF_LINT (= 0);
8912 ptrdiff_t keys_start
;
8914 Lisp_Object current_binding
= Qnil
;
8915 Lisp_Object first_event
= Qnil
;
8917 /* Index of the first key that has no binding.
8918 It is useless to try fkey.start larger than that. */
8921 /* If t < mock_input, then KEYBUF[t] should be read as the next
8924 We use this to recover after recognizing a function key. Once we
8925 realize that a suffix of the current key sequence is actually a
8926 function key's escape sequence, we replace the suffix with the
8927 function key's binding from Vfunction_key_map. Now keybuf
8928 contains a new and different key sequence, so the echo area,
8929 this_command_keys, and the submaps and defs arrays are wrong. In
8930 this situation, we set mock_input to t, set t to 0, and jump to
8931 restart_sequence; the loop will read keys from keybuf up until
8932 mock_input, thus rebuilding the state; and then it will resume
8933 reading characters from the keyboard. */
8936 /* If the sequence is unbound in submaps[], then
8937 keybuf[fkey.start..fkey.end-1] is a prefix in Vfunction_key_map,
8938 and fkey.map is its binding.
8940 These might be > t, indicating that all function key scanning
8941 should hold off until t reaches them. We do this when we've just
8942 recognized a function key, to avoid searching for the function
8943 key's again in Vfunction_key_map. */
8946 /* Likewise, for key_translation_map and input-decode-map. */
8947 keyremap keytran
, indec
;
8949 /* True if we are trying to map a key by changing an upper-case
8950 letter to lower case, or a shifted function key to an unshifted
8952 bool shift_translated
= 0;
8954 /* If we receive a `switch-frame' or `select-window' event in the middle of
8955 a key sequence, we put it off for later.
8956 While we're reading, we keep the event here. */
8957 Lisp_Object delayed_switch_frame
;
8959 Lisp_Object original_uppercase
IF_LINT (= Qnil
);
8960 int original_uppercase_position
= -1;
8962 /* Gets around Microsoft compiler limitations. */
8965 struct buffer
*starting_buffer
;
8967 /* List of events for which a fake prefix key has been generated. */
8968 Lisp_Object fake_prefixed_keys
= Qnil
;
8970 struct gcpro gcpro1
;
8972 GCPRO1 (fake_prefixed_keys
);
8973 raw_keybuf_count
= 0;
8975 last_nonmenu_event
= Qnil
;
8977 delayed_switch_frame
= Qnil
;
8983 /* Install the string PROMPT as the beginning of the string
8984 of echoing, so that it serves as a prompt for the next
8986 kset_echo_string (current_kboard
, prompt
);
8987 current_kboard
->echo_after_prompt
= SCHARS (prompt
);
8990 else if (cursor_in_echo_area
8991 && echo_keystrokes_p ())
8992 /* This doesn't put in a dash if the echo buffer is empty, so
8993 you don't always see a dash hanging out in the minibuffer. */
8997 /* Record the initial state of the echo area and this_command_keys;
8998 we will need to restore them if we replay a key sequence. */
9000 echo_start
= echo_length ();
9001 keys_start
= this_command_key_count
;
9002 this_single_command_key_start
= keys_start
;
9004 /* We jump here when we need to reinitialize fkey and keytran; this
9005 happens if we switch keyboards between rescans. */
9006 replay_entire_sequence
:
9008 indec
.map
= indec
.parent
= KVAR (current_kboard
, Vinput_decode_map
);
9009 fkey
.map
= fkey
.parent
= KVAR (current_kboard
, Vlocal_function_key_map
);
9010 keytran
.map
= keytran
.parent
= Vkey_translation_map
;
9011 indec
.start
= indec
.end
= 0;
9012 fkey
.start
= fkey
.end
= 0;
9013 keytran
.start
= keytran
.end
= 0;
9015 /* We jump here when the key sequence has been thoroughly changed, and
9016 we need to rescan it starting from the beginning. When we jump here,
9017 keybuf[0..mock_input] holds the sequence we should reread. */
9020 starting_buffer
= current_buffer
;
9021 first_unbound
= bufsize
+ 1;
9023 /* Build our list of keymaps.
9024 If we recognize a function key and replace its escape sequence in
9025 keybuf with its symbol, or if the sequence starts with a mouse
9026 click and we need to switch buffers, we jump back here to rebuild
9027 the initial keymaps from the current buffer. */
9028 current_binding
= active_maps (first_event
);
9030 /* Start from the beginning in keybuf. */
9033 /* These are no-ops the first time through, but if we restart, they
9034 revert the echo area and this_command_keys to their original state. */
9035 this_command_key_count
= keys_start
;
9036 if (INTERACTIVE
&& t
< mock_input
)
9037 echo_truncate (echo_start
);
9039 /* If the best binding for the current key sequence is a keymap, or
9040 we may be looking at a function key's escape sequence, keep on
9042 while (!NILP (current_binding
)
9043 /* Keep reading as long as there's a prefix binding. */
9044 ? KEYMAPP (current_binding
)
9045 /* Don't return in the middle of a possible function key sequence,
9046 if the only bindings we found were via case conversion.
9047 Thus, if ESC O a has a function-key-map translation
9048 and ESC o has a binding, don't return after ESC O,
9049 so that we can translate ESC O plus the next character. */
9050 : (/* indec.start < t || fkey.start < t || */ keytran
.start
< t
))
9053 bool used_mouse_menu
= 0;
9055 /* Where the last real key started. If we need to throw away a
9056 key that has expanded into more than one element of keybuf
9057 (say, a mouse click on the mode line which is being treated
9058 as [mode-line (mouse-...)], then we backtrack to this point
9060 int last_real_key_start
;
9062 /* These variables are analogous to echo_start and keys_start;
9063 while those allow us to restart the entire key sequence,
9064 echo_local_start and keys_local_start allow us to throw away
9066 ptrdiff_t echo_local_start
IF_LINT (= 0);
9067 int keys_local_start
;
9068 Lisp_Object new_binding
;
9070 eassert (indec
.end
== t
|| (indec
.end
> t
&& indec
.end
<= mock_input
));
9071 eassert (indec
.start
<= indec
.end
);
9072 eassert (fkey
.start
<= fkey
.end
);
9073 eassert (keytran
.start
<= keytran
.end
);
9074 /* key-translation-map is applied *after* function-key-map
9075 which is itself applied *after* input-decode-map. */
9076 eassert (fkey
.end
<= indec
.start
);
9077 eassert (keytran
.end
<= fkey
.start
);
9079 if (/* first_unbound < indec.start && first_unbound < fkey.start && */
9080 first_unbound
< keytran
.start
)
9081 { /* The prefix upto first_unbound has no binding and has
9082 no translation left to do either, so we know it's unbound.
9083 If we don't stop now, we risk staying here indefinitely
9084 (if the user keeps entering fkey or keytran prefixes
9085 like C-c ESC ESC ESC ESC ...) */
9087 for (i
= first_unbound
+ 1; i
< t
; i
++)
9088 keybuf
[i
- first_unbound
- 1] = keybuf
[i
];
9089 mock_input
= t
- first_unbound
- 1;
9090 indec
.end
= indec
.start
-= first_unbound
+ 1;
9091 indec
.map
= indec
.parent
;
9092 fkey
.end
= fkey
.start
-= first_unbound
+ 1;
9093 fkey
.map
= fkey
.parent
;
9094 keytran
.end
= keytran
.start
-= first_unbound
+ 1;
9095 keytran
.map
= keytran
.parent
;
9096 goto replay_sequence
;
9100 error ("Key sequence too long");
9103 echo_local_start
= echo_length ();
9104 keys_local_start
= this_command_key_count
;
9107 /* These are no-ops, unless we throw away a keystroke below and
9108 jumped back up to replay_key; in that case, these restore the
9109 variables to their original state, allowing us to replay the
9111 if (INTERACTIVE
&& t
< mock_input
)
9112 echo_truncate (echo_local_start
);
9113 this_command_key_count
= keys_local_start
;
9115 /* By default, assume each event is "real". */
9116 last_real_key_start
= t
;
9118 /* Does mock_input indicate that we are re-reading a key sequence? */
9122 add_command_key (key
);
9123 if (echo_keystrokes_p ()
9124 && current_kboard
->immediate_echo
)
9131 /* If not, we should actually read a character. */
9135 KBOARD
*interrupted_kboard
= current_kboard
;
9136 struct frame
*interrupted_frame
= SELECTED_FRAME ();
9137 /* Calling read_char with COMMANDFLAG = -2 avoids
9138 redisplay in read_char and its subroutines. */
9139 key
= read_char (prevent_redisplay
? -2 : NILP (prompt
),
9140 current_binding
, last_nonmenu_event
,
9141 &used_mouse_menu
, NULL
);
9142 if ((INTEGERP (key
) && XINT (key
) == -2) /* wrong_kboard_jmpbuf */
9143 /* When switching to a new tty (with a new keyboard),
9144 read_char returns the new buffer, rather than -2
9145 (Bug#5095). This is because `terminal-init-xterm'
9146 calls read-char, which eats the wrong_kboard_jmpbuf
9147 return. Any better way to fix this? -- cyd */
9148 || (interrupted_kboard
!= current_kboard
))
9153 for (k
= all_kboards
; k
; k
= k
->next_kboard
)
9154 if (k
== interrupted_kboard
)
9159 /* Don't touch interrupted_kboard when it's been
9161 delayed_switch_frame
= Qnil
;
9162 goto replay_entire_sequence
;
9165 if (!NILP (delayed_switch_frame
))
9168 (interrupted_kboard
,
9169 Fcons (delayed_switch_frame
,
9170 KVAR (interrupted_kboard
, kbd_queue
)));
9171 delayed_switch_frame
= Qnil
;
9176 (interrupted_kboard
,
9177 Fcons (keybuf
[--t
], KVAR (interrupted_kboard
, kbd_queue
)));
9179 /* If the side queue is non-empty, ensure it begins with a
9180 switch-frame, so we'll replay it in the right context. */
9181 if (CONSP (KVAR (interrupted_kboard
, kbd_queue
))
9182 && (key
= XCAR (KVAR (interrupted_kboard
, kbd_queue
)),
9183 !(EVENT_HAS_PARAMETERS (key
)
9184 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)),
9188 XSETFRAME (frame
, interrupted_frame
);
9190 (interrupted_kboard
,
9191 Fcons (make_lispy_switch_frame (frame
),
9192 KVAR (interrupted_kboard
, kbd_queue
)));
9195 goto replay_entire_sequence
;
9199 /* read_char returns t when it shows a menu and the user rejects it.
9203 unbind_to (count
, Qnil
);
9208 /* read_char returns -1 at the end of a macro.
9209 Emacs 18 handles this by returning immediately with a
9210 zero, so that's what we'll do. */
9211 if (INTEGERP (key
) && XINT (key
) == -1)
9214 /* The Microsoft C compiler can't handle the goto that
9220 /* If the current buffer has been changed from under us, the
9221 keymap may have changed, so replay the sequence. */
9224 timer_resume_idle ();
9227 /* Reset the current buffer from the selected window
9228 in case something changed the former and not the latter.
9229 This is to be more consistent with the behavior
9230 of the command_loop_1. */
9231 if (fix_current_buffer
)
9233 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
9235 if (XBUFFER (XWINDOW (selected_window
)->contents
)
9237 Fset_buffer (XWINDOW (selected_window
)->contents
);
9240 goto replay_sequence
;
9243 /* If we have a quit that was typed in another frame, and
9244 quit_throw_to_read_char switched buffers,
9245 replay to get the right keymap. */
9247 && XINT (key
) == quit_char
9248 && current_buffer
!= starting_buffer
)
9251 ASET (raw_keybuf
, raw_keybuf_count
, key
);
9256 goto replay_sequence
;
9261 if (EVENT_HAS_PARAMETERS (key
)
9262 /* Either a `switch-frame' or a `select-window' event. */
9263 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)), Qswitch_frame
))
9265 /* If we're at the beginning of a key sequence, and the caller
9266 says it's okay, go ahead and return this event. If we're
9267 in the midst of a key sequence, delay it until the end. */
9268 if (t
> 0 || !can_return_switch_frame
)
9270 delayed_switch_frame
= key
;
9275 if (NILP (first_event
))
9278 /* Even if first_event does not specify a particular
9279 window/position, it's important to recompute the maps here
9280 since a long time might have passed since we entered
9281 read_key_sequence, and a timer (or process-filter or
9282 special-event-map, ...) might have switched the current buffer
9283 or the selected window from under us in the mean time. */
9284 if (fix_current_buffer
9285 && (XBUFFER (XWINDOW (selected_window
)->contents
)
9287 Fset_buffer (XWINDOW (selected_window
)->contents
);
9288 current_binding
= active_maps (first_event
);
9292 ASET (raw_keybuf
, raw_keybuf_count
, key
);
9296 /* Clicks in non-text areas get prefixed by the symbol
9297 in their CHAR-ADDRESS field. For example, a click on
9298 the mode line is prefixed by the symbol `mode-line'.
9300 Furthermore, key sequences beginning with mouse clicks
9301 are read using the keymaps of the buffer clicked on, not
9302 the current buffer. So we may have to switch the buffer
9305 When we turn one event into two events, we must make sure
9306 that neither of the two looks like the original--so that,
9307 if we replay the events, they won't be expanded again.
9308 If not for this, such reexpansion could happen either here
9309 or when user programs play with this-command-keys. */
9310 if (EVENT_HAS_PARAMETERS (key
))
9312 Lisp_Object kind
= EVENT_HEAD_KIND (EVENT_HEAD (key
));
9313 if (EQ (kind
, Qmouse_click
))
9315 Lisp_Object window
= POSN_WINDOW (EVENT_START (key
));
9316 Lisp_Object posn
= POSN_POSN (EVENT_START (key
));
9319 || (!NILP (fake_prefixed_keys
)
9320 && !NILP (Fmemq (key
, fake_prefixed_keys
))))
9322 /* We're looking a second time at an event for which
9323 we generated a fake prefix key. Set
9324 last_real_key_start appropriately. */
9326 last_real_key_start
= t
- 1;
9329 if (last_real_key_start
== 0)
9331 /* Key sequences beginning with mouse clicks are
9332 read using the keymaps in the buffer clicked on,
9333 not the current buffer. If we're at the
9334 beginning of a key sequence, switch buffers. */
9335 if (WINDOWP (window
)
9336 && BUFFERP (XWINDOW (window
)->contents
)
9337 && XBUFFER (XWINDOW (window
)->contents
) != current_buffer
)
9339 ASET (raw_keybuf
, raw_keybuf_count
, key
);
9344 /* Arrange to go back to the original buffer once we're
9345 done reading the key sequence. Note that we can't
9346 use save_excursion_{save,restore} here, because they
9347 save point as well as the current buffer; we don't
9348 want to save point, because redisplay may change it,
9349 to accommodate a Fset_window_start or something. We
9350 don't want to do this at the top of the function,
9351 because we may get input from a subprocess which
9352 wants to change the selected window and stuff (say,
9354 record_unwind_current_buffer ();
9356 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
9358 set_buffer_internal (XBUFFER (XWINDOW (window
)->contents
));
9359 goto replay_sequence
;
9363 /* Expand mode-line and scroll-bar events into two events:
9364 use posn as a fake prefix key. */
9366 && (NILP (fake_prefixed_keys
)
9367 || NILP (Fmemq (key
, fake_prefixed_keys
))))
9369 if (bufsize
- t
<= 1)
9370 error ("Key sequence too long");
9373 keybuf
[t
+ 1] = key
;
9376 /* Record that a fake prefix key has been generated
9377 for KEY. Don't modify the event; this would
9378 prevent proper action when the event is pushed
9379 back into unread-command-events. */
9380 fake_prefixed_keys
= Fcons (key
, fake_prefixed_keys
);
9384 else if (CONSP (XCDR (key
))
9385 && CONSP (EVENT_START (key
))
9386 && CONSP (XCDR (EVENT_START (key
))))
9390 posn
= POSN_POSN (EVENT_START (key
));
9391 /* Handle menu-bar events:
9392 insert the dummy prefix event `menu-bar'. */
9393 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
9395 if (bufsize
- t
<= 1)
9396 error ("Key sequence too long");
9398 keybuf
[t
+ 1] = key
;
9400 /* Zap the position in key, so we know that we've
9401 expanded it, and don't try to do so again. */
9402 POSN_SET_POSN (EVENT_START (key
), list1 (posn
));
9405 goto replay_sequence
;
9407 else if (CONSP (posn
))
9409 /* We're looking at the second event of a
9410 sequence which we expanded before. Set
9411 last_real_key_start appropriately. */
9412 if (last_real_key_start
== t
&& t
> 0)
9413 last_real_key_start
= t
- 1;
9418 /* We have finally decided that KEY is something we might want
9420 new_binding
= follow_key (current_binding
, key
);
9422 /* If KEY wasn't bound, we'll try some fallbacks. */
9423 if (!NILP (new_binding
))
9424 /* This is needed for the following scenario:
9425 event 0: a down-event that gets dropped by calling replay_key.
9426 event 1: some normal prefix like C-h.
9427 After event 0, first_unbound is 0, after event 1 indec.start,
9428 fkey.start, and keytran.start are all 1, so when we see that
9429 C-h is bound, we need to update first_unbound. */
9430 first_unbound
= max (t
+ 1, first_unbound
);
9435 /* Remember the position to put an upper bound on indec.start. */
9436 first_unbound
= min (t
, first_unbound
);
9438 head
= EVENT_HEAD (key
);
9442 Lisp_Object breakdown
;
9445 breakdown
= parse_modifiers (head
);
9446 modifiers
= XINT (XCAR (XCDR (breakdown
)));
9447 /* Attempt to reduce an unbound mouse event to a simpler
9448 event that is bound:
9449 Drags reduce to clicks.
9450 Double-clicks reduce to clicks.
9451 Triple-clicks reduce to double-clicks, then to clicks.
9452 Down-clicks are eliminated.
9453 Double-downs reduce to downs, then are eliminated.
9454 Triple-downs reduce to double-downs, then to downs,
9455 then are eliminated. */
9456 if (modifiers
& (down_modifier
| drag_modifier
9457 | double_modifier
| triple_modifier
))
9459 while (modifiers
& (down_modifier
| drag_modifier
9460 | double_modifier
| triple_modifier
))
9462 Lisp_Object new_head
, new_click
;
9463 if (modifiers
& triple_modifier
)
9464 modifiers
^= (double_modifier
| triple_modifier
);
9465 else if (modifiers
& double_modifier
)
9466 modifiers
&= ~double_modifier
;
9467 else if (modifiers
& drag_modifier
)
9468 modifiers
&= ~drag_modifier
;
9471 /* Dispose of this `down' event by simply jumping
9472 back to replay_key, to get another event.
9474 Note that if this event came from mock input,
9475 then just jumping back to replay_key will just
9476 hand it to us again. So we have to wipe out any
9479 We could delete keybuf[t] and shift everything
9480 after that to the left by one spot, but we'd also
9481 have to fix up any variable that points into
9482 keybuf, and shifting isn't really necessary
9485 Adding prefixes for non-textual mouse clicks
9486 creates two characters of mock input, and both
9487 must be thrown away. If we're only looking at
9488 the prefix now, we can just jump back to
9489 replay_key. On the other hand, if we've already
9490 processed the prefix, and now the actual click
9491 itself is giving us trouble, then we've lost the
9492 state of the keymaps we want to backtrack to, and
9493 we need to replay the whole sequence to rebuild
9496 Beyond that, only function key expansion could
9497 create more than two keys, but that should never
9498 generate mouse events, so it's okay to zero
9499 mock_input in that case too.
9501 FIXME: The above paragraph seems just plain
9502 wrong, if you consider things like
9503 xterm-mouse-mode. -stef
9505 Isn't this just the most wonderful code ever? */
9507 /* If mock_input > t + 1, the above simplification
9508 will actually end up dropping keys on the floor.
9509 This is probably OK for now, but even
9510 if mock_input <= t + 1, we need to adjust indec,
9512 Typical case [header-line down-mouse-N]:
9513 mock_input = 2, t = 1, fkey.end = 1,
9514 last_real_key_start = 0. */
9515 if (indec
.end
> last_real_key_start
)
9517 indec
.end
= indec
.start
9518 = min (last_real_key_start
, indec
.start
);
9519 indec
.map
= indec
.parent
;
9520 if (fkey
.end
> last_real_key_start
)
9522 fkey
.end
= fkey
.start
9523 = min (last_real_key_start
, fkey
.start
);
9524 fkey
.map
= fkey
.parent
;
9525 if (keytran
.end
> last_real_key_start
)
9527 keytran
.end
= keytran
.start
9528 = min (last_real_key_start
, keytran
.start
);
9529 keytran
.map
= keytran
.parent
;
9533 if (t
== last_real_key_start
)
9540 mock_input
= last_real_key_start
;
9541 goto replay_sequence
;
9546 = apply_modifiers (modifiers
, XCAR (breakdown
));
9547 new_click
= list2 (new_head
, EVENT_START (key
));
9549 /* Look for a binding for this new key. */
9550 new_binding
= follow_key (current_binding
, new_click
);
9552 /* If that click is bound, go for it. */
9553 if (!NILP (new_binding
))
9555 current_binding
= new_binding
;
9559 /* Otherwise, we'll leave key set to the drag event. */
9564 current_binding
= new_binding
;
9567 /* Normally, last_nonmenu_event gets the previous key we read.
9568 But when a mouse popup menu is being used,
9569 we don't update last_nonmenu_event; it continues to hold the mouse
9570 event that preceded the first level of menu. */
9571 if (!used_mouse_menu
)
9572 last_nonmenu_event
= key
;
9574 /* Record what part of this_command_keys is the current key sequence. */
9575 this_single_command_key_start
= this_command_key_count
- t
;
9577 /* Look for this sequence in input-decode-map.
9578 Scan from indec.end until we find a bound suffix. */
9579 while (indec
.end
< t
)
9581 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9585 GCPRO4 (indec
.map
, fkey
.map
, keytran
.map
, delayed_switch_frame
);
9586 done
= keyremap_step (keybuf
, bufsize
, &indec
, max (t
, mock_input
),
9591 mock_input
= diff
+ max (t
, mock_input
);
9592 goto replay_sequence
;
9596 if (!KEYMAPP (current_binding
)
9597 && !test_undefined (current_binding
)
9598 && indec
.start
>= t
)
9599 /* There is a binding and it's not a prefix.
9600 (and it doesn't have any input-decode-map translation pending).
9601 There is thus no function-key in this sequence.
9602 Moving fkey.start is important in this case to allow keytran.start
9603 to go over the sequence before we return (since we keep the
9604 invariant that keytran.end <= fkey.start). */
9607 (fkey
.start
= fkey
.end
= t
, fkey
.map
= fkey
.parent
);
9610 /* If the sequence is unbound, see if we can hang a function key
9611 off the end of it. */
9612 /* Continue scan from fkey.end until we find a bound suffix. */
9613 while (fkey
.end
< indec
.start
)
9615 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9619 GCPRO4 (indec
.map
, fkey
.map
, keytran
.map
, delayed_switch_frame
);
9620 done
= keyremap_step (keybuf
, bufsize
, &fkey
,
9621 max (t
, mock_input
),
9622 /* If there's a binding (i.e.
9623 first_binding >= nmaps) we don't want
9624 to apply this function-key-mapping. */
9626 && (test_undefined (current_binding
)),
9631 mock_input
= diff
+ max (t
, mock_input
);
9632 /* Adjust the input-decode-map counters. */
9634 indec
.start
+= diff
;
9636 goto replay_sequence
;
9640 /* Look for this sequence in key-translation-map.
9641 Scan from keytran.end until we find a bound suffix. */
9642 while (keytran
.end
< fkey
.start
)
9644 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9648 GCPRO4 (indec
.map
, fkey
.map
, keytran
.map
, delayed_switch_frame
);
9649 done
= keyremap_step (keybuf
, bufsize
, &keytran
, max (t
, mock_input
),
9654 mock_input
= diff
+ max (t
, mock_input
);
9655 /* Adjust the function-key-map and input-decode-map counters. */
9657 indec
.start
+= diff
;
9661 goto replay_sequence
;
9665 /* If KEY is not defined in any of the keymaps,
9666 and cannot be part of a function key or translation,
9667 and is an upper case letter
9668 use the corresponding lower-case letter instead. */
9669 if (NILP (current_binding
)
9670 && /* indec.start >= t && fkey.start >= t && */ keytran
.start
>= t
9672 && ((CHARACTERP (make_number (XINT (key
) & ~CHAR_MODIFIER_MASK
))
9673 && uppercasep (XINT (key
) & ~CHAR_MODIFIER_MASK
))
9674 || (XINT (key
) & shift_modifier
)))
9676 Lisp_Object new_key
;
9678 original_uppercase
= key
;
9679 original_uppercase_position
= t
- 1;
9681 if (XINT (key
) & shift_modifier
)
9682 XSETINT (new_key
, XINT (key
) & ~shift_modifier
);
9684 XSETINT (new_key
, (downcase (XINT (key
) & ~CHAR_MODIFIER_MASK
)
9685 | (XINT (key
) & CHAR_MODIFIER_MASK
)));
9687 /* We have to do this unconditionally, regardless of whether
9688 the lower-case char is defined in the keymaps, because they
9689 might get translated through function-key-map. */
9690 keybuf
[t
- 1] = new_key
;
9691 mock_input
= max (t
, mock_input
);
9692 shift_translated
= 1;
9694 goto replay_sequence
;
9697 if (NILP (current_binding
)
9698 && help_char_p (EVENT_HEAD (key
)) && t
> 1)
9700 read_key_sequence_cmd
= Vprefix_help_command
;
9701 /* The Microsoft C compiler can't handle the goto that
9707 /* If KEY is not defined in any of the keymaps,
9708 and cannot be part of a function key or translation,
9709 and is a shifted function key,
9710 use the corresponding unshifted function key instead. */
9711 if (NILP (current_binding
)
9712 && /* indec.start >= t && fkey.start >= t && */ keytran
.start
>= t
)
9714 Lisp_Object breakdown
= parse_modifiers (key
);
9716 = CONSP (breakdown
) ? (XINT (XCAR (XCDR (breakdown
)))) : 0;
9718 if (modifiers
& shift_modifier
9719 /* Treat uppercase keys as shifted. */
9721 && (KEY_TO_CHAR (key
)
9722 < XCHAR_TABLE (BVAR (current_buffer
, downcase_table
))->header
.size
)
9723 && uppercasep (KEY_TO_CHAR (key
))))
9726 = (modifiers
& shift_modifier
9727 ? apply_modifiers (modifiers
& ~shift_modifier
,
9729 : make_number (downcase (KEY_TO_CHAR (key
)) | modifiers
));
9731 original_uppercase
= key
;
9732 original_uppercase_position
= t
- 1;
9734 /* We have to do this unconditionally, regardless of whether
9735 the lower-case char is defined in the keymaps, because they
9736 might get translated through function-key-map. */
9737 keybuf
[t
- 1] = new_key
;
9738 mock_input
= max (t
, mock_input
);
9739 /* Reset fkey (and consequently keytran) to apply
9740 function-key-map on the result, so that S-backspace is
9741 correctly mapped to DEL (via backspace). OTOH,
9742 input-decode-map doesn't need to go through it again. */
9743 fkey
.start
= fkey
.end
= 0;
9744 keytran
.start
= keytran
.end
= 0;
9745 shift_translated
= 1;
9747 goto replay_sequence
;
9752 read_key_sequence_cmd
= current_binding
;
9753 read_key_sequence_remapped
9754 /* Remap command through active keymaps.
9755 Do the remapping here, before the unbind_to so it uses the keymaps
9756 of the appropriate buffer. */
9757 = SYMBOLP (read_key_sequence_cmd
)
9758 ? Fcommand_remapping (read_key_sequence_cmd
, Qnil
, Qnil
)
9761 unread_switch_frame
= delayed_switch_frame
;
9762 unbind_to (count
, Qnil
);
9764 /* Don't downcase the last character if the caller says don't.
9765 Don't downcase it if the result is undefined, either. */
9766 if ((dont_downcase_last
|| NILP (current_binding
))
9768 && t
- 1 == original_uppercase_position
)
9770 keybuf
[t
- 1] = original_uppercase
;
9771 shift_translated
= 0;
9774 if (shift_translated
)
9775 Vthis_command_keys_shift_translated
= Qt
;
9777 /* Occasionally we fabricate events, perhaps by expanding something
9778 according to function-key-map, or by adding a prefix symbol to a
9779 mouse click in the scroll bar or modeline. In this cases, return
9780 the entire generated key sequence, even if we hit an unbound
9781 prefix or a definition before the end. This means that you will
9782 be able to push back the event properly, and also means that
9783 read-key-sequence will always return a logical unit.
9786 for (; t
< mock_input
; t
++)
9788 if (echo_keystrokes_p ())
9789 echo_char (keybuf
[t
]);
9790 add_command_key (keybuf
[t
]);
9798 read_key_sequence_vs (Lisp_Object prompt
, Lisp_Object continue_echo
,
9799 Lisp_Object dont_downcase_last
,
9800 Lisp_Object can_return_switch_frame
,
9801 Lisp_Object cmd_loop
, bool allow_string
)
9803 Lisp_Object keybuf
[30];
9805 struct gcpro gcpro1
;
9806 ptrdiff_t count
= SPECPDL_INDEX ();
9809 CHECK_STRING (prompt
);
9812 specbind (Qinput_method_exit_on_first_char
,
9813 (NILP (cmd_loop
) ? Qt
: Qnil
));
9814 specbind (Qinput_method_use_echo_area
,
9815 (NILP (cmd_loop
) ? Qt
: Qnil
));
9817 memset (keybuf
, 0, sizeof keybuf
);
9819 gcpro1
.nvars
= ARRAYELTS (keybuf
);
9821 if (NILP (continue_echo
))
9823 this_command_key_count
= 0;
9824 this_command_key_count_reset
= 0;
9825 this_single_command_key_start
= 0;
9828 #ifdef HAVE_WINDOW_SYSTEM
9829 if (display_hourglass_p
)
9830 cancel_hourglass ();
9833 i
= read_key_sequence (keybuf
, ARRAYELTS (keybuf
),
9834 prompt
, ! NILP (dont_downcase_last
),
9835 ! NILP (can_return_switch_frame
), 0, 0);
9837 #if 0 /* The following is fine for code reading a key sequence and
9838 then proceeding with a lengthy computation, but it's not good
9839 for code reading keys in a loop, like an input method. */
9840 #ifdef HAVE_WINDOW_SYSTEM
9841 if (display_hourglass_p
)
9852 return unbind_to (count
,
9853 ((allow_string
? make_event_array
: Fvector
)
9857 DEFUN ("read-key-sequence", Fread_key_sequence
, Sread_key_sequence
, 1, 5, 0,
9858 doc
: /* Read a sequence of keystrokes and return as a string or vector.
9859 The sequence is sufficient to specify a non-prefix command in the
9860 current local and global maps.
9862 First arg PROMPT is a prompt string. If nil, do not prompt specially.
9863 Second (optional) arg CONTINUE-ECHO, if non-nil, means this key echos
9864 as a continuation of the previous key.
9866 The third (optional) arg DONT-DOWNCASE-LAST, if non-nil, means do not
9867 convert the last event to lower case. (Normally any upper case event
9868 is converted to lower case if the original event is undefined and the lower
9869 case equivalent is defined.) A non-nil value is appropriate for reading
9870 a key sequence to be defined.
9872 A C-g typed while in this function is treated like any other character,
9873 and `quit-flag' is not set.
9875 If the key sequence starts with a mouse click, then the sequence is read
9876 using the keymaps of the buffer of the window clicked in, not the buffer
9877 of the selected window as normal.
9879 `read-key-sequence' drops unbound button-down events, since you normally
9880 only care about the click or drag events which follow them. If a drag
9881 or multi-click event is unbound, but the corresponding click event would
9882 be bound, `read-key-sequence' turns the event into a click event at the
9883 drag's starting position. This means that you don't have to distinguish
9884 between click and drag, double, or triple events unless you want to.
9886 `read-key-sequence' prefixes mouse events on mode lines, the vertical
9887 lines separating windows, and scroll bars with imaginary keys
9888 `mode-line', `vertical-line', and `vertical-scroll-bar'.
9890 Optional fourth argument CAN-RETURN-SWITCH-FRAME non-nil means that this
9891 function will process a switch-frame event if the user switches frames
9892 before typing anything. If the user switches frames in the middle of a
9893 key sequence, or at the start of the sequence but CAN-RETURN-SWITCH-FRAME
9894 is nil, then the event will be put off until after the current key sequence.
9896 `read-key-sequence' checks `function-key-map' for function key
9897 sequences, where they wouldn't conflict with ordinary bindings. See
9898 `function-key-map' for more details.
9900 The optional fifth argument CMD-LOOP, if non-nil, means
9901 that this key sequence is being read by something that will
9902 read commands one after another. It should be nil if the caller
9903 will read just one key sequence. */)
9904 (Lisp_Object prompt
, Lisp_Object continue_echo
, Lisp_Object dont_downcase_last
, Lisp_Object can_return_switch_frame
, Lisp_Object cmd_loop
)
9906 return read_key_sequence_vs (prompt
, continue_echo
, dont_downcase_last
,
9907 can_return_switch_frame
, cmd_loop
, true);
9910 DEFUN ("read-key-sequence-vector", Fread_key_sequence_vector
,
9911 Sread_key_sequence_vector
, 1, 5, 0,
9912 doc
: /* Like `read-key-sequence' but always return a vector. */)
9913 (Lisp_Object prompt
, Lisp_Object continue_echo
, Lisp_Object dont_downcase_last
, Lisp_Object can_return_switch_frame
, Lisp_Object cmd_loop
)
9915 return read_key_sequence_vs (prompt
, continue_echo
, dont_downcase_last
,
9916 can_return_switch_frame
, cmd_loop
, false);
9919 /* Return true if input events are pending. */
9922 detect_input_pending (void)
9924 return input_pending
|| get_input_pending (0);
9927 /* Return true if input events other than mouse movements are
9931 detect_input_pending_ignore_squeezables (void)
9933 return input_pending
|| get_input_pending (READABLE_EVENTS_IGNORE_SQUEEZABLES
);
9936 /* Return true if input events are pending, and run any pending timers. */
9939 detect_input_pending_run_timers (bool do_display
)
9941 unsigned old_timers_run
= timers_run
;
9944 get_input_pending (READABLE_EVENTS_DO_TIMERS_NOW
);
9946 if (old_timers_run
!= timers_run
&& do_display
)
9947 redisplay_preserve_echo_area (8);
9949 return input_pending
;
9952 /* This is called in some cases before a possible quit.
9953 It cases the next call to detect_input_pending to recompute input_pending.
9954 So calling this function unnecessarily can't do any harm. */
9957 clear_input_pending (void)
9962 /* Return true if there are pending requeued events.
9963 This isn't used yet. The hope is to make wait_reading_process_output
9964 call it, and return if it runs Lisp code that unreads something.
9965 The problem is, kbd_buffer_get_event needs to be fixed to know what
9966 to do in that case. It isn't trivial. */
9969 requeued_events_pending_p (void)
9971 return (!NILP (Vunread_command_events
));
9974 DEFUN ("input-pending-p", Finput_pending_p
, Sinput_pending_p
, 0, 1, 0,
9975 doc
: /* Return t if command input is currently available with no wait.
9976 Actually, the value is nil only if we can be sure that no input is available;
9977 if there is a doubt, the value is t.
9979 If CHECK-TIMERS is non-nil, timers that are ready to run will do so. */)
9980 (Lisp_Object check_timers
)
9982 if (!NILP (Vunread_command_events
)
9983 || !NILP (Vunread_post_input_method_events
)
9984 || !NILP (Vunread_input_method_events
))
9987 /* Process non-user-visible events (Bug#10195). */
9988 process_special_events ();
9990 return (get_input_pending ((NILP (check_timers
)
9991 ? 0 : READABLE_EVENTS_DO_TIMERS_NOW
)
9992 | READABLE_EVENTS_FILTER_EVENTS
)
9996 DEFUN ("recent-keys", Frecent_keys
, Srecent_keys
, 0, 1, 0,
9997 doc
: /* Return vector of last few events, not counting those from keyboard macros.
9998 If INCLUDE-CMDS is non-nil, include the commands that were run,
9999 represented as events of the form (nil . COMMAND). */)
10000 (Lisp_Object include_cmds
)
10002 bool cmds
= !NILP (include_cmds
);
10005 || (cmds
&& total_keys
< NUM_RECENT_KEYS
))
10006 return Fvector (total_keys
,
10007 XVECTOR (recent_keys
)->contents
);
10010 Lisp_Object es
= Qnil
;
10011 int i
= (total_keys
< NUM_RECENT_KEYS
10012 ? 0 : recent_keys_index
);
10013 eassert (recent_keys_index
< NUM_RECENT_KEYS
);
10016 Lisp_Object e
= AREF (recent_keys
, i
);
10017 if (cmds
|| !CONSP (e
) || !NILP (XCAR (e
)))
10018 es
= Fcons (e
, es
);
10019 if (++i
>= NUM_RECENT_KEYS
)
10021 } while (i
!= recent_keys_index
);
10022 es
= Fnreverse (es
);
10023 return Fvconcat (1, &es
);
10027 DEFUN ("this-command-keys", Fthis_command_keys
, Sthis_command_keys
, 0, 0, 0,
10028 doc
: /* Return the key sequence that invoked this command.
10029 However, if the command has called `read-key-sequence', it returns
10030 the last key sequence that has been read.
10031 The value is a string or a vector.
10033 See also `this-command-keys-vector'. */)
10036 return make_event_array (this_command_key_count
,
10037 XVECTOR (this_command_keys
)->contents
);
10040 DEFUN ("this-command-keys-vector", Fthis_command_keys_vector
, Sthis_command_keys_vector
, 0, 0, 0,
10041 doc
: /* Return the key sequence that invoked this command, as a vector.
10042 However, if the command has called `read-key-sequence', it returns
10043 the last key sequence that has been read.
10045 See also `this-command-keys'. */)
10048 return Fvector (this_command_key_count
,
10049 XVECTOR (this_command_keys
)->contents
);
10052 DEFUN ("this-single-command-keys", Fthis_single_command_keys
,
10053 Sthis_single_command_keys
, 0, 0, 0,
10054 doc
: /* Return the key sequence that invoked this command.
10055 More generally, it returns the last key sequence read, either by
10056 the command loop or by `read-key-sequence'.
10057 Unlike `this-command-keys', this function's value
10058 does not include prefix arguments.
10059 The value is always a vector. */)
10062 return Fvector (this_command_key_count
10063 - this_single_command_key_start
,
10064 (XVECTOR (this_command_keys
)->contents
10065 + this_single_command_key_start
));
10068 DEFUN ("this-single-command-raw-keys", Fthis_single_command_raw_keys
,
10069 Sthis_single_command_raw_keys
, 0, 0, 0,
10070 doc
: /* Return the raw events that were read for this command.
10071 More generally, it returns the last key sequence read, either by
10072 the command loop or by `read-key-sequence'.
10073 Unlike `this-single-command-keys', this function's value
10074 shows the events before all translations (except for input methods).
10075 The value is always a vector. */)
10078 return Fvector (raw_keybuf_count
, XVECTOR (raw_keybuf
)->contents
);
10081 DEFUN ("reset-this-command-lengths", Freset_this_command_lengths
,
10082 Sreset_this_command_lengths
, 0, 0, 0,
10083 doc
: /* Make the unread events replace the last command and echo.
10084 Used in `universal-argument-other-key'.
10086 `universal-argument-other-key' rereads the event just typed.
10087 It then gets translated through `function-key-map'.
10088 The translated event has to replace the real events,
10089 both in the value of (this-command-keys) and in echoing.
10090 To achieve this, `universal-argument-other-key' calls
10091 `reset-this-command-lengths', which discards the record of reading
10092 these events the first time. */)
10095 this_command_key_count
= before_command_key_count
;
10096 if (this_command_key_count
< this_single_command_key_start
)
10097 this_single_command_key_start
= this_command_key_count
;
10099 echo_truncate (before_command_echo_length
);
10101 /* Cause whatever we put into unread-command-events
10102 to echo as if it were being freshly read from the keyboard. */
10103 this_command_key_count_reset
= 1;
10108 DEFUN ("clear-this-command-keys", Fclear_this_command_keys
,
10109 Sclear_this_command_keys
, 0, 1, 0,
10110 doc
: /* Clear out the vector that `this-command-keys' returns.
10111 Also clear the record of the last 100 events, unless optional arg
10112 KEEP-RECORD is non-nil. */)
10113 (Lisp_Object keep_record
)
10117 this_command_key_count
= 0;
10118 this_command_key_count_reset
= 0;
10120 if (NILP (keep_record
))
10122 for (i
= 0; i
< ASIZE (recent_keys
); ++i
)
10123 ASET (recent_keys
, i
, Qnil
);
10125 recent_keys_index
= 0;
10130 DEFUN ("recursion-depth", Frecursion_depth
, Srecursion_depth
, 0, 0, 0,
10131 doc
: /* Return the current depth in recursive edits. */)
10135 /* Wrap around reliably on integer overflow. */
10136 EMACS_INT sum
= (command_loop_level
& INTMASK
) + (minibuf_level
& INTMASK
);
10137 XSETINT (temp
, sum
);
10141 DEFUN ("open-dribble-file", Fopen_dribble_file
, Sopen_dribble_file
, 1, 1,
10142 "FOpen dribble file: ",
10143 doc
: /* Start writing all keyboard characters to a dribble file called FILE.
10144 If FILE is nil, close any open dribble file.
10145 The file will be closed when Emacs exits.
10147 Be aware that this records ALL characters you type!
10148 This may include sensitive information such as passwords. */)
10161 Lisp_Object encfile
;
10163 file
= Fexpand_file_name (file
, Qnil
);
10164 encfile
= ENCODE_FILE (file
);
10165 fd
= emacs_open (SSDATA (encfile
), O_WRONLY
| O_CREAT
| O_EXCL
, 0600);
10166 if (fd
< 0 && errno
== EEXIST
&& unlink (SSDATA (encfile
)) == 0)
10167 fd
= emacs_open (SSDATA (encfile
), O_WRONLY
| O_CREAT
| O_EXCL
, 0600);
10168 dribble
= fd
< 0 ? 0 : fdopen (fd
, "w");
10170 report_file_error ("Opening dribble", file
);
10175 DEFUN ("discard-input", Fdiscard_input
, Sdiscard_input
, 0, 0, 0,
10176 doc
: /* Discard the contents of the terminal input buffer.
10177 Also end any kbd macro being defined. */)
10180 if (!NILP (KVAR (current_kboard
, defining_kbd_macro
)))
10182 /* Discard the last command from the macro. */
10183 Fcancel_kbd_macro_events ();
10187 Vunread_command_events
= Qnil
;
10189 discard_tty_input ();
10191 kbd_fetch_ptr
= kbd_store_ptr
;
10197 DEFUN ("suspend-emacs", Fsuspend_emacs
, Ssuspend_emacs
, 0, 1, "",
10198 doc
: /* Stop Emacs and return to superior process. You can resume later.
10199 If `cannot-suspend' is non-nil, or if the system doesn't support job
10200 control, run a subshell instead.
10202 If optional arg STUFFSTRING is non-nil, its characters are stuffed
10203 to be read as terminal input by Emacs's parent, after suspension.
10205 Before suspending, run the normal hook `suspend-hook'.
10206 After resumption run the normal hook `suspend-resume-hook'.
10208 Some operating systems cannot stop the Emacs process and resume it later.
10209 On such systems, Emacs starts a subshell instead of suspending. */)
10210 (Lisp_Object stuffstring
)
10212 ptrdiff_t count
= SPECPDL_INDEX ();
10213 int old_height
, old_width
;
10215 struct gcpro gcpro1
;
10217 if (tty_list
&& tty_list
->next
)
10218 error ("There are other tty frames open; close them before suspending Emacs");
10220 if (!NILP (stuffstring
))
10221 CHECK_STRING (stuffstring
);
10223 run_hook (intern ("suspend-hook"));
10225 GCPRO1 (stuffstring
);
10226 get_tty_size (fileno (CURTTY ()->input
), &old_width
, &old_height
);
10227 reset_all_sys_modes ();
10228 /* sys_suspend can get an error if it tries to fork a subshell
10229 and the system resources aren't available for that. */
10230 record_unwind_protect_void (init_all_sys_modes
);
10231 stuff_buffered_input (stuffstring
);
10232 if (cannot_suspend
)
10236 unbind_to (count
, Qnil
);
10238 /* Check if terminal/window size has changed.
10239 Note that this is not useful when we are running directly
10240 with a window system; but suspend should be disabled in that case. */
10241 get_tty_size (fileno (CURTTY ()->input
), &width
, &height
);
10242 if (width
!= old_width
|| height
!= old_height
)
10243 change_frame_size (SELECTED_FRAME (), width
,
10244 height
- FRAME_MENU_BAR_LINES (SELECTED_FRAME ()),
10247 run_hook (intern ("suspend-resume-hook"));
10253 /* If STUFFSTRING is a string, stuff its contents as pending terminal input.
10254 Then in any case stuff anything Emacs has read ahead and not used. */
10257 stuff_buffered_input (Lisp_Object stuffstring
)
10259 #ifdef SIGTSTP /* stuff_char is defined if SIGTSTP. */
10260 register unsigned char *p
;
10262 if (STRINGP (stuffstring
))
10264 register ptrdiff_t count
;
10266 p
= SDATA (stuffstring
);
10267 count
= SBYTES (stuffstring
);
10268 while (count
-- > 0)
10273 /* Anything we have read ahead, put back for the shell to read. */
10274 /* ?? What should this do when we have multiple keyboards??
10275 Should we ignore anything that was typed in at the "wrong" kboard?
10277 rms: we should stuff everything back into the kboard
10279 for (; kbd_fetch_ptr
!= kbd_store_ptr
; kbd_fetch_ptr
++)
10282 if (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
10283 kbd_fetch_ptr
= kbd_buffer
;
10284 if (kbd_fetch_ptr
->kind
== ASCII_KEYSTROKE_EVENT
)
10285 stuff_char (kbd_fetch_ptr
->code
);
10287 clear_event (kbd_fetch_ptr
);
10291 #endif /* SIGTSTP */
10295 set_waiting_for_input (struct timespec
*time_to_clear
)
10297 input_available_clear_time
= time_to_clear
;
10299 /* Tell handle_interrupt to throw back to read_char, */
10300 waiting_for_input
= 1;
10302 /* If handle_interrupt was called before and buffered a C-g,
10303 make it run again now, to avoid timing error. */
10304 if (!NILP (Vquit_flag
))
10305 quit_throw_to_read_char (0);
10309 clear_waiting_for_input (void)
10311 /* Tell handle_interrupt not to throw back to read_char, */
10312 waiting_for_input
= 0;
10313 input_available_clear_time
= 0;
10316 /* The SIGINT handler.
10318 If we have a frame on the controlling tty, we assume that the
10319 SIGINT was generated by C-g, so we call handle_interrupt.
10320 Otherwise, tell QUIT to kill Emacs. */
10323 handle_interrupt_signal (int sig
)
10325 /* See if we have an active terminal on our controlling tty. */
10326 struct terminal
*terminal
= get_named_terminal ("/dev/tty");
10329 /* If there are no frames there, let's pretend that we are a
10330 well-behaving UN*X program and quit. We must not call Lisp
10331 in a signal handler, so tell QUIT to exit when it is
10333 Vquit_flag
= Qkill_emacs
;
10337 /* Otherwise, the SIGINT was probably generated by C-g. */
10339 /* Set internal_last_event_frame to the top frame of the
10340 controlling tty, if we have a frame there. We disable the
10341 interrupt key on secondary ttys, so the SIGINT must have come
10342 from the controlling tty. */
10343 internal_last_event_frame
= terminal
->display_info
.tty
->top_frame
;
10345 handle_interrupt (1);
10350 deliver_interrupt_signal (int sig
)
10352 deliver_process_signal (sig
, handle_interrupt_signal
);
10356 /* If Emacs is stuck because `inhibit-quit' is true, then keep track
10357 of the number of times C-g has been requested. If C-g is pressed
10358 enough times, then quit anyway. See bug#6585. */
10359 static int volatile force_quit_count
;
10361 /* This routine is called at interrupt level in response to C-g.
10363 It is called from the SIGINT handler or kbd_buffer_store_event.
10365 If `waiting_for_input' is non zero, then unless `echoing' is
10366 nonzero, immediately throw back to read_char.
10368 Otherwise it sets the Lisp variable quit-flag not-nil. This causes
10369 eval to throw, when it gets a chance. If quit-flag is already
10370 non-nil, it stops the job right away. */
10373 handle_interrupt (bool in_signal_handler
)
10379 /* XXX This code needs to be revised for multi-tty support. */
10380 if (!NILP (Vquit_flag
) && get_named_terminal ("/dev/tty"))
10382 if (! in_signal_handler
)
10384 /* If SIGINT isn't blocked, don't let us be interrupted by
10385 a SIGINT. It might be harmful due to non-reentrancy
10386 in I/O functions. */
10388 sigemptyset (&blocked
);
10389 sigaddset (&blocked
, SIGINT
);
10390 pthread_sigmask (SIG_BLOCK
, &blocked
, 0);
10394 reset_all_sys_modes ();
10398 * On systems which can suspend the current process and return to the original
10399 * shell, this command causes the user to end up back at the shell.
10400 * The "Auto-save" and "Abort" questions are not asked until
10401 * the user elects to return to emacs, at which point he can save the current
10402 * job and either dump core or continue.
10406 /* Perhaps should really fork an inferior shell?
10407 But that would not provide any way to get back
10408 to the original shell, ever. */
10409 printf ("No support for stopping a process on this operating system;\n");
10410 printf ("you can continue or abort.\n");
10411 #endif /* not SIGTSTP */
10413 /* We must remain inside the screen area when the internal terminal
10414 is used. Note that [Enter] is not echoed by dos. */
10415 cursor_to (SELECTED_FRAME (), 0, 0);
10417 /* It doesn't work to autosave while GC is in progress;
10418 the code used for auto-saving doesn't cope with the mark bit. */
10419 if (!gc_in_progress
)
10421 printf ("Auto-save? (y or n) ");
10423 if (((c
= getchar ()) & ~040) == 'Y')
10425 Fdo_auto_save (Qt
, Qnil
);
10427 printf ("\r\nAuto-save done");
10428 #else /* not MSDOS */
10429 printf ("Auto-save done\n");
10430 #endif /* not MSDOS */
10432 while (c
!= '\n') c
= getchar ();
10436 /* During GC, it must be safe to reenable quitting again. */
10437 Vinhibit_quit
= Qnil
;
10440 #endif /* not MSDOS */
10441 printf ("Garbage collection in progress; cannot auto-save now\r\n");
10442 printf ("but will instead do a real quit after garbage collection ends\r\n");
10447 printf ("\r\nAbort? (y or n) ");
10448 #else /* not MSDOS */
10449 printf ("Abort (and dump core)? (y or n) ");
10450 #endif /* not MSDOS */
10452 if (((c
= getchar ()) & ~040) == 'Y')
10454 while (c
!= '\n') c
= getchar ();
10456 printf ("\r\nContinuing...\r\n");
10457 #else /* not MSDOS */
10458 printf ("Continuing...\n");
10459 #endif /* not MSDOS */
10461 init_all_sys_modes ();
10465 /* If executing a function that wants to be interrupted out of
10466 and the user has not deferred quitting by binding `inhibit-quit'
10467 then quit right away. */
10468 if (immediate_quit
&& NILP (Vinhibit_quit
))
10470 struct gl_state_s saved
;
10471 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
10473 immediate_quit
= 0;
10474 pthread_sigmask (SIG_SETMASK
, &empty_mask
, 0);
10476 GCPRO4 (saved
.object
, saved
.global_code
,
10477 saved
.current_syntax_table
, saved
.old_prop
);
10478 Fsignal (Qquit
, Qnil
);
10483 { /* Else request quit when it's safe. */
10484 int count
= NILP (Vquit_flag
) ? 1 : force_quit_count
+ 1;
10485 force_quit_count
= count
;
10488 immediate_quit
= 1;
10489 Vinhibit_quit
= Qnil
;
10495 pthread_sigmask (SIG_SETMASK
, &empty_mask
, 0);
10497 /* TODO: The longjmp in this call throws the NS event loop integration off,
10498 and it seems to do fine without this. Probably some attention
10499 needs to be paid to the setting of waiting_for_input in
10500 wait_reading_process_output() under HAVE_NS because of the call
10501 to ns_select there (needed because otherwise events aren't picked up
10502 outside of polling since we don't get SIGIO like X and we don't have a
10503 separate event loop thread like W32. */
10505 if (waiting_for_input
&& !echoing
)
10506 quit_throw_to_read_char (in_signal_handler
);
10510 /* Handle a C-g by making read_char return C-g. */
10513 quit_throw_to_read_char (bool from_signal
)
10515 /* When not called from a signal handler it is safe to call
10517 if (!from_signal
&& EQ (Vquit_flag
, Qkill_emacs
))
10518 Fkill_emacs (Qnil
);
10520 /* Prevent another signal from doing this before we finish. */
10521 clear_waiting_for_input ();
10524 Vunread_command_events
= Qnil
;
10526 if (FRAMEP (internal_last_event_frame
)
10527 && !EQ (internal_last_event_frame
, selected_frame
))
10528 do_switch_frame (make_lispy_switch_frame (internal_last_event_frame
),
10531 sys_longjmp (getcjmp
, 1);
10534 DEFUN ("set-input-interrupt-mode", Fset_input_interrupt_mode
,
10535 Sset_input_interrupt_mode
, 1, 1, 0,
10536 doc
: /* Set interrupt mode of reading keyboard input.
10537 If INTERRUPT is non-nil, Emacs will use input interrupts;
10538 otherwise Emacs uses CBREAK mode.
10540 See also `current-input-mode'. */)
10541 (Lisp_Object interrupt
)
10543 bool new_interrupt_input
;
10544 #ifdef USABLE_SIGIO
10545 #ifdef HAVE_X_WINDOWS
10546 if (x_display_list
!= NULL
)
10548 /* When using X, don't give the user a real choice,
10549 because we haven't implemented the mechanisms to support it. */
10550 new_interrupt_input
= 1;
10553 #endif /* HAVE_X_WINDOWS */
10554 new_interrupt_input
= !NILP (interrupt
);
10555 #else /* not USABLE_SIGIO */
10556 new_interrupt_input
= 0;
10557 #endif /* not USABLE_SIGIO */
10559 if (new_interrupt_input
!= interrupt_input
)
10561 #ifdef POLL_FOR_INPUT
10565 /* this causes startup screen to be restored and messes with the mouse */
10566 reset_all_sys_modes ();
10567 interrupt_input
= new_interrupt_input
;
10568 init_all_sys_modes ();
10570 interrupt_input
= new_interrupt_input
;
10573 #ifdef POLL_FOR_INPUT
10574 poll_suppress_count
= 1;
10581 DEFUN ("set-output-flow-control", Fset_output_flow_control
, Sset_output_flow_control
, 1, 2, 0,
10582 doc
: /* Enable or disable ^S/^Q flow control for output to TERMINAL.
10583 If FLOW is non-nil, flow control is enabled and you cannot use C-s or
10584 C-q in key sequences.
10586 This setting only has an effect on tty terminals and only when
10587 Emacs reads input in CBREAK mode; see `set-input-interrupt-mode'.
10589 See also `current-input-mode'. */)
10590 (Lisp_Object flow
, Lisp_Object terminal
)
10592 struct terminal
*t
= decode_tty_terminal (terminal
);
10593 struct tty_display_info
*tty
;
10597 tty
= t
->display_info
.tty
;
10599 if (tty
->flow_control
!= !NILP (flow
))
10602 /* This causes startup screen to be restored and messes with the mouse. */
10603 reset_sys_modes (tty
);
10606 tty
->flow_control
= !NILP (flow
);
10609 init_sys_modes (tty
);
10615 DEFUN ("set-input-meta-mode", Fset_input_meta_mode
, Sset_input_meta_mode
, 1, 2, 0,
10616 doc
: /* Enable or disable 8-bit input on TERMINAL.
10617 If META is t, Emacs will accept 8-bit input, and interpret the 8th
10618 bit as the Meta modifier.
10620 If META is nil, Emacs will ignore the top bit, on the assumption it is
10623 Otherwise, Emacs will accept and pass through 8-bit input without
10624 specially interpreting the top bit.
10626 This setting only has an effect on tty terminal devices.
10628 Optional parameter TERMINAL specifies the tty terminal device to use.
10629 It may be a terminal object, a frame, or nil for the terminal used by
10630 the currently selected frame.
10632 See also `current-input-mode'. */)
10633 (Lisp_Object meta
, Lisp_Object terminal
)
10635 struct terminal
*t
= decode_tty_terminal (terminal
);
10636 struct tty_display_info
*tty
;
10641 tty
= t
->display_info
.tty
;
10645 else if (EQ (meta
, Qt
))
10650 if (tty
->meta_key
!= new_meta
)
10653 /* this causes startup screen to be restored and messes with the mouse */
10654 reset_sys_modes (tty
);
10657 tty
->meta_key
= new_meta
;
10660 init_sys_modes (tty
);
10666 DEFUN ("set-quit-char", Fset_quit_char
, Sset_quit_char
, 1, 1, 0,
10667 doc
: /* Specify character used for quitting.
10668 QUIT must be an ASCII character.
10670 This function only has an effect on the controlling tty of the Emacs
10673 See also `current-input-mode'. */)
10676 struct terminal
*t
= get_named_terminal ("/dev/tty");
10677 struct tty_display_info
*tty
;
10681 tty
= t
->display_info
.tty
;
10683 if (NILP (quit
) || !INTEGERP (quit
) || XINT (quit
) < 0 || XINT (quit
) > 0400)
10684 error ("QUIT must be an ASCII character");
10687 /* this causes startup screen to be restored and messes with the mouse */
10688 reset_sys_modes (tty
);
10691 /* Don't let this value be out of range. */
10692 quit_char
= XINT (quit
) & (tty
->meta_key
== 0 ? 0177 : 0377);
10695 init_sys_modes (tty
);
10701 DEFUN ("set-input-mode", Fset_input_mode
, Sset_input_mode
, 3, 4, 0,
10702 doc
: /* Set mode of reading keyboard input.
10703 First arg INTERRUPT non-nil means use input interrupts;
10704 nil means use CBREAK mode.
10705 Second arg FLOW non-nil means use ^S/^Q flow control for output to terminal
10706 (no effect except in CBREAK mode).
10707 Third arg META t means accept 8-bit input (for a Meta key).
10708 META nil means ignore the top bit, on the assumption it is parity.
10709 Otherwise, accept 8-bit input and don't use the top bit for Meta.
10710 Optional fourth arg QUIT if non-nil specifies character to use for quitting.
10711 See also `current-input-mode'. */)
10712 (Lisp_Object interrupt
, Lisp_Object flow
, Lisp_Object meta
, Lisp_Object quit
)
10714 Fset_input_interrupt_mode (interrupt
);
10715 Fset_output_flow_control (flow
, Qnil
);
10716 Fset_input_meta_mode (meta
, Qnil
);
10718 Fset_quit_char (quit
);
10722 DEFUN ("current-input-mode", Fcurrent_input_mode
, Scurrent_input_mode
, 0, 0, 0,
10723 doc
: /* Return information about the way Emacs currently reads keyboard input.
10724 The value is a list of the form (INTERRUPT FLOW META QUIT), where
10725 INTERRUPT is non-nil if Emacs is using interrupt-driven input; if
10726 nil, Emacs is using CBREAK mode.
10727 FLOW is non-nil if Emacs uses ^S/^Q flow control for output to the
10728 terminal; this does not apply if Emacs uses interrupt-driven input.
10729 META is t if accepting 8-bit input with 8th bit as Meta flag.
10730 META nil means ignoring the top bit, on the assumption it is parity.
10731 META is neither t nor nil if accepting 8-bit input and using
10732 all 8 bits as the character code.
10733 QUIT is the character Emacs currently uses to quit.
10734 The elements of this list correspond to the arguments of
10735 `set-input-mode'. */)
10738 Lisp_Object val
[4];
10739 struct frame
*sf
= XFRAME (selected_frame
);
10741 val
[0] = interrupt_input
? Qt
: Qnil
;
10742 if (FRAME_TERMCAP_P (sf
) || FRAME_MSDOS_P (sf
))
10744 val
[1] = FRAME_TTY (sf
)->flow_control
? Qt
: Qnil
;
10745 val
[2] = (FRAME_TTY (sf
)->meta_key
== 2
10747 : (CURTTY ()->meta_key
== 1 ? Qt
: Qnil
));
10754 XSETFASTINT (val
[3], quit_char
);
10756 return Flist (ARRAYELTS (val
), val
);
10759 DEFUN ("posn-at-x-y", Fposn_at_x_y
, Sposn_at_x_y
, 2, 4, 0,
10760 doc
: /* Return position information for pixel coordinates X and Y.
10761 By default, X and Y are relative to text area of the selected window.
10762 Optional third arg FRAME-OR-WINDOW non-nil specifies frame or window.
10763 If optional fourth arg WHOLE is non-nil, X is relative to the left
10764 edge of the window.
10766 The return value is similar to a mouse click position:
10767 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
10768 IMAGE (DX . DY) (WIDTH . HEIGHT))
10769 The `posn-' functions access elements of such lists. */)
10770 (Lisp_Object x
, Lisp_Object y
, Lisp_Object frame_or_window
, Lisp_Object whole
)
10775 if (NILP (frame_or_window
))
10776 frame_or_window
= selected_window
;
10778 if (WINDOWP (frame_or_window
))
10780 struct window
*w
= decode_live_window (frame_or_window
);
10782 XSETINT (x
, (XINT (x
)
10783 + WINDOW_LEFT_EDGE_X (w
)
10785 ? window_box_left_offset (w
, TEXT_AREA
)
10787 XSETINT (y
, WINDOW_TO_FRAME_PIXEL_Y (w
, XINT (y
)));
10788 frame_or_window
= w
->frame
;
10791 CHECK_LIVE_FRAME (frame_or_window
);
10793 return make_lispy_position (XFRAME (frame_or_window
), x
, y
, 0);
10796 DEFUN ("posn-at-point", Fposn_at_point
, Sposn_at_point
, 0, 2, 0,
10797 doc
: /* Return position information for buffer POS in WINDOW.
10798 POS defaults to point in WINDOW; WINDOW defaults to the selected window.
10800 Return nil if position is not visible in window. Otherwise,
10801 the return value is similar to that returned by `event-start' for
10802 a mouse click at the upper left corner of the glyph corresponding
10803 to the given buffer position:
10804 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
10805 IMAGE (DX . DY) (WIDTH . HEIGHT))
10806 The `posn-' functions access elements of such lists. */)
10807 (Lisp_Object pos
, Lisp_Object window
)
10812 window
= selected_window
;
10814 tem
= Fpos_visible_in_window_p (pos
, window
, Qt
);
10817 Lisp_Object x
= XCAR (tem
);
10818 Lisp_Object y
= XCAR (XCDR (tem
));
10820 /* Point invisible due to hscrolling? */
10823 tem
= Fposn_at_x_y (x
, y
, window
, Qnil
);
10829 /* Set up a new kboard object with reasonable initial values.
10830 TYPE is a window system for which this keyboard is used. */
10833 init_kboard (KBOARD
*kb
, Lisp_Object type
)
10835 kset_overriding_terminal_local_map (kb
, Qnil
);
10836 kset_last_command (kb
, Qnil
);
10837 kset_real_last_command (kb
, Qnil
);
10838 kset_keyboard_translate_table (kb
, Qnil
);
10839 kset_last_repeatable_command (kb
, Qnil
);
10840 kset_prefix_arg (kb
, Qnil
);
10841 kset_last_prefix_arg (kb
, Qnil
);
10842 kset_kbd_queue (kb
, Qnil
);
10843 kb
->kbd_queue_has_data
= 0;
10844 kb
->immediate_echo
= 0;
10845 kset_echo_string (kb
, Qnil
);
10846 kb
->echo_after_prompt
= -1;
10847 kb
->kbd_macro_buffer
= 0;
10848 kb
->kbd_macro_bufsize
= 0;
10849 kset_defining_kbd_macro (kb
, Qnil
);
10850 kset_last_kbd_macro (kb
, Qnil
);
10851 kb
->reference_count
= 0;
10852 kset_system_key_alist (kb
, Qnil
);
10853 kset_system_key_syms (kb
, Qnil
);
10854 kset_window_system (kb
, type
);
10855 kset_input_decode_map (kb
, Fmake_sparse_keymap (Qnil
));
10856 kset_local_function_key_map (kb
, Fmake_sparse_keymap (Qnil
));
10857 Fset_keymap_parent (KVAR (kb
, Vlocal_function_key_map
), Vfunction_key_map
);
10858 kset_default_minibuffer_frame (kb
, Qnil
);
10861 /* Allocate and basically initialize keyboard
10862 object to use with window system TYPE. */
10865 allocate_kboard (Lisp_Object type
)
10867 KBOARD
*kb
= xmalloc (sizeof *kb
);
10869 init_kboard (kb
, type
);
10870 kb
->next_kboard
= all_kboards
;
10876 * Destroy the contents of a kboard object, but not the object itself.
10877 * We use this just before deleting it, or if we're going to initialize
10878 * it a second time.
10881 wipe_kboard (KBOARD
*kb
)
10883 xfree (kb
->kbd_macro_buffer
);
10886 /* Free KB and memory referenced from it. */
10889 delete_kboard (KBOARD
*kb
)
10893 for (kbp
= &all_kboards
; *kbp
!= kb
; kbp
= &(*kbp
)->next_kboard
)
10896 *kbp
= kb
->next_kboard
;
10898 /* Prevent a dangling reference to KB. */
10899 if (kb
== current_kboard
10900 && FRAMEP (selected_frame
)
10901 && FRAME_LIVE_P (XFRAME (selected_frame
)))
10903 current_kboard
= FRAME_KBOARD (XFRAME (selected_frame
));
10905 if (current_kboard
== kb
)
10914 init_keyboard (void)
10916 /* This is correct before outermost invocation of the editor loop. */
10917 command_loop_level
= -1;
10918 immediate_quit
= 0;
10919 quit_char
= Ctl ('g');
10920 Vunread_command_events
= Qnil
;
10921 timer_idleness_start_time
= invalid_timespec ();
10923 recent_keys_index
= 0;
10924 kbd_fetch_ptr
= kbd_buffer
;
10925 kbd_store_ptr
= kbd_buffer
;
10926 do_mouse_tracking
= Qnil
;
10928 interrupt_input_blocked
= 0;
10929 pending_signals
= 0;
10931 /* This means that command_loop_1 won't try to select anything the first
10933 internal_last_event_frame
= Qnil
;
10934 Vlast_event_frame
= internal_last_event_frame
;
10936 current_kboard
= initial_kboard
;
10937 /* Re-initialize the keyboard again. */
10938 wipe_kboard (current_kboard
);
10939 /* A value of nil for Vwindow_system normally means a tty, but we also use
10940 it for the initial terminal since there is no window system there. */
10941 init_kboard (current_kboard
, Qnil
);
10943 if (!noninteractive
)
10945 /* Before multi-tty support, these handlers used to be installed
10946 only if the current session was a tty session. Now an Emacs
10947 session may have multiple display types, so we always handle
10948 SIGINT. There is special code in handle_interrupt_signal to exit
10949 Emacs on SIGINT when there are no termcap frames on the
10950 controlling terminal. */
10951 struct sigaction action
;
10952 emacs_sigaction_init (&action
, deliver_interrupt_signal
);
10953 sigaction (SIGINT
, &action
, 0);
10955 /* For systems with SysV TERMIO, C-g is set up for both SIGINT and
10956 SIGQUIT and we can't tell which one it will give us. */
10957 sigaction (SIGQUIT
, &action
, 0);
10958 #endif /* not DOS_NT */
10960 #ifdef USABLE_SIGIO
10961 if (!noninteractive
)
10963 struct sigaction action
;
10964 emacs_sigaction_init (&action
, deliver_input_available_signal
);
10965 sigaction (SIGIO
, &action
, 0);
10969 /* Use interrupt input by default, if it works and noninterrupt input
10970 has deficiencies. */
10972 #ifdef INTERRUPT_INPUT
10973 interrupt_input
= 1;
10975 interrupt_input
= 0;
10978 pthread_sigmask (SIG_SETMASK
, &empty_mask
, 0);
10981 if (keyboard_init_hook
)
10982 (*keyboard_init_hook
) ();
10984 #ifdef POLL_FOR_INPUT
10986 poll_suppress_count
= 1;
10991 /* This type's only use is in syms_of_keyboard, to put properties on the
10992 event header symbols. */
10993 struct event_head
{
10994 struct Lisp_Symbol
*var
;
10995 struct Lisp_Symbol
*kind
;
11000 static const struct event_head head_table
[] = {
11001 {XSYMBOL_INIT (Qmouse_movement
), XSYMBOL_INIT (Qmouse_movement
)},
11002 {XSYMBOL_INIT (Qscroll_bar_movement
), XSYMBOL_INIT (Qmouse_movement
)},
11004 /* Some of the event heads. */
11005 {XSYMBOL_INIT (Qswitch_frame
), XSYMBOL_INIT (Qswitch_frame
)},
11007 {XSYMBOL_INIT (Qfocus_in
), XSYMBOL_INIT (Qfocus_in
)},
11008 {XSYMBOL_INIT (Qfocus_out
), XSYMBOL_INIT (Qfocus_out
)},
11009 {XSYMBOL_INIT (Qdelete_frame
), XSYMBOL_INIT (Qdelete_frame
)},
11010 {XSYMBOL_INIT (Qiconify_frame
), XSYMBOL_INIT (Qiconify_frame
)},
11011 {XSYMBOL_INIT (Qmake_frame_visible
), XSYMBOL_INIT (Qmake_frame_visible
)},
11012 /* `select-window' should be handled just like `switch-frame'
11013 in read_key_sequence. */
11014 {XSYMBOL_INIT (Qselect_window
), XSYMBOL_INIT (Qswitch_frame
)}
11018 syms_of_keyboard (void)
11020 pending_funcalls
= Qnil
;
11021 staticpro (&pending_funcalls
);
11023 Vlispy_mouse_stem
= build_pure_c_string ("mouse");
11024 staticpro (&Vlispy_mouse_stem
);
11026 regular_top_level_message
= build_pure_c_string ("Back to top level");
11027 #ifdef HAVE_STACK_OVERFLOW_HANDLING
11028 recover_top_level_message
11029 = build_pure_c_string ("Re-entering top level after C stack overflow");
11031 DEFVAR_LISP ("internal--top-level-message", Vinternal__top_level_message
,
11032 doc
: /* Message displayed by `normal-top-level'. */);
11033 Vinternal__top_level_message
= regular_top_level_message
;
11036 DEFSYM (QCimage
, ":image");
11037 DEFSYM (Qhelp_echo
, "help-echo");
11038 DEFSYM (QCrtl
, ":rtl");
11040 staticpro (&item_properties
);
11041 item_properties
= Qnil
;
11043 staticpro (&tool_bar_item_properties
);
11044 tool_bar_item_properties
= Qnil
;
11045 staticpro (&tool_bar_items_vector
);
11046 tool_bar_items_vector
= Qnil
;
11048 DEFSYM (Qtimer_event_handler
, "timer-event-handler");
11049 DEFSYM (Qdisabled_command_function
, "disabled-command-function");
11050 DEFSYM (Qself_insert_command
, "self-insert-command");
11051 DEFSYM (Qforward_char
, "forward-char");
11052 DEFSYM (Qbackward_char
, "backward-char");
11054 /* Non-nil disable property on a command means do not execute it;
11055 call disabled-command-function's value instead. */
11056 DEFSYM (Qdisabled
, "disabled");
11058 DEFSYM (Qundefined
, "undefined");
11060 /* Hooks to run before and after each command. */
11061 DEFSYM (Qpre_command_hook
, "pre-command-hook");
11062 DEFSYM (Qpost_command_hook
, "post-command-hook");
11064 DEFSYM (Qdeferred_action_function
, "deferred-action-function");
11065 DEFSYM (Qdelayed_warnings_hook
, "delayed-warnings-hook");
11066 DEFSYM (Qfunction_key
, "function-key");
11068 /* The values of Qevent_kind properties. */
11069 DEFSYM (Qmouse_click
, "mouse-click");
11071 DEFSYM (Qdrag_n_drop
, "drag-n-drop");
11072 DEFSYM (Qsave_session
, "save-session");
11073 DEFSYM (Qconfig_changed_event
, "config-changed-event");
11075 /* Menu and tool bar item parts. */
11076 DEFSYM (Qmenu_enable
, "menu-enable");
11079 DEFSYM (Qlanguage_change
, "language-change");
11083 DEFSYM (Qdbus_event
, "dbus-event");
11086 #ifdef USE_FILE_NOTIFY
11087 DEFSYM (Qfile_notify
, "file-notify");
11088 #endif /* USE_FILE_NOTIFY */
11090 /* Menu and tool bar item parts. */
11091 DEFSYM (QCenable
, ":enable");
11092 DEFSYM (QCvisible
, ":visible");
11093 DEFSYM (QChelp
, ":help");
11094 DEFSYM (QCfilter
, ":filter");
11095 DEFSYM (QCbutton
, ":button");
11096 DEFSYM (QCkeys
, ":keys");
11097 DEFSYM (QCkey_sequence
, ":key-sequence");
11099 /* Non-nil disable property on a command means
11100 do not execute it; call disabled-command-function's value instead. */
11101 DEFSYM (QCtoggle
, ":toggle");
11102 DEFSYM (QCradio
, ":radio");
11103 DEFSYM (QClabel
, ":label");
11104 DEFSYM (QCvert_only
, ":vert-only");
11106 /* Symbols to use for parts of windows. */
11107 DEFSYM (Qvertical_line
, "vertical-line");
11108 DEFSYM (Qright_divider
, "right-divider");
11109 DEFSYM (Qbottom_divider
, "bottom-divider");
11111 DEFSYM (Qmouse_fixup_help_message
, "mouse-fixup-help-message");
11113 DEFSYM (Qabove_handle
, "above-handle");
11114 DEFSYM (Qhandle
, "handle");
11115 DEFSYM (Qbelow_handle
, "below-handle");
11116 DEFSYM (Qup
, "up");
11117 DEFSYM (Qdown
, "down");
11118 DEFSYM (Qtop
, "top");
11119 DEFSYM (Qbottom
, "bottom");
11120 DEFSYM (Qend_scroll
, "end-scroll");
11121 DEFSYM (Qratio
, "ratio");
11122 DEFSYM (Qbefore_handle
, "before-handle");
11123 DEFSYM (Qhorizontal_handle
, "horizontal-handle");
11124 DEFSYM (Qafter_handle
, "after-handle");
11125 DEFSYM (Qleft
, "left");
11126 DEFSYM (Qright
, "right");
11127 DEFSYM (Qleftmost
, "leftmost");
11128 DEFSYM (Qrightmost
, "rightmost");
11130 /* Properties of event headers. */
11131 DEFSYM (Qevent_kind
, "event-kind");
11132 DEFSYM (Qevent_symbol_elements
, "event-symbol-elements");
11134 /* An event header symbol HEAD may have a property named
11135 Qevent_symbol_element_mask, which is of the form (BASE MODIFIERS);
11136 BASE is the base, unmodified version of HEAD, and MODIFIERS is the
11137 mask of modifiers applied to it. If present, this is used to help
11138 speed up parse_modifiers. */
11139 DEFSYM (Qevent_symbol_element_mask
, "event-symbol-element-mask");
11141 /* An unmodified event header BASE may have a property named
11142 Qmodifier_cache, which is an alist mapping modifier masks onto
11143 modified versions of BASE. If present, this helps speed up
11144 apply_modifiers. */
11145 DEFSYM (Qmodifier_cache
, "modifier-cache");
11147 DEFSYM (Qrecompute_lucid_menubar
, "recompute-lucid-menubar");
11148 DEFSYM (Qactivate_menubar_hook
, "activate-menubar-hook");
11150 DEFSYM (Qpolling_period
, "polling-period");
11152 DEFSYM (Qgui_set_selection
, "gui-set-selection");
11154 /* The primary selection. */
11155 DEFSYM (QPRIMARY
, "PRIMARY");
11157 DEFSYM (Qhandle_switch_frame
, "handle-switch-frame");
11158 DEFSYM (Qhandle_select_window
, "handle-select-window");
11160 DEFSYM (Qinput_method_function
, "input-method-function");
11161 DEFSYM (Qinput_method_exit_on_first_char
, "input-method-exit-on-first-char");
11162 DEFSYM (Qinput_method_use_echo_area
, "input-method-use-echo-area");
11164 DEFSYM (Qhelp_form_show
, "help-form-show");
11166 DEFSYM (Qecho_keystrokes
, "echo-keystrokes");
11168 Fset (Qinput_method_exit_on_first_char
, Qnil
);
11169 Fset (Qinput_method_use_echo_area
, Qnil
);
11171 /* Symbols to head events. */
11172 DEFSYM (Qmouse_movement
, "mouse-movement");
11173 DEFSYM (Qscroll_bar_movement
, "scroll-bar-movement");
11174 DEFSYM (Qswitch_frame
, "switch-frame");
11175 DEFSYM (Qfocus_in
, "focus-in");
11176 DEFSYM (Qfocus_out
, "focus-out");
11177 DEFSYM (Qdelete_frame
, "delete-frame");
11178 DEFSYM (Qiconify_frame
, "iconify-frame");
11179 DEFSYM (Qmake_frame_visible
, "make-frame-visible");
11180 DEFSYM (Qselect_window
, "select-window");
11184 for (i
= 0; i
< ARRAYELTS (head_table
); i
++)
11186 const struct event_head
*p
= &head_table
[i
];
11187 Lisp_Object var
= make_lisp_symbol (p
->var
);
11188 Lisp_Object kind
= make_lisp_symbol (p
->kind
);
11189 Fput (var
, Qevent_kind
, kind
);
11190 Fput (var
, Qevent_symbol_elements
, list1 (var
));
11194 button_down_location
= Fmake_vector (make_number (5), Qnil
);
11195 staticpro (&button_down_location
);
11196 mouse_syms
= Fmake_vector (make_number (5), Qnil
);
11197 staticpro (&mouse_syms
);
11198 wheel_syms
= Fmake_vector (make_number (ARRAYELTS (lispy_wheel_names
)),
11200 staticpro (&wheel_syms
);
11204 int len
= ARRAYELTS (modifier_names
);
11206 modifier_symbols
= Fmake_vector (make_number (len
), Qnil
);
11207 for (i
= 0; i
< len
; i
++)
11208 if (modifier_names
[i
])
11209 ASET (modifier_symbols
, i
, intern_c_string (modifier_names
[i
]));
11210 staticpro (&modifier_symbols
);
11213 recent_keys
= Fmake_vector (make_number (NUM_RECENT_KEYS
), Qnil
);
11214 staticpro (&recent_keys
);
11216 this_command_keys
= Fmake_vector (make_number (40), Qnil
);
11217 staticpro (&this_command_keys
);
11219 raw_keybuf
= Fmake_vector (make_number (30), Qnil
);
11220 staticpro (&raw_keybuf
);
11222 DEFSYM (Qcommand_execute
, "command-execute");
11224 accent_key_syms
= Qnil
;
11225 staticpro (&accent_key_syms
);
11227 func_key_syms
= Qnil
;
11228 staticpro (&func_key_syms
);
11230 drag_n_drop_syms
= Qnil
;
11231 staticpro (&drag_n_drop_syms
);
11233 unread_switch_frame
= Qnil
;
11234 staticpro (&unread_switch_frame
);
11236 internal_last_event_frame
= Qnil
;
11237 staticpro (&internal_last_event_frame
);
11239 read_key_sequence_cmd
= Qnil
;
11240 staticpro (&read_key_sequence_cmd
);
11241 read_key_sequence_remapped
= Qnil
;
11242 staticpro (&read_key_sequence_remapped
);
11244 menu_bar_one_keymap_changed_items
= Qnil
;
11245 staticpro (&menu_bar_one_keymap_changed_items
);
11247 menu_bar_items_vector
= Qnil
;
11248 staticpro (&menu_bar_items_vector
);
11250 help_form_saved_window_configs
= Qnil
;
11251 staticpro (&help_form_saved_window_configs
);
11253 defsubr (&Scurrent_idle_time
);
11254 defsubr (&Sevent_symbol_parse_modifiers
);
11255 defsubr (&Sevent_convert_list
);
11256 defsubr (&Sread_key_sequence
);
11257 defsubr (&Sread_key_sequence_vector
);
11258 defsubr (&Srecursive_edit
);
11259 defsubr (&Strack_mouse
);
11260 defsubr (&Sinput_pending_p
);
11261 defsubr (&Srecent_keys
);
11262 defsubr (&Sthis_command_keys
);
11263 defsubr (&Sthis_command_keys_vector
);
11264 defsubr (&Sthis_single_command_keys
);
11265 defsubr (&Sthis_single_command_raw_keys
);
11266 defsubr (&Sreset_this_command_lengths
);
11267 defsubr (&Sclear_this_command_keys
);
11268 defsubr (&Ssuspend_emacs
);
11269 defsubr (&Sabort_recursive_edit
);
11270 defsubr (&Sexit_recursive_edit
);
11271 defsubr (&Srecursion_depth
);
11272 defsubr (&Scommand_error_default_function
);
11273 defsubr (&Stop_level
);
11274 defsubr (&Sdiscard_input
);
11275 defsubr (&Sopen_dribble_file
);
11276 defsubr (&Sset_input_interrupt_mode
);
11277 defsubr (&Sset_output_flow_control
);
11278 defsubr (&Sset_input_meta_mode
);
11279 defsubr (&Sset_quit_char
);
11280 defsubr (&Sset_input_mode
);
11281 defsubr (&Scurrent_input_mode
);
11282 defsubr (&Sposn_at_point
);
11283 defsubr (&Sposn_at_x_y
);
11285 DEFVAR_LISP ("last-command-event", last_command_event
,
11286 doc
: /* Last input event that was part of a command. */);
11288 DEFVAR_LISP ("last-nonmenu-event", last_nonmenu_event
,
11289 doc
: /* Last input event in a command, except for mouse menu events.
11290 Mouse menus give back keys that don't look like mouse events;
11291 this variable holds the actual mouse event that led to the menu,
11292 so that you can determine whether the command was run by mouse or not. */);
11294 DEFVAR_LISP ("last-input-event", last_input_event
,
11295 doc
: /* Last input event. */);
11297 DEFVAR_LISP ("unread-command-events", Vunread_command_events
,
11298 doc
: /* List of events to be read as the command input.
11299 These events are processed first, before actual keyboard input.
11300 Events read from this list are not normally added to `this-command-keys',
11301 as they will already have been added once as they were read for the first time.
11302 An element of the form (t . EVENT) forces EVENT to be added to that list. */);
11303 Vunread_command_events
= Qnil
;
11305 DEFVAR_LISP ("unread-post-input-method-events", Vunread_post_input_method_events
,
11306 doc
: /* List of events to be processed as input by input methods.
11307 These events are processed before `unread-command-events'
11308 and actual keyboard input, but are not given to `input-method-function'. */);
11309 Vunread_post_input_method_events
= Qnil
;
11311 DEFVAR_LISP ("unread-input-method-events", Vunread_input_method_events
,
11312 doc
: /* List of events to be processed as input by input methods.
11313 These events are processed after `unread-command-events', but
11314 before actual keyboard input.
11315 If there's an active input method, the events are given to
11316 `input-method-function'. */);
11317 Vunread_input_method_events
= Qnil
;
11319 DEFVAR_LISP ("meta-prefix-char", meta_prefix_char
,
11320 doc
: /* Meta-prefix character code.
11321 Meta-foo as command input turns into this character followed by foo. */);
11322 XSETINT (meta_prefix_char
, 033);
11324 DEFVAR_KBOARD ("last-command", Vlast_command
,
11325 doc
: /* The last command executed.
11326 Normally a symbol with a function definition, but can be whatever was found
11327 in the keymap, or whatever the variable `this-command' was set to by that
11330 The value `mode-exit' is special; it means that the previous command
11331 read an event that told it to exit, and it did so and unread that event.
11332 In other words, the present command is the event that made the previous
11335 The value `kill-region' is special; it means that the previous command
11336 was a kill command.
11338 `last-command' has a separate binding for each terminal device.
11339 See Info node `(elisp)Multiple Terminals'. */);
11341 DEFVAR_KBOARD ("real-last-command", Vreal_last_command
,
11342 doc
: /* Same as `last-command', but never altered by Lisp code.
11343 Taken from the previous value of `real-this-command'. */);
11345 DEFVAR_KBOARD ("last-repeatable-command", Vlast_repeatable_command
,
11346 doc
: /* Last command that may be repeated.
11347 The last command executed that was not bound to an input event.
11348 This is the command `repeat' will try to repeat.
11349 Taken from a previous value of `real-this-command'. */);
11351 DEFVAR_LISP ("this-command", Vthis_command
,
11352 doc
: /* The command now being executed.
11353 The command can set this variable; whatever is put here
11354 will be in `last-command' during the following command. */);
11355 Vthis_command
= Qnil
;
11357 DEFVAR_LISP ("real-this-command", Vreal_this_command
,
11358 doc
: /* This is like `this-command', except that commands should never modify it. */);
11359 Vreal_this_command
= Qnil
;
11361 DEFVAR_LISP ("this-command-keys-shift-translated",
11362 Vthis_command_keys_shift_translated
,
11363 doc
: /* Non-nil if the key sequence activating this command was shift-translated.
11364 Shift-translation occurs when there is no binding for the key sequence
11365 as entered, but a binding was found by changing an upper-case letter
11366 to lower-case, or a shifted function key to an unshifted one. */);
11367 Vthis_command_keys_shift_translated
= Qnil
;
11369 DEFVAR_LISP ("this-original-command", Vthis_original_command
,
11370 doc
: /* The command bound to the current key sequence before remapping.
11371 It equals `this-command' if the original command was not remapped through
11372 any of the active keymaps. Otherwise, the value of `this-command' is the
11373 result of looking up the original command in the active keymaps. */);
11374 Vthis_original_command
= Qnil
;
11376 DEFVAR_INT ("auto-save-interval", auto_save_interval
,
11377 doc
: /* Number of input events between auto-saves.
11378 Zero means disable autosaving due to number of characters typed. */);
11379 auto_save_interval
= 300;
11381 DEFVAR_LISP ("auto-save-timeout", Vauto_save_timeout
,
11382 doc
: /* Number of seconds idle time before auto-save.
11383 Zero or nil means disable auto-saving due to idleness.
11384 After auto-saving due to this many seconds of idle time,
11385 Emacs also does a garbage collection if that seems to be warranted. */);
11386 XSETFASTINT (Vauto_save_timeout
, 30);
11388 DEFVAR_LISP ("echo-keystrokes", Vecho_keystrokes
,
11389 doc
: /* Nonzero means echo unfinished commands after this many seconds of pause.
11390 The value may be integer or floating point.
11391 If the value is zero, don't echo at all. */);
11392 Vecho_keystrokes
= make_number (1);
11394 DEFVAR_INT ("polling-period", polling_period
,
11395 doc
: /* Interval between polling for input during Lisp execution.
11396 The reason for polling is to make C-g work to stop a running program.
11397 Polling is needed only when using X windows and SIGIO does not work.
11398 Polling is automatically disabled in all other cases. */);
11399 polling_period
= 2;
11401 DEFVAR_LISP ("double-click-time", Vdouble_click_time
,
11402 doc
: /* Maximum time between mouse clicks to make a double-click.
11403 Measured in milliseconds. The value nil means disable double-click
11404 recognition; t means double-clicks have no time limit and are detected
11405 by position only. */);
11406 Vdouble_click_time
= make_number (500);
11408 DEFVAR_INT ("double-click-fuzz", double_click_fuzz
,
11409 doc
: /* Maximum mouse movement between clicks to make a double-click.
11410 On window-system frames, value is the number of pixels the mouse may have
11411 moved horizontally or vertically between two clicks to make a double-click.
11412 On non window-system frames, value is interpreted in units of 1/8 characters
11415 This variable is also the threshold for motion of the mouse
11416 to count as a drag. */);
11417 double_click_fuzz
= 3;
11419 DEFVAR_INT ("num-input-keys", num_input_keys
,
11420 doc
: /* Number of complete key sequences read as input so far.
11421 This includes key sequences read from keyboard macros.
11422 The number is effectively the number of interactive command invocations. */);
11423 num_input_keys
= 0;
11425 DEFVAR_INT ("num-nonmacro-input-events", num_nonmacro_input_events
,
11426 doc
: /* Number of input events read from the keyboard so far.
11427 This does not include events generated by keyboard macros. */);
11428 num_nonmacro_input_events
= 0;
11430 DEFVAR_LISP ("last-event-frame", Vlast_event_frame
,
11431 doc
: /* The frame in which the most recently read event occurred.
11432 If the last event came from a keyboard macro, this is set to `macro'. */);
11433 Vlast_event_frame
= Qnil
;
11435 /* This variable is set up in sysdep.c. */
11436 DEFVAR_LISP ("tty-erase-char", Vtty_erase_char
,
11437 doc
: /* The ERASE character as set by the user with stty. */);
11439 DEFVAR_LISP ("help-char", Vhelp_char
,
11440 doc
: /* Character to recognize as meaning Help.
11441 When it is read, do `(eval help-form)', and display result if it's a string.
11442 If the value of `help-form' is nil, this char can be read normally. */);
11443 XSETINT (Vhelp_char
, Ctl ('H'));
11445 DEFVAR_LISP ("help-event-list", Vhelp_event_list
,
11446 doc
: /* List of input events to recognize as meaning Help.
11447 These work just like the value of `help-char' (see that). */);
11448 Vhelp_event_list
= Qnil
;
11450 DEFVAR_LISP ("help-form", Vhelp_form
,
11451 doc
: /* Form to execute when character `help-char' is read.
11452 If the form returns a string, that string is displayed.
11453 If `help-form' is nil, the help char is not recognized. */);
11456 DEFVAR_LISP ("prefix-help-command", Vprefix_help_command
,
11457 doc
: /* Command to run when `help-char' character follows a prefix key.
11458 This command is used only when there is no actual binding
11459 for that character after that prefix key. */);
11460 Vprefix_help_command
= Qnil
;
11462 DEFVAR_LISP ("top-level", Vtop_level
,
11463 doc
: /* Form to evaluate when Emacs starts up.
11464 Useful to set before you dump a modified Emacs. */);
11467 DEFVAR_KBOARD ("keyboard-translate-table", Vkeyboard_translate_table
,
11468 doc
: /* Translate table for local keyboard input, or nil.
11469 If non-nil, the value should be a char-table. Each character read
11470 from the keyboard is looked up in this char-table. If the value found
11471 there is non-nil, then it is used instead of the actual input character.
11473 The value can also be a string or vector, but this is considered obsolete.
11474 If it is a string or vector of length N, character codes N and up are left
11475 untranslated. In a vector, an element which is nil means "no translation".
11477 This is applied to the characters supplied to input methods, not their
11478 output. See also `translation-table-for-input'.
11480 This variable has a separate binding for each terminal.
11481 See Info node `(elisp)Multiple Terminals'. */);
11483 DEFVAR_BOOL ("cannot-suspend", cannot_suspend
,
11484 doc
: /* Non-nil means to always spawn a subshell instead of suspending.
11485 \(Even if the operating system has support for stopping a process.\) */);
11486 cannot_suspend
= 0;
11488 DEFVAR_BOOL ("menu-prompting", menu_prompting
,
11489 doc
: /* Non-nil means prompt with menus when appropriate.
11490 This is done when reading from a keymap that has a prompt string,
11491 for elements that have prompt strings.
11492 The menu is displayed on the screen
11493 if X menus were enabled at configuration
11494 time and the previous event was a mouse click prefix key.
11495 Otherwise, menu prompting uses the echo area. */);
11496 menu_prompting
= 1;
11498 DEFVAR_LISP ("menu-prompt-more-char", menu_prompt_more_char
,
11499 doc
: /* Character to see next line of menu prompt.
11500 Type this character while in a menu prompt to rotate around the lines of it. */);
11501 XSETINT (menu_prompt_more_char
, ' ');
11503 DEFVAR_INT ("extra-keyboard-modifiers", extra_keyboard_modifiers
,
11504 doc
: /* A mask of additional modifier keys to use with every keyboard character.
11505 Emacs applies the modifiers of the character stored here to each keyboard
11506 character it reads. For example, after evaluating the expression
11507 (setq extra-keyboard-modifiers ?\\C-x)
11508 all input characters will have the control modifier applied to them.
11510 Note that the character ?\\C-@, equivalent to the integer zero, does
11511 not count as a control character; rather, it counts as a character
11512 with no modifiers; thus, setting `extra-keyboard-modifiers' to zero
11513 cancels any modification. */);
11514 extra_keyboard_modifiers
= 0;
11516 DEFSYM (Qdeactivate_mark
, "deactivate-mark");
11517 DEFVAR_LISP ("deactivate-mark", Vdeactivate_mark
,
11518 doc
: /* If an editing command sets this to t, deactivate the mark afterward.
11519 The command loop sets this to nil before each command,
11520 and tests the value when the command returns.
11521 Buffer modification stores t in this variable. */);
11522 Vdeactivate_mark
= Qnil
;
11523 Fmake_variable_buffer_local (Qdeactivate_mark
);
11525 DEFVAR_LISP ("pre-command-hook", Vpre_command_hook
,
11526 doc
: /* Normal hook run before each command is executed.
11527 If an unhandled error happens in running this hook,
11528 the function in which the error occurred is unconditionally removed, since
11529 otherwise the error might happen repeatedly and make Emacs nonfunctional. */);
11530 Vpre_command_hook
= Qnil
;
11532 DEFVAR_LISP ("post-command-hook", Vpost_command_hook
,
11533 doc
: /* Normal hook run after each command is executed.
11534 If an unhandled error happens in running this hook,
11535 the function in which the error occurred is unconditionally removed, since
11536 otherwise the error might happen repeatedly and make Emacs nonfunctional. */);
11537 Vpost_command_hook
= Qnil
;
11540 DEFVAR_LISP ("echo-area-clear-hook", ...,
11541 doc
: /* Normal hook run when clearing the echo area. */);
11543 DEFSYM (Qecho_area_clear_hook
, "echo-area-clear-hook");
11544 Fset (Qecho_area_clear_hook
, Qnil
);
11546 DEFVAR_LISP ("lucid-menu-bar-dirty-flag", Vlucid_menu_bar_dirty_flag
,
11547 doc
: /* Non-nil means menu bar, specified Lucid style, needs to be recomputed. */);
11548 Vlucid_menu_bar_dirty_flag
= Qnil
;
11550 DEFVAR_LISP ("menu-bar-final-items", Vmenu_bar_final_items
,
11551 doc
: /* List of menu bar items to move to the end of the menu bar.
11552 The elements of the list are event types that may have menu bar bindings. */);
11553 Vmenu_bar_final_items
= Qnil
;
11555 DEFVAR_LISP ("tool-bar-separator-image-expression", Vtool_bar_separator_image_expression
,
11556 doc
: /* Expression evaluating to the image spec for a tool-bar separator.
11557 This is used internally by graphical displays that do not render
11558 tool-bar separators natively. Otherwise it is unused (e.g. on GTK). */);
11559 Vtool_bar_separator_image_expression
= Qnil
;
11561 DEFVAR_KBOARD ("overriding-terminal-local-map",
11562 Voverriding_terminal_local_map
,
11563 doc
: /* Per-terminal keymap that takes precedence over all other keymaps.
11564 This variable is intended to let commands such as `universal-argument'
11565 set up a different keymap for reading the next command.
11567 `overriding-terminal-local-map' has a separate binding for each
11568 terminal device. See Info node `(elisp)Multiple Terminals'. */);
11570 DEFVAR_LISP ("overriding-local-map", Voverriding_local_map
,
11571 doc
: /* Keymap that replaces (overrides) local keymaps.
11572 If this variable is non-nil, Emacs looks up key bindings in this
11573 keymap INSTEAD OF the keymap char property, minor mode maps, and the
11574 buffer's local map. Hence, the only active keymaps would be
11575 `overriding-terminal-local-map', this keymap, and `global-keymap', in
11576 order of precedence. */);
11577 Voverriding_local_map
= Qnil
;
11579 DEFVAR_LISP ("overriding-local-map-menu-flag", Voverriding_local_map_menu_flag
,
11580 doc
: /* Non-nil means `overriding-local-map' applies to the menu bar.
11581 Otherwise, the menu bar continues to reflect the buffer's local map
11582 and the minor mode maps regardless of `overriding-local-map'. */);
11583 Voverriding_local_map_menu_flag
= Qnil
;
11585 DEFVAR_LISP ("special-event-map", Vspecial_event_map
,
11586 doc
: /* Keymap defining bindings for special events to execute at low level. */);
11587 Vspecial_event_map
= list1 (intern_c_string ("keymap"));
11589 DEFVAR_LISP ("track-mouse", do_mouse_tracking
,
11590 doc
: /* Non-nil means generate motion events for mouse motion. */);
11592 DEFVAR_KBOARD ("system-key-alist", Vsystem_key_alist
,
11593 doc
: /* Alist of system-specific X windows key symbols.
11594 Each element should have the form (N . SYMBOL) where N is the
11595 numeric keysym code (sans the \"system-specific\" bit 1<<28)
11596 and SYMBOL is its name.
11598 `system-key-alist' has a separate binding for each terminal device.
11599 See Info node `(elisp)Multiple Terminals'. */);
11601 DEFVAR_KBOARD ("local-function-key-map", Vlocal_function_key_map
,
11602 doc
: /* Keymap that translates key sequences to key sequences during input.
11603 This is used mainly for mapping key sequences into some preferred
11604 key events (symbols).
11606 The `read-key-sequence' function replaces any subsequence bound by
11607 `local-function-key-map' with its binding. More precisely, when the
11608 active keymaps have no binding for the current key sequence but
11609 `local-function-key-map' binds a suffix of the sequence to a vector or
11610 string, `read-key-sequence' replaces the matching suffix with its
11611 binding, and continues with the new sequence.
11613 If the binding is a function, it is called with one argument (the prompt)
11614 and its return value (a key sequence) is used.
11616 The events that come from bindings in `local-function-key-map' are not
11617 themselves looked up in `local-function-key-map'.
11619 For example, suppose `local-function-key-map' binds `ESC O P' to [f1].
11620 Typing `ESC O P' to `read-key-sequence' would return [f1]. Typing
11621 `C-x ESC O P' would return [?\\C-x f1]. If [f1] were a prefix key,
11622 typing `ESC O P x' would return [f1 x].
11624 `local-function-key-map' has a separate binding for each terminal
11625 device. See Info node `(elisp)Multiple Terminals'. If you need to
11626 define a binding on all terminals, change `function-key-map'
11627 instead. Initially, `local-function-key-map' is an empty keymap that
11628 has `function-key-map' as its parent on all terminal devices. */);
11630 DEFVAR_KBOARD ("input-decode-map", Vinput_decode_map
,
11631 doc
: /* Keymap that decodes input escape sequences.
11632 This is used mainly for mapping ASCII function key sequences into
11633 real Emacs function key events (symbols).
11635 The `read-key-sequence' function replaces any subsequence bound by
11636 `input-decode-map' with its binding. Contrary to `function-key-map',
11637 this map applies its rebinding regardless of the presence of an ordinary
11638 binding. So it is more like `key-translation-map' except that it applies
11639 before `function-key-map' rather than after.
11641 If the binding is a function, it is called with one argument (the prompt)
11642 and its return value (a key sequence) is used.
11644 The events that come from bindings in `input-decode-map' are not
11645 themselves looked up in `input-decode-map'. */);
11647 DEFVAR_LISP ("function-key-map", Vfunction_key_map
,
11648 doc
: /* The parent keymap of all `local-function-key-map' instances.
11649 Function key definitions that apply to all terminal devices should go
11650 here. If a mapping is defined in both the current
11651 `local-function-key-map' binding and this variable, then the local
11652 definition will take precedence. */);
11653 Vfunction_key_map
= Fmake_sparse_keymap (Qnil
);
11655 DEFVAR_LISP ("key-translation-map", Vkey_translation_map
,
11656 doc
: /* Keymap of key translations that can override keymaps.
11657 This keymap works like `input-decode-map', but comes after `function-key-map'.
11658 Another difference is that it is global rather than terminal-local. */);
11659 Vkey_translation_map
= Fmake_sparse_keymap (Qnil
);
11661 DEFVAR_LISP ("deferred-action-list", Vdeferred_action_list
,
11662 doc
: /* List of deferred actions to be performed at a later time.
11663 The precise format isn't relevant here; we just check whether it is nil. */);
11664 Vdeferred_action_list
= Qnil
;
11666 DEFVAR_LISP ("deferred-action-function", Vdeferred_action_function
,
11667 doc
: /* Function to call to handle deferred actions, after each command.
11668 This function is called with no arguments after each command
11669 whenever `deferred-action-list' is non-nil. */);
11670 Vdeferred_action_function
= Qnil
;
11672 DEFVAR_LISP ("delayed-warnings-list", Vdelayed_warnings_list
,
11673 doc
: /* List of warnings to be displayed after this command.
11674 Each element must be a list (TYPE MESSAGE [LEVEL [BUFFER-NAME]]),
11675 as per the args of `display-warning' (which see).
11676 If this variable is non-nil, `delayed-warnings-hook' will be run
11677 immediately after running `post-command-hook'. */);
11678 Vdelayed_warnings_list
= Qnil
;
11680 DEFVAR_LISP ("timer-list", Vtimer_list
,
11681 doc
: /* List of active absolute time timers in order of increasing time. */);
11682 Vtimer_list
= Qnil
;
11684 DEFVAR_LISP ("timer-idle-list", Vtimer_idle_list
,
11685 doc
: /* List of active idle-time timers in order of increasing time. */);
11686 Vtimer_idle_list
= Qnil
;
11688 DEFVAR_LISP ("input-method-function", Vinput_method_function
,
11689 doc
: /* If non-nil, the function that implements the current input method.
11690 It's called with one argument, a printing character that was just read.
11691 \(That means a character with code 040...0176.)
11692 Typically this function uses `read-event' to read additional events.
11693 When it does so, it should first bind `input-method-function' to nil
11694 so it will not be called recursively.
11696 The function should return a list of zero or more events
11697 to be used as input. If it wants to put back some events
11698 to be reconsidered, separately, by the input method,
11699 it can add them to the beginning of `unread-command-events'.
11701 The input method function can find in `input-method-previous-message'
11702 the previous echo area message.
11704 The input method function should refer to the variables
11705 `input-method-use-echo-area' and `input-method-exit-on-first-char'
11706 for guidance on what to do. */);
11707 Vinput_method_function
= Qnil
;
11709 DEFVAR_LISP ("input-method-previous-message",
11710 Vinput_method_previous_message
,
11711 doc
: /* When `input-method-function' is called, hold the previous echo area message.
11712 This variable exists because `read-event' clears the echo area
11713 before running the input method. It is nil if there was no message. */);
11714 Vinput_method_previous_message
= Qnil
;
11716 DEFVAR_LISP ("show-help-function", Vshow_help_function
,
11717 doc
: /* If non-nil, the function that implements the display of help.
11718 It's called with one argument, the help string to display. */);
11719 Vshow_help_function
= Qnil
;
11721 DEFVAR_LISP ("disable-point-adjustment", Vdisable_point_adjustment
,
11722 doc
: /* If non-nil, suppress point adjustment after executing a command.
11724 After a command is executed, if point is moved into a region that has
11725 special properties (e.g. composition, display), we adjust point to
11726 the boundary of the region. But, when a command sets this variable to
11727 non-nil, we suppress the point adjustment.
11729 This variable is set to nil before reading a command, and is checked
11730 just after executing the command. */);
11731 Vdisable_point_adjustment
= Qnil
;
11733 DEFVAR_LISP ("global-disable-point-adjustment",
11734 Vglobal_disable_point_adjustment
,
11735 doc
: /* If non-nil, always suppress point adjustment.
11737 The default value is nil, in which case, point adjustment are
11738 suppressed only after special commands that set
11739 `disable-point-adjustment' (which see) to non-nil. */);
11740 Vglobal_disable_point_adjustment
= Qnil
;
11742 DEFVAR_LISP ("minibuffer-message-timeout", Vminibuffer_message_timeout
,
11743 doc
: /* How long to display an echo-area message when the minibuffer is active.
11744 If the value is not a number, such messages don't time out. */);
11745 Vminibuffer_message_timeout
= make_number (2);
11747 DEFVAR_LISP ("throw-on-input", Vthrow_on_input
,
11748 doc
: /* If non-nil, any keyboard input throws to this symbol.
11749 The value of that variable is passed to `quit-flag' and later causes a
11750 peculiar kind of quitting. */);
11751 Vthrow_on_input
= Qnil
;
11753 DEFVAR_LISP ("command-error-function", Vcommand_error_function
,
11754 doc
: /* Function to output error messages.
11755 Called with three arguments:
11756 - the error data, a list of the form (SIGNALED-CONDITION . SIGNAL-DATA)
11757 such as what `condition-case' would bind its variable to,
11758 - the context (a string which normally goes at the start of the message),
11759 - the Lisp function within which the error was signaled. */);
11760 Vcommand_error_function
= intern ("command-error-default-function");
11762 DEFVAR_LISP ("enable-disabled-menus-and-buttons",
11763 Venable_disabled_menus_and_buttons
,
11764 doc
: /* If non-nil, don't ignore events produced by disabled menu items and tool-bar.
11766 Help functions bind this to allow help on disabled menu items
11767 and tool-bar buttons. */);
11768 Venable_disabled_menus_and_buttons
= Qnil
;
11770 DEFVAR_LISP ("select-active-regions",
11771 Vselect_active_regions
,
11772 doc
: /* If non-nil, an active region automatically sets the primary selection.
11773 If the value is `only', only temporarily active regions (usually made
11774 by mouse-dragging or shift-selection) set the window selection.
11776 This takes effect only when Transient Mark mode is enabled. */);
11777 Vselect_active_regions
= Qt
;
11779 DEFVAR_LISP ("saved-region-selection",
11780 Vsaved_region_selection
,
11781 doc
: /* Contents of active region prior to buffer modification.
11782 If `select-active-regions' is non-nil, Emacs sets this to the
11783 text in the region before modifying the buffer. The next call to
11784 the function `deactivate-mark' uses this to set the window selection. */);
11785 Vsaved_region_selection
= Qnil
;
11787 DEFVAR_LISP ("selection-inhibit-update-commands",
11788 Vselection_inhibit_update_commands
,
11789 doc
: /* List of commands which should not update the selection.
11790 Normally, if `select-active-regions' is non-nil and the mark remains
11791 active after a command (i.e. the mark was not deactivated), the Emacs
11792 command loop sets the selection to the text in the region. However,
11793 if the command is in this list, the selection is not updated. */);
11794 Vselection_inhibit_update_commands
11795 = list2 (Qhandle_switch_frame
, Qhandle_select_window
);
11797 DEFVAR_LISP ("debug-on-event",
11799 doc
: /* Enter debugger on this event. When Emacs
11800 receives the special event specified by this variable, it will try to
11801 break into the debugger as soon as possible instead of processing the
11802 event normally through `special-event-map'.
11804 Currently, the only supported values for this
11805 variable are `sigusr1' and `sigusr2'. */);
11806 Vdebug_on_event
= intern_c_string ("sigusr2");
11808 /* Create the initial keyboard. Qt means 'unset'. */
11809 initial_kboard
= allocate_kboard (Qt
);
11813 keys_of_keyboard (void)
11815 initial_define_key (global_map
, Ctl ('Z'), "suspend-emacs");
11816 initial_define_key (control_x_map
, Ctl ('Z'), "suspend-emacs");
11817 initial_define_key (meta_map
, Ctl ('C'), "exit-recursive-edit");
11818 initial_define_key (global_map
, Ctl (']'), "abort-recursive-edit");
11819 initial_define_key (meta_map
, 'x', "execute-extended-command");
11821 initial_define_lispy_key (Vspecial_event_map
, "delete-frame",
11822 "handle-delete-frame");
11823 initial_define_lispy_key (Vspecial_event_map
, "ns-put-working-text",
11824 "ns-put-working-text");
11825 initial_define_lispy_key (Vspecial_event_map
, "ns-unput-working-text",
11826 "ns-unput-working-text");
11827 /* Here we used to use `ignore-event' which would simple set prefix-arg to
11828 current-prefix-arg, as is done in `handle-switch-frame'.
11829 But `handle-switch-frame is not run from the special-map.
11830 Commands from that map are run in a special way that automatically
11831 preserves the prefix-arg. Restoring the prefix arg here is not just
11832 redundant but harmful:
11834 - current-prefix-arg is set to non-nil, prefix-arg is set to nil.
11835 - after the first prompt, the exit-minibuffer-hook is run which may
11836 iconify a frame and thus push a `iconify-frame' event.
11837 - after running exit-minibuffer-hook, current-prefix-arg is
11838 restored to the non-nil value it had before the prompt.
11839 - we enter the second prompt.
11840 current-prefix-arg is non-nil, prefix-arg is nil.
11841 - before running the first real event, we run the special iconify-frame
11842 event, but we pass the `special' arg to command-execute so
11843 current-prefix-arg and prefix-arg are left untouched.
11844 - here we foolishly copy the non-nil current-prefix-arg to prefix-arg.
11845 - the next key event will have a spuriously non-nil current-prefix-arg. */
11846 initial_define_lispy_key (Vspecial_event_map
, "iconify-frame",
11848 initial_define_lispy_key (Vspecial_event_map
, "make-frame-visible",
11850 /* Handling it at such a low-level causes read_key_sequence to get
11851 * confused because it doesn't realize that the current_buffer was
11852 * changed by read_char.
11854 * initial_define_lispy_key (Vspecial_event_map, "select-window",
11855 * "handle-select-window"); */
11856 initial_define_lispy_key (Vspecial_event_map
, "save-session",
11857 "handle-save-session");
11860 /* Define a special event which is raised for dbus callback
11862 initial_define_lispy_key (Vspecial_event_map
, "dbus-event",
11863 "dbus-handle-event");
11866 #ifdef USE_FILE_NOTIFY
11867 /* Define a special event which is raised for notification callback
11869 initial_define_lispy_key (Vspecial_event_map
, "file-notify",
11870 "file-notify-handle-event");
11871 #endif /* USE_FILE_NOTIFY */
11873 initial_define_lispy_key (Vspecial_event_map
, "config-changed-event",
11875 #if defined (WINDOWSNT)
11876 initial_define_lispy_key (Vspecial_event_map
, "language-change",
11879 initial_define_lispy_key (Vspecial_event_map
, "focus-in",
11880 "handle-focus-in");
11881 initial_define_lispy_key (Vspecial_event_map
, "focus-out",
11882 "handle-focus-out");
11885 /* Mark the pointers in the kboard objects.
11886 Called by Fgarbage_collect. */
11888 mark_kboards (void)
11892 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
11894 if (kb
->kbd_macro_buffer
)
11895 for (p
= kb
->kbd_macro_buffer
; p
< kb
->kbd_macro_ptr
; p
++)
11897 mark_object (KVAR (kb
, Voverriding_terminal_local_map
));
11898 mark_object (KVAR (kb
, Vlast_command
));
11899 mark_object (KVAR (kb
, Vreal_last_command
));
11900 mark_object (KVAR (kb
, Vkeyboard_translate_table
));
11901 mark_object (KVAR (kb
, Vlast_repeatable_command
));
11902 mark_object (KVAR (kb
, Vprefix_arg
));
11903 mark_object (KVAR (kb
, Vlast_prefix_arg
));
11904 mark_object (KVAR (kb
, kbd_queue
));
11905 mark_object (KVAR (kb
, defining_kbd_macro
));
11906 mark_object (KVAR (kb
, Vlast_kbd_macro
));
11907 mark_object (KVAR (kb
, Vsystem_key_alist
));
11908 mark_object (KVAR (kb
, system_key_syms
));
11909 mark_object (KVAR (kb
, Vwindow_system
));
11910 mark_object (KVAR (kb
, Vinput_decode_map
));
11911 mark_object (KVAR (kb
, Vlocal_function_key_map
));
11912 mark_object (KVAR (kb
, Vdefault_minibuffer_frame
));
11913 mark_object (KVAR (kb
, echo_string
));
11916 struct input_event
*event
;
11917 for (event
= kbd_fetch_ptr
; event
!= kbd_store_ptr
; event
++)
11919 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
11920 event
= kbd_buffer
;
11921 /* These two special event types has no Lisp_Objects to mark. */
11922 if (event
->kind
!= SELECTION_REQUEST_EVENT
11923 && event
->kind
!= SELECTION_CLEAR_EVENT
)
11925 mark_object (event
->x
);
11926 mark_object (event
->y
);
11927 mark_object (event
->frame_or_window
);
11928 mark_object (event
->arg
);