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
);
2291 unsigned char src
[MAX_ENCODED_BYTES
];
2292 unsigned char dest
[MAX_ENCODED_BYTES
* MAX_MULTIBYTE_LENGTH
];
2294 for (i
= 0; i
< n
; i
++)
2295 src
[i
] = XINT (events
[i
]);
2297 for (i
= 0; i
< n
; i
++)
2299 coding
->destination
= dest
;
2300 coding
->dst_bytes
= sizeof dest
;
2301 decode_coding_c_string (coding
, src
, n
, Qnil
);
2302 eassert (coding
->produced_char
<= n
);
2303 if (coding
->produced_char
== 0)
2304 { /* The encoded sequence is incomplete. */
2305 if (n
< MAX_ENCODED_BYTES
) /* Avoid buffer overflow. */
2306 continue; /* Read on! */
2310 const unsigned char *p
= coding
->destination
;
2311 eassert (coding
->carryover_bytes
== 0);
2313 while (n
< coding
->produced_char
)
2314 events
[n
++] = make_number (STRING_CHAR_ADVANCE (p
));
2317 /* Now `events' should hold decoded events.
2318 Normally, n should be equal to 1, but better not rely on it.
2319 We can only return one event here, so return the first we
2320 had and keep the others (if any) for later. */
2322 Vunread_command_events
2323 = Fcons (events
[--n
], Vunread_command_events
);
2331 echo_keystrokes_p (void)
2333 return (FLOATP (Vecho_keystrokes
) ? XFLOAT_DATA (Vecho_keystrokes
) > 0.0
2334 : INTEGERP (Vecho_keystrokes
) ? XINT (Vecho_keystrokes
) > 0 : false);
2337 /* Read a character from the keyboard; call the redisplay if needed. */
2338 /* commandflag 0 means do not autosave, but do redisplay.
2339 -1 means do not redisplay, but do autosave.
2340 -2 means do neither.
2343 The argument MAP is a keymap for menu prompting.
2345 PREV_EVENT is the previous input event, or nil if we are reading
2346 the first event of a key sequence (or not reading a key sequence).
2347 If PREV_EVENT is t, that is a "magic" value that says
2348 not to run input methods, but in other respects to act as if
2349 not reading a key sequence.
2351 If USED_MOUSE_MENU is non-null, then set *USED_MOUSE_MENU to true
2352 if we used a mouse menu to read the input, or false otherwise. If
2353 USED_MOUSE_MENU is null, don't dereference it.
2355 Value is -2 when we find input on another keyboard. A second call
2356 to read_char will read it.
2358 If END_TIME is non-null, it is a pointer to a struct timespec
2359 specifying the maximum time to wait until. If no input arrives by
2360 that time, stop waiting and return nil.
2362 Value is t if we showed a menu and the user rejected it. */
2365 read_char (int commandflag
, Lisp_Object map
,
2366 Lisp_Object prev_event
,
2367 bool *used_mouse_menu
, struct timespec
*end_time
)
2371 sys_jmp_buf local_getcjmp
;
2372 sys_jmp_buf save_jump
;
2373 Lisp_Object tem
, save
;
2374 volatile Lisp_Object previous_echo_area_message
;
2375 volatile Lisp_Object also_record
;
2376 volatile bool reread
;
2377 struct gcpro gcpro1
, gcpro2
;
2378 bool volatile polling_stopped_here
= 0;
2379 struct kboard
*orig_kboard
= current_kboard
;
2383 #if 0 /* This was commented out as part of fixing echo for C-u left. */
2384 before_command_key_count
= this_command_key_count
;
2385 before_command_echo_length
= echo_length ();
2388 previous_echo_area_message
= Qnil
;
2390 GCPRO2 (c
, previous_echo_area_message
);
2394 if (CONSP (Vunread_post_input_method_events
))
2396 c
= XCAR (Vunread_post_input_method_events
);
2397 Vunread_post_input_method_events
2398 = XCDR (Vunread_post_input_method_events
);
2400 /* Undo what read_char_x_menu_prompt did when it unread
2401 additional keys returned by Fx_popup_menu. */
2403 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2414 if (CONSP (Vunread_command_events
))
2416 bool was_disabled
= 0;
2418 c
= XCAR (Vunread_command_events
);
2419 Vunread_command_events
= XCDR (Vunread_command_events
);
2421 /* Undo what sit-for did when it unread additional keys
2422 inside universal-argument. */
2424 if (CONSP (c
) && EQ (XCAR (c
), Qt
))
2429 /* Undo what read_char_x_menu_prompt did when it unread
2430 additional keys returned by Fx_popup_menu. */
2432 && EQ (XCDR (c
), Qdisabled
)
2433 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
))))
2439 /* If the queued event is something that used the mouse,
2440 set used_mouse_menu accordingly. */
2442 /* Also check was_disabled so last-nonmenu-event won't return
2443 a bad value when submenus are involved. (Bug#447) */
2444 && (EQ (c
, Qtool_bar
) || EQ (c
, Qmenu_bar
) || was_disabled
))
2445 *used_mouse_menu
= 1;
2447 goto reread_for_input_method
;
2450 if (CONSP (Vunread_input_method_events
))
2452 c
= XCAR (Vunread_input_method_events
);
2453 Vunread_input_method_events
= XCDR (Vunread_input_method_events
);
2455 /* Undo what read_char_x_menu_prompt did when it unread
2456 additional keys returned by Fx_popup_menu. */
2458 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2462 goto reread_for_input_method
;
2465 this_command_key_count_reset
= 0;
2467 if (!NILP (Vexecuting_kbd_macro
))
2469 /* We set this to Qmacro; since that's not a frame, nobody will
2470 try to switch frames on us, and the selected window will
2473 Since this event came from a macro, it would be misleading to
2474 leave internal_last_event_frame set to wherever the last
2475 real event came from. Normally, a switch-frame event selects
2476 internal_last_event_frame after each command is read, but
2477 events read from a macro should never cause a new frame to be
2479 Vlast_event_frame
= internal_last_event_frame
= Qmacro
;
2481 /* Exit the macro if we are at the end.
2482 Also, some things replace the macro with t
2483 to force an early exit. */
2484 if (EQ (Vexecuting_kbd_macro
, Qt
)
2485 || executing_kbd_macro_index
>= XFASTINT (Flength (Vexecuting_kbd_macro
)))
2491 c
= Faref (Vexecuting_kbd_macro
, make_number (executing_kbd_macro_index
));
2492 if (STRINGP (Vexecuting_kbd_macro
)
2493 && (XFASTINT (c
) & 0x80) && (XFASTINT (c
) <= 0xff))
2494 XSETFASTINT (c
, CHAR_META
| (XFASTINT (c
) & ~0x80));
2496 executing_kbd_macro_index
++;
2501 if (!NILP (unread_switch_frame
))
2503 c
= unread_switch_frame
;
2504 unread_switch_frame
= Qnil
;
2506 /* This event should make it into this_command_keys, and get echoed
2507 again, so we do not set `reread'. */
2511 /* If redisplay was requested. */
2512 if (commandflag
>= 0)
2514 bool echo_current
= EQ (echo_message_buffer
, echo_area_buffer
[0]);
2516 /* If there is pending input, process any events which are not
2517 user-visible, such as X selection_request events. */
2519 || detect_input_pending_run_timers (0))
2520 swallow_events (false); /* May clear input_pending. */
2522 /* Redisplay if no pending input. */
2523 while (!(input_pending
2524 && (input_was_pending
|| !redisplay_dont_pause
)))
2526 input_was_pending
= input_pending
;
2527 if (help_echo_showing_p
&& !EQ (selected_window
, minibuf_window
))
2528 redisplay_preserve_echo_area (5);
2533 /* Normal case: no input arrived during redisplay. */
2536 /* Input arrived and pre-empted redisplay.
2537 Process any events which are not user-visible. */
2538 swallow_events (false);
2539 /* If that cleared input_pending, try again to redisplay. */
2542 /* Prevent the redisplay we just did
2543 from messing up echoing of the input after the prompt. */
2544 if (commandflag
== 0 && echo_current
)
2545 echo_message_buffer
= echo_area_buffer
[0];
2549 /* Message turns off echoing unless more keystrokes turn it on again.
2551 The code in 20.x for the condition was
2553 1. echo_area_glyphs && *echo_area_glyphs
2554 2. && echo_area_glyphs != current_kboard->echobuf
2555 3. && ok_to_echo_at_next_pause != echo_area_glyphs
2557 (1) means there's a current message displayed
2559 (2) means it's not the message from echoing from the current
2562 (3) There's only one place in 20.x where ok_to_echo_at_next_pause
2563 is set to a non-null value. This is done in read_char and it is
2564 set to echo_area_glyphs after a call to echo_char. That means
2565 ok_to_echo_at_next_pause is either null or
2566 current_kboard->echobuf with the appropriate current_kboard at
2569 So, condition (3) means in clear text ok_to_echo_at_next_pause
2570 must be either null, or the current message isn't from echoing at
2571 all, or it's from echoing from a different kboard than the
2574 if (/* There currently is something in the echo area. */
2575 !NILP (echo_area_buffer
[0])
2576 && (/* It's an echo from a different kboard. */
2577 echo_kboard
!= current_kboard
2578 /* Or we explicitly allow overwriting whatever there is. */
2579 || ok_to_echo_at_next_pause
== NULL
))
2584 /* Try reading a character via menu prompting in the minibuf.
2585 Try this before the sit-for, because the sit-for
2586 would do the wrong thing if we are supposed to do
2587 menu prompting. If EVENT_HAS_PARAMETERS then we are reading
2588 after a mouse event so don't try a minibuf menu. */
2590 if (KEYMAPP (map
) && INTERACTIVE
2591 && !NILP (prev_event
) && ! EVENT_HAS_PARAMETERS (prev_event
)
2592 /* Don't bring up a menu if we already have another event. */
2593 && NILP (Vunread_command_events
)
2594 && !detect_input_pending_run_timers (0))
2596 c
= read_char_minibuf_menu_prompt (commandflag
, map
);
2598 if (INTEGERP (c
) && XINT (c
) == -2)
2599 return c
; /* wrong_kboard_jmpbuf */
2605 /* Make a longjmp point for quits to use, but don't alter getcjmp just yet.
2606 We will do that below, temporarily for short sections of code,
2607 when appropriate. local_getcjmp must be in effect
2608 around any call to sit_for or kbd_buffer_get_event;
2609 it *must not* be in effect when we call redisplay. */
2611 jmpcount
= SPECPDL_INDEX ();
2612 if (sys_setjmp (local_getcjmp
))
2614 /* Handle quits while reading the keyboard. */
2615 /* We must have saved the outer value of getcjmp here,
2616 so restore it now. */
2617 restore_getcjmp (save_jump
);
2618 pthread_sigmask (SIG_SETMASK
, &empty_mask
, 0);
2619 unbind_to (jmpcount
, Qnil
);
2620 XSETINT (c
, quit_char
);
2621 internal_last_event_frame
= selected_frame
;
2622 Vlast_event_frame
= internal_last_event_frame
;
2623 /* If we report the quit char as an event,
2624 don't do so more than once. */
2625 if (!NILP (Vinhibit_quit
))
2629 KBOARD
*kb
= FRAME_KBOARD (XFRAME (selected_frame
));
2630 if (kb
!= current_kboard
)
2632 Lisp_Object last
= KVAR (kb
, kbd_queue
);
2633 /* We shouldn't get here if we were in single-kboard mode! */
2638 while (CONSP (XCDR (last
)))
2640 if (!NILP (XCDR (last
)))
2644 kset_kbd_queue (kb
, list1 (c
));
2646 XSETCDR (last
, list1 (c
));
2647 kb
->kbd_queue_has_data
= 1;
2648 current_kboard
= kb
;
2649 /* This is going to exit from read_char
2650 so we had better get rid of this frame's stuff. */
2652 return make_number (-2); /* wrong_kboard_jmpbuf */
2658 /* Start idle timers if no time limit is supplied. We don't do it
2659 if a time limit is supplied to avoid an infinite recursion in the
2660 situation where an idle timer calls `sit-for'. */
2663 timer_start_idle ();
2665 /* If in middle of key sequence and minibuffer not active,
2666 start echoing if enough time elapses. */
2668 if (minibuf_level
== 0
2670 && !current_kboard
->immediate_echo
2671 && this_command_key_count
> 0
2673 && echo_keystrokes_p ()
2674 && (/* No message. */
2675 NILP (echo_area_buffer
[0])
2676 /* Or empty message. */
2677 || (BUF_BEG (XBUFFER (echo_area_buffer
[0]))
2678 == BUF_Z (XBUFFER (echo_area_buffer
[0])))
2679 /* Or already echoing from same kboard. */
2680 || (echo_kboard
&& ok_to_echo_at_next_pause
== echo_kboard
)
2681 /* Or not echoing before and echoing allowed. */
2682 || (!echo_kboard
&& ok_to_echo_at_next_pause
)))
2684 /* After a mouse event, start echoing right away.
2685 This is because we are probably about to display a menu,
2686 and we don't want to delay before doing so. */
2687 if (EVENT_HAS_PARAMETERS (prev_event
))
2693 save_getcjmp (save_jump
);
2694 restore_getcjmp (local_getcjmp
);
2695 tem0
= sit_for (Vecho_keystrokes
, 1, 1);
2696 restore_getcjmp (save_jump
);
2698 && ! CONSP (Vunread_command_events
))
2703 /* Maybe auto save due to number of keystrokes. */
2705 if (commandflag
!= 0 && commandflag
!= -2
2706 && auto_save_interval
> 0
2707 && num_nonmacro_input_events
- last_auto_save
> max (auto_save_interval
, 20)
2708 && !detect_input_pending_run_timers (0))
2710 Fdo_auto_save (Qnil
, Qnil
);
2711 /* Hooks can actually change some buffers in auto save. */
2715 /* Try reading using an X menu.
2716 This is never confused with reading using the minibuf
2717 because the recursive call of read_char in read_char_minibuf_menu_prompt
2718 does not pass on any keymaps. */
2720 if (KEYMAPP (map
) && INTERACTIVE
2721 && !NILP (prev_event
)
2722 && EVENT_HAS_PARAMETERS (prev_event
)
2723 && !EQ (XCAR (prev_event
), Qmenu_bar
)
2724 && !EQ (XCAR (prev_event
), Qtool_bar
)
2725 /* Don't bring up a menu if we already have another event. */
2726 && NILP (Vunread_command_events
))
2728 c
= read_char_x_menu_prompt (map
, prev_event
, used_mouse_menu
);
2730 /* Now that we have read an event, Emacs is not idle. */
2737 /* Maybe autosave and/or garbage collect due to idleness. */
2739 if (INTERACTIVE
&& NILP (c
))
2742 ptrdiff_t buffer_size
;
2744 /* Slow down auto saves logarithmically in size of current buffer,
2745 and garbage collect while we're at it. */
2746 if (! MINI_WINDOW_P (XWINDOW (selected_window
)))
2747 last_non_minibuf_size
= Z
- BEG
;
2748 buffer_size
= (last_non_minibuf_size
>> 8) + 1;
2750 while (buffer_size
> 64)
2751 delay_level
++, buffer_size
-= buffer_size
>> 2;
2752 if (delay_level
< 4) delay_level
= 4;
2753 /* delay_level is 4 for files under around 50k, 7 at 100k,
2754 9 at 200k, 11 at 300k, and 12 at 500k. It is 15 at 1 meg. */
2756 /* Auto save if enough time goes by without input. */
2757 if (commandflag
!= 0 && commandflag
!= -2
2758 && num_nonmacro_input_events
> last_auto_save
2759 && INTEGERP (Vauto_save_timeout
)
2760 && XINT (Vauto_save_timeout
) > 0)
2763 EMACS_INT timeout
= XFASTINT (Vauto_save_timeout
);
2765 timeout
= min (timeout
, MOST_POSITIVE_FIXNUM
/ delay_level
* 4);
2766 timeout
= delay_level
* timeout
/ 4;
2767 save_getcjmp (save_jump
);
2768 restore_getcjmp (local_getcjmp
);
2769 tem0
= sit_for (make_number (timeout
), 1, 1);
2770 restore_getcjmp (save_jump
);
2773 && ! CONSP (Vunread_command_events
))
2775 Fdo_auto_save (Qnil
, Qnil
);
2780 /* If there is still no input available, ask for GC. */
2781 if (!detect_input_pending_run_timers (0))
2785 /* Notify the caller if an autosave hook, or a timer, sentinel or
2786 filter in the sit_for calls above have changed the current
2787 kboard. This could happen if they use the minibuffer or start a
2788 recursive edit, like the fancy splash screen in server.el's
2789 filter. If this longjmp wasn't here, read_key_sequence would
2790 interpret the next key sequence using the wrong translation
2791 tables and function keymaps. */
2792 if (NILP (c
) && current_kboard
!= orig_kboard
)
2795 return make_number (-2); /* wrong_kboard_jmpbuf */
2798 /* If this has become non-nil here, it has been set by a timer
2799 or sentinel or filter. */
2800 if (CONSP (Vunread_command_events
))
2802 c
= XCAR (Vunread_command_events
);
2803 Vunread_command_events
= XCDR (Vunread_command_events
);
2805 if (CONSP (c
) && EQ (XCAR (c
), Qt
))
2811 /* Read something from current KBOARD's side queue, if possible. */
2815 if (current_kboard
->kbd_queue_has_data
)
2817 if (!CONSP (KVAR (current_kboard
, kbd_queue
)))
2819 c
= XCAR (KVAR (current_kboard
, kbd_queue
));
2820 kset_kbd_queue (current_kboard
,
2821 XCDR (KVAR (current_kboard
, kbd_queue
)));
2822 if (NILP (KVAR (current_kboard
, kbd_queue
)))
2823 current_kboard
->kbd_queue_has_data
= 0;
2824 input_pending
= readable_events (0);
2825 if (EVENT_HAS_PARAMETERS (c
)
2826 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qswitch_frame
))
2827 internal_last_event_frame
= XCAR (XCDR (c
));
2828 Vlast_event_frame
= internal_last_event_frame
;
2832 /* If current_kboard's side queue is empty check the other kboards.
2833 If one of them has data that we have not yet seen here,
2834 switch to it and process the data waiting for it.
2836 Note: if the events queued up for another kboard
2837 have already been seen here, and therefore are not a complete command,
2838 the kbd_queue_has_data field is 0, so we skip that kboard here.
2839 That's to avoid an infinite loop switching between kboards here. */
2840 if (NILP (c
) && !single_kboard
)
2843 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
2844 if (kb
->kbd_queue_has_data
)
2846 current_kboard
= kb
;
2847 /* This is going to exit from read_char
2848 so we had better get rid of this frame's stuff. */
2850 return make_number (-2); /* wrong_kboard_jmpbuf */
2860 c
= read_decoded_event_from_main_queue (end_time
, local_getcjmp
,
2861 prev_event
, used_mouse_menu
);
2862 if (NILP (c
) && end_time
2863 && timespec_cmp (*end_time
, current_timespec ()) <= 0)
2868 if (EQ (c
, make_number (-2)))
2870 /* This is going to exit from read_char
2871 so we had better get rid of this frame's stuff. */
2885 if (commandflag
>= 0
2886 && !input_pending
&& !detect_input_pending_run_timers (0))
2892 /* Buffer switch events are only for internal wakeups
2893 so don't show them to the user.
2894 Also, don't record a key if we already did. */
2898 /* Process special events within read_char
2899 and loop around to read another event. */
2902 tem
= access_keymap (get_keymap (Vspecial_event_map
, 0, 1), c
, 0, 0, 1);
2907 struct buffer
*prev_buffer
= current_buffer
;
2908 last_input_event
= c
;
2909 call4 (Qcommand_execute
, tem
, Qnil
, Fvector (1, &last_input_event
), Qt
);
2911 if (CONSP (c
) && EQ (XCAR (c
), Qselect_window
) && !end_time
)
2912 /* We stopped being idle for this event; undo that. This
2913 prevents automatic window selection (under
2914 mouse_autoselect_window from acting as a real input event, for
2915 example banishing the mouse under mouse-avoidance-mode. */
2916 timer_resume_idle ();
2918 if (current_buffer
!= prev_buffer
)
2920 /* The command may have changed the keymaps. Pretend there
2921 is input in another keyboard and return. This will
2922 recalculate keymaps. */
2923 c
= make_number (-2);
2930 /* Handle things that only apply to characters. */
2933 /* If kbd_buffer_get_event gave us an EOF, return that. */
2937 if ((STRINGP (KVAR (current_kboard
, Vkeyboard_translate_table
))
2938 && UNSIGNED_CMP (XFASTINT (c
), <,
2939 SCHARS (KVAR (current_kboard
,
2940 Vkeyboard_translate_table
))))
2941 || (VECTORP (KVAR (current_kboard
, Vkeyboard_translate_table
))
2942 && UNSIGNED_CMP (XFASTINT (c
), <,
2943 ASIZE (KVAR (current_kboard
,
2944 Vkeyboard_translate_table
))))
2945 || (CHAR_TABLE_P (KVAR (current_kboard
, Vkeyboard_translate_table
))
2949 d
= Faref (KVAR (current_kboard
, Vkeyboard_translate_table
), c
);
2950 /* nil in keyboard-translate-table means no translation. */
2956 /* If this event is a mouse click in the menu bar,
2957 return just menu-bar for now. Modify the mouse click event
2958 so we won't do this twice, then queue it up. */
2959 if (EVENT_HAS_PARAMETERS (c
)
2961 && CONSP (EVENT_START (c
))
2962 && CONSP (XCDR (EVENT_START (c
))))
2966 posn
= POSN_POSN (EVENT_START (c
));
2967 /* Handle menu-bar events:
2968 insert the dummy prefix event `menu-bar'. */
2969 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
2971 /* Change menu-bar to (menu-bar) as the event "position". */
2972 POSN_SET_POSN (EVENT_START (c
), list1 (posn
));
2975 Vunread_command_events
= Fcons (c
, Vunread_command_events
);
2980 /* Store these characters into recent_keys, the dribble file if any,
2981 and the keyboard macro being defined, if any. */
2983 if (! NILP (also_record
))
2984 record_char (also_record
);
2986 /* Wipe the echo area.
2987 But first, if we are about to use an input method,
2988 save the echo area contents for it to refer to. */
2990 && ! NILP (Vinput_method_function
)
2991 && ' ' <= XINT (c
) && XINT (c
) < 256 && XINT (c
) != 127)
2993 previous_echo_area_message
= Fcurrent_message ();
2994 Vinput_method_previous_message
= previous_echo_area_message
;
2997 /* Now wipe the echo area, except for help events which do their
2998 own stuff with the echo area. */
3000 || (!(EQ (Qhelp_echo
, XCAR (c
)))
3001 && !(EQ (Qswitch_frame
, XCAR (c
)))
3002 /* Don't wipe echo area for select window events: These might
3003 get delayed via `mouse-autoselect-window' (Bug#11304). */
3004 && !(EQ (Qselect_window
, XCAR (c
)))))
3006 if (!NILP (echo_area_buffer
[0]))
3008 safe_run_hooks (Qecho_area_clear_hook
);
3009 clear_message (1, 0);
3013 reread_for_input_method
:
3015 /* Pass this to the input method, if appropriate. */
3017 && ! NILP (Vinput_method_function
)
3018 /* Don't run the input method within a key sequence,
3019 after the first event of the key sequence. */
3020 && NILP (prev_event
)
3021 && ' ' <= XINT (c
) && XINT (c
) < 256 && XINT (c
) != 127)
3024 ptrdiff_t key_count
;
3025 bool key_count_reset
;
3026 struct gcpro gcpro1
;
3027 ptrdiff_t count
= SPECPDL_INDEX ();
3029 /* Save the echo status. */
3030 bool saved_immediate_echo
= current_kboard
->immediate_echo
;
3031 struct kboard
*saved_ok_to_echo
= ok_to_echo_at_next_pause
;
3032 Lisp_Object saved_echo_string
= KVAR (current_kboard
, echo_string
);
3033 ptrdiff_t saved_echo_after_prompt
= current_kboard
->echo_after_prompt
;
3036 if (before_command_restore_flag
)
3038 this_command_key_count
= before_command_key_count_1
;
3039 if (this_command_key_count
< this_single_command_key_start
)
3040 this_single_command_key_start
= this_command_key_count
;
3041 echo_truncate (before_command_echo_length_1
);
3042 before_command_restore_flag
= 0;
3046 /* Save the this_command_keys status. */
3047 key_count
= this_command_key_count
;
3048 key_count_reset
= this_command_key_count_reset
;
3051 keys
= Fcopy_sequence (this_command_keys
);
3056 /* Clear out this_command_keys. */
3057 this_command_key_count
= 0;
3058 this_command_key_count_reset
= 0;
3060 /* Now wipe the echo area. */
3061 if (!NILP (echo_area_buffer
[0]))
3062 safe_run_hooks (Qecho_area_clear_hook
);
3063 clear_message (1, 0);
3066 /* If we are not reading a key sequence,
3067 never use the echo area. */
3070 specbind (Qinput_method_use_echo_area
, Qt
);
3073 /* Call the input method. */
3074 tem
= call1 (Vinput_method_function
, c
);
3076 tem
= unbind_to (count
, tem
);
3078 /* Restore the saved echoing state
3079 and this_command_keys state. */
3080 this_command_key_count
= key_count
;
3081 this_command_key_count_reset
= key_count_reset
;
3083 this_command_keys
= keys
;
3086 ok_to_echo_at_next_pause
= saved_ok_to_echo
;
3087 kset_echo_string (current_kboard
, saved_echo_string
);
3088 current_kboard
->echo_after_prompt
= saved_echo_after_prompt
;
3089 if (saved_immediate_echo
)
3094 /* The input method can return no events. */
3097 /* Bring back the previous message, if any. */
3098 if (! NILP (previous_echo_area_message
))
3099 message_with_string ("%s", previous_echo_area_message
, 0);
3102 /* It returned one event or more. */
3104 Vunread_post_input_method_events
3105 = nconc2 (XCDR (tem
), Vunread_post_input_method_events
);
3110 /* Display help if not echoing. */
3111 if (CONSP (c
) && EQ (XCAR (c
), Qhelp_echo
))
3113 /* (help-echo FRAME HELP WINDOW OBJECT POS). */
3114 Lisp_Object help
, object
, position
, window
, htem
;
3116 htem
= Fcdr (XCDR (c
));
3119 window
= Fcar (htem
);
3121 object
= Fcar (htem
);
3123 position
= Fcar (htem
);
3125 show_help_echo (help
, window
, object
, position
);
3127 /* We stopped being idle for this event; undo that. */
3129 timer_resume_idle ();
3133 if ((! reread
|| this_command_key_count
== 0
3134 || this_command_key_count_reset
)
3138 /* Don't echo mouse motion events. */
3139 if (echo_keystrokes_p ()
3140 && ! (EVENT_HAS_PARAMETERS (c
)
3141 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
3144 if (! NILP (also_record
))
3145 echo_char (also_record
);
3146 /* Once we reread a character, echoing can happen
3147 the next time we pause to read a new one. */
3148 ok_to_echo_at_next_pause
= current_kboard
;
3151 /* Record this character as part of the current key. */
3152 add_command_key (c
);
3153 if (! NILP (also_record
))
3154 add_command_key (also_record
);
3157 last_input_event
= c
;
3160 /* Process the help character specially if enabled. */
3161 if (!NILP (Vhelp_form
) && help_char_p (c
))
3163 ptrdiff_t count
= SPECPDL_INDEX ();
3165 help_form_saved_window_configs
3166 = Fcons (Fcurrent_window_configuration (Qnil
),
3167 help_form_saved_window_configs
);
3168 record_unwind_protect_void (read_char_help_form_unwind
);
3169 call0 (Qhelp_form_show
);
3174 c
= read_char (0, Qnil
, Qnil
, 0, NULL
);
3175 if (EVENT_HAS_PARAMETERS (c
)
3176 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_click
))
3177 XSETCAR (help_form_saved_window_configs
, Qnil
);
3179 while (BUFFERP (c
));
3180 /* Remove the help from the frame. */
3181 unbind_to (count
, Qnil
);
3184 if (EQ (c
, make_number (040)))
3188 c
= read_char (0, Qnil
, Qnil
, 0, NULL
);
3189 while (BUFFERP (c
));
3195 input_was_pending
= input_pending
;
3199 /* Record a key that came from a mouse menu.
3200 Record it for echoing, for this-command-keys, and so on. */
3203 record_menu_key (Lisp_Object c
)
3205 /* Wipe the echo area. */
3206 clear_message (1, 0);
3211 before_command_key_count
= this_command_key_count
;
3212 before_command_echo_length
= echo_length ();
3215 /* Don't echo mouse motion events. */
3216 if (echo_keystrokes_p ())
3220 /* Once we reread a character, echoing can happen
3221 the next time we pause to read a new one. */
3222 ok_to_echo_at_next_pause
= 0;
3225 /* Record this character as part of the current key. */
3226 add_command_key (c
);
3228 /* Re-reading in the middle of a command. */
3229 last_input_event
= c
;
3233 /* Return true if should recognize C as "the help character". */
3236 help_char_p (Lisp_Object c
)
3240 if (EQ (c
, Vhelp_char
))
3242 for (tail
= Vhelp_event_list
; CONSP (tail
); tail
= XCDR (tail
))
3243 if (EQ (c
, XCAR (tail
)))
3248 /* Record the input event C in various ways. */
3251 record_char (Lisp_Object c
)
3255 if (CONSP (c
) && (EQ (XCAR (c
), Qhelp_echo
) || EQ (XCAR (c
), Qmouse_movement
)))
3257 /* To avoid filling recent_keys with help-echo and mouse-movement
3258 events, we filter out repeated help-echo events, only store the
3259 first and last in a series of mouse-movement events, and don't
3260 store repeated help-echo events which are only separated by
3261 mouse-movement events. */
3263 Lisp_Object ev1
, ev2
, ev3
;
3266 if ((ix1
= recent_keys_index
- 1) < 0)
3267 ix1
= NUM_RECENT_KEYS
- 1;
3268 ev1
= AREF (recent_keys
, ix1
);
3270 if ((ix2
= ix1
- 1) < 0)
3271 ix2
= NUM_RECENT_KEYS
- 1;
3272 ev2
= AREF (recent_keys
, ix2
);
3274 if ((ix3
= ix2
- 1) < 0)
3275 ix3
= NUM_RECENT_KEYS
- 1;
3276 ev3
= AREF (recent_keys
, ix3
);
3278 if (EQ (XCAR (c
), Qhelp_echo
))
3280 /* Don't record `help-echo' in recent_keys unless it shows some help
3281 message, and a different help than the previously recorded
3283 Lisp_Object help
, last_help
;
3285 help
= Fcar_safe (Fcdr_safe (XCDR (c
)));
3286 if (!STRINGP (help
))
3288 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qhelp_echo
)
3289 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev1
))), EQ (last_help
, help
)))
3291 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3292 && CONSP (ev2
) && EQ (XCAR (ev2
), Qhelp_echo
)
3293 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev2
))), EQ (last_help
, help
)))
3295 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3296 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3297 && CONSP (ev3
) && EQ (XCAR (ev3
), Qhelp_echo
)
3298 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev3
))), EQ (last_help
, help
)))
3301 else if (EQ (XCAR (c
), Qmouse_movement
))
3303 /* Only record one pair of `mouse-movement' on a window in recent_keys.
3304 So additional mouse movement events replace the last element. */
3305 Lisp_Object last_window
, window
;
3307 window
= Fcar_safe (Fcar_safe (XCDR (c
)));
3308 if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3309 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev1
))), EQ (last_window
, window
))
3310 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3311 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev2
))), EQ (last_window
, window
)))
3313 ASET (recent_keys
, ix1
, c
);
3319 store_kbd_macro_char (c
);
3323 total_keys
+= total_keys
< NUM_RECENT_KEYS
;
3324 ASET (recent_keys
, recent_keys_index
, c
);
3325 if (++recent_keys_index
>= NUM_RECENT_KEYS
)
3326 recent_keys_index
= 0;
3328 else if (recorded
< 0)
3330 /* We need to remove one or two events from recent_keys.
3331 To do this, we simply put nil at those events and move the
3332 recent_keys_index backwards over those events. Usually,
3333 users will never see those nil events, as they will be
3334 overwritten by the command keys entered to see recent_keys
3337 while (recorded
++ < 0 && total_keys
> 0)
3339 if (total_keys
< NUM_RECENT_KEYS
)
3341 if (--recent_keys_index
< 0)
3342 recent_keys_index
= NUM_RECENT_KEYS
- 1;
3343 ASET (recent_keys
, recent_keys_index
, Qnil
);
3347 num_nonmacro_input_events
++;
3349 /* Write c to the dribble file. If c is a lispy event, write
3350 the event's symbol to the dribble file, in <brackets>. Bleaugh.
3351 If you, dear reader, have a better idea, you've got the source. :-) */
3357 if (XUINT (c
) < 0x100)
3358 putc (XUINT (c
), dribble
);
3360 fprintf (dribble
, " 0x%"pI
"x", XUINT (c
));
3364 Lisp_Object dribblee
;
3366 /* If it's a structured event, take the event header. */
3367 dribblee
= EVENT_HEAD (c
);
3369 if (SYMBOLP (dribblee
))
3371 putc ('<', dribble
);
3372 fwrite (SDATA (SYMBOL_NAME (dribblee
)), sizeof (char),
3373 SBYTES (SYMBOL_NAME (dribblee
)),
3375 putc ('>', dribble
);
3384 /* Copy out or in the info on where C-g should throw to.
3385 This is used when running Lisp code from within get_char,
3386 in case get_char is called recursively.
3387 See read_process_output. */
3390 save_getcjmp (sys_jmp_buf temp
)
3392 memcpy (temp
, getcjmp
, sizeof getcjmp
);
3396 restore_getcjmp (sys_jmp_buf temp
)
3398 memcpy (getcjmp
, temp
, sizeof getcjmp
);
3401 /* Low level keyboard/mouse input.
3402 kbd_buffer_store_event places events in kbd_buffer, and
3403 kbd_buffer_get_event retrieves them. */
3405 /* Return true if there are any events in the queue that read-char
3406 would return. If this returns false, a read-char would block. */
3408 readable_events (int flags
)
3410 if (flags
& READABLE_EVENTS_DO_TIMERS_NOW
)
3413 /* If the buffer contains only FOCUS_IN_EVENT events, and
3414 READABLE_EVENTS_FILTER_EVENTS is set, report it as empty. */
3415 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3417 if (flags
& (READABLE_EVENTS_FILTER_EVENTS
3418 #ifdef USE_TOOLKIT_SCROLL_BARS
3419 | READABLE_EVENTS_IGNORE_SQUEEZABLES
3423 struct input_event
*event
;
3425 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
3432 #ifdef USE_TOOLKIT_SCROLL_BARS
3433 (flags
& READABLE_EVENTS_FILTER_EVENTS
) &&
3435 event
->kind
== FOCUS_IN_EVENT
)
3436 #ifdef USE_TOOLKIT_SCROLL_BARS
3437 && !((flags
& READABLE_EVENTS_IGNORE_SQUEEZABLES
)
3438 && (event
->kind
== SCROLL_BAR_CLICK_EVENT
3439 || event
->kind
== HORIZONTAL_SCROLL_BAR_CLICK_EVENT
)
3440 && event
->part
== scroll_bar_handle
3441 && event
->modifiers
== 0)
3443 && !((flags
& READABLE_EVENTS_FILTER_EVENTS
)
3444 && event
->kind
== BUFFER_SWITCH_EVENT
))
3447 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3450 while (event
!= kbd_store_ptr
);
3456 if (!(flags
& READABLE_EVENTS_IGNORE_SQUEEZABLES
)
3457 && !NILP (do_mouse_tracking
) && some_mouse_moved ())
3461 if (current_kboard
->kbd_queue_has_data
)
3467 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
3468 if (kb
->kbd_queue_has_data
)
3474 /* Set this for debugging, to have a way to get out */
3475 int stop_character EXTERNALLY_VISIBLE
;
3478 event_to_kboard (struct input_event
*event
)
3480 /* Not applicable for these special events. */
3481 if (event
->kind
== SELECTION_REQUEST_EVENT
3482 || event
->kind
== SELECTION_CLEAR_EVENT
)
3486 Lisp_Object obj
= event
->frame_or_window
;
3487 /* There are some events that set this field to nil or string. */
3489 obj
= WINDOW_FRAME (XWINDOW (obj
));
3490 /* Also ignore dead frames here. */
3491 return ((FRAMEP (obj
) && FRAME_LIVE_P (XFRAME (obj
)))
3492 ? FRAME_KBOARD (XFRAME (obj
)) : NULL
);
3497 /* Return the number of slots occupied in kbd_buffer. */
3500 kbd_buffer_nr_stored (void)
3502 return kbd_fetch_ptr
== kbd_store_ptr
3504 : (kbd_fetch_ptr
< kbd_store_ptr
3505 ? kbd_store_ptr
- kbd_fetch_ptr
3506 : ((kbd_buffer
+ KBD_BUFFER_SIZE
) - kbd_fetch_ptr
3507 + (kbd_store_ptr
- kbd_buffer
)));
3509 #endif /* Store an event obtained at interrupt level into kbd_buffer, fifo */
3512 kbd_buffer_store_event (register struct input_event
*event
)
3514 kbd_buffer_store_event_hold (event
, 0);
3517 /* Store EVENT obtained at interrupt level into kbd_buffer, fifo.
3519 If HOLD_QUIT is 0, just stuff EVENT into the fifo.
3520 Else, if HOLD_QUIT.kind != NO_EVENT, discard EVENT.
3521 Else, if EVENT is a quit event, store the quit event
3522 in HOLD_QUIT, and return (thus ignoring further events).
3524 This is used to postpone the processing of the quit event until all
3525 subsequent input events have been parsed (and discarded). */
3528 kbd_buffer_store_event_hold (register struct input_event
*event
,
3529 struct input_event
*hold_quit
)
3531 if (event
->kind
== NO_EVENT
)
3534 if (hold_quit
&& hold_quit
->kind
!= NO_EVENT
)
3537 if (event
->kind
== ASCII_KEYSTROKE_EVENT
)
3539 register int c
= event
->code
& 0377;
3541 if (event
->modifiers
& ctrl_modifier
)
3542 c
= make_ctrl_char (c
);
3544 c
|= (event
->modifiers
3545 & (meta_modifier
| alt_modifier
3546 | hyper_modifier
| super_modifier
));
3550 KBOARD
*kb
= FRAME_KBOARD (XFRAME (event
->frame_or_window
));
3551 struct input_event
*sp
;
3553 if (single_kboard
&& kb
!= current_kboard
)
3556 (kb
, list2 (make_lispy_switch_frame (event
->frame_or_window
),
3558 kb
->kbd_queue_has_data
= 1;
3559 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3561 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3564 if (event_to_kboard (sp
) == kb
)
3566 sp
->kind
= NO_EVENT
;
3567 sp
->frame_or_window
= Qnil
;
3576 *hold_quit
= *event
;
3580 /* If this results in a quit_char being returned to Emacs as
3581 input, set Vlast_event_frame properly. If this doesn't
3582 get returned to Emacs as an event, the next event read
3583 will set Vlast_event_frame again, so this is safe to do. */
3587 focus
= FRAME_FOCUS_FRAME (XFRAME (event
->frame_or_window
));
3589 focus
= event
->frame_or_window
;
3590 internal_last_event_frame
= focus
;
3591 Vlast_event_frame
= focus
;
3594 handle_interrupt (0);
3598 if (c
&& c
== stop_character
)
3604 /* Don't insert two BUFFER_SWITCH_EVENT's in a row.
3605 Just ignore the second one. */
3606 else if (event
->kind
== BUFFER_SWITCH_EVENT
3607 && kbd_fetch_ptr
!= kbd_store_ptr
3608 && ((kbd_store_ptr
== kbd_buffer
3609 ? kbd_buffer
+ KBD_BUFFER_SIZE
- 1
3610 : kbd_store_ptr
- 1)->kind
) == BUFFER_SWITCH_EVENT
)
3613 if (kbd_store_ptr
- kbd_buffer
== KBD_BUFFER_SIZE
)
3614 kbd_store_ptr
= kbd_buffer
;
3616 /* Don't let the very last slot in the buffer become full,
3617 since that would make the two pointers equal,
3618 and that is indistinguishable from an empty buffer.
3619 Discard the event if it would fill the last slot. */
3620 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
3622 *kbd_store_ptr
= *event
;
3625 if (kbd_buffer_nr_stored () > KBD_BUFFER_SIZE
/ 2
3626 && ! kbd_on_hold_p ())
3628 /* Don't read keyboard input until we have processed kbd_buffer.
3629 This happens when pasting text longer than KBD_BUFFER_SIZE/2. */
3630 hold_keyboard_input ();
3631 if (!noninteractive
)
3635 #endif /* subprocesses */
3638 /* If we're inside while-no-input, and this event qualifies
3639 as input, set quit-flag to cause an interrupt. */
3640 if (!NILP (Vthrow_on_input
)
3641 && event
->kind
!= FOCUS_IN_EVENT
3642 && event
->kind
!= HELP_EVENT
3643 && event
->kind
!= DEICONIFY_EVENT
)
3645 Vquit_flag
= Vthrow_on_input
;
3646 /* If we're inside a function that wants immediate quits,
3648 if (immediate_quit
&& NILP (Vinhibit_quit
))
3657 /* Put an input event back in the head of the event queue. */
3660 kbd_buffer_unget_event (register struct input_event
*event
)
3662 if (kbd_fetch_ptr
== kbd_buffer
)
3663 kbd_fetch_ptr
= kbd_buffer
+ KBD_BUFFER_SIZE
;
3665 /* Don't let the very last slot in the buffer become full, */
3666 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
3669 *kbd_fetch_ptr
= *event
;
3673 /* Limit help event positions to this range, to avoid overflow problems. */
3674 #define INPUT_EVENT_POS_MAX \
3675 ((ptrdiff_t) min (PTRDIFF_MAX, min (TYPE_MAXIMUM (Time) / 2, \
3676 MOST_POSITIVE_FIXNUM)))
3677 #define INPUT_EVENT_POS_MIN (-1 - INPUT_EVENT_POS_MAX)
3679 /* Return a Time that encodes position POS. POS must be in range. */
3682 position_to_Time (ptrdiff_t pos
)
3684 eassert (INPUT_EVENT_POS_MIN
<= pos
&& pos
<= INPUT_EVENT_POS_MAX
);
3688 /* Return the position that ENCODED_POS encodes.
3689 Avoid signed integer overflow. */
3692 Time_to_position (Time encoded_pos
)
3694 if (encoded_pos
<= INPUT_EVENT_POS_MAX
)
3696 Time encoded_pos_min
= INPUT_EVENT_POS_MIN
;
3697 eassert (encoded_pos_min
<= encoded_pos
);
3698 ptrdiff_t notpos
= -1 - encoded_pos
;
3702 /* Generate a HELP_EVENT input_event and store it in the keyboard
3705 HELP is the help form.
3707 FRAME and WINDOW are the frame and window where the help is
3708 generated. OBJECT is the Lisp object where the help was found (a
3709 buffer, a string, an overlay, or nil if neither from a string nor
3710 from a buffer). POS is the position within OBJECT where the help
3714 gen_help_event (Lisp_Object help
, Lisp_Object frame
, Lisp_Object window
,
3715 Lisp_Object object
, ptrdiff_t pos
)
3717 struct input_event event
;
3719 event
.kind
= HELP_EVENT
;
3720 event
.frame_or_window
= frame
;
3722 event
.x
= WINDOWP (window
) ? window
: frame
;
3724 event
.timestamp
= position_to_Time (pos
);
3725 kbd_buffer_store_event (&event
);
3729 /* Store HELP_EVENTs for HELP on FRAME in the input queue. */
3732 kbd_buffer_store_help_event (Lisp_Object frame
, Lisp_Object help
)
3734 struct input_event event
;
3736 event
.kind
= HELP_EVENT
;
3737 event
.frame_or_window
= frame
;
3741 event
.timestamp
= 0;
3742 kbd_buffer_store_event (&event
);
3746 /* Discard any mouse events in the event buffer by setting them to
3749 discard_mouse_events (void)
3751 struct input_event
*sp
;
3752 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3754 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3757 if (sp
->kind
== MOUSE_CLICK_EVENT
3758 || sp
->kind
== WHEEL_EVENT
3759 || sp
->kind
== HORIZ_WHEEL_EVENT
3761 || sp
->kind
== GPM_CLICK_EVENT
3763 || sp
->kind
== SCROLL_BAR_CLICK_EVENT
3764 || sp
->kind
== HORIZONTAL_SCROLL_BAR_CLICK_EVENT
)
3766 sp
->kind
= NO_EVENT
;
3772 /* Return true if there are any real events waiting in the event
3773 buffer, not counting `NO_EVENT's.
3775 Discard NO_EVENT events at the front of the input queue, possibly
3776 leaving the input queue empty if there are no real input events. */
3779 kbd_buffer_events_waiting (void)
3781 struct input_event
*sp
;
3783 for (sp
= kbd_fetch_ptr
;
3784 sp
!= kbd_store_ptr
&& sp
->kind
== NO_EVENT
;
3787 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3792 return sp
!= kbd_store_ptr
&& sp
->kind
!= NO_EVENT
;
3796 /* Clear input event EVENT. */
3799 clear_event (struct input_event
*event
)
3801 event
->kind
= NO_EVENT
;
3805 /* Read one event from the event buffer, waiting if necessary.
3806 The value is a Lisp object representing the event.
3807 The value is nil for an event that should be ignored,
3808 or that was handled here.
3809 We always read and discard one event. */
3812 kbd_buffer_get_event (KBOARD
**kbp
,
3813 bool *used_mouse_menu
,
3814 struct timespec
*end_time
)
3819 if (kbd_on_hold_p () && kbd_buffer_nr_stored () < KBD_BUFFER_SIZE
/ 4)
3821 /* Start reading input again because we have processed enough to
3822 be able to accept new events again. */
3823 unhold_keyboard_input ();
3826 #endif /* subprocesses */
3828 #if !defined HAVE_DBUS && !defined USE_FILE_NOTIFY
3830 /* In case we are running as a daemon, only do this before
3831 detaching from the terminal. */
3832 || (IS_DAEMON
&& daemon_pipe
[1] >= 0))
3836 *kbp
= current_kboard
;
3839 #endif /* !defined HAVE_DBUS && !defined USE_FILE_NOTIFY */
3841 /* Wait until there is input available. */
3844 /* Break loop if there's an unread command event. Needed in
3845 moused window autoselection which uses a timer to insert such
3847 if (CONSP (Vunread_command_events
))
3850 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3852 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3855 /* If the quit flag is set, then read_char will return
3856 quit_char, so that counts as "available input." */
3857 if (!NILP (Vquit_flag
))
3858 quit_throw_to_read_char (0);
3860 /* One way or another, wait until input is available; then, if
3861 interrupt handlers have not read it, read it now. */
3866 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3868 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3872 struct timespec now
= current_timespec ();
3873 if (timespec_cmp (*end_time
, now
) <= 0)
3874 return Qnil
; /* Finished waiting. */
3877 struct timespec duration
= timespec_sub (*end_time
, now
);
3878 wait_reading_process_output (min (duration
.tv_sec
,
3881 -1, 1, Qnil
, NULL
, 0);
3886 bool do_display
= true;
3888 if (FRAME_TERMCAP_P (SELECTED_FRAME ()))
3890 struct tty_display_info
*tty
= CURTTY ();
3892 /* When this TTY is displaying a menu, we must prevent
3893 any redisplay, because we modify the frame's glyph
3894 matrix behind the back of the display engine. */
3895 if (tty
->showing_menu
)
3899 wait_reading_process_output (0, 0, -1, do_display
, Qnil
, NULL
, 0);
3902 if (!interrupt_input
&& kbd_fetch_ptr
== kbd_store_ptr
)
3906 if (CONSP (Vunread_command_events
))
3909 first
= XCAR (Vunread_command_events
);
3910 Vunread_command_events
= XCDR (Vunread_command_events
);
3911 *kbp
= current_kboard
;
3915 /* At this point, we know that there is a readable event available
3916 somewhere. If the event queue is empty, then there must be a
3917 mouse movement enabled and available. */
3918 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3920 struct input_event
*event
;
3922 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
3926 *kbp
= event_to_kboard (event
);
3928 *kbp
= current_kboard
; /* Better than returning null ptr? */
3932 /* These two kinds of events get special handling
3933 and don't actually appear to the command loop.
3934 We return nil for them. */
3935 if (event
->kind
== SELECTION_REQUEST_EVENT
3936 || event
->kind
== SELECTION_CLEAR_EVENT
)
3939 struct input_event copy
;
3941 /* Remove it from the buffer before processing it,
3942 since otherwise swallow_events will see it
3943 and process it again. */
3945 kbd_fetch_ptr
= event
+ 1;
3946 input_pending
= readable_events (0);
3947 x_handle_selection_event (©
);
3949 /* We're getting selection request events, but we don't have
3955 #if defined (HAVE_NS)
3956 else if (event
->kind
== NS_TEXT_EVENT
)
3958 if (event
->code
== KEY_NS_PUT_WORKING_TEXT
)
3959 obj
= list1 (intern ("ns-put-working-text"));
3961 obj
= list1 (intern ("ns-unput-working-text"));
3962 kbd_fetch_ptr
= event
+ 1;
3963 if (used_mouse_menu
)
3964 *used_mouse_menu
= 1;
3968 #if defined (HAVE_X11) || defined (HAVE_NTGUI) \
3969 || defined (HAVE_NS)
3970 else if (event
->kind
== DELETE_WINDOW_EVENT
)
3972 /* Make an event (delete-frame (FRAME)). */
3973 obj
= list2 (Qdelete_frame
, list1 (event
->frame_or_window
));
3974 kbd_fetch_ptr
= event
+ 1;
3977 #if defined (HAVE_X11) || defined (HAVE_NTGUI) \
3978 || defined (HAVE_NS)
3979 else if (event
->kind
== ICONIFY_EVENT
)
3981 /* Make an event (iconify-frame (FRAME)). */
3982 obj
= list2 (Qiconify_frame
, list1 (event
->frame_or_window
));
3983 kbd_fetch_ptr
= event
+ 1;
3985 else if (event
->kind
== DEICONIFY_EVENT
)
3987 /* Make an event (make-frame-visible (FRAME)). */
3988 obj
= list2 (Qmake_frame_visible
, list1 (event
->frame_or_window
));
3989 kbd_fetch_ptr
= event
+ 1;
3992 else if (event
->kind
== BUFFER_SWITCH_EVENT
)
3994 /* The value doesn't matter here; only the type is tested. */
3995 XSETBUFFER (obj
, current_buffer
);
3996 kbd_fetch_ptr
= event
+ 1;
3998 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
3999 || defined (HAVE_NS) || defined (USE_GTK)
4000 else if (event
->kind
== MENU_BAR_ACTIVATE_EVENT
)
4002 kbd_fetch_ptr
= event
+ 1;
4003 input_pending
= readable_events (0);
4004 if (FRAME_LIVE_P (XFRAME (event
->frame_or_window
)))
4005 x_activate_menubar (XFRAME (event
->frame_or_window
));
4009 else if (event
->kind
== LANGUAGE_CHANGE_EVENT
)
4011 /* Make an event (language-change FRAME CODEPAGE LANGUAGE-ID). */
4012 obj
= list4 (Qlanguage_change
,
4013 event
->frame_or_window
,
4014 make_number (event
->code
),
4015 make_number (event
->modifiers
));
4016 kbd_fetch_ptr
= event
+ 1;
4019 #ifdef USE_FILE_NOTIFY
4020 else if (event
->kind
== FILE_NOTIFY_EVENT
)
4022 #ifdef HAVE_W32NOTIFY
4023 /* Make an event (file-notify (DESCRIPTOR ACTION FILE) CALLBACK). */
4024 obj
= list3 (Qfile_notify
, event
->arg
, event
->frame_or_window
);
4026 obj
= make_lispy_event (event
);
4028 kbd_fetch_ptr
= event
+ 1;
4030 #endif /* USE_FILE_NOTIFY */
4031 else if (event
->kind
== SAVE_SESSION_EVENT
)
4033 obj
= list2 (Qsave_session
, event
->arg
);
4034 kbd_fetch_ptr
= event
+ 1;
4036 /* Just discard these, by returning nil.
4037 With MULTI_KBOARD, these events are used as placeholders
4038 when we need to randomly delete events from the queue.
4039 (They shouldn't otherwise be found in the buffer,
4040 but on some machines it appears they do show up
4041 even without MULTI_KBOARD.) */
4042 /* On Windows NT/9X, NO_EVENT is used to delete extraneous
4043 mouse events during a popup-menu call. */
4044 else if (event
->kind
== NO_EVENT
)
4045 kbd_fetch_ptr
= event
+ 1;
4046 else if (event
->kind
== HELP_EVENT
)
4048 Lisp_Object object
, position
, help
, frame
, window
;
4050 frame
= event
->frame_or_window
;
4051 object
= event
->arg
;
4052 position
= make_number (Time_to_position (event
->timestamp
));
4055 clear_event (event
);
4057 kbd_fetch_ptr
= event
+ 1;
4058 if (!WINDOWP (window
))
4060 obj
= Fcons (Qhelp_echo
,
4061 list5 (frame
, help
, window
, object
, position
));
4063 else if (event
->kind
== FOCUS_IN_EVENT
)
4065 /* Notification of a FocusIn event. The frame receiving the
4066 focus is in event->frame_or_window. Generate a
4067 switch-frame event if necessary. */
4068 Lisp_Object frame
, focus
;
4070 frame
= event
->frame_or_window
;
4071 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
4080 !EQ (frame
, internal_last_event_frame
)
4081 && !EQ (frame
, selected_frame
))
4082 obj
= make_lispy_switch_frame (frame
);
4084 obj
= make_lispy_focus_in (frame
);
4086 internal_last_event_frame
= frame
;
4087 kbd_fetch_ptr
= event
+ 1;
4089 else if (event
->kind
== FOCUS_OUT_EVENT
)
4091 #ifdef HAVE_WINDOW_SYSTEM
4094 Lisp_Object frame
= event
->frame_or_window
;
4095 bool focused
= false;
4097 for (di
= x_display_list
; di
&& ! focused
; di
= di
->next
)
4098 focused
= di
->x_highlight_frame
!= 0;
4101 obj
= make_lispy_focus_out (frame
);
4103 #endif /* HAVE_WINDOW_SYSTEM */
4105 kbd_fetch_ptr
= event
+ 1;
4108 else if (event
->kind
== DBUS_EVENT
)
4110 obj
= make_lispy_event (event
);
4111 kbd_fetch_ptr
= event
+ 1;
4114 #ifdef HAVE_XWIDGETS
4115 else if (event
->kind
== XWIDGET_EVENT
)
4117 obj
= make_lispy_event (event
);
4118 kbd_fetch_ptr
= event
+ 1;
4122 else if (event
->kind
== FILE_NOTIFY_EVENT
)
4124 obj
= make_lispy_event (event
);
4125 kbd_fetch_ptr
= event
+ 1;
4128 else if (event
->kind
== CONFIG_CHANGED_EVENT
)
4130 obj
= make_lispy_event (event
);
4131 kbd_fetch_ptr
= event
+ 1;
4135 /* If this event is on a different frame, return a switch-frame this
4136 time, and leave the event in the queue for next time. */
4140 frame
= event
->frame_or_window
;
4142 frame
= XCAR (frame
);
4143 else if (WINDOWP (frame
))
4144 frame
= WINDOW_FRAME (XWINDOW (frame
));
4146 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
4150 if (! EQ (frame
, internal_last_event_frame
)
4151 && !EQ (frame
, selected_frame
))
4152 obj
= make_lispy_switch_frame (frame
);
4153 internal_last_event_frame
= frame
;
4155 /* If we didn't decide to make a switch-frame event, go ahead
4156 and build a real event from the queue entry. */
4160 obj
= make_lispy_event (event
);
4162 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
4163 || defined (HAVE_NS) || defined (USE_GTK)
4164 /* If this was a menu selection, then set the flag to inhibit
4165 writing to last_nonmenu_event. Don't do this if the event
4166 we're returning is (menu-bar), though; that indicates the
4167 beginning of the menu sequence, and we might as well leave
4168 that as the `event with parameters' for this selection. */
4170 && !EQ (event
->frame_or_window
, event
->arg
)
4171 && (event
->kind
== MENU_BAR_EVENT
4172 || event
->kind
== TOOL_BAR_EVENT
))
4173 *used_mouse_menu
= 1;
4176 /* Certain system events are non-key events. */
4178 && event
->kind
== NS_NONKEY_EVENT
)
4179 *used_mouse_menu
= 1;
4182 /* Wipe out this event, to catch bugs. */
4183 clear_event (event
);
4184 kbd_fetch_ptr
= event
+ 1;
4188 /* Try generating a mouse motion event. */
4189 else if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
4191 struct frame
*f
= some_mouse_moved ();
4192 Lisp_Object bar_window
;
4193 enum scroll_bar_part part
;
4197 *kbp
= current_kboard
;
4198 /* Note that this uses F to determine which terminal to look at.
4199 If there is no valid info, it does not store anything
4200 so x remains nil. */
4203 /* XXX Can f or mouse_position_hook be NULL here? */
4204 if (f
&& FRAME_TERMINAL (f
)->mouse_position_hook
)
4205 (*FRAME_TERMINAL (f
)->mouse_position_hook
) (&f
, 0, &bar_window
,
4210 /* Decide if we should generate a switch-frame event. Don't
4211 generate switch-frame events for motion outside of all Emacs
4217 frame
= FRAME_FOCUS_FRAME (f
);
4219 XSETFRAME (frame
, f
);
4221 if (! EQ (frame
, internal_last_event_frame
)
4222 && !EQ (frame
, selected_frame
))
4223 obj
= make_lispy_switch_frame (frame
);
4224 internal_last_event_frame
= frame
;
4227 /* If we didn't decide to make a switch-frame event, go ahead and
4228 return a mouse-motion event. */
4229 if (!NILP (x
) && NILP (obj
))
4230 obj
= make_lispy_movement (f
, bar_window
, part
, x
, y
, t
);
4233 /* We were promised by the above while loop that there was
4234 something for us to read! */
4237 input_pending
= readable_events (0);
4239 Vlast_event_frame
= internal_last_event_frame
;
4244 /* Process any non-user-visible events (currently X selection events),
4245 without reading any user-visible events. */
4248 process_special_events (void)
4250 struct input_event
*event
;
4252 for (event
= kbd_fetch_ptr
; event
!= kbd_store_ptr
; ++event
)
4254 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
4257 if (event
== kbd_store_ptr
)
4261 /* If we find a stored X selection request, handle it now. */
4262 if (event
->kind
== SELECTION_REQUEST_EVENT
4263 || event
->kind
== SELECTION_CLEAR_EVENT
)
4267 /* Remove the event from the fifo buffer before processing;
4268 otherwise swallow_events called recursively could see it
4269 and process it again. To do this, we move the events
4270 between kbd_fetch_ptr and EVENT one slot to the right,
4273 struct input_event copy
= *event
;
4274 struct input_event
*beg
4275 = (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
4276 ? kbd_buffer
: kbd_fetch_ptr
;
4279 memmove (beg
+ 1, beg
, (event
- beg
) * sizeof (struct input_event
));
4280 else if (event
< beg
)
4282 if (event
> kbd_buffer
)
4283 memmove (kbd_buffer
+ 1, kbd_buffer
,
4284 (event
- kbd_buffer
) * sizeof (struct input_event
));
4285 *kbd_buffer
= *(kbd_buffer
+ KBD_BUFFER_SIZE
- 1);
4286 if (beg
< kbd_buffer
+ KBD_BUFFER_SIZE
- 1)
4287 memmove (beg
+ 1, beg
,
4288 (kbd_buffer
+ KBD_BUFFER_SIZE
- 1 - beg
)
4289 * sizeof (struct input_event
));
4292 if (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
4293 kbd_fetch_ptr
= kbd_buffer
+ 1;
4297 input_pending
= readable_events (0);
4298 x_handle_selection_event (©
);
4300 /* We're getting selection request events, but we don't have
4308 /* Process any events that are not user-visible, run timer events that
4309 are ripe, and return, without reading any user-visible events. */
4312 swallow_events (bool do_display
)
4314 unsigned old_timers_run
;
4316 process_special_events ();
4318 old_timers_run
= timers_run
;
4319 get_input_pending (READABLE_EVENTS_DO_TIMERS_NOW
);
4321 if (!input_pending
&& timers_run
!= old_timers_run
&& do_display
)
4322 redisplay_preserve_echo_area (7);
4325 /* Record the start of when Emacs is idle,
4326 for the sake of running idle-time timers. */
4329 timer_start_idle (void)
4331 /* If we are already in the idle state, do nothing. */
4332 if (timespec_valid_p (timer_idleness_start_time
))
4335 timer_idleness_start_time
= current_timespec ();
4336 timer_last_idleness_start_time
= timer_idleness_start_time
;
4338 /* Mark all idle-time timers as once again candidates for running. */
4339 call0 (intern ("internal-timer-start-idle"));
4342 /* Record that Emacs is no longer idle, so stop running idle-time timers. */
4345 timer_stop_idle (void)
4347 timer_idleness_start_time
= invalid_timespec ();
4350 /* Resume idle timer from last idle start time. */
4353 timer_resume_idle (void)
4355 if (timespec_valid_p (timer_idleness_start_time
))
4358 timer_idleness_start_time
= timer_last_idleness_start_time
;
4361 /* This is only for debugging. */
4362 struct input_event last_timer_event EXTERNALLY_VISIBLE
;
4364 /* List of elisp functions to call, delayed because they were generated in
4365 a context where Elisp could not be safely run (e.g. redisplay, signal,
4366 ...). Each element has the form (FUN . ARGS). */
4367 Lisp_Object pending_funcalls
;
4369 /* Return true if TIMER is a valid timer, placing its value into *RESULT. */
4371 decode_timer (Lisp_Object timer
, struct timespec
*result
)
4373 Lisp_Object
*vector
;
4375 if (! (VECTORP (timer
) && ASIZE (timer
) == 9))
4377 vector
= XVECTOR (timer
)->contents
;
4378 if (! NILP (vector
[0]))
4380 if (! INTEGERP (vector
[2]))
4384 if (! decode_time_components (vector
[1], vector
[2], vector
[3], vector
[8],
4387 *result
= lisp_to_timespec (t
);
4388 return timespec_valid_p (*result
);
4392 /* Check whether a timer has fired. To prevent larger problems we simply
4393 disregard elements that are not proper timers. Do not make a circular
4394 timer list for the time being.
4396 Returns the time to wait until the next timer fires. If a
4397 timer is triggering now, return zero.
4398 If no timer is active, return -1.
4400 If a timer is ripe, we run it, with quitting turned off.
4401 In that case we return 0 to indicate that a new timer_check_2 call
4404 static struct timespec
4405 timer_check_2 (Lisp_Object timers
, Lisp_Object idle_timers
)
4407 struct timespec nexttime
;
4408 struct timespec now
;
4409 struct timespec idleness_now
;
4410 Lisp_Object chosen_timer
;
4411 struct gcpro gcpro1
;
4413 nexttime
= invalid_timespec ();
4415 chosen_timer
= Qnil
;
4416 GCPRO1 (chosen_timer
);
4418 /* First run the code that was delayed. */
4419 while (CONSP (pending_funcalls
))
4421 Lisp_Object funcall
= XCAR (pending_funcalls
);
4422 pending_funcalls
= XCDR (pending_funcalls
);
4423 safe_call2 (Qapply
, XCAR (funcall
), XCDR (funcall
));
4426 if (CONSP (timers
) || CONSP (idle_timers
))
4428 now
= current_timespec ();
4429 idleness_now
= (timespec_valid_p (timer_idleness_start_time
)
4430 ? timespec_sub (now
, timer_idleness_start_time
)
4431 : make_timespec (0, 0));
4434 while (CONSP (timers
) || CONSP (idle_timers
))
4436 Lisp_Object timer
= Qnil
, idle_timer
= Qnil
;
4437 struct timespec timer_time
, idle_timer_time
;
4438 struct timespec difference
;
4439 struct timespec timer_difference
= invalid_timespec ();
4440 struct timespec idle_timer_difference
= invalid_timespec ();
4441 bool ripe
, timer_ripe
= 0, idle_timer_ripe
= 0;
4443 /* Set TIMER and TIMER_DIFFERENCE
4444 based on the next ordinary timer.
4445 TIMER_DIFFERENCE is the distance in time from NOW to when
4446 this timer becomes ripe (negative if it's already ripe).
4447 Skip past invalid timers and timers already handled. */
4450 timer
= XCAR (timers
);
4451 if (! decode_timer (timer
, &timer_time
))
4453 timers
= XCDR (timers
);
4457 timer_ripe
= timespec_cmp (timer_time
, now
) <= 0;
4458 timer_difference
= (timer_ripe
4459 ? timespec_sub (now
, timer_time
)
4460 : timespec_sub (timer_time
, now
));
4463 /* Likewise for IDLE_TIMER and IDLE_TIMER_DIFFERENCE
4464 based on the next idle timer. */
4465 if (CONSP (idle_timers
))
4467 idle_timer
= XCAR (idle_timers
);
4468 if (! decode_timer (idle_timer
, &idle_timer_time
))
4470 idle_timers
= XCDR (idle_timers
);
4474 idle_timer_ripe
= timespec_cmp (idle_timer_time
, idleness_now
) <= 0;
4475 idle_timer_difference
4477 ? timespec_sub (idleness_now
, idle_timer_time
)
4478 : timespec_sub (idle_timer_time
, idleness_now
));
4481 /* Decide which timer is the next timer,
4482 and set CHOSEN_TIMER, DIFFERENCE, and RIPE accordingly.
4483 Also step down the list where we found that timer. */
4485 if (timespec_valid_p (timer_difference
)
4486 && (! timespec_valid_p (idle_timer_difference
)
4487 || idle_timer_ripe
< timer_ripe
4488 || (idle_timer_ripe
== timer_ripe
4490 ? timespec_cmp (idle_timer_difference
,
4492 : timespec_cmp (timer_difference
,
4493 idle_timer_difference
))
4496 chosen_timer
= timer
;
4497 timers
= XCDR (timers
);
4498 difference
= timer_difference
;
4503 chosen_timer
= idle_timer
;
4504 idle_timers
= XCDR (idle_timers
);
4505 difference
= idle_timer_difference
;
4506 ripe
= idle_timer_ripe
;
4509 /* If timer is ripe, run it if it hasn't been run. */
4512 if (NILP (AREF (chosen_timer
, 0)))
4514 ptrdiff_t count
= SPECPDL_INDEX ();
4515 Lisp_Object old_deactivate_mark
= Vdeactivate_mark
;
4517 /* Mark the timer as triggered to prevent problems if the lisp
4518 code fails to reschedule it right. */
4519 ASET (chosen_timer
, 0, Qt
);
4521 specbind (Qinhibit_quit
, Qt
);
4523 call1 (Qtimer_event_handler
, chosen_timer
);
4524 Vdeactivate_mark
= old_deactivate_mark
;
4526 unbind_to (count
, Qnil
);
4528 /* Since we have handled the event,
4529 we don't need to tell the caller to wake up and do it. */
4530 /* But the caller must still wait for the next timer, so
4531 return 0 to indicate that. */
4534 nexttime
= make_timespec (0, 0);
4538 /* When we encounter a timer that is still waiting,
4539 return the amount of time to wait before it is ripe. */
4546 /* No timers are pending in the future. */
4547 /* Return 0 if we generated an event, and -1 if not. */
4553 /* Check whether a timer has fired. To prevent larger problems we simply
4554 disregard elements that are not proper timers. Do not make a circular
4555 timer list for the time being.
4557 Returns the time to wait until the next timer fires.
4558 If no timer is active, return an invalid value.
4560 As long as any timer is ripe, we run it. */
4565 struct timespec nexttime
;
4566 Lisp_Object timers
, idle_timers
;
4567 struct gcpro gcpro1
, gcpro2
;
4569 Lisp_Object tem
= Vinhibit_quit
;
4572 /* We use copies of the timers' lists to allow a timer to add itself
4573 again, without locking up Emacs if the newly added timer is
4574 already ripe when added. */
4576 /* Always consider the ordinary timers. */
4577 timers
= Fcopy_sequence (Vtimer_list
);
4578 /* Consider the idle timers only if Emacs is idle. */
4579 if (timespec_valid_p (timer_idleness_start_time
))
4580 idle_timers
= Fcopy_sequence (Vtimer_idle_list
);
4584 Vinhibit_quit
= tem
;
4586 GCPRO2 (timers
, idle_timers
);
4590 nexttime
= timer_check_2 (timers
, idle_timers
);
4592 while (nexttime
.tv_sec
== 0 && nexttime
.tv_nsec
== 0);
4598 DEFUN ("current-idle-time", Fcurrent_idle_time
, Scurrent_idle_time
, 0, 0, 0,
4599 doc
: /* Return the current length of Emacs idleness, or nil.
4600 The value when Emacs is idle is a list of four integers (HIGH LOW USEC PSEC)
4601 in the same style as (current-time).
4603 The value when Emacs is not idle is nil.
4605 PSEC is a multiple of the system clock resolution. */)
4608 if (timespec_valid_p (timer_idleness_start_time
))
4609 return make_lisp_time (timespec_sub (current_timespec (),
4610 timer_idleness_start_time
));
4615 /* Caches for modify_event_symbol. */
4616 static Lisp_Object accent_key_syms
;
4617 static Lisp_Object func_key_syms
;
4618 static Lisp_Object mouse_syms
;
4619 static Lisp_Object wheel_syms
;
4620 static Lisp_Object drag_n_drop_syms
;
4622 /* This is a list of keysym codes for special "accent" characters.
4623 It parallels lispy_accent_keys. */
4625 static const int lispy_accent_codes
[] =
4627 #ifdef XK_dead_circumflex
4632 #ifdef XK_dead_grave
4637 #ifdef XK_dead_tilde
4642 #ifdef XK_dead_diaeresis
4647 #ifdef XK_dead_macron
4652 #ifdef XK_dead_degree
4657 #ifdef XK_dead_acute
4662 #ifdef XK_dead_cedilla
4667 #ifdef XK_dead_breve
4672 #ifdef XK_dead_ogonek
4677 #ifdef XK_dead_caron
4682 #ifdef XK_dead_doubleacute
4683 XK_dead_doubleacute
,
4687 #ifdef XK_dead_abovedot
4692 #ifdef XK_dead_abovering
4702 #ifdef XK_dead_belowdot
4707 #ifdef XK_dead_voiced_sound
4708 XK_dead_voiced_sound
,
4712 #ifdef XK_dead_semivoiced_sound
4713 XK_dead_semivoiced_sound
,
4729 /* This is a list of Lisp names for special "accent" characters.
4730 It parallels lispy_accent_codes. */
4732 static const char *const lispy_accent_keys
[] =
4750 "dead-voiced-sound",
4751 "dead-semivoiced-sound",
4757 #define FUNCTION_KEY_OFFSET 0x0
4759 const char *const lispy_function_keys
[] =
4763 0, /* VK_LBUTTON 0x01 */
4764 0, /* VK_RBUTTON 0x02 */
4765 "cancel", /* VK_CANCEL 0x03 */
4766 0, /* VK_MBUTTON 0x04 */
4768 0, 0, 0, /* 0x05 .. 0x07 */
4770 "backspace", /* VK_BACK 0x08 */
4771 "tab", /* VK_TAB 0x09 */
4773 0, 0, /* 0x0A .. 0x0B */
4775 "clear", /* VK_CLEAR 0x0C */
4776 "return", /* VK_RETURN 0x0D */
4778 0, 0, /* 0x0E .. 0x0F */
4780 0, /* VK_SHIFT 0x10 */
4781 0, /* VK_CONTROL 0x11 */
4782 0, /* VK_MENU 0x12 */
4783 "pause", /* VK_PAUSE 0x13 */
4784 "capslock", /* VK_CAPITAL 0x14 */
4785 "kana", /* VK_KANA/VK_HANGUL 0x15 */
4787 "junja", /* VK_JUNJA 0x17 */
4788 "final", /* VK_FINAL 0x18 */
4789 "kanji", /* VK_KANJI/VK_HANJA 0x19 */
4791 "escape", /* VK_ESCAPE 0x1B */
4792 "convert", /* VK_CONVERT 0x1C */
4793 "non-convert", /* VK_NONCONVERT 0x1D */
4794 "accept", /* VK_ACCEPT 0x1E */
4795 "mode-change", /* VK_MODECHANGE 0x1F */
4796 0, /* VK_SPACE 0x20 */
4797 "prior", /* VK_PRIOR 0x21 */
4798 "next", /* VK_NEXT 0x22 */
4799 "end", /* VK_END 0x23 */
4800 "home", /* VK_HOME 0x24 */
4801 "left", /* VK_LEFT 0x25 */
4802 "up", /* VK_UP 0x26 */
4803 "right", /* VK_RIGHT 0x27 */
4804 "down", /* VK_DOWN 0x28 */
4805 "select", /* VK_SELECT 0x29 */
4806 "print", /* VK_PRINT 0x2A */
4807 "execute", /* VK_EXECUTE 0x2B */
4808 "snapshot", /* VK_SNAPSHOT 0x2C */
4809 "insert", /* VK_INSERT 0x2D */
4810 "delete", /* VK_DELETE 0x2E */
4811 "help", /* VK_HELP 0x2F */
4813 /* VK_0 thru VK_9 are the same as ASCII '0' thru '9' (0x30 - 0x39) */
4815 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4817 0, 0, 0, 0, 0, 0, 0, /* 0x3A .. 0x40 */
4819 /* VK_A thru VK_Z are the same as ASCII 'A' thru 'Z' (0x41 - 0x5A) */
4821 0, 0, 0, 0, 0, 0, 0, 0, 0,
4822 0, 0, 0, 0, 0, 0, 0, 0, 0,
4823 0, 0, 0, 0, 0, 0, 0, 0,
4825 "lwindow", /* VK_LWIN 0x5B */
4826 "rwindow", /* VK_RWIN 0x5C */
4827 "apps", /* VK_APPS 0x5D */
4830 "kp-0", /* VK_NUMPAD0 0x60 */
4831 "kp-1", /* VK_NUMPAD1 0x61 */
4832 "kp-2", /* VK_NUMPAD2 0x62 */
4833 "kp-3", /* VK_NUMPAD3 0x63 */
4834 "kp-4", /* VK_NUMPAD4 0x64 */
4835 "kp-5", /* VK_NUMPAD5 0x65 */
4836 "kp-6", /* VK_NUMPAD6 0x66 */
4837 "kp-7", /* VK_NUMPAD7 0x67 */
4838 "kp-8", /* VK_NUMPAD8 0x68 */
4839 "kp-9", /* VK_NUMPAD9 0x69 */
4840 "kp-multiply", /* VK_MULTIPLY 0x6A */
4841 "kp-add", /* VK_ADD 0x6B */
4842 "kp-separator", /* VK_SEPARATOR 0x6C */
4843 "kp-subtract", /* VK_SUBTRACT 0x6D */
4844 "kp-decimal", /* VK_DECIMAL 0x6E */
4845 "kp-divide", /* VK_DIVIDE 0x6F */
4846 "f1", /* VK_F1 0x70 */
4847 "f2", /* VK_F2 0x71 */
4848 "f3", /* VK_F3 0x72 */
4849 "f4", /* VK_F4 0x73 */
4850 "f5", /* VK_F5 0x74 */
4851 "f6", /* VK_F6 0x75 */
4852 "f7", /* VK_F7 0x76 */
4853 "f8", /* VK_F8 0x77 */
4854 "f9", /* VK_F9 0x78 */
4855 "f10", /* VK_F10 0x79 */
4856 "f11", /* VK_F11 0x7A */
4857 "f12", /* VK_F12 0x7B */
4858 "f13", /* VK_F13 0x7C */
4859 "f14", /* VK_F14 0x7D */
4860 "f15", /* VK_F15 0x7E */
4861 "f16", /* VK_F16 0x7F */
4862 "f17", /* VK_F17 0x80 */
4863 "f18", /* VK_F18 0x81 */
4864 "f19", /* VK_F19 0x82 */
4865 "f20", /* VK_F20 0x83 */
4866 "f21", /* VK_F21 0x84 */
4867 "f22", /* VK_F22 0x85 */
4868 "f23", /* VK_F23 0x86 */
4869 "f24", /* VK_F24 0x87 */
4871 0, 0, 0, 0, /* 0x88 .. 0x8B */
4872 0, 0, 0, 0, /* 0x8C .. 0x8F */
4874 "kp-numlock", /* VK_NUMLOCK 0x90 */
4875 "scroll", /* VK_SCROLL 0x91 */
4876 /* Not sure where the following block comes from.
4877 Windows headers have NEC and Fujitsu specific keys in
4878 this block, but nothing generic. */
4879 "kp-space", /* VK_NUMPAD_CLEAR 0x92 */
4880 "kp-enter", /* VK_NUMPAD_ENTER 0x93 */
4881 "kp-prior", /* VK_NUMPAD_PRIOR 0x94 */
4882 "kp-next", /* VK_NUMPAD_NEXT 0x95 */
4883 "kp-end", /* VK_NUMPAD_END 0x96 */
4884 "kp-home", /* VK_NUMPAD_HOME 0x97 */
4885 "kp-left", /* VK_NUMPAD_LEFT 0x98 */
4886 "kp-up", /* VK_NUMPAD_UP 0x99 */
4887 "kp-right", /* VK_NUMPAD_RIGHT 0x9A */
4888 "kp-down", /* VK_NUMPAD_DOWN 0x9B */
4889 "kp-insert", /* VK_NUMPAD_INSERT 0x9C */
4890 "kp-delete", /* VK_NUMPAD_DELETE 0x9D */
4892 0, 0, /* 0x9E .. 0x9F */
4895 * VK_L* & VK_R* - left and right Alt, Ctrl and Shift virtual keys.
4896 * Used only as parameters to GetAsyncKeyState and GetKeyState.
4897 * No other API or message will distinguish left and right keys this way.
4902 /* Multimedia keys. These are handled as WM_APPCOMMAND, which allows us
4903 to enable them selectively, and gives access to a few more functions.
4904 See lispy_multimedia_keys below. */
4905 0, 0, 0, 0, 0, 0, 0, /* 0xA6 .. 0xAC Browser */
4906 0, 0, 0, /* 0xAD .. 0xAF Volume */
4907 0, 0, 0, 0, /* 0xB0 .. 0xB3 Media */
4908 0, 0, 0, 0, /* 0xB4 .. 0xB7 Apps */
4910 /* 0xB8 .. 0xC0 "OEM" keys - all seem to be punctuation. */
4911 0, 0, 0, 0, 0, 0, 0, 0, 0,
4913 /* 0xC1 - 0xDA unallocated, 0xDB-0xDF more OEM keys */
4914 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4915 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4918 "ax", /* VK_OEM_AX 0xE1 */
4919 0, /* VK_OEM_102 0xE2 */
4920 "ico-help", /* VK_ICO_HELP 0xE3 */
4921 "ico-00", /* VK_ICO_00 0xE4 */
4922 0, /* VK_PROCESSKEY 0xE5 - used by IME */
4923 "ico-clear", /* VK_ICO_CLEAR 0xE6 */
4924 0, /* VK_PACKET 0xE7 - used to pass Unicode chars */
4926 "reset", /* VK_OEM_RESET 0xE9 */
4927 "jump", /* VK_OEM_JUMP 0xEA */
4928 "oem-pa1", /* VK_OEM_PA1 0xEB */
4929 "oem-pa2", /* VK_OEM_PA2 0xEC */
4930 "oem-pa3", /* VK_OEM_PA3 0xED */
4931 "wsctrl", /* VK_OEM_WSCTRL 0xEE */
4932 "cusel", /* VK_OEM_CUSEL 0xEF */
4933 "oem-attn", /* VK_OEM_ATTN 0xF0 */
4934 "finish", /* VK_OEM_FINISH 0xF1 */
4935 "copy", /* VK_OEM_COPY 0xF2 */
4936 "auto", /* VK_OEM_AUTO 0xF3 */
4937 "enlw", /* VK_OEM_ENLW 0xF4 */
4938 "backtab", /* VK_OEM_BACKTAB 0xF5 */
4939 "attn", /* VK_ATTN 0xF6 */
4940 "crsel", /* VK_CRSEL 0xF7 */
4941 "exsel", /* VK_EXSEL 0xF8 */
4942 "ereof", /* VK_EREOF 0xF9 */
4943 "play", /* VK_PLAY 0xFA */
4944 "zoom", /* VK_ZOOM 0xFB */
4945 "noname", /* VK_NONAME 0xFC */
4946 "pa1", /* VK_PA1 0xFD */
4947 "oem_clear", /* VK_OEM_CLEAR 0xFE */
4951 /* Some of these duplicate the "Media keys" on newer keyboards,
4952 but they are delivered to the application in a different way. */
4953 static const char *const lispy_multimedia_keys
[] =
4961 "browser-favorites",
4998 "toggle-dictate-command",
5004 "media-fast-forward",
5007 "media-channel-down"
5010 #else /* not HAVE_NTGUI */
5012 /* This should be dealt with in XTread_socket now, and that doesn't
5013 depend on the client system having the Kana syms defined. See also
5014 the XK_kana_A case below. */
5017 static const char *const lispy_kana_keys
[] =
5019 /* X Keysym value */
5020 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x400 .. 0x40f */
5021 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x410 .. 0x41f */
5022 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x420 .. 0x42f */
5023 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x430 .. 0x43f */
5024 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x440 .. 0x44f */
5025 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x450 .. 0x45f */
5026 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x460 .. 0x46f */
5027 0,0,0,0,0,0,0,0,0,0,0,0,0,0,"overline",0,
5028 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x480 .. 0x48f */
5029 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x490 .. 0x49f */
5030 0, "kana-fullstop", "kana-openingbracket", "kana-closingbracket",
5031 "kana-comma", "kana-conjunctive", "kana-WO", "kana-a",
5032 "kana-i", "kana-u", "kana-e", "kana-o",
5033 "kana-ya", "kana-yu", "kana-yo", "kana-tsu",
5034 "prolongedsound", "kana-A", "kana-I", "kana-U",
5035 "kana-E", "kana-O", "kana-KA", "kana-KI",
5036 "kana-KU", "kana-KE", "kana-KO", "kana-SA",
5037 "kana-SHI", "kana-SU", "kana-SE", "kana-SO",
5038 "kana-TA", "kana-CHI", "kana-TSU", "kana-TE",
5039 "kana-TO", "kana-NA", "kana-NI", "kana-NU",
5040 "kana-NE", "kana-NO", "kana-HA", "kana-HI",
5041 "kana-FU", "kana-HE", "kana-HO", "kana-MA",
5042 "kana-MI", "kana-MU", "kana-ME", "kana-MO",
5043 "kana-YA", "kana-YU", "kana-YO", "kana-RA",
5044 "kana-RI", "kana-RU", "kana-RE", "kana-RO",
5045 "kana-WA", "kana-N", "voicedsound", "semivoicedsound",
5046 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4e0 .. 0x4ef */
5047 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4f0 .. 0x4ff */
5049 #endif /* XK_kana_A */
5052 #define FUNCTION_KEY_OFFSET 0xff00
5054 /* You'll notice that this table is arranged to be conveniently
5055 indexed by X Windows keysym values. */
5056 static const char *const lispy_function_keys
[] =
5058 /* X Keysym value */
5060 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff00...0f */
5061 "backspace", "tab", "linefeed", "clear",
5063 0, 0, 0, "pause", /* 0xff10...1f */
5064 0, 0, 0, 0, 0, 0, 0, "escape",
5066 0, "kanji", "muhenkan", "henkan", /* 0xff20...2f */
5067 "romaji", "hiragana", "katakana", "hiragana-katakana",
5068 "zenkaku", "hankaku", "zenkaku-hankaku", "touroku",
5069 "massyo", "kana-lock", "kana-shift", "eisu-shift",
5070 "eisu-toggle", /* 0xff30...3f */
5071 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
5072 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff40...4f */
5074 "home", "left", "up", "right", /* 0xff50 */ /* IsCursorKey */
5075 "down", "prior", "next", "end",
5076 "begin", 0, 0, 0, 0, 0, 0, 0,
5077 "select", /* 0xff60 */ /* IsMiscFunctionKey */
5088 "break", /* 0xff6b */
5091 0, 0, 0, 0, "backtab", 0, 0, 0, /* 0xff70... */
5092 0, 0, 0, 0, 0, 0, 0, "kp-numlock", /* 0xff78... */
5093 "kp-space", /* 0xff80 */ /* IsKeypadKey */
5094 0, 0, 0, 0, 0, 0, 0, 0,
5095 "kp-tab", /* 0xff89 */
5097 "kp-enter", /* 0xff8d */
5099 "kp-f1", /* 0xff91 */
5103 "kp-home", /* 0xff95 */
5108 "kp-prior", /* kp-page-up */
5109 "kp-next", /* kp-page-down */
5115 0, 0, 0, 0, 0, 0, 0, 0, 0,
5116 "kp-multiply", /* 0xffaa */
5121 "kp-divide", /* 0xffaf */
5122 "kp-0", /* 0xffb0 */
5123 "kp-1", "kp-2", "kp-3", "kp-4", "kp-5", "kp-6", "kp-7", "kp-8", "kp-9",
5126 "kp-equal", /* 0xffbd */
5127 "f1", /* 0xffbe */ /* IsFunctionKey */
5129 "f3", "f4", "f5", "f6", "f7", "f8", "f9", "f10", /* 0xffc0 */
5130 "f11", "f12", "f13", "f14", "f15", "f16", "f17", "f18",
5131 "f19", "f20", "f21", "f22", "f23", "f24", "f25", "f26", /* 0xffd0 */
5132 "f27", "f28", "f29", "f30", "f31", "f32", "f33", "f34",
5133 "f35", 0, 0, 0, 0, 0, 0, 0, /* 0xffe0 */
5134 0, 0, 0, 0, 0, 0, 0, 0,
5135 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfff0 */
5136 0, 0, 0, 0, 0, 0, 0, "delete"
5139 /* ISO 9995 Function and Modifier Keys; the first byte is 0xFE. */
5140 #define ISO_FUNCTION_KEY_OFFSET 0xfe00
5142 static const char *const iso_lispy_function_keys
[] =
5144 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe00 */
5145 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe08 */
5146 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe10 */
5147 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe18 */
5148 "iso-lefttab", /* 0xfe20 */
5149 "iso-move-line-up", "iso-move-line-down",
5150 "iso-partial-line-up", "iso-partial-line-down",
5151 "iso-partial-space-left", "iso-partial-space-right",
5152 "iso-set-margin-left", "iso-set-margin-right", /* 0xffe27, 28 */
5153 "iso-release-margin-left", "iso-release-margin-right",
5154 "iso-release-both-margins",
5155 "iso-fast-cursor-left", "iso-fast-cursor-right",
5156 "iso-fast-cursor-up", "iso-fast-cursor-down",
5157 "iso-continuous-underline", "iso-discontinuous-underline", /* 0xfe30, 31 */
5158 "iso-emphasize", "iso-center-object", "iso-enter", /* ... 0xfe34 */
5161 #endif /* not HAVE_NTGUI */
5163 static Lisp_Object Vlispy_mouse_stem
;
5165 static const char *const lispy_wheel_names
[] =
5167 "wheel-up", "wheel-down", "wheel-left", "wheel-right"
5170 /* drag-n-drop events are generated when a set of selected files are
5171 dragged from another application and dropped onto an Emacs window. */
5172 static const char *const lispy_drag_n_drop_names
[] =
5177 /* An array of symbol indexes of scroll bar parts, indexed by an enum
5178 scroll_bar_part value. Note that Qnil corresponds to
5179 scroll_bar_nowhere and should not appear in Lisp events. */
5180 static short const scroll_bar_parts
[] = {
5181 SYMBOL_INDEX (Qnil
), SYMBOL_INDEX (Qabove_handle
), SYMBOL_INDEX (Qhandle
),
5182 SYMBOL_INDEX (Qbelow_handle
), SYMBOL_INDEX (Qup
), SYMBOL_INDEX (Qdown
),
5183 SYMBOL_INDEX (Qtop
), SYMBOL_INDEX (Qbottom
), SYMBOL_INDEX (Qend_scroll
),
5184 SYMBOL_INDEX (Qratio
), SYMBOL_INDEX (Qbefore_handle
),
5185 SYMBOL_INDEX (Qhorizontal_handle
), SYMBOL_INDEX (Qafter_handle
),
5186 SYMBOL_INDEX (Qleft
), SYMBOL_INDEX (Qright
), SYMBOL_INDEX (Qleftmost
),
5187 SYMBOL_INDEX (Qrightmost
), SYMBOL_INDEX (Qend_scroll
), SYMBOL_INDEX (Qratio
)
5190 /* A vector, indexed by button number, giving the down-going location
5191 of currently depressed buttons, both scroll bar and non-scroll bar.
5193 The elements have the form
5194 (BUTTON-NUMBER MODIFIER-MASK . REST)
5195 where REST is the cdr of a position as it would be reported in the event.
5197 The make_lispy_event function stores positions here to tell the
5198 difference between click and drag events, and to store the starting
5199 location to be included in drag events. */
5201 static Lisp_Object button_down_location
;
5203 /* Information about the most recent up-going button event: Which
5204 button, what location, and what time. */
5206 static int last_mouse_button
;
5207 static int last_mouse_x
;
5208 static int last_mouse_y
;
5209 static Time button_down_time
;
5211 /* The number of clicks in this multiple-click. */
5213 static int double_click_count
;
5215 /* X and Y are frame-relative coordinates for a click or wheel event.
5216 Return a Lisp-style event list. */
5219 make_lispy_position (struct frame
*f
, Lisp_Object x
, Lisp_Object y
,
5222 enum window_part part
;
5223 Lisp_Object posn
= Qnil
;
5224 Lisp_Object extra_info
= Qnil
;
5225 /* Coordinate pixel positions to return. */
5226 int xret
= 0, yret
= 0;
5227 /* The window under frame pixel coordinates (x,y) */
5228 Lisp_Object window
= f
5229 ? window_from_coordinates (f
, XINT (x
), XINT (y
), &part
, 0)
5232 if (WINDOWP (window
))
5234 /* It's a click in window WINDOW at frame coordinates (X,Y) */
5235 struct window
*w
= XWINDOW (window
);
5236 Lisp_Object string_info
= Qnil
;
5237 ptrdiff_t textpos
= 0;
5238 int col
= -1, row
= -1;
5239 int dx
= -1, dy
= -1;
5240 int width
= -1, height
= -1;
5241 Lisp_Object object
= Qnil
;
5243 /* Pixel coordinates relative to the window corner. */
5244 int wx
= XINT (x
) - WINDOW_LEFT_EDGE_X (w
);
5245 int wy
= XINT (y
) - WINDOW_TOP_EDGE_Y (w
);
5247 /* For text area clicks, return X, Y relative to the corner of
5248 this text area. Note that dX, dY etc are set below, by
5249 buffer_posn_from_coords. */
5250 if (part
== ON_TEXT
)
5252 xret
= XINT (x
) - window_box_left (w
, TEXT_AREA
);
5253 yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5255 /* For mode line and header line clicks, return X, Y relative to
5256 the left window edge. Use mode_line_string to look for a
5257 string on the click position. */
5258 else if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
)
5263 posn
= (part
== ON_MODE_LINE
) ? Qmode_line
: Qheader_line
;
5264 /* Note that mode_line_string takes COL, ROW as pixels and
5265 converts them to characters. */
5268 string
= mode_line_string (w
, part
, &col
, &row
, &charpos
,
5269 &object
, &dx
, &dy
, &width
, &height
);
5270 if (STRINGP (string
))
5271 string_info
= Fcons (string
, make_number (charpos
));
5277 /* For fringes and margins, Y is relative to the area's (and the
5278 window's) top edge, while X is meaningless. */
5279 else if (part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
5284 posn
= (part
== ON_LEFT_MARGIN
) ? Qleft_margin
: Qright_margin
;
5287 string
= marginal_area_string (w
, part
, &col
, &row
, &charpos
,
5288 &object
, &dx
, &dy
, &width
, &height
);
5289 if (STRINGP (string
))
5290 string_info
= Fcons (string
, make_number (charpos
));
5292 yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5294 else if (part
== ON_LEFT_FRINGE
)
5296 posn
= Qleft_fringe
;
5300 - (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5301 ? 0 : window_box_width (w
, LEFT_MARGIN_AREA
));
5302 dy
= yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5304 else if (part
== ON_RIGHT_FRINGE
)
5306 posn
= Qright_fringe
;
5310 - window_box_width (w
, LEFT_MARGIN_AREA
)
5311 - window_box_width (w
, TEXT_AREA
)
5312 - (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5313 ? window_box_width (w
, RIGHT_MARGIN_AREA
)
5315 dy
= yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5317 else if (part
== ON_VERTICAL_BORDER
)
5319 posn
= Qvertical_line
;
5325 else if (part
== ON_VERTICAL_SCROLL_BAR
)
5327 posn
= Qvertical_scroll_bar
;
5328 width
= WINDOW_SCROLL_BAR_AREA_WIDTH (w
);
5332 else if (part
== ON_HORIZONTAL_SCROLL_BAR
)
5334 posn
= Qhorizontal_scroll_bar
;
5335 width
= WINDOW_SCROLL_BAR_AREA_HEIGHT (w
);
5339 else if (part
== ON_RIGHT_DIVIDER
)
5341 posn
= Qright_divider
;
5342 width
= WINDOW_RIGHT_DIVIDER_WIDTH (w
);
5346 else if (part
== ON_BOTTOM_DIVIDER
)
5348 posn
= Qbottom_divider
;
5349 width
= WINDOW_BOTTOM_DIVIDER_WIDTH (w
);
5354 /* For clicks in the text area, fringes, or margins, call
5355 buffer_posn_from_coords to extract TEXTPOS, the buffer
5356 position nearest to the click. */
5359 Lisp_Object string2
, object2
= Qnil
;
5360 struct display_pos p
;
5362 int width2
, height2
;
5363 /* The pixel X coordinate passed to buffer_posn_from_coords
5364 is the X coordinate relative to the text area for
5365 text-area and right-margin clicks, zero otherwise. */
5367 = (part
== ON_TEXT
) ? xret
5368 : (part
== ON_RIGHT_FRINGE
|| part
== ON_RIGHT_MARGIN
)
5369 ? (XINT (x
) - window_box_left (w
, TEXT_AREA
))
5373 string2
= buffer_posn_from_coords (w
, &x2
, &y2
, &p
,
5374 &object2
, &dx2
, &dy2
,
5376 textpos
= CHARPOS (p
.pos
);
5377 if (col
< 0) col
= x2
;
5378 if (row
< 0) row
= y2
;
5379 if (dx
< 0) dx
= dx2
;
5380 if (dy
< 0) dy
= dy2
;
5381 if (width
< 0) width
= width2
;
5382 if (height
< 0) height
= height2
;
5386 posn
= make_number (textpos
);
5387 if (STRINGP (string2
))
5388 string_info
= Fcons (string2
,
5389 make_number (CHARPOS (p
.string_pos
)));
5395 #ifdef HAVE_WINDOW_SYSTEM
5396 if (IMAGEP (object
))
5398 Lisp_Object image_map
, hotspot
;
5399 if ((image_map
= Fplist_get (XCDR (object
), QCmap
),
5401 && (hotspot
= find_hot_spot (image_map
, dx
, dy
),
5403 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
5404 posn
= XCAR (hotspot
);
5411 Fcons (make_number (dx
), make_number (dy
)),
5412 Fcons (make_number (width
), make_number (height
)));
5415 extra_info
= Fcons (string_info
,
5416 Fcons (textpos
< 0 ? Qnil
: make_number (textpos
),
5417 Fcons (Fcons (make_number (col
),
5423 /* Return mouse pixel coordinates here. */
5424 XSETFRAME (window
, f
);
5431 return Fcons (window
,
5433 Fcons (Fcons (make_number (xret
),
5434 make_number (yret
)),
5435 Fcons (make_number (t
),
5439 /* Return non-zero if F is a GUI frame that uses some toolkit-managed
5440 menu bar. This really means that Emacs draws and manages the menu
5441 bar as part of its normal display, and therefore can compute its
5444 toolkit_menubar_in_use (struct frame
*f
)
5446 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS) || defined (HAVE_NTGUI)
5447 return !(!FRAME_WINDOW_P (f
));
5453 /* Build the part of Lisp event which represents scroll bar state from
5454 EV. TYPE is one of Qvertical_scroll_bar or Qhorizontal_scroll_bar. */
5457 make_scroll_bar_position (struct input_event
*ev
, Lisp_Object type
)
5459 return list5 (ev
->frame_or_window
, type
, Fcons (ev
->x
, ev
->y
),
5460 make_number (ev
->timestamp
),
5461 builtin_lisp_symbol (scroll_bar_parts
[ev
->part
]));
5464 /* Given a struct input_event, build the lisp event which represents
5465 it. If EVENT is 0, build a mouse movement event from the mouse
5466 movement buffer, which should have a movement event in it.
5468 Note that events must be passed to this function in the order they
5469 are received; this function stores the location of button presses
5470 in order to build drag events when the button is released. */
5473 make_lispy_event (struct input_event
*event
)
5477 switch (event
->kind
)
5479 /* A simple keystroke. */
5480 case ASCII_KEYSTROKE_EVENT
:
5481 case MULTIBYTE_CHAR_KEYSTROKE_EVENT
:
5483 Lisp_Object lispy_c
;
5484 EMACS_INT c
= event
->code
;
5485 if (event
->kind
== ASCII_KEYSTROKE_EVENT
)
5488 eassert (c
== event
->code
);
5489 /* Turn ASCII characters into control characters
5491 if (event
->modifiers
& ctrl_modifier
)
5493 c
= make_ctrl_char (c
);
5494 event
->modifiers
&= ~ctrl_modifier
;
5498 /* Add in the other modifier bits. The shift key was taken care
5499 of by the X code. */
5500 c
|= (event
->modifiers
5501 & (meta_modifier
| alt_modifier
5502 | hyper_modifier
| super_modifier
| ctrl_modifier
));
5503 /* Distinguish Shift-SPC from SPC. */
5504 if ((event
->code
) == 040
5505 && event
->modifiers
& shift_modifier
)
5506 c
|= shift_modifier
;
5507 button_down_time
= 0;
5508 XSETFASTINT (lispy_c
, c
);
5513 /* NS_NONKEY_EVENTs are just like NON_ASCII_KEYSTROKE_EVENTs,
5514 except that they are non-key events (last-nonmenu-event is nil). */
5515 case NS_NONKEY_EVENT
:
5518 /* A function key. The symbol may need to have modifier prefixes
5520 case NON_ASCII_KEYSTROKE_EVENT
:
5521 button_down_time
= 0;
5523 for (i
= 0; i
< ARRAYELTS (lispy_accent_codes
); i
++)
5524 if (event
->code
== lispy_accent_codes
[i
])
5525 return modify_event_symbol (i
,
5527 Qfunction_key
, Qnil
,
5528 lispy_accent_keys
, &accent_key_syms
,
5529 ARRAYELTS (lispy_accent_keys
));
5533 if (event
->code
>= 0x400 && event
->code
< 0x500)
5534 return modify_event_symbol (event
->code
- 0x400,
5535 event
->modifiers
& ~shift_modifier
,
5536 Qfunction_key
, Qnil
,
5537 lispy_kana_keys
, &func_key_syms
,
5538 ARRAYELTS (lispy_kana_keys
));
5539 #endif /* XK_kana_A */
5542 #ifdef ISO_FUNCTION_KEY_OFFSET
5543 if (event
->code
< FUNCTION_KEY_OFFSET
5544 && event
->code
>= ISO_FUNCTION_KEY_OFFSET
)
5545 return modify_event_symbol (event
->code
- ISO_FUNCTION_KEY_OFFSET
,
5547 Qfunction_key
, Qnil
,
5548 iso_lispy_function_keys
, &func_key_syms
,
5549 ARRAYELTS (iso_lispy_function_keys
));
5552 if ((FUNCTION_KEY_OFFSET
<= event
->code
5554 < FUNCTION_KEY_OFFSET
+ ARRAYELTS (lispy_function_keys
)))
5555 && lispy_function_keys
[event
->code
- FUNCTION_KEY_OFFSET
])
5556 return modify_event_symbol (event
->code
- FUNCTION_KEY_OFFSET
,
5558 Qfunction_key
, Qnil
,
5559 lispy_function_keys
, &func_key_syms
,
5560 ARRAYELTS (lispy_function_keys
));
5562 /* Handle system-specific or unknown keysyms.
5563 We need to use an alist rather than a vector as the cache
5564 since we can't make a vector long enough. */
5565 if (NILP (KVAR (current_kboard
, system_key_syms
)))
5566 kset_system_key_syms (current_kboard
, Fcons (Qnil
, Qnil
));
5567 return modify_event_symbol (event
->code
,
5570 KVAR (current_kboard
, Vsystem_key_alist
),
5571 0, &KVAR (current_kboard
, system_key_syms
),
5575 case MULTIMEDIA_KEY_EVENT
:
5576 if (event
->code
< ARRAYELTS (lispy_multimedia_keys
)
5577 && event
->code
> 0 && lispy_multimedia_keys
[event
->code
])
5579 return modify_event_symbol (event
->code
, event
->modifiers
,
5580 Qfunction_key
, Qnil
,
5581 lispy_multimedia_keys
, &func_key_syms
,
5582 ARRAYELTS (lispy_multimedia_keys
));
5587 /* A mouse click. Figure out where it is, decide whether it's
5588 a press, click or drag, and build the appropriate structure. */
5589 case MOUSE_CLICK_EVENT
:
5591 case GPM_CLICK_EVENT
:
5593 #ifndef USE_TOOLKIT_SCROLL_BARS
5594 case SCROLL_BAR_CLICK_EVENT
:
5595 case HORIZONTAL_SCROLL_BAR_CLICK_EVENT
:
5598 int button
= event
->code
;
5600 Lisp_Object position
;
5601 Lisp_Object
*start_pos_ptr
;
5602 Lisp_Object start_pos
;
5606 /* Build the position as appropriate for this mouse click. */
5607 if (event
->kind
== MOUSE_CLICK_EVENT
5609 || event
->kind
== GPM_CLICK_EVENT
5613 struct frame
*f
= XFRAME (event
->frame_or_window
);
5616 /* Ignore mouse events that were made on frame that
5617 have been deleted. */
5618 if (! FRAME_LIVE_P (f
))
5621 /* EVENT->x and EVENT->y are frame-relative pixel
5622 coordinates at this place. Under old redisplay, COLUMN
5623 and ROW are set to frame relative glyph coordinates
5624 which are then used to determine whether this click is
5625 in a menu (non-toolkit version). */
5626 if (!toolkit_menubar_in_use (f
))
5628 pixel_to_glyph_coords (f
, XINT (event
->x
), XINT (event
->y
),
5629 &column
, &row
, NULL
, 1);
5631 /* In the non-toolkit version, clicks on the menu bar
5632 are ordinary button events in the event buffer.
5633 Distinguish them, and invoke the menu.
5635 (In the toolkit version, the toolkit handles the
5636 menu bar and Emacs doesn't know about it until
5637 after the user makes a selection.) */
5638 if (row
>= 0 && row
< FRAME_MENU_BAR_LINES (f
)
5639 && (event
->modifiers
& down_modifier
))
5641 Lisp_Object items
, item
;
5643 /* Find the menu bar item under `column'. */
5645 items
= FRAME_MENU_BAR_ITEMS (f
);
5646 for (i
= 0; i
< ASIZE (items
); i
+= 4)
5648 Lisp_Object pos
, string
;
5649 string
= AREF (items
, i
+ 1);
5650 pos
= AREF (items
, i
+ 3);
5653 if (column
>= XINT (pos
)
5654 && column
< XINT (pos
) + SCHARS (string
))
5656 item
= AREF (items
, i
);
5661 /* ELisp manual 2.4b says (x y) are window
5662 relative but code says they are
5664 position
= list4 (event
->frame_or_window
,
5666 Fcons (event
->x
, event
->y
),
5667 make_number (event
->timestamp
));
5669 return list2 (item
, position
);
5673 position
= make_lispy_position (f
, event
->x
, event
->y
,
5676 #ifndef USE_TOOLKIT_SCROLL_BARS
5678 /* It's a scrollbar click. */
5679 position
= make_scroll_bar_position (event
, Qvertical_scroll_bar
);
5680 #endif /* not USE_TOOLKIT_SCROLL_BARS */
5682 if (button
>= ASIZE (button_down_location
))
5684 ptrdiff_t incr
= button
- ASIZE (button_down_location
) + 1;
5685 button_down_location
= larger_vector (button_down_location
,
5687 mouse_syms
= larger_vector (mouse_syms
, incr
, -1);
5690 start_pos_ptr
= aref_addr (button_down_location
, button
);
5691 start_pos
= *start_pos_ptr
;
5692 *start_pos_ptr
= Qnil
;
5695 /* On window-system frames, use the value of
5696 double-click-fuzz as is. On other frames, interpret it
5697 as a multiple of 1/8 characters. */
5701 if (WINDOWP (event
->frame_or_window
))
5702 f
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5703 else if (FRAMEP (event
->frame_or_window
))
5704 f
= XFRAME (event
->frame_or_window
);
5708 if (FRAME_WINDOW_P (f
))
5709 fuzz
= double_click_fuzz
;
5711 fuzz
= double_click_fuzz
/ 8;
5713 is_double
= (button
== last_mouse_button
5714 && (eabs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5715 && (eabs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5716 && button_down_time
!= 0
5717 && (EQ (Vdouble_click_time
, Qt
)
5718 || (NATNUMP (Vdouble_click_time
)
5719 && (event
->timestamp
- button_down_time
5720 < XFASTINT (Vdouble_click_time
)))));
5723 last_mouse_button
= button
;
5724 last_mouse_x
= XINT (event
->x
);
5725 last_mouse_y
= XINT (event
->y
);
5727 /* If this is a button press, squirrel away the location, so
5728 we can decide later whether it was a click or a drag. */
5729 if (event
->modifiers
& down_modifier
)
5733 double_click_count
++;
5734 event
->modifiers
|= ((double_click_count
> 2)
5739 double_click_count
= 1;
5740 button_down_time
= event
->timestamp
;
5741 *start_pos_ptr
= Fcopy_alist (position
);
5742 ignore_mouse_drag_p
= 0;
5745 /* Now we're releasing a button - check the co-ordinates to
5746 see if this was a click or a drag. */
5747 else if (event
->modifiers
& up_modifier
)
5749 /* If we did not see a down before this up, ignore the up.
5750 Probably this happened because the down event chose a
5751 menu item. It would be an annoyance to treat the
5752 release of the button that chose the menu item as a
5755 if (!CONSP (start_pos
))
5758 event
->modifiers
&= ~up_modifier
;
5761 Lisp_Object new_down
, down
;
5762 EMACS_INT xdiff
= double_click_fuzz
, ydiff
= double_click_fuzz
;
5764 /* The third element of every position
5765 should be the (x,y) pair. */
5766 down
= Fcar (Fcdr (Fcdr (start_pos
)));
5767 new_down
= Fcar (Fcdr (Fcdr (position
)));
5770 && INTEGERP (XCAR (down
)) && INTEGERP (XCDR (down
)))
5772 xdiff
= XINT (XCAR (new_down
)) - XINT (XCAR (down
));
5773 ydiff
= XINT (XCDR (new_down
)) - XINT (XCDR (down
));
5776 if (ignore_mouse_drag_p
)
5778 event
->modifiers
|= click_modifier
;
5779 ignore_mouse_drag_p
= 0;
5781 else if (xdiff
< double_click_fuzz
&& xdiff
> - double_click_fuzz
5782 && ydiff
< double_click_fuzz
&& ydiff
> - double_click_fuzz
5783 /* Maybe the mouse has moved a lot, caused scrolling, and
5784 eventually ended up at the same screen position (but
5785 not buffer position) in which case it is a drag, not
5787 /* FIXME: OTOH if the buffer position has changed
5788 because of a timer or process filter rather than
5789 because of mouse movement, it should be considered as
5790 a click. But mouse-drag-region completely ignores
5791 this case and it hasn't caused any real problem, so
5792 it's probably OK to ignore it as well. */
5793 && EQ (Fcar (Fcdr (start_pos
)), Fcar (Fcdr (position
))))
5794 /* Mouse hasn't moved (much). */
5795 event
->modifiers
|= click_modifier
;
5798 button_down_time
= 0;
5799 event
->modifiers
|= drag_modifier
;
5802 /* Don't check is_double; treat this as multiple
5803 if the down-event was multiple. */
5804 if (double_click_count
> 1)
5805 event
->modifiers
|= ((double_click_count
> 2)
5811 /* Every mouse event should either have the down_modifier or
5812 the up_modifier set. */
5816 /* Get the symbol we should use for the mouse click. */
5819 head
= modify_event_symbol (button
,
5821 Qmouse_click
, Vlispy_mouse_stem
,
5824 ASIZE (mouse_syms
));
5825 if (event
->modifiers
& drag_modifier
)
5826 return list3 (head
, start_pos
, position
);
5827 else if (event
->modifiers
& (double_modifier
| triple_modifier
))
5828 return list3 (head
, position
, make_number (double_click_count
));
5830 return list2 (head
, position
);
5835 case HORIZ_WHEEL_EVENT
:
5837 Lisp_Object position
;
5840 /* Build the position as appropriate for this mouse click. */
5841 struct frame
*f
= XFRAME (event
->frame_or_window
);
5843 /* Ignore wheel events that were made on frame that have been
5845 if (! FRAME_LIVE_P (f
))
5848 position
= make_lispy_position (f
, event
->x
, event
->y
,
5851 /* Set double or triple modifiers to indicate the wheel speed. */
5853 /* On window-system frames, use the value of
5854 double-click-fuzz as is. On other frames, interpret it
5855 as a multiple of 1/8 characters. */
5861 if (WINDOWP (event
->frame_or_window
))
5862 fr
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5863 else if (FRAMEP (event
->frame_or_window
))
5864 fr
= XFRAME (event
->frame_or_window
);
5868 fuzz
= FRAME_WINDOW_P (fr
)
5869 ? double_click_fuzz
: double_click_fuzz
/ 8;
5871 if (event
->modifiers
& up_modifier
)
5873 /* Emit a wheel-up event. */
5874 event
->modifiers
&= ~up_modifier
;
5877 else if (event
->modifiers
& down_modifier
)
5879 /* Emit a wheel-down event. */
5880 event
->modifiers
&= ~down_modifier
;
5884 /* Every wheel event should either have the down_modifier or
5885 the up_modifier set. */
5888 if (event
->kind
== HORIZ_WHEEL_EVENT
)
5891 is_double
= (last_mouse_button
== - (1 + symbol_num
)
5892 && (eabs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5893 && (eabs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5894 && button_down_time
!= 0
5895 && (EQ (Vdouble_click_time
, Qt
)
5896 || (NATNUMP (Vdouble_click_time
)
5897 && (event
->timestamp
- button_down_time
5898 < XFASTINT (Vdouble_click_time
)))));
5901 double_click_count
++;
5902 event
->modifiers
|= ((double_click_count
> 2)
5908 double_click_count
= 1;
5909 event
->modifiers
|= click_modifier
;
5912 button_down_time
= event
->timestamp
;
5913 /* Use a negative value to distinguish wheel from mouse button. */
5914 last_mouse_button
= - (1 + symbol_num
);
5915 last_mouse_x
= XINT (event
->x
);
5916 last_mouse_y
= XINT (event
->y
);
5918 /* Get the symbol we should use for the wheel event. */
5919 head
= modify_event_symbol (symbol_num
,
5925 ASIZE (wheel_syms
));
5928 if (event
->modifiers
& (double_modifier
| triple_modifier
))
5929 return list3 (head
, position
, make_number (double_click_count
));
5931 return list2 (head
, position
);
5935 #ifdef USE_TOOLKIT_SCROLL_BARS
5937 /* We don't have down and up events if using toolkit scroll bars,
5938 so make this always a click event. Store in the `part' of
5939 the Lisp event a symbol which maps to the following actions:
5941 `above_handle' page up
5942 `below_handle' page down
5946 `bottom' bottom of buffer
5947 `handle' thumb has been dragged.
5948 `end-scroll' end of interaction with scroll bar
5950 The incoming input_event contains in its `part' member an
5951 index of type `enum scroll_bar_part' which we can use as an
5952 index in scroll_bar_parts to get the appropriate symbol. */
5954 case SCROLL_BAR_CLICK_EVENT
:
5956 Lisp_Object position
, head
;
5958 position
= make_scroll_bar_position (event
, Qvertical_scroll_bar
);
5960 /* Always treat scroll bar events as clicks. */
5961 event
->modifiers
|= click_modifier
;
5962 event
->modifiers
&= ~up_modifier
;
5964 if (event
->code
>= ASIZE (mouse_syms
))
5965 mouse_syms
= larger_vector (mouse_syms
,
5966 event
->code
- ASIZE (mouse_syms
) + 1,
5969 /* Get the symbol we should use for the mouse click. */
5970 head
= modify_event_symbol (event
->code
,
5975 ASIZE (mouse_syms
));
5976 return list2 (head
, position
);
5979 case HORIZONTAL_SCROLL_BAR_CLICK_EVENT
:
5981 Lisp_Object position
, head
;
5983 position
= make_scroll_bar_position (event
, Qhorizontal_scroll_bar
);
5985 /* Always treat scroll bar events as clicks. */
5986 event
->modifiers
|= click_modifier
;
5987 event
->modifiers
&= ~up_modifier
;
5989 if (event
->code
>= ASIZE (mouse_syms
))
5990 mouse_syms
= larger_vector (mouse_syms
,
5991 event
->code
- ASIZE (mouse_syms
) + 1,
5994 /* Get the symbol we should use for the mouse click. */
5995 head
= modify_event_symbol (event
->code
,
6000 ASIZE (mouse_syms
));
6001 return list2 (head
, position
);
6004 #endif /* USE_TOOLKIT_SCROLL_BARS */
6006 case DRAG_N_DROP_EVENT
:
6009 Lisp_Object head
, position
;
6012 f
= XFRAME (event
->frame_or_window
);
6015 /* Ignore mouse events that were made on frames that
6016 have been deleted. */
6017 if (! FRAME_LIVE_P (f
))
6020 position
= make_lispy_position (f
, event
->x
, event
->y
,
6023 head
= modify_event_symbol (0, event
->modifiers
,
6025 lispy_drag_n_drop_names
,
6026 &drag_n_drop_syms
, 1);
6027 return list3 (head
, position
, files
);
6030 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
6031 || defined (HAVE_NS) || defined (USE_GTK)
6032 case MENU_BAR_EVENT
:
6033 if (EQ (event
->arg
, event
->frame_or_window
))
6034 /* This is the prefix key. We translate this to
6035 `(menu_bar)' because the code in keyboard.c for menu
6036 events, which we use, relies on this. */
6037 return list1 (Qmenu_bar
);
6041 case SELECT_WINDOW_EVENT
:
6042 /* Make an event (select-window (WINDOW)). */
6043 return list2 (Qselect_window
, list1 (event
->frame_or_window
));
6045 case TOOL_BAR_EVENT
:
6046 if (EQ (event
->arg
, event
->frame_or_window
))
6047 /* This is the prefix key. We translate this to
6048 `(tool_bar)' because the code in keyboard.c for tool bar
6049 events, which we use, relies on this. */
6050 return list1 (Qtool_bar
);
6051 else if (SYMBOLP (event
->arg
))
6052 return apply_modifiers (event
->modifiers
, event
->arg
);
6055 case USER_SIGNAL_EVENT
:
6056 /* A user signal. */
6058 char *name
= find_user_signal_name (event
->code
);
6061 return intern (name
);
6064 case SAVE_SESSION_EVENT
:
6065 return Qsave_session
;
6070 return Fcons (Qdbus_event
, event
->arg
);
6072 #endif /* HAVE_DBUS */
6074 #ifdef HAVE_XWIDGETS
6077 return Fcons (Qxwidget_event
,event
->arg
);
6079 #endif /* HAVE_XWIDGETS */
6082 #if defined HAVE_GFILENOTIFY || defined HAVE_INOTIFY
6083 case FILE_NOTIFY_EVENT
:
6085 return Fcons (Qfile_notify
, event
->arg
);
6087 #endif /* defined HAVE_GFILENOTIFY || defined HAVE_INOTIFY */
6089 case CONFIG_CHANGED_EVENT
:
6090 return list3 (Qconfig_changed_event
,
6091 event
->arg
, event
->frame_or_window
);
6093 /* The 'kind' field of the event is something we don't recognize. */
6100 make_lispy_movement (struct frame
*frame
, Lisp_Object bar_window
, enum scroll_bar_part part
,
6101 Lisp_Object x
, Lisp_Object y
, Time t
)
6103 /* Is it a scroll bar movement? */
6104 if (frame
&& ! NILP (bar_window
))
6106 Lisp_Object part_sym
;
6108 part_sym
= builtin_lisp_symbol (scroll_bar_parts
[part
]);
6109 return list2 (Qscroll_bar_movement
,
6111 Qvertical_scroll_bar
,
6116 /* Or is it an ordinary mouse movement? */
6119 Lisp_Object position
;
6120 position
= make_lispy_position (frame
, x
, y
, t
);
6121 return list2 (Qmouse_movement
, position
);
6125 /* Construct a switch frame event. */
6127 make_lispy_switch_frame (Lisp_Object frame
)
6129 return list2 (Qswitch_frame
, frame
);
6133 make_lispy_focus_in (Lisp_Object frame
)
6135 return list2 (Qfocus_in
, frame
);
6138 #ifdef HAVE_WINDOW_SYSTEM
6141 make_lispy_focus_out (Lisp_Object frame
)
6143 return list2 (Qfocus_out
, frame
);
6146 #endif /* HAVE_WINDOW_SYSTEM */
6148 /* Manipulating modifiers. */
6150 /* Parse the name of SYMBOL, and return the set of modifiers it contains.
6152 If MODIFIER_END is non-zero, set *MODIFIER_END to the position in
6153 SYMBOL's name of the end of the modifiers; the string from this
6154 position is the unmodified symbol name.
6156 This doesn't use any caches. */
6159 parse_modifiers_uncached (Lisp_Object symbol
, ptrdiff_t *modifier_end
)
6165 CHECK_SYMBOL (symbol
);
6168 name
= SYMBOL_NAME (symbol
);
6170 for (i
= 0; i
< SBYTES (name
) - 1; )
6172 ptrdiff_t this_mod_end
= 0;
6175 /* See if the name continues with a modifier word.
6176 Check that the word appears, but don't check what follows it.
6177 Set this_mod and this_mod_end to record what we find. */
6179 switch (SREF (name
, i
))
6181 #define SINGLE_LETTER_MOD(BIT) \
6182 (this_mod_end = i + 1, this_mod = BIT)
6185 SINGLE_LETTER_MOD (alt_modifier
);
6189 SINGLE_LETTER_MOD (ctrl_modifier
);
6193 SINGLE_LETTER_MOD (hyper_modifier
);
6197 SINGLE_LETTER_MOD (meta_modifier
);
6201 SINGLE_LETTER_MOD (shift_modifier
);
6205 SINGLE_LETTER_MOD (super_modifier
);
6208 #undef SINGLE_LETTER_MOD
6210 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6211 if (i + LEN + 1 <= SBYTES (name) \
6212 && ! memcmp (SDATA (name) + i, NAME, LEN)) \
6214 this_mod_end = i + LEN; \
6219 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
6220 MULTI_LETTER_MOD (down_modifier
, "down", 4);
6221 MULTI_LETTER_MOD (double_modifier
, "double", 6);
6225 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
6227 #undef MULTI_LETTER_MOD
6231 /* If we found no modifier, stop looking for them. */
6232 if (this_mod_end
== 0)
6235 /* Check there is a dash after the modifier, so that it
6236 really is a modifier. */
6237 if (this_mod_end
>= SBYTES (name
)
6238 || SREF (name
, this_mod_end
) != '-')
6241 /* This modifier is real; look for another. */
6242 modifiers
|= this_mod
;
6243 i
= this_mod_end
+ 1;
6246 /* Should we include the `click' modifier? */
6247 if (! (modifiers
& (down_modifier
| drag_modifier
6248 | double_modifier
| triple_modifier
))
6249 && i
+ 7 == SBYTES (name
)
6250 && memcmp (SDATA (name
) + i
, "mouse-", 6) == 0
6251 && ('0' <= SREF (name
, i
+ 6) && SREF (name
, i
+ 6) <= '9'))
6252 modifiers
|= click_modifier
;
6254 if (! (modifiers
& (double_modifier
| triple_modifier
))
6255 && i
+ 6 < SBYTES (name
)
6256 && memcmp (SDATA (name
) + i
, "wheel-", 6) == 0)
6257 modifiers
|= click_modifier
;
6265 /* Return a symbol whose name is the modifier prefixes for MODIFIERS
6266 prepended to the string BASE[0..BASE_LEN-1].
6267 This doesn't use any caches. */
6269 apply_modifiers_uncached (int modifiers
, char *base
, int base_len
, int base_len_byte
)
6271 /* Since BASE could contain nulls, we can't use intern here; we have
6272 to use Fintern, which expects a genuine Lisp_String, and keeps a
6274 char new_mods
[sizeof "A-C-H-M-S-s-down-drag-double-triple-"];
6280 /* Only the event queue may use the `up' modifier; it should always
6281 be turned into a click or drag event before presented to lisp code. */
6282 if (modifiers
& up_modifier
)
6285 if (modifiers
& alt_modifier
) { *p
++ = 'A'; *p
++ = '-'; }
6286 if (modifiers
& ctrl_modifier
) { *p
++ = 'C'; *p
++ = '-'; }
6287 if (modifiers
& hyper_modifier
) { *p
++ = 'H'; *p
++ = '-'; }
6288 if (modifiers
& meta_modifier
) { *p
++ = 'M'; *p
++ = '-'; }
6289 if (modifiers
& shift_modifier
) { *p
++ = 'S'; *p
++ = '-'; }
6290 if (modifiers
& super_modifier
) { *p
++ = 's'; *p
++ = '-'; }
6291 if (modifiers
& double_modifier
) p
= stpcpy (p
, "double-");
6292 if (modifiers
& triple_modifier
) p
= stpcpy (p
, "triple-");
6293 if (modifiers
& down_modifier
) p
= stpcpy (p
, "down-");
6294 if (modifiers
& drag_modifier
) p
= stpcpy (p
, "drag-");
6295 /* The click modifier is denoted by the absence of other modifiers. */
6299 mod_len
= p
- new_mods
;
6303 Lisp_Object new_name
;
6305 new_name
= make_uninit_multibyte_string (mod_len
+ base_len
,
6306 mod_len
+ base_len_byte
);
6307 memcpy (SDATA (new_name
), new_mods
, mod_len
);
6308 memcpy (SDATA (new_name
) + mod_len
, base
, base_len_byte
);
6310 return Fintern (new_name
, Qnil
);
6315 static const char *const modifier_names
[] =
6317 "up", "down", "drag", "click", "double", "triple", 0, 0,
6318 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
6319 0, 0, "alt", "super", "hyper", "shift", "control", "meta"
6321 #define NUM_MOD_NAMES ARRAYELTS (modifier_names)
6323 static Lisp_Object modifier_symbols
;
6325 /* Return the list of modifier symbols corresponding to the mask MODIFIERS. */
6327 lispy_modifier_list (int modifiers
)
6329 Lisp_Object modifier_list
;
6332 modifier_list
= Qnil
;
6333 for (i
= 0; (1<<i
) <= modifiers
&& i
< NUM_MOD_NAMES
; i
++)
6334 if (modifiers
& (1<<i
))
6335 modifier_list
= Fcons (AREF (modifier_symbols
, i
),
6338 return modifier_list
;
6342 /* Parse the modifiers on SYMBOL, and return a list like (UNMODIFIED MASK),
6343 where UNMODIFIED is the unmodified form of SYMBOL,
6344 MASK is the set of modifiers present in SYMBOL's name.
6345 This is similar to parse_modifiers_uncached, but uses the cache in
6346 SYMBOL's Qevent_symbol_element_mask property, and maintains the
6347 Qevent_symbol_elements property. */
6349 #define KEY_TO_CHAR(k) (XINT (k) & ((1 << CHARACTERBITS) - 1))
6352 parse_modifiers (Lisp_Object symbol
)
6354 Lisp_Object elements
;
6356 if (INTEGERP (symbol
))
6357 return list2i (KEY_TO_CHAR (symbol
), XINT (symbol
) & CHAR_MODIFIER_MASK
);
6358 else if (!SYMBOLP (symbol
))
6361 elements
= Fget (symbol
, Qevent_symbol_element_mask
);
6362 if (CONSP (elements
))
6367 int modifiers
= parse_modifiers_uncached (symbol
, &end
);
6368 Lisp_Object unmodified
;
6371 unmodified
= Fintern (make_string (SSDATA (SYMBOL_NAME (symbol
)) + end
,
6372 SBYTES (SYMBOL_NAME (symbol
)) - end
),
6375 if (modifiers
& ~INTMASK
)
6377 XSETFASTINT (mask
, modifiers
);
6378 elements
= list2 (unmodified
, mask
);
6380 /* Cache the parsing results on SYMBOL. */
6381 Fput (symbol
, Qevent_symbol_element_mask
,
6383 Fput (symbol
, Qevent_symbol_elements
,
6384 Fcons (unmodified
, lispy_modifier_list (modifiers
)));
6386 /* Since we know that SYMBOL is modifiers applied to unmodified,
6387 it would be nice to put that in unmodified's cache.
6388 But we can't, since we're not sure that parse_modifiers is
6395 DEFUN ("internal-event-symbol-parse-modifiers", Fevent_symbol_parse_modifiers
,
6396 Sevent_symbol_parse_modifiers
, 1, 1, 0,
6397 doc
: /* Parse the event symbol. For internal use. */)
6398 (Lisp_Object symbol
)
6400 /* Fill the cache if needed. */
6401 parse_modifiers (symbol
);
6402 /* Ignore the result (which is stored on Qevent_symbol_element_mask)
6403 and use the Lispier representation stored on Qevent_symbol_elements
6405 return Fget (symbol
, Qevent_symbol_elements
);
6408 /* Apply the modifiers MODIFIERS to the symbol BASE.
6409 BASE must be unmodified.
6411 This is like apply_modifiers_uncached, but uses BASE's
6412 Qmodifier_cache property, if present. It also builds
6413 Qevent_symbol_elements properties, since it has that info anyway.
6415 apply_modifiers copies the value of BASE's Qevent_kind property to
6416 the modified symbol. */
6418 apply_modifiers (int modifiers
, Lisp_Object base
)
6420 Lisp_Object cache
, idx
, entry
, new_symbol
;
6422 /* Mask out upper bits. We don't know where this value's been. */
6423 modifiers
&= INTMASK
;
6425 if (INTEGERP (base
))
6426 return make_number (XINT (base
) | modifiers
);
6428 /* The click modifier never figures into cache indices. */
6429 cache
= Fget (base
, Qmodifier_cache
);
6430 XSETFASTINT (idx
, (modifiers
& ~click_modifier
));
6431 entry
= assq_no_quit (idx
, cache
);
6434 new_symbol
= XCDR (entry
);
6437 /* We have to create the symbol ourselves. */
6438 new_symbol
= apply_modifiers_uncached (modifiers
,
6439 SSDATA (SYMBOL_NAME (base
)),
6440 SCHARS (SYMBOL_NAME (base
)),
6441 SBYTES (SYMBOL_NAME (base
)));
6443 /* Add the new symbol to the base's cache. */
6444 entry
= Fcons (idx
, new_symbol
);
6445 Fput (base
, Qmodifier_cache
, Fcons (entry
, cache
));
6447 /* We have the parsing info now for free, so we could add it to
6449 XSETFASTINT (idx, modifiers);
6450 Fput (new_symbol, Qevent_symbol_element_mask,
6452 Fput (new_symbol, Qevent_symbol_elements,
6453 Fcons (base, lispy_modifier_list (modifiers)));
6454 Sadly, this is only correct if `base' is indeed a base event,
6455 which is not necessarily the case. -stef */
6458 /* Make sure this symbol is of the same kind as BASE.
6460 You'd think we could just set this once and for all when we
6461 intern the symbol above, but reorder_modifiers may call us when
6462 BASE's property isn't set right; we can't assume that just
6463 because it has a Qmodifier_cache property it must have its
6464 Qevent_kind set right as well. */
6465 if (NILP (Fget (new_symbol
, Qevent_kind
)))
6469 kind
= Fget (base
, Qevent_kind
);
6471 Fput (new_symbol
, Qevent_kind
, kind
);
6478 /* Given a symbol whose name begins with modifiers ("C-", "M-", etc),
6479 return a symbol with the modifiers placed in the canonical order.
6480 Canonical order is alphabetical, except for down and drag, which
6481 always come last. The 'click' modifier is never written out.
6483 Fdefine_key calls this to make sure that (for example) C-M-foo
6484 and M-C-foo end up being equivalent in the keymap. */
6487 reorder_modifiers (Lisp_Object symbol
)
6489 /* It's hopefully okay to write the code this way, since everything
6490 will soon be in caches, and no consing will be done at all. */
6493 parsed
= parse_modifiers (symbol
);
6494 return apply_modifiers (XFASTINT (XCAR (XCDR (parsed
))),
6499 /* For handling events, we often want to produce a symbol whose name
6500 is a series of modifier key prefixes ("M-", "C-", etcetera) attached
6501 to some base, like the name of a function key or mouse button.
6502 modify_event_symbol produces symbols of this sort.
6504 NAME_TABLE should point to an array of strings, such that NAME_TABLE[i]
6505 is the name of the i'th symbol. TABLE_SIZE is the number of elements
6508 Alternatively, NAME_ALIST_OR_STEM is either an alist mapping codes
6509 into symbol names, or a string specifying a name stem used to
6510 construct a symbol name or the form `STEM-N', where N is the decimal
6511 representation of SYMBOL_NUM. NAME_ALIST_OR_STEM is used if it is
6512 non-nil; otherwise NAME_TABLE is used.
6514 SYMBOL_TABLE should be a pointer to a Lisp_Object whose value will
6515 persist between calls to modify_event_symbol that it can use to
6516 store a cache of the symbols it's generated for this NAME_TABLE
6517 before. The object stored there may be a vector or an alist.
6519 SYMBOL_NUM is the number of the base name we want from NAME_TABLE.
6521 MODIFIERS is a set of modifier bits (as given in struct input_events)
6522 whose prefixes should be applied to the symbol name.
6524 SYMBOL_KIND is the value to be placed in the event_kind property of
6525 the returned symbol.
6527 The symbols we create are supposed to have an
6528 `event-symbol-elements' property, which lists the modifiers present
6529 in the symbol's name. */
6532 modify_event_symbol (ptrdiff_t symbol_num
, int modifiers
, Lisp_Object symbol_kind
,
6533 Lisp_Object name_alist_or_stem
, const char *const *name_table
,
6534 Lisp_Object
*symbol_table
, ptrdiff_t table_size
)
6537 Lisp_Object symbol_int
;
6539 /* Get rid of the "vendor-specific" bit here. */
6540 XSETINT (symbol_int
, symbol_num
& 0xffffff);
6542 /* Is this a request for a valid symbol? */
6543 if (symbol_num
< 0 || symbol_num
>= table_size
)
6546 if (CONSP (*symbol_table
))
6547 value
= Fcdr (assq_no_quit (symbol_int
, *symbol_table
));
6549 /* If *symbol_table doesn't seem to be initialized properly, fix that.
6550 *symbol_table should be a lisp vector TABLE_SIZE elements long,
6551 where the Nth element is the symbol for NAME_TABLE[N], or nil if
6552 we've never used that symbol before. */
6555 if (! VECTORP (*symbol_table
)
6556 || ASIZE (*symbol_table
) != table_size
)
6560 XSETFASTINT (size
, table_size
);
6561 *symbol_table
= Fmake_vector (size
, Qnil
);
6564 value
= AREF (*symbol_table
, symbol_num
);
6567 /* Have we already used this symbol before? */
6570 /* No; let's create it. */
6571 if (CONSP (name_alist_or_stem
))
6572 value
= Fcdr_safe (Fassq (symbol_int
, name_alist_or_stem
));
6573 else if (STRINGP (name_alist_or_stem
))
6576 ptrdiff_t len
= (SBYTES (name_alist_or_stem
)
6577 + sizeof "-" + INT_STRLEN_BOUND (EMACS_INT
));
6579 buf
= SAFE_ALLOCA (len
);
6580 esprintf (buf
, "%s-%"pI
"d", SDATA (name_alist_or_stem
),
6581 XINT (symbol_int
) + 1);
6582 value
= intern (buf
);
6585 else if (name_table
!= 0 && name_table
[symbol_num
])
6586 value
= intern (name_table
[symbol_num
]);
6588 #ifdef HAVE_WINDOW_SYSTEM
6591 char *name
= x_get_keysym_name (symbol_num
);
6593 value
= intern (name
);
6599 char buf
[sizeof "key-" + INT_STRLEN_BOUND (EMACS_INT
)];
6600 sprintf (buf
, "key-%"pD
"d", symbol_num
);
6601 value
= intern (buf
);
6604 if (CONSP (*symbol_table
))
6605 *symbol_table
= Fcons (Fcons (symbol_int
, value
), *symbol_table
);
6607 ASET (*symbol_table
, symbol_num
, value
);
6609 /* Fill in the cache entries for this symbol; this also
6610 builds the Qevent_symbol_elements property, which the user
6612 apply_modifiers (modifiers
& click_modifier
, value
);
6613 Fput (value
, Qevent_kind
, symbol_kind
);
6616 /* Apply modifiers to that symbol. */
6617 return apply_modifiers (modifiers
, value
);
6620 /* Convert a list that represents an event type,
6621 such as (ctrl meta backspace), into the usual representation of that
6622 event type as a number or a symbol. */
6624 DEFUN ("event-convert-list", Fevent_convert_list
, Sevent_convert_list
, 1, 1, 0,
6625 doc
: /* Convert the event description list EVENT-DESC to an event type.
6626 EVENT-DESC should contain one base event type (a character or symbol)
6627 and zero or more modifier names (control, meta, hyper, super, shift, alt,
6628 drag, down, double or triple). The base must be last.
6629 The return value is an event type (a character or symbol) which
6630 has the same base event type and all the specified modifiers. */)
6631 (Lisp_Object event_desc
)
6639 while (CONSP (rest
))
6647 /* Given a symbol, see if it is a modifier name. */
6648 if (SYMBOLP (elt
) && CONSP (rest
))
6649 this = parse_solitary_modifier (elt
);
6653 else if (!NILP (base
))
6654 error ("Two bases given in one event");
6660 /* Let the symbol A refer to the character A. */
6661 if (SYMBOLP (base
) && SCHARS (SYMBOL_NAME (base
)) == 1)
6662 XSETINT (base
, SREF (SYMBOL_NAME (base
), 0));
6664 if (INTEGERP (base
))
6666 /* Turn (shift a) into A. */
6667 if ((modifiers
& shift_modifier
) != 0
6668 && (XINT (base
) >= 'a' && XINT (base
) <= 'z'))
6670 XSETINT (base
, XINT (base
) - ('a' - 'A'));
6671 modifiers
&= ~shift_modifier
;
6674 /* Turn (control a) into C-a. */
6675 if (modifiers
& ctrl_modifier
)
6676 return make_number ((modifiers
& ~ctrl_modifier
)
6677 | make_ctrl_char (XINT (base
)));
6679 return make_number (modifiers
| XINT (base
));
6681 else if (SYMBOLP (base
))
6682 return apply_modifiers (modifiers
, base
);
6684 error ("Invalid base event");
6687 /* Try to recognize SYMBOL as a modifier name.
6688 Return the modifier flag bit, or 0 if not recognized. */
6691 parse_solitary_modifier (Lisp_Object symbol
)
6693 Lisp_Object name
= SYMBOL_NAME (symbol
);
6695 switch (SREF (name
, 0))
6697 #define SINGLE_LETTER_MOD(BIT) \
6698 if (SBYTES (name) == 1) \
6701 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6702 if (LEN == SBYTES (name) \
6703 && ! memcmp (SDATA (name), NAME, LEN)) \
6707 SINGLE_LETTER_MOD (alt_modifier
);
6711 MULTI_LETTER_MOD (alt_modifier
, "alt", 3);
6715 SINGLE_LETTER_MOD (ctrl_modifier
);
6719 MULTI_LETTER_MOD (ctrl_modifier
, "ctrl", 4);
6720 MULTI_LETTER_MOD (ctrl_modifier
, "control", 7);
6724 SINGLE_LETTER_MOD (hyper_modifier
);
6728 MULTI_LETTER_MOD (hyper_modifier
, "hyper", 5);
6732 SINGLE_LETTER_MOD (meta_modifier
);
6736 MULTI_LETTER_MOD (meta_modifier
, "meta", 4);
6740 SINGLE_LETTER_MOD (shift_modifier
);
6744 MULTI_LETTER_MOD (shift_modifier
, "shift", 5);
6745 MULTI_LETTER_MOD (super_modifier
, "super", 5);
6746 SINGLE_LETTER_MOD (super_modifier
);
6750 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
6751 MULTI_LETTER_MOD (down_modifier
, "down", 4);
6752 MULTI_LETTER_MOD (double_modifier
, "double", 6);
6756 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
6759 #undef SINGLE_LETTER_MOD
6760 #undef MULTI_LETTER_MOD
6766 /* Return true if EVENT is a list whose elements are all integers or symbols.
6767 Such a list is not valid as an event,
6768 but it can be a Lucid-style event type list. */
6771 lucid_event_type_list_p (Lisp_Object object
)
6775 if (! CONSP (object
))
6778 if (EQ (XCAR (object
), Qhelp_echo
)
6779 || EQ (XCAR (object
), Qvertical_line
)
6780 || EQ (XCAR (object
), Qmode_line
)
6781 || EQ (XCAR (object
), Qheader_line
))
6784 for (tail
= object
; CONSP (tail
); tail
= XCDR (tail
))
6788 if (! (INTEGERP (elt
) || SYMBOLP (elt
)))
6795 /* Return true if terminal input chars are available.
6796 Also, store the return value into INPUT_PENDING.
6798 Serves the purpose of ioctl (0, FIONREAD, ...)
6799 but works even if FIONREAD does not exist.
6800 (In fact, this may actually read some input.)
6802 If READABLE_EVENTS_DO_TIMERS_NOW is set in FLAGS, actually run
6803 timer events that are ripe.
6804 If READABLE_EVENTS_FILTER_EVENTS is set in FLAGS, ignore internal
6805 events (FOCUS_IN_EVENT).
6806 If READABLE_EVENTS_IGNORE_SQUEEZABLES is set in FLAGS, ignore mouse
6807 movements and toolkit scroll bar thumb drags. */
6810 get_input_pending (int flags
)
6812 /* First of all, have we already counted some input? */
6813 input_pending
= (!NILP (Vquit_flag
) || readable_events (flags
));
6815 /* If input is being read as it arrives, and we have none, there is none. */
6816 if (!input_pending
&& (!interrupt_input
|| interrupts_deferred
))
6818 /* Try to read some input and see how much we get. */
6820 input_pending
= (!NILP (Vquit_flag
) || readable_events (flags
));
6823 return input_pending
;
6826 /* Put a BUFFER_SWITCH_EVENT in the buffer
6827 so that read_key_sequence will notice the new current buffer. */
6830 record_asynch_buffer_change (void)
6832 /* We don't need a buffer-switch event unless Emacs is waiting for input.
6833 The purpose of the event is to make read_key_sequence look up the
6834 keymaps again. If we aren't in read_key_sequence, we don't need one,
6835 and the event could cause trouble by messing up (input-pending-p).
6836 Note: Fwaiting_for_user_input_p always returns nil when async
6837 subprocesses aren't supported. */
6838 if (!NILP (Fwaiting_for_user_input_p ()))
6840 struct input_event event
;
6843 event
.kind
= BUFFER_SWITCH_EVENT
;
6844 event
.frame_or_window
= Qnil
;
6847 /* Make sure no interrupt happens while storing the event. */
6849 if (interrupt_input
)
6850 kbd_buffer_store_event (&event
);
6855 kbd_buffer_store_event (&event
);
6861 /* Read any terminal input already buffered up by the system
6862 into the kbd_buffer, but do not wait.
6864 Return the number of keyboard chars read, or -1 meaning
6865 this is a bad time to try to read input. */
6874 /* Store pending user signal events, if any. */
6875 store_user_signal_events ();
6877 /* Loop through the available terminals, and call their input hooks. */
6881 struct terminal
*next
= t
->next_terminal
;
6883 if (t
->read_socket_hook
)
6886 struct input_event hold_quit
;
6888 if (input_blocked_p ())
6890 pending_signals
= 1;
6894 EVENT_INIT (hold_quit
);
6895 hold_quit
.kind
= NO_EVENT
;
6897 /* No need for FIONREAD or fcntl; just say don't wait. */
6898 while ((nr
= (*t
->read_socket_hook
) (t
, &hold_quit
)) > 0)
6901 if (nr
== -1) /* Not OK to read input now. */
6905 else if (nr
== -2) /* Non-transient error. */
6907 /* The terminal device terminated; it should be closed. */
6909 /* Kill Emacs if this was our last terminal. */
6910 if (!terminal_list
->next_terminal
)
6911 /* Formerly simply reported no input, but that
6912 sometimes led to a failure of Emacs to terminate.
6913 SIGHUP seems appropriate if we can't reach the
6915 /* ??? Is it really right to send the signal just to
6916 this process rather than to the whole process
6917 group? Perhaps on systems with FIONREAD Emacs is
6918 alone in its group. */
6919 terminate_due_to_signal (SIGHUP
, 10);
6921 /* XXX Is calling delete_terminal safe here? It calls delete_frame. */
6924 XSETTERMINAL (tmp
, t
);
6925 Fdelete_terminal (tmp
, Qnoelisp
);
6929 /* If there was no error, make sure the pointer
6930 is visible for all frames on this terminal. */
6933 Lisp_Object tail
, frame
;
6935 FOR_EACH_FRAME (tail
, frame
)
6937 struct frame
*f
= XFRAME (frame
);
6938 if (FRAME_TERMINAL (f
) == t
)
6939 frame_make_pointer_visible (f
);
6943 if (hold_quit
.kind
!= NO_EVENT
)
6944 kbd_buffer_store_event (&hold_quit
);
6956 /* This is the tty way of reading available input.
6958 Note that each terminal device has its own `struct terminal' object,
6959 and so this function is called once for each individual termcap
6960 terminal. The first parameter indicates which terminal to read from. */
6963 tty_read_avail_input (struct terminal
*terminal
,
6964 struct input_event
*hold_quit
)
6966 /* Using KBD_BUFFER_SIZE - 1 here avoids reading more than
6967 the kbd_buffer can really hold. That may prevent loss
6968 of characters on some systems when input is stuffed at us. */
6969 unsigned char cbuf
[KBD_BUFFER_SIZE
- 1];
6971 struct tty_display_info
*tty
= terminal
->display_info
.tty
;
6974 int buffer_free
= KBD_BUFFER_SIZE
- kbd_buffer_nr_stored () - 1;
6976 if (kbd_on_hold_p () || buffer_free
<= 0)
6978 #endif /* subprocesses */
6980 if (!terminal
->name
) /* Don't read from a dead terminal. */
6983 if (terminal
->type
!= output_termcap
6984 && terminal
->type
!= output_msdos_raw
)
6987 /* XXX I think the following code should be moved to separate hook
6988 functions in system-dependent files. */
6990 /* FIXME: AFAIK, tty_read_avail_input is not used under w32 since the non-GUI
6991 code sets read_socket_hook to w32_console_read_socket instead! */
6993 #else /* not WINDOWSNT */
6994 if (! tty
->term_initted
) /* In case we get called during bootstrap. */
6998 return 0; /* The terminal is suspended. */
7001 n_to_read
= dos_keysns ();
7005 cbuf
[0] = dos_keyread ();
7008 #else /* not MSDOS */
7013 struct input_event gpm_hold_quit
;
7014 int gpm
, fd
= gpm_fd
;
7016 EVENT_INIT (gpm_hold_quit
);
7017 gpm_hold_quit
.kind
= NO_EVENT
;
7019 /* gpm==1 if event received.
7020 gpm==0 if the GPM daemon has closed the connection, in which case
7021 Gpm_GetEvent closes gpm_fd and clears it to -1, which is why
7022 we save it in `fd' so close_gpm can remove it from the
7024 gpm==-1 if a protocol error or EWOULDBLOCK; the latter is normal. */
7025 while (gpm
= Gpm_GetEvent (&event
), gpm
== 1) {
7026 nread
+= handle_one_term_event (tty
, &event
, &gpm_hold_quit
);
7029 /* Presumably the GPM daemon has closed the connection. */
7031 if (gpm_hold_quit
.kind
!= NO_EVENT
)
7032 kbd_buffer_store_event (&gpm_hold_quit
);
7036 #endif /* HAVE_GPM */
7038 /* Determine how many characters we should *try* to read. */
7039 #ifdef USABLE_FIONREAD
7040 /* Find out how much input is available. */
7041 if (ioctl (fileno (tty
->input
), FIONREAD
, &n_to_read
) < 0)
7043 if (! noninteractive
)
7044 return -2; /* Close this terminal. */
7050 if (n_to_read
> sizeof cbuf
)
7051 n_to_read
= sizeof cbuf
;
7052 #elif defined USG || defined CYGWIN
7053 /* Read some input if available, but don't wait. */
7054 n_to_read
= sizeof cbuf
;
7055 fcntl (fileno (tty
->input
), F_SETFL
, O_NONBLOCK
);
7057 # error "Cannot read without possibly delaying"
7061 /* Don't read more than we can store. */
7062 if (n_to_read
> buffer_free
)
7063 n_to_read
= buffer_free
;
7064 #endif /* subprocesses */
7066 /* Now read; for one reason or another, this will not block.
7067 NREAD is set to the number of chars read. */
7070 nread
= emacs_read (fileno (tty
->input
), (char *) cbuf
, n_to_read
);
7071 /* POSIX infers that processes which are not in the session leader's
7072 process group won't get SIGHUPs at logout time. BSDI adheres to
7073 this part standard and returns -1 from read (0) with errno==EIO
7074 when the control tty is taken away.
7075 Jeffrey Honig <jch@bsdi.com> says this is generally safe. */
7076 if (nread
== -1 && errno
== EIO
)
7077 return -2; /* Close this terminal. */
7078 #if defined (AIX) && defined (_BSD)
7079 /* The kernel sometimes fails to deliver SIGHUP for ptys.
7080 This looks incorrect, but it isn't, because _BSD causes
7081 O_NDELAY to be defined in fcntl.h as O_NONBLOCK,
7082 and that causes a value other than 0 when there is no input. */
7084 return -2; /* Close this terminal. */
7088 /* We used to retry the read if it was interrupted.
7089 But this does the wrong thing when O_NONBLOCK causes
7090 an EAGAIN error. Does anybody know of a situation
7091 where a retry is actually needed? */
7093 nread
< 0 && (errno
== EAGAIN
|| errno
== EFAULT
7103 #ifndef USABLE_FIONREAD
7104 #if defined (USG) || defined (CYGWIN)
7105 fcntl (fileno (tty
->input
), F_SETFL
, 0);
7106 #endif /* USG or CYGWIN */
7107 #endif /* no FIONREAD */
7112 #endif /* not MSDOS */
7113 #endif /* not WINDOWSNT */
7115 for (i
= 0; i
< nread
; i
++)
7117 struct input_event buf
;
7119 buf
.kind
= ASCII_KEYSTROKE_EVENT
;
7121 if (tty
->meta_key
== 1 && (cbuf
[i
] & 0x80))
7122 buf
.modifiers
= meta_modifier
;
7123 if (tty
->meta_key
!= 2)
7127 /* Set the frame corresponding to the active tty. Note that the
7128 value of selected_frame is not reliable here, redisplay tends
7129 to temporarily change it. */
7130 buf
.frame_or_window
= tty
->top_frame
;
7133 kbd_buffer_store_event (&buf
);
7134 /* Don't look at input that follows a C-g too closely.
7135 This reduces lossage due to autorepeat on C-g. */
7136 if (buf
.kind
== ASCII_KEYSTROKE_EVENT
7137 && buf
.code
== quit_char
)
7145 handle_async_input (void)
7150 int nread
= gobble_input ();
7151 /* -1 means it's not ok to read the input now.
7152 UNBLOCK_INPUT will read it later; now, avoid infinite loop.
7153 0 means there was no keyboard input available. */
7161 process_pending_signals (void)
7163 pending_signals
= 0;
7164 handle_async_input ();
7165 do_pending_atimers ();
7168 /* Undo any number of BLOCK_INPUT calls down to level LEVEL,
7169 and reinvoke any pending signal if the level is now 0 and
7170 a fatal error is not already in progress. */
7173 unblock_input_to (int level
)
7175 interrupt_input_blocked
= level
;
7178 if (pending_signals
&& !fatal_error_in_progress
)
7179 process_pending_signals ();
7185 /* End critical section.
7187 If doing signal-driven input, and a signal came in when input was
7188 blocked, reinvoke the signal handler now to deal with it.
7190 It will also process queued input, if it was not read before.
7191 When a longer code sequence does not use block/unblock input
7192 at all, the whole input gathered up to the next call to
7193 unblock_input will be processed inside that call. */
7196 unblock_input (void)
7198 unblock_input_to (interrupt_input_blocked
- 1);
7201 /* Undo any number of BLOCK_INPUT calls,
7202 and also reinvoke any pending signal. */
7205 totally_unblock_input (void)
7207 unblock_input_to (0);
7213 handle_input_available_signal (int sig
)
7215 pending_signals
= 1;
7217 if (input_available_clear_time
)
7218 *input_available_clear_time
= make_timespec (0, 0);
7222 deliver_input_available_signal (int sig
)
7224 deliver_process_signal (sig
, handle_input_available_signal
);
7226 #endif /* USABLE_SIGIO */
7229 /* User signal events. */
7231 struct user_signal_info
7233 /* Signal number. */
7236 /* Name of the signal. */
7239 /* Number of pending signals. */
7242 struct user_signal_info
*next
;
7245 /* List of user signals. */
7246 static struct user_signal_info
*user_signals
= NULL
;
7249 add_user_signal (int sig
, const char *name
)
7251 struct sigaction action
;
7252 struct user_signal_info
*p
;
7254 for (p
= user_signals
; p
; p
= p
->next
)
7256 /* Already added. */
7259 p
= xmalloc (sizeof *p
);
7261 p
->name
= xstrdup (name
);
7263 p
->next
= user_signals
;
7266 emacs_sigaction_init (&action
, deliver_user_signal
);
7267 sigaction (sig
, &action
, 0);
7271 handle_user_signal (int sig
)
7273 struct user_signal_info
*p
;
7274 const char *special_event_name
= NULL
;
7276 if (SYMBOLP (Vdebug_on_event
))
7277 special_event_name
= SSDATA (SYMBOL_NAME (Vdebug_on_event
));
7279 for (p
= user_signals
; p
; p
= p
->next
)
7282 if (special_event_name
7283 && strcmp (special_event_name
, p
->name
) == 0)
7285 /* Enter the debugger in many ways. */
7286 debug_on_next_call
= 1;
7289 Vinhibit_quit
= Qnil
;
7291 /* Eat the event. */
7297 if (interrupt_input
)
7298 handle_input_available_signal (sig
);
7302 /* Tell wait_reading_process_output that it needs to wake
7303 up and look around. */
7304 if (input_available_clear_time
)
7305 *input_available_clear_time
= make_timespec (0, 0);
7312 deliver_user_signal (int sig
)
7314 deliver_process_signal (sig
, handle_user_signal
);
7318 find_user_signal_name (int sig
)
7320 struct user_signal_info
*p
;
7322 for (p
= user_signals
; p
; p
= p
->next
)
7330 store_user_signal_events (void)
7332 struct user_signal_info
*p
;
7333 struct input_event buf
;
7334 bool buf_initialized
= 0;
7336 for (p
= user_signals
; p
; p
= p
->next
)
7337 if (p
->npending
> 0)
7339 if (! buf_initialized
)
7341 memset (&buf
, 0, sizeof buf
);
7342 buf
.kind
= USER_SIGNAL_EVENT
;
7343 buf
.frame_or_window
= selected_frame
;
7344 buf_initialized
= 1;
7350 kbd_buffer_store_event (&buf
);
7353 while (p
->npending
> 0);
7358 static void menu_bar_item (Lisp_Object
, Lisp_Object
, Lisp_Object
, void *);
7359 static Lisp_Object menu_bar_one_keymap_changed_items
;
7361 /* These variables hold the vector under construction within
7362 menu_bar_items and its subroutines, and the current index
7363 for storing into that vector. */
7364 static Lisp_Object menu_bar_items_vector
;
7365 static int menu_bar_items_index
;
7368 static const char *separator_names
[] = {
7373 "single-dashed-line",
7374 "double-dashed-line",
7376 "shadow-etched-out",
7377 "shadow-etched-in-dash",
7378 "shadow-etched-out-dash",
7379 "shadow-double-etched-in",
7380 "shadow-double-etched-out",
7381 "shadow-double-etched-in-dash",
7382 "shadow-double-etched-out-dash",
7386 /* Return true if LABEL specifies a separator. */
7389 menu_separator_name_p (const char *label
)
7393 else if (strlen (label
) > 3
7394 && memcmp (label
, "--", 2) == 0
7399 for (i
= 0; separator_names
[i
]; ++i
)
7400 if (strcmp (label
, separator_names
[i
]) == 0)
7405 /* It's a separator if it contains only dashes. */
7406 while (*label
== '-')
7408 return (*label
== 0);
7415 /* Return a vector of menu items for a menu bar, appropriate
7416 to the current buffer. Each item has three elements in the vector:
7419 OLD is an old vector we can optionally reuse, or nil. */
7422 menu_bar_items (Lisp_Object old
)
7424 /* The number of keymaps we're scanning right now, and the number of
7425 keymaps we have allocated space for. */
7428 /* maps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
7429 in the current keymaps, or nil where it is not a prefix. */
7432 Lisp_Object mapsbuf
[3];
7433 Lisp_Object def
, tail
;
7440 /* In order to build the menus, we need to call the keymap
7441 accessors. They all call QUIT. But this function is called
7442 during redisplay, during which a quit is fatal. So inhibit
7443 quitting while building the menus.
7444 We do this instead of specbind because (1) errors will clear it anyway
7445 and (2) this avoids risk of specpdl overflow. */
7446 oquit
= Vinhibit_quit
;
7450 menu_bar_items_vector
= old
;
7452 menu_bar_items_vector
= Fmake_vector (make_number (24), Qnil
);
7453 menu_bar_items_index
= 0;
7455 /* Build our list of keymaps.
7456 If we recognize a function key and replace its escape sequence in
7457 keybuf with its symbol, or if the sequence starts with a mouse
7458 click and we need to switch buffers, we jump back here to rebuild
7459 the initial keymaps from the current buffer. */
7463 /* Should overriding-terminal-local-map and overriding-local-map apply? */
7464 if (!NILP (Voverriding_local_map_menu_flag
)
7465 && !NILP (Voverriding_local_map
))
7467 /* Yes, use them (if non-nil) as well as the global map. */
7470 if (!NILP (KVAR (current_kboard
, Voverriding_terminal_local_map
)))
7471 maps
[nmaps
++] = KVAR (current_kboard
, Voverriding_terminal_local_map
);
7472 if (!NILP (Voverriding_local_map
))
7473 maps
[nmaps
++] = Voverriding_local_map
;
7477 /* No, so use major and minor mode keymaps and keymap property.
7478 Note that menu-bar bindings in the local-map and keymap
7479 properties may not work reliable, as they are only
7480 recognized when the menu-bar (or mode-line) is updated,
7481 which does not normally happen after every command. */
7484 nminor
= current_minor_maps (NULL
, &tmaps
);
7485 SAFE_NALLOCA (maps
, 1, nminor
+ 4);
7487 tem
= KVAR (current_kboard
, Voverriding_terminal_local_map
);
7488 if (!NILP (tem
) && !NILP (Voverriding_local_map_menu_flag
))
7489 maps
[nmaps
++] = tem
;
7490 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
7491 maps
[nmaps
++] = tem
;
7492 memcpy (maps
+ nmaps
, tmaps
, nminor
* sizeof (maps
[0]));
7494 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
7496 maps
[nmaps
++] = current_global_map
;
7499 /* Look up in each map the dummy prefix key `menu-bar'. */
7501 for (mapno
= nmaps
- 1; mapno
>= 0; mapno
--)
7502 if (!NILP (maps
[mapno
]))
7504 def
= get_keymap (access_keymap (maps
[mapno
], Qmenu_bar
, 1, 0, 1),
7508 menu_bar_one_keymap_changed_items
= Qnil
;
7509 map_keymap_canonical (def
, menu_bar_item
, Qnil
, NULL
);
7513 /* Move to the end those items that should be at the end. */
7515 for (tail
= Vmenu_bar_final_items
; CONSP (tail
); tail
= XCDR (tail
))
7518 int end
= menu_bar_items_index
;
7520 for (i
= 0; i
< end
; i
+= 4)
7521 if (EQ (XCAR (tail
), AREF (menu_bar_items_vector
, i
)))
7523 Lisp_Object tem0
, tem1
, tem2
, tem3
;
7524 /* Move the item at index I to the end,
7525 shifting all the others forward. */
7526 tem0
= AREF (menu_bar_items_vector
, i
+ 0);
7527 tem1
= AREF (menu_bar_items_vector
, i
+ 1);
7528 tem2
= AREF (menu_bar_items_vector
, i
+ 2);
7529 tem3
= AREF (menu_bar_items_vector
, i
+ 3);
7531 memmove (aref_addr (menu_bar_items_vector
, i
),
7532 aref_addr (menu_bar_items_vector
, i
+ 4),
7533 (end
- i
- 4) * word_size
);
7534 ASET (menu_bar_items_vector
, end
- 4, tem0
);
7535 ASET (menu_bar_items_vector
, end
- 3, tem1
);
7536 ASET (menu_bar_items_vector
, end
- 2, tem2
);
7537 ASET (menu_bar_items_vector
, end
- 1, tem3
);
7542 /* Add nil, nil, nil, nil at the end. */
7544 int i
= menu_bar_items_index
;
7545 if (i
+ 4 > ASIZE (menu_bar_items_vector
))
7546 menu_bar_items_vector
7547 = larger_vector (menu_bar_items_vector
, 4, -1);
7548 /* Add this item. */
7549 ASET (menu_bar_items_vector
, i
, Qnil
); i
++;
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 menu_bar_items_index
= i
;
7556 Vinhibit_quit
= oquit
;
7558 return menu_bar_items_vector
;
7561 /* Add one item to menu_bar_items_vector, for KEY, ITEM_STRING and DEF.
7562 If there's already an item for KEY, add this DEF to it. */
7564 Lisp_Object item_properties
;
7567 menu_bar_item (Lisp_Object key
, Lisp_Object item
, Lisp_Object dummy1
, void *dummy2
)
7569 struct gcpro gcpro1
;
7574 if (EQ (item
, Qundefined
))
7576 /* If a map has an explicit `undefined' as definition,
7577 discard any previously made menu bar item. */
7579 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7580 if (EQ (key
, AREF (menu_bar_items_vector
, i
)))
7582 if (menu_bar_items_index
> i
+ 4)
7583 memmove (aref_addr (menu_bar_items_vector
, i
),
7584 aref_addr (menu_bar_items_vector
, i
+ 4),
7585 (menu_bar_items_index
- i
- 4) * word_size
);
7586 menu_bar_items_index
-= 4;
7590 /* If this keymap has already contributed to this KEY,
7591 don't contribute to it a second time. */
7592 tem
= Fmemq (key
, menu_bar_one_keymap_changed_items
);
7593 if (!NILP (tem
) || NILP (item
))
7596 menu_bar_one_keymap_changed_items
7597 = Fcons (key
, menu_bar_one_keymap_changed_items
);
7599 /* We add to menu_bar_one_keymap_changed_items before doing the
7600 parse_menu_item, so that if it turns out it wasn't a menu item,
7601 it still correctly hides any further menu item. */
7603 parsed
= parse_menu_item (item
, 1);
7608 item
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7610 /* Find any existing item for this KEY. */
7611 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7612 if (EQ (key
, AREF (menu_bar_items_vector
, i
)))
7615 /* If we did not find this KEY, add it at the end. */
7616 if (i
== menu_bar_items_index
)
7618 /* If vector is too small, get a bigger one. */
7619 if (i
+ 4 > ASIZE (menu_bar_items_vector
))
7620 menu_bar_items_vector
= larger_vector (menu_bar_items_vector
, 4, -1);
7621 /* Add this item. */
7622 ASET (menu_bar_items_vector
, i
, key
); i
++;
7623 ASET (menu_bar_items_vector
, i
,
7624 AREF (item_properties
, ITEM_PROPERTY_NAME
)); i
++;
7625 ASET (menu_bar_items_vector
, i
, list1 (item
)); i
++;
7626 ASET (menu_bar_items_vector
, i
, make_number (0)); i
++;
7627 menu_bar_items_index
= i
;
7629 /* We did find an item for this KEY. Add ITEM to its list of maps. */
7633 old
= AREF (menu_bar_items_vector
, i
+ 2);
7634 /* If the new and the old items are not both keymaps,
7635 the lookup will only find `item'. */
7636 item
= Fcons (item
, KEYMAPP (item
) && KEYMAPP (XCAR (old
)) ? old
: Qnil
);
7637 ASET (menu_bar_items_vector
, i
+ 2, item
);
7641 /* This is used as the handler when calling menu_item_eval_property. */
7643 menu_item_eval_property_1 (Lisp_Object arg
)
7645 /* If we got a quit from within the menu computation,
7646 quit all the way out of it. This takes care of C-] in the debugger. */
7647 if (CONSP (arg
) && EQ (XCAR (arg
), Qquit
))
7648 Fsignal (Qquit
, Qnil
);
7654 eval_dyn (Lisp_Object form
)
7656 return Feval (form
, Qnil
);
7659 /* Evaluate an expression and return the result (or nil if something
7660 went wrong). Used to evaluate dynamic parts of menu items. */
7662 menu_item_eval_property (Lisp_Object sexpr
)
7664 ptrdiff_t count
= SPECPDL_INDEX ();
7666 specbind (Qinhibit_redisplay
, Qt
);
7667 val
= internal_condition_case_1 (eval_dyn
, sexpr
, Qerror
,
7668 menu_item_eval_property_1
);
7669 return unbind_to (count
, val
);
7672 /* This function parses a menu item and leaves the result in the
7673 vector item_properties.
7674 ITEM is a key binding, a possible menu item.
7675 INMENUBAR is > 0 when this is considered for an entry in a menu bar
7677 INMENUBAR is < 0 when this is considered for an entry in a keyboard menu.
7678 parse_menu_item returns true if the item is a menu item and false
7682 parse_menu_item (Lisp_Object item
, int inmenubar
)
7684 Lisp_Object def
, tem
, item_string
, start
;
7686 Lisp_Object keyhint
;
7695 /* Create item_properties vector if necessary. */
7696 if (NILP (item_properties
))
7698 = Fmake_vector (make_number (ITEM_PROPERTY_ENABLE
+ 1), Qnil
);
7700 /* Initialize optional entries. */
7701 for (i
= ITEM_PROPERTY_DEF
; i
< ITEM_PROPERTY_ENABLE
; i
++)
7702 ASET (item_properties
, i
, Qnil
);
7703 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7705 /* Save the item here to protect it from GC. */
7706 ASET (item_properties
, ITEM_PROPERTY_ITEM
, item
);
7708 item_string
= XCAR (item
);
7712 if (STRINGP (item_string
))
7714 /* Old format menu item. */
7715 ASET (item_properties
, ITEM_PROPERTY_NAME
, item_string
);
7717 /* Maybe help string. */
7718 if (CONSP (item
) && STRINGP (XCAR (item
)))
7720 ASET (item_properties
, ITEM_PROPERTY_HELP
, XCAR (item
));
7725 /* Maybe an obsolete key binding cache. */
7726 if (CONSP (item
) && CONSP (XCAR (item
))
7727 && (NILP (XCAR (XCAR (item
)))
7728 || VECTORP (XCAR (XCAR (item
)))))
7731 /* This is the real definition--the function to run. */
7732 ASET (item_properties
, ITEM_PROPERTY_DEF
, item
);
7734 /* Get enable property, if any. */
7737 tem
= Fget (item
, Qmenu_enable
);
7738 if (!NILP (Venable_disabled_menus_and_buttons
))
7739 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7740 else if (!NILP (tem
))
7741 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, tem
);
7744 else if (EQ (item_string
, Qmenu_item
) && CONSP (item
))
7746 /* New format menu item. */
7747 ASET (item_properties
, ITEM_PROPERTY_NAME
, XCAR (item
));
7748 start
= XCDR (item
);
7751 /* We have a real binding. */
7752 ASET (item_properties
, ITEM_PROPERTY_DEF
, XCAR (start
));
7754 item
= XCDR (start
);
7755 /* Is there an obsolete cache list with key equivalences. */
7756 if (CONSP (item
) && CONSP (XCAR (item
)))
7759 /* Parse properties. */
7760 while (CONSP (item
) && CONSP (XCDR (item
)))
7765 if (EQ (tem
, QCenable
))
7767 if (!NILP (Venable_disabled_menus_and_buttons
))
7768 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7770 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, XCAR (item
));
7772 else if (EQ (tem
, QCvisible
))
7774 /* If got a visible property and that evaluates to nil
7775 then ignore this item. */
7776 tem
= menu_item_eval_property (XCAR (item
));
7780 else if (EQ (tem
, QChelp
))
7781 ASET (item_properties
, ITEM_PROPERTY_HELP
, XCAR (item
));
7782 else if (EQ (tem
, QCfilter
))
7784 else if (EQ (tem
, QCkey_sequence
))
7787 if (SYMBOLP (tem
) || STRINGP (tem
) || VECTORP (tem
))
7788 /* Be GC protected. Set keyhint to item instead of tem. */
7791 else if (EQ (tem
, QCkeys
))
7794 if (CONSP (tem
) || STRINGP (tem
))
7795 ASET (item_properties
, ITEM_PROPERTY_KEYEQ
, tem
);
7797 else if (EQ (tem
, QCbutton
) && CONSP (XCAR (item
)))
7802 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
7804 ASET (item_properties
, ITEM_PROPERTY_SELECTED
,
7806 ASET (item_properties
, ITEM_PROPERTY_TYPE
, type
);
7812 else if (inmenubar
|| !NILP (start
))
7816 return 0; /* not a menu item */
7818 /* If item string is not a string, evaluate it to get string.
7819 If we don't get a string, skip this item. */
7820 item_string
= AREF (item_properties
, ITEM_PROPERTY_NAME
);
7821 if (!(STRINGP (item_string
)))
7823 item_string
= menu_item_eval_property (item_string
);
7824 if (!STRINGP (item_string
))
7826 ASET (item_properties
, ITEM_PROPERTY_NAME
, item_string
);
7829 /* If got a filter apply it on definition. */
7830 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7833 def
= menu_item_eval_property (list2 (XCAR (filter
),
7834 list2 (Qquote
, def
)));
7836 ASET (item_properties
, ITEM_PROPERTY_DEF
, def
);
7839 /* Enable or disable selection of item. */
7840 tem
= AREF (item_properties
, ITEM_PROPERTY_ENABLE
);
7843 tem
= menu_item_eval_property (tem
);
7844 if (inmenubar
&& NILP (tem
))
7845 return 0; /* Ignore disabled items in menu bar. */
7846 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, tem
);
7849 /* If we got no definition, this item is just unselectable text which
7850 is OK in a submenu but not in the menubar. */
7852 return (!inmenubar
);
7854 /* See if this is a separate pane or a submenu. */
7855 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7856 tem
= get_keymap (def
, 0, 1);
7857 /* For a subkeymap, just record its details and exit. */
7860 ASET (item_properties
, ITEM_PROPERTY_MAP
, tem
);
7861 ASET (item_properties
, ITEM_PROPERTY_DEF
, tem
);
7865 /* At the top level in the menu bar, do likewise for commands also.
7866 The menu bar does not display equivalent key bindings anyway.
7867 ITEM_PROPERTY_DEF is already set up properly. */
7871 { /* This is a command. See if there is an equivalent key binding. */
7872 Lisp_Object keyeq
= AREF (item_properties
, ITEM_PROPERTY_KEYEQ
);
7873 AUTO_STRING (space_space
, " ");
7875 /* The previous code preferred :key-sequence to :keys, so we
7876 preserve this behavior. */
7877 if (STRINGP (keyeq
) && !CONSP (keyhint
))
7878 keyeq
= concat2 (space_space
, Fsubstitute_command_keys (keyeq
));
7881 Lisp_Object prefix
= keyeq
;
7882 Lisp_Object keys
= Qnil
;
7886 def
= XCAR (prefix
);
7887 prefix
= XCDR (prefix
);
7890 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7892 if (CONSP (keyhint
) && !NILP (XCAR (keyhint
)))
7894 keys
= XCAR (keyhint
);
7895 tem
= Fkey_binding (keys
, Qnil
, Qnil
, Qnil
);
7897 /* We have a suggested key. Is it bound to the command? */
7900 /* If the command is an alias for another
7901 (such as lmenu.el set it up), check if the
7902 original command matches the cached command. */
7904 && EQ (tem
, XSYMBOL (def
)->function
))))
7909 keys
= Fwhere_is_internal (def
, Qnil
, Qt
, Qnil
, Qnil
);
7913 tem
= Fkey_description (keys
, Qnil
);
7916 if (STRINGP (XCAR (prefix
)))
7917 tem
= concat2 (XCAR (prefix
), tem
);
7918 if (STRINGP (XCDR (prefix
)))
7919 tem
= concat2 (tem
, XCDR (prefix
));
7921 keyeq
= concat2 (space_space
, tem
);
7927 /* If we have an equivalent key binding, use that. */
7928 ASET (item_properties
, ITEM_PROPERTY_KEYEQ
, keyeq
);
7931 /* Include this when menu help is implemented.
7932 tem = XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP];
7933 if (!(NILP (tem) || STRINGP (tem)))
7935 tem = menu_item_eval_property (tem);
7938 XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP] = tem;
7942 /* Handle radio buttons or toggle boxes. */
7943 tem
= AREF (item_properties
, ITEM_PROPERTY_SELECTED
);
7945 ASET (item_properties
, ITEM_PROPERTY_SELECTED
,
7946 menu_item_eval_property (tem
));
7953 /***********************************************************************
7955 ***********************************************************************/
7957 /* A vector holding tool bar items while they are parsed in function
7958 tool_bar_items. Each item occupies TOOL_BAR_ITEM_NSCLOTS elements
7961 static Lisp_Object tool_bar_items_vector
;
7963 /* A vector holding the result of parse_tool_bar_item. Layout is like
7964 the one for a single item in tool_bar_items_vector. */
7966 static Lisp_Object tool_bar_item_properties
;
7968 /* Next free index in tool_bar_items_vector. */
7970 static int ntool_bar_items
;
7972 /* Function prototypes. */
7974 static void init_tool_bar_items (Lisp_Object
);
7975 static void process_tool_bar_item (Lisp_Object
, Lisp_Object
, Lisp_Object
,
7977 static bool parse_tool_bar_item (Lisp_Object
, Lisp_Object
);
7978 static void append_tool_bar_item (void);
7981 /* Return a vector of tool bar items for keymaps currently in effect.
7982 Reuse vector REUSE if non-nil. Return in *NITEMS the number of
7983 tool bar items found. */
7986 tool_bar_items (Lisp_Object reuse
, int *nitems
)
7989 Lisp_Object mapsbuf
[3];
7997 /* In order to build the menus, we need to call the keymap
7998 accessors. They all call QUIT. But this function is called
7999 during redisplay, during which a quit is fatal. So inhibit
8000 quitting while building the menus. We do this instead of
8001 specbind because (1) errors will clear it anyway and (2) this
8002 avoids risk of specpdl overflow. */
8003 oquit
= Vinhibit_quit
;
8006 /* Initialize tool_bar_items_vector and protect it from GC. */
8007 init_tool_bar_items (reuse
);
8009 /* Build list of keymaps in maps. Set nmaps to the number of maps
8012 /* Should overriding-terminal-local-map and overriding-local-map apply? */
8013 if (!NILP (Voverriding_local_map_menu_flag
)
8014 && !NILP (Voverriding_local_map
))
8016 /* Yes, use them (if non-nil) as well as the global map. */
8019 if (!NILP (KVAR (current_kboard
, Voverriding_terminal_local_map
)))
8020 maps
[nmaps
++] = KVAR (current_kboard
, Voverriding_terminal_local_map
);
8021 if (!NILP (Voverriding_local_map
))
8022 maps
[nmaps
++] = Voverriding_local_map
;
8026 /* No, so use major and minor mode keymaps and keymap property.
8027 Note that tool-bar bindings in the local-map and keymap
8028 properties may not work reliable, as they are only
8029 recognized when the tool-bar (or mode-line) is updated,
8030 which does not normally happen after every command. */
8033 nminor
= current_minor_maps (NULL
, &tmaps
);
8034 SAFE_NALLOCA (maps
, 1, nminor
+ 4);
8036 tem
= KVAR (current_kboard
, Voverriding_terminal_local_map
);
8037 if (!NILP (tem
) && !NILP (Voverriding_local_map_menu_flag
))
8038 maps
[nmaps
++] = tem
;
8039 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
8040 maps
[nmaps
++] = tem
;
8041 memcpy (maps
+ nmaps
, tmaps
, nminor
* sizeof (maps
[0]));
8043 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
8046 /* Add global keymap at the end. */
8047 maps
[nmaps
++] = current_global_map
;
8049 /* Process maps in reverse order and look up in each map the prefix
8051 for (i
= nmaps
- 1; i
>= 0; --i
)
8052 if (!NILP (maps
[i
]))
8056 keymap
= get_keymap (access_keymap (maps
[i
], Qtool_bar
, 1, 0, 1), 0, 1);
8058 map_keymap (keymap
, process_tool_bar_item
, Qnil
, NULL
, 1);
8061 Vinhibit_quit
= oquit
;
8062 *nitems
= ntool_bar_items
/ TOOL_BAR_ITEM_NSLOTS
;
8064 return tool_bar_items_vector
;
8068 /* Process the definition of KEY which is DEF. */
8071 process_tool_bar_item (Lisp_Object key
, Lisp_Object def
, Lisp_Object data
, void *args
)
8074 struct gcpro gcpro1
, gcpro2
;
8076 /* Protect KEY and DEF from GC because parse_tool_bar_item may call
8080 if (EQ (def
, Qundefined
))
8082 /* If a map has an explicit `undefined' as definition,
8083 discard any previously made item. */
8084 for (i
= 0; i
< ntool_bar_items
; i
+= TOOL_BAR_ITEM_NSLOTS
)
8086 Lisp_Object
*v
= XVECTOR (tool_bar_items_vector
)->contents
+ i
;
8088 if (EQ (key
, v
[TOOL_BAR_ITEM_KEY
]))
8090 if (ntool_bar_items
> i
+ TOOL_BAR_ITEM_NSLOTS
)
8091 memmove (v
, v
+ TOOL_BAR_ITEM_NSLOTS
,
8092 ((ntool_bar_items
- i
- TOOL_BAR_ITEM_NSLOTS
)
8094 ntool_bar_items
-= TOOL_BAR_ITEM_NSLOTS
;
8099 else if (parse_tool_bar_item (key
, def
))
8100 /* Append a new tool bar item to tool_bar_items_vector. Accept
8101 more than one definition for the same key. */
8102 append_tool_bar_item ();
8107 /* Access slot with index IDX of vector tool_bar_item_properties. */
8108 #define PROP(IDX) AREF (tool_bar_item_properties, (IDX))
8110 set_prop (ptrdiff_t idx
, Lisp_Object val
)
8112 ASET (tool_bar_item_properties
, idx
, val
);
8116 /* Parse a tool bar item specification ITEM for key KEY and return the
8117 result in tool_bar_item_properties. Value is false if ITEM is
8120 ITEM is a list `(menu-item CAPTION BINDING PROPS...)'.
8122 CAPTION is the caption of the item, If it's not a string, it is
8123 evaluated to get a string.
8125 BINDING is the tool bar item's binding. Tool-bar items with keymaps
8126 as binding are currently ignored.
8128 The following properties are recognized:
8132 FORM is evaluated and specifies whether the tool bar item is
8133 enabled or disabled.
8137 FORM is evaluated and specifies whether the tool bar item is visible.
8139 - `:filter FUNCTION'
8141 FUNCTION is invoked with one parameter `(quote BINDING)'. Its
8142 result is stored as the new binding.
8144 - `:button (TYPE SELECTED)'
8146 TYPE must be one of `:radio' or `:toggle'. SELECTED is evaluated
8147 and specifies whether the button is selected (pressed) or not.
8151 IMAGES is either a single image specification or a vector of four
8152 image specifications. See enum tool_bar_item_images.
8154 - `:help HELP-STRING'.
8156 Gives a help string to display for the tool bar item.
8158 - `:label LABEL-STRING'.
8160 A text label to show with the tool bar button if labels are enabled. */
8163 parse_tool_bar_item (Lisp_Object key
, Lisp_Object item
)
8165 Lisp_Object filter
= Qnil
;
8166 Lisp_Object caption
;
8168 bool have_label
= 0;
8170 /* Definition looks like `(menu-item CAPTION BINDING PROPS...)'.
8171 Rule out items that aren't lists, don't start with
8172 `menu-item' or whose rest following `tool-bar-item' is not a
8177 /* As an exception, allow old-style menu separators. */
8178 if (STRINGP (XCAR (item
)))
8179 item
= list1 (XCAR (item
));
8180 else if (!EQ (XCAR (item
), Qmenu_item
)
8181 || (item
= XCDR (item
), !CONSP (item
)))
8184 /* Create tool_bar_item_properties vector if necessary. Reset it to
8186 if (VECTORP (tool_bar_item_properties
))
8188 for (i
= 0; i
< TOOL_BAR_ITEM_NSLOTS
; ++i
)
8192 tool_bar_item_properties
8193 = Fmake_vector (make_number (TOOL_BAR_ITEM_NSLOTS
), Qnil
);
8196 set_prop (TOOL_BAR_ITEM_KEY
, key
);
8197 set_prop (TOOL_BAR_ITEM_ENABLED_P
, Qt
);
8199 /* Get the caption of the item. If the caption is not a string,
8200 evaluate it to get a string. If we don't get a string, skip this
8202 caption
= XCAR (item
);
8203 if (!STRINGP (caption
))
8205 caption
= menu_item_eval_property (caption
);
8206 if (!STRINGP (caption
))
8209 set_prop (TOOL_BAR_ITEM_CAPTION
, caption
);
8211 /* If the rest following the caption is not a list, the menu item is
8212 either a separator, or invalid. */
8216 if (menu_separator_name_p (SSDATA (caption
)))
8218 set_prop (TOOL_BAR_ITEM_TYPE
, Qt
);
8219 #if !defined (USE_GTK) && !defined (HAVE_NS)
8220 /* If we use build_desired_tool_bar_string to render the
8221 tool bar, the separator is rendered as an image. */
8222 set_prop (TOOL_BAR_ITEM_IMAGES
,
8223 (menu_item_eval_property
8224 (Vtool_bar_separator_image_expression
)));
8225 set_prop (TOOL_BAR_ITEM_ENABLED_P
, Qnil
);
8226 set_prop (TOOL_BAR_ITEM_SELECTED_P
, Qnil
);
8227 set_prop (TOOL_BAR_ITEM_CAPTION
, Qnil
);
8234 /* Store the binding. */
8235 set_prop (TOOL_BAR_ITEM_BINDING
, XCAR (item
));
8238 /* Ignore cached key binding, if any. */
8239 if (CONSP (item
) && CONSP (XCAR (item
)))
8242 /* Process the rest of the properties. */
8243 for (; CONSP (item
) && CONSP (XCDR (item
)); item
= XCDR (XCDR (item
)))
8245 Lisp_Object ikey
, value
;
8248 value
= XCAR (XCDR (item
));
8250 if (EQ (ikey
, QCenable
))
8252 /* `:enable FORM'. */
8253 if (!NILP (Venable_disabled_menus_and_buttons
))
8254 set_prop (TOOL_BAR_ITEM_ENABLED_P
, Qt
);
8256 set_prop (TOOL_BAR_ITEM_ENABLED_P
, value
);
8258 else if (EQ (ikey
, QCvisible
))
8260 /* `:visible FORM'. If got a visible property and that
8261 evaluates to nil then ignore this item. */
8262 if (NILP (menu_item_eval_property (value
)))
8265 else if (EQ (ikey
, QChelp
))
8266 /* `:help HELP-STRING'. */
8267 set_prop (TOOL_BAR_ITEM_HELP
, value
);
8268 else if (EQ (ikey
, QCvert_only
))
8269 /* `:vert-only t/nil'. */
8270 set_prop (TOOL_BAR_ITEM_VERT_ONLY
, value
);
8271 else if (EQ (ikey
, QClabel
))
8273 const char *bad_label
= "!!?GARBLED ITEM?!!";
8274 /* `:label LABEL-STRING'. */
8275 set_prop (TOOL_BAR_ITEM_LABEL
,
8276 STRINGP (value
) ? value
: build_string (bad_label
));
8279 else if (EQ (ikey
, QCfilter
))
8280 /* ':filter FORM'. */
8282 else if (EQ (ikey
, QCbutton
) && CONSP (value
))
8284 /* `:button (TYPE . SELECTED)'. */
8285 Lisp_Object type
, selected
;
8287 type
= XCAR (value
);
8288 selected
= XCDR (value
);
8289 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
8291 set_prop (TOOL_BAR_ITEM_SELECTED_P
, selected
);
8292 set_prop (TOOL_BAR_ITEM_TYPE
, type
);
8295 else if (EQ (ikey
, QCimage
)
8297 || (VECTORP (value
) && ASIZE (value
) == 4)))
8298 /* Value is either a single image specification or a vector
8299 of 4 such specifications for the different button states. */
8300 set_prop (TOOL_BAR_ITEM_IMAGES
, value
);
8301 else if (EQ (ikey
, QCrtl
))
8303 set_prop (TOOL_BAR_ITEM_RTL_IMAGE
, value
);
8309 /* Try to make one from caption and key. */
8310 Lisp_Object tkey
= PROP (TOOL_BAR_ITEM_KEY
);
8311 Lisp_Object tcapt
= PROP (TOOL_BAR_ITEM_CAPTION
);
8312 const char *label
= SYMBOLP (tkey
) ? SSDATA (SYMBOL_NAME (tkey
)) : "";
8313 const char *capt
= STRINGP (tcapt
) ? SSDATA (tcapt
) : "";
8315 2 * max (0, min (tool_bar_max_label_size
, STRING_BYTES_BOUND
/ 2));
8316 char *buf
= xmalloc (max_lbl
+ 1);
8317 Lisp_Object new_lbl
;
8318 ptrdiff_t caption_len
= strlen (capt
);
8320 if (caption_len
<= max_lbl
&& capt
[0] != '\0')
8323 while (caption_len
> 0 && buf
[caption_len
- 1] == '.')
8325 buf
[caption_len
] = '\0';
8329 if (strlen (label
) <= max_lbl
&& label
[0] != '\0')
8333 strcpy (buf
, label
);
8335 for (j
= 0; buf
[j
] != '\0'; ++j
)
8343 new_lbl
= Fupcase_initials (build_string (label
));
8344 if (SCHARS (new_lbl
) <= tool_bar_max_label_size
)
8345 set_prop (TOOL_BAR_ITEM_LABEL
, new_lbl
);
8347 set_prop (TOOL_BAR_ITEM_LABEL
, empty_unibyte_string
);
8351 /* If got a filter apply it on binding. */
8353 set_prop (TOOL_BAR_ITEM_BINDING
,
8354 (menu_item_eval_property
8357 PROP (TOOL_BAR_ITEM_BINDING
))))));
8359 /* See if the binding is a keymap. Give up if it is. */
8360 if (CONSP (get_keymap (PROP (TOOL_BAR_ITEM_BINDING
), 0, 1)))
8363 /* Enable or disable selection of item. */
8364 if (!EQ (PROP (TOOL_BAR_ITEM_ENABLED_P
), Qt
))
8365 set_prop (TOOL_BAR_ITEM_ENABLED_P
,
8366 menu_item_eval_property (PROP (TOOL_BAR_ITEM_ENABLED_P
)));
8368 /* Handle radio buttons or toggle boxes. */
8369 if (!NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
)))
8370 set_prop (TOOL_BAR_ITEM_SELECTED_P
,
8371 menu_item_eval_property (PROP (TOOL_BAR_ITEM_SELECTED_P
)));
8379 /* Initialize tool_bar_items_vector. REUSE, if non-nil, is a vector
8380 that can be reused. */
8383 init_tool_bar_items (Lisp_Object reuse
)
8385 if (VECTORP (reuse
))
8386 tool_bar_items_vector
= reuse
;
8388 tool_bar_items_vector
= Fmake_vector (make_number (64), Qnil
);
8389 ntool_bar_items
= 0;
8393 /* Append parsed tool bar item properties from
8394 tool_bar_item_properties */
8397 append_tool_bar_item (void)
8401 - (ASIZE (tool_bar_items_vector
) - TOOL_BAR_ITEM_NSLOTS
));
8403 /* Enlarge tool_bar_items_vector if necessary. */
8405 tool_bar_items_vector
= larger_vector (tool_bar_items_vector
, incr
, -1);
8407 /* Append entries from tool_bar_item_properties to the end of
8408 tool_bar_items_vector. */
8409 vcopy (tool_bar_items_vector
, ntool_bar_items
,
8410 XVECTOR (tool_bar_item_properties
)->contents
, TOOL_BAR_ITEM_NSLOTS
);
8411 ntool_bar_items
+= TOOL_BAR_ITEM_NSLOTS
;
8418 /* Read a character using menus based on the keymap MAP.
8419 Return nil if there are no menus in the maps.
8420 Return t if we displayed a menu but the user rejected it.
8422 PREV_EVENT is the previous input event, or nil if we are reading
8423 the first event of a key sequence.
8425 If USED_MOUSE_MENU is non-null, set *USED_MOUSE_MENU to true
8426 if we used a mouse menu to read the input, or false otherwise. If
8427 USED_MOUSE_MENU is null, don't dereference it.
8429 The prompting is done based on the prompt-string of the map
8430 and the strings associated with various map elements.
8432 This can be done with X menus or with menus put in the minibuf.
8433 These are done in different ways, depending on how the input will be read.
8434 Menus using X are done after auto-saving in read-char, getting the input
8435 event from Fx_popup_menu; menus using the minibuf use read_char recursively
8436 and do auto-saving in the inner call of read_char. */
8439 read_char_x_menu_prompt (Lisp_Object map
,
8440 Lisp_Object prev_event
, bool *used_mouse_menu
)
8442 if (used_mouse_menu
)
8443 *used_mouse_menu
= 0;
8445 /* Use local over global Menu maps. */
8447 if (! menu_prompting
)
8450 /* If we got to this point via a mouse click,
8451 use a real menu for mouse selection. */
8452 if (EVENT_HAS_PARAMETERS (prev_event
)
8453 && !EQ (XCAR (prev_event
), Qmenu_bar
)
8454 && !EQ (XCAR (prev_event
), Qtool_bar
))
8456 /* Display the menu and get the selection. */
8459 value
= Fx_popup_menu (prev_event
, get_keymap (map
, 0, 1));
8464 record_menu_key (XCAR (value
));
8466 /* If we got multiple events, unread all but
8468 There is no way to prevent those unread events
8469 from showing up later in last_nonmenu_event.
8470 So turn symbol and integer events into lists,
8471 to indicate that they came from a mouse menu,
8472 so that when present in last_nonmenu_event
8473 they won't confuse things. */
8474 for (tem
= XCDR (value
); CONSP (tem
); tem
= XCDR (tem
))
8476 record_menu_key (XCAR (tem
));
8477 if (SYMBOLP (XCAR (tem
))
8478 || INTEGERP (XCAR (tem
)))
8479 XSETCAR (tem
, Fcons (XCAR (tem
), Qdisabled
));
8482 /* If we got more than one event, put all but the first
8483 onto this list to be read later.
8484 Return just the first event now. */
8485 Vunread_command_events
8486 = nconc2 (XCDR (value
), Vunread_command_events
);
8487 value
= XCAR (value
);
8489 else if (NILP (value
))
8491 if (used_mouse_menu
)
8492 *used_mouse_menu
= 1;
8499 read_char_minibuf_menu_prompt (int commandflag
,
8504 /* FIXME: Use the minibuffer's frame width. */
8505 ptrdiff_t width
= FRAME_COLS (SELECTED_FRAME ()) - 4;
8507 bool nobindings
= 1;
8508 Lisp_Object rest
, vector
;
8509 Lisp_Object prompt_strings
= Qnil
;
8513 if (! menu_prompting
)
8516 map
= get_keymap (map
, 0, 1);
8517 name
= Fkeymap_prompt (map
);
8519 /* If we don't have any menus, just read a character normally. */
8520 if (!STRINGP (name
))
8523 #define PUSH_C_STR(str, listvar) \
8524 listvar = Fcons (build_unibyte_string (str), listvar)
8526 /* Prompt string always starts with map's prompt, and a space. */
8527 prompt_strings
= Fcons (name
, prompt_strings
);
8528 PUSH_C_STR (": ", prompt_strings
);
8529 nlength
= SCHARS (name
) + 2;
8533 /* Present the documented bindings, a line at a time. */
8537 Lisp_Object menu_strings
= prompt_strings
;
8538 ptrdiff_t i
= nlength
;
8540 Lisp_Object orig_defn_macro
;
8542 /* Loop over elements of map. */
8547 /* FIXME: Use map_keymap to handle new keymap formats. */
8549 /* At end of map, wrap around if just starting,
8550 or end this line if already have something on it. */
8553 if (notfirst
|| nobindings
)
8559 /* Look at the next element of the map. */
8561 elt
= AREF (vector
, idx
);
8563 elt
= Fcar_safe (rest
);
8565 if (idx
< 0 && VECTORP (elt
))
8567 /* If we found a dense table in the keymap,
8568 advanced past it, but start scanning its contents. */
8569 rest
= Fcdr_safe (rest
);
8575 /* An ordinary element. */
8576 Lisp_Object event
, tem
;
8580 event
= Fcar_safe (elt
); /* alist */
8581 elt
= Fcdr_safe (elt
);
8585 XSETINT (event
, idx
); /* vector */
8588 /* Ignore the element if it has no prompt string. */
8589 if (INTEGERP (event
) && parse_menu_item (elt
, -1))
8591 /* True if the char to type matches the string. */
8593 Lisp_Object upcased_event
, downcased_event
;
8594 Lisp_Object desc
= Qnil
;
8596 = AREF (item_properties
, ITEM_PROPERTY_NAME
);
8598 upcased_event
= Fupcase (event
);
8599 downcased_event
= Fdowncase (event
);
8600 char_matches
= (XINT (upcased_event
) == SREF (s
, 0)
8601 || XINT (downcased_event
) == SREF (s
, 0));
8603 desc
= Fsingle_key_description (event
, Qnil
);
8605 #if 0 /* It is redundant to list the equivalent key bindings because
8606 the prefix is what the user has already typed. */
8608 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_KEYEQ
];
8610 /* Insert equivalent keybinding. */
8611 s
= concat2 (s
, tem
);
8614 = AREF (item_properties
, ITEM_PROPERTY_TYPE
);
8615 if (EQ (tem
, QCradio
) || EQ (tem
, QCtoggle
))
8617 /* Insert button prefix. */
8618 Lisp_Object selected
8619 = AREF (item_properties
, ITEM_PROPERTY_SELECTED
);
8620 AUTO_STRING (radio_yes
, "(*) ");
8621 AUTO_STRING (radio_no
, "( ) ");
8622 AUTO_STRING (check_yes
, "[X] ");
8623 AUTO_STRING (check_no
, "[ ] ");
8624 if (EQ (tem
, QCradio
))
8625 tem
= NILP (selected
) ? radio_yes
: radio_no
;
8627 tem
= NILP (selected
) ? check_yes
: check_no
;
8628 s
= concat2 (tem
, s
);
8632 /* If we have room for the prompt string, add it to this line.
8633 If this is the first on the line, always add it. */
8634 if ((SCHARS (s
) + i
+ 2
8635 + (char_matches
? 0 : SCHARS (desc
) + 3))
8639 ptrdiff_t thiswidth
;
8641 /* Punctuate between strings. */
8644 PUSH_C_STR (", ", menu_strings
);
8650 /* If the char to type doesn't match the string's
8651 first char, explicitly show what char to type. */
8654 /* Add as much of string as fits. */
8655 thiswidth
= min (SCHARS (desc
), width
- i
);
8657 = Fcons (Fsubstring (desc
, make_number (0),
8658 make_number (thiswidth
)),
8661 PUSH_C_STR (" = ", menu_strings
);
8665 /* Add as much of string as fits. */
8666 thiswidth
= min (SCHARS (s
), width
- i
);
8668 = Fcons (Fsubstring (s
, make_number (0),
8669 make_number (thiswidth
)),
8675 /* If this element does not fit, end the line now,
8676 and save the element for the next line. */
8677 PUSH_C_STR ("...", menu_strings
);
8682 /* Move past this element. */
8683 if (idx
>= 0 && idx
+ 1 >= ASIZE (vector
))
8684 /* Handle reaching end of dense table. */
8689 rest
= Fcdr_safe (rest
);
8693 /* Prompt with that and read response. */
8694 message3_nolog (apply1 (intern ("concat"), Fnreverse (menu_strings
)));
8696 /* Make believe it's not a keyboard macro in case the help char
8697 is pressed. Help characters are not recorded because menu prompting
8698 is not used on replay. */
8699 orig_defn_macro
= KVAR (current_kboard
, defining_kbd_macro
);
8700 kset_defining_kbd_macro (current_kboard
, Qnil
);
8702 obj
= read_char (commandflag
, Qnil
, Qt
, 0, NULL
);
8703 while (BUFFERP (obj
));
8704 kset_defining_kbd_macro (current_kboard
, orig_defn_macro
);
8706 if (!INTEGERP (obj
) || XINT (obj
) == -2)
8709 if (! EQ (obj
, menu_prompt_more_char
)
8710 && (!INTEGERP (menu_prompt_more_char
)
8711 || ! EQ (obj
, make_number (Ctl (XINT (menu_prompt_more_char
))))))
8713 if (!NILP (KVAR (current_kboard
, defining_kbd_macro
)))
8714 store_kbd_macro_char (obj
);
8717 /* Help char - go round again. */
8721 /* Reading key sequences. */
8724 follow_key (Lisp_Object keymap
, Lisp_Object key
)
8726 return access_keymap (get_keymap (keymap
, 0, 1),
8731 active_maps (Lisp_Object first_event
)
8733 Lisp_Object position
8734 = CONSP (first_event
) ? CAR_SAFE (XCDR (first_event
)) : Qnil
;
8735 return Fcons (Qkeymap
, Fcurrent_active_maps (Qt
, position
));
8738 /* Structure used to keep track of partial application of key remapping
8739 such as Vfunction_key_map and Vkey_translation_map. */
8740 typedef struct keyremap
8742 /* This is the map originally specified for this use. */
8744 /* This is a submap reached by looking up, in PARENT,
8745 the events from START to END. */
8747 /* Positions [START, END) in the key sequence buffer
8748 are the key that we have scanned so far.
8749 Those events are the ones that we will replace
8750 if PARENT maps them into a key sequence. */
8754 /* Lookup KEY in MAP.
8755 MAP is a keymap mapping keys to key vectors or functions.
8756 If the mapping is a function and DO_FUNCALL is true,
8757 the function is called with PROMPT as parameter and its return
8758 value is used as the return value of this function (after checking
8759 that it is indeed a vector). */
8762 access_keymap_keyremap (Lisp_Object map
, Lisp_Object key
, Lisp_Object prompt
,
8767 next
= access_keymap (map
, key
, 1, 0, 1);
8769 /* Handle a symbol whose function definition is a keymap
8771 if (SYMBOLP (next
) && !NILP (Ffboundp (next
))
8772 && (ARRAYP (XSYMBOL (next
)->function
)
8773 || KEYMAPP (XSYMBOL (next
)->function
)))
8774 next
= Fautoload_do_load (XSYMBOL (next
)->function
, next
, Qnil
);
8776 /* If the keymap gives a function, not an
8777 array, then call the function with one arg and use
8778 its value instead. */
8779 if (do_funcall
&& FUNCTIONP (next
))
8784 next
= call1 (next
, prompt
);
8785 /* If the function returned something invalid,
8786 barf--don't ignore it.
8787 (To ignore it safely, we would need to gcpro a bunch of
8788 other variables.) */
8789 if (! (NILP (next
) || VECTORP (next
) || STRINGP (next
)))
8790 error ("Function %s returns invalid key sequence",
8791 SSDATA (SYMBOL_NAME (tem
)));
8796 /* Do one step of the key remapping used for function-key-map and
8797 key-translation-map:
8798 KEYBUF is the buffer holding the input events.
8799 BUFSIZE is its maximum size.
8800 FKEY is a pointer to the keyremap structure to use.
8801 INPUT is the index of the last element in KEYBUF.
8802 DOIT if true says that the remapping can actually take place.
8803 DIFF is used to return the number of keys added/removed by the remapping.
8804 PARENT is the root of the keymap.
8805 PROMPT is the prompt to use if the remapping happens through a function.
8806 Return true if the remapping actually took place. */
8809 keyremap_step (Lisp_Object
*keybuf
, int bufsize
, volatile keyremap
*fkey
,
8810 int input
, bool doit
, int *diff
, Lisp_Object prompt
)
8812 Lisp_Object next
, key
;
8814 key
= keybuf
[fkey
->end
++];
8816 if (KEYMAPP (fkey
->parent
))
8817 next
= access_keymap_keyremap (fkey
->map
, key
, prompt
, doit
);
8821 /* If keybuf[fkey->start..fkey->end] is bound in the
8822 map and we're in a position to do the key remapping, replace it with
8823 the binding and restart with fkey->start at the end. */
8824 if ((VECTORP (next
) || STRINGP (next
)) && doit
)
8826 int len
= XFASTINT (Flength (next
));
8829 *diff
= len
- (fkey
->end
- fkey
->start
);
8831 if (bufsize
- input
<= *diff
)
8832 error ("Key sequence too long");
8834 /* Shift the keys that follow fkey->end. */
8836 for (i
= fkey
->end
; i
< input
; i
++)
8837 keybuf
[i
+ *diff
] = keybuf
[i
];
8839 for (i
= input
- 1; i
>= fkey
->end
; i
--)
8840 keybuf
[i
+ *diff
] = keybuf
[i
];
8841 /* Overwrite the old keys with the new ones. */
8842 for (i
= 0; i
< len
; i
++)
8843 keybuf
[fkey
->start
+ i
]
8844 = Faref (next
, make_number (i
));
8846 fkey
->start
= fkey
->end
+= *diff
;
8847 fkey
->map
= fkey
->parent
;
8852 fkey
->map
= get_keymap (next
, 0, 1);
8854 /* If we no longer have a bound suffix, try a new position for
8856 if (!CONSP (fkey
->map
))
8858 fkey
->end
= ++fkey
->start
;
8859 fkey
->map
= fkey
->parent
;
8865 test_undefined (Lisp_Object binding
)
8867 return (NILP (binding
)
8868 || EQ (binding
, Qundefined
)
8869 || (SYMBOLP (binding
)
8870 && EQ (Fcommand_remapping (binding
, Qnil
, Qnil
), Qundefined
)));
8873 /* Read a sequence of keys that ends with a non prefix character,
8874 storing it in KEYBUF, a buffer of size BUFSIZE.
8876 Return the length of the key sequence stored.
8877 Return -1 if the user rejected a command menu.
8879 Echo starting immediately unless `prompt' is 0.
8881 If PREVENT_REDISPLAY is non-zero, avoid redisplay by calling
8882 read_char with a suitable COMMANDFLAG argument.
8884 Where a key sequence ends depends on the currently active keymaps.
8885 These include any minor mode keymaps active in the current buffer,
8886 the current buffer's local map, and the global map.
8888 If a key sequence has no other bindings, we check Vfunction_key_map
8889 to see if some trailing subsequence might be the beginning of a
8890 function key's sequence. If so, we try to read the whole function
8891 key, and substitute its symbolic name into the key sequence.
8893 We ignore unbound `down-' mouse clicks. We turn unbound `drag-' and
8894 `double-' events into similar click events, if that would make them
8895 bound. We try to turn `triple-' events first into `double-' events,
8898 If we get a mouse click in a mode line, vertical divider, or other
8899 non-text area, we treat the click as if it were prefixed by the
8900 symbol denoting that area - `mode-line', `vertical-line', or
8903 If the sequence starts with a mouse click, we read the key sequence
8904 with respect to the buffer clicked on, not the current buffer.
8906 If the user switches frames in the midst of a key sequence, we put
8907 off the switch-frame event until later; the next call to
8908 read_char will return it.
8910 If FIX_CURRENT_BUFFER, we restore current_buffer
8911 from the selected window's buffer. */
8914 read_key_sequence (Lisp_Object
*keybuf
, int bufsize
, Lisp_Object prompt
,
8915 bool dont_downcase_last
, bool can_return_switch_frame
,
8916 bool fix_current_buffer
, bool prevent_redisplay
)
8918 ptrdiff_t count
= SPECPDL_INDEX ();
8920 /* How many keys there are in the current key sequence. */
8923 /* The length of the echo buffer when we started reading, and
8924 the length of this_command_keys when we started reading. */
8925 ptrdiff_t echo_start
IF_LINT (= 0);
8926 ptrdiff_t keys_start
;
8928 Lisp_Object current_binding
= Qnil
;
8929 Lisp_Object first_event
= Qnil
;
8931 /* Index of the first key that has no binding.
8932 It is useless to try fkey.start larger than that. */
8935 /* If t < mock_input, then KEYBUF[t] should be read as the next
8938 We use this to recover after recognizing a function key. Once we
8939 realize that a suffix of the current key sequence is actually a
8940 function key's escape sequence, we replace the suffix with the
8941 function key's binding from Vfunction_key_map. Now keybuf
8942 contains a new and different key sequence, so the echo area,
8943 this_command_keys, and the submaps and defs arrays are wrong. In
8944 this situation, we set mock_input to t, set t to 0, and jump to
8945 restart_sequence; the loop will read keys from keybuf up until
8946 mock_input, thus rebuilding the state; and then it will resume
8947 reading characters from the keyboard. */
8950 /* If the sequence is unbound in submaps[], then
8951 keybuf[fkey.start..fkey.end-1] is a prefix in Vfunction_key_map,
8952 and fkey.map is its binding.
8954 These might be > t, indicating that all function key scanning
8955 should hold off until t reaches them. We do this when we've just
8956 recognized a function key, to avoid searching for the function
8957 key's again in Vfunction_key_map. */
8960 /* Likewise, for key_translation_map and input-decode-map. */
8961 keyremap keytran
, indec
;
8963 /* True if we are trying to map a key by changing an upper-case
8964 letter to lower case, or a shifted function key to an unshifted
8966 bool shift_translated
= 0;
8968 /* If we receive a `switch-frame' or `select-window' event in the middle of
8969 a key sequence, we put it off for later.
8970 While we're reading, we keep the event here. */
8971 Lisp_Object delayed_switch_frame
;
8973 Lisp_Object original_uppercase
IF_LINT (= Qnil
);
8974 int original_uppercase_position
= -1;
8976 /* Gets around Microsoft compiler limitations. */
8979 struct buffer
*starting_buffer
;
8981 /* List of events for which a fake prefix key has been generated. */
8982 Lisp_Object fake_prefixed_keys
= Qnil
;
8984 struct gcpro gcpro1
;
8986 GCPRO1 (fake_prefixed_keys
);
8987 raw_keybuf_count
= 0;
8989 last_nonmenu_event
= Qnil
;
8991 delayed_switch_frame
= Qnil
;
8997 /* Install the string PROMPT as the beginning of the string
8998 of echoing, so that it serves as a prompt for the next
9000 kset_echo_string (current_kboard
, prompt
);
9001 current_kboard
->echo_after_prompt
= SCHARS (prompt
);
9004 else if (cursor_in_echo_area
9005 && echo_keystrokes_p ())
9006 /* This doesn't put in a dash if the echo buffer is empty, so
9007 you don't always see a dash hanging out in the minibuffer. */
9011 /* Record the initial state of the echo area and this_command_keys;
9012 we will need to restore them if we replay a key sequence. */
9014 echo_start
= echo_length ();
9015 keys_start
= this_command_key_count
;
9016 this_single_command_key_start
= keys_start
;
9018 /* We jump here when we need to reinitialize fkey and keytran; this
9019 happens if we switch keyboards between rescans. */
9020 replay_entire_sequence
:
9022 indec
.map
= indec
.parent
= KVAR (current_kboard
, Vinput_decode_map
);
9023 fkey
.map
= fkey
.parent
= KVAR (current_kboard
, Vlocal_function_key_map
);
9024 keytran
.map
= keytran
.parent
= Vkey_translation_map
;
9025 indec
.start
= indec
.end
= 0;
9026 fkey
.start
= fkey
.end
= 0;
9027 keytran
.start
= keytran
.end
= 0;
9029 /* We jump here when the key sequence has been thoroughly changed, and
9030 we need to rescan it starting from the beginning. When we jump here,
9031 keybuf[0..mock_input] holds the sequence we should reread. */
9034 starting_buffer
= current_buffer
;
9035 first_unbound
= bufsize
+ 1;
9037 /* Build our list of keymaps.
9038 If we recognize a function key and replace its escape sequence in
9039 keybuf with its symbol, or if the sequence starts with a mouse
9040 click and we need to switch buffers, we jump back here to rebuild
9041 the initial keymaps from the current buffer. */
9042 current_binding
= active_maps (first_event
);
9044 /* Start from the beginning in keybuf. */
9047 /* These are no-ops the first time through, but if we restart, they
9048 revert the echo area and this_command_keys to their original state. */
9049 this_command_key_count
= keys_start
;
9050 if (INTERACTIVE
&& t
< mock_input
)
9051 echo_truncate (echo_start
);
9053 /* If the best binding for the current key sequence is a keymap, or
9054 we may be looking at a function key's escape sequence, keep on
9056 while (!NILP (current_binding
)
9057 /* Keep reading as long as there's a prefix binding. */
9058 ? KEYMAPP (current_binding
)
9059 /* Don't return in the middle of a possible function key sequence,
9060 if the only bindings we found were via case conversion.
9061 Thus, if ESC O a has a function-key-map translation
9062 and ESC o has a binding, don't return after ESC O,
9063 so that we can translate ESC O plus the next character. */
9064 : (/* indec.start < t || fkey.start < t || */ keytran
.start
< t
))
9067 bool used_mouse_menu
= 0;
9069 /* Where the last real key started. If we need to throw away a
9070 key that has expanded into more than one element of keybuf
9071 (say, a mouse click on the mode line which is being treated
9072 as [mode-line (mouse-...)], then we backtrack to this point
9074 int last_real_key_start
;
9076 /* These variables are analogous to echo_start and keys_start;
9077 while those allow us to restart the entire key sequence,
9078 echo_local_start and keys_local_start allow us to throw away
9080 ptrdiff_t echo_local_start
IF_LINT (= 0);
9081 int keys_local_start
;
9082 Lisp_Object new_binding
;
9084 eassert (indec
.end
== t
|| (indec
.end
> t
&& indec
.end
<= mock_input
));
9085 eassert (indec
.start
<= indec
.end
);
9086 eassert (fkey
.start
<= fkey
.end
);
9087 eassert (keytran
.start
<= keytran
.end
);
9088 /* key-translation-map is applied *after* function-key-map
9089 which is itself applied *after* input-decode-map. */
9090 eassert (fkey
.end
<= indec
.start
);
9091 eassert (keytran
.end
<= fkey
.start
);
9093 if (/* first_unbound < indec.start && first_unbound < fkey.start && */
9094 first_unbound
< keytran
.start
)
9095 { /* The prefix upto first_unbound has no binding and has
9096 no translation left to do either, so we know it's unbound.
9097 If we don't stop now, we risk staying here indefinitely
9098 (if the user keeps entering fkey or keytran prefixes
9099 like C-c ESC ESC ESC ESC ...) */
9101 for (i
= first_unbound
+ 1; i
< t
; i
++)
9102 keybuf
[i
- first_unbound
- 1] = keybuf
[i
];
9103 mock_input
= t
- first_unbound
- 1;
9104 indec
.end
= indec
.start
-= first_unbound
+ 1;
9105 indec
.map
= indec
.parent
;
9106 fkey
.end
= fkey
.start
-= first_unbound
+ 1;
9107 fkey
.map
= fkey
.parent
;
9108 keytran
.end
= keytran
.start
-= first_unbound
+ 1;
9109 keytran
.map
= keytran
.parent
;
9110 goto replay_sequence
;
9114 error ("Key sequence too long");
9117 echo_local_start
= echo_length ();
9118 keys_local_start
= this_command_key_count
;
9121 /* These are no-ops, unless we throw away a keystroke below and
9122 jumped back up to replay_key; in that case, these restore the
9123 variables to their original state, allowing us to replay the
9125 if (INTERACTIVE
&& t
< mock_input
)
9126 echo_truncate (echo_local_start
);
9127 this_command_key_count
= keys_local_start
;
9129 /* By default, assume each event is "real". */
9130 last_real_key_start
= t
;
9132 /* Does mock_input indicate that we are re-reading a key sequence? */
9136 add_command_key (key
);
9137 if (echo_keystrokes_p ()
9138 && current_kboard
->immediate_echo
)
9145 /* If not, we should actually read a character. */
9149 KBOARD
*interrupted_kboard
= current_kboard
;
9150 struct frame
*interrupted_frame
= SELECTED_FRAME ();
9151 /* Calling read_char with COMMANDFLAG = -2 avoids
9152 redisplay in read_char and its subroutines. */
9153 key
= read_char (prevent_redisplay
? -2 : NILP (prompt
),
9154 current_binding
, last_nonmenu_event
,
9155 &used_mouse_menu
, NULL
);
9156 if ((INTEGERP (key
) && XINT (key
) == -2) /* wrong_kboard_jmpbuf */
9157 /* When switching to a new tty (with a new keyboard),
9158 read_char returns the new buffer, rather than -2
9159 (Bug#5095). This is because `terminal-init-xterm'
9160 calls read-char, which eats the wrong_kboard_jmpbuf
9161 return. Any better way to fix this? -- cyd */
9162 || (interrupted_kboard
!= current_kboard
))
9167 for (k
= all_kboards
; k
; k
= k
->next_kboard
)
9168 if (k
== interrupted_kboard
)
9173 /* Don't touch interrupted_kboard when it's been
9175 delayed_switch_frame
= Qnil
;
9176 goto replay_entire_sequence
;
9179 if (!NILP (delayed_switch_frame
))
9182 (interrupted_kboard
,
9183 Fcons (delayed_switch_frame
,
9184 KVAR (interrupted_kboard
, kbd_queue
)));
9185 delayed_switch_frame
= Qnil
;
9190 (interrupted_kboard
,
9191 Fcons (keybuf
[--t
], KVAR (interrupted_kboard
, kbd_queue
)));
9193 /* If the side queue is non-empty, ensure it begins with a
9194 switch-frame, so we'll replay it in the right context. */
9195 if (CONSP (KVAR (interrupted_kboard
, kbd_queue
))
9196 && (key
= XCAR (KVAR (interrupted_kboard
, kbd_queue
)),
9197 !(EVENT_HAS_PARAMETERS (key
)
9198 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)),
9202 XSETFRAME (frame
, interrupted_frame
);
9204 (interrupted_kboard
,
9205 Fcons (make_lispy_switch_frame (frame
),
9206 KVAR (interrupted_kboard
, kbd_queue
)));
9209 goto replay_entire_sequence
;
9213 /* read_char returns t when it shows a menu and the user rejects it.
9217 unbind_to (count
, Qnil
);
9222 /* read_char returns -1 at the end of a macro.
9223 Emacs 18 handles this by returning immediately with a
9224 zero, so that's what we'll do. */
9225 if (INTEGERP (key
) && XINT (key
) == -1)
9228 /* The Microsoft C compiler can't handle the goto that
9234 /* If the current buffer has been changed from under us, the
9235 keymap may have changed, so replay the sequence. */
9238 timer_resume_idle ();
9241 /* Reset the current buffer from the selected window
9242 in case something changed the former and not the latter.
9243 This is to be more consistent with the behavior
9244 of the command_loop_1. */
9245 if (fix_current_buffer
)
9247 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
9249 if (XBUFFER (XWINDOW (selected_window
)->contents
)
9251 Fset_buffer (XWINDOW (selected_window
)->contents
);
9254 goto replay_sequence
;
9257 /* If we have a quit that was typed in another frame, and
9258 quit_throw_to_read_char switched buffers,
9259 replay to get the right keymap. */
9261 && XINT (key
) == quit_char
9262 && current_buffer
!= starting_buffer
)
9265 ASET (raw_keybuf
, raw_keybuf_count
, key
);
9270 goto replay_sequence
;
9275 if (EVENT_HAS_PARAMETERS (key
)
9276 /* Either a `switch-frame' or a `select-window' event. */
9277 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)), Qswitch_frame
))
9279 /* If we're at the beginning of a key sequence, and the caller
9280 says it's okay, go ahead and return this event. If we're
9281 in the midst of a key sequence, delay it until the end. */
9282 if (t
> 0 || !can_return_switch_frame
)
9284 delayed_switch_frame
= key
;
9289 if (NILP (first_event
))
9292 /* Even if first_event does not specify a particular
9293 window/position, it's important to recompute the maps here
9294 since a long time might have passed since we entered
9295 read_key_sequence, and a timer (or process-filter or
9296 special-event-map, ...) might have switched the current buffer
9297 or the selected window from under us in the mean time. */
9298 if (fix_current_buffer
9299 && (XBUFFER (XWINDOW (selected_window
)->contents
)
9301 Fset_buffer (XWINDOW (selected_window
)->contents
);
9302 current_binding
= active_maps (first_event
);
9306 ASET (raw_keybuf
, raw_keybuf_count
, key
);
9310 /* Clicks in non-text areas get prefixed by the symbol
9311 in their CHAR-ADDRESS field. For example, a click on
9312 the mode line is prefixed by the symbol `mode-line'.
9314 Furthermore, key sequences beginning with mouse clicks
9315 are read using the keymaps of the buffer clicked on, not
9316 the current buffer. So we may have to switch the buffer
9319 When we turn one event into two events, we must make sure
9320 that neither of the two looks like the original--so that,
9321 if we replay the events, they won't be expanded again.
9322 If not for this, such reexpansion could happen either here
9323 or when user programs play with this-command-keys. */
9324 if (EVENT_HAS_PARAMETERS (key
))
9326 Lisp_Object kind
= EVENT_HEAD_KIND (EVENT_HEAD (key
));
9327 if (EQ (kind
, Qmouse_click
))
9329 Lisp_Object window
= POSN_WINDOW (EVENT_START (key
));
9330 Lisp_Object posn
= POSN_POSN (EVENT_START (key
));
9333 || (!NILP (fake_prefixed_keys
)
9334 && !NILP (Fmemq (key
, fake_prefixed_keys
))))
9336 /* We're looking a second time at an event for which
9337 we generated a fake prefix key. Set
9338 last_real_key_start appropriately. */
9340 last_real_key_start
= t
- 1;
9343 if (last_real_key_start
== 0)
9345 /* Key sequences beginning with mouse clicks are
9346 read using the keymaps in the buffer clicked on,
9347 not the current buffer. If we're at the
9348 beginning of a key sequence, switch buffers. */
9349 if (WINDOWP (window
)
9350 && BUFFERP (XWINDOW (window
)->contents
)
9351 && XBUFFER (XWINDOW (window
)->contents
) != current_buffer
)
9353 ASET (raw_keybuf
, raw_keybuf_count
, key
);
9358 /* Arrange to go back to the original buffer once we're
9359 done reading the key sequence. Note that we can't
9360 use save_excursion_{save,restore} here, because they
9361 save point as well as the current buffer; we don't
9362 want to save point, because redisplay may change it,
9363 to accommodate a Fset_window_start or something. We
9364 don't want to do this at the top of the function,
9365 because we may get input from a subprocess which
9366 wants to change the selected window and stuff (say,
9368 record_unwind_current_buffer ();
9370 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
9372 set_buffer_internal (XBUFFER (XWINDOW (window
)->contents
));
9373 goto replay_sequence
;
9377 /* Expand mode-line and scroll-bar events into two events:
9378 use posn as a fake prefix key. */
9380 && (NILP (fake_prefixed_keys
)
9381 || NILP (Fmemq (key
, fake_prefixed_keys
))))
9383 if (bufsize
- t
<= 1)
9384 error ("Key sequence too long");
9387 keybuf
[t
+ 1] = key
;
9390 /* Record that a fake prefix key has been generated
9391 for KEY. Don't modify the event; this would
9392 prevent proper action when the event is pushed
9393 back into unread-command-events. */
9394 fake_prefixed_keys
= Fcons (key
, fake_prefixed_keys
);
9398 else if (CONSP (XCDR (key
))
9399 && CONSP (EVENT_START (key
))
9400 && CONSP (XCDR (EVENT_START (key
))))
9404 posn
= POSN_POSN (EVENT_START (key
));
9405 /* Handle menu-bar events:
9406 insert the dummy prefix event `menu-bar'. */
9407 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
9409 if (bufsize
- t
<= 1)
9410 error ("Key sequence too long");
9412 keybuf
[t
+ 1] = key
;
9414 /* Zap the position in key, so we know that we've
9415 expanded it, and don't try to do so again. */
9416 POSN_SET_POSN (EVENT_START (key
), list1 (posn
));
9419 goto replay_sequence
;
9421 else if (CONSP (posn
))
9423 /* We're looking at the second event of a
9424 sequence which we expanded before. Set
9425 last_real_key_start appropriately. */
9426 if (last_real_key_start
== t
&& t
> 0)
9427 last_real_key_start
= t
- 1;
9432 /* We have finally decided that KEY is something we might want
9434 new_binding
= follow_key (current_binding
, key
);
9436 /* If KEY wasn't bound, we'll try some fallbacks. */
9437 if (!NILP (new_binding
))
9438 /* This is needed for the following scenario:
9439 event 0: a down-event that gets dropped by calling replay_key.
9440 event 1: some normal prefix like C-h.
9441 After event 0, first_unbound is 0, after event 1 indec.start,
9442 fkey.start, and keytran.start are all 1, so when we see that
9443 C-h is bound, we need to update first_unbound. */
9444 first_unbound
= max (t
+ 1, first_unbound
);
9449 /* Remember the position to put an upper bound on indec.start. */
9450 first_unbound
= min (t
, first_unbound
);
9452 head
= EVENT_HEAD (key
);
9456 Lisp_Object breakdown
;
9459 breakdown
= parse_modifiers (head
);
9460 modifiers
= XINT (XCAR (XCDR (breakdown
)));
9461 /* Attempt to reduce an unbound mouse event to a simpler
9462 event that is bound:
9463 Drags reduce to clicks.
9464 Double-clicks reduce to clicks.
9465 Triple-clicks reduce to double-clicks, then to clicks.
9466 Down-clicks are eliminated.
9467 Double-downs reduce to downs, then are eliminated.
9468 Triple-downs reduce to double-downs, then to downs,
9469 then are eliminated. */
9470 if (modifiers
& (down_modifier
| drag_modifier
9471 | double_modifier
| triple_modifier
))
9473 while (modifiers
& (down_modifier
| drag_modifier
9474 | double_modifier
| triple_modifier
))
9476 Lisp_Object new_head
, new_click
;
9477 if (modifiers
& triple_modifier
)
9478 modifiers
^= (double_modifier
| triple_modifier
);
9479 else if (modifiers
& double_modifier
)
9480 modifiers
&= ~double_modifier
;
9481 else if (modifiers
& drag_modifier
)
9482 modifiers
&= ~drag_modifier
;
9485 /* Dispose of this `down' event by simply jumping
9486 back to replay_key, to get another event.
9488 Note that if this event came from mock input,
9489 then just jumping back to replay_key will just
9490 hand it to us again. So we have to wipe out any
9493 We could delete keybuf[t] and shift everything
9494 after that to the left by one spot, but we'd also
9495 have to fix up any variable that points into
9496 keybuf, and shifting isn't really necessary
9499 Adding prefixes for non-textual mouse clicks
9500 creates two characters of mock input, and both
9501 must be thrown away. If we're only looking at
9502 the prefix now, we can just jump back to
9503 replay_key. On the other hand, if we've already
9504 processed the prefix, and now the actual click
9505 itself is giving us trouble, then we've lost the
9506 state of the keymaps we want to backtrack to, and
9507 we need to replay the whole sequence to rebuild
9510 Beyond that, only function key expansion could
9511 create more than two keys, but that should never
9512 generate mouse events, so it's okay to zero
9513 mock_input in that case too.
9515 FIXME: The above paragraph seems just plain
9516 wrong, if you consider things like
9517 xterm-mouse-mode. -stef
9519 Isn't this just the most wonderful code ever? */
9521 /* If mock_input > t + 1, the above simplification
9522 will actually end up dropping keys on the floor.
9523 This is probably OK for now, but even
9524 if mock_input <= t + 1, we need to adjust indec,
9526 Typical case [header-line down-mouse-N]:
9527 mock_input = 2, t = 1, fkey.end = 1,
9528 last_real_key_start = 0. */
9529 if (indec
.end
> last_real_key_start
)
9531 indec
.end
= indec
.start
9532 = min (last_real_key_start
, indec
.start
);
9533 indec
.map
= indec
.parent
;
9534 if (fkey
.end
> last_real_key_start
)
9536 fkey
.end
= fkey
.start
9537 = min (last_real_key_start
, fkey
.start
);
9538 fkey
.map
= fkey
.parent
;
9539 if (keytran
.end
> last_real_key_start
)
9541 keytran
.end
= keytran
.start
9542 = min (last_real_key_start
, keytran
.start
);
9543 keytran
.map
= keytran
.parent
;
9547 if (t
== last_real_key_start
)
9554 mock_input
= last_real_key_start
;
9555 goto replay_sequence
;
9560 = apply_modifiers (modifiers
, XCAR (breakdown
));
9561 new_click
= list2 (new_head
, EVENT_START (key
));
9563 /* Look for a binding for this new key. */
9564 new_binding
= follow_key (current_binding
, new_click
);
9566 /* If that click is bound, go for it. */
9567 if (!NILP (new_binding
))
9569 current_binding
= new_binding
;
9573 /* Otherwise, we'll leave key set to the drag event. */
9578 current_binding
= new_binding
;
9581 /* Normally, last_nonmenu_event gets the previous key we read.
9582 But when a mouse popup menu is being used,
9583 we don't update last_nonmenu_event; it continues to hold the mouse
9584 event that preceded the first level of menu. */
9585 if (!used_mouse_menu
)
9586 last_nonmenu_event
= key
;
9588 /* Record what part of this_command_keys is the current key sequence. */
9589 this_single_command_key_start
= this_command_key_count
- t
;
9591 /* Look for this sequence in input-decode-map.
9592 Scan from indec.end until we find a bound suffix. */
9593 while (indec
.end
< t
)
9595 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9599 GCPRO4 (indec
.map
, fkey
.map
, keytran
.map
, delayed_switch_frame
);
9600 done
= keyremap_step (keybuf
, bufsize
, &indec
, max (t
, mock_input
),
9605 mock_input
= diff
+ max (t
, mock_input
);
9606 goto replay_sequence
;
9610 if (!KEYMAPP (current_binding
)
9611 && !test_undefined (current_binding
)
9612 && indec
.start
>= t
)
9613 /* There is a binding and it's not a prefix.
9614 (and it doesn't have any input-decode-map translation pending).
9615 There is thus no function-key in this sequence.
9616 Moving fkey.start is important in this case to allow keytran.start
9617 to go over the sequence before we return (since we keep the
9618 invariant that keytran.end <= fkey.start). */
9621 (fkey
.start
= fkey
.end
= t
, fkey
.map
= fkey
.parent
);
9624 /* If the sequence is unbound, see if we can hang a function key
9625 off the end of it. */
9626 /* Continue scan from fkey.end until we find a bound suffix. */
9627 while (fkey
.end
< indec
.start
)
9629 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9633 GCPRO4 (indec
.map
, fkey
.map
, keytran
.map
, delayed_switch_frame
);
9634 done
= keyremap_step (keybuf
, bufsize
, &fkey
,
9635 max (t
, mock_input
),
9636 /* If there's a binding (i.e.
9637 first_binding >= nmaps) we don't want
9638 to apply this function-key-mapping. */
9640 && (test_undefined (current_binding
)),
9645 mock_input
= diff
+ max (t
, mock_input
);
9646 /* Adjust the input-decode-map counters. */
9648 indec
.start
+= diff
;
9650 goto replay_sequence
;
9654 /* Look for this sequence in key-translation-map.
9655 Scan from keytran.end until we find a bound suffix. */
9656 while (keytran
.end
< fkey
.start
)
9658 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9662 GCPRO4 (indec
.map
, fkey
.map
, keytran
.map
, delayed_switch_frame
);
9663 done
= keyremap_step (keybuf
, bufsize
, &keytran
, max (t
, mock_input
),
9668 mock_input
= diff
+ max (t
, mock_input
);
9669 /* Adjust the function-key-map and input-decode-map counters. */
9671 indec
.start
+= diff
;
9675 goto replay_sequence
;
9679 /* If KEY is not defined in any of the keymaps,
9680 and cannot be part of a function key or translation,
9681 and is an upper case letter
9682 use the corresponding lower-case letter instead. */
9683 if (NILP (current_binding
)
9684 && /* indec.start >= t && fkey.start >= t && */ keytran
.start
>= t
9686 && ((CHARACTERP (make_number (XINT (key
) & ~CHAR_MODIFIER_MASK
))
9687 && uppercasep (XINT (key
) & ~CHAR_MODIFIER_MASK
))
9688 || (XINT (key
) & shift_modifier
)))
9690 Lisp_Object new_key
;
9692 original_uppercase
= key
;
9693 original_uppercase_position
= t
- 1;
9695 if (XINT (key
) & shift_modifier
)
9696 XSETINT (new_key
, XINT (key
) & ~shift_modifier
);
9698 XSETINT (new_key
, (downcase (XINT (key
) & ~CHAR_MODIFIER_MASK
)
9699 | (XINT (key
) & CHAR_MODIFIER_MASK
)));
9701 /* We have to do this unconditionally, regardless of whether
9702 the lower-case char is defined in the keymaps, because they
9703 might get translated through function-key-map. */
9704 keybuf
[t
- 1] = new_key
;
9705 mock_input
= max (t
, mock_input
);
9706 shift_translated
= 1;
9708 goto replay_sequence
;
9711 if (NILP (current_binding
)
9712 && help_char_p (EVENT_HEAD (key
)) && t
> 1)
9714 read_key_sequence_cmd
= Vprefix_help_command
;
9715 /* The Microsoft C compiler can't handle the goto that
9721 /* If KEY is not defined in any of the keymaps,
9722 and cannot be part of a function key or translation,
9723 and is a shifted function key,
9724 use the corresponding unshifted function key instead. */
9725 if (NILP (current_binding
)
9726 && /* indec.start >= t && fkey.start >= t && */ keytran
.start
>= t
)
9728 Lisp_Object breakdown
= parse_modifiers (key
);
9730 = CONSP (breakdown
) ? (XINT (XCAR (XCDR (breakdown
)))) : 0;
9732 if (modifiers
& shift_modifier
9733 /* Treat uppercase keys as shifted. */
9735 && (KEY_TO_CHAR (key
)
9736 < XCHAR_TABLE (BVAR (current_buffer
, downcase_table
))->header
.size
)
9737 && uppercasep (KEY_TO_CHAR (key
))))
9740 = (modifiers
& shift_modifier
9741 ? apply_modifiers (modifiers
& ~shift_modifier
,
9743 : make_number (downcase (KEY_TO_CHAR (key
)) | modifiers
));
9745 original_uppercase
= key
;
9746 original_uppercase_position
= t
- 1;
9748 /* We have to do this unconditionally, regardless of whether
9749 the lower-case char is defined in the keymaps, because they
9750 might get translated through function-key-map. */
9751 keybuf
[t
- 1] = new_key
;
9752 mock_input
= max (t
, mock_input
);
9753 /* Reset fkey (and consequently keytran) to apply
9754 function-key-map on the result, so that S-backspace is
9755 correctly mapped to DEL (via backspace). OTOH,
9756 input-decode-map doesn't need to go through it again. */
9757 fkey
.start
= fkey
.end
= 0;
9758 keytran
.start
= keytran
.end
= 0;
9759 shift_translated
= 1;
9761 goto replay_sequence
;
9766 read_key_sequence_cmd
= current_binding
;
9767 read_key_sequence_remapped
9768 /* Remap command through active keymaps.
9769 Do the remapping here, before the unbind_to so it uses the keymaps
9770 of the appropriate buffer. */
9771 = SYMBOLP (read_key_sequence_cmd
)
9772 ? Fcommand_remapping (read_key_sequence_cmd
, Qnil
, Qnil
)
9775 unread_switch_frame
= delayed_switch_frame
;
9776 unbind_to (count
, Qnil
);
9778 /* Don't downcase the last character if the caller says don't.
9779 Don't downcase it if the result is undefined, either. */
9780 if ((dont_downcase_last
|| NILP (current_binding
))
9782 && t
- 1 == original_uppercase_position
)
9784 keybuf
[t
- 1] = original_uppercase
;
9785 shift_translated
= 0;
9788 if (shift_translated
)
9789 Vthis_command_keys_shift_translated
= Qt
;
9791 /* Occasionally we fabricate events, perhaps by expanding something
9792 according to function-key-map, or by adding a prefix symbol to a
9793 mouse click in the scroll bar or modeline. In this cases, return
9794 the entire generated key sequence, even if we hit an unbound
9795 prefix or a definition before the end. This means that you will
9796 be able to push back the event properly, and also means that
9797 read-key-sequence will always return a logical unit.
9800 for (; t
< mock_input
; t
++)
9802 if (echo_keystrokes_p ())
9803 echo_char (keybuf
[t
]);
9804 add_command_key (keybuf
[t
]);
9812 read_key_sequence_vs (Lisp_Object prompt
, Lisp_Object continue_echo
,
9813 Lisp_Object dont_downcase_last
,
9814 Lisp_Object can_return_switch_frame
,
9815 Lisp_Object cmd_loop
, bool allow_string
)
9817 Lisp_Object keybuf
[30];
9819 struct gcpro gcpro1
;
9820 ptrdiff_t count
= SPECPDL_INDEX ();
9823 CHECK_STRING (prompt
);
9826 specbind (Qinput_method_exit_on_first_char
,
9827 (NILP (cmd_loop
) ? Qt
: Qnil
));
9828 specbind (Qinput_method_use_echo_area
,
9829 (NILP (cmd_loop
) ? Qt
: Qnil
));
9831 memset (keybuf
, 0, sizeof keybuf
);
9833 gcpro1
.nvars
= ARRAYELTS (keybuf
);
9835 if (NILP (continue_echo
))
9837 this_command_key_count
= 0;
9838 this_command_key_count_reset
= 0;
9839 this_single_command_key_start
= 0;
9842 #ifdef HAVE_WINDOW_SYSTEM
9843 if (display_hourglass_p
)
9844 cancel_hourglass ();
9847 i
= read_key_sequence (keybuf
, ARRAYELTS (keybuf
),
9848 prompt
, ! NILP (dont_downcase_last
),
9849 ! NILP (can_return_switch_frame
), 0, 0);
9851 #if 0 /* The following is fine for code reading a key sequence and
9852 then proceeding with a lengthy computation, but it's not good
9853 for code reading keys in a loop, like an input method. */
9854 #ifdef HAVE_WINDOW_SYSTEM
9855 if (display_hourglass_p
)
9866 return unbind_to (count
,
9867 ((allow_string
? make_event_array
: Fvector
)
9871 DEFUN ("read-key-sequence", Fread_key_sequence
, Sread_key_sequence
, 1, 5, 0,
9872 doc
: /* Read a sequence of keystrokes and return as a string or vector.
9873 The sequence is sufficient to specify a non-prefix command in the
9874 current local and global maps.
9876 First arg PROMPT is a prompt string. If nil, do not prompt specially.
9877 Second (optional) arg CONTINUE-ECHO, if non-nil, means this key echos
9878 as a continuation of the previous key.
9880 The third (optional) arg DONT-DOWNCASE-LAST, if non-nil, means do not
9881 convert the last event to lower case. (Normally any upper case event
9882 is converted to lower case if the original event is undefined and the lower
9883 case equivalent is defined.) A non-nil value is appropriate for reading
9884 a key sequence to be defined.
9886 A C-g typed while in this function is treated like any other character,
9887 and `quit-flag' is not set.
9889 If the key sequence starts with a mouse click, then the sequence is read
9890 using the keymaps of the buffer of the window clicked in, not the buffer
9891 of the selected window as normal.
9893 `read-key-sequence' drops unbound button-down events, since you normally
9894 only care about the click or drag events which follow them. If a drag
9895 or multi-click event is unbound, but the corresponding click event would
9896 be bound, `read-key-sequence' turns the event into a click event at the
9897 drag's starting position. This means that you don't have to distinguish
9898 between click and drag, double, or triple events unless you want to.
9900 `read-key-sequence' prefixes mouse events on mode lines, the vertical
9901 lines separating windows, and scroll bars with imaginary keys
9902 `mode-line', `vertical-line', and `vertical-scroll-bar'.
9904 Optional fourth argument CAN-RETURN-SWITCH-FRAME non-nil means that this
9905 function will process a switch-frame event if the user switches frames
9906 before typing anything. If the user switches frames in the middle of a
9907 key sequence, or at the start of the sequence but CAN-RETURN-SWITCH-FRAME
9908 is nil, then the event will be put off until after the current key sequence.
9910 `read-key-sequence' checks `function-key-map' for function key
9911 sequences, where they wouldn't conflict with ordinary bindings. See
9912 `function-key-map' for more details.
9914 The optional fifth argument CMD-LOOP, if non-nil, means
9915 that this key sequence is being read by something that will
9916 read commands one after another. It should be nil if the caller
9917 will read just one key sequence. */)
9918 (Lisp_Object prompt
, Lisp_Object continue_echo
, Lisp_Object dont_downcase_last
, Lisp_Object can_return_switch_frame
, Lisp_Object cmd_loop
)
9920 return read_key_sequence_vs (prompt
, continue_echo
, dont_downcase_last
,
9921 can_return_switch_frame
, cmd_loop
, true);
9924 DEFUN ("read-key-sequence-vector", Fread_key_sequence_vector
,
9925 Sread_key_sequence_vector
, 1, 5, 0,
9926 doc
: /* Like `read-key-sequence' but always return a vector. */)
9927 (Lisp_Object prompt
, Lisp_Object continue_echo
, Lisp_Object dont_downcase_last
, Lisp_Object can_return_switch_frame
, Lisp_Object cmd_loop
)
9929 return read_key_sequence_vs (prompt
, continue_echo
, dont_downcase_last
,
9930 can_return_switch_frame
, cmd_loop
, false);
9933 /* Return true if input events are pending. */
9936 detect_input_pending (void)
9938 return input_pending
|| get_input_pending (0);
9941 /* Return true if input events other than mouse movements are
9945 detect_input_pending_ignore_squeezables (void)
9947 return input_pending
|| get_input_pending (READABLE_EVENTS_IGNORE_SQUEEZABLES
);
9950 /* Return true if input events are pending, and run any pending timers. */
9953 detect_input_pending_run_timers (bool do_display
)
9955 unsigned old_timers_run
= timers_run
;
9958 get_input_pending (READABLE_EVENTS_DO_TIMERS_NOW
);
9960 if (old_timers_run
!= timers_run
&& do_display
)
9961 redisplay_preserve_echo_area (8);
9963 return input_pending
;
9966 /* This is called in some cases before a possible quit.
9967 It cases the next call to detect_input_pending to recompute input_pending.
9968 So calling this function unnecessarily can't do any harm. */
9971 clear_input_pending (void)
9976 /* Return true if there are pending requeued events.
9977 This isn't used yet. The hope is to make wait_reading_process_output
9978 call it, and return if it runs Lisp code that unreads something.
9979 The problem is, kbd_buffer_get_event needs to be fixed to know what
9980 to do in that case. It isn't trivial. */
9983 requeued_events_pending_p (void)
9985 return (!NILP (Vunread_command_events
));
9988 DEFUN ("input-pending-p", Finput_pending_p
, Sinput_pending_p
, 0, 1, 0,
9989 doc
: /* Return t if command input is currently available with no wait.
9990 Actually, the value is nil only if we can be sure that no input is available;
9991 if there is a doubt, the value is t.
9993 If CHECK-TIMERS is non-nil, timers that are ready to run will do so. */)
9994 (Lisp_Object check_timers
)
9996 if (!NILP (Vunread_command_events
)
9997 || !NILP (Vunread_post_input_method_events
)
9998 || !NILP (Vunread_input_method_events
))
10001 /* Process non-user-visible events (Bug#10195). */
10002 process_special_events ();
10004 return (get_input_pending ((NILP (check_timers
)
10005 ? 0 : READABLE_EVENTS_DO_TIMERS_NOW
)
10006 | READABLE_EVENTS_FILTER_EVENTS
)
10010 DEFUN ("recent-keys", Frecent_keys
, Srecent_keys
, 0, 1, 0,
10011 doc
: /* Return vector of last few events, not counting those from keyboard macros.
10012 If INCLUDE-CMDS is non-nil, include the commands that were run,
10013 represented as events of the form (nil . COMMAND). */)
10014 (Lisp_Object include_cmds
)
10016 bool cmds
= !NILP (include_cmds
);
10019 || (cmds
&& total_keys
< NUM_RECENT_KEYS
))
10020 return Fvector (total_keys
,
10021 XVECTOR (recent_keys
)->contents
);
10024 Lisp_Object es
= Qnil
;
10025 int i
= (total_keys
< NUM_RECENT_KEYS
10026 ? 0 : recent_keys_index
);
10027 eassert (recent_keys_index
< NUM_RECENT_KEYS
);
10030 Lisp_Object e
= AREF (recent_keys
, i
);
10031 if (cmds
|| !CONSP (e
) || !NILP (XCAR (e
)))
10032 es
= Fcons (e
, es
);
10033 if (++i
>= NUM_RECENT_KEYS
)
10035 } while (i
!= recent_keys_index
);
10036 es
= Fnreverse (es
);
10037 return Fvconcat (1, &es
);
10041 DEFUN ("this-command-keys", Fthis_command_keys
, Sthis_command_keys
, 0, 0, 0,
10042 doc
: /* Return the key sequence that invoked this command.
10043 However, if the command has called `read-key-sequence', it returns
10044 the last key sequence that has been read.
10045 The value is a string or a vector.
10047 See also `this-command-keys-vector'. */)
10050 return make_event_array (this_command_key_count
,
10051 XVECTOR (this_command_keys
)->contents
);
10054 DEFUN ("this-command-keys-vector", Fthis_command_keys_vector
, Sthis_command_keys_vector
, 0, 0, 0,
10055 doc
: /* Return the key sequence that invoked this command, as a vector.
10056 However, if the command has called `read-key-sequence', it returns
10057 the last key sequence that has been read.
10059 See also `this-command-keys'. */)
10062 return Fvector (this_command_key_count
,
10063 XVECTOR (this_command_keys
)->contents
);
10066 DEFUN ("this-single-command-keys", Fthis_single_command_keys
,
10067 Sthis_single_command_keys
, 0, 0, 0,
10068 doc
: /* Return the key sequence that invoked this command.
10069 More generally, it returns the last key sequence read, either by
10070 the command loop or by `read-key-sequence'.
10071 Unlike `this-command-keys', this function's value
10072 does not include prefix arguments.
10073 The value is always a vector. */)
10076 return Fvector (this_command_key_count
10077 - this_single_command_key_start
,
10078 (XVECTOR (this_command_keys
)->contents
10079 + this_single_command_key_start
));
10082 DEFUN ("this-single-command-raw-keys", Fthis_single_command_raw_keys
,
10083 Sthis_single_command_raw_keys
, 0, 0, 0,
10084 doc
: /* Return the raw events that were read for this command.
10085 More generally, it returns the last key sequence read, either by
10086 the command loop or by `read-key-sequence'.
10087 Unlike `this-single-command-keys', this function's value
10088 shows the events before all translations (except for input methods).
10089 The value is always a vector. */)
10092 return Fvector (raw_keybuf_count
, XVECTOR (raw_keybuf
)->contents
);
10095 DEFUN ("reset-this-command-lengths", Freset_this_command_lengths
,
10096 Sreset_this_command_lengths
, 0, 0, 0,
10097 doc
: /* Make the unread events replace the last command and echo.
10098 Used in `universal-argument-other-key'.
10100 `universal-argument-other-key' rereads the event just typed.
10101 It then gets translated through `function-key-map'.
10102 The translated event has to replace the real events,
10103 both in the value of (this-command-keys) and in echoing.
10104 To achieve this, `universal-argument-other-key' calls
10105 `reset-this-command-lengths', which discards the record of reading
10106 these events the first time. */)
10109 this_command_key_count
= before_command_key_count
;
10110 if (this_command_key_count
< this_single_command_key_start
)
10111 this_single_command_key_start
= this_command_key_count
;
10113 echo_truncate (before_command_echo_length
);
10115 /* Cause whatever we put into unread-command-events
10116 to echo as if it were being freshly read from the keyboard. */
10117 this_command_key_count_reset
= 1;
10122 DEFUN ("clear-this-command-keys", Fclear_this_command_keys
,
10123 Sclear_this_command_keys
, 0, 1, 0,
10124 doc
: /* Clear out the vector that `this-command-keys' returns.
10125 Also clear the record of the last 100 events, unless optional arg
10126 KEEP-RECORD is non-nil. */)
10127 (Lisp_Object keep_record
)
10131 this_command_key_count
= 0;
10132 this_command_key_count_reset
= 0;
10134 if (NILP (keep_record
))
10136 for (i
= 0; i
< ASIZE (recent_keys
); ++i
)
10137 ASET (recent_keys
, i
, Qnil
);
10139 recent_keys_index
= 0;
10144 DEFUN ("recursion-depth", Frecursion_depth
, Srecursion_depth
, 0, 0, 0,
10145 doc
: /* Return the current depth in recursive edits. */)
10149 /* Wrap around reliably on integer overflow. */
10150 EMACS_INT sum
= (command_loop_level
& INTMASK
) + (minibuf_level
& INTMASK
);
10151 XSETINT (temp
, sum
);
10155 DEFUN ("open-dribble-file", Fopen_dribble_file
, Sopen_dribble_file
, 1, 1,
10156 "FOpen dribble file: ",
10157 doc
: /* Start writing all keyboard characters to a dribble file called FILE.
10158 If FILE is nil, close any open dribble file.
10159 The file will be closed when Emacs exits.
10161 Be aware that this records ALL characters you type!
10162 This may include sensitive information such as passwords. */)
10175 Lisp_Object encfile
;
10177 file
= Fexpand_file_name (file
, Qnil
);
10178 encfile
= ENCODE_FILE (file
);
10179 fd
= emacs_open (SSDATA (encfile
), O_WRONLY
| O_CREAT
| O_EXCL
, 0600);
10180 if (fd
< 0 && errno
== EEXIST
&& unlink (SSDATA (encfile
)) == 0)
10181 fd
= emacs_open (SSDATA (encfile
), O_WRONLY
| O_CREAT
| O_EXCL
, 0600);
10182 dribble
= fd
< 0 ? 0 : fdopen (fd
, "w");
10184 report_file_error ("Opening dribble", file
);
10189 DEFUN ("discard-input", Fdiscard_input
, Sdiscard_input
, 0, 0, 0,
10190 doc
: /* Discard the contents of the terminal input buffer.
10191 Also end any kbd macro being defined. */)
10194 if (!NILP (KVAR (current_kboard
, defining_kbd_macro
)))
10196 /* Discard the last command from the macro. */
10197 Fcancel_kbd_macro_events ();
10201 Vunread_command_events
= Qnil
;
10203 discard_tty_input ();
10205 kbd_fetch_ptr
= kbd_store_ptr
;
10211 DEFUN ("suspend-emacs", Fsuspend_emacs
, Ssuspend_emacs
, 0, 1, "",
10212 doc
: /* Stop Emacs and return to superior process. You can resume later.
10213 If `cannot-suspend' is non-nil, or if the system doesn't support job
10214 control, run a subshell instead.
10216 If optional arg STUFFSTRING is non-nil, its characters are stuffed
10217 to be read as terminal input by Emacs's parent, after suspension.
10219 Before suspending, run the normal hook `suspend-hook'.
10220 After resumption run the normal hook `suspend-resume-hook'.
10222 Some operating systems cannot stop the Emacs process and resume it later.
10223 On such systems, Emacs starts a subshell instead of suspending. */)
10224 (Lisp_Object stuffstring
)
10226 ptrdiff_t count
= SPECPDL_INDEX ();
10227 int old_height
, old_width
;
10229 struct gcpro gcpro1
;
10231 if (tty_list
&& tty_list
->next
)
10232 error ("There are other tty frames open; close them before suspending Emacs");
10234 if (!NILP (stuffstring
))
10235 CHECK_STRING (stuffstring
);
10237 run_hook (intern ("suspend-hook"));
10239 GCPRO1 (stuffstring
);
10240 get_tty_size (fileno (CURTTY ()->input
), &old_width
, &old_height
);
10241 reset_all_sys_modes ();
10242 /* sys_suspend can get an error if it tries to fork a subshell
10243 and the system resources aren't available for that. */
10244 record_unwind_protect_void (init_all_sys_modes
);
10245 stuff_buffered_input (stuffstring
);
10246 if (cannot_suspend
)
10250 unbind_to (count
, Qnil
);
10252 /* Check if terminal/window size has changed.
10253 Note that this is not useful when we are running directly
10254 with a window system; but suspend should be disabled in that case. */
10255 get_tty_size (fileno (CURTTY ()->input
), &width
, &height
);
10256 if (width
!= old_width
|| height
!= old_height
)
10257 change_frame_size (SELECTED_FRAME (), width
,
10258 height
- FRAME_MENU_BAR_LINES (SELECTED_FRAME ()),
10261 run_hook (intern ("suspend-resume-hook"));
10267 /* If STUFFSTRING is a string, stuff its contents as pending terminal input.
10268 Then in any case stuff anything Emacs has read ahead and not used. */
10271 stuff_buffered_input (Lisp_Object stuffstring
)
10273 #ifdef SIGTSTP /* stuff_char is defined if SIGTSTP. */
10274 register unsigned char *p
;
10276 if (STRINGP (stuffstring
))
10278 register ptrdiff_t count
;
10280 p
= SDATA (stuffstring
);
10281 count
= SBYTES (stuffstring
);
10282 while (count
-- > 0)
10287 /* Anything we have read ahead, put back for the shell to read. */
10288 /* ?? What should this do when we have multiple keyboards??
10289 Should we ignore anything that was typed in at the "wrong" kboard?
10291 rms: we should stuff everything back into the kboard
10293 for (; kbd_fetch_ptr
!= kbd_store_ptr
; kbd_fetch_ptr
++)
10296 if (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
10297 kbd_fetch_ptr
= kbd_buffer
;
10298 if (kbd_fetch_ptr
->kind
== ASCII_KEYSTROKE_EVENT
)
10299 stuff_char (kbd_fetch_ptr
->code
);
10301 clear_event (kbd_fetch_ptr
);
10305 #endif /* SIGTSTP */
10309 set_waiting_for_input (struct timespec
*time_to_clear
)
10311 input_available_clear_time
= time_to_clear
;
10313 /* Tell handle_interrupt to throw back to read_char, */
10314 waiting_for_input
= 1;
10316 /* If handle_interrupt was called before and buffered a C-g,
10317 make it run again now, to avoid timing error. */
10318 if (!NILP (Vquit_flag
))
10319 quit_throw_to_read_char (0);
10323 clear_waiting_for_input (void)
10325 /* Tell handle_interrupt not to throw back to read_char, */
10326 waiting_for_input
= 0;
10327 input_available_clear_time
= 0;
10330 /* The SIGINT handler.
10332 If we have a frame on the controlling tty, we assume that the
10333 SIGINT was generated by C-g, so we call handle_interrupt.
10334 Otherwise, tell QUIT to kill Emacs. */
10337 handle_interrupt_signal (int sig
)
10339 /* See if we have an active terminal on our controlling tty. */
10340 struct terminal
*terminal
= get_named_terminal ("/dev/tty");
10343 /* If there are no frames there, let's pretend that we are a
10344 well-behaving UN*X program and quit. We must not call Lisp
10345 in a signal handler, so tell QUIT to exit when it is
10347 Vquit_flag
= Qkill_emacs
;
10351 /* Otherwise, the SIGINT was probably generated by C-g. */
10353 /* Set internal_last_event_frame to the top frame of the
10354 controlling tty, if we have a frame there. We disable the
10355 interrupt key on secondary ttys, so the SIGINT must have come
10356 from the controlling tty. */
10357 internal_last_event_frame
= terminal
->display_info
.tty
->top_frame
;
10359 handle_interrupt (1);
10364 deliver_interrupt_signal (int sig
)
10366 deliver_process_signal (sig
, handle_interrupt_signal
);
10370 /* If Emacs is stuck because `inhibit-quit' is true, then keep track
10371 of the number of times C-g has been requested. If C-g is pressed
10372 enough times, then quit anyway. See bug#6585. */
10373 static int volatile force_quit_count
;
10375 /* This routine is called at interrupt level in response to C-g.
10377 It is called from the SIGINT handler or kbd_buffer_store_event.
10379 If `waiting_for_input' is non zero, then unless `echoing' is
10380 nonzero, immediately throw back to read_char.
10382 Otherwise it sets the Lisp variable quit-flag not-nil. This causes
10383 eval to throw, when it gets a chance. If quit-flag is already
10384 non-nil, it stops the job right away. */
10387 handle_interrupt (bool in_signal_handler
)
10393 /* XXX This code needs to be revised for multi-tty support. */
10394 if (!NILP (Vquit_flag
) && get_named_terminal ("/dev/tty"))
10396 if (! in_signal_handler
)
10398 /* If SIGINT isn't blocked, don't let us be interrupted by
10399 a SIGINT. It might be harmful due to non-reentrancy
10400 in I/O functions. */
10402 sigemptyset (&blocked
);
10403 sigaddset (&blocked
, SIGINT
);
10404 pthread_sigmask (SIG_BLOCK
, &blocked
, 0);
10408 reset_all_sys_modes ();
10412 * On systems which can suspend the current process and return to the original
10413 * shell, this command causes the user to end up back at the shell.
10414 * The "Auto-save" and "Abort" questions are not asked until
10415 * the user elects to return to emacs, at which point he can save the current
10416 * job and either dump core or continue.
10420 /* Perhaps should really fork an inferior shell?
10421 But that would not provide any way to get back
10422 to the original shell, ever. */
10423 printf ("No support for stopping a process on this operating system;\n");
10424 printf ("you can continue or abort.\n");
10425 #endif /* not SIGTSTP */
10427 /* We must remain inside the screen area when the internal terminal
10428 is used. Note that [Enter] is not echoed by dos. */
10429 cursor_to (SELECTED_FRAME (), 0, 0);
10431 /* It doesn't work to autosave while GC is in progress;
10432 the code used for auto-saving doesn't cope with the mark bit. */
10433 if (!gc_in_progress
)
10435 printf ("Auto-save? (y or n) ");
10437 if (((c
= getchar ()) & ~040) == 'Y')
10439 Fdo_auto_save (Qt
, Qnil
);
10441 printf ("\r\nAuto-save done");
10442 #else /* not MSDOS */
10443 printf ("Auto-save done\n");
10444 #endif /* not MSDOS */
10446 while (c
!= '\n') c
= getchar ();
10450 /* During GC, it must be safe to reenable quitting again. */
10451 Vinhibit_quit
= Qnil
;
10454 #endif /* not MSDOS */
10455 printf ("Garbage collection in progress; cannot auto-save now\r\n");
10456 printf ("but will instead do a real quit after garbage collection ends\r\n");
10461 printf ("\r\nAbort? (y or n) ");
10462 #else /* not MSDOS */
10463 printf ("Abort (and dump core)? (y or n) ");
10464 #endif /* not MSDOS */
10466 if (((c
= getchar ()) & ~040) == 'Y')
10468 while (c
!= '\n') c
= getchar ();
10470 printf ("\r\nContinuing...\r\n");
10471 #else /* not MSDOS */
10472 printf ("Continuing...\n");
10473 #endif /* not MSDOS */
10475 init_all_sys_modes ();
10479 /* If executing a function that wants to be interrupted out of
10480 and the user has not deferred quitting by binding `inhibit-quit'
10481 then quit right away. */
10482 if (immediate_quit
&& NILP (Vinhibit_quit
))
10484 struct gl_state_s saved
;
10485 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
10487 immediate_quit
= 0;
10488 pthread_sigmask (SIG_SETMASK
, &empty_mask
, 0);
10490 GCPRO4 (saved
.object
, saved
.global_code
,
10491 saved
.current_syntax_table
, saved
.old_prop
);
10492 Fsignal (Qquit
, Qnil
);
10497 { /* Else request quit when it's safe. */
10498 int count
= NILP (Vquit_flag
) ? 1 : force_quit_count
+ 1;
10499 force_quit_count
= count
;
10502 immediate_quit
= 1;
10503 Vinhibit_quit
= Qnil
;
10509 pthread_sigmask (SIG_SETMASK
, &empty_mask
, 0);
10511 /* TODO: The longjmp in this call throws the NS event loop integration off,
10512 and it seems to do fine without this. Probably some attention
10513 needs to be paid to the setting of waiting_for_input in
10514 wait_reading_process_output() under HAVE_NS because of the call
10515 to ns_select there (needed because otherwise events aren't picked up
10516 outside of polling since we don't get SIGIO like X and we don't have a
10517 separate event loop thread like W32. */
10519 if (waiting_for_input
&& !echoing
)
10520 quit_throw_to_read_char (in_signal_handler
);
10524 /* Handle a C-g by making read_char return C-g. */
10527 quit_throw_to_read_char (bool from_signal
)
10529 /* When not called from a signal handler it is safe to call
10531 if (!from_signal
&& EQ (Vquit_flag
, Qkill_emacs
))
10532 Fkill_emacs (Qnil
);
10534 /* Prevent another signal from doing this before we finish. */
10535 clear_waiting_for_input ();
10538 Vunread_command_events
= Qnil
;
10540 if (FRAMEP (internal_last_event_frame
)
10541 && !EQ (internal_last_event_frame
, selected_frame
))
10542 do_switch_frame (make_lispy_switch_frame (internal_last_event_frame
),
10545 sys_longjmp (getcjmp
, 1);
10548 DEFUN ("set-input-interrupt-mode", Fset_input_interrupt_mode
,
10549 Sset_input_interrupt_mode
, 1, 1, 0,
10550 doc
: /* Set interrupt mode of reading keyboard input.
10551 If INTERRUPT is non-nil, Emacs will use input interrupts;
10552 otherwise Emacs uses CBREAK mode.
10554 See also `current-input-mode'. */)
10555 (Lisp_Object interrupt
)
10557 bool new_interrupt_input
;
10558 #ifdef USABLE_SIGIO
10559 #ifdef HAVE_X_WINDOWS
10560 if (x_display_list
!= NULL
)
10562 /* When using X, don't give the user a real choice,
10563 because we haven't implemented the mechanisms to support it. */
10564 new_interrupt_input
= 1;
10567 #endif /* HAVE_X_WINDOWS */
10568 new_interrupt_input
= !NILP (interrupt
);
10569 #else /* not USABLE_SIGIO */
10570 new_interrupt_input
= 0;
10571 #endif /* not USABLE_SIGIO */
10573 if (new_interrupt_input
!= interrupt_input
)
10575 #ifdef POLL_FOR_INPUT
10579 /* this causes startup screen to be restored and messes with the mouse */
10580 reset_all_sys_modes ();
10581 interrupt_input
= new_interrupt_input
;
10582 init_all_sys_modes ();
10584 interrupt_input
= new_interrupt_input
;
10587 #ifdef POLL_FOR_INPUT
10588 poll_suppress_count
= 1;
10595 DEFUN ("set-output-flow-control", Fset_output_flow_control
, Sset_output_flow_control
, 1, 2, 0,
10596 doc
: /* Enable or disable ^S/^Q flow control for output to TERMINAL.
10597 If FLOW is non-nil, flow control is enabled and you cannot use C-s or
10598 C-q in key sequences.
10600 This setting only has an effect on tty terminals and only when
10601 Emacs reads input in CBREAK mode; see `set-input-interrupt-mode'.
10603 See also `current-input-mode'. */)
10604 (Lisp_Object flow
, Lisp_Object terminal
)
10606 struct terminal
*t
= decode_tty_terminal (terminal
);
10607 struct tty_display_info
*tty
;
10611 tty
= t
->display_info
.tty
;
10613 if (tty
->flow_control
!= !NILP (flow
))
10616 /* This causes startup screen to be restored and messes with the mouse. */
10617 reset_sys_modes (tty
);
10620 tty
->flow_control
= !NILP (flow
);
10623 init_sys_modes (tty
);
10629 DEFUN ("set-input-meta-mode", Fset_input_meta_mode
, Sset_input_meta_mode
, 1, 2, 0,
10630 doc
: /* Enable or disable 8-bit input on TERMINAL.
10631 If META is t, Emacs will accept 8-bit input, and interpret the 8th
10632 bit as the Meta modifier.
10634 If META is nil, Emacs will ignore the top bit, on the assumption it is
10637 Otherwise, Emacs will accept and pass through 8-bit input without
10638 specially interpreting the top bit.
10640 This setting only has an effect on tty terminal devices.
10642 Optional parameter TERMINAL specifies the tty terminal device to use.
10643 It may be a terminal object, a frame, or nil for the terminal used by
10644 the currently selected frame.
10646 See also `current-input-mode'. */)
10647 (Lisp_Object meta
, Lisp_Object terminal
)
10649 struct terminal
*t
= decode_tty_terminal (terminal
);
10650 struct tty_display_info
*tty
;
10655 tty
= t
->display_info
.tty
;
10659 else if (EQ (meta
, Qt
))
10664 if (tty
->meta_key
!= new_meta
)
10667 /* this causes startup screen to be restored and messes with the mouse */
10668 reset_sys_modes (tty
);
10671 tty
->meta_key
= new_meta
;
10674 init_sys_modes (tty
);
10680 DEFUN ("set-quit-char", Fset_quit_char
, Sset_quit_char
, 1, 1, 0,
10681 doc
: /* Specify character used for quitting.
10682 QUIT must be an ASCII character.
10684 This function only has an effect on the controlling tty of the Emacs
10687 See also `current-input-mode'. */)
10690 struct terminal
*t
= get_named_terminal ("/dev/tty");
10691 struct tty_display_info
*tty
;
10695 tty
= t
->display_info
.tty
;
10697 if (NILP (quit
) || !INTEGERP (quit
) || XINT (quit
) < 0 || XINT (quit
) > 0400)
10698 error ("QUIT must be an ASCII character");
10701 /* this causes startup screen to be restored and messes with the mouse */
10702 reset_sys_modes (tty
);
10705 /* Don't let this value be out of range. */
10706 quit_char
= XINT (quit
) & (tty
->meta_key
== 0 ? 0177 : 0377);
10709 init_sys_modes (tty
);
10715 DEFUN ("set-input-mode", Fset_input_mode
, Sset_input_mode
, 3, 4, 0,
10716 doc
: /* Set mode of reading keyboard input.
10717 First arg INTERRUPT non-nil means use input interrupts;
10718 nil means use CBREAK mode.
10719 Second arg FLOW non-nil means use ^S/^Q flow control for output to terminal
10720 (no effect except in CBREAK mode).
10721 Third arg META t means accept 8-bit input (for a Meta key).
10722 META nil means ignore the top bit, on the assumption it is parity.
10723 Otherwise, accept 8-bit input and don't use the top bit for Meta.
10724 Optional fourth arg QUIT if non-nil specifies character to use for quitting.
10725 See also `current-input-mode'. */)
10726 (Lisp_Object interrupt
, Lisp_Object flow
, Lisp_Object meta
, Lisp_Object quit
)
10728 Fset_input_interrupt_mode (interrupt
);
10729 Fset_output_flow_control (flow
, Qnil
);
10730 Fset_input_meta_mode (meta
, Qnil
);
10732 Fset_quit_char (quit
);
10736 DEFUN ("current-input-mode", Fcurrent_input_mode
, Scurrent_input_mode
, 0, 0, 0,
10737 doc
: /* Return information about the way Emacs currently reads keyboard input.
10738 The value is a list of the form (INTERRUPT FLOW META QUIT), where
10739 INTERRUPT is non-nil if Emacs is using interrupt-driven input; if
10740 nil, Emacs is using CBREAK mode.
10741 FLOW is non-nil if Emacs uses ^S/^Q flow control for output to the
10742 terminal; this does not apply if Emacs uses interrupt-driven input.
10743 META is t if accepting 8-bit input with 8th bit as Meta flag.
10744 META nil means ignoring the top bit, on the assumption it is parity.
10745 META is neither t nor nil if accepting 8-bit input and using
10746 all 8 bits as the character code.
10747 QUIT is the character Emacs currently uses to quit.
10748 The elements of this list correspond to the arguments of
10749 `set-input-mode'. */)
10752 struct frame
*sf
= XFRAME (selected_frame
);
10754 Lisp_Object interrupt
= interrupt_input
? Qt
: Qnil
;
10755 Lisp_Object flow
, meta
;
10756 if (FRAME_TERMCAP_P (sf
) || FRAME_MSDOS_P (sf
))
10758 flow
= FRAME_TTY (sf
)->flow_control
? Qt
: Qnil
;
10759 meta
= (FRAME_TTY (sf
)->meta_key
== 2
10761 : (CURTTY ()->meta_key
== 1 ? Qt
: Qnil
));
10768 Lisp_Object quit
= make_number (quit_char
);
10770 return list4 (interrupt
, flow
, meta
, quit
);
10773 DEFUN ("posn-at-x-y", Fposn_at_x_y
, Sposn_at_x_y
, 2, 4, 0,
10774 doc
: /* Return position information for pixel coordinates X and Y.
10775 By default, X and Y are relative to text area of the selected window.
10776 Optional third arg FRAME-OR-WINDOW non-nil specifies frame or window.
10777 If optional fourth arg WHOLE is non-nil, X is relative to the left
10778 edge of the window.
10780 The return value is similar to a mouse click position:
10781 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
10782 IMAGE (DX . DY) (WIDTH . HEIGHT))
10783 The `posn-' functions access elements of such lists. */)
10784 (Lisp_Object x
, Lisp_Object y
, Lisp_Object frame_or_window
, Lisp_Object whole
)
10789 if (NILP (frame_or_window
))
10790 frame_or_window
= selected_window
;
10792 if (WINDOWP (frame_or_window
))
10794 struct window
*w
= decode_live_window (frame_or_window
);
10796 XSETINT (x
, (XINT (x
)
10797 + WINDOW_LEFT_EDGE_X (w
)
10799 ? window_box_left_offset (w
, TEXT_AREA
)
10801 XSETINT (y
, WINDOW_TO_FRAME_PIXEL_Y (w
, XINT (y
)));
10802 frame_or_window
= w
->frame
;
10805 CHECK_LIVE_FRAME (frame_or_window
);
10807 return make_lispy_position (XFRAME (frame_or_window
), x
, y
, 0);
10810 DEFUN ("posn-at-point", Fposn_at_point
, Sposn_at_point
, 0, 2, 0,
10811 doc
: /* Return position information for buffer POS in WINDOW.
10812 POS defaults to point in WINDOW; WINDOW defaults to the selected window.
10814 Return nil if position is not visible in window. Otherwise,
10815 the return value is similar to that returned by `event-start' for
10816 a mouse click at the upper left corner of the glyph corresponding
10817 to the given buffer position:
10818 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
10819 IMAGE (DX . DY) (WIDTH . HEIGHT))
10820 The `posn-' functions access elements of such lists. */)
10821 (Lisp_Object pos
, Lisp_Object window
)
10826 window
= selected_window
;
10828 tem
= Fpos_visible_in_window_p (pos
, window
, Qt
);
10831 Lisp_Object x
= XCAR (tem
);
10832 Lisp_Object y
= XCAR (XCDR (tem
));
10834 /* Point invisible due to hscrolling? */
10837 tem
= Fposn_at_x_y (x
, y
, window
, Qnil
);
10843 /* Set up a new kboard object with reasonable initial values.
10844 TYPE is a window system for which this keyboard is used. */
10847 init_kboard (KBOARD
*kb
, Lisp_Object type
)
10849 kset_overriding_terminal_local_map (kb
, Qnil
);
10850 kset_last_command (kb
, Qnil
);
10851 kset_real_last_command (kb
, Qnil
);
10852 kset_keyboard_translate_table (kb
, Qnil
);
10853 kset_last_repeatable_command (kb
, Qnil
);
10854 kset_prefix_arg (kb
, Qnil
);
10855 kset_last_prefix_arg (kb
, Qnil
);
10856 kset_kbd_queue (kb
, Qnil
);
10857 kb
->kbd_queue_has_data
= 0;
10858 kb
->immediate_echo
= 0;
10859 kset_echo_string (kb
, Qnil
);
10860 kb
->echo_after_prompt
= -1;
10861 kb
->kbd_macro_buffer
= 0;
10862 kb
->kbd_macro_bufsize
= 0;
10863 kset_defining_kbd_macro (kb
, Qnil
);
10864 kset_last_kbd_macro (kb
, Qnil
);
10865 kb
->reference_count
= 0;
10866 kset_system_key_alist (kb
, Qnil
);
10867 kset_system_key_syms (kb
, Qnil
);
10868 kset_window_system (kb
, type
);
10869 kset_input_decode_map (kb
, Fmake_sparse_keymap (Qnil
));
10870 kset_local_function_key_map (kb
, Fmake_sparse_keymap (Qnil
));
10871 Fset_keymap_parent (KVAR (kb
, Vlocal_function_key_map
), Vfunction_key_map
);
10872 kset_default_minibuffer_frame (kb
, Qnil
);
10875 /* Allocate and basically initialize keyboard
10876 object to use with window system TYPE. */
10879 allocate_kboard (Lisp_Object type
)
10881 KBOARD
*kb
= xmalloc (sizeof *kb
);
10883 init_kboard (kb
, type
);
10884 kb
->next_kboard
= all_kboards
;
10890 * Destroy the contents of a kboard object, but not the object itself.
10891 * We use this just before deleting it, or if we're going to initialize
10892 * it a second time.
10895 wipe_kboard (KBOARD
*kb
)
10897 xfree (kb
->kbd_macro_buffer
);
10900 /* Free KB and memory referenced from it. */
10903 delete_kboard (KBOARD
*kb
)
10907 for (kbp
= &all_kboards
; *kbp
!= kb
; kbp
= &(*kbp
)->next_kboard
)
10910 *kbp
= kb
->next_kboard
;
10912 /* Prevent a dangling reference to KB. */
10913 if (kb
== current_kboard
10914 && FRAMEP (selected_frame
)
10915 && FRAME_LIVE_P (XFRAME (selected_frame
)))
10917 current_kboard
= FRAME_KBOARD (XFRAME (selected_frame
));
10919 if (current_kboard
== kb
)
10928 init_keyboard (void)
10930 /* This is correct before outermost invocation of the editor loop. */
10931 command_loop_level
= -1;
10932 immediate_quit
= 0;
10933 quit_char
= Ctl ('g');
10934 Vunread_command_events
= Qnil
;
10935 timer_idleness_start_time
= invalid_timespec ();
10937 recent_keys_index
= 0;
10938 kbd_fetch_ptr
= kbd_buffer
;
10939 kbd_store_ptr
= kbd_buffer
;
10940 do_mouse_tracking
= Qnil
;
10942 interrupt_input_blocked
= 0;
10943 pending_signals
= 0;
10945 /* This means that command_loop_1 won't try to select anything the first
10947 internal_last_event_frame
= Qnil
;
10948 Vlast_event_frame
= internal_last_event_frame
;
10950 current_kboard
= initial_kboard
;
10951 /* Re-initialize the keyboard again. */
10952 wipe_kboard (current_kboard
);
10953 /* A value of nil for Vwindow_system normally means a tty, but we also use
10954 it for the initial terminal since there is no window system there. */
10955 init_kboard (current_kboard
, Qnil
);
10957 if (!noninteractive
)
10959 /* Before multi-tty support, these handlers used to be installed
10960 only if the current session was a tty session. Now an Emacs
10961 session may have multiple display types, so we always handle
10962 SIGINT. There is special code in handle_interrupt_signal to exit
10963 Emacs on SIGINT when there are no termcap frames on the
10964 controlling terminal. */
10965 struct sigaction action
;
10966 emacs_sigaction_init (&action
, deliver_interrupt_signal
);
10967 sigaction (SIGINT
, &action
, 0);
10969 /* For systems with SysV TERMIO, C-g is set up for both SIGINT and
10970 SIGQUIT and we can't tell which one it will give us. */
10971 sigaction (SIGQUIT
, &action
, 0);
10972 #endif /* not DOS_NT */
10974 #ifdef USABLE_SIGIO
10975 if (!noninteractive
)
10977 struct sigaction action
;
10978 emacs_sigaction_init (&action
, deliver_input_available_signal
);
10979 sigaction (SIGIO
, &action
, 0);
10983 /* Use interrupt input by default, if it works and noninterrupt input
10984 has deficiencies. */
10986 #ifdef INTERRUPT_INPUT
10987 interrupt_input
= 1;
10989 interrupt_input
= 0;
10992 pthread_sigmask (SIG_SETMASK
, &empty_mask
, 0);
10995 if (keyboard_init_hook
)
10996 (*keyboard_init_hook
) ();
10998 #ifdef POLL_FOR_INPUT
11000 poll_suppress_count
= 1;
11005 /* This type's only use is in syms_of_keyboard, to put properties on the
11006 event header symbols. */
11013 static const struct event_head head_table
[] = {
11014 {SYMBOL_INDEX (Qmouse_movement
), SYMBOL_INDEX (Qmouse_movement
)},
11015 {SYMBOL_INDEX (Qscroll_bar_movement
), SYMBOL_INDEX (Qmouse_movement
)},
11017 /* Some of the event heads. */
11018 {SYMBOL_INDEX (Qswitch_frame
), SYMBOL_INDEX (Qswitch_frame
)},
11020 {SYMBOL_INDEX (Qfocus_in
), SYMBOL_INDEX (Qfocus_in
)},
11021 {SYMBOL_INDEX (Qfocus_out
), SYMBOL_INDEX (Qfocus_out
)},
11022 {SYMBOL_INDEX (Qdelete_frame
), SYMBOL_INDEX (Qdelete_frame
)},
11023 {SYMBOL_INDEX (Qiconify_frame
), SYMBOL_INDEX (Qiconify_frame
)},
11024 {SYMBOL_INDEX (Qmake_frame_visible
), SYMBOL_INDEX (Qmake_frame_visible
)},
11025 /* `select-window' should be handled just like `switch-frame'
11026 in read_key_sequence. */
11027 {SYMBOL_INDEX (Qselect_window
), SYMBOL_INDEX (Qswitch_frame
)}
11031 syms_of_keyboard (void)
11033 pending_funcalls
= Qnil
;
11034 staticpro (&pending_funcalls
);
11036 Vlispy_mouse_stem
= build_pure_c_string ("mouse");
11037 staticpro (&Vlispy_mouse_stem
);
11039 regular_top_level_message
= build_pure_c_string ("Back to top level");
11040 #ifdef HAVE_STACK_OVERFLOW_HANDLING
11041 recover_top_level_message
11042 = build_pure_c_string ("Re-entering top level after C stack overflow");
11044 DEFVAR_LISP ("internal--top-level-message", Vinternal__top_level_message
,
11045 doc
: /* Message displayed by `normal-top-level'. */);
11046 Vinternal__top_level_message
= regular_top_level_message
;
11049 DEFSYM (QCimage
, ":image");
11050 DEFSYM (Qhelp_echo
, "help-echo");
11051 DEFSYM (QCrtl
, ":rtl");
11053 staticpro (&item_properties
);
11054 item_properties
= Qnil
;
11056 staticpro (&tool_bar_item_properties
);
11057 tool_bar_item_properties
= Qnil
;
11058 staticpro (&tool_bar_items_vector
);
11059 tool_bar_items_vector
= Qnil
;
11061 DEFSYM (Qtimer_event_handler
, "timer-event-handler");
11062 DEFSYM (Qdisabled_command_function
, "disabled-command-function");
11063 DEFSYM (Qself_insert_command
, "self-insert-command");
11064 DEFSYM (Qforward_char
, "forward-char");
11065 DEFSYM (Qbackward_char
, "backward-char");
11067 /* Non-nil disable property on a command means do not execute it;
11068 call disabled-command-function's value instead. */
11069 DEFSYM (Qdisabled
, "disabled");
11071 DEFSYM (Qundefined
, "undefined");
11073 /* Hooks to run before and after each command. */
11074 DEFSYM (Qpre_command_hook
, "pre-command-hook");
11075 DEFSYM (Qpost_command_hook
, "post-command-hook");
11077 DEFSYM (Qdeferred_action_function
, "deferred-action-function");
11078 DEFSYM (Qdelayed_warnings_hook
, "delayed-warnings-hook");
11079 DEFSYM (Qfunction_key
, "function-key");
11081 /* The values of Qevent_kind properties. */
11082 DEFSYM (Qmouse_click
, "mouse-click");
11084 DEFSYM (Qdrag_n_drop
, "drag-n-drop");
11085 DEFSYM (Qsave_session
, "save-session");
11086 DEFSYM (Qconfig_changed_event
, "config-changed-event");
11088 /* Menu and tool bar item parts. */
11089 DEFSYM (Qmenu_enable
, "menu-enable");
11092 DEFSYM (Qlanguage_change
, "language-change");
11096 DEFSYM (Qdbus_event
, "dbus-event");
11099 #ifdef HAVE_XWIDGETS
11100 DEFSYM (Qxwidget_event
,"xwidget-event");
11101 #endif /* HAVE_XWIDGETS */
11102 #ifdef USE_FILE_NOTIFY
11103 DEFSYM (Qfile_notify
, "file-notify");
11104 #endif /* USE_FILE_NOTIFY */
11106 /* Menu and tool bar item parts. */
11107 DEFSYM (QCenable
, ":enable");
11108 DEFSYM (QCvisible
, ":visible");
11109 DEFSYM (QChelp
, ":help");
11110 DEFSYM (QCfilter
, ":filter");
11111 DEFSYM (QCbutton
, ":button");
11112 DEFSYM (QCkeys
, ":keys");
11113 DEFSYM (QCkey_sequence
, ":key-sequence");
11115 /* Non-nil disable property on a command means
11116 do not execute it; call disabled-command-function's value instead. */
11117 DEFSYM (QCtoggle
, ":toggle");
11118 DEFSYM (QCradio
, ":radio");
11119 DEFSYM (QClabel
, ":label");
11120 DEFSYM (QCvert_only
, ":vert-only");
11122 /* Symbols to use for parts of windows. */
11123 DEFSYM (Qvertical_line
, "vertical-line");
11124 DEFSYM (Qright_divider
, "right-divider");
11125 DEFSYM (Qbottom_divider
, "bottom-divider");
11127 DEFSYM (Qmouse_fixup_help_message
, "mouse-fixup-help-message");
11129 DEFSYM (Qabove_handle
, "above-handle");
11130 DEFSYM (Qhandle
, "handle");
11131 DEFSYM (Qbelow_handle
, "below-handle");
11132 DEFSYM (Qup
, "up");
11133 DEFSYM (Qdown
, "down");
11134 DEFSYM (Qtop
, "top");
11135 DEFSYM (Qbottom
, "bottom");
11136 DEFSYM (Qend_scroll
, "end-scroll");
11137 DEFSYM (Qratio
, "ratio");
11138 DEFSYM (Qbefore_handle
, "before-handle");
11139 DEFSYM (Qhorizontal_handle
, "horizontal-handle");
11140 DEFSYM (Qafter_handle
, "after-handle");
11141 DEFSYM (Qleft
, "left");
11142 DEFSYM (Qright
, "right");
11143 DEFSYM (Qleftmost
, "leftmost");
11144 DEFSYM (Qrightmost
, "rightmost");
11146 /* Properties of event headers. */
11147 DEFSYM (Qevent_kind
, "event-kind");
11148 DEFSYM (Qevent_symbol_elements
, "event-symbol-elements");
11150 /* An event header symbol HEAD may have a property named
11151 Qevent_symbol_element_mask, which is of the form (BASE MODIFIERS);
11152 BASE is the base, unmodified version of HEAD, and MODIFIERS is the
11153 mask of modifiers applied to it. If present, this is used to help
11154 speed up parse_modifiers. */
11155 DEFSYM (Qevent_symbol_element_mask
, "event-symbol-element-mask");
11157 /* An unmodified event header BASE may have a property named
11158 Qmodifier_cache, which is an alist mapping modifier masks onto
11159 modified versions of BASE. If present, this helps speed up
11160 apply_modifiers. */
11161 DEFSYM (Qmodifier_cache
, "modifier-cache");
11163 DEFSYM (Qrecompute_lucid_menubar
, "recompute-lucid-menubar");
11164 DEFSYM (Qactivate_menubar_hook
, "activate-menubar-hook");
11166 DEFSYM (Qpolling_period
, "polling-period");
11168 DEFSYM (Qgui_set_selection
, "gui-set-selection");
11170 /* The primary selection. */
11171 DEFSYM (QPRIMARY
, "PRIMARY");
11173 DEFSYM (Qhandle_switch_frame
, "handle-switch-frame");
11174 DEFSYM (Qhandle_select_window
, "handle-select-window");
11176 DEFSYM (Qinput_method_function
, "input-method-function");
11177 DEFSYM (Qinput_method_exit_on_first_char
, "input-method-exit-on-first-char");
11178 DEFSYM (Qinput_method_use_echo_area
, "input-method-use-echo-area");
11180 DEFSYM (Qhelp_form_show
, "help-form-show");
11182 DEFSYM (Qecho_keystrokes
, "echo-keystrokes");
11184 Fset (Qinput_method_exit_on_first_char
, Qnil
);
11185 Fset (Qinput_method_use_echo_area
, Qnil
);
11187 /* Symbols to head events. */
11188 DEFSYM (Qmouse_movement
, "mouse-movement");
11189 DEFSYM (Qscroll_bar_movement
, "scroll-bar-movement");
11190 DEFSYM (Qswitch_frame
, "switch-frame");
11191 DEFSYM (Qfocus_in
, "focus-in");
11192 DEFSYM (Qfocus_out
, "focus-out");
11193 DEFSYM (Qdelete_frame
, "delete-frame");
11194 DEFSYM (Qiconify_frame
, "iconify-frame");
11195 DEFSYM (Qmake_frame_visible
, "make-frame-visible");
11196 DEFSYM (Qselect_window
, "select-window");
11200 for (i
= 0; i
< ARRAYELTS (head_table
); i
++)
11202 const struct event_head
*p
= &head_table
[i
];
11203 Lisp_Object var
= builtin_lisp_symbol (p
->var
);
11204 Lisp_Object kind
= builtin_lisp_symbol (p
->kind
);
11205 Fput (var
, Qevent_kind
, kind
);
11206 Fput (var
, Qevent_symbol_elements
, list1 (var
));
11210 button_down_location
= Fmake_vector (make_number (5), Qnil
);
11211 staticpro (&button_down_location
);
11212 mouse_syms
= Fmake_vector (make_number (5), Qnil
);
11213 staticpro (&mouse_syms
);
11214 wheel_syms
= Fmake_vector (make_number (ARRAYELTS (lispy_wheel_names
)),
11216 staticpro (&wheel_syms
);
11220 int len
= ARRAYELTS (modifier_names
);
11222 modifier_symbols
= Fmake_vector (make_number (len
), Qnil
);
11223 for (i
= 0; i
< len
; i
++)
11224 if (modifier_names
[i
])
11225 ASET (modifier_symbols
, i
, intern_c_string (modifier_names
[i
]));
11226 staticpro (&modifier_symbols
);
11229 recent_keys
= Fmake_vector (make_number (NUM_RECENT_KEYS
), Qnil
);
11230 staticpro (&recent_keys
);
11232 this_command_keys
= Fmake_vector (make_number (40), Qnil
);
11233 staticpro (&this_command_keys
);
11235 raw_keybuf
= Fmake_vector (make_number (30), Qnil
);
11236 staticpro (&raw_keybuf
);
11238 DEFSYM (Qcommand_execute
, "command-execute");
11240 accent_key_syms
= Qnil
;
11241 staticpro (&accent_key_syms
);
11243 func_key_syms
= Qnil
;
11244 staticpro (&func_key_syms
);
11246 drag_n_drop_syms
= Qnil
;
11247 staticpro (&drag_n_drop_syms
);
11249 unread_switch_frame
= Qnil
;
11250 staticpro (&unread_switch_frame
);
11252 internal_last_event_frame
= Qnil
;
11253 staticpro (&internal_last_event_frame
);
11255 read_key_sequence_cmd
= Qnil
;
11256 staticpro (&read_key_sequence_cmd
);
11257 read_key_sequence_remapped
= Qnil
;
11258 staticpro (&read_key_sequence_remapped
);
11260 menu_bar_one_keymap_changed_items
= Qnil
;
11261 staticpro (&menu_bar_one_keymap_changed_items
);
11263 menu_bar_items_vector
= Qnil
;
11264 staticpro (&menu_bar_items_vector
);
11266 help_form_saved_window_configs
= Qnil
;
11267 staticpro (&help_form_saved_window_configs
);
11269 defsubr (&Scurrent_idle_time
);
11270 defsubr (&Sevent_symbol_parse_modifiers
);
11271 defsubr (&Sevent_convert_list
);
11272 defsubr (&Sread_key_sequence
);
11273 defsubr (&Sread_key_sequence_vector
);
11274 defsubr (&Srecursive_edit
);
11275 defsubr (&Strack_mouse
);
11276 defsubr (&Sinput_pending_p
);
11277 defsubr (&Srecent_keys
);
11278 defsubr (&Sthis_command_keys
);
11279 defsubr (&Sthis_command_keys_vector
);
11280 defsubr (&Sthis_single_command_keys
);
11281 defsubr (&Sthis_single_command_raw_keys
);
11282 defsubr (&Sreset_this_command_lengths
);
11283 defsubr (&Sclear_this_command_keys
);
11284 defsubr (&Ssuspend_emacs
);
11285 defsubr (&Sabort_recursive_edit
);
11286 defsubr (&Sexit_recursive_edit
);
11287 defsubr (&Srecursion_depth
);
11288 defsubr (&Scommand_error_default_function
);
11289 defsubr (&Stop_level
);
11290 defsubr (&Sdiscard_input
);
11291 defsubr (&Sopen_dribble_file
);
11292 defsubr (&Sset_input_interrupt_mode
);
11293 defsubr (&Sset_output_flow_control
);
11294 defsubr (&Sset_input_meta_mode
);
11295 defsubr (&Sset_quit_char
);
11296 defsubr (&Sset_input_mode
);
11297 defsubr (&Scurrent_input_mode
);
11298 defsubr (&Sposn_at_point
);
11299 defsubr (&Sposn_at_x_y
);
11301 DEFVAR_LISP ("last-command-event", last_command_event
,
11302 doc
: /* Last input event that was part of a command. */);
11304 DEFVAR_LISP ("last-nonmenu-event", last_nonmenu_event
,
11305 doc
: /* Last input event in a command, except for mouse menu events.
11306 Mouse menus give back keys that don't look like mouse events;
11307 this variable holds the actual mouse event that led to the menu,
11308 so that you can determine whether the command was run by mouse or not. */);
11310 DEFVAR_LISP ("last-input-event", last_input_event
,
11311 doc
: /* Last input event. */);
11313 DEFVAR_LISP ("unread-command-events", Vunread_command_events
,
11314 doc
: /* List of events to be read as the command input.
11315 These events are processed first, before actual keyboard input.
11316 Events read from this list are not normally added to `this-command-keys',
11317 as they will already have been added once as they were read for the first time.
11318 An element of the form (t . EVENT) forces EVENT to be added to that list. */);
11319 Vunread_command_events
= Qnil
;
11321 DEFVAR_LISP ("unread-post-input-method-events", Vunread_post_input_method_events
,
11322 doc
: /* List of events to be processed as input by input methods.
11323 These events are processed before `unread-command-events'
11324 and actual keyboard input, but are not given to `input-method-function'. */);
11325 Vunread_post_input_method_events
= Qnil
;
11327 DEFVAR_LISP ("unread-input-method-events", Vunread_input_method_events
,
11328 doc
: /* List of events to be processed as input by input methods.
11329 These events are processed after `unread-command-events', but
11330 before actual keyboard input.
11331 If there's an active input method, the events are given to
11332 `input-method-function'. */);
11333 Vunread_input_method_events
= Qnil
;
11335 DEFVAR_LISP ("meta-prefix-char", meta_prefix_char
,
11336 doc
: /* Meta-prefix character code.
11337 Meta-foo as command input turns into this character followed by foo. */);
11338 XSETINT (meta_prefix_char
, 033);
11340 DEFVAR_KBOARD ("last-command", Vlast_command
,
11341 doc
: /* The last command executed.
11342 Normally a symbol with a function definition, but can be whatever was found
11343 in the keymap, or whatever the variable `this-command' was set to by that
11346 The value `mode-exit' is special; it means that the previous command
11347 read an event that told it to exit, and it did so and unread that event.
11348 In other words, the present command is the event that made the previous
11351 The value `kill-region' is special; it means that the previous command
11352 was a kill command.
11354 `last-command' has a separate binding for each terminal device.
11355 See Info node `(elisp)Multiple Terminals'. */);
11357 DEFVAR_KBOARD ("real-last-command", Vreal_last_command
,
11358 doc
: /* Same as `last-command', but never altered by Lisp code.
11359 Taken from the previous value of `real-this-command'. */);
11361 DEFVAR_KBOARD ("last-repeatable-command", Vlast_repeatable_command
,
11362 doc
: /* Last command that may be repeated.
11363 The last command executed that was not bound to an input event.
11364 This is the command `repeat' will try to repeat.
11365 Taken from a previous value of `real-this-command'. */);
11367 DEFVAR_LISP ("this-command", Vthis_command
,
11368 doc
: /* The command now being executed.
11369 The command can set this variable; whatever is put here
11370 will be in `last-command' during the following command. */);
11371 Vthis_command
= Qnil
;
11373 DEFVAR_LISP ("real-this-command", Vreal_this_command
,
11374 doc
: /* This is like `this-command', except that commands should never modify it. */);
11375 Vreal_this_command
= Qnil
;
11377 DEFVAR_LISP ("this-command-keys-shift-translated",
11378 Vthis_command_keys_shift_translated
,
11379 doc
: /* Non-nil if the key sequence activating this command was shift-translated.
11380 Shift-translation occurs when there is no binding for the key sequence
11381 as entered, but a binding was found by changing an upper-case letter
11382 to lower-case, or a shifted function key to an unshifted one. */);
11383 Vthis_command_keys_shift_translated
= Qnil
;
11385 DEFVAR_LISP ("this-original-command", Vthis_original_command
,
11386 doc
: /* The command bound to the current key sequence before remapping.
11387 It equals `this-command' if the original command was not remapped through
11388 any of the active keymaps. Otherwise, the value of `this-command' is the
11389 result of looking up the original command in the active keymaps. */);
11390 Vthis_original_command
= Qnil
;
11392 DEFVAR_INT ("auto-save-interval", auto_save_interval
,
11393 doc
: /* Number of input events between auto-saves.
11394 Zero means disable autosaving due to number of characters typed. */);
11395 auto_save_interval
= 300;
11397 DEFVAR_LISP ("auto-save-timeout", Vauto_save_timeout
,
11398 doc
: /* Number of seconds idle time before auto-save.
11399 Zero or nil means disable auto-saving due to idleness.
11400 After auto-saving due to this many seconds of idle time,
11401 Emacs also does a garbage collection if that seems to be warranted. */);
11402 XSETFASTINT (Vauto_save_timeout
, 30);
11404 DEFVAR_LISP ("echo-keystrokes", Vecho_keystrokes
,
11405 doc
: /* Nonzero means echo unfinished commands after this many seconds of pause.
11406 The value may be integer or floating point.
11407 If the value is zero, don't echo at all. */);
11408 Vecho_keystrokes
= make_number (1);
11410 DEFVAR_INT ("polling-period", polling_period
,
11411 doc
: /* Interval between polling for input during Lisp execution.
11412 The reason for polling is to make C-g work to stop a running program.
11413 Polling is needed only when using X windows and SIGIO does not work.
11414 Polling is automatically disabled in all other cases. */);
11415 polling_period
= 2;
11417 DEFVAR_LISP ("double-click-time", Vdouble_click_time
,
11418 doc
: /* Maximum time between mouse clicks to make a double-click.
11419 Measured in milliseconds. The value nil means disable double-click
11420 recognition; t means double-clicks have no time limit and are detected
11421 by position only. */);
11422 Vdouble_click_time
= make_number (500);
11424 DEFVAR_INT ("double-click-fuzz", double_click_fuzz
,
11425 doc
: /* Maximum mouse movement between clicks to make a double-click.
11426 On window-system frames, value is the number of pixels the mouse may have
11427 moved horizontally or vertically between two clicks to make a double-click.
11428 On non window-system frames, value is interpreted in units of 1/8 characters
11431 This variable is also the threshold for motion of the mouse
11432 to count as a drag. */);
11433 double_click_fuzz
= 3;
11435 DEFVAR_INT ("num-input-keys", num_input_keys
,
11436 doc
: /* Number of complete key sequences read as input so far.
11437 This includes key sequences read from keyboard macros.
11438 The number is effectively the number of interactive command invocations. */);
11439 num_input_keys
= 0;
11441 DEFVAR_INT ("num-nonmacro-input-events", num_nonmacro_input_events
,
11442 doc
: /* Number of input events read from the keyboard so far.
11443 This does not include events generated by keyboard macros. */);
11444 num_nonmacro_input_events
= 0;
11446 DEFVAR_LISP ("last-event-frame", Vlast_event_frame
,
11447 doc
: /* The frame in which the most recently read event occurred.
11448 If the last event came from a keyboard macro, this is set to `macro'. */);
11449 Vlast_event_frame
= Qnil
;
11451 /* This variable is set up in sysdep.c. */
11452 DEFVAR_LISP ("tty-erase-char", Vtty_erase_char
,
11453 doc
: /* The ERASE character as set by the user with stty. */);
11455 DEFVAR_LISP ("help-char", Vhelp_char
,
11456 doc
: /* Character to recognize as meaning Help.
11457 When it is read, do `(eval help-form)', and display result if it's a string.
11458 If the value of `help-form' is nil, this char can be read normally. */);
11459 XSETINT (Vhelp_char
, Ctl ('H'));
11461 DEFVAR_LISP ("help-event-list", Vhelp_event_list
,
11462 doc
: /* List of input events to recognize as meaning Help.
11463 These work just like the value of `help-char' (see that). */);
11464 Vhelp_event_list
= Qnil
;
11466 DEFVAR_LISP ("help-form", Vhelp_form
,
11467 doc
: /* Form to execute when character `help-char' is read.
11468 If the form returns a string, that string is displayed.
11469 If `help-form' is nil, the help char is not recognized. */);
11472 DEFVAR_LISP ("prefix-help-command", Vprefix_help_command
,
11473 doc
: /* Command to run when `help-char' character follows a prefix key.
11474 This command is used only when there is no actual binding
11475 for that character after that prefix key. */);
11476 Vprefix_help_command
= Qnil
;
11478 DEFVAR_LISP ("top-level", Vtop_level
,
11479 doc
: /* Form to evaluate when Emacs starts up.
11480 Useful to set before you dump a modified Emacs. */);
11483 DEFVAR_KBOARD ("keyboard-translate-table", Vkeyboard_translate_table
,
11484 doc
: /* Translate table for local keyboard input, or nil.
11485 If non-nil, the value should be a char-table. Each character read
11486 from the keyboard is looked up in this char-table. If the value found
11487 there is non-nil, then it is used instead of the actual input character.
11489 The value can also be a string or vector, but this is considered obsolete.
11490 If it is a string or vector of length N, character codes N and up are left
11491 untranslated. In a vector, an element which is nil means "no translation".
11493 This is applied to the characters supplied to input methods, not their
11494 output. See also `translation-table-for-input'.
11496 This variable has a separate binding for each terminal.
11497 See Info node `(elisp)Multiple Terminals'. */);
11499 DEFVAR_BOOL ("cannot-suspend", cannot_suspend
,
11500 doc
: /* Non-nil means to always spawn a subshell instead of suspending.
11501 \(Even if the operating system has support for stopping a process.\) */);
11502 cannot_suspend
= 0;
11504 DEFVAR_BOOL ("menu-prompting", menu_prompting
,
11505 doc
: /* Non-nil means prompt with menus when appropriate.
11506 This is done when reading from a keymap that has a prompt string,
11507 for elements that have prompt strings.
11508 The menu is displayed on the screen
11509 if X menus were enabled at configuration
11510 time and the previous event was a mouse click prefix key.
11511 Otherwise, menu prompting uses the echo area. */);
11512 menu_prompting
= 1;
11514 DEFVAR_LISP ("menu-prompt-more-char", menu_prompt_more_char
,
11515 doc
: /* Character to see next line of menu prompt.
11516 Type this character while in a menu prompt to rotate around the lines of it. */);
11517 XSETINT (menu_prompt_more_char
, ' ');
11519 DEFVAR_INT ("extra-keyboard-modifiers", extra_keyboard_modifiers
,
11520 doc
: /* A mask of additional modifier keys to use with every keyboard character.
11521 Emacs applies the modifiers of the character stored here to each keyboard
11522 character it reads. For example, after evaluating the expression
11523 (setq extra-keyboard-modifiers ?\\C-x)
11524 all input characters will have the control modifier applied to them.
11526 Note that the character ?\\C-@, equivalent to the integer zero, does
11527 not count as a control character; rather, it counts as a character
11528 with no modifiers; thus, setting `extra-keyboard-modifiers' to zero
11529 cancels any modification. */);
11530 extra_keyboard_modifiers
= 0;
11532 DEFSYM (Qdeactivate_mark
, "deactivate-mark");
11533 DEFVAR_LISP ("deactivate-mark", Vdeactivate_mark
,
11534 doc
: /* If an editing command sets this to t, deactivate the mark afterward.
11535 The command loop sets this to nil before each command,
11536 and tests the value when the command returns.
11537 Buffer modification stores t in this variable. */);
11538 Vdeactivate_mark
= Qnil
;
11539 Fmake_variable_buffer_local (Qdeactivate_mark
);
11541 DEFVAR_LISP ("pre-command-hook", Vpre_command_hook
,
11542 doc
: /* Normal hook run before each command is executed.
11543 If an unhandled error happens in running this hook,
11544 the function in which the error occurred is unconditionally removed, since
11545 otherwise the error might happen repeatedly and make Emacs nonfunctional. */);
11546 Vpre_command_hook
= Qnil
;
11548 DEFVAR_LISP ("post-command-hook", Vpost_command_hook
,
11549 doc
: /* Normal hook run after each command is executed.
11550 If an unhandled error happens in running this hook,
11551 the function in which the error occurred is unconditionally removed, since
11552 otherwise the error might happen repeatedly and make Emacs nonfunctional. */);
11553 Vpost_command_hook
= Qnil
;
11556 DEFVAR_LISP ("echo-area-clear-hook", ...,
11557 doc
: /* Normal hook run when clearing the echo area. */);
11559 DEFSYM (Qecho_area_clear_hook
, "echo-area-clear-hook");
11560 Fset (Qecho_area_clear_hook
, Qnil
);
11562 DEFVAR_LISP ("lucid-menu-bar-dirty-flag", Vlucid_menu_bar_dirty_flag
,
11563 doc
: /* Non-nil means menu bar, specified Lucid style, needs to be recomputed. */);
11564 Vlucid_menu_bar_dirty_flag
= Qnil
;
11566 DEFVAR_LISP ("menu-bar-final-items", Vmenu_bar_final_items
,
11567 doc
: /* List of menu bar items to move to the end of the menu bar.
11568 The elements of the list are event types that may have menu bar bindings. */);
11569 Vmenu_bar_final_items
= Qnil
;
11571 DEFVAR_LISP ("tool-bar-separator-image-expression", Vtool_bar_separator_image_expression
,
11572 doc
: /* Expression evaluating to the image spec for a tool-bar separator.
11573 This is used internally by graphical displays that do not render
11574 tool-bar separators natively. Otherwise it is unused (e.g. on GTK). */);
11575 Vtool_bar_separator_image_expression
= Qnil
;
11577 DEFVAR_KBOARD ("overriding-terminal-local-map",
11578 Voverriding_terminal_local_map
,
11579 doc
: /* Per-terminal keymap that takes precedence over all other keymaps.
11580 This variable is intended to let commands such as `universal-argument'
11581 set up a different keymap for reading the next command.
11583 `overriding-terminal-local-map' has a separate binding for each
11584 terminal device. See Info node `(elisp)Multiple Terminals'. */);
11586 DEFVAR_LISP ("overriding-local-map", Voverriding_local_map
,
11587 doc
: /* Keymap that replaces (overrides) local keymaps.
11588 If this variable is non-nil, Emacs looks up key bindings in this
11589 keymap INSTEAD OF the keymap char property, minor mode maps, and the
11590 buffer's local map. Hence, the only active keymaps would be
11591 `overriding-terminal-local-map', this keymap, and `global-keymap', in
11592 order of precedence. */);
11593 Voverriding_local_map
= Qnil
;
11595 DEFVAR_LISP ("overriding-local-map-menu-flag", Voverriding_local_map_menu_flag
,
11596 doc
: /* Non-nil means `overriding-local-map' applies to the menu bar.
11597 Otherwise, the menu bar continues to reflect the buffer's local map
11598 and the minor mode maps regardless of `overriding-local-map'. */);
11599 Voverriding_local_map_menu_flag
= Qnil
;
11601 DEFVAR_LISP ("special-event-map", Vspecial_event_map
,
11602 doc
: /* Keymap defining bindings for special events to execute at low level. */);
11603 Vspecial_event_map
= list1 (intern_c_string ("keymap"));
11605 DEFVAR_LISP ("track-mouse", do_mouse_tracking
,
11606 doc
: /* Non-nil means generate motion events for mouse motion. */);
11608 DEFVAR_KBOARD ("system-key-alist", Vsystem_key_alist
,
11609 doc
: /* Alist of system-specific X windows key symbols.
11610 Each element should have the form (N . SYMBOL) where N is the
11611 numeric keysym code (sans the \"system-specific\" bit 1<<28)
11612 and SYMBOL is its name.
11614 `system-key-alist' has a separate binding for each terminal device.
11615 See Info node `(elisp)Multiple Terminals'. */);
11617 DEFVAR_KBOARD ("local-function-key-map", Vlocal_function_key_map
,
11618 doc
: /* Keymap that translates key sequences to key sequences during input.
11619 This is used mainly for mapping key sequences into some preferred
11620 key events (symbols).
11622 The `read-key-sequence' function replaces any subsequence bound by
11623 `local-function-key-map' with its binding. More precisely, when the
11624 active keymaps have no binding for the current key sequence but
11625 `local-function-key-map' binds a suffix of the sequence to a vector or
11626 string, `read-key-sequence' replaces the matching suffix with its
11627 binding, and continues with the new sequence.
11629 If the binding is a function, it is called with one argument (the prompt)
11630 and its return value (a key sequence) is used.
11632 The events that come from bindings in `local-function-key-map' are not
11633 themselves looked up in `local-function-key-map'.
11635 For example, suppose `local-function-key-map' binds `ESC O P' to [f1].
11636 Typing `ESC O P' to `read-key-sequence' would return [f1]. Typing
11637 `C-x ESC O P' would return [?\\C-x f1]. If [f1] were a prefix key,
11638 typing `ESC O P x' would return [f1 x].
11640 `local-function-key-map' has a separate binding for each terminal
11641 device. See Info node `(elisp)Multiple Terminals'. If you need to
11642 define a binding on all terminals, change `function-key-map'
11643 instead. Initially, `local-function-key-map' is an empty keymap that
11644 has `function-key-map' as its parent on all terminal devices. */);
11646 DEFVAR_KBOARD ("input-decode-map", Vinput_decode_map
,
11647 doc
: /* Keymap that decodes input escape sequences.
11648 This is used mainly for mapping ASCII function key sequences into
11649 real Emacs function key events (symbols).
11651 The `read-key-sequence' function replaces any subsequence bound by
11652 `input-decode-map' with its binding. Contrary to `function-key-map',
11653 this map applies its rebinding regardless of the presence of an ordinary
11654 binding. So it is more like `key-translation-map' except that it applies
11655 before `function-key-map' rather than after.
11657 If the binding is a function, it is called with one argument (the prompt)
11658 and its return value (a key sequence) is used.
11660 The events that come from bindings in `input-decode-map' are not
11661 themselves looked up in `input-decode-map'. */);
11663 DEFVAR_LISP ("function-key-map", Vfunction_key_map
,
11664 doc
: /* The parent keymap of all `local-function-key-map' instances.
11665 Function key definitions that apply to all terminal devices should go
11666 here. If a mapping is defined in both the current
11667 `local-function-key-map' binding and this variable, then the local
11668 definition will take precedence. */);
11669 Vfunction_key_map
= Fmake_sparse_keymap (Qnil
);
11671 DEFVAR_LISP ("key-translation-map", Vkey_translation_map
,
11672 doc
: /* Keymap of key translations that can override keymaps.
11673 This keymap works like `input-decode-map', but comes after `function-key-map'.
11674 Another difference is that it is global rather than terminal-local. */);
11675 Vkey_translation_map
= Fmake_sparse_keymap (Qnil
);
11677 DEFVAR_LISP ("deferred-action-list", Vdeferred_action_list
,
11678 doc
: /* List of deferred actions to be performed at a later time.
11679 The precise format isn't relevant here; we just check whether it is nil. */);
11680 Vdeferred_action_list
= Qnil
;
11682 DEFVAR_LISP ("deferred-action-function", Vdeferred_action_function
,
11683 doc
: /* Function to call to handle deferred actions, after each command.
11684 This function is called with no arguments after each command
11685 whenever `deferred-action-list' is non-nil. */);
11686 Vdeferred_action_function
= Qnil
;
11688 DEFVAR_LISP ("delayed-warnings-list", Vdelayed_warnings_list
,
11689 doc
: /* List of warnings to be displayed after this command.
11690 Each element must be a list (TYPE MESSAGE [LEVEL [BUFFER-NAME]]),
11691 as per the args of `display-warning' (which see).
11692 If this variable is non-nil, `delayed-warnings-hook' will be run
11693 immediately after running `post-command-hook'. */);
11694 Vdelayed_warnings_list
= Qnil
;
11696 DEFVAR_LISP ("timer-list", Vtimer_list
,
11697 doc
: /* List of active absolute time timers in order of increasing time. */);
11698 Vtimer_list
= Qnil
;
11700 DEFVAR_LISP ("timer-idle-list", Vtimer_idle_list
,
11701 doc
: /* List of active idle-time timers in order of increasing time. */);
11702 Vtimer_idle_list
= Qnil
;
11704 DEFVAR_LISP ("input-method-function", Vinput_method_function
,
11705 doc
: /* If non-nil, the function that implements the current input method.
11706 It's called with one argument, a printing character that was just read.
11707 \(That means a character with code 040...0176.)
11708 Typically this function uses `read-event' to read additional events.
11709 When it does so, it should first bind `input-method-function' to nil
11710 so it will not be called recursively.
11712 The function should return a list of zero or more events
11713 to be used as input. If it wants to put back some events
11714 to be reconsidered, separately, by the input method,
11715 it can add them to the beginning of `unread-command-events'.
11717 The input method function can find in `input-method-previous-message'
11718 the previous echo area message.
11720 The input method function should refer to the variables
11721 `input-method-use-echo-area' and `input-method-exit-on-first-char'
11722 for guidance on what to do. */);
11723 Vinput_method_function
= Qnil
;
11725 DEFVAR_LISP ("input-method-previous-message",
11726 Vinput_method_previous_message
,
11727 doc
: /* When `input-method-function' is called, hold the previous echo area message.
11728 This variable exists because `read-event' clears the echo area
11729 before running the input method. It is nil if there was no message. */);
11730 Vinput_method_previous_message
= Qnil
;
11732 DEFVAR_LISP ("show-help-function", Vshow_help_function
,
11733 doc
: /* If non-nil, the function that implements the display of help.
11734 It's called with one argument, the help string to display. */);
11735 Vshow_help_function
= Qnil
;
11737 DEFVAR_LISP ("disable-point-adjustment", Vdisable_point_adjustment
,
11738 doc
: /* If non-nil, suppress point adjustment after executing a command.
11740 After a command is executed, if point is moved into a region that has
11741 special properties (e.g. composition, display), we adjust point to
11742 the boundary of the region. But, when a command sets this variable to
11743 non-nil, we suppress the point adjustment.
11745 This variable is set to nil before reading a command, and is checked
11746 just after executing the command. */);
11747 Vdisable_point_adjustment
= Qnil
;
11749 DEFVAR_LISP ("global-disable-point-adjustment",
11750 Vglobal_disable_point_adjustment
,
11751 doc
: /* If non-nil, always suppress point adjustment.
11753 The default value is nil, in which case, point adjustment are
11754 suppressed only after special commands that set
11755 `disable-point-adjustment' (which see) to non-nil. */);
11756 Vglobal_disable_point_adjustment
= Qnil
;
11758 DEFVAR_LISP ("minibuffer-message-timeout", Vminibuffer_message_timeout
,
11759 doc
: /* How long to display an echo-area message when the minibuffer is active.
11760 If the value is not a number, such messages don't time out. */);
11761 Vminibuffer_message_timeout
= make_number (2);
11763 DEFVAR_LISP ("throw-on-input", Vthrow_on_input
,
11764 doc
: /* If non-nil, any keyboard input throws to this symbol.
11765 The value of that variable is passed to `quit-flag' and later causes a
11766 peculiar kind of quitting. */);
11767 Vthrow_on_input
= Qnil
;
11769 DEFVAR_LISP ("command-error-function", Vcommand_error_function
,
11770 doc
: /* Function to output error messages.
11771 Called with three arguments:
11772 - the error data, a list of the form (SIGNALED-CONDITION . SIGNAL-DATA)
11773 such as what `condition-case' would bind its variable to,
11774 - the context (a string which normally goes at the start of the message),
11775 - the Lisp function within which the error was signaled. */);
11776 Vcommand_error_function
= intern ("command-error-default-function");
11778 DEFVAR_LISP ("enable-disabled-menus-and-buttons",
11779 Venable_disabled_menus_and_buttons
,
11780 doc
: /* If non-nil, don't ignore events produced by disabled menu items and tool-bar.
11782 Help functions bind this to allow help on disabled menu items
11783 and tool-bar buttons. */);
11784 Venable_disabled_menus_and_buttons
= Qnil
;
11786 DEFVAR_LISP ("select-active-regions",
11787 Vselect_active_regions
,
11788 doc
: /* If non-nil, an active region automatically sets the primary selection.
11789 If the value is `only', only temporarily active regions (usually made
11790 by mouse-dragging or shift-selection) set the window selection.
11792 This takes effect only when Transient Mark mode is enabled. */);
11793 Vselect_active_regions
= Qt
;
11795 DEFVAR_LISP ("saved-region-selection",
11796 Vsaved_region_selection
,
11797 doc
: /* Contents of active region prior to buffer modification.
11798 If `select-active-regions' is non-nil, Emacs sets this to the
11799 text in the region before modifying the buffer. The next call to
11800 the function `deactivate-mark' uses this to set the window selection. */);
11801 Vsaved_region_selection
= Qnil
;
11803 DEFVAR_LISP ("selection-inhibit-update-commands",
11804 Vselection_inhibit_update_commands
,
11805 doc
: /* List of commands which should not update the selection.
11806 Normally, if `select-active-regions' is non-nil and the mark remains
11807 active after a command (i.e. the mark was not deactivated), the Emacs
11808 command loop sets the selection to the text in the region. However,
11809 if the command is in this list, the selection is not updated. */);
11810 Vselection_inhibit_update_commands
11811 = list2 (Qhandle_switch_frame
, Qhandle_select_window
);
11813 DEFVAR_LISP ("debug-on-event",
11815 doc
: /* Enter debugger on this event. When Emacs
11816 receives the special event specified by this variable, it will try to
11817 break into the debugger as soon as possible instead of processing the
11818 event normally through `special-event-map'.
11820 Currently, the only supported values for this
11821 variable are `sigusr1' and `sigusr2'. */);
11822 Vdebug_on_event
= intern_c_string ("sigusr2");
11824 /* Create the initial keyboard. Qt means 'unset'. */
11825 initial_kboard
= allocate_kboard (Qt
);
11829 keys_of_keyboard (void)
11831 initial_define_key (global_map
, Ctl ('Z'), "suspend-emacs");
11832 initial_define_key (control_x_map
, Ctl ('Z'), "suspend-emacs");
11833 initial_define_key (meta_map
, Ctl ('C'), "exit-recursive-edit");
11834 initial_define_key (global_map
, Ctl (']'), "abort-recursive-edit");
11835 initial_define_key (meta_map
, 'x', "execute-extended-command");
11837 initial_define_lispy_key (Vspecial_event_map
, "delete-frame",
11838 "handle-delete-frame");
11839 initial_define_lispy_key (Vspecial_event_map
, "ns-put-working-text",
11840 "ns-put-working-text");
11841 initial_define_lispy_key (Vspecial_event_map
, "ns-unput-working-text",
11842 "ns-unput-working-text");
11843 /* Here we used to use `ignore-event' which would simple set prefix-arg to
11844 current-prefix-arg, as is done in `handle-switch-frame'.
11845 But `handle-switch-frame is not run from the special-map.
11846 Commands from that map are run in a special way that automatically
11847 preserves the prefix-arg. Restoring the prefix arg here is not just
11848 redundant but harmful:
11850 - current-prefix-arg is set to non-nil, prefix-arg is set to nil.
11851 - after the first prompt, the exit-minibuffer-hook is run which may
11852 iconify a frame and thus push a `iconify-frame' event.
11853 - after running exit-minibuffer-hook, current-prefix-arg is
11854 restored to the non-nil value it had before the prompt.
11855 - we enter the second prompt.
11856 current-prefix-arg is non-nil, prefix-arg is nil.
11857 - before running the first real event, we run the special iconify-frame
11858 event, but we pass the `special' arg to command-execute so
11859 current-prefix-arg and prefix-arg are left untouched.
11860 - here we foolishly copy the non-nil current-prefix-arg to prefix-arg.
11861 - the next key event will have a spuriously non-nil current-prefix-arg. */
11862 initial_define_lispy_key (Vspecial_event_map
, "iconify-frame",
11864 initial_define_lispy_key (Vspecial_event_map
, "make-frame-visible",
11866 /* Handling it at such a low-level causes read_key_sequence to get
11867 * confused because it doesn't realize that the current_buffer was
11868 * changed by read_char.
11870 * initial_define_lispy_key (Vspecial_event_map, "select-window",
11871 * "handle-select-window"); */
11872 initial_define_lispy_key (Vspecial_event_map
, "save-session",
11873 "handle-save-session");
11876 /* Define a special event which is raised for dbus callback
11878 initial_define_lispy_key (Vspecial_event_map
, "dbus-event",
11879 "dbus-handle-event");
11882 #ifdef USE_FILE_NOTIFY
11883 /* Define a special event which is raised for notification callback
11885 initial_define_lispy_key (Vspecial_event_map
, "file-notify",
11886 "file-notify-handle-event");
11887 #endif /* USE_FILE_NOTIFY */
11889 initial_define_lispy_key (Vspecial_event_map
, "config-changed-event",
11891 #if defined (WINDOWSNT)
11892 initial_define_lispy_key (Vspecial_event_map
, "language-change",
11895 initial_define_lispy_key (Vspecial_event_map
, "focus-in",
11896 "handle-focus-in");
11897 initial_define_lispy_key (Vspecial_event_map
, "focus-out",
11898 "handle-focus-out");
11901 /* Mark the pointers in the kboard objects.
11902 Called by Fgarbage_collect. */
11904 mark_kboards (void)
11908 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
11910 if (kb
->kbd_macro_buffer
)
11911 for (p
= kb
->kbd_macro_buffer
; p
< kb
->kbd_macro_ptr
; p
++)
11913 mark_object (KVAR (kb
, Voverriding_terminal_local_map
));
11914 mark_object (KVAR (kb
, Vlast_command
));
11915 mark_object (KVAR (kb
, Vreal_last_command
));
11916 mark_object (KVAR (kb
, Vkeyboard_translate_table
));
11917 mark_object (KVAR (kb
, Vlast_repeatable_command
));
11918 mark_object (KVAR (kb
, Vprefix_arg
));
11919 mark_object (KVAR (kb
, Vlast_prefix_arg
));
11920 mark_object (KVAR (kb
, kbd_queue
));
11921 mark_object (KVAR (kb
, defining_kbd_macro
));
11922 mark_object (KVAR (kb
, Vlast_kbd_macro
));
11923 mark_object (KVAR (kb
, Vsystem_key_alist
));
11924 mark_object (KVAR (kb
, system_key_syms
));
11925 mark_object (KVAR (kb
, Vwindow_system
));
11926 mark_object (KVAR (kb
, Vinput_decode_map
));
11927 mark_object (KVAR (kb
, Vlocal_function_key_map
));
11928 mark_object (KVAR (kb
, Vdefault_minibuffer_frame
));
11929 mark_object (KVAR (kb
, echo_string
));
11932 struct input_event
*event
;
11933 for (event
= kbd_fetch_ptr
; event
!= kbd_store_ptr
; event
++)
11935 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
11936 event
= kbd_buffer
;
11937 /* These two special event types has no Lisp_Objects to mark. */
11938 if (event
->kind
!= SELECTION_REQUEST_EVENT
11939 && event
->kind
!= SELECTION_CLEAR_EVENT
)
11941 mark_object (event
->x
);
11942 mark_object (event
->y
);
11943 mark_object (event
->frame_or_window
);
11944 mark_object (event
->arg
);