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 CALLN (Fmessage
, 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 eassert (nargs
== 2);
1881 /* Yes, run_hook_with_args works with args in the other order. */
1882 internal_condition_case_n (safe_run_hooks_1
,
1883 2, ((Lisp_Object
[]) {args
[1], args
[0]}),
1884 Qt
, safe_run_hooks_error
);
1888 /* If we get an error while running the hook, cause the hook variable
1889 to be nil. Also inhibit quits, so that C-g won't cause the hook
1890 to mysteriously evaporate. */
1893 safe_run_hooks (Lisp_Object hook
)
1895 struct gcpro gcpro1
;
1896 ptrdiff_t count
= SPECPDL_INDEX ();
1899 specbind (Qinhibit_quit
, Qt
);
1900 run_hook_with_args (2, ((Lisp_Object
[]) {hook
, hook
}), safe_run_hook_funcall
);
1901 unbind_to (count
, Qnil
);
1906 /* Nonzero means polling for input is temporarily suppressed. */
1908 int poll_suppress_count
;
1911 #ifdef POLL_FOR_INPUT
1913 /* Asynchronous timer for polling. */
1915 static struct atimer
*poll_timer
;
1917 /* Poll for input, so that we catch a C-g if it comes in. */
1919 poll_for_input_1 (void)
1921 if (! input_blocked_p ()
1922 && !waiting_for_input
)
1926 /* Timer callback function for poll_timer. TIMER is equal to
1930 poll_for_input (struct atimer
*timer
)
1932 if (poll_suppress_count
== 0)
1933 pending_signals
= 1;
1936 #endif /* POLL_FOR_INPUT */
1938 /* Begin signals to poll for input, if they are appropriate.
1939 This function is called unconditionally from various places. */
1942 start_polling (void)
1944 #ifdef POLL_FOR_INPUT
1945 /* XXX This condition was (read_socket_hook && !interrupt_input),
1946 but read_socket_hook is not global anymore. Let's pretend that
1948 if (!interrupt_input
)
1950 /* Turn alarm handling on unconditionally. It might have
1951 been turned off in process.c. */
1952 turn_on_atimers (1);
1954 /* If poll timer doesn't exist, or we need one with
1955 a different interval, start a new one. */
1956 if (poll_timer
== NULL
1957 || poll_timer
->interval
.tv_sec
!= polling_period
)
1959 time_t period
= max (1, min (polling_period
, TYPE_MAXIMUM (time_t)));
1960 struct timespec interval
= make_timespec (period
, 0);
1963 cancel_atimer (poll_timer
);
1965 poll_timer
= start_atimer (ATIMER_CONTINUOUS
, interval
,
1966 poll_for_input
, NULL
);
1969 /* Let the timer's callback function poll for input
1970 if this becomes zero. */
1971 --poll_suppress_count
;
1976 /* True if we are using polling to handle input asynchronously. */
1979 input_polling_used (void)
1981 #ifdef POLL_FOR_INPUT
1982 /* XXX This condition was (read_socket_hook && !interrupt_input),
1983 but read_socket_hook is not global anymore. Let's pretend that
1985 return !interrupt_input
;
1991 /* Turn off polling. */
1996 #ifdef POLL_FOR_INPUT
1997 /* XXX This condition was (read_socket_hook && !interrupt_input),
1998 but read_socket_hook is not global anymore. Let's pretend that
2000 if (!interrupt_input
)
2001 ++poll_suppress_count
;
2005 /* Set the value of poll_suppress_count to COUNT
2006 and start or stop polling accordingly. */
2009 set_poll_suppress_count (int count
)
2011 #ifdef POLL_FOR_INPUT
2012 if (count
== 0 && poll_suppress_count
!= 0)
2014 poll_suppress_count
= 1;
2017 else if (count
!= 0 && poll_suppress_count
== 0)
2021 poll_suppress_count
= count
;
2025 /* Bind polling_period to a value at least N.
2026 But don't decrease it. */
2029 bind_polling_period (int n
)
2031 #ifdef POLL_FOR_INPUT
2032 EMACS_INT
new = polling_period
;
2037 stop_other_atimers (poll_timer
);
2039 specbind (Qpolling_period
, make_number (new));
2040 /* Start a new alarm with the new period. */
2045 /* Apply the control modifier to CHARACTER. */
2048 make_ctrl_char (int c
)
2050 /* Save the upper bits here. */
2051 int upper
= c
& ~0177;
2053 if (! ASCII_CHAR_P (c
))
2054 return c
|= ctrl_modifier
;
2058 /* Everything in the columns containing the upper-case letters
2059 denotes a control character. */
2060 if (c
>= 0100 && c
< 0140)
2064 /* Set the shift modifier for a control char
2065 made from a shifted letter. But only for letters! */
2066 if (oc
>= 'A' && oc
<= 'Z')
2067 c
|= shift_modifier
;
2070 /* The lower-case letters denote control characters too. */
2071 else if (c
>= 'a' && c
<= 'z')
2074 /* Include the bits for control and shift
2075 only if the basic ASCII code can't indicate them. */
2079 /* Replace the high bits. */
2080 c
|= (upper
& ~ctrl_modifier
);
2085 /* Display the help-echo property of the character after the mouse pointer.
2086 Either show it in the echo area, or call show-help-function to display
2087 it by other means (maybe in a tooltip).
2089 If HELP is nil, that means clear the previous help echo.
2091 If HELP is a string, display that string. If HELP is a function,
2092 call it with OBJECT and POS as arguments; the function should
2093 return a help string or nil for none. For all other types of HELP,
2094 evaluate it to obtain a string.
2096 WINDOW is the window in which the help was generated, if any.
2097 It is nil if not in a window.
2099 If OBJECT is a buffer, POS is the position in the buffer where the
2100 `help-echo' text property was found.
2102 If OBJECT is an overlay, that overlay has a `help-echo' property,
2103 and POS is the position in the overlay's buffer under the mouse.
2105 If OBJECT is a string (an overlay string or a string displayed with
2106 the `display' property). POS is the position in that string under
2109 Note: this function may only be called with HELP nil or a string
2110 from X code running asynchronously. */
2113 show_help_echo (Lisp_Object help
, Lisp_Object window
, Lisp_Object object
,
2116 if (!NILP (help
) && !STRINGP (help
))
2118 if (FUNCTIONP (help
))
2119 help
= safe_call (4, help
, window
, object
, pos
);
2121 help
= safe_eval (help
);
2123 if (!STRINGP (help
))
2127 if (!noninteractive
&& STRINGP (help
))
2129 /* The mouse-fixup-help-message Lisp function can call
2130 mouse_position_hook, which resets the mouse_moved flags.
2131 This causes trouble if we are trying to read a mouse motion
2132 event (i.e., if we are inside a `track-mouse' form), so we
2133 restore the mouse_moved flag. */
2134 struct frame
*f
= NILP (do_mouse_tracking
) ? NULL
: some_mouse_moved ();
2135 help
= call1 (Qmouse_fixup_help_message
, help
);
2140 if (STRINGP (help
) || NILP (help
))
2142 if (!NILP (Vshow_help_function
))
2143 call1 (Vshow_help_function
, help
);
2144 help_echo_showing_p
= STRINGP (help
);
2150 /* Input of single characters from keyboard. */
2152 static Lisp_Object
kbd_buffer_get_event (KBOARD
**kbp
, bool *used_mouse_menu
,
2153 struct timespec
*end_time
);
2154 static void record_char (Lisp_Object c
);
2156 static Lisp_Object help_form_saved_window_configs
;
2158 read_char_help_form_unwind (void)
2160 Lisp_Object window_config
= XCAR (help_form_saved_window_configs
);
2161 help_form_saved_window_configs
= XCDR (help_form_saved_window_configs
);
2162 if (!NILP (window_config
))
2163 Fset_window_configuration (window_config
);
2166 #define STOP_POLLING \
2167 do { if (! polling_stopped_here) stop_polling (); \
2168 polling_stopped_here = 1; } while (0)
2170 #define RESUME_POLLING \
2171 do { if (polling_stopped_here) start_polling (); \
2172 polling_stopped_here = 0; } while (0)
2175 read_event_from_main_queue (struct timespec
*end_time
,
2176 sys_jmp_buf local_getcjmp
,
2177 bool *used_mouse_menu
)
2179 Lisp_Object c
= Qnil
;
2180 sys_jmp_buf save_jump
;
2181 KBOARD
*kb
IF_LINT (= NULL
);
2185 /* Read from the main queue, and if that gives us something we can't use yet,
2186 we put it on the appropriate side queue and try again. */
2188 if (end_time
&& timespec_cmp (*end_time
, current_timespec ()) <= 0)
2191 /* Actually read a character, waiting if necessary. */
2192 save_getcjmp (save_jump
);
2193 restore_getcjmp (local_getcjmp
);
2195 timer_start_idle ();
2196 c
= kbd_buffer_get_event (&kb
, used_mouse_menu
, end_time
);
2197 restore_getcjmp (save_jump
);
2199 if (! NILP (c
) && (kb
!= current_kboard
))
2201 Lisp_Object last
= KVAR (kb
, kbd_queue
);
2204 while (CONSP (XCDR (last
)))
2206 if (!NILP (XCDR (last
)))
2210 kset_kbd_queue (kb
, list1 (c
));
2212 XSETCDR (last
, list1 (c
));
2213 kb
->kbd_queue_has_data
= 1;
2217 current_kboard
= kb
;
2218 /* This is going to exit from read_char
2219 so we had better get rid of this frame's stuff. */
2220 return make_number (-2);
2223 /* Terminate Emacs in batch mode if at eof. */
2224 if (noninteractive
&& INTEGERP (c
) && XINT (c
) < 0)
2225 Fkill_emacs (make_number (1));
2229 /* Add in any extra modifiers, where appropriate. */
2230 if ((extra_keyboard_modifiers
& CHAR_CTL
)
2231 || ((extra_keyboard_modifiers
& 0177) < ' '
2232 && (extra_keyboard_modifiers
& 0177) != 0))
2233 XSETINT (c
, make_ctrl_char (XINT (c
)));
2235 /* Transfer any other modifier bits directly from
2236 extra_keyboard_modifiers to c. Ignore the actual character code
2237 in the low 16 bits of extra_keyboard_modifiers. */
2238 XSETINT (c
, XINT (c
) | (extra_keyboard_modifiers
& ~0xff7f & ~CHAR_CTL
));
2246 /* Like `read_event_from_main_queue' but applies keyboard-coding-system
2249 read_decoded_event_from_main_queue (struct timespec
*end_time
,
2250 sys_jmp_buf local_getcjmp
,
2251 Lisp_Object prev_event
,
2252 bool *used_mouse_menu
)
2254 #define MAX_ENCODED_BYTES 16
2256 Lisp_Object events
[MAX_ENCODED_BYTES
];
2262 = read_event_from_main_queue (end_time
, local_getcjmp
,
2265 /* w32_console already returns decoded events. It either reads
2266 Unicode characters from the Windows keyboard input, or
2267 converts characters encoded in the current codepage into
2268 Unicode. See w32inevt.c:key_event, near its end. */
2271 struct frame
*frame
= XFRAME (selected_frame
);
2272 struct terminal
*terminal
= frame
->terminal
;
2273 if (!((FRAME_TERMCAP_P (frame
) || FRAME_MSDOS_P (frame
))
2274 /* Don't apply decoding if we're just reading a raw event
2275 (e.g. reading bytes sent by the xterm to specify the position
2276 of a mouse click). */
2277 && (!EQ (prev_event
, Qt
))
2278 && (TERMINAL_KEYBOARD_CODING (terminal
)->common_flags
2279 & CODING_REQUIRE_DECODING_MASK
)))
2280 return nextevt
; /* No decoding needed. */
2283 int meta_key
= terminal
->display_info
.tty
->meta_key
;
2284 eassert (n
< MAX_ENCODED_BYTES
);
2285 events
[n
++] = nextevt
;
2286 if (NATNUMP (nextevt
)
2287 && XINT (nextevt
) < (meta_key
== 1 ? 0x80 : 0x100))
2288 { /* An encoded byte sequence, let's try to decode it. */
2289 struct coding_system
*coding
2290 = TERMINAL_KEYBOARD_CODING (terminal
);
2292 if (raw_text_coding_system_p (coding
))
2296 for (i
= 0; i
< n
; i
++)
2297 events
[i
] = make_number (XINT (events
[i
]) & ~0x80);
2301 unsigned char src
[MAX_ENCODED_BYTES
];
2302 unsigned char dest
[MAX_ENCODED_BYTES
* MAX_MULTIBYTE_LENGTH
];
2304 for (i
= 0; i
< n
; i
++)
2305 src
[i
] = XINT (events
[i
]);
2307 for (i
= 0; i
< n
; i
++)
2309 coding
->destination
= dest
;
2310 coding
->dst_bytes
= sizeof dest
;
2311 decode_coding_c_string (coding
, src
, n
, Qnil
);
2312 eassert (coding
->produced_char
<= n
);
2313 if (coding
->produced_char
== 0)
2314 { /* The encoded sequence is incomplete. */
2315 if (n
< MAX_ENCODED_BYTES
) /* Avoid buffer overflow. */
2316 continue; /* Read on! */
2320 const unsigned char *p
= coding
->destination
;
2321 eassert (coding
->carryover_bytes
== 0);
2323 while (n
< coding
->produced_char
)
2324 events
[n
++] = make_number (STRING_CHAR_ADVANCE (p
));
2328 /* Now `events' should hold decoded events.
2329 Normally, n should be equal to 1, but better not rely on it.
2330 We can only return one event here, so return the first we
2331 had and keep the others (if any) for later. */
2333 Vunread_command_events
2334 = Fcons (events
[--n
], Vunread_command_events
);
2342 echo_keystrokes_p (void)
2344 return (FLOATP (Vecho_keystrokes
) ? XFLOAT_DATA (Vecho_keystrokes
) > 0.0
2345 : INTEGERP (Vecho_keystrokes
) ? XINT (Vecho_keystrokes
) > 0 : false);
2348 /* Read a character from the keyboard; call the redisplay if needed. */
2349 /* commandflag 0 means do not autosave, but do redisplay.
2350 -1 means do not redisplay, but do autosave.
2351 -2 means do neither.
2354 The argument MAP is a keymap for menu prompting.
2356 PREV_EVENT is the previous input event, or nil if we are reading
2357 the first event of a key sequence (or not reading a key sequence).
2358 If PREV_EVENT is t, that is a "magic" value that says
2359 not to run input methods, but in other respects to act as if
2360 not reading a key sequence.
2362 If USED_MOUSE_MENU is non-null, then set *USED_MOUSE_MENU to true
2363 if we used a mouse menu to read the input, or false otherwise. If
2364 USED_MOUSE_MENU is null, don't dereference it.
2366 Value is -2 when we find input on another keyboard. A second call
2367 to read_char will read it.
2369 If END_TIME is non-null, it is a pointer to a struct timespec
2370 specifying the maximum time to wait until. If no input arrives by
2371 that time, stop waiting and return nil.
2373 Value is t if we showed a menu and the user rejected it. */
2376 read_char (int commandflag
, Lisp_Object map
,
2377 Lisp_Object prev_event
,
2378 bool *used_mouse_menu
, struct timespec
*end_time
)
2382 sys_jmp_buf local_getcjmp
;
2383 sys_jmp_buf save_jump
;
2384 Lisp_Object tem
, save
;
2385 volatile Lisp_Object previous_echo_area_message
;
2386 volatile Lisp_Object also_record
;
2387 volatile bool reread
;
2388 struct gcpro gcpro1
, gcpro2
;
2389 bool volatile polling_stopped_here
= 0;
2390 struct kboard
*orig_kboard
= current_kboard
;
2394 #if 0 /* This was commented out as part of fixing echo for C-u left. */
2395 before_command_key_count
= this_command_key_count
;
2396 before_command_echo_length
= echo_length ();
2399 previous_echo_area_message
= Qnil
;
2401 GCPRO2 (c
, previous_echo_area_message
);
2405 if (CONSP (Vunread_post_input_method_events
))
2407 c
= XCAR (Vunread_post_input_method_events
);
2408 Vunread_post_input_method_events
2409 = XCDR (Vunread_post_input_method_events
);
2411 /* Undo what read_char_x_menu_prompt did when it unread
2412 additional keys returned by Fx_popup_menu. */
2414 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2425 if (CONSP (Vunread_command_events
))
2427 bool was_disabled
= 0;
2429 c
= XCAR (Vunread_command_events
);
2430 Vunread_command_events
= XCDR (Vunread_command_events
);
2432 /* Undo what sit-for did when it unread additional keys
2433 inside universal-argument. */
2435 if (CONSP (c
) && EQ (XCAR (c
), Qt
))
2440 /* Undo what read_char_x_menu_prompt did when it unread
2441 additional keys returned by Fx_popup_menu. */
2443 && EQ (XCDR (c
), Qdisabled
)
2444 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
))))
2450 /* If the queued event is something that used the mouse,
2451 set used_mouse_menu accordingly. */
2453 /* Also check was_disabled so last-nonmenu-event won't return
2454 a bad value when submenus are involved. (Bug#447) */
2455 && (EQ (c
, Qtool_bar
) || EQ (c
, Qmenu_bar
) || was_disabled
))
2456 *used_mouse_menu
= 1;
2458 goto reread_for_input_method
;
2461 if (CONSP (Vunread_input_method_events
))
2463 c
= XCAR (Vunread_input_method_events
);
2464 Vunread_input_method_events
= XCDR (Vunread_input_method_events
);
2466 /* Undo what read_char_x_menu_prompt did when it unread
2467 additional keys returned by Fx_popup_menu. */
2469 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2473 goto reread_for_input_method
;
2476 this_command_key_count_reset
= 0;
2478 if (!NILP (Vexecuting_kbd_macro
))
2480 /* We set this to Qmacro; since that's not a frame, nobody will
2481 try to switch frames on us, and the selected window will
2484 Since this event came from a macro, it would be misleading to
2485 leave internal_last_event_frame set to wherever the last
2486 real event came from. Normally, a switch-frame event selects
2487 internal_last_event_frame after each command is read, but
2488 events read from a macro should never cause a new frame to be
2490 Vlast_event_frame
= internal_last_event_frame
= Qmacro
;
2492 /* Exit the macro if we are at the end.
2493 Also, some things replace the macro with t
2494 to force an early exit. */
2495 if (EQ (Vexecuting_kbd_macro
, Qt
)
2496 || executing_kbd_macro_index
>= XFASTINT (Flength (Vexecuting_kbd_macro
)))
2502 c
= Faref (Vexecuting_kbd_macro
, make_number (executing_kbd_macro_index
));
2503 if (STRINGP (Vexecuting_kbd_macro
)
2504 && (XFASTINT (c
) & 0x80) && (XFASTINT (c
) <= 0xff))
2505 XSETFASTINT (c
, CHAR_META
| (XFASTINT (c
) & ~0x80));
2507 executing_kbd_macro_index
++;
2512 if (!NILP (unread_switch_frame
))
2514 c
= unread_switch_frame
;
2515 unread_switch_frame
= Qnil
;
2517 /* This event should make it into this_command_keys, and get echoed
2518 again, so we do not set `reread'. */
2522 /* If redisplay was requested. */
2523 if (commandflag
>= 0)
2525 bool echo_current
= EQ (echo_message_buffer
, echo_area_buffer
[0]);
2527 /* If there is pending input, process any events which are not
2528 user-visible, such as X selection_request events. */
2530 || detect_input_pending_run_timers (0))
2531 swallow_events (false); /* May clear input_pending. */
2533 /* Redisplay if no pending input. */
2534 while (!(input_pending
2535 && (input_was_pending
|| !redisplay_dont_pause
)))
2537 input_was_pending
= input_pending
;
2538 if (help_echo_showing_p
&& !EQ (selected_window
, minibuf_window
))
2539 redisplay_preserve_echo_area (5);
2544 /* Normal case: no input arrived during redisplay. */
2547 /* Input arrived and pre-empted redisplay.
2548 Process any events which are not user-visible. */
2549 swallow_events (false);
2550 /* If that cleared input_pending, try again to redisplay. */
2553 /* Prevent the redisplay we just did
2554 from messing up echoing of the input after the prompt. */
2555 if (commandflag
== 0 && echo_current
)
2556 echo_message_buffer
= echo_area_buffer
[0];
2560 /* Message turns off echoing unless more keystrokes turn it on again.
2562 The code in 20.x for the condition was
2564 1. echo_area_glyphs && *echo_area_glyphs
2565 2. && echo_area_glyphs != current_kboard->echobuf
2566 3. && ok_to_echo_at_next_pause != echo_area_glyphs
2568 (1) means there's a current message displayed
2570 (2) means it's not the message from echoing from the current
2573 (3) There's only one place in 20.x where ok_to_echo_at_next_pause
2574 is set to a non-null value. This is done in read_char and it is
2575 set to echo_area_glyphs after a call to echo_char. That means
2576 ok_to_echo_at_next_pause is either null or
2577 current_kboard->echobuf with the appropriate current_kboard at
2580 So, condition (3) means in clear text ok_to_echo_at_next_pause
2581 must be either null, or the current message isn't from echoing at
2582 all, or it's from echoing from a different kboard than the
2585 if (/* There currently is something in the echo area. */
2586 !NILP (echo_area_buffer
[0])
2587 && (/* It's an echo from a different kboard. */
2588 echo_kboard
!= current_kboard
2589 /* Or we explicitly allow overwriting whatever there is. */
2590 || ok_to_echo_at_next_pause
== NULL
))
2595 /* Try reading a character via menu prompting in the minibuf.
2596 Try this before the sit-for, because the sit-for
2597 would do the wrong thing if we are supposed to do
2598 menu prompting. If EVENT_HAS_PARAMETERS then we are reading
2599 after a mouse event so don't try a minibuf menu. */
2601 if (KEYMAPP (map
) && INTERACTIVE
2602 && !NILP (prev_event
) && ! EVENT_HAS_PARAMETERS (prev_event
)
2603 /* Don't bring up a menu if we already have another event. */
2604 && NILP (Vunread_command_events
)
2605 && !detect_input_pending_run_timers (0))
2607 c
= read_char_minibuf_menu_prompt (commandflag
, map
);
2609 if (INTEGERP (c
) && XINT (c
) == -2)
2610 return c
; /* wrong_kboard_jmpbuf */
2616 /* Make a longjmp point for quits to use, but don't alter getcjmp just yet.
2617 We will do that below, temporarily for short sections of code,
2618 when appropriate. local_getcjmp must be in effect
2619 around any call to sit_for or kbd_buffer_get_event;
2620 it *must not* be in effect when we call redisplay. */
2622 jmpcount
= SPECPDL_INDEX ();
2623 if (sys_setjmp (local_getcjmp
))
2625 /* Handle quits while reading the keyboard. */
2626 /* We must have saved the outer value of getcjmp here,
2627 so restore it now. */
2628 restore_getcjmp (save_jump
);
2629 pthread_sigmask (SIG_SETMASK
, &empty_mask
, 0);
2630 unbind_to (jmpcount
, Qnil
);
2631 XSETINT (c
, quit_char
);
2632 internal_last_event_frame
= selected_frame
;
2633 Vlast_event_frame
= internal_last_event_frame
;
2634 /* If we report the quit char as an event,
2635 don't do so more than once. */
2636 if (!NILP (Vinhibit_quit
))
2640 KBOARD
*kb
= FRAME_KBOARD (XFRAME (selected_frame
));
2641 if (kb
!= current_kboard
)
2643 Lisp_Object last
= KVAR (kb
, kbd_queue
);
2644 /* We shouldn't get here if we were in single-kboard mode! */
2649 while (CONSP (XCDR (last
)))
2651 if (!NILP (XCDR (last
)))
2655 kset_kbd_queue (kb
, list1 (c
));
2657 XSETCDR (last
, list1 (c
));
2658 kb
->kbd_queue_has_data
= 1;
2659 current_kboard
= kb
;
2660 /* This is going to exit from read_char
2661 so we had better get rid of this frame's stuff. */
2663 return make_number (-2); /* wrong_kboard_jmpbuf */
2669 /* Start idle timers if no time limit is supplied. We don't do it
2670 if a time limit is supplied to avoid an infinite recursion in the
2671 situation where an idle timer calls `sit-for'. */
2674 timer_start_idle ();
2676 /* If in middle of key sequence and minibuffer not active,
2677 start echoing if enough time elapses. */
2679 if (minibuf_level
== 0
2681 && !current_kboard
->immediate_echo
2682 && this_command_key_count
> 0
2684 && echo_keystrokes_p ()
2685 && (/* No message. */
2686 NILP (echo_area_buffer
[0])
2687 /* Or empty message. */
2688 || (BUF_BEG (XBUFFER (echo_area_buffer
[0]))
2689 == BUF_Z (XBUFFER (echo_area_buffer
[0])))
2690 /* Or already echoing from same kboard. */
2691 || (echo_kboard
&& ok_to_echo_at_next_pause
== echo_kboard
)
2692 /* Or not echoing before and echoing allowed. */
2693 || (!echo_kboard
&& ok_to_echo_at_next_pause
)))
2695 /* After a mouse event, start echoing right away.
2696 This is because we are probably about to display a menu,
2697 and we don't want to delay before doing so. */
2698 if (EVENT_HAS_PARAMETERS (prev_event
))
2704 save_getcjmp (save_jump
);
2705 restore_getcjmp (local_getcjmp
);
2706 tem0
= sit_for (Vecho_keystrokes
, 1, 1);
2707 restore_getcjmp (save_jump
);
2709 && ! CONSP (Vunread_command_events
))
2714 /* Maybe auto save due to number of keystrokes. */
2716 if (commandflag
!= 0 && commandflag
!= -2
2717 && auto_save_interval
> 0
2718 && num_nonmacro_input_events
- last_auto_save
> max (auto_save_interval
, 20)
2719 && !detect_input_pending_run_timers (0))
2721 Fdo_auto_save (Qnil
, Qnil
);
2722 /* Hooks can actually change some buffers in auto save. */
2726 /* Try reading using an X menu.
2727 This is never confused with reading using the minibuf
2728 because the recursive call of read_char in read_char_minibuf_menu_prompt
2729 does not pass on any keymaps. */
2731 if (KEYMAPP (map
) && INTERACTIVE
2732 && !NILP (prev_event
)
2733 && EVENT_HAS_PARAMETERS (prev_event
)
2734 && !EQ (XCAR (prev_event
), Qmenu_bar
)
2735 && !EQ (XCAR (prev_event
), Qtool_bar
)
2736 /* Don't bring up a menu if we already have another event. */
2737 && NILP (Vunread_command_events
))
2739 c
= read_char_x_menu_prompt (map
, prev_event
, used_mouse_menu
);
2741 /* Now that we have read an event, Emacs is not idle. */
2748 /* Maybe autosave and/or garbage collect due to idleness. */
2750 if (INTERACTIVE
&& NILP (c
))
2753 ptrdiff_t buffer_size
;
2755 /* Slow down auto saves logarithmically in size of current buffer,
2756 and garbage collect while we're at it. */
2757 if (! MINI_WINDOW_P (XWINDOW (selected_window
)))
2758 last_non_minibuf_size
= Z
- BEG
;
2759 buffer_size
= (last_non_minibuf_size
>> 8) + 1;
2761 while (buffer_size
> 64)
2762 delay_level
++, buffer_size
-= buffer_size
>> 2;
2763 if (delay_level
< 4) delay_level
= 4;
2764 /* delay_level is 4 for files under around 50k, 7 at 100k,
2765 9 at 200k, 11 at 300k, and 12 at 500k. It is 15 at 1 meg. */
2767 /* Auto save if enough time goes by without input. */
2768 if (commandflag
!= 0 && commandflag
!= -2
2769 && num_nonmacro_input_events
> last_auto_save
2770 && INTEGERP (Vauto_save_timeout
)
2771 && XINT (Vauto_save_timeout
) > 0)
2774 EMACS_INT timeout
= XFASTINT (Vauto_save_timeout
);
2776 timeout
= min (timeout
, MOST_POSITIVE_FIXNUM
/ delay_level
* 4);
2777 timeout
= delay_level
* timeout
/ 4;
2778 save_getcjmp (save_jump
);
2779 restore_getcjmp (local_getcjmp
);
2780 tem0
= sit_for (make_number (timeout
), 1, 1);
2781 restore_getcjmp (save_jump
);
2784 && ! CONSP (Vunread_command_events
))
2786 Fdo_auto_save (Qnil
, Qnil
);
2791 /* If there is still no input available, ask for GC. */
2792 if (!detect_input_pending_run_timers (0))
2796 /* Notify the caller if an autosave hook, or a timer, sentinel or
2797 filter in the sit_for calls above have changed the current
2798 kboard. This could happen if they use the minibuffer or start a
2799 recursive edit, like the fancy splash screen in server.el's
2800 filter. If this longjmp wasn't here, read_key_sequence would
2801 interpret the next key sequence using the wrong translation
2802 tables and function keymaps. */
2803 if (NILP (c
) && current_kboard
!= orig_kboard
)
2806 return make_number (-2); /* wrong_kboard_jmpbuf */
2809 /* If this has become non-nil here, it has been set by a timer
2810 or sentinel or filter. */
2811 if (CONSP (Vunread_command_events
))
2813 c
= XCAR (Vunread_command_events
);
2814 Vunread_command_events
= XCDR (Vunread_command_events
);
2816 if (CONSP (c
) && EQ (XCAR (c
), Qt
))
2822 /* Read something from current KBOARD's side queue, if possible. */
2826 if (current_kboard
->kbd_queue_has_data
)
2828 if (!CONSP (KVAR (current_kboard
, kbd_queue
)))
2830 c
= XCAR (KVAR (current_kboard
, kbd_queue
));
2831 kset_kbd_queue (current_kboard
,
2832 XCDR (KVAR (current_kboard
, kbd_queue
)));
2833 if (NILP (KVAR (current_kboard
, kbd_queue
)))
2834 current_kboard
->kbd_queue_has_data
= 0;
2835 input_pending
= readable_events (0);
2836 if (EVENT_HAS_PARAMETERS (c
)
2837 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qswitch_frame
))
2838 internal_last_event_frame
= XCAR (XCDR (c
));
2839 Vlast_event_frame
= internal_last_event_frame
;
2843 /* If current_kboard's side queue is empty check the other kboards.
2844 If one of them has data that we have not yet seen here,
2845 switch to it and process the data waiting for it.
2847 Note: if the events queued up for another kboard
2848 have already been seen here, and therefore are not a complete command,
2849 the kbd_queue_has_data field is 0, so we skip that kboard here.
2850 That's to avoid an infinite loop switching between kboards here. */
2851 if (NILP (c
) && !single_kboard
)
2854 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
2855 if (kb
->kbd_queue_has_data
)
2857 current_kboard
= kb
;
2858 /* This is going to exit from read_char
2859 so we had better get rid of this frame's stuff. */
2861 return make_number (-2); /* wrong_kboard_jmpbuf */
2871 c
= read_decoded_event_from_main_queue (end_time
, local_getcjmp
,
2872 prev_event
, used_mouse_menu
);
2873 if (NILP (c
) && end_time
2874 && timespec_cmp (*end_time
, current_timespec ()) <= 0)
2879 if (EQ (c
, make_number (-2)))
2881 /* This is going to exit from read_char
2882 so we had better get rid of this frame's stuff. */
2896 if (commandflag
>= 0
2897 && !input_pending
&& !detect_input_pending_run_timers (0))
2903 /* Buffer switch events are only for internal wakeups
2904 so don't show them to the user.
2905 Also, don't record a key if we already did. */
2909 /* Process special events within read_char
2910 and loop around to read another event. */
2913 tem
= access_keymap (get_keymap (Vspecial_event_map
, 0, 1), c
, 0, 0, 1);
2918 struct buffer
*prev_buffer
= current_buffer
;
2919 last_input_event
= c
;
2920 call4 (Qcommand_execute
, tem
, Qnil
, Fvector (1, &last_input_event
), Qt
);
2922 if (CONSP (c
) && EQ (XCAR (c
), Qselect_window
) && !end_time
)
2923 /* We stopped being idle for this event; undo that. This
2924 prevents automatic window selection (under
2925 mouse_autoselect_window from acting as a real input event, for
2926 example banishing the mouse under mouse-avoidance-mode. */
2927 timer_resume_idle ();
2929 if (current_buffer
!= prev_buffer
)
2931 /* The command may have changed the keymaps. Pretend there
2932 is input in another keyboard and return. This will
2933 recalculate keymaps. */
2934 c
= make_number (-2);
2941 /* Handle things that only apply to characters. */
2944 /* If kbd_buffer_get_event gave us an EOF, return that. */
2948 if ((STRINGP (KVAR (current_kboard
, Vkeyboard_translate_table
))
2949 && UNSIGNED_CMP (XFASTINT (c
), <,
2950 SCHARS (KVAR (current_kboard
,
2951 Vkeyboard_translate_table
))))
2952 || (VECTORP (KVAR (current_kboard
, Vkeyboard_translate_table
))
2953 && UNSIGNED_CMP (XFASTINT (c
), <,
2954 ASIZE (KVAR (current_kboard
,
2955 Vkeyboard_translate_table
))))
2956 || (CHAR_TABLE_P (KVAR (current_kboard
, Vkeyboard_translate_table
))
2960 d
= Faref (KVAR (current_kboard
, Vkeyboard_translate_table
), c
);
2961 /* nil in keyboard-translate-table means no translation. */
2967 /* If this event is a mouse click in the menu bar,
2968 return just menu-bar for now. Modify the mouse click event
2969 so we won't do this twice, then queue it up. */
2970 if (EVENT_HAS_PARAMETERS (c
)
2972 && CONSP (EVENT_START (c
))
2973 && CONSP (XCDR (EVENT_START (c
))))
2977 posn
= POSN_POSN (EVENT_START (c
));
2978 /* Handle menu-bar events:
2979 insert the dummy prefix event `menu-bar'. */
2980 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
2982 /* Change menu-bar to (menu-bar) as the event "position". */
2983 POSN_SET_POSN (EVENT_START (c
), list1 (posn
));
2986 Vunread_command_events
= Fcons (c
, Vunread_command_events
);
2991 /* Store these characters into recent_keys, the dribble file if any,
2992 and the keyboard macro being defined, if any. */
2994 if (! NILP (also_record
))
2995 record_char (also_record
);
2997 /* Wipe the echo area.
2998 But first, if we are about to use an input method,
2999 save the echo area contents for it to refer to. */
3001 && ! NILP (Vinput_method_function
)
3002 && ' ' <= XINT (c
) && XINT (c
) < 256 && XINT (c
) != 127)
3004 previous_echo_area_message
= Fcurrent_message ();
3005 Vinput_method_previous_message
= previous_echo_area_message
;
3008 /* Now wipe the echo area, except for help events which do their
3009 own stuff with the echo area. */
3011 || (!(EQ (Qhelp_echo
, XCAR (c
)))
3012 && !(EQ (Qswitch_frame
, XCAR (c
)))
3013 /* Don't wipe echo area for select window events: These might
3014 get delayed via `mouse-autoselect-window' (Bug#11304). */
3015 && !(EQ (Qselect_window
, XCAR (c
)))))
3017 if (!NILP (echo_area_buffer
[0]))
3019 safe_run_hooks (Qecho_area_clear_hook
);
3020 clear_message (1, 0);
3024 reread_for_input_method
:
3026 /* Pass this to the input method, if appropriate. */
3028 && ! NILP (Vinput_method_function
)
3029 /* Don't run the input method within a key sequence,
3030 after the first event of the key sequence. */
3031 && NILP (prev_event
)
3032 && ' ' <= XINT (c
) && XINT (c
) < 256 && XINT (c
) != 127)
3035 ptrdiff_t key_count
;
3036 bool key_count_reset
;
3037 struct gcpro gcpro1
;
3038 ptrdiff_t count
= SPECPDL_INDEX ();
3040 /* Save the echo status. */
3041 bool saved_immediate_echo
= current_kboard
->immediate_echo
;
3042 struct kboard
*saved_ok_to_echo
= ok_to_echo_at_next_pause
;
3043 Lisp_Object saved_echo_string
= KVAR (current_kboard
, echo_string
);
3044 ptrdiff_t saved_echo_after_prompt
= current_kboard
->echo_after_prompt
;
3047 if (before_command_restore_flag
)
3049 this_command_key_count
= before_command_key_count_1
;
3050 if (this_command_key_count
< this_single_command_key_start
)
3051 this_single_command_key_start
= this_command_key_count
;
3052 echo_truncate (before_command_echo_length_1
);
3053 before_command_restore_flag
= 0;
3057 /* Save the this_command_keys status. */
3058 key_count
= this_command_key_count
;
3059 key_count_reset
= this_command_key_count_reset
;
3062 keys
= Fcopy_sequence (this_command_keys
);
3067 /* Clear out this_command_keys. */
3068 this_command_key_count
= 0;
3069 this_command_key_count_reset
= 0;
3071 /* Now wipe the echo area. */
3072 if (!NILP (echo_area_buffer
[0]))
3073 safe_run_hooks (Qecho_area_clear_hook
);
3074 clear_message (1, 0);
3077 /* If we are not reading a key sequence,
3078 never use the echo area. */
3081 specbind (Qinput_method_use_echo_area
, Qt
);
3084 /* Call the input method. */
3085 tem
= call1 (Vinput_method_function
, c
);
3087 tem
= unbind_to (count
, tem
);
3089 /* Restore the saved echoing state
3090 and this_command_keys state. */
3091 this_command_key_count
= key_count
;
3092 this_command_key_count_reset
= key_count_reset
;
3094 this_command_keys
= keys
;
3097 ok_to_echo_at_next_pause
= saved_ok_to_echo
;
3098 /* Do not restore the echo area string when the user is
3099 introducing a prefix argument. Otherwise we end with
3100 repetitions of the partially introduced prefix
3101 argument. (bug#19875) */
3102 if (NILP (intern ("prefix-arg")))
3104 kset_echo_string (current_kboard
, saved_echo_string
);
3106 current_kboard
->echo_after_prompt
= saved_echo_after_prompt
;
3107 if (saved_immediate_echo
)
3112 /* The input method can return no events. */
3115 /* Bring back the previous message, if any. */
3116 if (! NILP (previous_echo_area_message
))
3117 message_with_string ("%s", previous_echo_area_message
, 0);
3120 /* It returned one event or more. */
3122 Vunread_post_input_method_events
3123 = nconc2 (XCDR (tem
), Vunread_post_input_method_events
);
3128 /* Display help if not echoing. */
3129 if (CONSP (c
) && EQ (XCAR (c
), Qhelp_echo
))
3131 /* (help-echo FRAME HELP WINDOW OBJECT POS). */
3132 Lisp_Object help
, object
, position
, window
, htem
;
3134 htem
= Fcdr (XCDR (c
));
3137 window
= Fcar (htem
);
3139 object
= Fcar (htem
);
3141 position
= Fcar (htem
);
3143 show_help_echo (help
, window
, object
, position
);
3145 /* We stopped being idle for this event; undo that. */
3147 timer_resume_idle ();
3151 if ((! reread
|| this_command_key_count
== 0
3152 || this_command_key_count_reset
)
3156 /* Don't echo mouse motion events. */
3157 if (echo_keystrokes_p ()
3158 && ! (EVENT_HAS_PARAMETERS (c
)
3159 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
3162 if (! NILP (also_record
))
3163 echo_char (also_record
);
3164 /* Once we reread a character, echoing can happen
3165 the next time we pause to read a new one. */
3166 ok_to_echo_at_next_pause
= current_kboard
;
3169 /* Record this character as part of the current key. */
3170 add_command_key (c
);
3171 if (! NILP (also_record
))
3172 add_command_key (also_record
);
3175 last_input_event
= c
;
3178 /* Process the help character specially if enabled. */
3179 if (!NILP (Vhelp_form
) && help_char_p (c
))
3181 ptrdiff_t count
= SPECPDL_INDEX ();
3183 help_form_saved_window_configs
3184 = Fcons (Fcurrent_window_configuration (Qnil
),
3185 help_form_saved_window_configs
);
3186 record_unwind_protect_void (read_char_help_form_unwind
);
3187 call0 (Qhelp_form_show
);
3192 c
= read_char (0, Qnil
, Qnil
, 0, NULL
);
3193 if (EVENT_HAS_PARAMETERS (c
)
3194 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_click
))
3195 XSETCAR (help_form_saved_window_configs
, Qnil
);
3197 while (BUFFERP (c
));
3198 /* Remove the help from the frame. */
3199 unbind_to (count
, Qnil
);
3202 if (EQ (c
, make_number (040)))
3206 c
= read_char (0, Qnil
, Qnil
, 0, NULL
);
3207 while (BUFFERP (c
));
3213 input_was_pending
= input_pending
;
3217 /* Record a key that came from a mouse menu.
3218 Record it for echoing, for this-command-keys, and so on. */
3221 record_menu_key (Lisp_Object c
)
3223 /* Wipe the echo area. */
3224 clear_message (1, 0);
3229 before_command_key_count
= this_command_key_count
;
3230 before_command_echo_length
= echo_length ();
3233 /* Don't echo mouse motion events. */
3234 if (echo_keystrokes_p ())
3238 /* Once we reread a character, echoing can happen
3239 the next time we pause to read a new one. */
3240 ok_to_echo_at_next_pause
= 0;
3243 /* Record this character as part of the current key. */
3244 add_command_key (c
);
3246 /* Re-reading in the middle of a command. */
3247 last_input_event
= c
;
3251 /* Return true if should recognize C as "the help character". */
3254 help_char_p (Lisp_Object c
)
3258 if (EQ (c
, Vhelp_char
))
3260 for (tail
= Vhelp_event_list
; CONSP (tail
); tail
= XCDR (tail
))
3261 if (EQ (c
, XCAR (tail
)))
3266 /* Record the input event C in various ways. */
3269 record_char (Lisp_Object c
)
3273 if (CONSP (c
) && (EQ (XCAR (c
), Qhelp_echo
) || EQ (XCAR (c
), Qmouse_movement
)))
3275 /* To avoid filling recent_keys with help-echo and mouse-movement
3276 events, we filter out repeated help-echo events, only store the
3277 first and last in a series of mouse-movement events, and don't
3278 store repeated help-echo events which are only separated by
3279 mouse-movement events. */
3281 Lisp_Object ev1
, ev2
, ev3
;
3284 if ((ix1
= recent_keys_index
- 1) < 0)
3285 ix1
= NUM_RECENT_KEYS
- 1;
3286 ev1
= AREF (recent_keys
, ix1
);
3288 if ((ix2
= ix1
- 1) < 0)
3289 ix2
= NUM_RECENT_KEYS
- 1;
3290 ev2
= AREF (recent_keys
, ix2
);
3292 if ((ix3
= ix2
- 1) < 0)
3293 ix3
= NUM_RECENT_KEYS
- 1;
3294 ev3
= AREF (recent_keys
, ix3
);
3296 if (EQ (XCAR (c
), Qhelp_echo
))
3298 /* Don't record `help-echo' in recent_keys unless it shows some help
3299 message, and a different help than the previously recorded
3301 Lisp_Object help
, last_help
;
3303 help
= Fcar_safe (Fcdr_safe (XCDR (c
)));
3304 if (!STRINGP (help
))
3306 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qhelp_echo
)
3307 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev1
))), EQ (last_help
, help
)))
3309 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3310 && CONSP (ev2
) && EQ (XCAR (ev2
), Qhelp_echo
)
3311 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev2
))), EQ (last_help
, help
)))
3313 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3314 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3315 && CONSP (ev3
) && EQ (XCAR (ev3
), Qhelp_echo
)
3316 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev3
))), EQ (last_help
, help
)))
3319 else if (EQ (XCAR (c
), Qmouse_movement
))
3321 /* Only record one pair of `mouse-movement' on a window in recent_keys.
3322 So additional mouse movement events replace the last element. */
3323 Lisp_Object last_window
, window
;
3325 window
= Fcar_safe (Fcar_safe (XCDR (c
)));
3326 if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3327 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev1
))), EQ (last_window
, window
))
3328 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3329 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev2
))), EQ (last_window
, window
)))
3331 ASET (recent_keys
, ix1
, c
);
3337 store_kbd_macro_char (c
);
3341 total_keys
+= total_keys
< NUM_RECENT_KEYS
;
3342 ASET (recent_keys
, recent_keys_index
, c
);
3343 if (++recent_keys_index
>= NUM_RECENT_KEYS
)
3344 recent_keys_index
= 0;
3346 else if (recorded
< 0)
3348 /* We need to remove one or two events from recent_keys.
3349 To do this, we simply put nil at those events and move the
3350 recent_keys_index backwards over those events. Usually,
3351 users will never see those nil events, as they will be
3352 overwritten by the command keys entered to see recent_keys
3355 while (recorded
++ < 0 && total_keys
> 0)
3357 if (total_keys
< NUM_RECENT_KEYS
)
3359 if (--recent_keys_index
< 0)
3360 recent_keys_index
= NUM_RECENT_KEYS
- 1;
3361 ASET (recent_keys
, recent_keys_index
, Qnil
);
3365 num_nonmacro_input_events
++;
3367 /* Write c to the dribble file. If c is a lispy event, write
3368 the event's symbol to the dribble file, in <brackets>. Bleaugh.
3369 If you, dear reader, have a better idea, you've got the source. :-) */
3375 if (XUINT (c
) < 0x100)
3376 putc (XUINT (c
), dribble
);
3378 fprintf (dribble
, " 0x%"pI
"x", XUINT (c
));
3382 Lisp_Object dribblee
;
3384 /* If it's a structured event, take the event header. */
3385 dribblee
= EVENT_HEAD (c
);
3387 if (SYMBOLP (dribblee
))
3389 putc ('<', dribble
);
3390 fwrite (SDATA (SYMBOL_NAME (dribblee
)), sizeof (char),
3391 SBYTES (SYMBOL_NAME (dribblee
)),
3393 putc ('>', dribble
);
3402 /* Copy out or in the info on where C-g should throw to.
3403 This is used when running Lisp code from within get_char,
3404 in case get_char is called recursively.
3405 See read_process_output. */
3408 save_getcjmp (sys_jmp_buf temp
)
3410 memcpy (temp
, getcjmp
, sizeof getcjmp
);
3414 restore_getcjmp (sys_jmp_buf temp
)
3416 memcpy (getcjmp
, temp
, sizeof getcjmp
);
3419 /* Low level keyboard/mouse input.
3420 kbd_buffer_store_event places events in kbd_buffer, and
3421 kbd_buffer_get_event retrieves them. */
3423 /* Return true if there are any events in the queue that read-char
3424 would return. If this returns false, a read-char would block. */
3426 readable_events (int flags
)
3428 if (flags
& READABLE_EVENTS_DO_TIMERS_NOW
)
3431 /* If the buffer contains only FOCUS_IN_EVENT events, and
3432 READABLE_EVENTS_FILTER_EVENTS is set, report it as empty. */
3433 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3435 if (flags
& (READABLE_EVENTS_FILTER_EVENTS
3436 #ifdef USE_TOOLKIT_SCROLL_BARS
3437 | READABLE_EVENTS_IGNORE_SQUEEZABLES
3441 struct input_event
*event
;
3443 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
3450 #ifdef USE_TOOLKIT_SCROLL_BARS
3451 (flags
& READABLE_EVENTS_FILTER_EVENTS
) &&
3453 event
->kind
== FOCUS_IN_EVENT
)
3454 #ifdef USE_TOOLKIT_SCROLL_BARS
3455 && !((flags
& READABLE_EVENTS_IGNORE_SQUEEZABLES
)
3456 && (event
->kind
== SCROLL_BAR_CLICK_EVENT
3457 || event
->kind
== HORIZONTAL_SCROLL_BAR_CLICK_EVENT
)
3458 && event
->part
== scroll_bar_handle
3459 && event
->modifiers
== 0)
3461 && !((flags
& READABLE_EVENTS_FILTER_EVENTS
)
3462 && event
->kind
== BUFFER_SWITCH_EVENT
))
3465 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3468 while (event
!= kbd_store_ptr
);
3474 if (!(flags
& READABLE_EVENTS_IGNORE_SQUEEZABLES
)
3475 && !NILP (do_mouse_tracking
) && some_mouse_moved ())
3479 if (current_kboard
->kbd_queue_has_data
)
3485 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
3486 if (kb
->kbd_queue_has_data
)
3492 /* Set this for debugging, to have a way to get out */
3493 int stop_character EXTERNALLY_VISIBLE
;
3496 event_to_kboard (struct input_event
*event
)
3498 /* Not applicable for these special events. */
3499 if (event
->kind
== SELECTION_REQUEST_EVENT
3500 || event
->kind
== SELECTION_CLEAR_EVENT
)
3504 Lisp_Object obj
= event
->frame_or_window
;
3505 /* There are some events that set this field to nil or string. */
3507 obj
= WINDOW_FRAME (XWINDOW (obj
));
3508 /* Also ignore dead frames here. */
3509 return ((FRAMEP (obj
) && FRAME_LIVE_P (XFRAME (obj
)))
3510 ? FRAME_KBOARD (XFRAME (obj
)) : NULL
);
3515 /* Return the number of slots occupied in kbd_buffer. */
3518 kbd_buffer_nr_stored (void)
3520 return kbd_fetch_ptr
== kbd_store_ptr
3522 : (kbd_fetch_ptr
< kbd_store_ptr
3523 ? kbd_store_ptr
- kbd_fetch_ptr
3524 : ((kbd_buffer
+ KBD_BUFFER_SIZE
) - kbd_fetch_ptr
3525 + (kbd_store_ptr
- kbd_buffer
)));
3527 #endif /* Store an event obtained at interrupt level into kbd_buffer, fifo */
3530 kbd_buffer_store_event (register struct input_event
*event
)
3532 kbd_buffer_store_event_hold (event
, 0);
3535 /* Store EVENT obtained at interrupt level into kbd_buffer, fifo.
3537 If HOLD_QUIT is 0, just stuff EVENT into the fifo.
3538 Else, if HOLD_QUIT.kind != NO_EVENT, discard EVENT.
3539 Else, if EVENT is a quit event, store the quit event
3540 in HOLD_QUIT, and return (thus ignoring further events).
3542 This is used to postpone the processing of the quit event until all
3543 subsequent input events have been parsed (and discarded). */
3546 kbd_buffer_store_event_hold (register struct input_event
*event
,
3547 struct input_event
*hold_quit
)
3549 if (event
->kind
== NO_EVENT
)
3552 if (hold_quit
&& hold_quit
->kind
!= NO_EVENT
)
3555 if (event
->kind
== ASCII_KEYSTROKE_EVENT
)
3557 register int c
= event
->code
& 0377;
3559 if (event
->modifiers
& ctrl_modifier
)
3560 c
= make_ctrl_char (c
);
3562 c
|= (event
->modifiers
3563 & (meta_modifier
| alt_modifier
3564 | hyper_modifier
| super_modifier
));
3568 KBOARD
*kb
= FRAME_KBOARD (XFRAME (event
->frame_or_window
));
3569 struct input_event
*sp
;
3571 if (single_kboard
&& kb
!= current_kboard
)
3574 (kb
, list2 (make_lispy_switch_frame (event
->frame_or_window
),
3576 kb
->kbd_queue_has_data
= 1;
3577 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3579 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3582 if (event_to_kboard (sp
) == kb
)
3584 sp
->kind
= NO_EVENT
;
3585 sp
->frame_or_window
= Qnil
;
3594 *hold_quit
= *event
;
3598 /* If this results in a quit_char being returned to Emacs as
3599 input, set Vlast_event_frame properly. If this doesn't
3600 get returned to Emacs as an event, the next event read
3601 will set Vlast_event_frame again, so this is safe to do. */
3605 focus
= FRAME_FOCUS_FRAME (XFRAME (event
->frame_or_window
));
3607 focus
= event
->frame_or_window
;
3608 internal_last_event_frame
= focus
;
3609 Vlast_event_frame
= focus
;
3612 handle_interrupt (0);
3616 if (c
&& c
== stop_character
)
3622 /* Don't insert two BUFFER_SWITCH_EVENT's in a row.
3623 Just ignore the second one. */
3624 else if (event
->kind
== BUFFER_SWITCH_EVENT
3625 && kbd_fetch_ptr
!= kbd_store_ptr
3626 && ((kbd_store_ptr
== kbd_buffer
3627 ? kbd_buffer
+ KBD_BUFFER_SIZE
- 1
3628 : kbd_store_ptr
- 1)->kind
) == BUFFER_SWITCH_EVENT
)
3631 if (kbd_store_ptr
- kbd_buffer
== KBD_BUFFER_SIZE
)
3632 kbd_store_ptr
= kbd_buffer
;
3634 /* Don't let the very last slot in the buffer become full,
3635 since that would make the two pointers equal,
3636 and that is indistinguishable from an empty buffer.
3637 Discard the event if it would fill the last slot. */
3638 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
3640 *kbd_store_ptr
= *event
;
3643 if (kbd_buffer_nr_stored () > KBD_BUFFER_SIZE
/ 2
3644 && ! kbd_on_hold_p ())
3646 /* Don't read keyboard input until we have processed kbd_buffer.
3647 This happens when pasting text longer than KBD_BUFFER_SIZE/2. */
3648 hold_keyboard_input ();
3649 if (!noninteractive
)
3653 #endif /* subprocesses */
3656 /* If we're inside while-no-input, and this event qualifies
3657 as input, set quit-flag to cause an interrupt. */
3658 if (!NILP (Vthrow_on_input
)
3659 && event
->kind
!= FOCUS_IN_EVENT
3660 && event
->kind
!= FOCUS_OUT_EVENT
3661 && event
->kind
!= HELP_EVENT
3662 && event
->kind
!= ICONIFY_EVENT
3663 && event
->kind
!= DEICONIFY_EVENT
)
3665 Vquit_flag
= Vthrow_on_input
;
3666 /* If we're inside a function that wants immediate quits,
3668 if (immediate_quit
&& NILP (Vinhibit_quit
))
3677 /* Put an input event back in the head of the event queue. */
3680 kbd_buffer_unget_event (register struct input_event
*event
)
3682 if (kbd_fetch_ptr
== kbd_buffer
)
3683 kbd_fetch_ptr
= kbd_buffer
+ KBD_BUFFER_SIZE
;
3685 /* Don't let the very last slot in the buffer become full, */
3686 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
3689 *kbd_fetch_ptr
= *event
;
3693 /* Limit help event positions to this range, to avoid overflow problems. */
3694 #define INPUT_EVENT_POS_MAX \
3695 ((ptrdiff_t) min (PTRDIFF_MAX, min (TYPE_MAXIMUM (Time) / 2, \
3696 MOST_POSITIVE_FIXNUM)))
3697 #define INPUT_EVENT_POS_MIN (-1 - INPUT_EVENT_POS_MAX)
3699 /* Return a Time that encodes position POS. POS must be in range. */
3702 position_to_Time (ptrdiff_t pos
)
3704 eassert (INPUT_EVENT_POS_MIN
<= pos
&& pos
<= INPUT_EVENT_POS_MAX
);
3708 /* Return the position that ENCODED_POS encodes.
3709 Avoid signed integer overflow. */
3712 Time_to_position (Time encoded_pos
)
3714 if (encoded_pos
<= INPUT_EVENT_POS_MAX
)
3716 Time encoded_pos_min
= INPUT_EVENT_POS_MIN
;
3717 eassert (encoded_pos_min
<= encoded_pos
);
3718 ptrdiff_t notpos
= -1 - encoded_pos
;
3722 /* Generate a HELP_EVENT input_event and store it in the keyboard
3725 HELP is the help form.
3727 FRAME and WINDOW are the frame and window where the help is
3728 generated. OBJECT is the Lisp object where the help was found (a
3729 buffer, a string, an overlay, or nil if neither from a string nor
3730 from a buffer). POS is the position within OBJECT where the help
3734 gen_help_event (Lisp_Object help
, Lisp_Object frame
, Lisp_Object window
,
3735 Lisp_Object object
, ptrdiff_t pos
)
3737 struct input_event event
;
3739 event
.kind
= HELP_EVENT
;
3740 event
.frame_or_window
= frame
;
3742 event
.x
= WINDOWP (window
) ? window
: frame
;
3744 event
.timestamp
= position_to_Time (pos
);
3745 kbd_buffer_store_event (&event
);
3749 /* Store HELP_EVENTs for HELP on FRAME in the input queue. */
3752 kbd_buffer_store_help_event (Lisp_Object frame
, Lisp_Object help
)
3754 struct input_event event
;
3756 event
.kind
= HELP_EVENT
;
3757 event
.frame_or_window
= frame
;
3761 event
.timestamp
= 0;
3762 kbd_buffer_store_event (&event
);
3766 /* Discard any mouse events in the event buffer by setting them to
3769 discard_mouse_events (void)
3771 struct input_event
*sp
;
3772 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3774 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3777 if (sp
->kind
== MOUSE_CLICK_EVENT
3778 || sp
->kind
== WHEEL_EVENT
3779 || sp
->kind
== HORIZ_WHEEL_EVENT
3781 || sp
->kind
== GPM_CLICK_EVENT
3783 || sp
->kind
== SCROLL_BAR_CLICK_EVENT
3784 || sp
->kind
== HORIZONTAL_SCROLL_BAR_CLICK_EVENT
)
3786 sp
->kind
= NO_EVENT
;
3792 /* Return true if there are any real events waiting in the event
3793 buffer, not counting `NO_EVENT's.
3795 Discard NO_EVENT events at the front of the input queue, possibly
3796 leaving the input queue empty if there are no real input events. */
3799 kbd_buffer_events_waiting (void)
3801 struct input_event
*sp
;
3803 for (sp
= kbd_fetch_ptr
;
3804 sp
!= kbd_store_ptr
&& sp
->kind
== NO_EVENT
;
3807 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3812 return sp
!= kbd_store_ptr
&& sp
->kind
!= NO_EVENT
;
3816 /* Clear input event EVENT. */
3819 clear_event (struct input_event
*event
)
3821 event
->kind
= NO_EVENT
;
3825 /* Read one event from the event buffer, waiting if necessary.
3826 The value is a Lisp object representing the event.
3827 The value is nil for an event that should be ignored,
3828 or that was handled here.
3829 We always read and discard one event. */
3832 kbd_buffer_get_event (KBOARD
**kbp
,
3833 bool *used_mouse_menu
,
3834 struct timespec
*end_time
)
3839 if (kbd_on_hold_p () && kbd_buffer_nr_stored () < KBD_BUFFER_SIZE
/ 4)
3841 /* Start reading input again because we have processed enough to
3842 be able to accept new events again. */
3843 unhold_keyboard_input ();
3846 #endif /* subprocesses */
3848 #if !defined HAVE_DBUS && !defined USE_FILE_NOTIFY
3850 /* In case we are running as a daemon, only do this before
3851 detaching from the terminal. */
3852 || (IS_DAEMON
&& daemon_pipe
[1] >= 0))
3856 *kbp
= current_kboard
;
3859 #endif /* !defined HAVE_DBUS && !defined USE_FILE_NOTIFY */
3861 /* Wait until there is input available. */
3864 /* Break loop if there's an unread command event. Needed in
3865 moused window autoselection which uses a timer to insert such
3867 if (CONSP (Vunread_command_events
))
3870 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3872 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3875 /* If the quit flag is set, then read_char will return
3876 quit_char, so that counts as "available input." */
3877 if (!NILP (Vquit_flag
))
3878 quit_throw_to_read_char (0);
3880 /* One way or another, wait until input is available; then, if
3881 interrupt handlers have not read it, read it now. */
3886 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3888 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3892 struct timespec now
= current_timespec ();
3893 if (timespec_cmp (*end_time
, now
) <= 0)
3894 return Qnil
; /* Finished waiting. */
3897 struct timespec duration
= timespec_sub (*end_time
, now
);
3898 wait_reading_process_output (min (duration
.tv_sec
,
3901 -1, 1, Qnil
, NULL
, 0);
3906 bool do_display
= true;
3908 if (FRAME_TERMCAP_P (SELECTED_FRAME ()))
3910 struct tty_display_info
*tty
= CURTTY ();
3912 /* When this TTY is displaying a menu, we must prevent
3913 any redisplay, because we modify the frame's glyph
3914 matrix behind the back of the display engine. */
3915 if (tty
->showing_menu
)
3919 wait_reading_process_output (0, 0, -1, do_display
, Qnil
, NULL
, 0);
3922 if (!interrupt_input
&& kbd_fetch_ptr
== kbd_store_ptr
)
3926 if (CONSP (Vunread_command_events
))
3929 first
= XCAR (Vunread_command_events
);
3930 Vunread_command_events
= XCDR (Vunread_command_events
);
3931 *kbp
= current_kboard
;
3935 /* At this point, we know that there is a readable event available
3936 somewhere. If the event queue is empty, then there must be a
3937 mouse movement enabled and available. */
3938 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3940 struct input_event
*event
;
3942 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
3946 *kbp
= event_to_kboard (event
);
3948 *kbp
= current_kboard
; /* Better than returning null ptr? */
3952 /* These two kinds of events get special handling
3953 and don't actually appear to the command loop.
3954 We return nil for them. */
3955 if (event
->kind
== SELECTION_REQUEST_EVENT
3956 || event
->kind
== SELECTION_CLEAR_EVENT
)
3959 struct input_event copy
;
3961 /* Remove it from the buffer before processing it,
3962 since otherwise swallow_events will see it
3963 and process it again. */
3965 kbd_fetch_ptr
= event
+ 1;
3966 input_pending
= readable_events (0);
3967 x_handle_selection_event (©
);
3969 /* We're getting selection request events, but we don't have
3975 #if defined (HAVE_NS)
3976 else if (event
->kind
== NS_TEXT_EVENT
)
3978 if (event
->code
== KEY_NS_PUT_WORKING_TEXT
)
3979 obj
= list1 (intern ("ns-put-working-text"));
3981 obj
= list1 (intern ("ns-unput-working-text"));
3982 kbd_fetch_ptr
= event
+ 1;
3983 if (used_mouse_menu
)
3984 *used_mouse_menu
= 1;
3988 #if defined (HAVE_X11) || defined (HAVE_NTGUI) \
3989 || defined (HAVE_NS)
3990 else if (event
->kind
== DELETE_WINDOW_EVENT
)
3992 /* Make an event (delete-frame (FRAME)). */
3993 obj
= list2 (Qdelete_frame
, list1 (event
->frame_or_window
));
3994 kbd_fetch_ptr
= event
+ 1;
3997 #if defined (HAVE_X11) || defined (HAVE_NTGUI) \
3998 || defined (HAVE_NS)
3999 else if (event
->kind
== ICONIFY_EVENT
)
4001 /* Make an event (iconify-frame (FRAME)). */
4002 obj
= list2 (Qiconify_frame
, list1 (event
->frame_or_window
));
4003 kbd_fetch_ptr
= event
+ 1;
4005 else if (event
->kind
== DEICONIFY_EVENT
)
4007 /* Make an event (make-frame-visible (FRAME)). */
4008 obj
= list2 (Qmake_frame_visible
, list1 (event
->frame_or_window
));
4009 kbd_fetch_ptr
= event
+ 1;
4012 else if (event
->kind
== BUFFER_SWITCH_EVENT
)
4014 /* The value doesn't matter here; only the type is tested. */
4015 XSETBUFFER (obj
, current_buffer
);
4016 kbd_fetch_ptr
= event
+ 1;
4018 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
4019 || defined (HAVE_NS) || defined (USE_GTK)
4020 else if (event
->kind
== MENU_BAR_ACTIVATE_EVENT
)
4022 kbd_fetch_ptr
= event
+ 1;
4023 input_pending
= readable_events (0);
4024 if (FRAME_LIVE_P (XFRAME (event
->frame_or_window
)))
4025 x_activate_menubar (XFRAME (event
->frame_or_window
));
4029 else if (event
->kind
== LANGUAGE_CHANGE_EVENT
)
4031 /* Make an event (language-change FRAME CODEPAGE LANGUAGE-ID). */
4032 obj
= list4 (Qlanguage_change
,
4033 event
->frame_or_window
,
4034 make_number (event
->code
),
4035 make_number (event
->modifiers
));
4036 kbd_fetch_ptr
= event
+ 1;
4039 #ifdef USE_FILE_NOTIFY
4040 else if (event
->kind
== FILE_NOTIFY_EVENT
)
4042 #ifdef HAVE_W32NOTIFY
4043 /* Make an event (file-notify (DESCRIPTOR ACTION FILE) CALLBACK). */
4044 obj
= list3 (Qfile_notify
, event
->arg
, event
->frame_or_window
);
4046 obj
= make_lispy_event (event
);
4048 kbd_fetch_ptr
= event
+ 1;
4050 #endif /* USE_FILE_NOTIFY */
4051 else if (event
->kind
== SAVE_SESSION_EVENT
)
4053 obj
= list2 (Qsave_session
, event
->arg
);
4054 kbd_fetch_ptr
= event
+ 1;
4056 /* Just discard these, by returning nil.
4057 With MULTI_KBOARD, these events are used as placeholders
4058 when we need to randomly delete events from the queue.
4059 (They shouldn't otherwise be found in the buffer,
4060 but on some machines it appears they do show up
4061 even without MULTI_KBOARD.) */
4062 /* On Windows NT/9X, NO_EVENT is used to delete extraneous
4063 mouse events during a popup-menu call. */
4064 else if (event
->kind
== NO_EVENT
)
4065 kbd_fetch_ptr
= event
+ 1;
4066 else if (event
->kind
== HELP_EVENT
)
4068 Lisp_Object object
, position
, help
, frame
, window
;
4070 frame
= event
->frame_or_window
;
4071 object
= event
->arg
;
4072 position
= make_number (Time_to_position (event
->timestamp
));
4075 clear_event (event
);
4077 kbd_fetch_ptr
= event
+ 1;
4078 if (!WINDOWP (window
))
4080 obj
= Fcons (Qhelp_echo
,
4081 list5 (frame
, help
, window
, object
, position
));
4083 else if (event
->kind
== FOCUS_IN_EVENT
)
4085 /* Notification of a FocusIn event. The frame receiving the
4086 focus is in event->frame_or_window. Generate a
4087 switch-frame event if necessary. */
4088 Lisp_Object frame
, focus
;
4090 frame
= event
->frame_or_window
;
4091 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
4100 !EQ (frame
, internal_last_event_frame
)
4101 && !EQ (frame
, selected_frame
))
4102 obj
= make_lispy_switch_frame (frame
);
4104 obj
= make_lispy_focus_in (frame
);
4106 internal_last_event_frame
= frame
;
4107 kbd_fetch_ptr
= event
+ 1;
4109 else if (event
->kind
== FOCUS_OUT_EVENT
)
4111 #ifdef HAVE_WINDOW_SYSTEM
4114 Lisp_Object frame
= event
->frame_or_window
;
4115 bool focused
= false;
4117 for (di
= x_display_list
; di
&& ! focused
; di
= di
->next
)
4118 focused
= di
->x_highlight_frame
!= 0;
4121 obj
= make_lispy_focus_out (frame
);
4123 #endif /* HAVE_WINDOW_SYSTEM */
4125 kbd_fetch_ptr
= event
+ 1;
4128 else if (event
->kind
== DBUS_EVENT
)
4130 obj
= make_lispy_event (event
);
4131 kbd_fetch_ptr
= event
+ 1;
4134 else if (event
->kind
== CONFIG_CHANGED_EVENT
)
4136 obj
= make_lispy_event (event
);
4137 kbd_fetch_ptr
= event
+ 1;
4141 /* If this event is on a different frame, return a switch-frame this
4142 time, and leave the event in the queue for next time. */
4146 frame
= event
->frame_or_window
;
4148 frame
= XCAR (frame
);
4149 else if (WINDOWP (frame
))
4150 frame
= WINDOW_FRAME (XWINDOW (frame
));
4152 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
4156 if (! EQ (frame
, internal_last_event_frame
)
4157 && !EQ (frame
, selected_frame
))
4158 obj
= make_lispy_switch_frame (frame
);
4159 internal_last_event_frame
= frame
;
4161 /* If we didn't decide to make a switch-frame event, go ahead
4162 and build a real event from the queue entry. */
4166 obj
= make_lispy_event (event
);
4168 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
4169 || defined (HAVE_NS) || defined (USE_GTK)
4170 /* If this was a menu selection, then set the flag to inhibit
4171 writing to last_nonmenu_event. Don't do this if the event
4172 we're returning is (menu-bar), though; that indicates the
4173 beginning of the menu sequence, and we might as well leave
4174 that as the `event with parameters' for this selection. */
4176 && !EQ (event
->frame_or_window
, event
->arg
)
4177 && (event
->kind
== MENU_BAR_EVENT
4178 || event
->kind
== TOOL_BAR_EVENT
))
4179 *used_mouse_menu
= 1;
4182 /* Certain system events are non-key events. */
4184 && event
->kind
== NS_NONKEY_EVENT
)
4185 *used_mouse_menu
= 1;
4188 /* Wipe out this event, to catch bugs. */
4189 clear_event (event
);
4190 kbd_fetch_ptr
= event
+ 1;
4194 /* Try generating a mouse motion event. */
4195 else if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
4197 struct frame
*f
= some_mouse_moved ();
4198 Lisp_Object bar_window
;
4199 enum scroll_bar_part part
;
4203 *kbp
= current_kboard
;
4204 /* Note that this uses F to determine which terminal to look at.
4205 If there is no valid info, it does not store anything
4206 so x remains nil. */
4209 /* XXX Can f or mouse_position_hook be NULL here? */
4210 if (f
&& FRAME_TERMINAL (f
)->mouse_position_hook
)
4211 (*FRAME_TERMINAL (f
)->mouse_position_hook
) (&f
, 0, &bar_window
,
4216 /* Decide if we should generate a switch-frame event. Don't
4217 generate switch-frame events for motion outside of all Emacs
4223 frame
= FRAME_FOCUS_FRAME (f
);
4225 XSETFRAME (frame
, f
);
4227 if (! EQ (frame
, internal_last_event_frame
)
4228 && !EQ (frame
, selected_frame
))
4229 obj
= make_lispy_switch_frame (frame
);
4230 internal_last_event_frame
= frame
;
4233 /* If we didn't decide to make a switch-frame event, go ahead and
4234 return a mouse-motion event. */
4235 if (!NILP (x
) && NILP (obj
))
4236 obj
= make_lispy_movement (f
, bar_window
, part
, x
, y
, t
);
4239 /* We were promised by the above while loop that there was
4240 something for us to read! */
4243 input_pending
= readable_events (0);
4245 Vlast_event_frame
= internal_last_event_frame
;
4250 /* Process any non-user-visible events (currently X selection events),
4251 without reading any user-visible events. */
4254 process_special_events (void)
4256 struct input_event
*event
;
4258 for (event
= kbd_fetch_ptr
; event
!= kbd_store_ptr
; ++event
)
4260 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
4263 if (event
== kbd_store_ptr
)
4267 /* If we find a stored X selection request, handle it now. */
4268 if (event
->kind
== SELECTION_REQUEST_EVENT
4269 || event
->kind
== SELECTION_CLEAR_EVENT
)
4273 /* Remove the event from the fifo buffer before processing;
4274 otherwise swallow_events called recursively could see it
4275 and process it again. To do this, we move the events
4276 between kbd_fetch_ptr and EVENT one slot to the right,
4279 struct input_event copy
= *event
;
4280 struct input_event
*beg
4281 = (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
4282 ? kbd_buffer
: kbd_fetch_ptr
;
4285 memmove (beg
+ 1, beg
, (event
- beg
) * sizeof (struct input_event
));
4286 else if (event
< beg
)
4288 if (event
> kbd_buffer
)
4289 memmove (kbd_buffer
+ 1, kbd_buffer
,
4290 (event
- kbd_buffer
) * sizeof (struct input_event
));
4291 *kbd_buffer
= *(kbd_buffer
+ KBD_BUFFER_SIZE
- 1);
4292 if (beg
< kbd_buffer
+ KBD_BUFFER_SIZE
- 1)
4293 memmove (beg
+ 1, beg
,
4294 (kbd_buffer
+ KBD_BUFFER_SIZE
- 1 - beg
)
4295 * sizeof (struct input_event
));
4298 if (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
4299 kbd_fetch_ptr
= kbd_buffer
+ 1;
4303 input_pending
= readable_events (0);
4304 x_handle_selection_event (©
);
4306 /* We're getting selection request events, but we don't have
4314 /* Process any events that are not user-visible, run timer events that
4315 are ripe, and return, without reading any user-visible events. */
4318 swallow_events (bool do_display
)
4320 unsigned old_timers_run
;
4322 process_special_events ();
4324 old_timers_run
= timers_run
;
4325 get_input_pending (READABLE_EVENTS_DO_TIMERS_NOW
);
4327 if (!input_pending
&& timers_run
!= old_timers_run
&& do_display
)
4328 redisplay_preserve_echo_area (7);
4331 /* Record the start of when Emacs is idle,
4332 for the sake of running idle-time timers. */
4335 timer_start_idle (void)
4337 /* If we are already in the idle state, do nothing. */
4338 if (timespec_valid_p (timer_idleness_start_time
))
4341 timer_idleness_start_time
= current_timespec ();
4342 timer_last_idleness_start_time
= timer_idleness_start_time
;
4344 /* Mark all idle-time timers as once again candidates for running. */
4345 call0 (intern ("internal-timer-start-idle"));
4348 /* Record that Emacs is no longer idle, so stop running idle-time timers. */
4351 timer_stop_idle (void)
4353 timer_idleness_start_time
= invalid_timespec ();
4356 /* Resume idle timer from last idle start time. */
4359 timer_resume_idle (void)
4361 if (timespec_valid_p (timer_idleness_start_time
))
4364 timer_idleness_start_time
= timer_last_idleness_start_time
;
4367 /* This is only for debugging. */
4368 struct input_event last_timer_event EXTERNALLY_VISIBLE
;
4370 /* List of elisp functions to call, delayed because they were generated in
4371 a context where Elisp could not be safely run (e.g. redisplay, signal,
4372 ...). Each element has the form (FUN . ARGS). */
4373 Lisp_Object pending_funcalls
;
4375 /* Return true if TIMER is a valid timer, placing its value into *RESULT. */
4377 decode_timer (Lisp_Object timer
, struct timespec
*result
)
4381 if (! (VECTORP (timer
) && ASIZE (timer
) == 9))
4383 vec
= XVECTOR (timer
)->contents
;
4384 if (! NILP (vec
[0]))
4386 if (! INTEGERP (vec
[2]))
4390 if (decode_time_components (vec
[1], vec
[2], vec
[3], vec
[8], &t
, 0) <= 0)
4392 *result
= lisp_to_timespec (t
);
4393 return timespec_valid_p (*result
);
4397 /* Check whether a timer has fired. To prevent larger problems we simply
4398 disregard elements that are not proper timers. Do not make a circular
4399 timer list for the time being.
4401 Returns the time to wait until the next timer fires. If a
4402 timer is triggering now, return zero.
4403 If no timer is active, return -1.
4405 If a timer is ripe, we run it, with quitting turned off.
4406 In that case we return 0 to indicate that a new timer_check_2 call
4409 static struct timespec
4410 timer_check_2 (Lisp_Object timers
, Lisp_Object idle_timers
)
4412 struct timespec nexttime
;
4413 struct timespec now
;
4414 struct timespec idleness_now
;
4415 Lisp_Object chosen_timer
;
4416 struct gcpro gcpro1
;
4418 nexttime
= invalid_timespec ();
4420 chosen_timer
= Qnil
;
4421 GCPRO1 (chosen_timer
);
4423 /* First run the code that was delayed. */
4424 while (CONSP (pending_funcalls
))
4426 Lisp_Object funcall
= XCAR (pending_funcalls
);
4427 pending_funcalls
= XCDR (pending_funcalls
);
4428 safe_call2 (Qapply
, XCAR (funcall
), XCDR (funcall
));
4431 if (CONSP (timers
) || CONSP (idle_timers
))
4433 now
= current_timespec ();
4434 idleness_now
= (timespec_valid_p (timer_idleness_start_time
)
4435 ? timespec_sub (now
, timer_idleness_start_time
)
4436 : make_timespec (0, 0));
4439 while (CONSP (timers
) || CONSP (idle_timers
))
4441 Lisp_Object timer
= Qnil
, idle_timer
= Qnil
;
4442 struct timespec timer_time
, idle_timer_time
;
4443 struct timespec difference
;
4444 struct timespec timer_difference
= invalid_timespec ();
4445 struct timespec idle_timer_difference
= invalid_timespec ();
4446 bool ripe
, timer_ripe
= 0, idle_timer_ripe
= 0;
4448 /* Set TIMER and TIMER_DIFFERENCE
4449 based on the next ordinary timer.
4450 TIMER_DIFFERENCE is the distance in time from NOW to when
4451 this timer becomes ripe.
4452 Skip past invalid timers and timers already handled. */
4455 timer
= XCAR (timers
);
4456 if (! decode_timer (timer
, &timer_time
))
4458 timers
= XCDR (timers
);
4462 timer_ripe
= timespec_cmp (timer_time
, now
) <= 0;
4463 timer_difference
= (timer_ripe
4464 ? timespec_sub (now
, timer_time
)
4465 : timespec_sub (timer_time
, now
));
4468 /* Likewise for IDLE_TIMER and IDLE_TIMER_DIFFERENCE
4469 based on the next idle timer. */
4470 if (CONSP (idle_timers
))
4472 idle_timer
= XCAR (idle_timers
);
4473 if (! decode_timer (idle_timer
, &idle_timer_time
))
4475 idle_timers
= XCDR (idle_timers
);
4479 idle_timer_ripe
= timespec_cmp (idle_timer_time
, idleness_now
) <= 0;
4480 idle_timer_difference
4482 ? timespec_sub (idleness_now
, idle_timer_time
)
4483 : timespec_sub (idle_timer_time
, idleness_now
));
4486 /* Decide which timer is the next timer,
4487 and set CHOSEN_TIMER, DIFFERENCE, and RIPE accordingly.
4488 Also step down the list where we found that timer. */
4490 if (timespec_valid_p (timer_difference
)
4491 && (! timespec_valid_p (idle_timer_difference
)
4492 || idle_timer_ripe
< timer_ripe
4493 || (idle_timer_ripe
== timer_ripe
4495 ? timespec_cmp (idle_timer_difference
,
4497 : timespec_cmp (timer_difference
,
4498 idle_timer_difference
))
4501 chosen_timer
= timer
;
4502 timers
= XCDR (timers
);
4503 difference
= timer_difference
;
4508 chosen_timer
= idle_timer
;
4509 idle_timers
= XCDR (idle_timers
);
4510 difference
= idle_timer_difference
;
4511 ripe
= idle_timer_ripe
;
4514 /* If timer is ripe, run it if it hasn't been run. */
4517 if (NILP (AREF (chosen_timer
, 0)))
4519 ptrdiff_t count
= SPECPDL_INDEX ();
4520 Lisp_Object old_deactivate_mark
= Vdeactivate_mark
;
4522 /* Mark the timer as triggered to prevent problems if the lisp
4523 code fails to reschedule it right. */
4524 ASET (chosen_timer
, 0, Qt
);
4526 specbind (Qinhibit_quit
, Qt
);
4528 call1 (Qtimer_event_handler
, chosen_timer
);
4529 Vdeactivate_mark
= old_deactivate_mark
;
4531 unbind_to (count
, Qnil
);
4533 /* Since we have handled the event,
4534 we don't need to tell the caller to wake up and do it. */
4535 /* But the caller must still wait for the next timer, so
4536 return 0 to indicate that. */
4539 nexttime
= make_timespec (0, 0);
4543 /* When we encounter a timer that is still waiting,
4544 return the amount of time to wait before it is ripe. */
4551 /* No timers are pending in the future. */
4552 /* Return 0 if we generated an event, and -1 if not. */
4558 /* Check whether a timer has fired. To prevent larger problems we simply
4559 disregard elements that are not proper timers. Do not make a circular
4560 timer list for the time being.
4562 Returns the time to wait until the next timer fires.
4563 If no timer is active, return an invalid value.
4565 As long as any timer is ripe, we run it. */
4570 struct timespec nexttime
;
4571 Lisp_Object timers
, idle_timers
;
4572 struct gcpro gcpro1
, gcpro2
;
4574 Lisp_Object tem
= Vinhibit_quit
;
4577 /* We use copies of the timers' lists to allow a timer to add itself
4578 again, without locking up Emacs if the newly added timer is
4579 already ripe when added. */
4581 /* Always consider the ordinary timers. */
4582 timers
= Fcopy_sequence (Vtimer_list
);
4583 /* Consider the idle timers only if Emacs is idle. */
4584 if (timespec_valid_p (timer_idleness_start_time
))
4585 idle_timers
= Fcopy_sequence (Vtimer_idle_list
);
4589 Vinhibit_quit
= tem
;
4591 GCPRO2 (timers
, idle_timers
);
4595 nexttime
= timer_check_2 (timers
, idle_timers
);
4597 while (nexttime
.tv_sec
== 0 && nexttime
.tv_nsec
== 0);
4603 DEFUN ("current-idle-time", Fcurrent_idle_time
, Scurrent_idle_time
, 0, 0, 0,
4604 doc
: /* Return the current length of Emacs idleness, or nil.
4605 The value when Emacs is idle is a list of four integers (HIGH LOW USEC PSEC)
4606 in the same style as (current-time).
4608 The value when Emacs is not idle is nil.
4610 PSEC is a multiple of the system clock resolution. */)
4613 if (timespec_valid_p (timer_idleness_start_time
))
4614 return make_lisp_time (timespec_sub (current_timespec (),
4615 timer_idleness_start_time
));
4620 /* Caches for modify_event_symbol. */
4621 static Lisp_Object accent_key_syms
;
4622 static Lisp_Object func_key_syms
;
4623 static Lisp_Object mouse_syms
;
4624 static Lisp_Object wheel_syms
;
4625 static Lisp_Object drag_n_drop_syms
;
4627 /* This is a list of keysym codes for special "accent" characters.
4628 It parallels lispy_accent_keys. */
4630 static const int lispy_accent_codes
[] =
4632 #ifdef XK_dead_circumflex
4637 #ifdef XK_dead_grave
4642 #ifdef XK_dead_tilde
4647 #ifdef XK_dead_diaeresis
4652 #ifdef XK_dead_macron
4657 #ifdef XK_dead_degree
4662 #ifdef XK_dead_acute
4667 #ifdef XK_dead_cedilla
4672 #ifdef XK_dead_breve
4677 #ifdef XK_dead_ogonek
4682 #ifdef XK_dead_caron
4687 #ifdef XK_dead_doubleacute
4688 XK_dead_doubleacute
,
4692 #ifdef XK_dead_abovedot
4697 #ifdef XK_dead_abovering
4707 #ifdef XK_dead_belowdot
4712 #ifdef XK_dead_voiced_sound
4713 XK_dead_voiced_sound
,
4717 #ifdef XK_dead_semivoiced_sound
4718 XK_dead_semivoiced_sound
,
4734 /* This is a list of Lisp names for special "accent" characters.
4735 It parallels lispy_accent_codes. */
4737 static const char *const lispy_accent_keys
[] =
4755 "dead-voiced-sound",
4756 "dead-semivoiced-sound",
4762 #define FUNCTION_KEY_OFFSET 0x0
4764 const char *const lispy_function_keys
[] =
4768 0, /* VK_LBUTTON 0x01 */
4769 0, /* VK_RBUTTON 0x02 */
4770 "cancel", /* VK_CANCEL 0x03 */
4771 0, /* VK_MBUTTON 0x04 */
4773 0, 0, 0, /* 0x05 .. 0x07 */
4775 "backspace", /* VK_BACK 0x08 */
4776 "tab", /* VK_TAB 0x09 */
4778 0, 0, /* 0x0A .. 0x0B */
4780 "clear", /* VK_CLEAR 0x0C */
4781 "return", /* VK_RETURN 0x0D */
4783 0, 0, /* 0x0E .. 0x0F */
4785 0, /* VK_SHIFT 0x10 */
4786 0, /* VK_CONTROL 0x11 */
4787 0, /* VK_MENU 0x12 */
4788 "pause", /* VK_PAUSE 0x13 */
4789 "capslock", /* VK_CAPITAL 0x14 */
4790 "kana", /* VK_KANA/VK_HANGUL 0x15 */
4792 "junja", /* VK_JUNJA 0x17 */
4793 "final", /* VK_FINAL 0x18 */
4794 "kanji", /* VK_KANJI/VK_HANJA 0x19 */
4796 "escape", /* VK_ESCAPE 0x1B */
4797 "convert", /* VK_CONVERT 0x1C */
4798 "non-convert", /* VK_NONCONVERT 0x1D */
4799 "accept", /* VK_ACCEPT 0x1E */
4800 "mode-change", /* VK_MODECHANGE 0x1F */
4801 0, /* VK_SPACE 0x20 */
4802 "prior", /* VK_PRIOR 0x21 */
4803 "next", /* VK_NEXT 0x22 */
4804 "end", /* VK_END 0x23 */
4805 "home", /* VK_HOME 0x24 */
4806 "left", /* VK_LEFT 0x25 */
4807 "up", /* VK_UP 0x26 */
4808 "right", /* VK_RIGHT 0x27 */
4809 "down", /* VK_DOWN 0x28 */
4810 "select", /* VK_SELECT 0x29 */
4811 "print", /* VK_PRINT 0x2A */
4812 "execute", /* VK_EXECUTE 0x2B */
4813 "snapshot", /* VK_SNAPSHOT 0x2C */
4814 "insert", /* VK_INSERT 0x2D */
4815 "delete", /* VK_DELETE 0x2E */
4816 "help", /* VK_HELP 0x2F */
4818 /* VK_0 thru VK_9 are the same as ASCII '0' thru '9' (0x30 - 0x39) */
4820 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4822 0, 0, 0, 0, 0, 0, 0, /* 0x3A .. 0x40 */
4824 /* VK_A thru VK_Z are the same as ASCII 'A' thru 'Z' (0x41 - 0x5A) */
4826 0, 0, 0, 0, 0, 0, 0, 0, 0,
4827 0, 0, 0, 0, 0, 0, 0, 0, 0,
4828 0, 0, 0, 0, 0, 0, 0, 0,
4830 "lwindow", /* VK_LWIN 0x5B */
4831 "rwindow", /* VK_RWIN 0x5C */
4832 "apps", /* VK_APPS 0x5D */
4835 "kp-0", /* VK_NUMPAD0 0x60 */
4836 "kp-1", /* VK_NUMPAD1 0x61 */
4837 "kp-2", /* VK_NUMPAD2 0x62 */
4838 "kp-3", /* VK_NUMPAD3 0x63 */
4839 "kp-4", /* VK_NUMPAD4 0x64 */
4840 "kp-5", /* VK_NUMPAD5 0x65 */
4841 "kp-6", /* VK_NUMPAD6 0x66 */
4842 "kp-7", /* VK_NUMPAD7 0x67 */
4843 "kp-8", /* VK_NUMPAD8 0x68 */
4844 "kp-9", /* VK_NUMPAD9 0x69 */
4845 "kp-multiply", /* VK_MULTIPLY 0x6A */
4846 "kp-add", /* VK_ADD 0x6B */
4847 "kp-separator", /* VK_SEPARATOR 0x6C */
4848 "kp-subtract", /* VK_SUBTRACT 0x6D */
4849 "kp-decimal", /* VK_DECIMAL 0x6E */
4850 "kp-divide", /* VK_DIVIDE 0x6F */
4851 "f1", /* VK_F1 0x70 */
4852 "f2", /* VK_F2 0x71 */
4853 "f3", /* VK_F3 0x72 */
4854 "f4", /* VK_F4 0x73 */
4855 "f5", /* VK_F5 0x74 */
4856 "f6", /* VK_F6 0x75 */
4857 "f7", /* VK_F7 0x76 */
4858 "f8", /* VK_F8 0x77 */
4859 "f9", /* VK_F9 0x78 */
4860 "f10", /* VK_F10 0x79 */
4861 "f11", /* VK_F11 0x7A */
4862 "f12", /* VK_F12 0x7B */
4863 "f13", /* VK_F13 0x7C */
4864 "f14", /* VK_F14 0x7D */
4865 "f15", /* VK_F15 0x7E */
4866 "f16", /* VK_F16 0x7F */
4867 "f17", /* VK_F17 0x80 */
4868 "f18", /* VK_F18 0x81 */
4869 "f19", /* VK_F19 0x82 */
4870 "f20", /* VK_F20 0x83 */
4871 "f21", /* VK_F21 0x84 */
4872 "f22", /* VK_F22 0x85 */
4873 "f23", /* VK_F23 0x86 */
4874 "f24", /* VK_F24 0x87 */
4876 0, 0, 0, 0, /* 0x88 .. 0x8B */
4877 0, 0, 0, 0, /* 0x8C .. 0x8F */
4879 "kp-numlock", /* VK_NUMLOCK 0x90 */
4880 "scroll", /* VK_SCROLL 0x91 */
4881 /* Not sure where the following block comes from.
4882 Windows headers have NEC and Fujitsu specific keys in
4883 this block, but nothing generic. */
4884 "kp-space", /* VK_NUMPAD_CLEAR 0x92 */
4885 "kp-enter", /* VK_NUMPAD_ENTER 0x93 */
4886 "kp-prior", /* VK_NUMPAD_PRIOR 0x94 */
4887 "kp-next", /* VK_NUMPAD_NEXT 0x95 */
4888 "kp-end", /* VK_NUMPAD_END 0x96 */
4889 "kp-home", /* VK_NUMPAD_HOME 0x97 */
4890 "kp-left", /* VK_NUMPAD_LEFT 0x98 */
4891 "kp-up", /* VK_NUMPAD_UP 0x99 */
4892 "kp-right", /* VK_NUMPAD_RIGHT 0x9A */
4893 "kp-down", /* VK_NUMPAD_DOWN 0x9B */
4894 "kp-insert", /* VK_NUMPAD_INSERT 0x9C */
4895 "kp-delete", /* VK_NUMPAD_DELETE 0x9D */
4897 0, 0, /* 0x9E .. 0x9F */
4900 * VK_L* & VK_R* - left and right Alt, Ctrl and Shift virtual keys.
4901 * Used only as parameters to GetAsyncKeyState and GetKeyState.
4902 * No other API or message will distinguish left and right keys this way.
4907 /* Multimedia keys. These are handled as WM_APPCOMMAND, which allows us
4908 to enable them selectively, and gives access to a few more functions.
4909 See lispy_multimedia_keys below. */
4910 0, 0, 0, 0, 0, 0, 0, /* 0xA6 .. 0xAC Browser */
4911 0, 0, 0, /* 0xAD .. 0xAF Volume */
4912 0, 0, 0, 0, /* 0xB0 .. 0xB3 Media */
4913 0, 0, 0, 0, /* 0xB4 .. 0xB7 Apps */
4915 /* 0xB8 .. 0xC0 "OEM" keys - all seem to be punctuation. */
4916 0, 0, 0, 0, 0, 0, 0, 0, 0,
4918 /* 0xC1 - 0xDA unallocated, 0xDB-0xDF more OEM keys */
4919 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4920 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4923 "ax", /* VK_OEM_AX 0xE1 */
4924 0, /* VK_OEM_102 0xE2 */
4925 "ico-help", /* VK_ICO_HELP 0xE3 */
4926 "ico-00", /* VK_ICO_00 0xE4 */
4927 0, /* VK_PROCESSKEY 0xE5 - used by IME */
4928 "ico-clear", /* VK_ICO_CLEAR 0xE6 */
4929 0, /* VK_PACKET 0xE7 - used to pass Unicode chars */
4931 "reset", /* VK_OEM_RESET 0xE9 */
4932 "jump", /* VK_OEM_JUMP 0xEA */
4933 "oem-pa1", /* VK_OEM_PA1 0xEB */
4934 "oem-pa2", /* VK_OEM_PA2 0xEC */
4935 "oem-pa3", /* VK_OEM_PA3 0xED */
4936 "wsctrl", /* VK_OEM_WSCTRL 0xEE */
4937 "cusel", /* VK_OEM_CUSEL 0xEF */
4938 "oem-attn", /* VK_OEM_ATTN 0xF0 */
4939 "finish", /* VK_OEM_FINISH 0xF1 */
4940 "copy", /* VK_OEM_COPY 0xF2 */
4941 "auto", /* VK_OEM_AUTO 0xF3 */
4942 "enlw", /* VK_OEM_ENLW 0xF4 */
4943 "backtab", /* VK_OEM_BACKTAB 0xF5 */
4944 "attn", /* VK_ATTN 0xF6 */
4945 "crsel", /* VK_CRSEL 0xF7 */
4946 "exsel", /* VK_EXSEL 0xF8 */
4947 "ereof", /* VK_EREOF 0xF9 */
4948 "play", /* VK_PLAY 0xFA */
4949 "zoom", /* VK_ZOOM 0xFB */
4950 "noname", /* VK_NONAME 0xFC */
4951 "pa1", /* VK_PA1 0xFD */
4952 "oem_clear", /* VK_OEM_CLEAR 0xFE */
4956 /* Some of these duplicate the "Media keys" on newer keyboards,
4957 but they are delivered to the application in a different way. */
4958 static const char *const lispy_multimedia_keys
[] =
4966 "browser-favorites",
5003 "toggle-dictate-command",
5009 "media-fast-forward",
5012 "media-channel-down"
5015 #else /* not HAVE_NTGUI */
5017 /* This should be dealt with in XTread_socket now, and that doesn't
5018 depend on the client system having the Kana syms defined. See also
5019 the XK_kana_A case below. */
5022 static const char *const lispy_kana_keys
[] =
5024 /* X Keysym value */
5025 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x400 .. 0x40f */
5026 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x410 .. 0x41f */
5027 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x420 .. 0x42f */
5028 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x430 .. 0x43f */
5029 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x440 .. 0x44f */
5030 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x450 .. 0x45f */
5031 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x460 .. 0x46f */
5032 0,0,0,0,0,0,0,0,0,0,0,0,0,0,"overline",0,
5033 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x480 .. 0x48f */
5034 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x490 .. 0x49f */
5035 0, "kana-fullstop", "kana-openingbracket", "kana-closingbracket",
5036 "kana-comma", "kana-conjunctive", "kana-WO", "kana-a",
5037 "kana-i", "kana-u", "kana-e", "kana-o",
5038 "kana-ya", "kana-yu", "kana-yo", "kana-tsu",
5039 "prolongedsound", "kana-A", "kana-I", "kana-U",
5040 "kana-E", "kana-O", "kana-KA", "kana-KI",
5041 "kana-KU", "kana-KE", "kana-KO", "kana-SA",
5042 "kana-SHI", "kana-SU", "kana-SE", "kana-SO",
5043 "kana-TA", "kana-CHI", "kana-TSU", "kana-TE",
5044 "kana-TO", "kana-NA", "kana-NI", "kana-NU",
5045 "kana-NE", "kana-NO", "kana-HA", "kana-HI",
5046 "kana-FU", "kana-HE", "kana-HO", "kana-MA",
5047 "kana-MI", "kana-MU", "kana-ME", "kana-MO",
5048 "kana-YA", "kana-YU", "kana-YO", "kana-RA",
5049 "kana-RI", "kana-RU", "kana-RE", "kana-RO",
5050 "kana-WA", "kana-N", "voicedsound", "semivoicedsound",
5051 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4e0 .. 0x4ef */
5052 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4f0 .. 0x4ff */
5054 #endif /* XK_kana_A */
5057 #define FUNCTION_KEY_OFFSET 0xff00
5059 /* You'll notice that this table is arranged to be conveniently
5060 indexed by X Windows keysym values. */
5061 static const char *const lispy_function_keys
[] =
5063 /* X Keysym value */
5065 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff00...0f */
5066 "backspace", "tab", "linefeed", "clear",
5068 0, 0, 0, "pause", /* 0xff10...1f */
5069 0, 0, 0, 0, 0, 0, 0, "escape",
5071 0, "kanji", "muhenkan", "henkan", /* 0xff20...2f */
5072 "romaji", "hiragana", "katakana", "hiragana-katakana",
5073 "zenkaku", "hankaku", "zenkaku-hankaku", "touroku",
5074 "massyo", "kana-lock", "kana-shift", "eisu-shift",
5075 "eisu-toggle", /* 0xff30...3f */
5076 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
5077 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff40...4f */
5079 "home", "left", "up", "right", /* 0xff50 */ /* IsCursorKey */
5080 "down", "prior", "next", "end",
5081 "begin", 0, 0, 0, 0, 0, 0, 0,
5082 "select", /* 0xff60 */ /* IsMiscFunctionKey */
5093 "break", /* 0xff6b */
5096 0, 0, 0, 0, "backtab", 0, 0, 0, /* 0xff70... */
5097 0, 0, 0, 0, 0, 0, 0, "kp-numlock", /* 0xff78... */
5098 "kp-space", /* 0xff80 */ /* IsKeypadKey */
5099 0, 0, 0, 0, 0, 0, 0, 0,
5100 "kp-tab", /* 0xff89 */
5102 "kp-enter", /* 0xff8d */
5104 "kp-f1", /* 0xff91 */
5108 "kp-home", /* 0xff95 */
5113 "kp-prior", /* kp-page-up */
5114 "kp-next", /* kp-page-down */
5120 0, 0, 0, 0, 0, 0, 0, 0, 0,
5121 "kp-multiply", /* 0xffaa */
5126 "kp-divide", /* 0xffaf */
5127 "kp-0", /* 0xffb0 */
5128 "kp-1", "kp-2", "kp-3", "kp-4", "kp-5", "kp-6", "kp-7", "kp-8", "kp-9",
5131 "kp-equal", /* 0xffbd */
5132 "f1", /* 0xffbe */ /* IsFunctionKey */
5134 "f3", "f4", "f5", "f6", "f7", "f8", "f9", "f10", /* 0xffc0 */
5135 "f11", "f12", "f13", "f14", "f15", "f16", "f17", "f18",
5136 "f19", "f20", "f21", "f22", "f23", "f24", "f25", "f26", /* 0xffd0 */
5137 "f27", "f28", "f29", "f30", "f31", "f32", "f33", "f34",
5138 "f35", 0, 0, 0, 0, 0, 0, 0, /* 0xffe0 */
5139 0, 0, 0, 0, 0, 0, 0, 0,
5140 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfff0 */
5141 0, 0, 0, 0, 0, 0, 0, "delete"
5144 /* ISO 9995 Function and Modifier Keys; the first byte is 0xFE. */
5145 #define ISO_FUNCTION_KEY_OFFSET 0xfe00
5147 static const char *const iso_lispy_function_keys
[] =
5149 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe00 */
5150 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe08 */
5151 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe10 */
5152 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe18 */
5153 "iso-lefttab", /* 0xfe20 */
5154 "iso-move-line-up", "iso-move-line-down",
5155 "iso-partial-line-up", "iso-partial-line-down",
5156 "iso-partial-space-left", "iso-partial-space-right",
5157 "iso-set-margin-left", "iso-set-margin-right", /* 0xffe27, 28 */
5158 "iso-release-margin-left", "iso-release-margin-right",
5159 "iso-release-both-margins",
5160 "iso-fast-cursor-left", "iso-fast-cursor-right",
5161 "iso-fast-cursor-up", "iso-fast-cursor-down",
5162 "iso-continuous-underline", "iso-discontinuous-underline", /* 0xfe30, 31 */
5163 "iso-emphasize", "iso-center-object", "iso-enter", /* ... 0xfe34 */
5166 #endif /* not HAVE_NTGUI */
5168 static Lisp_Object Vlispy_mouse_stem
;
5170 static const char *const lispy_wheel_names
[] =
5172 "wheel-up", "wheel-down", "wheel-left", "wheel-right"
5175 /* drag-n-drop events are generated when a set of selected files are
5176 dragged from another application and dropped onto an Emacs window. */
5177 static const char *const lispy_drag_n_drop_names
[] =
5182 /* An array of symbol indexes of scroll bar parts, indexed by an enum
5183 scroll_bar_part value. Note that Qnil corresponds to
5184 scroll_bar_nowhere and should not appear in Lisp events. */
5185 static short const scroll_bar_parts
[] = {
5186 SYMBOL_INDEX (Qnil
), SYMBOL_INDEX (Qabove_handle
), SYMBOL_INDEX (Qhandle
),
5187 SYMBOL_INDEX (Qbelow_handle
), SYMBOL_INDEX (Qup
), SYMBOL_INDEX (Qdown
),
5188 SYMBOL_INDEX (Qtop
), SYMBOL_INDEX (Qbottom
), SYMBOL_INDEX (Qend_scroll
),
5189 SYMBOL_INDEX (Qratio
), SYMBOL_INDEX (Qbefore_handle
),
5190 SYMBOL_INDEX (Qhorizontal_handle
), SYMBOL_INDEX (Qafter_handle
),
5191 SYMBOL_INDEX (Qleft
), SYMBOL_INDEX (Qright
), SYMBOL_INDEX (Qleftmost
),
5192 SYMBOL_INDEX (Qrightmost
), SYMBOL_INDEX (Qend_scroll
), SYMBOL_INDEX (Qratio
)
5195 /* A vector, indexed by button number, giving the down-going location
5196 of currently depressed buttons, both scroll bar and non-scroll bar.
5198 The elements have the form
5199 (BUTTON-NUMBER MODIFIER-MASK . REST)
5200 where REST is the cdr of a position as it would be reported in the event.
5202 The make_lispy_event function stores positions here to tell the
5203 difference between click and drag events, and to store the starting
5204 location to be included in drag events. */
5206 static Lisp_Object button_down_location
;
5208 /* Information about the most recent up-going button event: Which
5209 button, what location, and what time. */
5211 static int last_mouse_button
;
5212 static int last_mouse_x
;
5213 static int last_mouse_y
;
5214 static Time button_down_time
;
5216 /* The number of clicks in this multiple-click. */
5218 static int double_click_count
;
5220 /* X and Y are frame-relative coordinates for a click or wheel event.
5221 Return a Lisp-style event list. */
5224 make_lispy_position (struct frame
*f
, Lisp_Object x
, Lisp_Object y
,
5227 enum window_part part
;
5228 Lisp_Object posn
= Qnil
;
5229 Lisp_Object extra_info
= Qnil
;
5230 /* Coordinate pixel positions to return. */
5231 int xret
= 0, yret
= 0;
5232 /* The window under frame pixel coordinates (x,y) */
5233 Lisp_Object window
= f
5234 ? window_from_coordinates (f
, XINT (x
), XINT (y
), &part
, 0)
5237 if (WINDOWP (window
))
5239 /* It's a click in window WINDOW at frame coordinates (X,Y) */
5240 struct window
*w
= XWINDOW (window
);
5241 Lisp_Object string_info
= Qnil
;
5242 ptrdiff_t textpos
= 0;
5243 int col
= -1, row
= -1;
5244 int dx
= -1, dy
= -1;
5245 int width
= -1, height
= -1;
5246 Lisp_Object object
= Qnil
;
5248 /* Pixel coordinates relative to the window corner. */
5249 int wx
= XINT (x
) - WINDOW_LEFT_EDGE_X (w
);
5250 int wy
= XINT (y
) - WINDOW_TOP_EDGE_Y (w
);
5252 /* For text area clicks, return X, Y relative to the corner of
5253 this text area. Note that dX, dY etc are set below, by
5254 buffer_posn_from_coords. */
5255 if (part
== ON_TEXT
)
5257 xret
= XINT (x
) - window_box_left (w
, TEXT_AREA
);
5258 yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5260 /* For mode line and header line clicks, return X, Y relative to
5261 the left window edge. Use mode_line_string to look for a
5262 string on the click position. */
5263 else if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
)
5268 posn
= (part
== ON_MODE_LINE
) ? Qmode_line
: Qheader_line
;
5269 /* Note that mode_line_string takes COL, ROW as pixels and
5270 converts them to characters. */
5273 string
= mode_line_string (w
, part
, &col
, &row
, &charpos
,
5274 &object
, &dx
, &dy
, &width
, &height
);
5275 if (STRINGP (string
))
5276 string_info
= Fcons (string
, make_number (charpos
));
5282 /* For fringes and margins, Y is relative to the area's (and the
5283 window's) top edge, while X is meaningless. */
5284 else if (part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
5289 posn
= (part
== ON_LEFT_MARGIN
) ? Qleft_margin
: Qright_margin
;
5292 string
= marginal_area_string (w
, part
, &col
, &row
, &charpos
,
5293 &object
, &dx
, &dy
, &width
, &height
);
5294 if (STRINGP (string
))
5295 string_info
= Fcons (string
, make_number (charpos
));
5297 yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5299 else if (part
== ON_LEFT_FRINGE
)
5301 posn
= Qleft_fringe
;
5305 - (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5306 ? 0 : window_box_width (w
, LEFT_MARGIN_AREA
));
5307 dy
= yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5309 else if (part
== ON_RIGHT_FRINGE
)
5311 posn
= Qright_fringe
;
5315 - window_box_width (w
, LEFT_MARGIN_AREA
)
5316 - window_box_width (w
, TEXT_AREA
)
5317 - (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5318 ? window_box_width (w
, RIGHT_MARGIN_AREA
)
5320 dy
= yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5322 else if (part
== ON_VERTICAL_BORDER
)
5324 posn
= Qvertical_line
;
5330 else if (part
== ON_VERTICAL_SCROLL_BAR
)
5332 posn
= Qvertical_scroll_bar
;
5333 width
= WINDOW_SCROLL_BAR_AREA_WIDTH (w
);
5337 else if (part
== ON_HORIZONTAL_SCROLL_BAR
)
5339 posn
= Qhorizontal_scroll_bar
;
5340 width
= WINDOW_SCROLL_BAR_AREA_HEIGHT (w
);
5344 else if (part
== ON_RIGHT_DIVIDER
)
5346 posn
= Qright_divider
;
5347 width
= WINDOW_RIGHT_DIVIDER_WIDTH (w
);
5351 else if (part
== ON_BOTTOM_DIVIDER
)
5353 posn
= Qbottom_divider
;
5354 width
= WINDOW_BOTTOM_DIVIDER_WIDTH (w
);
5359 /* For clicks in the text area, fringes, or margins, call
5360 buffer_posn_from_coords to extract TEXTPOS, the buffer
5361 position nearest to the click. */
5364 Lisp_Object string2
, object2
= Qnil
;
5365 struct display_pos p
;
5367 int width2
, height2
;
5368 /* The pixel X coordinate passed to buffer_posn_from_coords
5369 is the X coordinate relative to the text area for
5370 text-area and right-margin clicks, zero otherwise. */
5372 = (part
== ON_TEXT
) ? xret
5373 : (part
== ON_RIGHT_FRINGE
|| part
== ON_RIGHT_MARGIN
)
5374 ? (XINT (x
) - window_box_left (w
, TEXT_AREA
))
5378 string2
= buffer_posn_from_coords (w
, &x2
, &y2
, &p
,
5379 &object2
, &dx2
, &dy2
,
5381 textpos
= CHARPOS (p
.pos
);
5382 if (col
< 0) col
= x2
;
5383 if (row
< 0) row
= y2
;
5384 if (dx
< 0) dx
= dx2
;
5385 if (dy
< 0) dy
= dy2
;
5386 if (width
< 0) width
= width2
;
5387 if (height
< 0) height
= height2
;
5391 posn
= make_number (textpos
);
5392 if (STRINGP (string2
))
5393 string_info
= Fcons (string2
,
5394 make_number (CHARPOS (p
.string_pos
)));
5400 #ifdef HAVE_WINDOW_SYSTEM
5401 if (IMAGEP (object
))
5403 Lisp_Object image_map
, hotspot
;
5404 if ((image_map
= Fplist_get (XCDR (object
), QCmap
),
5406 && (hotspot
= find_hot_spot (image_map
, dx
, dy
),
5408 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
5409 posn
= XCAR (hotspot
);
5416 Fcons (make_number (dx
), make_number (dy
)),
5417 Fcons (make_number (width
), make_number (height
)));
5420 extra_info
= Fcons (string_info
,
5421 Fcons (textpos
< 0 ? Qnil
: make_number (textpos
),
5422 Fcons (Fcons (make_number (col
),
5428 /* Return mouse pixel coordinates here. */
5429 XSETFRAME (window
, f
);
5436 return Fcons (window
,
5438 Fcons (Fcons (make_number (xret
),
5439 make_number (yret
)),
5440 Fcons (make_number (t
),
5444 /* Return non-zero if F is a GUI frame that uses some toolkit-managed
5445 menu bar. This really means that Emacs draws and manages the menu
5446 bar as part of its normal display, and therefore can compute its
5449 toolkit_menubar_in_use (struct frame
*f
)
5451 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS) || defined (HAVE_NTGUI)
5452 return !(!FRAME_WINDOW_P (f
));
5458 /* Build the part of Lisp event which represents scroll bar state from
5459 EV. TYPE is one of Qvertical_scroll_bar or Qhorizontal_scroll_bar. */
5462 make_scroll_bar_position (struct input_event
*ev
, Lisp_Object type
)
5464 return list5 (ev
->frame_or_window
, type
, Fcons (ev
->x
, ev
->y
),
5465 make_number (ev
->timestamp
),
5466 builtin_lisp_symbol (scroll_bar_parts
[ev
->part
]));
5469 /* Given a struct input_event, build the lisp event which represents
5470 it. If EVENT is 0, build a mouse movement event from the mouse
5471 movement buffer, which should have a movement event in it.
5473 Note that events must be passed to this function in the order they
5474 are received; this function stores the location of button presses
5475 in order to build drag events when the button is released. */
5478 make_lispy_event (struct input_event
*event
)
5482 switch (event
->kind
)
5484 /* A simple keystroke. */
5485 case ASCII_KEYSTROKE_EVENT
:
5486 case MULTIBYTE_CHAR_KEYSTROKE_EVENT
:
5488 Lisp_Object lispy_c
;
5489 EMACS_INT c
= event
->code
;
5490 if (event
->kind
== ASCII_KEYSTROKE_EVENT
)
5493 eassert (c
== event
->code
);
5494 /* Turn ASCII characters into control characters
5496 if (event
->modifiers
& ctrl_modifier
)
5498 c
= make_ctrl_char (c
);
5499 event
->modifiers
&= ~ctrl_modifier
;
5503 /* Add in the other modifier bits. The shift key was taken care
5504 of by the X code. */
5505 c
|= (event
->modifiers
5506 & (meta_modifier
| alt_modifier
5507 | hyper_modifier
| super_modifier
| ctrl_modifier
));
5508 /* Distinguish Shift-SPC from SPC. */
5509 if ((event
->code
) == 040
5510 && event
->modifiers
& shift_modifier
)
5511 c
|= shift_modifier
;
5512 button_down_time
= 0;
5513 XSETFASTINT (lispy_c
, c
);
5518 /* NS_NONKEY_EVENTs are just like NON_ASCII_KEYSTROKE_EVENTs,
5519 except that they are non-key events (last-nonmenu-event is nil). */
5520 case NS_NONKEY_EVENT
:
5523 /* A function key. The symbol may need to have modifier prefixes
5525 case NON_ASCII_KEYSTROKE_EVENT
:
5526 button_down_time
= 0;
5528 for (i
= 0; i
< ARRAYELTS (lispy_accent_codes
); i
++)
5529 if (event
->code
== lispy_accent_codes
[i
])
5530 return modify_event_symbol (i
,
5532 Qfunction_key
, Qnil
,
5533 lispy_accent_keys
, &accent_key_syms
,
5534 ARRAYELTS (lispy_accent_keys
));
5538 if (event
->code
>= 0x400 && event
->code
< 0x500)
5539 return modify_event_symbol (event
->code
- 0x400,
5540 event
->modifiers
& ~shift_modifier
,
5541 Qfunction_key
, Qnil
,
5542 lispy_kana_keys
, &func_key_syms
,
5543 ARRAYELTS (lispy_kana_keys
));
5544 #endif /* XK_kana_A */
5547 #ifdef ISO_FUNCTION_KEY_OFFSET
5548 if (event
->code
< FUNCTION_KEY_OFFSET
5549 && event
->code
>= ISO_FUNCTION_KEY_OFFSET
)
5550 return modify_event_symbol (event
->code
- ISO_FUNCTION_KEY_OFFSET
,
5552 Qfunction_key
, Qnil
,
5553 iso_lispy_function_keys
, &func_key_syms
,
5554 ARRAYELTS (iso_lispy_function_keys
));
5557 if ((FUNCTION_KEY_OFFSET
<= event
->code
5559 < FUNCTION_KEY_OFFSET
+ ARRAYELTS (lispy_function_keys
)))
5560 && lispy_function_keys
[event
->code
- FUNCTION_KEY_OFFSET
])
5561 return modify_event_symbol (event
->code
- FUNCTION_KEY_OFFSET
,
5563 Qfunction_key
, Qnil
,
5564 lispy_function_keys
, &func_key_syms
,
5565 ARRAYELTS (lispy_function_keys
));
5567 /* Handle system-specific or unknown keysyms.
5568 We need to use an alist rather than a vector as the cache
5569 since we can't make a vector long enough. */
5570 if (NILP (KVAR (current_kboard
, system_key_syms
)))
5571 kset_system_key_syms (current_kboard
, Fcons (Qnil
, Qnil
));
5572 return modify_event_symbol (event
->code
,
5575 KVAR (current_kboard
, Vsystem_key_alist
),
5576 0, &KVAR (current_kboard
, system_key_syms
),
5580 case MULTIMEDIA_KEY_EVENT
:
5581 if (event
->code
< ARRAYELTS (lispy_multimedia_keys
)
5582 && event
->code
> 0 && lispy_multimedia_keys
[event
->code
])
5584 return modify_event_symbol (event
->code
, event
->modifiers
,
5585 Qfunction_key
, Qnil
,
5586 lispy_multimedia_keys
, &func_key_syms
,
5587 ARRAYELTS (lispy_multimedia_keys
));
5592 /* A mouse click. Figure out where it is, decide whether it's
5593 a press, click or drag, and build the appropriate structure. */
5594 case MOUSE_CLICK_EVENT
:
5596 case GPM_CLICK_EVENT
:
5598 #ifndef USE_TOOLKIT_SCROLL_BARS
5599 case SCROLL_BAR_CLICK_EVENT
:
5600 case HORIZONTAL_SCROLL_BAR_CLICK_EVENT
:
5603 int button
= event
->code
;
5605 Lisp_Object position
;
5606 Lisp_Object
*start_pos_ptr
;
5607 Lisp_Object start_pos
;
5611 /* Build the position as appropriate for this mouse click. */
5612 if (event
->kind
== MOUSE_CLICK_EVENT
5614 || event
->kind
== GPM_CLICK_EVENT
5618 struct frame
*f
= XFRAME (event
->frame_or_window
);
5621 /* Ignore mouse events that were made on frame that
5622 have been deleted. */
5623 if (! FRAME_LIVE_P (f
))
5626 /* EVENT->x and EVENT->y are frame-relative pixel
5627 coordinates at this place. Under old redisplay, COLUMN
5628 and ROW are set to frame relative glyph coordinates
5629 which are then used to determine whether this click is
5630 in a menu (non-toolkit version). */
5631 if (!toolkit_menubar_in_use (f
))
5633 pixel_to_glyph_coords (f
, XINT (event
->x
), XINT (event
->y
),
5634 &column
, &row
, NULL
, 1);
5636 /* In the non-toolkit version, clicks on the menu bar
5637 are ordinary button events in the event buffer.
5638 Distinguish them, and invoke the menu.
5640 (In the toolkit version, the toolkit handles the
5641 menu bar and Emacs doesn't know about it until
5642 after the user makes a selection.) */
5643 if (row
>= 0 && row
< FRAME_MENU_BAR_LINES (f
)
5644 && (event
->modifiers
& down_modifier
))
5646 Lisp_Object items
, item
;
5648 /* Find the menu bar item under `column'. */
5650 items
= FRAME_MENU_BAR_ITEMS (f
);
5651 for (i
= 0; i
< ASIZE (items
); i
+= 4)
5653 Lisp_Object pos
, string
;
5654 string
= AREF (items
, i
+ 1);
5655 pos
= AREF (items
, i
+ 3);
5658 if (column
>= XINT (pos
)
5659 && column
< XINT (pos
) + SCHARS (string
))
5661 item
= AREF (items
, i
);
5666 /* ELisp manual 2.4b says (x y) are window
5667 relative but code says they are
5669 position
= list4 (event
->frame_or_window
,
5671 Fcons (event
->x
, event
->y
),
5672 make_number (event
->timestamp
));
5674 return list2 (item
, position
);
5678 position
= make_lispy_position (f
, event
->x
, event
->y
,
5681 #ifndef USE_TOOLKIT_SCROLL_BARS
5683 /* It's a scrollbar click. */
5684 position
= make_scroll_bar_position (event
, Qvertical_scroll_bar
);
5685 #endif /* not USE_TOOLKIT_SCROLL_BARS */
5687 if (button
>= ASIZE (button_down_location
))
5689 ptrdiff_t incr
= button
- ASIZE (button_down_location
) + 1;
5690 button_down_location
= larger_vector (button_down_location
,
5692 mouse_syms
= larger_vector (mouse_syms
, incr
, -1);
5695 start_pos_ptr
= aref_addr (button_down_location
, button
);
5696 start_pos
= *start_pos_ptr
;
5697 *start_pos_ptr
= Qnil
;
5700 /* On window-system frames, use the value of
5701 double-click-fuzz as is. On other frames, interpret it
5702 as a multiple of 1/8 characters. */
5706 if (WINDOWP (event
->frame_or_window
))
5707 f
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5708 else if (FRAMEP (event
->frame_or_window
))
5709 f
= XFRAME (event
->frame_or_window
);
5713 if (FRAME_WINDOW_P (f
))
5714 fuzz
= double_click_fuzz
;
5716 fuzz
= double_click_fuzz
/ 8;
5718 is_double
= (button
== last_mouse_button
5719 && (eabs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5720 && (eabs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5721 && button_down_time
!= 0
5722 && (EQ (Vdouble_click_time
, Qt
)
5723 || (NATNUMP (Vdouble_click_time
)
5724 && (event
->timestamp
- button_down_time
5725 < XFASTINT (Vdouble_click_time
)))));
5728 last_mouse_button
= button
;
5729 last_mouse_x
= XINT (event
->x
);
5730 last_mouse_y
= XINT (event
->y
);
5732 /* If this is a button press, squirrel away the location, so
5733 we can decide later whether it was a click or a drag. */
5734 if (event
->modifiers
& down_modifier
)
5738 double_click_count
++;
5739 event
->modifiers
|= ((double_click_count
> 2)
5744 double_click_count
= 1;
5745 button_down_time
= event
->timestamp
;
5746 *start_pos_ptr
= Fcopy_alist (position
);
5747 ignore_mouse_drag_p
= 0;
5750 /* Now we're releasing a button - check the co-ordinates to
5751 see if this was a click or a drag. */
5752 else if (event
->modifiers
& up_modifier
)
5754 /* If we did not see a down before this up, ignore the up.
5755 Probably this happened because the down event chose a
5756 menu item. It would be an annoyance to treat the
5757 release of the button that chose the menu item as a
5760 if (!CONSP (start_pos
))
5763 event
->modifiers
&= ~up_modifier
;
5766 Lisp_Object new_down
, down
;
5767 EMACS_INT xdiff
= double_click_fuzz
, ydiff
= double_click_fuzz
;
5769 /* The third element of every position
5770 should be the (x,y) pair. */
5771 down
= Fcar (Fcdr (Fcdr (start_pos
)));
5772 new_down
= Fcar (Fcdr (Fcdr (position
)));
5775 && INTEGERP (XCAR (down
)) && INTEGERP (XCDR (down
)))
5777 xdiff
= XINT (XCAR (new_down
)) - XINT (XCAR (down
));
5778 ydiff
= XINT (XCDR (new_down
)) - XINT (XCDR (down
));
5781 if (ignore_mouse_drag_p
)
5783 event
->modifiers
|= click_modifier
;
5784 ignore_mouse_drag_p
= 0;
5786 else if (xdiff
< double_click_fuzz
&& xdiff
> - double_click_fuzz
5787 && ydiff
< double_click_fuzz
&& ydiff
> - double_click_fuzz
5788 /* Maybe the mouse has moved a lot, caused scrolling, and
5789 eventually ended up at the same screen position (but
5790 not buffer position) in which case it is a drag, not
5792 /* FIXME: OTOH if the buffer position has changed
5793 because of a timer or process filter rather than
5794 because of mouse movement, it should be considered as
5795 a click. But mouse-drag-region completely ignores
5796 this case and it hasn't caused any real problem, so
5797 it's probably OK to ignore it as well. */
5798 && EQ (Fcar (Fcdr (start_pos
)), Fcar (Fcdr (position
))))
5799 /* Mouse hasn't moved (much). */
5800 event
->modifiers
|= click_modifier
;
5803 button_down_time
= 0;
5804 event
->modifiers
|= drag_modifier
;
5807 /* Don't check is_double; treat this as multiple
5808 if the down-event was multiple. */
5809 if (double_click_count
> 1)
5810 event
->modifiers
|= ((double_click_count
> 2)
5816 /* Every mouse event should either have the down_modifier or
5817 the up_modifier set. */
5821 /* Get the symbol we should use for the mouse click. */
5824 head
= modify_event_symbol (button
,
5826 Qmouse_click
, Vlispy_mouse_stem
,
5829 ASIZE (mouse_syms
));
5830 if (event
->modifiers
& drag_modifier
)
5831 return list3 (head
, start_pos
, position
);
5832 else if (event
->modifiers
& (double_modifier
| triple_modifier
))
5833 return list3 (head
, position
, make_number (double_click_count
));
5835 return list2 (head
, position
);
5840 case HORIZ_WHEEL_EVENT
:
5842 Lisp_Object position
;
5845 /* Build the position as appropriate for this mouse click. */
5846 struct frame
*f
= XFRAME (event
->frame_or_window
);
5848 /* Ignore wheel events that were made on frame that have been
5850 if (! FRAME_LIVE_P (f
))
5853 position
= make_lispy_position (f
, event
->x
, event
->y
,
5856 /* Set double or triple modifiers to indicate the wheel speed. */
5858 /* On window-system frames, use the value of
5859 double-click-fuzz as is. On other frames, interpret it
5860 as a multiple of 1/8 characters. */
5866 if (WINDOWP (event
->frame_or_window
))
5867 fr
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5868 else if (FRAMEP (event
->frame_or_window
))
5869 fr
= XFRAME (event
->frame_or_window
);
5873 fuzz
= FRAME_WINDOW_P (fr
)
5874 ? double_click_fuzz
: double_click_fuzz
/ 8;
5876 if (event
->modifiers
& up_modifier
)
5878 /* Emit a wheel-up event. */
5879 event
->modifiers
&= ~up_modifier
;
5882 else if (event
->modifiers
& down_modifier
)
5884 /* Emit a wheel-down event. */
5885 event
->modifiers
&= ~down_modifier
;
5889 /* Every wheel event should either have the down_modifier or
5890 the up_modifier set. */
5893 if (event
->kind
== HORIZ_WHEEL_EVENT
)
5896 is_double
= (last_mouse_button
== - (1 + symbol_num
)
5897 && (eabs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5898 && (eabs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5899 && button_down_time
!= 0
5900 && (EQ (Vdouble_click_time
, Qt
)
5901 || (NATNUMP (Vdouble_click_time
)
5902 && (event
->timestamp
- button_down_time
5903 < XFASTINT (Vdouble_click_time
)))));
5906 double_click_count
++;
5907 event
->modifiers
|= ((double_click_count
> 2)
5913 double_click_count
= 1;
5914 event
->modifiers
|= click_modifier
;
5917 button_down_time
= event
->timestamp
;
5918 /* Use a negative value to distinguish wheel from mouse button. */
5919 last_mouse_button
= - (1 + symbol_num
);
5920 last_mouse_x
= XINT (event
->x
);
5921 last_mouse_y
= XINT (event
->y
);
5923 /* Get the symbol we should use for the wheel event. */
5924 head
= modify_event_symbol (symbol_num
,
5930 ASIZE (wheel_syms
));
5933 if (event
->modifiers
& (double_modifier
| triple_modifier
))
5934 return list3 (head
, position
, make_number (double_click_count
));
5936 return list2 (head
, position
);
5940 #ifdef USE_TOOLKIT_SCROLL_BARS
5942 /* We don't have down and up events if using toolkit scroll bars,
5943 so make this always a click event. Store in the `part' of
5944 the Lisp event a symbol which maps to the following actions:
5946 `above_handle' page up
5947 `below_handle' page down
5951 `bottom' bottom of buffer
5952 `handle' thumb has been dragged.
5953 `end-scroll' end of interaction with scroll bar
5955 The incoming input_event contains in its `part' member an
5956 index of type `enum scroll_bar_part' which we can use as an
5957 index in scroll_bar_parts to get the appropriate symbol. */
5959 case SCROLL_BAR_CLICK_EVENT
:
5961 Lisp_Object position
, head
;
5963 position
= make_scroll_bar_position (event
, Qvertical_scroll_bar
);
5965 /* Always treat scroll bar events as clicks. */
5966 event
->modifiers
|= click_modifier
;
5967 event
->modifiers
&= ~up_modifier
;
5969 if (event
->code
>= ASIZE (mouse_syms
))
5970 mouse_syms
= larger_vector (mouse_syms
,
5971 event
->code
- ASIZE (mouse_syms
) + 1,
5974 /* Get the symbol we should use for the mouse click. */
5975 head
= modify_event_symbol (event
->code
,
5980 ASIZE (mouse_syms
));
5981 return list2 (head
, position
);
5984 case HORIZONTAL_SCROLL_BAR_CLICK_EVENT
:
5986 Lisp_Object position
, head
;
5988 position
= make_scroll_bar_position (event
, Qhorizontal_scroll_bar
);
5990 /* Always treat scroll bar events as clicks. */
5991 event
->modifiers
|= click_modifier
;
5992 event
->modifiers
&= ~up_modifier
;
5994 if (event
->code
>= ASIZE (mouse_syms
))
5995 mouse_syms
= larger_vector (mouse_syms
,
5996 event
->code
- ASIZE (mouse_syms
) + 1,
5999 /* Get the symbol we should use for the mouse click. */
6000 head
= modify_event_symbol (event
->code
,
6005 ASIZE (mouse_syms
));
6006 return list2 (head
, position
);
6009 #endif /* USE_TOOLKIT_SCROLL_BARS */
6011 case DRAG_N_DROP_EVENT
:
6014 Lisp_Object head
, position
;
6017 f
= XFRAME (event
->frame_or_window
);
6020 /* Ignore mouse events that were made on frames that
6021 have been deleted. */
6022 if (! FRAME_LIVE_P (f
))
6025 position
= make_lispy_position (f
, event
->x
, event
->y
,
6028 head
= modify_event_symbol (0, event
->modifiers
,
6030 lispy_drag_n_drop_names
,
6031 &drag_n_drop_syms
, 1);
6032 return list3 (head
, position
, files
);
6035 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
6036 || defined (HAVE_NS) || defined (USE_GTK)
6037 case MENU_BAR_EVENT
:
6038 if (EQ (event
->arg
, event
->frame_or_window
))
6039 /* This is the prefix key. We translate this to
6040 `(menu_bar)' because the code in keyboard.c for menu
6041 events, which we use, relies on this. */
6042 return list1 (Qmenu_bar
);
6046 case SELECT_WINDOW_EVENT
:
6047 /* Make an event (select-window (WINDOW)). */
6048 return list2 (Qselect_window
, list1 (event
->frame_or_window
));
6050 case TOOL_BAR_EVENT
:
6051 if (EQ (event
->arg
, event
->frame_or_window
))
6052 /* This is the prefix key. We translate this to
6053 `(tool_bar)' because the code in keyboard.c for tool bar
6054 events, which we use, relies on this. */
6055 return list1 (Qtool_bar
);
6056 else if (SYMBOLP (event
->arg
))
6057 return apply_modifiers (event
->modifiers
, event
->arg
);
6060 case USER_SIGNAL_EVENT
:
6061 /* A user signal. */
6063 char *name
= find_user_signal_name (event
->code
);
6066 return intern (name
);
6069 case SAVE_SESSION_EVENT
:
6070 return Qsave_session
;
6075 return Fcons (Qdbus_event
, event
->arg
);
6077 #endif /* HAVE_DBUS */
6079 #if defined HAVE_GFILENOTIFY || defined HAVE_INOTIFY
6080 case FILE_NOTIFY_EVENT
:
6082 return Fcons (Qfile_notify
, event
->arg
);
6084 #endif /* defined HAVE_GFILENOTIFY || defined HAVE_INOTIFY */
6086 case CONFIG_CHANGED_EVENT
:
6087 return list3 (Qconfig_changed_event
,
6088 event
->arg
, event
->frame_or_window
);
6090 /* The 'kind' field of the event is something we don't recognize. */
6097 make_lispy_movement (struct frame
*frame
, Lisp_Object bar_window
, enum scroll_bar_part part
,
6098 Lisp_Object x
, Lisp_Object y
, Time t
)
6100 /* Is it a scroll bar movement? */
6101 if (frame
&& ! NILP (bar_window
))
6103 Lisp_Object part_sym
;
6105 part_sym
= builtin_lisp_symbol (scroll_bar_parts
[part
]);
6106 return list2 (Qscroll_bar_movement
,
6108 Qvertical_scroll_bar
,
6113 /* Or is it an ordinary mouse movement? */
6116 Lisp_Object position
;
6117 position
= make_lispy_position (frame
, x
, y
, t
);
6118 return list2 (Qmouse_movement
, position
);
6122 /* Construct a switch frame event. */
6124 make_lispy_switch_frame (Lisp_Object frame
)
6126 return list2 (Qswitch_frame
, frame
);
6130 make_lispy_focus_in (Lisp_Object frame
)
6132 return list2 (Qfocus_in
, frame
);
6135 #ifdef HAVE_WINDOW_SYSTEM
6138 make_lispy_focus_out (Lisp_Object frame
)
6140 return list2 (Qfocus_out
, frame
);
6143 #endif /* HAVE_WINDOW_SYSTEM */
6145 /* Manipulating modifiers. */
6147 /* Parse the name of SYMBOL, and return the set of modifiers it contains.
6149 If MODIFIER_END is non-zero, set *MODIFIER_END to the position in
6150 SYMBOL's name of the end of the modifiers; the string from this
6151 position is the unmodified symbol name.
6153 This doesn't use any caches. */
6156 parse_modifiers_uncached (Lisp_Object symbol
, ptrdiff_t *modifier_end
)
6162 CHECK_SYMBOL (symbol
);
6165 name
= SYMBOL_NAME (symbol
);
6167 for (i
= 0; i
< SBYTES (name
) - 1; )
6169 ptrdiff_t this_mod_end
= 0;
6172 /* See if the name continues with a modifier word.
6173 Check that the word appears, but don't check what follows it.
6174 Set this_mod and this_mod_end to record what we find. */
6176 switch (SREF (name
, i
))
6178 #define SINGLE_LETTER_MOD(BIT) \
6179 (this_mod_end = i + 1, this_mod = BIT)
6182 SINGLE_LETTER_MOD (alt_modifier
);
6186 SINGLE_LETTER_MOD (ctrl_modifier
);
6190 SINGLE_LETTER_MOD (hyper_modifier
);
6194 SINGLE_LETTER_MOD (meta_modifier
);
6198 SINGLE_LETTER_MOD (shift_modifier
);
6202 SINGLE_LETTER_MOD (super_modifier
);
6205 #undef SINGLE_LETTER_MOD
6207 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6208 if (i + LEN + 1 <= SBYTES (name) \
6209 && ! memcmp (SDATA (name) + i, NAME, LEN)) \
6211 this_mod_end = i + LEN; \
6216 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
6217 MULTI_LETTER_MOD (down_modifier
, "down", 4);
6218 MULTI_LETTER_MOD (double_modifier
, "double", 6);
6222 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
6224 #undef MULTI_LETTER_MOD
6228 /* If we found no modifier, stop looking for them. */
6229 if (this_mod_end
== 0)
6232 /* Check there is a dash after the modifier, so that it
6233 really is a modifier. */
6234 if (this_mod_end
>= SBYTES (name
)
6235 || SREF (name
, this_mod_end
) != '-')
6238 /* This modifier is real; look for another. */
6239 modifiers
|= this_mod
;
6240 i
= this_mod_end
+ 1;
6243 /* Should we include the `click' modifier? */
6244 if (! (modifiers
& (down_modifier
| drag_modifier
6245 | double_modifier
| triple_modifier
))
6246 && i
+ 7 == SBYTES (name
)
6247 && memcmp (SDATA (name
) + i
, "mouse-", 6) == 0
6248 && ('0' <= SREF (name
, i
+ 6) && SREF (name
, i
+ 6) <= '9'))
6249 modifiers
|= click_modifier
;
6251 if (! (modifiers
& (double_modifier
| triple_modifier
))
6252 && i
+ 6 < SBYTES (name
)
6253 && memcmp (SDATA (name
) + i
, "wheel-", 6) == 0)
6254 modifiers
|= click_modifier
;
6262 /* Return a symbol whose name is the modifier prefixes for MODIFIERS
6263 prepended to the string BASE[0..BASE_LEN-1].
6264 This doesn't use any caches. */
6266 apply_modifiers_uncached (int modifiers
, char *base
, int base_len
, int base_len_byte
)
6268 /* Since BASE could contain nulls, we can't use intern here; we have
6269 to use Fintern, which expects a genuine Lisp_String, and keeps a
6271 char new_mods
[sizeof "A-C-H-M-S-s-down-drag-double-triple-"];
6277 /* Only the event queue may use the `up' modifier; it should always
6278 be turned into a click or drag event before presented to lisp code. */
6279 if (modifiers
& up_modifier
)
6282 if (modifiers
& alt_modifier
) { *p
++ = 'A'; *p
++ = '-'; }
6283 if (modifiers
& ctrl_modifier
) { *p
++ = 'C'; *p
++ = '-'; }
6284 if (modifiers
& hyper_modifier
) { *p
++ = 'H'; *p
++ = '-'; }
6285 if (modifiers
& meta_modifier
) { *p
++ = 'M'; *p
++ = '-'; }
6286 if (modifiers
& shift_modifier
) { *p
++ = 'S'; *p
++ = '-'; }
6287 if (modifiers
& super_modifier
) { *p
++ = 's'; *p
++ = '-'; }
6288 if (modifiers
& double_modifier
) p
= stpcpy (p
, "double-");
6289 if (modifiers
& triple_modifier
) p
= stpcpy (p
, "triple-");
6290 if (modifiers
& down_modifier
) p
= stpcpy (p
, "down-");
6291 if (modifiers
& drag_modifier
) p
= stpcpy (p
, "drag-");
6292 /* The click modifier is denoted by the absence of other modifiers. */
6296 mod_len
= p
- new_mods
;
6300 Lisp_Object new_name
;
6302 new_name
= make_uninit_multibyte_string (mod_len
+ base_len
,
6303 mod_len
+ base_len_byte
);
6304 memcpy (SDATA (new_name
), new_mods
, mod_len
);
6305 memcpy (SDATA (new_name
) + mod_len
, base
, base_len_byte
);
6307 return Fintern (new_name
, Qnil
);
6312 static const char *const modifier_names
[] =
6314 "up", "down", "drag", "click", "double", "triple", 0, 0,
6315 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
6316 0, 0, "alt", "super", "hyper", "shift", "control", "meta"
6318 #define NUM_MOD_NAMES ARRAYELTS (modifier_names)
6320 static Lisp_Object modifier_symbols
;
6322 /* Return the list of modifier symbols corresponding to the mask MODIFIERS. */
6324 lispy_modifier_list (int modifiers
)
6326 Lisp_Object modifier_list
;
6329 modifier_list
= Qnil
;
6330 for (i
= 0; (1<<i
) <= modifiers
&& i
< NUM_MOD_NAMES
; i
++)
6331 if (modifiers
& (1<<i
))
6332 modifier_list
= Fcons (AREF (modifier_symbols
, i
),
6335 return modifier_list
;
6339 /* Parse the modifiers on SYMBOL, and return a list like (UNMODIFIED MASK),
6340 where UNMODIFIED is the unmodified form of SYMBOL,
6341 MASK is the set of modifiers present in SYMBOL's name.
6342 This is similar to parse_modifiers_uncached, but uses the cache in
6343 SYMBOL's Qevent_symbol_element_mask property, and maintains the
6344 Qevent_symbol_elements property. */
6346 #define KEY_TO_CHAR(k) (XINT (k) & ((1 << CHARACTERBITS) - 1))
6349 parse_modifiers (Lisp_Object symbol
)
6351 Lisp_Object elements
;
6353 if (INTEGERP (symbol
))
6354 return list2i (KEY_TO_CHAR (symbol
), XINT (symbol
) & CHAR_MODIFIER_MASK
);
6355 else if (!SYMBOLP (symbol
))
6358 elements
= Fget (symbol
, Qevent_symbol_element_mask
);
6359 if (CONSP (elements
))
6364 int modifiers
= parse_modifiers_uncached (symbol
, &end
);
6365 Lisp_Object unmodified
;
6368 unmodified
= Fintern (make_string (SSDATA (SYMBOL_NAME (symbol
)) + end
,
6369 SBYTES (SYMBOL_NAME (symbol
)) - end
),
6372 if (modifiers
& ~INTMASK
)
6374 XSETFASTINT (mask
, modifiers
);
6375 elements
= list2 (unmodified
, mask
);
6377 /* Cache the parsing results on SYMBOL. */
6378 Fput (symbol
, Qevent_symbol_element_mask
,
6380 Fput (symbol
, Qevent_symbol_elements
,
6381 Fcons (unmodified
, lispy_modifier_list (modifiers
)));
6383 /* Since we know that SYMBOL is modifiers applied to unmodified,
6384 it would be nice to put that in unmodified's cache.
6385 But we can't, since we're not sure that parse_modifiers is
6392 DEFUN ("internal-event-symbol-parse-modifiers", Fevent_symbol_parse_modifiers
,
6393 Sevent_symbol_parse_modifiers
, 1, 1, 0,
6394 doc
: /* Parse the event symbol. For internal use. */)
6395 (Lisp_Object symbol
)
6397 /* Fill the cache if needed. */
6398 parse_modifiers (symbol
);
6399 /* Ignore the result (which is stored on Qevent_symbol_element_mask)
6400 and use the Lispier representation stored on Qevent_symbol_elements
6402 return Fget (symbol
, Qevent_symbol_elements
);
6405 /* Apply the modifiers MODIFIERS to the symbol BASE.
6406 BASE must be unmodified.
6408 This is like apply_modifiers_uncached, but uses BASE's
6409 Qmodifier_cache property, if present. It also builds
6410 Qevent_symbol_elements properties, since it has that info anyway.
6412 apply_modifiers copies the value of BASE's Qevent_kind property to
6413 the modified symbol. */
6415 apply_modifiers (int modifiers
, Lisp_Object base
)
6417 Lisp_Object cache
, idx
, entry
, new_symbol
;
6419 /* Mask out upper bits. We don't know where this value's been. */
6420 modifiers
&= INTMASK
;
6422 if (INTEGERP (base
))
6423 return make_number (XINT (base
) | modifiers
);
6425 /* The click modifier never figures into cache indices. */
6426 cache
= Fget (base
, Qmodifier_cache
);
6427 XSETFASTINT (idx
, (modifiers
& ~click_modifier
));
6428 entry
= assq_no_quit (idx
, cache
);
6431 new_symbol
= XCDR (entry
);
6434 /* We have to create the symbol ourselves. */
6435 new_symbol
= apply_modifiers_uncached (modifiers
,
6436 SSDATA (SYMBOL_NAME (base
)),
6437 SCHARS (SYMBOL_NAME (base
)),
6438 SBYTES (SYMBOL_NAME (base
)));
6440 /* Add the new symbol to the base's cache. */
6441 entry
= Fcons (idx
, new_symbol
);
6442 Fput (base
, Qmodifier_cache
, Fcons (entry
, cache
));
6444 /* We have the parsing info now for free, so we could add it to
6446 XSETFASTINT (idx, modifiers);
6447 Fput (new_symbol, Qevent_symbol_element_mask,
6449 Fput (new_symbol, Qevent_symbol_elements,
6450 Fcons (base, lispy_modifier_list (modifiers)));
6451 Sadly, this is only correct if `base' is indeed a base event,
6452 which is not necessarily the case. -stef */
6455 /* Make sure this symbol is of the same kind as BASE.
6457 You'd think we could just set this once and for all when we
6458 intern the symbol above, but reorder_modifiers may call us when
6459 BASE's property isn't set right; we can't assume that just
6460 because it has a Qmodifier_cache property it must have its
6461 Qevent_kind set right as well. */
6462 if (NILP (Fget (new_symbol
, Qevent_kind
)))
6466 kind
= Fget (base
, Qevent_kind
);
6468 Fput (new_symbol
, Qevent_kind
, kind
);
6475 /* Given a symbol whose name begins with modifiers ("C-", "M-", etc),
6476 return a symbol with the modifiers placed in the canonical order.
6477 Canonical order is alphabetical, except for down and drag, which
6478 always come last. The 'click' modifier is never written out.
6480 Fdefine_key calls this to make sure that (for example) C-M-foo
6481 and M-C-foo end up being equivalent in the keymap. */
6484 reorder_modifiers (Lisp_Object symbol
)
6486 /* It's hopefully okay to write the code this way, since everything
6487 will soon be in caches, and no consing will be done at all. */
6490 parsed
= parse_modifiers (symbol
);
6491 return apply_modifiers (XFASTINT (XCAR (XCDR (parsed
))),
6496 /* For handling events, we often want to produce a symbol whose name
6497 is a series of modifier key prefixes ("M-", "C-", etcetera) attached
6498 to some base, like the name of a function key or mouse button.
6499 modify_event_symbol produces symbols of this sort.
6501 NAME_TABLE should point to an array of strings, such that NAME_TABLE[i]
6502 is the name of the i'th symbol. TABLE_SIZE is the number of elements
6505 Alternatively, NAME_ALIST_OR_STEM is either an alist mapping codes
6506 into symbol names, or a string specifying a name stem used to
6507 construct a symbol name or the form `STEM-N', where N is the decimal
6508 representation of SYMBOL_NUM. NAME_ALIST_OR_STEM is used if it is
6509 non-nil; otherwise NAME_TABLE is used.
6511 SYMBOL_TABLE should be a pointer to a Lisp_Object whose value will
6512 persist between calls to modify_event_symbol that it can use to
6513 store a cache of the symbols it's generated for this NAME_TABLE
6514 before. The object stored there may be a vector or an alist.
6516 SYMBOL_NUM is the number of the base name we want from NAME_TABLE.
6518 MODIFIERS is a set of modifier bits (as given in struct input_events)
6519 whose prefixes should be applied to the symbol name.
6521 SYMBOL_KIND is the value to be placed in the event_kind property of
6522 the returned symbol.
6524 The symbols we create are supposed to have an
6525 `event-symbol-elements' property, which lists the modifiers present
6526 in the symbol's name. */
6529 modify_event_symbol (ptrdiff_t symbol_num
, int modifiers
, Lisp_Object symbol_kind
,
6530 Lisp_Object name_alist_or_stem
, const char *const *name_table
,
6531 Lisp_Object
*symbol_table
, ptrdiff_t table_size
)
6534 Lisp_Object symbol_int
;
6536 /* Get rid of the "vendor-specific" bit here. */
6537 XSETINT (symbol_int
, symbol_num
& 0xffffff);
6539 /* Is this a request for a valid symbol? */
6540 if (symbol_num
< 0 || symbol_num
>= table_size
)
6543 if (CONSP (*symbol_table
))
6544 value
= Fcdr (assq_no_quit (symbol_int
, *symbol_table
));
6546 /* If *symbol_table doesn't seem to be initialized properly, fix that.
6547 *symbol_table should be a lisp vector TABLE_SIZE elements long,
6548 where the Nth element is the symbol for NAME_TABLE[N], or nil if
6549 we've never used that symbol before. */
6552 if (! VECTORP (*symbol_table
)
6553 || ASIZE (*symbol_table
) != table_size
)
6557 XSETFASTINT (size
, table_size
);
6558 *symbol_table
= Fmake_vector (size
, Qnil
);
6561 value
= AREF (*symbol_table
, symbol_num
);
6564 /* Have we already used this symbol before? */
6567 /* No; let's create it. */
6568 if (CONSP (name_alist_or_stem
))
6569 value
= Fcdr_safe (Fassq (symbol_int
, name_alist_or_stem
));
6570 else if (STRINGP (name_alist_or_stem
))
6573 ptrdiff_t len
= (SBYTES (name_alist_or_stem
)
6574 + sizeof "-" + INT_STRLEN_BOUND (EMACS_INT
));
6576 buf
= SAFE_ALLOCA (len
);
6577 esprintf (buf
, "%s-%"pI
"d", SDATA (name_alist_or_stem
),
6578 XINT (symbol_int
) + 1);
6579 value
= intern (buf
);
6582 else if (name_table
!= 0 && name_table
[symbol_num
])
6583 value
= intern (name_table
[symbol_num
]);
6585 #ifdef HAVE_WINDOW_SYSTEM
6588 char *name
= x_get_keysym_name (symbol_num
);
6590 value
= intern (name
);
6596 char buf
[sizeof "key-" + INT_STRLEN_BOUND (EMACS_INT
)];
6597 sprintf (buf
, "key-%"pD
"d", symbol_num
);
6598 value
= intern (buf
);
6601 if (CONSP (*symbol_table
))
6602 *symbol_table
= Fcons (Fcons (symbol_int
, value
), *symbol_table
);
6604 ASET (*symbol_table
, symbol_num
, value
);
6606 /* Fill in the cache entries for this symbol; this also
6607 builds the Qevent_symbol_elements property, which the user
6609 apply_modifiers (modifiers
& click_modifier
, value
);
6610 Fput (value
, Qevent_kind
, symbol_kind
);
6613 /* Apply modifiers to that symbol. */
6614 return apply_modifiers (modifiers
, value
);
6617 /* Convert a list that represents an event type,
6618 such as (ctrl meta backspace), into the usual representation of that
6619 event type as a number or a symbol. */
6621 DEFUN ("event-convert-list", Fevent_convert_list
, Sevent_convert_list
, 1, 1, 0,
6622 doc
: /* Convert the event description list EVENT-DESC to an event type.
6623 EVENT-DESC should contain one base event type (a character or symbol)
6624 and zero or more modifier names (control, meta, hyper, super, shift, alt,
6625 drag, down, double or triple). The base must be last.
6626 The return value is an event type (a character or symbol) which
6627 has the same base event type and all the specified modifiers. */)
6628 (Lisp_Object event_desc
)
6636 while (CONSP (rest
))
6644 /* Given a symbol, see if it is a modifier name. */
6645 if (SYMBOLP (elt
) && CONSP (rest
))
6646 this = parse_solitary_modifier (elt
);
6650 else if (!NILP (base
))
6651 error ("Two bases given in one event");
6657 /* Let the symbol A refer to the character A. */
6658 if (SYMBOLP (base
) && SCHARS (SYMBOL_NAME (base
)) == 1)
6659 XSETINT (base
, SREF (SYMBOL_NAME (base
), 0));
6661 if (INTEGERP (base
))
6663 /* Turn (shift a) into A. */
6664 if ((modifiers
& shift_modifier
) != 0
6665 && (XINT (base
) >= 'a' && XINT (base
) <= 'z'))
6667 XSETINT (base
, XINT (base
) - ('a' - 'A'));
6668 modifiers
&= ~shift_modifier
;
6671 /* Turn (control a) into C-a. */
6672 if (modifiers
& ctrl_modifier
)
6673 return make_number ((modifiers
& ~ctrl_modifier
)
6674 | make_ctrl_char (XINT (base
)));
6676 return make_number (modifiers
| XINT (base
));
6678 else if (SYMBOLP (base
))
6679 return apply_modifiers (modifiers
, base
);
6681 error ("Invalid base event");
6684 /* Try to recognize SYMBOL as a modifier name.
6685 Return the modifier flag bit, or 0 if not recognized. */
6688 parse_solitary_modifier (Lisp_Object symbol
)
6690 Lisp_Object name
= SYMBOL_NAME (symbol
);
6692 switch (SREF (name
, 0))
6694 #define SINGLE_LETTER_MOD(BIT) \
6695 if (SBYTES (name) == 1) \
6698 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6699 if (LEN == SBYTES (name) \
6700 && ! memcmp (SDATA (name), NAME, LEN)) \
6704 SINGLE_LETTER_MOD (alt_modifier
);
6708 MULTI_LETTER_MOD (alt_modifier
, "alt", 3);
6712 SINGLE_LETTER_MOD (ctrl_modifier
);
6716 MULTI_LETTER_MOD (ctrl_modifier
, "ctrl", 4);
6717 MULTI_LETTER_MOD (ctrl_modifier
, "control", 7);
6721 SINGLE_LETTER_MOD (hyper_modifier
);
6725 MULTI_LETTER_MOD (hyper_modifier
, "hyper", 5);
6729 SINGLE_LETTER_MOD (meta_modifier
);
6733 MULTI_LETTER_MOD (meta_modifier
, "meta", 4);
6737 SINGLE_LETTER_MOD (shift_modifier
);
6741 MULTI_LETTER_MOD (shift_modifier
, "shift", 5);
6742 MULTI_LETTER_MOD (super_modifier
, "super", 5);
6743 SINGLE_LETTER_MOD (super_modifier
);
6747 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
6748 MULTI_LETTER_MOD (down_modifier
, "down", 4);
6749 MULTI_LETTER_MOD (double_modifier
, "double", 6);
6753 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
6756 #undef SINGLE_LETTER_MOD
6757 #undef MULTI_LETTER_MOD
6763 /* Return true if EVENT is a list whose elements are all integers or symbols.
6764 Such a list is not valid as an event,
6765 but it can be a Lucid-style event type list. */
6768 lucid_event_type_list_p (Lisp_Object object
)
6772 if (! CONSP (object
))
6775 if (EQ (XCAR (object
), Qhelp_echo
)
6776 || EQ (XCAR (object
), Qvertical_line
)
6777 || EQ (XCAR (object
), Qmode_line
)
6778 || EQ (XCAR (object
), Qheader_line
))
6781 for (tail
= object
; CONSP (tail
); tail
= XCDR (tail
))
6785 if (! (INTEGERP (elt
) || SYMBOLP (elt
)))
6792 /* Return true if terminal input chars are available.
6793 Also, store the return value into INPUT_PENDING.
6795 Serves the purpose of ioctl (0, FIONREAD, ...)
6796 but works even if FIONREAD does not exist.
6797 (In fact, this may actually read some input.)
6799 If READABLE_EVENTS_DO_TIMERS_NOW is set in FLAGS, actually run
6800 timer events that are ripe.
6801 If READABLE_EVENTS_FILTER_EVENTS is set in FLAGS, ignore internal
6802 events (FOCUS_IN_EVENT).
6803 If READABLE_EVENTS_IGNORE_SQUEEZABLES is set in FLAGS, ignore mouse
6804 movements and toolkit scroll bar thumb drags. */
6807 get_input_pending (int flags
)
6809 /* First of all, have we already counted some input? */
6810 input_pending
= (!NILP (Vquit_flag
) || readable_events (flags
));
6812 /* If input is being read as it arrives, and we have none, there is none. */
6813 if (!input_pending
&& (!interrupt_input
|| interrupts_deferred
))
6815 /* Try to read some input and see how much we get. */
6817 input_pending
= (!NILP (Vquit_flag
) || readable_events (flags
));
6820 return input_pending
;
6823 /* Put a BUFFER_SWITCH_EVENT in the buffer
6824 so that read_key_sequence will notice the new current buffer. */
6827 record_asynch_buffer_change (void)
6829 /* We don't need a buffer-switch event unless Emacs is waiting for input.
6830 The purpose of the event is to make read_key_sequence look up the
6831 keymaps again. If we aren't in read_key_sequence, we don't need one,
6832 and the event could cause trouble by messing up (input-pending-p).
6833 Note: Fwaiting_for_user_input_p always returns nil when async
6834 subprocesses aren't supported. */
6835 if (!NILP (Fwaiting_for_user_input_p ()))
6837 struct input_event event
;
6840 event
.kind
= BUFFER_SWITCH_EVENT
;
6841 event
.frame_or_window
= Qnil
;
6844 /* Make sure no interrupt happens while storing the event. */
6846 if (interrupt_input
)
6847 kbd_buffer_store_event (&event
);
6852 kbd_buffer_store_event (&event
);
6858 /* Read any terminal input already buffered up by the system
6859 into the kbd_buffer, but do not wait.
6861 Return the number of keyboard chars read, or -1 meaning
6862 this is a bad time to try to read input. */
6871 /* Store pending user signal events, if any. */
6872 store_user_signal_events ();
6874 /* Loop through the available terminals, and call their input hooks. */
6878 struct terminal
*next
= t
->next_terminal
;
6880 if (t
->read_socket_hook
)
6883 struct input_event hold_quit
;
6885 if (input_blocked_p ())
6887 pending_signals
= 1;
6891 EVENT_INIT (hold_quit
);
6892 hold_quit
.kind
= NO_EVENT
;
6894 /* No need for FIONREAD or fcntl; just say don't wait. */
6895 while ((nr
= (*t
->read_socket_hook
) (t
, &hold_quit
)) > 0)
6898 if (nr
== -1) /* Not OK to read input now. */
6902 else if (nr
== -2) /* Non-transient error. */
6904 /* The terminal device terminated; it should be closed. */
6906 /* Kill Emacs if this was our last terminal. */
6907 if (!terminal_list
->next_terminal
)
6908 /* Formerly simply reported no input, but that
6909 sometimes led to a failure of Emacs to terminate.
6910 SIGHUP seems appropriate if we can't reach the
6912 /* ??? Is it really right to send the signal just to
6913 this process rather than to the whole process
6914 group? Perhaps on systems with FIONREAD Emacs is
6915 alone in its group. */
6916 terminate_due_to_signal (SIGHUP
, 10);
6918 /* XXX Is calling delete_terminal safe here? It calls delete_frame. */
6921 XSETTERMINAL (tmp
, t
);
6922 Fdelete_terminal (tmp
, Qnoelisp
);
6926 /* If there was no error, make sure the pointer
6927 is visible for all frames on this terminal. */
6930 Lisp_Object tail
, frame
;
6932 FOR_EACH_FRAME (tail
, frame
)
6934 struct frame
*f
= XFRAME (frame
);
6935 if (FRAME_TERMINAL (f
) == t
)
6936 frame_make_pointer_visible (f
);
6940 if (hold_quit
.kind
!= NO_EVENT
)
6941 kbd_buffer_store_event (&hold_quit
);
6953 /* This is the tty way of reading available input.
6955 Note that each terminal device has its own `struct terminal' object,
6956 and so this function is called once for each individual termcap
6957 terminal. The first parameter indicates which terminal to read from. */
6960 tty_read_avail_input (struct terminal
*terminal
,
6961 struct input_event
*hold_quit
)
6963 /* Using KBD_BUFFER_SIZE - 1 here avoids reading more than
6964 the kbd_buffer can really hold. That may prevent loss
6965 of characters on some systems when input is stuffed at us. */
6966 unsigned char cbuf
[KBD_BUFFER_SIZE
- 1];
6968 struct tty_display_info
*tty
= terminal
->display_info
.tty
;
6971 int buffer_free
= KBD_BUFFER_SIZE
- kbd_buffer_nr_stored () - 1;
6973 if (kbd_on_hold_p () || buffer_free
<= 0)
6975 #endif /* subprocesses */
6977 if (!terminal
->name
) /* Don't read from a dead terminal. */
6980 if (terminal
->type
!= output_termcap
6981 && terminal
->type
!= output_msdos_raw
)
6984 /* XXX I think the following code should be moved to separate hook
6985 functions in system-dependent files. */
6987 /* FIXME: AFAIK, tty_read_avail_input is not used under w32 since the non-GUI
6988 code sets read_socket_hook to w32_console_read_socket instead! */
6990 #else /* not WINDOWSNT */
6991 if (! tty
->term_initted
) /* In case we get called during bootstrap. */
6995 return 0; /* The terminal is suspended. */
6998 n_to_read
= dos_keysns ();
7002 cbuf
[0] = dos_keyread ();
7005 #else /* not MSDOS */
7010 struct input_event gpm_hold_quit
;
7011 int gpm
, fd
= gpm_fd
;
7013 EVENT_INIT (gpm_hold_quit
);
7014 gpm_hold_quit
.kind
= NO_EVENT
;
7016 /* gpm==1 if event received.
7017 gpm==0 if the GPM daemon has closed the connection, in which case
7018 Gpm_GetEvent closes gpm_fd and clears it to -1, which is why
7019 we save it in `fd' so close_gpm can remove it from the
7021 gpm==-1 if a protocol error or EWOULDBLOCK; the latter is normal. */
7022 while (gpm
= Gpm_GetEvent (&event
), gpm
== 1) {
7023 nread
+= handle_one_term_event (tty
, &event
, &gpm_hold_quit
);
7026 /* Presumably the GPM daemon has closed the connection. */
7028 if (gpm_hold_quit
.kind
!= NO_EVENT
)
7029 kbd_buffer_store_event (&gpm_hold_quit
);
7033 #endif /* HAVE_GPM */
7035 /* Determine how many characters we should *try* to read. */
7036 #ifdef USABLE_FIONREAD
7037 /* Find out how much input is available. */
7038 if (ioctl (fileno (tty
->input
), FIONREAD
, &n_to_read
) < 0)
7040 if (! noninteractive
)
7041 return -2; /* Close this terminal. */
7047 if (n_to_read
> sizeof cbuf
)
7048 n_to_read
= sizeof cbuf
;
7049 #elif defined USG || defined CYGWIN
7050 /* Read some input if available, but don't wait. */
7051 n_to_read
= sizeof cbuf
;
7052 fcntl (fileno (tty
->input
), F_SETFL
, O_NONBLOCK
);
7054 # error "Cannot read without possibly delaying"
7058 /* Don't read more than we can store. */
7059 if (n_to_read
> buffer_free
)
7060 n_to_read
= buffer_free
;
7061 #endif /* subprocesses */
7063 /* Now read; for one reason or another, this will not block.
7064 NREAD is set to the number of chars read. */
7067 nread
= emacs_read (fileno (tty
->input
), (char *) cbuf
, n_to_read
);
7068 /* POSIX infers that processes which are not in the session leader's
7069 process group won't get SIGHUPs at logout time. BSDI adheres to
7070 this part standard and returns -1 from read (0) with errno==EIO
7071 when the control tty is taken away.
7072 Jeffrey Honig <jch@bsdi.com> says this is generally safe. */
7073 if (nread
== -1 && errno
== EIO
)
7074 return -2; /* Close this terminal. */
7075 #if defined (AIX) && defined (_BSD)
7076 /* The kernel sometimes fails to deliver SIGHUP for ptys.
7077 This looks incorrect, but it isn't, because _BSD causes
7078 O_NDELAY to be defined in fcntl.h as O_NONBLOCK,
7079 and that causes a value other than 0 when there is no input. */
7081 return -2; /* Close this terminal. */
7085 /* We used to retry the read if it was interrupted.
7086 But this does the wrong thing when O_NONBLOCK causes
7087 an EAGAIN error. Does anybody know of a situation
7088 where a retry is actually needed? */
7090 nread
< 0 && (errno
== EAGAIN
|| errno
== EFAULT
7100 #ifndef USABLE_FIONREAD
7101 #if defined (USG) || defined (CYGWIN)
7102 fcntl (fileno (tty
->input
), F_SETFL
, 0);
7103 #endif /* USG or CYGWIN */
7104 #endif /* no FIONREAD */
7109 #endif /* not MSDOS */
7110 #endif /* not WINDOWSNT */
7112 for (i
= 0; i
< nread
; i
++)
7114 struct input_event buf
;
7116 buf
.kind
= ASCII_KEYSTROKE_EVENT
;
7118 if (tty
->meta_key
== 1 && (cbuf
[i
] & 0x80))
7119 buf
.modifiers
= meta_modifier
;
7120 if (tty
->meta_key
!= 2)
7124 /* Set the frame corresponding to the active tty. Note that the
7125 value of selected_frame is not reliable here, redisplay tends
7126 to temporarily change it. */
7127 buf
.frame_or_window
= tty
->top_frame
;
7130 kbd_buffer_store_event (&buf
);
7131 /* Don't look at input that follows a C-g too closely.
7132 This reduces lossage due to autorepeat on C-g. */
7133 if (buf
.kind
== ASCII_KEYSTROKE_EVENT
7134 && buf
.code
== quit_char
)
7142 handle_async_input (void)
7147 int nread
= gobble_input ();
7148 /* -1 means it's not ok to read the input now.
7149 UNBLOCK_INPUT will read it later; now, avoid infinite loop.
7150 0 means there was no keyboard input available. */
7158 process_pending_signals (void)
7160 pending_signals
= 0;
7161 handle_async_input ();
7162 do_pending_atimers ();
7165 /* Undo any number of BLOCK_INPUT calls down to level LEVEL,
7166 and reinvoke any pending signal if the level is now 0 and
7167 a fatal error is not already in progress. */
7170 unblock_input_to (int level
)
7172 interrupt_input_blocked
= level
;
7175 if (pending_signals
&& !fatal_error_in_progress
)
7176 process_pending_signals ();
7182 /* End critical section.
7184 If doing signal-driven input, and a signal came in when input was
7185 blocked, reinvoke the signal handler now to deal with it.
7187 It will also process queued input, if it was not read before.
7188 When a longer code sequence does not use block/unblock input
7189 at all, the whole input gathered up to the next call to
7190 unblock_input will be processed inside that call. */
7193 unblock_input (void)
7195 unblock_input_to (interrupt_input_blocked
- 1);
7198 /* Undo any number of BLOCK_INPUT calls,
7199 and also reinvoke any pending signal. */
7202 totally_unblock_input (void)
7204 unblock_input_to (0);
7210 handle_input_available_signal (int sig
)
7212 pending_signals
= 1;
7214 if (input_available_clear_time
)
7215 *input_available_clear_time
= make_timespec (0, 0);
7219 deliver_input_available_signal (int sig
)
7221 deliver_process_signal (sig
, handle_input_available_signal
);
7223 #endif /* USABLE_SIGIO */
7226 /* User signal events. */
7228 struct user_signal_info
7230 /* Signal number. */
7233 /* Name of the signal. */
7236 /* Number of pending signals. */
7239 struct user_signal_info
*next
;
7242 /* List of user signals. */
7243 static struct user_signal_info
*user_signals
= NULL
;
7246 add_user_signal (int sig
, const char *name
)
7248 struct sigaction action
;
7249 struct user_signal_info
*p
;
7251 for (p
= user_signals
; p
; p
= p
->next
)
7253 /* Already added. */
7256 p
= xmalloc (sizeof *p
);
7258 p
->name
= xstrdup (name
);
7260 p
->next
= user_signals
;
7263 emacs_sigaction_init (&action
, deliver_user_signal
);
7264 sigaction (sig
, &action
, 0);
7268 handle_user_signal (int sig
)
7270 struct user_signal_info
*p
;
7271 const char *special_event_name
= NULL
;
7273 if (SYMBOLP (Vdebug_on_event
))
7274 special_event_name
= SSDATA (SYMBOL_NAME (Vdebug_on_event
));
7276 for (p
= user_signals
; p
; p
= p
->next
)
7279 if (special_event_name
7280 && strcmp (special_event_name
, p
->name
) == 0)
7282 /* Enter the debugger in many ways. */
7283 debug_on_next_call
= 1;
7286 Vinhibit_quit
= Qnil
;
7288 /* Eat the event. */
7294 if (interrupt_input
)
7295 handle_input_available_signal (sig
);
7299 /* Tell wait_reading_process_output that it needs to wake
7300 up and look around. */
7301 if (input_available_clear_time
)
7302 *input_available_clear_time
= make_timespec (0, 0);
7309 deliver_user_signal (int sig
)
7311 deliver_process_signal (sig
, handle_user_signal
);
7315 find_user_signal_name (int sig
)
7317 struct user_signal_info
*p
;
7319 for (p
= user_signals
; p
; p
= p
->next
)
7327 store_user_signal_events (void)
7329 struct user_signal_info
*p
;
7330 struct input_event buf
;
7331 bool buf_initialized
= 0;
7333 for (p
= user_signals
; p
; p
= p
->next
)
7334 if (p
->npending
> 0)
7336 if (! buf_initialized
)
7338 memset (&buf
, 0, sizeof buf
);
7339 buf
.kind
= USER_SIGNAL_EVENT
;
7340 buf
.frame_or_window
= selected_frame
;
7341 buf_initialized
= 1;
7347 kbd_buffer_store_event (&buf
);
7350 while (p
->npending
> 0);
7355 static void menu_bar_item (Lisp_Object
, Lisp_Object
, Lisp_Object
, void *);
7356 static Lisp_Object menu_bar_one_keymap_changed_items
;
7358 /* These variables hold the vector under construction within
7359 menu_bar_items and its subroutines, and the current index
7360 for storing into that vector. */
7361 static Lisp_Object menu_bar_items_vector
;
7362 static int menu_bar_items_index
;
7365 static const char *separator_names
[] = {
7370 "single-dashed-line",
7371 "double-dashed-line",
7373 "shadow-etched-out",
7374 "shadow-etched-in-dash",
7375 "shadow-etched-out-dash",
7376 "shadow-double-etched-in",
7377 "shadow-double-etched-out",
7378 "shadow-double-etched-in-dash",
7379 "shadow-double-etched-out-dash",
7383 /* Return true if LABEL specifies a separator. */
7386 menu_separator_name_p (const char *label
)
7390 else if (strlen (label
) > 3
7391 && memcmp (label
, "--", 2) == 0
7396 for (i
= 0; separator_names
[i
]; ++i
)
7397 if (strcmp (label
, separator_names
[i
]) == 0)
7402 /* It's a separator if it contains only dashes. */
7403 while (*label
== '-')
7405 return (*label
== 0);
7412 /* Return a vector of menu items for a menu bar, appropriate
7413 to the current buffer. Each item has three elements in the vector:
7416 OLD is an old vector we can optionally reuse, or nil. */
7419 menu_bar_items (Lisp_Object old
)
7421 /* The number of keymaps we're scanning right now, and the number of
7422 keymaps we have allocated space for. */
7425 /* maps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
7426 in the current keymaps, or nil where it is not a prefix. */
7429 Lisp_Object mapsbuf
[3];
7430 Lisp_Object def
, tail
;
7437 /* In order to build the menus, we need to call the keymap
7438 accessors. They all call QUIT. But this function is called
7439 during redisplay, during which a quit is fatal. So inhibit
7440 quitting while building the menus.
7441 We do this instead of specbind because (1) errors will clear it anyway
7442 and (2) this avoids risk of specpdl overflow. */
7443 oquit
= Vinhibit_quit
;
7447 menu_bar_items_vector
= old
;
7449 menu_bar_items_vector
= Fmake_vector (make_number (24), Qnil
);
7450 menu_bar_items_index
= 0;
7452 /* Build our list of keymaps.
7453 If we recognize a function key and replace its escape sequence in
7454 keybuf with its symbol, or if the sequence starts with a mouse
7455 click and we need to switch buffers, we jump back here to rebuild
7456 the initial keymaps from the current buffer. */
7460 /* Should overriding-terminal-local-map and overriding-local-map apply? */
7461 if (!NILP (Voverriding_local_map_menu_flag
)
7462 && !NILP (Voverriding_local_map
))
7464 /* Yes, use them (if non-nil) as well as the global map. */
7467 if (!NILP (KVAR (current_kboard
, Voverriding_terminal_local_map
)))
7468 maps
[nmaps
++] = KVAR (current_kboard
, Voverriding_terminal_local_map
);
7469 if (!NILP (Voverriding_local_map
))
7470 maps
[nmaps
++] = Voverriding_local_map
;
7474 /* No, so use major and minor mode keymaps and keymap property.
7475 Note that menu-bar bindings in the local-map and keymap
7476 properties may not work reliable, as they are only
7477 recognized when the menu-bar (or mode-line) is updated,
7478 which does not normally happen after every command. */
7481 nminor
= current_minor_maps (NULL
, &tmaps
);
7482 SAFE_NALLOCA (maps
, 1, nminor
+ 4);
7484 tem
= KVAR (current_kboard
, Voverriding_terminal_local_map
);
7485 if (!NILP (tem
) && !NILP (Voverriding_local_map_menu_flag
))
7486 maps
[nmaps
++] = tem
;
7487 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
7488 maps
[nmaps
++] = tem
;
7489 memcpy (maps
+ nmaps
, tmaps
, nminor
* sizeof (maps
[0]));
7491 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
7493 maps
[nmaps
++] = current_global_map
;
7496 /* Look up in each map the dummy prefix key `menu-bar'. */
7498 for (mapno
= nmaps
- 1; mapno
>= 0; mapno
--)
7499 if (!NILP (maps
[mapno
]))
7501 def
= get_keymap (access_keymap (maps
[mapno
], Qmenu_bar
, 1, 0, 1),
7505 menu_bar_one_keymap_changed_items
= Qnil
;
7506 map_keymap_canonical (def
, menu_bar_item
, Qnil
, NULL
);
7510 /* Move to the end those items that should be at the end. */
7512 for (tail
= Vmenu_bar_final_items
; CONSP (tail
); tail
= XCDR (tail
))
7515 int end
= menu_bar_items_index
;
7517 for (i
= 0; i
< end
; i
+= 4)
7518 if (EQ (XCAR (tail
), AREF (menu_bar_items_vector
, i
)))
7520 Lisp_Object tem0
, tem1
, tem2
, tem3
;
7521 /* Move the item at index I to the end,
7522 shifting all the others forward. */
7523 tem0
= AREF (menu_bar_items_vector
, i
+ 0);
7524 tem1
= AREF (menu_bar_items_vector
, i
+ 1);
7525 tem2
= AREF (menu_bar_items_vector
, i
+ 2);
7526 tem3
= AREF (menu_bar_items_vector
, i
+ 3);
7528 memmove (aref_addr (menu_bar_items_vector
, i
),
7529 aref_addr (menu_bar_items_vector
, i
+ 4),
7530 (end
- i
- 4) * word_size
);
7531 ASET (menu_bar_items_vector
, end
- 4, tem0
);
7532 ASET (menu_bar_items_vector
, end
- 3, tem1
);
7533 ASET (menu_bar_items_vector
, end
- 2, tem2
);
7534 ASET (menu_bar_items_vector
, end
- 1, tem3
);
7539 /* Add nil, nil, nil, nil at the end. */
7541 int i
= menu_bar_items_index
;
7542 if (i
+ 4 > ASIZE (menu_bar_items_vector
))
7543 menu_bar_items_vector
7544 = larger_vector (menu_bar_items_vector
, 4, -1);
7545 /* Add this item. */
7546 ASET (menu_bar_items_vector
, i
, Qnil
); i
++;
7547 ASET (menu_bar_items_vector
, i
, Qnil
); i
++;
7548 ASET (menu_bar_items_vector
, i
, Qnil
); i
++;
7549 ASET (menu_bar_items_vector
, i
, Qnil
); i
++;
7550 menu_bar_items_index
= i
;
7553 Vinhibit_quit
= oquit
;
7555 return menu_bar_items_vector
;
7558 /* Add one item to menu_bar_items_vector, for KEY, ITEM_STRING and DEF.
7559 If there's already an item for KEY, add this DEF to it. */
7561 Lisp_Object item_properties
;
7564 menu_bar_item (Lisp_Object key
, Lisp_Object item
, Lisp_Object dummy1
, void *dummy2
)
7566 struct gcpro gcpro1
;
7571 if (EQ (item
, Qundefined
))
7573 /* If a map has an explicit `undefined' as definition,
7574 discard any previously made menu bar item. */
7576 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7577 if (EQ (key
, AREF (menu_bar_items_vector
, i
)))
7579 if (menu_bar_items_index
> i
+ 4)
7580 memmove (aref_addr (menu_bar_items_vector
, i
),
7581 aref_addr (menu_bar_items_vector
, i
+ 4),
7582 (menu_bar_items_index
- i
- 4) * word_size
);
7583 menu_bar_items_index
-= 4;
7587 /* If this keymap has already contributed to this KEY,
7588 don't contribute to it a second time. */
7589 tem
= Fmemq (key
, menu_bar_one_keymap_changed_items
);
7590 if (!NILP (tem
) || NILP (item
))
7593 menu_bar_one_keymap_changed_items
7594 = Fcons (key
, menu_bar_one_keymap_changed_items
);
7596 /* We add to menu_bar_one_keymap_changed_items before doing the
7597 parse_menu_item, so that if it turns out it wasn't a menu item,
7598 it still correctly hides any further menu item. */
7600 parsed
= parse_menu_item (item
, 1);
7605 item
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7607 /* Find any existing item for this KEY. */
7608 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7609 if (EQ (key
, AREF (menu_bar_items_vector
, i
)))
7612 /* If we did not find this KEY, add it at the end. */
7613 if (i
== menu_bar_items_index
)
7615 /* If vector is too small, get a bigger one. */
7616 if (i
+ 4 > ASIZE (menu_bar_items_vector
))
7617 menu_bar_items_vector
= larger_vector (menu_bar_items_vector
, 4, -1);
7618 /* Add this item. */
7619 ASET (menu_bar_items_vector
, i
, key
); i
++;
7620 ASET (menu_bar_items_vector
, i
,
7621 AREF (item_properties
, ITEM_PROPERTY_NAME
)); i
++;
7622 ASET (menu_bar_items_vector
, i
, list1 (item
)); i
++;
7623 ASET (menu_bar_items_vector
, i
, make_number (0)); i
++;
7624 menu_bar_items_index
= i
;
7626 /* We did find an item for this KEY. Add ITEM to its list of maps. */
7630 old
= AREF (menu_bar_items_vector
, i
+ 2);
7631 /* If the new and the old items are not both keymaps,
7632 the lookup will only find `item'. */
7633 item
= Fcons (item
, KEYMAPP (item
) && KEYMAPP (XCAR (old
)) ? old
: Qnil
);
7634 ASET (menu_bar_items_vector
, i
+ 2, item
);
7638 /* This is used as the handler when calling menu_item_eval_property. */
7640 menu_item_eval_property_1 (Lisp_Object arg
)
7642 /* If we got a quit from within the menu computation,
7643 quit all the way out of it. This takes care of C-] in the debugger. */
7644 if (CONSP (arg
) && EQ (XCAR (arg
), Qquit
))
7645 Fsignal (Qquit
, Qnil
);
7651 eval_dyn (Lisp_Object form
)
7653 return Feval (form
, Qnil
);
7656 /* Evaluate an expression and return the result (or nil if something
7657 went wrong). Used to evaluate dynamic parts of menu items. */
7659 menu_item_eval_property (Lisp_Object sexpr
)
7661 ptrdiff_t count
= SPECPDL_INDEX ();
7663 specbind (Qinhibit_redisplay
, Qt
);
7664 val
= internal_condition_case_1 (eval_dyn
, sexpr
, Qerror
,
7665 menu_item_eval_property_1
);
7666 return unbind_to (count
, val
);
7669 /* This function parses a menu item and leaves the result in the
7670 vector item_properties.
7671 ITEM is a key binding, a possible menu item.
7672 INMENUBAR is > 0 when this is considered for an entry in a menu bar
7674 INMENUBAR is < 0 when this is considered for an entry in a keyboard menu.
7675 parse_menu_item returns true if the item is a menu item and false
7679 parse_menu_item (Lisp_Object item
, int inmenubar
)
7681 Lisp_Object def
, tem
, item_string
, start
;
7683 Lisp_Object keyhint
;
7692 /* Create item_properties vector if necessary. */
7693 if (NILP (item_properties
))
7695 = Fmake_vector (make_number (ITEM_PROPERTY_ENABLE
+ 1), Qnil
);
7697 /* Initialize optional entries. */
7698 for (i
= ITEM_PROPERTY_DEF
; i
< ITEM_PROPERTY_ENABLE
; i
++)
7699 ASET (item_properties
, i
, Qnil
);
7700 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7702 /* Save the item here to protect it from GC. */
7703 ASET (item_properties
, ITEM_PROPERTY_ITEM
, item
);
7705 item_string
= XCAR (item
);
7709 if (STRINGP (item_string
))
7711 /* Old format menu item. */
7712 ASET (item_properties
, ITEM_PROPERTY_NAME
, item_string
);
7714 /* Maybe help string. */
7715 if (CONSP (item
) && STRINGP (XCAR (item
)))
7717 ASET (item_properties
, ITEM_PROPERTY_HELP
, XCAR (item
));
7722 /* Maybe an obsolete key binding cache. */
7723 if (CONSP (item
) && CONSP (XCAR (item
))
7724 && (NILP (XCAR (XCAR (item
)))
7725 || VECTORP (XCAR (XCAR (item
)))))
7728 /* This is the real definition--the function to run. */
7729 ASET (item_properties
, ITEM_PROPERTY_DEF
, item
);
7731 /* Get enable property, if any. */
7734 tem
= Fget (item
, Qmenu_enable
);
7735 if (!NILP (Venable_disabled_menus_and_buttons
))
7736 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7737 else if (!NILP (tem
))
7738 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, tem
);
7741 else if (EQ (item_string
, Qmenu_item
) && CONSP (item
))
7743 /* New format menu item. */
7744 ASET (item_properties
, ITEM_PROPERTY_NAME
, XCAR (item
));
7745 start
= XCDR (item
);
7748 /* We have a real binding. */
7749 ASET (item_properties
, ITEM_PROPERTY_DEF
, XCAR (start
));
7751 item
= XCDR (start
);
7752 /* Is there an obsolete cache list with key equivalences. */
7753 if (CONSP (item
) && CONSP (XCAR (item
)))
7756 /* Parse properties. */
7757 while (CONSP (item
) && CONSP (XCDR (item
)))
7762 if (EQ (tem
, QCenable
))
7764 if (!NILP (Venable_disabled_menus_and_buttons
))
7765 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7767 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, XCAR (item
));
7769 else if (EQ (tem
, QCvisible
))
7771 /* If got a visible property and that evaluates to nil
7772 then ignore this item. */
7773 tem
= menu_item_eval_property (XCAR (item
));
7777 else if (EQ (tem
, QChelp
))
7778 ASET (item_properties
, ITEM_PROPERTY_HELP
, XCAR (item
));
7779 else if (EQ (tem
, QCfilter
))
7781 else if (EQ (tem
, QCkey_sequence
))
7784 if (SYMBOLP (tem
) || STRINGP (tem
) || VECTORP (tem
))
7785 /* Be GC protected. Set keyhint to item instead of tem. */
7788 else if (EQ (tem
, QCkeys
))
7791 if (CONSP (tem
) || STRINGP (tem
))
7792 ASET (item_properties
, ITEM_PROPERTY_KEYEQ
, tem
);
7794 else if (EQ (tem
, QCbutton
) && CONSP (XCAR (item
)))
7799 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
7801 ASET (item_properties
, ITEM_PROPERTY_SELECTED
,
7803 ASET (item_properties
, ITEM_PROPERTY_TYPE
, type
);
7809 else if (inmenubar
|| !NILP (start
))
7813 return 0; /* not a menu item */
7815 /* If item string is not a string, evaluate it to get string.
7816 If we don't get a string, skip this item. */
7817 item_string
= AREF (item_properties
, ITEM_PROPERTY_NAME
);
7818 if (!(STRINGP (item_string
)))
7820 item_string
= menu_item_eval_property (item_string
);
7821 if (!STRINGP (item_string
))
7823 ASET (item_properties
, ITEM_PROPERTY_NAME
, item_string
);
7826 /* If got a filter apply it on definition. */
7827 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7830 def
= menu_item_eval_property (list2 (XCAR (filter
),
7831 list2 (Qquote
, def
)));
7833 ASET (item_properties
, ITEM_PROPERTY_DEF
, def
);
7836 /* Enable or disable selection of item. */
7837 tem
= AREF (item_properties
, ITEM_PROPERTY_ENABLE
);
7840 tem
= menu_item_eval_property (tem
);
7841 if (inmenubar
&& NILP (tem
))
7842 return 0; /* Ignore disabled items in menu bar. */
7843 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, tem
);
7846 /* If we got no definition, this item is just unselectable text which
7847 is OK in a submenu but not in the menubar. */
7849 return (!inmenubar
);
7851 /* See if this is a separate pane or a submenu. */
7852 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7853 tem
= get_keymap (def
, 0, 1);
7854 /* For a subkeymap, just record its details and exit. */
7857 ASET (item_properties
, ITEM_PROPERTY_MAP
, tem
);
7858 ASET (item_properties
, ITEM_PROPERTY_DEF
, tem
);
7862 /* At the top level in the menu bar, do likewise for commands also.
7863 The menu bar does not display equivalent key bindings anyway.
7864 ITEM_PROPERTY_DEF is already set up properly. */
7868 { /* This is a command. See if there is an equivalent key binding. */
7869 Lisp_Object keyeq
= AREF (item_properties
, ITEM_PROPERTY_KEYEQ
);
7870 AUTO_STRING (space_space
, " ");
7872 /* The previous code preferred :key-sequence to :keys, so we
7873 preserve this behavior. */
7874 if (STRINGP (keyeq
) && !CONSP (keyhint
))
7875 keyeq
= concat2 (space_space
, Fsubstitute_command_keys (keyeq
));
7878 Lisp_Object prefix
= keyeq
;
7879 Lisp_Object keys
= Qnil
;
7883 def
= XCAR (prefix
);
7884 prefix
= XCDR (prefix
);
7887 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7889 if (CONSP (keyhint
) && !NILP (XCAR (keyhint
)))
7891 keys
= XCAR (keyhint
);
7892 tem
= Fkey_binding (keys
, Qnil
, Qnil
, Qnil
);
7894 /* We have a suggested key. Is it bound to the command? */
7897 /* If the command is an alias for another
7898 (such as lmenu.el set it up), check if the
7899 original command matches the cached command. */
7901 && EQ (tem
, XSYMBOL (def
)->function
))))
7906 keys
= Fwhere_is_internal (def
, Qnil
, Qt
, Qnil
, Qnil
);
7910 tem
= Fkey_description (keys
, Qnil
);
7913 if (STRINGP (XCAR (prefix
)))
7914 tem
= concat2 (XCAR (prefix
), tem
);
7915 if (STRINGP (XCDR (prefix
)))
7916 tem
= concat2 (tem
, XCDR (prefix
));
7918 keyeq
= concat2 (space_space
, tem
);
7924 /* If we have an equivalent key binding, use that. */
7925 ASET (item_properties
, ITEM_PROPERTY_KEYEQ
, keyeq
);
7928 /* Include this when menu help is implemented.
7929 tem = XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP];
7930 if (!(NILP (tem) || STRINGP (tem)))
7932 tem = menu_item_eval_property (tem);
7935 XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP] = tem;
7939 /* Handle radio buttons or toggle boxes. */
7940 tem
= AREF (item_properties
, ITEM_PROPERTY_SELECTED
);
7942 ASET (item_properties
, ITEM_PROPERTY_SELECTED
,
7943 menu_item_eval_property (tem
));
7950 /***********************************************************************
7952 ***********************************************************************/
7954 /* A vector holding tool bar items while they are parsed in function
7955 tool_bar_items. Each item occupies TOOL_BAR_ITEM_NSCLOTS elements
7958 static Lisp_Object tool_bar_items_vector
;
7960 /* A vector holding the result of parse_tool_bar_item. Layout is like
7961 the one for a single item in tool_bar_items_vector. */
7963 static Lisp_Object tool_bar_item_properties
;
7965 /* Next free index in tool_bar_items_vector. */
7967 static int ntool_bar_items
;
7969 /* Function prototypes. */
7971 static void init_tool_bar_items (Lisp_Object
);
7972 static void process_tool_bar_item (Lisp_Object
, Lisp_Object
, Lisp_Object
,
7974 static bool parse_tool_bar_item (Lisp_Object
, Lisp_Object
);
7975 static void append_tool_bar_item (void);
7978 /* Return a vector of tool bar items for keymaps currently in effect.
7979 Reuse vector REUSE if non-nil. Return in *NITEMS the number of
7980 tool bar items found. */
7983 tool_bar_items (Lisp_Object reuse
, int *nitems
)
7986 Lisp_Object mapsbuf
[3];
7994 /* In order to build the menus, we need to call the keymap
7995 accessors. They all call QUIT. But this function is called
7996 during redisplay, during which a quit is fatal. So inhibit
7997 quitting while building the menus. We do this instead of
7998 specbind because (1) errors will clear it anyway and (2) this
7999 avoids risk of specpdl overflow. */
8000 oquit
= Vinhibit_quit
;
8003 /* Initialize tool_bar_items_vector and protect it from GC. */
8004 init_tool_bar_items (reuse
);
8006 /* Build list of keymaps in maps. Set nmaps to the number of maps
8009 /* Should overriding-terminal-local-map and overriding-local-map apply? */
8010 if (!NILP (Voverriding_local_map_menu_flag
)
8011 && !NILP (Voverriding_local_map
))
8013 /* Yes, use them (if non-nil) as well as the global map. */
8016 if (!NILP (KVAR (current_kboard
, Voverriding_terminal_local_map
)))
8017 maps
[nmaps
++] = KVAR (current_kboard
, Voverriding_terminal_local_map
);
8018 if (!NILP (Voverriding_local_map
))
8019 maps
[nmaps
++] = Voverriding_local_map
;
8023 /* No, so use major and minor mode keymaps and keymap property.
8024 Note that tool-bar bindings in the local-map and keymap
8025 properties may not work reliable, as they are only
8026 recognized when the tool-bar (or mode-line) is updated,
8027 which does not normally happen after every command. */
8030 nminor
= current_minor_maps (NULL
, &tmaps
);
8031 SAFE_NALLOCA (maps
, 1, nminor
+ 4);
8033 tem
= KVAR (current_kboard
, Voverriding_terminal_local_map
);
8034 if (!NILP (tem
) && !NILP (Voverriding_local_map_menu_flag
))
8035 maps
[nmaps
++] = tem
;
8036 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
8037 maps
[nmaps
++] = tem
;
8038 memcpy (maps
+ nmaps
, tmaps
, nminor
* sizeof (maps
[0]));
8040 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
8043 /* Add global keymap at the end. */
8044 maps
[nmaps
++] = current_global_map
;
8046 /* Process maps in reverse order and look up in each map the prefix
8048 for (i
= nmaps
- 1; i
>= 0; --i
)
8049 if (!NILP (maps
[i
]))
8053 keymap
= get_keymap (access_keymap (maps
[i
], Qtool_bar
, 1, 0, 1), 0, 1);
8055 map_keymap (keymap
, process_tool_bar_item
, Qnil
, NULL
, 1);
8058 Vinhibit_quit
= oquit
;
8059 *nitems
= ntool_bar_items
/ TOOL_BAR_ITEM_NSLOTS
;
8061 return tool_bar_items_vector
;
8065 /* Process the definition of KEY which is DEF. */
8068 process_tool_bar_item (Lisp_Object key
, Lisp_Object def
, Lisp_Object data
, void *args
)
8071 struct gcpro gcpro1
, gcpro2
;
8073 /* Protect KEY and DEF from GC because parse_tool_bar_item may call
8077 if (EQ (def
, Qundefined
))
8079 /* If a map has an explicit `undefined' as definition,
8080 discard any previously made item. */
8081 for (i
= 0; i
< ntool_bar_items
; i
+= TOOL_BAR_ITEM_NSLOTS
)
8083 Lisp_Object
*v
= XVECTOR (tool_bar_items_vector
)->contents
+ i
;
8085 if (EQ (key
, v
[TOOL_BAR_ITEM_KEY
]))
8087 if (ntool_bar_items
> i
+ TOOL_BAR_ITEM_NSLOTS
)
8088 memmove (v
, v
+ TOOL_BAR_ITEM_NSLOTS
,
8089 ((ntool_bar_items
- i
- TOOL_BAR_ITEM_NSLOTS
)
8091 ntool_bar_items
-= TOOL_BAR_ITEM_NSLOTS
;
8096 else if (parse_tool_bar_item (key
, def
))
8097 /* Append a new tool bar item to tool_bar_items_vector. Accept
8098 more than one definition for the same key. */
8099 append_tool_bar_item ();
8104 /* Access slot with index IDX of vector tool_bar_item_properties. */
8105 #define PROP(IDX) AREF (tool_bar_item_properties, (IDX))
8107 set_prop (ptrdiff_t idx
, Lisp_Object val
)
8109 ASET (tool_bar_item_properties
, idx
, val
);
8113 /* Parse a tool bar item specification ITEM for key KEY and return the
8114 result in tool_bar_item_properties. Value is false if ITEM is
8117 ITEM is a list `(menu-item CAPTION BINDING PROPS...)'.
8119 CAPTION is the caption of the item, If it's not a string, it is
8120 evaluated to get a string.
8122 BINDING is the tool bar item's binding. Tool-bar items with keymaps
8123 as binding are currently ignored.
8125 The following properties are recognized:
8129 FORM is evaluated and specifies whether the tool bar item is
8130 enabled or disabled.
8134 FORM is evaluated and specifies whether the tool bar item is visible.
8136 - `:filter FUNCTION'
8138 FUNCTION is invoked with one parameter `(quote BINDING)'. Its
8139 result is stored as the new binding.
8141 - `:button (TYPE SELECTED)'
8143 TYPE must be one of `:radio' or `:toggle'. SELECTED is evaluated
8144 and specifies whether the button is selected (pressed) or not.
8148 IMAGES is either a single image specification or a vector of four
8149 image specifications. See enum tool_bar_item_images.
8151 - `:help HELP-STRING'.
8153 Gives a help string to display for the tool bar item.
8155 - `:label LABEL-STRING'.
8157 A text label to show with the tool bar button if labels are enabled. */
8160 parse_tool_bar_item (Lisp_Object key
, Lisp_Object item
)
8162 Lisp_Object filter
= Qnil
;
8163 Lisp_Object caption
;
8165 bool have_label
= 0;
8167 /* Definition looks like `(menu-item CAPTION BINDING PROPS...)'.
8168 Rule out items that aren't lists, don't start with
8169 `menu-item' or whose rest following `tool-bar-item' is not a
8174 /* As an exception, allow old-style menu separators. */
8175 if (STRINGP (XCAR (item
)))
8176 item
= list1 (XCAR (item
));
8177 else if (!EQ (XCAR (item
), Qmenu_item
)
8178 || (item
= XCDR (item
), !CONSP (item
)))
8181 /* Create tool_bar_item_properties vector if necessary. Reset it to
8183 if (VECTORP (tool_bar_item_properties
))
8185 for (i
= 0; i
< TOOL_BAR_ITEM_NSLOTS
; ++i
)
8189 tool_bar_item_properties
8190 = Fmake_vector (make_number (TOOL_BAR_ITEM_NSLOTS
), Qnil
);
8193 set_prop (TOOL_BAR_ITEM_KEY
, key
);
8194 set_prop (TOOL_BAR_ITEM_ENABLED_P
, Qt
);
8196 /* Get the caption of the item. If the caption is not a string,
8197 evaluate it to get a string. If we don't get a string, skip this
8199 caption
= XCAR (item
);
8200 if (!STRINGP (caption
))
8202 caption
= menu_item_eval_property (caption
);
8203 if (!STRINGP (caption
))
8206 set_prop (TOOL_BAR_ITEM_CAPTION
, caption
);
8208 /* If the rest following the caption is not a list, the menu item is
8209 either a separator, or invalid. */
8213 if (menu_separator_name_p (SSDATA (caption
)))
8215 set_prop (TOOL_BAR_ITEM_TYPE
, Qt
);
8216 #if !defined (USE_GTK) && !defined (HAVE_NS)
8217 /* If we use build_desired_tool_bar_string to render the
8218 tool bar, the separator is rendered as an image. */
8219 set_prop (TOOL_BAR_ITEM_IMAGES
,
8220 (menu_item_eval_property
8221 (Vtool_bar_separator_image_expression
)));
8222 set_prop (TOOL_BAR_ITEM_ENABLED_P
, Qnil
);
8223 set_prop (TOOL_BAR_ITEM_SELECTED_P
, Qnil
);
8224 set_prop (TOOL_BAR_ITEM_CAPTION
, Qnil
);
8231 /* Store the binding. */
8232 set_prop (TOOL_BAR_ITEM_BINDING
, XCAR (item
));
8235 /* Ignore cached key binding, if any. */
8236 if (CONSP (item
) && CONSP (XCAR (item
)))
8239 /* Process the rest of the properties. */
8240 for (; CONSP (item
) && CONSP (XCDR (item
)); item
= XCDR (XCDR (item
)))
8242 Lisp_Object ikey
, value
;
8245 value
= XCAR (XCDR (item
));
8247 if (EQ (ikey
, QCenable
))
8249 /* `:enable FORM'. */
8250 if (!NILP (Venable_disabled_menus_and_buttons
))
8251 set_prop (TOOL_BAR_ITEM_ENABLED_P
, Qt
);
8253 set_prop (TOOL_BAR_ITEM_ENABLED_P
, value
);
8255 else if (EQ (ikey
, QCvisible
))
8257 /* `:visible FORM'. If got a visible property and that
8258 evaluates to nil then ignore this item. */
8259 if (NILP (menu_item_eval_property (value
)))
8262 else if (EQ (ikey
, QChelp
))
8263 /* `:help HELP-STRING'. */
8264 set_prop (TOOL_BAR_ITEM_HELP
, value
);
8265 else if (EQ (ikey
, QCvert_only
))
8266 /* `:vert-only t/nil'. */
8267 set_prop (TOOL_BAR_ITEM_VERT_ONLY
, value
);
8268 else if (EQ (ikey
, QClabel
))
8270 const char *bad_label
= "!!?GARBLED ITEM?!!";
8271 /* `:label LABEL-STRING'. */
8272 set_prop (TOOL_BAR_ITEM_LABEL
,
8273 STRINGP (value
) ? value
: build_string (bad_label
));
8276 else if (EQ (ikey
, QCfilter
))
8277 /* ':filter FORM'. */
8279 else if (EQ (ikey
, QCbutton
) && CONSP (value
))
8281 /* `:button (TYPE . SELECTED)'. */
8282 Lisp_Object type
, selected
;
8284 type
= XCAR (value
);
8285 selected
= XCDR (value
);
8286 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
8288 set_prop (TOOL_BAR_ITEM_SELECTED_P
, selected
);
8289 set_prop (TOOL_BAR_ITEM_TYPE
, type
);
8292 else if (EQ (ikey
, QCimage
)
8294 || (VECTORP (value
) && ASIZE (value
) == 4)))
8295 /* Value is either a single image specification or a vector
8296 of 4 such specifications for the different button states. */
8297 set_prop (TOOL_BAR_ITEM_IMAGES
, value
);
8298 else if (EQ (ikey
, QCrtl
))
8300 set_prop (TOOL_BAR_ITEM_RTL_IMAGE
, value
);
8306 /* Try to make one from caption and key. */
8307 Lisp_Object tkey
= PROP (TOOL_BAR_ITEM_KEY
);
8308 Lisp_Object tcapt
= PROP (TOOL_BAR_ITEM_CAPTION
);
8309 const char *label
= SYMBOLP (tkey
) ? SSDATA (SYMBOL_NAME (tkey
)) : "";
8310 const char *capt
= STRINGP (tcapt
) ? SSDATA (tcapt
) : "";
8312 2 * max (0, min (tool_bar_max_label_size
, STRING_BYTES_BOUND
/ 2));
8313 char *buf
= xmalloc (max_lbl
+ 1);
8314 Lisp_Object new_lbl
;
8315 ptrdiff_t caption_len
= strlen (capt
);
8317 if (caption_len
<= max_lbl
&& capt
[0] != '\0')
8320 while (caption_len
> 0 && buf
[caption_len
- 1] == '.')
8322 buf
[caption_len
] = '\0';
8326 if (strlen (label
) <= max_lbl
&& label
[0] != '\0')
8330 strcpy (buf
, label
);
8332 for (j
= 0; buf
[j
] != '\0'; ++j
)
8340 new_lbl
= Fupcase_initials (build_string (label
));
8341 if (SCHARS (new_lbl
) <= tool_bar_max_label_size
)
8342 set_prop (TOOL_BAR_ITEM_LABEL
, new_lbl
);
8344 set_prop (TOOL_BAR_ITEM_LABEL
, empty_unibyte_string
);
8348 /* If got a filter apply it on binding. */
8350 set_prop (TOOL_BAR_ITEM_BINDING
,
8351 (menu_item_eval_property
8354 PROP (TOOL_BAR_ITEM_BINDING
))))));
8356 /* See if the binding is a keymap. Give up if it is. */
8357 if (CONSP (get_keymap (PROP (TOOL_BAR_ITEM_BINDING
), 0, 1)))
8360 /* Enable or disable selection of item. */
8361 if (!EQ (PROP (TOOL_BAR_ITEM_ENABLED_P
), Qt
))
8362 set_prop (TOOL_BAR_ITEM_ENABLED_P
,
8363 menu_item_eval_property (PROP (TOOL_BAR_ITEM_ENABLED_P
)));
8365 /* Handle radio buttons or toggle boxes. */
8366 if (!NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
)))
8367 set_prop (TOOL_BAR_ITEM_SELECTED_P
,
8368 menu_item_eval_property (PROP (TOOL_BAR_ITEM_SELECTED_P
)));
8376 /* Initialize tool_bar_items_vector. REUSE, if non-nil, is a vector
8377 that can be reused. */
8380 init_tool_bar_items (Lisp_Object reuse
)
8382 if (VECTORP (reuse
))
8383 tool_bar_items_vector
= reuse
;
8385 tool_bar_items_vector
= Fmake_vector (make_number (64), Qnil
);
8386 ntool_bar_items
= 0;
8390 /* Append parsed tool bar item properties from
8391 tool_bar_item_properties */
8394 append_tool_bar_item (void)
8398 - (ASIZE (tool_bar_items_vector
) - TOOL_BAR_ITEM_NSLOTS
));
8400 /* Enlarge tool_bar_items_vector if necessary. */
8402 tool_bar_items_vector
= larger_vector (tool_bar_items_vector
, incr
, -1);
8404 /* Append entries from tool_bar_item_properties to the end of
8405 tool_bar_items_vector. */
8406 vcopy (tool_bar_items_vector
, ntool_bar_items
,
8407 XVECTOR (tool_bar_item_properties
)->contents
, TOOL_BAR_ITEM_NSLOTS
);
8408 ntool_bar_items
+= TOOL_BAR_ITEM_NSLOTS
;
8415 /* Read a character using menus based on the keymap MAP.
8416 Return nil if there are no menus in the maps.
8417 Return t if we displayed a menu but the user rejected it.
8419 PREV_EVENT is the previous input event, or nil if we are reading
8420 the first event of a key sequence.
8422 If USED_MOUSE_MENU is non-null, set *USED_MOUSE_MENU to true
8423 if we used a mouse menu to read the input, or false otherwise. If
8424 USED_MOUSE_MENU is null, don't dereference it.
8426 The prompting is done based on the prompt-string of the map
8427 and the strings associated with various map elements.
8429 This can be done with X menus or with menus put in the minibuf.
8430 These are done in different ways, depending on how the input will be read.
8431 Menus using X are done after auto-saving in read-char, getting the input
8432 event from Fx_popup_menu; menus using the minibuf use read_char recursively
8433 and do auto-saving in the inner call of read_char. */
8436 read_char_x_menu_prompt (Lisp_Object map
,
8437 Lisp_Object prev_event
, bool *used_mouse_menu
)
8439 if (used_mouse_menu
)
8440 *used_mouse_menu
= 0;
8442 /* Use local over global Menu maps. */
8444 if (! menu_prompting
)
8447 /* If we got to this point via a mouse click,
8448 use a real menu for mouse selection. */
8449 if (EVENT_HAS_PARAMETERS (prev_event
)
8450 && !EQ (XCAR (prev_event
), Qmenu_bar
)
8451 && !EQ (XCAR (prev_event
), Qtool_bar
))
8453 /* Display the menu and get the selection. */
8456 value
= Fx_popup_menu (prev_event
, get_keymap (map
, 0, 1));
8461 record_menu_key (XCAR (value
));
8463 /* If we got multiple events, unread all but
8465 There is no way to prevent those unread events
8466 from showing up later in last_nonmenu_event.
8467 So turn symbol and integer events into lists,
8468 to indicate that they came from a mouse menu,
8469 so that when present in last_nonmenu_event
8470 they won't confuse things. */
8471 for (tem
= XCDR (value
); CONSP (tem
); tem
= XCDR (tem
))
8473 record_menu_key (XCAR (tem
));
8474 if (SYMBOLP (XCAR (tem
))
8475 || INTEGERP (XCAR (tem
)))
8476 XSETCAR (tem
, Fcons (XCAR (tem
), Qdisabled
));
8479 /* If we got more than one event, put all but the first
8480 onto this list to be read later.
8481 Return just the first event now. */
8482 Vunread_command_events
8483 = nconc2 (XCDR (value
), Vunread_command_events
);
8484 value
= XCAR (value
);
8486 else if (NILP (value
))
8488 if (used_mouse_menu
)
8489 *used_mouse_menu
= 1;
8496 read_char_minibuf_menu_prompt (int commandflag
,
8501 /* FIXME: Use the minibuffer's frame width. */
8502 ptrdiff_t width
= FRAME_COLS (SELECTED_FRAME ()) - 4;
8504 bool nobindings
= 1;
8505 Lisp_Object rest
, vector
;
8506 Lisp_Object prompt_strings
= Qnil
;
8510 if (! menu_prompting
)
8513 map
= get_keymap (map
, 0, 1);
8514 name
= Fkeymap_prompt (map
);
8516 /* If we don't have any menus, just read a character normally. */
8517 if (!STRINGP (name
))
8520 #define PUSH_C_STR(str, listvar) \
8521 listvar = Fcons (build_unibyte_string (str), listvar)
8523 /* Prompt string always starts with map's prompt, and a space. */
8524 prompt_strings
= Fcons (name
, prompt_strings
);
8525 PUSH_C_STR (": ", prompt_strings
);
8526 nlength
= SCHARS (name
) + 2;
8530 /* Present the documented bindings, a line at a time. */
8534 Lisp_Object menu_strings
= prompt_strings
;
8535 ptrdiff_t i
= nlength
;
8537 Lisp_Object orig_defn_macro
;
8539 /* Loop over elements of map. */
8544 /* FIXME: Use map_keymap to handle new keymap formats. */
8546 /* At end of map, wrap around if just starting,
8547 or end this line if already have something on it. */
8550 if (notfirst
|| nobindings
)
8556 /* Look at the next element of the map. */
8558 elt
= AREF (vector
, idx
);
8560 elt
= Fcar_safe (rest
);
8562 if (idx
< 0 && VECTORP (elt
))
8564 /* If we found a dense table in the keymap,
8565 advanced past it, but start scanning its contents. */
8566 rest
= Fcdr_safe (rest
);
8572 /* An ordinary element. */
8573 Lisp_Object event
, tem
;
8577 event
= Fcar_safe (elt
); /* alist */
8578 elt
= Fcdr_safe (elt
);
8582 XSETINT (event
, idx
); /* vector */
8585 /* Ignore the element if it has no prompt string. */
8586 if (INTEGERP (event
) && parse_menu_item (elt
, -1))
8588 /* True if the char to type matches the string. */
8590 Lisp_Object upcased_event
, downcased_event
;
8591 Lisp_Object desc
= Qnil
;
8593 = AREF (item_properties
, ITEM_PROPERTY_NAME
);
8595 upcased_event
= Fupcase (event
);
8596 downcased_event
= Fdowncase (event
);
8597 char_matches
= (XINT (upcased_event
) == SREF (s
, 0)
8598 || XINT (downcased_event
) == SREF (s
, 0));
8600 desc
= Fsingle_key_description (event
, Qnil
);
8602 #if 0 /* It is redundant to list the equivalent key bindings because
8603 the prefix is what the user has already typed. */
8605 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_KEYEQ
];
8607 /* Insert equivalent keybinding. */
8608 s
= concat2 (s
, tem
);
8611 = AREF (item_properties
, ITEM_PROPERTY_TYPE
);
8612 if (EQ (tem
, QCradio
) || EQ (tem
, QCtoggle
))
8614 /* Insert button prefix. */
8615 Lisp_Object selected
8616 = AREF (item_properties
, ITEM_PROPERTY_SELECTED
);
8617 AUTO_STRING (radio_yes
, "(*) ");
8618 AUTO_STRING (radio_no
, "( ) ");
8619 AUTO_STRING (check_yes
, "[X] ");
8620 AUTO_STRING (check_no
, "[ ] ");
8621 if (EQ (tem
, QCradio
))
8622 tem
= NILP (selected
) ? radio_yes
: radio_no
;
8624 tem
= NILP (selected
) ? check_yes
: check_no
;
8625 s
= concat2 (tem
, s
);
8629 /* If we have room for the prompt string, add it to this line.
8630 If this is the first on the line, always add it. */
8631 if ((SCHARS (s
) + i
+ 2
8632 + (char_matches
? 0 : SCHARS (desc
) + 3))
8636 ptrdiff_t thiswidth
;
8638 /* Punctuate between strings. */
8641 PUSH_C_STR (", ", menu_strings
);
8647 /* If the char to type doesn't match the string's
8648 first char, explicitly show what char to type. */
8651 /* Add as much of string as fits. */
8652 thiswidth
= min (SCHARS (desc
), width
- i
);
8654 = Fcons (Fsubstring (desc
, make_number (0),
8655 make_number (thiswidth
)),
8658 PUSH_C_STR (" = ", menu_strings
);
8662 /* Add as much of string as fits. */
8663 thiswidth
= min (SCHARS (s
), width
- i
);
8665 = Fcons (Fsubstring (s
, make_number (0),
8666 make_number (thiswidth
)),
8672 /* If this element does not fit, end the line now,
8673 and save the element for the next line. */
8674 PUSH_C_STR ("...", menu_strings
);
8679 /* Move past this element. */
8680 if (idx
>= 0 && idx
+ 1 >= ASIZE (vector
))
8681 /* Handle reaching end of dense table. */
8686 rest
= Fcdr_safe (rest
);
8690 /* Prompt with that and read response. */
8691 message3_nolog (apply1 (intern ("concat"), Fnreverse (menu_strings
)));
8693 /* Make believe it's not a keyboard macro in case the help char
8694 is pressed. Help characters are not recorded because menu prompting
8695 is not used on replay. */
8696 orig_defn_macro
= KVAR (current_kboard
, defining_kbd_macro
);
8697 kset_defining_kbd_macro (current_kboard
, Qnil
);
8699 obj
= read_char (commandflag
, Qnil
, Qt
, 0, NULL
);
8700 while (BUFFERP (obj
));
8701 kset_defining_kbd_macro (current_kboard
, orig_defn_macro
);
8703 if (!INTEGERP (obj
) || XINT (obj
) == -2)
8706 if (! EQ (obj
, menu_prompt_more_char
)
8707 && (!INTEGERP (menu_prompt_more_char
)
8708 || ! EQ (obj
, make_number (Ctl (XINT (menu_prompt_more_char
))))))
8710 if (!NILP (KVAR (current_kboard
, defining_kbd_macro
)))
8711 store_kbd_macro_char (obj
);
8714 /* Help char - go round again. */
8718 /* Reading key sequences. */
8721 follow_key (Lisp_Object keymap
, Lisp_Object key
)
8723 return access_keymap (get_keymap (keymap
, 0, 1),
8728 active_maps (Lisp_Object first_event
)
8730 Lisp_Object position
8731 = CONSP (first_event
) ? CAR_SAFE (XCDR (first_event
)) : Qnil
;
8732 return Fcons (Qkeymap
, Fcurrent_active_maps (Qt
, position
));
8735 /* Structure used to keep track of partial application of key remapping
8736 such as Vfunction_key_map and Vkey_translation_map. */
8737 typedef struct keyremap
8739 /* This is the map originally specified for this use. */
8741 /* This is a submap reached by looking up, in PARENT,
8742 the events from START to END. */
8744 /* Positions [START, END) in the key sequence buffer
8745 are the key that we have scanned so far.
8746 Those events are the ones that we will replace
8747 if PARENT maps them into a key sequence. */
8751 /* Lookup KEY in MAP.
8752 MAP is a keymap mapping keys to key vectors or functions.
8753 If the mapping is a function and DO_FUNCALL is true,
8754 the function is called with PROMPT as parameter and its return
8755 value is used as the return value of this function (after checking
8756 that it is indeed a vector). */
8759 access_keymap_keyremap (Lisp_Object map
, Lisp_Object key
, Lisp_Object prompt
,
8764 next
= access_keymap (map
, key
, 1, 0, 1);
8766 /* Handle a symbol whose function definition is a keymap
8768 if (SYMBOLP (next
) && !NILP (Ffboundp (next
))
8769 && (ARRAYP (XSYMBOL (next
)->function
)
8770 || KEYMAPP (XSYMBOL (next
)->function
)))
8771 next
= Fautoload_do_load (XSYMBOL (next
)->function
, next
, Qnil
);
8773 /* If the keymap gives a function, not an
8774 array, then call the function with one arg and use
8775 its value instead. */
8776 if (do_funcall
&& FUNCTIONP (next
))
8781 next
= call1 (next
, prompt
);
8782 /* If the function returned something invalid,
8783 barf--don't ignore it.
8784 (To ignore it safely, we would need to gcpro a bunch of
8785 other variables.) */
8786 if (! (NILP (next
) || VECTORP (next
) || STRINGP (next
)))
8787 error ("Function %s returns invalid key sequence",
8788 SSDATA (SYMBOL_NAME (tem
)));
8793 /* Do one step of the key remapping used for function-key-map and
8794 key-translation-map:
8795 KEYBUF is the buffer holding the input events.
8796 BUFSIZE is its maximum size.
8797 FKEY is a pointer to the keyremap structure to use.
8798 INPUT is the index of the last element in KEYBUF.
8799 DOIT if true says that the remapping can actually take place.
8800 DIFF is used to return the number of keys added/removed by the remapping.
8801 PARENT is the root of the keymap.
8802 PROMPT is the prompt to use if the remapping happens through a function.
8803 Return true if the remapping actually took place. */
8806 keyremap_step (Lisp_Object
*keybuf
, int bufsize
, volatile keyremap
*fkey
,
8807 int input
, bool doit
, int *diff
, Lisp_Object prompt
)
8809 Lisp_Object next
, key
;
8811 key
= keybuf
[fkey
->end
++];
8813 if (KEYMAPP (fkey
->parent
))
8814 next
= access_keymap_keyremap (fkey
->map
, key
, prompt
, doit
);
8818 /* If keybuf[fkey->start..fkey->end] is bound in the
8819 map and we're in a position to do the key remapping, replace it with
8820 the binding and restart with fkey->start at the end. */
8821 if ((VECTORP (next
) || STRINGP (next
)) && doit
)
8823 int len
= XFASTINT (Flength (next
));
8826 *diff
= len
- (fkey
->end
- fkey
->start
);
8828 if (bufsize
- input
<= *diff
)
8829 error ("Key sequence too long");
8831 /* Shift the keys that follow fkey->end. */
8833 for (i
= fkey
->end
; i
< input
; i
++)
8834 keybuf
[i
+ *diff
] = keybuf
[i
];
8836 for (i
= input
- 1; i
>= fkey
->end
; i
--)
8837 keybuf
[i
+ *diff
] = keybuf
[i
];
8838 /* Overwrite the old keys with the new ones. */
8839 for (i
= 0; i
< len
; i
++)
8840 keybuf
[fkey
->start
+ i
]
8841 = Faref (next
, make_number (i
));
8843 fkey
->start
= fkey
->end
+= *diff
;
8844 fkey
->map
= fkey
->parent
;
8849 fkey
->map
= get_keymap (next
, 0, 1);
8851 /* If we no longer have a bound suffix, try a new position for
8853 if (!CONSP (fkey
->map
))
8855 fkey
->end
= ++fkey
->start
;
8856 fkey
->map
= fkey
->parent
;
8862 test_undefined (Lisp_Object binding
)
8864 return (NILP (binding
)
8865 || EQ (binding
, Qundefined
)
8866 || (SYMBOLP (binding
)
8867 && EQ (Fcommand_remapping (binding
, Qnil
, Qnil
), Qundefined
)));
8870 /* Read a sequence of keys that ends with a non prefix character,
8871 storing it in KEYBUF, a buffer of size BUFSIZE.
8873 Return the length of the key sequence stored.
8874 Return -1 if the user rejected a command menu.
8876 Echo starting immediately unless `prompt' is 0.
8878 If PREVENT_REDISPLAY is non-zero, avoid redisplay by calling
8879 read_char with a suitable COMMANDFLAG argument.
8881 Where a key sequence ends depends on the currently active keymaps.
8882 These include any minor mode keymaps active in the current buffer,
8883 the current buffer's local map, and the global map.
8885 If a key sequence has no other bindings, we check Vfunction_key_map
8886 to see if some trailing subsequence might be the beginning of a
8887 function key's sequence. If so, we try to read the whole function
8888 key, and substitute its symbolic name into the key sequence.
8890 We ignore unbound `down-' mouse clicks. We turn unbound `drag-' and
8891 `double-' events into similar click events, if that would make them
8892 bound. We try to turn `triple-' events first into `double-' events,
8895 If we get a mouse click in a mode line, vertical divider, or other
8896 non-text area, we treat the click as if it were prefixed by the
8897 symbol denoting that area - `mode-line', `vertical-line', or
8900 If the sequence starts with a mouse click, we read the key sequence
8901 with respect to the buffer clicked on, not the current buffer.
8903 If the user switches frames in the midst of a key sequence, we put
8904 off the switch-frame event until later; the next call to
8905 read_char will return it.
8907 If FIX_CURRENT_BUFFER, we restore current_buffer
8908 from the selected window's buffer. */
8911 read_key_sequence (Lisp_Object
*keybuf
, int bufsize
, Lisp_Object prompt
,
8912 bool dont_downcase_last
, bool can_return_switch_frame
,
8913 bool fix_current_buffer
, bool prevent_redisplay
)
8915 ptrdiff_t count
= SPECPDL_INDEX ();
8917 /* How many keys there are in the current key sequence. */
8920 /* The length of the echo buffer when we started reading, and
8921 the length of this_command_keys when we started reading. */
8922 ptrdiff_t echo_start
IF_LINT (= 0);
8923 ptrdiff_t keys_start
;
8925 Lisp_Object current_binding
= Qnil
;
8926 Lisp_Object first_event
= Qnil
;
8928 /* Index of the first key that has no binding.
8929 It is useless to try fkey.start larger than that. */
8932 /* If t < mock_input, then KEYBUF[t] should be read as the next
8935 We use this to recover after recognizing a function key. Once we
8936 realize that a suffix of the current key sequence is actually a
8937 function key's escape sequence, we replace the suffix with the
8938 function key's binding from Vfunction_key_map. Now keybuf
8939 contains a new and different key sequence, so the echo area,
8940 this_command_keys, and the submaps and defs arrays are wrong. In
8941 this situation, we set mock_input to t, set t to 0, and jump to
8942 restart_sequence; the loop will read keys from keybuf up until
8943 mock_input, thus rebuilding the state; and then it will resume
8944 reading characters from the keyboard. */
8947 /* If the sequence is unbound in submaps[], then
8948 keybuf[fkey.start..fkey.end-1] is a prefix in Vfunction_key_map,
8949 and fkey.map is its binding.
8951 These might be > t, indicating that all function key scanning
8952 should hold off until t reaches them. We do this when we've just
8953 recognized a function key, to avoid searching for the function
8954 key's again in Vfunction_key_map. */
8957 /* Likewise, for key_translation_map and input-decode-map. */
8958 keyremap keytran
, indec
;
8960 /* True if we are trying to map a key by changing an upper-case
8961 letter to lower case, or a shifted function key to an unshifted
8963 bool shift_translated
= 0;
8965 /* If we receive a `switch-frame' or `select-window' event in the middle of
8966 a key sequence, we put it off for later.
8967 While we're reading, we keep the event here. */
8968 Lisp_Object delayed_switch_frame
;
8970 Lisp_Object original_uppercase
IF_LINT (= Qnil
);
8971 int original_uppercase_position
= -1;
8973 /* Gets around Microsoft compiler limitations. */
8976 struct buffer
*starting_buffer
;
8978 /* List of events for which a fake prefix key has been generated. */
8979 Lisp_Object fake_prefixed_keys
= Qnil
;
8981 struct gcpro gcpro1
;
8983 GCPRO1 (fake_prefixed_keys
);
8984 raw_keybuf_count
= 0;
8986 last_nonmenu_event
= Qnil
;
8988 delayed_switch_frame
= Qnil
;
8994 /* Install the string PROMPT as the beginning of the string
8995 of echoing, so that it serves as a prompt for the next
8997 kset_echo_string (current_kboard
, prompt
);
8998 current_kboard
->echo_after_prompt
= SCHARS (prompt
);
9001 else if (cursor_in_echo_area
9002 && echo_keystrokes_p ())
9003 /* This doesn't put in a dash if the echo buffer is empty, so
9004 you don't always see a dash hanging out in the minibuffer. */
9008 /* Record the initial state of the echo area and this_command_keys;
9009 we will need to restore them if we replay a key sequence. */
9011 echo_start
= echo_length ();
9012 keys_start
= this_command_key_count
;
9013 this_single_command_key_start
= keys_start
;
9015 /* We jump here when we need to reinitialize fkey and keytran; this
9016 happens if we switch keyboards between rescans. */
9017 replay_entire_sequence
:
9019 indec
.map
= indec
.parent
= KVAR (current_kboard
, Vinput_decode_map
);
9020 fkey
.map
= fkey
.parent
= KVAR (current_kboard
, Vlocal_function_key_map
);
9021 keytran
.map
= keytran
.parent
= Vkey_translation_map
;
9022 indec
.start
= indec
.end
= 0;
9023 fkey
.start
= fkey
.end
= 0;
9024 keytran
.start
= keytran
.end
= 0;
9026 /* We jump here when the key sequence has been thoroughly changed, and
9027 we need to rescan it starting from the beginning. When we jump here,
9028 keybuf[0..mock_input] holds the sequence we should reread. */
9031 starting_buffer
= current_buffer
;
9032 first_unbound
= bufsize
+ 1;
9034 /* Build our list of keymaps.
9035 If we recognize a function key and replace its escape sequence in
9036 keybuf with its symbol, or if the sequence starts with a mouse
9037 click and we need to switch buffers, we jump back here to rebuild
9038 the initial keymaps from the current buffer. */
9039 current_binding
= active_maps (first_event
);
9041 /* Start from the beginning in keybuf. */
9044 /* These are no-ops the first time through, but if we restart, they
9045 revert the echo area and this_command_keys to their original state. */
9046 this_command_key_count
= keys_start
;
9047 if (INTERACTIVE
&& t
< mock_input
)
9048 echo_truncate (echo_start
);
9050 /* If the best binding for the current key sequence is a keymap, or
9051 we may be looking at a function key's escape sequence, keep on
9053 while (!NILP (current_binding
)
9054 /* Keep reading as long as there's a prefix binding. */
9055 ? KEYMAPP (current_binding
)
9056 /* Don't return in the middle of a possible function key sequence,
9057 if the only bindings we found were via case conversion.
9058 Thus, if ESC O a has a function-key-map translation
9059 and ESC o has a binding, don't return after ESC O,
9060 so that we can translate ESC O plus the next character. */
9061 : (/* indec.start < t || fkey.start < t || */ keytran
.start
< t
))
9064 bool used_mouse_menu
= 0;
9066 /* Where the last real key started. If we need to throw away a
9067 key that has expanded into more than one element of keybuf
9068 (say, a mouse click on the mode line which is being treated
9069 as [mode-line (mouse-...)], then we backtrack to this point
9071 int last_real_key_start
;
9073 /* These variables are analogous to echo_start and keys_start;
9074 while those allow us to restart the entire key sequence,
9075 echo_local_start and keys_local_start allow us to throw away
9077 ptrdiff_t echo_local_start
IF_LINT (= 0);
9078 int keys_local_start
;
9079 Lisp_Object new_binding
;
9081 eassert (indec
.end
== t
|| (indec
.end
> t
&& indec
.end
<= mock_input
));
9082 eassert (indec
.start
<= indec
.end
);
9083 eassert (fkey
.start
<= fkey
.end
);
9084 eassert (keytran
.start
<= keytran
.end
);
9085 /* key-translation-map is applied *after* function-key-map
9086 which is itself applied *after* input-decode-map. */
9087 eassert (fkey
.end
<= indec
.start
);
9088 eassert (keytran
.end
<= fkey
.start
);
9090 if (/* first_unbound < indec.start && first_unbound < fkey.start && */
9091 first_unbound
< keytran
.start
)
9092 { /* The prefix upto first_unbound has no binding and has
9093 no translation left to do either, so we know it's unbound.
9094 If we don't stop now, we risk staying here indefinitely
9095 (if the user keeps entering fkey or keytran prefixes
9096 like C-c ESC ESC ESC ESC ...) */
9098 for (i
= first_unbound
+ 1; i
< t
; i
++)
9099 keybuf
[i
- first_unbound
- 1] = keybuf
[i
];
9100 mock_input
= t
- first_unbound
- 1;
9101 indec
.end
= indec
.start
-= first_unbound
+ 1;
9102 indec
.map
= indec
.parent
;
9103 fkey
.end
= fkey
.start
-= first_unbound
+ 1;
9104 fkey
.map
= fkey
.parent
;
9105 keytran
.end
= keytran
.start
-= first_unbound
+ 1;
9106 keytran
.map
= keytran
.parent
;
9107 goto replay_sequence
;
9111 error ("Key sequence too long");
9114 echo_local_start
= echo_length ();
9115 keys_local_start
= this_command_key_count
;
9118 /* These are no-ops, unless we throw away a keystroke below and
9119 jumped back up to replay_key; in that case, these restore the
9120 variables to their original state, allowing us to replay the
9122 if (INTERACTIVE
&& t
< mock_input
)
9123 echo_truncate (echo_local_start
);
9124 this_command_key_count
= keys_local_start
;
9126 /* By default, assume each event is "real". */
9127 last_real_key_start
= t
;
9129 /* Does mock_input indicate that we are re-reading a key sequence? */
9133 add_command_key (key
);
9134 if (echo_keystrokes_p ()
9135 && current_kboard
->immediate_echo
)
9142 /* If not, we should actually read a character. */
9146 KBOARD
*interrupted_kboard
= current_kboard
;
9147 struct frame
*interrupted_frame
= SELECTED_FRAME ();
9148 /* Calling read_char with COMMANDFLAG = -2 avoids
9149 redisplay in read_char and its subroutines. */
9150 key
= read_char (prevent_redisplay
? -2 : NILP (prompt
),
9151 current_binding
, last_nonmenu_event
,
9152 &used_mouse_menu
, NULL
);
9153 if ((INTEGERP (key
) && XINT (key
) == -2) /* wrong_kboard_jmpbuf */
9154 /* When switching to a new tty (with a new keyboard),
9155 read_char returns the new buffer, rather than -2
9156 (Bug#5095). This is because `terminal-init-xterm'
9157 calls read-char, which eats the wrong_kboard_jmpbuf
9158 return. Any better way to fix this? -- cyd */
9159 || (interrupted_kboard
!= current_kboard
))
9164 for (k
= all_kboards
; k
; k
= k
->next_kboard
)
9165 if (k
== interrupted_kboard
)
9170 /* Don't touch interrupted_kboard when it's been
9172 delayed_switch_frame
= Qnil
;
9173 goto replay_entire_sequence
;
9176 if (!NILP (delayed_switch_frame
))
9179 (interrupted_kboard
,
9180 Fcons (delayed_switch_frame
,
9181 KVAR (interrupted_kboard
, kbd_queue
)));
9182 delayed_switch_frame
= Qnil
;
9187 (interrupted_kboard
,
9188 Fcons (keybuf
[--t
], KVAR (interrupted_kboard
, kbd_queue
)));
9190 /* If the side queue is non-empty, ensure it begins with a
9191 switch-frame, so we'll replay it in the right context. */
9192 if (CONSP (KVAR (interrupted_kboard
, kbd_queue
))
9193 && (key
= XCAR (KVAR (interrupted_kboard
, kbd_queue
)),
9194 !(EVENT_HAS_PARAMETERS (key
)
9195 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)),
9199 XSETFRAME (frame
, interrupted_frame
);
9201 (interrupted_kboard
,
9202 Fcons (make_lispy_switch_frame (frame
),
9203 KVAR (interrupted_kboard
, kbd_queue
)));
9206 goto replay_entire_sequence
;
9210 /* read_char returns t when it shows a menu and the user rejects it.
9214 unbind_to (count
, Qnil
);
9219 /* read_char returns -1 at the end of a macro.
9220 Emacs 18 handles this by returning immediately with a
9221 zero, so that's what we'll do. */
9222 if (INTEGERP (key
) && XINT (key
) == -1)
9225 /* The Microsoft C compiler can't handle the goto that
9231 /* If the current buffer has been changed from under us, the
9232 keymap may have changed, so replay the sequence. */
9235 timer_resume_idle ();
9238 /* Reset the current buffer from the selected window
9239 in case something changed the former and not the latter.
9240 This is to be more consistent with the behavior
9241 of the command_loop_1. */
9242 if (fix_current_buffer
)
9244 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
9246 if (XBUFFER (XWINDOW (selected_window
)->contents
)
9248 Fset_buffer (XWINDOW (selected_window
)->contents
);
9251 goto replay_sequence
;
9254 /* If we have a quit that was typed in another frame, and
9255 quit_throw_to_read_char switched buffers,
9256 replay to get the right keymap. */
9258 && XINT (key
) == quit_char
9259 && current_buffer
!= starting_buffer
)
9262 ASET (raw_keybuf
, raw_keybuf_count
, key
);
9267 goto replay_sequence
;
9272 if (EVENT_HAS_PARAMETERS (key
)
9273 /* Either a `switch-frame' or a `select-window' event. */
9274 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)), Qswitch_frame
))
9276 /* If we're at the beginning of a key sequence, and the caller
9277 says it's okay, go ahead and return this event. If we're
9278 in the midst of a key sequence, delay it until the end. */
9279 if (t
> 0 || !can_return_switch_frame
)
9281 delayed_switch_frame
= key
;
9286 if (NILP (first_event
))
9289 /* Even if first_event does not specify a particular
9290 window/position, it's important to recompute the maps here
9291 since a long time might have passed since we entered
9292 read_key_sequence, and a timer (or process-filter or
9293 special-event-map, ...) might have switched the current buffer
9294 or the selected window from under us in the mean time. */
9295 if (fix_current_buffer
9296 && (XBUFFER (XWINDOW (selected_window
)->contents
)
9298 Fset_buffer (XWINDOW (selected_window
)->contents
);
9299 current_binding
= active_maps (first_event
);
9303 ASET (raw_keybuf
, raw_keybuf_count
, key
);
9307 /* Clicks in non-text areas get prefixed by the symbol
9308 in their CHAR-ADDRESS field. For example, a click on
9309 the mode line is prefixed by the symbol `mode-line'.
9311 Furthermore, key sequences beginning with mouse clicks
9312 are read using the keymaps of the buffer clicked on, not
9313 the current buffer. So we may have to switch the buffer
9316 When we turn one event into two events, we must make sure
9317 that neither of the two looks like the original--so that,
9318 if we replay the events, they won't be expanded again.
9319 If not for this, such reexpansion could happen either here
9320 or when user programs play with this-command-keys. */
9321 if (EVENT_HAS_PARAMETERS (key
))
9323 Lisp_Object kind
= EVENT_HEAD_KIND (EVENT_HEAD (key
));
9324 if (EQ (kind
, Qmouse_click
))
9326 Lisp_Object window
= POSN_WINDOW (EVENT_START (key
));
9327 Lisp_Object posn
= POSN_POSN (EVENT_START (key
));
9330 || (!NILP (fake_prefixed_keys
)
9331 && !NILP (Fmemq (key
, fake_prefixed_keys
))))
9333 /* We're looking a second time at an event for which
9334 we generated a fake prefix key. Set
9335 last_real_key_start appropriately. */
9337 last_real_key_start
= t
- 1;
9340 if (last_real_key_start
== 0)
9342 /* Key sequences beginning with mouse clicks are
9343 read using the keymaps in the buffer clicked on,
9344 not the current buffer. If we're at the
9345 beginning of a key sequence, switch buffers. */
9346 if (WINDOWP (window
)
9347 && BUFFERP (XWINDOW (window
)->contents
)
9348 && XBUFFER (XWINDOW (window
)->contents
) != current_buffer
)
9350 ASET (raw_keybuf
, raw_keybuf_count
, key
);
9355 /* Arrange to go back to the original buffer once we're
9356 done reading the key sequence. Note that we can't
9357 use save_excursion_{save,restore} here, because they
9358 save point as well as the current buffer; we don't
9359 want to save point, because redisplay may change it,
9360 to accommodate a Fset_window_start or something. We
9361 don't want to do this at the top of the function,
9362 because we may get input from a subprocess which
9363 wants to change the selected window and stuff (say,
9365 record_unwind_current_buffer ();
9367 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
9369 set_buffer_internal (XBUFFER (XWINDOW (window
)->contents
));
9370 goto replay_sequence
;
9374 /* Expand mode-line and scroll-bar events into two events:
9375 use posn as a fake prefix key. */
9377 && (NILP (fake_prefixed_keys
)
9378 || NILP (Fmemq (key
, fake_prefixed_keys
))))
9380 if (bufsize
- t
<= 1)
9381 error ("Key sequence too long");
9384 keybuf
[t
+ 1] = key
;
9387 /* Record that a fake prefix key has been generated
9388 for KEY. Don't modify the event; this would
9389 prevent proper action when the event is pushed
9390 back into unread-command-events. */
9391 fake_prefixed_keys
= Fcons (key
, fake_prefixed_keys
);
9395 else if (CONSP (XCDR (key
))
9396 && CONSP (EVENT_START (key
))
9397 && CONSP (XCDR (EVENT_START (key
))))
9401 posn
= POSN_POSN (EVENT_START (key
));
9402 /* Handle menu-bar events:
9403 insert the dummy prefix event `menu-bar'. */
9404 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
9406 if (bufsize
- t
<= 1)
9407 error ("Key sequence too long");
9409 keybuf
[t
+ 1] = key
;
9411 /* Zap the position in key, so we know that we've
9412 expanded it, and don't try to do so again. */
9413 POSN_SET_POSN (EVENT_START (key
), list1 (posn
));
9416 goto replay_sequence
;
9418 else if (CONSP (posn
))
9420 /* We're looking at the second event of a
9421 sequence which we expanded before. Set
9422 last_real_key_start appropriately. */
9423 if (last_real_key_start
== t
&& t
> 0)
9424 last_real_key_start
= t
- 1;
9429 /* We have finally decided that KEY is something we might want
9431 new_binding
= follow_key (current_binding
, key
);
9433 /* If KEY wasn't bound, we'll try some fallbacks. */
9434 if (!NILP (new_binding
))
9435 /* This is needed for the following scenario:
9436 event 0: a down-event that gets dropped by calling replay_key.
9437 event 1: some normal prefix like C-h.
9438 After event 0, first_unbound is 0, after event 1 indec.start,
9439 fkey.start, and keytran.start are all 1, so when we see that
9440 C-h is bound, we need to update first_unbound. */
9441 first_unbound
= max (t
+ 1, first_unbound
);
9446 /* Remember the position to put an upper bound on indec.start. */
9447 first_unbound
= min (t
, first_unbound
);
9449 head
= EVENT_HEAD (key
);
9453 Lisp_Object breakdown
;
9456 breakdown
= parse_modifiers (head
);
9457 modifiers
= XINT (XCAR (XCDR (breakdown
)));
9458 /* Attempt to reduce an unbound mouse event to a simpler
9459 event that is bound:
9460 Drags reduce to clicks.
9461 Double-clicks reduce to clicks.
9462 Triple-clicks reduce to double-clicks, then to clicks.
9463 Down-clicks are eliminated.
9464 Double-downs reduce to downs, then are eliminated.
9465 Triple-downs reduce to double-downs, then to downs,
9466 then are eliminated. */
9467 if (modifiers
& (down_modifier
| drag_modifier
9468 | double_modifier
| triple_modifier
))
9470 while (modifiers
& (down_modifier
| drag_modifier
9471 | double_modifier
| triple_modifier
))
9473 Lisp_Object new_head
, new_click
;
9474 if (modifiers
& triple_modifier
)
9475 modifiers
^= (double_modifier
| triple_modifier
);
9476 else if (modifiers
& double_modifier
)
9477 modifiers
&= ~double_modifier
;
9478 else if (modifiers
& drag_modifier
)
9479 modifiers
&= ~drag_modifier
;
9482 /* Dispose of this `down' event by simply jumping
9483 back to replay_key, to get another event.
9485 Note that if this event came from mock input,
9486 then just jumping back to replay_key will just
9487 hand it to us again. So we have to wipe out any
9490 We could delete keybuf[t] and shift everything
9491 after that to the left by one spot, but we'd also
9492 have to fix up any variable that points into
9493 keybuf, and shifting isn't really necessary
9496 Adding prefixes for non-textual mouse clicks
9497 creates two characters of mock input, and both
9498 must be thrown away. If we're only looking at
9499 the prefix now, we can just jump back to
9500 replay_key. On the other hand, if we've already
9501 processed the prefix, and now the actual click
9502 itself is giving us trouble, then we've lost the
9503 state of the keymaps we want to backtrack to, and
9504 we need to replay the whole sequence to rebuild
9507 Beyond that, only function key expansion could
9508 create more than two keys, but that should never
9509 generate mouse events, so it's okay to zero
9510 mock_input in that case too.
9512 FIXME: The above paragraph seems just plain
9513 wrong, if you consider things like
9514 xterm-mouse-mode. -stef
9516 Isn't this just the most wonderful code ever? */
9518 /* If mock_input > t + 1, the above simplification
9519 will actually end up dropping keys on the floor.
9520 This is probably OK for now, but even
9521 if mock_input <= t + 1, we need to adjust indec,
9523 Typical case [header-line down-mouse-N]:
9524 mock_input = 2, t = 1, fkey.end = 1,
9525 last_real_key_start = 0. */
9526 if (indec
.end
> last_real_key_start
)
9528 indec
.end
= indec
.start
9529 = min (last_real_key_start
, indec
.start
);
9530 indec
.map
= indec
.parent
;
9531 if (fkey
.end
> last_real_key_start
)
9533 fkey
.end
= fkey
.start
9534 = min (last_real_key_start
, fkey
.start
);
9535 fkey
.map
= fkey
.parent
;
9536 if (keytran
.end
> last_real_key_start
)
9538 keytran
.end
= keytran
.start
9539 = min (last_real_key_start
, keytran
.start
);
9540 keytran
.map
= keytran
.parent
;
9544 if (t
== last_real_key_start
)
9551 mock_input
= last_real_key_start
;
9552 goto replay_sequence
;
9557 = apply_modifiers (modifiers
, XCAR (breakdown
));
9558 new_click
= list2 (new_head
, EVENT_START (key
));
9560 /* Look for a binding for this new key. */
9561 new_binding
= follow_key (current_binding
, new_click
);
9563 /* If that click is bound, go for it. */
9564 if (!NILP (new_binding
))
9566 current_binding
= new_binding
;
9570 /* Otherwise, we'll leave key set to the drag event. */
9575 current_binding
= new_binding
;
9578 /* Normally, last_nonmenu_event gets the previous key we read.
9579 But when a mouse popup menu is being used,
9580 we don't update last_nonmenu_event; it continues to hold the mouse
9581 event that preceded the first level of menu. */
9582 if (!used_mouse_menu
)
9583 last_nonmenu_event
= key
;
9585 /* Record what part of this_command_keys is the current key sequence. */
9586 this_single_command_key_start
= this_command_key_count
- t
;
9588 /* Look for this sequence in input-decode-map.
9589 Scan from indec.end until we find a bound suffix. */
9590 while (indec
.end
< t
)
9592 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9596 GCPRO4 (indec
.map
, fkey
.map
, keytran
.map
, delayed_switch_frame
);
9597 done
= keyremap_step (keybuf
, bufsize
, &indec
, max (t
, mock_input
),
9602 mock_input
= diff
+ max (t
, mock_input
);
9603 goto replay_sequence
;
9607 if (!KEYMAPP (current_binding
)
9608 && !test_undefined (current_binding
)
9609 && indec
.start
>= t
)
9610 /* There is a binding and it's not a prefix.
9611 (and it doesn't have any input-decode-map translation pending).
9612 There is thus no function-key in this sequence.
9613 Moving fkey.start is important in this case to allow keytran.start
9614 to go over the sequence before we return (since we keep the
9615 invariant that keytran.end <= fkey.start). */
9618 (fkey
.start
= fkey
.end
= t
, fkey
.map
= fkey
.parent
);
9621 /* If the sequence is unbound, see if we can hang a function key
9622 off the end of it. */
9623 /* Continue scan from fkey.end until we find a bound suffix. */
9624 while (fkey
.end
< indec
.start
)
9626 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9630 GCPRO4 (indec
.map
, fkey
.map
, keytran
.map
, delayed_switch_frame
);
9631 done
= keyremap_step (keybuf
, bufsize
, &fkey
,
9632 max (t
, mock_input
),
9633 /* If there's a binding (i.e.
9634 first_binding >= nmaps) we don't want
9635 to apply this function-key-mapping. */
9637 && (test_undefined (current_binding
)),
9642 mock_input
= diff
+ max (t
, mock_input
);
9643 /* Adjust the input-decode-map counters. */
9645 indec
.start
+= diff
;
9647 goto replay_sequence
;
9651 /* Look for this sequence in key-translation-map.
9652 Scan from keytran.end until we find a bound suffix. */
9653 while (keytran
.end
< fkey
.start
)
9655 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9659 GCPRO4 (indec
.map
, fkey
.map
, keytran
.map
, delayed_switch_frame
);
9660 done
= keyremap_step (keybuf
, bufsize
, &keytran
, max (t
, mock_input
),
9665 mock_input
= diff
+ max (t
, mock_input
);
9666 /* Adjust the function-key-map and input-decode-map counters. */
9668 indec
.start
+= diff
;
9672 goto replay_sequence
;
9676 /* If KEY is not defined in any of the keymaps,
9677 and cannot be part of a function key or translation,
9678 and is an upper case letter
9679 use the corresponding lower-case letter instead. */
9680 if (NILP (current_binding
)
9681 && /* indec.start >= t && fkey.start >= t && */ keytran
.start
>= t
9683 && ((CHARACTERP (make_number (XINT (key
) & ~CHAR_MODIFIER_MASK
))
9684 && uppercasep (XINT (key
) & ~CHAR_MODIFIER_MASK
))
9685 || (XINT (key
) & shift_modifier
)))
9687 Lisp_Object new_key
;
9689 original_uppercase
= key
;
9690 original_uppercase_position
= t
- 1;
9692 if (XINT (key
) & shift_modifier
)
9693 XSETINT (new_key
, XINT (key
) & ~shift_modifier
);
9695 XSETINT (new_key
, (downcase (XINT (key
) & ~CHAR_MODIFIER_MASK
)
9696 | (XINT (key
) & CHAR_MODIFIER_MASK
)));
9698 /* We have to do this unconditionally, regardless of whether
9699 the lower-case char is defined in the keymaps, because they
9700 might get translated through function-key-map. */
9701 keybuf
[t
- 1] = new_key
;
9702 mock_input
= max (t
, mock_input
);
9703 shift_translated
= 1;
9705 goto replay_sequence
;
9708 if (NILP (current_binding
)
9709 && help_char_p (EVENT_HEAD (key
)) && t
> 1)
9711 read_key_sequence_cmd
= Vprefix_help_command
;
9712 /* The Microsoft C compiler can't handle the goto that
9718 /* If KEY is not defined in any of the keymaps,
9719 and cannot be part of a function key or translation,
9720 and is a shifted function key,
9721 use the corresponding unshifted function key instead. */
9722 if (NILP (current_binding
)
9723 && /* indec.start >= t && fkey.start >= t && */ keytran
.start
>= t
)
9725 Lisp_Object breakdown
= parse_modifiers (key
);
9727 = CONSP (breakdown
) ? (XINT (XCAR (XCDR (breakdown
)))) : 0;
9729 if (modifiers
& shift_modifier
9730 /* Treat uppercase keys as shifted. */
9732 && (KEY_TO_CHAR (key
)
9733 < XCHAR_TABLE (BVAR (current_buffer
, downcase_table
))->header
.size
)
9734 && uppercasep (KEY_TO_CHAR (key
))))
9737 = (modifiers
& shift_modifier
9738 ? apply_modifiers (modifiers
& ~shift_modifier
,
9740 : make_number (downcase (KEY_TO_CHAR (key
)) | modifiers
));
9742 original_uppercase
= key
;
9743 original_uppercase_position
= t
- 1;
9745 /* We have to do this unconditionally, regardless of whether
9746 the lower-case char is defined in the keymaps, because they
9747 might get translated through function-key-map. */
9748 keybuf
[t
- 1] = new_key
;
9749 mock_input
= max (t
, mock_input
);
9750 /* Reset fkey (and consequently keytran) to apply
9751 function-key-map on the result, so that S-backspace is
9752 correctly mapped to DEL (via backspace). OTOH,
9753 input-decode-map doesn't need to go through it again. */
9754 fkey
.start
= fkey
.end
= 0;
9755 keytran
.start
= keytran
.end
= 0;
9756 shift_translated
= 1;
9758 goto replay_sequence
;
9763 read_key_sequence_cmd
= current_binding
;
9764 read_key_sequence_remapped
9765 /* Remap command through active keymaps.
9766 Do the remapping here, before the unbind_to so it uses the keymaps
9767 of the appropriate buffer. */
9768 = SYMBOLP (read_key_sequence_cmd
)
9769 ? Fcommand_remapping (read_key_sequence_cmd
, Qnil
, Qnil
)
9772 unread_switch_frame
= delayed_switch_frame
;
9773 unbind_to (count
, Qnil
);
9775 /* Don't downcase the last character if the caller says don't.
9776 Don't downcase it if the result is undefined, either. */
9777 if ((dont_downcase_last
|| NILP (current_binding
))
9779 && t
- 1 == original_uppercase_position
)
9781 keybuf
[t
- 1] = original_uppercase
;
9782 shift_translated
= 0;
9785 if (shift_translated
)
9786 Vthis_command_keys_shift_translated
= Qt
;
9788 /* Occasionally we fabricate events, perhaps by expanding something
9789 according to function-key-map, or by adding a prefix symbol to a
9790 mouse click in the scroll bar or modeline. In this cases, return
9791 the entire generated key sequence, even if we hit an unbound
9792 prefix or a definition before the end. This means that you will
9793 be able to push back the event properly, and also means that
9794 read-key-sequence will always return a logical unit.
9797 for (; t
< mock_input
; t
++)
9799 if (echo_keystrokes_p ())
9800 echo_char (keybuf
[t
]);
9801 add_command_key (keybuf
[t
]);
9809 read_key_sequence_vs (Lisp_Object prompt
, Lisp_Object continue_echo
,
9810 Lisp_Object dont_downcase_last
,
9811 Lisp_Object can_return_switch_frame
,
9812 Lisp_Object cmd_loop
, bool allow_string
)
9814 Lisp_Object keybuf
[30];
9816 struct gcpro gcpro1
;
9817 ptrdiff_t count
= SPECPDL_INDEX ();
9820 CHECK_STRING (prompt
);
9823 specbind (Qinput_method_exit_on_first_char
,
9824 (NILP (cmd_loop
) ? Qt
: Qnil
));
9825 specbind (Qinput_method_use_echo_area
,
9826 (NILP (cmd_loop
) ? Qt
: Qnil
));
9828 memset (keybuf
, 0, sizeof keybuf
);
9830 gcpro1
.nvars
= ARRAYELTS (keybuf
);
9832 if (NILP (continue_echo
))
9834 this_command_key_count
= 0;
9835 this_command_key_count_reset
= 0;
9836 this_single_command_key_start
= 0;
9839 #ifdef HAVE_WINDOW_SYSTEM
9840 if (display_hourglass_p
)
9841 cancel_hourglass ();
9844 i
= read_key_sequence (keybuf
, ARRAYELTS (keybuf
),
9845 prompt
, ! NILP (dont_downcase_last
),
9846 ! NILP (can_return_switch_frame
), 0, 0);
9848 #if 0 /* The following is fine for code reading a key sequence and
9849 then proceeding with a lengthy computation, but it's not good
9850 for code reading keys in a loop, like an input method. */
9851 #ifdef HAVE_WINDOW_SYSTEM
9852 if (display_hourglass_p
)
9863 return unbind_to (count
,
9864 ((allow_string
? make_event_array
: Fvector
)
9868 DEFUN ("read-key-sequence", Fread_key_sequence
, Sread_key_sequence
, 1, 5, 0,
9869 doc
: /* Read a sequence of keystrokes and return as a string or vector.
9870 The sequence is sufficient to specify a non-prefix command in the
9871 current local and global maps.
9873 First arg PROMPT is a prompt string. If nil, do not prompt specially.
9874 Second (optional) arg CONTINUE-ECHO, if non-nil, means this key echos
9875 as a continuation of the previous key.
9877 The third (optional) arg DONT-DOWNCASE-LAST, if non-nil, means do not
9878 convert the last event to lower case. (Normally any upper case event
9879 is converted to lower case if the original event is undefined and the lower
9880 case equivalent is defined.) A non-nil value is appropriate for reading
9881 a key sequence to be defined.
9883 A C-g typed while in this function is treated like any other character,
9884 and `quit-flag' is not set.
9886 If the key sequence starts with a mouse click, then the sequence is read
9887 using the keymaps of the buffer of the window clicked in, not the buffer
9888 of the selected window as normal.
9890 `read-key-sequence' drops unbound button-down events, since you normally
9891 only care about the click or drag events which follow them. If a drag
9892 or multi-click event is unbound, but the corresponding click event would
9893 be bound, `read-key-sequence' turns the event into a click event at the
9894 drag's starting position. This means that you don't have to distinguish
9895 between click and drag, double, or triple events unless you want to.
9897 `read-key-sequence' prefixes mouse events on mode lines, the vertical
9898 lines separating windows, and scroll bars with imaginary keys
9899 `mode-line', `vertical-line', and `vertical-scroll-bar'.
9901 Optional fourth argument CAN-RETURN-SWITCH-FRAME non-nil means that this
9902 function will process a switch-frame event if the user switches frames
9903 before typing anything. If the user switches frames in the middle of a
9904 key sequence, or at the start of the sequence but CAN-RETURN-SWITCH-FRAME
9905 is nil, then the event will be put off until after the current key sequence.
9907 `read-key-sequence' checks `function-key-map' for function key
9908 sequences, where they wouldn't conflict with ordinary bindings. See
9909 `function-key-map' for more details.
9911 The optional fifth argument CMD-LOOP, if non-nil, means
9912 that this key sequence is being read by something that will
9913 read commands one after another. It should be nil if the caller
9914 will read just one key sequence. */)
9915 (Lisp_Object prompt
, Lisp_Object continue_echo
, Lisp_Object dont_downcase_last
, Lisp_Object can_return_switch_frame
, Lisp_Object cmd_loop
)
9917 return read_key_sequence_vs (prompt
, continue_echo
, dont_downcase_last
,
9918 can_return_switch_frame
, cmd_loop
, true);
9921 DEFUN ("read-key-sequence-vector", Fread_key_sequence_vector
,
9922 Sread_key_sequence_vector
, 1, 5, 0,
9923 doc
: /* Like `read-key-sequence' but always return a vector. */)
9924 (Lisp_Object prompt
, Lisp_Object continue_echo
, Lisp_Object dont_downcase_last
, Lisp_Object can_return_switch_frame
, Lisp_Object cmd_loop
)
9926 return read_key_sequence_vs (prompt
, continue_echo
, dont_downcase_last
,
9927 can_return_switch_frame
, cmd_loop
, false);
9930 /* Return true if input events are pending. */
9933 detect_input_pending (void)
9935 return input_pending
|| get_input_pending (0);
9938 /* Return true if input events other than mouse movements are
9942 detect_input_pending_ignore_squeezables (void)
9944 return input_pending
|| get_input_pending (READABLE_EVENTS_IGNORE_SQUEEZABLES
);
9947 /* Return true if input events are pending, and run any pending timers. */
9950 detect_input_pending_run_timers (bool do_display
)
9952 unsigned old_timers_run
= timers_run
;
9955 get_input_pending (READABLE_EVENTS_DO_TIMERS_NOW
);
9957 if (old_timers_run
!= timers_run
&& do_display
)
9958 redisplay_preserve_echo_area (8);
9960 return input_pending
;
9963 /* This is called in some cases before a possible quit.
9964 It cases the next call to detect_input_pending to recompute input_pending.
9965 So calling this function unnecessarily can't do any harm. */
9968 clear_input_pending (void)
9973 /* Return true if there are pending requeued events.
9974 This isn't used yet. The hope is to make wait_reading_process_output
9975 call it, and return if it runs Lisp code that unreads something.
9976 The problem is, kbd_buffer_get_event needs to be fixed to know what
9977 to do in that case. It isn't trivial. */
9980 requeued_events_pending_p (void)
9982 return (!NILP (Vunread_command_events
));
9985 DEFUN ("input-pending-p", Finput_pending_p
, Sinput_pending_p
, 0, 1, 0,
9986 doc
: /* Return t if command input is currently available with no wait.
9987 Actually, the value is nil only if we can be sure that no input is available;
9988 if there is a doubt, the value is t.
9990 If CHECK-TIMERS is non-nil, timers that are ready to run will do so. */)
9991 (Lisp_Object check_timers
)
9993 if (!NILP (Vunread_command_events
)
9994 || !NILP (Vunread_post_input_method_events
)
9995 || !NILP (Vunread_input_method_events
))
9998 /* Process non-user-visible events (Bug#10195). */
9999 process_special_events ();
10001 return (get_input_pending ((NILP (check_timers
)
10002 ? 0 : READABLE_EVENTS_DO_TIMERS_NOW
)
10003 | READABLE_EVENTS_FILTER_EVENTS
)
10007 DEFUN ("recent-keys", Frecent_keys
, Srecent_keys
, 0, 1, 0,
10008 doc
: /* Return vector of last few events, not counting those from keyboard macros.
10009 If INCLUDE-CMDS is non-nil, include the commands that were run,
10010 represented as events of the form (nil . COMMAND). */)
10011 (Lisp_Object include_cmds
)
10013 bool cmds
= !NILP (include_cmds
);
10016 || (cmds
&& total_keys
< NUM_RECENT_KEYS
))
10017 return Fvector (total_keys
,
10018 XVECTOR (recent_keys
)->contents
);
10021 Lisp_Object es
= Qnil
;
10022 int i
= (total_keys
< NUM_RECENT_KEYS
10023 ? 0 : recent_keys_index
);
10024 eassert (recent_keys_index
< NUM_RECENT_KEYS
);
10027 Lisp_Object e
= AREF (recent_keys
, i
);
10028 if (cmds
|| !CONSP (e
) || !NILP (XCAR (e
)))
10029 es
= Fcons (e
, es
);
10030 if (++i
>= NUM_RECENT_KEYS
)
10032 } while (i
!= recent_keys_index
);
10033 es
= Fnreverse (es
);
10034 return Fvconcat (1, &es
);
10038 DEFUN ("this-command-keys", Fthis_command_keys
, Sthis_command_keys
, 0, 0, 0,
10039 doc
: /* Return the key sequence that invoked this command.
10040 However, if the command has called `read-key-sequence', it returns
10041 the last key sequence that has been read.
10042 The value is a string or a vector.
10044 See also `this-command-keys-vector'. */)
10047 return make_event_array (this_command_key_count
,
10048 XVECTOR (this_command_keys
)->contents
);
10051 DEFUN ("this-command-keys-vector", Fthis_command_keys_vector
, Sthis_command_keys_vector
, 0, 0, 0,
10052 doc
: /* Return the key sequence that invoked this command, as a vector.
10053 However, if the command has called `read-key-sequence', it returns
10054 the last key sequence that has been read.
10056 See also `this-command-keys'. */)
10059 return Fvector (this_command_key_count
,
10060 XVECTOR (this_command_keys
)->contents
);
10063 DEFUN ("this-single-command-keys", Fthis_single_command_keys
,
10064 Sthis_single_command_keys
, 0, 0, 0,
10065 doc
: /* Return the key sequence that invoked this command.
10066 More generally, it returns the last key sequence read, either by
10067 the command loop or by `read-key-sequence'.
10068 Unlike `this-command-keys', this function's value
10069 does not include prefix arguments.
10070 The value is always a vector. */)
10073 return Fvector (this_command_key_count
10074 - this_single_command_key_start
,
10075 (XVECTOR (this_command_keys
)->contents
10076 + this_single_command_key_start
));
10079 DEFUN ("this-single-command-raw-keys", Fthis_single_command_raw_keys
,
10080 Sthis_single_command_raw_keys
, 0, 0, 0,
10081 doc
: /* Return the raw events that were read for this command.
10082 More generally, it returns the last key sequence read, either by
10083 the command loop or by `read-key-sequence'.
10084 Unlike `this-single-command-keys', this function's value
10085 shows the events before all translations (except for input methods).
10086 The value is always a vector. */)
10089 return Fvector (raw_keybuf_count
, XVECTOR (raw_keybuf
)->contents
);
10092 DEFUN ("reset-this-command-lengths", Freset_this_command_lengths
,
10093 Sreset_this_command_lengths
, 0, 0, 0,
10094 doc
: /* Make the unread events replace the last command and echo.
10095 Used in `universal-argument-other-key'.
10097 `universal-argument-other-key' rereads the event just typed.
10098 It then gets translated through `function-key-map'.
10099 The translated event has to replace the real events,
10100 both in the value of (this-command-keys) and in echoing.
10101 To achieve this, `universal-argument-other-key' calls
10102 `reset-this-command-lengths', which discards the record of reading
10103 these events the first time. */)
10106 this_command_key_count
= before_command_key_count
;
10107 if (this_command_key_count
< this_single_command_key_start
)
10108 this_single_command_key_start
= this_command_key_count
;
10110 echo_truncate (before_command_echo_length
);
10112 /* Cause whatever we put into unread-command-events
10113 to echo as if it were being freshly read from the keyboard. */
10114 this_command_key_count_reset
= 1;
10119 DEFUN ("clear-this-command-keys", Fclear_this_command_keys
,
10120 Sclear_this_command_keys
, 0, 1, 0,
10121 doc
: /* Clear out the vector that `this-command-keys' returns.
10122 Also clear the record of the last 100 events, unless optional arg
10123 KEEP-RECORD is non-nil. */)
10124 (Lisp_Object keep_record
)
10128 this_command_key_count
= 0;
10129 this_command_key_count_reset
= 0;
10131 if (NILP (keep_record
))
10133 for (i
= 0; i
< ASIZE (recent_keys
); ++i
)
10134 ASET (recent_keys
, i
, Qnil
);
10136 recent_keys_index
= 0;
10141 DEFUN ("recursion-depth", Frecursion_depth
, Srecursion_depth
, 0, 0, 0,
10142 doc
: /* Return the current depth in recursive edits. */)
10146 /* Wrap around reliably on integer overflow. */
10147 EMACS_INT sum
= (command_loop_level
& INTMASK
) + (minibuf_level
& INTMASK
);
10148 XSETINT (temp
, sum
);
10152 DEFUN ("open-dribble-file", Fopen_dribble_file
, Sopen_dribble_file
, 1, 1,
10153 "FOpen dribble file: ",
10154 doc
: /* Start writing all keyboard characters to a dribble file called FILE.
10155 If FILE is nil, close any open dribble file.
10156 The file will be closed when Emacs exits.
10158 Be aware that this records ALL characters you type!
10159 This may include sensitive information such as passwords. */)
10172 Lisp_Object encfile
;
10174 file
= Fexpand_file_name (file
, Qnil
);
10175 encfile
= ENCODE_FILE (file
);
10176 fd
= emacs_open (SSDATA (encfile
), O_WRONLY
| O_CREAT
| O_EXCL
, 0600);
10177 if (fd
< 0 && errno
== EEXIST
&& unlink (SSDATA (encfile
)) == 0)
10178 fd
= emacs_open (SSDATA (encfile
), O_WRONLY
| O_CREAT
| O_EXCL
, 0600);
10179 dribble
= fd
< 0 ? 0 : fdopen (fd
, "w");
10181 report_file_error ("Opening dribble", file
);
10186 DEFUN ("discard-input", Fdiscard_input
, Sdiscard_input
, 0, 0, 0,
10187 doc
: /* Discard the contents of the terminal input buffer.
10188 Also end any kbd macro being defined. */)
10191 if (!NILP (KVAR (current_kboard
, defining_kbd_macro
)))
10193 /* Discard the last command from the macro. */
10194 Fcancel_kbd_macro_events ();
10198 Vunread_command_events
= Qnil
;
10200 discard_tty_input ();
10202 kbd_fetch_ptr
= kbd_store_ptr
;
10208 DEFUN ("suspend-emacs", Fsuspend_emacs
, Ssuspend_emacs
, 0, 1, "",
10209 doc
: /* Stop Emacs and return to superior process. You can resume later.
10210 If `cannot-suspend' is non-nil, or if the system doesn't support job
10211 control, run a subshell instead.
10213 If optional arg STUFFSTRING is non-nil, its characters are stuffed
10214 to be read as terminal input by Emacs's parent, after suspension.
10216 Before suspending, run the normal hook `suspend-hook'.
10217 After resumption run the normal hook `suspend-resume-hook'.
10219 Some operating systems cannot stop the Emacs process and resume it later.
10220 On such systems, Emacs starts a subshell instead of suspending. */)
10221 (Lisp_Object stuffstring
)
10223 ptrdiff_t count
= SPECPDL_INDEX ();
10224 int old_height
, old_width
;
10226 struct gcpro gcpro1
;
10228 if (tty_list
&& tty_list
->next
)
10229 error ("There are other tty frames open; close them before suspending Emacs");
10231 if (!NILP (stuffstring
))
10232 CHECK_STRING (stuffstring
);
10234 run_hook (intern ("suspend-hook"));
10236 GCPRO1 (stuffstring
);
10237 get_tty_size (fileno (CURTTY ()->input
), &old_width
, &old_height
);
10238 reset_all_sys_modes ();
10239 /* sys_suspend can get an error if it tries to fork a subshell
10240 and the system resources aren't available for that. */
10241 record_unwind_protect_void (init_all_sys_modes
);
10242 stuff_buffered_input (stuffstring
);
10243 if (cannot_suspend
)
10247 unbind_to (count
, Qnil
);
10249 /* Check if terminal/window size has changed.
10250 Note that this is not useful when we are running directly
10251 with a window system; but suspend should be disabled in that case. */
10252 get_tty_size (fileno (CURTTY ()->input
), &width
, &height
);
10253 if (width
!= old_width
|| height
!= old_height
)
10254 change_frame_size (SELECTED_FRAME (), width
,
10255 height
- FRAME_MENU_BAR_LINES (SELECTED_FRAME ()),
10258 run_hook (intern ("suspend-resume-hook"));
10264 /* If STUFFSTRING is a string, stuff its contents as pending terminal input.
10265 Then in any case stuff anything Emacs has read ahead and not used. */
10268 stuff_buffered_input (Lisp_Object stuffstring
)
10270 #ifdef SIGTSTP /* stuff_char is defined if SIGTSTP. */
10271 register unsigned char *p
;
10273 if (STRINGP (stuffstring
))
10275 register ptrdiff_t count
;
10277 p
= SDATA (stuffstring
);
10278 count
= SBYTES (stuffstring
);
10279 while (count
-- > 0)
10284 /* Anything we have read ahead, put back for the shell to read. */
10285 /* ?? What should this do when we have multiple keyboards??
10286 Should we ignore anything that was typed in at the "wrong" kboard?
10288 rms: we should stuff everything back into the kboard
10290 for (; kbd_fetch_ptr
!= kbd_store_ptr
; kbd_fetch_ptr
++)
10293 if (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
10294 kbd_fetch_ptr
= kbd_buffer
;
10295 if (kbd_fetch_ptr
->kind
== ASCII_KEYSTROKE_EVENT
)
10296 stuff_char (kbd_fetch_ptr
->code
);
10298 clear_event (kbd_fetch_ptr
);
10302 #endif /* SIGTSTP */
10306 set_waiting_for_input (struct timespec
*time_to_clear
)
10308 input_available_clear_time
= time_to_clear
;
10310 /* Tell handle_interrupt to throw back to read_char, */
10311 waiting_for_input
= 1;
10313 /* If handle_interrupt was called before and buffered a C-g,
10314 make it run again now, to avoid timing error. */
10315 if (!NILP (Vquit_flag
))
10316 quit_throw_to_read_char (0);
10320 clear_waiting_for_input (void)
10322 /* Tell handle_interrupt not to throw back to read_char, */
10323 waiting_for_input
= 0;
10324 input_available_clear_time
= 0;
10327 /* The SIGINT handler.
10329 If we have a frame on the controlling tty, we assume that the
10330 SIGINT was generated by C-g, so we call handle_interrupt.
10331 Otherwise, tell QUIT to kill Emacs. */
10334 handle_interrupt_signal (int sig
)
10336 /* See if we have an active terminal on our controlling tty. */
10337 struct terminal
*terminal
= get_named_terminal ("/dev/tty");
10340 /* If there are no frames there, let's pretend that we are a
10341 well-behaving UN*X program and quit. We must not call Lisp
10342 in a signal handler, so tell QUIT to exit when it is
10344 Vquit_flag
= Qkill_emacs
;
10348 /* Otherwise, the SIGINT was probably generated by C-g. */
10350 /* Set internal_last_event_frame to the top frame of the
10351 controlling tty, if we have a frame there. We disable the
10352 interrupt key on secondary ttys, so the SIGINT must have come
10353 from the controlling tty. */
10354 internal_last_event_frame
= terminal
->display_info
.tty
->top_frame
;
10356 handle_interrupt (1);
10361 deliver_interrupt_signal (int sig
)
10363 deliver_process_signal (sig
, handle_interrupt_signal
);
10367 /* If Emacs is stuck because `inhibit-quit' is true, then keep track
10368 of the number of times C-g has been requested. If C-g is pressed
10369 enough times, then quit anyway. See bug#6585. */
10370 static int volatile force_quit_count
;
10372 /* This routine is called at interrupt level in response to C-g.
10374 It is called from the SIGINT handler or kbd_buffer_store_event.
10376 If `waiting_for_input' is non zero, then unless `echoing' is
10377 nonzero, immediately throw back to read_char.
10379 Otherwise it sets the Lisp variable quit-flag not-nil. This causes
10380 eval to throw, when it gets a chance. If quit-flag is already
10381 non-nil, it stops the job right away. */
10384 handle_interrupt (bool in_signal_handler
)
10390 /* XXX This code needs to be revised for multi-tty support. */
10391 if (!NILP (Vquit_flag
) && get_named_terminal ("/dev/tty"))
10393 if (! in_signal_handler
)
10395 /* If SIGINT isn't blocked, don't let us be interrupted by
10396 a SIGINT. It might be harmful due to non-reentrancy
10397 in I/O functions. */
10399 sigemptyset (&blocked
);
10400 sigaddset (&blocked
, SIGINT
);
10401 pthread_sigmask (SIG_BLOCK
, &blocked
, 0);
10405 reset_all_sys_modes ();
10409 * On systems which can suspend the current process and return to the original
10410 * shell, this command causes the user to end up back at the shell.
10411 * The "Auto-save" and "Abort" questions are not asked until
10412 * the user elects to return to emacs, at which point he can save the current
10413 * job and either dump core or continue.
10417 /* Perhaps should really fork an inferior shell?
10418 But that would not provide any way to get back
10419 to the original shell, ever. */
10420 printf ("No support for stopping a process on this operating system;\n");
10421 printf ("you can continue or abort.\n");
10422 #endif /* not SIGTSTP */
10424 /* We must remain inside the screen area when the internal terminal
10425 is used. Note that [Enter] is not echoed by dos. */
10426 cursor_to (SELECTED_FRAME (), 0, 0);
10428 /* It doesn't work to autosave while GC is in progress;
10429 the code used for auto-saving doesn't cope with the mark bit. */
10430 if (!gc_in_progress
)
10432 printf ("Auto-save? (y or n) ");
10434 if (((c
= getchar ()) & ~040) == 'Y')
10436 Fdo_auto_save (Qt
, Qnil
);
10438 printf ("\r\nAuto-save done");
10439 #else /* not MSDOS */
10440 printf ("Auto-save done\n");
10441 #endif /* not MSDOS */
10443 while (c
!= '\n') c
= getchar ();
10447 /* During GC, it must be safe to reenable quitting again. */
10448 Vinhibit_quit
= Qnil
;
10451 #endif /* not MSDOS */
10452 printf ("Garbage collection in progress; cannot auto-save now\r\n");
10453 printf ("but will instead do a real quit after garbage collection ends\r\n");
10458 printf ("\r\nAbort? (y or n) ");
10459 #else /* not MSDOS */
10460 printf ("Abort (and dump core)? (y or n) ");
10461 #endif /* not MSDOS */
10463 if (((c
= getchar ()) & ~040) == 'Y')
10465 while (c
!= '\n') c
= getchar ();
10467 printf ("\r\nContinuing...\r\n");
10468 #else /* not MSDOS */
10469 printf ("Continuing...\n");
10470 #endif /* not MSDOS */
10472 init_all_sys_modes ();
10476 /* If executing a function that wants to be interrupted out of
10477 and the user has not deferred quitting by binding `inhibit-quit'
10478 then quit right away. */
10479 if (immediate_quit
&& NILP (Vinhibit_quit
))
10481 struct gl_state_s saved
;
10482 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
10484 immediate_quit
= 0;
10485 pthread_sigmask (SIG_SETMASK
, &empty_mask
, 0);
10487 GCPRO4 (saved
.object
, saved
.global_code
,
10488 saved
.current_syntax_table
, saved
.old_prop
);
10489 Fsignal (Qquit
, Qnil
);
10494 { /* Else request quit when it's safe. */
10495 int count
= NILP (Vquit_flag
) ? 1 : force_quit_count
+ 1;
10496 force_quit_count
= count
;
10499 immediate_quit
= 1;
10500 Vinhibit_quit
= Qnil
;
10506 pthread_sigmask (SIG_SETMASK
, &empty_mask
, 0);
10508 /* TODO: The longjmp in this call throws the NS event loop integration off,
10509 and it seems to do fine without this. Probably some attention
10510 needs to be paid to the setting of waiting_for_input in
10511 wait_reading_process_output() under HAVE_NS because of the call
10512 to ns_select there (needed because otherwise events aren't picked up
10513 outside of polling since we don't get SIGIO like X and we don't have a
10514 separate event loop thread like W32. */
10516 if (waiting_for_input
&& !echoing
)
10517 quit_throw_to_read_char (in_signal_handler
);
10521 /* Handle a C-g by making read_char return C-g. */
10524 quit_throw_to_read_char (bool from_signal
)
10526 /* When not called from a signal handler it is safe to call
10528 if (!from_signal
&& EQ (Vquit_flag
, Qkill_emacs
))
10529 Fkill_emacs (Qnil
);
10531 /* Prevent another signal from doing this before we finish. */
10532 clear_waiting_for_input ();
10535 Vunread_command_events
= Qnil
;
10537 if (FRAMEP (internal_last_event_frame
)
10538 && !EQ (internal_last_event_frame
, selected_frame
))
10539 do_switch_frame (make_lispy_switch_frame (internal_last_event_frame
),
10542 sys_longjmp (getcjmp
, 1);
10545 DEFUN ("set-input-interrupt-mode", Fset_input_interrupt_mode
,
10546 Sset_input_interrupt_mode
, 1, 1, 0,
10547 doc
: /* Set interrupt mode of reading keyboard input.
10548 If INTERRUPT is non-nil, Emacs will use input interrupts;
10549 otherwise Emacs uses CBREAK mode.
10551 See also `current-input-mode'. */)
10552 (Lisp_Object interrupt
)
10554 bool new_interrupt_input
;
10555 #ifdef USABLE_SIGIO
10556 #ifdef HAVE_X_WINDOWS
10557 if (x_display_list
!= NULL
)
10559 /* When using X, don't give the user a real choice,
10560 because we haven't implemented the mechanisms to support it. */
10561 new_interrupt_input
= 1;
10564 #endif /* HAVE_X_WINDOWS */
10565 new_interrupt_input
= !NILP (interrupt
);
10566 #else /* not USABLE_SIGIO */
10567 new_interrupt_input
= 0;
10568 #endif /* not USABLE_SIGIO */
10570 if (new_interrupt_input
!= interrupt_input
)
10572 #ifdef POLL_FOR_INPUT
10576 /* this causes startup screen to be restored and messes with the mouse */
10577 reset_all_sys_modes ();
10578 interrupt_input
= new_interrupt_input
;
10579 init_all_sys_modes ();
10581 interrupt_input
= new_interrupt_input
;
10584 #ifdef POLL_FOR_INPUT
10585 poll_suppress_count
= 1;
10592 DEFUN ("set-output-flow-control", Fset_output_flow_control
, Sset_output_flow_control
, 1, 2, 0,
10593 doc
: /* Enable or disable ^S/^Q flow control for output to TERMINAL.
10594 If FLOW is non-nil, flow control is enabled and you cannot use C-s or
10595 C-q in key sequences.
10597 This setting only has an effect on tty terminals and only when
10598 Emacs reads input in CBREAK mode; see `set-input-interrupt-mode'.
10600 See also `current-input-mode'. */)
10601 (Lisp_Object flow
, Lisp_Object terminal
)
10603 struct terminal
*t
= decode_tty_terminal (terminal
);
10604 struct tty_display_info
*tty
;
10608 tty
= t
->display_info
.tty
;
10610 if (tty
->flow_control
!= !NILP (flow
))
10613 /* This causes startup screen to be restored and messes with the mouse. */
10614 reset_sys_modes (tty
);
10617 tty
->flow_control
= !NILP (flow
);
10620 init_sys_modes (tty
);
10626 DEFUN ("set-input-meta-mode", Fset_input_meta_mode
, Sset_input_meta_mode
, 1, 2, 0,
10627 doc
: /* Enable or disable 8-bit input on TERMINAL.
10628 If META is t, Emacs will accept 8-bit input, and interpret the 8th
10629 bit as the Meta modifier.
10631 If META is nil, Emacs will ignore the top bit, on the assumption it is
10634 Otherwise, Emacs will accept and pass through 8-bit input without
10635 specially interpreting the top bit.
10637 This setting only has an effect on tty terminal devices.
10639 Optional parameter TERMINAL specifies the tty terminal device to use.
10640 It may be a terminal object, a frame, or nil for the terminal used by
10641 the currently selected frame.
10643 See also `current-input-mode'. */)
10644 (Lisp_Object meta
, Lisp_Object terminal
)
10646 struct terminal
*t
= decode_tty_terminal (terminal
);
10647 struct tty_display_info
*tty
;
10652 tty
= t
->display_info
.tty
;
10656 else if (EQ (meta
, Qt
))
10661 if (tty
->meta_key
!= new_meta
)
10664 /* this causes startup screen to be restored and messes with the mouse */
10665 reset_sys_modes (tty
);
10668 tty
->meta_key
= new_meta
;
10671 init_sys_modes (tty
);
10677 DEFUN ("set-quit-char", Fset_quit_char
, Sset_quit_char
, 1, 1, 0,
10678 doc
: /* Specify character used for quitting.
10679 QUIT must be an ASCII character.
10681 This function only has an effect on the controlling tty of the Emacs
10684 See also `current-input-mode'. */)
10687 struct terminal
*t
= get_named_terminal ("/dev/tty");
10688 struct tty_display_info
*tty
;
10692 tty
= t
->display_info
.tty
;
10694 if (NILP (quit
) || !INTEGERP (quit
) || XINT (quit
) < 0 || XINT (quit
) > 0400)
10695 error ("QUIT must be an ASCII character");
10698 /* this causes startup screen to be restored and messes with the mouse */
10699 reset_sys_modes (tty
);
10702 /* Don't let this value be out of range. */
10703 quit_char
= XINT (quit
) & (tty
->meta_key
== 0 ? 0177 : 0377);
10706 init_sys_modes (tty
);
10712 DEFUN ("set-input-mode", Fset_input_mode
, Sset_input_mode
, 3, 4, 0,
10713 doc
: /* Set mode of reading keyboard input.
10714 First arg INTERRUPT non-nil means use input interrupts;
10715 nil means use CBREAK mode.
10716 Second arg FLOW non-nil means use ^S/^Q flow control for output to terminal
10717 (no effect except in CBREAK mode).
10718 Third arg META t means accept 8-bit input (for a Meta key).
10719 META nil means ignore the top bit, on the assumption it is parity.
10720 Otherwise, accept 8-bit input and don't use the top bit for Meta.
10721 Optional fourth arg QUIT if non-nil specifies character to use for quitting.
10722 See also `current-input-mode'. */)
10723 (Lisp_Object interrupt
, Lisp_Object flow
, Lisp_Object meta
, Lisp_Object quit
)
10725 Fset_input_interrupt_mode (interrupt
);
10726 Fset_output_flow_control (flow
, Qnil
);
10727 Fset_input_meta_mode (meta
, Qnil
);
10729 Fset_quit_char (quit
);
10733 DEFUN ("current-input-mode", Fcurrent_input_mode
, Scurrent_input_mode
, 0, 0, 0,
10734 doc
: /* Return information about the way Emacs currently reads keyboard input.
10735 The value is a list of the form (INTERRUPT FLOW META QUIT), where
10736 INTERRUPT is non-nil if Emacs is using interrupt-driven input; if
10737 nil, Emacs is using CBREAK mode.
10738 FLOW is non-nil if Emacs uses ^S/^Q flow control for output to the
10739 terminal; this does not apply if Emacs uses interrupt-driven input.
10740 META is t if accepting 8-bit input with 8th bit as Meta flag.
10741 META nil means ignoring the top bit, on the assumption it is parity.
10742 META is neither t nor nil if accepting 8-bit input and using
10743 all 8 bits as the character code.
10744 QUIT is the character Emacs currently uses to quit.
10745 The elements of this list correspond to the arguments of
10746 `set-input-mode'. */)
10749 struct frame
*sf
= XFRAME (selected_frame
);
10751 Lisp_Object interrupt
= interrupt_input
? Qt
: Qnil
;
10752 Lisp_Object flow
, meta
;
10753 if (FRAME_TERMCAP_P (sf
) || FRAME_MSDOS_P (sf
))
10755 flow
= FRAME_TTY (sf
)->flow_control
? Qt
: Qnil
;
10756 meta
= (FRAME_TTY (sf
)->meta_key
== 2
10758 : (CURTTY ()->meta_key
== 1 ? Qt
: Qnil
));
10765 Lisp_Object quit
= make_number (quit_char
);
10767 return list4 (interrupt
, flow
, meta
, quit
);
10770 DEFUN ("posn-at-x-y", Fposn_at_x_y
, Sposn_at_x_y
, 2, 4, 0,
10771 doc
: /* Return position information for pixel coordinates X and Y.
10772 By default, X and Y are relative to text area of the selected window.
10773 Optional third arg FRAME-OR-WINDOW non-nil specifies frame or window.
10774 If optional fourth arg WHOLE is non-nil, X is relative to the left
10775 edge of the window.
10777 The return value is similar to a mouse click position:
10778 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
10779 IMAGE (DX . DY) (WIDTH . HEIGHT))
10780 The `posn-' functions access elements of such lists. */)
10781 (Lisp_Object x
, Lisp_Object y
, Lisp_Object frame_or_window
, Lisp_Object whole
)
10786 if (NILP (frame_or_window
))
10787 frame_or_window
= selected_window
;
10789 if (WINDOWP (frame_or_window
))
10791 struct window
*w
= decode_live_window (frame_or_window
);
10793 XSETINT (x
, (XINT (x
)
10794 + WINDOW_LEFT_EDGE_X (w
)
10796 ? window_box_left_offset (w
, TEXT_AREA
)
10798 XSETINT (y
, WINDOW_TO_FRAME_PIXEL_Y (w
, XINT (y
)));
10799 frame_or_window
= w
->frame
;
10802 CHECK_LIVE_FRAME (frame_or_window
);
10804 return make_lispy_position (XFRAME (frame_or_window
), x
, y
, 0);
10807 DEFUN ("posn-at-point", Fposn_at_point
, Sposn_at_point
, 0, 2, 0,
10808 doc
: /* Return position information for buffer POS in WINDOW.
10809 POS defaults to point in WINDOW; WINDOW defaults to the selected window.
10811 Return nil if position is not visible in window. Otherwise,
10812 the return value is similar to that returned by `event-start' for
10813 a mouse click at the upper left corner of the glyph corresponding
10814 to the given buffer position:
10815 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
10816 IMAGE (DX . DY) (WIDTH . HEIGHT))
10817 The `posn-' functions access elements of such lists. */)
10818 (Lisp_Object pos
, Lisp_Object window
)
10823 window
= selected_window
;
10825 tem
= Fpos_visible_in_window_p (pos
, window
, Qt
);
10828 Lisp_Object x
= XCAR (tem
);
10829 Lisp_Object y
= XCAR (XCDR (tem
));
10831 /* Point invisible due to hscrolling? */
10834 tem
= Fposn_at_x_y (x
, y
, window
, Qnil
);
10840 /* Set up a new kboard object with reasonable initial values.
10841 TYPE is a window system for which this keyboard is used. */
10844 init_kboard (KBOARD
*kb
, Lisp_Object type
)
10846 kset_overriding_terminal_local_map (kb
, Qnil
);
10847 kset_last_command (kb
, Qnil
);
10848 kset_real_last_command (kb
, Qnil
);
10849 kset_keyboard_translate_table (kb
, Qnil
);
10850 kset_last_repeatable_command (kb
, Qnil
);
10851 kset_prefix_arg (kb
, Qnil
);
10852 kset_last_prefix_arg (kb
, Qnil
);
10853 kset_kbd_queue (kb
, Qnil
);
10854 kb
->kbd_queue_has_data
= 0;
10855 kb
->immediate_echo
= 0;
10856 kset_echo_string (kb
, Qnil
);
10857 kb
->echo_after_prompt
= -1;
10858 kb
->kbd_macro_buffer
= 0;
10859 kb
->kbd_macro_bufsize
= 0;
10860 kset_defining_kbd_macro (kb
, Qnil
);
10861 kset_last_kbd_macro (kb
, Qnil
);
10862 kb
->reference_count
= 0;
10863 kset_system_key_alist (kb
, Qnil
);
10864 kset_system_key_syms (kb
, Qnil
);
10865 kset_window_system (kb
, type
);
10866 kset_input_decode_map (kb
, Fmake_sparse_keymap (Qnil
));
10867 kset_local_function_key_map (kb
, Fmake_sparse_keymap (Qnil
));
10868 Fset_keymap_parent (KVAR (kb
, Vlocal_function_key_map
), Vfunction_key_map
);
10869 kset_default_minibuffer_frame (kb
, Qnil
);
10872 /* Allocate and basically initialize keyboard
10873 object to use with window system TYPE. */
10876 allocate_kboard (Lisp_Object type
)
10878 KBOARD
*kb
= xmalloc (sizeof *kb
);
10880 init_kboard (kb
, type
);
10881 kb
->next_kboard
= all_kboards
;
10887 * Destroy the contents of a kboard object, but not the object itself.
10888 * We use this just before deleting it, or if we're going to initialize
10889 * it a second time.
10892 wipe_kboard (KBOARD
*kb
)
10894 xfree (kb
->kbd_macro_buffer
);
10897 /* Free KB and memory referenced from it. */
10900 delete_kboard (KBOARD
*kb
)
10904 for (kbp
= &all_kboards
; *kbp
!= kb
; kbp
= &(*kbp
)->next_kboard
)
10907 *kbp
= kb
->next_kboard
;
10909 /* Prevent a dangling reference to KB. */
10910 if (kb
== current_kboard
10911 && FRAMEP (selected_frame
)
10912 && FRAME_LIVE_P (XFRAME (selected_frame
)))
10914 current_kboard
= FRAME_KBOARD (XFRAME (selected_frame
));
10916 if (current_kboard
== kb
)
10925 init_keyboard (void)
10927 /* This is correct before outermost invocation of the editor loop. */
10928 command_loop_level
= -1;
10929 immediate_quit
= 0;
10930 quit_char
= Ctl ('g');
10931 Vunread_command_events
= Qnil
;
10932 timer_idleness_start_time
= invalid_timespec ();
10934 recent_keys_index
= 0;
10935 kbd_fetch_ptr
= kbd_buffer
;
10936 kbd_store_ptr
= kbd_buffer
;
10937 do_mouse_tracking
= Qnil
;
10939 interrupt_input_blocked
= 0;
10940 pending_signals
= 0;
10942 /* This means that command_loop_1 won't try to select anything the first
10944 internal_last_event_frame
= Qnil
;
10945 Vlast_event_frame
= internal_last_event_frame
;
10947 current_kboard
= initial_kboard
;
10948 /* Re-initialize the keyboard again. */
10949 wipe_kboard (current_kboard
);
10950 /* A value of nil for Vwindow_system normally means a tty, but we also use
10951 it for the initial terminal since there is no window system there. */
10952 init_kboard (current_kboard
, Qnil
);
10954 if (!noninteractive
)
10956 /* Before multi-tty support, these handlers used to be installed
10957 only if the current session was a tty session. Now an Emacs
10958 session may have multiple display types, so we always handle
10959 SIGINT. There is special code in handle_interrupt_signal to exit
10960 Emacs on SIGINT when there are no termcap frames on the
10961 controlling terminal. */
10962 struct sigaction action
;
10963 emacs_sigaction_init (&action
, deliver_interrupt_signal
);
10964 sigaction (SIGINT
, &action
, 0);
10966 /* For systems with SysV TERMIO, C-g is set up for both SIGINT and
10967 SIGQUIT and we can't tell which one it will give us. */
10968 sigaction (SIGQUIT
, &action
, 0);
10969 #endif /* not DOS_NT */
10971 #ifdef USABLE_SIGIO
10972 if (!noninteractive
)
10974 struct sigaction action
;
10975 emacs_sigaction_init (&action
, deliver_input_available_signal
);
10976 sigaction (SIGIO
, &action
, 0);
10980 /* Use interrupt input by default, if it works and noninterrupt input
10981 has deficiencies. */
10983 #ifdef INTERRUPT_INPUT
10984 interrupt_input
= 1;
10986 interrupt_input
= 0;
10989 pthread_sigmask (SIG_SETMASK
, &empty_mask
, 0);
10992 if (keyboard_init_hook
)
10993 (*keyboard_init_hook
) ();
10995 #ifdef POLL_FOR_INPUT
10997 poll_suppress_count
= 1;
11002 /* This type's only use is in syms_of_keyboard, to put properties on the
11003 event header symbols. */
11010 static const struct event_head head_table
[] = {
11011 {SYMBOL_INDEX (Qmouse_movement
), SYMBOL_INDEX (Qmouse_movement
)},
11012 {SYMBOL_INDEX (Qscroll_bar_movement
), SYMBOL_INDEX (Qmouse_movement
)},
11014 /* Some of the event heads. */
11015 {SYMBOL_INDEX (Qswitch_frame
), SYMBOL_INDEX (Qswitch_frame
)},
11017 {SYMBOL_INDEX (Qfocus_in
), SYMBOL_INDEX (Qfocus_in
)},
11018 {SYMBOL_INDEX (Qfocus_out
), SYMBOL_INDEX (Qfocus_out
)},
11019 {SYMBOL_INDEX (Qdelete_frame
), SYMBOL_INDEX (Qdelete_frame
)},
11020 {SYMBOL_INDEX (Qiconify_frame
), SYMBOL_INDEX (Qiconify_frame
)},
11021 {SYMBOL_INDEX (Qmake_frame_visible
), SYMBOL_INDEX (Qmake_frame_visible
)},
11022 /* `select-window' should be handled just like `switch-frame'
11023 in read_key_sequence. */
11024 {SYMBOL_INDEX (Qselect_window
), SYMBOL_INDEX (Qswitch_frame
)}
11028 syms_of_keyboard (void)
11030 pending_funcalls
= Qnil
;
11031 staticpro (&pending_funcalls
);
11033 Vlispy_mouse_stem
= build_pure_c_string ("mouse");
11034 staticpro (&Vlispy_mouse_stem
);
11036 regular_top_level_message
= build_pure_c_string ("Back to top level");
11037 #ifdef HAVE_STACK_OVERFLOW_HANDLING
11038 recover_top_level_message
11039 = build_pure_c_string ("Re-entering top level after C stack overflow");
11041 DEFVAR_LISP ("internal--top-level-message", Vinternal__top_level_message
,
11042 doc
: /* Message displayed by `normal-top-level'. */);
11043 Vinternal__top_level_message
= regular_top_level_message
;
11046 DEFSYM (QCimage
, ":image");
11047 DEFSYM (Qhelp_echo
, "help-echo");
11048 DEFSYM (QCrtl
, ":rtl");
11050 staticpro (&item_properties
);
11051 item_properties
= Qnil
;
11053 staticpro (&tool_bar_item_properties
);
11054 tool_bar_item_properties
= Qnil
;
11055 staticpro (&tool_bar_items_vector
);
11056 tool_bar_items_vector
= Qnil
;
11058 DEFSYM (Qtimer_event_handler
, "timer-event-handler");
11059 DEFSYM (Qdisabled_command_function
, "disabled-command-function");
11060 DEFSYM (Qself_insert_command
, "self-insert-command");
11061 DEFSYM (Qforward_char
, "forward-char");
11062 DEFSYM (Qbackward_char
, "backward-char");
11064 /* Non-nil disable property on a command means do not execute it;
11065 call disabled-command-function's value instead. */
11066 DEFSYM (Qdisabled
, "disabled");
11068 DEFSYM (Qundefined
, "undefined");
11070 /* Hooks to run before and after each command. */
11071 DEFSYM (Qpre_command_hook
, "pre-command-hook");
11072 DEFSYM (Qpost_command_hook
, "post-command-hook");
11074 DEFSYM (Qdeferred_action_function
, "deferred-action-function");
11075 DEFSYM (Qdelayed_warnings_hook
, "delayed-warnings-hook");
11076 DEFSYM (Qfunction_key
, "function-key");
11078 /* The values of Qevent_kind properties. */
11079 DEFSYM (Qmouse_click
, "mouse-click");
11081 DEFSYM (Qdrag_n_drop
, "drag-n-drop");
11082 DEFSYM (Qsave_session
, "save-session");
11083 DEFSYM (Qconfig_changed_event
, "config-changed-event");
11085 /* Menu and tool bar item parts. */
11086 DEFSYM (Qmenu_enable
, "menu-enable");
11089 DEFSYM (Qlanguage_change
, "language-change");
11093 DEFSYM (Qdbus_event
, "dbus-event");
11096 #ifdef USE_FILE_NOTIFY
11097 DEFSYM (Qfile_notify
, "file-notify");
11098 #endif /* USE_FILE_NOTIFY */
11100 /* Menu and tool bar item parts. */
11101 DEFSYM (QCenable
, ":enable");
11102 DEFSYM (QCvisible
, ":visible");
11103 DEFSYM (QChelp
, ":help");
11104 DEFSYM (QCfilter
, ":filter");
11105 DEFSYM (QCbutton
, ":button");
11106 DEFSYM (QCkeys
, ":keys");
11107 DEFSYM (QCkey_sequence
, ":key-sequence");
11109 /* Non-nil disable property on a command means
11110 do not execute it; call disabled-command-function's value instead. */
11111 DEFSYM (QCtoggle
, ":toggle");
11112 DEFSYM (QCradio
, ":radio");
11113 DEFSYM (QClabel
, ":label");
11114 DEFSYM (QCvert_only
, ":vert-only");
11116 /* Symbols to use for parts of windows. */
11117 DEFSYM (Qvertical_line
, "vertical-line");
11118 DEFSYM (Qright_divider
, "right-divider");
11119 DEFSYM (Qbottom_divider
, "bottom-divider");
11121 DEFSYM (Qmouse_fixup_help_message
, "mouse-fixup-help-message");
11123 DEFSYM (Qabove_handle
, "above-handle");
11124 DEFSYM (Qhandle
, "handle");
11125 DEFSYM (Qbelow_handle
, "below-handle");
11126 DEFSYM (Qup
, "up");
11127 DEFSYM (Qdown
, "down");
11128 DEFSYM (Qtop
, "top");
11129 DEFSYM (Qbottom
, "bottom");
11130 DEFSYM (Qend_scroll
, "end-scroll");
11131 DEFSYM (Qratio
, "ratio");
11132 DEFSYM (Qbefore_handle
, "before-handle");
11133 DEFSYM (Qhorizontal_handle
, "horizontal-handle");
11134 DEFSYM (Qafter_handle
, "after-handle");
11135 DEFSYM (Qleft
, "left");
11136 DEFSYM (Qright
, "right");
11137 DEFSYM (Qleftmost
, "leftmost");
11138 DEFSYM (Qrightmost
, "rightmost");
11140 /* Properties of event headers. */
11141 DEFSYM (Qevent_kind
, "event-kind");
11142 DEFSYM (Qevent_symbol_elements
, "event-symbol-elements");
11144 /* An event header symbol HEAD may have a property named
11145 Qevent_symbol_element_mask, which is of the form (BASE MODIFIERS);
11146 BASE is the base, unmodified version of HEAD, and MODIFIERS is the
11147 mask of modifiers applied to it. If present, this is used to help
11148 speed up parse_modifiers. */
11149 DEFSYM (Qevent_symbol_element_mask
, "event-symbol-element-mask");
11151 /* An unmodified event header BASE may have a property named
11152 Qmodifier_cache, which is an alist mapping modifier masks onto
11153 modified versions of BASE. If present, this helps speed up
11154 apply_modifiers. */
11155 DEFSYM (Qmodifier_cache
, "modifier-cache");
11157 DEFSYM (Qrecompute_lucid_menubar
, "recompute-lucid-menubar");
11158 DEFSYM (Qactivate_menubar_hook
, "activate-menubar-hook");
11160 DEFSYM (Qpolling_period
, "polling-period");
11162 DEFSYM (Qgui_set_selection
, "gui-set-selection");
11164 /* The primary selection. */
11165 DEFSYM (QPRIMARY
, "PRIMARY");
11167 DEFSYM (Qhandle_switch_frame
, "handle-switch-frame");
11168 DEFSYM (Qhandle_select_window
, "handle-select-window");
11170 DEFSYM (Qinput_method_function
, "input-method-function");
11171 DEFSYM (Qinput_method_exit_on_first_char
, "input-method-exit-on-first-char");
11172 DEFSYM (Qinput_method_use_echo_area
, "input-method-use-echo-area");
11174 DEFSYM (Qhelp_form_show
, "help-form-show");
11176 DEFSYM (Qecho_keystrokes
, "echo-keystrokes");
11178 Fset (Qinput_method_exit_on_first_char
, Qnil
);
11179 Fset (Qinput_method_use_echo_area
, Qnil
);
11181 /* Symbols to head events. */
11182 DEFSYM (Qmouse_movement
, "mouse-movement");
11183 DEFSYM (Qscroll_bar_movement
, "scroll-bar-movement");
11184 DEFSYM (Qswitch_frame
, "switch-frame");
11185 DEFSYM (Qfocus_in
, "focus-in");
11186 DEFSYM (Qfocus_out
, "focus-out");
11187 DEFSYM (Qdelete_frame
, "delete-frame");
11188 DEFSYM (Qiconify_frame
, "iconify-frame");
11189 DEFSYM (Qmake_frame_visible
, "make-frame-visible");
11190 DEFSYM (Qselect_window
, "select-window");
11194 for (i
= 0; i
< ARRAYELTS (head_table
); i
++)
11196 const struct event_head
*p
= &head_table
[i
];
11197 Lisp_Object var
= builtin_lisp_symbol (p
->var
);
11198 Lisp_Object kind
= builtin_lisp_symbol (p
->kind
);
11199 Fput (var
, Qevent_kind
, kind
);
11200 Fput (var
, Qevent_symbol_elements
, list1 (var
));
11204 button_down_location
= Fmake_vector (make_number (5), Qnil
);
11205 staticpro (&button_down_location
);
11206 mouse_syms
= Fmake_vector (make_number (5), Qnil
);
11207 staticpro (&mouse_syms
);
11208 wheel_syms
= Fmake_vector (make_number (ARRAYELTS (lispy_wheel_names
)),
11210 staticpro (&wheel_syms
);
11214 int len
= ARRAYELTS (modifier_names
);
11216 modifier_symbols
= Fmake_vector (make_number (len
), Qnil
);
11217 for (i
= 0; i
< len
; i
++)
11218 if (modifier_names
[i
])
11219 ASET (modifier_symbols
, i
, intern_c_string (modifier_names
[i
]));
11220 staticpro (&modifier_symbols
);
11223 recent_keys
= Fmake_vector (make_number (NUM_RECENT_KEYS
), Qnil
);
11224 staticpro (&recent_keys
);
11226 this_command_keys
= Fmake_vector (make_number (40), Qnil
);
11227 staticpro (&this_command_keys
);
11229 raw_keybuf
= Fmake_vector (make_number (30), Qnil
);
11230 staticpro (&raw_keybuf
);
11232 DEFSYM (Qcommand_execute
, "command-execute");
11234 accent_key_syms
= Qnil
;
11235 staticpro (&accent_key_syms
);
11237 func_key_syms
= Qnil
;
11238 staticpro (&func_key_syms
);
11240 drag_n_drop_syms
= Qnil
;
11241 staticpro (&drag_n_drop_syms
);
11243 unread_switch_frame
= Qnil
;
11244 staticpro (&unread_switch_frame
);
11246 internal_last_event_frame
= Qnil
;
11247 staticpro (&internal_last_event_frame
);
11249 read_key_sequence_cmd
= Qnil
;
11250 staticpro (&read_key_sequence_cmd
);
11251 read_key_sequence_remapped
= Qnil
;
11252 staticpro (&read_key_sequence_remapped
);
11254 menu_bar_one_keymap_changed_items
= Qnil
;
11255 staticpro (&menu_bar_one_keymap_changed_items
);
11257 menu_bar_items_vector
= Qnil
;
11258 staticpro (&menu_bar_items_vector
);
11260 help_form_saved_window_configs
= Qnil
;
11261 staticpro (&help_form_saved_window_configs
);
11263 defsubr (&Scurrent_idle_time
);
11264 defsubr (&Sevent_symbol_parse_modifiers
);
11265 defsubr (&Sevent_convert_list
);
11266 defsubr (&Sread_key_sequence
);
11267 defsubr (&Sread_key_sequence_vector
);
11268 defsubr (&Srecursive_edit
);
11269 defsubr (&Strack_mouse
);
11270 defsubr (&Sinput_pending_p
);
11271 defsubr (&Srecent_keys
);
11272 defsubr (&Sthis_command_keys
);
11273 defsubr (&Sthis_command_keys_vector
);
11274 defsubr (&Sthis_single_command_keys
);
11275 defsubr (&Sthis_single_command_raw_keys
);
11276 defsubr (&Sreset_this_command_lengths
);
11277 defsubr (&Sclear_this_command_keys
);
11278 defsubr (&Ssuspend_emacs
);
11279 defsubr (&Sabort_recursive_edit
);
11280 defsubr (&Sexit_recursive_edit
);
11281 defsubr (&Srecursion_depth
);
11282 defsubr (&Scommand_error_default_function
);
11283 defsubr (&Stop_level
);
11284 defsubr (&Sdiscard_input
);
11285 defsubr (&Sopen_dribble_file
);
11286 defsubr (&Sset_input_interrupt_mode
);
11287 defsubr (&Sset_output_flow_control
);
11288 defsubr (&Sset_input_meta_mode
);
11289 defsubr (&Sset_quit_char
);
11290 defsubr (&Sset_input_mode
);
11291 defsubr (&Scurrent_input_mode
);
11292 defsubr (&Sposn_at_point
);
11293 defsubr (&Sposn_at_x_y
);
11295 DEFVAR_LISP ("last-command-event", last_command_event
,
11296 doc
: /* Last input event that was part of a command. */);
11298 DEFVAR_LISP ("last-nonmenu-event", last_nonmenu_event
,
11299 doc
: /* Last input event in a command, except for mouse menu events.
11300 Mouse menus give back keys that don't look like mouse events;
11301 this variable holds the actual mouse event that led to the menu,
11302 so that you can determine whether the command was run by mouse or not. */);
11304 DEFVAR_LISP ("last-input-event", last_input_event
,
11305 doc
: /* Last input event. */);
11307 DEFVAR_LISP ("unread-command-events", Vunread_command_events
,
11308 doc
: /* List of events to be read as the command input.
11309 These events are processed first, before actual keyboard input.
11310 Events read from this list are not normally added to `this-command-keys',
11311 as they will already have been added once as they were read for the first time.
11312 An element of the form (t . EVENT) forces EVENT to be added to that list. */);
11313 Vunread_command_events
= Qnil
;
11315 DEFVAR_LISP ("unread-post-input-method-events", Vunread_post_input_method_events
,
11316 doc
: /* List of events to be processed as input by input methods.
11317 These events are processed before `unread-command-events'
11318 and actual keyboard input, but are not given to `input-method-function'. */);
11319 Vunread_post_input_method_events
= Qnil
;
11321 DEFVAR_LISP ("unread-input-method-events", Vunread_input_method_events
,
11322 doc
: /* List of events to be processed as input by input methods.
11323 These events are processed after `unread-command-events', but
11324 before actual keyboard input.
11325 If there's an active input method, the events are given to
11326 `input-method-function'. */);
11327 Vunread_input_method_events
= Qnil
;
11329 DEFVAR_LISP ("meta-prefix-char", meta_prefix_char
,
11330 doc
: /* Meta-prefix character code.
11331 Meta-foo as command input turns into this character followed by foo. */);
11332 XSETINT (meta_prefix_char
, 033);
11334 DEFVAR_KBOARD ("last-command", Vlast_command
,
11335 doc
: /* The last command executed.
11336 Normally a symbol with a function definition, but can be whatever was found
11337 in the keymap, or whatever the variable `this-command' was set to by that
11340 The value `mode-exit' is special; it means that the previous command
11341 read an event that told it to exit, and it did so and unread that event.
11342 In other words, the present command is the event that made the previous
11345 The value `kill-region' is special; it means that the previous command
11346 was a kill command.
11348 `last-command' has a separate binding for each terminal device.
11349 See Info node `(elisp)Multiple Terminals'. */);
11351 DEFVAR_KBOARD ("real-last-command", Vreal_last_command
,
11352 doc
: /* Same as `last-command', but never altered by Lisp code.
11353 Taken from the previous value of `real-this-command'. */);
11355 DEFVAR_KBOARD ("last-repeatable-command", Vlast_repeatable_command
,
11356 doc
: /* Last command that may be repeated.
11357 The last command executed that was not bound to an input event.
11358 This is the command `repeat' will try to repeat.
11359 Taken from a previous value of `real-this-command'. */);
11361 DEFVAR_LISP ("this-command", Vthis_command
,
11362 doc
: /* The command now being executed.
11363 The command can set this variable; whatever is put here
11364 will be in `last-command' during the following command. */);
11365 Vthis_command
= Qnil
;
11367 DEFVAR_LISP ("real-this-command", Vreal_this_command
,
11368 doc
: /* This is like `this-command', except that commands should never modify it. */);
11369 Vreal_this_command
= Qnil
;
11371 DEFVAR_LISP ("this-command-keys-shift-translated",
11372 Vthis_command_keys_shift_translated
,
11373 doc
: /* Non-nil if the key sequence activating this command was shift-translated.
11374 Shift-translation occurs when there is no binding for the key sequence
11375 as entered, but a binding was found by changing an upper-case letter
11376 to lower-case, or a shifted function key to an unshifted one. */);
11377 Vthis_command_keys_shift_translated
= Qnil
;
11379 DEFVAR_LISP ("this-original-command", Vthis_original_command
,
11380 doc
: /* The command bound to the current key sequence before remapping.
11381 It equals `this-command' if the original command was not remapped through
11382 any of the active keymaps. Otherwise, the value of `this-command' is the
11383 result of looking up the original command in the active keymaps. */);
11384 Vthis_original_command
= Qnil
;
11386 DEFVAR_INT ("auto-save-interval", auto_save_interval
,
11387 doc
: /* Number of input events between auto-saves.
11388 Zero means disable autosaving due to number of characters typed. */);
11389 auto_save_interval
= 300;
11391 DEFVAR_LISP ("auto-save-timeout", Vauto_save_timeout
,
11392 doc
: /* Number of seconds idle time before auto-save.
11393 Zero or nil means disable auto-saving due to idleness.
11394 After auto-saving due to this many seconds of idle time,
11395 Emacs also does a garbage collection if that seems to be warranted. */);
11396 XSETFASTINT (Vauto_save_timeout
, 30);
11398 DEFVAR_LISP ("echo-keystrokes", Vecho_keystrokes
,
11399 doc
: /* Nonzero means echo unfinished commands after this many seconds of pause.
11400 The value may be integer or floating point.
11401 If the value is zero, don't echo at all. */);
11402 Vecho_keystrokes
= make_number (1);
11404 DEFVAR_INT ("polling-period", polling_period
,
11405 doc
: /* Interval between polling for input during Lisp execution.
11406 The reason for polling is to make C-g work to stop a running program.
11407 Polling is needed only when using X windows and SIGIO does not work.
11408 Polling is automatically disabled in all other cases. */);
11409 polling_period
= 2;
11411 DEFVAR_LISP ("double-click-time", Vdouble_click_time
,
11412 doc
: /* Maximum time between mouse clicks to make a double-click.
11413 Measured in milliseconds. The value nil means disable double-click
11414 recognition; t means double-clicks have no time limit and are detected
11415 by position only. */);
11416 Vdouble_click_time
= make_number (500);
11418 DEFVAR_INT ("double-click-fuzz", double_click_fuzz
,
11419 doc
: /* Maximum mouse movement between clicks to make a double-click.
11420 On window-system frames, value is the number of pixels the mouse may have
11421 moved horizontally or vertically between two clicks to make a double-click.
11422 On non window-system frames, value is interpreted in units of 1/8 characters
11425 This variable is also the threshold for motion of the mouse
11426 to count as a drag. */);
11427 double_click_fuzz
= 3;
11429 DEFVAR_INT ("num-input-keys", num_input_keys
,
11430 doc
: /* Number of complete key sequences read as input so far.
11431 This includes key sequences read from keyboard macros.
11432 The number is effectively the number of interactive command invocations. */);
11433 num_input_keys
= 0;
11435 DEFVAR_INT ("num-nonmacro-input-events", num_nonmacro_input_events
,
11436 doc
: /* Number of input events read from the keyboard so far.
11437 This does not include events generated by keyboard macros. */);
11438 num_nonmacro_input_events
= 0;
11440 DEFVAR_LISP ("last-event-frame", Vlast_event_frame
,
11441 doc
: /* The frame in which the most recently read event occurred.
11442 If the last event came from a keyboard macro, this is set to `macro'. */);
11443 Vlast_event_frame
= Qnil
;
11445 /* This variable is set up in sysdep.c. */
11446 DEFVAR_LISP ("tty-erase-char", Vtty_erase_char
,
11447 doc
: /* The ERASE character as set by the user with stty. */);
11449 DEFVAR_LISP ("help-char", Vhelp_char
,
11450 doc
: /* Character to recognize as meaning Help.
11451 When it is read, do `(eval help-form)', and display result if it's a string.
11452 If the value of `help-form' is nil, this char can be read normally. */);
11453 XSETINT (Vhelp_char
, Ctl ('H'));
11455 DEFVAR_LISP ("help-event-list", Vhelp_event_list
,
11456 doc
: /* List of input events to recognize as meaning Help.
11457 These work just like the value of `help-char' (see that). */);
11458 Vhelp_event_list
= Qnil
;
11460 DEFVAR_LISP ("help-form", Vhelp_form
,
11461 doc
: /* Form to execute when character `help-char' is read.
11462 If the form returns a string, that string is displayed.
11463 If `help-form' is nil, the help char is not recognized. */);
11466 DEFVAR_LISP ("prefix-help-command", Vprefix_help_command
,
11467 doc
: /* Command to run when `help-char' character follows a prefix key.
11468 This command is used only when there is no actual binding
11469 for that character after that prefix key. */);
11470 Vprefix_help_command
= Qnil
;
11472 DEFVAR_LISP ("top-level", Vtop_level
,
11473 doc
: /* Form to evaluate when Emacs starts up.
11474 Useful to set before you dump a modified Emacs. */);
11477 DEFVAR_KBOARD ("keyboard-translate-table", Vkeyboard_translate_table
,
11478 doc
: /* Translate table for local keyboard input, or nil.
11479 If non-nil, the value should be a char-table. Each character read
11480 from the keyboard is looked up in this char-table. If the value found
11481 there is non-nil, then it is used instead of the actual input character.
11483 The value can also be a string or vector, but this is considered obsolete.
11484 If it is a string or vector of length N, character codes N and up are left
11485 untranslated. In a vector, an element which is nil means "no translation".
11487 This is applied to the characters supplied to input methods, not their
11488 output. See also `translation-table-for-input'.
11490 This variable has a separate binding for each terminal.
11491 See Info node `(elisp)Multiple Terminals'. */);
11493 DEFVAR_BOOL ("cannot-suspend", cannot_suspend
,
11494 doc
: /* Non-nil means to always spawn a subshell instead of suspending.
11495 \(Even if the operating system has support for stopping a process.\) */);
11496 cannot_suspend
= 0;
11498 DEFVAR_BOOL ("menu-prompting", menu_prompting
,
11499 doc
: /* Non-nil means prompt with menus when appropriate.
11500 This is done when reading from a keymap that has a prompt string,
11501 for elements that have prompt strings.
11502 The menu is displayed on the screen
11503 if X menus were enabled at configuration
11504 time and the previous event was a mouse click prefix key.
11505 Otherwise, menu prompting uses the echo area. */);
11506 menu_prompting
= 1;
11508 DEFVAR_LISP ("menu-prompt-more-char", menu_prompt_more_char
,
11509 doc
: /* Character to see next line of menu prompt.
11510 Type this character while in a menu prompt to rotate around the lines of it. */);
11511 XSETINT (menu_prompt_more_char
, ' ');
11513 DEFVAR_INT ("extra-keyboard-modifiers", extra_keyboard_modifiers
,
11514 doc
: /* A mask of additional modifier keys to use with every keyboard character.
11515 Emacs applies the modifiers of the character stored here to each keyboard
11516 character it reads. For example, after evaluating the expression
11517 (setq extra-keyboard-modifiers ?\\C-x)
11518 all input characters will have the control modifier applied to them.
11520 Note that the character ?\\C-@, equivalent to the integer zero, does
11521 not count as a control character; rather, it counts as a character
11522 with no modifiers; thus, setting `extra-keyboard-modifiers' to zero
11523 cancels any modification. */);
11524 extra_keyboard_modifiers
= 0;
11526 DEFSYM (Qdeactivate_mark
, "deactivate-mark");
11527 DEFVAR_LISP ("deactivate-mark", Vdeactivate_mark
,
11528 doc
: /* If an editing command sets this to t, deactivate the mark afterward.
11529 The command loop sets this to nil before each command,
11530 and tests the value when the command returns.
11531 Buffer modification stores t in this variable. */);
11532 Vdeactivate_mark
= Qnil
;
11533 Fmake_variable_buffer_local (Qdeactivate_mark
);
11535 DEFVAR_LISP ("pre-command-hook", Vpre_command_hook
,
11536 doc
: /* Normal hook run before each command is executed.
11537 If an unhandled error happens in running this hook,
11538 the function in which the error occurred is unconditionally removed, since
11539 otherwise the error might happen repeatedly and make Emacs nonfunctional. */);
11540 Vpre_command_hook
= Qnil
;
11542 DEFVAR_LISP ("post-command-hook", Vpost_command_hook
,
11543 doc
: /* Normal hook run after each command is executed.
11544 If an unhandled error happens in running this hook,
11545 the function in which the error occurred is unconditionally removed, since
11546 otherwise the error might happen repeatedly and make Emacs nonfunctional. */);
11547 Vpost_command_hook
= Qnil
;
11550 DEFVAR_LISP ("echo-area-clear-hook", ...,
11551 doc
: /* Normal hook run when clearing the echo area. */);
11553 DEFSYM (Qecho_area_clear_hook
, "echo-area-clear-hook");
11554 Fset (Qecho_area_clear_hook
, Qnil
);
11556 DEFVAR_LISP ("lucid-menu-bar-dirty-flag", Vlucid_menu_bar_dirty_flag
,
11557 doc
: /* Non-nil means menu bar, specified Lucid style, needs to be recomputed. */);
11558 Vlucid_menu_bar_dirty_flag
= Qnil
;
11560 DEFVAR_LISP ("menu-bar-final-items", Vmenu_bar_final_items
,
11561 doc
: /* List of menu bar items to move to the end of the menu bar.
11562 The elements of the list are event types that may have menu bar bindings. */);
11563 Vmenu_bar_final_items
= Qnil
;
11565 DEFVAR_LISP ("tool-bar-separator-image-expression", Vtool_bar_separator_image_expression
,
11566 doc
: /* Expression evaluating to the image spec for a tool-bar separator.
11567 This is used internally by graphical displays that do not render
11568 tool-bar separators natively. Otherwise it is unused (e.g. on GTK). */);
11569 Vtool_bar_separator_image_expression
= Qnil
;
11571 DEFVAR_KBOARD ("overriding-terminal-local-map",
11572 Voverriding_terminal_local_map
,
11573 doc
: /* Per-terminal keymap that takes precedence over all other keymaps.
11574 This variable is intended to let commands such as `universal-argument'
11575 set up a different keymap for reading the next command.
11577 `overriding-terminal-local-map' has a separate binding for each
11578 terminal device. See Info node `(elisp)Multiple Terminals'. */);
11580 DEFVAR_LISP ("overriding-local-map", Voverriding_local_map
,
11581 doc
: /* Keymap that replaces (overrides) local keymaps.
11582 If this variable is non-nil, Emacs looks up key bindings in this
11583 keymap INSTEAD OF the keymap char property, minor mode maps, and the
11584 buffer's local map. Hence, the only active keymaps would be
11585 `overriding-terminal-local-map', this keymap, and `global-keymap', in
11586 order of precedence. */);
11587 Voverriding_local_map
= Qnil
;
11589 DEFVAR_LISP ("overriding-local-map-menu-flag", Voverriding_local_map_menu_flag
,
11590 doc
: /* Non-nil means `overriding-local-map' applies to the menu bar.
11591 Otherwise, the menu bar continues to reflect the buffer's local map
11592 and the minor mode maps regardless of `overriding-local-map'. */);
11593 Voverriding_local_map_menu_flag
= Qnil
;
11595 DEFVAR_LISP ("special-event-map", Vspecial_event_map
,
11596 doc
: /* Keymap defining bindings for special events to execute at low level. */);
11597 Vspecial_event_map
= list1 (intern_c_string ("keymap"));
11599 DEFVAR_LISP ("track-mouse", do_mouse_tracking
,
11600 doc
: /* Non-nil means generate motion events for mouse motion. */);
11602 DEFVAR_KBOARD ("system-key-alist", Vsystem_key_alist
,
11603 doc
: /* Alist of system-specific X windows key symbols.
11604 Each element should have the form (N . SYMBOL) where N is the
11605 numeric keysym code (sans the \"system-specific\" bit 1<<28)
11606 and SYMBOL is its name.
11608 `system-key-alist' has a separate binding for each terminal device.
11609 See Info node `(elisp)Multiple Terminals'. */);
11611 DEFVAR_KBOARD ("local-function-key-map", Vlocal_function_key_map
,
11612 doc
: /* Keymap that translates key sequences to key sequences during input.
11613 This is used mainly for mapping key sequences into some preferred
11614 key events (symbols).
11616 The `read-key-sequence' function replaces any subsequence bound by
11617 `local-function-key-map' with its binding. More precisely, when the
11618 active keymaps have no binding for the current key sequence but
11619 `local-function-key-map' binds a suffix of the sequence to a vector or
11620 string, `read-key-sequence' replaces the matching suffix with its
11621 binding, and continues with the new sequence.
11623 If the binding is a function, it is called with one argument (the prompt)
11624 and its return value (a key sequence) is used.
11626 The events that come from bindings in `local-function-key-map' are not
11627 themselves looked up in `local-function-key-map'.
11629 For example, suppose `local-function-key-map' binds `ESC O P' to [f1].
11630 Typing `ESC O P' to `read-key-sequence' would return [f1]. Typing
11631 `C-x ESC O P' would return [?\\C-x f1]. If [f1] were a prefix key,
11632 typing `ESC O P x' would return [f1 x].
11634 `local-function-key-map' has a separate binding for each terminal
11635 device. See Info node `(elisp)Multiple Terminals'. If you need to
11636 define a binding on all terminals, change `function-key-map'
11637 instead. Initially, `local-function-key-map' is an empty keymap that
11638 has `function-key-map' as its parent on all terminal devices. */);
11640 DEFVAR_KBOARD ("input-decode-map", Vinput_decode_map
,
11641 doc
: /* Keymap that decodes input escape sequences.
11642 This is used mainly for mapping ASCII function key sequences into
11643 real Emacs function key events (symbols).
11645 The `read-key-sequence' function replaces any subsequence bound by
11646 `input-decode-map' with its binding. Contrary to `function-key-map',
11647 this map applies its rebinding regardless of the presence of an ordinary
11648 binding. So it is more like `key-translation-map' except that it applies
11649 before `function-key-map' rather than after.
11651 If the binding is a function, it is called with one argument (the prompt)
11652 and its return value (a key sequence) is used.
11654 The events that come from bindings in `input-decode-map' are not
11655 themselves looked up in `input-decode-map'. */);
11657 DEFVAR_LISP ("function-key-map", Vfunction_key_map
,
11658 doc
: /* The parent keymap of all `local-function-key-map' instances.
11659 Function key definitions that apply to all terminal devices should go
11660 here. If a mapping is defined in both the current
11661 `local-function-key-map' binding and this variable, then the local
11662 definition will take precedence. */);
11663 Vfunction_key_map
= Fmake_sparse_keymap (Qnil
);
11665 DEFVAR_LISP ("key-translation-map", Vkey_translation_map
,
11666 doc
: /* Keymap of key translations that can override keymaps.
11667 This keymap works like `input-decode-map', but comes after `function-key-map'.
11668 Another difference is that it is global rather than terminal-local. */);
11669 Vkey_translation_map
= Fmake_sparse_keymap (Qnil
);
11671 DEFVAR_LISP ("deferred-action-list", Vdeferred_action_list
,
11672 doc
: /* List of deferred actions to be performed at a later time.
11673 The precise format isn't relevant here; we just check whether it is nil. */);
11674 Vdeferred_action_list
= Qnil
;
11676 DEFVAR_LISP ("deferred-action-function", Vdeferred_action_function
,
11677 doc
: /* Function to call to handle deferred actions, after each command.
11678 This function is called with no arguments after each command
11679 whenever `deferred-action-list' is non-nil. */);
11680 Vdeferred_action_function
= Qnil
;
11682 DEFVAR_LISP ("delayed-warnings-list", Vdelayed_warnings_list
,
11683 doc
: /* List of warnings to be displayed after this command.
11684 Each element must be a list (TYPE MESSAGE [LEVEL [BUFFER-NAME]]),
11685 as per the args of `display-warning' (which see).
11686 If this variable is non-nil, `delayed-warnings-hook' will be run
11687 immediately after running `post-command-hook'. */);
11688 Vdelayed_warnings_list
= Qnil
;
11690 DEFVAR_LISP ("timer-list", Vtimer_list
,
11691 doc
: /* List of active absolute time timers in order of increasing time. */);
11692 Vtimer_list
= Qnil
;
11694 DEFVAR_LISP ("timer-idle-list", Vtimer_idle_list
,
11695 doc
: /* List of active idle-time timers in order of increasing time. */);
11696 Vtimer_idle_list
= Qnil
;
11698 DEFVAR_LISP ("input-method-function", Vinput_method_function
,
11699 doc
: /* If non-nil, the function that implements the current input method.
11700 It's called with one argument, a printing character that was just read.
11701 \(That means a character with code 040...0176.)
11702 Typically this function uses `read-event' to read additional events.
11703 When it does so, it should first bind `input-method-function' to nil
11704 so it will not be called recursively.
11706 The function should return a list of zero or more events
11707 to be used as input. If it wants to put back some events
11708 to be reconsidered, separately, by the input method,
11709 it can add them to the beginning of `unread-command-events'.
11711 The input method function can find in `input-method-previous-message'
11712 the previous echo area message.
11714 The input method function should refer to the variables
11715 `input-method-use-echo-area' and `input-method-exit-on-first-char'
11716 for guidance on what to do. */);
11717 Vinput_method_function
= Qlist
;
11719 DEFVAR_LISP ("input-method-previous-message",
11720 Vinput_method_previous_message
,
11721 doc
: /* When `input-method-function' is called, hold the previous echo area message.
11722 This variable exists because `read-event' clears the echo area
11723 before running the input method. It is nil if there was no message. */);
11724 Vinput_method_previous_message
= Qnil
;
11726 DEFVAR_LISP ("show-help-function", Vshow_help_function
,
11727 doc
: /* If non-nil, the function that implements the display of help.
11728 It's called with one argument, the help string to display. */);
11729 Vshow_help_function
= Qnil
;
11731 DEFVAR_LISP ("disable-point-adjustment", Vdisable_point_adjustment
,
11732 doc
: /* If non-nil, suppress point adjustment after executing a command.
11734 After a command is executed, if point is moved into a region that has
11735 special properties (e.g. composition, display), we adjust point to
11736 the boundary of the region. But, when a command sets this variable to
11737 non-nil, we suppress the point adjustment.
11739 This variable is set to nil before reading a command, and is checked
11740 just after executing the command. */);
11741 Vdisable_point_adjustment
= Qnil
;
11743 DEFVAR_LISP ("global-disable-point-adjustment",
11744 Vglobal_disable_point_adjustment
,
11745 doc
: /* If non-nil, always suppress point adjustment.
11747 The default value is nil, in which case, point adjustment are
11748 suppressed only after special commands that set
11749 `disable-point-adjustment' (which see) to non-nil. */);
11750 Vglobal_disable_point_adjustment
= Qnil
;
11752 DEFVAR_LISP ("minibuffer-message-timeout", Vminibuffer_message_timeout
,
11753 doc
: /* How long to display an echo-area message when the minibuffer is active.
11754 If the value is not a number, such messages don't time out. */);
11755 Vminibuffer_message_timeout
= make_number (2);
11757 DEFVAR_LISP ("throw-on-input", Vthrow_on_input
,
11758 doc
: /* If non-nil, any keyboard input throws to this symbol.
11759 The value of that variable is passed to `quit-flag' and later causes a
11760 peculiar kind of quitting. */);
11761 Vthrow_on_input
= Qnil
;
11763 DEFVAR_LISP ("command-error-function", Vcommand_error_function
,
11764 doc
: /* Function to output error messages.
11765 Called with three arguments:
11766 - the error data, a list of the form (SIGNALED-CONDITION . SIGNAL-DATA)
11767 such as what `condition-case' would bind its variable to,
11768 - the context (a string which normally goes at the start of the message),
11769 - the Lisp function within which the error was signaled. */);
11770 Vcommand_error_function
= intern ("command-error-default-function");
11772 DEFVAR_LISP ("enable-disabled-menus-and-buttons",
11773 Venable_disabled_menus_and_buttons
,
11774 doc
: /* If non-nil, don't ignore events produced by disabled menu items and tool-bar.
11776 Help functions bind this to allow help on disabled menu items
11777 and tool-bar buttons. */);
11778 Venable_disabled_menus_and_buttons
= Qnil
;
11780 DEFVAR_LISP ("select-active-regions",
11781 Vselect_active_regions
,
11782 doc
: /* If non-nil, an active region automatically sets the primary selection.
11783 If the value is `only', only temporarily active regions (usually made
11784 by mouse-dragging or shift-selection) set the window selection.
11786 This takes effect only when Transient Mark mode is enabled. */);
11787 Vselect_active_regions
= Qt
;
11789 DEFVAR_LISP ("saved-region-selection",
11790 Vsaved_region_selection
,
11791 doc
: /* Contents of active region prior to buffer modification.
11792 If `select-active-regions' is non-nil, Emacs sets this to the
11793 text in the region before modifying the buffer. The next call to
11794 the function `deactivate-mark' uses this to set the window selection. */);
11795 Vsaved_region_selection
= Qnil
;
11797 DEFVAR_LISP ("selection-inhibit-update-commands",
11798 Vselection_inhibit_update_commands
,
11799 doc
: /* List of commands which should not update the selection.
11800 Normally, if `select-active-regions' is non-nil and the mark remains
11801 active after a command (i.e. the mark was not deactivated), the Emacs
11802 command loop sets the selection to the text in the region. However,
11803 if the command is in this list, the selection is not updated. */);
11804 Vselection_inhibit_update_commands
11805 = list2 (Qhandle_switch_frame
, Qhandle_select_window
);
11807 DEFVAR_LISP ("debug-on-event",
11809 doc
: /* Enter debugger on this event. When Emacs
11810 receives the special event specified by this variable, it will try to
11811 break into the debugger as soon as possible instead of processing the
11812 event normally through `special-event-map'.
11814 Currently, the only supported values for this
11815 variable are `sigusr1' and `sigusr2'. */);
11816 Vdebug_on_event
= intern_c_string ("sigusr2");
11818 /* Create the initial keyboard. Qt means 'unset'. */
11819 initial_kboard
= allocate_kboard (Qt
);
11823 keys_of_keyboard (void)
11825 initial_define_key (global_map
, Ctl ('Z'), "suspend-emacs");
11826 initial_define_key (control_x_map
, Ctl ('Z'), "suspend-emacs");
11827 initial_define_key (meta_map
, Ctl ('C'), "exit-recursive-edit");
11828 initial_define_key (global_map
, Ctl (']'), "abort-recursive-edit");
11829 initial_define_key (meta_map
, 'x', "execute-extended-command");
11831 initial_define_lispy_key (Vspecial_event_map
, "delete-frame",
11832 "handle-delete-frame");
11833 initial_define_lispy_key (Vspecial_event_map
, "ns-put-working-text",
11834 "ns-put-working-text");
11835 initial_define_lispy_key (Vspecial_event_map
, "ns-unput-working-text",
11836 "ns-unput-working-text");
11837 /* Here we used to use `ignore-event' which would simple set prefix-arg to
11838 current-prefix-arg, as is done in `handle-switch-frame'.
11839 But `handle-switch-frame is not run from the special-map.
11840 Commands from that map are run in a special way that automatically
11841 preserves the prefix-arg. Restoring the prefix arg here is not just
11842 redundant but harmful:
11844 - current-prefix-arg is set to non-nil, prefix-arg is set to nil.
11845 - after the first prompt, the exit-minibuffer-hook is run which may
11846 iconify a frame and thus push a `iconify-frame' event.
11847 - after running exit-minibuffer-hook, current-prefix-arg is
11848 restored to the non-nil value it had before the prompt.
11849 - we enter the second prompt.
11850 current-prefix-arg is non-nil, prefix-arg is nil.
11851 - before running the first real event, we run the special iconify-frame
11852 event, but we pass the `special' arg to command-execute so
11853 current-prefix-arg and prefix-arg are left untouched.
11854 - here we foolishly copy the non-nil current-prefix-arg to prefix-arg.
11855 - the next key event will have a spuriously non-nil current-prefix-arg. */
11856 initial_define_lispy_key (Vspecial_event_map
, "iconify-frame",
11858 initial_define_lispy_key (Vspecial_event_map
, "make-frame-visible",
11860 /* Handling it at such a low-level causes read_key_sequence to get
11861 * confused because it doesn't realize that the current_buffer was
11862 * changed by read_char.
11864 * initial_define_lispy_key (Vspecial_event_map, "select-window",
11865 * "handle-select-window"); */
11866 initial_define_lispy_key (Vspecial_event_map
, "save-session",
11867 "handle-save-session");
11870 /* Define a special event which is raised for dbus callback
11872 initial_define_lispy_key (Vspecial_event_map
, "dbus-event",
11873 "dbus-handle-event");
11876 #ifdef USE_FILE_NOTIFY
11877 /* Define a special event which is raised for notification callback
11879 initial_define_lispy_key (Vspecial_event_map
, "file-notify",
11880 "file-notify-handle-event");
11881 #endif /* USE_FILE_NOTIFY */
11883 initial_define_lispy_key (Vspecial_event_map
, "config-changed-event",
11885 #if defined (WINDOWSNT)
11886 initial_define_lispy_key (Vspecial_event_map
, "language-change",
11889 initial_define_lispy_key (Vspecial_event_map
, "focus-in",
11890 "handle-focus-in");
11891 initial_define_lispy_key (Vspecial_event_map
, "focus-out",
11892 "handle-focus-out");
11895 /* Mark the pointers in the kboard objects.
11896 Called by Fgarbage_collect. */
11898 mark_kboards (void)
11902 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
11904 if (kb
->kbd_macro_buffer
)
11905 for (p
= kb
->kbd_macro_buffer
; p
< kb
->kbd_macro_ptr
; p
++)
11907 mark_object (KVAR (kb
, Voverriding_terminal_local_map
));
11908 mark_object (KVAR (kb
, Vlast_command
));
11909 mark_object (KVAR (kb
, Vreal_last_command
));
11910 mark_object (KVAR (kb
, Vkeyboard_translate_table
));
11911 mark_object (KVAR (kb
, Vlast_repeatable_command
));
11912 mark_object (KVAR (kb
, Vprefix_arg
));
11913 mark_object (KVAR (kb
, Vlast_prefix_arg
));
11914 mark_object (KVAR (kb
, kbd_queue
));
11915 mark_object (KVAR (kb
, defining_kbd_macro
));
11916 mark_object (KVAR (kb
, Vlast_kbd_macro
));
11917 mark_object (KVAR (kb
, Vsystem_key_alist
));
11918 mark_object (KVAR (kb
, system_key_syms
));
11919 mark_object (KVAR (kb
, Vwindow_system
));
11920 mark_object (KVAR (kb
, Vinput_decode_map
));
11921 mark_object (KVAR (kb
, Vlocal_function_key_map
));
11922 mark_object (KVAR (kb
, Vdefault_minibuffer_frame
));
11923 mark_object (KVAR (kb
, echo_string
));
11926 struct input_event
*event
;
11927 for (event
= kbd_fetch_ptr
; event
!= kbd_store_ptr
; event
++)
11929 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
11930 event
= kbd_buffer
;
11931 /* These two special event types has no Lisp_Objects to mark. */
11932 if (event
->kind
!= SELECTION_REQUEST_EVENT
11933 && event
->kind
!= SELECTION_CLEAR_EVENT
)
11935 mark_object (event
->x
);
11936 mark_object (event
->y
);
11937 mark_object (event
->frame_or_window
);
11938 mark_object (event
->arg
);