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 ptrdiff_t command_key_start
;
3038 struct gcpro gcpro1
;
3039 ptrdiff_t count
= SPECPDL_INDEX ();
3041 /* Save the echo status. */
3042 bool saved_immediate_echo
= current_kboard
->immediate_echo
;
3043 struct kboard
*saved_ok_to_echo
= ok_to_echo_at_next_pause
;
3044 Lisp_Object saved_echo_string
= KVAR (current_kboard
, echo_string
);
3045 ptrdiff_t saved_echo_after_prompt
= current_kboard
->echo_after_prompt
;
3048 if (before_command_restore_flag
)
3050 this_command_key_count
= before_command_key_count_1
;
3051 if (this_command_key_count
< this_single_command_key_start
)
3052 this_single_command_key_start
= this_command_key_count
;
3053 echo_truncate (before_command_echo_length_1
);
3054 before_command_restore_flag
= 0;
3058 /* Save the this_command_keys status. */
3059 key_count
= this_command_key_count
;
3060 key_count_reset
= this_command_key_count_reset
;
3061 command_key_start
= this_single_command_key_start
;
3064 keys
= Fcopy_sequence (this_command_keys
);
3069 /* Clear out this_command_keys. */
3070 this_command_key_count
= 0;
3071 this_command_key_count_reset
= 0;
3072 this_single_command_key_start
= 0;
3074 /* Now wipe the echo area. */
3075 if (!NILP (echo_area_buffer
[0]))
3076 safe_run_hooks (Qecho_area_clear_hook
);
3077 clear_message (1, 0);
3080 /* If we are not reading a key sequence,
3081 never use the echo area. */
3084 specbind (Qinput_method_use_echo_area
, Qt
);
3087 /* Call the input method. */
3088 tem
= call1 (Vinput_method_function
, c
);
3090 tem
= unbind_to (count
, tem
);
3092 /* Restore the saved echoing state
3093 and this_command_keys state. */
3094 this_command_key_count
= key_count
;
3095 this_command_key_count_reset
= key_count_reset
;
3096 this_single_command_key_start
= command_key_start
;
3098 this_command_keys
= keys
;
3101 ok_to_echo_at_next_pause
= saved_ok_to_echo
;
3102 /* Do not restore the echo area string when the user is
3103 introducing a prefix argument. Otherwise we end with
3104 repetitions of the partially introduced prefix
3105 argument. (bug#19875) */
3106 if (NILP (intern ("prefix-arg")))
3108 kset_echo_string (current_kboard
, saved_echo_string
);
3110 current_kboard
->echo_after_prompt
= saved_echo_after_prompt
;
3111 if (saved_immediate_echo
)
3116 /* The input method can return no events. */
3119 /* Bring back the previous message, if any. */
3120 if (! NILP (previous_echo_area_message
))
3121 message_with_string ("%s", previous_echo_area_message
, 0);
3124 /* It returned one event or more. */
3126 Vunread_post_input_method_events
3127 = nconc2 (XCDR (tem
), Vunread_post_input_method_events
);
3132 /* Display help if not echoing. */
3133 if (CONSP (c
) && EQ (XCAR (c
), Qhelp_echo
))
3135 /* (help-echo FRAME HELP WINDOW OBJECT POS). */
3136 Lisp_Object help
, object
, position
, window
, htem
;
3138 htem
= Fcdr (XCDR (c
));
3141 window
= Fcar (htem
);
3143 object
= Fcar (htem
);
3145 position
= Fcar (htem
);
3147 show_help_echo (help
, window
, object
, position
);
3149 /* We stopped being idle for this event; undo that. */
3151 timer_resume_idle ();
3155 if ((! reread
|| this_command_key_count
== 0
3156 || this_command_key_count_reset
)
3160 /* Don't echo mouse motion events. */
3161 if (echo_keystrokes_p ()
3162 && ! (EVENT_HAS_PARAMETERS (c
)
3163 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
3166 if (! NILP (also_record
))
3167 echo_char (also_record
);
3168 /* Once we reread a character, echoing can happen
3169 the next time we pause to read a new one. */
3170 ok_to_echo_at_next_pause
= current_kboard
;
3173 /* Record this character as part of the current key. */
3174 add_command_key (c
);
3175 if (! NILP (also_record
))
3176 add_command_key (also_record
);
3179 last_input_event
= c
;
3182 /* Process the help character specially if enabled. */
3183 if (!NILP (Vhelp_form
) && help_char_p (c
))
3185 ptrdiff_t count
= SPECPDL_INDEX ();
3187 help_form_saved_window_configs
3188 = Fcons (Fcurrent_window_configuration (Qnil
),
3189 help_form_saved_window_configs
);
3190 record_unwind_protect_void (read_char_help_form_unwind
);
3191 call0 (Qhelp_form_show
);
3196 c
= read_char (0, Qnil
, Qnil
, 0, NULL
);
3197 if (EVENT_HAS_PARAMETERS (c
)
3198 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_click
))
3199 XSETCAR (help_form_saved_window_configs
, Qnil
);
3201 while (BUFFERP (c
));
3202 /* Remove the help from the frame. */
3203 unbind_to (count
, Qnil
);
3206 if (EQ (c
, make_number (040)))
3210 c
= read_char (0, Qnil
, Qnil
, 0, NULL
);
3211 while (BUFFERP (c
));
3217 input_was_pending
= input_pending
;
3221 /* Record a key that came from a mouse menu.
3222 Record it for echoing, for this-command-keys, and so on. */
3225 record_menu_key (Lisp_Object c
)
3227 /* Wipe the echo area. */
3228 clear_message (1, 0);
3233 before_command_key_count
= this_command_key_count
;
3234 before_command_echo_length
= echo_length ();
3237 /* Don't echo mouse motion events. */
3238 if (echo_keystrokes_p ())
3242 /* Once we reread a character, echoing can happen
3243 the next time we pause to read a new one. */
3244 ok_to_echo_at_next_pause
= 0;
3247 /* Record this character as part of the current key. */
3248 add_command_key (c
);
3250 /* Re-reading in the middle of a command. */
3251 last_input_event
= c
;
3255 /* Return true if should recognize C as "the help character". */
3258 help_char_p (Lisp_Object c
)
3262 if (EQ (c
, Vhelp_char
))
3264 for (tail
= Vhelp_event_list
; CONSP (tail
); tail
= XCDR (tail
))
3265 if (EQ (c
, XCAR (tail
)))
3270 /* Record the input event C in various ways. */
3273 record_char (Lisp_Object c
)
3277 if (CONSP (c
) && (EQ (XCAR (c
), Qhelp_echo
) || EQ (XCAR (c
), Qmouse_movement
)))
3279 /* To avoid filling recent_keys with help-echo and mouse-movement
3280 events, we filter out repeated help-echo events, only store the
3281 first and last in a series of mouse-movement events, and don't
3282 store repeated help-echo events which are only separated by
3283 mouse-movement events. */
3285 Lisp_Object ev1
, ev2
, ev3
;
3288 if ((ix1
= recent_keys_index
- 1) < 0)
3289 ix1
= NUM_RECENT_KEYS
- 1;
3290 ev1
= AREF (recent_keys
, ix1
);
3292 if ((ix2
= ix1
- 1) < 0)
3293 ix2
= NUM_RECENT_KEYS
- 1;
3294 ev2
= AREF (recent_keys
, ix2
);
3296 if ((ix3
= ix2
- 1) < 0)
3297 ix3
= NUM_RECENT_KEYS
- 1;
3298 ev3
= AREF (recent_keys
, ix3
);
3300 if (EQ (XCAR (c
), Qhelp_echo
))
3302 /* Don't record `help-echo' in recent_keys unless it shows some help
3303 message, and a different help than the previously recorded
3305 Lisp_Object help
, last_help
;
3307 help
= Fcar_safe (Fcdr_safe (XCDR (c
)));
3308 if (!STRINGP (help
))
3310 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qhelp_echo
)
3311 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev1
))), EQ (last_help
, help
)))
3313 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3314 && CONSP (ev2
) && EQ (XCAR (ev2
), Qhelp_echo
)
3315 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev2
))), EQ (last_help
, help
)))
3317 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3318 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3319 && CONSP (ev3
) && EQ (XCAR (ev3
), Qhelp_echo
)
3320 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev3
))), EQ (last_help
, help
)))
3323 else if (EQ (XCAR (c
), Qmouse_movement
))
3325 /* Only record one pair of `mouse-movement' on a window in recent_keys.
3326 So additional mouse movement events replace the last element. */
3327 Lisp_Object last_window
, window
;
3329 window
= Fcar_safe (Fcar_safe (XCDR (c
)));
3330 if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3331 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev1
))), EQ (last_window
, window
))
3332 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3333 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev2
))), EQ (last_window
, window
)))
3335 ASET (recent_keys
, ix1
, c
);
3341 store_kbd_macro_char (c
);
3345 total_keys
+= total_keys
< NUM_RECENT_KEYS
;
3346 ASET (recent_keys
, recent_keys_index
, c
);
3347 if (++recent_keys_index
>= NUM_RECENT_KEYS
)
3348 recent_keys_index
= 0;
3350 else if (recorded
< 0)
3352 /* We need to remove one or two events from recent_keys.
3353 To do this, we simply put nil at those events and move the
3354 recent_keys_index backwards over those events. Usually,
3355 users will never see those nil events, as they will be
3356 overwritten by the command keys entered to see recent_keys
3359 while (recorded
++ < 0 && total_keys
> 0)
3361 if (total_keys
< NUM_RECENT_KEYS
)
3363 if (--recent_keys_index
< 0)
3364 recent_keys_index
= NUM_RECENT_KEYS
- 1;
3365 ASET (recent_keys
, recent_keys_index
, Qnil
);
3369 num_nonmacro_input_events
++;
3371 /* Write c to the dribble file. If c is a lispy event, write
3372 the event's symbol to the dribble file, in <brackets>. Bleaugh.
3373 If you, dear reader, have a better idea, you've got the source. :-) */
3379 if (XUINT (c
) < 0x100)
3380 putc (XUINT (c
), dribble
);
3382 fprintf (dribble
, " 0x%"pI
"x", XUINT (c
));
3386 Lisp_Object dribblee
;
3388 /* If it's a structured event, take the event header. */
3389 dribblee
= EVENT_HEAD (c
);
3391 if (SYMBOLP (dribblee
))
3393 putc ('<', dribble
);
3394 fwrite (SDATA (SYMBOL_NAME (dribblee
)), sizeof (char),
3395 SBYTES (SYMBOL_NAME (dribblee
)),
3397 putc ('>', dribble
);
3406 /* Copy out or in the info on where C-g should throw to.
3407 This is used when running Lisp code from within get_char,
3408 in case get_char is called recursively.
3409 See read_process_output. */
3412 save_getcjmp (sys_jmp_buf temp
)
3414 memcpy (temp
, getcjmp
, sizeof getcjmp
);
3418 restore_getcjmp (sys_jmp_buf temp
)
3420 memcpy (getcjmp
, temp
, sizeof getcjmp
);
3423 /* Low level keyboard/mouse input.
3424 kbd_buffer_store_event places events in kbd_buffer, and
3425 kbd_buffer_get_event retrieves them. */
3427 /* Return true if there are any events in the queue that read-char
3428 would return. If this returns false, a read-char would block. */
3430 readable_events (int flags
)
3432 if (flags
& READABLE_EVENTS_DO_TIMERS_NOW
)
3435 /* If the buffer contains only FOCUS_IN_EVENT events, and
3436 READABLE_EVENTS_FILTER_EVENTS is set, report it as empty. */
3437 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3439 if (flags
& (READABLE_EVENTS_FILTER_EVENTS
3440 #ifdef USE_TOOLKIT_SCROLL_BARS
3441 | READABLE_EVENTS_IGNORE_SQUEEZABLES
3445 struct input_event
*event
;
3447 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
3454 #ifdef USE_TOOLKIT_SCROLL_BARS
3455 (flags
& READABLE_EVENTS_FILTER_EVENTS
) &&
3457 event
->kind
== FOCUS_IN_EVENT
)
3458 #ifdef USE_TOOLKIT_SCROLL_BARS
3459 && !((flags
& READABLE_EVENTS_IGNORE_SQUEEZABLES
)
3460 && (event
->kind
== SCROLL_BAR_CLICK_EVENT
3461 || event
->kind
== HORIZONTAL_SCROLL_BAR_CLICK_EVENT
)
3462 && event
->part
== scroll_bar_handle
3463 && event
->modifiers
== 0)
3465 && !((flags
& READABLE_EVENTS_FILTER_EVENTS
)
3466 && event
->kind
== BUFFER_SWITCH_EVENT
))
3469 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3472 while (event
!= kbd_store_ptr
);
3478 if (!(flags
& READABLE_EVENTS_IGNORE_SQUEEZABLES
)
3479 && !NILP (do_mouse_tracking
) && some_mouse_moved ())
3483 if (current_kboard
->kbd_queue_has_data
)
3489 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
3490 if (kb
->kbd_queue_has_data
)
3496 /* Set this for debugging, to have a way to get out */
3497 int stop_character EXTERNALLY_VISIBLE
;
3500 event_to_kboard (struct input_event
*event
)
3502 /* Not applicable for these special events. */
3503 if (event
->kind
== SELECTION_REQUEST_EVENT
3504 || event
->kind
== SELECTION_CLEAR_EVENT
)
3508 Lisp_Object obj
= event
->frame_or_window
;
3509 /* There are some events that set this field to nil or string. */
3511 obj
= WINDOW_FRAME (XWINDOW (obj
));
3512 /* Also ignore dead frames here. */
3513 return ((FRAMEP (obj
) && FRAME_LIVE_P (XFRAME (obj
)))
3514 ? FRAME_KBOARD (XFRAME (obj
)) : NULL
);
3519 /* Return the number of slots occupied in kbd_buffer. */
3522 kbd_buffer_nr_stored (void)
3524 return kbd_fetch_ptr
== kbd_store_ptr
3526 : (kbd_fetch_ptr
< kbd_store_ptr
3527 ? kbd_store_ptr
- kbd_fetch_ptr
3528 : ((kbd_buffer
+ KBD_BUFFER_SIZE
) - kbd_fetch_ptr
3529 + (kbd_store_ptr
- kbd_buffer
)));
3531 #endif /* Store an event obtained at interrupt level into kbd_buffer, fifo */
3534 kbd_buffer_store_event (register struct input_event
*event
)
3536 kbd_buffer_store_event_hold (event
, 0);
3539 /* Store EVENT obtained at interrupt level into kbd_buffer, fifo.
3541 If HOLD_QUIT is 0, just stuff EVENT into the fifo.
3542 Else, if HOLD_QUIT.kind != NO_EVENT, discard EVENT.
3543 Else, if EVENT is a quit event, store the quit event
3544 in HOLD_QUIT, and return (thus ignoring further events).
3546 This is used to postpone the processing of the quit event until all
3547 subsequent input events have been parsed (and discarded). */
3550 kbd_buffer_store_event_hold (register struct input_event
*event
,
3551 struct input_event
*hold_quit
)
3553 if (event
->kind
== NO_EVENT
)
3556 if (hold_quit
&& hold_quit
->kind
!= NO_EVENT
)
3559 if (event
->kind
== ASCII_KEYSTROKE_EVENT
)
3561 register int c
= event
->code
& 0377;
3563 if (event
->modifiers
& ctrl_modifier
)
3564 c
= make_ctrl_char (c
);
3566 c
|= (event
->modifiers
3567 & (meta_modifier
| alt_modifier
3568 | hyper_modifier
| super_modifier
));
3572 KBOARD
*kb
= FRAME_KBOARD (XFRAME (event
->frame_or_window
));
3573 struct input_event
*sp
;
3575 if (single_kboard
&& kb
!= current_kboard
)
3578 (kb
, list2 (make_lispy_switch_frame (event
->frame_or_window
),
3580 kb
->kbd_queue_has_data
= 1;
3581 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3583 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3586 if (event_to_kboard (sp
) == kb
)
3588 sp
->kind
= NO_EVENT
;
3589 sp
->frame_or_window
= Qnil
;
3598 *hold_quit
= *event
;
3602 /* If this results in a quit_char being returned to Emacs as
3603 input, set Vlast_event_frame properly. If this doesn't
3604 get returned to Emacs as an event, the next event read
3605 will set Vlast_event_frame again, so this is safe to do. */
3609 focus
= FRAME_FOCUS_FRAME (XFRAME (event
->frame_or_window
));
3611 focus
= event
->frame_or_window
;
3612 internal_last_event_frame
= focus
;
3613 Vlast_event_frame
= focus
;
3616 handle_interrupt (0);
3620 if (c
&& c
== stop_character
)
3626 /* Don't insert two BUFFER_SWITCH_EVENT's in a row.
3627 Just ignore the second one. */
3628 else if (event
->kind
== BUFFER_SWITCH_EVENT
3629 && kbd_fetch_ptr
!= kbd_store_ptr
3630 && ((kbd_store_ptr
== kbd_buffer
3631 ? kbd_buffer
+ KBD_BUFFER_SIZE
- 1
3632 : kbd_store_ptr
- 1)->kind
) == BUFFER_SWITCH_EVENT
)
3635 if (kbd_store_ptr
- kbd_buffer
== KBD_BUFFER_SIZE
)
3636 kbd_store_ptr
= kbd_buffer
;
3638 /* Don't let the very last slot in the buffer become full,
3639 since that would make the two pointers equal,
3640 and that is indistinguishable from an empty buffer.
3641 Discard the event if it would fill the last slot. */
3642 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
3644 *kbd_store_ptr
= *event
;
3647 if (kbd_buffer_nr_stored () > KBD_BUFFER_SIZE
/ 2
3648 && ! kbd_on_hold_p ())
3650 /* Don't read keyboard input until we have processed kbd_buffer.
3651 This happens when pasting text longer than KBD_BUFFER_SIZE/2. */
3652 hold_keyboard_input ();
3653 if (!noninteractive
)
3657 #endif /* subprocesses */
3660 /* If we're inside while-no-input, and this event qualifies
3661 as input, set quit-flag to cause an interrupt. */
3662 if (!NILP (Vthrow_on_input
)
3663 && event
->kind
!= FOCUS_IN_EVENT
3664 && event
->kind
!= FOCUS_OUT_EVENT
3665 && event
->kind
!= HELP_EVENT
3666 && event
->kind
!= ICONIFY_EVENT
3667 && event
->kind
!= DEICONIFY_EVENT
)
3669 Vquit_flag
= Vthrow_on_input
;
3670 /* If we're inside a function that wants immediate quits,
3672 if (immediate_quit
&& NILP (Vinhibit_quit
))
3681 /* Put an input event back in the head of the event queue. */
3684 kbd_buffer_unget_event (register struct input_event
*event
)
3686 if (kbd_fetch_ptr
== kbd_buffer
)
3687 kbd_fetch_ptr
= kbd_buffer
+ KBD_BUFFER_SIZE
;
3689 /* Don't let the very last slot in the buffer become full, */
3690 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
3693 *kbd_fetch_ptr
= *event
;
3697 /* Limit help event positions to this range, to avoid overflow problems. */
3698 #define INPUT_EVENT_POS_MAX \
3699 ((ptrdiff_t) min (PTRDIFF_MAX, min (TYPE_MAXIMUM (Time) / 2, \
3700 MOST_POSITIVE_FIXNUM)))
3701 #define INPUT_EVENT_POS_MIN (-1 - INPUT_EVENT_POS_MAX)
3703 /* Return a Time that encodes position POS. POS must be in range. */
3706 position_to_Time (ptrdiff_t pos
)
3708 eassert (INPUT_EVENT_POS_MIN
<= pos
&& pos
<= INPUT_EVENT_POS_MAX
);
3712 /* Return the position that ENCODED_POS encodes.
3713 Avoid signed integer overflow. */
3716 Time_to_position (Time encoded_pos
)
3718 if (encoded_pos
<= INPUT_EVENT_POS_MAX
)
3720 Time encoded_pos_min
= INPUT_EVENT_POS_MIN
;
3721 eassert (encoded_pos_min
<= encoded_pos
);
3722 ptrdiff_t notpos
= -1 - encoded_pos
;
3726 /* Generate a HELP_EVENT input_event and store it in the keyboard
3729 HELP is the help form.
3731 FRAME and WINDOW are the frame and window where the help is
3732 generated. OBJECT is the Lisp object where the help was found (a
3733 buffer, a string, an overlay, or nil if neither from a string nor
3734 from a buffer). POS is the position within OBJECT where the help
3738 gen_help_event (Lisp_Object help
, Lisp_Object frame
, Lisp_Object window
,
3739 Lisp_Object object
, ptrdiff_t pos
)
3741 struct input_event event
;
3743 event
.kind
= HELP_EVENT
;
3744 event
.frame_or_window
= frame
;
3746 event
.x
= WINDOWP (window
) ? window
: frame
;
3748 event
.timestamp
= position_to_Time (pos
);
3749 kbd_buffer_store_event (&event
);
3753 /* Store HELP_EVENTs for HELP on FRAME in the input queue. */
3756 kbd_buffer_store_help_event (Lisp_Object frame
, Lisp_Object help
)
3758 struct input_event event
;
3760 event
.kind
= HELP_EVENT
;
3761 event
.frame_or_window
= frame
;
3765 event
.timestamp
= 0;
3766 kbd_buffer_store_event (&event
);
3770 /* Discard any mouse events in the event buffer by setting them to
3773 discard_mouse_events (void)
3775 struct input_event
*sp
;
3776 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3778 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3781 if (sp
->kind
== MOUSE_CLICK_EVENT
3782 || sp
->kind
== WHEEL_EVENT
3783 || sp
->kind
== HORIZ_WHEEL_EVENT
3785 || sp
->kind
== GPM_CLICK_EVENT
3787 || sp
->kind
== SCROLL_BAR_CLICK_EVENT
3788 || sp
->kind
== HORIZONTAL_SCROLL_BAR_CLICK_EVENT
)
3790 sp
->kind
= NO_EVENT
;
3796 /* Return true if there are any real events waiting in the event
3797 buffer, not counting `NO_EVENT's.
3799 Discard NO_EVENT events at the front of the input queue, possibly
3800 leaving the input queue empty if there are no real input events. */
3803 kbd_buffer_events_waiting (void)
3805 struct input_event
*sp
;
3807 for (sp
= kbd_fetch_ptr
;
3808 sp
!= kbd_store_ptr
&& sp
->kind
== NO_EVENT
;
3811 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3816 return sp
!= kbd_store_ptr
&& sp
->kind
!= NO_EVENT
;
3820 /* Clear input event EVENT. */
3823 clear_event (struct input_event
*event
)
3825 event
->kind
= NO_EVENT
;
3829 /* Read one event from the event buffer, waiting if necessary.
3830 The value is a Lisp object representing the event.
3831 The value is nil for an event that should be ignored,
3832 or that was handled here.
3833 We always read and discard one event. */
3836 kbd_buffer_get_event (KBOARD
**kbp
,
3837 bool *used_mouse_menu
,
3838 struct timespec
*end_time
)
3843 if (kbd_on_hold_p () && kbd_buffer_nr_stored () < KBD_BUFFER_SIZE
/ 4)
3845 /* Start reading input again because we have processed enough to
3846 be able to accept new events again. */
3847 unhold_keyboard_input ();
3850 #endif /* subprocesses */
3852 #if !defined HAVE_DBUS && !defined USE_FILE_NOTIFY
3854 /* In case we are running as a daemon, only do this before
3855 detaching from the terminal. */
3856 || (IS_DAEMON
&& DAEMON_RUNNING
))
3860 *kbp
= current_kboard
;
3863 #endif /* !defined HAVE_DBUS && !defined USE_FILE_NOTIFY */
3865 /* Wait until there is input available. */
3868 /* Break loop if there's an unread command event. Needed in
3869 moused window autoselection which uses a timer to insert such
3871 if (CONSP (Vunread_command_events
))
3874 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3876 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3879 /* If the quit flag is set, then read_char will return
3880 quit_char, so that counts as "available input." */
3881 if (!NILP (Vquit_flag
))
3882 quit_throw_to_read_char (0);
3884 /* One way or another, wait until input is available; then, if
3885 interrupt handlers have not read it, read it now. */
3890 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3892 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3896 struct timespec now
= current_timespec ();
3897 if (timespec_cmp (*end_time
, now
) <= 0)
3898 return Qnil
; /* Finished waiting. */
3901 struct timespec duration
= timespec_sub (*end_time
, now
);
3902 wait_reading_process_output (min (duration
.tv_sec
,
3905 -1, 1, Qnil
, NULL
, 0);
3910 bool do_display
= true;
3912 if (FRAME_TERMCAP_P (SELECTED_FRAME ()))
3914 struct tty_display_info
*tty
= CURTTY ();
3916 /* When this TTY is displaying a menu, we must prevent
3917 any redisplay, because we modify the frame's glyph
3918 matrix behind the back of the display engine. */
3919 if (tty
->showing_menu
)
3923 wait_reading_process_output (0, 0, -1, do_display
, Qnil
, NULL
, 0);
3926 if (!interrupt_input
&& kbd_fetch_ptr
== kbd_store_ptr
)
3930 if (CONSP (Vunread_command_events
))
3933 first
= XCAR (Vunread_command_events
);
3934 Vunread_command_events
= XCDR (Vunread_command_events
);
3935 *kbp
= current_kboard
;
3939 /* At this point, we know that there is a readable event available
3940 somewhere. If the event queue is empty, then there must be a
3941 mouse movement enabled and available. */
3942 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3944 struct input_event
*event
;
3946 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
3950 *kbp
= event_to_kboard (event
);
3952 *kbp
= current_kboard
; /* Better than returning null ptr? */
3956 /* These two kinds of events get special handling
3957 and don't actually appear to the command loop.
3958 We return nil for them. */
3959 if (event
->kind
== SELECTION_REQUEST_EVENT
3960 || event
->kind
== SELECTION_CLEAR_EVENT
)
3963 struct input_event copy
;
3965 /* Remove it from the buffer before processing it,
3966 since otherwise swallow_events will see it
3967 and process it again. */
3969 kbd_fetch_ptr
= event
+ 1;
3970 input_pending
= readable_events (0);
3971 x_handle_selection_event (©
);
3973 /* We're getting selection request events, but we don't have
3979 #if defined (HAVE_NS)
3980 else if (event
->kind
== NS_TEXT_EVENT
)
3982 if (event
->code
== KEY_NS_PUT_WORKING_TEXT
)
3983 obj
= list1 (intern ("ns-put-working-text"));
3985 obj
= list1 (intern ("ns-unput-working-text"));
3986 kbd_fetch_ptr
= event
+ 1;
3987 if (used_mouse_menu
)
3988 *used_mouse_menu
= 1;
3992 #if defined (HAVE_X11) || defined (HAVE_NTGUI) \
3993 || defined (HAVE_NS)
3994 else if (event
->kind
== DELETE_WINDOW_EVENT
)
3996 /* Make an event (delete-frame (FRAME)). */
3997 obj
= list2 (Qdelete_frame
, list1 (event
->frame_or_window
));
3998 kbd_fetch_ptr
= event
+ 1;
4001 #if defined (HAVE_X11) || defined (HAVE_NTGUI) \
4002 || defined (HAVE_NS)
4003 else if (event
->kind
== ICONIFY_EVENT
)
4005 /* Make an event (iconify-frame (FRAME)). */
4006 obj
= list2 (Qiconify_frame
, list1 (event
->frame_or_window
));
4007 kbd_fetch_ptr
= event
+ 1;
4009 else if (event
->kind
== DEICONIFY_EVENT
)
4011 /* Make an event (make-frame-visible (FRAME)). */
4012 obj
= list2 (Qmake_frame_visible
, list1 (event
->frame_or_window
));
4013 kbd_fetch_ptr
= event
+ 1;
4016 else if (event
->kind
== BUFFER_SWITCH_EVENT
)
4018 /* The value doesn't matter here; only the type is tested. */
4019 XSETBUFFER (obj
, current_buffer
);
4020 kbd_fetch_ptr
= event
+ 1;
4022 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
4023 || defined (HAVE_NS) || defined (USE_GTK)
4024 else if (event
->kind
== MENU_BAR_ACTIVATE_EVENT
)
4026 kbd_fetch_ptr
= event
+ 1;
4027 input_pending
= readable_events (0);
4028 if (FRAME_LIVE_P (XFRAME (event
->frame_or_window
)))
4029 x_activate_menubar (XFRAME (event
->frame_or_window
));
4033 else if (event
->kind
== LANGUAGE_CHANGE_EVENT
)
4035 /* Make an event (language-change FRAME CODEPAGE LANGUAGE-ID). */
4036 obj
= list4 (Qlanguage_change
,
4037 event
->frame_or_window
,
4038 make_number (event
->code
),
4039 make_number (event
->modifiers
));
4040 kbd_fetch_ptr
= event
+ 1;
4043 #ifdef USE_FILE_NOTIFY
4044 else if (event
->kind
== FILE_NOTIFY_EVENT
)
4046 #ifdef HAVE_W32NOTIFY
4047 /* Make an event (file-notify (DESCRIPTOR ACTION FILE) CALLBACK). */
4048 obj
= list3 (Qfile_notify
, event
->arg
, event
->frame_or_window
);
4050 obj
= make_lispy_event (event
);
4052 kbd_fetch_ptr
= event
+ 1;
4054 #endif /* USE_FILE_NOTIFY */
4055 else if (event
->kind
== SAVE_SESSION_EVENT
)
4057 obj
= list2 (Qsave_session
, event
->arg
);
4058 kbd_fetch_ptr
= event
+ 1;
4060 /* Just discard these, by returning nil.
4061 With MULTI_KBOARD, these events are used as placeholders
4062 when we need to randomly delete events from the queue.
4063 (They shouldn't otherwise be found in the buffer,
4064 but on some machines it appears they do show up
4065 even without MULTI_KBOARD.) */
4066 /* On Windows NT/9X, NO_EVENT is used to delete extraneous
4067 mouse events during a popup-menu call. */
4068 else if (event
->kind
== NO_EVENT
)
4069 kbd_fetch_ptr
= event
+ 1;
4070 else if (event
->kind
== HELP_EVENT
)
4072 Lisp_Object object
, position
, help
, frame
, window
;
4074 frame
= event
->frame_or_window
;
4075 object
= event
->arg
;
4076 position
= make_number (Time_to_position (event
->timestamp
));
4079 clear_event (event
);
4081 kbd_fetch_ptr
= event
+ 1;
4082 if (!WINDOWP (window
))
4084 obj
= Fcons (Qhelp_echo
,
4085 list5 (frame
, help
, window
, object
, position
));
4087 else if (event
->kind
== FOCUS_IN_EVENT
)
4089 /* Notification of a FocusIn event. The frame receiving the
4090 focus is in event->frame_or_window. Generate a
4091 switch-frame event if necessary. */
4092 Lisp_Object frame
, focus
;
4094 frame
= event
->frame_or_window
;
4095 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
4104 !EQ (frame
, internal_last_event_frame
)
4105 && !EQ (frame
, selected_frame
))
4106 obj
= make_lispy_switch_frame (frame
);
4108 obj
= make_lispy_focus_in (frame
);
4110 internal_last_event_frame
= frame
;
4111 kbd_fetch_ptr
= event
+ 1;
4113 else if (event
->kind
== FOCUS_OUT_EVENT
)
4115 #ifdef HAVE_WINDOW_SYSTEM
4118 Lisp_Object frame
= event
->frame_or_window
;
4119 bool focused
= false;
4121 for (di
= x_display_list
; di
&& ! focused
; di
= di
->next
)
4122 focused
= di
->x_highlight_frame
!= 0;
4125 obj
= make_lispy_focus_out (frame
);
4127 #endif /* HAVE_WINDOW_SYSTEM */
4129 kbd_fetch_ptr
= event
+ 1;
4132 else if (event
->kind
== DBUS_EVENT
)
4134 obj
= make_lispy_event (event
);
4135 kbd_fetch_ptr
= event
+ 1;
4138 else if (event
->kind
== CONFIG_CHANGED_EVENT
)
4140 obj
= make_lispy_event (event
);
4141 kbd_fetch_ptr
= event
+ 1;
4145 /* If this event is on a different frame, return a switch-frame this
4146 time, and leave the event in the queue for next time. */
4150 frame
= event
->frame_or_window
;
4152 frame
= XCAR (frame
);
4153 else if (WINDOWP (frame
))
4154 frame
= WINDOW_FRAME (XWINDOW (frame
));
4156 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
4160 if (! EQ (frame
, internal_last_event_frame
)
4161 && !EQ (frame
, selected_frame
))
4162 obj
= make_lispy_switch_frame (frame
);
4163 internal_last_event_frame
= frame
;
4165 /* If we didn't decide to make a switch-frame event, go ahead
4166 and build a real event from the queue entry. */
4170 obj
= make_lispy_event (event
);
4172 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
4173 || defined (HAVE_NS) || defined (USE_GTK)
4174 /* If this was a menu selection, then set the flag to inhibit
4175 writing to last_nonmenu_event. Don't do this if the event
4176 we're returning is (menu-bar), though; that indicates the
4177 beginning of the menu sequence, and we might as well leave
4178 that as the `event with parameters' for this selection. */
4180 && !EQ (event
->frame_or_window
, event
->arg
)
4181 && (event
->kind
== MENU_BAR_EVENT
4182 || event
->kind
== TOOL_BAR_EVENT
))
4183 *used_mouse_menu
= 1;
4186 /* Certain system events are non-key events. */
4188 && event
->kind
== NS_NONKEY_EVENT
)
4189 *used_mouse_menu
= 1;
4192 /* Wipe out this event, to catch bugs. */
4193 clear_event (event
);
4194 kbd_fetch_ptr
= event
+ 1;
4198 /* Try generating a mouse motion event. */
4199 else if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
4201 struct frame
*f
= some_mouse_moved ();
4202 Lisp_Object bar_window
;
4203 enum scroll_bar_part part
;
4207 *kbp
= current_kboard
;
4208 /* Note that this uses F to determine which terminal to look at.
4209 If there is no valid info, it does not store anything
4210 so x remains nil. */
4213 /* XXX Can f or mouse_position_hook be NULL here? */
4214 if (f
&& FRAME_TERMINAL (f
)->mouse_position_hook
)
4215 (*FRAME_TERMINAL (f
)->mouse_position_hook
) (&f
, 0, &bar_window
,
4220 /* Decide if we should generate a switch-frame event. Don't
4221 generate switch-frame events for motion outside of all Emacs
4227 frame
= FRAME_FOCUS_FRAME (f
);
4229 XSETFRAME (frame
, f
);
4231 if (! EQ (frame
, internal_last_event_frame
)
4232 && !EQ (frame
, selected_frame
))
4233 obj
= make_lispy_switch_frame (frame
);
4234 internal_last_event_frame
= frame
;
4237 /* If we didn't decide to make a switch-frame event, go ahead and
4238 return a mouse-motion event. */
4239 if (!NILP (x
) && NILP (obj
))
4240 obj
= make_lispy_movement (f
, bar_window
, part
, x
, y
, t
);
4243 /* We were promised by the above while loop that there was
4244 something for us to read! */
4247 input_pending
= readable_events (0);
4249 Vlast_event_frame
= internal_last_event_frame
;
4254 /* Process any non-user-visible events (currently X selection events),
4255 without reading any user-visible events. */
4258 process_special_events (void)
4260 struct input_event
*event
;
4262 for (event
= kbd_fetch_ptr
; event
!= kbd_store_ptr
; ++event
)
4264 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
4267 if (event
== kbd_store_ptr
)
4271 /* If we find a stored X selection request, handle it now. */
4272 if (event
->kind
== SELECTION_REQUEST_EVENT
4273 || event
->kind
== SELECTION_CLEAR_EVENT
)
4277 /* Remove the event from the fifo buffer before processing;
4278 otherwise swallow_events called recursively could see it
4279 and process it again. To do this, we move the events
4280 between kbd_fetch_ptr and EVENT one slot to the right,
4283 struct input_event copy
= *event
;
4284 struct input_event
*beg
4285 = (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
4286 ? kbd_buffer
: kbd_fetch_ptr
;
4289 memmove (beg
+ 1, beg
, (event
- beg
) * sizeof (struct input_event
));
4290 else if (event
< beg
)
4292 if (event
> kbd_buffer
)
4293 memmove (kbd_buffer
+ 1, kbd_buffer
,
4294 (event
- kbd_buffer
) * sizeof (struct input_event
));
4295 *kbd_buffer
= *(kbd_buffer
+ KBD_BUFFER_SIZE
- 1);
4296 if (beg
< kbd_buffer
+ KBD_BUFFER_SIZE
- 1)
4297 memmove (beg
+ 1, beg
,
4298 (kbd_buffer
+ KBD_BUFFER_SIZE
- 1 - beg
)
4299 * sizeof (struct input_event
));
4302 if (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
4303 kbd_fetch_ptr
= kbd_buffer
+ 1;
4307 input_pending
= readable_events (0);
4308 x_handle_selection_event (©
);
4310 /* We're getting selection request events, but we don't have
4318 /* Process any events that are not user-visible, run timer events that
4319 are ripe, and return, without reading any user-visible events. */
4322 swallow_events (bool do_display
)
4324 unsigned old_timers_run
;
4326 process_special_events ();
4328 old_timers_run
= timers_run
;
4329 get_input_pending (READABLE_EVENTS_DO_TIMERS_NOW
);
4331 if (!input_pending
&& timers_run
!= old_timers_run
&& do_display
)
4332 redisplay_preserve_echo_area (7);
4335 /* Record the start of when Emacs is idle,
4336 for the sake of running idle-time timers. */
4339 timer_start_idle (void)
4341 /* If we are already in the idle state, do nothing. */
4342 if (timespec_valid_p (timer_idleness_start_time
))
4345 timer_idleness_start_time
= current_timespec ();
4346 timer_last_idleness_start_time
= timer_idleness_start_time
;
4348 /* Mark all idle-time timers as once again candidates for running. */
4349 call0 (intern ("internal-timer-start-idle"));
4352 /* Record that Emacs is no longer idle, so stop running idle-time timers. */
4355 timer_stop_idle (void)
4357 timer_idleness_start_time
= invalid_timespec ();
4360 /* Resume idle timer from last idle start time. */
4363 timer_resume_idle (void)
4365 if (timespec_valid_p (timer_idleness_start_time
))
4368 timer_idleness_start_time
= timer_last_idleness_start_time
;
4371 /* This is only for debugging. */
4372 struct input_event last_timer_event EXTERNALLY_VISIBLE
;
4374 /* List of elisp functions to call, delayed because they were generated in
4375 a context where Elisp could not be safely run (e.g. redisplay, signal,
4376 ...). Each element has the form (FUN . ARGS). */
4377 Lisp_Object pending_funcalls
;
4379 /* Return true if TIMER is a valid timer, placing its value into *RESULT. */
4381 decode_timer (Lisp_Object timer
, struct timespec
*result
)
4385 if (! (VECTORP (timer
) && ASIZE (timer
) == 9))
4387 vec
= XVECTOR (timer
)->contents
;
4388 if (! NILP (vec
[0]))
4390 if (! INTEGERP (vec
[2]))
4394 if (decode_time_components (vec
[1], vec
[2], vec
[3], vec
[8], &t
, 0) <= 0)
4396 *result
= lisp_to_timespec (t
);
4397 return timespec_valid_p (*result
);
4401 /* Check whether a timer has fired. To prevent larger problems we simply
4402 disregard elements that are not proper timers. Do not make a circular
4403 timer list for the time being.
4405 Returns the time to wait until the next timer fires. If a
4406 timer is triggering now, return zero.
4407 If no timer is active, return -1.
4409 If a timer is ripe, we run it, with quitting turned off.
4410 In that case we return 0 to indicate that a new timer_check_2 call
4413 static struct timespec
4414 timer_check_2 (Lisp_Object timers
, Lisp_Object idle_timers
)
4416 struct timespec nexttime
;
4417 struct timespec now
;
4418 struct timespec idleness_now
;
4419 Lisp_Object chosen_timer
;
4420 struct gcpro gcpro1
;
4422 nexttime
= invalid_timespec ();
4424 chosen_timer
= Qnil
;
4425 GCPRO1 (chosen_timer
);
4427 /* First run the code that was delayed. */
4428 while (CONSP (pending_funcalls
))
4430 Lisp_Object funcall
= XCAR (pending_funcalls
);
4431 pending_funcalls
= XCDR (pending_funcalls
);
4432 safe_call2 (Qapply
, XCAR (funcall
), XCDR (funcall
));
4435 if (CONSP (timers
) || CONSP (idle_timers
))
4437 now
= current_timespec ();
4438 idleness_now
= (timespec_valid_p (timer_idleness_start_time
)
4439 ? timespec_sub (now
, timer_idleness_start_time
)
4440 : make_timespec (0, 0));
4443 while (CONSP (timers
) || CONSP (idle_timers
))
4445 Lisp_Object timer
= Qnil
, idle_timer
= Qnil
;
4446 struct timespec timer_time
, idle_timer_time
;
4447 struct timespec difference
;
4448 struct timespec timer_difference
= invalid_timespec ();
4449 struct timespec idle_timer_difference
= invalid_timespec ();
4450 bool ripe
, timer_ripe
= 0, idle_timer_ripe
= 0;
4452 /* Set TIMER and TIMER_DIFFERENCE
4453 based on the next ordinary timer.
4454 TIMER_DIFFERENCE is the distance in time from NOW to when
4455 this timer becomes ripe.
4456 Skip past invalid timers and timers already handled. */
4459 timer
= XCAR (timers
);
4460 if (! decode_timer (timer
, &timer_time
))
4462 timers
= XCDR (timers
);
4466 timer_ripe
= timespec_cmp (timer_time
, now
) <= 0;
4467 timer_difference
= (timer_ripe
4468 ? timespec_sub (now
, timer_time
)
4469 : timespec_sub (timer_time
, now
));
4472 /* Likewise for IDLE_TIMER and IDLE_TIMER_DIFFERENCE
4473 based on the next idle timer. */
4474 if (CONSP (idle_timers
))
4476 idle_timer
= XCAR (idle_timers
);
4477 if (! decode_timer (idle_timer
, &idle_timer_time
))
4479 idle_timers
= XCDR (idle_timers
);
4483 idle_timer_ripe
= timespec_cmp (idle_timer_time
, idleness_now
) <= 0;
4484 idle_timer_difference
4486 ? timespec_sub (idleness_now
, idle_timer_time
)
4487 : timespec_sub (idle_timer_time
, idleness_now
));
4490 /* Decide which timer is the next timer,
4491 and set CHOSEN_TIMER, DIFFERENCE, and RIPE accordingly.
4492 Also step down the list where we found that timer. */
4494 if (timespec_valid_p (timer_difference
)
4495 && (! timespec_valid_p (idle_timer_difference
)
4496 || idle_timer_ripe
< timer_ripe
4497 || (idle_timer_ripe
== timer_ripe
4499 ? timespec_cmp (idle_timer_difference
,
4501 : timespec_cmp (timer_difference
,
4502 idle_timer_difference
))
4505 chosen_timer
= timer
;
4506 timers
= XCDR (timers
);
4507 difference
= timer_difference
;
4512 chosen_timer
= idle_timer
;
4513 idle_timers
= XCDR (idle_timers
);
4514 difference
= idle_timer_difference
;
4515 ripe
= idle_timer_ripe
;
4518 /* If timer is ripe, run it if it hasn't been run. */
4521 if (NILP (AREF (chosen_timer
, 0)))
4523 ptrdiff_t count
= SPECPDL_INDEX ();
4524 Lisp_Object old_deactivate_mark
= Vdeactivate_mark
;
4526 /* Mark the timer as triggered to prevent problems if the lisp
4527 code fails to reschedule it right. */
4528 ASET (chosen_timer
, 0, Qt
);
4530 specbind (Qinhibit_quit
, Qt
);
4532 call1 (Qtimer_event_handler
, chosen_timer
);
4533 Vdeactivate_mark
= old_deactivate_mark
;
4535 unbind_to (count
, Qnil
);
4537 /* Since we have handled the event,
4538 we don't need to tell the caller to wake up and do it. */
4539 /* But the caller must still wait for the next timer, so
4540 return 0 to indicate that. */
4543 nexttime
= make_timespec (0, 0);
4547 /* When we encounter a timer that is still waiting,
4548 return the amount of time to wait before it is ripe. */
4555 /* No timers are pending in the future. */
4556 /* Return 0 if we generated an event, and -1 if not. */
4562 /* Check whether a timer has fired. To prevent larger problems we simply
4563 disregard elements that are not proper timers. Do not make a circular
4564 timer list for the time being.
4566 Returns the time to wait until the next timer fires.
4567 If no timer is active, return an invalid value.
4569 As long as any timer is ripe, we run it. */
4574 struct timespec nexttime
;
4575 Lisp_Object timers
, idle_timers
;
4576 struct gcpro gcpro1
, gcpro2
;
4578 Lisp_Object tem
= Vinhibit_quit
;
4581 /* We use copies of the timers' lists to allow a timer to add itself
4582 again, without locking up Emacs if the newly added timer is
4583 already ripe when added. */
4585 /* Always consider the ordinary timers. */
4586 timers
= Fcopy_sequence (Vtimer_list
);
4587 /* Consider the idle timers only if Emacs is idle. */
4588 if (timespec_valid_p (timer_idleness_start_time
))
4589 idle_timers
= Fcopy_sequence (Vtimer_idle_list
);
4593 Vinhibit_quit
= tem
;
4595 GCPRO2 (timers
, idle_timers
);
4599 nexttime
= timer_check_2 (timers
, idle_timers
);
4601 while (nexttime
.tv_sec
== 0 && nexttime
.tv_nsec
== 0);
4607 DEFUN ("current-idle-time", Fcurrent_idle_time
, Scurrent_idle_time
, 0, 0, 0,
4608 doc
: /* Return the current length of Emacs idleness, or nil.
4609 The value when Emacs is idle is a list of four integers (HIGH LOW USEC PSEC)
4610 in the same style as (current-time).
4612 The value when Emacs is not idle is nil.
4614 PSEC is a multiple of the system clock resolution. */)
4617 if (timespec_valid_p (timer_idleness_start_time
))
4618 return make_lisp_time (timespec_sub (current_timespec (),
4619 timer_idleness_start_time
));
4624 /* Caches for modify_event_symbol. */
4625 static Lisp_Object accent_key_syms
;
4626 static Lisp_Object func_key_syms
;
4627 static Lisp_Object mouse_syms
;
4628 static Lisp_Object wheel_syms
;
4629 static Lisp_Object drag_n_drop_syms
;
4631 /* This is a list of keysym codes for special "accent" characters.
4632 It parallels lispy_accent_keys. */
4634 static const int lispy_accent_codes
[] =
4636 #ifdef XK_dead_circumflex
4641 #ifdef XK_dead_grave
4646 #ifdef XK_dead_tilde
4651 #ifdef XK_dead_diaeresis
4656 #ifdef XK_dead_macron
4661 #ifdef XK_dead_degree
4666 #ifdef XK_dead_acute
4671 #ifdef XK_dead_cedilla
4676 #ifdef XK_dead_breve
4681 #ifdef XK_dead_ogonek
4686 #ifdef XK_dead_caron
4691 #ifdef XK_dead_doubleacute
4692 XK_dead_doubleacute
,
4696 #ifdef XK_dead_abovedot
4701 #ifdef XK_dead_abovering
4711 #ifdef XK_dead_belowdot
4716 #ifdef XK_dead_voiced_sound
4717 XK_dead_voiced_sound
,
4721 #ifdef XK_dead_semivoiced_sound
4722 XK_dead_semivoiced_sound
,
4738 /* This is a list of Lisp names for special "accent" characters.
4739 It parallels lispy_accent_codes. */
4741 static const char *const lispy_accent_keys
[] =
4759 "dead-voiced-sound",
4760 "dead-semivoiced-sound",
4766 #define FUNCTION_KEY_OFFSET 0x0
4768 const char *const lispy_function_keys
[] =
4772 0, /* VK_LBUTTON 0x01 */
4773 0, /* VK_RBUTTON 0x02 */
4774 "cancel", /* VK_CANCEL 0x03 */
4775 0, /* VK_MBUTTON 0x04 */
4777 0, 0, 0, /* 0x05 .. 0x07 */
4779 "backspace", /* VK_BACK 0x08 */
4780 "tab", /* VK_TAB 0x09 */
4782 0, 0, /* 0x0A .. 0x0B */
4784 "clear", /* VK_CLEAR 0x0C */
4785 "return", /* VK_RETURN 0x0D */
4787 0, 0, /* 0x0E .. 0x0F */
4789 0, /* VK_SHIFT 0x10 */
4790 0, /* VK_CONTROL 0x11 */
4791 0, /* VK_MENU 0x12 */
4792 "pause", /* VK_PAUSE 0x13 */
4793 "capslock", /* VK_CAPITAL 0x14 */
4794 "kana", /* VK_KANA/VK_HANGUL 0x15 */
4796 "junja", /* VK_JUNJA 0x17 */
4797 "final", /* VK_FINAL 0x18 */
4798 "kanji", /* VK_KANJI/VK_HANJA 0x19 */
4800 "escape", /* VK_ESCAPE 0x1B */
4801 "convert", /* VK_CONVERT 0x1C */
4802 "non-convert", /* VK_NONCONVERT 0x1D */
4803 "accept", /* VK_ACCEPT 0x1E */
4804 "mode-change", /* VK_MODECHANGE 0x1F */
4805 0, /* VK_SPACE 0x20 */
4806 "prior", /* VK_PRIOR 0x21 */
4807 "next", /* VK_NEXT 0x22 */
4808 "end", /* VK_END 0x23 */
4809 "home", /* VK_HOME 0x24 */
4810 "left", /* VK_LEFT 0x25 */
4811 "up", /* VK_UP 0x26 */
4812 "right", /* VK_RIGHT 0x27 */
4813 "down", /* VK_DOWN 0x28 */
4814 "select", /* VK_SELECT 0x29 */
4815 "print", /* VK_PRINT 0x2A */
4816 "execute", /* VK_EXECUTE 0x2B */
4817 "snapshot", /* VK_SNAPSHOT 0x2C */
4818 "insert", /* VK_INSERT 0x2D */
4819 "delete", /* VK_DELETE 0x2E */
4820 "help", /* VK_HELP 0x2F */
4822 /* VK_0 thru VK_9 are the same as ASCII '0' thru '9' (0x30 - 0x39) */
4824 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4826 0, 0, 0, 0, 0, 0, 0, /* 0x3A .. 0x40 */
4828 /* VK_A thru VK_Z are the same as ASCII 'A' thru 'Z' (0x41 - 0x5A) */
4830 0, 0, 0, 0, 0, 0, 0, 0, 0,
4831 0, 0, 0, 0, 0, 0, 0, 0, 0,
4832 0, 0, 0, 0, 0, 0, 0, 0,
4834 "lwindow", /* VK_LWIN 0x5B */
4835 "rwindow", /* VK_RWIN 0x5C */
4836 "apps", /* VK_APPS 0x5D */
4839 "kp-0", /* VK_NUMPAD0 0x60 */
4840 "kp-1", /* VK_NUMPAD1 0x61 */
4841 "kp-2", /* VK_NUMPAD2 0x62 */
4842 "kp-3", /* VK_NUMPAD3 0x63 */
4843 "kp-4", /* VK_NUMPAD4 0x64 */
4844 "kp-5", /* VK_NUMPAD5 0x65 */
4845 "kp-6", /* VK_NUMPAD6 0x66 */
4846 "kp-7", /* VK_NUMPAD7 0x67 */
4847 "kp-8", /* VK_NUMPAD8 0x68 */
4848 "kp-9", /* VK_NUMPAD9 0x69 */
4849 "kp-multiply", /* VK_MULTIPLY 0x6A */
4850 "kp-add", /* VK_ADD 0x6B */
4851 "kp-separator", /* VK_SEPARATOR 0x6C */
4852 "kp-subtract", /* VK_SUBTRACT 0x6D */
4853 "kp-decimal", /* VK_DECIMAL 0x6E */
4854 "kp-divide", /* VK_DIVIDE 0x6F */
4855 "f1", /* VK_F1 0x70 */
4856 "f2", /* VK_F2 0x71 */
4857 "f3", /* VK_F3 0x72 */
4858 "f4", /* VK_F4 0x73 */
4859 "f5", /* VK_F5 0x74 */
4860 "f6", /* VK_F6 0x75 */
4861 "f7", /* VK_F7 0x76 */
4862 "f8", /* VK_F8 0x77 */
4863 "f9", /* VK_F9 0x78 */
4864 "f10", /* VK_F10 0x79 */
4865 "f11", /* VK_F11 0x7A */
4866 "f12", /* VK_F12 0x7B */
4867 "f13", /* VK_F13 0x7C */
4868 "f14", /* VK_F14 0x7D */
4869 "f15", /* VK_F15 0x7E */
4870 "f16", /* VK_F16 0x7F */
4871 "f17", /* VK_F17 0x80 */
4872 "f18", /* VK_F18 0x81 */
4873 "f19", /* VK_F19 0x82 */
4874 "f20", /* VK_F20 0x83 */
4875 "f21", /* VK_F21 0x84 */
4876 "f22", /* VK_F22 0x85 */
4877 "f23", /* VK_F23 0x86 */
4878 "f24", /* VK_F24 0x87 */
4880 0, 0, 0, 0, /* 0x88 .. 0x8B */
4881 0, 0, 0, 0, /* 0x8C .. 0x8F */
4883 "kp-numlock", /* VK_NUMLOCK 0x90 */
4884 "scroll", /* VK_SCROLL 0x91 */
4885 /* Not sure where the following block comes from.
4886 Windows headers have NEC and Fujitsu specific keys in
4887 this block, but nothing generic. */
4888 "kp-space", /* VK_NUMPAD_CLEAR 0x92 */
4889 "kp-enter", /* VK_NUMPAD_ENTER 0x93 */
4890 "kp-prior", /* VK_NUMPAD_PRIOR 0x94 */
4891 "kp-next", /* VK_NUMPAD_NEXT 0x95 */
4892 "kp-end", /* VK_NUMPAD_END 0x96 */
4893 "kp-home", /* VK_NUMPAD_HOME 0x97 */
4894 "kp-left", /* VK_NUMPAD_LEFT 0x98 */
4895 "kp-up", /* VK_NUMPAD_UP 0x99 */
4896 "kp-right", /* VK_NUMPAD_RIGHT 0x9A */
4897 "kp-down", /* VK_NUMPAD_DOWN 0x9B */
4898 "kp-insert", /* VK_NUMPAD_INSERT 0x9C */
4899 "kp-delete", /* VK_NUMPAD_DELETE 0x9D */
4901 0, 0, /* 0x9E .. 0x9F */
4904 * VK_L* & VK_R* - left and right Alt, Ctrl and Shift virtual keys.
4905 * Used only as parameters to GetAsyncKeyState and GetKeyState.
4906 * No other API or message will distinguish left and right keys this way.
4911 /* Multimedia keys. These are handled as WM_APPCOMMAND, which allows us
4912 to enable them selectively, and gives access to a few more functions.
4913 See lispy_multimedia_keys below. */
4914 0, 0, 0, 0, 0, 0, 0, /* 0xA6 .. 0xAC Browser */
4915 0, 0, 0, /* 0xAD .. 0xAF Volume */
4916 0, 0, 0, 0, /* 0xB0 .. 0xB3 Media */
4917 0, 0, 0, 0, /* 0xB4 .. 0xB7 Apps */
4919 /* 0xB8 .. 0xC0 "OEM" keys - all seem to be punctuation. */
4920 0, 0, 0, 0, 0, 0, 0, 0, 0,
4922 /* 0xC1 - 0xDA unallocated, 0xDB-0xDF more OEM keys */
4923 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4924 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4927 "ax", /* VK_OEM_AX 0xE1 */
4928 0, /* VK_OEM_102 0xE2 */
4929 "ico-help", /* VK_ICO_HELP 0xE3 */
4930 "ico-00", /* VK_ICO_00 0xE4 */
4931 0, /* VK_PROCESSKEY 0xE5 - used by IME */
4932 "ico-clear", /* VK_ICO_CLEAR 0xE6 */
4933 0, /* VK_PACKET 0xE7 - used to pass Unicode chars */
4935 "reset", /* VK_OEM_RESET 0xE9 */
4936 "jump", /* VK_OEM_JUMP 0xEA */
4937 "oem-pa1", /* VK_OEM_PA1 0xEB */
4938 "oem-pa2", /* VK_OEM_PA2 0xEC */
4939 "oem-pa3", /* VK_OEM_PA3 0xED */
4940 "wsctrl", /* VK_OEM_WSCTRL 0xEE */
4941 "cusel", /* VK_OEM_CUSEL 0xEF */
4942 "oem-attn", /* VK_OEM_ATTN 0xF0 */
4943 "finish", /* VK_OEM_FINISH 0xF1 */
4944 "copy", /* VK_OEM_COPY 0xF2 */
4945 "auto", /* VK_OEM_AUTO 0xF3 */
4946 "enlw", /* VK_OEM_ENLW 0xF4 */
4947 "backtab", /* VK_OEM_BACKTAB 0xF5 */
4948 "attn", /* VK_ATTN 0xF6 */
4949 "crsel", /* VK_CRSEL 0xF7 */
4950 "exsel", /* VK_EXSEL 0xF8 */
4951 "ereof", /* VK_EREOF 0xF9 */
4952 "play", /* VK_PLAY 0xFA */
4953 "zoom", /* VK_ZOOM 0xFB */
4954 "noname", /* VK_NONAME 0xFC */
4955 "pa1", /* VK_PA1 0xFD */
4956 "oem_clear", /* VK_OEM_CLEAR 0xFE */
4960 /* Some of these duplicate the "Media keys" on newer keyboards,
4961 but they are delivered to the application in a different way. */
4962 static const char *const lispy_multimedia_keys
[] =
4970 "browser-favorites",
5007 "toggle-dictate-command",
5013 "media-fast-forward",
5016 "media-channel-down"
5019 #else /* not HAVE_NTGUI */
5021 /* This should be dealt with in XTread_socket now, and that doesn't
5022 depend on the client system having the Kana syms defined. See also
5023 the XK_kana_A case below. */
5026 static const char *const lispy_kana_keys
[] =
5028 /* X Keysym value */
5029 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x400 .. 0x40f */
5030 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x410 .. 0x41f */
5031 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x420 .. 0x42f */
5032 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x430 .. 0x43f */
5033 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x440 .. 0x44f */
5034 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x450 .. 0x45f */
5035 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x460 .. 0x46f */
5036 0,0,0,0,0,0,0,0,0,0,0,0,0,0,"overline",0,
5037 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x480 .. 0x48f */
5038 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x490 .. 0x49f */
5039 0, "kana-fullstop", "kana-openingbracket", "kana-closingbracket",
5040 "kana-comma", "kana-conjunctive", "kana-WO", "kana-a",
5041 "kana-i", "kana-u", "kana-e", "kana-o",
5042 "kana-ya", "kana-yu", "kana-yo", "kana-tsu",
5043 "prolongedsound", "kana-A", "kana-I", "kana-U",
5044 "kana-E", "kana-O", "kana-KA", "kana-KI",
5045 "kana-KU", "kana-KE", "kana-KO", "kana-SA",
5046 "kana-SHI", "kana-SU", "kana-SE", "kana-SO",
5047 "kana-TA", "kana-CHI", "kana-TSU", "kana-TE",
5048 "kana-TO", "kana-NA", "kana-NI", "kana-NU",
5049 "kana-NE", "kana-NO", "kana-HA", "kana-HI",
5050 "kana-FU", "kana-HE", "kana-HO", "kana-MA",
5051 "kana-MI", "kana-MU", "kana-ME", "kana-MO",
5052 "kana-YA", "kana-YU", "kana-YO", "kana-RA",
5053 "kana-RI", "kana-RU", "kana-RE", "kana-RO",
5054 "kana-WA", "kana-N", "voicedsound", "semivoicedsound",
5055 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4e0 .. 0x4ef */
5056 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4f0 .. 0x4ff */
5058 #endif /* XK_kana_A */
5061 #define FUNCTION_KEY_OFFSET 0xff00
5063 /* You'll notice that this table is arranged to be conveniently
5064 indexed by X Windows keysym values. */
5065 static const char *const lispy_function_keys
[] =
5067 /* X Keysym value */
5069 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff00...0f */
5070 "backspace", "tab", "linefeed", "clear",
5072 0, 0, 0, "pause", /* 0xff10...1f */
5073 0, 0, 0, 0, 0, 0, 0, "escape",
5075 0, "kanji", "muhenkan", "henkan", /* 0xff20...2f */
5076 "romaji", "hiragana", "katakana", "hiragana-katakana",
5077 "zenkaku", "hankaku", "zenkaku-hankaku", "touroku",
5078 "massyo", "kana-lock", "kana-shift", "eisu-shift",
5079 "eisu-toggle", /* 0xff30...3f */
5080 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
5081 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff40...4f */
5083 "home", "left", "up", "right", /* 0xff50 */ /* IsCursorKey */
5084 "down", "prior", "next", "end",
5085 "begin", 0, 0, 0, 0, 0, 0, 0,
5086 "select", /* 0xff60 */ /* IsMiscFunctionKey */
5097 "break", /* 0xff6b */
5100 0, 0, 0, 0, "backtab", 0, 0, 0, /* 0xff70... */
5101 0, 0, 0, 0, 0, 0, 0, "kp-numlock", /* 0xff78... */
5102 "kp-space", /* 0xff80 */ /* IsKeypadKey */
5103 0, 0, 0, 0, 0, 0, 0, 0,
5104 "kp-tab", /* 0xff89 */
5106 "kp-enter", /* 0xff8d */
5108 "kp-f1", /* 0xff91 */
5112 "kp-home", /* 0xff95 */
5117 "kp-prior", /* kp-page-up */
5118 "kp-next", /* kp-page-down */
5124 0, 0, 0, 0, 0, 0, 0, 0, 0,
5125 "kp-multiply", /* 0xffaa */
5130 "kp-divide", /* 0xffaf */
5131 "kp-0", /* 0xffb0 */
5132 "kp-1", "kp-2", "kp-3", "kp-4", "kp-5", "kp-6", "kp-7", "kp-8", "kp-9",
5135 "kp-equal", /* 0xffbd */
5136 "f1", /* 0xffbe */ /* IsFunctionKey */
5138 "f3", "f4", "f5", "f6", "f7", "f8", "f9", "f10", /* 0xffc0 */
5139 "f11", "f12", "f13", "f14", "f15", "f16", "f17", "f18",
5140 "f19", "f20", "f21", "f22", "f23", "f24", "f25", "f26", /* 0xffd0 */
5141 "f27", "f28", "f29", "f30", "f31", "f32", "f33", "f34",
5142 "f35", 0, 0, 0, 0, 0, 0, 0, /* 0xffe0 */
5143 0, 0, 0, 0, 0, 0, 0, 0,
5144 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfff0 */
5145 0, 0, 0, 0, 0, 0, 0, "delete"
5148 /* ISO 9995 Function and Modifier Keys; the first byte is 0xFE. */
5149 #define ISO_FUNCTION_KEY_OFFSET 0xfe00
5151 static const char *const iso_lispy_function_keys
[] =
5153 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe00 */
5154 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe08 */
5155 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe10 */
5156 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe18 */
5157 "iso-lefttab", /* 0xfe20 */
5158 "iso-move-line-up", "iso-move-line-down",
5159 "iso-partial-line-up", "iso-partial-line-down",
5160 "iso-partial-space-left", "iso-partial-space-right",
5161 "iso-set-margin-left", "iso-set-margin-right", /* 0xffe27, 28 */
5162 "iso-release-margin-left", "iso-release-margin-right",
5163 "iso-release-both-margins",
5164 "iso-fast-cursor-left", "iso-fast-cursor-right",
5165 "iso-fast-cursor-up", "iso-fast-cursor-down",
5166 "iso-continuous-underline", "iso-discontinuous-underline", /* 0xfe30, 31 */
5167 "iso-emphasize", "iso-center-object", "iso-enter", /* ... 0xfe34 */
5170 #endif /* not HAVE_NTGUI */
5172 static Lisp_Object Vlispy_mouse_stem
;
5174 static const char *const lispy_wheel_names
[] =
5176 "wheel-up", "wheel-down", "wheel-left", "wheel-right"
5179 /* drag-n-drop events are generated when a set of selected files are
5180 dragged from another application and dropped onto an Emacs window. */
5181 static const char *const lispy_drag_n_drop_names
[] =
5186 /* An array of symbol indexes of scroll bar parts, indexed by an enum
5187 scroll_bar_part value. Note that Qnil corresponds to
5188 scroll_bar_nowhere and should not appear in Lisp events. */
5189 static short const scroll_bar_parts
[] = {
5190 SYMBOL_INDEX (Qnil
), SYMBOL_INDEX (Qabove_handle
), SYMBOL_INDEX (Qhandle
),
5191 SYMBOL_INDEX (Qbelow_handle
), SYMBOL_INDEX (Qup
), SYMBOL_INDEX (Qdown
),
5192 SYMBOL_INDEX (Qtop
), SYMBOL_INDEX (Qbottom
), SYMBOL_INDEX (Qend_scroll
),
5193 SYMBOL_INDEX (Qratio
), SYMBOL_INDEX (Qbefore_handle
),
5194 SYMBOL_INDEX (Qhorizontal_handle
), SYMBOL_INDEX (Qafter_handle
),
5195 SYMBOL_INDEX (Qleft
), SYMBOL_INDEX (Qright
), SYMBOL_INDEX (Qleftmost
),
5196 SYMBOL_INDEX (Qrightmost
), SYMBOL_INDEX (Qend_scroll
), SYMBOL_INDEX (Qratio
)
5199 /* A vector, indexed by button number, giving the down-going location
5200 of currently depressed buttons, both scroll bar and non-scroll bar.
5202 The elements have the form
5203 (BUTTON-NUMBER MODIFIER-MASK . REST)
5204 where REST is the cdr of a position as it would be reported in the event.
5206 The make_lispy_event function stores positions here to tell the
5207 difference between click and drag events, and to store the starting
5208 location to be included in drag events. */
5210 static Lisp_Object button_down_location
;
5212 /* Information about the most recent up-going button event: Which
5213 button, what location, and what time. */
5215 static int last_mouse_button
;
5216 static int last_mouse_x
;
5217 static int last_mouse_y
;
5218 static Time button_down_time
;
5220 /* The number of clicks in this multiple-click. */
5222 static int double_click_count
;
5224 /* X and Y are frame-relative coordinates for a click or wheel event.
5225 Return a Lisp-style event list. */
5228 make_lispy_position (struct frame
*f
, Lisp_Object x
, Lisp_Object y
,
5231 enum window_part part
;
5232 Lisp_Object posn
= Qnil
;
5233 Lisp_Object extra_info
= Qnil
;
5234 /* Coordinate pixel positions to return. */
5235 int xret
= 0, yret
= 0;
5236 /* The window under frame pixel coordinates (x,y) */
5237 Lisp_Object window
= f
5238 ? window_from_coordinates (f
, XINT (x
), XINT (y
), &part
, 0)
5241 if (WINDOWP (window
))
5243 /* It's a click in window WINDOW at frame coordinates (X,Y) */
5244 struct window
*w
= XWINDOW (window
);
5245 Lisp_Object string_info
= Qnil
;
5246 ptrdiff_t textpos
= 0;
5247 int col
= -1, row
= -1;
5248 int dx
= -1, dy
= -1;
5249 int width
= -1, height
= -1;
5250 Lisp_Object object
= Qnil
;
5252 /* Pixel coordinates relative to the window corner. */
5253 int wx
= XINT (x
) - WINDOW_LEFT_EDGE_X (w
);
5254 int wy
= XINT (y
) - WINDOW_TOP_EDGE_Y (w
);
5256 /* For text area clicks, return X, Y relative to the corner of
5257 this text area. Note that dX, dY etc are set below, by
5258 buffer_posn_from_coords. */
5259 if (part
== ON_TEXT
)
5261 xret
= XINT (x
) - window_box_left (w
, TEXT_AREA
);
5262 yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5264 /* For mode line and header line clicks, return X, Y relative to
5265 the left window edge. Use mode_line_string to look for a
5266 string on the click position. */
5267 else if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
)
5272 posn
= (part
== ON_MODE_LINE
) ? Qmode_line
: Qheader_line
;
5273 /* Note that mode_line_string takes COL, ROW as pixels and
5274 converts them to characters. */
5277 string
= mode_line_string (w
, part
, &col
, &row
, &charpos
,
5278 &object
, &dx
, &dy
, &width
, &height
);
5279 if (STRINGP (string
))
5280 string_info
= Fcons (string
, make_number (charpos
));
5286 /* For fringes and margins, Y is relative to the area's (and the
5287 window's) top edge, while X is meaningless. */
5288 else if (part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
5293 posn
= (part
== ON_LEFT_MARGIN
) ? Qleft_margin
: Qright_margin
;
5296 string
= marginal_area_string (w
, part
, &col
, &row
, &charpos
,
5297 &object
, &dx
, &dy
, &width
, &height
);
5298 if (STRINGP (string
))
5299 string_info
= Fcons (string
, make_number (charpos
));
5301 yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5303 else if (part
== ON_LEFT_FRINGE
)
5305 posn
= Qleft_fringe
;
5309 - (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5310 ? 0 : window_box_width (w
, LEFT_MARGIN_AREA
));
5311 dy
= yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5313 else if (part
== ON_RIGHT_FRINGE
)
5315 posn
= Qright_fringe
;
5319 - window_box_width (w
, LEFT_MARGIN_AREA
)
5320 - window_box_width (w
, TEXT_AREA
)
5321 - (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5322 ? window_box_width (w
, RIGHT_MARGIN_AREA
)
5324 dy
= yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5326 else if (part
== ON_VERTICAL_BORDER
)
5328 posn
= Qvertical_line
;
5334 else if (part
== ON_VERTICAL_SCROLL_BAR
)
5336 posn
= Qvertical_scroll_bar
;
5337 width
= WINDOW_SCROLL_BAR_AREA_WIDTH (w
);
5341 else if (part
== ON_HORIZONTAL_SCROLL_BAR
)
5343 posn
= Qhorizontal_scroll_bar
;
5344 width
= WINDOW_SCROLL_BAR_AREA_HEIGHT (w
);
5348 else if (part
== ON_RIGHT_DIVIDER
)
5350 posn
= Qright_divider
;
5351 width
= WINDOW_RIGHT_DIVIDER_WIDTH (w
);
5355 else if (part
== ON_BOTTOM_DIVIDER
)
5357 posn
= Qbottom_divider
;
5358 width
= WINDOW_BOTTOM_DIVIDER_WIDTH (w
);
5363 /* For clicks in the text area, fringes, or margins, call
5364 buffer_posn_from_coords to extract TEXTPOS, the buffer
5365 position nearest to the click. */
5368 Lisp_Object string2
, object2
= Qnil
;
5369 struct display_pos p
;
5371 int width2
, height2
;
5372 /* The pixel X coordinate passed to buffer_posn_from_coords
5373 is the X coordinate relative to the text area for
5374 text-area and right-margin clicks, zero otherwise. */
5376 = (part
== ON_TEXT
) ? xret
5377 : (part
== ON_RIGHT_FRINGE
|| part
== ON_RIGHT_MARGIN
)
5378 ? (XINT (x
) - window_box_left (w
, TEXT_AREA
))
5382 string2
= buffer_posn_from_coords (w
, &x2
, &y2
, &p
,
5383 &object2
, &dx2
, &dy2
,
5385 textpos
= CHARPOS (p
.pos
);
5386 if (col
< 0) col
= x2
;
5387 if (row
< 0) row
= y2
;
5388 if (dx
< 0) dx
= dx2
;
5389 if (dy
< 0) dy
= dy2
;
5390 if (width
< 0) width
= width2
;
5391 if (height
< 0) height
= height2
;
5395 posn
= make_number (textpos
);
5396 if (STRINGP (string2
))
5397 string_info
= Fcons (string2
,
5398 make_number (CHARPOS (p
.string_pos
)));
5404 #ifdef HAVE_WINDOW_SYSTEM
5405 if (IMAGEP (object
))
5407 Lisp_Object image_map
, hotspot
;
5408 if ((image_map
= Fplist_get (XCDR (object
), QCmap
),
5410 && (hotspot
= find_hot_spot (image_map
, dx
, dy
),
5412 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
5413 posn
= XCAR (hotspot
);
5420 Fcons (make_number (dx
), make_number (dy
)),
5421 Fcons (make_number (width
), make_number (height
)));
5424 extra_info
= Fcons (string_info
,
5425 Fcons (textpos
< 0 ? Qnil
: make_number (textpos
),
5426 Fcons (Fcons (make_number (col
),
5432 /* Return mouse pixel coordinates here. */
5433 XSETFRAME (window
, f
);
5440 return Fcons (window
,
5442 Fcons (Fcons (make_number (xret
),
5443 make_number (yret
)),
5444 Fcons (make_number (t
),
5448 /* Return non-zero if F is a GUI frame that uses some toolkit-managed
5449 menu bar. This really means that Emacs draws and manages the menu
5450 bar as part of its normal display, and therefore can compute its
5453 toolkit_menubar_in_use (struct frame
*f
)
5455 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS) || defined (HAVE_NTGUI)
5456 return !(!FRAME_WINDOW_P (f
));
5462 /* Build the part of Lisp event which represents scroll bar state from
5463 EV. TYPE is one of Qvertical_scroll_bar or Qhorizontal_scroll_bar. */
5466 make_scroll_bar_position (struct input_event
*ev
, Lisp_Object type
)
5468 return list5 (ev
->frame_or_window
, type
, Fcons (ev
->x
, ev
->y
),
5469 make_number (ev
->timestamp
),
5470 builtin_lisp_symbol (scroll_bar_parts
[ev
->part
]));
5473 /* Given a struct input_event, build the lisp event which represents
5474 it. If EVENT is 0, build a mouse movement event from the mouse
5475 movement buffer, which should have a movement event in it.
5477 Note that events must be passed to this function in the order they
5478 are received; this function stores the location of button presses
5479 in order to build drag events when the button is released. */
5482 make_lispy_event (struct input_event
*event
)
5486 switch (event
->kind
)
5488 /* A simple keystroke. */
5489 case ASCII_KEYSTROKE_EVENT
:
5490 case MULTIBYTE_CHAR_KEYSTROKE_EVENT
:
5492 Lisp_Object lispy_c
;
5493 EMACS_INT c
= event
->code
;
5494 if (event
->kind
== ASCII_KEYSTROKE_EVENT
)
5497 eassert (c
== event
->code
);
5498 /* Turn ASCII characters into control characters
5500 if (event
->modifiers
& ctrl_modifier
)
5502 c
= make_ctrl_char (c
);
5503 event
->modifiers
&= ~ctrl_modifier
;
5507 /* Add in the other modifier bits. The shift key was taken care
5508 of by the X code. */
5509 c
|= (event
->modifiers
5510 & (meta_modifier
| alt_modifier
5511 | hyper_modifier
| super_modifier
| ctrl_modifier
));
5512 /* Distinguish Shift-SPC from SPC. */
5513 if ((event
->code
) == 040
5514 && event
->modifiers
& shift_modifier
)
5515 c
|= shift_modifier
;
5516 button_down_time
= 0;
5517 XSETFASTINT (lispy_c
, c
);
5522 /* NS_NONKEY_EVENTs are just like NON_ASCII_KEYSTROKE_EVENTs,
5523 except that they are non-key events (last-nonmenu-event is nil). */
5524 case NS_NONKEY_EVENT
:
5527 /* A function key. The symbol may need to have modifier prefixes
5529 case NON_ASCII_KEYSTROKE_EVENT
:
5530 button_down_time
= 0;
5532 for (i
= 0; i
< ARRAYELTS (lispy_accent_codes
); i
++)
5533 if (event
->code
== lispy_accent_codes
[i
])
5534 return modify_event_symbol (i
,
5536 Qfunction_key
, Qnil
,
5537 lispy_accent_keys
, &accent_key_syms
,
5538 ARRAYELTS (lispy_accent_keys
));
5542 if (event
->code
>= 0x400 && event
->code
< 0x500)
5543 return modify_event_symbol (event
->code
- 0x400,
5544 event
->modifiers
& ~shift_modifier
,
5545 Qfunction_key
, Qnil
,
5546 lispy_kana_keys
, &func_key_syms
,
5547 ARRAYELTS (lispy_kana_keys
));
5548 #endif /* XK_kana_A */
5551 #ifdef ISO_FUNCTION_KEY_OFFSET
5552 if (event
->code
< FUNCTION_KEY_OFFSET
5553 && event
->code
>= ISO_FUNCTION_KEY_OFFSET
)
5554 return modify_event_symbol (event
->code
- ISO_FUNCTION_KEY_OFFSET
,
5556 Qfunction_key
, Qnil
,
5557 iso_lispy_function_keys
, &func_key_syms
,
5558 ARRAYELTS (iso_lispy_function_keys
));
5561 if ((FUNCTION_KEY_OFFSET
<= event
->code
5563 < FUNCTION_KEY_OFFSET
+ ARRAYELTS (lispy_function_keys
)))
5564 && lispy_function_keys
[event
->code
- FUNCTION_KEY_OFFSET
])
5565 return modify_event_symbol (event
->code
- FUNCTION_KEY_OFFSET
,
5567 Qfunction_key
, Qnil
,
5568 lispy_function_keys
, &func_key_syms
,
5569 ARRAYELTS (lispy_function_keys
));
5571 /* Handle system-specific or unknown keysyms.
5572 We need to use an alist rather than a vector as the cache
5573 since we can't make a vector long enough. */
5574 if (NILP (KVAR (current_kboard
, system_key_syms
)))
5575 kset_system_key_syms (current_kboard
, Fcons (Qnil
, Qnil
));
5576 return modify_event_symbol (event
->code
,
5579 KVAR (current_kboard
, Vsystem_key_alist
),
5580 0, &KVAR (current_kboard
, system_key_syms
),
5584 case MULTIMEDIA_KEY_EVENT
:
5585 if (event
->code
< ARRAYELTS (lispy_multimedia_keys
)
5586 && event
->code
> 0 && lispy_multimedia_keys
[event
->code
])
5588 return modify_event_symbol (event
->code
, event
->modifiers
,
5589 Qfunction_key
, Qnil
,
5590 lispy_multimedia_keys
, &func_key_syms
,
5591 ARRAYELTS (lispy_multimedia_keys
));
5596 /* A mouse click. Figure out where it is, decide whether it's
5597 a press, click or drag, and build the appropriate structure. */
5598 case MOUSE_CLICK_EVENT
:
5600 case GPM_CLICK_EVENT
:
5602 #ifndef USE_TOOLKIT_SCROLL_BARS
5603 case SCROLL_BAR_CLICK_EVENT
:
5604 case HORIZONTAL_SCROLL_BAR_CLICK_EVENT
:
5607 int button
= event
->code
;
5609 Lisp_Object position
;
5610 Lisp_Object
*start_pos_ptr
;
5611 Lisp_Object start_pos
;
5615 /* Build the position as appropriate for this mouse click. */
5616 if (event
->kind
== MOUSE_CLICK_EVENT
5618 || event
->kind
== GPM_CLICK_EVENT
5622 struct frame
*f
= XFRAME (event
->frame_or_window
);
5625 /* Ignore mouse events that were made on frame that
5626 have been deleted. */
5627 if (! FRAME_LIVE_P (f
))
5630 /* EVENT->x and EVENT->y are frame-relative pixel
5631 coordinates at this place. Under old redisplay, COLUMN
5632 and ROW are set to frame relative glyph coordinates
5633 which are then used to determine whether this click is
5634 in a menu (non-toolkit version). */
5635 if (!toolkit_menubar_in_use (f
))
5637 pixel_to_glyph_coords (f
, XINT (event
->x
), XINT (event
->y
),
5638 &column
, &row
, NULL
, 1);
5640 /* In the non-toolkit version, clicks on the menu bar
5641 are ordinary button events in the event buffer.
5642 Distinguish them, and invoke the menu.
5644 (In the toolkit version, the toolkit handles the
5645 menu bar and Emacs doesn't know about it until
5646 after the user makes a selection.) */
5647 if (row
>= 0 && row
< FRAME_MENU_BAR_LINES (f
)
5648 && (event
->modifiers
& down_modifier
))
5650 Lisp_Object items
, item
;
5652 /* Find the menu bar item under `column'. */
5654 items
= FRAME_MENU_BAR_ITEMS (f
);
5655 for (i
= 0; i
< ASIZE (items
); i
+= 4)
5657 Lisp_Object pos
, string
;
5658 string
= AREF (items
, i
+ 1);
5659 pos
= AREF (items
, i
+ 3);
5662 if (column
>= XINT (pos
)
5663 && column
< XINT (pos
) + SCHARS (string
))
5665 item
= AREF (items
, i
);
5670 /* ELisp manual 2.4b says (x y) are window
5671 relative but code says they are
5673 position
= list4 (event
->frame_or_window
,
5675 Fcons (event
->x
, event
->y
),
5676 make_number (event
->timestamp
));
5678 return list2 (item
, position
);
5682 position
= make_lispy_position (f
, event
->x
, event
->y
,
5685 #ifndef USE_TOOLKIT_SCROLL_BARS
5687 /* It's a scrollbar click. */
5688 position
= make_scroll_bar_position (event
, Qvertical_scroll_bar
);
5689 #endif /* not USE_TOOLKIT_SCROLL_BARS */
5691 if (button
>= ASIZE (button_down_location
))
5693 ptrdiff_t incr
= button
- ASIZE (button_down_location
) + 1;
5694 button_down_location
= larger_vector (button_down_location
,
5696 mouse_syms
= larger_vector (mouse_syms
, incr
, -1);
5699 start_pos_ptr
= aref_addr (button_down_location
, button
);
5700 start_pos
= *start_pos_ptr
;
5701 *start_pos_ptr
= Qnil
;
5704 /* On window-system frames, use the value of
5705 double-click-fuzz as is. On other frames, interpret it
5706 as a multiple of 1/8 characters. */
5710 if (WINDOWP (event
->frame_or_window
))
5711 f
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5712 else if (FRAMEP (event
->frame_or_window
))
5713 f
= XFRAME (event
->frame_or_window
);
5717 if (FRAME_WINDOW_P (f
))
5718 fuzz
= double_click_fuzz
;
5720 fuzz
= double_click_fuzz
/ 8;
5722 is_double
= (button
== last_mouse_button
5723 && (eabs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5724 && (eabs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5725 && button_down_time
!= 0
5726 && (EQ (Vdouble_click_time
, Qt
)
5727 || (NATNUMP (Vdouble_click_time
)
5728 && (event
->timestamp
- button_down_time
5729 < XFASTINT (Vdouble_click_time
)))));
5732 last_mouse_button
= button
;
5733 last_mouse_x
= XINT (event
->x
);
5734 last_mouse_y
= XINT (event
->y
);
5736 /* If this is a button press, squirrel away the location, so
5737 we can decide later whether it was a click or a drag. */
5738 if (event
->modifiers
& down_modifier
)
5742 double_click_count
++;
5743 event
->modifiers
|= ((double_click_count
> 2)
5748 double_click_count
= 1;
5749 button_down_time
= event
->timestamp
;
5750 *start_pos_ptr
= Fcopy_alist (position
);
5751 ignore_mouse_drag_p
= 0;
5754 /* Now we're releasing a button - check the co-ordinates to
5755 see if this was a click or a drag. */
5756 else if (event
->modifiers
& up_modifier
)
5758 /* If we did not see a down before this up, ignore the up.
5759 Probably this happened because the down event chose a
5760 menu item. It would be an annoyance to treat the
5761 release of the button that chose the menu item as a
5764 if (!CONSP (start_pos
))
5767 event
->modifiers
&= ~up_modifier
;
5770 Lisp_Object new_down
, down
;
5771 EMACS_INT xdiff
= double_click_fuzz
, ydiff
= double_click_fuzz
;
5773 /* The third element of every position
5774 should be the (x,y) pair. */
5775 down
= Fcar (Fcdr (Fcdr (start_pos
)));
5776 new_down
= Fcar (Fcdr (Fcdr (position
)));
5779 && INTEGERP (XCAR (down
)) && INTEGERP (XCDR (down
)))
5781 xdiff
= XINT (XCAR (new_down
)) - XINT (XCAR (down
));
5782 ydiff
= XINT (XCDR (new_down
)) - XINT (XCDR (down
));
5785 if (ignore_mouse_drag_p
)
5787 event
->modifiers
|= click_modifier
;
5788 ignore_mouse_drag_p
= 0;
5790 else if (xdiff
< double_click_fuzz
&& xdiff
> - double_click_fuzz
5791 && ydiff
< double_click_fuzz
&& ydiff
> - double_click_fuzz
5792 /* Maybe the mouse has moved a lot, caused scrolling, and
5793 eventually ended up at the same screen position (but
5794 not buffer position) in which case it is a drag, not
5796 /* FIXME: OTOH if the buffer position has changed
5797 because of a timer or process filter rather than
5798 because of mouse movement, it should be considered as
5799 a click. But mouse-drag-region completely ignores
5800 this case and it hasn't caused any real problem, so
5801 it's probably OK to ignore it as well. */
5802 && EQ (Fcar (Fcdr (start_pos
)), Fcar (Fcdr (position
))))
5803 /* Mouse hasn't moved (much). */
5804 event
->modifiers
|= click_modifier
;
5807 button_down_time
= 0;
5808 event
->modifiers
|= drag_modifier
;
5811 /* Don't check is_double; treat this as multiple
5812 if the down-event was multiple. */
5813 if (double_click_count
> 1)
5814 event
->modifiers
|= ((double_click_count
> 2)
5820 /* Every mouse event should either have the down_modifier or
5821 the up_modifier set. */
5825 /* Get the symbol we should use for the mouse click. */
5828 head
= modify_event_symbol (button
,
5830 Qmouse_click
, Vlispy_mouse_stem
,
5833 ASIZE (mouse_syms
));
5834 if (event
->modifiers
& drag_modifier
)
5835 return list3 (head
, start_pos
, position
);
5836 else if (event
->modifiers
& (double_modifier
| triple_modifier
))
5837 return list3 (head
, position
, make_number (double_click_count
));
5839 return list2 (head
, position
);
5844 case HORIZ_WHEEL_EVENT
:
5846 Lisp_Object position
;
5849 /* Build the position as appropriate for this mouse click. */
5850 struct frame
*f
= XFRAME (event
->frame_or_window
);
5852 /* Ignore wheel events that were made on frame that have been
5854 if (! FRAME_LIVE_P (f
))
5857 position
= make_lispy_position (f
, event
->x
, event
->y
,
5860 /* Set double or triple modifiers to indicate the wheel speed. */
5862 /* On window-system frames, use the value of
5863 double-click-fuzz as is. On other frames, interpret it
5864 as a multiple of 1/8 characters. */
5870 if (WINDOWP (event
->frame_or_window
))
5871 fr
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5872 else if (FRAMEP (event
->frame_or_window
))
5873 fr
= XFRAME (event
->frame_or_window
);
5877 fuzz
= FRAME_WINDOW_P (fr
)
5878 ? double_click_fuzz
: double_click_fuzz
/ 8;
5880 if (event
->modifiers
& up_modifier
)
5882 /* Emit a wheel-up event. */
5883 event
->modifiers
&= ~up_modifier
;
5886 else if (event
->modifiers
& down_modifier
)
5888 /* Emit a wheel-down event. */
5889 event
->modifiers
&= ~down_modifier
;
5893 /* Every wheel event should either have the down_modifier or
5894 the up_modifier set. */
5897 if (event
->kind
== HORIZ_WHEEL_EVENT
)
5900 is_double
= (last_mouse_button
== - (1 + symbol_num
)
5901 && (eabs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5902 && (eabs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5903 && button_down_time
!= 0
5904 && (EQ (Vdouble_click_time
, Qt
)
5905 || (NATNUMP (Vdouble_click_time
)
5906 && (event
->timestamp
- button_down_time
5907 < XFASTINT (Vdouble_click_time
)))));
5910 double_click_count
++;
5911 event
->modifiers
|= ((double_click_count
> 2)
5917 double_click_count
= 1;
5918 event
->modifiers
|= click_modifier
;
5921 button_down_time
= event
->timestamp
;
5922 /* Use a negative value to distinguish wheel from mouse button. */
5923 last_mouse_button
= - (1 + symbol_num
);
5924 last_mouse_x
= XINT (event
->x
);
5925 last_mouse_y
= XINT (event
->y
);
5927 /* Get the symbol we should use for the wheel event. */
5928 head
= modify_event_symbol (symbol_num
,
5934 ASIZE (wheel_syms
));
5937 if (event
->modifiers
& (double_modifier
| triple_modifier
))
5938 return list3 (head
, position
, make_number (double_click_count
));
5940 return list2 (head
, position
);
5944 #ifdef USE_TOOLKIT_SCROLL_BARS
5946 /* We don't have down and up events if using toolkit scroll bars,
5947 so make this always a click event. Store in the `part' of
5948 the Lisp event a symbol which maps to the following actions:
5950 `above_handle' page up
5951 `below_handle' page down
5955 `bottom' bottom of buffer
5956 `handle' thumb has been dragged.
5957 `end-scroll' end of interaction with scroll bar
5959 The incoming input_event contains in its `part' member an
5960 index of type `enum scroll_bar_part' which we can use as an
5961 index in scroll_bar_parts to get the appropriate symbol. */
5963 case SCROLL_BAR_CLICK_EVENT
:
5965 Lisp_Object position
, head
;
5967 position
= make_scroll_bar_position (event
, Qvertical_scroll_bar
);
5969 /* Always treat scroll bar events as clicks. */
5970 event
->modifiers
|= click_modifier
;
5971 event
->modifiers
&= ~up_modifier
;
5973 if (event
->code
>= ASIZE (mouse_syms
))
5974 mouse_syms
= larger_vector (mouse_syms
,
5975 event
->code
- ASIZE (mouse_syms
) + 1,
5978 /* Get the symbol we should use for the mouse click. */
5979 head
= modify_event_symbol (event
->code
,
5984 ASIZE (mouse_syms
));
5985 return list2 (head
, position
);
5988 case HORIZONTAL_SCROLL_BAR_CLICK_EVENT
:
5990 Lisp_Object position
, head
;
5992 position
= make_scroll_bar_position (event
, Qhorizontal_scroll_bar
);
5994 /* Always treat scroll bar events as clicks. */
5995 event
->modifiers
|= click_modifier
;
5996 event
->modifiers
&= ~up_modifier
;
5998 if (event
->code
>= ASIZE (mouse_syms
))
5999 mouse_syms
= larger_vector (mouse_syms
,
6000 event
->code
- ASIZE (mouse_syms
) + 1,
6003 /* Get the symbol we should use for the mouse click. */
6004 head
= modify_event_symbol (event
->code
,
6009 ASIZE (mouse_syms
));
6010 return list2 (head
, position
);
6013 #endif /* USE_TOOLKIT_SCROLL_BARS */
6015 case DRAG_N_DROP_EVENT
:
6018 Lisp_Object head
, position
;
6021 f
= XFRAME (event
->frame_or_window
);
6024 /* Ignore mouse events that were made on frames that
6025 have been deleted. */
6026 if (! FRAME_LIVE_P (f
))
6029 position
= make_lispy_position (f
, event
->x
, event
->y
,
6032 head
= modify_event_symbol (0, event
->modifiers
,
6034 lispy_drag_n_drop_names
,
6035 &drag_n_drop_syms
, 1);
6036 return list3 (head
, position
, files
);
6039 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
6040 || defined (HAVE_NS) || defined (USE_GTK)
6041 case MENU_BAR_EVENT
:
6042 if (EQ (event
->arg
, event
->frame_or_window
))
6043 /* This is the prefix key. We translate this to
6044 `(menu_bar)' because the code in keyboard.c for menu
6045 events, which we use, relies on this. */
6046 return list1 (Qmenu_bar
);
6050 case SELECT_WINDOW_EVENT
:
6051 /* Make an event (select-window (WINDOW)). */
6052 return list2 (Qselect_window
, list1 (event
->frame_or_window
));
6054 case TOOL_BAR_EVENT
:
6055 if (EQ (event
->arg
, event
->frame_or_window
))
6056 /* This is the prefix key. We translate this to
6057 `(tool_bar)' because the code in keyboard.c for tool bar
6058 events, which we use, relies on this. */
6059 return list1 (Qtool_bar
);
6060 else if (SYMBOLP (event
->arg
))
6061 return apply_modifiers (event
->modifiers
, event
->arg
);
6064 case USER_SIGNAL_EVENT
:
6065 /* A user signal. */
6067 char *name
= find_user_signal_name (event
->code
);
6070 return intern (name
);
6073 case SAVE_SESSION_EVENT
:
6074 return Qsave_session
;
6079 return Fcons (Qdbus_event
, event
->arg
);
6081 #endif /* HAVE_DBUS */
6083 #if defined HAVE_GFILENOTIFY || defined HAVE_INOTIFY
6084 case FILE_NOTIFY_EVENT
:
6086 return Fcons (Qfile_notify
, event
->arg
);
6088 #endif /* defined HAVE_GFILENOTIFY || defined HAVE_INOTIFY */
6090 case CONFIG_CHANGED_EVENT
:
6091 return list3 (Qconfig_changed_event
,
6092 event
->arg
, event
->frame_or_window
);
6094 /* The 'kind' field of the event is something we don't recognize. */
6101 make_lispy_movement (struct frame
*frame
, Lisp_Object bar_window
, enum scroll_bar_part part
,
6102 Lisp_Object x
, Lisp_Object y
, Time t
)
6104 /* Is it a scroll bar movement? */
6105 if (frame
&& ! NILP (bar_window
))
6107 Lisp_Object part_sym
;
6109 part_sym
= builtin_lisp_symbol (scroll_bar_parts
[part
]);
6110 return list2 (Qscroll_bar_movement
,
6112 Qvertical_scroll_bar
,
6117 /* Or is it an ordinary mouse movement? */
6120 Lisp_Object position
;
6121 position
= make_lispy_position (frame
, x
, y
, t
);
6122 return list2 (Qmouse_movement
, position
);
6126 /* Construct a switch frame event. */
6128 make_lispy_switch_frame (Lisp_Object frame
)
6130 return list2 (Qswitch_frame
, frame
);
6134 make_lispy_focus_in (Lisp_Object frame
)
6136 return list2 (Qfocus_in
, frame
);
6139 #ifdef HAVE_WINDOW_SYSTEM
6142 make_lispy_focus_out (Lisp_Object frame
)
6144 return list2 (Qfocus_out
, frame
);
6147 #endif /* HAVE_WINDOW_SYSTEM */
6149 /* Manipulating modifiers. */
6151 /* Parse the name of SYMBOL, and return the set of modifiers it contains.
6153 If MODIFIER_END is non-zero, set *MODIFIER_END to the position in
6154 SYMBOL's name of the end of the modifiers; the string from this
6155 position is the unmodified symbol name.
6157 This doesn't use any caches. */
6160 parse_modifiers_uncached (Lisp_Object symbol
, ptrdiff_t *modifier_end
)
6166 CHECK_SYMBOL (symbol
);
6169 name
= SYMBOL_NAME (symbol
);
6171 for (i
= 0; i
< SBYTES (name
) - 1; )
6173 ptrdiff_t this_mod_end
= 0;
6176 /* See if the name continues with a modifier word.
6177 Check that the word appears, but don't check what follows it.
6178 Set this_mod and this_mod_end to record what we find. */
6180 switch (SREF (name
, i
))
6182 #define SINGLE_LETTER_MOD(BIT) \
6183 (this_mod_end = i + 1, this_mod = BIT)
6186 SINGLE_LETTER_MOD (alt_modifier
);
6190 SINGLE_LETTER_MOD (ctrl_modifier
);
6194 SINGLE_LETTER_MOD (hyper_modifier
);
6198 SINGLE_LETTER_MOD (meta_modifier
);
6202 SINGLE_LETTER_MOD (shift_modifier
);
6206 SINGLE_LETTER_MOD (super_modifier
);
6209 #undef SINGLE_LETTER_MOD
6211 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6212 if (i + LEN + 1 <= SBYTES (name) \
6213 && ! memcmp (SDATA (name) + i, NAME, LEN)) \
6215 this_mod_end = i + LEN; \
6220 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
6221 MULTI_LETTER_MOD (down_modifier
, "down", 4);
6222 MULTI_LETTER_MOD (double_modifier
, "double", 6);
6226 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
6228 #undef MULTI_LETTER_MOD
6232 /* If we found no modifier, stop looking for them. */
6233 if (this_mod_end
== 0)
6236 /* Check there is a dash after the modifier, so that it
6237 really is a modifier. */
6238 if (this_mod_end
>= SBYTES (name
)
6239 || SREF (name
, this_mod_end
) != '-')
6242 /* This modifier is real; look for another. */
6243 modifiers
|= this_mod
;
6244 i
= this_mod_end
+ 1;
6247 /* Should we include the `click' modifier? */
6248 if (! (modifiers
& (down_modifier
| drag_modifier
6249 | double_modifier
| triple_modifier
))
6250 && i
+ 7 == SBYTES (name
)
6251 && memcmp (SDATA (name
) + i
, "mouse-", 6) == 0
6252 && ('0' <= SREF (name
, i
+ 6) && SREF (name
, i
+ 6) <= '9'))
6253 modifiers
|= click_modifier
;
6255 if (! (modifiers
& (double_modifier
| triple_modifier
))
6256 && i
+ 6 < SBYTES (name
)
6257 && memcmp (SDATA (name
) + i
, "wheel-", 6) == 0)
6258 modifiers
|= click_modifier
;
6266 /* Return a symbol whose name is the modifier prefixes for MODIFIERS
6267 prepended to the string BASE[0..BASE_LEN-1].
6268 This doesn't use any caches. */
6270 apply_modifiers_uncached (int modifiers
, char *base
, int base_len
, int base_len_byte
)
6272 /* Since BASE could contain nulls, we can't use intern here; we have
6273 to use Fintern, which expects a genuine Lisp_String, and keeps a
6275 char new_mods
[sizeof "A-C-H-M-S-s-down-drag-double-triple-"];
6281 /* Only the event queue may use the `up' modifier; it should always
6282 be turned into a click or drag event before presented to lisp code. */
6283 if (modifiers
& up_modifier
)
6286 if (modifiers
& alt_modifier
) { *p
++ = 'A'; *p
++ = '-'; }
6287 if (modifiers
& ctrl_modifier
) { *p
++ = 'C'; *p
++ = '-'; }
6288 if (modifiers
& hyper_modifier
) { *p
++ = 'H'; *p
++ = '-'; }
6289 if (modifiers
& meta_modifier
) { *p
++ = 'M'; *p
++ = '-'; }
6290 if (modifiers
& shift_modifier
) { *p
++ = 'S'; *p
++ = '-'; }
6291 if (modifiers
& super_modifier
) { *p
++ = 's'; *p
++ = '-'; }
6292 if (modifiers
& double_modifier
) p
= stpcpy (p
, "double-");
6293 if (modifiers
& triple_modifier
) p
= stpcpy (p
, "triple-");
6294 if (modifiers
& down_modifier
) p
= stpcpy (p
, "down-");
6295 if (modifiers
& drag_modifier
) p
= stpcpy (p
, "drag-");
6296 /* The click modifier is denoted by the absence of other modifiers. */
6300 mod_len
= p
- new_mods
;
6304 Lisp_Object new_name
;
6306 new_name
= make_uninit_multibyte_string (mod_len
+ base_len
,
6307 mod_len
+ base_len_byte
);
6308 memcpy (SDATA (new_name
), new_mods
, mod_len
);
6309 memcpy (SDATA (new_name
) + mod_len
, base
, base_len_byte
);
6311 return Fintern (new_name
, Qnil
);
6316 static const char *const modifier_names
[] =
6318 "up", "down", "drag", "click", "double", "triple", 0, 0,
6319 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
6320 0, 0, "alt", "super", "hyper", "shift", "control", "meta"
6322 #define NUM_MOD_NAMES ARRAYELTS (modifier_names)
6324 static Lisp_Object modifier_symbols
;
6326 /* Return the list of modifier symbols corresponding to the mask MODIFIERS. */
6328 lispy_modifier_list (int modifiers
)
6330 Lisp_Object modifier_list
;
6333 modifier_list
= Qnil
;
6334 for (i
= 0; (1<<i
) <= modifiers
&& i
< NUM_MOD_NAMES
; i
++)
6335 if (modifiers
& (1<<i
))
6336 modifier_list
= Fcons (AREF (modifier_symbols
, i
),
6339 return modifier_list
;
6343 /* Parse the modifiers on SYMBOL, and return a list like (UNMODIFIED MASK),
6344 where UNMODIFIED is the unmodified form of SYMBOL,
6345 MASK is the set of modifiers present in SYMBOL's name.
6346 This is similar to parse_modifiers_uncached, but uses the cache in
6347 SYMBOL's Qevent_symbol_element_mask property, and maintains the
6348 Qevent_symbol_elements property. */
6350 #define KEY_TO_CHAR(k) (XINT (k) & ((1 << CHARACTERBITS) - 1))
6353 parse_modifiers (Lisp_Object symbol
)
6355 Lisp_Object elements
;
6357 if (INTEGERP (symbol
))
6358 return list2i (KEY_TO_CHAR (symbol
), XINT (symbol
) & CHAR_MODIFIER_MASK
);
6359 else if (!SYMBOLP (symbol
))
6362 elements
= Fget (symbol
, Qevent_symbol_element_mask
);
6363 if (CONSP (elements
))
6368 int modifiers
= parse_modifiers_uncached (symbol
, &end
);
6369 Lisp_Object unmodified
;
6372 unmodified
= Fintern (make_string (SSDATA (SYMBOL_NAME (symbol
)) + end
,
6373 SBYTES (SYMBOL_NAME (symbol
)) - end
),
6376 if (modifiers
& ~INTMASK
)
6378 XSETFASTINT (mask
, modifiers
);
6379 elements
= list2 (unmodified
, mask
);
6381 /* Cache the parsing results on SYMBOL. */
6382 Fput (symbol
, Qevent_symbol_element_mask
,
6384 Fput (symbol
, Qevent_symbol_elements
,
6385 Fcons (unmodified
, lispy_modifier_list (modifiers
)));
6387 /* Since we know that SYMBOL is modifiers applied to unmodified,
6388 it would be nice to put that in unmodified's cache.
6389 But we can't, since we're not sure that parse_modifiers is
6396 DEFUN ("internal-event-symbol-parse-modifiers", Fevent_symbol_parse_modifiers
,
6397 Sevent_symbol_parse_modifiers
, 1, 1, 0,
6398 doc
: /* Parse the event symbol. For internal use. */)
6399 (Lisp_Object symbol
)
6401 /* Fill the cache if needed. */
6402 parse_modifiers (symbol
);
6403 /* Ignore the result (which is stored on Qevent_symbol_element_mask)
6404 and use the Lispier representation stored on Qevent_symbol_elements
6406 return Fget (symbol
, Qevent_symbol_elements
);
6409 /* Apply the modifiers MODIFIERS to the symbol BASE.
6410 BASE must be unmodified.
6412 This is like apply_modifiers_uncached, but uses BASE's
6413 Qmodifier_cache property, if present. It also builds
6414 Qevent_symbol_elements properties, since it has that info anyway.
6416 apply_modifiers copies the value of BASE's Qevent_kind property to
6417 the modified symbol. */
6419 apply_modifiers (int modifiers
, Lisp_Object base
)
6421 Lisp_Object cache
, idx
, entry
, new_symbol
;
6423 /* Mask out upper bits. We don't know where this value's been. */
6424 modifiers
&= INTMASK
;
6426 if (INTEGERP (base
))
6427 return make_number (XINT (base
) | modifiers
);
6429 /* The click modifier never figures into cache indices. */
6430 cache
= Fget (base
, Qmodifier_cache
);
6431 XSETFASTINT (idx
, (modifiers
& ~click_modifier
));
6432 entry
= assq_no_quit (idx
, cache
);
6435 new_symbol
= XCDR (entry
);
6438 /* We have to create the symbol ourselves. */
6439 new_symbol
= apply_modifiers_uncached (modifiers
,
6440 SSDATA (SYMBOL_NAME (base
)),
6441 SCHARS (SYMBOL_NAME (base
)),
6442 SBYTES (SYMBOL_NAME (base
)));
6444 /* Add the new symbol to the base's cache. */
6445 entry
= Fcons (idx
, new_symbol
);
6446 Fput (base
, Qmodifier_cache
, Fcons (entry
, cache
));
6448 /* We have the parsing info now for free, so we could add it to
6450 XSETFASTINT (idx, modifiers);
6451 Fput (new_symbol, Qevent_symbol_element_mask,
6453 Fput (new_symbol, Qevent_symbol_elements,
6454 Fcons (base, lispy_modifier_list (modifiers)));
6455 Sadly, this is only correct if `base' is indeed a base event,
6456 which is not necessarily the case. -stef */
6459 /* Make sure this symbol is of the same kind as BASE.
6461 You'd think we could just set this once and for all when we
6462 intern the symbol above, but reorder_modifiers may call us when
6463 BASE's property isn't set right; we can't assume that just
6464 because it has a Qmodifier_cache property it must have its
6465 Qevent_kind set right as well. */
6466 if (NILP (Fget (new_symbol
, Qevent_kind
)))
6470 kind
= Fget (base
, Qevent_kind
);
6472 Fput (new_symbol
, Qevent_kind
, kind
);
6479 /* Given a symbol whose name begins with modifiers ("C-", "M-", etc),
6480 return a symbol with the modifiers placed in the canonical order.
6481 Canonical order is alphabetical, except for down and drag, which
6482 always come last. The 'click' modifier is never written out.
6484 Fdefine_key calls this to make sure that (for example) C-M-foo
6485 and M-C-foo end up being equivalent in the keymap. */
6488 reorder_modifiers (Lisp_Object symbol
)
6490 /* It's hopefully okay to write the code this way, since everything
6491 will soon be in caches, and no consing will be done at all. */
6494 parsed
= parse_modifiers (symbol
);
6495 return apply_modifiers (XFASTINT (XCAR (XCDR (parsed
))),
6500 /* For handling events, we often want to produce a symbol whose name
6501 is a series of modifier key prefixes ("M-", "C-", etcetera) attached
6502 to some base, like the name of a function key or mouse button.
6503 modify_event_symbol produces symbols of this sort.
6505 NAME_TABLE should point to an array of strings, such that NAME_TABLE[i]
6506 is the name of the i'th symbol. TABLE_SIZE is the number of elements
6509 Alternatively, NAME_ALIST_OR_STEM is either an alist mapping codes
6510 into symbol names, or a string specifying a name stem used to
6511 construct a symbol name or the form `STEM-N', where N is the decimal
6512 representation of SYMBOL_NUM. NAME_ALIST_OR_STEM is used if it is
6513 non-nil; otherwise NAME_TABLE is used.
6515 SYMBOL_TABLE should be a pointer to a Lisp_Object whose value will
6516 persist between calls to modify_event_symbol that it can use to
6517 store a cache of the symbols it's generated for this NAME_TABLE
6518 before. The object stored there may be a vector or an alist.
6520 SYMBOL_NUM is the number of the base name we want from NAME_TABLE.
6522 MODIFIERS is a set of modifier bits (as given in struct input_events)
6523 whose prefixes should be applied to the symbol name.
6525 SYMBOL_KIND is the value to be placed in the event_kind property of
6526 the returned symbol.
6528 The symbols we create are supposed to have an
6529 `event-symbol-elements' property, which lists the modifiers present
6530 in the symbol's name. */
6533 modify_event_symbol (ptrdiff_t symbol_num
, int modifiers
, Lisp_Object symbol_kind
,
6534 Lisp_Object name_alist_or_stem
, const char *const *name_table
,
6535 Lisp_Object
*symbol_table
, ptrdiff_t table_size
)
6538 Lisp_Object symbol_int
;
6540 /* Get rid of the "vendor-specific" bit here. */
6541 XSETINT (symbol_int
, symbol_num
& 0xffffff);
6543 /* Is this a request for a valid symbol? */
6544 if (symbol_num
< 0 || symbol_num
>= table_size
)
6547 if (CONSP (*symbol_table
))
6548 value
= Fcdr (assq_no_quit (symbol_int
, *symbol_table
));
6550 /* If *symbol_table doesn't seem to be initialized properly, fix that.
6551 *symbol_table should be a lisp vector TABLE_SIZE elements long,
6552 where the Nth element is the symbol for NAME_TABLE[N], or nil if
6553 we've never used that symbol before. */
6556 if (! VECTORP (*symbol_table
)
6557 || ASIZE (*symbol_table
) != table_size
)
6561 XSETFASTINT (size
, table_size
);
6562 *symbol_table
= Fmake_vector (size
, Qnil
);
6565 value
= AREF (*symbol_table
, symbol_num
);
6568 /* Have we already used this symbol before? */
6571 /* No; let's create it. */
6572 if (CONSP (name_alist_or_stem
))
6573 value
= Fcdr_safe (Fassq (symbol_int
, name_alist_or_stem
));
6574 else if (STRINGP (name_alist_or_stem
))
6577 ptrdiff_t len
= (SBYTES (name_alist_or_stem
)
6578 + sizeof "-" + INT_STRLEN_BOUND (EMACS_INT
));
6580 buf
= SAFE_ALLOCA (len
);
6581 esprintf (buf
, "%s-%"pI
"d", SDATA (name_alist_or_stem
),
6582 XINT (symbol_int
) + 1);
6583 value
= intern (buf
);
6586 else if (name_table
!= 0 && name_table
[symbol_num
])
6587 value
= intern (name_table
[symbol_num
]);
6589 #ifdef HAVE_WINDOW_SYSTEM
6592 char *name
= x_get_keysym_name (symbol_num
);
6594 value
= intern (name
);
6600 char buf
[sizeof "key-" + INT_STRLEN_BOUND (EMACS_INT
)];
6601 sprintf (buf
, "key-%"pD
"d", symbol_num
);
6602 value
= intern (buf
);
6605 if (CONSP (*symbol_table
))
6606 *symbol_table
= Fcons (Fcons (symbol_int
, value
), *symbol_table
);
6608 ASET (*symbol_table
, symbol_num
, value
);
6610 /* Fill in the cache entries for this symbol; this also
6611 builds the Qevent_symbol_elements property, which the user
6613 apply_modifiers (modifiers
& click_modifier
, value
);
6614 Fput (value
, Qevent_kind
, symbol_kind
);
6617 /* Apply modifiers to that symbol. */
6618 return apply_modifiers (modifiers
, value
);
6621 /* Convert a list that represents an event type,
6622 such as (ctrl meta backspace), into the usual representation of that
6623 event type as a number or a symbol. */
6625 DEFUN ("event-convert-list", Fevent_convert_list
, Sevent_convert_list
, 1, 1, 0,
6626 doc
: /* Convert the event description list EVENT-DESC to an event type.
6627 EVENT-DESC should contain one base event type (a character or symbol)
6628 and zero or more modifier names (control, meta, hyper, super, shift, alt,
6629 drag, down, double or triple). The base must be last.
6630 The return value is an event type (a character or symbol) which
6631 has the same base event type and all the specified modifiers. */)
6632 (Lisp_Object event_desc
)
6640 while (CONSP (rest
))
6648 /* Given a symbol, see if it is a modifier name. */
6649 if (SYMBOLP (elt
) && CONSP (rest
))
6650 this = parse_solitary_modifier (elt
);
6654 else if (!NILP (base
))
6655 error ("Two bases given in one event");
6661 /* Let the symbol A refer to the character A. */
6662 if (SYMBOLP (base
) && SCHARS (SYMBOL_NAME (base
)) == 1)
6663 XSETINT (base
, SREF (SYMBOL_NAME (base
), 0));
6665 if (INTEGERP (base
))
6667 /* Turn (shift a) into A. */
6668 if ((modifiers
& shift_modifier
) != 0
6669 && (XINT (base
) >= 'a' && XINT (base
) <= 'z'))
6671 XSETINT (base
, XINT (base
) - ('a' - 'A'));
6672 modifiers
&= ~shift_modifier
;
6675 /* Turn (control a) into C-a. */
6676 if (modifiers
& ctrl_modifier
)
6677 return make_number ((modifiers
& ~ctrl_modifier
)
6678 | make_ctrl_char (XINT (base
)));
6680 return make_number (modifiers
| XINT (base
));
6682 else if (SYMBOLP (base
))
6683 return apply_modifiers (modifiers
, base
);
6685 error ("Invalid base event");
6688 /* Try to recognize SYMBOL as a modifier name.
6689 Return the modifier flag bit, or 0 if not recognized. */
6692 parse_solitary_modifier (Lisp_Object symbol
)
6694 Lisp_Object name
= SYMBOL_NAME (symbol
);
6696 switch (SREF (name
, 0))
6698 #define SINGLE_LETTER_MOD(BIT) \
6699 if (SBYTES (name) == 1) \
6702 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6703 if (LEN == SBYTES (name) \
6704 && ! memcmp (SDATA (name), NAME, LEN)) \
6708 SINGLE_LETTER_MOD (alt_modifier
);
6712 MULTI_LETTER_MOD (alt_modifier
, "alt", 3);
6716 SINGLE_LETTER_MOD (ctrl_modifier
);
6720 MULTI_LETTER_MOD (ctrl_modifier
, "ctrl", 4);
6721 MULTI_LETTER_MOD (ctrl_modifier
, "control", 7);
6725 SINGLE_LETTER_MOD (hyper_modifier
);
6729 MULTI_LETTER_MOD (hyper_modifier
, "hyper", 5);
6733 SINGLE_LETTER_MOD (meta_modifier
);
6737 MULTI_LETTER_MOD (meta_modifier
, "meta", 4);
6741 SINGLE_LETTER_MOD (shift_modifier
);
6745 MULTI_LETTER_MOD (shift_modifier
, "shift", 5);
6746 MULTI_LETTER_MOD (super_modifier
, "super", 5);
6747 SINGLE_LETTER_MOD (super_modifier
);
6751 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
6752 MULTI_LETTER_MOD (down_modifier
, "down", 4);
6753 MULTI_LETTER_MOD (double_modifier
, "double", 6);
6757 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
6760 #undef SINGLE_LETTER_MOD
6761 #undef MULTI_LETTER_MOD
6767 /* Return true if EVENT is a list whose elements are all integers or symbols.
6768 Such a list is not valid as an event,
6769 but it can be a Lucid-style event type list. */
6772 lucid_event_type_list_p (Lisp_Object object
)
6776 if (! CONSP (object
))
6779 if (EQ (XCAR (object
), Qhelp_echo
)
6780 || EQ (XCAR (object
), Qvertical_line
)
6781 || EQ (XCAR (object
), Qmode_line
)
6782 || EQ (XCAR (object
), Qheader_line
))
6785 for (tail
= object
; CONSP (tail
); tail
= XCDR (tail
))
6789 if (! (INTEGERP (elt
) || SYMBOLP (elt
)))
6796 /* Return true if terminal input chars are available.
6797 Also, store the return value into INPUT_PENDING.
6799 Serves the purpose of ioctl (0, FIONREAD, ...)
6800 but works even if FIONREAD does not exist.
6801 (In fact, this may actually read some input.)
6803 If READABLE_EVENTS_DO_TIMERS_NOW is set in FLAGS, actually run
6804 timer events that are ripe.
6805 If READABLE_EVENTS_FILTER_EVENTS is set in FLAGS, ignore internal
6806 events (FOCUS_IN_EVENT).
6807 If READABLE_EVENTS_IGNORE_SQUEEZABLES is set in FLAGS, ignore mouse
6808 movements and toolkit scroll bar thumb drags. */
6811 get_input_pending (int flags
)
6813 /* First of all, have we already counted some input? */
6814 input_pending
= (!NILP (Vquit_flag
) || readable_events (flags
));
6816 /* If input is being read as it arrives, and we have none, there is none. */
6817 if (!input_pending
&& (!interrupt_input
|| interrupts_deferred
))
6819 /* Try to read some input and see how much we get. */
6821 input_pending
= (!NILP (Vquit_flag
) || readable_events (flags
));
6824 return input_pending
;
6827 /* Put a BUFFER_SWITCH_EVENT in the buffer
6828 so that read_key_sequence will notice the new current buffer. */
6831 record_asynch_buffer_change (void)
6833 /* We don't need a buffer-switch event unless Emacs is waiting for input.
6834 The purpose of the event is to make read_key_sequence look up the
6835 keymaps again. If we aren't in read_key_sequence, we don't need one,
6836 and the event could cause trouble by messing up (input-pending-p).
6837 Note: Fwaiting_for_user_input_p always returns nil when async
6838 subprocesses aren't supported. */
6839 if (!NILP (Fwaiting_for_user_input_p ()))
6841 struct input_event event
;
6844 event
.kind
= BUFFER_SWITCH_EVENT
;
6845 event
.frame_or_window
= Qnil
;
6848 /* Make sure no interrupt happens while storing the event. */
6850 if (interrupt_input
)
6851 kbd_buffer_store_event (&event
);
6856 kbd_buffer_store_event (&event
);
6862 /* Read any terminal input already buffered up by the system
6863 into the kbd_buffer, but do not wait.
6865 Return the number of keyboard chars read, or -1 meaning
6866 this is a bad time to try to read input. */
6875 /* Store pending user signal events, if any. */
6876 store_user_signal_events ();
6878 /* Loop through the available terminals, and call their input hooks. */
6882 struct terminal
*next
= t
->next_terminal
;
6884 if (t
->read_socket_hook
)
6887 struct input_event hold_quit
;
6889 if (input_blocked_p ())
6891 pending_signals
= 1;
6895 EVENT_INIT (hold_quit
);
6896 hold_quit
.kind
= NO_EVENT
;
6898 /* No need for FIONREAD or fcntl; just say don't wait. */
6899 while ((nr
= (*t
->read_socket_hook
) (t
, &hold_quit
)) > 0)
6902 if (nr
== -1) /* Not OK to read input now. */
6906 else if (nr
== -2) /* Non-transient error. */
6908 /* The terminal device terminated; it should be closed. */
6910 /* Kill Emacs if this was our last terminal. */
6911 if (!terminal_list
->next_terminal
)
6912 /* Formerly simply reported no input, but that
6913 sometimes led to a failure of Emacs to terminate.
6914 SIGHUP seems appropriate if we can't reach the
6916 /* ??? Is it really right to send the signal just to
6917 this process rather than to the whole process
6918 group? Perhaps on systems with FIONREAD Emacs is
6919 alone in its group. */
6920 terminate_due_to_signal (SIGHUP
, 10);
6922 /* XXX Is calling delete_terminal safe here? It calls delete_frame. */
6925 XSETTERMINAL (tmp
, t
);
6926 Fdelete_terminal (tmp
, Qnoelisp
);
6930 /* If there was no error, make sure the pointer
6931 is visible for all frames on this terminal. */
6934 Lisp_Object tail
, frame
;
6936 FOR_EACH_FRAME (tail
, frame
)
6938 struct frame
*f
= XFRAME (frame
);
6939 if (FRAME_TERMINAL (f
) == t
)
6940 frame_make_pointer_visible (f
);
6944 if (hold_quit
.kind
!= NO_EVENT
)
6945 kbd_buffer_store_event (&hold_quit
);
6957 /* This is the tty way of reading available input.
6959 Note that each terminal device has its own `struct terminal' object,
6960 and so this function is called once for each individual termcap
6961 terminal. The first parameter indicates which terminal to read from. */
6964 tty_read_avail_input (struct terminal
*terminal
,
6965 struct input_event
*hold_quit
)
6967 /* Using KBD_BUFFER_SIZE - 1 here avoids reading more than
6968 the kbd_buffer can really hold. That may prevent loss
6969 of characters on some systems when input is stuffed at us. */
6970 unsigned char cbuf
[KBD_BUFFER_SIZE
- 1];
6972 struct tty_display_info
*tty
= terminal
->display_info
.tty
;
6975 int buffer_free
= KBD_BUFFER_SIZE
- kbd_buffer_nr_stored () - 1;
6977 if (kbd_on_hold_p () || buffer_free
<= 0)
6979 #endif /* subprocesses */
6981 if (!terminal
->name
) /* Don't read from a dead terminal. */
6984 if (terminal
->type
!= output_termcap
6985 && terminal
->type
!= output_msdos_raw
)
6988 /* XXX I think the following code should be moved to separate hook
6989 functions in system-dependent files. */
6991 /* FIXME: AFAIK, tty_read_avail_input is not used under w32 since the non-GUI
6992 code sets read_socket_hook to w32_console_read_socket instead! */
6994 #else /* not WINDOWSNT */
6995 if (! tty
->term_initted
) /* In case we get called during bootstrap. */
6999 return 0; /* The terminal is suspended. */
7002 n_to_read
= dos_keysns ();
7006 cbuf
[0] = dos_keyread ();
7009 #else /* not MSDOS */
7014 struct input_event gpm_hold_quit
;
7015 int gpm
, fd
= gpm_fd
;
7017 EVENT_INIT (gpm_hold_quit
);
7018 gpm_hold_quit
.kind
= NO_EVENT
;
7020 /* gpm==1 if event received.
7021 gpm==0 if the GPM daemon has closed the connection, in which case
7022 Gpm_GetEvent closes gpm_fd and clears it to -1, which is why
7023 we save it in `fd' so close_gpm can remove it from the
7025 gpm==-1 if a protocol error or EWOULDBLOCK; the latter is normal. */
7026 while (gpm
= Gpm_GetEvent (&event
), gpm
== 1) {
7027 nread
+= handle_one_term_event (tty
, &event
, &gpm_hold_quit
);
7030 /* Presumably the GPM daemon has closed the connection. */
7032 if (gpm_hold_quit
.kind
!= NO_EVENT
)
7033 kbd_buffer_store_event (&gpm_hold_quit
);
7037 #endif /* HAVE_GPM */
7039 /* Determine how many characters we should *try* to read. */
7040 #ifdef USABLE_FIONREAD
7041 /* Find out how much input is available. */
7042 if (ioctl (fileno (tty
->input
), FIONREAD
, &n_to_read
) < 0)
7044 if (! noninteractive
)
7045 return -2; /* Close this terminal. */
7051 if (n_to_read
> sizeof cbuf
)
7052 n_to_read
= sizeof cbuf
;
7053 #elif defined USG || defined CYGWIN
7054 /* Read some input if available, but don't wait. */
7055 n_to_read
= sizeof cbuf
;
7056 fcntl (fileno (tty
->input
), F_SETFL
, O_NONBLOCK
);
7058 # error "Cannot read without possibly delaying"
7062 /* Don't read more than we can store. */
7063 if (n_to_read
> buffer_free
)
7064 n_to_read
= buffer_free
;
7065 #endif /* subprocesses */
7067 /* Now read; for one reason or another, this will not block.
7068 NREAD is set to the number of chars read. */
7071 nread
= emacs_read (fileno (tty
->input
), (char *) cbuf
, n_to_read
);
7072 /* POSIX infers that processes which are not in the session leader's
7073 process group won't get SIGHUPs at logout time. BSDI adheres to
7074 this part standard and returns -1 from read (0) with errno==EIO
7075 when the control tty is taken away.
7076 Jeffrey Honig <jch@bsdi.com> says this is generally safe. */
7077 if (nread
== -1 && errno
== EIO
)
7078 return -2; /* Close this terminal. */
7079 #if defined (AIX) && defined (_BSD)
7080 /* The kernel sometimes fails to deliver SIGHUP for ptys.
7081 This looks incorrect, but it isn't, because _BSD causes
7082 O_NDELAY to be defined in fcntl.h as O_NONBLOCK,
7083 and that causes a value other than 0 when there is no input. */
7085 return -2; /* Close this terminal. */
7089 /* We used to retry the read if it was interrupted.
7090 But this does the wrong thing when O_NONBLOCK causes
7091 an EAGAIN error. Does anybody know of a situation
7092 where a retry is actually needed? */
7094 nread
< 0 && (errno
== EAGAIN
|| errno
== EFAULT
7104 #ifndef USABLE_FIONREAD
7105 #if defined (USG) || defined (CYGWIN)
7106 fcntl (fileno (tty
->input
), F_SETFL
, 0);
7107 #endif /* USG or CYGWIN */
7108 #endif /* no FIONREAD */
7113 #endif /* not MSDOS */
7114 #endif /* not WINDOWSNT */
7116 for (i
= 0; i
< nread
; i
++)
7118 struct input_event buf
;
7120 buf
.kind
= ASCII_KEYSTROKE_EVENT
;
7122 if (tty
->meta_key
== 1 && (cbuf
[i
] & 0x80))
7123 buf
.modifiers
= meta_modifier
;
7124 if (tty
->meta_key
!= 2)
7128 /* Set the frame corresponding to the active tty. Note that the
7129 value of selected_frame is not reliable here, redisplay tends
7130 to temporarily change it. */
7131 buf
.frame_or_window
= tty
->top_frame
;
7134 kbd_buffer_store_event (&buf
);
7135 /* Don't look at input that follows a C-g too closely.
7136 This reduces lossage due to autorepeat on C-g. */
7137 if (buf
.kind
== ASCII_KEYSTROKE_EVENT
7138 && buf
.code
== quit_char
)
7146 handle_async_input (void)
7151 int nread
= gobble_input ();
7152 /* -1 means it's not ok to read the input now.
7153 UNBLOCK_INPUT will read it later; now, avoid infinite loop.
7154 0 means there was no keyboard input available. */
7162 process_pending_signals (void)
7164 pending_signals
= 0;
7165 handle_async_input ();
7166 do_pending_atimers ();
7169 /* Undo any number of BLOCK_INPUT calls down to level LEVEL,
7170 and reinvoke any pending signal if the level is now 0 and
7171 a fatal error is not already in progress. */
7174 unblock_input_to (int level
)
7176 interrupt_input_blocked
= level
;
7179 if (pending_signals
&& !fatal_error_in_progress
)
7180 process_pending_signals ();
7186 /* End critical section.
7188 If doing signal-driven input, and a signal came in when input was
7189 blocked, reinvoke the signal handler now to deal with it.
7191 It will also process queued input, if it was not read before.
7192 When a longer code sequence does not use block/unblock input
7193 at all, the whole input gathered up to the next call to
7194 unblock_input will be processed inside that call. */
7197 unblock_input (void)
7199 unblock_input_to (interrupt_input_blocked
- 1);
7202 /* Undo any number of BLOCK_INPUT calls,
7203 and also reinvoke any pending signal. */
7206 totally_unblock_input (void)
7208 unblock_input_to (0);
7214 handle_input_available_signal (int sig
)
7216 pending_signals
= 1;
7218 if (input_available_clear_time
)
7219 *input_available_clear_time
= make_timespec (0, 0);
7223 deliver_input_available_signal (int sig
)
7225 deliver_process_signal (sig
, handle_input_available_signal
);
7227 #endif /* USABLE_SIGIO */
7230 /* User signal events. */
7232 struct user_signal_info
7234 /* Signal number. */
7237 /* Name of the signal. */
7240 /* Number of pending signals. */
7243 struct user_signal_info
*next
;
7246 /* List of user signals. */
7247 static struct user_signal_info
*user_signals
= NULL
;
7250 add_user_signal (int sig
, const char *name
)
7252 struct sigaction action
;
7253 struct user_signal_info
*p
;
7255 for (p
= user_signals
; p
; p
= p
->next
)
7257 /* Already added. */
7260 p
= xmalloc (sizeof *p
);
7262 p
->name
= xstrdup (name
);
7264 p
->next
= user_signals
;
7267 emacs_sigaction_init (&action
, deliver_user_signal
);
7268 sigaction (sig
, &action
, 0);
7272 handle_user_signal (int sig
)
7274 struct user_signal_info
*p
;
7275 const char *special_event_name
= NULL
;
7277 if (SYMBOLP (Vdebug_on_event
))
7278 special_event_name
= SSDATA (SYMBOL_NAME (Vdebug_on_event
));
7280 for (p
= user_signals
; p
; p
= p
->next
)
7283 if (special_event_name
7284 && strcmp (special_event_name
, p
->name
) == 0)
7286 /* Enter the debugger in many ways. */
7287 debug_on_next_call
= 1;
7290 Vinhibit_quit
= Qnil
;
7292 /* Eat the event. */
7298 if (interrupt_input
)
7299 handle_input_available_signal (sig
);
7303 /* Tell wait_reading_process_output that it needs to wake
7304 up and look around. */
7305 if (input_available_clear_time
)
7306 *input_available_clear_time
= make_timespec (0, 0);
7313 deliver_user_signal (int sig
)
7315 deliver_process_signal (sig
, handle_user_signal
);
7319 find_user_signal_name (int sig
)
7321 struct user_signal_info
*p
;
7323 for (p
= user_signals
; p
; p
= p
->next
)
7331 store_user_signal_events (void)
7333 struct user_signal_info
*p
;
7334 struct input_event buf
;
7335 bool buf_initialized
= 0;
7337 for (p
= user_signals
; p
; p
= p
->next
)
7338 if (p
->npending
> 0)
7340 if (! buf_initialized
)
7342 memset (&buf
, 0, sizeof buf
);
7343 buf
.kind
= USER_SIGNAL_EVENT
;
7344 buf
.frame_or_window
= selected_frame
;
7345 buf_initialized
= 1;
7351 kbd_buffer_store_event (&buf
);
7354 while (p
->npending
> 0);
7359 static void menu_bar_item (Lisp_Object
, Lisp_Object
, Lisp_Object
, void *);
7360 static Lisp_Object menu_bar_one_keymap_changed_items
;
7362 /* These variables hold the vector under construction within
7363 menu_bar_items and its subroutines, and the current index
7364 for storing into that vector. */
7365 static Lisp_Object menu_bar_items_vector
;
7366 static int menu_bar_items_index
;
7369 static const char *separator_names
[] = {
7374 "single-dashed-line",
7375 "double-dashed-line",
7377 "shadow-etched-out",
7378 "shadow-etched-in-dash",
7379 "shadow-etched-out-dash",
7380 "shadow-double-etched-in",
7381 "shadow-double-etched-out",
7382 "shadow-double-etched-in-dash",
7383 "shadow-double-etched-out-dash",
7387 /* Return true if LABEL specifies a separator. */
7390 menu_separator_name_p (const char *label
)
7394 else if (strlen (label
) > 3
7395 && memcmp (label
, "--", 2) == 0
7400 for (i
= 0; separator_names
[i
]; ++i
)
7401 if (strcmp (label
, separator_names
[i
]) == 0)
7406 /* It's a separator if it contains only dashes. */
7407 while (*label
== '-')
7409 return (*label
== 0);
7416 /* Return a vector of menu items for a menu bar, appropriate
7417 to the current buffer. Each item has three elements in the vector:
7420 OLD is an old vector we can optionally reuse, or nil. */
7423 menu_bar_items (Lisp_Object old
)
7425 /* The number of keymaps we're scanning right now, and the number of
7426 keymaps we have allocated space for. */
7429 /* maps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
7430 in the current keymaps, or nil where it is not a prefix. */
7433 Lisp_Object mapsbuf
[3];
7434 Lisp_Object def
, tail
;
7441 /* In order to build the menus, we need to call the keymap
7442 accessors. They all call QUIT. But this function is called
7443 during redisplay, during which a quit is fatal. So inhibit
7444 quitting while building the menus.
7445 We do this instead of specbind because (1) errors will clear it anyway
7446 and (2) this avoids risk of specpdl overflow. */
7447 oquit
= Vinhibit_quit
;
7451 menu_bar_items_vector
= old
;
7453 menu_bar_items_vector
= Fmake_vector (make_number (24), Qnil
);
7454 menu_bar_items_index
= 0;
7456 /* Build our list of keymaps.
7457 If we recognize a function key and replace its escape sequence in
7458 keybuf with its symbol, or if the sequence starts with a mouse
7459 click and we need to switch buffers, we jump back here to rebuild
7460 the initial keymaps from the current buffer. */
7464 /* Should overriding-terminal-local-map and overriding-local-map apply? */
7465 if (!NILP (Voverriding_local_map_menu_flag
)
7466 && !NILP (Voverriding_local_map
))
7468 /* Yes, use them (if non-nil) as well as the global map. */
7471 if (!NILP (KVAR (current_kboard
, Voverriding_terminal_local_map
)))
7472 maps
[nmaps
++] = KVAR (current_kboard
, Voverriding_terminal_local_map
);
7473 if (!NILP (Voverriding_local_map
))
7474 maps
[nmaps
++] = Voverriding_local_map
;
7478 /* No, so use major and minor mode keymaps and keymap property.
7479 Note that menu-bar bindings in the local-map and keymap
7480 properties may not work reliable, as they are only
7481 recognized when the menu-bar (or mode-line) is updated,
7482 which does not normally happen after every command. */
7485 nminor
= current_minor_maps (NULL
, &tmaps
);
7486 SAFE_NALLOCA (maps
, 1, nminor
+ 4);
7488 tem
= KVAR (current_kboard
, Voverriding_terminal_local_map
);
7489 if (!NILP (tem
) && !NILP (Voverriding_local_map_menu_flag
))
7490 maps
[nmaps
++] = tem
;
7491 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
7492 maps
[nmaps
++] = tem
;
7493 memcpy (maps
+ nmaps
, tmaps
, nminor
* sizeof (maps
[0]));
7495 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
7497 maps
[nmaps
++] = current_global_map
;
7500 /* Look up in each map the dummy prefix key `menu-bar'. */
7502 for (mapno
= nmaps
- 1; mapno
>= 0; mapno
--)
7503 if (!NILP (maps
[mapno
]))
7505 def
= get_keymap (access_keymap (maps
[mapno
], Qmenu_bar
, 1, 0, 1),
7509 menu_bar_one_keymap_changed_items
= Qnil
;
7510 map_keymap_canonical (def
, menu_bar_item
, Qnil
, NULL
);
7514 /* Move to the end those items that should be at the end. */
7516 for (tail
= Vmenu_bar_final_items
; CONSP (tail
); tail
= XCDR (tail
))
7519 int end
= menu_bar_items_index
;
7521 for (i
= 0; i
< end
; i
+= 4)
7522 if (EQ (XCAR (tail
), AREF (menu_bar_items_vector
, i
)))
7524 Lisp_Object tem0
, tem1
, tem2
, tem3
;
7525 /* Move the item at index I to the end,
7526 shifting all the others forward. */
7527 tem0
= AREF (menu_bar_items_vector
, i
+ 0);
7528 tem1
= AREF (menu_bar_items_vector
, i
+ 1);
7529 tem2
= AREF (menu_bar_items_vector
, i
+ 2);
7530 tem3
= AREF (menu_bar_items_vector
, i
+ 3);
7532 memmove (aref_addr (menu_bar_items_vector
, i
),
7533 aref_addr (menu_bar_items_vector
, i
+ 4),
7534 (end
- i
- 4) * word_size
);
7535 ASET (menu_bar_items_vector
, end
- 4, tem0
);
7536 ASET (menu_bar_items_vector
, end
- 3, tem1
);
7537 ASET (menu_bar_items_vector
, end
- 2, tem2
);
7538 ASET (menu_bar_items_vector
, end
- 1, tem3
);
7543 /* Add nil, nil, nil, nil at the end. */
7545 int i
= menu_bar_items_index
;
7546 if (i
+ 4 > ASIZE (menu_bar_items_vector
))
7547 menu_bar_items_vector
7548 = larger_vector (menu_bar_items_vector
, 4, -1);
7549 /* Add this item. */
7550 ASET (menu_bar_items_vector
, i
, Qnil
); i
++;
7551 ASET (menu_bar_items_vector
, i
, Qnil
); i
++;
7552 ASET (menu_bar_items_vector
, i
, Qnil
); i
++;
7553 ASET (menu_bar_items_vector
, i
, Qnil
); i
++;
7554 menu_bar_items_index
= i
;
7557 Vinhibit_quit
= oquit
;
7559 return menu_bar_items_vector
;
7562 /* Add one item to menu_bar_items_vector, for KEY, ITEM_STRING and DEF.
7563 If there's already an item for KEY, add this DEF to it. */
7565 Lisp_Object item_properties
;
7568 menu_bar_item (Lisp_Object key
, Lisp_Object item
, Lisp_Object dummy1
, void *dummy2
)
7570 struct gcpro gcpro1
;
7575 if (EQ (item
, Qundefined
))
7577 /* If a map has an explicit `undefined' as definition,
7578 discard any previously made menu bar item. */
7580 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7581 if (EQ (key
, AREF (menu_bar_items_vector
, i
)))
7583 if (menu_bar_items_index
> i
+ 4)
7584 memmove (aref_addr (menu_bar_items_vector
, i
),
7585 aref_addr (menu_bar_items_vector
, i
+ 4),
7586 (menu_bar_items_index
- i
- 4) * word_size
);
7587 menu_bar_items_index
-= 4;
7591 /* If this keymap has already contributed to this KEY,
7592 don't contribute to it a second time. */
7593 tem
= Fmemq (key
, menu_bar_one_keymap_changed_items
);
7594 if (!NILP (tem
) || NILP (item
))
7597 menu_bar_one_keymap_changed_items
7598 = Fcons (key
, menu_bar_one_keymap_changed_items
);
7600 /* We add to menu_bar_one_keymap_changed_items before doing the
7601 parse_menu_item, so that if it turns out it wasn't a menu item,
7602 it still correctly hides any further menu item. */
7604 parsed
= parse_menu_item (item
, 1);
7609 item
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7611 /* Find any existing item for this KEY. */
7612 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7613 if (EQ (key
, AREF (menu_bar_items_vector
, i
)))
7616 /* If we did not find this KEY, add it at the end. */
7617 if (i
== menu_bar_items_index
)
7619 /* If vector is too small, get a bigger one. */
7620 if (i
+ 4 > ASIZE (menu_bar_items_vector
))
7621 menu_bar_items_vector
= larger_vector (menu_bar_items_vector
, 4, -1);
7622 /* Add this item. */
7623 ASET (menu_bar_items_vector
, i
, key
); i
++;
7624 ASET (menu_bar_items_vector
, i
,
7625 AREF (item_properties
, ITEM_PROPERTY_NAME
)); i
++;
7626 ASET (menu_bar_items_vector
, i
, list1 (item
)); i
++;
7627 ASET (menu_bar_items_vector
, i
, make_number (0)); i
++;
7628 menu_bar_items_index
= i
;
7630 /* We did find an item for this KEY. Add ITEM to its list of maps. */
7634 old
= AREF (menu_bar_items_vector
, i
+ 2);
7635 /* If the new and the old items are not both keymaps,
7636 the lookup will only find `item'. */
7637 item
= Fcons (item
, KEYMAPP (item
) && KEYMAPP (XCAR (old
)) ? old
: Qnil
);
7638 ASET (menu_bar_items_vector
, i
+ 2, item
);
7642 /* This is used as the handler when calling menu_item_eval_property. */
7644 menu_item_eval_property_1 (Lisp_Object arg
)
7646 /* If we got a quit from within the menu computation,
7647 quit all the way out of it. This takes care of C-] in the debugger. */
7648 if (CONSP (arg
) && EQ (XCAR (arg
), Qquit
))
7649 Fsignal (Qquit
, Qnil
);
7655 eval_dyn (Lisp_Object form
)
7657 return Feval (form
, Qnil
);
7660 /* Evaluate an expression and return the result (or nil if something
7661 went wrong). Used to evaluate dynamic parts of menu items. */
7663 menu_item_eval_property (Lisp_Object sexpr
)
7665 ptrdiff_t count
= SPECPDL_INDEX ();
7667 specbind (Qinhibit_redisplay
, Qt
);
7668 val
= internal_condition_case_1 (eval_dyn
, sexpr
, Qerror
,
7669 menu_item_eval_property_1
);
7670 return unbind_to (count
, val
);
7673 /* This function parses a menu item and leaves the result in the
7674 vector item_properties.
7675 ITEM is a key binding, a possible menu item.
7676 INMENUBAR is > 0 when this is considered for an entry in a menu bar
7678 INMENUBAR is < 0 when this is considered for an entry in a keyboard menu.
7679 parse_menu_item returns true if the item is a menu item and false
7683 parse_menu_item (Lisp_Object item
, int inmenubar
)
7685 Lisp_Object def
, tem
, item_string
, start
;
7687 Lisp_Object keyhint
;
7696 /* Create item_properties vector if necessary. */
7697 if (NILP (item_properties
))
7699 = Fmake_vector (make_number (ITEM_PROPERTY_ENABLE
+ 1), Qnil
);
7701 /* Initialize optional entries. */
7702 for (i
= ITEM_PROPERTY_DEF
; i
< ITEM_PROPERTY_ENABLE
; i
++)
7703 ASET (item_properties
, i
, Qnil
);
7704 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7706 /* Save the item here to protect it from GC. */
7707 ASET (item_properties
, ITEM_PROPERTY_ITEM
, item
);
7709 item_string
= XCAR (item
);
7713 if (STRINGP (item_string
))
7715 /* Old format menu item. */
7716 ASET (item_properties
, ITEM_PROPERTY_NAME
, item_string
);
7718 /* Maybe help string. */
7719 if (CONSP (item
) && STRINGP (XCAR (item
)))
7721 ASET (item_properties
, ITEM_PROPERTY_HELP
, XCAR (item
));
7726 /* Maybe an obsolete key binding cache. */
7727 if (CONSP (item
) && CONSP (XCAR (item
))
7728 && (NILP (XCAR (XCAR (item
)))
7729 || VECTORP (XCAR (XCAR (item
)))))
7732 /* This is the real definition--the function to run. */
7733 ASET (item_properties
, ITEM_PROPERTY_DEF
, item
);
7735 /* Get enable property, if any. */
7738 tem
= Fget (item
, Qmenu_enable
);
7739 if (!NILP (Venable_disabled_menus_and_buttons
))
7740 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7741 else if (!NILP (tem
))
7742 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, tem
);
7745 else if (EQ (item_string
, Qmenu_item
) && CONSP (item
))
7747 /* New format menu item. */
7748 ASET (item_properties
, ITEM_PROPERTY_NAME
, XCAR (item
));
7749 start
= XCDR (item
);
7752 /* We have a real binding. */
7753 ASET (item_properties
, ITEM_PROPERTY_DEF
, XCAR (start
));
7755 item
= XCDR (start
);
7756 /* Is there an obsolete cache list with key equivalences. */
7757 if (CONSP (item
) && CONSP (XCAR (item
)))
7760 /* Parse properties. */
7761 while (CONSP (item
) && CONSP (XCDR (item
)))
7766 if (EQ (tem
, QCenable
))
7768 if (!NILP (Venable_disabled_menus_and_buttons
))
7769 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7771 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, XCAR (item
));
7773 else if (EQ (tem
, QCvisible
))
7775 /* If got a visible property and that evaluates to nil
7776 then ignore this item. */
7777 tem
= menu_item_eval_property (XCAR (item
));
7781 else if (EQ (tem
, QChelp
))
7782 ASET (item_properties
, ITEM_PROPERTY_HELP
, XCAR (item
));
7783 else if (EQ (tem
, QCfilter
))
7785 else if (EQ (tem
, QCkey_sequence
))
7788 if (SYMBOLP (tem
) || STRINGP (tem
) || VECTORP (tem
))
7789 /* Be GC protected. Set keyhint to item instead of tem. */
7792 else if (EQ (tem
, QCkeys
))
7795 if (CONSP (tem
) || STRINGP (tem
))
7796 ASET (item_properties
, ITEM_PROPERTY_KEYEQ
, tem
);
7798 else if (EQ (tem
, QCbutton
) && CONSP (XCAR (item
)))
7803 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
7805 ASET (item_properties
, ITEM_PROPERTY_SELECTED
,
7807 ASET (item_properties
, ITEM_PROPERTY_TYPE
, type
);
7813 else if (inmenubar
|| !NILP (start
))
7817 return 0; /* not a menu item */
7819 /* If item string is not a string, evaluate it to get string.
7820 If we don't get a string, skip this item. */
7821 item_string
= AREF (item_properties
, ITEM_PROPERTY_NAME
);
7822 if (!(STRINGP (item_string
)))
7824 item_string
= menu_item_eval_property (item_string
);
7825 if (!STRINGP (item_string
))
7827 ASET (item_properties
, ITEM_PROPERTY_NAME
, item_string
);
7830 /* If got a filter apply it on definition. */
7831 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7834 def
= menu_item_eval_property (list2 (XCAR (filter
),
7835 list2 (Qquote
, def
)));
7837 ASET (item_properties
, ITEM_PROPERTY_DEF
, def
);
7840 /* Enable or disable selection of item. */
7841 tem
= AREF (item_properties
, ITEM_PROPERTY_ENABLE
);
7844 tem
= menu_item_eval_property (tem
);
7845 if (inmenubar
&& NILP (tem
))
7846 return 0; /* Ignore disabled items in menu bar. */
7847 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, tem
);
7850 /* If we got no definition, this item is just unselectable text which
7851 is OK in a submenu but not in the menubar. */
7853 return (!inmenubar
);
7855 /* See if this is a separate pane or a submenu. */
7856 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7857 tem
= get_keymap (def
, 0, 1);
7858 /* For a subkeymap, just record its details and exit. */
7861 ASET (item_properties
, ITEM_PROPERTY_MAP
, tem
);
7862 ASET (item_properties
, ITEM_PROPERTY_DEF
, tem
);
7866 /* At the top level in the menu bar, do likewise for commands also.
7867 The menu bar does not display equivalent key bindings anyway.
7868 ITEM_PROPERTY_DEF is already set up properly. */
7872 { /* This is a command. See if there is an equivalent key binding. */
7873 Lisp_Object keyeq
= AREF (item_properties
, ITEM_PROPERTY_KEYEQ
);
7874 AUTO_STRING (space_space
, " ");
7876 /* The previous code preferred :key-sequence to :keys, so we
7877 preserve this behavior. */
7878 if (STRINGP (keyeq
) && !CONSP (keyhint
))
7879 keyeq
= concat2 (space_space
, Fsubstitute_command_keys (keyeq
));
7882 Lisp_Object prefix
= keyeq
;
7883 Lisp_Object keys
= Qnil
;
7887 def
= XCAR (prefix
);
7888 prefix
= XCDR (prefix
);
7891 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7893 if (CONSP (keyhint
) && !NILP (XCAR (keyhint
)))
7895 keys
= XCAR (keyhint
);
7896 tem
= Fkey_binding (keys
, Qnil
, Qnil
, Qnil
);
7898 /* We have a suggested key. Is it bound to the command? */
7901 /* If the command is an alias for another
7902 (such as lmenu.el set it up), check if the
7903 original command matches the cached command. */
7905 && EQ (tem
, XSYMBOL (def
)->function
))))
7910 keys
= Fwhere_is_internal (def
, Qnil
, Qt
, Qnil
, Qnil
);
7914 tem
= Fkey_description (keys
, Qnil
);
7917 if (STRINGP (XCAR (prefix
)))
7918 tem
= concat2 (XCAR (prefix
), tem
);
7919 if (STRINGP (XCDR (prefix
)))
7920 tem
= concat2 (tem
, XCDR (prefix
));
7922 keyeq
= concat2 (space_space
, tem
);
7928 /* If we have an equivalent key binding, use that. */
7929 ASET (item_properties
, ITEM_PROPERTY_KEYEQ
, keyeq
);
7932 /* Include this when menu help is implemented.
7933 tem = XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP];
7934 if (!(NILP (tem) || STRINGP (tem)))
7936 tem = menu_item_eval_property (tem);
7939 XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP] = tem;
7943 /* Handle radio buttons or toggle boxes. */
7944 tem
= AREF (item_properties
, ITEM_PROPERTY_SELECTED
);
7946 ASET (item_properties
, ITEM_PROPERTY_SELECTED
,
7947 menu_item_eval_property (tem
));
7954 /***********************************************************************
7956 ***********************************************************************/
7958 /* A vector holding tool bar items while they are parsed in function
7959 tool_bar_items. Each item occupies TOOL_BAR_ITEM_NSCLOTS elements
7962 static Lisp_Object tool_bar_items_vector
;
7964 /* A vector holding the result of parse_tool_bar_item. Layout is like
7965 the one for a single item in tool_bar_items_vector. */
7967 static Lisp_Object tool_bar_item_properties
;
7969 /* Next free index in tool_bar_items_vector. */
7971 static int ntool_bar_items
;
7973 /* Function prototypes. */
7975 static void init_tool_bar_items (Lisp_Object
);
7976 static void process_tool_bar_item (Lisp_Object
, Lisp_Object
, Lisp_Object
,
7978 static bool parse_tool_bar_item (Lisp_Object
, Lisp_Object
);
7979 static void append_tool_bar_item (void);
7982 /* Return a vector of tool bar items for keymaps currently in effect.
7983 Reuse vector REUSE if non-nil. Return in *NITEMS the number of
7984 tool bar items found. */
7987 tool_bar_items (Lisp_Object reuse
, int *nitems
)
7990 Lisp_Object mapsbuf
[3];
7998 /* In order to build the menus, we need to call the keymap
7999 accessors. They all call QUIT. But this function is called
8000 during redisplay, during which a quit is fatal. So inhibit
8001 quitting while building the menus. We do this instead of
8002 specbind because (1) errors will clear it anyway and (2) this
8003 avoids risk of specpdl overflow. */
8004 oquit
= Vinhibit_quit
;
8007 /* Initialize tool_bar_items_vector and protect it from GC. */
8008 init_tool_bar_items (reuse
);
8010 /* Build list of keymaps in maps. Set nmaps to the number of maps
8013 /* Should overriding-terminal-local-map and overriding-local-map apply? */
8014 if (!NILP (Voverriding_local_map_menu_flag
)
8015 && !NILP (Voverriding_local_map
))
8017 /* Yes, use them (if non-nil) as well as the global map. */
8020 if (!NILP (KVAR (current_kboard
, Voverriding_terminal_local_map
)))
8021 maps
[nmaps
++] = KVAR (current_kboard
, Voverriding_terminal_local_map
);
8022 if (!NILP (Voverriding_local_map
))
8023 maps
[nmaps
++] = Voverriding_local_map
;
8027 /* No, so use major and minor mode keymaps and keymap property.
8028 Note that tool-bar bindings in the local-map and keymap
8029 properties may not work reliable, as they are only
8030 recognized when the tool-bar (or mode-line) is updated,
8031 which does not normally happen after every command. */
8034 nminor
= current_minor_maps (NULL
, &tmaps
);
8035 SAFE_NALLOCA (maps
, 1, nminor
+ 4);
8037 tem
= KVAR (current_kboard
, Voverriding_terminal_local_map
);
8038 if (!NILP (tem
) && !NILP (Voverriding_local_map_menu_flag
))
8039 maps
[nmaps
++] = tem
;
8040 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
8041 maps
[nmaps
++] = tem
;
8042 memcpy (maps
+ nmaps
, tmaps
, nminor
* sizeof (maps
[0]));
8044 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
8047 /* Add global keymap at the end. */
8048 maps
[nmaps
++] = current_global_map
;
8050 /* Process maps in reverse order and look up in each map the prefix
8052 for (i
= nmaps
- 1; i
>= 0; --i
)
8053 if (!NILP (maps
[i
]))
8057 keymap
= get_keymap (access_keymap (maps
[i
], Qtool_bar
, 1, 0, 1), 0, 1);
8059 map_keymap (keymap
, process_tool_bar_item
, Qnil
, NULL
, 1);
8062 Vinhibit_quit
= oquit
;
8063 *nitems
= ntool_bar_items
/ TOOL_BAR_ITEM_NSLOTS
;
8065 return tool_bar_items_vector
;
8069 /* Process the definition of KEY which is DEF. */
8072 process_tool_bar_item (Lisp_Object key
, Lisp_Object def
, Lisp_Object data
, void *args
)
8075 struct gcpro gcpro1
, gcpro2
;
8077 /* Protect KEY and DEF from GC because parse_tool_bar_item may call
8081 if (EQ (def
, Qundefined
))
8083 /* If a map has an explicit `undefined' as definition,
8084 discard any previously made item. */
8085 for (i
= 0; i
< ntool_bar_items
; i
+= TOOL_BAR_ITEM_NSLOTS
)
8087 Lisp_Object
*v
= XVECTOR (tool_bar_items_vector
)->contents
+ i
;
8089 if (EQ (key
, v
[TOOL_BAR_ITEM_KEY
]))
8091 if (ntool_bar_items
> i
+ TOOL_BAR_ITEM_NSLOTS
)
8092 memmove (v
, v
+ TOOL_BAR_ITEM_NSLOTS
,
8093 ((ntool_bar_items
- i
- TOOL_BAR_ITEM_NSLOTS
)
8095 ntool_bar_items
-= TOOL_BAR_ITEM_NSLOTS
;
8100 else if (parse_tool_bar_item (key
, def
))
8101 /* Append a new tool bar item to tool_bar_items_vector. Accept
8102 more than one definition for the same key. */
8103 append_tool_bar_item ();
8108 /* Access slot with index IDX of vector tool_bar_item_properties. */
8109 #define PROP(IDX) AREF (tool_bar_item_properties, (IDX))
8111 set_prop (ptrdiff_t idx
, Lisp_Object val
)
8113 ASET (tool_bar_item_properties
, idx
, val
);
8117 /* Parse a tool bar item specification ITEM for key KEY and return the
8118 result in tool_bar_item_properties. Value is false if ITEM is
8121 ITEM is a list `(menu-item CAPTION BINDING PROPS...)'.
8123 CAPTION is the caption of the item, If it's not a string, it is
8124 evaluated to get a string.
8126 BINDING is the tool bar item's binding. Tool-bar items with keymaps
8127 as binding are currently ignored.
8129 The following properties are recognized:
8133 FORM is evaluated and specifies whether the tool bar item is
8134 enabled or disabled.
8138 FORM is evaluated and specifies whether the tool bar item is visible.
8140 - `:filter FUNCTION'
8142 FUNCTION is invoked with one parameter `(quote BINDING)'. Its
8143 result is stored as the new binding.
8145 - `:button (TYPE SELECTED)'
8147 TYPE must be one of `:radio' or `:toggle'. SELECTED is evaluated
8148 and specifies whether the button is selected (pressed) or not.
8152 IMAGES is either a single image specification or a vector of four
8153 image specifications. See enum tool_bar_item_images.
8155 - `:help HELP-STRING'.
8157 Gives a help string to display for the tool bar item.
8159 - `:label LABEL-STRING'.
8161 A text label to show with the tool bar button if labels are enabled. */
8164 parse_tool_bar_item (Lisp_Object key
, Lisp_Object item
)
8166 Lisp_Object filter
= Qnil
;
8167 Lisp_Object caption
;
8169 bool have_label
= 0;
8171 /* Definition looks like `(menu-item CAPTION BINDING PROPS...)'.
8172 Rule out items that aren't lists, don't start with
8173 `menu-item' or whose rest following `tool-bar-item' is not a
8178 /* As an exception, allow old-style menu separators. */
8179 if (STRINGP (XCAR (item
)))
8180 item
= list1 (XCAR (item
));
8181 else if (!EQ (XCAR (item
), Qmenu_item
)
8182 || (item
= XCDR (item
), !CONSP (item
)))
8185 /* Create tool_bar_item_properties vector if necessary. Reset it to
8187 if (VECTORP (tool_bar_item_properties
))
8189 for (i
= 0; i
< TOOL_BAR_ITEM_NSLOTS
; ++i
)
8193 tool_bar_item_properties
8194 = Fmake_vector (make_number (TOOL_BAR_ITEM_NSLOTS
), Qnil
);
8197 set_prop (TOOL_BAR_ITEM_KEY
, key
);
8198 set_prop (TOOL_BAR_ITEM_ENABLED_P
, Qt
);
8200 /* Get the caption of the item. If the caption is not a string,
8201 evaluate it to get a string. If we don't get a string, skip this
8203 caption
= XCAR (item
);
8204 if (!STRINGP (caption
))
8206 caption
= menu_item_eval_property (caption
);
8207 if (!STRINGP (caption
))
8210 set_prop (TOOL_BAR_ITEM_CAPTION
, caption
);
8212 /* If the rest following the caption is not a list, the menu item is
8213 either a separator, or invalid. */
8217 if (menu_separator_name_p (SSDATA (caption
)))
8219 set_prop (TOOL_BAR_ITEM_TYPE
, Qt
);
8220 #if !defined (USE_GTK) && !defined (HAVE_NS)
8221 /* If we use build_desired_tool_bar_string to render the
8222 tool bar, the separator is rendered as an image. */
8223 set_prop (TOOL_BAR_ITEM_IMAGES
,
8224 (menu_item_eval_property
8225 (Vtool_bar_separator_image_expression
)));
8226 set_prop (TOOL_BAR_ITEM_ENABLED_P
, Qnil
);
8227 set_prop (TOOL_BAR_ITEM_SELECTED_P
, Qnil
);
8228 set_prop (TOOL_BAR_ITEM_CAPTION
, Qnil
);
8235 /* Store the binding. */
8236 set_prop (TOOL_BAR_ITEM_BINDING
, XCAR (item
));
8239 /* Ignore cached key binding, if any. */
8240 if (CONSP (item
) && CONSP (XCAR (item
)))
8243 /* Process the rest of the properties. */
8244 for (; CONSP (item
) && CONSP (XCDR (item
)); item
= XCDR (XCDR (item
)))
8246 Lisp_Object ikey
, value
;
8249 value
= XCAR (XCDR (item
));
8251 if (EQ (ikey
, QCenable
))
8253 /* `:enable FORM'. */
8254 if (!NILP (Venable_disabled_menus_and_buttons
))
8255 set_prop (TOOL_BAR_ITEM_ENABLED_P
, Qt
);
8257 set_prop (TOOL_BAR_ITEM_ENABLED_P
, value
);
8259 else if (EQ (ikey
, QCvisible
))
8261 /* `:visible FORM'. If got a visible property and that
8262 evaluates to nil then ignore this item. */
8263 if (NILP (menu_item_eval_property (value
)))
8266 else if (EQ (ikey
, QChelp
))
8267 /* `:help HELP-STRING'. */
8268 set_prop (TOOL_BAR_ITEM_HELP
, value
);
8269 else if (EQ (ikey
, QCvert_only
))
8270 /* `:vert-only t/nil'. */
8271 set_prop (TOOL_BAR_ITEM_VERT_ONLY
, value
);
8272 else if (EQ (ikey
, QClabel
))
8274 const char *bad_label
= "!!?GARBLED ITEM?!!";
8275 /* `:label LABEL-STRING'. */
8276 set_prop (TOOL_BAR_ITEM_LABEL
,
8277 STRINGP (value
) ? value
: build_string (bad_label
));
8280 else if (EQ (ikey
, QCfilter
))
8281 /* ':filter FORM'. */
8283 else if (EQ (ikey
, QCbutton
) && CONSP (value
))
8285 /* `:button (TYPE . SELECTED)'. */
8286 Lisp_Object type
, selected
;
8288 type
= XCAR (value
);
8289 selected
= XCDR (value
);
8290 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
8292 set_prop (TOOL_BAR_ITEM_SELECTED_P
, selected
);
8293 set_prop (TOOL_BAR_ITEM_TYPE
, type
);
8296 else if (EQ (ikey
, QCimage
)
8298 || (VECTORP (value
) && ASIZE (value
) == 4)))
8299 /* Value is either a single image specification or a vector
8300 of 4 such specifications for the different button states. */
8301 set_prop (TOOL_BAR_ITEM_IMAGES
, value
);
8302 else if (EQ (ikey
, QCrtl
))
8304 set_prop (TOOL_BAR_ITEM_RTL_IMAGE
, value
);
8310 /* Try to make one from caption and key. */
8311 Lisp_Object tkey
= PROP (TOOL_BAR_ITEM_KEY
);
8312 Lisp_Object tcapt
= PROP (TOOL_BAR_ITEM_CAPTION
);
8313 const char *label
= SYMBOLP (tkey
) ? SSDATA (SYMBOL_NAME (tkey
)) : "";
8314 const char *capt
= STRINGP (tcapt
) ? SSDATA (tcapt
) : "";
8316 2 * max (0, min (tool_bar_max_label_size
, STRING_BYTES_BOUND
/ 2));
8317 char *buf
= xmalloc (max_lbl
+ 1);
8318 Lisp_Object new_lbl
;
8319 ptrdiff_t caption_len
= strlen (capt
);
8321 if (caption_len
<= max_lbl
&& capt
[0] != '\0')
8324 while (caption_len
> 0 && buf
[caption_len
- 1] == '.')
8326 buf
[caption_len
] = '\0';
8330 if (strlen (label
) <= max_lbl
&& label
[0] != '\0')
8334 strcpy (buf
, label
);
8336 for (j
= 0; buf
[j
] != '\0'; ++j
)
8344 new_lbl
= Fupcase_initials (build_string (label
));
8345 if (SCHARS (new_lbl
) <= tool_bar_max_label_size
)
8346 set_prop (TOOL_BAR_ITEM_LABEL
, new_lbl
);
8348 set_prop (TOOL_BAR_ITEM_LABEL
, empty_unibyte_string
);
8352 /* If got a filter apply it on binding. */
8354 set_prop (TOOL_BAR_ITEM_BINDING
,
8355 (menu_item_eval_property
8358 PROP (TOOL_BAR_ITEM_BINDING
))))));
8360 /* See if the binding is a keymap. Give up if it is. */
8361 if (CONSP (get_keymap (PROP (TOOL_BAR_ITEM_BINDING
), 0, 1)))
8364 /* Enable or disable selection of item. */
8365 if (!EQ (PROP (TOOL_BAR_ITEM_ENABLED_P
), Qt
))
8366 set_prop (TOOL_BAR_ITEM_ENABLED_P
,
8367 menu_item_eval_property (PROP (TOOL_BAR_ITEM_ENABLED_P
)));
8369 /* Handle radio buttons or toggle boxes. */
8370 if (!NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
)))
8371 set_prop (TOOL_BAR_ITEM_SELECTED_P
,
8372 menu_item_eval_property (PROP (TOOL_BAR_ITEM_SELECTED_P
)));
8380 /* Initialize tool_bar_items_vector. REUSE, if non-nil, is a vector
8381 that can be reused. */
8384 init_tool_bar_items (Lisp_Object reuse
)
8386 if (VECTORP (reuse
))
8387 tool_bar_items_vector
= reuse
;
8389 tool_bar_items_vector
= Fmake_vector (make_number (64), Qnil
);
8390 ntool_bar_items
= 0;
8394 /* Append parsed tool bar item properties from
8395 tool_bar_item_properties */
8398 append_tool_bar_item (void)
8402 - (ASIZE (tool_bar_items_vector
) - TOOL_BAR_ITEM_NSLOTS
));
8404 /* Enlarge tool_bar_items_vector if necessary. */
8406 tool_bar_items_vector
= larger_vector (tool_bar_items_vector
, incr
, -1);
8408 /* Append entries from tool_bar_item_properties to the end of
8409 tool_bar_items_vector. */
8410 vcopy (tool_bar_items_vector
, ntool_bar_items
,
8411 XVECTOR (tool_bar_item_properties
)->contents
, TOOL_BAR_ITEM_NSLOTS
);
8412 ntool_bar_items
+= TOOL_BAR_ITEM_NSLOTS
;
8419 /* Read a character using menus based on the keymap MAP.
8420 Return nil if there are no menus in the maps.
8421 Return t if we displayed a menu but the user rejected it.
8423 PREV_EVENT is the previous input event, or nil if we are reading
8424 the first event of a key sequence.
8426 If USED_MOUSE_MENU is non-null, set *USED_MOUSE_MENU to true
8427 if we used a mouse menu to read the input, or false otherwise. If
8428 USED_MOUSE_MENU is null, don't dereference it.
8430 The prompting is done based on the prompt-string of the map
8431 and the strings associated with various map elements.
8433 This can be done with X menus or with menus put in the minibuf.
8434 These are done in different ways, depending on how the input will be read.
8435 Menus using X are done after auto-saving in read-char, getting the input
8436 event from Fx_popup_menu; menus using the minibuf use read_char recursively
8437 and do auto-saving in the inner call of read_char. */
8440 read_char_x_menu_prompt (Lisp_Object map
,
8441 Lisp_Object prev_event
, bool *used_mouse_menu
)
8443 if (used_mouse_menu
)
8444 *used_mouse_menu
= 0;
8446 /* Use local over global Menu maps. */
8448 if (! menu_prompting
)
8451 /* If we got to this point via a mouse click,
8452 use a real menu for mouse selection. */
8453 if (EVENT_HAS_PARAMETERS (prev_event
)
8454 && !EQ (XCAR (prev_event
), Qmenu_bar
)
8455 && !EQ (XCAR (prev_event
), Qtool_bar
))
8457 /* Display the menu and get the selection. */
8460 value
= Fx_popup_menu (prev_event
, get_keymap (map
, 0, 1));
8465 record_menu_key (XCAR (value
));
8467 /* If we got multiple events, unread all but
8469 There is no way to prevent those unread events
8470 from showing up later in last_nonmenu_event.
8471 So turn symbol and integer events into lists,
8472 to indicate that they came from a mouse menu,
8473 so that when present in last_nonmenu_event
8474 they won't confuse things. */
8475 for (tem
= XCDR (value
); CONSP (tem
); tem
= XCDR (tem
))
8477 record_menu_key (XCAR (tem
));
8478 if (SYMBOLP (XCAR (tem
))
8479 || INTEGERP (XCAR (tem
)))
8480 XSETCAR (tem
, Fcons (XCAR (tem
), Qdisabled
));
8483 /* If we got more than one event, put all but the first
8484 onto this list to be read later.
8485 Return just the first event now. */
8486 Vunread_command_events
8487 = nconc2 (XCDR (value
), Vunread_command_events
);
8488 value
= XCAR (value
);
8490 else if (NILP (value
))
8492 if (used_mouse_menu
)
8493 *used_mouse_menu
= 1;
8500 read_char_minibuf_menu_prompt (int commandflag
,
8505 /* FIXME: Use the minibuffer's frame width. */
8506 ptrdiff_t width
= FRAME_COLS (SELECTED_FRAME ()) - 4;
8508 bool nobindings
= 1;
8509 Lisp_Object rest
, vector
;
8510 Lisp_Object prompt_strings
= Qnil
;
8514 if (! menu_prompting
)
8517 map
= get_keymap (map
, 0, 1);
8518 name
= Fkeymap_prompt (map
);
8520 /* If we don't have any menus, just read a character normally. */
8521 if (!STRINGP (name
))
8524 #define PUSH_C_STR(str, listvar) \
8525 listvar = Fcons (build_unibyte_string (str), listvar)
8527 /* Prompt string always starts with map's prompt, and a space. */
8528 prompt_strings
= Fcons (name
, prompt_strings
);
8529 PUSH_C_STR (": ", prompt_strings
);
8530 nlength
= SCHARS (name
) + 2;
8534 /* Present the documented bindings, a line at a time. */
8538 Lisp_Object menu_strings
= prompt_strings
;
8539 ptrdiff_t i
= nlength
;
8541 Lisp_Object orig_defn_macro
;
8543 /* Loop over elements of map. */
8548 /* FIXME: Use map_keymap to handle new keymap formats. */
8550 /* At end of map, wrap around if just starting,
8551 or end this line if already have something on it. */
8554 if (notfirst
|| nobindings
)
8560 /* Look at the next element of the map. */
8562 elt
= AREF (vector
, idx
);
8564 elt
= Fcar_safe (rest
);
8566 if (idx
< 0 && VECTORP (elt
))
8568 /* If we found a dense table in the keymap,
8569 advanced past it, but start scanning its contents. */
8570 rest
= Fcdr_safe (rest
);
8576 /* An ordinary element. */
8577 Lisp_Object event
, tem
;
8581 event
= Fcar_safe (elt
); /* alist */
8582 elt
= Fcdr_safe (elt
);
8586 XSETINT (event
, idx
); /* vector */
8589 /* Ignore the element if it has no prompt string. */
8590 if (INTEGERP (event
) && parse_menu_item (elt
, -1))
8592 /* True if the char to type matches the string. */
8594 Lisp_Object upcased_event
, downcased_event
;
8595 Lisp_Object desc
= Qnil
;
8597 = AREF (item_properties
, ITEM_PROPERTY_NAME
);
8599 upcased_event
= Fupcase (event
);
8600 downcased_event
= Fdowncase (event
);
8601 char_matches
= (XINT (upcased_event
) == SREF (s
, 0)
8602 || XINT (downcased_event
) == SREF (s
, 0));
8604 desc
= Fsingle_key_description (event
, Qnil
);
8606 #if 0 /* It is redundant to list the equivalent key bindings because
8607 the prefix is what the user has already typed. */
8609 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_KEYEQ
];
8611 /* Insert equivalent keybinding. */
8612 s
= concat2 (s
, tem
);
8615 = AREF (item_properties
, ITEM_PROPERTY_TYPE
);
8616 if (EQ (tem
, QCradio
) || EQ (tem
, QCtoggle
))
8618 /* Insert button prefix. */
8619 Lisp_Object selected
8620 = AREF (item_properties
, ITEM_PROPERTY_SELECTED
);
8621 AUTO_STRING (radio_yes
, "(*) ");
8622 AUTO_STRING (radio_no
, "( ) ");
8623 AUTO_STRING (check_yes
, "[X] ");
8624 AUTO_STRING (check_no
, "[ ] ");
8625 if (EQ (tem
, QCradio
))
8626 tem
= NILP (selected
) ? radio_yes
: radio_no
;
8628 tem
= NILP (selected
) ? check_yes
: check_no
;
8629 s
= concat2 (tem
, s
);
8633 /* If we have room for the prompt string, add it to this line.
8634 If this is the first on the line, always add it. */
8635 if ((SCHARS (s
) + i
+ 2
8636 + (char_matches
? 0 : SCHARS (desc
) + 3))
8640 ptrdiff_t thiswidth
;
8642 /* Punctuate between strings. */
8645 PUSH_C_STR (", ", menu_strings
);
8651 /* If the char to type doesn't match the string's
8652 first char, explicitly show what char to type. */
8655 /* Add as much of string as fits. */
8656 thiswidth
= min (SCHARS (desc
), width
- i
);
8658 = Fcons (Fsubstring (desc
, make_number (0),
8659 make_number (thiswidth
)),
8662 PUSH_C_STR (" = ", menu_strings
);
8666 /* Add as much of string as fits. */
8667 thiswidth
= min (SCHARS (s
), width
- i
);
8669 = Fcons (Fsubstring (s
, make_number (0),
8670 make_number (thiswidth
)),
8676 /* If this element does not fit, end the line now,
8677 and save the element for the next line. */
8678 PUSH_C_STR ("...", menu_strings
);
8683 /* Move past this element. */
8684 if (idx
>= 0 && idx
+ 1 >= ASIZE (vector
))
8685 /* Handle reaching end of dense table. */
8690 rest
= Fcdr_safe (rest
);
8694 /* Prompt with that and read response. */
8695 message3_nolog (apply1 (intern ("concat"), Fnreverse (menu_strings
)));
8697 /* Make believe it's not a keyboard macro in case the help char
8698 is pressed. Help characters are not recorded because menu prompting
8699 is not used on replay. */
8700 orig_defn_macro
= KVAR (current_kboard
, defining_kbd_macro
);
8701 kset_defining_kbd_macro (current_kboard
, Qnil
);
8703 obj
= read_char (commandflag
, Qnil
, Qt
, 0, NULL
);
8704 while (BUFFERP (obj
));
8705 kset_defining_kbd_macro (current_kboard
, orig_defn_macro
);
8707 if (!INTEGERP (obj
) || XINT (obj
) == -2)
8710 if (! EQ (obj
, menu_prompt_more_char
)
8711 && (!INTEGERP (menu_prompt_more_char
)
8712 || ! EQ (obj
, make_number (Ctl (XINT (menu_prompt_more_char
))))))
8714 if (!NILP (KVAR (current_kboard
, defining_kbd_macro
)))
8715 store_kbd_macro_char (obj
);
8718 /* Help char - go round again. */
8722 /* Reading key sequences. */
8725 follow_key (Lisp_Object keymap
, Lisp_Object key
)
8727 return access_keymap (get_keymap (keymap
, 0, 1),
8732 active_maps (Lisp_Object first_event
)
8734 Lisp_Object position
8735 = CONSP (first_event
) ? CAR_SAFE (XCDR (first_event
)) : Qnil
;
8736 return Fcons (Qkeymap
, Fcurrent_active_maps (Qt
, position
));
8739 /* Structure used to keep track of partial application of key remapping
8740 such as Vfunction_key_map and Vkey_translation_map. */
8741 typedef struct keyremap
8743 /* This is the map originally specified for this use. */
8745 /* This is a submap reached by looking up, in PARENT,
8746 the events from START to END. */
8748 /* Positions [START, END) in the key sequence buffer
8749 are the key that we have scanned so far.
8750 Those events are the ones that we will replace
8751 if PARENT maps them into a key sequence. */
8755 /* Lookup KEY in MAP.
8756 MAP is a keymap mapping keys to key vectors or functions.
8757 If the mapping is a function and DO_FUNCALL is true,
8758 the function is called with PROMPT as parameter and its return
8759 value is used as the return value of this function (after checking
8760 that it is indeed a vector). */
8763 access_keymap_keyremap (Lisp_Object map
, Lisp_Object key
, Lisp_Object prompt
,
8768 next
= access_keymap (map
, key
, 1, 0, 1);
8770 /* Handle a symbol whose function definition is a keymap
8772 if (SYMBOLP (next
) && !NILP (Ffboundp (next
))
8773 && (ARRAYP (XSYMBOL (next
)->function
)
8774 || KEYMAPP (XSYMBOL (next
)->function
)))
8775 next
= Fautoload_do_load (XSYMBOL (next
)->function
, next
, Qnil
);
8777 /* If the keymap gives a function, not an
8778 array, then call the function with one arg and use
8779 its value instead. */
8780 if (do_funcall
&& FUNCTIONP (next
))
8785 next
= call1 (next
, prompt
);
8786 /* If the function returned something invalid,
8787 barf--don't ignore it.
8788 (To ignore it safely, we would need to gcpro a bunch of
8789 other variables.) */
8790 if (! (NILP (next
) || VECTORP (next
) || STRINGP (next
)))
8791 error ("Function %s returns invalid key sequence",
8792 SSDATA (SYMBOL_NAME (tem
)));
8797 /* Do one step of the key remapping used for function-key-map and
8798 key-translation-map:
8799 KEYBUF is the buffer holding the input events.
8800 BUFSIZE is its maximum size.
8801 FKEY is a pointer to the keyremap structure to use.
8802 INPUT is the index of the last element in KEYBUF.
8803 DOIT if true says that the remapping can actually take place.
8804 DIFF is used to return the number of keys added/removed by the remapping.
8805 PARENT is the root of the keymap.
8806 PROMPT is the prompt to use if the remapping happens through a function.
8807 Return true if the remapping actually took place. */
8810 keyremap_step (Lisp_Object
*keybuf
, int bufsize
, volatile keyremap
*fkey
,
8811 int input
, bool doit
, int *diff
, Lisp_Object prompt
)
8813 Lisp_Object next
, key
;
8815 key
= keybuf
[fkey
->end
++];
8817 if (KEYMAPP (fkey
->parent
))
8818 next
= access_keymap_keyremap (fkey
->map
, key
, prompt
, doit
);
8822 /* If keybuf[fkey->start..fkey->end] is bound in the
8823 map and we're in a position to do the key remapping, replace it with
8824 the binding and restart with fkey->start at the end. */
8825 if ((VECTORP (next
) || STRINGP (next
)) && doit
)
8827 int len
= XFASTINT (Flength (next
));
8830 *diff
= len
- (fkey
->end
- fkey
->start
);
8832 if (bufsize
- input
<= *diff
)
8833 error ("Key sequence too long");
8835 /* Shift the keys that follow fkey->end. */
8837 for (i
= fkey
->end
; i
< input
; i
++)
8838 keybuf
[i
+ *diff
] = keybuf
[i
];
8840 for (i
= input
- 1; i
>= fkey
->end
; i
--)
8841 keybuf
[i
+ *diff
] = keybuf
[i
];
8842 /* Overwrite the old keys with the new ones. */
8843 for (i
= 0; i
< len
; i
++)
8844 keybuf
[fkey
->start
+ i
]
8845 = Faref (next
, make_number (i
));
8847 fkey
->start
= fkey
->end
+= *diff
;
8848 fkey
->map
= fkey
->parent
;
8853 fkey
->map
= get_keymap (next
, 0, 1);
8855 /* If we no longer have a bound suffix, try a new position for
8857 if (!CONSP (fkey
->map
))
8859 fkey
->end
= ++fkey
->start
;
8860 fkey
->map
= fkey
->parent
;
8866 test_undefined (Lisp_Object binding
)
8868 return (NILP (binding
)
8869 || EQ (binding
, Qundefined
)
8870 || (SYMBOLP (binding
)
8871 && EQ (Fcommand_remapping (binding
, Qnil
, Qnil
), Qundefined
)));
8874 /* Read a sequence of keys that ends with a non prefix character,
8875 storing it in KEYBUF, a buffer of size BUFSIZE.
8877 Return the length of the key sequence stored.
8878 Return -1 if the user rejected a command menu.
8880 Echo starting immediately unless `prompt' is 0.
8882 If PREVENT_REDISPLAY is non-zero, avoid redisplay by calling
8883 read_char with a suitable COMMANDFLAG argument.
8885 Where a key sequence ends depends on the currently active keymaps.
8886 These include any minor mode keymaps active in the current buffer,
8887 the current buffer's local map, and the global map.
8889 If a key sequence has no other bindings, we check Vfunction_key_map
8890 to see if some trailing subsequence might be the beginning of a
8891 function key's sequence. If so, we try to read the whole function
8892 key, and substitute its symbolic name into the key sequence.
8894 We ignore unbound `down-' mouse clicks. We turn unbound `drag-' and
8895 `double-' events into similar click events, if that would make them
8896 bound. We try to turn `triple-' events first into `double-' events,
8899 If we get a mouse click in a mode line, vertical divider, or other
8900 non-text area, we treat the click as if it were prefixed by the
8901 symbol denoting that area - `mode-line', `vertical-line', or
8904 If the sequence starts with a mouse click, we read the key sequence
8905 with respect to the buffer clicked on, not the current buffer.
8907 If the user switches frames in the midst of a key sequence, we put
8908 off the switch-frame event until later; the next call to
8909 read_char will return it.
8911 If FIX_CURRENT_BUFFER, we restore current_buffer
8912 from the selected window's buffer. */
8915 read_key_sequence (Lisp_Object
*keybuf
, int bufsize
, Lisp_Object prompt
,
8916 bool dont_downcase_last
, bool can_return_switch_frame
,
8917 bool fix_current_buffer
, bool prevent_redisplay
)
8919 ptrdiff_t count
= SPECPDL_INDEX ();
8921 /* How many keys there are in the current key sequence. */
8924 /* The length of the echo buffer when we started reading, and
8925 the length of this_command_keys when we started reading. */
8926 ptrdiff_t echo_start
IF_LINT (= 0);
8927 ptrdiff_t keys_start
;
8929 Lisp_Object current_binding
= Qnil
;
8930 Lisp_Object first_event
= Qnil
;
8932 /* Index of the first key that has no binding.
8933 It is useless to try fkey.start larger than that. */
8936 /* If t < mock_input, then KEYBUF[t] should be read as the next
8939 We use this to recover after recognizing a function key. Once we
8940 realize that a suffix of the current key sequence is actually a
8941 function key's escape sequence, we replace the suffix with the
8942 function key's binding from Vfunction_key_map. Now keybuf
8943 contains a new and different key sequence, so the echo area,
8944 this_command_keys, and the submaps and defs arrays are wrong. In
8945 this situation, we set mock_input to t, set t to 0, and jump to
8946 restart_sequence; the loop will read keys from keybuf up until
8947 mock_input, thus rebuilding the state; and then it will resume
8948 reading characters from the keyboard. */
8951 /* If the sequence is unbound in submaps[], then
8952 keybuf[fkey.start..fkey.end-1] is a prefix in Vfunction_key_map,
8953 and fkey.map is its binding.
8955 These might be > t, indicating that all function key scanning
8956 should hold off until t reaches them. We do this when we've just
8957 recognized a function key, to avoid searching for the function
8958 key's again in Vfunction_key_map. */
8961 /* Likewise, for key_translation_map and input-decode-map. */
8962 keyremap keytran
, indec
;
8964 /* True if we are trying to map a key by changing an upper-case
8965 letter to lower case, or a shifted function key to an unshifted
8967 bool shift_translated
= 0;
8969 /* If we receive a `switch-frame' or `select-window' event in the middle of
8970 a key sequence, we put it off for later.
8971 While we're reading, we keep the event here. */
8972 Lisp_Object delayed_switch_frame
;
8974 Lisp_Object original_uppercase
IF_LINT (= Qnil
);
8975 int original_uppercase_position
= -1;
8977 /* Gets around Microsoft compiler limitations. */
8980 struct buffer
*starting_buffer
;
8982 /* List of events for which a fake prefix key has been generated. */
8983 Lisp_Object fake_prefixed_keys
= Qnil
;
8985 struct gcpro gcpro1
;
8987 GCPRO1 (fake_prefixed_keys
);
8988 raw_keybuf_count
= 0;
8990 last_nonmenu_event
= Qnil
;
8992 delayed_switch_frame
= Qnil
;
8998 /* Install the string PROMPT as the beginning of the string
8999 of echoing, so that it serves as a prompt for the next
9001 kset_echo_string (current_kboard
, prompt
);
9002 current_kboard
->echo_after_prompt
= SCHARS (prompt
);
9005 else if (cursor_in_echo_area
9006 && echo_keystrokes_p ())
9007 /* This doesn't put in a dash if the echo buffer is empty, so
9008 you don't always see a dash hanging out in the minibuffer. */
9012 /* Record the initial state of the echo area and this_command_keys;
9013 we will need to restore them if we replay a key sequence. */
9015 echo_start
= echo_length ();
9016 keys_start
= this_command_key_count
;
9017 this_single_command_key_start
= keys_start
;
9019 /* We jump here when we need to reinitialize fkey and keytran; this
9020 happens if we switch keyboards between rescans. */
9021 replay_entire_sequence
:
9023 indec
.map
= indec
.parent
= KVAR (current_kboard
, Vinput_decode_map
);
9024 fkey
.map
= fkey
.parent
= KVAR (current_kboard
, Vlocal_function_key_map
);
9025 keytran
.map
= keytran
.parent
= Vkey_translation_map
;
9026 indec
.start
= indec
.end
= 0;
9027 fkey
.start
= fkey
.end
= 0;
9028 keytran
.start
= keytran
.end
= 0;
9030 /* We jump here when the key sequence has been thoroughly changed, and
9031 we need to rescan it starting from the beginning. When we jump here,
9032 keybuf[0..mock_input] holds the sequence we should reread. */
9035 starting_buffer
= current_buffer
;
9036 first_unbound
= bufsize
+ 1;
9038 /* Build our list of keymaps.
9039 If we recognize a function key and replace its escape sequence in
9040 keybuf with its symbol, or if the sequence starts with a mouse
9041 click and we need to switch buffers, we jump back here to rebuild
9042 the initial keymaps from the current buffer. */
9043 current_binding
= active_maps (first_event
);
9045 /* Start from the beginning in keybuf. */
9048 /* These are no-ops the first time through, but if we restart, they
9049 revert the echo area and this_command_keys to their original state. */
9050 this_command_key_count
= keys_start
;
9051 if (INTERACTIVE
&& t
< mock_input
)
9052 echo_truncate (echo_start
);
9054 /* If the best binding for the current key sequence is a keymap, or
9055 we may be looking at a function key's escape sequence, keep on
9057 while (!NILP (current_binding
)
9058 /* Keep reading as long as there's a prefix binding. */
9059 ? KEYMAPP (current_binding
)
9060 /* Don't return in the middle of a possible function key sequence,
9061 if the only bindings we found were via case conversion.
9062 Thus, if ESC O a has a function-key-map translation
9063 and ESC o has a binding, don't return after ESC O,
9064 so that we can translate ESC O plus the next character. */
9065 : (/* indec.start < t || fkey.start < t || */ keytran
.start
< t
))
9068 bool used_mouse_menu
= 0;
9070 /* Where the last real key started. If we need to throw away a
9071 key that has expanded into more than one element of keybuf
9072 (say, a mouse click on the mode line which is being treated
9073 as [mode-line (mouse-...)], then we backtrack to this point
9075 int last_real_key_start
;
9077 /* These variables are analogous to echo_start and keys_start;
9078 while those allow us to restart the entire key sequence,
9079 echo_local_start and keys_local_start allow us to throw away
9081 ptrdiff_t echo_local_start
IF_LINT (= 0);
9082 int keys_local_start
;
9083 Lisp_Object new_binding
;
9085 eassert (indec
.end
== t
|| (indec
.end
> t
&& indec
.end
<= mock_input
));
9086 eassert (indec
.start
<= indec
.end
);
9087 eassert (fkey
.start
<= fkey
.end
);
9088 eassert (keytran
.start
<= keytran
.end
);
9089 /* key-translation-map is applied *after* function-key-map
9090 which is itself applied *after* input-decode-map. */
9091 eassert (fkey
.end
<= indec
.start
);
9092 eassert (keytran
.end
<= fkey
.start
);
9094 if (/* first_unbound < indec.start && first_unbound < fkey.start && */
9095 first_unbound
< keytran
.start
)
9096 { /* The prefix upto first_unbound has no binding and has
9097 no translation left to do either, so we know it's unbound.
9098 If we don't stop now, we risk staying here indefinitely
9099 (if the user keeps entering fkey or keytran prefixes
9100 like C-c ESC ESC ESC ESC ...) */
9102 for (i
= first_unbound
+ 1; i
< t
; i
++)
9103 keybuf
[i
- first_unbound
- 1] = keybuf
[i
];
9104 mock_input
= t
- first_unbound
- 1;
9105 indec
.end
= indec
.start
-= first_unbound
+ 1;
9106 indec
.map
= indec
.parent
;
9107 fkey
.end
= fkey
.start
-= first_unbound
+ 1;
9108 fkey
.map
= fkey
.parent
;
9109 keytran
.end
= keytran
.start
-= first_unbound
+ 1;
9110 keytran
.map
= keytran
.parent
;
9111 goto replay_sequence
;
9115 error ("Key sequence too long");
9118 echo_local_start
= echo_length ();
9119 keys_local_start
= this_command_key_count
;
9122 /* These are no-ops, unless we throw away a keystroke below and
9123 jumped back up to replay_key; in that case, these restore the
9124 variables to their original state, allowing us to replay the
9126 if (INTERACTIVE
&& t
< mock_input
)
9127 echo_truncate (echo_local_start
);
9128 this_command_key_count
= keys_local_start
;
9130 /* By default, assume each event is "real". */
9131 last_real_key_start
= t
;
9133 /* Does mock_input indicate that we are re-reading a key sequence? */
9137 add_command_key (key
);
9138 if (echo_keystrokes_p ()
9139 && current_kboard
->immediate_echo
)
9146 /* If not, we should actually read a character. */
9150 KBOARD
*interrupted_kboard
= current_kboard
;
9151 struct frame
*interrupted_frame
= SELECTED_FRAME ();
9152 /* Calling read_char with COMMANDFLAG = -2 avoids
9153 redisplay in read_char and its subroutines. */
9154 key
= read_char (prevent_redisplay
? -2 : NILP (prompt
),
9155 current_binding
, last_nonmenu_event
,
9156 &used_mouse_menu
, NULL
);
9157 if ((INTEGERP (key
) && XINT (key
) == -2) /* wrong_kboard_jmpbuf */
9158 /* When switching to a new tty (with a new keyboard),
9159 read_char returns the new buffer, rather than -2
9160 (Bug#5095). This is because `terminal-init-xterm'
9161 calls read-char, which eats the wrong_kboard_jmpbuf
9162 return. Any better way to fix this? -- cyd */
9163 || (interrupted_kboard
!= current_kboard
))
9168 for (k
= all_kboards
; k
; k
= k
->next_kboard
)
9169 if (k
== interrupted_kboard
)
9174 /* Don't touch interrupted_kboard when it's been
9176 delayed_switch_frame
= Qnil
;
9177 goto replay_entire_sequence
;
9180 if (!NILP (delayed_switch_frame
))
9183 (interrupted_kboard
,
9184 Fcons (delayed_switch_frame
,
9185 KVAR (interrupted_kboard
, kbd_queue
)));
9186 delayed_switch_frame
= Qnil
;
9191 (interrupted_kboard
,
9192 Fcons (keybuf
[--t
], KVAR (interrupted_kboard
, kbd_queue
)));
9194 /* If the side queue is non-empty, ensure it begins with a
9195 switch-frame, so we'll replay it in the right context. */
9196 if (CONSP (KVAR (interrupted_kboard
, kbd_queue
))
9197 && (key
= XCAR (KVAR (interrupted_kboard
, kbd_queue
)),
9198 !(EVENT_HAS_PARAMETERS (key
)
9199 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)),
9203 XSETFRAME (frame
, interrupted_frame
);
9205 (interrupted_kboard
,
9206 Fcons (make_lispy_switch_frame (frame
),
9207 KVAR (interrupted_kboard
, kbd_queue
)));
9210 goto replay_entire_sequence
;
9214 /* read_char returns t when it shows a menu and the user rejects it.
9218 unbind_to (count
, Qnil
);
9223 /* read_char returns -1 at the end of a macro.
9224 Emacs 18 handles this by returning immediately with a
9225 zero, so that's what we'll do. */
9226 if (INTEGERP (key
) && XINT (key
) == -1)
9229 /* The Microsoft C compiler can't handle the goto that
9235 /* If the current buffer has been changed from under us, the
9236 keymap may have changed, so replay the sequence. */
9239 timer_resume_idle ();
9242 /* Reset the current buffer from the selected window
9243 in case something changed the former and not the latter.
9244 This is to be more consistent with the behavior
9245 of the command_loop_1. */
9246 if (fix_current_buffer
)
9248 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
9250 if (XBUFFER (XWINDOW (selected_window
)->contents
)
9252 Fset_buffer (XWINDOW (selected_window
)->contents
);
9255 goto replay_sequence
;
9258 /* If we have a quit that was typed in another frame, and
9259 quit_throw_to_read_char switched buffers,
9260 replay to get the right keymap. */
9262 && XINT (key
) == quit_char
9263 && current_buffer
!= starting_buffer
)
9266 ASET (raw_keybuf
, raw_keybuf_count
, key
);
9271 goto replay_sequence
;
9276 if (EVENT_HAS_PARAMETERS (key
)
9277 /* Either a `switch-frame' or a `select-window' event. */
9278 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)), Qswitch_frame
))
9280 /* If we're at the beginning of a key sequence, and the caller
9281 says it's okay, go ahead and return this event. If we're
9282 in the midst of a key sequence, delay it until the end. */
9283 if (t
> 0 || !can_return_switch_frame
)
9285 delayed_switch_frame
= key
;
9290 if (NILP (first_event
))
9293 /* Even if first_event does not specify a particular
9294 window/position, it's important to recompute the maps here
9295 since a long time might have passed since we entered
9296 read_key_sequence, and a timer (or process-filter or
9297 special-event-map, ...) might have switched the current buffer
9298 or the selected window from under us in the mean time. */
9299 if (fix_current_buffer
9300 && (XBUFFER (XWINDOW (selected_window
)->contents
)
9302 Fset_buffer (XWINDOW (selected_window
)->contents
);
9303 current_binding
= active_maps (first_event
);
9307 ASET (raw_keybuf
, raw_keybuf_count
, key
);
9311 /* Clicks in non-text areas get prefixed by the symbol
9312 in their CHAR-ADDRESS field. For example, a click on
9313 the mode line is prefixed by the symbol `mode-line'.
9315 Furthermore, key sequences beginning with mouse clicks
9316 are read using the keymaps of the buffer clicked on, not
9317 the current buffer. So we may have to switch the buffer
9320 When we turn one event into two events, we must make sure
9321 that neither of the two looks like the original--so that,
9322 if we replay the events, they won't be expanded again.
9323 If not for this, such reexpansion could happen either here
9324 or when user programs play with this-command-keys. */
9325 if (EVENT_HAS_PARAMETERS (key
))
9327 Lisp_Object kind
= EVENT_HEAD_KIND (EVENT_HEAD (key
));
9328 if (EQ (kind
, Qmouse_click
))
9330 Lisp_Object window
= POSN_WINDOW (EVENT_START (key
));
9331 Lisp_Object posn
= POSN_POSN (EVENT_START (key
));
9334 || (!NILP (fake_prefixed_keys
)
9335 && !NILP (Fmemq (key
, fake_prefixed_keys
))))
9337 /* We're looking a second time at an event for which
9338 we generated a fake prefix key. Set
9339 last_real_key_start appropriately. */
9341 last_real_key_start
= t
- 1;
9344 if (last_real_key_start
== 0)
9346 /* Key sequences beginning with mouse clicks are
9347 read using the keymaps in the buffer clicked on,
9348 not the current buffer. If we're at the
9349 beginning of a key sequence, switch buffers. */
9350 if (WINDOWP (window
)
9351 && BUFFERP (XWINDOW (window
)->contents
)
9352 && XBUFFER (XWINDOW (window
)->contents
) != current_buffer
)
9354 ASET (raw_keybuf
, raw_keybuf_count
, key
);
9359 /* Arrange to go back to the original buffer once we're
9360 done reading the key sequence. Note that we can't
9361 use save_excursion_{save,restore} here, because they
9362 save point as well as the current buffer; we don't
9363 want to save point, because redisplay may change it,
9364 to accommodate a Fset_window_start or something. We
9365 don't want to do this at the top of the function,
9366 because we may get input from a subprocess which
9367 wants to change the selected window and stuff (say,
9369 record_unwind_current_buffer ();
9371 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
9373 set_buffer_internal (XBUFFER (XWINDOW (window
)->contents
));
9374 goto replay_sequence
;
9378 /* Expand mode-line and scroll-bar events into two events:
9379 use posn as a fake prefix key. */
9381 && (NILP (fake_prefixed_keys
)
9382 || NILP (Fmemq (key
, fake_prefixed_keys
))))
9384 if (bufsize
- t
<= 1)
9385 error ("Key sequence too long");
9388 keybuf
[t
+ 1] = key
;
9391 /* Record that a fake prefix key has been generated
9392 for KEY. Don't modify the event; this would
9393 prevent proper action when the event is pushed
9394 back into unread-command-events. */
9395 fake_prefixed_keys
= Fcons (key
, fake_prefixed_keys
);
9399 else if (CONSP (XCDR (key
))
9400 && CONSP (EVENT_START (key
))
9401 && CONSP (XCDR (EVENT_START (key
))))
9405 posn
= POSN_POSN (EVENT_START (key
));
9406 /* Handle menu-bar events:
9407 insert the dummy prefix event `menu-bar'. */
9408 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
9410 if (bufsize
- t
<= 1)
9411 error ("Key sequence too long");
9413 keybuf
[t
+ 1] = key
;
9415 /* Zap the position in key, so we know that we've
9416 expanded it, and don't try to do so again. */
9417 POSN_SET_POSN (EVENT_START (key
), list1 (posn
));
9420 goto replay_sequence
;
9422 else if (CONSP (posn
))
9424 /* We're looking at the second event of a
9425 sequence which we expanded before. Set
9426 last_real_key_start appropriately. */
9427 if (last_real_key_start
== t
&& t
> 0)
9428 last_real_key_start
= t
- 1;
9433 /* We have finally decided that KEY is something we might want
9435 new_binding
= follow_key (current_binding
, key
);
9437 /* If KEY wasn't bound, we'll try some fallbacks. */
9438 if (!NILP (new_binding
))
9439 /* This is needed for the following scenario:
9440 event 0: a down-event that gets dropped by calling replay_key.
9441 event 1: some normal prefix like C-h.
9442 After event 0, first_unbound is 0, after event 1 indec.start,
9443 fkey.start, and keytran.start are all 1, so when we see that
9444 C-h is bound, we need to update first_unbound. */
9445 first_unbound
= max (t
+ 1, first_unbound
);
9450 /* Remember the position to put an upper bound on indec.start. */
9451 first_unbound
= min (t
, first_unbound
);
9453 head
= EVENT_HEAD (key
);
9457 Lisp_Object breakdown
;
9460 breakdown
= parse_modifiers (head
);
9461 modifiers
= XINT (XCAR (XCDR (breakdown
)));
9462 /* Attempt to reduce an unbound mouse event to a simpler
9463 event that is bound:
9464 Drags reduce to clicks.
9465 Double-clicks reduce to clicks.
9466 Triple-clicks reduce to double-clicks, then to clicks.
9467 Down-clicks are eliminated.
9468 Double-downs reduce to downs, then are eliminated.
9469 Triple-downs reduce to double-downs, then to downs,
9470 then are eliminated. */
9471 if (modifiers
& (down_modifier
| drag_modifier
9472 | double_modifier
| triple_modifier
))
9474 while (modifiers
& (down_modifier
| drag_modifier
9475 | double_modifier
| triple_modifier
))
9477 Lisp_Object new_head
, new_click
;
9478 if (modifiers
& triple_modifier
)
9479 modifiers
^= (double_modifier
| triple_modifier
);
9480 else if (modifiers
& double_modifier
)
9481 modifiers
&= ~double_modifier
;
9482 else if (modifiers
& drag_modifier
)
9483 modifiers
&= ~drag_modifier
;
9486 /* Dispose of this `down' event by simply jumping
9487 back to replay_key, to get another event.
9489 Note that if this event came from mock input,
9490 then just jumping back to replay_key will just
9491 hand it to us again. So we have to wipe out any
9494 We could delete keybuf[t] and shift everything
9495 after that to the left by one spot, but we'd also
9496 have to fix up any variable that points into
9497 keybuf, and shifting isn't really necessary
9500 Adding prefixes for non-textual mouse clicks
9501 creates two characters of mock input, and both
9502 must be thrown away. If we're only looking at
9503 the prefix now, we can just jump back to
9504 replay_key. On the other hand, if we've already
9505 processed the prefix, and now the actual click
9506 itself is giving us trouble, then we've lost the
9507 state of the keymaps we want to backtrack to, and
9508 we need to replay the whole sequence to rebuild
9511 Beyond that, only function key expansion could
9512 create more than two keys, but that should never
9513 generate mouse events, so it's okay to zero
9514 mock_input in that case too.
9516 FIXME: The above paragraph seems just plain
9517 wrong, if you consider things like
9518 xterm-mouse-mode. -stef
9520 Isn't this just the most wonderful code ever? */
9522 /* If mock_input > t + 1, the above simplification
9523 will actually end up dropping keys on the floor.
9524 This is probably OK for now, but even
9525 if mock_input <= t + 1, we need to adjust indec,
9527 Typical case [header-line down-mouse-N]:
9528 mock_input = 2, t = 1, fkey.end = 1,
9529 last_real_key_start = 0. */
9530 if (indec
.end
> last_real_key_start
)
9532 indec
.end
= indec
.start
9533 = min (last_real_key_start
, indec
.start
);
9534 indec
.map
= indec
.parent
;
9535 if (fkey
.end
> last_real_key_start
)
9537 fkey
.end
= fkey
.start
9538 = min (last_real_key_start
, fkey
.start
);
9539 fkey
.map
= fkey
.parent
;
9540 if (keytran
.end
> last_real_key_start
)
9542 keytran
.end
= keytran
.start
9543 = min (last_real_key_start
, keytran
.start
);
9544 keytran
.map
= keytran
.parent
;
9548 if (t
== last_real_key_start
)
9555 mock_input
= last_real_key_start
;
9556 goto replay_sequence
;
9561 = apply_modifiers (modifiers
, XCAR (breakdown
));
9562 new_click
= list2 (new_head
, EVENT_START (key
));
9564 /* Look for a binding for this new key. */
9565 new_binding
= follow_key (current_binding
, new_click
);
9567 /* If that click is bound, go for it. */
9568 if (!NILP (new_binding
))
9570 current_binding
= new_binding
;
9574 /* Otherwise, we'll leave key set to the drag event. */
9579 current_binding
= new_binding
;
9582 /* Normally, last_nonmenu_event gets the previous key we read.
9583 But when a mouse popup menu is being used,
9584 we don't update last_nonmenu_event; it continues to hold the mouse
9585 event that preceded the first level of menu. */
9586 if (!used_mouse_menu
)
9587 last_nonmenu_event
= key
;
9589 /* Record what part of this_command_keys is the current key sequence. */
9590 this_single_command_key_start
= this_command_key_count
- t
;
9592 /* Look for this sequence in input-decode-map.
9593 Scan from indec.end until we find a bound suffix. */
9594 while (indec
.end
< t
)
9596 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9600 GCPRO4 (indec
.map
, fkey
.map
, keytran
.map
, delayed_switch_frame
);
9601 done
= keyremap_step (keybuf
, bufsize
, &indec
, max (t
, mock_input
),
9606 mock_input
= diff
+ max (t
, mock_input
);
9607 goto replay_sequence
;
9611 if (!KEYMAPP (current_binding
)
9612 && !test_undefined (current_binding
)
9613 && indec
.start
>= t
)
9614 /* There is a binding and it's not a prefix.
9615 (and it doesn't have any input-decode-map translation pending).
9616 There is thus no function-key in this sequence.
9617 Moving fkey.start is important in this case to allow keytran.start
9618 to go over the sequence before we return (since we keep the
9619 invariant that keytran.end <= fkey.start). */
9622 (fkey
.start
= fkey
.end
= t
, fkey
.map
= fkey
.parent
);
9625 /* If the sequence is unbound, see if we can hang a function key
9626 off the end of it. */
9627 /* Continue scan from fkey.end until we find a bound suffix. */
9628 while (fkey
.end
< indec
.start
)
9630 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9634 GCPRO4 (indec
.map
, fkey
.map
, keytran
.map
, delayed_switch_frame
);
9635 done
= keyremap_step (keybuf
, bufsize
, &fkey
,
9636 max (t
, mock_input
),
9637 /* If there's a binding (i.e.
9638 first_binding >= nmaps) we don't want
9639 to apply this function-key-mapping. */
9641 && (test_undefined (current_binding
)),
9646 mock_input
= diff
+ max (t
, mock_input
);
9647 /* Adjust the input-decode-map counters. */
9649 indec
.start
+= diff
;
9651 goto replay_sequence
;
9655 /* Look for this sequence in key-translation-map.
9656 Scan from keytran.end until we find a bound suffix. */
9657 while (keytran
.end
< fkey
.start
)
9659 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9663 GCPRO4 (indec
.map
, fkey
.map
, keytran
.map
, delayed_switch_frame
);
9664 done
= keyremap_step (keybuf
, bufsize
, &keytran
, max (t
, mock_input
),
9669 mock_input
= diff
+ max (t
, mock_input
);
9670 /* Adjust the function-key-map and input-decode-map counters. */
9672 indec
.start
+= diff
;
9676 goto replay_sequence
;
9680 /* If KEY is not defined in any of the keymaps,
9681 and cannot be part of a function key or translation,
9682 and is an upper case letter
9683 use the corresponding lower-case letter instead. */
9684 if (NILP (current_binding
)
9685 && /* indec.start >= t && fkey.start >= t && */ keytran
.start
>= t
9687 && ((CHARACTERP (make_number (XINT (key
) & ~CHAR_MODIFIER_MASK
))
9688 && uppercasep (XINT (key
) & ~CHAR_MODIFIER_MASK
))
9689 || (XINT (key
) & shift_modifier
)))
9691 Lisp_Object new_key
;
9693 original_uppercase
= key
;
9694 original_uppercase_position
= t
- 1;
9696 if (XINT (key
) & shift_modifier
)
9697 XSETINT (new_key
, XINT (key
) & ~shift_modifier
);
9699 XSETINT (new_key
, (downcase (XINT (key
) & ~CHAR_MODIFIER_MASK
)
9700 | (XINT (key
) & CHAR_MODIFIER_MASK
)));
9702 /* We have to do this unconditionally, regardless of whether
9703 the lower-case char is defined in the keymaps, because they
9704 might get translated through function-key-map. */
9705 keybuf
[t
- 1] = new_key
;
9706 mock_input
= max (t
, mock_input
);
9707 shift_translated
= 1;
9709 goto replay_sequence
;
9712 if (NILP (current_binding
)
9713 && help_char_p (EVENT_HEAD (key
)) && t
> 1)
9715 read_key_sequence_cmd
= Vprefix_help_command
;
9716 /* The Microsoft C compiler can't handle the goto that
9722 /* If KEY is not defined in any of the keymaps,
9723 and cannot be part of a function key or translation,
9724 and is a shifted function key,
9725 use the corresponding unshifted function key instead. */
9726 if (NILP (current_binding
)
9727 && /* indec.start >= t && fkey.start >= t && */ keytran
.start
>= t
)
9729 Lisp_Object breakdown
= parse_modifiers (key
);
9731 = CONSP (breakdown
) ? (XINT (XCAR (XCDR (breakdown
)))) : 0;
9733 if (modifiers
& shift_modifier
9734 /* Treat uppercase keys as shifted. */
9736 && (KEY_TO_CHAR (key
)
9737 < XCHAR_TABLE (BVAR (current_buffer
, downcase_table
))->header
.size
)
9738 && uppercasep (KEY_TO_CHAR (key
))))
9741 = (modifiers
& shift_modifier
9742 ? apply_modifiers (modifiers
& ~shift_modifier
,
9744 : make_number (downcase (KEY_TO_CHAR (key
)) | modifiers
));
9746 original_uppercase
= key
;
9747 original_uppercase_position
= t
- 1;
9749 /* We have to do this unconditionally, regardless of whether
9750 the lower-case char is defined in the keymaps, because they
9751 might get translated through function-key-map. */
9752 keybuf
[t
- 1] = new_key
;
9753 mock_input
= max (t
, mock_input
);
9754 /* Reset fkey (and consequently keytran) to apply
9755 function-key-map on the result, so that S-backspace is
9756 correctly mapped to DEL (via backspace). OTOH,
9757 input-decode-map doesn't need to go through it again. */
9758 fkey
.start
= fkey
.end
= 0;
9759 keytran
.start
= keytran
.end
= 0;
9760 shift_translated
= 1;
9762 goto replay_sequence
;
9767 read_key_sequence_cmd
= current_binding
;
9768 read_key_sequence_remapped
9769 /* Remap command through active keymaps.
9770 Do the remapping here, before the unbind_to so it uses the keymaps
9771 of the appropriate buffer. */
9772 = SYMBOLP (read_key_sequence_cmd
)
9773 ? Fcommand_remapping (read_key_sequence_cmd
, Qnil
, Qnil
)
9776 unread_switch_frame
= delayed_switch_frame
;
9777 unbind_to (count
, Qnil
);
9779 /* Don't downcase the last character if the caller says don't.
9780 Don't downcase it if the result is undefined, either. */
9781 if ((dont_downcase_last
|| NILP (current_binding
))
9783 && t
- 1 == original_uppercase_position
)
9785 keybuf
[t
- 1] = original_uppercase
;
9786 shift_translated
= 0;
9789 if (shift_translated
)
9790 Vthis_command_keys_shift_translated
= Qt
;
9792 /* Occasionally we fabricate events, perhaps by expanding something
9793 according to function-key-map, or by adding a prefix symbol to a
9794 mouse click in the scroll bar or modeline. In this cases, return
9795 the entire generated key sequence, even if we hit an unbound
9796 prefix or a definition before the end. This means that you will
9797 be able to push back the event properly, and also means that
9798 read-key-sequence will always return a logical unit.
9801 for (; t
< mock_input
; t
++)
9803 if (echo_keystrokes_p ())
9804 echo_char (keybuf
[t
]);
9805 add_command_key (keybuf
[t
]);
9813 read_key_sequence_vs (Lisp_Object prompt
, Lisp_Object continue_echo
,
9814 Lisp_Object dont_downcase_last
,
9815 Lisp_Object can_return_switch_frame
,
9816 Lisp_Object cmd_loop
, bool allow_string
)
9818 Lisp_Object keybuf
[30];
9820 struct gcpro gcpro1
;
9821 ptrdiff_t count
= SPECPDL_INDEX ();
9824 CHECK_STRING (prompt
);
9827 specbind (Qinput_method_exit_on_first_char
,
9828 (NILP (cmd_loop
) ? Qt
: Qnil
));
9829 specbind (Qinput_method_use_echo_area
,
9830 (NILP (cmd_loop
) ? Qt
: Qnil
));
9832 memset (keybuf
, 0, sizeof keybuf
);
9834 gcpro1
.nvars
= ARRAYELTS (keybuf
);
9836 if (NILP (continue_echo
))
9838 this_command_key_count
= 0;
9839 this_command_key_count_reset
= 0;
9840 this_single_command_key_start
= 0;
9843 #ifdef HAVE_WINDOW_SYSTEM
9844 if (display_hourglass_p
)
9845 cancel_hourglass ();
9848 i
= read_key_sequence (keybuf
, ARRAYELTS (keybuf
),
9849 prompt
, ! NILP (dont_downcase_last
),
9850 ! NILP (can_return_switch_frame
), 0, 0);
9852 #if 0 /* The following is fine for code reading a key sequence and
9853 then proceeding with a lengthy computation, but it's not good
9854 for code reading keys in a loop, like an input method. */
9855 #ifdef HAVE_WINDOW_SYSTEM
9856 if (display_hourglass_p
)
9867 return unbind_to (count
,
9868 ((allow_string
? make_event_array
: Fvector
)
9872 DEFUN ("read-key-sequence", Fread_key_sequence
, Sread_key_sequence
, 1, 5, 0,
9873 doc
: /* Read a sequence of keystrokes and return as a string or vector.
9874 The sequence is sufficient to specify a non-prefix command in the
9875 current local and global maps.
9877 First arg PROMPT is a prompt string. If nil, do not prompt specially.
9878 Second (optional) arg CONTINUE-ECHO, if non-nil, means this key echos
9879 as a continuation of the previous key.
9881 The third (optional) arg DONT-DOWNCASE-LAST, if non-nil, means do not
9882 convert the last event to lower case. (Normally any upper case event
9883 is converted to lower case if the original event is undefined and the lower
9884 case equivalent is defined.) A non-nil value is appropriate for reading
9885 a key sequence to be defined.
9887 A C-g typed while in this function is treated like any other character,
9888 and `quit-flag' is not set.
9890 If the key sequence starts with a mouse click, then the sequence is read
9891 using the keymaps of the buffer of the window clicked in, not the buffer
9892 of the selected window as normal.
9894 `read-key-sequence' drops unbound button-down events, since you normally
9895 only care about the click or drag events which follow them. If a drag
9896 or multi-click event is unbound, but the corresponding click event would
9897 be bound, `read-key-sequence' turns the event into a click event at the
9898 drag's starting position. This means that you don't have to distinguish
9899 between click and drag, double, or triple events unless you want to.
9901 `read-key-sequence' prefixes mouse events on mode lines, the vertical
9902 lines separating windows, and scroll bars with imaginary keys
9903 `mode-line', `vertical-line', and `vertical-scroll-bar'.
9905 Optional fourth argument CAN-RETURN-SWITCH-FRAME non-nil means that this
9906 function will process a switch-frame event if the user switches frames
9907 before typing anything. If the user switches frames in the middle of a
9908 key sequence, or at the start of the sequence but CAN-RETURN-SWITCH-FRAME
9909 is nil, then the event will be put off until after the current key sequence.
9911 `read-key-sequence' checks `function-key-map' for function key
9912 sequences, where they wouldn't conflict with ordinary bindings. See
9913 `function-key-map' for more details.
9915 The optional fifth argument CMD-LOOP, if non-nil, means
9916 that this key sequence is being read by something that will
9917 read commands one after another. It should be nil if the caller
9918 will read just one key sequence. */)
9919 (Lisp_Object prompt
, Lisp_Object continue_echo
, Lisp_Object dont_downcase_last
, Lisp_Object can_return_switch_frame
, Lisp_Object cmd_loop
)
9921 return read_key_sequence_vs (prompt
, continue_echo
, dont_downcase_last
,
9922 can_return_switch_frame
, cmd_loop
, true);
9925 DEFUN ("read-key-sequence-vector", Fread_key_sequence_vector
,
9926 Sread_key_sequence_vector
, 1, 5, 0,
9927 doc
: /* Like `read-key-sequence' but always return a vector. */)
9928 (Lisp_Object prompt
, Lisp_Object continue_echo
, Lisp_Object dont_downcase_last
, Lisp_Object can_return_switch_frame
, Lisp_Object cmd_loop
)
9930 return read_key_sequence_vs (prompt
, continue_echo
, dont_downcase_last
,
9931 can_return_switch_frame
, cmd_loop
, false);
9934 /* Return true if input events are pending. */
9937 detect_input_pending (void)
9939 return input_pending
|| get_input_pending (0);
9942 /* Return true if input events other than mouse movements are
9946 detect_input_pending_ignore_squeezables (void)
9948 return input_pending
|| get_input_pending (READABLE_EVENTS_IGNORE_SQUEEZABLES
);
9951 /* Return true if input events are pending, and run any pending timers. */
9954 detect_input_pending_run_timers (bool do_display
)
9956 unsigned old_timers_run
= timers_run
;
9959 get_input_pending (READABLE_EVENTS_DO_TIMERS_NOW
);
9961 if (old_timers_run
!= timers_run
&& do_display
)
9962 redisplay_preserve_echo_area (8);
9964 return input_pending
;
9967 /* This is called in some cases before a possible quit.
9968 It cases the next call to detect_input_pending to recompute input_pending.
9969 So calling this function unnecessarily can't do any harm. */
9972 clear_input_pending (void)
9977 /* Return true if there are pending requeued events.
9978 This isn't used yet. The hope is to make wait_reading_process_output
9979 call it, and return if it runs Lisp code that unreads something.
9980 The problem is, kbd_buffer_get_event needs to be fixed to know what
9981 to do in that case. It isn't trivial. */
9984 requeued_events_pending_p (void)
9986 return (!NILP (Vunread_command_events
));
9989 DEFUN ("input-pending-p", Finput_pending_p
, Sinput_pending_p
, 0, 1, 0,
9990 doc
: /* Return t if command input is currently available with no wait.
9991 Actually, the value is nil only if we can be sure that no input is available;
9992 if there is a doubt, the value is t.
9994 If CHECK-TIMERS is non-nil, timers that are ready to run will do so. */)
9995 (Lisp_Object check_timers
)
9997 if (!NILP (Vunread_command_events
)
9998 || !NILP (Vunread_post_input_method_events
)
9999 || !NILP (Vunread_input_method_events
))
10002 /* Process non-user-visible events (Bug#10195). */
10003 process_special_events ();
10005 return (get_input_pending ((NILP (check_timers
)
10006 ? 0 : READABLE_EVENTS_DO_TIMERS_NOW
)
10007 | READABLE_EVENTS_FILTER_EVENTS
)
10011 DEFUN ("recent-keys", Frecent_keys
, Srecent_keys
, 0, 1, 0,
10012 doc
: /* Return vector of last few events, not counting those from keyboard macros.
10013 If INCLUDE-CMDS is non-nil, include the commands that were run,
10014 represented as events of the form (nil . COMMAND). */)
10015 (Lisp_Object include_cmds
)
10017 bool cmds
= !NILP (include_cmds
);
10020 || (cmds
&& total_keys
< NUM_RECENT_KEYS
))
10021 return Fvector (total_keys
,
10022 XVECTOR (recent_keys
)->contents
);
10025 Lisp_Object es
= Qnil
;
10026 int i
= (total_keys
< NUM_RECENT_KEYS
10027 ? 0 : recent_keys_index
);
10028 eassert (recent_keys_index
< NUM_RECENT_KEYS
);
10031 Lisp_Object e
= AREF (recent_keys
, i
);
10032 if (cmds
|| !CONSP (e
) || !NILP (XCAR (e
)))
10033 es
= Fcons (e
, es
);
10034 if (++i
>= NUM_RECENT_KEYS
)
10036 } while (i
!= recent_keys_index
);
10037 es
= Fnreverse (es
);
10038 return Fvconcat (1, &es
);
10042 DEFUN ("this-command-keys", Fthis_command_keys
, Sthis_command_keys
, 0, 0, 0,
10043 doc
: /* Return the key sequence that invoked this command.
10044 However, if the command has called `read-key-sequence', it returns
10045 the last key sequence that has been read.
10046 The value is a string or a vector.
10048 See also `this-command-keys-vector'. */)
10051 return make_event_array (this_command_key_count
,
10052 XVECTOR (this_command_keys
)->contents
);
10055 DEFUN ("this-command-keys-vector", Fthis_command_keys_vector
, Sthis_command_keys_vector
, 0, 0, 0,
10056 doc
: /* Return the key sequence that invoked this command, as a vector.
10057 However, if the command has called `read-key-sequence', it returns
10058 the last key sequence that has been read.
10060 See also `this-command-keys'. */)
10063 return Fvector (this_command_key_count
,
10064 XVECTOR (this_command_keys
)->contents
);
10067 DEFUN ("this-single-command-keys", Fthis_single_command_keys
,
10068 Sthis_single_command_keys
, 0, 0, 0,
10069 doc
: /* Return the key sequence that invoked this command.
10070 More generally, it returns the last key sequence read, either by
10071 the command loop or by `read-key-sequence'.
10072 Unlike `this-command-keys', this function's value
10073 does not include prefix arguments.
10074 The value is always a vector. */)
10077 return Fvector (this_command_key_count
10078 - this_single_command_key_start
,
10079 (XVECTOR (this_command_keys
)->contents
10080 + this_single_command_key_start
));
10083 DEFUN ("this-single-command-raw-keys", Fthis_single_command_raw_keys
,
10084 Sthis_single_command_raw_keys
, 0, 0, 0,
10085 doc
: /* Return the raw events that were read for this command.
10086 More generally, it returns the last key sequence read, either by
10087 the command loop or by `read-key-sequence'.
10088 Unlike `this-single-command-keys', this function's value
10089 shows the events before all translations (except for input methods).
10090 The value is always a vector. */)
10093 return Fvector (raw_keybuf_count
, XVECTOR (raw_keybuf
)->contents
);
10096 DEFUN ("reset-this-command-lengths", Freset_this_command_lengths
,
10097 Sreset_this_command_lengths
, 0, 0, 0,
10098 doc
: /* Make the unread events replace the last command and echo.
10099 Used in `universal-argument-other-key'.
10101 `universal-argument-other-key' rereads the event just typed.
10102 It then gets translated through `function-key-map'.
10103 The translated event has to replace the real events,
10104 both in the value of (this-command-keys) and in echoing.
10105 To achieve this, `universal-argument-other-key' calls
10106 `reset-this-command-lengths', which discards the record of reading
10107 these events the first time. */)
10110 this_command_key_count
= before_command_key_count
;
10111 if (this_command_key_count
< this_single_command_key_start
)
10112 this_single_command_key_start
= this_command_key_count
;
10114 echo_truncate (before_command_echo_length
);
10116 /* Cause whatever we put into unread-command-events
10117 to echo as if it were being freshly read from the keyboard. */
10118 this_command_key_count_reset
= 1;
10123 DEFUN ("clear-this-command-keys", Fclear_this_command_keys
,
10124 Sclear_this_command_keys
, 0, 1, 0,
10125 doc
: /* Clear out the vector that `this-command-keys' returns.
10126 Also clear the record of the last 100 events, unless optional arg
10127 KEEP-RECORD is non-nil. */)
10128 (Lisp_Object keep_record
)
10132 this_command_key_count
= 0;
10133 this_command_key_count_reset
= 0;
10135 if (NILP (keep_record
))
10137 for (i
= 0; i
< ASIZE (recent_keys
); ++i
)
10138 ASET (recent_keys
, i
, Qnil
);
10140 recent_keys_index
= 0;
10145 DEFUN ("recursion-depth", Frecursion_depth
, Srecursion_depth
, 0, 0, 0,
10146 doc
: /* Return the current depth in recursive edits. */)
10150 /* Wrap around reliably on integer overflow. */
10151 EMACS_INT sum
= (command_loop_level
& INTMASK
) + (minibuf_level
& INTMASK
);
10152 XSETINT (temp
, sum
);
10156 DEFUN ("open-dribble-file", Fopen_dribble_file
, Sopen_dribble_file
, 1, 1,
10157 "FOpen dribble file: ",
10158 doc
: /* Start writing all keyboard characters to a dribble file called FILE.
10159 If FILE is nil, close any open dribble file.
10160 The file will be closed when Emacs exits.
10162 Be aware that this records ALL characters you type!
10163 This may include sensitive information such as passwords. */)
10176 Lisp_Object encfile
;
10178 file
= Fexpand_file_name (file
, Qnil
);
10179 encfile
= ENCODE_FILE (file
);
10180 fd
= emacs_open (SSDATA (encfile
), O_WRONLY
| O_CREAT
| O_EXCL
, 0600);
10181 if (fd
< 0 && errno
== EEXIST
&& unlink (SSDATA (encfile
)) == 0)
10182 fd
= emacs_open (SSDATA (encfile
), O_WRONLY
| O_CREAT
| O_EXCL
, 0600);
10183 dribble
= fd
< 0 ? 0 : fdopen (fd
, "w");
10185 report_file_error ("Opening dribble", file
);
10190 DEFUN ("discard-input", Fdiscard_input
, Sdiscard_input
, 0, 0, 0,
10191 doc
: /* Discard the contents of the terminal input buffer.
10192 Also end any kbd macro being defined. */)
10195 if (!NILP (KVAR (current_kboard
, defining_kbd_macro
)))
10197 /* Discard the last command from the macro. */
10198 Fcancel_kbd_macro_events ();
10202 Vunread_command_events
= Qnil
;
10204 discard_tty_input ();
10206 kbd_fetch_ptr
= kbd_store_ptr
;
10212 DEFUN ("suspend-emacs", Fsuspend_emacs
, Ssuspend_emacs
, 0, 1, "",
10213 doc
: /* Stop Emacs and return to superior process. You can resume later.
10214 If `cannot-suspend' is non-nil, or if the system doesn't support job
10215 control, run a subshell instead.
10217 If optional arg STUFFSTRING is non-nil, its characters are stuffed
10218 to be read as terminal input by Emacs's parent, after suspension.
10220 Before suspending, run the normal hook `suspend-hook'.
10221 After resumption run the normal hook `suspend-resume-hook'.
10223 Some operating systems cannot stop the Emacs process and resume it later.
10224 On such systems, Emacs starts a subshell instead of suspending. */)
10225 (Lisp_Object stuffstring
)
10227 ptrdiff_t count
= SPECPDL_INDEX ();
10228 int old_height
, old_width
;
10230 struct gcpro gcpro1
;
10232 if (tty_list
&& tty_list
->next
)
10233 error ("There are other tty frames open; close them before suspending Emacs");
10235 if (!NILP (stuffstring
))
10236 CHECK_STRING (stuffstring
);
10238 run_hook (intern ("suspend-hook"));
10240 GCPRO1 (stuffstring
);
10241 get_tty_size (fileno (CURTTY ()->input
), &old_width
, &old_height
);
10242 reset_all_sys_modes ();
10243 /* sys_suspend can get an error if it tries to fork a subshell
10244 and the system resources aren't available for that. */
10245 record_unwind_protect_void (init_all_sys_modes
);
10246 stuff_buffered_input (stuffstring
);
10247 if (cannot_suspend
)
10251 unbind_to (count
, Qnil
);
10253 /* Check if terminal/window size has changed.
10254 Note that this is not useful when we are running directly
10255 with a window system; but suspend should be disabled in that case. */
10256 get_tty_size (fileno (CURTTY ()->input
), &width
, &height
);
10257 if (width
!= old_width
|| height
!= old_height
)
10258 change_frame_size (SELECTED_FRAME (), width
,
10259 height
- FRAME_MENU_BAR_LINES (SELECTED_FRAME ()),
10262 run_hook (intern ("suspend-resume-hook"));
10268 /* If STUFFSTRING is a string, stuff its contents as pending terminal input.
10269 Then in any case stuff anything Emacs has read ahead and not used. */
10272 stuff_buffered_input (Lisp_Object stuffstring
)
10274 #ifdef SIGTSTP /* stuff_char is defined if SIGTSTP. */
10275 register unsigned char *p
;
10277 if (STRINGP (stuffstring
))
10279 register ptrdiff_t count
;
10281 p
= SDATA (stuffstring
);
10282 count
= SBYTES (stuffstring
);
10283 while (count
-- > 0)
10288 /* Anything we have read ahead, put back for the shell to read. */
10289 /* ?? What should this do when we have multiple keyboards??
10290 Should we ignore anything that was typed in at the "wrong" kboard?
10292 rms: we should stuff everything back into the kboard
10294 for (; kbd_fetch_ptr
!= kbd_store_ptr
; kbd_fetch_ptr
++)
10297 if (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
10298 kbd_fetch_ptr
= kbd_buffer
;
10299 if (kbd_fetch_ptr
->kind
== ASCII_KEYSTROKE_EVENT
)
10300 stuff_char (kbd_fetch_ptr
->code
);
10302 clear_event (kbd_fetch_ptr
);
10306 #endif /* SIGTSTP */
10310 set_waiting_for_input (struct timespec
*time_to_clear
)
10312 input_available_clear_time
= time_to_clear
;
10314 /* Tell handle_interrupt to throw back to read_char, */
10315 waiting_for_input
= 1;
10317 /* If handle_interrupt was called before and buffered a C-g,
10318 make it run again now, to avoid timing error. */
10319 if (!NILP (Vquit_flag
))
10320 quit_throw_to_read_char (0);
10324 clear_waiting_for_input (void)
10326 /* Tell handle_interrupt not to throw back to read_char, */
10327 waiting_for_input
= 0;
10328 input_available_clear_time
= 0;
10331 /* The SIGINT handler.
10333 If we have a frame on the controlling tty, we assume that the
10334 SIGINT was generated by C-g, so we call handle_interrupt.
10335 Otherwise, tell QUIT to kill Emacs. */
10338 handle_interrupt_signal (int sig
)
10340 /* See if we have an active terminal on our controlling tty. */
10341 struct terminal
*terminal
= get_named_terminal ("/dev/tty");
10344 /* If there are no frames there, let's pretend that we are a
10345 well-behaving UN*X program and quit. We must not call Lisp
10346 in a signal handler, so tell QUIT to exit when it is
10348 Vquit_flag
= Qkill_emacs
;
10352 /* Otherwise, the SIGINT was probably generated by C-g. */
10354 /* Set internal_last_event_frame to the top frame of the
10355 controlling tty, if we have a frame there. We disable the
10356 interrupt key on secondary ttys, so the SIGINT must have come
10357 from the controlling tty. */
10358 internal_last_event_frame
= terminal
->display_info
.tty
->top_frame
;
10360 handle_interrupt (1);
10365 deliver_interrupt_signal (int sig
)
10367 deliver_process_signal (sig
, handle_interrupt_signal
);
10371 /* If Emacs is stuck because `inhibit-quit' is true, then keep track
10372 of the number of times C-g has been requested. If C-g is pressed
10373 enough times, then quit anyway. See bug#6585. */
10374 static int volatile force_quit_count
;
10376 /* This routine is called at interrupt level in response to C-g.
10378 It is called from the SIGINT handler or kbd_buffer_store_event.
10380 If `waiting_for_input' is non zero, then unless `echoing' is
10381 nonzero, immediately throw back to read_char.
10383 Otherwise it sets the Lisp variable quit-flag not-nil. This causes
10384 eval to throw, when it gets a chance. If quit-flag is already
10385 non-nil, it stops the job right away. */
10388 handle_interrupt (bool in_signal_handler
)
10394 /* XXX This code needs to be revised for multi-tty support. */
10395 if (!NILP (Vquit_flag
) && get_named_terminal ("/dev/tty"))
10397 if (! in_signal_handler
)
10399 /* If SIGINT isn't blocked, don't let us be interrupted by
10400 a SIGINT. It might be harmful due to non-reentrancy
10401 in I/O functions. */
10403 sigemptyset (&blocked
);
10404 sigaddset (&blocked
, SIGINT
);
10405 pthread_sigmask (SIG_BLOCK
, &blocked
, 0);
10409 reset_all_sys_modes ();
10413 * On systems which can suspend the current process and return to the original
10414 * shell, this command causes the user to end up back at the shell.
10415 * The "Auto-save" and "Abort" questions are not asked until
10416 * the user elects to return to emacs, at which point he can save the current
10417 * job and either dump core or continue.
10421 /* Perhaps should really fork an inferior shell?
10422 But that would not provide any way to get back
10423 to the original shell, ever. */
10424 printf ("No support for stopping a process on this operating system;\n");
10425 printf ("you can continue or abort.\n");
10426 #endif /* not SIGTSTP */
10428 /* We must remain inside the screen area when the internal terminal
10429 is used. Note that [Enter] is not echoed by dos. */
10430 cursor_to (SELECTED_FRAME (), 0, 0);
10432 /* It doesn't work to autosave while GC is in progress;
10433 the code used for auto-saving doesn't cope with the mark bit. */
10434 if (!gc_in_progress
)
10436 printf ("Auto-save? (y or n) ");
10438 if (((c
= getchar ()) & ~040) == 'Y')
10440 Fdo_auto_save (Qt
, Qnil
);
10442 printf ("\r\nAuto-save done");
10443 #else /* not MSDOS */
10444 printf ("Auto-save done\n");
10445 #endif /* not MSDOS */
10447 while (c
!= '\n') c
= getchar ();
10451 /* During GC, it must be safe to reenable quitting again. */
10452 Vinhibit_quit
= Qnil
;
10455 #endif /* not MSDOS */
10456 printf ("Garbage collection in progress; cannot auto-save now\r\n");
10457 printf ("but will instead do a real quit after garbage collection ends\r\n");
10462 printf ("\r\nAbort? (y or n) ");
10463 #else /* not MSDOS */
10464 printf ("Abort (and dump core)? (y or n) ");
10465 #endif /* not MSDOS */
10467 if (((c
= getchar ()) & ~040) == 'Y')
10469 while (c
!= '\n') c
= getchar ();
10471 printf ("\r\nContinuing...\r\n");
10472 #else /* not MSDOS */
10473 printf ("Continuing...\n");
10474 #endif /* not MSDOS */
10476 init_all_sys_modes ();
10480 /* If executing a function that wants to be interrupted out of
10481 and the user has not deferred quitting by binding `inhibit-quit'
10482 then quit right away. */
10483 if (immediate_quit
&& NILP (Vinhibit_quit
))
10485 struct gl_state_s saved
;
10486 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
10488 immediate_quit
= 0;
10489 pthread_sigmask (SIG_SETMASK
, &empty_mask
, 0);
10491 GCPRO4 (saved
.object
, saved
.global_code
,
10492 saved
.current_syntax_table
, saved
.old_prop
);
10493 Fsignal (Qquit
, Qnil
);
10498 { /* Else request quit when it's safe. */
10499 int count
= NILP (Vquit_flag
) ? 1 : force_quit_count
+ 1;
10500 force_quit_count
= count
;
10503 immediate_quit
= 1;
10504 Vinhibit_quit
= Qnil
;
10510 pthread_sigmask (SIG_SETMASK
, &empty_mask
, 0);
10512 /* TODO: The longjmp in this call throws the NS event loop integration off,
10513 and it seems to do fine without this. Probably some attention
10514 needs to be paid to the setting of waiting_for_input in
10515 wait_reading_process_output() under HAVE_NS because of the call
10516 to ns_select there (needed because otherwise events aren't picked up
10517 outside of polling since we don't get SIGIO like X and we don't have a
10518 separate event loop thread like W32. */
10520 if (waiting_for_input
&& !echoing
)
10521 quit_throw_to_read_char (in_signal_handler
);
10525 /* Handle a C-g by making read_char return C-g. */
10528 quit_throw_to_read_char (bool from_signal
)
10530 /* When not called from a signal handler it is safe to call
10532 if (!from_signal
&& EQ (Vquit_flag
, Qkill_emacs
))
10533 Fkill_emacs (Qnil
);
10535 /* Prevent another signal from doing this before we finish. */
10536 clear_waiting_for_input ();
10539 Vunread_command_events
= Qnil
;
10541 if (FRAMEP (internal_last_event_frame
)
10542 && !EQ (internal_last_event_frame
, selected_frame
))
10543 do_switch_frame (make_lispy_switch_frame (internal_last_event_frame
),
10546 sys_longjmp (getcjmp
, 1);
10549 DEFUN ("set-input-interrupt-mode", Fset_input_interrupt_mode
,
10550 Sset_input_interrupt_mode
, 1, 1, 0,
10551 doc
: /* Set interrupt mode of reading keyboard input.
10552 If INTERRUPT is non-nil, Emacs will use input interrupts;
10553 otherwise Emacs uses CBREAK mode.
10555 See also `current-input-mode'. */)
10556 (Lisp_Object interrupt
)
10558 bool new_interrupt_input
;
10559 #ifdef USABLE_SIGIO
10560 #ifdef HAVE_X_WINDOWS
10561 if (x_display_list
!= NULL
)
10563 /* When using X, don't give the user a real choice,
10564 because we haven't implemented the mechanisms to support it. */
10565 new_interrupt_input
= 1;
10568 #endif /* HAVE_X_WINDOWS */
10569 new_interrupt_input
= !NILP (interrupt
);
10570 #else /* not USABLE_SIGIO */
10571 new_interrupt_input
= 0;
10572 #endif /* not USABLE_SIGIO */
10574 if (new_interrupt_input
!= interrupt_input
)
10576 #ifdef POLL_FOR_INPUT
10580 /* this causes startup screen to be restored and messes with the mouse */
10581 reset_all_sys_modes ();
10582 interrupt_input
= new_interrupt_input
;
10583 init_all_sys_modes ();
10585 interrupt_input
= new_interrupt_input
;
10588 #ifdef POLL_FOR_INPUT
10589 poll_suppress_count
= 1;
10596 DEFUN ("set-output-flow-control", Fset_output_flow_control
, Sset_output_flow_control
, 1, 2, 0,
10597 doc
: /* Enable or disable ^S/^Q flow control for output to TERMINAL.
10598 If FLOW is non-nil, flow control is enabled and you cannot use C-s or
10599 C-q in key sequences.
10601 This setting only has an effect on tty terminals and only when
10602 Emacs reads input in CBREAK mode; see `set-input-interrupt-mode'.
10604 See also `current-input-mode'. */)
10605 (Lisp_Object flow
, Lisp_Object terminal
)
10607 struct terminal
*t
= decode_tty_terminal (terminal
);
10608 struct tty_display_info
*tty
;
10612 tty
= t
->display_info
.tty
;
10614 if (tty
->flow_control
!= !NILP (flow
))
10617 /* This causes startup screen to be restored and messes with the mouse. */
10618 reset_sys_modes (tty
);
10621 tty
->flow_control
= !NILP (flow
);
10624 init_sys_modes (tty
);
10630 DEFUN ("set-input-meta-mode", Fset_input_meta_mode
, Sset_input_meta_mode
, 1, 2, 0,
10631 doc
: /* Enable or disable 8-bit input on TERMINAL.
10632 If META is t, Emacs will accept 8-bit input, and interpret the 8th
10633 bit as the Meta modifier.
10635 If META is nil, Emacs will ignore the top bit, on the assumption it is
10638 Otherwise, Emacs will accept and pass through 8-bit input without
10639 specially interpreting the top bit.
10641 This setting only has an effect on tty terminal devices.
10643 Optional parameter TERMINAL specifies the tty terminal device to use.
10644 It may be a terminal object, a frame, or nil for the terminal used by
10645 the currently selected frame.
10647 See also `current-input-mode'. */)
10648 (Lisp_Object meta
, Lisp_Object terminal
)
10650 struct terminal
*t
= decode_tty_terminal (terminal
);
10651 struct tty_display_info
*tty
;
10656 tty
= t
->display_info
.tty
;
10660 else if (EQ (meta
, Qt
))
10665 if (tty
->meta_key
!= new_meta
)
10668 /* this causes startup screen to be restored and messes with the mouse */
10669 reset_sys_modes (tty
);
10672 tty
->meta_key
= new_meta
;
10675 init_sys_modes (tty
);
10681 DEFUN ("set-quit-char", Fset_quit_char
, Sset_quit_char
, 1, 1, 0,
10682 doc
: /* Specify character used for quitting.
10683 QUIT must be an ASCII character.
10685 This function only has an effect on the controlling tty of the Emacs
10688 See also `current-input-mode'. */)
10691 struct terminal
*t
= get_named_terminal ("/dev/tty");
10692 struct tty_display_info
*tty
;
10696 tty
= t
->display_info
.tty
;
10698 if (NILP (quit
) || !INTEGERP (quit
) || XINT (quit
) < 0 || XINT (quit
) > 0400)
10699 error ("QUIT must be an ASCII character");
10702 /* this causes startup screen to be restored and messes with the mouse */
10703 reset_sys_modes (tty
);
10706 /* Don't let this value be out of range. */
10707 quit_char
= XINT (quit
) & (tty
->meta_key
== 0 ? 0177 : 0377);
10710 init_sys_modes (tty
);
10716 DEFUN ("set-input-mode", Fset_input_mode
, Sset_input_mode
, 3, 4, 0,
10717 doc
: /* Set mode of reading keyboard input.
10718 First arg INTERRUPT non-nil means use input interrupts;
10719 nil means use CBREAK mode.
10720 Second arg FLOW non-nil means use ^S/^Q flow control for output to terminal
10721 (no effect except in CBREAK mode).
10722 Third arg META t means accept 8-bit input (for a Meta key).
10723 META nil means ignore the top bit, on the assumption it is parity.
10724 Otherwise, accept 8-bit input and don't use the top bit for Meta.
10725 Optional fourth arg QUIT if non-nil specifies character to use for quitting.
10726 See also `current-input-mode'. */)
10727 (Lisp_Object interrupt
, Lisp_Object flow
, Lisp_Object meta
, Lisp_Object quit
)
10729 Fset_input_interrupt_mode (interrupt
);
10730 Fset_output_flow_control (flow
, Qnil
);
10731 Fset_input_meta_mode (meta
, Qnil
);
10733 Fset_quit_char (quit
);
10737 DEFUN ("current-input-mode", Fcurrent_input_mode
, Scurrent_input_mode
, 0, 0, 0,
10738 doc
: /* Return information about the way Emacs currently reads keyboard input.
10739 The value is a list of the form (INTERRUPT FLOW META QUIT), where
10740 INTERRUPT is non-nil if Emacs is using interrupt-driven input; if
10741 nil, Emacs is using CBREAK mode.
10742 FLOW is non-nil if Emacs uses ^S/^Q flow control for output to the
10743 terminal; this does not apply if Emacs uses interrupt-driven input.
10744 META is t if accepting 8-bit input with 8th bit as Meta flag.
10745 META nil means ignoring the top bit, on the assumption it is parity.
10746 META is neither t nor nil if accepting 8-bit input and using
10747 all 8 bits as the character code.
10748 QUIT is the character Emacs currently uses to quit.
10749 The elements of this list correspond to the arguments of
10750 `set-input-mode'. */)
10753 struct frame
*sf
= XFRAME (selected_frame
);
10755 Lisp_Object interrupt
= interrupt_input
? Qt
: Qnil
;
10756 Lisp_Object flow
, meta
;
10757 if (FRAME_TERMCAP_P (sf
) || FRAME_MSDOS_P (sf
))
10759 flow
= FRAME_TTY (sf
)->flow_control
? Qt
: Qnil
;
10760 meta
= (FRAME_TTY (sf
)->meta_key
== 2
10762 : (CURTTY ()->meta_key
== 1 ? Qt
: Qnil
));
10769 Lisp_Object quit
= make_number (quit_char
);
10771 return list4 (interrupt
, flow
, meta
, quit
);
10774 DEFUN ("posn-at-x-y", Fposn_at_x_y
, Sposn_at_x_y
, 2, 4, 0,
10775 doc
: /* Return position information for pixel coordinates X and Y.
10776 By default, X and Y are relative to text area of the selected window.
10777 Optional third arg FRAME-OR-WINDOW non-nil specifies frame or window.
10778 If optional fourth arg WHOLE is non-nil, X is relative to the left
10779 edge of the window.
10781 The return value is similar to a mouse click position:
10782 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
10783 IMAGE (DX . DY) (WIDTH . HEIGHT))
10784 The `posn-' functions access elements of such lists. */)
10785 (Lisp_Object x
, Lisp_Object y
, Lisp_Object frame_or_window
, Lisp_Object whole
)
10790 if (NILP (frame_or_window
))
10791 frame_or_window
= selected_window
;
10793 if (WINDOWP (frame_or_window
))
10795 struct window
*w
= decode_live_window (frame_or_window
);
10797 XSETINT (x
, (XINT (x
)
10798 + WINDOW_LEFT_EDGE_X (w
)
10800 ? window_box_left_offset (w
, TEXT_AREA
)
10802 XSETINT (y
, WINDOW_TO_FRAME_PIXEL_Y (w
, XINT (y
)));
10803 frame_or_window
= w
->frame
;
10806 CHECK_LIVE_FRAME (frame_or_window
);
10808 return make_lispy_position (XFRAME (frame_or_window
), x
, y
, 0);
10811 DEFUN ("posn-at-point", Fposn_at_point
, Sposn_at_point
, 0, 2, 0,
10812 doc
: /* Return position information for buffer POS in WINDOW.
10813 POS defaults to point in WINDOW; WINDOW defaults to the selected window.
10815 Return nil if position is not visible in window. Otherwise,
10816 the return value is similar to that returned by `event-start' for
10817 a mouse click at the upper left corner of the glyph corresponding
10818 to the given buffer position:
10819 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
10820 IMAGE (DX . DY) (WIDTH . HEIGHT))
10821 The `posn-' functions access elements of such lists. */)
10822 (Lisp_Object pos
, Lisp_Object window
)
10827 window
= selected_window
;
10829 tem
= Fpos_visible_in_window_p (pos
, window
, Qt
);
10832 Lisp_Object x
= XCAR (tem
);
10833 Lisp_Object y
= XCAR (XCDR (tem
));
10835 /* Point invisible due to hscrolling? */
10838 tem
= Fposn_at_x_y (x
, y
, window
, Qnil
);
10844 /* Set up a new kboard object with reasonable initial values.
10845 TYPE is a window system for which this keyboard is used. */
10848 init_kboard (KBOARD
*kb
, Lisp_Object type
)
10850 kset_overriding_terminal_local_map (kb
, Qnil
);
10851 kset_last_command (kb
, Qnil
);
10852 kset_real_last_command (kb
, Qnil
);
10853 kset_keyboard_translate_table (kb
, Qnil
);
10854 kset_last_repeatable_command (kb
, Qnil
);
10855 kset_prefix_arg (kb
, Qnil
);
10856 kset_last_prefix_arg (kb
, Qnil
);
10857 kset_kbd_queue (kb
, Qnil
);
10858 kb
->kbd_queue_has_data
= 0;
10859 kb
->immediate_echo
= 0;
10860 kset_echo_string (kb
, Qnil
);
10861 kb
->echo_after_prompt
= -1;
10862 kb
->kbd_macro_buffer
= 0;
10863 kb
->kbd_macro_bufsize
= 0;
10864 kset_defining_kbd_macro (kb
, Qnil
);
10865 kset_last_kbd_macro (kb
, Qnil
);
10866 kb
->reference_count
= 0;
10867 kset_system_key_alist (kb
, Qnil
);
10868 kset_system_key_syms (kb
, Qnil
);
10869 kset_window_system (kb
, type
);
10870 kset_input_decode_map (kb
, Fmake_sparse_keymap (Qnil
));
10871 kset_local_function_key_map (kb
, Fmake_sparse_keymap (Qnil
));
10872 Fset_keymap_parent (KVAR (kb
, Vlocal_function_key_map
), Vfunction_key_map
);
10873 kset_default_minibuffer_frame (kb
, Qnil
);
10876 /* Allocate and basically initialize keyboard
10877 object to use with window system TYPE. */
10880 allocate_kboard (Lisp_Object type
)
10882 KBOARD
*kb
= xmalloc (sizeof *kb
);
10884 init_kboard (kb
, type
);
10885 kb
->next_kboard
= all_kboards
;
10891 * Destroy the contents of a kboard object, but not the object itself.
10892 * We use this just before deleting it, or if we're going to initialize
10893 * it a second time.
10896 wipe_kboard (KBOARD
*kb
)
10898 xfree (kb
->kbd_macro_buffer
);
10901 /* Free KB and memory referenced from it. */
10904 delete_kboard (KBOARD
*kb
)
10908 for (kbp
= &all_kboards
; *kbp
!= kb
; kbp
= &(*kbp
)->next_kboard
)
10911 *kbp
= kb
->next_kboard
;
10913 /* Prevent a dangling reference to KB. */
10914 if (kb
== current_kboard
10915 && FRAMEP (selected_frame
)
10916 && FRAME_LIVE_P (XFRAME (selected_frame
)))
10918 current_kboard
= FRAME_KBOARD (XFRAME (selected_frame
));
10920 if (current_kboard
== kb
)
10929 init_keyboard (void)
10931 /* This is correct before outermost invocation of the editor loop. */
10932 command_loop_level
= -1;
10933 immediate_quit
= 0;
10934 quit_char
= Ctl ('g');
10935 Vunread_command_events
= Qnil
;
10936 timer_idleness_start_time
= invalid_timespec ();
10938 recent_keys_index
= 0;
10939 kbd_fetch_ptr
= kbd_buffer
;
10940 kbd_store_ptr
= kbd_buffer
;
10941 do_mouse_tracking
= Qnil
;
10943 interrupt_input_blocked
= 0;
10944 pending_signals
= 0;
10946 /* This means that command_loop_1 won't try to select anything the first
10948 internal_last_event_frame
= Qnil
;
10949 Vlast_event_frame
= internal_last_event_frame
;
10951 current_kboard
= initial_kboard
;
10952 /* Re-initialize the keyboard again. */
10953 wipe_kboard (current_kboard
);
10954 /* A value of nil for Vwindow_system normally means a tty, but we also use
10955 it for the initial terminal since there is no window system there. */
10956 init_kboard (current_kboard
, Qnil
);
10958 if (!noninteractive
)
10960 /* Before multi-tty support, these handlers used to be installed
10961 only if the current session was a tty session. Now an Emacs
10962 session may have multiple display types, so we always handle
10963 SIGINT. There is special code in handle_interrupt_signal to exit
10964 Emacs on SIGINT when there are no termcap frames on the
10965 controlling terminal. */
10966 struct sigaction action
;
10967 emacs_sigaction_init (&action
, deliver_interrupt_signal
);
10968 sigaction (SIGINT
, &action
, 0);
10970 /* For systems with SysV TERMIO, C-g is set up for both SIGINT and
10971 SIGQUIT and we can't tell which one it will give us. */
10972 sigaction (SIGQUIT
, &action
, 0);
10973 #endif /* not DOS_NT */
10975 #ifdef USABLE_SIGIO
10976 if (!noninteractive
)
10978 struct sigaction action
;
10979 emacs_sigaction_init (&action
, deliver_input_available_signal
);
10980 sigaction (SIGIO
, &action
, 0);
10984 /* Use interrupt input by default, if it works and noninterrupt input
10985 has deficiencies. */
10987 #ifdef INTERRUPT_INPUT
10988 interrupt_input
= 1;
10990 interrupt_input
= 0;
10993 pthread_sigmask (SIG_SETMASK
, &empty_mask
, 0);
10996 if (keyboard_init_hook
)
10997 (*keyboard_init_hook
) ();
10999 #ifdef POLL_FOR_INPUT
11001 poll_suppress_count
= 1;
11006 /* This type's only use is in syms_of_keyboard, to put properties on the
11007 event header symbols. */
11014 static const struct event_head head_table
[] = {
11015 {SYMBOL_INDEX (Qmouse_movement
), SYMBOL_INDEX (Qmouse_movement
)},
11016 {SYMBOL_INDEX (Qscroll_bar_movement
), SYMBOL_INDEX (Qmouse_movement
)},
11018 /* Some of the event heads. */
11019 {SYMBOL_INDEX (Qswitch_frame
), SYMBOL_INDEX (Qswitch_frame
)},
11021 {SYMBOL_INDEX (Qfocus_in
), SYMBOL_INDEX (Qfocus_in
)},
11022 {SYMBOL_INDEX (Qfocus_out
), SYMBOL_INDEX (Qfocus_out
)},
11023 {SYMBOL_INDEX (Qdelete_frame
), SYMBOL_INDEX (Qdelete_frame
)},
11024 {SYMBOL_INDEX (Qiconify_frame
), SYMBOL_INDEX (Qiconify_frame
)},
11025 {SYMBOL_INDEX (Qmake_frame_visible
), SYMBOL_INDEX (Qmake_frame_visible
)},
11026 /* `select-window' should be handled just like `switch-frame'
11027 in read_key_sequence. */
11028 {SYMBOL_INDEX (Qselect_window
), SYMBOL_INDEX (Qswitch_frame
)}
11032 syms_of_keyboard (void)
11034 pending_funcalls
= Qnil
;
11035 staticpro (&pending_funcalls
);
11037 Vlispy_mouse_stem
= build_pure_c_string ("mouse");
11038 staticpro (&Vlispy_mouse_stem
);
11040 regular_top_level_message
= build_pure_c_string ("Back to top level");
11041 #ifdef HAVE_STACK_OVERFLOW_HANDLING
11042 recover_top_level_message
11043 = build_pure_c_string ("Re-entering top level after C stack overflow");
11045 DEFVAR_LISP ("internal--top-level-message", Vinternal__top_level_message
,
11046 doc
: /* Message displayed by `normal-top-level'. */);
11047 Vinternal__top_level_message
= regular_top_level_message
;
11050 DEFSYM (QCimage
, ":image");
11051 DEFSYM (Qhelp_echo
, "help-echo");
11052 DEFSYM (QCrtl
, ":rtl");
11054 staticpro (&item_properties
);
11055 item_properties
= Qnil
;
11057 staticpro (&tool_bar_item_properties
);
11058 tool_bar_item_properties
= Qnil
;
11059 staticpro (&tool_bar_items_vector
);
11060 tool_bar_items_vector
= Qnil
;
11062 DEFSYM (Qtimer_event_handler
, "timer-event-handler");
11063 DEFSYM (Qdisabled_command_function
, "disabled-command-function");
11064 DEFSYM (Qself_insert_command
, "self-insert-command");
11065 DEFSYM (Qforward_char
, "forward-char");
11066 DEFSYM (Qbackward_char
, "backward-char");
11068 /* Non-nil disable property on a command means do not execute it;
11069 call disabled-command-function's value instead. */
11070 DEFSYM (Qdisabled
, "disabled");
11072 DEFSYM (Qundefined
, "undefined");
11074 /* Hooks to run before and after each command. */
11075 DEFSYM (Qpre_command_hook
, "pre-command-hook");
11076 DEFSYM (Qpost_command_hook
, "post-command-hook");
11078 DEFSYM (Qdeferred_action_function
, "deferred-action-function");
11079 DEFSYM (Qdelayed_warnings_hook
, "delayed-warnings-hook");
11080 DEFSYM (Qfunction_key
, "function-key");
11082 /* The values of Qevent_kind properties. */
11083 DEFSYM (Qmouse_click
, "mouse-click");
11085 DEFSYM (Qdrag_n_drop
, "drag-n-drop");
11086 DEFSYM (Qsave_session
, "save-session");
11087 DEFSYM (Qconfig_changed_event
, "config-changed-event");
11089 /* Menu and tool bar item parts. */
11090 DEFSYM (Qmenu_enable
, "menu-enable");
11093 DEFSYM (Qlanguage_change
, "language-change");
11097 DEFSYM (Qdbus_event
, "dbus-event");
11100 #ifdef USE_FILE_NOTIFY
11101 DEFSYM (Qfile_notify
, "file-notify");
11102 #endif /* USE_FILE_NOTIFY */
11104 /* Menu and tool bar item parts. */
11105 DEFSYM (QCenable
, ":enable");
11106 DEFSYM (QCvisible
, ":visible");
11107 DEFSYM (QChelp
, ":help");
11108 DEFSYM (QCfilter
, ":filter");
11109 DEFSYM (QCbutton
, ":button");
11110 DEFSYM (QCkeys
, ":keys");
11111 DEFSYM (QCkey_sequence
, ":key-sequence");
11113 /* Non-nil disable property on a command means
11114 do not execute it; call disabled-command-function's value instead. */
11115 DEFSYM (QCtoggle
, ":toggle");
11116 DEFSYM (QCradio
, ":radio");
11117 DEFSYM (QClabel
, ":label");
11118 DEFSYM (QCvert_only
, ":vert-only");
11120 /* Symbols to use for parts of windows. */
11121 DEFSYM (Qvertical_line
, "vertical-line");
11122 DEFSYM (Qright_divider
, "right-divider");
11123 DEFSYM (Qbottom_divider
, "bottom-divider");
11125 DEFSYM (Qmouse_fixup_help_message
, "mouse-fixup-help-message");
11127 DEFSYM (Qabove_handle
, "above-handle");
11128 DEFSYM (Qhandle
, "handle");
11129 DEFSYM (Qbelow_handle
, "below-handle");
11130 DEFSYM (Qup
, "up");
11131 DEFSYM (Qdown
, "down");
11132 DEFSYM (Qtop
, "top");
11133 DEFSYM (Qbottom
, "bottom");
11134 DEFSYM (Qend_scroll
, "end-scroll");
11135 DEFSYM (Qratio
, "ratio");
11136 DEFSYM (Qbefore_handle
, "before-handle");
11137 DEFSYM (Qhorizontal_handle
, "horizontal-handle");
11138 DEFSYM (Qafter_handle
, "after-handle");
11139 DEFSYM (Qleft
, "left");
11140 DEFSYM (Qright
, "right");
11141 DEFSYM (Qleftmost
, "leftmost");
11142 DEFSYM (Qrightmost
, "rightmost");
11144 /* Properties of event headers. */
11145 DEFSYM (Qevent_kind
, "event-kind");
11146 DEFSYM (Qevent_symbol_elements
, "event-symbol-elements");
11148 /* An event header symbol HEAD may have a property named
11149 Qevent_symbol_element_mask, which is of the form (BASE MODIFIERS);
11150 BASE is the base, unmodified version of HEAD, and MODIFIERS is the
11151 mask of modifiers applied to it. If present, this is used to help
11152 speed up parse_modifiers. */
11153 DEFSYM (Qevent_symbol_element_mask
, "event-symbol-element-mask");
11155 /* An unmodified event header BASE may have a property named
11156 Qmodifier_cache, which is an alist mapping modifier masks onto
11157 modified versions of BASE. If present, this helps speed up
11158 apply_modifiers. */
11159 DEFSYM (Qmodifier_cache
, "modifier-cache");
11161 DEFSYM (Qrecompute_lucid_menubar
, "recompute-lucid-menubar");
11162 DEFSYM (Qactivate_menubar_hook
, "activate-menubar-hook");
11164 DEFSYM (Qpolling_period
, "polling-period");
11166 DEFSYM (Qgui_set_selection
, "gui-set-selection");
11168 /* The primary selection. */
11169 DEFSYM (QPRIMARY
, "PRIMARY");
11171 DEFSYM (Qhandle_switch_frame
, "handle-switch-frame");
11172 DEFSYM (Qhandle_select_window
, "handle-select-window");
11174 DEFSYM (Qinput_method_function
, "input-method-function");
11175 DEFSYM (Qinput_method_exit_on_first_char
, "input-method-exit-on-first-char");
11176 DEFSYM (Qinput_method_use_echo_area
, "input-method-use-echo-area");
11178 DEFSYM (Qhelp_form_show
, "help-form-show");
11180 DEFSYM (Qecho_keystrokes
, "echo-keystrokes");
11182 Fset (Qinput_method_exit_on_first_char
, Qnil
);
11183 Fset (Qinput_method_use_echo_area
, Qnil
);
11185 /* Symbols to head events. */
11186 DEFSYM (Qmouse_movement
, "mouse-movement");
11187 DEFSYM (Qscroll_bar_movement
, "scroll-bar-movement");
11188 DEFSYM (Qswitch_frame
, "switch-frame");
11189 DEFSYM (Qfocus_in
, "focus-in");
11190 DEFSYM (Qfocus_out
, "focus-out");
11191 DEFSYM (Qdelete_frame
, "delete-frame");
11192 DEFSYM (Qiconify_frame
, "iconify-frame");
11193 DEFSYM (Qmake_frame_visible
, "make-frame-visible");
11194 DEFSYM (Qselect_window
, "select-window");
11198 for (i
= 0; i
< ARRAYELTS (head_table
); i
++)
11200 const struct event_head
*p
= &head_table
[i
];
11201 Lisp_Object var
= builtin_lisp_symbol (p
->var
);
11202 Lisp_Object kind
= builtin_lisp_symbol (p
->kind
);
11203 Fput (var
, Qevent_kind
, kind
);
11204 Fput (var
, Qevent_symbol_elements
, list1 (var
));
11208 button_down_location
= Fmake_vector (make_number (5), Qnil
);
11209 staticpro (&button_down_location
);
11210 mouse_syms
= Fmake_vector (make_number (5), Qnil
);
11211 staticpro (&mouse_syms
);
11212 wheel_syms
= Fmake_vector (make_number (ARRAYELTS (lispy_wheel_names
)),
11214 staticpro (&wheel_syms
);
11218 int len
= ARRAYELTS (modifier_names
);
11220 modifier_symbols
= Fmake_vector (make_number (len
), Qnil
);
11221 for (i
= 0; i
< len
; i
++)
11222 if (modifier_names
[i
])
11223 ASET (modifier_symbols
, i
, intern_c_string (modifier_names
[i
]));
11224 staticpro (&modifier_symbols
);
11227 recent_keys
= Fmake_vector (make_number (NUM_RECENT_KEYS
), Qnil
);
11228 staticpro (&recent_keys
);
11230 this_command_keys
= Fmake_vector (make_number (40), Qnil
);
11231 staticpro (&this_command_keys
);
11233 raw_keybuf
= Fmake_vector (make_number (30), Qnil
);
11234 staticpro (&raw_keybuf
);
11236 DEFSYM (Qcommand_execute
, "command-execute");
11238 accent_key_syms
= Qnil
;
11239 staticpro (&accent_key_syms
);
11241 func_key_syms
= Qnil
;
11242 staticpro (&func_key_syms
);
11244 drag_n_drop_syms
= Qnil
;
11245 staticpro (&drag_n_drop_syms
);
11247 unread_switch_frame
= Qnil
;
11248 staticpro (&unread_switch_frame
);
11250 internal_last_event_frame
= Qnil
;
11251 staticpro (&internal_last_event_frame
);
11253 read_key_sequence_cmd
= Qnil
;
11254 staticpro (&read_key_sequence_cmd
);
11255 read_key_sequence_remapped
= Qnil
;
11256 staticpro (&read_key_sequence_remapped
);
11258 menu_bar_one_keymap_changed_items
= Qnil
;
11259 staticpro (&menu_bar_one_keymap_changed_items
);
11261 menu_bar_items_vector
= Qnil
;
11262 staticpro (&menu_bar_items_vector
);
11264 help_form_saved_window_configs
= Qnil
;
11265 staticpro (&help_form_saved_window_configs
);
11267 defsubr (&Scurrent_idle_time
);
11268 defsubr (&Sevent_symbol_parse_modifiers
);
11269 defsubr (&Sevent_convert_list
);
11270 defsubr (&Sread_key_sequence
);
11271 defsubr (&Sread_key_sequence_vector
);
11272 defsubr (&Srecursive_edit
);
11273 defsubr (&Strack_mouse
);
11274 defsubr (&Sinput_pending_p
);
11275 defsubr (&Srecent_keys
);
11276 defsubr (&Sthis_command_keys
);
11277 defsubr (&Sthis_command_keys_vector
);
11278 defsubr (&Sthis_single_command_keys
);
11279 defsubr (&Sthis_single_command_raw_keys
);
11280 defsubr (&Sreset_this_command_lengths
);
11281 defsubr (&Sclear_this_command_keys
);
11282 defsubr (&Ssuspend_emacs
);
11283 defsubr (&Sabort_recursive_edit
);
11284 defsubr (&Sexit_recursive_edit
);
11285 defsubr (&Srecursion_depth
);
11286 defsubr (&Scommand_error_default_function
);
11287 defsubr (&Stop_level
);
11288 defsubr (&Sdiscard_input
);
11289 defsubr (&Sopen_dribble_file
);
11290 defsubr (&Sset_input_interrupt_mode
);
11291 defsubr (&Sset_output_flow_control
);
11292 defsubr (&Sset_input_meta_mode
);
11293 defsubr (&Sset_quit_char
);
11294 defsubr (&Sset_input_mode
);
11295 defsubr (&Scurrent_input_mode
);
11296 defsubr (&Sposn_at_point
);
11297 defsubr (&Sposn_at_x_y
);
11299 DEFVAR_LISP ("last-command-event", last_command_event
,
11300 doc
: /* Last input event that was part of a command. */);
11302 DEFVAR_LISP ("last-nonmenu-event", last_nonmenu_event
,
11303 doc
: /* Last input event in a command, except for mouse menu events.
11304 Mouse menus give back keys that don't look like mouse events;
11305 this variable holds the actual mouse event that led to the menu,
11306 so that you can determine whether the command was run by mouse or not. */);
11308 DEFVAR_LISP ("last-input-event", last_input_event
,
11309 doc
: /* Last input event. */);
11311 DEFVAR_LISP ("unread-command-events", Vunread_command_events
,
11312 doc
: /* List of events to be read as the command input.
11313 These events are processed first, before actual keyboard input.
11314 Events read from this list are not normally added to `this-command-keys',
11315 as they will already have been added once as they were read for the first time.
11316 An element of the form (t . EVENT) forces EVENT to be added to that list. */);
11317 Vunread_command_events
= Qnil
;
11319 DEFVAR_LISP ("unread-post-input-method-events", Vunread_post_input_method_events
,
11320 doc
: /* List of events to be processed as input by input methods.
11321 These events are processed before `unread-command-events'
11322 and actual keyboard input, but are not given to `input-method-function'. */);
11323 Vunread_post_input_method_events
= Qnil
;
11325 DEFVAR_LISP ("unread-input-method-events", Vunread_input_method_events
,
11326 doc
: /* List of events to be processed as input by input methods.
11327 These events are processed after `unread-command-events', but
11328 before actual keyboard input.
11329 If there's an active input method, the events are given to
11330 `input-method-function'. */);
11331 Vunread_input_method_events
= Qnil
;
11333 DEFVAR_LISP ("meta-prefix-char", meta_prefix_char
,
11334 doc
: /* Meta-prefix character code.
11335 Meta-foo as command input turns into this character followed by foo. */);
11336 XSETINT (meta_prefix_char
, 033);
11338 DEFVAR_KBOARD ("last-command", Vlast_command
,
11339 doc
: /* The last command executed.
11340 Normally a symbol with a function definition, but can be whatever was found
11341 in the keymap, or whatever the variable `this-command' was set to by that
11344 The value `mode-exit' is special; it means that the previous command
11345 read an event that told it to exit, and it did so and unread that event.
11346 In other words, the present command is the event that made the previous
11349 The value `kill-region' is special; it means that the previous command
11350 was a kill command.
11352 `last-command' has a separate binding for each terminal device.
11353 See Info node `(elisp)Multiple Terminals'. */);
11355 DEFVAR_KBOARD ("real-last-command", Vreal_last_command
,
11356 doc
: /* Same as `last-command', but never altered by Lisp code.
11357 Taken from the previous value of `real-this-command'. */);
11359 DEFVAR_KBOARD ("last-repeatable-command", Vlast_repeatable_command
,
11360 doc
: /* Last command that may be repeated.
11361 The last command executed that was not bound to an input event.
11362 This is the command `repeat' will try to repeat.
11363 Taken from a previous value of `real-this-command'. */);
11365 DEFVAR_LISP ("this-command", Vthis_command
,
11366 doc
: /* The command now being executed.
11367 The command can set this variable; whatever is put here
11368 will be in `last-command' during the following command. */);
11369 Vthis_command
= Qnil
;
11371 DEFVAR_LISP ("real-this-command", Vreal_this_command
,
11372 doc
: /* This is like `this-command', except that commands should never modify it. */);
11373 Vreal_this_command
= Qnil
;
11375 DEFVAR_LISP ("this-command-keys-shift-translated",
11376 Vthis_command_keys_shift_translated
,
11377 doc
: /* Non-nil if the key sequence activating this command was shift-translated.
11378 Shift-translation occurs when there is no binding for the key sequence
11379 as entered, but a binding was found by changing an upper-case letter
11380 to lower-case, or a shifted function key to an unshifted one. */);
11381 Vthis_command_keys_shift_translated
= Qnil
;
11383 DEFVAR_LISP ("this-original-command", Vthis_original_command
,
11384 doc
: /* The command bound to the current key sequence before remapping.
11385 It equals `this-command' if the original command was not remapped through
11386 any of the active keymaps. Otherwise, the value of `this-command' is the
11387 result of looking up the original command in the active keymaps. */);
11388 Vthis_original_command
= Qnil
;
11390 DEFVAR_INT ("auto-save-interval", auto_save_interval
,
11391 doc
: /* Number of input events between auto-saves.
11392 Zero means disable autosaving due to number of characters typed. */);
11393 auto_save_interval
= 300;
11395 DEFVAR_LISP ("auto-save-timeout", Vauto_save_timeout
,
11396 doc
: /* Number of seconds idle time before auto-save.
11397 Zero or nil means disable auto-saving due to idleness.
11398 After auto-saving due to this many seconds of idle time,
11399 Emacs also does a garbage collection if that seems to be warranted. */);
11400 XSETFASTINT (Vauto_save_timeout
, 30);
11402 DEFVAR_LISP ("echo-keystrokes", Vecho_keystrokes
,
11403 doc
: /* Nonzero means echo unfinished commands after this many seconds of pause.
11404 The value may be integer or floating point.
11405 If the value is zero, don't echo at all. */);
11406 Vecho_keystrokes
= make_number (1);
11408 DEFVAR_INT ("polling-period", polling_period
,
11409 doc
: /* Interval between polling for input during Lisp execution.
11410 The reason for polling is to make C-g work to stop a running program.
11411 Polling is needed only when using X windows and SIGIO does not work.
11412 Polling is automatically disabled in all other cases. */);
11413 polling_period
= 2;
11415 DEFVAR_LISP ("double-click-time", Vdouble_click_time
,
11416 doc
: /* Maximum time between mouse clicks to make a double-click.
11417 Measured in milliseconds. The value nil means disable double-click
11418 recognition; t means double-clicks have no time limit and are detected
11419 by position only. */);
11420 Vdouble_click_time
= make_number (500);
11422 DEFVAR_INT ("double-click-fuzz", double_click_fuzz
,
11423 doc
: /* Maximum mouse movement between clicks to make a double-click.
11424 On window-system frames, value is the number of pixels the mouse may have
11425 moved horizontally or vertically between two clicks to make a double-click.
11426 On non window-system frames, value is interpreted in units of 1/8 characters
11429 This variable is also the threshold for motion of the mouse
11430 to count as a drag. */);
11431 double_click_fuzz
= 3;
11433 DEFVAR_INT ("num-input-keys", num_input_keys
,
11434 doc
: /* Number of complete key sequences read as input so far.
11435 This includes key sequences read from keyboard macros.
11436 The number is effectively the number of interactive command invocations. */);
11437 num_input_keys
= 0;
11439 DEFVAR_INT ("num-nonmacro-input-events", num_nonmacro_input_events
,
11440 doc
: /* Number of input events read from the keyboard so far.
11441 This does not include events generated by keyboard macros. */);
11442 num_nonmacro_input_events
= 0;
11444 DEFVAR_LISP ("last-event-frame", Vlast_event_frame
,
11445 doc
: /* The frame in which the most recently read event occurred.
11446 If the last event came from a keyboard macro, this is set to `macro'. */);
11447 Vlast_event_frame
= Qnil
;
11449 /* This variable is set up in sysdep.c. */
11450 DEFVAR_LISP ("tty-erase-char", Vtty_erase_char
,
11451 doc
: /* The ERASE character as set by the user with stty. */);
11453 DEFVAR_LISP ("help-char", Vhelp_char
,
11454 doc
: /* Character to recognize as meaning Help.
11455 When it is read, do `(eval help-form)', and display result if it's a string.
11456 If the value of `help-form' is nil, this char can be read normally. */);
11457 XSETINT (Vhelp_char
, Ctl ('H'));
11459 DEFVAR_LISP ("help-event-list", Vhelp_event_list
,
11460 doc
: /* List of input events to recognize as meaning Help.
11461 These work just like the value of `help-char' (see that). */);
11462 Vhelp_event_list
= Qnil
;
11464 DEFVAR_LISP ("help-form", Vhelp_form
,
11465 doc
: /* Form to execute when character `help-char' is read.
11466 If the form returns a string, that string is displayed.
11467 If `help-form' is nil, the help char is not recognized. */);
11470 DEFVAR_LISP ("prefix-help-command", Vprefix_help_command
,
11471 doc
: /* Command to run when `help-char' character follows a prefix key.
11472 This command is used only when there is no actual binding
11473 for that character after that prefix key. */);
11474 Vprefix_help_command
= Qnil
;
11476 DEFVAR_LISP ("top-level", Vtop_level
,
11477 doc
: /* Form to evaluate when Emacs starts up.
11478 Useful to set before you dump a modified Emacs. */);
11481 DEFVAR_KBOARD ("keyboard-translate-table", Vkeyboard_translate_table
,
11482 doc
: /* Translate table for local keyboard input, or nil.
11483 If non-nil, the value should be a char-table. Each character read
11484 from the keyboard is looked up in this char-table. If the value found
11485 there is non-nil, then it is used instead of the actual input character.
11487 The value can also be a string or vector, but this is considered obsolete.
11488 If it is a string or vector of length N, character codes N and up are left
11489 untranslated. In a vector, an element which is nil means "no translation".
11491 This is applied to the characters supplied to input methods, not their
11492 output. See also `translation-table-for-input'.
11494 This variable has a separate binding for each terminal.
11495 See Info node `(elisp)Multiple Terminals'. */);
11497 DEFVAR_BOOL ("cannot-suspend", cannot_suspend
,
11498 doc
: /* Non-nil means to always spawn a subshell instead of suspending.
11499 \(Even if the operating system has support for stopping a process.\) */);
11500 cannot_suspend
= 0;
11502 DEFVAR_BOOL ("menu-prompting", menu_prompting
,
11503 doc
: /* Non-nil means prompt with menus when appropriate.
11504 This is done when reading from a keymap that has a prompt string,
11505 for elements that have prompt strings.
11506 The menu is displayed on the screen
11507 if X menus were enabled at configuration
11508 time and the previous event was a mouse click prefix key.
11509 Otherwise, menu prompting uses the echo area. */);
11510 menu_prompting
= 1;
11512 DEFVAR_LISP ("menu-prompt-more-char", menu_prompt_more_char
,
11513 doc
: /* Character to see next line of menu prompt.
11514 Type this character while in a menu prompt to rotate around the lines of it. */);
11515 XSETINT (menu_prompt_more_char
, ' ');
11517 DEFVAR_INT ("extra-keyboard-modifiers", extra_keyboard_modifiers
,
11518 doc
: /* A mask of additional modifier keys to use with every keyboard character.
11519 Emacs applies the modifiers of the character stored here to each keyboard
11520 character it reads. For example, after evaluating the expression
11521 (setq extra-keyboard-modifiers ?\\C-x)
11522 all input characters will have the control modifier applied to them.
11524 Note that the character ?\\C-@, equivalent to the integer zero, does
11525 not count as a control character; rather, it counts as a character
11526 with no modifiers; thus, setting `extra-keyboard-modifiers' to zero
11527 cancels any modification. */);
11528 extra_keyboard_modifiers
= 0;
11530 DEFSYM (Qdeactivate_mark
, "deactivate-mark");
11531 DEFVAR_LISP ("deactivate-mark", Vdeactivate_mark
,
11532 doc
: /* If an editing command sets this to t, deactivate the mark afterward.
11533 The command loop sets this to nil before each command,
11534 and tests the value when the command returns.
11535 Buffer modification stores t in this variable. */);
11536 Vdeactivate_mark
= Qnil
;
11537 Fmake_variable_buffer_local (Qdeactivate_mark
);
11539 DEFVAR_LISP ("pre-command-hook", Vpre_command_hook
,
11540 doc
: /* Normal hook run before each command is executed.
11541 If an unhandled error happens in running this hook,
11542 the function in which the error occurred is unconditionally removed, since
11543 otherwise the error might happen repeatedly and make Emacs nonfunctional. */);
11544 Vpre_command_hook
= Qnil
;
11546 DEFVAR_LISP ("post-command-hook", Vpost_command_hook
,
11547 doc
: /* Normal hook run after each command is executed.
11548 If an unhandled error happens in running this hook,
11549 the function in which the error occurred is unconditionally removed, since
11550 otherwise the error might happen repeatedly and make Emacs nonfunctional. */);
11551 Vpost_command_hook
= Qnil
;
11554 DEFVAR_LISP ("echo-area-clear-hook", ...,
11555 doc
: /* Normal hook run when clearing the echo area. */);
11557 DEFSYM (Qecho_area_clear_hook
, "echo-area-clear-hook");
11558 Fset (Qecho_area_clear_hook
, Qnil
);
11560 DEFVAR_LISP ("lucid-menu-bar-dirty-flag", Vlucid_menu_bar_dirty_flag
,
11561 doc
: /* Non-nil means menu bar, specified Lucid style, needs to be recomputed. */);
11562 Vlucid_menu_bar_dirty_flag
= Qnil
;
11564 DEFVAR_LISP ("menu-bar-final-items", Vmenu_bar_final_items
,
11565 doc
: /* List of menu bar items to move to the end of the menu bar.
11566 The elements of the list are event types that may have menu bar bindings. */);
11567 Vmenu_bar_final_items
= Qnil
;
11569 DEFVAR_LISP ("tool-bar-separator-image-expression", Vtool_bar_separator_image_expression
,
11570 doc
: /* Expression evaluating to the image spec for a tool-bar separator.
11571 This is used internally by graphical displays that do not render
11572 tool-bar separators natively. Otherwise it is unused (e.g. on GTK). */);
11573 Vtool_bar_separator_image_expression
= Qnil
;
11575 DEFVAR_KBOARD ("overriding-terminal-local-map",
11576 Voverriding_terminal_local_map
,
11577 doc
: /* Per-terminal keymap that takes precedence over all other keymaps.
11578 This variable is intended to let commands such as `universal-argument'
11579 set up a different keymap for reading the next command.
11581 `overriding-terminal-local-map' has a separate binding for each
11582 terminal device. See Info node `(elisp)Multiple Terminals'. */);
11584 DEFVAR_LISP ("overriding-local-map", Voverriding_local_map
,
11585 doc
: /* Keymap that replaces (overrides) local keymaps.
11586 If this variable is non-nil, Emacs looks up key bindings in this
11587 keymap INSTEAD OF the keymap char property, minor mode maps, and the
11588 buffer's local map. Hence, the only active keymaps would be
11589 `overriding-terminal-local-map', this keymap, and `global-keymap', in
11590 order of precedence. */);
11591 Voverriding_local_map
= Qnil
;
11593 DEFVAR_LISP ("overriding-local-map-menu-flag", Voverriding_local_map_menu_flag
,
11594 doc
: /* Non-nil means `overriding-local-map' applies to the menu bar.
11595 Otherwise, the menu bar continues to reflect the buffer's local map
11596 and the minor mode maps regardless of `overriding-local-map'. */);
11597 Voverriding_local_map_menu_flag
= Qnil
;
11599 DEFVAR_LISP ("special-event-map", Vspecial_event_map
,
11600 doc
: /* Keymap defining bindings for special events to execute at low level. */);
11601 Vspecial_event_map
= list1 (Qkeymap
);
11603 DEFVAR_LISP ("track-mouse", do_mouse_tracking
,
11604 doc
: /* Non-nil means generate motion events for mouse motion. */);
11606 DEFVAR_KBOARD ("system-key-alist", Vsystem_key_alist
,
11607 doc
: /* Alist of system-specific X windows key symbols.
11608 Each element should have the form (N . SYMBOL) where N is the
11609 numeric keysym code (sans the \"system-specific\" bit 1<<28)
11610 and SYMBOL is its name.
11612 `system-key-alist' has a separate binding for each terminal device.
11613 See Info node `(elisp)Multiple Terminals'. */);
11615 DEFVAR_KBOARD ("local-function-key-map", Vlocal_function_key_map
,
11616 doc
: /* Keymap that translates key sequences to key sequences during input.
11617 This is used mainly for mapping key sequences into some preferred
11618 key events (symbols).
11620 The `read-key-sequence' function replaces any subsequence bound by
11621 `local-function-key-map' with its binding. More precisely, when the
11622 active keymaps have no binding for the current key sequence but
11623 `local-function-key-map' binds a suffix of the sequence to a vector or
11624 string, `read-key-sequence' replaces the matching suffix with its
11625 binding, and continues with the new sequence.
11627 If the binding is a function, it is called with one argument (the prompt)
11628 and its return value (a key sequence) is used.
11630 The events that come from bindings in `local-function-key-map' are not
11631 themselves looked up in `local-function-key-map'.
11633 For example, suppose `local-function-key-map' binds `ESC O P' to [f1].
11634 Typing `ESC O P' to `read-key-sequence' would return [f1]. Typing
11635 `C-x ESC O P' would return [?\\C-x f1]. If [f1] were a prefix key,
11636 typing `ESC O P x' would return [f1 x].
11638 `local-function-key-map' has a separate binding for each terminal
11639 device. See Info node `(elisp)Multiple Terminals'. If you need to
11640 define a binding on all terminals, change `function-key-map'
11641 instead. Initially, `local-function-key-map' is an empty keymap that
11642 has `function-key-map' as its parent on all terminal devices. */);
11644 DEFVAR_KBOARD ("input-decode-map", Vinput_decode_map
,
11645 doc
: /* Keymap that decodes input escape sequences.
11646 This is used mainly for mapping ASCII function key sequences into
11647 real Emacs function key events (symbols).
11649 The `read-key-sequence' function replaces any subsequence bound by
11650 `input-decode-map' with its binding. Contrary to `function-key-map',
11651 this map applies its rebinding regardless of the presence of an ordinary
11652 binding. So it is more like `key-translation-map' except that it applies
11653 before `function-key-map' rather than after.
11655 If the binding is a function, it is called with one argument (the prompt)
11656 and its return value (a key sequence) is used.
11658 The events that come from bindings in `input-decode-map' are not
11659 themselves looked up in `input-decode-map'. */);
11661 DEFVAR_LISP ("function-key-map", Vfunction_key_map
,
11662 doc
: /* The parent keymap of all `local-function-key-map' instances.
11663 Function key definitions that apply to all terminal devices should go
11664 here. If a mapping is defined in both the current
11665 `local-function-key-map' binding and this variable, then the local
11666 definition will take precedence. */);
11667 Vfunction_key_map
= Fmake_sparse_keymap (Qnil
);
11669 DEFVAR_LISP ("key-translation-map", Vkey_translation_map
,
11670 doc
: /* Keymap of key translations that can override keymaps.
11671 This keymap works like `input-decode-map', but comes after `function-key-map'.
11672 Another difference is that it is global rather than terminal-local. */);
11673 Vkey_translation_map
= Fmake_sparse_keymap (Qnil
);
11675 DEFVAR_LISP ("deferred-action-list", Vdeferred_action_list
,
11676 doc
: /* List of deferred actions to be performed at a later time.
11677 The precise format isn't relevant here; we just check whether it is nil. */);
11678 Vdeferred_action_list
= Qnil
;
11680 DEFVAR_LISP ("deferred-action-function", Vdeferred_action_function
,
11681 doc
: /* Function to call to handle deferred actions, after each command.
11682 This function is called with no arguments after each command
11683 whenever `deferred-action-list' is non-nil. */);
11684 Vdeferred_action_function
= Qnil
;
11686 DEFVAR_LISP ("delayed-warnings-list", Vdelayed_warnings_list
,
11687 doc
: /* List of warnings to be displayed after this command.
11688 Each element must be a list (TYPE MESSAGE [LEVEL [BUFFER-NAME]]),
11689 as per the args of `display-warning' (which see).
11690 If this variable is non-nil, `delayed-warnings-hook' will be run
11691 immediately after running `post-command-hook'. */);
11692 Vdelayed_warnings_list
= Qnil
;
11694 DEFVAR_LISP ("timer-list", Vtimer_list
,
11695 doc
: /* List of active absolute time timers in order of increasing time. */);
11696 Vtimer_list
= Qnil
;
11698 DEFVAR_LISP ("timer-idle-list", Vtimer_idle_list
,
11699 doc
: /* List of active idle-time timers in order of increasing time. */);
11700 Vtimer_idle_list
= Qnil
;
11702 DEFVAR_LISP ("input-method-function", Vinput_method_function
,
11703 doc
: /* If non-nil, the function that implements the current input method.
11704 It's called with one argument, a printing character that was just read.
11705 \(That means a character with code 040...0176.)
11706 Typically this function uses `read-event' to read additional events.
11707 When it does so, it should first bind `input-method-function' to nil
11708 so it will not be called recursively.
11710 The function should return a list of zero or more events
11711 to be used as input. If it wants to put back some events
11712 to be reconsidered, separately, by the input method,
11713 it can add them to the beginning of `unread-command-events'.
11715 The input method function can find in `input-method-previous-message'
11716 the previous echo area message.
11718 The input method function should refer to the variables
11719 `input-method-use-echo-area' and `input-method-exit-on-first-char'
11720 for guidance on what to do. */);
11721 Vinput_method_function
= Qlist
;
11723 DEFVAR_LISP ("input-method-previous-message",
11724 Vinput_method_previous_message
,
11725 doc
: /* When `input-method-function' is called, hold the previous echo area message.
11726 This variable exists because `read-event' clears the echo area
11727 before running the input method. It is nil if there was no message. */);
11728 Vinput_method_previous_message
= Qnil
;
11730 DEFVAR_LISP ("show-help-function", Vshow_help_function
,
11731 doc
: /* If non-nil, the function that implements the display of help.
11732 It's called with one argument, the help string to display. */);
11733 Vshow_help_function
= Qnil
;
11735 DEFVAR_LISP ("disable-point-adjustment", Vdisable_point_adjustment
,
11736 doc
: /* If non-nil, suppress point adjustment after executing a command.
11738 After a command is executed, if point is moved into a region that has
11739 special properties (e.g. composition, display), we adjust point to
11740 the boundary of the region. But, when a command sets this variable to
11741 non-nil, we suppress the point adjustment.
11743 This variable is set to nil before reading a command, and is checked
11744 just after executing the command. */);
11745 Vdisable_point_adjustment
= Qnil
;
11747 DEFVAR_LISP ("global-disable-point-adjustment",
11748 Vglobal_disable_point_adjustment
,
11749 doc
: /* If non-nil, always suppress point adjustment.
11751 The default value is nil, in which case, point adjustment are
11752 suppressed only after special commands that set
11753 `disable-point-adjustment' (which see) to non-nil. */);
11754 Vglobal_disable_point_adjustment
= Qnil
;
11756 DEFVAR_LISP ("minibuffer-message-timeout", Vminibuffer_message_timeout
,
11757 doc
: /* How long to display an echo-area message when the minibuffer is active.
11758 If the value is not a number, such messages don't time out. */);
11759 Vminibuffer_message_timeout
= make_number (2);
11761 DEFVAR_LISP ("throw-on-input", Vthrow_on_input
,
11762 doc
: /* If non-nil, any keyboard input throws to this symbol.
11763 The value of that variable is passed to `quit-flag' and later causes a
11764 peculiar kind of quitting. */);
11765 Vthrow_on_input
= Qnil
;
11767 DEFVAR_LISP ("command-error-function", Vcommand_error_function
,
11768 doc
: /* Function to output error messages.
11769 Called with three arguments:
11770 - the error data, a list of the form (SIGNALED-CONDITION . SIGNAL-DATA)
11771 such as what `condition-case' would bind its variable to,
11772 - the context (a string which normally goes at the start of the message),
11773 - the Lisp function within which the error was signaled. */);
11774 Vcommand_error_function
= intern ("command-error-default-function");
11776 DEFVAR_LISP ("enable-disabled-menus-and-buttons",
11777 Venable_disabled_menus_and_buttons
,
11778 doc
: /* If non-nil, don't ignore events produced by disabled menu items and tool-bar.
11780 Help functions bind this to allow help on disabled menu items
11781 and tool-bar buttons. */);
11782 Venable_disabled_menus_and_buttons
= Qnil
;
11784 DEFVAR_LISP ("select-active-regions",
11785 Vselect_active_regions
,
11786 doc
: /* If non-nil, an active region automatically sets the primary selection.
11787 If the value is `only', only temporarily active regions (usually made
11788 by mouse-dragging or shift-selection) set the window selection.
11790 This takes effect only when Transient Mark mode is enabled. */);
11791 Vselect_active_regions
= Qt
;
11793 DEFVAR_LISP ("saved-region-selection",
11794 Vsaved_region_selection
,
11795 doc
: /* Contents of active region prior to buffer modification.
11796 If `select-active-regions' is non-nil, Emacs sets this to the
11797 text in the region before modifying the buffer. The next call to
11798 the function `deactivate-mark' uses this to set the window selection. */);
11799 Vsaved_region_selection
= Qnil
;
11801 DEFVAR_LISP ("selection-inhibit-update-commands",
11802 Vselection_inhibit_update_commands
,
11803 doc
: /* List of commands which should not update the selection.
11804 Normally, if `select-active-regions' is non-nil and the mark remains
11805 active after a command (i.e. the mark was not deactivated), the Emacs
11806 command loop sets the selection to the text in the region. However,
11807 if the command is in this list, the selection is not updated. */);
11808 Vselection_inhibit_update_commands
11809 = list2 (Qhandle_switch_frame
, Qhandle_select_window
);
11811 DEFVAR_LISP ("debug-on-event",
11813 doc
: /* Enter debugger on this event. When Emacs
11814 receives the special event specified by this variable, it will try to
11815 break into the debugger as soon as possible instead of processing the
11816 event normally through `special-event-map'.
11818 Currently, the only supported values for this
11819 variable are `sigusr1' and `sigusr2'. */);
11820 Vdebug_on_event
= intern_c_string ("sigusr2");
11822 /* Create the initial keyboard. Qt means 'unset'. */
11823 initial_kboard
= allocate_kboard (Qt
);
11827 keys_of_keyboard (void)
11829 initial_define_key (global_map
, Ctl ('Z'), "suspend-emacs");
11830 initial_define_key (control_x_map
, Ctl ('Z'), "suspend-emacs");
11831 initial_define_key (meta_map
, Ctl ('C'), "exit-recursive-edit");
11832 initial_define_key (global_map
, Ctl (']'), "abort-recursive-edit");
11833 initial_define_key (meta_map
, 'x', "execute-extended-command");
11835 initial_define_lispy_key (Vspecial_event_map
, "delete-frame",
11836 "handle-delete-frame");
11837 initial_define_lispy_key (Vspecial_event_map
, "ns-put-working-text",
11838 "ns-put-working-text");
11839 initial_define_lispy_key (Vspecial_event_map
, "ns-unput-working-text",
11840 "ns-unput-working-text");
11841 /* Here we used to use `ignore-event' which would simple set prefix-arg to
11842 current-prefix-arg, as is done in `handle-switch-frame'.
11843 But `handle-switch-frame is not run from the special-map.
11844 Commands from that map are run in a special way that automatically
11845 preserves the prefix-arg. Restoring the prefix arg here is not just
11846 redundant but harmful:
11848 - current-prefix-arg is set to non-nil, prefix-arg is set to nil.
11849 - after the first prompt, the exit-minibuffer-hook is run which may
11850 iconify a frame and thus push a `iconify-frame' event.
11851 - after running exit-minibuffer-hook, current-prefix-arg is
11852 restored to the non-nil value it had before the prompt.
11853 - we enter the second prompt.
11854 current-prefix-arg is non-nil, prefix-arg is nil.
11855 - before running the first real event, we run the special iconify-frame
11856 event, but we pass the `special' arg to command-execute so
11857 current-prefix-arg and prefix-arg are left untouched.
11858 - here we foolishly copy the non-nil current-prefix-arg to prefix-arg.
11859 - the next key event will have a spuriously non-nil current-prefix-arg. */
11860 initial_define_lispy_key (Vspecial_event_map
, "iconify-frame",
11862 initial_define_lispy_key (Vspecial_event_map
, "make-frame-visible",
11864 /* Handling it at such a low-level causes read_key_sequence to get
11865 * confused because it doesn't realize that the current_buffer was
11866 * changed by read_char.
11868 * initial_define_lispy_key (Vspecial_event_map, "select-window",
11869 * "handle-select-window"); */
11870 initial_define_lispy_key (Vspecial_event_map
, "save-session",
11871 "handle-save-session");
11874 /* Define a special event which is raised for dbus callback
11876 initial_define_lispy_key (Vspecial_event_map
, "dbus-event",
11877 "dbus-handle-event");
11880 #ifdef USE_FILE_NOTIFY
11881 /* Define a special event which is raised for notification callback
11883 initial_define_lispy_key (Vspecial_event_map
, "file-notify",
11884 "file-notify-handle-event");
11885 #endif /* USE_FILE_NOTIFY */
11887 initial_define_lispy_key (Vspecial_event_map
, "config-changed-event",
11889 #if defined (WINDOWSNT)
11890 initial_define_lispy_key (Vspecial_event_map
, "language-change",
11893 initial_define_lispy_key (Vspecial_event_map
, "focus-in",
11894 "handle-focus-in");
11895 initial_define_lispy_key (Vspecial_event_map
, "focus-out",
11896 "handle-focus-out");
11899 /* Mark the pointers in the kboard objects.
11900 Called by Fgarbage_collect. */
11902 mark_kboards (void)
11906 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
11908 if (kb
->kbd_macro_buffer
)
11909 for (p
= kb
->kbd_macro_buffer
; p
< kb
->kbd_macro_ptr
; p
++)
11911 mark_object (KVAR (kb
, Voverriding_terminal_local_map
));
11912 mark_object (KVAR (kb
, Vlast_command
));
11913 mark_object (KVAR (kb
, Vreal_last_command
));
11914 mark_object (KVAR (kb
, Vkeyboard_translate_table
));
11915 mark_object (KVAR (kb
, Vlast_repeatable_command
));
11916 mark_object (KVAR (kb
, Vprefix_arg
));
11917 mark_object (KVAR (kb
, Vlast_prefix_arg
));
11918 mark_object (KVAR (kb
, kbd_queue
));
11919 mark_object (KVAR (kb
, defining_kbd_macro
));
11920 mark_object (KVAR (kb
, Vlast_kbd_macro
));
11921 mark_object (KVAR (kb
, Vsystem_key_alist
));
11922 mark_object (KVAR (kb
, system_key_syms
));
11923 mark_object (KVAR (kb
, Vwindow_system
));
11924 mark_object (KVAR (kb
, Vinput_decode_map
));
11925 mark_object (KVAR (kb
, Vlocal_function_key_map
));
11926 mark_object (KVAR (kb
, Vdefault_minibuffer_frame
));
11927 mark_object (KVAR (kb
, echo_string
));
11930 struct input_event
*event
;
11931 for (event
= kbd_fetch_ptr
; event
!= kbd_store_ptr
; event
++)
11933 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
11934 event
= kbd_buffer
;
11935 /* These two special event types has no Lisp_Objects to mark. */
11936 if (event
->kind
!= SELECTION_REQUEST_EVENT
11937 && event
->kind
!= SELECTION_CLEAR_EVENT
)
11939 mark_object (event
->x
);
11940 mark_object (event
->y
);
11941 mark_object (event
->frame_or_window
);
11942 mark_object (event
->arg
);