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. */
1167 attributes
: noreturn
)
1170 #ifdef HAVE_WINDOW_SYSTEM
1171 if (display_hourglass_p
)
1172 cancel_hourglass ();
1175 /* Unblock input if we enter with input blocked. This may happen if
1176 redisplay traps e.g. during tool-bar update with input blocked. */
1177 totally_unblock_input ();
1179 Fthrow (Qtop_level
, Qnil
);
1182 static _Noreturn
void
1183 user_error (const char *msg
)
1185 xsignal1 (Quser_error
, build_string (msg
));
1188 /* _Noreturn will be added to prototype by make-docfile. */
1189 DEFUN ("exit-recursive-edit", Fexit_recursive_edit
, Sexit_recursive_edit
, 0, 0, "",
1190 doc
: /* Exit from the innermost recursive edit or minibuffer. */
1191 attributes
: noreturn
)
1194 if (command_loop_level
> 0 || minibuf_level
> 0)
1195 Fthrow (Qexit
, Qnil
);
1197 user_error ("No recursive edit is in progress");
1200 /* _Noreturn will be added to prototype by make-docfile. */
1201 DEFUN ("abort-recursive-edit", Fabort_recursive_edit
, Sabort_recursive_edit
, 0, 0, "",
1202 doc
: /* Abort the command that requested this recursive edit or minibuffer input. */
1203 attributes
: noreturn
)
1206 if (command_loop_level
> 0 || minibuf_level
> 0)
1209 user_error ("No recursive edit is in progress");
1212 /* Restore mouse tracking enablement. See Ftrack_mouse for the only use
1213 of this function. */
1216 tracking_off (Lisp_Object old_value
)
1218 do_mouse_tracking
= old_value
;
1219 if (NILP (old_value
))
1221 /* Redisplay may have been preempted because there was input
1222 available, and it assumes it will be called again after the
1223 input has been processed. If the only input available was
1224 the sort that we have just disabled, then we need to call
1226 if (!readable_events (READABLE_EVENTS_DO_TIMERS_NOW
))
1228 redisplay_preserve_echo_area (6);
1229 get_input_pending (READABLE_EVENTS_DO_TIMERS_NOW
);
1234 DEFUN ("internal--track-mouse", Ftrack_mouse
, Strack_mouse
, 1, 1, 0,
1235 doc
: /* Call BODYFUN with mouse movement events enabled. */)
1236 (Lisp_Object bodyfun
)
1238 ptrdiff_t count
= SPECPDL_INDEX ();
1241 record_unwind_protect (tracking_off
, do_mouse_tracking
);
1243 do_mouse_tracking
= Qt
;
1245 val
= call0 (bodyfun
);
1246 return unbind_to (count
, val
);
1249 /* If mouse has moved on some frame, return one of those frames.
1253 If ignore_mouse_drag_p is non-zero, ignore (implicit) mouse movement
1254 after resizing the tool-bar window. */
1256 bool ignore_mouse_drag_p
;
1258 static struct frame
*
1259 some_mouse_moved (void)
1261 Lisp_Object tail
, frame
;
1263 if (ignore_mouse_drag_p
)
1265 /* ignore_mouse_drag_p = 0; */
1269 FOR_EACH_FRAME (tail
, frame
)
1271 if (XFRAME (frame
)->mouse_moved
)
1272 return XFRAME (frame
);
1279 /* This is the actual command reading loop,
1280 sans error-handling encapsulation. */
1282 static int read_key_sequence (Lisp_Object
*, int, Lisp_Object
,
1283 bool, bool, bool, bool);
1284 static void adjust_point_for_property (ptrdiff_t, bool);
1286 /* The last boundary auto-added to buffer-undo-list. */
1287 Lisp_Object last_undo_boundary
;
1289 /* FIXME: This is wrong rather than test window-system, we should call
1290 a new set-selection, which will then dispatch to x-set-selection, or
1291 tty-set-selection, or w32-set-selection, ... */
1294 command_loop_1 (void)
1297 Lisp_Object keybuf
[30];
1299 EMACS_INT prev_modiff
= 0;
1300 struct buffer
*prev_buffer
= NULL
;
1301 bool already_adjusted
= 0;
1303 kset_prefix_arg (current_kboard
, Qnil
);
1304 kset_last_prefix_arg (current_kboard
, Qnil
);
1305 Vdeactivate_mark
= Qnil
;
1306 waiting_for_input
= 0;
1309 this_command_key_count
= 0;
1310 this_command_key_count_reset
= 0;
1311 this_single_command_key_start
= 0;
1313 if (NILP (Vmemory_full
))
1315 /* Make sure this hook runs after commands that get errors and
1316 throw to top level. */
1317 /* Note that the value cell will never directly contain nil
1318 if the symbol is a local variable. */
1319 if (!NILP (Vpost_command_hook
) && !NILP (Vrun_hooks
))
1320 safe_run_hooks (Qpost_command_hook
);
1322 /* If displaying a message, resize the echo area window to fit
1323 that message's size exactly. */
1324 if (!NILP (echo_area_buffer
[0]))
1325 resize_echo_area_exactly ();
1327 /* If there are warnings waiting, process them. */
1328 if (!NILP (Vdelayed_warnings_list
))
1329 safe_run_hooks (Qdelayed_warnings_hook
);
1331 if (!NILP (Vdeferred_action_list
))
1332 safe_run_hooks (Qdeferred_action_function
);
1335 /* Do this after running Vpost_command_hook, for consistency. */
1336 kset_last_command (current_kboard
, Vthis_command
);
1337 kset_real_last_command (current_kboard
, Vreal_this_command
);
1338 if (!CONSP (last_command_event
))
1339 kset_last_repeatable_command (current_kboard
, Vreal_this_command
);
1343 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1346 /* Make sure the current window's buffer is selected. */
1347 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->contents
));
1349 /* Display any malloc warning that just came out. Use while because
1350 displaying one warning can cause another. */
1352 while (pending_malloc_warning
)
1353 display_malloc_warning ();
1355 Vdeactivate_mark
= Qnil
;
1357 /* Don't ignore mouse movements for more than a single command
1358 loop. (This flag is set in xdisp.c whenever the tool bar is
1359 resized, because the resize moves text up or down, and would
1360 generate false mouse drag events if we don't ignore them.) */
1361 ignore_mouse_drag_p
= 0;
1363 /* If minibuffer on and echo area in use,
1364 wait a short time and redraw minibuffer. */
1367 && !NILP (echo_area_buffer
[0])
1368 && EQ (minibuf_window
, echo_area_window
)
1369 && NUMBERP (Vminibuffer_message_timeout
))
1371 /* Bind inhibit-quit to t so that C-g gets read in
1372 rather than quitting back to the minibuffer. */
1373 ptrdiff_t count
= SPECPDL_INDEX ();
1374 specbind (Qinhibit_quit
, Qt
);
1376 sit_for (Vminibuffer_message_timeout
, 0, 2);
1378 /* Clear the echo area. */
1380 safe_run_hooks (Qecho_area_clear_hook
);
1382 unbind_to (count
, Qnil
);
1384 /* If a C-g came in before, treat it as input now. */
1385 if (!NILP (Vquit_flag
))
1388 Vunread_command_events
= list1 (make_number (quit_char
));
1392 /* If it has changed current-menubar from previous value,
1393 really recompute the menubar from the value. */
1394 if (! NILP (Vlucid_menu_bar_dirty_flag
)
1395 && !NILP (Ffboundp (Qrecompute_lucid_menubar
)))
1396 call0 (Qrecompute_lucid_menubar
);
1398 before_command_key_count
= this_command_key_count
;
1399 before_command_echo_length
= echo_length ();
1401 Vthis_command
= Qnil
;
1402 Vreal_this_command
= Qnil
;
1403 Vthis_original_command
= Qnil
;
1404 Vthis_command_keys_shift_translated
= Qnil
;
1406 /* Read next key sequence; i gets its length. */
1407 i
= read_key_sequence (keybuf
, ARRAYELTS (keybuf
),
1410 /* A filter may have run while we were reading the input. */
1411 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1413 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->contents
));
1417 /* Now we have read a key sequence of length I,
1418 or else I is 0 and we found end of file. */
1420 if (i
== 0) /* End of file -- happens only in */
1421 return Qnil
; /* a kbd macro, at the end. */
1422 /* -1 means read_key_sequence got a menu that was rejected.
1423 Just loop around and read another command. */
1427 this_command_key_count
= 0;
1428 this_command_key_count_reset
= 0;
1429 this_single_command_key_start
= 0;
1433 last_command_event
= keybuf
[i
- 1];
1435 /* If the previous command tried to force a specific window-start,
1436 forget about that, in case this command moves point far away
1437 from that position. But also throw away beg_unchanged and
1438 end_unchanged information in that case, so that redisplay will
1439 update the whole window properly. */
1440 if (XWINDOW (selected_window
)->force_start
)
1443 XWINDOW (selected_window
)->force_start
= 0;
1444 b
= XBUFFER (XWINDOW (selected_window
)->contents
);
1445 BUF_BEG_UNCHANGED (b
) = BUF_END_UNCHANGED (b
) = 0;
1448 cmd
= read_key_sequence_cmd
;
1449 if (!NILP (Vexecuting_kbd_macro
))
1451 if (!NILP (Vquit_flag
))
1453 Vexecuting_kbd_macro
= Qt
;
1454 QUIT
; /* Make some noise. */
1455 /* Will return since macro now empty. */
1459 /* Do redisplay processing after this command except in special
1460 cases identified below. */
1461 prev_buffer
= current_buffer
;
1462 prev_modiff
= MODIFF
;
1463 last_point_position
= PT
;
1465 /* By default, we adjust point to a boundary of a region that
1466 has such a property that should be treated intangible
1467 (e.g. composition, display). But, some commands will set
1468 this variable differently. */
1469 Vdisable_point_adjustment
= Qnil
;
1471 /* Process filters and timers may have messed with deactivate-mark.
1472 reset it before we execute the command. */
1473 Vdeactivate_mark
= Qnil
;
1475 /* Remap command through active keymaps. */
1476 Vthis_original_command
= cmd
;
1477 if (!NILP (read_key_sequence_remapped
))
1478 cmd
= read_key_sequence_remapped
;
1480 /* Execute the command. */
1483 total_keys
+= total_keys
< NUM_RECENT_KEYS
;
1484 ASET (recent_keys
, recent_keys_index
,
1486 if (++recent_keys_index
>= NUM_RECENT_KEYS
)
1487 recent_keys_index
= 0;
1489 Vthis_command
= cmd
;
1490 Vreal_this_command
= cmd
;
1491 safe_run_hooks (Qpre_command_hook
);
1493 already_adjusted
= 0;
1495 if (NILP (Vthis_command
))
1496 /* nil means key is undefined. */
1500 /* Here for a command that isn't executed directly. */
1502 #ifdef HAVE_WINDOW_SYSTEM
1503 ptrdiff_t scount
= SPECPDL_INDEX ();
1505 if (display_hourglass_p
1506 && NILP (Vexecuting_kbd_macro
))
1508 record_unwind_protect_void (cancel_hourglass
);
1513 if (NILP (KVAR (current_kboard
, Vprefix_arg
))) /* FIXME: Why? --Stef */
1515 Lisp_Object undo
= BVAR (current_buffer
, undo_list
);
1518 = (EQ (undo
, BVAR (current_buffer
, undo_list
))
1519 ? Qnil
: BVAR (current_buffer
, undo_list
));
1521 call1 (Qcommand_execute
, Vthis_command
);
1523 #ifdef HAVE_WINDOW_SYSTEM
1524 /* Do not check display_hourglass_p here, because
1525 `command-execute' could change it, but we should cancel
1526 hourglass cursor anyway.
1527 But don't cancel the hourglass within a macro
1528 just because a command in the macro finishes. */
1529 if (NILP (Vexecuting_kbd_macro
))
1530 unbind_to (scount
, Qnil
);
1533 kset_last_prefix_arg (current_kboard
, Vcurrent_prefix_arg
);
1535 safe_run_hooks (Qpost_command_hook
);
1537 /* If displaying a message, resize the echo area window to fit
1538 that message's size exactly. */
1539 if (!NILP (echo_area_buffer
[0]))
1540 resize_echo_area_exactly ();
1542 /* If there are warnings waiting, process them. */
1543 if (!NILP (Vdelayed_warnings_list
))
1544 safe_run_hooks (Qdelayed_warnings_hook
);
1546 safe_run_hooks (Qdeferred_action_function
);
1548 /* If there is a prefix argument,
1549 1) We don't want Vlast_command to be ``universal-argument''
1550 (that would be dumb), so don't set Vlast_command,
1551 2) we want to leave echoing on so that the prefix will be
1552 echoed as part of this key sequence, so don't call
1554 3) we want to leave this_command_key_count non-zero, so that
1555 read_char will realize that it is re-reading a character, and
1556 not echo it a second time.
1558 If the command didn't actually create a prefix arg,
1559 but is merely a frame event that is transparent to prefix args,
1560 then the above doesn't apply. */
1561 if (NILP (KVAR (current_kboard
, Vprefix_arg
))
1562 || CONSP (last_command_event
))
1564 kset_last_command (current_kboard
, Vthis_command
);
1565 kset_real_last_command (current_kboard
, Vreal_this_command
);
1566 if (!CONSP (last_command_event
))
1567 kset_last_repeatable_command (current_kboard
, Vreal_this_command
);
1569 this_command_key_count
= 0;
1570 this_command_key_count_reset
= 0;
1571 this_single_command_key_start
= 0;
1574 if (!NILP (BVAR (current_buffer
, mark_active
))
1575 && !NILP (Vrun_hooks
))
1577 /* In Emacs 22, setting transient-mark-mode to `only' was a
1578 way of turning it on for just one command. This usage is
1579 obsolete, but support it anyway. */
1580 if (EQ (Vtransient_mark_mode
, Qidentity
))
1581 Vtransient_mark_mode
= Qnil
;
1582 else if (EQ (Vtransient_mark_mode
, Qonly
))
1583 Vtransient_mark_mode
= Qidentity
;
1585 if (!NILP (Vdeactivate_mark
))
1586 /* If `select-active-regions' is non-nil, this call to
1587 `deactivate-mark' also sets the PRIMARY selection. */
1588 call0 (Qdeactivate_mark
);
1591 /* Even if not deactivating the mark, set PRIMARY if
1592 `select-active-regions' is non-nil. */
1593 if (!NILP (Fwindow_system (Qnil
))
1594 /* Even if mark_active is non-nil, the actual buffer
1595 marker may not have been set yet (Bug#7044). */
1596 && XMARKER (BVAR (current_buffer
, mark
))->buffer
1597 && (EQ (Vselect_active_regions
, Qonly
)
1598 ? EQ (CAR_SAFE (Vtransient_mark_mode
), Qonly
)
1599 : (!NILP (Vselect_active_regions
)
1600 && !NILP (Vtransient_mark_mode
)))
1601 && NILP (Fmemq (Vthis_command
,
1602 Vselection_inhibit_update_commands
)))
1605 = call1 (Fsymbol_value (Qregion_extract_function
), Qnil
);
1606 if (XINT (Flength (txt
)) > 0)
1607 /* Don't set empty selections. */
1608 call2 (Qgui_set_selection
, QPRIMARY
, txt
);
1611 if (current_buffer
!= prev_buffer
|| MODIFF
!= prev_modiff
)
1612 run_hook (intern ("activate-mark-hook"));
1615 Vsaved_region_selection
= Qnil
;
1620 if (current_buffer
== prev_buffer
1621 && last_point_position
!= PT
1622 && NILP (Vdisable_point_adjustment
)
1623 && NILP (Vglobal_disable_point_adjustment
))
1625 if (last_point_position
> BEGV
1626 && last_point_position
< ZV
1627 && (composition_adjust_point (last_point_position
,
1628 last_point_position
)
1629 != last_point_position
))
1630 /* The last point was temporarily set within a grapheme
1631 cluster to prevent automatic composition. To recover
1632 the automatic composition, we must update the
1634 windows_or_buffers_changed
= 21;
1635 if (!already_adjusted
)
1636 adjust_point_for_property (last_point_position
,
1637 MODIFF
!= prev_modiff
);
1640 /* Install chars successfully executed in kbd macro. */
1642 if (!NILP (KVAR (current_kboard
, defining_kbd_macro
))
1643 && NILP (KVAR (current_kboard
, Vprefix_arg
)))
1644 finalize_kbd_macro_chars ();
1649 read_menu_command (void)
1651 Lisp_Object keybuf
[30];
1652 ptrdiff_t count
= SPECPDL_INDEX ();
1655 /* We don't want to echo the keystrokes while navigating the
1657 specbind (Qecho_keystrokes
, make_number (0));
1659 i
= read_key_sequence (keybuf
, ARRAYELTS (keybuf
),
1662 unbind_to (count
, Qnil
);
1664 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1666 if (i
== 0 || i
== -1)
1669 return read_key_sequence_cmd
;
1672 /* Adjust point to a boundary of a region that has such a property
1673 that should be treated intangible. For the moment, we check
1674 `composition', `display' and `invisible' properties.
1675 LAST_PT is the last position of point. */
1678 adjust_point_for_property (ptrdiff_t last_pt
, bool modified
)
1681 Lisp_Object val
, overlay
, tmp
;
1682 /* When called after buffer modification, we should temporarily
1683 suppress the point adjustment for automatic composition so that a
1684 user can keep inserting another character at point or keep
1685 deleting characters around point. */
1686 bool check_composition
= ! modified
, check_display
= 1, check_invisible
= 1;
1687 ptrdiff_t orig_pt
= PT
;
1689 /* FIXME: cycling is probably not necessary because these properties
1690 can't be usefully combined anyway. */
1691 while (check_composition
|| check_display
|| check_invisible
)
1693 /* FIXME: check `intangible'. */
1694 if (check_composition
1695 && PT
> BEGV
&& PT
< ZV
1696 && (beg
= composition_adjust_point (last_pt
, PT
)) != PT
)
1699 check_display
= check_invisible
= 1;
1701 check_composition
= 0;
1703 && PT
> BEGV
&& PT
< ZV
1704 && !NILP (val
= get_char_property_and_overlay
1705 (make_number (PT
), Qdisplay
, Qnil
, &overlay
))
1706 && display_prop_intangible_p (val
, overlay
, PT
, PT_BYTE
)
1707 && (!OVERLAYP (overlay
)
1708 ? get_property_and_range (PT
, Qdisplay
, &val
, &beg
, &end
, Qnil
)
1709 : (beg
= OVERLAY_POSITION (OVERLAY_START (overlay
)),
1710 end
= OVERLAY_POSITION (OVERLAY_END (overlay
))))
1711 && (beg
< PT
/* && end > PT <- It's always the case. */
1712 || (beg
<= PT
&& STRINGP (val
) && SCHARS (val
) == 0)))
1715 SET_PT (PT
< last_pt
1716 ? (STRINGP (val
) && SCHARS (val
) == 0
1717 ? max (beg
- 1, BEGV
)
1720 check_composition
= check_invisible
= 1;
1723 if (check_invisible
&& PT
> BEGV
&& PT
< ZV
)
1729 /* Find boundaries `beg' and `end' of the invisible area, if any. */
1732 /* FIXME: We should stop if we find a spot between
1733 two runs of `invisible' where inserted text would
1734 be visible. This is important when we have two
1735 invisible boundaries that enclose an area: if the
1736 area is empty, we need this test in order to make
1737 it possible to place point in the middle rather
1738 than skip both boundaries. However, this code
1739 also stops anywhere in a non-sticky text-property,
1740 which breaks (e.g.) Org mode. */
1741 && (val
= Fget_pos_property (make_number (end
),
1743 TEXT_PROP_MEANS_INVISIBLE (val
))
1745 && !NILP (val
= get_char_property_and_overlay
1746 (make_number (end
), Qinvisible
, Qnil
, &overlay
))
1747 && (inv
= TEXT_PROP_MEANS_INVISIBLE (val
)))
1749 ellipsis
= ellipsis
|| inv
> 1
1750 || (OVERLAYP (overlay
)
1751 && (!NILP (Foverlay_get (overlay
, Qafter_string
))
1752 || !NILP (Foverlay_get (overlay
, Qbefore_string
))));
1753 tmp
= Fnext_single_char_property_change
1754 (make_number (end
), Qinvisible
, Qnil
, Qnil
);
1755 end
= NATNUMP (tmp
) ? XFASTINT (tmp
) : ZV
;
1759 && (val
= Fget_pos_property (make_number (beg
),
1761 TEXT_PROP_MEANS_INVISIBLE (val
))
1763 && !NILP (val
= get_char_property_and_overlay
1764 (make_number (beg
- 1), Qinvisible
, Qnil
, &overlay
))
1765 && (inv
= TEXT_PROP_MEANS_INVISIBLE (val
)))
1767 ellipsis
= ellipsis
|| inv
> 1
1768 || (OVERLAYP (overlay
)
1769 && (!NILP (Foverlay_get (overlay
, Qafter_string
))
1770 || !NILP (Foverlay_get (overlay
, Qbefore_string
))));
1771 tmp
= Fprevious_single_char_property_change
1772 (make_number (beg
), Qinvisible
, Qnil
, Qnil
);
1773 beg
= NATNUMP (tmp
) ? XFASTINT (tmp
) : BEGV
;
1776 /* Move away from the inside area. */
1777 if (beg
< PT
&& end
> PT
)
1779 SET_PT ((orig_pt
== PT
&& (last_pt
< beg
|| last_pt
> end
))
1780 /* We haven't moved yet (so we don't need to fear
1781 infinite-looping) and we were outside the range
1782 before (so either end of the range still corresponds
1783 to a move in the right direction): pretend we moved
1784 less than we actually did, so that we still have
1785 more freedom below in choosing which end of the range
1787 ? (orig_pt
= -1, PT
< last_pt
? end
: beg
)
1788 /* We either have moved already or the last point
1789 was already in the range: we don't get to choose
1790 which end of the range we have to go to. */
1791 : (PT
< last_pt
? beg
: end
));
1792 check_composition
= check_display
= 1;
1794 #if 0 /* This assertion isn't correct, because SET_PT may end up setting
1795 the point to something other than its argument, due to
1796 point-motion hooks, intangibility, etc. */
1797 eassert (PT
== beg
|| PT
== end
);
1800 /* Pretend the area doesn't exist if the buffer is not
1802 if (!modified
&& !ellipsis
&& beg
< end
)
1804 if (last_pt
== beg
&& PT
== end
&& end
< ZV
)
1805 (check_composition
= check_display
= 1, SET_PT (end
+ 1));
1806 else if (last_pt
== end
&& PT
== beg
&& beg
> BEGV
)
1807 (check_composition
= check_display
= 1, SET_PT (beg
- 1));
1808 else if (PT
== ((PT
< last_pt
) ? beg
: end
))
1809 /* We've already moved as far as we can. Trying to go
1810 to the other end would mean moving backwards and thus
1811 could lead to an infinite loop. */
1813 else if (val
= Fget_pos_property (make_number (PT
),
1815 TEXT_PROP_MEANS_INVISIBLE (val
)
1816 && (val
= (Fget_pos_property
1817 (make_number (PT
== beg
? end
: beg
),
1819 !TEXT_PROP_MEANS_INVISIBLE (val
)))
1820 (check_composition
= check_display
= 1,
1821 SET_PT (PT
== beg
? end
: beg
));
1824 check_invisible
= 0;
1828 /* Subroutine for safe_run_hooks: run the hook, which is ARGS[1]. */
1831 safe_run_hooks_1 (ptrdiff_t nargs
, Lisp_Object
*args
)
1833 eassert (nargs
== 2);
1834 return call0 (args
[1]);
1837 /* Subroutine for safe_run_hooks: handle an error by clearing out the function
1841 safe_run_hooks_error (Lisp_Object error
, ptrdiff_t nargs
, Lisp_Object
*args
)
1843 eassert (nargs
== 2);
1844 AUTO_STRING (format
, "Error in %s (%S): %S");
1845 Lisp_Object hook
= args
[0];
1846 Lisp_Object fun
= args
[1];
1847 Fmessage (4, (Lisp_Object
[]) {format
, hook
, fun
, error
});
1853 Lisp_Object newval
= Qnil
;
1854 for (val
= find_symbol_value (hook
); CONSP (val
); val
= XCDR (val
))
1855 if (EQ (fun
, XCAR (val
)))
1858 newval
= Fcons (XCAR (val
), newval
);
1860 return Fset (hook
, Fnreverse (newval
));
1861 /* Not found in the local part of the hook. Let's look at the global
1864 for (val
= (NILP (Fdefault_boundp (hook
)) ? Qnil
1865 : Fdefault_value (hook
));
1866 CONSP (val
); val
= XCDR (val
))
1867 if (EQ (fun
, XCAR (val
)))
1870 newval
= Fcons (XCAR (val
), newval
);
1872 return Fset_default (hook
, Fnreverse (newval
));
1878 safe_run_hook_funcall (ptrdiff_t nargs
, Lisp_Object
*args
)
1880 Lisp_Object iargs
[2];
1882 eassert (nargs
== 2);
1883 /* Yes, run_hook_with_args works this way. */
1886 internal_condition_case_n (safe_run_hooks_1
, 2, iargs
,
1887 Qt
, safe_run_hooks_error
);
1891 /* If we get an error while running the hook, cause the hook variable
1892 to be nil. Also inhibit quits, so that C-g won't cause the hook
1893 to mysteriously evaporate. */
1896 safe_run_hooks (Lisp_Object hook
)
1898 Lisp_Object args
[2];
1899 struct gcpro gcpro1
;
1900 ptrdiff_t count
= SPECPDL_INDEX ();
1906 specbind (Qinhibit_quit
, Qt
);
1907 run_hook_with_args (2, args
, safe_run_hook_funcall
);
1908 unbind_to (count
, Qnil
);
1913 /* Nonzero means polling for input is temporarily suppressed. */
1915 int poll_suppress_count
;
1918 #ifdef POLL_FOR_INPUT
1920 /* Asynchronous timer for polling. */
1922 static struct atimer
*poll_timer
;
1924 /* Poll for input, so that we catch a C-g if it comes in. */
1926 poll_for_input_1 (void)
1928 if (! input_blocked_p ()
1929 && !waiting_for_input
)
1933 /* Timer callback function for poll_timer. TIMER is equal to
1937 poll_for_input (struct atimer
*timer
)
1939 if (poll_suppress_count
== 0)
1940 pending_signals
= 1;
1943 #endif /* POLL_FOR_INPUT */
1945 /* Begin signals to poll for input, if they are appropriate.
1946 This function is called unconditionally from various places. */
1949 start_polling (void)
1951 #ifdef POLL_FOR_INPUT
1952 /* XXX This condition was (read_socket_hook && !interrupt_input),
1953 but read_socket_hook is not global anymore. Let's pretend that
1955 if (!interrupt_input
)
1957 /* Turn alarm handling on unconditionally. It might have
1958 been turned off in process.c. */
1959 turn_on_atimers (1);
1961 /* If poll timer doesn't exist, or we need one with
1962 a different interval, start a new one. */
1963 if (poll_timer
== NULL
1964 || poll_timer
->interval
.tv_sec
!= polling_period
)
1966 time_t period
= max (1, min (polling_period
, TYPE_MAXIMUM (time_t)));
1967 struct timespec interval
= make_timespec (period
, 0);
1970 cancel_atimer (poll_timer
);
1972 poll_timer
= start_atimer (ATIMER_CONTINUOUS
, interval
,
1973 poll_for_input
, NULL
);
1976 /* Let the timer's callback function poll for input
1977 if this becomes zero. */
1978 --poll_suppress_count
;
1983 /* True if we are using polling to handle input asynchronously. */
1986 input_polling_used (void)
1988 #ifdef POLL_FOR_INPUT
1989 /* XXX This condition was (read_socket_hook && !interrupt_input),
1990 but read_socket_hook is not global anymore. Let's pretend that
1992 return !interrupt_input
;
1998 /* Turn off polling. */
2003 #ifdef POLL_FOR_INPUT
2004 /* XXX This condition was (read_socket_hook && !interrupt_input),
2005 but read_socket_hook is not global anymore. Let's pretend that
2007 if (!interrupt_input
)
2008 ++poll_suppress_count
;
2012 /* Set the value of poll_suppress_count to COUNT
2013 and start or stop polling accordingly. */
2016 set_poll_suppress_count (int count
)
2018 #ifdef POLL_FOR_INPUT
2019 if (count
== 0 && poll_suppress_count
!= 0)
2021 poll_suppress_count
= 1;
2024 else if (count
!= 0 && poll_suppress_count
== 0)
2028 poll_suppress_count
= count
;
2032 /* Bind polling_period to a value at least N.
2033 But don't decrease it. */
2036 bind_polling_period (int n
)
2038 #ifdef POLL_FOR_INPUT
2039 EMACS_INT
new = polling_period
;
2044 stop_other_atimers (poll_timer
);
2046 specbind (Qpolling_period
, make_number (new));
2047 /* Start a new alarm with the new period. */
2052 /* Apply the control modifier to CHARACTER. */
2055 make_ctrl_char (int c
)
2057 /* Save the upper bits here. */
2058 int upper
= c
& ~0177;
2060 if (! ASCII_CHAR_P (c
))
2061 return c
|= ctrl_modifier
;
2065 /* Everything in the columns containing the upper-case letters
2066 denotes a control character. */
2067 if (c
>= 0100 && c
< 0140)
2071 /* Set the shift modifier for a control char
2072 made from a shifted letter. But only for letters! */
2073 if (oc
>= 'A' && oc
<= 'Z')
2074 c
|= shift_modifier
;
2077 /* The lower-case letters denote control characters too. */
2078 else if (c
>= 'a' && c
<= 'z')
2081 /* Include the bits for control and shift
2082 only if the basic ASCII code can't indicate them. */
2086 /* Replace the high bits. */
2087 c
|= (upper
& ~ctrl_modifier
);
2092 /* Display the help-echo property of the character after the mouse pointer.
2093 Either show it in the echo area, or call show-help-function to display
2094 it by other means (maybe in a tooltip).
2096 If HELP is nil, that means clear the previous help echo.
2098 If HELP is a string, display that string. If HELP is a function,
2099 call it with OBJECT and POS as arguments; the function should
2100 return a help string or nil for none. For all other types of HELP,
2101 evaluate it to obtain a string.
2103 WINDOW is the window in which the help was generated, if any.
2104 It is nil if not in a window.
2106 If OBJECT is a buffer, POS is the position in the buffer where the
2107 `help-echo' text property was found.
2109 If OBJECT is an overlay, that overlay has a `help-echo' property,
2110 and POS is the position in the overlay's buffer under the mouse.
2112 If OBJECT is a string (an overlay string or a string displayed with
2113 the `display' property). POS is the position in that string under
2116 Note: this function may only be called with HELP nil or a string
2117 from X code running asynchronously. */
2120 show_help_echo (Lisp_Object help
, Lisp_Object window
, Lisp_Object object
,
2123 if (!NILP (help
) && !STRINGP (help
))
2125 if (FUNCTIONP (help
))
2126 help
= safe_call (4, help
, window
, object
, pos
);
2128 help
= safe_eval (help
);
2130 if (!STRINGP (help
))
2134 if (!noninteractive
&& STRINGP (help
))
2136 /* The mouse-fixup-help-message Lisp function can call
2137 mouse_position_hook, which resets the mouse_moved flags.
2138 This causes trouble if we are trying to read a mouse motion
2139 event (i.e., if we are inside a `track-mouse' form), so we
2140 restore the mouse_moved flag. */
2141 struct frame
*f
= NILP (do_mouse_tracking
) ? NULL
: some_mouse_moved ();
2142 help
= call1 (Qmouse_fixup_help_message
, help
);
2147 if (STRINGP (help
) || NILP (help
))
2149 if (!NILP (Vshow_help_function
))
2150 call1 (Vshow_help_function
, help
);
2151 help_echo_showing_p
= STRINGP (help
);
2157 /* Input of single characters from keyboard. */
2159 static Lisp_Object
kbd_buffer_get_event (KBOARD
**kbp
, bool *used_mouse_menu
,
2160 struct timespec
*end_time
);
2161 static void record_char (Lisp_Object c
);
2163 static Lisp_Object help_form_saved_window_configs
;
2165 read_char_help_form_unwind (void)
2167 Lisp_Object window_config
= XCAR (help_form_saved_window_configs
);
2168 help_form_saved_window_configs
= XCDR (help_form_saved_window_configs
);
2169 if (!NILP (window_config
))
2170 Fset_window_configuration (window_config
);
2173 #define STOP_POLLING \
2174 do { if (! polling_stopped_here) stop_polling (); \
2175 polling_stopped_here = 1; } while (0)
2177 #define RESUME_POLLING \
2178 do { if (polling_stopped_here) start_polling (); \
2179 polling_stopped_here = 0; } while (0)
2182 read_event_from_main_queue (struct timespec
*end_time
,
2183 sys_jmp_buf local_getcjmp
,
2184 bool *used_mouse_menu
)
2186 Lisp_Object c
= Qnil
;
2187 sys_jmp_buf save_jump
;
2188 KBOARD
*kb
IF_LINT (= NULL
);
2192 /* Read from the main queue, and if that gives us something we can't use yet,
2193 we put it on the appropriate side queue and try again. */
2195 if (end_time
&& timespec_cmp (*end_time
, current_timespec ()) <= 0)
2198 /* Actually read a character, waiting if necessary. */
2199 save_getcjmp (save_jump
);
2200 restore_getcjmp (local_getcjmp
);
2202 timer_start_idle ();
2203 c
= kbd_buffer_get_event (&kb
, used_mouse_menu
, end_time
);
2204 restore_getcjmp (save_jump
);
2206 if (! NILP (c
) && (kb
!= current_kboard
))
2208 Lisp_Object last
= KVAR (kb
, kbd_queue
);
2211 while (CONSP (XCDR (last
)))
2213 if (!NILP (XCDR (last
)))
2217 kset_kbd_queue (kb
, list1 (c
));
2219 XSETCDR (last
, list1 (c
));
2220 kb
->kbd_queue_has_data
= 1;
2224 current_kboard
= kb
;
2225 /* This is going to exit from read_char
2226 so we had better get rid of this frame's stuff. */
2227 return make_number (-2);
2230 /* Terminate Emacs in batch mode if at eof. */
2231 if (noninteractive
&& INTEGERP (c
) && XINT (c
) < 0)
2232 Fkill_emacs (make_number (1));
2236 /* Add in any extra modifiers, where appropriate. */
2237 if ((extra_keyboard_modifiers
& CHAR_CTL
)
2238 || ((extra_keyboard_modifiers
& 0177) < ' '
2239 && (extra_keyboard_modifiers
& 0177) != 0))
2240 XSETINT (c
, make_ctrl_char (XINT (c
)));
2242 /* Transfer any other modifier bits directly from
2243 extra_keyboard_modifiers to c. Ignore the actual character code
2244 in the low 16 bits of extra_keyboard_modifiers. */
2245 XSETINT (c
, XINT (c
) | (extra_keyboard_modifiers
& ~0xff7f & ~CHAR_CTL
));
2253 /* Like `read_event_from_main_queue' but applies keyboard-coding-system
2256 read_decoded_event_from_main_queue (struct timespec
*end_time
,
2257 sys_jmp_buf local_getcjmp
,
2258 Lisp_Object prev_event
,
2259 bool *used_mouse_menu
)
2261 #define MAX_ENCODED_BYTES 16
2263 Lisp_Object events
[MAX_ENCODED_BYTES
];
2269 = read_event_from_main_queue (end_time
, local_getcjmp
,
2272 /* w32_console already returns decoded events. It either reads
2273 Unicode characters from the Windows keyboard input, or
2274 converts characters encoded in the current codepage into
2275 Unicode. See w32inevt.c:key_event, near its end. */
2278 struct frame
*frame
= XFRAME (selected_frame
);
2279 struct terminal
*terminal
= frame
->terminal
;
2280 if (!((FRAME_TERMCAP_P (frame
) || FRAME_MSDOS_P (frame
))
2281 /* Don't apply decoding if we're just reading a raw event
2282 (e.g. reading bytes sent by the xterm to specify the position
2283 of a mouse click). */
2284 && (!EQ (prev_event
, Qt
))
2285 && (TERMINAL_KEYBOARD_CODING (terminal
)->common_flags
2286 & CODING_REQUIRE_DECODING_MASK
)))
2287 return nextevt
; /* No decoding needed. */
2290 int meta_key
= terminal
->display_info
.tty
->meta_key
;
2291 eassert (n
< MAX_ENCODED_BYTES
);
2292 events
[n
++] = nextevt
;
2293 if (NATNUMP (nextevt
)
2294 && XINT (nextevt
) < (meta_key
== 1 ? 0x80 : 0x100))
2295 { /* An encoded byte sequence, let's try to decode it. */
2296 struct coding_system
*coding
2297 = TERMINAL_KEYBOARD_CODING (terminal
);
2298 unsigned char src
[MAX_ENCODED_BYTES
];
2299 unsigned char dest
[MAX_ENCODED_BYTES
* MAX_MULTIBYTE_LENGTH
];
2301 for (i
= 0; i
< n
; i
++)
2302 src
[i
] = XINT (events
[i
]);
2304 for (i
= 0; i
< n
; i
++)
2306 coding
->destination
= dest
;
2307 coding
->dst_bytes
= sizeof dest
;
2308 decode_coding_c_string (coding
, src
, n
, Qnil
);
2309 eassert (coding
->produced_char
<= n
);
2310 if (coding
->produced_char
== 0)
2311 { /* The encoded sequence is incomplete. */
2312 if (n
< MAX_ENCODED_BYTES
) /* Avoid buffer overflow. */
2313 continue; /* Read on! */
2317 const unsigned char *p
= coding
->destination
;
2318 eassert (coding
->carryover_bytes
== 0);
2320 while (n
< coding
->produced_char
)
2321 events
[n
++] = make_number (STRING_CHAR_ADVANCE (p
));
2324 /* Now `events' should hold decoded events.
2325 Normally, n should be equal to 1, but better not rely on it.
2326 We can only return one event here, so return the first we
2327 had and keep the others (if any) for later. */
2329 Vunread_command_events
2330 = Fcons (events
[--n
], Vunread_command_events
);
2338 echo_keystrokes_p (void)
2340 return (FLOATP (Vecho_keystrokes
) ? XFLOAT_DATA (Vecho_keystrokes
) > 0.0
2341 : INTEGERP (Vecho_keystrokes
) ? XINT (Vecho_keystrokes
) > 0 : false);
2344 /* Read a character from the keyboard; call the redisplay if needed. */
2345 /* commandflag 0 means do not autosave, but do redisplay.
2346 -1 means do not redisplay, but do autosave.
2347 -2 means do neither.
2350 The argument MAP is a keymap for menu prompting.
2352 PREV_EVENT is the previous input event, or nil if we are reading
2353 the first event of a key sequence (or not reading a key sequence).
2354 If PREV_EVENT is t, that is a "magic" value that says
2355 not to run input methods, but in other respects to act as if
2356 not reading a key sequence.
2358 If USED_MOUSE_MENU is non-null, then set *USED_MOUSE_MENU to true
2359 if we used a mouse menu to read the input, or false otherwise. If
2360 USED_MOUSE_MENU is null, don't dereference it.
2362 Value is -2 when we find input on another keyboard. A second call
2363 to read_char will read it.
2365 If END_TIME is non-null, it is a pointer to a struct timespec
2366 specifying the maximum time to wait until. If no input arrives by
2367 that time, stop waiting and return nil.
2369 Value is t if we showed a menu and the user rejected it. */
2372 read_char (int commandflag
, Lisp_Object map
,
2373 Lisp_Object prev_event
,
2374 bool *used_mouse_menu
, struct timespec
*end_time
)
2378 sys_jmp_buf local_getcjmp
;
2379 sys_jmp_buf save_jump
;
2380 Lisp_Object tem
, save
;
2381 volatile Lisp_Object previous_echo_area_message
;
2382 volatile Lisp_Object also_record
;
2383 volatile bool reread
;
2384 struct gcpro gcpro1
, gcpro2
;
2385 bool volatile polling_stopped_here
= 0;
2386 struct kboard
*orig_kboard
= current_kboard
;
2390 #if 0 /* This was commented out as part of fixing echo for C-u left. */
2391 before_command_key_count
= this_command_key_count
;
2392 before_command_echo_length
= echo_length ();
2395 previous_echo_area_message
= Qnil
;
2397 GCPRO2 (c
, previous_echo_area_message
);
2401 if (CONSP (Vunread_post_input_method_events
))
2403 c
= XCAR (Vunread_post_input_method_events
);
2404 Vunread_post_input_method_events
2405 = XCDR (Vunread_post_input_method_events
);
2407 /* Undo what read_char_x_menu_prompt did when it unread
2408 additional keys returned by Fx_popup_menu. */
2410 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2421 if (CONSP (Vunread_command_events
))
2423 bool was_disabled
= 0;
2425 c
= XCAR (Vunread_command_events
);
2426 Vunread_command_events
= XCDR (Vunread_command_events
);
2428 /* Undo what sit-for did when it unread additional keys
2429 inside universal-argument. */
2431 if (CONSP (c
) && EQ (XCAR (c
), Qt
))
2436 /* Undo what read_char_x_menu_prompt did when it unread
2437 additional keys returned by Fx_popup_menu. */
2439 && EQ (XCDR (c
), Qdisabled
)
2440 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
))))
2446 /* If the queued event is something that used the mouse,
2447 set used_mouse_menu accordingly. */
2449 /* Also check was_disabled so last-nonmenu-event won't return
2450 a bad value when submenus are involved. (Bug#447) */
2451 && (EQ (c
, Qtool_bar
) || EQ (c
, Qmenu_bar
) || was_disabled
))
2452 *used_mouse_menu
= 1;
2454 goto reread_for_input_method
;
2457 if (CONSP (Vunread_input_method_events
))
2459 c
= XCAR (Vunread_input_method_events
);
2460 Vunread_input_method_events
= XCDR (Vunread_input_method_events
);
2462 /* Undo what read_char_x_menu_prompt did when it unread
2463 additional keys returned by Fx_popup_menu. */
2465 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2469 goto reread_for_input_method
;
2472 this_command_key_count_reset
= 0;
2474 if (!NILP (Vexecuting_kbd_macro
))
2476 /* We set this to Qmacro; since that's not a frame, nobody will
2477 try to switch frames on us, and the selected window will
2480 Since this event came from a macro, it would be misleading to
2481 leave internal_last_event_frame set to wherever the last
2482 real event came from. Normally, a switch-frame event selects
2483 internal_last_event_frame after each command is read, but
2484 events read from a macro should never cause a new frame to be
2486 Vlast_event_frame
= internal_last_event_frame
= Qmacro
;
2488 /* Exit the macro if we are at the end.
2489 Also, some things replace the macro with t
2490 to force an early exit. */
2491 if (EQ (Vexecuting_kbd_macro
, Qt
)
2492 || executing_kbd_macro_index
>= XFASTINT (Flength (Vexecuting_kbd_macro
)))
2498 c
= Faref (Vexecuting_kbd_macro
, make_number (executing_kbd_macro_index
));
2499 if (STRINGP (Vexecuting_kbd_macro
)
2500 && (XFASTINT (c
) & 0x80) && (XFASTINT (c
) <= 0xff))
2501 XSETFASTINT (c
, CHAR_META
| (XFASTINT (c
) & ~0x80));
2503 executing_kbd_macro_index
++;
2508 if (!NILP (unread_switch_frame
))
2510 c
= unread_switch_frame
;
2511 unread_switch_frame
= Qnil
;
2513 /* This event should make it into this_command_keys, and get echoed
2514 again, so we do not set `reread'. */
2518 /* If redisplay was requested. */
2519 if (commandflag
>= 0)
2521 bool echo_current
= EQ (echo_message_buffer
, echo_area_buffer
[0]);
2523 /* If there is pending input, process any events which are not
2524 user-visible, such as X selection_request events. */
2526 || detect_input_pending_run_timers (0))
2527 swallow_events (false); /* May clear input_pending. */
2529 /* Redisplay if no pending input. */
2530 while (!(input_pending
2531 && (input_was_pending
|| !redisplay_dont_pause
)))
2533 input_was_pending
= input_pending
;
2534 if (help_echo_showing_p
&& !EQ (selected_window
, minibuf_window
))
2535 redisplay_preserve_echo_area (5);
2540 /* Normal case: no input arrived during redisplay. */
2543 /* Input arrived and pre-empted redisplay.
2544 Process any events which are not user-visible. */
2545 swallow_events (false);
2546 /* If that cleared input_pending, try again to redisplay. */
2549 /* Prevent the redisplay we just did
2550 from messing up echoing of the input after the prompt. */
2551 if (commandflag
== 0 && echo_current
)
2552 echo_message_buffer
= echo_area_buffer
[0];
2556 /* Message turns off echoing unless more keystrokes turn it on again.
2558 The code in 20.x for the condition was
2560 1. echo_area_glyphs && *echo_area_glyphs
2561 2. && echo_area_glyphs != current_kboard->echobuf
2562 3. && ok_to_echo_at_next_pause != echo_area_glyphs
2564 (1) means there's a current message displayed
2566 (2) means it's not the message from echoing from the current
2569 (3) There's only one place in 20.x where ok_to_echo_at_next_pause
2570 is set to a non-null value. This is done in read_char and it is
2571 set to echo_area_glyphs after a call to echo_char. That means
2572 ok_to_echo_at_next_pause is either null or
2573 current_kboard->echobuf with the appropriate current_kboard at
2576 So, condition (3) means in clear text ok_to_echo_at_next_pause
2577 must be either null, or the current message isn't from echoing at
2578 all, or it's from echoing from a different kboard than the
2581 if (/* There currently is something in the echo area. */
2582 !NILP (echo_area_buffer
[0])
2583 && (/* It's an echo from a different kboard. */
2584 echo_kboard
!= current_kboard
2585 /* Or we explicitly allow overwriting whatever there is. */
2586 || ok_to_echo_at_next_pause
== NULL
))
2591 /* Try reading a character via menu prompting in the minibuf.
2592 Try this before the sit-for, because the sit-for
2593 would do the wrong thing if we are supposed to do
2594 menu prompting. If EVENT_HAS_PARAMETERS then we are reading
2595 after a mouse event so don't try a minibuf menu. */
2597 if (KEYMAPP (map
) && INTERACTIVE
2598 && !NILP (prev_event
) && ! EVENT_HAS_PARAMETERS (prev_event
)
2599 /* Don't bring up a menu if we already have another event. */
2600 && NILP (Vunread_command_events
)
2601 && !detect_input_pending_run_timers (0))
2603 c
= read_char_minibuf_menu_prompt (commandflag
, map
);
2605 if (INTEGERP (c
) && XINT (c
) == -2)
2606 return c
; /* wrong_kboard_jmpbuf */
2612 /* Make a longjmp point for quits to use, but don't alter getcjmp just yet.
2613 We will do that below, temporarily for short sections of code,
2614 when appropriate. local_getcjmp must be in effect
2615 around any call to sit_for or kbd_buffer_get_event;
2616 it *must not* be in effect when we call redisplay. */
2618 jmpcount
= SPECPDL_INDEX ();
2619 if (sys_setjmp (local_getcjmp
))
2621 /* Handle quits while reading the keyboard. */
2622 /* We must have saved the outer value of getcjmp here,
2623 so restore it now. */
2624 restore_getcjmp (save_jump
);
2625 pthread_sigmask (SIG_SETMASK
, &empty_mask
, 0);
2626 unbind_to (jmpcount
, Qnil
);
2627 XSETINT (c
, quit_char
);
2628 internal_last_event_frame
= selected_frame
;
2629 Vlast_event_frame
= internal_last_event_frame
;
2630 /* If we report the quit char as an event,
2631 don't do so more than once. */
2632 if (!NILP (Vinhibit_quit
))
2636 KBOARD
*kb
= FRAME_KBOARD (XFRAME (selected_frame
));
2637 if (kb
!= current_kboard
)
2639 Lisp_Object last
= KVAR (kb
, kbd_queue
);
2640 /* We shouldn't get here if we were in single-kboard mode! */
2645 while (CONSP (XCDR (last
)))
2647 if (!NILP (XCDR (last
)))
2651 kset_kbd_queue (kb
, list1 (c
));
2653 XSETCDR (last
, list1 (c
));
2654 kb
->kbd_queue_has_data
= 1;
2655 current_kboard
= kb
;
2656 /* This is going to exit from read_char
2657 so we had better get rid of this frame's stuff. */
2659 return make_number (-2); /* wrong_kboard_jmpbuf */
2665 /* Start idle timers if no time limit is supplied. We don't do it
2666 if a time limit is supplied to avoid an infinite recursion in the
2667 situation where an idle timer calls `sit-for'. */
2670 timer_start_idle ();
2672 /* If in middle of key sequence and minibuffer not active,
2673 start echoing if enough time elapses. */
2675 if (minibuf_level
== 0
2677 && !current_kboard
->immediate_echo
2678 && this_command_key_count
> 0
2680 && echo_keystrokes_p ()
2681 && (/* No message. */
2682 NILP (echo_area_buffer
[0])
2683 /* Or empty message. */
2684 || (BUF_BEG (XBUFFER (echo_area_buffer
[0]))
2685 == BUF_Z (XBUFFER (echo_area_buffer
[0])))
2686 /* Or already echoing from same kboard. */
2687 || (echo_kboard
&& ok_to_echo_at_next_pause
== echo_kboard
)
2688 /* Or not echoing before and echoing allowed. */
2689 || (!echo_kboard
&& ok_to_echo_at_next_pause
)))
2691 /* After a mouse event, start echoing right away.
2692 This is because we are probably about to display a menu,
2693 and we don't want to delay before doing so. */
2694 if (EVENT_HAS_PARAMETERS (prev_event
))
2700 save_getcjmp (save_jump
);
2701 restore_getcjmp (local_getcjmp
);
2702 tem0
= sit_for (Vecho_keystrokes
, 1, 1);
2703 restore_getcjmp (save_jump
);
2705 && ! CONSP (Vunread_command_events
))
2710 /* Maybe auto save due to number of keystrokes. */
2712 if (commandflag
!= 0 && commandflag
!= -2
2713 && auto_save_interval
> 0
2714 && num_nonmacro_input_events
- last_auto_save
> max (auto_save_interval
, 20)
2715 && !detect_input_pending_run_timers (0))
2717 Fdo_auto_save (Qnil
, Qnil
);
2718 /* Hooks can actually change some buffers in auto save. */
2722 /* Try reading using an X menu.
2723 This is never confused with reading using the minibuf
2724 because the recursive call of read_char in read_char_minibuf_menu_prompt
2725 does not pass on any keymaps. */
2727 if (KEYMAPP (map
) && INTERACTIVE
2728 && !NILP (prev_event
)
2729 && EVENT_HAS_PARAMETERS (prev_event
)
2730 && !EQ (XCAR (prev_event
), Qmenu_bar
)
2731 && !EQ (XCAR (prev_event
), Qtool_bar
)
2732 /* Don't bring up a menu if we already have another event. */
2733 && NILP (Vunread_command_events
))
2735 c
= read_char_x_menu_prompt (map
, prev_event
, used_mouse_menu
);
2737 /* Now that we have read an event, Emacs is not idle. */
2744 /* Maybe autosave and/or garbage collect due to idleness. */
2746 if (INTERACTIVE
&& NILP (c
))
2749 ptrdiff_t buffer_size
;
2751 /* Slow down auto saves logarithmically in size of current buffer,
2752 and garbage collect while we're at it. */
2753 if (! MINI_WINDOW_P (XWINDOW (selected_window
)))
2754 last_non_minibuf_size
= Z
- BEG
;
2755 buffer_size
= (last_non_minibuf_size
>> 8) + 1;
2757 while (buffer_size
> 64)
2758 delay_level
++, buffer_size
-= buffer_size
>> 2;
2759 if (delay_level
< 4) delay_level
= 4;
2760 /* delay_level is 4 for files under around 50k, 7 at 100k,
2761 9 at 200k, 11 at 300k, and 12 at 500k. It is 15 at 1 meg. */
2763 /* Auto save if enough time goes by without input. */
2764 if (commandflag
!= 0 && commandflag
!= -2
2765 && num_nonmacro_input_events
> last_auto_save
2766 && INTEGERP (Vauto_save_timeout
)
2767 && XINT (Vauto_save_timeout
) > 0)
2770 EMACS_INT timeout
= XFASTINT (Vauto_save_timeout
);
2772 timeout
= min (timeout
, MOST_POSITIVE_FIXNUM
/ delay_level
* 4);
2773 timeout
= delay_level
* timeout
/ 4;
2774 save_getcjmp (save_jump
);
2775 restore_getcjmp (local_getcjmp
);
2776 tem0
= sit_for (make_number (timeout
), 1, 1);
2777 restore_getcjmp (save_jump
);
2780 && ! CONSP (Vunread_command_events
))
2782 Fdo_auto_save (Qnil
, Qnil
);
2787 /* If there is still no input available, ask for GC. */
2788 if (!detect_input_pending_run_timers (0))
2792 /* Notify the caller if an autosave hook, or a timer, sentinel or
2793 filter in the sit_for calls above have changed the current
2794 kboard. This could happen if they use the minibuffer or start a
2795 recursive edit, like the fancy splash screen in server.el's
2796 filter. If this longjmp wasn't here, read_key_sequence would
2797 interpret the next key sequence using the wrong translation
2798 tables and function keymaps. */
2799 if (NILP (c
) && current_kboard
!= orig_kboard
)
2802 return make_number (-2); /* wrong_kboard_jmpbuf */
2805 /* If this has become non-nil here, it has been set by a timer
2806 or sentinel or filter. */
2807 if (CONSP (Vunread_command_events
))
2809 c
= XCAR (Vunread_command_events
);
2810 Vunread_command_events
= XCDR (Vunread_command_events
);
2812 if (CONSP (c
) && EQ (XCAR (c
), Qt
))
2818 /* Read something from current KBOARD's side queue, if possible. */
2822 if (current_kboard
->kbd_queue_has_data
)
2824 if (!CONSP (KVAR (current_kboard
, kbd_queue
)))
2826 c
= XCAR (KVAR (current_kboard
, kbd_queue
));
2827 kset_kbd_queue (current_kboard
,
2828 XCDR (KVAR (current_kboard
, kbd_queue
)));
2829 if (NILP (KVAR (current_kboard
, kbd_queue
)))
2830 current_kboard
->kbd_queue_has_data
= 0;
2831 input_pending
= readable_events (0);
2832 if (EVENT_HAS_PARAMETERS (c
)
2833 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qswitch_frame
))
2834 internal_last_event_frame
= XCAR (XCDR (c
));
2835 Vlast_event_frame
= internal_last_event_frame
;
2839 /* If current_kboard's side queue is empty check the other kboards.
2840 If one of them has data that we have not yet seen here,
2841 switch to it and process the data waiting for it.
2843 Note: if the events queued up for another kboard
2844 have already been seen here, and therefore are not a complete command,
2845 the kbd_queue_has_data field is 0, so we skip that kboard here.
2846 That's to avoid an infinite loop switching between kboards here. */
2847 if (NILP (c
) && !single_kboard
)
2850 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
2851 if (kb
->kbd_queue_has_data
)
2853 current_kboard
= kb
;
2854 /* This is going to exit from read_char
2855 so we had better get rid of this frame's stuff. */
2857 return make_number (-2); /* wrong_kboard_jmpbuf */
2867 c
= read_decoded_event_from_main_queue (end_time
, local_getcjmp
,
2868 prev_event
, used_mouse_menu
);
2869 if (NILP (c
) && end_time
2870 && timespec_cmp (*end_time
, current_timespec ()) <= 0)
2875 if (EQ (c
, make_number (-2)))
2877 /* This is going to exit from read_char
2878 so we had better get rid of this frame's stuff. */
2892 if (commandflag
>= 0
2893 && !input_pending
&& !detect_input_pending_run_timers (0))
2899 /* Buffer switch events are only for internal wakeups
2900 so don't show them to the user.
2901 Also, don't record a key if we already did. */
2905 /* Process special events within read_char
2906 and loop around to read another event. */
2909 tem
= access_keymap (get_keymap (Vspecial_event_map
, 0, 1), c
, 0, 0, 1);
2914 struct buffer
*prev_buffer
= current_buffer
;
2915 last_input_event
= c
;
2916 call4 (Qcommand_execute
, tem
, Qnil
, Fvector (1, &last_input_event
), Qt
);
2918 if (CONSP (c
) && EQ (XCAR (c
), Qselect_window
) && !end_time
)
2919 /* We stopped being idle for this event; undo that. This
2920 prevents automatic window selection (under
2921 mouse_autoselect_window from acting as a real input event, for
2922 example banishing the mouse under mouse-avoidance-mode. */
2923 timer_resume_idle ();
2925 if (current_buffer
!= prev_buffer
)
2927 /* The command may have changed the keymaps. Pretend there
2928 is input in another keyboard and return. This will
2929 recalculate keymaps. */
2930 c
= make_number (-2);
2937 /* Handle things that only apply to characters. */
2940 /* If kbd_buffer_get_event gave us an EOF, return that. */
2944 if ((STRINGP (KVAR (current_kboard
, Vkeyboard_translate_table
))
2945 && UNSIGNED_CMP (XFASTINT (c
), <,
2946 SCHARS (KVAR (current_kboard
,
2947 Vkeyboard_translate_table
))))
2948 || (VECTORP (KVAR (current_kboard
, Vkeyboard_translate_table
))
2949 && UNSIGNED_CMP (XFASTINT (c
), <,
2950 ASIZE (KVAR (current_kboard
,
2951 Vkeyboard_translate_table
))))
2952 || (CHAR_TABLE_P (KVAR (current_kboard
, Vkeyboard_translate_table
))
2956 d
= Faref (KVAR (current_kboard
, Vkeyboard_translate_table
), c
);
2957 /* nil in keyboard-translate-table means no translation. */
2963 /* If this event is a mouse click in the menu bar,
2964 return just menu-bar for now. Modify the mouse click event
2965 so we won't do this twice, then queue it up. */
2966 if (EVENT_HAS_PARAMETERS (c
)
2968 && CONSP (EVENT_START (c
))
2969 && CONSP (XCDR (EVENT_START (c
))))
2973 posn
= POSN_POSN (EVENT_START (c
));
2974 /* Handle menu-bar events:
2975 insert the dummy prefix event `menu-bar'. */
2976 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
2978 /* Change menu-bar to (menu-bar) as the event "position". */
2979 POSN_SET_POSN (EVENT_START (c
), list1 (posn
));
2982 Vunread_command_events
= Fcons (c
, Vunread_command_events
);
2987 /* Store these characters into recent_keys, the dribble file if any,
2988 and the keyboard macro being defined, if any. */
2990 if (! NILP (also_record
))
2991 record_char (also_record
);
2993 /* Wipe the echo area.
2994 But first, if we are about to use an input method,
2995 save the echo area contents for it to refer to. */
2997 && ! NILP (Vinput_method_function
)
2998 && ' ' <= XINT (c
) && XINT (c
) < 256 && XINT (c
) != 127)
3000 previous_echo_area_message
= Fcurrent_message ();
3001 Vinput_method_previous_message
= previous_echo_area_message
;
3004 /* Now wipe the echo area, except for help events which do their
3005 own stuff with the echo area. */
3007 || (!(EQ (Qhelp_echo
, XCAR (c
)))
3008 && !(EQ (Qswitch_frame
, XCAR (c
)))
3009 /* Don't wipe echo area for select window events: These might
3010 get delayed via `mouse-autoselect-window' (Bug#11304). */
3011 && !(EQ (Qselect_window
, XCAR (c
)))))
3013 if (!NILP (echo_area_buffer
[0]))
3015 safe_run_hooks (Qecho_area_clear_hook
);
3016 clear_message (1, 0);
3020 reread_for_input_method
:
3022 /* Pass this to the input method, if appropriate. */
3024 && ! NILP (Vinput_method_function
)
3025 /* Don't run the input method within a key sequence,
3026 after the first event of the key sequence. */
3027 && NILP (prev_event
)
3028 && ' ' <= XINT (c
) && XINT (c
) < 256 && XINT (c
) != 127)
3031 ptrdiff_t key_count
;
3032 bool key_count_reset
;
3033 struct gcpro gcpro1
;
3034 ptrdiff_t count
= SPECPDL_INDEX ();
3036 /* Save the echo status. */
3037 bool saved_immediate_echo
= current_kboard
->immediate_echo
;
3038 struct kboard
*saved_ok_to_echo
= ok_to_echo_at_next_pause
;
3039 Lisp_Object saved_echo_string
= KVAR (current_kboard
, echo_string
);
3040 ptrdiff_t saved_echo_after_prompt
= current_kboard
->echo_after_prompt
;
3043 if (before_command_restore_flag
)
3045 this_command_key_count
= before_command_key_count_1
;
3046 if (this_command_key_count
< this_single_command_key_start
)
3047 this_single_command_key_start
= this_command_key_count
;
3048 echo_truncate (before_command_echo_length_1
);
3049 before_command_restore_flag
= 0;
3053 /* Save the this_command_keys status. */
3054 key_count
= this_command_key_count
;
3055 key_count_reset
= this_command_key_count_reset
;
3058 keys
= Fcopy_sequence (this_command_keys
);
3063 /* Clear out this_command_keys. */
3064 this_command_key_count
= 0;
3065 this_command_key_count_reset
= 0;
3067 /* Now wipe the echo area. */
3068 if (!NILP (echo_area_buffer
[0]))
3069 safe_run_hooks (Qecho_area_clear_hook
);
3070 clear_message (1, 0);
3073 /* If we are not reading a key sequence,
3074 never use the echo area. */
3077 specbind (Qinput_method_use_echo_area
, Qt
);
3080 /* Call the input method. */
3081 tem
= call1 (Vinput_method_function
, c
);
3083 tem
= unbind_to (count
, tem
);
3085 /* Restore the saved echoing state
3086 and this_command_keys state. */
3087 this_command_key_count
= key_count
;
3088 this_command_key_count_reset
= key_count_reset
;
3090 this_command_keys
= keys
;
3093 ok_to_echo_at_next_pause
= saved_ok_to_echo
;
3094 kset_echo_string (current_kboard
, saved_echo_string
);
3095 current_kboard
->echo_after_prompt
= saved_echo_after_prompt
;
3096 if (saved_immediate_echo
)
3101 /* The input method can return no events. */
3104 /* Bring back the previous message, if any. */
3105 if (! NILP (previous_echo_area_message
))
3106 message_with_string ("%s", previous_echo_area_message
, 0);
3109 /* It returned one event or more. */
3111 Vunread_post_input_method_events
3112 = nconc2 (XCDR (tem
), Vunread_post_input_method_events
);
3117 /* Display help if not echoing. */
3118 if (CONSP (c
) && EQ (XCAR (c
), Qhelp_echo
))
3120 /* (help-echo FRAME HELP WINDOW OBJECT POS). */
3121 Lisp_Object help
, object
, position
, window
, htem
;
3123 htem
= Fcdr (XCDR (c
));
3126 window
= Fcar (htem
);
3128 object
= Fcar (htem
);
3130 position
= Fcar (htem
);
3132 show_help_echo (help
, window
, object
, position
);
3134 /* We stopped being idle for this event; undo that. */
3136 timer_resume_idle ();
3140 if ((! reread
|| this_command_key_count
== 0
3141 || this_command_key_count_reset
)
3145 /* Don't echo mouse motion events. */
3146 if (echo_keystrokes_p ()
3147 && ! (EVENT_HAS_PARAMETERS (c
)
3148 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
3151 if (! NILP (also_record
))
3152 echo_char (also_record
);
3153 /* Once we reread a character, echoing can happen
3154 the next time we pause to read a new one. */
3155 ok_to_echo_at_next_pause
= current_kboard
;
3158 /* Record this character as part of the current key. */
3159 add_command_key (c
);
3160 if (! NILP (also_record
))
3161 add_command_key (also_record
);
3164 last_input_event
= c
;
3167 /* Process the help character specially if enabled. */
3168 if (!NILP (Vhelp_form
) && help_char_p (c
))
3170 ptrdiff_t count
= SPECPDL_INDEX ();
3172 help_form_saved_window_configs
3173 = Fcons (Fcurrent_window_configuration (Qnil
),
3174 help_form_saved_window_configs
);
3175 record_unwind_protect_void (read_char_help_form_unwind
);
3176 call0 (Qhelp_form_show
);
3181 c
= read_char (0, Qnil
, Qnil
, 0, NULL
);
3182 if (EVENT_HAS_PARAMETERS (c
)
3183 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_click
))
3184 XSETCAR (help_form_saved_window_configs
, Qnil
);
3186 while (BUFFERP (c
));
3187 /* Remove the help from the frame. */
3188 unbind_to (count
, Qnil
);
3191 if (EQ (c
, make_number (040)))
3195 c
= read_char (0, Qnil
, Qnil
, 0, NULL
);
3196 while (BUFFERP (c
));
3202 input_was_pending
= input_pending
;
3206 /* Record a key that came from a mouse menu.
3207 Record it for echoing, for this-command-keys, and so on. */
3210 record_menu_key (Lisp_Object c
)
3212 /* Wipe the echo area. */
3213 clear_message (1, 0);
3218 before_command_key_count
= this_command_key_count
;
3219 before_command_echo_length
= echo_length ();
3222 /* Don't echo mouse motion events. */
3223 if (echo_keystrokes_p ())
3227 /* Once we reread a character, echoing can happen
3228 the next time we pause to read a new one. */
3229 ok_to_echo_at_next_pause
= 0;
3232 /* Record this character as part of the current key. */
3233 add_command_key (c
);
3235 /* Re-reading in the middle of a command. */
3236 last_input_event
= c
;
3240 /* Return true if should recognize C as "the help character". */
3243 help_char_p (Lisp_Object c
)
3247 if (EQ (c
, Vhelp_char
))
3249 for (tail
= Vhelp_event_list
; CONSP (tail
); tail
= XCDR (tail
))
3250 if (EQ (c
, XCAR (tail
)))
3255 /* Record the input event C in various ways. */
3258 record_char (Lisp_Object c
)
3262 if (CONSP (c
) && (EQ (XCAR (c
), Qhelp_echo
) || EQ (XCAR (c
), Qmouse_movement
)))
3264 /* To avoid filling recent_keys with help-echo and mouse-movement
3265 events, we filter out repeated help-echo events, only store the
3266 first and last in a series of mouse-movement events, and don't
3267 store repeated help-echo events which are only separated by
3268 mouse-movement events. */
3270 Lisp_Object ev1
, ev2
, ev3
;
3273 if ((ix1
= recent_keys_index
- 1) < 0)
3274 ix1
= NUM_RECENT_KEYS
- 1;
3275 ev1
= AREF (recent_keys
, ix1
);
3277 if ((ix2
= ix1
- 1) < 0)
3278 ix2
= NUM_RECENT_KEYS
- 1;
3279 ev2
= AREF (recent_keys
, ix2
);
3281 if ((ix3
= ix2
- 1) < 0)
3282 ix3
= NUM_RECENT_KEYS
- 1;
3283 ev3
= AREF (recent_keys
, ix3
);
3285 if (EQ (XCAR (c
), Qhelp_echo
))
3287 /* Don't record `help-echo' in recent_keys unless it shows some help
3288 message, and a different help than the previously recorded
3290 Lisp_Object help
, last_help
;
3292 help
= Fcar_safe (Fcdr_safe (XCDR (c
)));
3293 if (!STRINGP (help
))
3295 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qhelp_echo
)
3296 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev1
))), EQ (last_help
, help
)))
3298 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3299 && CONSP (ev2
) && EQ (XCAR (ev2
), Qhelp_echo
)
3300 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev2
))), EQ (last_help
, help
)))
3302 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3303 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3304 && CONSP (ev3
) && EQ (XCAR (ev3
), Qhelp_echo
)
3305 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev3
))), EQ (last_help
, help
)))
3308 else if (EQ (XCAR (c
), Qmouse_movement
))
3310 /* Only record one pair of `mouse-movement' on a window in recent_keys.
3311 So additional mouse movement events replace the last element. */
3312 Lisp_Object last_window
, window
;
3314 window
= Fcar_safe (Fcar_safe (XCDR (c
)));
3315 if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3316 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev1
))), EQ (last_window
, window
))
3317 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3318 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev2
))), EQ (last_window
, window
)))
3320 ASET (recent_keys
, ix1
, c
);
3326 store_kbd_macro_char (c
);
3330 total_keys
+= total_keys
< NUM_RECENT_KEYS
;
3331 ASET (recent_keys
, recent_keys_index
, c
);
3332 if (++recent_keys_index
>= NUM_RECENT_KEYS
)
3333 recent_keys_index
= 0;
3335 else if (recorded
< 0)
3337 /* We need to remove one or two events from recent_keys.
3338 To do this, we simply put nil at those events and move the
3339 recent_keys_index backwards over those events. Usually,
3340 users will never see those nil events, as they will be
3341 overwritten by the command keys entered to see recent_keys
3344 while (recorded
++ < 0 && total_keys
> 0)
3346 if (total_keys
< NUM_RECENT_KEYS
)
3348 if (--recent_keys_index
< 0)
3349 recent_keys_index
= NUM_RECENT_KEYS
- 1;
3350 ASET (recent_keys
, recent_keys_index
, Qnil
);
3354 num_nonmacro_input_events
++;
3356 /* Write c to the dribble file. If c is a lispy event, write
3357 the event's symbol to the dribble file, in <brackets>. Bleaugh.
3358 If you, dear reader, have a better idea, you've got the source. :-) */
3364 if (XUINT (c
) < 0x100)
3365 putc (XUINT (c
), dribble
);
3367 fprintf (dribble
, " 0x%"pI
"x", XUINT (c
));
3371 Lisp_Object dribblee
;
3373 /* If it's a structured event, take the event header. */
3374 dribblee
= EVENT_HEAD (c
);
3376 if (SYMBOLP (dribblee
))
3378 putc ('<', dribble
);
3379 fwrite (SDATA (SYMBOL_NAME (dribblee
)), sizeof (char),
3380 SBYTES (SYMBOL_NAME (dribblee
)),
3382 putc ('>', dribble
);
3391 /* Copy out or in the info on where C-g should throw to.
3392 This is used when running Lisp code from within get_char,
3393 in case get_char is called recursively.
3394 See read_process_output. */
3397 save_getcjmp (sys_jmp_buf temp
)
3399 memcpy (temp
, getcjmp
, sizeof getcjmp
);
3403 restore_getcjmp (sys_jmp_buf temp
)
3405 memcpy (getcjmp
, temp
, sizeof getcjmp
);
3408 /* Low level keyboard/mouse input.
3409 kbd_buffer_store_event places events in kbd_buffer, and
3410 kbd_buffer_get_event retrieves them. */
3412 /* Return true if there are any events in the queue that read-char
3413 would return. If this returns false, a read-char would block. */
3415 readable_events (int flags
)
3417 if (flags
& READABLE_EVENTS_DO_TIMERS_NOW
)
3420 /* If the buffer contains only FOCUS_IN_EVENT events, and
3421 READABLE_EVENTS_FILTER_EVENTS is set, report it as empty. */
3422 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3424 if (flags
& (READABLE_EVENTS_FILTER_EVENTS
3425 #ifdef USE_TOOLKIT_SCROLL_BARS
3426 | READABLE_EVENTS_IGNORE_SQUEEZABLES
3430 struct input_event
*event
;
3432 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
3439 #ifdef USE_TOOLKIT_SCROLL_BARS
3440 (flags
& READABLE_EVENTS_FILTER_EVENTS
) &&
3442 event
->kind
== FOCUS_IN_EVENT
)
3443 #ifdef USE_TOOLKIT_SCROLL_BARS
3444 && !((flags
& READABLE_EVENTS_IGNORE_SQUEEZABLES
)
3445 && (event
->kind
== SCROLL_BAR_CLICK_EVENT
3446 || event
->kind
== HORIZONTAL_SCROLL_BAR_CLICK_EVENT
)
3447 && event
->part
== scroll_bar_handle
3448 && event
->modifiers
== 0)
3450 && !((flags
& READABLE_EVENTS_FILTER_EVENTS
)
3451 && event
->kind
== BUFFER_SWITCH_EVENT
))
3454 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3457 while (event
!= kbd_store_ptr
);
3463 if (!(flags
& READABLE_EVENTS_IGNORE_SQUEEZABLES
)
3464 && !NILP (do_mouse_tracking
) && some_mouse_moved ())
3468 if (current_kboard
->kbd_queue_has_data
)
3474 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
3475 if (kb
->kbd_queue_has_data
)
3481 /* Set this for debugging, to have a way to get out */
3482 int stop_character EXTERNALLY_VISIBLE
;
3485 event_to_kboard (struct input_event
*event
)
3487 /* Not applicable for these special events. */
3488 if (event
->kind
== SELECTION_REQUEST_EVENT
3489 || event
->kind
== SELECTION_CLEAR_EVENT
)
3493 Lisp_Object obj
= event
->frame_or_window
;
3494 /* There are some events that set this field to nil or string. */
3496 obj
= WINDOW_FRAME (XWINDOW (obj
));
3497 /* Also ignore dead frames here. */
3498 return ((FRAMEP (obj
) && FRAME_LIVE_P (XFRAME (obj
)))
3499 ? FRAME_KBOARD (XFRAME (obj
)) : NULL
);
3504 /* Return the number of slots occupied in kbd_buffer. */
3507 kbd_buffer_nr_stored (void)
3509 return kbd_fetch_ptr
== kbd_store_ptr
3511 : (kbd_fetch_ptr
< kbd_store_ptr
3512 ? kbd_store_ptr
- kbd_fetch_ptr
3513 : ((kbd_buffer
+ KBD_BUFFER_SIZE
) - kbd_fetch_ptr
3514 + (kbd_store_ptr
- kbd_buffer
)));
3516 #endif /* Store an event obtained at interrupt level into kbd_buffer, fifo */
3519 kbd_buffer_store_event (register struct input_event
*event
)
3521 kbd_buffer_store_event_hold (event
, 0);
3524 /* Store EVENT obtained at interrupt level into kbd_buffer, fifo.
3526 If HOLD_QUIT is 0, just stuff EVENT into the fifo.
3527 Else, if HOLD_QUIT.kind != NO_EVENT, discard EVENT.
3528 Else, if EVENT is a quit event, store the quit event
3529 in HOLD_QUIT, and return (thus ignoring further events).
3531 This is used to postpone the processing of the quit event until all
3532 subsequent input events have been parsed (and discarded). */
3535 kbd_buffer_store_event_hold (register struct input_event
*event
,
3536 struct input_event
*hold_quit
)
3538 if (event
->kind
== NO_EVENT
)
3541 if (hold_quit
&& hold_quit
->kind
!= NO_EVENT
)
3544 if (event
->kind
== ASCII_KEYSTROKE_EVENT
)
3546 register int c
= event
->code
& 0377;
3548 if (event
->modifiers
& ctrl_modifier
)
3549 c
= make_ctrl_char (c
);
3551 c
|= (event
->modifiers
3552 & (meta_modifier
| alt_modifier
3553 | hyper_modifier
| super_modifier
));
3557 KBOARD
*kb
= FRAME_KBOARD (XFRAME (event
->frame_or_window
));
3558 struct input_event
*sp
;
3560 if (single_kboard
&& kb
!= current_kboard
)
3563 (kb
, list2 (make_lispy_switch_frame (event
->frame_or_window
),
3565 kb
->kbd_queue_has_data
= 1;
3566 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3568 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3571 if (event_to_kboard (sp
) == kb
)
3573 sp
->kind
= NO_EVENT
;
3574 sp
->frame_or_window
= Qnil
;
3583 *hold_quit
= *event
;
3587 /* If this results in a quit_char being returned to Emacs as
3588 input, set Vlast_event_frame properly. If this doesn't
3589 get returned to Emacs as an event, the next event read
3590 will set Vlast_event_frame again, so this is safe to do. */
3594 focus
= FRAME_FOCUS_FRAME (XFRAME (event
->frame_or_window
));
3596 focus
= event
->frame_or_window
;
3597 internal_last_event_frame
= focus
;
3598 Vlast_event_frame
= focus
;
3601 handle_interrupt (0);
3605 if (c
&& c
== stop_character
)
3611 /* Don't insert two BUFFER_SWITCH_EVENT's in a row.
3612 Just ignore the second one. */
3613 else if (event
->kind
== BUFFER_SWITCH_EVENT
3614 && kbd_fetch_ptr
!= kbd_store_ptr
3615 && ((kbd_store_ptr
== kbd_buffer
3616 ? kbd_buffer
+ KBD_BUFFER_SIZE
- 1
3617 : kbd_store_ptr
- 1)->kind
) == BUFFER_SWITCH_EVENT
)
3620 if (kbd_store_ptr
- kbd_buffer
== KBD_BUFFER_SIZE
)
3621 kbd_store_ptr
= kbd_buffer
;
3623 /* Don't let the very last slot in the buffer become full,
3624 since that would make the two pointers equal,
3625 and that is indistinguishable from an empty buffer.
3626 Discard the event if it would fill the last slot. */
3627 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
3629 *kbd_store_ptr
= *event
;
3632 if (kbd_buffer_nr_stored () > KBD_BUFFER_SIZE
/ 2
3633 && ! kbd_on_hold_p ())
3635 /* Don't read keyboard input until we have processed kbd_buffer.
3636 This happens when pasting text longer than KBD_BUFFER_SIZE/2. */
3637 hold_keyboard_input ();
3638 if (!noninteractive
)
3642 #endif /* subprocesses */
3645 /* If we're inside while-no-input, and this event qualifies
3646 as input, set quit-flag to cause an interrupt. */
3647 if (!NILP (Vthrow_on_input
)
3648 && event
->kind
!= FOCUS_IN_EVENT
3649 && event
->kind
!= HELP_EVENT
3650 && event
->kind
!= DEICONIFY_EVENT
)
3652 Vquit_flag
= Vthrow_on_input
;
3653 /* If we're inside a function that wants immediate quits,
3655 if (immediate_quit
&& NILP (Vinhibit_quit
))
3664 /* Put an input event back in the head of the event queue. */
3667 kbd_buffer_unget_event (register struct input_event
*event
)
3669 if (kbd_fetch_ptr
== kbd_buffer
)
3670 kbd_fetch_ptr
= kbd_buffer
+ KBD_BUFFER_SIZE
;
3672 /* Don't let the very last slot in the buffer become full, */
3673 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
3676 *kbd_fetch_ptr
= *event
;
3680 /* Limit help event positions to this range, to avoid overflow problems. */
3681 #define INPUT_EVENT_POS_MAX \
3682 ((ptrdiff_t) min (PTRDIFF_MAX, min (TYPE_MAXIMUM (Time) / 2, \
3683 MOST_POSITIVE_FIXNUM)))
3684 #define INPUT_EVENT_POS_MIN (-1 - INPUT_EVENT_POS_MAX)
3686 /* Return a Time that encodes position POS. POS must be in range. */
3689 position_to_Time (ptrdiff_t pos
)
3691 eassert (INPUT_EVENT_POS_MIN
<= pos
&& pos
<= INPUT_EVENT_POS_MAX
);
3695 /* Return the position that ENCODED_POS encodes.
3696 Avoid signed integer overflow. */
3699 Time_to_position (Time encoded_pos
)
3701 if (encoded_pos
<= INPUT_EVENT_POS_MAX
)
3703 Time encoded_pos_min
= INPUT_EVENT_POS_MIN
;
3704 eassert (encoded_pos_min
<= encoded_pos
);
3705 ptrdiff_t notpos
= -1 - encoded_pos
;
3709 /* Generate a HELP_EVENT input_event and store it in the keyboard
3712 HELP is the help form.
3714 FRAME and WINDOW are the frame and window where the help is
3715 generated. OBJECT is the Lisp object where the help was found (a
3716 buffer, a string, an overlay, or nil if neither from a string nor
3717 from a buffer). POS is the position within OBJECT where the help
3721 gen_help_event (Lisp_Object help
, Lisp_Object frame
, Lisp_Object window
,
3722 Lisp_Object object
, ptrdiff_t pos
)
3724 struct input_event event
;
3726 event
.kind
= HELP_EVENT
;
3727 event
.frame_or_window
= frame
;
3729 event
.x
= WINDOWP (window
) ? window
: frame
;
3731 event
.timestamp
= position_to_Time (pos
);
3732 kbd_buffer_store_event (&event
);
3736 /* Store HELP_EVENTs for HELP on FRAME in the input queue. */
3739 kbd_buffer_store_help_event (Lisp_Object frame
, Lisp_Object help
)
3741 struct input_event event
;
3743 event
.kind
= HELP_EVENT
;
3744 event
.frame_or_window
= frame
;
3748 event
.timestamp
= 0;
3749 kbd_buffer_store_event (&event
);
3753 /* Discard any mouse events in the event buffer by setting them to
3756 discard_mouse_events (void)
3758 struct input_event
*sp
;
3759 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3761 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3764 if (sp
->kind
== MOUSE_CLICK_EVENT
3765 || sp
->kind
== WHEEL_EVENT
3766 || sp
->kind
== HORIZ_WHEEL_EVENT
3768 || sp
->kind
== GPM_CLICK_EVENT
3770 || sp
->kind
== SCROLL_BAR_CLICK_EVENT
3771 || sp
->kind
== HORIZONTAL_SCROLL_BAR_CLICK_EVENT
)
3773 sp
->kind
= NO_EVENT
;
3779 /* Return true if there are any real events waiting in the event
3780 buffer, not counting `NO_EVENT's.
3782 Discard NO_EVENT events at the front of the input queue, possibly
3783 leaving the input queue empty if there are no real input events. */
3786 kbd_buffer_events_waiting (void)
3788 struct input_event
*sp
;
3790 for (sp
= kbd_fetch_ptr
;
3791 sp
!= kbd_store_ptr
&& sp
->kind
== NO_EVENT
;
3794 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3799 return sp
!= kbd_store_ptr
&& sp
->kind
!= NO_EVENT
;
3803 /* Clear input event EVENT. */
3806 clear_event (struct input_event
*event
)
3808 event
->kind
= NO_EVENT
;
3812 /* Read one event from the event buffer, waiting if necessary.
3813 The value is a Lisp object representing the event.
3814 The value is nil for an event that should be ignored,
3815 or that was handled here.
3816 We always read and discard one event. */
3819 kbd_buffer_get_event (KBOARD
**kbp
,
3820 bool *used_mouse_menu
,
3821 struct timespec
*end_time
)
3826 if (kbd_on_hold_p () && kbd_buffer_nr_stored () < KBD_BUFFER_SIZE
/ 4)
3828 /* Start reading input again because we have processed enough to
3829 be able to accept new events again. */
3830 unhold_keyboard_input ();
3833 #endif /* subprocesses */
3835 #if !defined HAVE_DBUS && !defined USE_FILE_NOTIFY
3837 /* In case we are running as a daemon, only do this before
3838 detaching from the terminal. */
3839 || (IS_DAEMON
&& daemon_pipe
[1] >= 0))
3843 *kbp
= current_kboard
;
3846 #endif /* !defined HAVE_DBUS && !defined USE_FILE_NOTIFY */
3848 /* Wait until there is input available. */
3851 /* Break loop if there's an unread command event. Needed in
3852 moused window autoselection which uses a timer to insert such
3854 if (CONSP (Vunread_command_events
))
3857 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3859 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3862 /* If the quit flag is set, then read_char will return
3863 quit_char, so that counts as "available input." */
3864 if (!NILP (Vquit_flag
))
3865 quit_throw_to_read_char (0);
3867 /* One way or another, wait until input is available; then, if
3868 interrupt handlers have not read it, read it now. */
3873 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3875 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3879 struct timespec now
= current_timespec ();
3880 if (timespec_cmp (*end_time
, now
) <= 0)
3881 return Qnil
; /* Finished waiting. */
3884 struct timespec duration
= timespec_sub (*end_time
, now
);
3885 wait_reading_process_output (min (duration
.tv_sec
,
3888 -1, 1, Qnil
, NULL
, 0);
3893 bool do_display
= true;
3895 if (FRAME_TERMCAP_P (SELECTED_FRAME ()))
3897 struct tty_display_info
*tty
= CURTTY ();
3899 /* When this TTY is displaying a menu, we must prevent
3900 any redisplay, because we modify the frame's glyph
3901 matrix behind the back of the display engine. */
3902 if (tty
->showing_menu
)
3906 wait_reading_process_output (0, 0, -1, do_display
, Qnil
, NULL
, 0);
3909 if (!interrupt_input
&& kbd_fetch_ptr
== kbd_store_ptr
)
3913 if (CONSP (Vunread_command_events
))
3916 first
= XCAR (Vunread_command_events
);
3917 Vunread_command_events
= XCDR (Vunread_command_events
);
3918 *kbp
= current_kboard
;
3922 /* At this point, we know that there is a readable event available
3923 somewhere. If the event queue is empty, then there must be a
3924 mouse movement enabled and available. */
3925 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3927 struct input_event
*event
;
3929 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
3933 *kbp
= event_to_kboard (event
);
3935 *kbp
= current_kboard
; /* Better than returning null ptr? */
3939 /* These two kinds of events get special handling
3940 and don't actually appear to the command loop.
3941 We return nil for them. */
3942 if (event
->kind
== SELECTION_REQUEST_EVENT
3943 || event
->kind
== SELECTION_CLEAR_EVENT
)
3946 struct input_event copy
;
3948 /* Remove it from the buffer before processing it,
3949 since otherwise swallow_events will see it
3950 and process it again. */
3952 kbd_fetch_ptr
= event
+ 1;
3953 input_pending
= readable_events (0);
3954 x_handle_selection_event (©
);
3956 /* We're getting selection request events, but we don't have
3962 #if defined (HAVE_NS)
3963 else if (event
->kind
== NS_TEXT_EVENT
)
3965 if (event
->code
== KEY_NS_PUT_WORKING_TEXT
)
3966 obj
= list1 (intern ("ns-put-working-text"));
3968 obj
= list1 (intern ("ns-unput-working-text"));
3969 kbd_fetch_ptr
= event
+ 1;
3970 if (used_mouse_menu
)
3971 *used_mouse_menu
= 1;
3975 #if defined (HAVE_X11) || defined (HAVE_NTGUI) \
3976 || defined (HAVE_NS)
3977 else if (event
->kind
== DELETE_WINDOW_EVENT
)
3979 /* Make an event (delete-frame (FRAME)). */
3980 obj
= list2 (Qdelete_frame
, list1 (event
->frame_or_window
));
3981 kbd_fetch_ptr
= event
+ 1;
3984 #if defined (HAVE_X11) || defined (HAVE_NTGUI) \
3985 || defined (HAVE_NS)
3986 else if (event
->kind
== ICONIFY_EVENT
)
3988 /* Make an event (iconify-frame (FRAME)). */
3989 obj
= list2 (Qiconify_frame
, list1 (event
->frame_or_window
));
3990 kbd_fetch_ptr
= event
+ 1;
3992 else if (event
->kind
== DEICONIFY_EVENT
)
3994 /* Make an event (make-frame-visible (FRAME)). */
3995 obj
= list2 (Qmake_frame_visible
, list1 (event
->frame_or_window
));
3996 kbd_fetch_ptr
= event
+ 1;
3999 else if (event
->kind
== BUFFER_SWITCH_EVENT
)
4001 /* The value doesn't matter here; only the type is tested. */
4002 XSETBUFFER (obj
, current_buffer
);
4003 kbd_fetch_ptr
= event
+ 1;
4005 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
4006 || defined (HAVE_NS) || defined (USE_GTK)
4007 else if (event
->kind
== MENU_BAR_ACTIVATE_EVENT
)
4009 kbd_fetch_ptr
= event
+ 1;
4010 input_pending
= readable_events (0);
4011 if (FRAME_LIVE_P (XFRAME (event
->frame_or_window
)))
4012 x_activate_menubar (XFRAME (event
->frame_or_window
));
4016 else if (event
->kind
== LANGUAGE_CHANGE_EVENT
)
4018 /* Make an event (language-change FRAME CODEPAGE LANGUAGE-ID). */
4019 obj
= list4 (Qlanguage_change
,
4020 event
->frame_or_window
,
4021 make_number (event
->code
),
4022 make_number (event
->modifiers
));
4023 kbd_fetch_ptr
= event
+ 1;
4026 #ifdef USE_FILE_NOTIFY
4027 else if (event
->kind
== FILE_NOTIFY_EVENT
)
4029 #ifdef HAVE_W32NOTIFY
4030 /* Make an event (file-notify (DESCRIPTOR ACTION FILE) CALLBACK). */
4031 obj
= list3 (Qfile_notify
, event
->arg
, event
->frame_or_window
);
4033 obj
= make_lispy_event (event
);
4035 kbd_fetch_ptr
= event
+ 1;
4037 #endif /* USE_FILE_NOTIFY */
4038 else if (event
->kind
== SAVE_SESSION_EVENT
)
4040 obj
= list2 (Qsave_session
, event
->arg
);
4041 kbd_fetch_ptr
= event
+ 1;
4043 /* Just discard these, by returning nil.
4044 With MULTI_KBOARD, these events are used as placeholders
4045 when we need to randomly delete events from the queue.
4046 (They shouldn't otherwise be found in the buffer,
4047 but on some machines it appears they do show up
4048 even without MULTI_KBOARD.) */
4049 /* On Windows NT/9X, NO_EVENT is used to delete extraneous
4050 mouse events during a popup-menu call. */
4051 else if (event
->kind
== NO_EVENT
)
4052 kbd_fetch_ptr
= event
+ 1;
4053 else if (event
->kind
== HELP_EVENT
)
4055 Lisp_Object object
, position
, help
, frame
, window
;
4057 frame
= event
->frame_or_window
;
4058 object
= event
->arg
;
4059 position
= make_number (Time_to_position (event
->timestamp
));
4062 clear_event (event
);
4064 kbd_fetch_ptr
= event
+ 1;
4065 if (!WINDOWP (window
))
4067 obj
= Fcons (Qhelp_echo
,
4068 list5 (frame
, help
, window
, object
, position
));
4070 else if (event
->kind
== FOCUS_IN_EVENT
)
4072 /* Notification of a FocusIn event. The frame receiving the
4073 focus is in event->frame_or_window. Generate a
4074 switch-frame event if necessary. */
4075 Lisp_Object frame
, focus
;
4077 frame
= event
->frame_or_window
;
4078 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
4087 !EQ (frame
, internal_last_event_frame
)
4088 && !EQ (frame
, selected_frame
))
4089 obj
= make_lispy_switch_frame (frame
);
4091 obj
= make_lispy_focus_in (frame
);
4093 internal_last_event_frame
= frame
;
4094 kbd_fetch_ptr
= event
+ 1;
4096 else if (event
->kind
== FOCUS_OUT_EVENT
)
4098 #ifdef HAVE_WINDOW_SYSTEM
4101 Lisp_Object frame
= event
->frame_or_window
;
4102 bool focused
= false;
4104 for (di
= x_display_list
; di
&& ! focused
; di
= di
->next
)
4105 focused
= di
->x_highlight_frame
!= 0;
4108 obj
= make_lispy_focus_out (frame
);
4110 #endif /* HAVE_WINDOW_SYSTEM */
4112 kbd_fetch_ptr
= event
+ 1;
4115 else if (event
->kind
== DBUS_EVENT
)
4117 obj
= make_lispy_event (event
);
4118 kbd_fetch_ptr
= event
+ 1;
4121 else if (event
->kind
== CONFIG_CHANGED_EVENT
)
4123 obj
= make_lispy_event (event
);
4124 kbd_fetch_ptr
= event
+ 1;
4128 /* If this event is on a different frame, return a switch-frame this
4129 time, and leave the event in the queue for next time. */
4133 frame
= event
->frame_or_window
;
4135 frame
= XCAR (frame
);
4136 else if (WINDOWP (frame
))
4137 frame
= WINDOW_FRAME (XWINDOW (frame
));
4139 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
4143 if (! EQ (frame
, internal_last_event_frame
)
4144 && !EQ (frame
, selected_frame
))
4145 obj
= make_lispy_switch_frame (frame
);
4146 internal_last_event_frame
= frame
;
4148 /* If we didn't decide to make a switch-frame event, go ahead
4149 and build a real event from the queue entry. */
4153 obj
= make_lispy_event (event
);
4155 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
4156 || defined (HAVE_NS) || defined (USE_GTK)
4157 /* If this was a menu selection, then set the flag to inhibit
4158 writing to last_nonmenu_event. Don't do this if the event
4159 we're returning is (menu-bar), though; that indicates the
4160 beginning of the menu sequence, and we might as well leave
4161 that as the `event with parameters' for this selection. */
4163 && !EQ (event
->frame_or_window
, event
->arg
)
4164 && (event
->kind
== MENU_BAR_EVENT
4165 || event
->kind
== TOOL_BAR_EVENT
))
4166 *used_mouse_menu
= 1;
4169 /* Certain system events are non-key events. */
4171 && event
->kind
== NS_NONKEY_EVENT
)
4172 *used_mouse_menu
= 1;
4175 /* Wipe out this event, to catch bugs. */
4176 clear_event (event
);
4177 kbd_fetch_ptr
= event
+ 1;
4181 /* Try generating a mouse motion event. */
4182 else if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
4184 struct frame
*f
= some_mouse_moved ();
4185 Lisp_Object bar_window
;
4186 enum scroll_bar_part part
;
4190 *kbp
= current_kboard
;
4191 /* Note that this uses F to determine which terminal to look at.
4192 If there is no valid info, it does not store anything
4193 so x remains nil. */
4196 /* XXX Can f or mouse_position_hook be NULL here? */
4197 if (f
&& FRAME_TERMINAL (f
)->mouse_position_hook
)
4198 (*FRAME_TERMINAL (f
)->mouse_position_hook
) (&f
, 0, &bar_window
,
4203 /* Decide if we should generate a switch-frame event. Don't
4204 generate switch-frame events for motion outside of all Emacs
4210 frame
= FRAME_FOCUS_FRAME (f
);
4212 XSETFRAME (frame
, f
);
4214 if (! EQ (frame
, internal_last_event_frame
)
4215 && !EQ (frame
, selected_frame
))
4216 obj
= make_lispy_switch_frame (frame
);
4217 internal_last_event_frame
= frame
;
4220 /* If we didn't decide to make a switch-frame event, go ahead and
4221 return a mouse-motion event. */
4222 if (!NILP (x
) && NILP (obj
))
4223 obj
= make_lispy_movement (f
, bar_window
, part
, x
, y
, t
);
4226 /* We were promised by the above while loop that there was
4227 something for us to read! */
4230 input_pending
= readable_events (0);
4232 Vlast_event_frame
= internal_last_event_frame
;
4237 /* Process any non-user-visible events (currently X selection events),
4238 without reading any user-visible events. */
4241 process_special_events (void)
4243 struct input_event
*event
;
4245 for (event
= kbd_fetch_ptr
; event
!= kbd_store_ptr
; ++event
)
4247 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
4250 if (event
== kbd_store_ptr
)
4254 /* If we find a stored X selection request, handle it now. */
4255 if (event
->kind
== SELECTION_REQUEST_EVENT
4256 || event
->kind
== SELECTION_CLEAR_EVENT
)
4260 /* Remove the event from the fifo buffer before processing;
4261 otherwise swallow_events called recursively could see it
4262 and process it again. To do this, we move the events
4263 between kbd_fetch_ptr and EVENT one slot to the right,
4266 struct input_event copy
= *event
;
4267 struct input_event
*beg
4268 = (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
4269 ? kbd_buffer
: kbd_fetch_ptr
;
4272 memmove (beg
+ 1, beg
, (event
- beg
) * sizeof (struct input_event
));
4273 else if (event
< beg
)
4275 if (event
> kbd_buffer
)
4276 memmove (kbd_buffer
+ 1, kbd_buffer
,
4277 (event
- kbd_buffer
) * sizeof (struct input_event
));
4278 *kbd_buffer
= *(kbd_buffer
+ KBD_BUFFER_SIZE
- 1);
4279 if (beg
< kbd_buffer
+ KBD_BUFFER_SIZE
- 1)
4280 memmove (beg
+ 1, beg
,
4281 (kbd_buffer
+ KBD_BUFFER_SIZE
- 1 - beg
)
4282 * sizeof (struct input_event
));
4285 if (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
4286 kbd_fetch_ptr
= kbd_buffer
+ 1;
4290 input_pending
= readable_events (0);
4291 x_handle_selection_event (©
);
4293 /* We're getting selection request events, but we don't have
4301 /* Process any events that are not user-visible, run timer events that
4302 are ripe, and return, without reading any user-visible events. */
4305 swallow_events (bool do_display
)
4307 unsigned old_timers_run
;
4309 process_special_events ();
4311 old_timers_run
= timers_run
;
4312 get_input_pending (READABLE_EVENTS_DO_TIMERS_NOW
);
4314 if (!input_pending
&& timers_run
!= old_timers_run
&& do_display
)
4315 redisplay_preserve_echo_area (7);
4318 /* Record the start of when Emacs is idle,
4319 for the sake of running idle-time timers. */
4322 timer_start_idle (void)
4324 /* If we are already in the idle state, do nothing. */
4325 if (timespec_valid_p (timer_idleness_start_time
))
4328 timer_idleness_start_time
= current_timespec ();
4329 timer_last_idleness_start_time
= timer_idleness_start_time
;
4331 /* Mark all idle-time timers as once again candidates for running. */
4332 call0 (intern ("internal-timer-start-idle"));
4335 /* Record that Emacs is no longer idle, so stop running idle-time timers. */
4338 timer_stop_idle (void)
4340 timer_idleness_start_time
= invalid_timespec ();
4343 /* Resume idle timer from last idle start time. */
4346 timer_resume_idle (void)
4348 if (timespec_valid_p (timer_idleness_start_time
))
4351 timer_idleness_start_time
= timer_last_idleness_start_time
;
4354 /* This is only for debugging. */
4355 struct input_event last_timer_event EXTERNALLY_VISIBLE
;
4357 /* List of elisp functions to call, delayed because they were generated in
4358 a context where Elisp could not be safely run (e.g. redisplay, signal,
4359 ...). Each element has the form (FUN . ARGS). */
4360 Lisp_Object pending_funcalls
;
4362 /* Return true if TIMER is a valid timer, placing its value into *RESULT. */
4364 decode_timer (Lisp_Object timer
, struct timespec
*result
)
4366 Lisp_Object
*vector
;
4368 if (! (VECTORP (timer
) && ASIZE (timer
) == 9))
4370 vector
= XVECTOR (timer
)->contents
;
4371 if (! NILP (vector
[0]))
4373 if (! INTEGERP (vector
[2]))
4377 if (! decode_time_components (vector
[1], vector
[2], vector
[3], vector
[8],
4380 *result
= lisp_to_timespec (t
);
4381 return timespec_valid_p (*result
);
4385 /* Check whether a timer has fired. To prevent larger problems we simply
4386 disregard elements that are not proper timers. Do not make a circular
4387 timer list for the time being.
4389 Returns the time to wait until the next timer fires. If a
4390 timer is triggering now, return zero.
4391 If no timer is active, return -1.
4393 If a timer is ripe, we run it, with quitting turned off.
4394 In that case we return 0 to indicate that a new timer_check_2 call
4397 static struct timespec
4398 timer_check_2 (Lisp_Object timers
, Lisp_Object idle_timers
)
4400 struct timespec nexttime
;
4401 struct timespec now
;
4402 struct timespec idleness_now
;
4403 Lisp_Object chosen_timer
;
4404 struct gcpro gcpro1
;
4406 nexttime
= invalid_timespec ();
4408 chosen_timer
= Qnil
;
4409 GCPRO1 (chosen_timer
);
4411 /* First run the code that was delayed. */
4412 while (CONSP (pending_funcalls
))
4414 Lisp_Object funcall
= XCAR (pending_funcalls
);
4415 pending_funcalls
= XCDR (pending_funcalls
);
4416 safe_call2 (Qapply
, XCAR (funcall
), XCDR (funcall
));
4419 if (CONSP (timers
) || CONSP (idle_timers
))
4421 now
= current_timespec ();
4422 idleness_now
= (timespec_valid_p (timer_idleness_start_time
)
4423 ? timespec_sub (now
, timer_idleness_start_time
)
4424 : make_timespec (0, 0));
4427 while (CONSP (timers
) || CONSP (idle_timers
))
4429 Lisp_Object timer
= Qnil
, idle_timer
= Qnil
;
4430 struct timespec timer_time
, idle_timer_time
;
4431 struct timespec difference
;
4432 struct timespec timer_difference
= invalid_timespec ();
4433 struct timespec idle_timer_difference
= invalid_timespec ();
4434 bool ripe
, timer_ripe
= 0, idle_timer_ripe
= 0;
4436 /* Set TIMER and TIMER_DIFFERENCE
4437 based on the next ordinary timer.
4438 TIMER_DIFFERENCE is the distance in time from NOW to when
4439 this timer becomes ripe (negative if it's already ripe).
4440 Skip past invalid timers and timers already handled. */
4443 timer
= XCAR (timers
);
4444 if (! decode_timer (timer
, &timer_time
))
4446 timers
= XCDR (timers
);
4450 timer_ripe
= timespec_cmp (timer_time
, now
) <= 0;
4451 timer_difference
= (timer_ripe
4452 ? timespec_sub (now
, timer_time
)
4453 : timespec_sub (timer_time
, now
));
4456 /* Likewise for IDLE_TIMER and IDLE_TIMER_DIFFERENCE
4457 based on the next idle timer. */
4458 if (CONSP (idle_timers
))
4460 idle_timer
= XCAR (idle_timers
);
4461 if (! decode_timer (idle_timer
, &idle_timer_time
))
4463 idle_timers
= XCDR (idle_timers
);
4467 idle_timer_ripe
= timespec_cmp (idle_timer_time
, idleness_now
) <= 0;
4468 idle_timer_difference
4470 ? timespec_sub (idleness_now
, idle_timer_time
)
4471 : timespec_sub (idle_timer_time
, idleness_now
));
4474 /* Decide which timer is the next timer,
4475 and set CHOSEN_TIMER, DIFFERENCE, and RIPE accordingly.
4476 Also step down the list where we found that timer. */
4478 if (timespec_valid_p (timer_difference
)
4479 && (! timespec_valid_p (idle_timer_difference
)
4480 || idle_timer_ripe
< timer_ripe
4481 || (idle_timer_ripe
== timer_ripe
4483 ? timespec_cmp (idle_timer_difference
,
4485 : timespec_cmp (timer_difference
,
4486 idle_timer_difference
))
4489 chosen_timer
= timer
;
4490 timers
= XCDR (timers
);
4491 difference
= timer_difference
;
4496 chosen_timer
= idle_timer
;
4497 idle_timers
= XCDR (idle_timers
);
4498 difference
= idle_timer_difference
;
4499 ripe
= idle_timer_ripe
;
4502 /* If timer is ripe, run it if it hasn't been run. */
4505 if (NILP (AREF (chosen_timer
, 0)))
4507 ptrdiff_t count
= SPECPDL_INDEX ();
4508 Lisp_Object old_deactivate_mark
= Vdeactivate_mark
;
4510 /* Mark the timer as triggered to prevent problems if the lisp
4511 code fails to reschedule it right. */
4512 ASET (chosen_timer
, 0, Qt
);
4514 specbind (Qinhibit_quit
, Qt
);
4516 call1 (Qtimer_event_handler
, chosen_timer
);
4517 Vdeactivate_mark
= old_deactivate_mark
;
4519 unbind_to (count
, Qnil
);
4521 /* Since we have handled the event,
4522 we don't need to tell the caller to wake up and do it. */
4523 /* But the caller must still wait for the next timer, so
4524 return 0 to indicate that. */
4527 nexttime
= make_timespec (0, 0);
4531 /* When we encounter a timer that is still waiting,
4532 return the amount of time to wait before it is ripe. */
4539 /* No timers are pending in the future. */
4540 /* Return 0 if we generated an event, and -1 if not. */
4546 /* Check whether a timer has fired. To prevent larger problems we simply
4547 disregard elements that are not proper timers. Do not make a circular
4548 timer list for the time being.
4550 Returns the time to wait until the next timer fires.
4551 If no timer is active, return an invalid value.
4553 As long as any timer is ripe, we run it. */
4558 struct timespec nexttime
;
4559 Lisp_Object timers
, idle_timers
;
4560 struct gcpro gcpro1
, gcpro2
;
4562 Lisp_Object tem
= Vinhibit_quit
;
4565 /* We use copies of the timers' lists to allow a timer to add itself
4566 again, without locking up Emacs if the newly added timer is
4567 already ripe when added. */
4569 /* Always consider the ordinary timers. */
4570 timers
= Fcopy_sequence (Vtimer_list
);
4571 /* Consider the idle timers only if Emacs is idle. */
4572 if (timespec_valid_p (timer_idleness_start_time
))
4573 idle_timers
= Fcopy_sequence (Vtimer_idle_list
);
4577 Vinhibit_quit
= tem
;
4579 GCPRO2 (timers
, idle_timers
);
4583 nexttime
= timer_check_2 (timers
, idle_timers
);
4585 while (nexttime
.tv_sec
== 0 && nexttime
.tv_nsec
== 0);
4591 DEFUN ("current-idle-time", Fcurrent_idle_time
, Scurrent_idle_time
, 0, 0, 0,
4592 doc
: /* Return the current length of Emacs idleness, or nil.
4593 The value when Emacs is idle is a list of four integers (HIGH LOW USEC PSEC)
4594 in the same style as (current-time).
4596 The value when Emacs is not idle is nil.
4598 PSEC is a multiple of the system clock resolution. */)
4601 if (timespec_valid_p (timer_idleness_start_time
))
4602 return make_lisp_time (timespec_sub (current_timespec (),
4603 timer_idleness_start_time
));
4608 /* Caches for modify_event_symbol. */
4609 static Lisp_Object accent_key_syms
;
4610 static Lisp_Object func_key_syms
;
4611 static Lisp_Object mouse_syms
;
4612 static Lisp_Object wheel_syms
;
4613 static Lisp_Object drag_n_drop_syms
;
4615 /* This is a list of keysym codes for special "accent" characters.
4616 It parallels lispy_accent_keys. */
4618 static const int lispy_accent_codes
[] =
4620 #ifdef XK_dead_circumflex
4625 #ifdef XK_dead_grave
4630 #ifdef XK_dead_tilde
4635 #ifdef XK_dead_diaeresis
4640 #ifdef XK_dead_macron
4645 #ifdef XK_dead_degree
4650 #ifdef XK_dead_acute
4655 #ifdef XK_dead_cedilla
4660 #ifdef XK_dead_breve
4665 #ifdef XK_dead_ogonek
4670 #ifdef XK_dead_caron
4675 #ifdef XK_dead_doubleacute
4676 XK_dead_doubleacute
,
4680 #ifdef XK_dead_abovedot
4685 #ifdef XK_dead_abovering
4695 #ifdef XK_dead_belowdot
4700 #ifdef XK_dead_voiced_sound
4701 XK_dead_voiced_sound
,
4705 #ifdef XK_dead_semivoiced_sound
4706 XK_dead_semivoiced_sound
,
4722 /* This is a list of Lisp names for special "accent" characters.
4723 It parallels lispy_accent_codes. */
4725 static const char *const lispy_accent_keys
[] =
4743 "dead-voiced-sound",
4744 "dead-semivoiced-sound",
4750 #define FUNCTION_KEY_OFFSET 0x0
4752 const char *const lispy_function_keys
[] =
4756 0, /* VK_LBUTTON 0x01 */
4757 0, /* VK_RBUTTON 0x02 */
4758 "cancel", /* VK_CANCEL 0x03 */
4759 0, /* VK_MBUTTON 0x04 */
4761 0, 0, 0, /* 0x05 .. 0x07 */
4763 "backspace", /* VK_BACK 0x08 */
4764 "tab", /* VK_TAB 0x09 */
4766 0, 0, /* 0x0A .. 0x0B */
4768 "clear", /* VK_CLEAR 0x0C */
4769 "return", /* VK_RETURN 0x0D */
4771 0, 0, /* 0x0E .. 0x0F */
4773 0, /* VK_SHIFT 0x10 */
4774 0, /* VK_CONTROL 0x11 */
4775 0, /* VK_MENU 0x12 */
4776 "pause", /* VK_PAUSE 0x13 */
4777 "capslock", /* VK_CAPITAL 0x14 */
4778 "kana", /* VK_KANA/VK_HANGUL 0x15 */
4780 "junja", /* VK_JUNJA 0x17 */
4781 "final", /* VK_FINAL 0x18 */
4782 "kanji", /* VK_KANJI/VK_HANJA 0x19 */
4784 "escape", /* VK_ESCAPE 0x1B */
4785 "convert", /* VK_CONVERT 0x1C */
4786 "non-convert", /* VK_NONCONVERT 0x1D */
4787 "accept", /* VK_ACCEPT 0x1E */
4788 "mode-change", /* VK_MODECHANGE 0x1F */
4789 0, /* VK_SPACE 0x20 */
4790 "prior", /* VK_PRIOR 0x21 */
4791 "next", /* VK_NEXT 0x22 */
4792 "end", /* VK_END 0x23 */
4793 "home", /* VK_HOME 0x24 */
4794 "left", /* VK_LEFT 0x25 */
4795 "up", /* VK_UP 0x26 */
4796 "right", /* VK_RIGHT 0x27 */
4797 "down", /* VK_DOWN 0x28 */
4798 "select", /* VK_SELECT 0x29 */
4799 "print", /* VK_PRINT 0x2A */
4800 "execute", /* VK_EXECUTE 0x2B */
4801 "snapshot", /* VK_SNAPSHOT 0x2C */
4802 "insert", /* VK_INSERT 0x2D */
4803 "delete", /* VK_DELETE 0x2E */
4804 "help", /* VK_HELP 0x2F */
4806 /* VK_0 thru VK_9 are the same as ASCII '0' thru '9' (0x30 - 0x39) */
4808 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4810 0, 0, 0, 0, 0, 0, 0, /* 0x3A .. 0x40 */
4812 /* VK_A thru VK_Z are the same as ASCII 'A' thru 'Z' (0x41 - 0x5A) */
4814 0, 0, 0, 0, 0, 0, 0, 0, 0,
4815 0, 0, 0, 0, 0, 0, 0, 0, 0,
4816 0, 0, 0, 0, 0, 0, 0, 0,
4818 "lwindow", /* VK_LWIN 0x5B */
4819 "rwindow", /* VK_RWIN 0x5C */
4820 "apps", /* VK_APPS 0x5D */
4823 "kp-0", /* VK_NUMPAD0 0x60 */
4824 "kp-1", /* VK_NUMPAD1 0x61 */
4825 "kp-2", /* VK_NUMPAD2 0x62 */
4826 "kp-3", /* VK_NUMPAD3 0x63 */
4827 "kp-4", /* VK_NUMPAD4 0x64 */
4828 "kp-5", /* VK_NUMPAD5 0x65 */
4829 "kp-6", /* VK_NUMPAD6 0x66 */
4830 "kp-7", /* VK_NUMPAD7 0x67 */
4831 "kp-8", /* VK_NUMPAD8 0x68 */
4832 "kp-9", /* VK_NUMPAD9 0x69 */
4833 "kp-multiply", /* VK_MULTIPLY 0x6A */
4834 "kp-add", /* VK_ADD 0x6B */
4835 "kp-separator", /* VK_SEPARATOR 0x6C */
4836 "kp-subtract", /* VK_SUBTRACT 0x6D */
4837 "kp-decimal", /* VK_DECIMAL 0x6E */
4838 "kp-divide", /* VK_DIVIDE 0x6F */
4839 "f1", /* VK_F1 0x70 */
4840 "f2", /* VK_F2 0x71 */
4841 "f3", /* VK_F3 0x72 */
4842 "f4", /* VK_F4 0x73 */
4843 "f5", /* VK_F5 0x74 */
4844 "f6", /* VK_F6 0x75 */
4845 "f7", /* VK_F7 0x76 */
4846 "f8", /* VK_F8 0x77 */
4847 "f9", /* VK_F9 0x78 */
4848 "f10", /* VK_F10 0x79 */
4849 "f11", /* VK_F11 0x7A */
4850 "f12", /* VK_F12 0x7B */
4851 "f13", /* VK_F13 0x7C */
4852 "f14", /* VK_F14 0x7D */
4853 "f15", /* VK_F15 0x7E */
4854 "f16", /* VK_F16 0x7F */
4855 "f17", /* VK_F17 0x80 */
4856 "f18", /* VK_F18 0x81 */
4857 "f19", /* VK_F19 0x82 */
4858 "f20", /* VK_F20 0x83 */
4859 "f21", /* VK_F21 0x84 */
4860 "f22", /* VK_F22 0x85 */
4861 "f23", /* VK_F23 0x86 */
4862 "f24", /* VK_F24 0x87 */
4864 0, 0, 0, 0, /* 0x88 .. 0x8B */
4865 0, 0, 0, 0, /* 0x8C .. 0x8F */
4867 "kp-numlock", /* VK_NUMLOCK 0x90 */
4868 "scroll", /* VK_SCROLL 0x91 */
4869 /* Not sure where the following block comes from.
4870 Windows headers have NEC and Fujitsu specific keys in
4871 this block, but nothing generic. */
4872 "kp-space", /* VK_NUMPAD_CLEAR 0x92 */
4873 "kp-enter", /* VK_NUMPAD_ENTER 0x93 */
4874 "kp-prior", /* VK_NUMPAD_PRIOR 0x94 */
4875 "kp-next", /* VK_NUMPAD_NEXT 0x95 */
4876 "kp-end", /* VK_NUMPAD_END 0x96 */
4877 "kp-home", /* VK_NUMPAD_HOME 0x97 */
4878 "kp-left", /* VK_NUMPAD_LEFT 0x98 */
4879 "kp-up", /* VK_NUMPAD_UP 0x99 */
4880 "kp-right", /* VK_NUMPAD_RIGHT 0x9A */
4881 "kp-down", /* VK_NUMPAD_DOWN 0x9B */
4882 "kp-insert", /* VK_NUMPAD_INSERT 0x9C */
4883 "kp-delete", /* VK_NUMPAD_DELETE 0x9D */
4885 0, 0, /* 0x9E .. 0x9F */
4888 * VK_L* & VK_R* - left and right Alt, Ctrl and Shift virtual keys.
4889 * Used only as parameters to GetAsyncKeyState and GetKeyState.
4890 * No other API or message will distinguish left and right keys this way.
4895 /* Multimedia keys. These are handled as WM_APPCOMMAND, which allows us
4896 to enable them selectively, and gives access to a few more functions.
4897 See lispy_multimedia_keys below. */
4898 0, 0, 0, 0, 0, 0, 0, /* 0xA6 .. 0xAC Browser */
4899 0, 0, 0, /* 0xAD .. 0xAF Volume */
4900 0, 0, 0, 0, /* 0xB0 .. 0xB3 Media */
4901 0, 0, 0, 0, /* 0xB4 .. 0xB7 Apps */
4903 /* 0xB8 .. 0xC0 "OEM" keys - all seem to be punctuation. */
4904 0, 0, 0, 0, 0, 0, 0, 0, 0,
4906 /* 0xC1 - 0xDA unallocated, 0xDB-0xDF more OEM keys */
4907 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4908 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4911 "ax", /* VK_OEM_AX 0xE1 */
4912 0, /* VK_OEM_102 0xE2 */
4913 "ico-help", /* VK_ICO_HELP 0xE3 */
4914 "ico-00", /* VK_ICO_00 0xE4 */
4915 0, /* VK_PROCESSKEY 0xE5 - used by IME */
4916 "ico-clear", /* VK_ICO_CLEAR 0xE6 */
4917 0, /* VK_PACKET 0xE7 - used to pass Unicode chars */
4919 "reset", /* VK_OEM_RESET 0xE9 */
4920 "jump", /* VK_OEM_JUMP 0xEA */
4921 "oem-pa1", /* VK_OEM_PA1 0xEB */
4922 "oem-pa2", /* VK_OEM_PA2 0xEC */
4923 "oem-pa3", /* VK_OEM_PA3 0xED */
4924 "wsctrl", /* VK_OEM_WSCTRL 0xEE */
4925 "cusel", /* VK_OEM_CUSEL 0xEF */
4926 "oem-attn", /* VK_OEM_ATTN 0xF0 */
4927 "finish", /* VK_OEM_FINISH 0xF1 */
4928 "copy", /* VK_OEM_COPY 0xF2 */
4929 "auto", /* VK_OEM_AUTO 0xF3 */
4930 "enlw", /* VK_OEM_ENLW 0xF4 */
4931 "backtab", /* VK_OEM_BACKTAB 0xF5 */
4932 "attn", /* VK_ATTN 0xF6 */
4933 "crsel", /* VK_CRSEL 0xF7 */
4934 "exsel", /* VK_EXSEL 0xF8 */
4935 "ereof", /* VK_EREOF 0xF9 */
4936 "play", /* VK_PLAY 0xFA */
4937 "zoom", /* VK_ZOOM 0xFB */
4938 "noname", /* VK_NONAME 0xFC */
4939 "pa1", /* VK_PA1 0xFD */
4940 "oem_clear", /* VK_OEM_CLEAR 0xFE */
4944 /* Some of these duplicate the "Media keys" on newer keyboards,
4945 but they are delivered to the application in a different way. */
4946 static const char *const lispy_multimedia_keys
[] =
4954 "browser-favorites",
4991 "toggle-dictate-command",
4997 "media-fast-forward",
5000 "media-channel-down"
5003 #else /* not HAVE_NTGUI */
5005 /* This should be dealt with in XTread_socket now, and that doesn't
5006 depend on the client system having the Kana syms defined. See also
5007 the XK_kana_A case below. */
5010 static const char *const lispy_kana_keys
[] =
5012 /* X Keysym value */
5013 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x400 .. 0x40f */
5014 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x410 .. 0x41f */
5015 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x420 .. 0x42f */
5016 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x430 .. 0x43f */
5017 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x440 .. 0x44f */
5018 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x450 .. 0x45f */
5019 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x460 .. 0x46f */
5020 0,0,0,0,0,0,0,0,0,0,0,0,0,0,"overline",0,
5021 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x480 .. 0x48f */
5022 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x490 .. 0x49f */
5023 0, "kana-fullstop", "kana-openingbracket", "kana-closingbracket",
5024 "kana-comma", "kana-conjunctive", "kana-WO", "kana-a",
5025 "kana-i", "kana-u", "kana-e", "kana-o",
5026 "kana-ya", "kana-yu", "kana-yo", "kana-tsu",
5027 "prolongedsound", "kana-A", "kana-I", "kana-U",
5028 "kana-E", "kana-O", "kana-KA", "kana-KI",
5029 "kana-KU", "kana-KE", "kana-KO", "kana-SA",
5030 "kana-SHI", "kana-SU", "kana-SE", "kana-SO",
5031 "kana-TA", "kana-CHI", "kana-TSU", "kana-TE",
5032 "kana-TO", "kana-NA", "kana-NI", "kana-NU",
5033 "kana-NE", "kana-NO", "kana-HA", "kana-HI",
5034 "kana-FU", "kana-HE", "kana-HO", "kana-MA",
5035 "kana-MI", "kana-MU", "kana-ME", "kana-MO",
5036 "kana-YA", "kana-YU", "kana-YO", "kana-RA",
5037 "kana-RI", "kana-RU", "kana-RE", "kana-RO",
5038 "kana-WA", "kana-N", "voicedsound", "semivoicedsound",
5039 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4e0 .. 0x4ef */
5040 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4f0 .. 0x4ff */
5042 #endif /* XK_kana_A */
5045 #define FUNCTION_KEY_OFFSET 0xff00
5047 /* You'll notice that this table is arranged to be conveniently
5048 indexed by X Windows keysym values. */
5049 static const char *const lispy_function_keys
[] =
5051 /* X Keysym value */
5053 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff00...0f */
5054 "backspace", "tab", "linefeed", "clear",
5056 0, 0, 0, "pause", /* 0xff10...1f */
5057 0, 0, 0, 0, 0, 0, 0, "escape",
5059 0, "kanji", "muhenkan", "henkan", /* 0xff20...2f */
5060 "romaji", "hiragana", "katakana", "hiragana-katakana",
5061 "zenkaku", "hankaku", "zenkaku-hankaku", "touroku",
5062 "massyo", "kana-lock", "kana-shift", "eisu-shift",
5063 "eisu-toggle", /* 0xff30...3f */
5064 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
5065 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff40...4f */
5067 "home", "left", "up", "right", /* 0xff50 */ /* IsCursorKey */
5068 "down", "prior", "next", "end",
5069 "begin", 0, 0, 0, 0, 0, 0, 0,
5070 "select", /* 0xff60 */ /* IsMiscFunctionKey */
5081 "break", /* 0xff6b */
5084 0, 0, 0, 0, "backtab", 0, 0, 0, /* 0xff70... */
5085 0, 0, 0, 0, 0, 0, 0, "kp-numlock", /* 0xff78... */
5086 "kp-space", /* 0xff80 */ /* IsKeypadKey */
5087 0, 0, 0, 0, 0, 0, 0, 0,
5088 "kp-tab", /* 0xff89 */
5090 "kp-enter", /* 0xff8d */
5092 "kp-f1", /* 0xff91 */
5096 "kp-home", /* 0xff95 */
5101 "kp-prior", /* kp-page-up */
5102 "kp-next", /* kp-page-down */
5108 0, 0, 0, 0, 0, 0, 0, 0, 0,
5109 "kp-multiply", /* 0xffaa */
5114 "kp-divide", /* 0xffaf */
5115 "kp-0", /* 0xffb0 */
5116 "kp-1", "kp-2", "kp-3", "kp-4", "kp-5", "kp-6", "kp-7", "kp-8", "kp-9",
5119 "kp-equal", /* 0xffbd */
5120 "f1", /* 0xffbe */ /* IsFunctionKey */
5122 "f3", "f4", "f5", "f6", "f7", "f8", "f9", "f10", /* 0xffc0 */
5123 "f11", "f12", "f13", "f14", "f15", "f16", "f17", "f18",
5124 "f19", "f20", "f21", "f22", "f23", "f24", "f25", "f26", /* 0xffd0 */
5125 "f27", "f28", "f29", "f30", "f31", "f32", "f33", "f34",
5126 "f35", 0, 0, 0, 0, 0, 0, 0, /* 0xffe0 */
5127 0, 0, 0, 0, 0, 0, 0, 0,
5128 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfff0 */
5129 0, 0, 0, 0, 0, 0, 0, "delete"
5132 /* ISO 9995 Function and Modifier Keys; the first byte is 0xFE. */
5133 #define ISO_FUNCTION_KEY_OFFSET 0xfe00
5135 static const char *const iso_lispy_function_keys
[] =
5137 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe00 */
5138 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe08 */
5139 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe10 */
5140 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe18 */
5141 "iso-lefttab", /* 0xfe20 */
5142 "iso-move-line-up", "iso-move-line-down",
5143 "iso-partial-line-up", "iso-partial-line-down",
5144 "iso-partial-space-left", "iso-partial-space-right",
5145 "iso-set-margin-left", "iso-set-margin-right", /* 0xffe27, 28 */
5146 "iso-release-margin-left", "iso-release-margin-right",
5147 "iso-release-both-margins",
5148 "iso-fast-cursor-left", "iso-fast-cursor-right",
5149 "iso-fast-cursor-up", "iso-fast-cursor-down",
5150 "iso-continuous-underline", "iso-discontinuous-underline", /* 0xfe30, 31 */
5151 "iso-emphasize", "iso-center-object", "iso-enter", /* ... 0xfe34 */
5154 #endif /* not HAVE_NTGUI */
5156 static Lisp_Object Vlispy_mouse_stem
;
5158 static const char *const lispy_wheel_names
[] =
5160 "wheel-up", "wheel-down", "wheel-left", "wheel-right"
5163 /* drag-n-drop events are generated when a set of selected files are
5164 dragged from another application and dropped onto an Emacs window. */
5165 static const char *const lispy_drag_n_drop_names
[] =
5170 /* An array of symbol indexes of scroll bar parts, indexed by an enum
5171 scroll_bar_part value. Note that Qnil corresponds to
5172 scroll_bar_nowhere and should not appear in Lisp events. */
5173 static short const scroll_bar_parts
[] = {
5174 SYMBOL_INDEX (Qnil
), SYMBOL_INDEX (Qabove_handle
), SYMBOL_INDEX (Qhandle
),
5175 SYMBOL_INDEX (Qbelow_handle
), SYMBOL_INDEX (Qup
), SYMBOL_INDEX (Qdown
),
5176 SYMBOL_INDEX (Qtop
), SYMBOL_INDEX (Qbottom
), SYMBOL_INDEX (Qend_scroll
),
5177 SYMBOL_INDEX (Qratio
), SYMBOL_INDEX (Qbefore_handle
),
5178 SYMBOL_INDEX (Qhorizontal_handle
), SYMBOL_INDEX (Qafter_handle
),
5179 SYMBOL_INDEX (Qleft
), SYMBOL_INDEX (Qright
), SYMBOL_INDEX (Qleftmost
),
5180 SYMBOL_INDEX (Qrightmost
), SYMBOL_INDEX (Qend_scroll
), SYMBOL_INDEX (Qratio
)
5183 /* A vector, indexed by button number, giving the down-going location
5184 of currently depressed buttons, both scroll bar and non-scroll bar.
5186 The elements have the form
5187 (BUTTON-NUMBER MODIFIER-MASK . REST)
5188 where REST is the cdr of a position as it would be reported in the event.
5190 The make_lispy_event function stores positions here to tell the
5191 difference between click and drag events, and to store the starting
5192 location to be included in drag events. */
5194 static Lisp_Object button_down_location
;
5196 /* Information about the most recent up-going button event: Which
5197 button, what location, and what time. */
5199 static int last_mouse_button
;
5200 static int last_mouse_x
;
5201 static int last_mouse_y
;
5202 static Time button_down_time
;
5204 /* The number of clicks in this multiple-click. */
5206 static int double_click_count
;
5208 /* X and Y are frame-relative coordinates for a click or wheel event.
5209 Return a Lisp-style event list. */
5212 make_lispy_position (struct frame
*f
, Lisp_Object x
, Lisp_Object y
,
5215 enum window_part part
;
5216 Lisp_Object posn
= Qnil
;
5217 Lisp_Object extra_info
= Qnil
;
5218 /* Coordinate pixel positions to return. */
5219 int xret
= 0, yret
= 0;
5220 /* The window under frame pixel coordinates (x,y) */
5221 Lisp_Object window
= f
5222 ? window_from_coordinates (f
, XINT (x
), XINT (y
), &part
, 0)
5225 if (WINDOWP (window
))
5227 /* It's a click in window WINDOW at frame coordinates (X,Y) */
5228 struct window
*w
= XWINDOW (window
);
5229 Lisp_Object string_info
= Qnil
;
5230 ptrdiff_t textpos
= 0;
5231 int col
= -1, row
= -1;
5232 int dx
= -1, dy
= -1;
5233 int width
= -1, height
= -1;
5234 Lisp_Object object
= Qnil
;
5236 /* Pixel coordinates relative to the window corner. */
5237 int wx
= XINT (x
) - WINDOW_LEFT_EDGE_X (w
);
5238 int wy
= XINT (y
) - WINDOW_TOP_EDGE_Y (w
);
5240 /* For text area clicks, return X, Y relative to the corner of
5241 this text area. Note that dX, dY etc are set below, by
5242 buffer_posn_from_coords. */
5243 if (part
== ON_TEXT
)
5245 xret
= XINT (x
) - window_box_left (w
, TEXT_AREA
);
5246 yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5248 /* For mode line and header line clicks, return X, Y relative to
5249 the left window edge. Use mode_line_string to look for a
5250 string on the click position. */
5251 else if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
)
5256 posn
= (part
== ON_MODE_LINE
) ? Qmode_line
: Qheader_line
;
5257 /* Note that mode_line_string takes COL, ROW as pixels and
5258 converts them to characters. */
5261 string
= mode_line_string (w
, part
, &col
, &row
, &charpos
,
5262 &object
, &dx
, &dy
, &width
, &height
);
5263 if (STRINGP (string
))
5264 string_info
= Fcons (string
, make_number (charpos
));
5270 /* For fringes and margins, Y is relative to the area's (and the
5271 window's) top edge, while X is meaningless. */
5272 else if (part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
5277 posn
= (part
== ON_LEFT_MARGIN
) ? Qleft_margin
: Qright_margin
;
5280 string
= marginal_area_string (w
, part
, &col
, &row
, &charpos
,
5281 &object
, &dx
, &dy
, &width
, &height
);
5282 if (STRINGP (string
))
5283 string_info
= Fcons (string
, make_number (charpos
));
5285 yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5287 else if (part
== ON_LEFT_FRINGE
)
5289 posn
= Qleft_fringe
;
5293 - (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5294 ? 0 : window_box_width (w
, LEFT_MARGIN_AREA
));
5295 dy
= yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5297 else if (part
== ON_RIGHT_FRINGE
)
5299 posn
= Qright_fringe
;
5303 - window_box_width (w
, LEFT_MARGIN_AREA
)
5304 - window_box_width (w
, TEXT_AREA
)
5305 - (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5306 ? window_box_width (w
, RIGHT_MARGIN_AREA
)
5308 dy
= yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5310 else if (part
== ON_VERTICAL_BORDER
)
5312 posn
= Qvertical_line
;
5318 else if (part
== ON_VERTICAL_SCROLL_BAR
)
5320 posn
= Qvertical_scroll_bar
;
5321 width
= WINDOW_SCROLL_BAR_AREA_WIDTH (w
);
5325 else if (part
== ON_HORIZONTAL_SCROLL_BAR
)
5327 posn
= Qhorizontal_scroll_bar
;
5328 width
= WINDOW_SCROLL_BAR_AREA_HEIGHT (w
);
5332 else if (part
== ON_RIGHT_DIVIDER
)
5334 posn
= Qright_divider
;
5335 width
= WINDOW_RIGHT_DIVIDER_WIDTH (w
);
5339 else if (part
== ON_BOTTOM_DIVIDER
)
5341 posn
= Qbottom_divider
;
5342 width
= WINDOW_BOTTOM_DIVIDER_WIDTH (w
);
5347 /* For clicks in the text area, fringes, or margins, call
5348 buffer_posn_from_coords to extract TEXTPOS, the buffer
5349 position nearest to the click. */
5352 Lisp_Object string2
, object2
= Qnil
;
5353 struct display_pos p
;
5355 int width2
, height2
;
5356 /* The pixel X coordinate passed to buffer_posn_from_coords
5357 is the X coordinate relative to the text area for
5358 text-area and right-margin clicks, zero otherwise. */
5360 = (part
== ON_TEXT
) ? xret
5361 : (part
== ON_RIGHT_FRINGE
|| part
== ON_RIGHT_MARGIN
)
5362 ? (XINT (x
) - window_box_left (w
, TEXT_AREA
))
5366 string2
= buffer_posn_from_coords (w
, &x2
, &y2
, &p
,
5367 &object2
, &dx2
, &dy2
,
5369 textpos
= CHARPOS (p
.pos
);
5370 if (col
< 0) col
= x2
;
5371 if (row
< 0) row
= y2
;
5372 if (dx
< 0) dx
= dx2
;
5373 if (dy
< 0) dy
= dy2
;
5374 if (width
< 0) width
= width2
;
5375 if (height
< 0) height
= height2
;
5379 posn
= make_number (textpos
);
5380 if (STRINGP (string2
))
5381 string_info
= Fcons (string2
,
5382 make_number (CHARPOS (p
.string_pos
)));
5388 #ifdef HAVE_WINDOW_SYSTEM
5389 if (IMAGEP (object
))
5391 Lisp_Object image_map
, hotspot
;
5392 if ((image_map
= Fplist_get (XCDR (object
), QCmap
),
5394 && (hotspot
= find_hot_spot (image_map
, dx
, dy
),
5396 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
5397 posn
= XCAR (hotspot
);
5404 Fcons (make_number (dx
), make_number (dy
)),
5405 Fcons (make_number (width
), make_number (height
)));
5408 extra_info
= Fcons (string_info
,
5409 Fcons (textpos
< 0 ? Qnil
: make_number (textpos
),
5410 Fcons (Fcons (make_number (col
),
5416 /* Return mouse pixel coordinates here. */
5417 XSETFRAME (window
, f
);
5424 return Fcons (window
,
5426 Fcons (Fcons (make_number (xret
),
5427 make_number (yret
)),
5428 Fcons (make_number (t
),
5432 /* Return non-zero if F is a GUI frame that uses some toolkit-managed
5433 menu bar. This really means that Emacs draws and manages the menu
5434 bar as part of its normal display, and therefore can compute its
5437 toolkit_menubar_in_use (struct frame
*f
)
5439 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS) || defined (HAVE_NTGUI)
5440 return !(!FRAME_WINDOW_P (f
));
5446 /* Build the part of Lisp event which represents scroll bar state from
5447 EV. TYPE is one of Qvertical_scroll_bar or Qhorizontal_scroll_bar. */
5450 make_scroll_bar_position (struct input_event
*ev
, Lisp_Object type
)
5452 return list5 (ev
->frame_or_window
, type
, Fcons (ev
->x
, ev
->y
),
5453 make_number (ev
->timestamp
),
5454 builtin_lisp_symbol (scroll_bar_parts
[ev
->part
]));
5457 /* Given a struct input_event, build the lisp event which represents
5458 it. If EVENT is 0, build a mouse movement event from the mouse
5459 movement buffer, which should have a movement event in it.
5461 Note that events must be passed to this function in the order they
5462 are received; this function stores the location of button presses
5463 in order to build drag events when the button is released. */
5466 make_lispy_event (struct input_event
*event
)
5470 switch (event
->kind
)
5472 /* A simple keystroke. */
5473 case ASCII_KEYSTROKE_EVENT
:
5474 case MULTIBYTE_CHAR_KEYSTROKE_EVENT
:
5476 Lisp_Object lispy_c
;
5477 EMACS_INT c
= event
->code
;
5478 if (event
->kind
== ASCII_KEYSTROKE_EVENT
)
5481 eassert (c
== event
->code
);
5482 /* Turn ASCII characters into control characters
5484 if (event
->modifiers
& ctrl_modifier
)
5486 c
= make_ctrl_char (c
);
5487 event
->modifiers
&= ~ctrl_modifier
;
5491 /* Add in the other modifier bits. The shift key was taken care
5492 of by the X code. */
5493 c
|= (event
->modifiers
5494 & (meta_modifier
| alt_modifier
5495 | hyper_modifier
| super_modifier
| ctrl_modifier
));
5496 /* Distinguish Shift-SPC from SPC. */
5497 if ((event
->code
) == 040
5498 && event
->modifiers
& shift_modifier
)
5499 c
|= shift_modifier
;
5500 button_down_time
= 0;
5501 XSETFASTINT (lispy_c
, c
);
5506 /* NS_NONKEY_EVENTs are just like NON_ASCII_KEYSTROKE_EVENTs,
5507 except that they are non-key events (last-nonmenu-event is nil). */
5508 case NS_NONKEY_EVENT
:
5511 /* A function key. The symbol may need to have modifier prefixes
5513 case NON_ASCII_KEYSTROKE_EVENT
:
5514 button_down_time
= 0;
5516 for (i
= 0; i
< ARRAYELTS (lispy_accent_codes
); i
++)
5517 if (event
->code
== lispy_accent_codes
[i
])
5518 return modify_event_symbol (i
,
5520 Qfunction_key
, Qnil
,
5521 lispy_accent_keys
, &accent_key_syms
,
5522 ARRAYELTS (lispy_accent_keys
));
5526 if (event
->code
>= 0x400 && event
->code
< 0x500)
5527 return modify_event_symbol (event
->code
- 0x400,
5528 event
->modifiers
& ~shift_modifier
,
5529 Qfunction_key
, Qnil
,
5530 lispy_kana_keys
, &func_key_syms
,
5531 ARRAYELTS (lispy_kana_keys
));
5532 #endif /* XK_kana_A */
5535 #ifdef ISO_FUNCTION_KEY_OFFSET
5536 if (event
->code
< FUNCTION_KEY_OFFSET
5537 && event
->code
>= ISO_FUNCTION_KEY_OFFSET
)
5538 return modify_event_symbol (event
->code
- ISO_FUNCTION_KEY_OFFSET
,
5540 Qfunction_key
, Qnil
,
5541 iso_lispy_function_keys
, &func_key_syms
,
5542 ARRAYELTS (iso_lispy_function_keys
));
5545 if ((FUNCTION_KEY_OFFSET
<= event
->code
5547 < FUNCTION_KEY_OFFSET
+ ARRAYELTS (lispy_function_keys
)))
5548 && lispy_function_keys
[event
->code
- FUNCTION_KEY_OFFSET
])
5549 return modify_event_symbol (event
->code
- FUNCTION_KEY_OFFSET
,
5551 Qfunction_key
, Qnil
,
5552 lispy_function_keys
, &func_key_syms
,
5553 ARRAYELTS (lispy_function_keys
));
5555 /* Handle system-specific or unknown keysyms.
5556 We need to use an alist rather than a vector as the cache
5557 since we can't make a vector long enough. */
5558 if (NILP (KVAR (current_kboard
, system_key_syms
)))
5559 kset_system_key_syms (current_kboard
, Fcons (Qnil
, Qnil
));
5560 return modify_event_symbol (event
->code
,
5563 KVAR (current_kboard
, Vsystem_key_alist
),
5564 0, &KVAR (current_kboard
, system_key_syms
),
5568 case MULTIMEDIA_KEY_EVENT
:
5569 if (event
->code
< ARRAYELTS (lispy_multimedia_keys
)
5570 && event
->code
> 0 && lispy_multimedia_keys
[event
->code
])
5572 return modify_event_symbol (event
->code
, event
->modifiers
,
5573 Qfunction_key
, Qnil
,
5574 lispy_multimedia_keys
, &func_key_syms
,
5575 ARRAYELTS (lispy_multimedia_keys
));
5580 /* A mouse click. Figure out where it is, decide whether it's
5581 a press, click or drag, and build the appropriate structure. */
5582 case MOUSE_CLICK_EVENT
:
5584 case GPM_CLICK_EVENT
:
5586 #ifndef USE_TOOLKIT_SCROLL_BARS
5587 case SCROLL_BAR_CLICK_EVENT
:
5588 case HORIZONTAL_SCROLL_BAR_CLICK_EVENT
:
5591 int button
= event
->code
;
5593 Lisp_Object position
;
5594 Lisp_Object
*start_pos_ptr
;
5595 Lisp_Object start_pos
;
5599 /* Build the position as appropriate for this mouse click. */
5600 if (event
->kind
== MOUSE_CLICK_EVENT
5602 || event
->kind
== GPM_CLICK_EVENT
5606 struct frame
*f
= XFRAME (event
->frame_or_window
);
5609 /* Ignore mouse events that were made on frame that
5610 have been deleted. */
5611 if (! FRAME_LIVE_P (f
))
5614 /* EVENT->x and EVENT->y are frame-relative pixel
5615 coordinates at this place. Under old redisplay, COLUMN
5616 and ROW are set to frame relative glyph coordinates
5617 which are then used to determine whether this click is
5618 in a menu (non-toolkit version). */
5619 if (!toolkit_menubar_in_use (f
))
5621 pixel_to_glyph_coords (f
, XINT (event
->x
), XINT (event
->y
),
5622 &column
, &row
, NULL
, 1);
5624 /* In the non-toolkit version, clicks on the menu bar
5625 are ordinary button events in the event buffer.
5626 Distinguish them, and invoke the menu.
5628 (In the toolkit version, the toolkit handles the
5629 menu bar and Emacs doesn't know about it until
5630 after the user makes a selection.) */
5631 if (row
>= 0 && row
< FRAME_MENU_BAR_LINES (f
)
5632 && (event
->modifiers
& down_modifier
))
5634 Lisp_Object items
, item
;
5636 /* Find the menu bar item under `column'. */
5638 items
= FRAME_MENU_BAR_ITEMS (f
);
5639 for (i
= 0; i
< ASIZE (items
); i
+= 4)
5641 Lisp_Object pos
, string
;
5642 string
= AREF (items
, i
+ 1);
5643 pos
= AREF (items
, i
+ 3);
5646 if (column
>= XINT (pos
)
5647 && column
< XINT (pos
) + SCHARS (string
))
5649 item
= AREF (items
, i
);
5654 /* ELisp manual 2.4b says (x y) are window
5655 relative but code says they are
5657 position
= list4 (event
->frame_or_window
,
5659 Fcons (event
->x
, event
->y
),
5660 make_number (event
->timestamp
));
5662 return list2 (item
, position
);
5666 position
= make_lispy_position (f
, event
->x
, event
->y
,
5669 #ifndef USE_TOOLKIT_SCROLL_BARS
5671 /* It's a scrollbar click. */
5672 position
= make_scroll_bar_position (event
, Qvertical_scroll_bar
);
5673 #endif /* not USE_TOOLKIT_SCROLL_BARS */
5675 if (button
>= ASIZE (button_down_location
))
5677 ptrdiff_t incr
= button
- ASIZE (button_down_location
) + 1;
5678 button_down_location
= larger_vector (button_down_location
,
5680 mouse_syms
= larger_vector (mouse_syms
, incr
, -1);
5683 start_pos_ptr
= aref_addr (button_down_location
, button
);
5684 start_pos
= *start_pos_ptr
;
5685 *start_pos_ptr
= Qnil
;
5688 /* On window-system frames, use the value of
5689 double-click-fuzz as is. On other frames, interpret it
5690 as a multiple of 1/8 characters. */
5694 if (WINDOWP (event
->frame_or_window
))
5695 f
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5696 else if (FRAMEP (event
->frame_or_window
))
5697 f
= XFRAME (event
->frame_or_window
);
5701 if (FRAME_WINDOW_P (f
))
5702 fuzz
= double_click_fuzz
;
5704 fuzz
= double_click_fuzz
/ 8;
5706 is_double
= (button
== last_mouse_button
5707 && (eabs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5708 && (eabs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5709 && button_down_time
!= 0
5710 && (EQ (Vdouble_click_time
, Qt
)
5711 || (NATNUMP (Vdouble_click_time
)
5712 && (event
->timestamp
- button_down_time
5713 < XFASTINT (Vdouble_click_time
)))));
5716 last_mouse_button
= button
;
5717 last_mouse_x
= XINT (event
->x
);
5718 last_mouse_y
= XINT (event
->y
);
5720 /* If this is a button press, squirrel away the location, so
5721 we can decide later whether it was a click or a drag. */
5722 if (event
->modifiers
& down_modifier
)
5726 double_click_count
++;
5727 event
->modifiers
|= ((double_click_count
> 2)
5732 double_click_count
= 1;
5733 button_down_time
= event
->timestamp
;
5734 *start_pos_ptr
= Fcopy_alist (position
);
5735 ignore_mouse_drag_p
= 0;
5738 /* Now we're releasing a button - check the co-ordinates to
5739 see if this was a click or a drag. */
5740 else if (event
->modifiers
& up_modifier
)
5742 /* If we did not see a down before this up, ignore the up.
5743 Probably this happened because the down event chose a
5744 menu item. It would be an annoyance to treat the
5745 release of the button that chose the menu item as a
5748 if (!CONSP (start_pos
))
5751 event
->modifiers
&= ~up_modifier
;
5754 Lisp_Object new_down
, down
;
5755 EMACS_INT xdiff
= double_click_fuzz
, ydiff
= double_click_fuzz
;
5757 /* The third element of every position
5758 should be the (x,y) pair. */
5759 down
= Fcar (Fcdr (Fcdr (start_pos
)));
5760 new_down
= Fcar (Fcdr (Fcdr (position
)));
5763 && INTEGERP (XCAR (down
)) && INTEGERP (XCDR (down
)))
5765 xdiff
= XINT (XCAR (new_down
)) - XINT (XCAR (down
));
5766 ydiff
= XINT (XCDR (new_down
)) - XINT (XCDR (down
));
5769 if (ignore_mouse_drag_p
)
5771 event
->modifiers
|= click_modifier
;
5772 ignore_mouse_drag_p
= 0;
5774 else if (xdiff
< double_click_fuzz
&& xdiff
> - double_click_fuzz
5775 && ydiff
< double_click_fuzz
&& ydiff
> - double_click_fuzz
5776 /* Maybe the mouse has moved a lot, caused scrolling, and
5777 eventually ended up at the same screen position (but
5778 not buffer position) in which case it is a drag, not
5780 /* FIXME: OTOH if the buffer position has changed
5781 because of a timer or process filter rather than
5782 because of mouse movement, it should be considered as
5783 a click. But mouse-drag-region completely ignores
5784 this case and it hasn't caused any real problem, so
5785 it's probably OK to ignore it as well. */
5786 && EQ (Fcar (Fcdr (start_pos
)), Fcar (Fcdr (position
))))
5787 /* Mouse hasn't moved (much). */
5788 event
->modifiers
|= click_modifier
;
5791 button_down_time
= 0;
5792 event
->modifiers
|= drag_modifier
;
5795 /* Don't check is_double; treat this as multiple
5796 if the down-event was multiple. */
5797 if (double_click_count
> 1)
5798 event
->modifiers
|= ((double_click_count
> 2)
5804 /* Every mouse event should either have the down_modifier or
5805 the up_modifier set. */
5809 /* Get the symbol we should use for the mouse click. */
5812 head
= modify_event_symbol (button
,
5814 Qmouse_click
, Vlispy_mouse_stem
,
5817 ASIZE (mouse_syms
));
5818 if (event
->modifiers
& drag_modifier
)
5819 return list3 (head
, start_pos
, position
);
5820 else if (event
->modifiers
& (double_modifier
| triple_modifier
))
5821 return list3 (head
, position
, make_number (double_click_count
));
5823 return list2 (head
, position
);
5828 case HORIZ_WHEEL_EVENT
:
5830 Lisp_Object position
;
5833 /* Build the position as appropriate for this mouse click. */
5834 struct frame
*f
= XFRAME (event
->frame_or_window
);
5836 /* Ignore wheel events that were made on frame that have been
5838 if (! FRAME_LIVE_P (f
))
5841 position
= make_lispy_position (f
, event
->x
, event
->y
,
5844 /* Set double or triple modifiers to indicate the wheel speed. */
5846 /* On window-system frames, use the value of
5847 double-click-fuzz as is. On other frames, interpret it
5848 as a multiple of 1/8 characters. */
5854 if (WINDOWP (event
->frame_or_window
))
5855 fr
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5856 else if (FRAMEP (event
->frame_or_window
))
5857 fr
= XFRAME (event
->frame_or_window
);
5861 fuzz
= FRAME_WINDOW_P (fr
)
5862 ? double_click_fuzz
: double_click_fuzz
/ 8;
5864 if (event
->modifiers
& up_modifier
)
5866 /* Emit a wheel-up event. */
5867 event
->modifiers
&= ~up_modifier
;
5870 else if (event
->modifiers
& down_modifier
)
5872 /* Emit a wheel-down event. */
5873 event
->modifiers
&= ~down_modifier
;
5877 /* Every wheel event should either have the down_modifier or
5878 the up_modifier set. */
5881 if (event
->kind
== HORIZ_WHEEL_EVENT
)
5884 is_double
= (last_mouse_button
== - (1 + symbol_num
)
5885 && (eabs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5886 && (eabs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5887 && button_down_time
!= 0
5888 && (EQ (Vdouble_click_time
, Qt
)
5889 || (NATNUMP (Vdouble_click_time
)
5890 && (event
->timestamp
- button_down_time
5891 < XFASTINT (Vdouble_click_time
)))));
5894 double_click_count
++;
5895 event
->modifiers
|= ((double_click_count
> 2)
5901 double_click_count
= 1;
5902 event
->modifiers
|= click_modifier
;
5905 button_down_time
= event
->timestamp
;
5906 /* Use a negative value to distinguish wheel from mouse button. */
5907 last_mouse_button
= - (1 + symbol_num
);
5908 last_mouse_x
= XINT (event
->x
);
5909 last_mouse_y
= XINT (event
->y
);
5911 /* Get the symbol we should use for the wheel event. */
5912 head
= modify_event_symbol (symbol_num
,
5918 ASIZE (wheel_syms
));
5921 if (event
->modifiers
& (double_modifier
| triple_modifier
))
5922 return list3 (head
, position
, make_number (double_click_count
));
5924 return list2 (head
, position
);
5928 #ifdef USE_TOOLKIT_SCROLL_BARS
5930 /* We don't have down and up events if using toolkit scroll bars,
5931 so make this always a click event. Store in the `part' of
5932 the Lisp event a symbol which maps to the following actions:
5934 `above_handle' page up
5935 `below_handle' page down
5939 `bottom' bottom of buffer
5940 `handle' thumb has been dragged.
5941 `end-scroll' end of interaction with scroll bar
5943 The incoming input_event contains in its `part' member an
5944 index of type `enum scroll_bar_part' which we can use as an
5945 index in scroll_bar_parts to get the appropriate symbol. */
5947 case SCROLL_BAR_CLICK_EVENT
:
5949 Lisp_Object position
, head
;
5951 position
= make_scroll_bar_position (event
, Qvertical_scroll_bar
);
5953 /* Always treat scroll bar events as clicks. */
5954 event
->modifiers
|= click_modifier
;
5955 event
->modifiers
&= ~up_modifier
;
5957 if (event
->code
>= ASIZE (mouse_syms
))
5958 mouse_syms
= larger_vector (mouse_syms
,
5959 event
->code
- ASIZE (mouse_syms
) + 1,
5962 /* Get the symbol we should use for the mouse click. */
5963 head
= modify_event_symbol (event
->code
,
5968 ASIZE (mouse_syms
));
5969 return list2 (head
, position
);
5972 case HORIZONTAL_SCROLL_BAR_CLICK_EVENT
:
5974 Lisp_Object position
, head
;
5976 position
= make_scroll_bar_position (event
, Qhorizontal_scroll_bar
);
5978 /* Always treat scroll bar events as clicks. */
5979 event
->modifiers
|= click_modifier
;
5980 event
->modifiers
&= ~up_modifier
;
5982 if (event
->code
>= ASIZE (mouse_syms
))
5983 mouse_syms
= larger_vector (mouse_syms
,
5984 event
->code
- ASIZE (mouse_syms
) + 1,
5987 /* Get the symbol we should use for the mouse click. */
5988 head
= modify_event_symbol (event
->code
,
5993 ASIZE (mouse_syms
));
5994 return list2 (head
, position
);
5997 #endif /* USE_TOOLKIT_SCROLL_BARS */
5999 case DRAG_N_DROP_EVENT
:
6002 Lisp_Object head
, position
;
6005 f
= XFRAME (event
->frame_or_window
);
6008 /* Ignore mouse events that were made on frames that
6009 have been deleted. */
6010 if (! FRAME_LIVE_P (f
))
6013 position
= make_lispy_position (f
, event
->x
, event
->y
,
6016 head
= modify_event_symbol (0, event
->modifiers
,
6018 lispy_drag_n_drop_names
,
6019 &drag_n_drop_syms
, 1);
6020 return list3 (head
, position
, files
);
6023 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
6024 || defined (HAVE_NS) || defined (USE_GTK)
6025 case MENU_BAR_EVENT
:
6026 if (EQ (event
->arg
, event
->frame_or_window
))
6027 /* This is the prefix key. We translate this to
6028 `(menu_bar)' because the code in keyboard.c for menu
6029 events, which we use, relies on this. */
6030 return list1 (Qmenu_bar
);
6034 case SELECT_WINDOW_EVENT
:
6035 /* Make an event (select-window (WINDOW)). */
6036 return list2 (Qselect_window
, list1 (event
->frame_or_window
));
6038 case TOOL_BAR_EVENT
:
6039 if (EQ (event
->arg
, event
->frame_or_window
))
6040 /* This is the prefix key. We translate this to
6041 `(tool_bar)' because the code in keyboard.c for tool bar
6042 events, which we use, relies on this. */
6043 return list1 (Qtool_bar
);
6044 else if (SYMBOLP (event
->arg
))
6045 return apply_modifiers (event
->modifiers
, event
->arg
);
6048 case USER_SIGNAL_EVENT
:
6049 /* A user signal. */
6051 char *name
= find_user_signal_name (event
->code
);
6054 return intern (name
);
6057 case SAVE_SESSION_EVENT
:
6058 return Qsave_session
;
6063 return Fcons (Qdbus_event
, event
->arg
);
6065 #endif /* HAVE_DBUS */
6067 #if defined HAVE_GFILENOTIFY || defined HAVE_INOTIFY
6068 case FILE_NOTIFY_EVENT
:
6070 return Fcons (Qfile_notify
, event
->arg
);
6072 #endif /* defined HAVE_GFILENOTIFY || defined HAVE_INOTIFY */
6074 case CONFIG_CHANGED_EVENT
:
6075 return list3 (Qconfig_changed_event
,
6076 event
->arg
, event
->frame_or_window
);
6078 /* The 'kind' field of the event is something we don't recognize. */
6085 make_lispy_movement (struct frame
*frame
, Lisp_Object bar_window
, enum scroll_bar_part part
,
6086 Lisp_Object x
, Lisp_Object y
, Time t
)
6088 /* Is it a scroll bar movement? */
6089 if (frame
&& ! NILP (bar_window
))
6091 Lisp_Object part_sym
;
6093 part_sym
= builtin_lisp_symbol (scroll_bar_parts
[part
]);
6094 return list2 (Qscroll_bar_movement
,
6096 Qvertical_scroll_bar
,
6101 /* Or is it an ordinary mouse movement? */
6104 Lisp_Object position
;
6105 position
= make_lispy_position (frame
, x
, y
, t
);
6106 return list2 (Qmouse_movement
, position
);
6110 /* Construct a switch frame event. */
6112 make_lispy_switch_frame (Lisp_Object frame
)
6114 return list2 (Qswitch_frame
, frame
);
6118 make_lispy_focus_in (Lisp_Object frame
)
6120 return list2 (Qfocus_in
, frame
);
6123 #ifdef HAVE_WINDOW_SYSTEM
6126 make_lispy_focus_out (Lisp_Object frame
)
6128 return list2 (Qfocus_out
, frame
);
6131 #endif /* HAVE_WINDOW_SYSTEM */
6133 /* Manipulating modifiers. */
6135 /* Parse the name of SYMBOL, and return the set of modifiers it contains.
6137 If MODIFIER_END is non-zero, set *MODIFIER_END to the position in
6138 SYMBOL's name of the end of the modifiers; the string from this
6139 position is the unmodified symbol name.
6141 This doesn't use any caches. */
6144 parse_modifiers_uncached (Lisp_Object symbol
, ptrdiff_t *modifier_end
)
6150 CHECK_SYMBOL (symbol
);
6153 name
= SYMBOL_NAME (symbol
);
6155 for (i
= 0; i
< SBYTES (name
) - 1; )
6157 ptrdiff_t this_mod_end
= 0;
6160 /* See if the name continues with a modifier word.
6161 Check that the word appears, but don't check what follows it.
6162 Set this_mod and this_mod_end to record what we find. */
6164 switch (SREF (name
, i
))
6166 #define SINGLE_LETTER_MOD(BIT) \
6167 (this_mod_end = i + 1, this_mod = BIT)
6170 SINGLE_LETTER_MOD (alt_modifier
);
6174 SINGLE_LETTER_MOD (ctrl_modifier
);
6178 SINGLE_LETTER_MOD (hyper_modifier
);
6182 SINGLE_LETTER_MOD (meta_modifier
);
6186 SINGLE_LETTER_MOD (shift_modifier
);
6190 SINGLE_LETTER_MOD (super_modifier
);
6193 #undef SINGLE_LETTER_MOD
6195 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6196 if (i + LEN + 1 <= SBYTES (name) \
6197 && ! memcmp (SDATA (name) + i, NAME, LEN)) \
6199 this_mod_end = i + LEN; \
6204 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
6205 MULTI_LETTER_MOD (down_modifier
, "down", 4);
6206 MULTI_LETTER_MOD (double_modifier
, "double", 6);
6210 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
6212 #undef MULTI_LETTER_MOD
6216 /* If we found no modifier, stop looking for them. */
6217 if (this_mod_end
== 0)
6220 /* Check there is a dash after the modifier, so that it
6221 really is a modifier. */
6222 if (this_mod_end
>= SBYTES (name
)
6223 || SREF (name
, this_mod_end
) != '-')
6226 /* This modifier is real; look for another. */
6227 modifiers
|= this_mod
;
6228 i
= this_mod_end
+ 1;
6231 /* Should we include the `click' modifier? */
6232 if (! (modifiers
& (down_modifier
| drag_modifier
6233 | double_modifier
| triple_modifier
))
6234 && i
+ 7 == SBYTES (name
)
6235 && memcmp (SDATA (name
) + i
, "mouse-", 6) == 0
6236 && ('0' <= SREF (name
, i
+ 6) && SREF (name
, i
+ 6) <= '9'))
6237 modifiers
|= click_modifier
;
6239 if (! (modifiers
& (double_modifier
| triple_modifier
))
6240 && i
+ 6 < SBYTES (name
)
6241 && memcmp (SDATA (name
) + i
, "wheel-", 6) == 0)
6242 modifiers
|= click_modifier
;
6250 /* Return a symbol whose name is the modifier prefixes for MODIFIERS
6251 prepended to the string BASE[0..BASE_LEN-1].
6252 This doesn't use any caches. */
6254 apply_modifiers_uncached (int modifiers
, char *base
, int base_len
, int base_len_byte
)
6256 /* Since BASE could contain nulls, we can't use intern here; we have
6257 to use Fintern, which expects a genuine Lisp_String, and keeps a
6259 char new_mods
[sizeof "A-C-H-M-S-s-down-drag-double-triple-"];
6265 /* Only the event queue may use the `up' modifier; it should always
6266 be turned into a click or drag event before presented to lisp code. */
6267 if (modifiers
& up_modifier
)
6270 if (modifiers
& alt_modifier
) { *p
++ = 'A'; *p
++ = '-'; }
6271 if (modifiers
& ctrl_modifier
) { *p
++ = 'C'; *p
++ = '-'; }
6272 if (modifiers
& hyper_modifier
) { *p
++ = 'H'; *p
++ = '-'; }
6273 if (modifiers
& meta_modifier
) { *p
++ = 'M'; *p
++ = '-'; }
6274 if (modifiers
& shift_modifier
) { *p
++ = 'S'; *p
++ = '-'; }
6275 if (modifiers
& super_modifier
) { *p
++ = 's'; *p
++ = '-'; }
6276 if (modifiers
& double_modifier
) p
= stpcpy (p
, "double-");
6277 if (modifiers
& triple_modifier
) p
= stpcpy (p
, "triple-");
6278 if (modifiers
& down_modifier
) p
= stpcpy (p
, "down-");
6279 if (modifiers
& drag_modifier
) p
= stpcpy (p
, "drag-");
6280 /* The click modifier is denoted by the absence of other modifiers. */
6284 mod_len
= p
- new_mods
;
6288 Lisp_Object new_name
;
6290 new_name
= make_uninit_multibyte_string (mod_len
+ base_len
,
6291 mod_len
+ base_len_byte
);
6292 memcpy (SDATA (new_name
), new_mods
, mod_len
);
6293 memcpy (SDATA (new_name
) + mod_len
, base
, base_len_byte
);
6295 return Fintern (new_name
, Qnil
);
6300 static const char *const modifier_names
[] =
6302 "up", "down", "drag", "click", "double", "triple", 0, 0,
6303 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
6304 0, 0, "alt", "super", "hyper", "shift", "control", "meta"
6306 #define NUM_MOD_NAMES ARRAYELTS (modifier_names)
6308 static Lisp_Object modifier_symbols
;
6310 /* Return the list of modifier symbols corresponding to the mask MODIFIERS. */
6312 lispy_modifier_list (int modifiers
)
6314 Lisp_Object modifier_list
;
6317 modifier_list
= Qnil
;
6318 for (i
= 0; (1<<i
) <= modifiers
&& i
< NUM_MOD_NAMES
; i
++)
6319 if (modifiers
& (1<<i
))
6320 modifier_list
= Fcons (AREF (modifier_symbols
, i
),
6323 return modifier_list
;
6327 /* Parse the modifiers on SYMBOL, and return a list like (UNMODIFIED MASK),
6328 where UNMODIFIED is the unmodified form of SYMBOL,
6329 MASK is the set of modifiers present in SYMBOL's name.
6330 This is similar to parse_modifiers_uncached, but uses the cache in
6331 SYMBOL's Qevent_symbol_element_mask property, and maintains the
6332 Qevent_symbol_elements property. */
6334 #define KEY_TO_CHAR(k) (XINT (k) & ((1 << CHARACTERBITS) - 1))
6337 parse_modifiers (Lisp_Object symbol
)
6339 Lisp_Object elements
;
6341 if (INTEGERP (symbol
))
6342 return list2i (KEY_TO_CHAR (symbol
), XINT (symbol
) & CHAR_MODIFIER_MASK
);
6343 else if (!SYMBOLP (symbol
))
6346 elements
= Fget (symbol
, Qevent_symbol_element_mask
);
6347 if (CONSP (elements
))
6352 int modifiers
= parse_modifiers_uncached (symbol
, &end
);
6353 Lisp_Object unmodified
;
6356 unmodified
= Fintern (make_string (SSDATA (SYMBOL_NAME (symbol
)) + end
,
6357 SBYTES (SYMBOL_NAME (symbol
)) - end
),
6360 if (modifiers
& ~INTMASK
)
6362 XSETFASTINT (mask
, modifiers
);
6363 elements
= list2 (unmodified
, mask
);
6365 /* Cache the parsing results on SYMBOL. */
6366 Fput (symbol
, Qevent_symbol_element_mask
,
6368 Fput (symbol
, Qevent_symbol_elements
,
6369 Fcons (unmodified
, lispy_modifier_list (modifiers
)));
6371 /* Since we know that SYMBOL is modifiers applied to unmodified,
6372 it would be nice to put that in unmodified's cache.
6373 But we can't, since we're not sure that parse_modifiers is
6380 DEFUN ("internal-event-symbol-parse-modifiers", Fevent_symbol_parse_modifiers
,
6381 Sevent_symbol_parse_modifiers
, 1, 1, 0,
6382 doc
: /* Parse the event symbol. For internal use. */)
6383 (Lisp_Object symbol
)
6385 /* Fill the cache if needed. */
6386 parse_modifiers (symbol
);
6387 /* Ignore the result (which is stored on Qevent_symbol_element_mask)
6388 and use the Lispier representation stored on Qevent_symbol_elements
6390 return Fget (symbol
, Qevent_symbol_elements
);
6393 /* Apply the modifiers MODIFIERS to the symbol BASE.
6394 BASE must be unmodified.
6396 This is like apply_modifiers_uncached, but uses BASE's
6397 Qmodifier_cache property, if present. It also builds
6398 Qevent_symbol_elements properties, since it has that info anyway.
6400 apply_modifiers copies the value of BASE's Qevent_kind property to
6401 the modified symbol. */
6403 apply_modifiers (int modifiers
, Lisp_Object base
)
6405 Lisp_Object cache
, idx
, entry
, new_symbol
;
6407 /* Mask out upper bits. We don't know where this value's been. */
6408 modifiers
&= INTMASK
;
6410 if (INTEGERP (base
))
6411 return make_number (XINT (base
) | modifiers
);
6413 /* The click modifier never figures into cache indices. */
6414 cache
= Fget (base
, Qmodifier_cache
);
6415 XSETFASTINT (idx
, (modifiers
& ~click_modifier
));
6416 entry
= assq_no_quit (idx
, cache
);
6419 new_symbol
= XCDR (entry
);
6422 /* We have to create the symbol ourselves. */
6423 new_symbol
= apply_modifiers_uncached (modifiers
,
6424 SSDATA (SYMBOL_NAME (base
)),
6425 SCHARS (SYMBOL_NAME (base
)),
6426 SBYTES (SYMBOL_NAME (base
)));
6428 /* Add the new symbol to the base's cache. */
6429 entry
= Fcons (idx
, new_symbol
);
6430 Fput (base
, Qmodifier_cache
, Fcons (entry
, cache
));
6432 /* We have the parsing info now for free, so we could add it to
6434 XSETFASTINT (idx, modifiers);
6435 Fput (new_symbol, Qevent_symbol_element_mask,
6437 Fput (new_symbol, Qevent_symbol_elements,
6438 Fcons (base, lispy_modifier_list (modifiers)));
6439 Sadly, this is only correct if `base' is indeed a base event,
6440 which is not necessarily the case. -stef */
6443 /* Make sure this symbol is of the same kind as BASE.
6445 You'd think we could just set this once and for all when we
6446 intern the symbol above, but reorder_modifiers may call us when
6447 BASE's property isn't set right; we can't assume that just
6448 because it has a Qmodifier_cache property it must have its
6449 Qevent_kind set right as well. */
6450 if (NILP (Fget (new_symbol
, Qevent_kind
)))
6454 kind
= Fget (base
, Qevent_kind
);
6456 Fput (new_symbol
, Qevent_kind
, kind
);
6463 /* Given a symbol whose name begins with modifiers ("C-", "M-", etc),
6464 return a symbol with the modifiers placed in the canonical order.
6465 Canonical order is alphabetical, except for down and drag, which
6466 always come last. The 'click' modifier is never written out.
6468 Fdefine_key calls this to make sure that (for example) C-M-foo
6469 and M-C-foo end up being equivalent in the keymap. */
6472 reorder_modifiers (Lisp_Object symbol
)
6474 /* It's hopefully okay to write the code this way, since everything
6475 will soon be in caches, and no consing will be done at all. */
6478 parsed
= parse_modifiers (symbol
);
6479 return apply_modifiers (XFASTINT (XCAR (XCDR (parsed
))),
6484 /* For handling events, we often want to produce a symbol whose name
6485 is a series of modifier key prefixes ("M-", "C-", etcetera) attached
6486 to some base, like the name of a function key or mouse button.
6487 modify_event_symbol produces symbols of this sort.
6489 NAME_TABLE should point to an array of strings, such that NAME_TABLE[i]
6490 is the name of the i'th symbol. TABLE_SIZE is the number of elements
6493 Alternatively, NAME_ALIST_OR_STEM is either an alist mapping codes
6494 into symbol names, or a string specifying a name stem used to
6495 construct a symbol name or the form `STEM-N', where N is the decimal
6496 representation of SYMBOL_NUM. NAME_ALIST_OR_STEM is used if it is
6497 non-nil; otherwise NAME_TABLE is used.
6499 SYMBOL_TABLE should be a pointer to a Lisp_Object whose value will
6500 persist between calls to modify_event_symbol that it can use to
6501 store a cache of the symbols it's generated for this NAME_TABLE
6502 before. The object stored there may be a vector or an alist.
6504 SYMBOL_NUM is the number of the base name we want from NAME_TABLE.
6506 MODIFIERS is a set of modifier bits (as given in struct input_events)
6507 whose prefixes should be applied to the symbol name.
6509 SYMBOL_KIND is the value to be placed in the event_kind property of
6510 the returned symbol.
6512 The symbols we create are supposed to have an
6513 `event-symbol-elements' property, which lists the modifiers present
6514 in the symbol's name. */
6517 modify_event_symbol (ptrdiff_t symbol_num
, int modifiers
, Lisp_Object symbol_kind
,
6518 Lisp_Object name_alist_or_stem
, const char *const *name_table
,
6519 Lisp_Object
*symbol_table
, ptrdiff_t table_size
)
6522 Lisp_Object symbol_int
;
6524 /* Get rid of the "vendor-specific" bit here. */
6525 XSETINT (symbol_int
, symbol_num
& 0xffffff);
6527 /* Is this a request for a valid symbol? */
6528 if (symbol_num
< 0 || symbol_num
>= table_size
)
6531 if (CONSP (*symbol_table
))
6532 value
= Fcdr (assq_no_quit (symbol_int
, *symbol_table
));
6534 /* If *symbol_table doesn't seem to be initialized properly, fix that.
6535 *symbol_table should be a lisp vector TABLE_SIZE elements long,
6536 where the Nth element is the symbol for NAME_TABLE[N], or nil if
6537 we've never used that symbol before. */
6540 if (! VECTORP (*symbol_table
)
6541 || ASIZE (*symbol_table
) != table_size
)
6545 XSETFASTINT (size
, table_size
);
6546 *symbol_table
= Fmake_vector (size
, Qnil
);
6549 value
= AREF (*symbol_table
, symbol_num
);
6552 /* Have we already used this symbol before? */
6555 /* No; let's create it. */
6556 if (CONSP (name_alist_or_stem
))
6557 value
= Fcdr_safe (Fassq (symbol_int
, name_alist_or_stem
));
6558 else if (STRINGP (name_alist_or_stem
))
6561 ptrdiff_t len
= (SBYTES (name_alist_or_stem
)
6562 + sizeof "-" + INT_STRLEN_BOUND (EMACS_INT
));
6564 buf
= SAFE_ALLOCA (len
);
6565 esprintf (buf
, "%s-%"pI
"d", SDATA (name_alist_or_stem
),
6566 XINT (symbol_int
) + 1);
6567 value
= intern (buf
);
6570 else if (name_table
!= 0 && name_table
[symbol_num
])
6571 value
= intern (name_table
[symbol_num
]);
6573 #ifdef HAVE_WINDOW_SYSTEM
6576 char *name
= x_get_keysym_name (symbol_num
);
6578 value
= intern (name
);
6584 char buf
[sizeof "key-" + INT_STRLEN_BOUND (EMACS_INT
)];
6585 sprintf (buf
, "key-%"pD
"d", symbol_num
);
6586 value
= intern (buf
);
6589 if (CONSP (*symbol_table
))
6590 *symbol_table
= Fcons (Fcons (symbol_int
, value
), *symbol_table
);
6592 ASET (*symbol_table
, symbol_num
, value
);
6594 /* Fill in the cache entries for this symbol; this also
6595 builds the Qevent_symbol_elements property, which the user
6597 apply_modifiers (modifiers
& click_modifier
, value
);
6598 Fput (value
, Qevent_kind
, symbol_kind
);
6601 /* Apply modifiers to that symbol. */
6602 return apply_modifiers (modifiers
, value
);
6605 /* Convert a list that represents an event type,
6606 such as (ctrl meta backspace), into the usual representation of that
6607 event type as a number or a symbol. */
6609 DEFUN ("event-convert-list", Fevent_convert_list
, Sevent_convert_list
, 1, 1, 0,
6610 doc
: /* Convert the event description list EVENT-DESC to an event type.
6611 EVENT-DESC should contain one base event type (a character or symbol)
6612 and zero or more modifier names (control, meta, hyper, super, shift, alt,
6613 drag, down, double or triple). The base must be last.
6614 The return value is an event type (a character or symbol) which
6615 has the same base event type and all the specified modifiers. */)
6616 (Lisp_Object event_desc
)
6624 while (CONSP (rest
))
6632 /* Given a symbol, see if it is a modifier name. */
6633 if (SYMBOLP (elt
) && CONSP (rest
))
6634 this = parse_solitary_modifier (elt
);
6638 else if (!NILP (base
))
6639 error ("Two bases given in one event");
6645 /* Let the symbol A refer to the character A. */
6646 if (SYMBOLP (base
) && SCHARS (SYMBOL_NAME (base
)) == 1)
6647 XSETINT (base
, SREF (SYMBOL_NAME (base
), 0));
6649 if (INTEGERP (base
))
6651 /* Turn (shift a) into A. */
6652 if ((modifiers
& shift_modifier
) != 0
6653 && (XINT (base
) >= 'a' && XINT (base
) <= 'z'))
6655 XSETINT (base
, XINT (base
) - ('a' - 'A'));
6656 modifiers
&= ~shift_modifier
;
6659 /* Turn (control a) into C-a. */
6660 if (modifiers
& ctrl_modifier
)
6661 return make_number ((modifiers
& ~ctrl_modifier
)
6662 | make_ctrl_char (XINT (base
)));
6664 return make_number (modifiers
| XINT (base
));
6666 else if (SYMBOLP (base
))
6667 return apply_modifiers (modifiers
, base
);
6669 error ("Invalid base event");
6672 /* Try to recognize SYMBOL as a modifier name.
6673 Return the modifier flag bit, or 0 if not recognized. */
6676 parse_solitary_modifier (Lisp_Object symbol
)
6678 Lisp_Object name
= SYMBOL_NAME (symbol
);
6680 switch (SREF (name
, 0))
6682 #define SINGLE_LETTER_MOD(BIT) \
6683 if (SBYTES (name) == 1) \
6686 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6687 if (LEN == SBYTES (name) \
6688 && ! memcmp (SDATA (name), NAME, LEN)) \
6692 SINGLE_LETTER_MOD (alt_modifier
);
6696 MULTI_LETTER_MOD (alt_modifier
, "alt", 3);
6700 SINGLE_LETTER_MOD (ctrl_modifier
);
6704 MULTI_LETTER_MOD (ctrl_modifier
, "ctrl", 4);
6705 MULTI_LETTER_MOD (ctrl_modifier
, "control", 7);
6709 SINGLE_LETTER_MOD (hyper_modifier
);
6713 MULTI_LETTER_MOD (hyper_modifier
, "hyper", 5);
6717 SINGLE_LETTER_MOD (meta_modifier
);
6721 MULTI_LETTER_MOD (meta_modifier
, "meta", 4);
6725 SINGLE_LETTER_MOD (shift_modifier
);
6729 MULTI_LETTER_MOD (shift_modifier
, "shift", 5);
6730 MULTI_LETTER_MOD (super_modifier
, "super", 5);
6731 SINGLE_LETTER_MOD (super_modifier
);
6735 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
6736 MULTI_LETTER_MOD (down_modifier
, "down", 4);
6737 MULTI_LETTER_MOD (double_modifier
, "double", 6);
6741 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
6744 #undef SINGLE_LETTER_MOD
6745 #undef MULTI_LETTER_MOD
6751 /* Return true if EVENT is a list whose elements are all integers or symbols.
6752 Such a list is not valid as an event,
6753 but it can be a Lucid-style event type list. */
6756 lucid_event_type_list_p (Lisp_Object object
)
6760 if (! CONSP (object
))
6763 if (EQ (XCAR (object
), Qhelp_echo
)
6764 || EQ (XCAR (object
), Qvertical_line
)
6765 || EQ (XCAR (object
), Qmode_line
)
6766 || EQ (XCAR (object
), Qheader_line
))
6769 for (tail
= object
; CONSP (tail
); tail
= XCDR (tail
))
6773 if (! (INTEGERP (elt
) || SYMBOLP (elt
)))
6780 /* Return true if terminal input chars are available.
6781 Also, store the return value into INPUT_PENDING.
6783 Serves the purpose of ioctl (0, FIONREAD, ...)
6784 but works even if FIONREAD does not exist.
6785 (In fact, this may actually read some input.)
6787 If READABLE_EVENTS_DO_TIMERS_NOW is set in FLAGS, actually run
6788 timer events that are ripe.
6789 If READABLE_EVENTS_FILTER_EVENTS is set in FLAGS, ignore internal
6790 events (FOCUS_IN_EVENT).
6791 If READABLE_EVENTS_IGNORE_SQUEEZABLES is set in FLAGS, ignore mouse
6792 movements and toolkit scroll bar thumb drags. */
6795 get_input_pending (int flags
)
6797 /* First of all, have we already counted some input? */
6798 input_pending
= (!NILP (Vquit_flag
) || readable_events (flags
));
6800 /* If input is being read as it arrives, and we have none, there is none. */
6801 if (!input_pending
&& (!interrupt_input
|| interrupts_deferred
))
6803 /* Try to read some input and see how much we get. */
6805 input_pending
= (!NILP (Vquit_flag
) || readable_events (flags
));
6808 return input_pending
;
6811 /* Put a BUFFER_SWITCH_EVENT in the buffer
6812 so that read_key_sequence will notice the new current buffer. */
6815 record_asynch_buffer_change (void)
6817 /* We don't need a buffer-switch event unless Emacs is waiting for input.
6818 The purpose of the event is to make read_key_sequence look up the
6819 keymaps again. If we aren't in read_key_sequence, we don't need one,
6820 and the event could cause trouble by messing up (input-pending-p).
6821 Note: Fwaiting_for_user_input_p always returns nil when async
6822 subprocesses aren't supported. */
6823 if (!NILP (Fwaiting_for_user_input_p ()))
6825 struct input_event event
;
6828 event
.kind
= BUFFER_SWITCH_EVENT
;
6829 event
.frame_or_window
= Qnil
;
6832 /* Make sure no interrupt happens while storing the event. */
6834 if (interrupt_input
)
6835 kbd_buffer_store_event (&event
);
6840 kbd_buffer_store_event (&event
);
6846 /* Read any terminal input already buffered up by the system
6847 into the kbd_buffer, but do not wait.
6849 Return the number of keyboard chars read, or -1 meaning
6850 this is a bad time to try to read input. */
6859 /* Store pending user signal events, if any. */
6860 store_user_signal_events ();
6862 /* Loop through the available terminals, and call their input hooks. */
6866 struct terminal
*next
= t
->next_terminal
;
6868 if (t
->read_socket_hook
)
6871 struct input_event hold_quit
;
6873 if (input_blocked_p ())
6875 pending_signals
= 1;
6879 EVENT_INIT (hold_quit
);
6880 hold_quit
.kind
= NO_EVENT
;
6882 /* No need for FIONREAD or fcntl; just say don't wait. */
6883 while ((nr
= (*t
->read_socket_hook
) (t
, &hold_quit
)) > 0)
6886 if (nr
== -1) /* Not OK to read input now. */
6890 else if (nr
== -2) /* Non-transient error. */
6892 /* The terminal device terminated; it should be closed. */
6894 /* Kill Emacs if this was our last terminal. */
6895 if (!terminal_list
->next_terminal
)
6896 /* Formerly simply reported no input, but that
6897 sometimes led to a failure of Emacs to terminate.
6898 SIGHUP seems appropriate if we can't reach the
6900 /* ??? Is it really right to send the signal just to
6901 this process rather than to the whole process
6902 group? Perhaps on systems with FIONREAD Emacs is
6903 alone in its group. */
6904 terminate_due_to_signal (SIGHUP
, 10);
6906 /* XXX Is calling delete_terminal safe here? It calls delete_frame. */
6909 XSETTERMINAL (tmp
, t
);
6910 Fdelete_terminal (tmp
, Qnoelisp
);
6914 /* If there was no error, make sure the pointer
6915 is visible for all frames on this terminal. */
6918 Lisp_Object tail
, frame
;
6920 FOR_EACH_FRAME (tail
, frame
)
6922 struct frame
*f
= XFRAME (frame
);
6923 if (FRAME_TERMINAL (f
) == t
)
6924 frame_make_pointer_visible (f
);
6928 if (hold_quit
.kind
!= NO_EVENT
)
6929 kbd_buffer_store_event (&hold_quit
);
6941 /* This is the tty way of reading available input.
6943 Note that each terminal device has its own `struct terminal' object,
6944 and so this function is called once for each individual termcap
6945 terminal. The first parameter indicates which terminal to read from. */
6948 tty_read_avail_input (struct terminal
*terminal
,
6949 struct input_event
*hold_quit
)
6951 /* Using KBD_BUFFER_SIZE - 1 here avoids reading more than
6952 the kbd_buffer can really hold. That may prevent loss
6953 of characters on some systems when input is stuffed at us. */
6954 unsigned char cbuf
[KBD_BUFFER_SIZE
- 1];
6956 struct tty_display_info
*tty
= terminal
->display_info
.tty
;
6959 int buffer_free
= KBD_BUFFER_SIZE
- kbd_buffer_nr_stored () - 1;
6961 if (kbd_on_hold_p () || buffer_free
<= 0)
6963 #endif /* subprocesses */
6965 if (!terminal
->name
) /* Don't read from a dead terminal. */
6968 if (terminal
->type
!= output_termcap
6969 && terminal
->type
!= output_msdos_raw
)
6972 /* XXX I think the following code should be moved to separate hook
6973 functions in system-dependent files. */
6975 /* FIXME: AFAIK, tty_read_avail_input is not used under w32 since the non-GUI
6976 code sets read_socket_hook to w32_console_read_socket instead! */
6978 #else /* not WINDOWSNT */
6979 if (! tty
->term_initted
) /* In case we get called during bootstrap. */
6983 return 0; /* The terminal is suspended. */
6986 n_to_read
= dos_keysns ();
6990 cbuf
[0] = dos_keyread ();
6993 #else /* not MSDOS */
6998 struct input_event gpm_hold_quit
;
6999 int gpm
, fd
= gpm_fd
;
7001 EVENT_INIT (gpm_hold_quit
);
7002 gpm_hold_quit
.kind
= NO_EVENT
;
7004 /* gpm==1 if event received.
7005 gpm==0 if the GPM daemon has closed the connection, in which case
7006 Gpm_GetEvent closes gpm_fd and clears it to -1, which is why
7007 we save it in `fd' so close_gpm can remove it from the
7009 gpm==-1 if a protocol error or EWOULDBLOCK; the latter is normal. */
7010 while (gpm
= Gpm_GetEvent (&event
), gpm
== 1) {
7011 nread
+= handle_one_term_event (tty
, &event
, &gpm_hold_quit
);
7014 /* Presumably the GPM daemon has closed the connection. */
7016 if (gpm_hold_quit
.kind
!= NO_EVENT
)
7017 kbd_buffer_store_event (&gpm_hold_quit
);
7021 #endif /* HAVE_GPM */
7023 /* Determine how many characters we should *try* to read. */
7024 #ifdef USABLE_FIONREAD
7025 /* Find out how much input is available. */
7026 if (ioctl (fileno (tty
->input
), FIONREAD
, &n_to_read
) < 0)
7028 if (! noninteractive
)
7029 return -2; /* Close this terminal. */
7035 if (n_to_read
> sizeof cbuf
)
7036 n_to_read
= sizeof cbuf
;
7037 #elif defined USG || defined CYGWIN
7038 /* Read some input if available, but don't wait. */
7039 n_to_read
= sizeof cbuf
;
7040 fcntl (fileno (tty
->input
), F_SETFL
, O_NONBLOCK
);
7042 # error "Cannot read without possibly delaying"
7046 /* Don't read more than we can store. */
7047 if (n_to_read
> buffer_free
)
7048 n_to_read
= buffer_free
;
7049 #endif /* subprocesses */
7051 /* Now read; for one reason or another, this will not block.
7052 NREAD is set to the number of chars read. */
7055 nread
= emacs_read (fileno (tty
->input
), (char *) cbuf
, n_to_read
);
7056 /* POSIX infers that processes which are not in the session leader's
7057 process group won't get SIGHUPs at logout time. BSDI adheres to
7058 this part standard and returns -1 from read (0) with errno==EIO
7059 when the control tty is taken away.
7060 Jeffrey Honig <jch@bsdi.com> says this is generally safe. */
7061 if (nread
== -1 && errno
== EIO
)
7062 return -2; /* Close this terminal. */
7063 #if defined (AIX) && defined (_BSD)
7064 /* The kernel sometimes fails to deliver SIGHUP for ptys.
7065 This looks incorrect, but it isn't, because _BSD causes
7066 O_NDELAY to be defined in fcntl.h as O_NONBLOCK,
7067 and that causes a value other than 0 when there is no input. */
7069 return -2; /* Close this terminal. */
7073 /* We used to retry the read if it was interrupted.
7074 But this does the wrong thing when O_NONBLOCK causes
7075 an EAGAIN error. Does anybody know of a situation
7076 where a retry is actually needed? */
7078 nread
< 0 && (errno
== EAGAIN
|| errno
== EFAULT
7088 #ifndef USABLE_FIONREAD
7089 #if defined (USG) || defined (CYGWIN)
7090 fcntl (fileno (tty
->input
), F_SETFL
, 0);
7091 #endif /* USG or CYGWIN */
7092 #endif /* no FIONREAD */
7097 #endif /* not MSDOS */
7098 #endif /* not WINDOWSNT */
7100 for (i
= 0; i
< nread
; i
++)
7102 struct input_event buf
;
7104 buf
.kind
= ASCII_KEYSTROKE_EVENT
;
7106 if (tty
->meta_key
== 1 && (cbuf
[i
] & 0x80))
7107 buf
.modifiers
= meta_modifier
;
7108 if (tty
->meta_key
!= 2)
7112 /* Set the frame corresponding to the active tty. Note that the
7113 value of selected_frame is not reliable here, redisplay tends
7114 to temporarily change it. */
7115 buf
.frame_or_window
= tty
->top_frame
;
7118 kbd_buffer_store_event (&buf
);
7119 /* Don't look at input that follows a C-g too closely.
7120 This reduces lossage due to autorepeat on C-g. */
7121 if (buf
.kind
== ASCII_KEYSTROKE_EVENT
7122 && buf
.code
== quit_char
)
7130 handle_async_input (void)
7135 int nread
= gobble_input ();
7136 /* -1 means it's not ok to read the input now.
7137 UNBLOCK_INPUT will read it later; now, avoid infinite loop.
7138 0 means there was no keyboard input available. */
7146 process_pending_signals (void)
7148 pending_signals
= 0;
7149 handle_async_input ();
7150 do_pending_atimers ();
7153 /* Undo any number of BLOCK_INPUT calls down to level LEVEL,
7154 and reinvoke any pending signal if the level is now 0 and
7155 a fatal error is not already in progress. */
7158 unblock_input_to (int level
)
7160 interrupt_input_blocked
= level
;
7163 if (pending_signals
&& !fatal_error_in_progress
)
7164 process_pending_signals ();
7170 /* End critical section.
7172 If doing signal-driven input, and a signal came in when input was
7173 blocked, reinvoke the signal handler now to deal with it.
7175 It will also process queued input, if it was not read before.
7176 When a longer code sequence does not use block/unblock input
7177 at all, the whole input gathered up to the next call to
7178 unblock_input will be processed inside that call. */
7181 unblock_input (void)
7183 unblock_input_to (interrupt_input_blocked
- 1);
7186 /* Undo any number of BLOCK_INPUT calls,
7187 and also reinvoke any pending signal. */
7190 totally_unblock_input (void)
7192 unblock_input_to (0);
7198 handle_input_available_signal (int sig
)
7200 pending_signals
= 1;
7202 if (input_available_clear_time
)
7203 *input_available_clear_time
= make_timespec (0, 0);
7207 deliver_input_available_signal (int sig
)
7209 deliver_process_signal (sig
, handle_input_available_signal
);
7211 #endif /* USABLE_SIGIO */
7214 /* User signal events. */
7216 struct user_signal_info
7218 /* Signal number. */
7221 /* Name of the signal. */
7224 /* Number of pending signals. */
7227 struct user_signal_info
*next
;
7230 /* List of user signals. */
7231 static struct user_signal_info
*user_signals
= NULL
;
7234 add_user_signal (int sig
, const char *name
)
7236 struct sigaction action
;
7237 struct user_signal_info
*p
;
7239 for (p
= user_signals
; p
; p
= p
->next
)
7241 /* Already added. */
7244 p
= xmalloc (sizeof *p
);
7246 p
->name
= xstrdup (name
);
7248 p
->next
= user_signals
;
7251 emacs_sigaction_init (&action
, deliver_user_signal
);
7252 sigaction (sig
, &action
, 0);
7256 handle_user_signal (int sig
)
7258 struct user_signal_info
*p
;
7259 const char *special_event_name
= NULL
;
7261 if (SYMBOLP (Vdebug_on_event
))
7262 special_event_name
= SSDATA (SYMBOL_NAME (Vdebug_on_event
));
7264 for (p
= user_signals
; p
; p
= p
->next
)
7267 if (special_event_name
7268 && strcmp (special_event_name
, p
->name
) == 0)
7270 /* Enter the debugger in many ways. */
7271 debug_on_next_call
= 1;
7274 Vinhibit_quit
= Qnil
;
7276 /* Eat the event. */
7282 if (interrupt_input
)
7283 handle_input_available_signal (sig
);
7287 /* Tell wait_reading_process_output that it needs to wake
7288 up and look around. */
7289 if (input_available_clear_time
)
7290 *input_available_clear_time
= make_timespec (0, 0);
7297 deliver_user_signal (int sig
)
7299 deliver_process_signal (sig
, handle_user_signal
);
7303 find_user_signal_name (int sig
)
7305 struct user_signal_info
*p
;
7307 for (p
= user_signals
; p
; p
= p
->next
)
7315 store_user_signal_events (void)
7317 struct user_signal_info
*p
;
7318 struct input_event buf
;
7319 bool buf_initialized
= 0;
7321 for (p
= user_signals
; p
; p
= p
->next
)
7322 if (p
->npending
> 0)
7324 if (! buf_initialized
)
7326 memset (&buf
, 0, sizeof buf
);
7327 buf
.kind
= USER_SIGNAL_EVENT
;
7328 buf
.frame_or_window
= selected_frame
;
7329 buf_initialized
= 1;
7335 kbd_buffer_store_event (&buf
);
7338 while (p
->npending
> 0);
7343 static void menu_bar_item (Lisp_Object
, Lisp_Object
, Lisp_Object
, void *);
7344 static Lisp_Object menu_bar_one_keymap_changed_items
;
7346 /* These variables hold the vector under construction within
7347 menu_bar_items and its subroutines, and the current index
7348 for storing into that vector. */
7349 static Lisp_Object menu_bar_items_vector
;
7350 static int menu_bar_items_index
;
7353 static const char *separator_names
[] = {
7358 "single-dashed-line",
7359 "double-dashed-line",
7361 "shadow-etched-out",
7362 "shadow-etched-in-dash",
7363 "shadow-etched-out-dash",
7364 "shadow-double-etched-in",
7365 "shadow-double-etched-out",
7366 "shadow-double-etched-in-dash",
7367 "shadow-double-etched-out-dash",
7371 /* Return true if LABEL specifies a separator. */
7374 menu_separator_name_p (const char *label
)
7378 else if (strlen (label
) > 3
7379 && memcmp (label
, "--", 2) == 0
7384 for (i
= 0; separator_names
[i
]; ++i
)
7385 if (strcmp (label
, separator_names
[i
]) == 0)
7390 /* It's a separator if it contains only dashes. */
7391 while (*label
== '-')
7393 return (*label
== 0);
7400 /* Return a vector of menu items for a menu bar, appropriate
7401 to the current buffer. Each item has three elements in the vector:
7404 OLD is an old vector we can optionally reuse, or nil. */
7407 menu_bar_items (Lisp_Object old
)
7409 /* The number of keymaps we're scanning right now, and the number of
7410 keymaps we have allocated space for. */
7413 /* maps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
7414 in the current keymaps, or nil where it is not a prefix. */
7417 Lisp_Object mapsbuf
[3];
7418 Lisp_Object def
, tail
;
7425 /* In order to build the menus, we need to call the keymap
7426 accessors. They all call QUIT. But this function is called
7427 during redisplay, during which a quit is fatal. So inhibit
7428 quitting while building the menus.
7429 We do this instead of specbind because (1) errors will clear it anyway
7430 and (2) this avoids risk of specpdl overflow. */
7431 oquit
= Vinhibit_quit
;
7435 menu_bar_items_vector
= old
;
7437 menu_bar_items_vector
= Fmake_vector (make_number (24), Qnil
);
7438 menu_bar_items_index
= 0;
7440 /* Build our list of keymaps.
7441 If we recognize a function key and replace its escape sequence in
7442 keybuf with its symbol, or if the sequence starts with a mouse
7443 click and we need to switch buffers, we jump back here to rebuild
7444 the initial keymaps from the current buffer. */
7448 /* Should overriding-terminal-local-map and overriding-local-map apply? */
7449 if (!NILP (Voverriding_local_map_menu_flag
)
7450 && !NILP (Voverriding_local_map
))
7452 /* Yes, use them (if non-nil) as well as the global map. */
7455 if (!NILP (KVAR (current_kboard
, Voverriding_terminal_local_map
)))
7456 maps
[nmaps
++] = KVAR (current_kboard
, Voverriding_terminal_local_map
);
7457 if (!NILP (Voverriding_local_map
))
7458 maps
[nmaps
++] = Voverriding_local_map
;
7462 /* No, so use major and minor mode keymaps and keymap property.
7463 Note that menu-bar bindings in the local-map and keymap
7464 properties may not work reliable, as they are only
7465 recognized when the menu-bar (or mode-line) is updated,
7466 which does not normally happen after every command. */
7469 nminor
= current_minor_maps (NULL
, &tmaps
);
7470 SAFE_NALLOCA (maps
, 1, nminor
+ 4);
7472 tem
= KVAR (current_kboard
, Voverriding_terminal_local_map
);
7473 if (!NILP (tem
) && !NILP (Voverriding_local_map_menu_flag
))
7474 maps
[nmaps
++] = tem
;
7475 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
7476 maps
[nmaps
++] = tem
;
7477 memcpy (maps
+ nmaps
, tmaps
, nminor
* sizeof (maps
[0]));
7479 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
7481 maps
[nmaps
++] = current_global_map
;
7484 /* Look up in each map the dummy prefix key `menu-bar'. */
7486 for (mapno
= nmaps
- 1; mapno
>= 0; mapno
--)
7487 if (!NILP (maps
[mapno
]))
7489 def
= get_keymap (access_keymap (maps
[mapno
], Qmenu_bar
, 1, 0, 1),
7493 menu_bar_one_keymap_changed_items
= Qnil
;
7494 map_keymap_canonical (def
, menu_bar_item
, Qnil
, NULL
);
7498 /* Move to the end those items that should be at the end. */
7500 for (tail
= Vmenu_bar_final_items
; CONSP (tail
); tail
= XCDR (tail
))
7503 int end
= menu_bar_items_index
;
7505 for (i
= 0; i
< end
; i
+= 4)
7506 if (EQ (XCAR (tail
), AREF (menu_bar_items_vector
, i
)))
7508 Lisp_Object tem0
, tem1
, tem2
, tem3
;
7509 /* Move the item at index I to the end,
7510 shifting all the others forward. */
7511 tem0
= AREF (menu_bar_items_vector
, i
+ 0);
7512 tem1
= AREF (menu_bar_items_vector
, i
+ 1);
7513 tem2
= AREF (menu_bar_items_vector
, i
+ 2);
7514 tem3
= AREF (menu_bar_items_vector
, i
+ 3);
7516 memmove (aref_addr (menu_bar_items_vector
, i
),
7517 aref_addr (menu_bar_items_vector
, i
+ 4),
7518 (end
- i
- 4) * word_size
);
7519 ASET (menu_bar_items_vector
, end
- 4, tem0
);
7520 ASET (menu_bar_items_vector
, end
- 3, tem1
);
7521 ASET (menu_bar_items_vector
, end
- 2, tem2
);
7522 ASET (menu_bar_items_vector
, end
- 1, tem3
);
7527 /* Add nil, nil, nil, nil at the end. */
7529 int i
= menu_bar_items_index
;
7530 if (i
+ 4 > ASIZE (menu_bar_items_vector
))
7531 menu_bar_items_vector
7532 = larger_vector (menu_bar_items_vector
, 4, -1);
7533 /* Add this item. */
7534 ASET (menu_bar_items_vector
, i
, Qnil
); i
++;
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 menu_bar_items_index
= i
;
7541 Vinhibit_quit
= oquit
;
7543 return menu_bar_items_vector
;
7546 /* Add one item to menu_bar_items_vector, for KEY, ITEM_STRING and DEF.
7547 If there's already an item for KEY, add this DEF to it. */
7549 Lisp_Object item_properties
;
7552 menu_bar_item (Lisp_Object key
, Lisp_Object item
, Lisp_Object dummy1
, void *dummy2
)
7554 struct gcpro gcpro1
;
7559 if (EQ (item
, Qundefined
))
7561 /* If a map has an explicit `undefined' as definition,
7562 discard any previously made menu bar item. */
7564 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7565 if (EQ (key
, AREF (menu_bar_items_vector
, i
)))
7567 if (menu_bar_items_index
> i
+ 4)
7568 memmove (aref_addr (menu_bar_items_vector
, i
),
7569 aref_addr (menu_bar_items_vector
, i
+ 4),
7570 (menu_bar_items_index
- i
- 4) * word_size
);
7571 menu_bar_items_index
-= 4;
7575 /* If this keymap has already contributed to this KEY,
7576 don't contribute to it a second time. */
7577 tem
= Fmemq (key
, menu_bar_one_keymap_changed_items
);
7578 if (!NILP (tem
) || NILP (item
))
7581 menu_bar_one_keymap_changed_items
7582 = Fcons (key
, menu_bar_one_keymap_changed_items
);
7584 /* We add to menu_bar_one_keymap_changed_items before doing the
7585 parse_menu_item, so that if it turns out it wasn't a menu item,
7586 it still correctly hides any further menu item. */
7588 parsed
= parse_menu_item (item
, 1);
7593 item
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7595 /* Find any existing item for this KEY. */
7596 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7597 if (EQ (key
, AREF (menu_bar_items_vector
, i
)))
7600 /* If we did not find this KEY, add it at the end. */
7601 if (i
== menu_bar_items_index
)
7603 /* If vector is too small, get a bigger one. */
7604 if (i
+ 4 > ASIZE (menu_bar_items_vector
))
7605 menu_bar_items_vector
= larger_vector (menu_bar_items_vector
, 4, -1);
7606 /* Add this item. */
7607 ASET (menu_bar_items_vector
, i
, key
); i
++;
7608 ASET (menu_bar_items_vector
, i
,
7609 AREF (item_properties
, ITEM_PROPERTY_NAME
)); i
++;
7610 ASET (menu_bar_items_vector
, i
, list1 (item
)); i
++;
7611 ASET (menu_bar_items_vector
, i
, make_number (0)); i
++;
7612 menu_bar_items_index
= i
;
7614 /* We did find an item for this KEY. Add ITEM to its list of maps. */
7618 old
= AREF (menu_bar_items_vector
, i
+ 2);
7619 /* If the new and the old items are not both keymaps,
7620 the lookup will only find `item'. */
7621 item
= Fcons (item
, KEYMAPP (item
) && KEYMAPP (XCAR (old
)) ? old
: Qnil
);
7622 ASET (menu_bar_items_vector
, i
+ 2, item
);
7626 /* This is used as the handler when calling menu_item_eval_property. */
7628 menu_item_eval_property_1 (Lisp_Object arg
)
7630 /* If we got a quit from within the menu computation,
7631 quit all the way out of it. This takes care of C-] in the debugger. */
7632 if (CONSP (arg
) && EQ (XCAR (arg
), Qquit
))
7633 Fsignal (Qquit
, Qnil
);
7639 eval_dyn (Lisp_Object form
)
7641 return Feval (form
, Qnil
);
7644 /* Evaluate an expression and return the result (or nil if something
7645 went wrong). Used to evaluate dynamic parts of menu items. */
7647 menu_item_eval_property (Lisp_Object sexpr
)
7649 ptrdiff_t count
= SPECPDL_INDEX ();
7651 specbind (Qinhibit_redisplay
, Qt
);
7652 val
= internal_condition_case_1 (eval_dyn
, sexpr
, Qerror
,
7653 menu_item_eval_property_1
);
7654 return unbind_to (count
, val
);
7657 /* This function parses a menu item and leaves the result in the
7658 vector item_properties.
7659 ITEM is a key binding, a possible menu item.
7660 INMENUBAR is > 0 when this is considered for an entry in a menu bar
7662 INMENUBAR is < 0 when this is considered for an entry in a keyboard menu.
7663 parse_menu_item returns true if the item is a menu item and false
7667 parse_menu_item (Lisp_Object item
, int inmenubar
)
7669 Lisp_Object def
, tem
, item_string
, start
;
7671 Lisp_Object keyhint
;
7680 /* Create item_properties vector if necessary. */
7681 if (NILP (item_properties
))
7683 = Fmake_vector (make_number (ITEM_PROPERTY_ENABLE
+ 1), Qnil
);
7685 /* Initialize optional entries. */
7686 for (i
= ITEM_PROPERTY_DEF
; i
< ITEM_PROPERTY_ENABLE
; i
++)
7687 ASET (item_properties
, i
, Qnil
);
7688 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7690 /* Save the item here to protect it from GC. */
7691 ASET (item_properties
, ITEM_PROPERTY_ITEM
, item
);
7693 item_string
= XCAR (item
);
7697 if (STRINGP (item_string
))
7699 /* Old format menu item. */
7700 ASET (item_properties
, ITEM_PROPERTY_NAME
, item_string
);
7702 /* Maybe help string. */
7703 if (CONSP (item
) && STRINGP (XCAR (item
)))
7705 ASET (item_properties
, ITEM_PROPERTY_HELP
, XCAR (item
));
7710 /* Maybe an obsolete key binding cache. */
7711 if (CONSP (item
) && CONSP (XCAR (item
))
7712 && (NILP (XCAR (XCAR (item
)))
7713 || VECTORP (XCAR (XCAR (item
)))))
7716 /* This is the real definition--the function to run. */
7717 ASET (item_properties
, ITEM_PROPERTY_DEF
, item
);
7719 /* Get enable property, if any. */
7722 tem
= Fget (item
, Qmenu_enable
);
7723 if (!NILP (Venable_disabled_menus_and_buttons
))
7724 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7725 else if (!NILP (tem
))
7726 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, tem
);
7729 else if (EQ (item_string
, Qmenu_item
) && CONSP (item
))
7731 /* New format menu item. */
7732 ASET (item_properties
, ITEM_PROPERTY_NAME
, XCAR (item
));
7733 start
= XCDR (item
);
7736 /* We have a real binding. */
7737 ASET (item_properties
, ITEM_PROPERTY_DEF
, XCAR (start
));
7739 item
= XCDR (start
);
7740 /* Is there an obsolete cache list with key equivalences. */
7741 if (CONSP (item
) && CONSP (XCAR (item
)))
7744 /* Parse properties. */
7745 while (CONSP (item
) && CONSP (XCDR (item
)))
7750 if (EQ (tem
, QCenable
))
7752 if (!NILP (Venable_disabled_menus_and_buttons
))
7753 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7755 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, XCAR (item
));
7757 else if (EQ (tem
, QCvisible
))
7759 /* If got a visible property and that evaluates to nil
7760 then ignore this item. */
7761 tem
= menu_item_eval_property (XCAR (item
));
7765 else if (EQ (tem
, QChelp
))
7766 ASET (item_properties
, ITEM_PROPERTY_HELP
, XCAR (item
));
7767 else if (EQ (tem
, QCfilter
))
7769 else if (EQ (tem
, QCkey_sequence
))
7772 if (SYMBOLP (tem
) || STRINGP (tem
) || VECTORP (tem
))
7773 /* Be GC protected. Set keyhint to item instead of tem. */
7776 else if (EQ (tem
, QCkeys
))
7779 if (CONSP (tem
) || STRINGP (tem
))
7780 ASET (item_properties
, ITEM_PROPERTY_KEYEQ
, tem
);
7782 else if (EQ (tem
, QCbutton
) && CONSP (XCAR (item
)))
7787 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
7789 ASET (item_properties
, ITEM_PROPERTY_SELECTED
,
7791 ASET (item_properties
, ITEM_PROPERTY_TYPE
, type
);
7797 else if (inmenubar
|| !NILP (start
))
7801 return 0; /* not a menu item */
7803 /* If item string is not a string, evaluate it to get string.
7804 If we don't get a string, skip this item. */
7805 item_string
= AREF (item_properties
, ITEM_PROPERTY_NAME
);
7806 if (!(STRINGP (item_string
)))
7808 item_string
= menu_item_eval_property (item_string
);
7809 if (!STRINGP (item_string
))
7811 ASET (item_properties
, ITEM_PROPERTY_NAME
, item_string
);
7814 /* If got a filter apply it on definition. */
7815 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7818 def
= menu_item_eval_property (list2 (XCAR (filter
),
7819 list2 (Qquote
, def
)));
7821 ASET (item_properties
, ITEM_PROPERTY_DEF
, def
);
7824 /* Enable or disable selection of item. */
7825 tem
= AREF (item_properties
, ITEM_PROPERTY_ENABLE
);
7828 tem
= menu_item_eval_property (tem
);
7829 if (inmenubar
&& NILP (tem
))
7830 return 0; /* Ignore disabled items in menu bar. */
7831 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, tem
);
7834 /* If we got no definition, this item is just unselectable text which
7835 is OK in a submenu but not in the menubar. */
7837 return (!inmenubar
);
7839 /* See if this is a separate pane or a submenu. */
7840 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7841 tem
= get_keymap (def
, 0, 1);
7842 /* For a subkeymap, just record its details and exit. */
7845 ASET (item_properties
, ITEM_PROPERTY_MAP
, tem
);
7846 ASET (item_properties
, ITEM_PROPERTY_DEF
, tem
);
7850 /* At the top level in the menu bar, do likewise for commands also.
7851 The menu bar does not display equivalent key bindings anyway.
7852 ITEM_PROPERTY_DEF is already set up properly. */
7856 { /* This is a command. See if there is an equivalent key binding. */
7857 Lisp_Object keyeq
= AREF (item_properties
, ITEM_PROPERTY_KEYEQ
);
7858 AUTO_STRING (space_space
, " ");
7860 /* The previous code preferred :key-sequence to :keys, so we
7861 preserve this behavior. */
7862 if (STRINGP (keyeq
) && !CONSP (keyhint
))
7863 keyeq
= concat2 (space_space
, Fsubstitute_command_keys (keyeq
));
7866 Lisp_Object prefix
= keyeq
;
7867 Lisp_Object keys
= Qnil
;
7871 def
= XCAR (prefix
);
7872 prefix
= XCDR (prefix
);
7875 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7877 if (CONSP (keyhint
) && !NILP (XCAR (keyhint
)))
7879 keys
= XCAR (keyhint
);
7880 tem
= Fkey_binding (keys
, Qnil
, Qnil
, Qnil
);
7882 /* We have a suggested key. Is it bound to the command? */
7885 /* If the command is an alias for another
7886 (such as lmenu.el set it up), check if the
7887 original command matches the cached command. */
7889 && EQ (tem
, XSYMBOL (def
)->function
))))
7894 keys
= Fwhere_is_internal (def
, Qnil
, Qt
, Qnil
, Qnil
);
7898 tem
= Fkey_description (keys
, Qnil
);
7901 if (STRINGP (XCAR (prefix
)))
7902 tem
= concat2 (XCAR (prefix
), tem
);
7903 if (STRINGP (XCDR (prefix
)))
7904 tem
= concat2 (tem
, XCDR (prefix
));
7906 keyeq
= concat2 (space_space
, tem
);
7912 /* If we have an equivalent key binding, use that. */
7913 ASET (item_properties
, ITEM_PROPERTY_KEYEQ
, keyeq
);
7916 /* Include this when menu help is implemented.
7917 tem = XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP];
7918 if (!(NILP (tem) || STRINGP (tem)))
7920 tem = menu_item_eval_property (tem);
7923 XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP] = tem;
7927 /* Handle radio buttons or toggle boxes. */
7928 tem
= AREF (item_properties
, ITEM_PROPERTY_SELECTED
);
7930 ASET (item_properties
, ITEM_PROPERTY_SELECTED
,
7931 menu_item_eval_property (tem
));
7938 /***********************************************************************
7940 ***********************************************************************/
7942 /* A vector holding tool bar items while they are parsed in function
7943 tool_bar_items. Each item occupies TOOL_BAR_ITEM_NSCLOTS elements
7946 static Lisp_Object tool_bar_items_vector
;
7948 /* A vector holding the result of parse_tool_bar_item. Layout is like
7949 the one for a single item in tool_bar_items_vector. */
7951 static Lisp_Object tool_bar_item_properties
;
7953 /* Next free index in tool_bar_items_vector. */
7955 static int ntool_bar_items
;
7957 /* Function prototypes. */
7959 static void init_tool_bar_items (Lisp_Object
);
7960 static void process_tool_bar_item (Lisp_Object
, Lisp_Object
, Lisp_Object
,
7962 static bool parse_tool_bar_item (Lisp_Object
, Lisp_Object
);
7963 static void append_tool_bar_item (void);
7966 /* Return a vector of tool bar items for keymaps currently in effect.
7967 Reuse vector REUSE if non-nil. Return in *NITEMS the number of
7968 tool bar items found. */
7971 tool_bar_items (Lisp_Object reuse
, int *nitems
)
7974 Lisp_Object mapsbuf
[3];
7982 /* In order to build the menus, we need to call the keymap
7983 accessors. They all call QUIT. But this function is called
7984 during redisplay, during which a quit is fatal. So inhibit
7985 quitting while building the menus. We do this instead of
7986 specbind because (1) errors will clear it anyway and (2) this
7987 avoids risk of specpdl overflow. */
7988 oquit
= Vinhibit_quit
;
7991 /* Initialize tool_bar_items_vector and protect it from GC. */
7992 init_tool_bar_items (reuse
);
7994 /* Build list of keymaps in maps. Set nmaps to the number of maps
7997 /* Should overriding-terminal-local-map and overriding-local-map apply? */
7998 if (!NILP (Voverriding_local_map_menu_flag
)
7999 && !NILP (Voverriding_local_map
))
8001 /* Yes, use them (if non-nil) as well as the global map. */
8004 if (!NILP (KVAR (current_kboard
, Voverriding_terminal_local_map
)))
8005 maps
[nmaps
++] = KVAR (current_kboard
, Voverriding_terminal_local_map
);
8006 if (!NILP (Voverriding_local_map
))
8007 maps
[nmaps
++] = Voverriding_local_map
;
8011 /* No, so use major and minor mode keymaps and keymap property.
8012 Note that tool-bar bindings in the local-map and keymap
8013 properties may not work reliable, as they are only
8014 recognized when the tool-bar (or mode-line) is updated,
8015 which does not normally happen after every command. */
8018 nminor
= current_minor_maps (NULL
, &tmaps
);
8019 SAFE_NALLOCA (maps
, 1, nminor
+ 4);
8021 tem
= KVAR (current_kboard
, Voverriding_terminal_local_map
);
8022 if (!NILP (tem
) && !NILP (Voverriding_local_map_menu_flag
))
8023 maps
[nmaps
++] = tem
;
8024 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
8025 maps
[nmaps
++] = tem
;
8026 memcpy (maps
+ nmaps
, tmaps
, nminor
* sizeof (maps
[0]));
8028 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
8031 /* Add global keymap at the end. */
8032 maps
[nmaps
++] = current_global_map
;
8034 /* Process maps in reverse order and look up in each map the prefix
8036 for (i
= nmaps
- 1; i
>= 0; --i
)
8037 if (!NILP (maps
[i
]))
8041 keymap
= get_keymap (access_keymap (maps
[i
], Qtool_bar
, 1, 0, 1), 0, 1);
8043 map_keymap (keymap
, process_tool_bar_item
, Qnil
, NULL
, 1);
8046 Vinhibit_quit
= oquit
;
8047 *nitems
= ntool_bar_items
/ TOOL_BAR_ITEM_NSLOTS
;
8049 return tool_bar_items_vector
;
8053 /* Process the definition of KEY which is DEF. */
8056 process_tool_bar_item (Lisp_Object key
, Lisp_Object def
, Lisp_Object data
, void *args
)
8059 struct gcpro gcpro1
, gcpro2
;
8061 /* Protect KEY and DEF from GC because parse_tool_bar_item may call
8065 if (EQ (def
, Qundefined
))
8067 /* If a map has an explicit `undefined' as definition,
8068 discard any previously made item. */
8069 for (i
= 0; i
< ntool_bar_items
; i
+= TOOL_BAR_ITEM_NSLOTS
)
8071 Lisp_Object
*v
= XVECTOR (tool_bar_items_vector
)->contents
+ i
;
8073 if (EQ (key
, v
[TOOL_BAR_ITEM_KEY
]))
8075 if (ntool_bar_items
> i
+ TOOL_BAR_ITEM_NSLOTS
)
8076 memmove (v
, v
+ TOOL_BAR_ITEM_NSLOTS
,
8077 ((ntool_bar_items
- i
- TOOL_BAR_ITEM_NSLOTS
)
8079 ntool_bar_items
-= TOOL_BAR_ITEM_NSLOTS
;
8084 else if (parse_tool_bar_item (key
, def
))
8085 /* Append a new tool bar item to tool_bar_items_vector. Accept
8086 more than one definition for the same key. */
8087 append_tool_bar_item ();
8092 /* Access slot with index IDX of vector tool_bar_item_properties. */
8093 #define PROP(IDX) AREF (tool_bar_item_properties, (IDX))
8095 set_prop (ptrdiff_t idx
, Lisp_Object val
)
8097 ASET (tool_bar_item_properties
, idx
, val
);
8101 /* Parse a tool bar item specification ITEM for key KEY and return the
8102 result in tool_bar_item_properties. Value is false if ITEM is
8105 ITEM is a list `(menu-item CAPTION BINDING PROPS...)'.
8107 CAPTION is the caption of the item, If it's not a string, it is
8108 evaluated to get a string.
8110 BINDING is the tool bar item's binding. Tool-bar items with keymaps
8111 as binding are currently ignored.
8113 The following properties are recognized:
8117 FORM is evaluated and specifies whether the tool bar item is
8118 enabled or disabled.
8122 FORM is evaluated and specifies whether the tool bar item is visible.
8124 - `:filter FUNCTION'
8126 FUNCTION is invoked with one parameter `(quote BINDING)'. Its
8127 result is stored as the new binding.
8129 - `:button (TYPE SELECTED)'
8131 TYPE must be one of `:radio' or `:toggle'. SELECTED is evaluated
8132 and specifies whether the button is selected (pressed) or not.
8136 IMAGES is either a single image specification or a vector of four
8137 image specifications. See enum tool_bar_item_images.
8139 - `:help HELP-STRING'.
8141 Gives a help string to display for the tool bar item.
8143 - `:label LABEL-STRING'.
8145 A text label to show with the tool bar button if labels are enabled. */
8148 parse_tool_bar_item (Lisp_Object key
, Lisp_Object item
)
8150 Lisp_Object filter
= Qnil
;
8151 Lisp_Object caption
;
8153 bool have_label
= 0;
8155 /* Definition looks like `(menu-item CAPTION BINDING PROPS...)'.
8156 Rule out items that aren't lists, don't start with
8157 `menu-item' or whose rest following `tool-bar-item' is not a
8162 /* As an exception, allow old-style menu separators. */
8163 if (STRINGP (XCAR (item
)))
8164 item
= list1 (XCAR (item
));
8165 else if (!EQ (XCAR (item
), Qmenu_item
)
8166 || (item
= XCDR (item
), !CONSP (item
)))
8169 /* Create tool_bar_item_properties vector if necessary. Reset it to
8171 if (VECTORP (tool_bar_item_properties
))
8173 for (i
= 0; i
< TOOL_BAR_ITEM_NSLOTS
; ++i
)
8177 tool_bar_item_properties
8178 = Fmake_vector (make_number (TOOL_BAR_ITEM_NSLOTS
), Qnil
);
8181 set_prop (TOOL_BAR_ITEM_KEY
, key
);
8182 set_prop (TOOL_BAR_ITEM_ENABLED_P
, Qt
);
8184 /* Get the caption of the item. If the caption is not a string,
8185 evaluate it to get a string. If we don't get a string, skip this
8187 caption
= XCAR (item
);
8188 if (!STRINGP (caption
))
8190 caption
= menu_item_eval_property (caption
);
8191 if (!STRINGP (caption
))
8194 set_prop (TOOL_BAR_ITEM_CAPTION
, caption
);
8196 /* If the rest following the caption is not a list, the menu item is
8197 either a separator, or invalid. */
8201 if (menu_separator_name_p (SSDATA (caption
)))
8203 set_prop (TOOL_BAR_ITEM_TYPE
, Qt
);
8204 #if !defined (USE_GTK) && !defined (HAVE_NS)
8205 /* If we use build_desired_tool_bar_string to render the
8206 tool bar, the separator is rendered as an image. */
8207 set_prop (TOOL_BAR_ITEM_IMAGES
,
8208 (menu_item_eval_property
8209 (Vtool_bar_separator_image_expression
)));
8210 set_prop (TOOL_BAR_ITEM_ENABLED_P
, Qnil
);
8211 set_prop (TOOL_BAR_ITEM_SELECTED_P
, Qnil
);
8212 set_prop (TOOL_BAR_ITEM_CAPTION
, Qnil
);
8219 /* Store the binding. */
8220 set_prop (TOOL_BAR_ITEM_BINDING
, XCAR (item
));
8223 /* Ignore cached key binding, if any. */
8224 if (CONSP (item
) && CONSP (XCAR (item
)))
8227 /* Process the rest of the properties. */
8228 for (; CONSP (item
) && CONSP (XCDR (item
)); item
= XCDR (XCDR (item
)))
8230 Lisp_Object ikey
, value
;
8233 value
= XCAR (XCDR (item
));
8235 if (EQ (ikey
, QCenable
))
8237 /* `:enable FORM'. */
8238 if (!NILP (Venable_disabled_menus_and_buttons
))
8239 set_prop (TOOL_BAR_ITEM_ENABLED_P
, Qt
);
8241 set_prop (TOOL_BAR_ITEM_ENABLED_P
, value
);
8243 else if (EQ (ikey
, QCvisible
))
8245 /* `:visible FORM'. If got a visible property and that
8246 evaluates to nil then ignore this item. */
8247 if (NILP (menu_item_eval_property (value
)))
8250 else if (EQ (ikey
, QChelp
))
8251 /* `:help HELP-STRING'. */
8252 set_prop (TOOL_BAR_ITEM_HELP
, value
);
8253 else if (EQ (ikey
, QCvert_only
))
8254 /* `:vert-only t/nil'. */
8255 set_prop (TOOL_BAR_ITEM_VERT_ONLY
, value
);
8256 else if (EQ (ikey
, QClabel
))
8258 const char *bad_label
= "!!?GARBLED ITEM?!!";
8259 /* `:label LABEL-STRING'. */
8260 set_prop (TOOL_BAR_ITEM_LABEL
,
8261 STRINGP (value
) ? value
: build_string (bad_label
));
8264 else if (EQ (ikey
, QCfilter
))
8265 /* ':filter FORM'. */
8267 else if (EQ (ikey
, QCbutton
) && CONSP (value
))
8269 /* `:button (TYPE . SELECTED)'. */
8270 Lisp_Object type
, selected
;
8272 type
= XCAR (value
);
8273 selected
= XCDR (value
);
8274 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
8276 set_prop (TOOL_BAR_ITEM_SELECTED_P
, selected
);
8277 set_prop (TOOL_BAR_ITEM_TYPE
, type
);
8280 else if (EQ (ikey
, QCimage
)
8282 || (VECTORP (value
) && ASIZE (value
) == 4)))
8283 /* Value is either a single image specification or a vector
8284 of 4 such specifications for the different button states. */
8285 set_prop (TOOL_BAR_ITEM_IMAGES
, value
);
8286 else if (EQ (ikey
, QCrtl
))
8288 set_prop (TOOL_BAR_ITEM_RTL_IMAGE
, value
);
8294 /* Try to make one from caption and key. */
8295 Lisp_Object tkey
= PROP (TOOL_BAR_ITEM_KEY
);
8296 Lisp_Object tcapt
= PROP (TOOL_BAR_ITEM_CAPTION
);
8297 const char *label
= SYMBOLP (tkey
) ? SSDATA (SYMBOL_NAME (tkey
)) : "";
8298 const char *capt
= STRINGP (tcapt
) ? SSDATA (tcapt
) : "";
8300 2 * max (0, min (tool_bar_max_label_size
, STRING_BYTES_BOUND
/ 2));
8301 char *buf
= xmalloc (max_lbl
+ 1);
8302 Lisp_Object new_lbl
;
8303 ptrdiff_t caption_len
= strlen (capt
);
8305 if (caption_len
<= max_lbl
&& capt
[0] != '\0')
8308 while (caption_len
> 0 && buf
[caption_len
- 1] == '.')
8310 buf
[caption_len
] = '\0';
8314 if (strlen (label
) <= max_lbl
&& label
[0] != '\0')
8318 strcpy (buf
, label
);
8320 for (j
= 0; buf
[j
] != '\0'; ++j
)
8328 new_lbl
= Fupcase_initials (build_string (label
));
8329 if (SCHARS (new_lbl
) <= tool_bar_max_label_size
)
8330 set_prop (TOOL_BAR_ITEM_LABEL
, new_lbl
);
8332 set_prop (TOOL_BAR_ITEM_LABEL
, empty_unibyte_string
);
8336 /* If got a filter apply it on binding. */
8338 set_prop (TOOL_BAR_ITEM_BINDING
,
8339 (menu_item_eval_property
8342 PROP (TOOL_BAR_ITEM_BINDING
))))));
8344 /* See if the binding is a keymap. Give up if it is. */
8345 if (CONSP (get_keymap (PROP (TOOL_BAR_ITEM_BINDING
), 0, 1)))
8348 /* Enable or disable selection of item. */
8349 if (!EQ (PROP (TOOL_BAR_ITEM_ENABLED_P
), Qt
))
8350 set_prop (TOOL_BAR_ITEM_ENABLED_P
,
8351 menu_item_eval_property (PROP (TOOL_BAR_ITEM_ENABLED_P
)));
8353 /* Handle radio buttons or toggle boxes. */
8354 if (!NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
)))
8355 set_prop (TOOL_BAR_ITEM_SELECTED_P
,
8356 menu_item_eval_property (PROP (TOOL_BAR_ITEM_SELECTED_P
)));
8364 /* Initialize tool_bar_items_vector. REUSE, if non-nil, is a vector
8365 that can be reused. */
8368 init_tool_bar_items (Lisp_Object reuse
)
8370 if (VECTORP (reuse
))
8371 tool_bar_items_vector
= reuse
;
8373 tool_bar_items_vector
= Fmake_vector (make_number (64), Qnil
);
8374 ntool_bar_items
= 0;
8378 /* Append parsed tool bar item properties from
8379 tool_bar_item_properties */
8382 append_tool_bar_item (void)
8386 - (ASIZE (tool_bar_items_vector
) - TOOL_BAR_ITEM_NSLOTS
));
8388 /* Enlarge tool_bar_items_vector if necessary. */
8390 tool_bar_items_vector
= larger_vector (tool_bar_items_vector
, incr
, -1);
8392 /* Append entries from tool_bar_item_properties to the end of
8393 tool_bar_items_vector. */
8394 vcopy (tool_bar_items_vector
, ntool_bar_items
,
8395 XVECTOR (tool_bar_item_properties
)->contents
, TOOL_BAR_ITEM_NSLOTS
);
8396 ntool_bar_items
+= TOOL_BAR_ITEM_NSLOTS
;
8403 /* Read a character using menus based on the keymap MAP.
8404 Return nil if there are no menus in the maps.
8405 Return t if we displayed a menu but the user rejected it.
8407 PREV_EVENT is the previous input event, or nil if we are reading
8408 the first event of a key sequence.
8410 If USED_MOUSE_MENU is non-null, set *USED_MOUSE_MENU to true
8411 if we used a mouse menu to read the input, or false otherwise. If
8412 USED_MOUSE_MENU is null, don't dereference it.
8414 The prompting is done based on the prompt-string of the map
8415 and the strings associated with various map elements.
8417 This can be done with X menus or with menus put in the minibuf.
8418 These are done in different ways, depending on how the input will be read.
8419 Menus using X are done after auto-saving in read-char, getting the input
8420 event from Fx_popup_menu; menus using the minibuf use read_char recursively
8421 and do auto-saving in the inner call of read_char. */
8424 read_char_x_menu_prompt (Lisp_Object map
,
8425 Lisp_Object prev_event
, bool *used_mouse_menu
)
8427 if (used_mouse_menu
)
8428 *used_mouse_menu
= 0;
8430 /* Use local over global Menu maps. */
8432 if (! menu_prompting
)
8435 /* If we got to this point via a mouse click,
8436 use a real menu for mouse selection. */
8437 if (EVENT_HAS_PARAMETERS (prev_event
)
8438 && !EQ (XCAR (prev_event
), Qmenu_bar
)
8439 && !EQ (XCAR (prev_event
), Qtool_bar
))
8441 /* Display the menu and get the selection. */
8444 value
= Fx_popup_menu (prev_event
, get_keymap (map
, 0, 1));
8449 record_menu_key (XCAR (value
));
8451 /* If we got multiple events, unread all but
8453 There is no way to prevent those unread events
8454 from showing up later in last_nonmenu_event.
8455 So turn symbol and integer events into lists,
8456 to indicate that they came from a mouse menu,
8457 so that when present in last_nonmenu_event
8458 they won't confuse things. */
8459 for (tem
= XCDR (value
); CONSP (tem
); tem
= XCDR (tem
))
8461 record_menu_key (XCAR (tem
));
8462 if (SYMBOLP (XCAR (tem
))
8463 || INTEGERP (XCAR (tem
)))
8464 XSETCAR (tem
, Fcons (XCAR (tem
), Qdisabled
));
8467 /* If we got more than one event, put all but the first
8468 onto this list to be read later.
8469 Return just the first event now. */
8470 Vunread_command_events
8471 = nconc2 (XCDR (value
), Vunread_command_events
);
8472 value
= XCAR (value
);
8474 else if (NILP (value
))
8476 if (used_mouse_menu
)
8477 *used_mouse_menu
= 1;
8484 read_char_minibuf_menu_prompt (int commandflag
,
8489 /* FIXME: Use the minibuffer's frame width. */
8490 ptrdiff_t width
= FRAME_COLS (SELECTED_FRAME ()) - 4;
8492 bool nobindings
= 1;
8493 Lisp_Object rest
, vector
;
8494 Lisp_Object prompt_strings
= Qnil
;
8498 if (! menu_prompting
)
8501 map
= get_keymap (map
, 0, 1);
8502 name
= Fkeymap_prompt (map
);
8504 /* If we don't have any menus, just read a character normally. */
8505 if (!STRINGP (name
))
8508 #define PUSH_C_STR(str, listvar) \
8509 listvar = Fcons (build_unibyte_string (str), listvar)
8511 /* Prompt string always starts with map's prompt, and a space. */
8512 prompt_strings
= Fcons (name
, prompt_strings
);
8513 PUSH_C_STR (": ", prompt_strings
);
8514 nlength
= SCHARS (name
) + 2;
8518 /* Present the documented bindings, a line at a time. */
8522 Lisp_Object menu_strings
= prompt_strings
;
8523 ptrdiff_t i
= nlength
;
8525 Lisp_Object orig_defn_macro
;
8527 /* Loop over elements of map. */
8532 /* FIXME: Use map_keymap to handle new keymap formats. */
8534 /* At end of map, wrap around if just starting,
8535 or end this line if already have something on it. */
8538 if (notfirst
|| nobindings
)
8544 /* Look at the next element of the map. */
8546 elt
= AREF (vector
, idx
);
8548 elt
= Fcar_safe (rest
);
8550 if (idx
< 0 && VECTORP (elt
))
8552 /* If we found a dense table in the keymap,
8553 advanced past it, but start scanning its contents. */
8554 rest
= Fcdr_safe (rest
);
8560 /* An ordinary element. */
8561 Lisp_Object event
, tem
;
8565 event
= Fcar_safe (elt
); /* alist */
8566 elt
= Fcdr_safe (elt
);
8570 XSETINT (event
, idx
); /* vector */
8573 /* Ignore the element if it has no prompt string. */
8574 if (INTEGERP (event
) && parse_menu_item (elt
, -1))
8576 /* True if the char to type matches the string. */
8578 Lisp_Object upcased_event
, downcased_event
;
8579 Lisp_Object desc
= Qnil
;
8581 = AREF (item_properties
, ITEM_PROPERTY_NAME
);
8583 upcased_event
= Fupcase (event
);
8584 downcased_event
= Fdowncase (event
);
8585 char_matches
= (XINT (upcased_event
) == SREF (s
, 0)
8586 || XINT (downcased_event
) == SREF (s
, 0));
8588 desc
= Fsingle_key_description (event
, Qnil
);
8590 #if 0 /* It is redundant to list the equivalent key bindings because
8591 the prefix is what the user has already typed. */
8593 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_KEYEQ
];
8595 /* Insert equivalent keybinding. */
8596 s
= concat2 (s
, tem
);
8599 = AREF (item_properties
, ITEM_PROPERTY_TYPE
);
8600 if (EQ (tem
, QCradio
) || EQ (tem
, QCtoggle
))
8602 /* Insert button prefix. */
8603 Lisp_Object selected
8604 = AREF (item_properties
, ITEM_PROPERTY_SELECTED
);
8605 AUTO_STRING (radio_yes
, "(*) ");
8606 AUTO_STRING (radio_no
, "( ) ");
8607 AUTO_STRING (check_yes
, "[X] ");
8608 AUTO_STRING (check_no
, "[ ] ");
8609 if (EQ (tem
, QCradio
))
8610 tem
= NILP (selected
) ? radio_yes
: radio_no
;
8612 tem
= NILP (selected
) ? check_yes
: check_no
;
8613 s
= concat2 (tem
, s
);
8617 /* If we have room for the prompt string, add it to this line.
8618 If this is the first on the line, always add it. */
8619 if ((SCHARS (s
) + i
+ 2
8620 + (char_matches
? 0 : SCHARS (desc
) + 3))
8624 ptrdiff_t thiswidth
;
8626 /* Punctuate between strings. */
8629 PUSH_C_STR (", ", menu_strings
);
8635 /* If the char to type doesn't match the string's
8636 first char, explicitly show what char to type. */
8639 /* Add as much of string as fits. */
8640 thiswidth
= min (SCHARS (desc
), width
- i
);
8642 = Fcons (Fsubstring (desc
, make_number (0),
8643 make_number (thiswidth
)),
8646 PUSH_C_STR (" = ", menu_strings
);
8650 /* Add as much of string as fits. */
8651 thiswidth
= min (SCHARS (s
), width
- i
);
8653 = Fcons (Fsubstring (s
, make_number (0),
8654 make_number (thiswidth
)),
8660 /* If this element does not fit, end the line now,
8661 and save the element for the next line. */
8662 PUSH_C_STR ("...", menu_strings
);
8667 /* Move past this element. */
8668 if (idx
>= 0 && idx
+ 1 >= ASIZE (vector
))
8669 /* Handle reaching end of dense table. */
8674 rest
= Fcdr_safe (rest
);
8678 /* Prompt with that and read response. */
8679 message3_nolog (apply1 (intern ("concat"), Fnreverse (menu_strings
)));
8681 /* Make believe it's not a keyboard macro in case the help char
8682 is pressed. Help characters are not recorded because menu prompting
8683 is not used on replay. */
8684 orig_defn_macro
= KVAR (current_kboard
, defining_kbd_macro
);
8685 kset_defining_kbd_macro (current_kboard
, Qnil
);
8687 obj
= read_char (commandflag
, Qnil
, Qt
, 0, NULL
);
8688 while (BUFFERP (obj
));
8689 kset_defining_kbd_macro (current_kboard
, orig_defn_macro
);
8691 if (!INTEGERP (obj
) || XINT (obj
) == -2)
8694 if (! EQ (obj
, menu_prompt_more_char
)
8695 && (!INTEGERP (menu_prompt_more_char
)
8696 || ! EQ (obj
, make_number (Ctl (XINT (menu_prompt_more_char
))))))
8698 if (!NILP (KVAR (current_kboard
, defining_kbd_macro
)))
8699 store_kbd_macro_char (obj
);
8702 /* Help char - go round again. */
8706 /* Reading key sequences. */
8709 follow_key (Lisp_Object keymap
, Lisp_Object key
)
8711 return access_keymap (get_keymap (keymap
, 0, 1),
8716 active_maps (Lisp_Object first_event
)
8718 Lisp_Object position
8719 = CONSP (first_event
) ? CAR_SAFE (XCDR (first_event
)) : Qnil
;
8720 return Fcons (Qkeymap
, Fcurrent_active_maps (Qt
, position
));
8723 /* Structure used to keep track of partial application of key remapping
8724 such as Vfunction_key_map and Vkey_translation_map. */
8725 typedef struct keyremap
8727 /* This is the map originally specified for this use. */
8729 /* This is a submap reached by looking up, in PARENT,
8730 the events from START to END. */
8732 /* Positions [START, END) in the key sequence buffer
8733 are the key that we have scanned so far.
8734 Those events are the ones that we will replace
8735 if PARENT maps them into a key sequence. */
8739 /* Lookup KEY in MAP.
8740 MAP is a keymap mapping keys to key vectors or functions.
8741 If the mapping is a function and DO_FUNCALL is true,
8742 the function is called with PROMPT as parameter and its return
8743 value is used as the return value of this function (after checking
8744 that it is indeed a vector). */
8747 access_keymap_keyremap (Lisp_Object map
, Lisp_Object key
, Lisp_Object prompt
,
8752 next
= access_keymap (map
, key
, 1, 0, 1);
8754 /* Handle a symbol whose function definition is a keymap
8756 if (SYMBOLP (next
) && !NILP (Ffboundp (next
))
8757 && (ARRAYP (XSYMBOL (next
)->function
)
8758 || KEYMAPP (XSYMBOL (next
)->function
)))
8759 next
= Fautoload_do_load (XSYMBOL (next
)->function
, next
, Qnil
);
8761 /* If the keymap gives a function, not an
8762 array, then call the function with one arg and use
8763 its value instead. */
8764 if (do_funcall
&& FUNCTIONP (next
))
8769 next
= call1 (next
, prompt
);
8770 /* If the function returned something invalid,
8771 barf--don't ignore it.
8772 (To ignore it safely, we would need to gcpro a bunch of
8773 other variables.) */
8774 if (! (NILP (next
) || VECTORP (next
) || STRINGP (next
)))
8775 error ("Function %s returns invalid key sequence",
8776 SSDATA (SYMBOL_NAME (tem
)));
8781 /* Do one step of the key remapping used for function-key-map and
8782 key-translation-map:
8783 KEYBUF is the buffer holding the input events.
8784 BUFSIZE is its maximum size.
8785 FKEY is a pointer to the keyremap structure to use.
8786 INPUT is the index of the last element in KEYBUF.
8787 DOIT if true says that the remapping can actually take place.
8788 DIFF is used to return the number of keys added/removed by the remapping.
8789 PARENT is the root of the keymap.
8790 PROMPT is the prompt to use if the remapping happens through a function.
8791 Return true if the remapping actually took place. */
8794 keyremap_step (Lisp_Object
*keybuf
, int bufsize
, volatile keyremap
*fkey
,
8795 int input
, bool doit
, int *diff
, Lisp_Object prompt
)
8797 Lisp_Object next
, key
;
8799 key
= keybuf
[fkey
->end
++];
8801 if (KEYMAPP (fkey
->parent
))
8802 next
= access_keymap_keyremap (fkey
->map
, key
, prompt
, doit
);
8806 /* If keybuf[fkey->start..fkey->end] is bound in the
8807 map and we're in a position to do the key remapping, replace it with
8808 the binding and restart with fkey->start at the end. */
8809 if ((VECTORP (next
) || STRINGP (next
)) && doit
)
8811 int len
= XFASTINT (Flength (next
));
8814 *diff
= len
- (fkey
->end
- fkey
->start
);
8816 if (bufsize
- input
<= *diff
)
8817 error ("Key sequence too long");
8819 /* Shift the keys that follow fkey->end. */
8821 for (i
= fkey
->end
; i
< input
; i
++)
8822 keybuf
[i
+ *diff
] = keybuf
[i
];
8824 for (i
= input
- 1; i
>= fkey
->end
; i
--)
8825 keybuf
[i
+ *diff
] = keybuf
[i
];
8826 /* Overwrite the old keys with the new ones. */
8827 for (i
= 0; i
< len
; i
++)
8828 keybuf
[fkey
->start
+ i
]
8829 = Faref (next
, make_number (i
));
8831 fkey
->start
= fkey
->end
+= *diff
;
8832 fkey
->map
= fkey
->parent
;
8837 fkey
->map
= get_keymap (next
, 0, 1);
8839 /* If we no longer have a bound suffix, try a new position for
8841 if (!CONSP (fkey
->map
))
8843 fkey
->end
= ++fkey
->start
;
8844 fkey
->map
= fkey
->parent
;
8850 test_undefined (Lisp_Object binding
)
8852 return (NILP (binding
)
8853 || EQ (binding
, Qundefined
)
8854 || (SYMBOLP (binding
)
8855 && EQ (Fcommand_remapping (binding
, Qnil
, Qnil
), Qundefined
)));
8858 /* Read a sequence of keys that ends with a non prefix character,
8859 storing it in KEYBUF, a buffer of size BUFSIZE.
8861 Return the length of the key sequence stored.
8862 Return -1 if the user rejected a command menu.
8864 Echo starting immediately unless `prompt' is 0.
8866 If PREVENT_REDISPLAY is non-zero, avoid redisplay by calling
8867 read_char with a suitable COMMANDFLAG argument.
8869 Where a key sequence ends depends on the currently active keymaps.
8870 These include any minor mode keymaps active in the current buffer,
8871 the current buffer's local map, and the global map.
8873 If a key sequence has no other bindings, we check Vfunction_key_map
8874 to see if some trailing subsequence might be the beginning of a
8875 function key's sequence. If so, we try to read the whole function
8876 key, and substitute its symbolic name into the key sequence.
8878 We ignore unbound `down-' mouse clicks. We turn unbound `drag-' and
8879 `double-' events into similar click events, if that would make them
8880 bound. We try to turn `triple-' events first into `double-' events,
8883 If we get a mouse click in a mode line, vertical divider, or other
8884 non-text area, we treat the click as if it were prefixed by the
8885 symbol denoting that area - `mode-line', `vertical-line', or
8888 If the sequence starts with a mouse click, we read the key sequence
8889 with respect to the buffer clicked on, not the current buffer.
8891 If the user switches frames in the midst of a key sequence, we put
8892 off the switch-frame event until later; the next call to
8893 read_char will return it.
8895 If FIX_CURRENT_BUFFER, we restore current_buffer
8896 from the selected window's buffer. */
8899 read_key_sequence (Lisp_Object
*keybuf
, int bufsize
, Lisp_Object prompt
,
8900 bool dont_downcase_last
, bool can_return_switch_frame
,
8901 bool fix_current_buffer
, bool prevent_redisplay
)
8903 ptrdiff_t count
= SPECPDL_INDEX ();
8905 /* How many keys there are in the current key sequence. */
8908 /* The length of the echo buffer when we started reading, and
8909 the length of this_command_keys when we started reading. */
8910 ptrdiff_t echo_start
IF_LINT (= 0);
8911 ptrdiff_t keys_start
;
8913 Lisp_Object current_binding
= Qnil
;
8914 Lisp_Object first_event
= Qnil
;
8916 /* Index of the first key that has no binding.
8917 It is useless to try fkey.start larger than that. */
8920 /* If t < mock_input, then KEYBUF[t] should be read as the next
8923 We use this to recover after recognizing a function key. Once we
8924 realize that a suffix of the current key sequence is actually a
8925 function key's escape sequence, we replace the suffix with the
8926 function key's binding from Vfunction_key_map. Now keybuf
8927 contains a new and different key sequence, so the echo area,
8928 this_command_keys, and the submaps and defs arrays are wrong. In
8929 this situation, we set mock_input to t, set t to 0, and jump to
8930 restart_sequence; the loop will read keys from keybuf up until
8931 mock_input, thus rebuilding the state; and then it will resume
8932 reading characters from the keyboard. */
8935 /* If the sequence is unbound in submaps[], then
8936 keybuf[fkey.start..fkey.end-1] is a prefix in Vfunction_key_map,
8937 and fkey.map is its binding.
8939 These might be > t, indicating that all function key scanning
8940 should hold off until t reaches them. We do this when we've just
8941 recognized a function key, to avoid searching for the function
8942 key's again in Vfunction_key_map. */
8945 /* Likewise, for key_translation_map and input-decode-map. */
8946 keyremap keytran
, indec
;
8948 /* True if we are trying to map a key by changing an upper-case
8949 letter to lower case, or a shifted function key to an unshifted
8951 bool shift_translated
= 0;
8953 /* If we receive a `switch-frame' or `select-window' event in the middle of
8954 a key sequence, we put it off for later.
8955 While we're reading, we keep the event here. */
8956 Lisp_Object delayed_switch_frame
;
8958 Lisp_Object original_uppercase
IF_LINT (= Qnil
);
8959 int original_uppercase_position
= -1;
8961 /* Gets around Microsoft compiler limitations. */
8964 struct buffer
*starting_buffer
;
8966 /* List of events for which a fake prefix key has been generated. */
8967 Lisp_Object fake_prefixed_keys
= Qnil
;
8969 struct gcpro gcpro1
;
8971 GCPRO1 (fake_prefixed_keys
);
8972 raw_keybuf_count
= 0;
8974 last_nonmenu_event
= Qnil
;
8976 delayed_switch_frame
= Qnil
;
8982 /* Install the string PROMPT as the beginning of the string
8983 of echoing, so that it serves as a prompt for the next
8985 kset_echo_string (current_kboard
, prompt
);
8986 current_kboard
->echo_after_prompt
= SCHARS (prompt
);
8989 else if (cursor_in_echo_area
8990 && echo_keystrokes_p ())
8991 /* This doesn't put in a dash if the echo buffer is empty, so
8992 you don't always see a dash hanging out in the minibuffer. */
8996 /* Record the initial state of the echo area and this_command_keys;
8997 we will need to restore them if we replay a key sequence. */
8999 echo_start
= echo_length ();
9000 keys_start
= this_command_key_count
;
9001 this_single_command_key_start
= keys_start
;
9003 /* We jump here when we need to reinitialize fkey and keytran; this
9004 happens if we switch keyboards between rescans. */
9005 replay_entire_sequence
:
9007 indec
.map
= indec
.parent
= KVAR (current_kboard
, Vinput_decode_map
);
9008 fkey
.map
= fkey
.parent
= KVAR (current_kboard
, Vlocal_function_key_map
);
9009 keytran
.map
= keytran
.parent
= Vkey_translation_map
;
9010 indec
.start
= indec
.end
= 0;
9011 fkey
.start
= fkey
.end
= 0;
9012 keytran
.start
= keytran
.end
= 0;
9014 /* We jump here when the key sequence has been thoroughly changed, and
9015 we need to rescan it starting from the beginning. When we jump here,
9016 keybuf[0..mock_input] holds the sequence we should reread. */
9019 starting_buffer
= current_buffer
;
9020 first_unbound
= bufsize
+ 1;
9022 /* Build our list of keymaps.
9023 If we recognize a function key and replace its escape sequence in
9024 keybuf with its symbol, or if the sequence starts with a mouse
9025 click and we need to switch buffers, we jump back here to rebuild
9026 the initial keymaps from the current buffer. */
9027 current_binding
= active_maps (first_event
);
9029 /* Start from the beginning in keybuf. */
9032 /* These are no-ops the first time through, but if we restart, they
9033 revert the echo area and this_command_keys to their original state. */
9034 this_command_key_count
= keys_start
;
9035 if (INTERACTIVE
&& t
< mock_input
)
9036 echo_truncate (echo_start
);
9038 /* If the best binding for the current key sequence is a keymap, or
9039 we may be looking at a function key's escape sequence, keep on
9041 while (!NILP (current_binding
)
9042 /* Keep reading as long as there's a prefix binding. */
9043 ? KEYMAPP (current_binding
)
9044 /* Don't return in the middle of a possible function key sequence,
9045 if the only bindings we found were via case conversion.
9046 Thus, if ESC O a has a function-key-map translation
9047 and ESC o has a binding, don't return after ESC O,
9048 so that we can translate ESC O plus the next character. */
9049 : (/* indec.start < t || fkey.start < t || */ keytran
.start
< t
))
9052 bool used_mouse_menu
= 0;
9054 /* Where the last real key started. If we need to throw away a
9055 key that has expanded into more than one element of keybuf
9056 (say, a mouse click on the mode line which is being treated
9057 as [mode-line (mouse-...)], then we backtrack to this point
9059 int last_real_key_start
;
9061 /* These variables are analogous to echo_start and keys_start;
9062 while those allow us to restart the entire key sequence,
9063 echo_local_start and keys_local_start allow us to throw away
9065 ptrdiff_t echo_local_start
IF_LINT (= 0);
9066 int keys_local_start
;
9067 Lisp_Object new_binding
;
9069 eassert (indec
.end
== t
|| (indec
.end
> t
&& indec
.end
<= mock_input
));
9070 eassert (indec
.start
<= indec
.end
);
9071 eassert (fkey
.start
<= fkey
.end
);
9072 eassert (keytran
.start
<= keytran
.end
);
9073 /* key-translation-map is applied *after* function-key-map
9074 which is itself applied *after* input-decode-map. */
9075 eassert (fkey
.end
<= indec
.start
);
9076 eassert (keytran
.end
<= fkey
.start
);
9078 if (/* first_unbound < indec.start && first_unbound < fkey.start && */
9079 first_unbound
< keytran
.start
)
9080 { /* The prefix upto first_unbound has no binding and has
9081 no translation left to do either, so we know it's unbound.
9082 If we don't stop now, we risk staying here indefinitely
9083 (if the user keeps entering fkey or keytran prefixes
9084 like C-c ESC ESC ESC ESC ...) */
9086 for (i
= first_unbound
+ 1; i
< t
; i
++)
9087 keybuf
[i
- first_unbound
- 1] = keybuf
[i
];
9088 mock_input
= t
- first_unbound
- 1;
9089 indec
.end
= indec
.start
-= first_unbound
+ 1;
9090 indec
.map
= indec
.parent
;
9091 fkey
.end
= fkey
.start
-= first_unbound
+ 1;
9092 fkey
.map
= fkey
.parent
;
9093 keytran
.end
= keytran
.start
-= first_unbound
+ 1;
9094 keytran
.map
= keytran
.parent
;
9095 goto replay_sequence
;
9099 error ("Key sequence too long");
9102 echo_local_start
= echo_length ();
9103 keys_local_start
= this_command_key_count
;
9106 /* These are no-ops, unless we throw away a keystroke below and
9107 jumped back up to replay_key; in that case, these restore the
9108 variables to their original state, allowing us to replay the
9110 if (INTERACTIVE
&& t
< mock_input
)
9111 echo_truncate (echo_local_start
);
9112 this_command_key_count
= keys_local_start
;
9114 /* By default, assume each event is "real". */
9115 last_real_key_start
= t
;
9117 /* Does mock_input indicate that we are re-reading a key sequence? */
9121 add_command_key (key
);
9122 if (echo_keystrokes_p ()
9123 && current_kboard
->immediate_echo
)
9130 /* If not, we should actually read a character. */
9134 KBOARD
*interrupted_kboard
= current_kboard
;
9135 struct frame
*interrupted_frame
= SELECTED_FRAME ();
9136 /* Calling read_char with COMMANDFLAG = -2 avoids
9137 redisplay in read_char and its subroutines. */
9138 key
= read_char (prevent_redisplay
? -2 : NILP (prompt
),
9139 current_binding
, last_nonmenu_event
,
9140 &used_mouse_menu
, NULL
);
9141 if ((INTEGERP (key
) && XINT (key
) == -2) /* wrong_kboard_jmpbuf */
9142 /* When switching to a new tty (with a new keyboard),
9143 read_char returns the new buffer, rather than -2
9144 (Bug#5095). This is because `terminal-init-xterm'
9145 calls read-char, which eats the wrong_kboard_jmpbuf
9146 return. Any better way to fix this? -- cyd */
9147 || (interrupted_kboard
!= current_kboard
))
9152 for (k
= all_kboards
; k
; k
= k
->next_kboard
)
9153 if (k
== interrupted_kboard
)
9158 /* Don't touch interrupted_kboard when it's been
9160 delayed_switch_frame
= Qnil
;
9161 goto replay_entire_sequence
;
9164 if (!NILP (delayed_switch_frame
))
9167 (interrupted_kboard
,
9168 Fcons (delayed_switch_frame
,
9169 KVAR (interrupted_kboard
, kbd_queue
)));
9170 delayed_switch_frame
= Qnil
;
9175 (interrupted_kboard
,
9176 Fcons (keybuf
[--t
], KVAR (interrupted_kboard
, kbd_queue
)));
9178 /* If the side queue is non-empty, ensure it begins with a
9179 switch-frame, so we'll replay it in the right context. */
9180 if (CONSP (KVAR (interrupted_kboard
, kbd_queue
))
9181 && (key
= XCAR (KVAR (interrupted_kboard
, kbd_queue
)),
9182 !(EVENT_HAS_PARAMETERS (key
)
9183 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)),
9187 XSETFRAME (frame
, interrupted_frame
);
9189 (interrupted_kboard
,
9190 Fcons (make_lispy_switch_frame (frame
),
9191 KVAR (interrupted_kboard
, kbd_queue
)));
9194 goto replay_entire_sequence
;
9198 /* read_char returns t when it shows a menu and the user rejects it.
9202 unbind_to (count
, Qnil
);
9207 /* read_char returns -1 at the end of a macro.
9208 Emacs 18 handles this by returning immediately with a
9209 zero, so that's what we'll do. */
9210 if (INTEGERP (key
) && XINT (key
) == -1)
9213 /* The Microsoft C compiler can't handle the goto that
9219 /* If the current buffer has been changed from under us, the
9220 keymap may have changed, so replay the sequence. */
9223 timer_resume_idle ();
9226 /* Reset the current buffer from the selected window
9227 in case something changed the former and not the latter.
9228 This is to be more consistent with the behavior
9229 of the command_loop_1. */
9230 if (fix_current_buffer
)
9232 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
9234 if (XBUFFER (XWINDOW (selected_window
)->contents
)
9236 Fset_buffer (XWINDOW (selected_window
)->contents
);
9239 goto replay_sequence
;
9242 /* If we have a quit that was typed in another frame, and
9243 quit_throw_to_read_char switched buffers,
9244 replay to get the right keymap. */
9246 && XINT (key
) == quit_char
9247 && current_buffer
!= starting_buffer
)
9250 ASET (raw_keybuf
, raw_keybuf_count
, key
);
9255 goto replay_sequence
;
9260 if (EVENT_HAS_PARAMETERS (key
)
9261 /* Either a `switch-frame' or a `select-window' event. */
9262 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)), Qswitch_frame
))
9264 /* If we're at the beginning of a key sequence, and the caller
9265 says it's okay, go ahead and return this event. If we're
9266 in the midst of a key sequence, delay it until the end. */
9267 if (t
> 0 || !can_return_switch_frame
)
9269 delayed_switch_frame
= key
;
9274 if (NILP (first_event
))
9277 /* Even if first_event does not specify a particular
9278 window/position, it's important to recompute the maps here
9279 since a long time might have passed since we entered
9280 read_key_sequence, and a timer (or process-filter or
9281 special-event-map, ...) might have switched the current buffer
9282 or the selected window from under us in the mean time. */
9283 if (fix_current_buffer
9284 && (XBUFFER (XWINDOW (selected_window
)->contents
)
9286 Fset_buffer (XWINDOW (selected_window
)->contents
);
9287 current_binding
= active_maps (first_event
);
9291 ASET (raw_keybuf
, raw_keybuf_count
, key
);
9295 /* Clicks in non-text areas get prefixed by the symbol
9296 in their CHAR-ADDRESS field. For example, a click on
9297 the mode line is prefixed by the symbol `mode-line'.
9299 Furthermore, key sequences beginning with mouse clicks
9300 are read using the keymaps of the buffer clicked on, not
9301 the current buffer. So we may have to switch the buffer
9304 When we turn one event into two events, we must make sure
9305 that neither of the two looks like the original--so that,
9306 if we replay the events, they won't be expanded again.
9307 If not for this, such reexpansion could happen either here
9308 or when user programs play with this-command-keys. */
9309 if (EVENT_HAS_PARAMETERS (key
))
9311 Lisp_Object kind
= EVENT_HEAD_KIND (EVENT_HEAD (key
));
9312 if (EQ (kind
, Qmouse_click
))
9314 Lisp_Object window
= POSN_WINDOW (EVENT_START (key
));
9315 Lisp_Object posn
= POSN_POSN (EVENT_START (key
));
9318 || (!NILP (fake_prefixed_keys
)
9319 && !NILP (Fmemq (key
, fake_prefixed_keys
))))
9321 /* We're looking a second time at an event for which
9322 we generated a fake prefix key. Set
9323 last_real_key_start appropriately. */
9325 last_real_key_start
= t
- 1;
9328 if (last_real_key_start
== 0)
9330 /* Key sequences beginning with mouse clicks are
9331 read using the keymaps in the buffer clicked on,
9332 not the current buffer. If we're at the
9333 beginning of a key sequence, switch buffers. */
9334 if (WINDOWP (window
)
9335 && BUFFERP (XWINDOW (window
)->contents
)
9336 && XBUFFER (XWINDOW (window
)->contents
) != current_buffer
)
9338 ASET (raw_keybuf
, raw_keybuf_count
, key
);
9343 /* Arrange to go back to the original buffer once we're
9344 done reading the key sequence. Note that we can't
9345 use save_excursion_{save,restore} here, because they
9346 save point as well as the current buffer; we don't
9347 want to save point, because redisplay may change it,
9348 to accommodate a Fset_window_start or something. We
9349 don't want to do this at the top of the function,
9350 because we may get input from a subprocess which
9351 wants to change the selected window and stuff (say,
9353 record_unwind_current_buffer ();
9355 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
9357 set_buffer_internal (XBUFFER (XWINDOW (window
)->contents
));
9358 goto replay_sequence
;
9362 /* Expand mode-line and scroll-bar events into two events:
9363 use posn as a fake prefix key. */
9365 && (NILP (fake_prefixed_keys
)
9366 || NILP (Fmemq (key
, fake_prefixed_keys
))))
9368 if (bufsize
- t
<= 1)
9369 error ("Key sequence too long");
9372 keybuf
[t
+ 1] = key
;
9375 /* Record that a fake prefix key has been generated
9376 for KEY. Don't modify the event; this would
9377 prevent proper action when the event is pushed
9378 back into unread-command-events. */
9379 fake_prefixed_keys
= Fcons (key
, fake_prefixed_keys
);
9383 else if (CONSP (XCDR (key
))
9384 && CONSP (EVENT_START (key
))
9385 && CONSP (XCDR (EVENT_START (key
))))
9389 posn
= POSN_POSN (EVENT_START (key
));
9390 /* Handle menu-bar events:
9391 insert the dummy prefix event `menu-bar'. */
9392 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
9394 if (bufsize
- t
<= 1)
9395 error ("Key sequence too long");
9397 keybuf
[t
+ 1] = key
;
9399 /* Zap the position in key, so we know that we've
9400 expanded it, and don't try to do so again. */
9401 POSN_SET_POSN (EVENT_START (key
), list1 (posn
));
9404 goto replay_sequence
;
9406 else if (CONSP (posn
))
9408 /* We're looking at the second event of a
9409 sequence which we expanded before. Set
9410 last_real_key_start appropriately. */
9411 if (last_real_key_start
== t
&& t
> 0)
9412 last_real_key_start
= t
- 1;
9417 /* We have finally decided that KEY is something we might want
9419 new_binding
= follow_key (current_binding
, key
);
9421 /* If KEY wasn't bound, we'll try some fallbacks. */
9422 if (!NILP (new_binding
))
9423 /* This is needed for the following scenario:
9424 event 0: a down-event that gets dropped by calling replay_key.
9425 event 1: some normal prefix like C-h.
9426 After event 0, first_unbound is 0, after event 1 indec.start,
9427 fkey.start, and keytran.start are all 1, so when we see that
9428 C-h is bound, we need to update first_unbound. */
9429 first_unbound
= max (t
+ 1, first_unbound
);
9434 /* Remember the position to put an upper bound on indec.start. */
9435 first_unbound
= min (t
, first_unbound
);
9437 head
= EVENT_HEAD (key
);
9441 Lisp_Object breakdown
;
9444 breakdown
= parse_modifiers (head
);
9445 modifiers
= XINT (XCAR (XCDR (breakdown
)));
9446 /* Attempt to reduce an unbound mouse event to a simpler
9447 event that is bound:
9448 Drags reduce to clicks.
9449 Double-clicks reduce to clicks.
9450 Triple-clicks reduce to double-clicks, then to clicks.
9451 Down-clicks are eliminated.
9452 Double-downs reduce to downs, then are eliminated.
9453 Triple-downs reduce to double-downs, then to downs,
9454 then are eliminated. */
9455 if (modifiers
& (down_modifier
| drag_modifier
9456 | double_modifier
| triple_modifier
))
9458 while (modifiers
& (down_modifier
| drag_modifier
9459 | double_modifier
| triple_modifier
))
9461 Lisp_Object new_head
, new_click
;
9462 if (modifiers
& triple_modifier
)
9463 modifiers
^= (double_modifier
| triple_modifier
);
9464 else if (modifiers
& double_modifier
)
9465 modifiers
&= ~double_modifier
;
9466 else if (modifiers
& drag_modifier
)
9467 modifiers
&= ~drag_modifier
;
9470 /* Dispose of this `down' event by simply jumping
9471 back to replay_key, to get another event.
9473 Note that if this event came from mock input,
9474 then just jumping back to replay_key will just
9475 hand it to us again. So we have to wipe out any
9478 We could delete keybuf[t] and shift everything
9479 after that to the left by one spot, but we'd also
9480 have to fix up any variable that points into
9481 keybuf, and shifting isn't really necessary
9484 Adding prefixes for non-textual mouse clicks
9485 creates two characters of mock input, and both
9486 must be thrown away. If we're only looking at
9487 the prefix now, we can just jump back to
9488 replay_key. On the other hand, if we've already
9489 processed the prefix, and now the actual click
9490 itself is giving us trouble, then we've lost the
9491 state of the keymaps we want to backtrack to, and
9492 we need to replay the whole sequence to rebuild
9495 Beyond that, only function key expansion could
9496 create more than two keys, but that should never
9497 generate mouse events, so it's okay to zero
9498 mock_input in that case too.
9500 FIXME: The above paragraph seems just plain
9501 wrong, if you consider things like
9502 xterm-mouse-mode. -stef
9504 Isn't this just the most wonderful code ever? */
9506 /* If mock_input > t + 1, the above simplification
9507 will actually end up dropping keys on the floor.
9508 This is probably OK for now, but even
9509 if mock_input <= t + 1, we need to adjust indec,
9511 Typical case [header-line down-mouse-N]:
9512 mock_input = 2, t = 1, fkey.end = 1,
9513 last_real_key_start = 0. */
9514 if (indec
.end
> last_real_key_start
)
9516 indec
.end
= indec
.start
9517 = min (last_real_key_start
, indec
.start
);
9518 indec
.map
= indec
.parent
;
9519 if (fkey
.end
> last_real_key_start
)
9521 fkey
.end
= fkey
.start
9522 = min (last_real_key_start
, fkey
.start
);
9523 fkey
.map
= fkey
.parent
;
9524 if (keytran
.end
> last_real_key_start
)
9526 keytran
.end
= keytran
.start
9527 = min (last_real_key_start
, keytran
.start
);
9528 keytran
.map
= keytran
.parent
;
9532 if (t
== last_real_key_start
)
9539 mock_input
= last_real_key_start
;
9540 goto replay_sequence
;
9545 = apply_modifiers (modifiers
, XCAR (breakdown
));
9546 new_click
= list2 (new_head
, EVENT_START (key
));
9548 /* Look for a binding for this new key. */
9549 new_binding
= follow_key (current_binding
, new_click
);
9551 /* If that click is bound, go for it. */
9552 if (!NILP (new_binding
))
9554 current_binding
= new_binding
;
9558 /* Otherwise, we'll leave key set to the drag event. */
9563 current_binding
= new_binding
;
9566 /* Normally, last_nonmenu_event gets the previous key we read.
9567 But when a mouse popup menu is being used,
9568 we don't update last_nonmenu_event; it continues to hold the mouse
9569 event that preceded the first level of menu. */
9570 if (!used_mouse_menu
)
9571 last_nonmenu_event
= key
;
9573 /* Record what part of this_command_keys is the current key sequence. */
9574 this_single_command_key_start
= this_command_key_count
- t
;
9576 /* Look for this sequence in input-decode-map.
9577 Scan from indec.end until we find a bound suffix. */
9578 while (indec
.end
< t
)
9580 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9584 GCPRO4 (indec
.map
, fkey
.map
, keytran
.map
, delayed_switch_frame
);
9585 done
= keyremap_step (keybuf
, bufsize
, &indec
, max (t
, mock_input
),
9590 mock_input
= diff
+ max (t
, mock_input
);
9591 goto replay_sequence
;
9595 if (!KEYMAPP (current_binding
)
9596 && !test_undefined (current_binding
)
9597 && indec
.start
>= t
)
9598 /* There is a binding and it's not a prefix.
9599 (and it doesn't have any input-decode-map translation pending).
9600 There is thus no function-key in this sequence.
9601 Moving fkey.start is important in this case to allow keytran.start
9602 to go over the sequence before we return (since we keep the
9603 invariant that keytran.end <= fkey.start). */
9606 (fkey
.start
= fkey
.end
= t
, fkey
.map
= fkey
.parent
);
9609 /* If the sequence is unbound, see if we can hang a function key
9610 off the end of it. */
9611 /* Continue scan from fkey.end until we find a bound suffix. */
9612 while (fkey
.end
< indec
.start
)
9614 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9618 GCPRO4 (indec
.map
, fkey
.map
, keytran
.map
, delayed_switch_frame
);
9619 done
= keyremap_step (keybuf
, bufsize
, &fkey
,
9620 max (t
, mock_input
),
9621 /* If there's a binding (i.e.
9622 first_binding >= nmaps) we don't want
9623 to apply this function-key-mapping. */
9625 && (test_undefined (current_binding
)),
9630 mock_input
= diff
+ max (t
, mock_input
);
9631 /* Adjust the input-decode-map counters. */
9633 indec
.start
+= diff
;
9635 goto replay_sequence
;
9639 /* Look for this sequence in key-translation-map.
9640 Scan from keytran.end until we find a bound suffix. */
9641 while (keytran
.end
< fkey
.start
)
9643 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9647 GCPRO4 (indec
.map
, fkey
.map
, keytran
.map
, delayed_switch_frame
);
9648 done
= keyremap_step (keybuf
, bufsize
, &keytran
, max (t
, mock_input
),
9653 mock_input
= diff
+ max (t
, mock_input
);
9654 /* Adjust the function-key-map and input-decode-map counters. */
9656 indec
.start
+= diff
;
9660 goto replay_sequence
;
9664 /* If KEY is not defined in any of the keymaps,
9665 and cannot be part of a function key or translation,
9666 and is an upper case letter
9667 use the corresponding lower-case letter instead. */
9668 if (NILP (current_binding
)
9669 && /* indec.start >= t && fkey.start >= t && */ keytran
.start
>= t
9671 && ((CHARACTERP (make_number (XINT (key
) & ~CHAR_MODIFIER_MASK
))
9672 && uppercasep (XINT (key
) & ~CHAR_MODIFIER_MASK
))
9673 || (XINT (key
) & shift_modifier
)))
9675 Lisp_Object new_key
;
9677 original_uppercase
= key
;
9678 original_uppercase_position
= t
- 1;
9680 if (XINT (key
) & shift_modifier
)
9681 XSETINT (new_key
, XINT (key
) & ~shift_modifier
);
9683 XSETINT (new_key
, (downcase (XINT (key
) & ~CHAR_MODIFIER_MASK
)
9684 | (XINT (key
) & CHAR_MODIFIER_MASK
)));
9686 /* We have to do this unconditionally, regardless of whether
9687 the lower-case char is defined in the keymaps, because they
9688 might get translated through function-key-map. */
9689 keybuf
[t
- 1] = new_key
;
9690 mock_input
= max (t
, mock_input
);
9691 shift_translated
= 1;
9693 goto replay_sequence
;
9696 if (NILP (current_binding
)
9697 && help_char_p (EVENT_HEAD (key
)) && t
> 1)
9699 read_key_sequence_cmd
= Vprefix_help_command
;
9700 /* The Microsoft C compiler can't handle the goto that
9706 /* If KEY is not defined in any of the keymaps,
9707 and cannot be part of a function key or translation,
9708 and is a shifted function key,
9709 use the corresponding unshifted function key instead. */
9710 if (NILP (current_binding
)
9711 && /* indec.start >= t && fkey.start >= t && */ keytran
.start
>= t
)
9713 Lisp_Object breakdown
= parse_modifiers (key
);
9715 = CONSP (breakdown
) ? (XINT (XCAR (XCDR (breakdown
)))) : 0;
9717 if (modifiers
& shift_modifier
9718 /* Treat uppercase keys as shifted. */
9720 && (KEY_TO_CHAR (key
)
9721 < XCHAR_TABLE (BVAR (current_buffer
, downcase_table
))->header
.size
)
9722 && uppercasep (KEY_TO_CHAR (key
))))
9725 = (modifiers
& shift_modifier
9726 ? apply_modifiers (modifiers
& ~shift_modifier
,
9728 : make_number (downcase (KEY_TO_CHAR (key
)) | modifiers
));
9730 original_uppercase
= key
;
9731 original_uppercase_position
= t
- 1;
9733 /* We have to do this unconditionally, regardless of whether
9734 the lower-case char is defined in the keymaps, because they
9735 might get translated through function-key-map. */
9736 keybuf
[t
- 1] = new_key
;
9737 mock_input
= max (t
, mock_input
);
9738 /* Reset fkey (and consequently keytran) to apply
9739 function-key-map on the result, so that S-backspace is
9740 correctly mapped to DEL (via backspace). OTOH,
9741 input-decode-map doesn't need to go through it again. */
9742 fkey
.start
= fkey
.end
= 0;
9743 keytran
.start
= keytran
.end
= 0;
9744 shift_translated
= 1;
9746 goto replay_sequence
;
9751 read_key_sequence_cmd
= current_binding
;
9752 read_key_sequence_remapped
9753 /* Remap command through active keymaps.
9754 Do the remapping here, before the unbind_to so it uses the keymaps
9755 of the appropriate buffer. */
9756 = SYMBOLP (read_key_sequence_cmd
)
9757 ? Fcommand_remapping (read_key_sequence_cmd
, Qnil
, Qnil
)
9760 unread_switch_frame
= delayed_switch_frame
;
9761 unbind_to (count
, Qnil
);
9763 /* Don't downcase the last character if the caller says don't.
9764 Don't downcase it if the result is undefined, either. */
9765 if ((dont_downcase_last
|| NILP (current_binding
))
9767 && t
- 1 == original_uppercase_position
)
9769 keybuf
[t
- 1] = original_uppercase
;
9770 shift_translated
= 0;
9773 if (shift_translated
)
9774 Vthis_command_keys_shift_translated
= Qt
;
9776 /* Occasionally we fabricate events, perhaps by expanding something
9777 according to function-key-map, or by adding a prefix symbol to a
9778 mouse click in the scroll bar or modeline. In this cases, return
9779 the entire generated key sequence, even if we hit an unbound
9780 prefix or a definition before the end. This means that you will
9781 be able to push back the event properly, and also means that
9782 read-key-sequence will always return a logical unit.
9785 for (; t
< mock_input
; t
++)
9787 if (echo_keystrokes_p ())
9788 echo_char (keybuf
[t
]);
9789 add_command_key (keybuf
[t
]);
9797 read_key_sequence_vs (Lisp_Object prompt
, Lisp_Object continue_echo
,
9798 Lisp_Object dont_downcase_last
,
9799 Lisp_Object can_return_switch_frame
,
9800 Lisp_Object cmd_loop
, bool allow_string
)
9802 Lisp_Object keybuf
[30];
9804 struct gcpro gcpro1
;
9805 ptrdiff_t count
= SPECPDL_INDEX ();
9808 CHECK_STRING (prompt
);
9811 specbind (Qinput_method_exit_on_first_char
,
9812 (NILP (cmd_loop
) ? Qt
: Qnil
));
9813 specbind (Qinput_method_use_echo_area
,
9814 (NILP (cmd_loop
) ? Qt
: Qnil
));
9816 memset (keybuf
, 0, sizeof keybuf
);
9818 gcpro1
.nvars
= ARRAYELTS (keybuf
);
9820 if (NILP (continue_echo
))
9822 this_command_key_count
= 0;
9823 this_command_key_count_reset
= 0;
9824 this_single_command_key_start
= 0;
9827 #ifdef HAVE_WINDOW_SYSTEM
9828 if (display_hourglass_p
)
9829 cancel_hourglass ();
9832 i
= read_key_sequence (keybuf
, ARRAYELTS (keybuf
),
9833 prompt
, ! NILP (dont_downcase_last
),
9834 ! NILP (can_return_switch_frame
), 0, 0);
9836 #if 0 /* The following is fine for code reading a key sequence and
9837 then proceeding with a lengthy computation, but it's not good
9838 for code reading keys in a loop, like an input method. */
9839 #ifdef HAVE_WINDOW_SYSTEM
9840 if (display_hourglass_p
)
9851 return unbind_to (count
,
9852 ((allow_string
? make_event_array
: Fvector
)
9856 DEFUN ("read-key-sequence", Fread_key_sequence
, Sread_key_sequence
, 1, 5, 0,
9857 doc
: /* Read a sequence of keystrokes and return as a string or vector.
9858 The sequence is sufficient to specify a non-prefix command in the
9859 current local and global maps.
9861 First arg PROMPT is a prompt string. If nil, do not prompt specially.
9862 Second (optional) arg CONTINUE-ECHO, if non-nil, means this key echos
9863 as a continuation of the previous key.
9865 The third (optional) arg DONT-DOWNCASE-LAST, if non-nil, means do not
9866 convert the last event to lower case. (Normally any upper case event
9867 is converted to lower case if the original event is undefined and the lower
9868 case equivalent is defined.) A non-nil value is appropriate for reading
9869 a key sequence to be defined.
9871 A C-g typed while in this function is treated like any other character,
9872 and `quit-flag' is not set.
9874 If the key sequence starts with a mouse click, then the sequence is read
9875 using the keymaps of the buffer of the window clicked in, not the buffer
9876 of the selected window as normal.
9878 `read-key-sequence' drops unbound button-down events, since you normally
9879 only care about the click or drag events which follow them. If a drag
9880 or multi-click event is unbound, but the corresponding click event would
9881 be bound, `read-key-sequence' turns the event into a click event at the
9882 drag's starting position. This means that you don't have to distinguish
9883 between click and drag, double, or triple events unless you want to.
9885 `read-key-sequence' prefixes mouse events on mode lines, the vertical
9886 lines separating windows, and scroll bars with imaginary keys
9887 `mode-line', `vertical-line', and `vertical-scroll-bar'.
9889 Optional fourth argument CAN-RETURN-SWITCH-FRAME non-nil means that this
9890 function will process a switch-frame event if the user switches frames
9891 before typing anything. If the user switches frames in the middle of a
9892 key sequence, or at the start of the sequence but CAN-RETURN-SWITCH-FRAME
9893 is nil, then the event will be put off until after the current key sequence.
9895 `read-key-sequence' checks `function-key-map' for function key
9896 sequences, where they wouldn't conflict with ordinary bindings. See
9897 `function-key-map' for more details.
9899 The optional fifth argument CMD-LOOP, if non-nil, means
9900 that this key sequence is being read by something that will
9901 read commands one after another. It should be nil if the caller
9902 will read just one key sequence. */)
9903 (Lisp_Object prompt
, Lisp_Object continue_echo
, Lisp_Object dont_downcase_last
, Lisp_Object can_return_switch_frame
, Lisp_Object cmd_loop
)
9905 return read_key_sequence_vs (prompt
, continue_echo
, dont_downcase_last
,
9906 can_return_switch_frame
, cmd_loop
, true);
9909 DEFUN ("read-key-sequence-vector", Fread_key_sequence_vector
,
9910 Sread_key_sequence_vector
, 1, 5, 0,
9911 doc
: /* Like `read-key-sequence' but always return a vector. */)
9912 (Lisp_Object prompt
, Lisp_Object continue_echo
, Lisp_Object dont_downcase_last
, Lisp_Object can_return_switch_frame
, Lisp_Object cmd_loop
)
9914 return read_key_sequence_vs (prompt
, continue_echo
, dont_downcase_last
,
9915 can_return_switch_frame
, cmd_loop
, false);
9918 /* Return true if input events are pending. */
9921 detect_input_pending (void)
9923 return input_pending
|| get_input_pending (0);
9926 /* Return true if input events other than mouse movements are
9930 detect_input_pending_ignore_squeezables (void)
9932 return input_pending
|| get_input_pending (READABLE_EVENTS_IGNORE_SQUEEZABLES
);
9935 /* Return true if input events are pending, and run any pending timers. */
9938 detect_input_pending_run_timers (bool do_display
)
9940 unsigned old_timers_run
= timers_run
;
9943 get_input_pending (READABLE_EVENTS_DO_TIMERS_NOW
);
9945 if (old_timers_run
!= timers_run
&& do_display
)
9946 redisplay_preserve_echo_area (8);
9948 return input_pending
;
9951 /* This is called in some cases before a possible quit.
9952 It cases the next call to detect_input_pending to recompute input_pending.
9953 So calling this function unnecessarily can't do any harm. */
9956 clear_input_pending (void)
9961 /* Return true if there are pending requeued events.
9962 This isn't used yet. The hope is to make wait_reading_process_output
9963 call it, and return if it runs Lisp code that unreads something.
9964 The problem is, kbd_buffer_get_event needs to be fixed to know what
9965 to do in that case. It isn't trivial. */
9968 requeued_events_pending_p (void)
9970 return (!NILP (Vunread_command_events
));
9973 DEFUN ("input-pending-p", Finput_pending_p
, Sinput_pending_p
, 0, 1, 0,
9974 doc
: /* Return t if command input is currently available with no wait.
9975 Actually, the value is nil only if we can be sure that no input is available;
9976 if there is a doubt, the value is t.
9978 If CHECK-TIMERS is non-nil, timers that are ready to run will do so. */)
9979 (Lisp_Object check_timers
)
9981 if (!NILP (Vunread_command_events
)
9982 || !NILP (Vunread_post_input_method_events
)
9983 || !NILP (Vunread_input_method_events
))
9986 /* Process non-user-visible events (Bug#10195). */
9987 process_special_events ();
9989 return (get_input_pending ((NILP (check_timers
)
9990 ? 0 : READABLE_EVENTS_DO_TIMERS_NOW
)
9991 | READABLE_EVENTS_FILTER_EVENTS
)
9995 DEFUN ("recent-keys", Frecent_keys
, Srecent_keys
, 0, 1, 0,
9996 doc
: /* Return vector of last few events, not counting those from keyboard macros.
9997 If INCLUDE-CMDS is non-nil, include the commands that were run,
9998 represented as events of the form (nil . COMMAND). */)
9999 (Lisp_Object include_cmds
)
10001 bool cmds
= !NILP (include_cmds
);
10004 || (cmds
&& total_keys
< NUM_RECENT_KEYS
))
10005 return Fvector (total_keys
,
10006 XVECTOR (recent_keys
)->contents
);
10009 Lisp_Object es
= Qnil
;
10010 int i
= (total_keys
< NUM_RECENT_KEYS
10011 ? 0 : recent_keys_index
);
10012 eassert (recent_keys_index
< NUM_RECENT_KEYS
);
10015 Lisp_Object e
= AREF (recent_keys
, i
);
10016 if (cmds
|| !CONSP (e
) || !NILP (XCAR (e
)))
10017 es
= Fcons (e
, es
);
10018 if (++i
>= NUM_RECENT_KEYS
)
10020 } while (i
!= recent_keys_index
);
10021 es
= Fnreverse (es
);
10022 return Fvconcat (1, &es
);
10026 DEFUN ("this-command-keys", Fthis_command_keys
, Sthis_command_keys
, 0, 0, 0,
10027 doc
: /* Return the key sequence that invoked this command.
10028 However, if the command has called `read-key-sequence', it returns
10029 the last key sequence that has been read.
10030 The value is a string or a vector.
10032 See also `this-command-keys-vector'. */)
10035 return make_event_array (this_command_key_count
,
10036 XVECTOR (this_command_keys
)->contents
);
10039 DEFUN ("this-command-keys-vector", Fthis_command_keys_vector
, Sthis_command_keys_vector
, 0, 0, 0,
10040 doc
: /* Return the key sequence that invoked this command, as a vector.
10041 However, if the command has called `read-key-sequence', it returns
10042 the last key sequence that has been read.
10044 See also `this-command-keys'. */)
10047 return Fvector (this_command_key_count
,
10048 XVECTOR (this_command_keys
)->contents
);
10051 DEFUN ("this-single-command-keys", Fthis_single_command_keys
,
10052 Sthis_single_command_keys
, 0, 0, 0,
10053 doc
: /* Return the key sequence that invoked this command.
10054 More generally, it returns the last key sequence read, either by
10055 the command loop or by `read-key-sequence'.
10056 Unlike `this-command-keys', this function's value
10057 does not include prefix arguments.
10058 The value is always a vector. */)
10061 return Fvector (this_command_key_count
10062 - this_single_command_key_start
,
10063 (XVECTOR (this_command_keys
)->contents
10064 + this_single_command_key_start
));
10067 DEFUN ("this-single-command-raw-keys", Fthis_single_command_raw_keys
,
10068 Sthis_single_command_raw_keys
, 0, 0, 0,
10069 doc
: /* Return the raw events that were read for this command.
10070 More generally, it returns the last key sequence read, either by
10071 the command loop or by `read-key-sequence'.
10072 Unlike `this-single-command-keys', this function's value
10073 shows the events before all translations (except for input methods).
10074 The value is always a vector. */)
10077 return Fvector (raw_keybuf_count
, XVECTOR (raw_keybuf
)->contents
);
10080 DEFUN ("reset-this-command-lengths", Freset_this_command_lengths
,
10081 Sreset_this_command_lengths
, 0, 0, 0,
10082 doc
: /* Make the unread events replace the last command and echo.
10083 Used in `universal-argument-other-key'.
10085 `universal-argument-other-key' rereads the event just typed.
10086 It then gets translated through `function-key-map'.
10087 The translated event has to replace the real events,
10088 both in the value of (this-command-keys) and in echoing.
10089 To achieve this, `universal-argument-other-key' calls
10090 `reset-this-command-lengths', which discards the record of reading
10091 these events the first time. */)
10094 this_command_key_count
= before_command_key_count
;
10095 if (this_command_key_count
< this_single_command_key_start
)
10096 this_single_command_key_start
= this_command_key_count
;
10098 echo_truncate (before_command_echo_length
);
10100 /* Cause whatever we put into unread-command-events
10101 to echo as if it were being freshly read from the keyboard. */
10102 this_command_key_count_reset
= 1;
10107 DEFUN ("clear-this-command-keys", Fclear_this_command_keys
,
10108 Sclear_this_command_keys
, 0, 1, 0,
10109 doc
: /* Clear out the vector that `this-command-keys' returns.
10110 Also clear the record of the last 100 events, unless optional arg
10111 KEEP-RECORD is non-nil. */)
10112 (Lisp_Object keep_record
)
10116 this_command_key_count
= 0;
10117 this_command_key_count_reset
= 0;
10119 if (NILP (keep_record
))
10121 for (i
= 0; i
< ASIZE (recent_keys
); ++i
)
10122 ASET (recent_keys
, i
, Qnil
);
10124 recent_keys_index
= 0;
10129 DEFUN ("recursion-depth", Frecursion_depth
, Srecursion_depth
, 0, 0, 0,
10130 doc
: /* Return the current depth in recursive edits. */)
10134 /* Wrap around reliably on integer overflow. */
10135 EMACS_INT sum
= (command_loop_level
& INTMASK
) + (minibuf_level
& INTMASK
);
10136 XSETINT (temp
, sum
);
10140 DEFUN ("open-dribble-file", Fopen_dribble_file
, Sopen_dribble_file
, 1, 1,
10141 "FOpen dribble file: ",
10142 doc
: /* Start writing all keyboard characters to a dribble file called FILE.
10143 If FILE is nil, close any open dribble file.
10144 The file will be closed when Emacs exits.
10146 Be aware that this records ALL characters you type!
10147 This may include sensitive information such as passwords. */)
10160 Lisp_Object encfile
;
10162 file
= Fexpand_file_name (file
, Qnil
);
10163 encfile
= ENCODE_FILE (file
);
10164 fd
= emacs_open (SSDATA (encfile
), O_WRONLY
| O_CREAT
| O_EXCL
, 0600);
10165 if (fd
< 0 && errno
== EEXIST
&& unlink (SSDATA (encfile
)) == 0)
10166 fd
= emacs_open (SSDATA (encfile
), O_WRONLY
| O_CREAT
| O_EXCL
, 0600);
10167 dribble
= fd
< 0 ? 0 : fdopen (fd
, "w");
10169 report_file_error ("Opening dribble", file
);
10174 DEFUN ("discard-input", Fdiscard_input
, Sdiscard_input
, 0, 0, 0,
10175 doc
: /* Discard the contents of the terminal input buffer.
10176 Also end any kbd macro being defined. */)
10179 if (!NILP (KVAR (current_kboard
, defining_kbd_macro
)))
10181 /* Discard the last command from the macro. */
10182 Fcancel_kbd_macro_events ();
10186 Vunread_command_events
= Qnil
;
10188 discard_tty_input ();
10190 kbd_fetch_ptr
= kbd_store_ptr
;
10196 DEFUN ("suspend-emacs", Fsuspend_emacs
, Ssuspend_emacs
, 0, 1, "",
10197 doc
: /* Stop Emacs and return to superior process. You can resume later.
10198 If `cannot-suspend' is non-nil, or if the system doesn't support job
10199 control, run a subshell instead.
10201 If optional arg STUFFSTRING is non-nil, its characters are stuffed
10202 to be read as terminal input by Emacs's parent, after suspension.
10204 Before suspending, run the normal hook `suspend-hook'.
10205 After resumption run the normal hook `suspend-resume-hook'.
10207 Some operating systems cannot stop the Emacs process and resume it later.
10208 On such systems, Emacs starts a subshell instead of suspending. */)
10209 (Lisp_Object stuffstring
)
10211 ptrdiff_t count
= SPECPDL_INDEX ();
10212 int old_height
, old_width
;
10214 struct gcpro gcpro1
;
10216 if (tty_list
&& tty_list
->next
)
10217 error ("There are other tty frames open; close them before suspending Emacs");
10219 if (!NILP (stuffstring
))
10220 CHECK_STRING (stuffstring
);
10222 run_hook (intern ("suspend-hook"));
10224 GCPRO1 (stuffstring
);
10225 get_tty_size (fileno (CURTTY ()->input
), &old_width
, &old_height
);
10226 reset_all_sys_modes ();
10227 /* sys_suspend can get an error if it tries to fork a subshell
10228 and the system resources aren't available for that. */
10229 record_unwind_protect_void (init_all_sys_modes
);
10230 stuff_buffered_input (stuffstring
);
10231 if (cannot_suspend
)
10235 unbind_to (count
, Qnil
);
10237 /* Check if terminal/window size has changed.
10238 Note that this is not useful when we are running directly
10239 with a window system; but suspend should be disabled in that case. */
10240 get_tty_size (fileno (CURTTY ()->input
), &width
, &height
);
10241 if (width
!= old_width
|| height
!= old_height
)
10242 change_frame_size (SELECTED_FRAME (), width
,
10243 height
- FRAME_MENU_BAR_LINES (SELECTED_FRAME ()),
10246 run_hook (intern ("suspend-resume-hook"));
10252 /* If STUFFSTRING is a string, stuff its contents as pending terminal input.
10253 Then in any case stuff anything Emacs has read ahead and not used. */
10256 stuff_buffered_input (Lisp_Object stuffstring
)
10258 #ifdef SIGTSTP /* stuff_char is defined if SIGTSTP. */
10259 register unsigned char *p
;
10261 if (STRINGP (stuffstring
))
10263 register ptrdiff_t count
;
10265 p
= SDATA (stuffstring
);
10266 count
= SBYTES (stuffstring
);
10267 while (count
-- > 0)
10272 /* Anything we have read ahead, put back for the shell to read. */
10273 /* ?? What should this do when we have multiple keyboards??
10274 Should we ignore anything that was typed in at the "wrong" kboard?
10276 rms: we should stuff everything back into the kboard
10278 for (; kbd_fetch_ptr
!= kbd_store_ptr
; kbd_fetch_ptr
++)
10281 if (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
10282 kbd_fetch_ptr
= kbd_buffer
;
10283 if (kbd_fetch_ptr
->kind
== ASCII_KEYSTROKE_EVENT
)
10284 stuff_char (kbd_fetch_ptr
->code
);
10286 clear_event (kbd_fetch_ptr
);
10290 #endif /* SIGTSTP */
10294 set_waiting_for_input (struct timespec
*time_to_clear
)
10296 input_available_clear_time
= time_to_clear
;
10298 /* Tell handle_interrupt to throw back to read_char, */
10299 waiting_for_input
= 1;
10301 /* If handle_interrupt was called before and buffered a C-g,
10302 make it run again now, to avoid timing error. */
10303 if (!NILP (Vquit_flag
))
10304 quit_throw_to_read_char (0);
10308 clear_waiting_for_input (void)
10310 /* Tell handle_interrupt not to throw back to read_char, */
10311 waiting_for_input
= 0;
10312 input_available_clear_time
= 0;
10315 /* The SIGINT handler.
10317 If we have a frame on the controlling tty, we assume that the
10318 SIGINT was generated by C-g, so we call handle_interrupt.
10319 Otherwise, tell QUIT to kill Emacs. */
10322 handle_interrupt_signal (int sig
)
10324 /* See if we have an active terminal on our controlling tty. */
10325 struct terminal
*terminal
= get_named_terminal ("/dev/tty");
10328 /* If there are no frames there, let's pretend that we are a
10329 well-behaving UN*X program and quit. We must not call Lisp
10330 in a signal handler, so tell QUIT to exit when it is
10332 Vquit_flag
= Qkill_emacs
;
10336 /* Otherwise, the SIGINT was probably generated by C-g. */
10338 /* Set internal_last_event_frame to the top frame of the
10339 controlling tty, if we have a frame there. We disable the
10340 interrupt key on secondary ttys, so the SIGINT must have come
10341 from the controlling tty. */
10342 internal_last_event_frame
= terminal
->display_info
.tty
->top_frame
;
10344 handle_interrupt (1);
10349 deliver_interrupt_signal (int sig
)
10351 deliver_process_signal (sig
, handle_interrupt_signal
);
10355 /* If Emacs is stuck because `inhibit-quit' is true, then keep track
10356 of the number of times C-g has been requested. If C-g is pressed
10357 enough times, then quit anyway. See bug#6585. */
10358 static int volatile force_quit_count
;
10360 /* This routine is called at interrupt level in response to C-g.
10362 It is called from the SIGINT handler or kbd_buffer_store_event.
10364 If `waiting_for_input' is non zero, then unless `echoing' is
10365 nonzero, immediately throw back to read_char.
10367 Otherwise it sets the Lisp variable quit-flag not-nil. This causes
10368 eval to throw, when it gets a chance. If quit-flag is already
10369 non-nil, it stops the job right away. */
10372 handle_interrupt (bool in_signal_handler
)
10378 /* XXX This code needs to be revised for multi-tty support. */
10379 if (!NILP (Vquit_flag
) && get_named_terminal ("/dev/tty"))
10381 if (! in_signal_handler
)
10383 /* If SIGINT isn't blocked, don't let us be interrupted by
10384 a SIGINT. It might be harmful due to non-reentrancy
10385 in I/O functions. */
10387 sigemptyset (&blocked
);
10388 sigaddset (&blocked
, SIGINT
);
10389 pthread_sigmask (SIG_BLOCK
, &blocked
, 0);
10393 reset_all_sys_modes ();
10397 * On systems which can suspend the current process and return to the original
10398 * shell, this command causes the user to end up back at the shell.
10399 * The "Auto-save" and "Abort" questions are not asked until
10400 * the user elects to return to emacs, at which point he can save the current
10401 * job and either dump core or continue.
10405 /* Perhaps should really fork an inferior shell?
10406 But that would not provide any way to get back
10407 to the original shell, ever. */
10408 printf ("No support for stopping a process on this operating system;\n");
10409 printf ("you can continue or abort.\n");
10410 #endif /* not SIGTSTP */
10412 /* We must remain inside the screen area when the internal terminal
10413 is used. Note that [Enter] is not echoed by dos. */
10414 cursor_to (SELECTED_FRAME (), 0, 0);
10416 /* It doesn't work to autosave while GC is in progress;
10417 the code used for auto-saving doesn't cope with the mark bit. */
10418 if (!gc_in_progress
)
10420 printf ("Auto-save? (y or n) ");
10422 if (((c
= getchar ()) & ~040) == 'Y')
10424 Fdo_auto_save (Qt
, Qnil
);
10426 printf ("\r\nAuto-save done");
10427 #else /* not MSDOS */
10428 printf ("Auto-save done\n");
10429 #endif /* not MSDOS */
10431 while (c
!= '\n') c
= getchar ();
10435 /* During GC, it must be safe to reenable quitting again. */
10436 Vinhibit_quit
= Qnil
;
10439 #endif /* not MSDOS */
10440 printf ("Garbage collection in progress; cannot auto-save now\r\n");
10441 printf ("but will instead do a real quit after garbage collection ends\r\n");
10446 printf ("\r\nAbort? (y or n) ");
10447 #else /* not MSDOS */
10448 printf ("Abort (and dump core)? (y or n) ");
10449 #endif /* not MSDOS */
10451 if (((c
= getchar ()) & ~040) == 'Y')
10453 while (c
!= '\n') c
= getchar ();
10455 printf ("\r\nContinuing...\r\n");
10456 #else /* not MSDOS */
10457 printf ("Continuing...\n");
10458 #endif /* not MSDOS */
10460 init_all_sys_modes ();
10464 /* If executing a function that wants to be interrupted out of
10465 and the user has not deferred quitting by binding `inhibit-quit'
10466 then quit right away. */
10467 if (immediate_quit
&& NILP (Vinhibit_quit
))
10469 struct gl_state_s saved
;
10470 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
10472 immediate_quit
= 0;
10473 pthread_sigmask (SIG_SETMASK
, &empty_mask
, 0);
10475 GCPRO4 (saved
.object
, saved
.global_code
,
10476 saved
.current_syntax_table
, saved
.old_prop
);
10477 Fsignal (Qquit
, Qnil
);
10482 { /* Else request quit when it's safe. */
10483 int count
= NILP (Vquit_flag
) ? 1 : force_quit_count
+ 1;
10484 force_quit_count
= count
;
10487 immediate_quit
= 1;
10488 Vinhibit_quit
= Qnil
;
10494 pthread_sigmask (SIG_SETMASK
, &empty_mask
, 0);
10496 /* TODO: The longjmp in this call throws the NS event loop integration off,
10497 and it seems to do fine without this. Probably some attention
10498 needs to be paid to the setting of waiting_for_input in
10499 wait_reading_process_output() under HAVE_NS because of the call
10500 to ns_select there (needed because otherwise events aren't picked up
10501 outside of polling since we don't get SIGIO like X and we don't have a
10502 separate event loop thread like W32. */
10504 if (waiting_for_input
&& !echoing
)
10505 quit_throw_to_read_char (in_signal_handler
);
10509 /* Handle a C-g by making read_char return C-g. */
10512 quit_throw_to_read_char (bool from_signal
)
10514 /* When not called from a signal handler it is safe to call
10516 if (!from_signal
&& EQ (Vquit_flag
, Qkill_emacs
))
10517 Fkill_emacs (Qnil
);
10519 /* Prevent another signal from doing this before we finish. */
10520 clear_waiting_for_input ();
10523 Vunread_command_events
= Qnil
;
10525 if (FRAMEP (internal_last_event_frame
)
10526 && !EQ (internal_last_event_frame
, selected_frame
))
10527 do_switch_frame (make_lispy_switch_frame (internal_last_event_frame
),
10530 sys_longjmp (getcjmp
, 1);
10533 DEFUN ("set-input-interrupt-mode", Fset_input_interrupt_mode
,
10534 Sset_input_interrupt_mode
, 1, 1, 0,
10535 doc
: /* Set interrupt mode of reading keyboard input.
10536 If INTERRUPT is non-nil, Emacs will use input interrupts;
10537 otherwise Emacs uses CBREAK mode.
10539 See also `current-input-mode'. */)
10540 (Lisp_Object interrupt
)
10542 bool new_interrupt_input
;
10543 #ifdef USABLE_SIGIO
10544 #ifdef HAVE_X_WINDOWS
10545 if (x_display_list
!= NULL
)
10547 /* When using X, don't give the user a real choice,
10548 because we haven't implemented the mechanisms to support it. */
10549 new_interrupt_input
= 1;
10552 #endif /* HAVE_X_WINDOWS */
10553 new_interrupt_input
= !NILP (interrupt
);
10554 #else /* not USABLE_SIGIO */
10555 new_interrupt_input
= 0;
10556 #endif /* not USABLE_SIGIO */
10558 if (new_interrupt_input
!= interrupt_input
)
10560 #ifdef POLL_FOR_INPUT
10564 /* this causes startup screen to be restored and messes with the mouse */
10565 reset_all_sys_modes ();
10566 interrupt_input
= new_interrupt_input
;
10567 init_all_sys_modes ();
10569 interrupt_input
= new_interrupt_input
;
10572 #ifdef POLL_FOR_INPUT
10573 poll_suppress_count
= 1;
10580 DEFUN ("set-output-flow-control", Fset_output_flow_control
, Sset_output_flow_control
, 1, 2, 0,
10581 doc
: /* Enable or disable ^S/^Q flow control for output to TERMINAL.
10582 If FLOW is non-nil, flow control is enabled and you cannot use C-s or
10583 C-q in key sequences.
10585 This setting only has an effect on tty terminals and only when
10586 Emacs reads input in CBREAK mode; see `set-input-interrupt-mode'.
10588 See also `current-input-mode'. */)
10589 (Lisp_Object flow
, Lisp_Object terminal
)
10591 struct terminal
*t
= decode_tty_terminal (terminal
);
10592 struct tty_display_info
*tty
;
10596 tty
= t
->display_info
.tty
;
10598 if (tty
->flow_control
!= !NILP (flow
))
10601 /* This causes startup screen to be restored and messes with the mouse. */
10602 reset_sys_modes (tty
);
10605 tty
->flow_control
= !NILP (flow
);
10608 init_sys_modes (tty
);
10614 DEFUN ("set-input-meta-mode", Fset_input_meta_mode
, Sset_input_meta_mode
, 1, 2, 0,
10615 doc
: /* Enable or disable 8-bit input on TERMINAL.
10616 If META is t, Emacs will accept 8-bit input, and interpret the 8th
10617 bit as the Meta modifier.
10619 If META is nil, Emacs will ignore the top bit, on the assumption it is
10622 Otherwise, Emacs will accept and pass through 8-bit input without
10623 specially interpreting the top bit.
10625 This setting only has an effect on tty terminal devices.
10627 Optional parameter TERMINAL specifies the tty terminal device to use.
10628 It may be a terminal object, a frame, or nil for the terminal used by
10629 the currently selected frame.
10631 See also `current-input-mode'. */)
10632 (Lisp_Object meta
, Lisp_Object terminal
)
10634 struct terminal
*t
= decode_tty_terminal (terminal
);
10635 struct tty_display_info
*tty
;
10640 tty
= t
->display_info
.tty
;
10644 else if (EQ (meta
, Qt
))
10649 if (tty
->meta_key
!= new_meta
)
10652 /* this causes startup screen to be restored and messes with the mouse */
10653 reset_sys_modes (tty
);
10656 tty
->meta_key
= new_meta
;
10659 init_sys_modes (tty
);
10665 DEFUN ("set-quit-char", Fset_quit_char
, Sset_quit_char
, 1, 1, 0,
10666 doc
: /* Specify character used for quitting.
10667 QUIT must be an ASCII character.
10669 This function only has an effect on the controlling tty of the Emacs
10672 See also `current-input-mode'. */)
10675 struct terminal
*t
= get_named_terminal ("/dev/tty");
10676 struct tty_display_info
*tty
;
10680 tty
= t
->display_info
.tty
;
10682 if (NILP (quit
) || !INTEGERP (quit
) || XINT (quit
) < 0 || XINT (quit
) > 0400)
10683 error ("QUIT must be an ASCII character");
10686 /* this causes startup screen to be restored and messes with the mouse */
10687 reset_sys_modes (tty
);
10690 /* Don't let this value be out of range. */
10691 quit_char
= XINT (quit
) & (tty
->meta_key
== 0 ? 0177 : 0377);
10694 init_sys_modes (tty
);
10700 DEFUN ("set-input-mode", Fset_input_mode
, Sset_input_mode
, 3, 4, 0,
10701 doc
: /* Set mode of reading keyboard input.
10702 First arg INTERRUPT non-nil means use input interrupts;
10703 nil means use CBREAK mode.
10704 Second arg FLOW non-nil means use ^S/^Q flow control for output to terminal
10705 (no effect except in CBREAK mode).
10706 Third arg META t means accept 8-bit input (for a Meta key).
10707 META nil means ignore the top bit, on the assumption it is parity.
10708 Otherwise, accept 8-bit input and don't use the top bit for Meta.
10709 Optional fourth arg QUIT if non-nil specifies character to use for quitting.
10710 See also `current-input-mode'. */)
10711 (Lisp_Object interrupt
, Lisp_Object flow
, Lisp_Object meta
, Lisp_Object quit
)
10713 Fset_input_interrupt_mode (interrupt
);
10714 Fset_output_flow_control (flow
, Qnil
);
10715 Fset_input_meta_mode (meta
, Qnil
);
10717 Fset_quit_char (quit
);
10721 DEFUN ("current-input-mode", Fcurrent_input_mode
, Scurrent_input_mode
, 0, 0, 0,
10722 doc
: /* Return information about the way Emacs currently reads keyboard input.
10723 The value is a list of the form (INTERRUPT FLOW META QUIT), where
10724 INTERRUPT is non-nil if Emacs is using interrupt-driven input; if
10725 nil, Emacs is using CBREAK mode.
10726 FLOW is non-nil if Emacs uses ^S/^Q flow control for output to the
10727 terminal; this does not apply if Emacs uses interrupt-driven input.
10728 META is t if accepting 8-bit input with 8th bit as Meta flag.
10729 META nil means ignoring the top bit, on the assumption it is parity.
10730 META is neither t nor nil if accepting 8-bit input and using
10731 all 8 bits as the character code.
10732 QUIT is the character Emacs currently uses to quit.
10733 The elements of this list correspond to the arguments of
10734 `set-input-mode'. */)
10737 Lisp_Object val
[4];
10738 struct frame
*sf
= XFRAME (selected_frame
);
10740 val
[0] = interrupt_input
? Qt
: Qnil
;
10741 if (FRAME_TERMCAP_P (sf
) || FRAME_MSDOS_P (sf
))
10743 val
[1] = FRAME_TTY (sf
)->flow_control
? Qt
: Qnil
;
10744 val
[2] = (FRAME_TTY (sf
)->meta_key
== 2
10746 : (CURTTY ()->meta_key
== 1 ? Qt
: Qnil
));
10753 XSETFASTINT (val
[3], quit_char
);
10755 return Flist (ARRAYELTS (val
), val
);
10758 DEFUN ("posn-at-x-y", Fposn_at_x_y
, Sposn_at_x_y
, 2, 4, 0,
10759 doc
: /* Return position information for pixel coordinates X and Y.
10760 By default, X and Y are relative to text area of the selected window.
10761 Optional third arg FRAME-OR-WINDOW non-nil specifies frame or window.
10762 If optional fourth arg WHOLE is non-nil, X is relative to the left
10763 edge of the window.
10765 The return value is similar to a mouse click position:
10766 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
10767 IMAGE (DX . DY) (WIDTH . HEIGHT))
10768 The `posn-' functions access elements of such lists. */)
10769 (Lisp_Object x
, Lisp_Object y
, Lisp_Object frame_or_window
, Lisp_Object whole
)
10774 if (NILP (frame_or_window
))
10775 frame_or_window
= selected_window
;
10777 if (WINDOWP (frame_or_window
))
10779 struct window
*w
= decode_live_window (frame_or_window
);
10781 XSETINT (x
, (XINT (x
)
10782 + WINDOW_LEFT_EDGE_X (w
)
10784 ? window_box_left_offset (w
, TEXT_AREA
)
10786 XSETINT (y
, WINDOW_TO_FRAME_PIXEL_Y (w
, XINT (y
)));
10787 frame_or_window
= w
->frame
;
10790 CHECK_LIVE_FRAME (frame_or_window
);
10792 return make_lispy_position (XFRAME (frame_or_window
), x
, y
, 0);
10795 DEFUN ("posn-at-point", Fposn_at_point
, Sposn_at_point
, 0, 2, 0,
10796 doc
: /* Return position information for buffer POS in WINDOW.
10797 POS defaults to point in WINDOW; WINDOW defaults to the selected window.
10799 Return nil if position is not visible in window. Otherwise,
10800 the return value is similar to that returned by `event-start' for
10801 a mouse click at the upper left corner of the glyph corresponding
10802 to the given buffer position:
10803 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
10804 IMAGE (DX . DY) (WIDTH . HEIGHT))
10805 The `posn-' functions access elements of such lists. */)
10806 (Lisp_Object pos
, Lisp_Object window
)
10811 window
= selected_window
;
10813 tem
= Fpos_visible_in_window_p (pos
, window
, Qt
);
10816 Lisp_Object x
= XCAR (tem
);
10817 Lisp_Object y
= XCAR (XCDR (tem
));
10819 /* Point invisible due to hscrolling? */
10822 tem
= Fposn_at_x_y (x
, y
, window
, Qnil
);
10828 /* Set up a new kboard object with reasonable initial values.
10829 TYPE is a window system for which this keyboard is used. */
10832 init_kboard (KBOARD
*kb
, Lisp_Object type
)
10834 kset_overriding_terminal_local_map (kb
, Qnil
);
10835 kset_last_command (kb
, Qnil
);
10836 kset_real_last_command (kb
, Qnil
);
10837 kset_keyboard_translate_table (kb
, Qnil
);
10838 kset_last_repeatable_command (kb
, Qnil
);
10839 kset_prefix_arg (kb
, Qnil
);
10840 kset_last_prefix_arg (kb
, Qnil
);
10841 kset_kbd_queue (kb
, Qnil
);
10842 kb
->kbd_queue_has_data
= 0;
10843 kb
->immediate_echo
= 0;
10844 kset_echo_string (kb
, Qnil
);
10845 kb
->echo_after_prompt
= -1;
10846 kb
->kbd_macro_buffer
= 0;
10847 kb
->kbd_macro_bufsize
= 0;
10848 kset_defining_kbd_macro (kb
, Qnil
);
10849 kset_last_kbd_macro (kb
, Qnil
);
10850 kb
->reference_count
= 0;
10851 kset_system_key_alist (kb
, Qnil
);
10852 kset_system_key_syms (kb
, Qnil
);
10853 kset_window_system (kb
, type
);
10854 kset_input_decode_map (kb
, Fmake_sparse_keymap (Qnil
));
10855 kset_local_function_key_map (kb
, Fmake_sparse_keymap (Qnil
));
10856 Fset_keymap_parent (KVAR (kb
, Vlocal_function_key_map
), Vfunction_key_map
);
10857 kset_default_minibuffer_frame (kb
, Qnil
);
10860 /* Allocate and basically initialize keyboard
10861 object to use with window system TYPE. */
10864 allocate_kboard (Lisp_Object type
)
10866 KBOARD
*kb
= xmalloc (sizeof *kb
);
10868 init_kboard (kb
, type
);
10869 kb
->next_kboard
= all_kboards
;
10875 * Destroy the contents of a kboard object, but not the object itself.
10876 * We use this just before deleting it, or if we're going to initialize
10877 * it a second time.
10880 wipe_kboard (KBOARD
*kb
)
10882 xfree (kb
->kbd_macro_buffer
);
10885 /* Free KB and memory referenced from it. */
10888 delete_kboard (KBOARD
*kb
)
10892 for (kbp
= &all_kboards
; *kbp
!= kb
; kbp
= &(*kbp
)->next_kboard
)
10895 *kbp
= kb
->next_kboard
;
10897 /* Prevent a dangling reference to KB. */
10898 if (kb
== current_kboard
10899 && FRAMEP (selected_frame
)
10900 && FRAME_LIVE_P (XFRAME (selected_frame
)))
10902 current_kboard
= FRAME_KBOARD (XFRAME (selected_frame
));
10904 if (current_kboard
== kb
)
10913 init_keyboard (void)
10915 /* This is correct before outermost invocation of the editor loop. */
10916 command_loop_level
= -1;
10917 immediate_quit
= 0;
10918 quit_char
= Ctl ('g');
10919 Vunread_command_events
= Qnil
;
10920 timer_idleness_start_time
= invalid_timespec ();
10922 recent_keys_index
= 0;
10923 kbd_fetch_ptr
= kbd_buffer
;
10924 kbd_store_ptr
= kbd_buffer
;
10925 do_mouse_tracking
= Qnil
;
10927 interrupt_input_blocked
= 0;
10928 pending_signals
= 0;
10930 /* This means that command_loop_1 won't try to select anything the first
10932 internal_last_event_frame
= Qnil
;
10933 Vlast_event_frame
= internal_last_event_frame
;
10935 current_kboard
= initial_kboard
;
10936 /* Re-initialize the keyboard again. */
10937 wipe_kboard (current_kboard
);
10938 /* A value of nil for Vwindow_system normally means a tty, but we also use
10939 it for the initial terminal since there is no window system there. */
10940 init_kboard (current_kboard
, Qnil
);
10942 if (!noninteractive
)
10944 /* Before multi-tty support, these handlers used to be installed
10945 only if the current session was a tty session. Now an Emacs
10946 session may have multiple display types, so we always handle
10947 SIGINT. There is special code in handle_interrupt_signal to exit
10948 Emacs on SIGINT when there are no termcap frames on the
10949 controlling terminal. */
10950 struct sigaction action
;
10951 emacs_sigaction_init (&action
, deliver_interrupt_signal
);
10952 sigaction (SIGINT
, &action
, 0);
10954 /* For systems with SysV TERMIO, C-g is set up for both SIGINT and
10955 SIGQUIT and we can't tell which one it will give us. */
10956 sigaction (SIGQUIT
, &action
, 0);
10957 #endif /* not DOS_NT */
10959 #ifdef USABLE_SIGIO
10960 if (!noninteractive
)
10962 struct sigaction action
;
10963 emacs_sigaction_init (&action
, deliver_input_available_signal
);
10964 sigaction (SIGIO
, &action
, 0);
10968 /* Use interrupt input by default, if it works and noninterrupt input
10969 has deficiencies. */
10971 #ifdef INTERRUPT_INPUT
10972 interrupt_input
= 1;
10974 interrupt_input
= 0;
10977 pthread_sigmask (SIG_SETMASK
, &empty_mask
, 0);
10980 if (keyboard_init_hook
)
10981 (*keyboard_init_hook
) ();
10983 #ifdef POLL_FOR_INPUT
10985 poll_suppress_count
= 1;
10990 /* This type's only use is in syms_of_keyboard, to put properties on the
10991 event header symbols. */
10998 static const struct event_head head_table
[] = {
10999 {SYMBOL_INDEX (Qmouse_movement
), SYMBOL_INDEX (Qmouse_movement
)},
11000 {SYMBOL_INDEX (Qscroll_bar_movement
), SYMBOL_INDEX (Qmouse_movement
)},
11002 /* Some of the event heads. */
11003 {SYMBOL_INDEX (Qswitch_frame
), SYMBOL_INDEX (Qswitch_frame
)},
11005 {SYMBOL_INDEX (Qfocus_in
), SYMBOL_INDEX (Qfocus_in
)},
11006 {SYMBOL_INDEX (Qfocus_out
), SYMBOL_INDEX (Qfocus_out
)},
11007 {SYMBOL_INDEX (Qdelete_frame
), SYMBOL_INDEX (Qdelete_frame
)},
11008 {SYMBOL_INDEX (Qiconify_frame
), SYMBOL_INDEX (Qiconify_frame
)},
11009 {SYMBOL_INDEX (Qmake_frame_visible
), SYMBOL_INDEX (Qmake_frame_visible
)},
11010 /* `select-window' should be handled just like `switch-frame'
11011 in read_key_sequence. */
11012 {SYMBOL_INDEX (Qselect_window
), SYMBOL_INDEX (Qswitch_frame
)}
11016 syms_of_keyboard (void)
11018 pending_funcalls
= Qnil
;
11019 staticpro (&pending_funcalls
);
11021 Vlispy_mouse_stem
= build_pure_c_string ("mouse");
11022 staticpro (&Vlispy_mouse_stem
);
11024 regular_top_level_message
= build_pure_c_string ("Back to top level");
11025 #ifdef HAVE_STACK_OVERFLOW_HANDLING
11026 recover_top_level_message
11027 = build_pure_c_string ("Re-entering top level after C stack overflow");
11029 DEFVAR_LISP ("internal--top-level-message", Vinternal__top_level_message
,
11030 doc
: /* Message displayed by `normal-top-level'. */);
11031 Vinternal__top_level_message
= regular_top_level_message
;
11034 DEFSYM (QCimage
, ":image");
11035 DEFSYM (Qhelp_echo
, "help-echo");
11036 DEFSYM (QCrtl
, ":rtl");
11038 staticpro (&item_properties
);
11039 item_properties
= Qnil
;
11041 staticpro (&tool_bar_item_properties
);
11042 tool_bar_item_properties
= Qnil
;
11043 staticpro (&tool_bar_items_vector
);
11044 tool_bar_items_vector
= Qnil
;
11046 DEFSYM (Qtimer_event_handler
, "timer-event-handler");
11047 DEFSYM (Qdisabled_command_function
, "disabled-command-function");
11048 DEFSYM (Qself_insert_command
, "self-insert-command");
11049 DEFSYM (Qforward_char
, "forward-char");
11050 DEFSYM (Qbackward_char
, "backward-char");
11052 /* Non-nil disable property on a command means do not execute it;
11053 call disabled-command-function's value instead. */
11054 DEFSYM (Qdisabled
, "disabled");
11056 DEFSYM (Qundefined
, "undefined");
11058 /* Hooks to run before and after each command. */
11059 DEFSYM (Qpre_command_hook
, "pre-command-hook");
11060 DEFSYM (Qpost_command_hook
, "post-command-hook");
11062 DEFSYM (Qdeferred_action_function
, "deferred-action-function");
11063 DEFSYM (Qdelayed_warnings_hook
, "delayed-warnings-hook");
11064 DEFSYM (Qfunction_key
, "function-key");
11066 /* The values of Qevent_kind properties. */
11067 DEFSYM (Qmouse_click
, "mouse-click");
11069 DEFSYM (Qdrag_n_drop
, "drag-n-drop");
11070 DEFSYM (Qsave_session
, "save-session");
11071 DEFSYM (Qconfig_changed_event
, "config-changed-event");
11073 /* Menu and tool bar item parts. */
11074 DEFSYM (Qmenu_enable
, "menu-enable");
11077 DEFSYM (Qlanguage_change
, "language-change");
11081 DEFSYM (Qdbus_event
, "dbus-event");
11084 #ifdef USE_FILE_NOTIFY
11085 DEFSYM (Qfile_notify
, "file-notify");
11086 #endif /* USE_FILE_NOTIFY */
11088 /* Menu and tool bar item parts. */
11089 DEFSYM (QCenable
, ":enable");
11090 DEFSYM (QCvisible
, ":visible");
11091 DEFSYM (QChelp
, ":help");
11092 DEFSYM (QCfilter
, ":filter");
11093 DEFSYM (QCbutton
, ":button");
11094 DEFSYM (QCkeys
, ":keys");
11095 DEFSYM (QCkey_sequence
, ":key-sequence");
11097 /* Non-nil disable property on a command means
11098 do not execute it; call disabled-command-function's value instead. */
11099 DEFSYM (QCtoggle
, ":toggle");
11100 DEFSYM (QCradio
, ":radio");
11101 DEFSYM (QClabel
, ":label");
11102 DEFSYM (QCvert_only
, ":vert-only");
11104 /* Symbols to use for parts of windows. */
11105 DEFSYM (Qvertical_line
, "vertical-line");
11106 DEFSYM (Qright_divider
, "right-divider");
11107 DEFSYM (Qbottom_divider
, "bottom-divider");
11109 DEFSYM (Qmouse_fixup_help_message
, "mouse-fixup-help-message");
11111 DEFSYM (Qabove_handle
, "above-handle");
11112 DEFSYM (Qhandle
, "handle");
11113 DEFSYM (Qbelow_handle
, "below-handle");
11114 DEFSYM (Qup
, "up");
11115 DEFSYM (Qdown
, "down");
11116 DEFSYM (Qtop
, "top");
11117 DEFSYM (Qbottom
, "bottom");
11118 DEFSYM (Qend_scroll
, "end-scroll");
11119 DEFSYM (Qratio
, "ratio");
11120 DEFSYM (Qbefore_handle
, "before-handle");
11121 DEFSYM (Qhorizontal_handle
, "horizontal-handle");
11122 DEFSYM (Qafter_handle
, "after-handle");
11123 DEFSYM (Qleft
, "left");
11124 DEFSYM (Qright
, "right");
11125 DEFSYM (Qleftmost
, "leftmost");
11126 DEFSYM (Qrightmost
, "rightmost");
11128 /* Properties of event headers. */
11129 DEFSYM (Qevent_kind
, "event-kind");
11130 DEFSYM (Qevent_symbol_elements
, "event-symbol-elements");
11132 /* An event header symbol HEAD may have a property named
11133 Qevent_symbol_element_mask, which is of the form (BASE MODIFIERS);
11134 BASE is the base, unmodified version of HEAD, and MODIFIERS is the
11135 mask of modifiers applied to it. If present, this is used to help
11136 speed up parse_modifiers. */
11137 DEFSYM (Qevent_symbol_element_mask
, "event-symbol-element-mask");
11139 /* An unmodified event header BASE may have a property named
11140 Qmodifier_cache, which is an alist mapping modifier masks onto
11141 modified versions of BASE. If present, this helps speed up
11142 apply_modifiers. */
11143 DEFSYM (Qmodifier_cache
, "modifier-cache");
11145 DEFSYM (Qrecompute_lucid_menubar
, "recompute-lucid-menubar");
11146 DEFSYM (Qactivate_menubar_hook
, "activate-menubar-hook");
11148 DEFSYM (Qpolling_period
, "polling-period");
11150 DEFSYM (Qgui_set_selection
, "gui-set-selection");
11152 /* The primary selection. */
11153 DEFSYM (QPRIMARY
, "PRIMARY");
11155 DEFSYM (Qhandle_switch_frame
, "handle-switch-frame");
11156 DEFSYM (Qhandle_select_window
, "handle-select-window");
11158 DEFSYM (Qinput_method_function
, "input-method-function");
11159 DEFSYM (Qinput_method_exit_on_first_char
, "input-method-exit-on-first-char");
11160 DEFSYM (Qinput_method_use_echo_area
, "input-method-use-echo-area");
11162 DEFSYM (Qhelp_form_show
, "help-form-show");
11164 DEFSYM (Qecho_keystrokes
, "echo-keystrokes");
11166 Fset (Qinput_method_exit_on_first_char
, Qnil
);
11167 Fset (Qinput_method_use_echo_area
, Qnil
);
11169 /* Symbols to head events. */
11170 DEFSYM (Qmouse_movement
, "mouse-movement");
11171 DEFSYM (Qscroll_bar_movement
, "scroll-bar-movement");
11172 DEFSYM (Qswitch_frame
, "switch-frame");
11173 DEFSYM (Qfocus_in
, "focus-in");
11174 DEFSYM (Qfocus_out
, "focus-out");
11175 DEFSYM (Qdelete_frame
, "delete-frame");
11176 DEFSYM (Qiconify_frame
, "iconify-frame");
11177 DEFSYM (Qmake_frame_visible
, "make-frame-visible");
11178 DEFSYM (Qselect_window
, "select-window");
11182 for (i
= 0; i
< ARRAYELTS (head_table
); i
++)
11184 const struct event_head
*p
= &head_table
[i
];
11185 Lisp_Object var
= builtin_lisp_symbol (p
->var
);
11186 Lisp_Object kind
= builtin_lisp_symbol (p
->kind
);
11187 Fput (var
, Qevent_kind
, kind
);
11188 Fput (var
, Qevent_symbol_elements
, list1 (var
));
11192 button_down_location
= Fmake_vector (make_number (5), Qnil
);
11193 staticpro (&button_down_location
);
11194 mouse_syms
= Fmake_vector (make_number (5), Qnil
);
11195 staticpro (&mouse_syms
);
11196 wheel_syms
= Fmake_vector (make_number (ARRAYELTS (lispy_wheel_names
)),
11198 staticpro (&wheel_syms
);
11202 int len
= ARRAYELTS (modifier_names
);
11204 modifier_symbols
= Fmake_vector (make_number (len
), Qnil
);
11205 for (i
= 0; i
< len
; i
++)
11206 if (modifier_names
[i
])
11207 ASET (modifier_symbols
, i
, intern_c_string (modifier_names
[i
]));
11208 staticpro (&modifier_symbols
);
11211 recent_keys
= Fmake_vector (make_number (NUM_RECENT_KEYS
), Qnil
);
11212 staticpro (&recent_keys
);
11214 this_command_keys
= Fmake_vector (make_number (40), Qnil
);
11215 staticpro (&this_command_keys
);
11217 raw_keybuf
= Fmake_vector (make_number (30), Qnil
);
11218 staticpro (&raw_keybuf
);
11220 DEFSYM (Qcommand_execute
, "command-execute");
11222 accent_key_syms
= Qnil
;
11223 staticpro (&accent_key_syms
);
11225 func_key_syms
= Qnil
;
11226 staticpro (&func_key_syms
);
11228 drag_n_drop_syms
= Qnil
;
11229 staticpro (&drag_n_drop_syms
);
11231 unread_switch_frame
= Qnil
;
11232 staticpro (&unread_switch_frame
);
11234 internal_last_event_frame
= Qnil
;
11235 staticpro (&internal_last_event_frame
);
11237 read_key_sequence_cmd
= Qnil
;
11238 staticpro (&read_key_sequence_cmd
);
11239 read_key_sequence_remapped
= Qnil
;
11240 staticpro (&read_key_sequence_remapped
);
11242 menu_bar_one_keymap_changed_items
= Qnil
;
11243 staticpro (&menu_bar_one_keymap_changed_items
);
11245 menu_bar_items_vector
= Qnil
;
11246 staticpro (&menu_bar_items_vector
);
11248 help_form_saved_window_configs
= Qnil
;
11249 staticpro (&help_form_saved_window_configs
);
11251 defsubr (&Scurrent_idle_time
);
11252 defsubr (&Sevent_symbol_parse_modifiers
);
11253 defsubr (&Sevent_convert_list
);
11254 defsubr (&Sread_key_sequence
);
11255 defsubr (&Sread_key_sequence_vector
);
11256 defsubr (&Srecursive_edit
);
11257 defsubr (&Strack_mouse
);
11258 defsubr (&Sinput_pending_p
);
11259 defsubr (&Srecent_keys
);
11260 defsubr (&Sthis_command_keys
);
11261 defsubr (&Sthis_command_keys_vector
);
11262 defsubr (&Sthis_single_command_keys
);
11263 defsubr (&Sthis_single_command_raw_keys
);
11264 defsubr (&Sreset_this_command_lengths
);
11265 defsubr (&Sclear_this_command_keys
);
11266 defsubr (&Ssuspend_emacs
);
11267 defsubr (&Sabort_recursive_edit
);
11268 defsubr (&Sexit_recursive_edit
);
11269 defsubr (&Srecursion_depth
);
11270 defsubr (&Scommand_error_default_function
);
11271 defsubr (&Stop_level
);
11272 defsubr (&Sdiscard_input
);
11273 defsubr (&Sopen_dribble_file
);
11274 defsubr (&Sset_input_interrupt_mode
);
11275 defsubr (&Sset_output_flow_control
);
11276 defsubr (&Sset_input_meta_mode
);
11277 defsubr (&Sset_quit_char
);
11278 defsubr (&Sset_input_mode
);
11279 defsubr (&Scurrent_input_mode
);
11280 defsubr (&Sposn_at_point
);
11281 defsubr (&Sposn_at_x_y
);
11283 DEFVAR_LISP ("last-command-event", last_command_event
,
11284 doc
: /* Last input event that was part of a command. */);
11286 DEFVAR_LISP ("last-nonmenu-event", last_nonmenu_event
,
11287 doc
: /* Last input event in a command, except for mouse menu events.
11288 Mouse menus give back keys that don't look like mouse events;
11289 this variable holds the actual mouse event that led to the menu,
11290 so that you can determine whether the command was run by mouse or not. */);
11292 DEFVAR_LISP ("last-input-event", last_input_event
,
11293 doc
: /* Last input event. */);
11295 DEFVAR_LISP ("unread-command-events", Vunread_command_events
,
11296 doc
: /* List of events to be read as the command input.
11297 These events are processed first, before actual keyboard input.
11298 Events read from this list are not normally added to `this-command-keys',
11299 as they will already have been added once as they were read for the first time.
11300 An element of the form (t . EVENT) forces EVENT to be added to that list. */);
11301 Vunread_command_events
= Qnil
;
11303 DEFVAR_LISP ("unread-post-input-method-events", Vunread_post_input_method_events
,
11304 doc
: /* List of events to be processed as input by input methods.
11305 These events are processed before `unread-command-events'
11306 and actual keyboard input, but are not given to `input-method-function'. */);
11307 Vunread_post_input_method_events
= Qnil
;
11309 DEFVAR_LISP ("unread-input-method-events", Vunread_input_method_events
,
11310 doc
: /* List of events to be processed as input by input methods.
11311 These events are processed after `unread-command-events', but
11312 before actual keyboard input.
11313 If there's an active input method, the events are given to
11314 `input-method-function'. */);
11315 Vunread_input_method_events
= Qnil
;
11317 DEFVAR_LISP ("meta-prefix-char", meta_prefix_char
,
11318 doc
: /* Meta-prefix character code.
11319 Meta-foo as command input turns into this character followed by foo. */);
11320 XSETINT (meta_prefix_char
, 033);
11322 DEFVAR_KBOARD ("last-command", Vlast_command
,
11323 doc
: /* The last command executed.
11324 Normally a symbol with a function definition, but can be whatever was found
11325 in the keymap, or whatever the variable `this-command' was set to by that
11328 The value `mode-exit' is special; it means that the previous command
11329 read an event that told it to exit, and it did so and unread that event.
11330 In other words, the present command is the event that made the previous
11333 The value `kill-region' is special; it means that the previous command
11334 was a kill command.
11336 `last-command' has a separate binding for each terminal device.
11337 See Info node `(elisp)Multiple Terminals'. */);
11339 DEFVAR_KBOARD ("real-last-command", Vreal_last_command
,
11340 doc
: /* Same as `last-command', but never altered by Lisp code.
11341 Taken from the previous value of `real-this-command'. */);
11343 DEFVAR_KBOARD ("last-repeatable-command", Vlast_repeatable_command
,
11344 doc
: /* Last command that may be repeated.
11345 The last command executed that was not bound to an input event.
11346 This is the command `repeat' will try to repeat.
11347 Taken from a previous value of `real-this-command'. */);
11349 DEFVAR_LISP ("this-command", Vthis_command
,
11350 doc
: /* The command now being executed.
11351 The command can set this variable; whatever is put here
11352 will be in `last-command' during the following command. */);
11353 Vthis_command
= Qnil
;
11355 DEFVAR_LISP ("real-this-command", Vreal_this_command
,
11356 doc
: /* This is like `this-command', except that commands should never modify it. */);
11357 Vreal_this_command
= Qnil
;
11359 DEFVAR_LISP ("this-command-keys-shift-translated",
11360 Vthis_command_keys_shift_translated
,
11361 doc
: /* Non-nil if the key sequence activating this command was shift-translated.
11362 Shift-translation occurs when there is no binding for the key sequence
11363 as entered, but a binding was found by changing an upper-case letter
11364 to lower-case, or a shifted function key to an unshifted one. */);
11365 Vthis_command_keys_shift_translated
= Qnil
;
11367 DEFVAR_LISP ("this-original-command", Vthis_original_command
,
11368 doc
: /* The command bound to the current key sequence before remapping.
11369 It equals `this-command' if the original command was not remapped through
11370 any of the active keymaps. Otherwise, the value of `this-command' is the
11371 result of looking up the original command in the active keymaps. */);
11372 Vthis_original_command
= Qnil
;
11374 DEFVAR_INT ("auto-save-interval", auto_save_interval
,
11375 doc
: /* Number of input events between auto-saves.
11376 Zero means disable autosaving due to number of characters typed. */);
11377 auto_save_interval
= 300;
11379 DEFVAR_LISP ("auto-save-timeout", Vauto_save_timeout
,
11380 doc
: /* Number of seconds idle time before auto-save.
11381 Zero or nil means disable auto-saving due to idleness.
11382 After auto-saving due to this many seconds of idle time,
11383 Emacs also does a garbage collection if that seems to be warranted. */);
11384 XSETFASTINT (Vauto_save_timeout
, 30);
11386 DEFVAR_LISP ("echo-keystrokes", Vecho_keystrokes
,
11387 doc
: /* Nonzero means echo unfinished commands after this many seconds of pause.
11388 The value may be integer or floating point.
11389 If the value is zero, don't echo at all. */);
11390 Vecho_keystrokes
= make_number (1);
11392 DEFVAR_INT ("polling-period", polling_period
,
11393 doc
: /* Interval between polling for input during Lisp execution.
11394 The reason for polling is to make C-g work to stop a running program.
11395 Polling is needed only when using X windows and SIGIO does not work.
11396 Polling is automatically disabled in all other cases. */);
11397 polling_period
= 2;
11399 DEFVAR_LISP ("double-click-time", Vdouble_click_time
,
11400 doc
: /* Maximum time between mouse clicks to make a double-click.
11401 Measured in milliseconds. The value nil means disable double-click
11402 recognition; t means double-clicks have no time limit and are detected
11403 by position only. */);
11404 Vdouble_click_time
= make_number (500);
11406 DEFVAR_INT ("double-click-fuzz", double_click_fuzz
,
11407 doc
: /* Maximum mouse movement between clicks to make a double-click.
11408 On window-system frames, value is the number of pixels the mouse may have
11409 moved horizontally or vertically between two clicks to make a double-click.
11410 On non window-system frames, value is interpreted in units of 1/8 characters
11413 This variable is also the threshold for motion of the mouse
11414 to count as a drag. */);
11415 double_click_fuzz
= 3;
11417 DEFVAR_INT ("num-input-keys", num_input_keys
,
11418 doc
: /* Number of complete key sequences read as input so far.
11419 This includes key sequences read from keyboard macros.
11420 The number is effectively the number of interactive command invocations. */);
11421 num_input_keys
= 0;
11423 DEFVAR_INT ("num-nonmacro-input-events", num_nonmacro_input_events
,
11424 doc
: /* Number of input events read from the keyboard so far.
11425 This does not include events generated by keyboard macros. */);
11426 num_nonmacro_input_events
= 0;
11428 DEFVAR_LISP ("last-event-frame", Vlast_event_frame
,
11429 doc
: /* The frame in which the most recently read event occurred.
11430 If the last event came from a keyboard macro, this is set to `macro'. */);
11431 Vlast_event_frame
= Qnil
;
11433 /* This variable is set up in sysdep.c. */
11434 DEFVAR_LISP ("tty-erase-char", Vtty_erase_char
,
11435 doc
: /* The ERASE character as set by the user with stty. */);
11437 DEFVAR_LISP ("help-char", Vhelp_char
,
11438 doc
: /* Character to recognize as meaning Help.
11439 When it is read, do `(eval help-form)', and display result if it's a string.
11440 If the value of `help-form' is nil, this char can be read normally. */);
11441 XSETINT (Vhelp_char
, Ctl ('H'));
11443 DEFVAR_LISP ("help-event-list", Vhelp_event_list
,
11444 doc
: /* List of input events to recognize as meaning Help.
11445 These work just like the value of `help-char' (see that). */);
11446 Vhelp_event_list
= Qnil
;
11448 DEFVAR_LISP ("help-form", Vhelp_form
,
11449 doc
: /* Form to execute when character `help-char' is read.
11450 If the form returns a string, that string is displayed.
11451 If `help-form' is nil, the help char is not recognized. */);
11454 DEFVAR_LISP ("prefix-help-command", Vprefix_help_command
,
11455 doc
: /* Command to run when `help-char' character follows a prefix key.
11456 This command is used only when there is no actual binding
11457 for that character after that prefix key. */);
11458 Vprefix_help_command
= Qnil
;
11460 DEFVAR_LISP ("top-level", Vtop_level
,
11461 doc
: /* Form to evaluate when Emacs starts up.
11462 Useful to set before you dump a modified Emacs. */);
11465 DEFVAR_KBOARD ("keyboard-translate-table", Vkeyboard_translate_table
,
11466 doc
: /* Translate table for local keyboard input, or nil.
11467 If non-nil, the value should be a char-table. Each character read
11468 from the keyboard is looked up in this char-table. If the value found
11469 there is non-nil, then it is used instead of the actual input character.
11471 The value can also be a string or vector, but this is considered obsolete.
11472 If it is a string or vector of length N, character codes N and up are left
11473 untranslated. In a vector, an element which is nil means "no translation".
11475 This is applied to the characters supplied to input methods, not their
11476 output. See also `translation-table-for-input'.
11478 This variable has a separate binding for each terminal.
11479 See Info node `(elisp)Multiple Terminals'. */);
11481 DEFVAR_BOOL ("cannot-suspend", cannot_suspend
,
11482 doc
: /* Non-nil means to always spawn a subshell instead of suspending.
11483 \(Even if the operating system has support for stopping a process.\) */);
11484 cannot_suspend
= 0;
11486 DEFVAR_BOOL ("menu-prompting", menu_prompting
,
11487 doc
: /* Non-nil means prompt with menus when appropriate.
11488 This is done when reading from a keymap that has a prompt string,
11489 for elements that have prompt strings.
11490 The menu is displayed on the screen
11491 if X menus were enabled at configuration
11492 time and the previous event was a mouse click prefix key.
11493 Otherwise, menu prompting uses the echo area. */);
11494 menu_prompting
= 1;
11496 DEFVAR_LISP ("menu-prompt-more-char", menu_prompt_more_char
,
11497 doc
: /* Character to see next line of menu prompt.
11498 Type this character while in a menu prompt to rotate around the lines of it. */);
11499 XSETINT (menu_prompt_more_char
, ' ');
11501 DEFVAR_INT ("extra-keyboard-modifiers", extra_keyboard_modifiers
,
11502 doc
: /* A mask of additional modifier keys to use with every keyboard character.
11503 Emacs applies the modifiers of the character stored here to each keyboard
11504 character it reads. For example, after evaluating the expression
11505 (setq extra-keyboard-modifiers ?\\C-x)
11506 all input characters will have the control modifier applied to them.
11508 Note that the character ?\\C-@, equivalent to the integer zero, does
11509 not count as a control character; rather, it counts as a character
11510 with no modifiers; thus, setting `extra-keyboard-modifiers' to zero
11511 cancels any modification. */);
11512 extra_keyboard_modifiers
= 0;
11514 DEFSYM (Qdeactivate_mark
, "deactivate-mark");
11515 DEFVAR_LISP ("deactivate-mark", Vdeactivate_mark
,
11516 doc
: /* If an editing command sets this to t, deactivate the mark afterward.
11517 The command loop sets this to nil before each command,
11518 and tests the value when the command returns.
11519 Buffer modification stores t in this variable. */);
11520 Vdeactivate_mark
= Qnil
;
11521 Fmake_variable_buffer_local (Qdeactivate_mark
);
11523 DEFVAR_LISP ("pre-command-hook", Vpre_command_hook
,
11524 doc
: /* Normal hook run before each command is executed.
11525 If an unhandled error happens in running this hook,
11526 the function in which the error occurred is unconditionally removed, since
11527 otherwise the error might happen repeatedly and make Emacs nonfunctional. */);
11528 Vpre_command_hook
= Qnil
;
11530 DEFVAR_LISP ("post-command-hook", Vpost_command_hook
,
11531 doc
: /* Normal hook run after each command is executed.
11532 If an unhandled error happens in running this hook,
11533 the function in which the error occurred is unconditionally removed, since
11534 otherwise the error might happen repeatedly and make Emacs nonfunctional. */);
11535 Vpost_command_hook
= Qnil
;
11538 DEFVAR_LISP ("echo-area-clear-hook", ...,
11539 doc
: /* Normal hook run when clearing the echo area. */);
11541 DEFSYM (Qecho_area_clear_hook
, "echo-area-clear-hook");
11542 Fset (Qecho_area_clear_hook
, Qnil
);
11544 DEFVAR_LISP ("lucid-menu-bar-dirty-flag", Vlucid_menu_bar_dirty_flag
,
11545 doc
: /* Non-nil means menu bar, specified Lucid style, needs to be recomputed. */);
11546 Vlucid_menu_bar_dirty_flag
= Qnil
;
11548 DEFVAR_LISP ("menu-bar-final-items", Vmenu_bar_final_items
,
11549 doc
: /* List of menu bar items to move to the end of the menu bar.
11550 The elements of the list are event types that may have menu bar bindings. */);
11551 Vmenu_bar_final_items
= Qnil
;
11553 DEFVAR_LISP ("tool-bar-separator-image-expression", Vtool_bar_separator_image_expression
,
11554 doc
: /* Expression evaluating to the image spec for a tool-bar separator.
11555 This is used internally by graphical displays that do not render
11556 tool-bar separators natively. Otherwise it is unused (e.g. on GTK). */);
11557 Vtool_bar_separator_image_expression
= Qnil
;
11559 DEFVAR_KBOARD ("overriding-terminal-local-map",
11560 Voverriding_terminal_local_map
,
11561 doc
: /* Per-terminal keymap that takes precedence over all other keymaps.
11562 This variable is intended to let commands such as `universal-argument'
11563 set up a different keymap for reading the next command.
11565 `overriding-terminal-local-map' has a separate binding for each
11566 terminal device. See Info node `(elisp)Multiple Terminals'. */);
11568 DEFVAR_LISP ("overriding-local-map", Voverriding_local_map
,
11569 doc
: /* Keymap that replaces (overrides) local keymaps.
11570 If this variable is non-nil, Emacs looks up key bindings in this
11571 keymap INSTEAD OF the keymap char property, minor mode maps, and the
11572 buffer's local map. Hence, the only active keymaps would be
11573 `overriding-terminal-local-map', this keymap, and `global-keymap', in
11574 order of precedence. */);
11575 Voverriding_local_map
= Qnil
;
11577 DEFVAR_LISP ("overriding-local-map-menu-flag", Voverriding_local_map_menu_flag
,
11578 doc
: /* Non-nil means `overriding-local-map' applies to the menu bar.
11579 Otherwise, the menu bar continues to reflect the buffer's local map
11580 and the minor mode maps regardless of `overriding-local-map'. */);
11581 Voverriding_local_map_menu_flag
= Qnil
;
11583 DEFVAR_LISP ("special-event-map", Vspecial_event_map
,
11584 doc
: /* Keymap defining bindings for special events to execute at low level. */);
11585 Vspecial_event_map
= list1 (intern_c_string ("keymap"));
11587 DEFVAR_LISP ("track-mouse", do_mouse_tracking
,
11588 doc
: /* Non-nil means generate motion events for mouse motion. */);
11590 DEFVAR_KBOARD ("system-key-alist", Vsystem_key_alist
,
11591 doc
: /* Alist of system-specific X windows key symbols.
11592 Each element should have the form (N . SYMBOL) where N is the
11593 numeric keysym code (sans the \"system-specific\" bit 1<<28)
11594 and SYMBOL is its name.
11596 `system-key-alist' has a separate binding for each terminal device.
11597 See Info node `(elisp)Multiple Terminals'. */);
11599 DEFVAR_KBOARD ("local-function-key-map", Vlocal_function_key_map
,
11600 doc
: /* Keymap that translates key sequences to key sequences during input.
11601 This is used mainly for mapping key sequences into some preferred
11602 key events (symbols).
11604 The `read-key-sequence' function replaces any subsequence bound by
11605 `local-function-key-map' with its binding. More precisely, when the
11606 active keymaps have no binding for the current key sequence but
11607 `local-function-key-map' binds a suffix of the sequence to a vector or
11608 string, `read-key-sequence' replaces the matching suffix with its
11609 binding, and continues with the new sequence.
11611 If the binding is a function, it is called with one argument (the prompt)
11612 and its return value (a key sequence) is used.
11614 The events that come from bindings in `local-function-key-map' are not
11615 themselves looked up in `local-function-key-map'.
11617 For example, suppose `local-function-key-map' binds `ESC O P' to [f1].
11618 Typing `ESC O P' to `read-key-sequence' would return [f1]. Typing
11619 `C-x ESC O P' would return [?\\C-x f1]. If [f1] were a prefix key,
11620 typing `ESC O P x' would return [f1 x].
11622 `local-function-key-map' has a separate binding for each terminal
11623 device. See Info node `(elisp)Multiple Terminals'. If you need to
11624 define a binding on all terminals, change `function-key-map'
11625 instead. Initially, `local-function-key-map' is an empty keymap that
11626 has `function-key-map' as its parent on all terminal devices. */);
11628 DEFVAR_KBOARD ("input-decode-map", Vinput_decode_map
,
11629 doc
: /* Keymap that decodes input escape sequences.
11630 This is used mainly for mapping ASCII function key sequences into
11631 real Emacs function key events (symbols).
11633 The `read-key-sequence' function replaces any subsequence bound by
11634 `input-decode-map' with its binding. Contrary to `function-key-map',
11635 this map applies its rebinding regardless of the presence of an ordinary
11636 binding. So it is more like `key-translation-map' except that it applies
11637 before `function-key-map' rather than after.
11639 If the binding is a function, it is called with one argument (the prompt)
11640 and its return value (a key sequence) is used.
11642 The events that come from bindings in `input-decode-map' are not
11643 themselves looked up in `input-decode-map'. */);
11645 DEFVAR_LISP ("function-key-map", Vfunction_key_map
,
11646 doc
: /* The parent keymap of all `local-function-key-map' instances.
11647 Function key definitions that apply to all terminal devices should go
11648 here. If a mapping is defined in both the current
11649 `local-function-key-map' binding and this variable, then the local
11650 definition will take precedence. */);
11651 Vfunction_key_map
= Fmake_sparse_keymap (Qnil
);
11653 DEFVAR_LISP ("key-translation-map", Vkey_translation_map
,
11654 doc
: /* Keymap of key translations that can override keymaps.
11655 This keymap works like `input-decode-map', but comes after `function-key-map'.
11656 Another difference is that it is global rather than terminal-local. */);
11657 Vkey_translation_map
= Fmake_sparse_keymap (Qnil
);
11659 DEFVAR_LISP ("deferred-action-list", Vdeferred_action_list
,
11660 doc
: /* List of deferred actions to be performed at a later time.
11661 The precise format isn't relevant here; we just check whether it is nil. */);
11662 Vdeferred_action_list
= Qnil
;
11664 DEFVAR_LISP ("deferred-action-function", Vdeferred_action_function
,
11665 doc
: /* Function to call to handle deferred actions, after each command.
11666 This function is called with no arguments after each command
11667 whenever `deferred-action-list' is non-nil. */);
11668 Vdeferred_action_function
= Qnil
;
11670 DEFVAR_LISP ("delayed-warnings-list", Vdelayed_warnings_list
,
11671 doc
: /* List of warnings to be displayed after this command.
11672 Each element must be a list (TYPE MESSAGE [LEVEL [BUFFER-NAME]]),
11673 as per the args of `display-warning' (which see).
11674 If this variable is non-nil, `delayed-warnings-hook' will be run
11675 immediately after running `post-command-hook'. */);
11676 Vdelayed_warnings_list
= Qnil
;
11678 DEFVAR_LISP ("timer-list", Vtimer_list
,
11679 doc
: /* List of active absolute time timers in order of increasing time. */);
11680 Vtimer_list
= Qnil
;
11682 DEFVAR_LISP ("timer-idle-list", Vtimer_idle_list
,
11683 doc
: /* List of active idle-time timers in order of increasing time. */);
11684 Vtimer_idle_list
= Qnil
;
11686 DEFVAR_LISP ("input-method-function", Vinput_method_function
,
11687 doc
: /* If non-nil, the function that implements the current input method.
11688 It's called with one argument, a printing character that was just read.
11689 \(That means a character with code 040...0176.)
11690 Typically this function uses `read-event' to read additional events.
11691 When it does so, it should first bind `input-method-function' to nil
11692 so it will not be called recursively.
11694 The function should return a list of zero or more events
11695 to be used as input. If it wants to put back some events
11696 to be reconsidered, separately, by the input method,
11697 it can add them to the beginning of `unread-command-events'.
11699 The input method function can find in `input-method-previous-message'
11700 the previous echo area message.
11702 The input method function should refer to the variables
11703 `input-method-use-echo-area' and `input-method-exit-on-first-char'
11704 for guidance on what to do. */);
11705 Vinput_method_function
= Qnil
;
11707 DEFVAR_LISP ("input-method-previous-message",
11708 Vinput_method_previous_message
,
11709 doc
: /* When `input-method-function' is called, hold the previous echo area message.
11710 This variable exists because `read-event' clears the echo area
11711 before running the input method. It is nil if there was no message. */);
11712 Vinput_method_previous_message
= Qnil
;
11714 DEFVAR_LISP ("show-help-function", Vshow_help_function
,
11715 doc
: /* If non-nil, the function that implements the display of help.
11716 It's called with one argument, the help string to display. */);
11717 Vshow_help_function
= Qnil
;
11719 DEFVAR_LISP ("disable-point-adjustment", Vdisable_point_adjustment
,
11720 doc
: /* If non-nil, suppress point adjustment after executing a command.
11722 After a command is executed, if point is moved into a region that has
11723 special properties (e.g. composition, display), we adjust point to
11724 the boundary of the region. But, when a command sets this variable to
11725 non-nil, we suppress the point adjustment.
11727 This variable is set to nil before reading a command, and is checked
11728 just after executing the command. */);
11729 Vdisable_point_adjustment
= Qnil
;
11731 DEFVAR_LISP ("global-disable-point-adjustment",
11732 Vglobal_disable_point_adjustment
,
11733 doc
: /* If non-nil, always suppress point adjustment.
11735 The default value is nil, in which case, point adjustment are
11736 suppressed only after special commands that set
11737 `disable-point-adjustment' (which see) to non-nil. */);
11738 Vglobal_disable_point_adjustment
= Qnil
;
11740 DEFVAR_LISP ("minibuffer-message-timeout", Vminibuffer_message_timeout
,
11741 doc
: /* How long to display an echo-area message when the minibuffer is active.
11742 If the value is not a number, such messages don't time out. */);
11743 Vminibuffer_message_timeout
= make_number (2);
11745 DEFVAR_LISP ("throw-on-input", Vthrow_on_input
,
11746 doc
: /* If non-nil, any keyboard input throws to this symbol.
11747 The value of that variable is passed to `quit-flag' and later causes a
11748 peculiar kind of quitting. */);
11749 Vthrow_on_input
= Qnil
;
11751 DEFVAR_LISP ("command-error-function", Vcommand_error_function
,
11752 doc
: /* Function to output error messages.
11753 Called with three arguments:
11754 - the error data, a list of the form (SIGNALED-CONDITION . SIGNAL-DATA)
11755 such as what `condition-case' would bind its variable to,
11756 - the context (a string which normally goes at the start of the message),
11757 - the Lisp function within which the error was signaled. */);
11758 Vcommand_error_function
= intern ("command-error-default-function");
11760 DEFVAR_LISP ("enable-disabled-menus-and-buttons",
11761 Venable_disabled_menus_and_buttons
,
11762 doc
: /* If non-nil, don't ignore events produced by disabled menu items and tool-bar.
11764 Help functions bind this to allow help on disabled menu items
11765 and tool-bar buttons. */);
11766 Venable_disabled_menus_and_buttons
= Qnil
;
11768 DEFVAR_LISP ("select-active-regions",
11769 Vselect_active_regions
,
11770 doc
: /* If non-nil, an active region automatically sets the primary selection.
11771 If the value is `only', only temporarily active regions (usually made
11772 by mouse-dragging or shift-selection) set the window selection.
11774 This takes effect only when Transient Mark mode is enabled. */);
11775 Vselect_active_regions
= Qt
;
11777 DEFVAR_LISP ("saved-region-selection",
11778 Vsaved_region_selection
,
11779 doc
: /* Contents of active region prior to buffer modification.
11780 If `select-active-regions' is non-nil, Emacs sets this to the
11781 text in the region before modifying the buffer. The next call to
11782 the function `deactivate-mark' uses this to set the window selection. */);
11783 Vsaved_region_selection
= Qnil
;
11785 DEFVAR_LISP ("selection-inhibit-update-commands",
11786 Vselection_inhibit_update_commands
,
11787 doc
: /* List of commands which should not update the selection.
11788 Normally, if `select-active-regions' is non-nil and the mark remains
11789 active after a command (i.e. the mark was not deactivated), the Emacs
11790 command loop sets the selection to the text in the region. However,
11791 if the command is in this list, the selection is not updated. */);
11792 Vselection_inhibit_update_commands
11793 = list2 (Qhandle_switch_frame
, Qhandle_select_window
);
11795 DEFVAR_LISP ("debug-on-event",
11797 doc
: /* Enter debugger on this event. When Emacs
11798 receives the special event specified by this variable, it will try to
11799 break into the debugger as soon as possible instead of processing the
11800 event normally through `special-event-map'.
11802 Currently, the only supported values for this
11803 variable are `sigusr1' and `sigusr2'. */);
11804 Vdebug_on_event
= intern_c_string ("sigusr2");
11806 /* Create the initial keyboard. Qt means 'unset'. */
11807 initial_kboard
= allocate_kboard (Qt
);
11811 keys_of_keyboard (void)
11813 initial_define_key (global_map
, Ctl ('Z'), "suspend-emacs");
11814 initial_define_key (control_x_map
, Ctl ('Z'), "suspend-emacs");
11815 initial_define_key (meta_map
, Ctl ('C'), "exit-recursive-edit");
11816 initial_define_key (global_map
, Ctl (']'), "abort-recursive-edit");
11817 initial_define_key (meta_map
, 'x', "execute-extended-command");
11819 initial_define_lispy_key (Vspecial_event_map
, "delete-frame",
11820 "handle-delete-frame");
11821 initial_define_lispy_key (Vspecial_event_map
, "ns-put-working-text",
11822 "ns-put-working-text");
11823 initial_define_lispy_key (Vspecial_event_map
, "ns-unput-working-text",
11824 "ns-unput-working-text");
11825 /* Here we used to use `ignore-event' which would simple set prefix-arg to
11826 current-prefix-arg, as is done in `handle-switch-frame'.
11827 But `handle-switch-frame is not run from the special-map.
11828 Commands from that map are run in a special way that automatically
11829 preserves the prefix-arg. Restoring the prefix arg here is not just
11830 redundant but harmful:
11832 - current-prefix-arg is set to non-nil, prefix-arg is set to nil.
11833 - after the first prompt, the exit-minibuffer-hook is run which may
11834 iconify a frame and thus push a `iconify-frame' event.
11835 - after running exit-minibuffer-hook, current-prefix-arg is
11836 restored to the non-nil value it had before the prompt.
11837 - we enter the second prompt.
11838 current-prefix-arg is non-nil, prefix-arg is nil.
11839 - before running the first real event, we run the special iconify-frame
11840 event, but we pass the `special' arg to command-execute so
11841 current-prefix-arg and prefix-arg are left untouched.
11842 - here we foolishly copy the non-nil current-prefix-arg to prefix-arg.
11843 - the next key event will have a spuriously non-nil current-prefix-arg. */
11844 initial_define_lispy_key (Vspecial_event_map
, "iconify-frame",
11846 initial_define_lispy_key (Vspecial_event_map
, "make-frame-visible",
11848 /* Handling it at such a low-level causes read_key_sequence to get
11849 * confused because it doesn't realize that the current_buffer was
11850 * changed by read_char.
11852 * initial_define_lispy_key (Vspecial_event_map, "select-window",
11853 * "handle-select-window"); */
11854 initial_define_lispy_key (Vspecial_event_map
, "save-session",
11855 "handle-save-session");
11858 /* Define a special event which is raised for dbus callback
11860 initial_define_lispy_key (Vspecial_event_map
, "dbus-event",
11861 "dbus-handle-event");
11864 #ifdef USE_FILE_NOTIFY
11865 /* Define a special event which is raised for notification callback
11867 initial_define_lispy_key (Vspecial_event_map
, "file-notify",
11868 "file-notify-handle-event");
11869 #endif /* USE_FILE_NOTIFY */
11871 initial_define_lispy_key (Vspecial_event_map
, "config-changed-event",
11873 #if defined (WINDOWSNT)
11874 initial_define_lispy_key (Vspecial_event_map
, "language-change",
11877 initial_define_lispy_key (Vspecial_event_map
, "focus-in",
11878 "handle-focus-in");
11879 initial_define_lispy_key (Vspecial_event_map
, "focus-out",
11880 "handle-focus-out");
11883 /* Mark the pointers in the kboard objects.
11884 Called by Fgarbage_collect. */
11886 mark_kboards (void)
11890 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
11892 if (kb
->kbd_macro_buffer
)
11893 for (p
= kb
->kbd_macro_buffer
; p
< kb
->kbd_macro_ptr
; p
++)
11895 mark_object (KVAR (kb
, Voverriding_terminal_local_map
));
11896 mark_object (KVAR (kb
, Vlast_command
));
11897 mark_object (KVAR (kb
, Vreal_last_command
));
11898 mark_object (KVAR (kb
, Vkeyboard_translate_table
));
11899 mark_object (KVAR (kb
, Vlast_repeatable_command
));
11900 mark_object (KVAR (kb
, Vprefix_arg
));
11901 mark_object (KVAR (kb
, Vlast_prefix_arg
));
11902 mark_object (KVAR (kb
, kbd_queue
));
11903 mark_object (KVAR (kb
, defining_kbd_macro
));
11904 mark_object (KVAR (kb
, Vlast_kbd_macro
));
11905 mark_object (KVAR (kb
, Vsystem_key_alist
));
11906 mark_object (KVAR (kb
, system_key_syms
));
11907 mark_object (KVAR (kb
, Vwindow_system
));
11908 mark_object (KVAR (kb
, Vinput_decode_map
));
11909 mark_object (KVAR (kb
, Vlocal_function_key_map
));
11910 mark_object (KVAR (kb
, Vdefault_minibuffer_frame
));
11911 mark_object (KVAR (kb
, echo_string
));
11914 struct input_event
*event
;
11915 for (event
= kbd_fetch_ptr
; event
!= kbd_store_ptr
; event
++)
11917 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
11918 event
= kbd_buffer
;
11919 /* These two special event types has no Lisp_Objects to mark. */
11920 if (event
->kind
!= SELECTION_REQUEST_EVENT
11921 && event
->kind
!= SELECTION_CLEAR_EVENT
)
11923 mark_object (event
->x
);
11924 mark_object (event
->y
);
11925 mark_object (event
->frame_or_window
);
11926 mark_object (event
->arg
);