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
->echo_string_
= val
;
397 kset_kbd_queue (struct kboard
*kb
, Lisp_Object val
)
399 kb
->kbd_queue_
= val
;
402 kset_keyboard_translate_table (struct kboard
*kb
, Lisp_Object val
)
404 kb
->Vkeyboard_translate_table_
= val
;
407 kset_last_prefix_arg (struct kboard
*kb
, Lisp_Object val
)
409 kb
->Vlast_prefix_arg_
= val
;
412 kset_last_repeatable_command (struct kboard
*kb
, Lisp_Object val
)
414 kb
->Vlast_repeatable_command_
= val
;
417 kset_local_function_key_map (struct kboard
*kb
, Lisp_Object val
)
419 kb
->Vlocal_function_key_map_
= val
;
422 kset_overriding_terminal_local_map (struct kboard
*kb
, Lisp_Object val
)
424 kb
->Voverriding_terminal_local_map_
= val
;
427 kset_real_last_command (struct kboard
*kb
, Lisp_Object val
)
429 kb
->Vreal_last_command_
= val
;
432 kset_system_key_syms (struct kboard
*kb
, Lisp_Object val
)
434 kb
->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 && XBUFFER (XWINDOW (selected_window
)->contents
) == current_buffer
1622 && last_point_position
!= PT
1623 && NILP (Vdisable_point_adjustment
)
1624 && NILP (Vglobal_disable_point_adjustment
))
1626 if (last_point_position
> BEGV
1627 && last_point_position
< ZV
1628 && (composition_adjust_point (last_point_position
,
1629 last_point_position
)
1630 != last_point_position
))
1631 /* The last point was temporarily set within a grapheme
1632 cluster to prevent automatic composition. To recover
1633 the automatic composition, we must update the
1635 windows_or_buffers_changed
= 21;
1636 if (!already_adjusted
)
1637 adjust_point_for_property (last_point_position
,
1638 MODIFF
!= prev_modiff
);
1641 /* Install chars successfully executed in kbd macro. */
1643 if (!NILP (KVAR (current_kboard
, defining_kbd_macro
))
1644 && NILP (KVAR (current_kboard
, Vprefix_arg
)))
1645 finalize_kbd_macro_chars ();
1650 read_menu_command (void)
1652 Lisp_Object keybuf
[30];
1653 ptrdiff_t count
= SPECPDL_INDEX ();
1656 /* We don't want to echo the keystrokes while navigating the
1658 specbind (Qecho_keystrokes
, make_number (0));
1660 i
= read_key_sequence (keybuf
, ARRAYELTS (keybuf
),
1663 unbind_to (count
, Qnil
);
1665 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1667 if (i
== 0 || i
== -1)
1670 return read_key_sequence_cmd
;
1673 /* Adjust point to a boundary of a region that has such a property
1674 that should be treated intangible. For the moment, we check
1675 `composition', `display' and `invisible' properties.
1676 LAST_PT is the last position of point. */
1679 adjust_point_for_property (ptrdiff_t last_pt
, bool modified
)
1682 Lisp_Object val
, overlay
, tmp
;
1683 /* When called after buffer modification, we should temporarily
1684 suppress the point adjustment for automatic composition so that a
1685 user can keep inserting another character at point or keep
1686 deleting characters around point. */
1687 bool check_composition
= ! modified
, check_display
= 1, check_invisible
= 1;
1688 ptrdiff_t orig_pt
= PT
;
1690 /* FIXME: cycling is probably not necessary because these properties
1691 can't be usefully combined anyway. */
1692 while (check_composition
|| check_display
|| check_invisible
)
1694 /* FIXME: check `intangible'. */
1695 if (check_composition
1696 && PT
> BEGV
&& PT
< ZV
1697 && (beg
= composition_adjust_point (last_pt
, PT
)) != PT
)
1700 check_display
= check_invisible
= 1;
1702 check_composition
= 0;
1704 && PT
> BEGV
&& PT
< ZV
1705 && !NILP (val
= get_char_property_and_overlay
1706 (make_number (PT
), Qdisplay
, selected_window
,
1708 && display_prop_intangible_p (val
, overlay
, PT
, PT_BYTE
)
1709 && (!OVERLAYP (overlay
)
1710 ? get_property_and_range (PT
, Qdisplay
, &val
, &beg
, &end
, Qnil
)
1711 : (beg
= OVERLAY_POSITION (OVERLAY_START (overlay
)),
1712 end
= OVERLAY_POSITION (OVERLAY_END (overlay
))))
1713 && (beg
< PT
/* && end > PT <- It's always the case. */
1714 || (beg
<= PT
&& STRINGP (val
) && SCHARS (val
) == 0)))
1717 SET_PT (PT
< last_pt
1718 ? (STRINGP (val
) && SCHARS (val
) == 0
1719 ? max (beg
- 1, BEGV
)
1722 check_composition
= check_invisible
= 1;
1725 if (check_invisible
&& PT
> BEGV
&& PT
< ZV
)
1731 /* Find boundaries `beg' and `end' of the invisible area, if any. */
1734 /* FIXME: We should stop if we find a spot between
1735 two runs of `invisible' where inserted text would
1736 be visible. This is important when we have two
1737 invisible boundaries that enclose an area: if the
1738 area is empty, we need this test in order to make
1739 it possible to place point in the middle rather
1740 than skip both boundaries. However, this code
1741 also stops anywhere in a non-sticky text-property,
1742 which breaks (e.g.) Org mode. */
1743 && (val
= Fget_pos_property (make_number (end
),
1745 TEXT_PROP_MEANS_INVISIBLE (val
))
1747 && !NILP (val
= get_char_property_and_overlay
1748 (make_number (end
), Qinvisible
, Qnil
, &overlay
))
1749 && (inv
= TEXT_PROP_MEANS_INVISIBLE (val
)))
1751 ellipsis
= ellipsis
|| inv
> 1
1752 || (OVERLAYP (overlay
)
1753 && (!NILP (Foverlay_get (overlay
, Qafter_string
))
1754 || !NILP (Foverlay_get (overlay
, Qbefore_string
))));
1755 tmp
= Fnext_single_char_property_change
1756 (make_number (end
), Qinvisible
, Qnil
, Qnil
);
1757 end
= NATNUMP (tmp
) ? XFASTINT (tmp
) : ZV
;
1761 && (val
= Fget_pos_property (make_number (beg
),
1763 TEXT_PROP_MEANS_INVISIBLE (val
))
1765 && !NILP (val
= get_char_property_and_overlay
1766 (make_number (beg
- 1), Qinvisible
, Qnil
, &overlay
))
1767 && (inv
= TEXT_PROP_MEANS_INVISIBLE (val
)))
1769 ellipsis
= ellipsis
|| inv
> 1
1770 || (OVERLAYP (overlay
)
1771 && (!NILP (Foverlay_get (overlay
, Qafter_string
))
1772 || !NILP (Foverlay_get (overlay
, Qbefore_string
))));
1773 tmp
= Fprevious_single_char_property_change
1774 (make_number (beg
), Qinvisible
, Qnil
, Qnil
);
1775 beg
= NATNUMP (tmp
) ? XFASTINT (tmp
) : BEGV
;
1778 /* Move away from the inside area. */
1779 if (beg
< PT
&& end
> PT
)
1781 SET_PT ((orig_pt
== PT
&& (last_pt
< beg
|| last_pt
> end
))
1782 /* We haven't moved yet (so we don't need to fear
1783 infinite-looping) and we were outside the range
1784 before (so either end of the range still corresponds
1785 to a move in the right direction): pretend we moved
1786 less than we actually did, so that we still have
1787 more freedom below in choosing which end of the range
1789 ? (orig_pt
= -1, PT
< last_pt
? end
: beg
)
1790 /* We either have moved already or the last point
1791 was already in the range: we don't get to choose
1792 which end of the range we have to go to. */
1793 : (PT
< last_pt
? beg
: end
));
1794 check_composition
= check_display
= 1;
1796 #if 0 /* This assertion isn't correct, because SET_PT may end up setting
1797 the point to something other than its argument, due to
1798 point-motion hooks, intangibility, etc. */
1799 eassert (PT
== beg
|| PT
== end
);
1802 /* Pretend the area doesn't exist if the buffer is not
1804 if (!modified
&& !ellipsis
&& beg
< end
)
1806 if (last_pt
== beg
&& PT
== end
&& end
< ZV
)
1807 (check_composition
= check_display
= 1, SET_PT (end
+ 1));
1808 else if (last_pt
== end
&& PT
== beg
&& beg
> BEGV
)
1809 (check_composition
= check_display
= 1, SET_PT (beg
- 1));
1810 else if (PT
== ((PT
< last_pt
) ? beg
: end
))
1811 /* We've already moved as far as we can. Trying to go
1812 to the other end would mean moving backwards and thus
1813 could lead to an infinite loop. */
1815 else if (val
= Fget_pos_property (make_number (PT
),
1817 TEXT_PROP_MEANS_INVISIBLE (val
)
1818 && (val
= (Fget_pos_property
1819 (make_number (PT
== beg
? end
: beg
),
1821 !TEXT_PROP_MEANS_INVISIBLE (val
)))
1822 (check_composition
= check_display
= 1,
1823 SET_PT (PT
== beg
? end
: beg
));
1826 check_invisible
= 0;
1830 /* Subroutine for safe_run_hooks: run the hook, which is ARGS[1]. */
1833 safe_run_hooks_1 (ptrdiff_t nargs
, Lisp_Object
*args
)
1835 eassert (nargs
== 2);
1836 return call0 (args
[1]);
1839 /* Subroutine for safe_run_hooks: handle an error by clearing out the function
1843 safe_run_hooks_error (Lisp_Object error
, ptrdiff_t nargs
, Lisp_Object
*args
)
1845 eassert (nargs
== 2);
1846 AUTO_STRING (format
, "Error in %s (%S): %S");
1847 Lisp_Object hook
= args
[0];
1848 Lisp_Object fun
= args
[1];
1849 CALLN (Fmessage
, format
, hook
, fun
, error
);
1855 Lisp_Object newval
= Qnil
;
1856 for (val
= find_symbol_value (hook
); CONSP (val
); val
= XCDR (val
))
1857 if (EQ (fun
, XCAR (val
)))
1860 newval
= Fcons (XCAR (val
), newval
);
1862 return Fset (hook
, Fnreverse (newval
));
1863 /* Not found in the local part of the hook. Let's look at the global
1866 for (val
= (NILP (Fdefault_boundp (hook
)) ? Qnil
1867 : Fdefault_value (hook
));
1868 CONSP (val
); val
= XCDR (val
))
1869 if (EQ (fun
, XCAR (val
)))
1872 newval
= Fcons (XCAR (val
), newval
);
1874 return Fset_default (hook
, Fnreverse (newval
));
1880 safe_run_hook_funcall (ptrdiff_t nargs
, Lisp_Object
*args
)
1882 eassert (nargs
== 2);
1883 /* Yes, run_hook_with_args works with args in the other order. */
1884 internal_condition_case_n (safe_run_hooks_1
,
1885 2, ((Lisp_Object
[]) {args
[1], args
[0]}),
1886 Qt
, safe_run_hooks_error
);
1890 /* If we get an error while running the hook, cause the hook variable
1891 to be nil. Also inhibit quits, so that C-g won't cause the hook
1892 to mysteriously evaporate. */
1895 safe_run_hooks (Lisp_Object hook
)
1897 struct gcpro gcpro1
;
1898 ptrdiff_t count
= SPECPDL_INDEX ();
1901 specbind (Qinhibit_quit
, Qt
);
1902 run_hook_with_args (2, ((Lisp_Object
[]) {hook
, hook
}), safe_run_hook_funcall
);
1903 unbind_to (count
, Qnil
);
1908 /* Nonzero means polling for input is temporarily suppressed. */
1910 int poll_suppress_count
;
1913 #ifdef POLL_FOR_INPUT
1915 /* Asynchronous timer for polling. */
1917 static struct atimer
*poll_timer
;
1919 /* Poll for input, so that we catch a C-g if it comes in. */
1921 poll_for_input_1 (void)
1923 if (! input_blocked_p ()
1924 && !waiting_for_input
)
1928 /* Timer callback function for poll_timer. TIMER is equal to
1932 poll_for_input (struct atimer
*timer
)
1934 if (poll_suppress_count
== 0)
1935 pending_signals
= 1;
1938 #endif /* POLL_FOR_INPUT */
1940 /* Begin signals to poll for input, if they are appropriate.
1941 This function is called unconditionally from various places. */
1944 start_polling (void)
1946 #ifdef POLL_FOR_INPUT
1947 /* XXX This condition was (read_socket_hook && !interrupt_input),
1948 but read_socket_hook is not global anymore. Let's pretend that
1950 if (!interrupt_input
)
1952 /* Turn alarm handling on unconditionally. It might have
1953 been turned off in process.c. */
1954 turn_on_atimers (1);
1956 /* If poll timer doesn't exist, or we need one with
1957 a different interval, start a new one. */
1958 if (poll_timer
== NULL
1959 || poll_timer
->interval
.tv_sec
!= polling_period
)
1961 time_t period
= max (1, min (polling_period
, TYPE_MAXIMUM (time_t)));
1962 struct timespec interval
= make_timespec (period
, 0);
1965 cancel_atimer (poll_timer
);
1967 poll_timer
= start_atimer (ATIMER_CONTINUOUS
, interval
,
1968 poll_for_input
, NULL
);
1971 /* Let the timer's callback function poll for input
1972 if this becomes zero. */
1973 --poll_suppress_count
;
1978 /* True if we are using polling to handle input asynchronously. */
1981 input_polling_used (void)
1983 #ifdef POLL_FOR_INPUT
1984 /* XXX This condition was (read_socket_hook && !interrupt_input),
1985 but read_socket_hook is not global anymore. Let's pretend that
1987 return !interrupt_input
;
1993 /* Turn off polling. */
1998 #ifdef POLL_FOR_INPUT
1999 /* XXX This condition was (read_socket_hook && !interrupt_input),
2000 but read_socket_hook is not global anymore. Let's pretend that
2002 if (!interrupt_input
)
2003 ++poll_suppress_count
;
2007 /* Set the value of poll_suppress_count to COUNT
2008 and start or stop polling accordingly. */
2011 set_poll_suppress_count (int count
)
2013 #ifdef POLL_FOR_INPUT
2014 if (count
== 0 && poll_suppress_count
!= 0)
2016 poll_suppress_count
= 1;
2019 else if (count
!= 0 && poll_suppress_count
== 0)
2023 poll_suppress_count
= count
;
2027 /* Bind polling_period to a value at least N.
2028 But don't decrease it. */
2031 bind_polling_period (int n
)
2033 #ifdef POLL_FOR_INPUT
2034 EMACS_INT
new = polling_period
;
2039 stop_other_atimers (poll_timer
);
2041 specbind (Qpolling_period
, make_number (new));
2042 /* Start a new alarm with the new period. */
2047 /* Apply the control modifier to CHARACTER. */
2050 make_ctrl_char (int c
)
2052 /* Save the upper bits here. */
2053 int upper
= c
& ~0177;
2055 if (! ASCII_CHAR_P (c
))
2056 return c
|= ctrl_modifier
;
2060 /* Everything in the columns containing the upper-case letters
2061 denotes a control character. */
2062 if (c
>= 0100 && c
< 0140)
2066 /* Set the shift modifier for a control char
2067 made from a shifted letter. But only for letters! */
2068 if (oc
>= 'A' && oc
<= 'Z')
2069 c
|= shift_modifier
;
2072 /* The lower-case letters denote control characters too. */
2073 else if (c
>= 'a' && c
<= 'z')
2076 /* Include the bits for control and shift
2077 only if the basic ASCII code can't indicate them. */
2081 /* Replace the high bits. */
2082 c
|= (upper
& ~ctrl_modifier
);
2087 /* Display the help-echo property of the character after the mouse pointer.
2088 Either show it in the echo area, or call show-help-function to display
2089 it by other means (maybe in a tooltip).
2091 If HELP is nil, that means clear the previous help echo.
2093 If HELP is a string, display that string. If HELP is a function,
2094 call it with OBJECT and POS as arguments; the function should
2095 return a help string or nil for none. For all other types of HELP,
2096 evaluate it to obtain a string.
2098 WINDOW is the window in which the help was generated, if any.
2099 It is nil if not in a window.
2101 If OBJECT is a buffer, POS is the position in the buffer where the
2102 `help-echo' text property was found.
2104 If OBJECT is an overlay, that overlay has a `help-echo' property,
2105 and POS is the position in the overlay's buffer under the mouse.
2107 If OBJECT is a string (an overlay string or a string displayed with
2108 the `display' property). POS is the position in that string under
2111 Note: this function may only be called with HELP nil or a string
2112 from X code running asynchronously. */
2115 show_help_echo (Lisp_Object help
, Lisp_Object window
, Lisp_Object object
,
2118 if (!NILP (help
) && !STRINGP (help
))
2120 if (FUNCTIONP (help
))
2121 help
= safe_call (4, help
, window
, object
, pos
);
2123 help
= safe_eval (help
);
2125 if (!STRINGP (help
))
2129 if (!noninteractive
&& STRINGP (help
))
2131 /* The mouse-fixup-help-message Lisp function can call
2132 mouse_position_hook, which resets the mouse_moved flags.
2133 This causes trouble if we are trying to read a mouse motion
2134 event (i.e., if we are inside a `track-mouse' form), so we
2135 restore the mouse_moved flag. */
2136 struct frame
*f
= NILP (do_mouse_tracking
) ? NULL
: some_mouse_moved ();
2137 help
= call1 (Qmouse_fixup_help_message
, help
);
2142 if (STRINGP (help
) || NILP (help
))
2144 if (!NILP (Vshow_help_function
))
2145 call1 (Vshow_help_function
, help
);
2146 help_echo_showing_p
= STRINGP (help
);
2152 /* Input of single characters from keyboard. */
2154 static Lisp_Object
kbd_buffer_get_event (KBOARD
**kbp
, bool *used_mouse_menu
,
2155 struct timespec
*end_time
);
2156 static void record_char (Lisp_Object c
);
2158 static Lisp_Object help_form_saved_window_configs
;
2160 read_char_help_form_unwind (void)
2162 Lisp_Object window_config
= XCAR (help_form_saved_window_configs
);
2163 help_form_saved_window_configs
= XCDR (help_form_saved_window_configs
);
2164 if (!NILP (window_config
))
2165 Fset_window_configuration (window_config
);
2168 #define STOP_POLLING \
2169 do { if (! polling_stopped_here) stop_polling (); \
2170 polling_stopped_here = 1; } while (0)
2172 #define RESUME_POLLING \
2173 do { if (polling_stopped_here) start_polling (); \
2174 polling_stopped_here = 0; } while (0)
2177 read_event_from_main_queue (struct timespec
*end_time
,
2178 sys_jmp_buf local_getcjmp
,
2179 bool *used_mouse_menu
)
2181 Lisp_Object c
= Qnil
;
2182 sys_jmp_buf save_jump
;
2183 KBOARD
*kb
IF_LINT (= NULL
);
2187 /* Read from the main queue, and if that gives us something we can't use yet,
2188 we put it on the appropriate side queue and try again. */
2190 if (end_time
&& timespec_cmp (*end_time
, current_timespec ()) <= 0)
2193 /* Actually read a character, waiting if necessary. */
2194 save_getcjmp (save_jump
);
2195 restore_getcjmp (local_getcjmp
);
2197 timer_start_idle ();
2198 c
= kbd_buffer_get_event (&kb
, used_mouse_menu
, end_time
);
2199 restore_getcjmp (save_jump
);
2201 if (! NILP (c
) && (kb
!= current_kboard
))
2203 Lisp_Object last
= KVAR (kb
, kbd_queue
);
2206 while (CONSP (XCDR (last
)))
2208 if (!NILP (XCDR (last
)))
2212 kset_kbd_queue (kb
, list1 (c
));
2214 XSETCDR (last
, list1 (c
));
2215 kb
->kbd_queue_has_data
= 1;
2219 current_kboard
= kb
;
2220 /* This is going to exit from read_char
2221 so we had better get rid of this frame's stuff. */
2222 return make_number (-2);
2225 /* Terminate Emacs in batch mode if at eof. */
2226 if (noninteractive
&& INTEGERP (c
) && XINT (c
) < 0)
2227 Fkill_emacs (make_number (1));
2231 /* Add in any extra modifiers, where appropriate. */
2232 if ((extra_keyboard_modifiers
& CHAR_CTL
)
2233 || ((extra_keyboard_modifiers
& 0177) < ' '
2234 && (extra_keyboard_modifiers
& 0177) != 0))
2235 XSETINT (c
, make_ctrl_char (XINT (c
)));
2237 /* Transfer any other modifier bits directly from
2238 extra_keyboard_modifiers to c. Ignore the actual character code
2239 in the low 16 bits of extra_keyboard_modifiers. */
2240 XSETINT (c
, XINT (c
) | (extra_keyboard_modifiers
& ~0xff7f & ~CHAR_CTL
));
2248 /* Like `read_event_from_main_queue' but applies keyboard-coding-system
2251 read_decoded_event_from_main_queue (struct timespec
*end_time
,
2252 sys_jmp_buf local_getcjmp
,
2253 Lisp_Object prev_event
,
2254 bool *used_mouse_menu
)
2256 #define MAX_ENCODED_BYTES 16
2258 Lisp_Object events
[MAX_ENCODED_BYTES
];
2264 = read_event_from_main_queue (end_time
, local_getcjmp
,
2267 /* w32_console already returns decoded events. It either reads
2268 Unicode characters from the Windows keyboard input, or
2269 converts characters encoded in the current codepage into
2270 Unicode. See w32inevt.c:key_event, near its end. */
2273 struct frame
*frame
= XFRAME (selected_frame
);
2274 struct terminal
*terminal
= frame
->terminal
;
2275 if (!((FRAME_TERMCAP_P (frame
) || FRAME_MSDOS_P (frame
))
2276 /* Don't apply decoding if we're just reading a raw event
2277 (e.g. reading bytes sent by the xterm to specify the position
2278 of a mouse click). */
2279 && (!EQ (prev_event
, Qt
))
2280 && (TERMINAL_KEYBOARD_CODING (terminal
)->common_flags
2281 & CODING_REQUIRE_DECODING_MASK
)))
2282 return nextevt
; /* No decoding needed. */
2285 int meta_key
= terminal
->display_info
.tty
->meta_key
;
2286 eassert (n
< MAX_ENCODED_BYTES
);
2287 events
[n
++] = nextevt
;
2288 if (NATNUMP (nextevt
)
2289 && XINT (nextevt
) < (meta_key
== 1 ? 0x80 : 0x100))
2290 { /* An encoded byte sequence, let's try to decode it. */
2291 struct coding_system
*coding
2292 = TERMINAL_KEYBOARD_CODING (terminal
);
2294 if (raw_text_coding_system_p (coding
))
2298 for (i
= 0; i
< n
; i
++)
2299 events
[i
] = make_number (XINT (events
[i
]) & ~0x80);
2303 unsigned char src
[MAX_ENCODED_BYTES
];
2304 unsigned char dest
[MAX_ENCODED_BYTES
* MAX_MULTIBYTE_LENGTH
];
2306 for (i
= 0; i
< n
; i
++)
2307 src
[i
] = XINT (events
[i
]);
2309 for (i
= 0; i
< n
; i
++)
2311 coding
->destination
= dest
;
2312 coding
->dst_bytes
= sizeof dest
;
2313 decode_coding_c_string (coding
, src
, n
, Qnil
);
2314 eassert (coding
->produced_char
<= n
);
2315 if (coding
->produced_char
== 0)
2316 { /* The encoded sequence is incomplete. */
2317 if (n
< MAX_ENCODED_BYTES
) /* Avoid buffer overflow. */
2318 continue; /* Read on! */
2322 const unsigned char *p
= coding
->destination
;
2323 eassert (coding
->carryover_bytes
== 0);
2325 while (n
< coding
->produced_char
)
2326 events
[n
++] = make_number (STRING_CHAR_ADVANCE (p
));
2330 /* Now `events' should hold decoded events.
2331 Normally, n should be equal to 1, but better not rely on it.
2332 We can only return one event here, so return the first we
2333 had and keep the others (if any) for later. */
2335 Vunread_command_events
2336 = Fcons (events
[--n
], Vunread_command_events
);
2344 echo_keystrokes_p (void)
2346 return (FLOATP (Vecho_keystrokes
) ? XFLOAT_DATA (Vecho_keystrokes
) > 0.0
2347 : INTEGERP (Vecho_keystrokes
) ? XINT (Vecho_keystrokes
) > 0 : false);
2350 /* Read a character from the keyboard; call the redisplay if needed. */
2351 /* commandflag 0 means do not autosave, but do redisplay.
2352 -1 means do not redisplay, but do autosave.
2353 -2 means do neither.
2356 The argument MAP is a keymap for menu prompting.
2358 PREV_EVENT is the previous input event, or nil if we are reading
2359 the first event of a key sequence (or not reading a key sequence).
2360 If PREV_EVENT is t, that is a "magic" value that says
2361 not to run input methods, but in other respects to act as if
2362 not reading a key sequence.
2364 If USED_MOUSE_MENU is non-null, then set *USED_MOUSE_MENU to true
2365 if we used a mouse menu to read the input, or false otherwise. If
2366 USED_MOUSE_MENU is null, don't dereference it.
2368 Value is -2 when we find input on another keyboard. A second call
2369 to read_char will read it.
2371 If END_TIME is non-null, it is a pointer to a struct timespec
2372 specifying the maximum time to wait until. If no input arrives by
2373 that time, stop waiting and return nil.
2375 Value is t if we showed a menu and the user rejected it. */
2378 read_char (int commandflag
, Lisp_Object map
,
2379 Lisp_Object prev_event
,
2380 bool *used_mouse_menu
, struct timespec
*end_time
)
2384 sys_jmp_buf local_getcjmp
;
2385 sys_jmp_buf save_jump
;
2386 Lisp_Object tem
, save
;
2387 volatile Lisp_Object previous_echo_area_message
;
2388 volatile Lisp_Object also_record
;
2389 volatile bool reread
;
2390 struct gcpro gcpro1
, gcpro2
;
2391 bool volatile polling_stopped_here
= 0;
2392 struct kboard
*orig_kboard
= current_kboard
;
2396 #if 0 /* This was commented out as part of fixing echo for C-u left. */
2397 before_command_key_count
= this_command_key_count
;
2398 before_command_echo_length
= echo_length ();
2401 previous_echo_area_message
= Qnil
;
2403 GCPRO2 (c
, previous_echo_area_message
);
2407 if (CONSP (Vunread_post_input_method_events
))
2409 c
= XCAR (Vunread_post_input_method_events
);
2410 Vunread_post_input_method_events
2411 = XCDR (Vunread_post_input_method_events
);
2413 /* Undo what read_char_x_menu_prompt did when it unread
2414 additional keys returned by Fx_popup_menu. */
2416 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2427 if (CONSP (Vunread_command_events
))
2429 bool was_disabled
= 0;
2431 c
= XCAR (Vunread_command_events
);
2432 Vunread_command_events
= XCDR (Vunread_command_events
);
2434 /* Undo what sit-for did when it unread additional keys
2435 inside universal-argument. */
2437 if (CONSP (c
) && EQ (XCAR (c
), Qt
))
2442 /* Undo what read_char_x_menu_prompt did when it unread
2443 additional keys returned by Fx_popup_menu. */
2445 && EQ (XCDR (c
), Qdisabled
)
2446 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
))))
2452 /* If the queued event is something that used the mouse,
2453 set used_mouse_menu accordingly. */
2455 /* Also check was_disabled so last-nonmenu-event won't return
2456 a bad value when submenus are involved. (Bug#447) */
2457 && (EQ (c
, Qtool_bar
) || EQ (c
, Qmenu_bar
) || was_disabled
))
2458 *used_mouse_menu
= 1;
2460 goto reread_for_input_method
;
2463 if (CONSP (Vunread_input_method_events
))
2465 c
= XCAR (Vunread_input_method_events
);
2466 Vunread_input_method_events
= XCDR (Vunread_input_method_events
);
2468 /* Undo what read_char_x_menu_prompt did when it unread
2469 additional keys returned by Fx_popup_menu. */
2471 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2475 goto reread_for_input_method
;
2478 this_command_key_count_reset
= 0;
2480 if (!NILP (Vexecuting_kbd_macro
))
2482 /* We set this to Qmacro; since that's not a frame, nobody will
2483 try to switch frames on us, and the selected window will
2486 Since this event came from a macro, it would be misleading to
2487 leave internal_last_event_frame set to wherever the last
2488 real event came from. Normally, a switch-frame event selects
2489 internal_last_event_frame after each command is read, but
2490 events read from a macro should never cause a new frame to be
2492 Vlast_event_frame
= internal_last_event_frame
= Qmacro
;
2494 /* Exit the macro if we are at the end.
2495 Also, some things replace the macro with t
2496 to force an early exit. */
2497 if (EQ (Vexecuting_kbd_macro
, Qt
)
2498 || executing_kbd_macro_index
>= XFASTINT (Flength (Vexecuting_kbd_macro
)))
2504 c
= Faref (Vexecuting_kbd_macro
, make_number (executing_kbd_macro_index
));
2505 if (STRINGP (Vexecuting_kbd_macro
)
2506 && (XFASTINT (c
) & 0x80) && (XFASTINT (c
) <= 0xff))
2507 XSETFASTINT (c
, CHAR_META
| (XFASTINT (c
) & ~0x80));
2509 executing_kbd_macro_index
++;
2514 if (!NILP (unread_switch_frame
))
2516 c
= unread_switch_frame
;
2517 unread_switch_frame
= Qnil
;
2519 /* This event should make it into this_command_keys, and get echoed
2520 again, so we do not set `reread'. */
2524 /* If redisplay was requested. */
2525 if (commandflag
>= 0)
2527 bool echo_current
= EQ (echo_message_buffer
, echo_area_buffer
[0]);
2529 /* If there is pending input, process any events which are not
2530 user-visible, such as X selection_request events. */
2532 || detect_input_pending_run_timers (0))
2533 swallow_events (false); /* May clear input_pending. */
2535 /* Redisplay if no pending input. */
2536 while (!(input_pending
2537 && (input_was_pending
|| !redisplay_dont_pause
)))
2539 input_was_pending
= input_pending
;
2540 if (help_echo_showing_p
&& !EQ (selected_window
, minibuf_window
))
2541 redisplay_preserve_echo_area (5);
2546 /* Normal case: no input arrived during redisplay. */
2549 /* Input arrived and pre-empted redisplay.
2550 Process any events which are not user-visible. */
2551 swallow_events (false);
2552 /* If that cleared input_pending, try again to redisplay. */
2555 /* Prevent the redisplay we just did
2556 from messing up echoing of the input after the prompt. */
2557 if (commandflag
== 0 && echo_current
)
2558 echo_message_buffer
= echo_area_buffer
[0];
2562 /* Message turns off echoing unless more keystrokes turn it on again.
2564 The code in 20.x for the condition was
2566 1. echo_area_glyphs && *echo_area_glyphs
2567 2. && echo_area_glyphs != current_kboard->echobuf
2568 3. && ok_to_echo_at_next_pause != echo_area_glyphs
2570 (1) means there's a current message displayed
2572 (2) means it's not the message from echoing from the current
2575 (3) There's only one place in 20.x where ok_to_echo_at_next_pause
2576 is set to a non-null value. This is done in read_char and it is
2577 set to echo_area_glyphs after a call to echo_char. That means
2578 ok_to_echo_at_next_pause is either null or
2579 current_kboard->echobuf with the appropriate current_kboard at
2582 So, condition (3) means in clear text ok_to_echo_at_next_pause
2583 must be either null, or the current message isn't from echoing at
2584 all, or it's from echoing from a different kboard than the
2587 if (/* There currently is something in the echo area. */
2588 !NILP (echo_area_buffer
[0])
2589 && (/* It's an echo from a different kboard. */
2590 echo_kboard
!= current_kboard
2591 /* Or we explicitly allow overwriting whatever there is. */
2592 || ok_to_echo_at_next_pause
== NULL
))
2597 /* Try reading a character via menu prompting in the minibuf.
2598 Try this before the sit-for, because the sit-for
2599 would do the wrong thing if we are supposed to do
2600 menu prompting. If EVENT_HAS_PARAMETERS then we are reading
2601 after a mouse event so don't try a minibuf menu. */
2603 if (KEYMAPP (map
) && INTERACTIVE
2604 && !NILP (prev_event
) && ! EVENT_HAS_PARAMETERS (prev_event
)
2605 /* Don't bring up a menu if we already have another event. */
2606 && NILP (Vunread_command_events
)
2607 && !detect_input_pending_run_timers (0))
2609 c
= read_char_minibuf_menu_prompt (commandflag
, map
);
2611 if (INTEGERP (c
) && XINT (c
) == -2)
2612 return c
; /* wrong_kboard_jmpbuf */
2618 /* Make a longjmp point for quits to use, but don't alter getcjmp just yet.
2619 We will do that below, temporarily for short sections of code,
2620 when appropriate. local_getcjmp must be in effect
2621 around any call to sit_for or kbd_buffer_get_event;
2622 it *must not* be in effect when we call redisplay. */
2624 jmpcount
= SPECPDL_INDEX ();
2625 if (sys_setjmp (local_getcjmp
))
2627 /* Handle quits while reading the keyboard. */
2628 /* We must have saved the outer value of getcjmp here,
2629 so restore it now. */
2630 restore_getcjmp (save_jump
);
2631 pthread_sigmask (SIG_SETMASK
, &empty_mask
, 0);
2632 unbind_to (jmpcount
, Qnil
);
2633 XSETINT (c
, quit_char
);
2634 internal_last_event_frame
= selected_frame
;
2635 Vlast_event_frame
= internal_last_event_frame
;
2636 /* If we report the quit char as an event,
2637 don't do so more than once. */
2638 if (!NILP (Vinhibit_quit
))
2642 KBOARD
*kb
= FRAME_KBOARD (XFRAME (selected_frame
));
2643 if (kb
!= current_kboard
)
2645 Lisp_Object last
= KVAR (kb
, kbd_queue
);
2646 /* We shouldn't get here if we were in single-kboard mode! */
2651 while (CONSP (XCDR (last
)))
2653 if (!NILP (XCDR (last
)))
2657 kset_kbd_queue (kb
, list1 (c
));
2659 XSETCDR (last
, list1 (c
));
2660 kb
->kbd_queue_has_data
= 1;
2661 current_kboard
= kb
;
2662 /* This is going to exit from read_char
2663 so we had better get rid of this frame's stuff. */
2665 return make_number (-2); /* wrong_kboard_jmpbuf */
2671 /* Start idle timers if no time limit is supplied. We don't do it
2672 if a time limit is supplied to avoid an infinite recursion in the
2673 situation where an idle timer calls `sit-for'. */
2676 timer_start_idle ();
2678 /* If in middle of key sequence and minibuffer not active,
2679 start echoing if enough time elapses. */
2681 if (minibuf_level
== 0
2683 && !current_kboard
->immediate_echo
2684 && this_command_key_count
> 0
2686 && echo_keystrokes_p ()
2687 && (/* No message. */
2688 NILP (echo_area_buffer
[0])
2689 /* Or empty message. */
2690 || (BUF_BEG (XBUFFER (echo_area_buffer
[0]))
2691 == BUF_Z (XBUFFER (echo_area_buffer
[0])))
2692 /* Or already echoing from same kboard. */
2693 || (echo_kboard
&& ok_to_echo_at_next_pause
== echo_kboard
)
2694 /* Or not echoing before and echoing allowed. */
2695 || (!echo_kboard
&& ok_to_echo_at_next_pause
)))
2697 /* After a mouse event, start echoing right away.
2698 This is because we are probably about to display a menu,
2699 and we don't want to delay before doing so. */
2700 if (EVENT_HAS_PARAMETERS (prev_event
))
2706 save_getcjmp (save_jump
);
2707 restore_getcjmp (local_getcjmp
);
2708 tem0
= sit_for (Vecho_keystrokes
, 1, 1);
2709 restore_getcjmp (save_jump
);
2711 && ! CONSP (Vunread_command_events
))
2716 /* Maybe auto save due to number of keystrokes. */
2718 if (commandflag
!= 0 && commandflag
!= -2
2719 && auto_save_interval
> 0
2720 && num_nonmacro_input_events
- last_auto_save
> max (auto_save_interval
, 20)
2721 && !detect_input_pending_run_timers (0))
2723 Fdo_auto_save (Qnil
, Qnil
);
2724 /* Hooks can actually change some buffers in auto save. */
2728 /* Try reading using an X menu.
2729 This is never confused with reading using the minibuf
2730 because the recursive call of read_char in read_char_minibuf_menu_prompt
2731 does not pass on any keymaps. */
2733 if (KEYMAPP (map
) && INTERACTIVE
2734 && !NILP (prev_event
)
2735 && EVENT_HAS_PARAMETERS (prev_event
)
2736 && !EQ (XCAR (prev_event
), Qmenu_bar
)
2737 && !EQ (XCAR (prev_event
), Qtool_bar
)
2738 /* Don't bring up a menu if we already have another event. */
2739 && NILP (Vunread_command_events
))
2741 c
= read_char_x_menu_prompt (map
, prev_event
, used_mouse_menu
);
2743 /* Now that we have read an event, Emacs is not idle. */
2750 /* Maybe autosave and/or garbage collect due to idleness. */
2752 if (INTERACTIVE
&& NILP (c
))
2755 ptrdiff_t buffer_size
;
2757 /* Slow down auto saves logarithmically in size of current buffer,
2758 and garbage collect while we're at it. */
2759 if (! MINI_WINDOW_P (XWINDOW (selected_window
)))
2760 last_non_minibuf_size
= Z
- BEG
;
2761 buffer_size
= (last_non_minibuf_size
>> 8) + 1;
2763 while (buffer_size
> 64)
2764 delay_level
++, buffer_size
-= buffer_size
>> 2;
2765 if (delay_level
< 4) delay_level
= 4;
2766 /* delay_level is 4 for files under around 50k, 7 at 100k,
2767 9 at 200k, 11 at 300k, and 12 at 500k. It is 15 at 1 meg. */
2769 /* Auto save if enough time goes by without input. */
2770 if (commandflag
!= 0 && commandflag
!= -2
2771 && num_nonmacro_input_events
> last_auto_save
2772 && INTEGERP (Vauto_save_timeout
)
2773 && XINT (Vauto_save_timeout
) > 0)
2776 EMACS_INT timeout
= XFASTINT (Vauto_save_timeout
);
2778 timeout
= min (timeout
, MOST_POSITIVE_FIXNUM
/ delay_level
* 4);
2779 timeout
= delay_level
* timeout
/ 4;
2780 save_getcjmp (save_jump
);
2781 restore_getcjmp (local_getcjmp
);
2782 tem0
= sit_for (make_number (timeout
), 1, 1);
2783 restore_getcjmp (save_jump
);
2786 && ! CONSP (Vunread_command_events
))
2788 Fdo_auto_save (Qnil
, Qnil
);
2793 /* If there is still no input available, ask for GC. */
2794 if (!detect_input_pending_run_timers (0))
2798 /* Notify the caller if an autosave hook, or a timer, sentinel or
2799 filter in the sit_for calls above have changed the current
2800 kboard. This could happen if they use the minibuffer or start a
2801 recursive edit, like the fancy splash screen in server.el's
2802 filter. If this longjmp wasn't here, read_key_sequence would
2803 interpret the next key sequence using the wrong translation
2804 tables and function keymaps. */
2805 if (NILP (c
) && current_kboard
!= orig_kboard
)
2808 return make_number (-2); /* wrong_kboard_jmpbuf */
2811 /* If this has become non-nil here, it has been set by a timer
2812 or sentinel or filter. */
2813 if (CONSP (Vunread_command_events
))
2815 c
= XCAR (Vunread_command_events
);
2816 Vunread_command_events
= XCDR (Vunread_command_events
);
2818 if (CONSP (c
) && EQ (XCAR (c
), Qt
))
2824 /* Read something from current KBOARD's side queue, if possible. */
2828 if (current_kboard
->kbd_queue_has_data
)
2830 if (!CONSP (KVAR (current_kboard
, kbd_queue
)))
2832 c
= XCAR (KVAR (current_kboard
, kbd_queue
));
2833 kset_kbd_queue (current_kboard
,
2834 XCDR (KVAR (current_kboard
, kbd_queue
)));
2835 if (NILP (KVAR (current_kboard
, kbd_queue
)))
2836 current_kboard
->kbd_queue_has_data
= 0;
2837 input_pending
= readable_events (0);
2838 if (EVENT_HAS_PARAMETERS (c
)
2839 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qswitch_frame
))
2840 internal_last_event_frame
= XCAR (XCDR (c
));
2841 Vlast_event_frame
= internal_last_event_frame
;
2845 /* If current_kboard's side queue is empty check the other kboards.
2846 If one of them has data that we have not yet seen here,
2847 switch to it and process the data waiting for it.
2849 Note: if the events queued up for another kboard
2850 have already been seen here, and therefore are not a complete command,
2851 the kbd_queue_has_data field is 0, so we skip that kboard here.
2852 That's to avoid an infinite loop switching between kboards here. */
2853 if (NILP (c
) && !single_kboard
)
2856 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
2857 if (kb
->kbd_queue_has_data
)
2859 current_kboard
= kb
;
2860 /* This is going to exit from read_char
2861 so we had better get rid of this frame's stuff. */
2863 return make_number (-2); /* wrong_kboard_jmpbuf */
2873 c
= read_decoded_event_from_main_queue (end_time
, local_getcjmp
,
2874 prev_event
, used_mouse_menu
);
2875 if (NILP (c
) && end_time
2876 && timespec_cmp (*end_time
, current_timespec ()) <= 0)
2881 if (EQ (c
, make_number (-2)))
2883 /* This is going to exit from read_char
2884 so we had better get rid of this frame's stuff. */
2898 if (commandflag
>= 0
2899 && !input_pending
&& !detect_input_pending_run_timers (0))
2905 /* Buffer switch events are only for internal wakeups
2906 so don't show them to the user.
2907 Also, don't record a key if we already did. */
2911 /* Process special events within read_char
2912 and loop around to read another event. */
2915 tem
= access_keymap (get_keymap (Vspecial_event_map
, 0, 1), c
, 0, 0, 1);
2920 struct buffer
*prev_buffer
= current_buffer
;
2921 last_input_event
= c
;
2922 call4 (Qcommand_execute
, tem
, Qnil
, Fvector (1, &last_input_event
), Qt
);
2924 if (CONSP (c
) && EQ (XCAR (c
), Qselect_window
) && !end_time
)
2925 /* We stopped being idle for this event; undo that. This
2926 prevents automatic window selection (under
2927 mouse_autoselect_window from acting as a real input event, for
2928 example banishing the mouse under mouse-avoidance-mode. */
2929 timer_resume_idle ();
2931 if (current_buffer
!= prev_buffer
)
2933 /* The command may have changed the keymaps. Pretend there
2934 is input in another keyboard and return. This will
2935 recalculate keymaps. */
2936 c
= make_number (-2);
2943 /* Handle things that only apply to characters. */
2946 /* If kbd_buffer_get_event gave us an EOF, return that. */
2950 if ((STRINGP (KVAR (current_kboard
, Vkeyboard_translate_table
))
2951 && UNSIGNED_CMP (XFASTINT (c
), <,
2952 SCHARS (KVAR (current_kboard
,
2953 Vkeyboard_translate_table
))))
2954 || (VECTORP (KVAR (current_kboard
, Vkeyboard_translate_table
))
2955 && UNSIGNED_CMP (XFASTINT (c
), <,
2956 ASIZE (KVAR (current_kboard
,
2957 Vkeyboard_translate_table
))))
2958 || (CHAR_TABLE_P (KVAR (current_kboard
, Vkeyboard_translate_table
))
2962 d
= Faref (KVAR (current_kboard
, Vkeyboard_translate_table
), c
);
2963 /* nil in keyboard-translate-table means no translation. */
2969 /* If this event is a mouse click in the menu bar,
2970 return just menu-bar for now. Modify the mouse click event
2971 so we won't do this twice, then queue it up. */
2972 if (EVENT_HAS_PARAMETERS (c
)
2974 && CONSP (EVENT_START (c
))
2975 && CONSP (XCDR (EVENT_START (c
))))
2979 posn
= POSN_POSN (EVENT_START (c
));
2980 /* Handle menu-bar events:
2981 insert the dummy prefix event `menu-bar'. */
2982 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
2984 /* Change menu-bar to (menu-bar) as the event "position". */
2985 POSN_SET_POSN (EVENT_START (c
), list1 (posn
));
2988 Vunread_command_events
= Fcons (c
, Vunread_command_events
);
2993 /* Store these characters into recent_keys, the dribble file if any,
2994 and the keyboard macro being defined, if any. */
2996 if (! NILP (also_record
))
2997 record_char (also_record
);
2999 /* Wipe the echo area.
3000 But first, if we are about to use an input method,
3001 save the echo area contents for it to refer to. */
3003 && ! NILP (Vinput_method_function
)
3004 && ' ' <= XINT (c
) && XINT (c
) < 256 && XINT (c
) != 127)
3006 previous_echo_area_message
= Fcurrent_message ();
3007 Vinput_method_previous_message
= previous_echo_area_message
;
3010 /* Now wipe the echo area, except for help events which do their
3011 own stuff with the echo area. */
3013 || (!(EQ (Qhelp_echo
, XCAR (c
)))
3014 && !(EQ (Qswitch_frame
, XCAR (c
)))
3015 /* Don't wipe echo area for select window events: These might
3016 get delayed via `mouse-autoselect-window' (Bug#11304). */
3017 && !(EQ (Qselect_window
, XCAR (c
)))))
3019 if (!NILP (echo_area_buffer
[0]))
3021 safe_run_hooks (Qecho_area_clear_hook
);
3022 clear_message (1, 0);
3026 reread_for_input_method
:
3028 /* Pass this to the input method, if appropriate. */
3030 && ! NILP (Vinput_method_function
)
3031 /* Don't run the input method within a key sequence,
3032 after the first event of the key sequence. */
3033 && NILP (prev_event
)
3034 && ' ' <= XINT (c
) && XINT (c
) < 256 && XINT (c
) != 127)
3037 ptrdiff_t key_count
;
3038 bool key_count_reset
;
3039 ptrdiff_t command_key_start
;
3040 struct gcpro gcpro1
;
3041 ptrdiff_t count
= SPECPDL_INDEX ();
3043 /* Save the echo status. */
3044 bool saved_immediate_echo
= current_kboard
->immediate_echo
;
3045 struct kboard
*saved_ok_to_echo
= ok_to_echo_at_next_pause
;
3046 Lisp_Object saved_echo_string
= KVAR (current_kboard
, echo_string
);
3047 ptrdiff_t saved_echo_after_prompt
= current_kboard
->echo_after_prompt
;
3050 if (before_command_restore_flag
)
3052 this_command_key_count
= before_command_key_count_1
;
3053 if (this_command_key_count
< this_single_command_key_start
)
3054 this_single_command_key_start
= this_command_key_count
;
3055 echo_truncate (before_command_echo_length_1
);
3056 before_command_restore_flag
= 0;
3060 /* Save the this_command_keys status. */
3061 key_count
= this_command_key_count
;
3062 key_count_reset
= this_command_key_count_reset
;
3063 command_key_start
= this_single_command_key_start
;
3066 keys
= Fcopy_sequence (this_command_keys
);
3071 /* Clear out this_command_keys. */
3072 this_command_key_count
= 0;
3073 this_command_key_count_reset
= 0;
3074 this_single_command_key_start
= 0;
3076 /* Now wipe the echo area. */
3077 if (!NILP (echo_area_buffer
[0]))
3078 safe_run_hooks (Qecho_area_clear_hook
);
3079 clear_message (1, 0);
3082 /* If we are not reading a key sequence,
3083 never use the echo area. */
3086 specbind (Qinput_method_use_echo_area
, Qt
);
3089 /* Call the input method. */
3090 tem
= call1 (Vinput_method_function
, c
);
3092 tem
= unbind_to (count
, tem
);
3094 /* Restore the saved echoing state
3095 and this_command_keys state. */
3096 this_command_key_count
= key_count
;
3097 this_command_key_count_reset
= key_count_reset
;
3098 this_single_command_key_start
= command_key_start
;
3100 this_command_keys
= keys
;
3103 ok_to_echo_at_next_pause
= saved_ok_to_echo
;
3104 /* Do not restore the echo area string when the user is
3105 introducing a prefix argument. Otherwise we end with
3106 repetitions of the partially introduced prefix
3107 argument. (bug#19875) */
3108 if (NILP (intern ("prefix-arg")))
3110 kset_echo_string (current_kboard
, saved_echo_string
);
3112 current_kboard
->echo_after_prompt
= saved_echo_after_prompt
;
3113 if (saved_immediate_echo
)
3118 /* The input method can return no events. */
3121 /* Bring back the previous message, if any. */
3122 if (! NILP (previous_echo_area_message
))
3123 message_with_string ("%s", previous_echo_area_message
, 0);
3126 /* It returned one event or more. */
3128 Vunread_post_input_method_events
3129 = nconc2 (XCDR (tem
), Vunread_post_input_method_events
);
3134 /* Display help if not echoing. */
3135 if (CONSP (c
) && EQ (XCAR (c
), Qhelp_echo
))
3137 /* (help-echo FRAME HELP WINDOW OBJECT POS). */
3138 Lisp_Object help
, object
, position
, window
, htem
;
3140 htem
= Fcdr (XCDR (c
));
3143 window
= Fcar (htem
);
3145 object
= Fcar (htem
);
3147 position
= Fcar (htem
);
3149 show_help_echo (help
, window
, object
, position
);
3151 /* We stopped being idle for this event; undo that. */
3153 timer_resume_idle ();
3157 if ((! reread
|| this_command_key_count
== 0
3158 || this_command_key_count_reset
)
3162 /* Don't echo mouse motion events. */
3163 if (echo_keystrokes_p ()
3164 && ! (EVENT_HAS_PARAMETERS (c
)
3165 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
3168 if (! NILP (also_record
))
3169 echo_char (also_record
);
3170 /* Once we reread a character, echoing can happen
3171 the next time we pause to read a new one. */
3172 ok_to_echo_at_next_pause
= current_kboard
;
3175 /* Record this character as part of the current key. */
3176 add_command_key (c
);
3177 if (! NILP (also_record
))
3178 add_command_key (also_record
);
3181 last_input_event
= c
;
3184 /* Process the help character specially if enabled. */
3185 if (!NILP (Vhelp_form
) && help_char_p (c
))
3187 ptrdiff_t count
= SPECPDL_INDEX ();
3189 help_form_saved_window_configs
3190 = Fcons (Fcurrent_window_configuration (Qnil
),
3191 help_form_saved_window_configs
);
3192 record_unwind_protect_void (read_char_help_form_unwind
);
3193 call0 (Qhelp_form_show
);
3198 c
= read_char (0, Qnil
, Qnil
, 0, NULL
);
3199 if (EVENT_HAS_PARAMETERS (c
)
3200 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_click
))
3201 XSETCAR (help_form_saved_window_configs
, Qnil
);
3203 while (BUFFERP (c
));
3204 /* Remove the help from the frame. */
3205 unbind_to (count
, Qnil
);
3208 if (EQ (c
, make_number (040)))
3212 c
= read_char (0, Qnil
, Qnil
, 0, NULL
);
3213 while (BUFFERP (c
));
3219 input_was_pending
= input_pending
;
3223 /* Record a key that came from a mouse menu.
3224 Record it for echoing, for this-command-keys, and so on. */
3227 record_menu_key (Lisp_Object c
)
3229 /* Wipe the echo area. */
3230 clear_message (1, 0);
3235 before_command_key_count
= this_command_key_count
;
3236 before_command_echo_length
= echo_length ();
3239 /* Don't echo mouse motion events. */
3240 if (echo_keystrokes_p ())
3244 /* Once we reread a character, echoing can happen
3245 the next time we pause to read a new one. */
3246 ok_to_echo_at_next_pause
= 0;
3249 /* Record this character as part of the current key. */
3250 add_command_key (c
);
3252 /* Re-reading in the middle of a command. */
3253 last_input_event
= c
;
3257 /* Return true if should recognize C as "the help character". */
3260 help_char_p (Lisp_Object c
)
3264 if (EQ (c
, Vhelp_char
))
3266 for (tail
= Vhelp_event_list
; CONSP (tail
); tail
= XCDR (tail
))
3267 if (EQ (c
, XCAR (tail
)))
3272 /* Record the input event C in various ways. */
3275 record_char (Lisp_Object c
)
3279 if (CONSP (c
) && (EQ (XCAR (c
), Qhelp_echo
) || EQ (XCAR (c
), Qmouse_movement
)))
3281 /* To avoid filling recent_keys with help-echo and mouse-movement
3282 events, we filter out repeated help-echo events, only store the
3283 first and last in a series of mouse-movement events, and don't
3284 store repeated help-echo events which are only separated by
3285 mouse-movement events. */
3287 Lisp_Object ev1
, ev2
, ev3
;
3290 if ((ix1
= recent_keys_index
- 1) < 0)
3291 ix1
= NUM_RECENT_KEYS
- 1;
3292 ev1
= AREF (recent_keys
, ix1
);
3294 if ((ix2
= ix1
- 1) < 0)
3295 ix2
= NUM_RECENT_KEYS
- 1;
3296 ev2
= AREF (recent_keys
, ix2
);
3298 if ((ix3
= ix2
- 1) < 0)
3299 ix3
= NUM_RECENT_KEYS
- 1;
3300 ev3
= AREF (recent_keys
, ix3
);
3302 if (EQ (XCAR (c
), Qhelp_echo
))
3304 /* Don't record `help-echo' in recent_keys unless it shows some help
3305 message, and a different help than the previously recorded
3307 Lisp_Object help
, last_help
;
3309 help
= Fcar_safe (Fcdr_safe (XCDR (c
)));
3310 if (!STRINGP (help
))
3312 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qhelp_echo
)
3313 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev1
))), EQ (last_help
, help
)))
3315 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3316 && CONSP (ev2
) && EQ (XCAR (ev2
), Qhelp_echo
)
3317 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev2
))), EQ (last_help
, help
)))
3319 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3320 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3321 && CONSP (ev3
) && EQ (XCAR (ev3
), Qhelp_echo
)
3322 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev3
))), EQ (last_help
, help
)))
3325 else if (EQ (XCAR (c
), Qmouse_movement
))
3327 /* Only record one pair of `mouse-movement' on a window in recent_keys.
3328 So additional mouse movement events replace the last element. */
3329 Lisp_Object last_window
, window
;
3331 window
= Fcar_safe (Fcar_safe (XCDR (c
)));
3332 if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3333 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev1
))), EQ (last_window
, window
))
3334 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3335 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev2
))), EQ (last_window
, window
)))
3337 ASET (recent_keys
, ix1
, c
);
3343 store_kbd_macro_char (c
);
3347 total_keys
+= total_keys
< NUM_RECENT_KEYS
;
3348 ASET (recent_keys
, recent_keys_index
, c
);
3349 if (++recent_keys_index
>= NUM_RECENT_KEYS
)
3350 recent_keys_index
= 0;
3352 else if (recorded
< 0)
3354 /* We need to remove one or two events from recent_keys.
3355 To do this, we simply put nil at those events and move the
3356 recent_keys_index backwards over those events. Usually,
3357 users will never see those nil events, as they will be
3358 overwritten by the command keys entered to see recent_keys
3361 while (recorded
++ < 0 && total_keys
> 0)
3363 if (total_keys
< NUM_RECENT_KEYS
)
3365 if (--recent_keys_index
< 0)
3366 recent_keys_index
= NUM_RECENT_KEYS
- 1;
3367 ASET (recent_keys
, recent_keys_index
, Qnil
);
3371 num_nonmacro_input_events
++;
3373 /* Write c to the dribble file. If c is a lispy event, write
3374 the event's symbol to the dribble file, in <brackets>. Bleaugh.
3375 If you, dear reader, have a better idea, you've got the source. :-) */
3381 if (XUINT (c
) < 0x100)
3382 putc (XUINT (c
), dribble
);
3384 fprintf (dribble
, " 0x%"pI
"x", XUINT (c
));
3388 Lisp_Object dribblee
;
3390 /* If it's a structured event, take the event header. */
3391 dribblee
= EVENT_HEAD (c
);
3393 if (SYMBOLP (dribblee
))
3395 putc ('<', dribble
);
3396 fwrite (SDATA (SYMBOL_NAME (dribblee
)), sizeof (char),
3397 SBYTES (SYMBOL_NAME (dribblee
)),
3399 putc ('>', dribble
);
3408 /* Copy out or in the info on where C-g should throw to.
3409 This is used when running Lisp code from within get_char,
3410 in case get_char is called recursively.
3411 See read_process_output. */
3414 save_getcjmp (sys_jmp_buf temp
)
3416 memcpy (temp
, getcjmp
, sizeof getcjmp
);
3420 restore_getcjmp (sys_jmp_buf temp
)
3422 memcpy (getcjmp
, temp
, sizeof getcjmp
);
3425 /* Low level keyboard/mouse input.
3426 kbd_buffer_store_event places events in kbd_buffer, and
3427 kbd_buffer_get_event retrieves them. */
3429 /* Return true if there are any events in the queue that read-char
3430 would return. If this returns false, a read-char would block. */
3432 readable_events (int flags
)
3434 if (flags
& READABLE_EVENTS_DO_TIMERS_NOW
)
3437 /* If the buffer contains only FOCUS_IN_EVENT events, and
3438 READABLE_EVENTS_FILTER_EVENTS is set, report it as empty. */
3439 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3441 if (flags
& (READABLE_EVENTS_FILTER_EVENTS
3442 #ifdef USE_TOOLKIT_SCROLL_BARS
3443 | READABLE_EVENTS_IGNORE_SQUEEZABLES
3447 struct input_event
*event
;
3449 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
3456 #ifdef USE_TOOLKIT_SCROLL_BARS
3457 (flags
& READABLE_EVENTS_FILTER_EVENTS
) &&
3459 event
->kind
== FOCUS_IN_EVENT
)
3460 #ifdef USE_TOOLKIT_SCROLL_BARS
3461 && !((flags
& READABLE_EVENTS_IGNORE_SQUEEZABLES
)
3462 && (event
->kind
== SCROLL_BAR_CLICK_EVENT
3463 || event
->kind
== HORIZONTAL_SCROLL_BAR_CLICK_EVENT
)
3464 && event
->part
== scroll_bar_handle
3465 && event
->modifiers
== 0)
3467 && !((flags
& READABLE_EVENTS_FILTER_EVENTS
)
3468 && event
->kind
== BUFFER_SWITCH_EVENT
))
3471 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3474 while (event
!= kbd_store_ptr
);
3480 if (!(flags
& READABLE_EVENTS_IGNORE_SQUEEZABLES
)
3481 && !NILP (do_mouse_tracking
) && some_mouse_moved ())
3485 if (current_kboard
->kbd_queue_has_data
)
3491 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
3492 if (kb
->kbd_queue_has_data
)
3498 /* Set this for debugging, to have a way to get out */
3499 int stop_character EXTERNALLY_VISIBLE
;
3502 event_to_kboard (struct input_event
*event
)
3504 /* Not applicable for these special events. */
3505 if (event
->kind
== SELECTION_REQUEST_EVENT
3506 || event
->kind
== SELECTION_CLEAR_EVENT
)
3510 Lisp_Object obj
= event
->frame_or_window
;
3511 /* There are some events that set this field to nil or string. */
3513 obj
= WINDOW_FRAME (XWINDOW (obj
));
3514 /* Also ignore dead frames here. */
3515 return ((FRAMEP (obj
) && FRAME_LIVE_P (XFRAME (obj
)))
3516 ? FRAME_KBOARD (XFRAME (obj
)) : NULL
);
3521 /* Return the number of slots occupied in kbd_buffer. */
3524 kbd_buffer_nr_stored (void)
3526 return kbd_fetch_ptr
== kbd_store_ptr
3528 : (kbd_fetch_ptr
< kbd_store_ptr
3529 ? kbd_store_ptr
- kbd_fetch_ptr
3530 : ((kbd_buffer
+ KBD_BUFFER_SIZE
) - kbd_fetch_ptr
3531 + (kbd_store_ptr
- kbd_buffer
)));
3533 #endif /* Store an event obtained at interrupt level into kbd_buffer, fifo */
3536 kbd_buffer_store_event (register struct input_event
*event
)
3538 kbd_buffer_store_event_hold (event
, 0);
3541 /* Store EVENT obtained at interrupt level into kbd_buffer, fifo.
3543 If HOLD_QUIT is 0, just stuff EVENT into the fifo.
3544 Else, if HOLD_QUIT.kind != NO_EVENT, discard EVENT.
3545 Else, if EVENT is a quit event, store the quit event
3546 in HOLD_QUIT, and return (thus ignoring further events).
3548 This is used to postpone the processing of the quit event until all
3549 subsequent input events have been parsed (and discarded). */
3552 kbd_buffer_store_event_hold (register struct input_event
*event
,
3553 struct input_event
*hold_quit
)
3555 if (event
->kind
== NO_EVENT
)
3558 if (hold_quit
&& hold_quit
->kind
!= NO_EVENT
)
3561 if (event
->kind
== ASCII_KEYSTROKE_EVENT
)
3563 register int c
= event
->code
& 0377;
3565 if (event
->modifiers
& ctrl_modifier
)
3566 c
= make_ctrl_char (c
);
3568 c
|= (event
->modifiers
3569 & (meta_modifier
| alt_modifier
3570 | hyper_modifier
| super_modifier
));
3574 KBOARD
*kb
= FRAME_KBOARD (XFRAME (event
->frame_or_window
));
3575 struct input_event
*sp
;
3577 if (single_kboard
&& kb
!= current_kboard
)
3580 (kb
, list2 (make_lispy_switch_frame (event
->frame_or_window
),
3582 kb
->kbd_queue_has_data
= 1;
3583 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3585 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3588 if (event_to_kboard (sp
) == kb
)
3590 sp
->kind
= NO_EVENT
;
3591 sp
->frame_or_window
= Qnil
;
3600 *hold_quit
= *event
;
3604 /* If this results in a quit_char being returned to Emacs as
3605 input, set Vlast_event_frame properly. If this doesn't
3606 get returned to Emacs as an event, the next event read
3607 will set Vlast_event_frame again, so this is safe to do. */
3611 focus
= FRAME_FOCUS_FRAME (XFRAME (event
->frame_or_window
));
3613 focus
= event
->frame_or_window
;
3614 internal_last_event_frame
= focus
;
3615 Vlast_event_frame
= focus
;
3618 handle_interrupt (0);
3622 if (c
&& c
== stop_character
)
3628 /* Don't insert two BUFFER_SWITCH_EVENT's in a row.
3629 Just ignore the second one. */
3630 else if (event
->kind
== BUFFER_SWITCH_EVENT
3631 && kbd_fetch_ptr
!= kbd_store_ptr
3632 && ((kbd_store_ptr
== kbd_buffer
3633 ? kbd_buffer
+ KBD_BUFFER_SIZE
- 1
3634 : kbd_store_ptr
- 1)->kind
) == BUFFER_SWITCH_EVENT
)
3637 if (kbd_store_ptr
- kbd_buffer
== KBD_BUFFER_SIZE
)
3638 kbd_store_ptr
= kbd_buffer
;
3640 /* Don't let the very last slot in the buffer become full,
3641 since that would make the two pointers equal,
3642 and that is indistinguishable from an empty buffer.
3643 Discard the event if it would fill the last slot. */
3644 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
3646 *kbd_store_ptr
= *event
;
3649 if (kbd_buffer_nr_stored () > KBD_BUFFER_SIZE
/ 2
3650 && ! kbd_on_hold_p ())
3652 /* Don't read keyboard input until we have processed kbd_buffer.
3653 This happens when pasting text longer than KBD_BUFFER_SIZE/2. */
3654 hold_keyboard_input ();
3655 if (!noninteractive
)
3659 #endif /* subprocesses */
3662 /* If we're inside while-no-input, and this event qualifies
3663 as input, set quit-flag to cause an interrupt. */
3664 if (!NILP (Vthrow_on_input
)
3665 && event
->kind
!= FOCUS_IN_EVENT
3666 && event
->kind
!= FOCUS_OUT_EVENT
3667 && event
->kind
!= HELP_EVENT
3668 && event
->kind
!= ICONIFY_EVENT
3669 && event
->kind
!= DEICONIFY_EVENT
)
3671 Vquit_flag
= Vthrow_on_input
;
3672 /* If we're inside a function that wants immediate quits,
3674 if (immediate_quit
&& NILP (Vinhibit_quit
))
3683 /* Put an input event back in the head of the event queue. */
3686 kbd_buffer_unget_event (register struct input_event
*event
)
3688 if (kbd_fetch_ptr
== kbd_buffer
)
3689 kbd_fetch_ptr
= kbd_buffer
+ KBD_BUFFER_SIZE
;
3691 /* Don't let the very last slot in the buffer become full, */
3692 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
3695 *kbd_fetch_ptr
= *event
;
3699 /* Limit help event positions to this range, to avoid overflow problems. */
3700 #define INPUT_EVENT_POS_MAX \
3701 ((ptrdiff_t) min (PTRDIFF_MAX, min (TYPE_MAXIMUM (Time) / 2, \
3702 MOST_POSITIVE_FIXNUM)))
3703 #define INPUT_EVENT_POS_MIN (-1 - INPUT_EVENT_POS_MAX)
3705 /* Return a Time that encodes position POS. POS must be in range. */
3708 position_to_Time (ptrdiff_t pos
)
3710 eassert (INPUT_EVENT_POS_MIN
<= pos
&& pos
<= INPUT_EVENT_POS_MAX
);
3714 /* Return the position that ENCODED_POS encodes.
3715 Avoid signed integer overflow. */
3718 Time_to_position (Time encoded_pos
)
3720 if (encoded_pos
<= INPUT_EVENT_POS_MAX
)
3722 Time encoded_pos_min
= INPUT_EVENT_POS_MIN
;
3723 eassert (encoded_pos_min
<= encoded_pos
);
3724 ptrdiff_t notpos
= -1 - encoded_pos
;
3728 /* Generate a HELP_EVENT input_event and store it in the keyboard
3731 HELP is the help form.
3733 FRAME and WINDOW are the frame and window where the help is
3734 generated. OBJECT is the Lisp object where the help was found (a
3735 buffer, a string, an overlay, or nil if neither from a string nor
3736 from a buffer). POS is the position within OBJECT where the help
3740 gen_help_event (Lisp_Object help
, Lisp_Object frame
, Lisp_Object window
,
3741 Lisp_Object object
, ptrdiff_t pos
)
3743 struct input_event event
;
3745 event
.kind
= HELP_EVENT
;
3746 event
.frame_or_window
= frame
;
3748 event
.x
= WINDOWP (window
) ? window
: frame
;
3750 event
.timestamp
= position_to_Time (pos
);
3751 kbd_buffer_store_event (&event
);
3755 /* Store HELP_EVENTs for HELP on FRAME in the input queue. */
3758 kbd_buffer_store_help_event (Lisp_Object frame
, Lisp_Object help
)
3760 struct input_event event
;
3762 event
.kind
= HELP_EVENT
;
3763 event
.frame_or_window
= frame
;
3767 event
.timestamp
= 0;
3768 kbd_buffer_store_event (&event
);
3772 /* Discard any mouse events in the event buffer by setting them to
3775 discard_mouse_events (void)
3777 struct input_event
*sp
;
3778 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3780 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3783 if (sp
->kind
== MOUSE_CLICK_EVENT
3784 || sp
->kind
== WHEEL_EVENT
3785 || sp
->kind
== HORIZ_WHEEL_EVENT
3787 || sp
->kind
== GPM_CLICK_EVENT
3789 || sp
->kind
== SCROLL_BAR_CLICK_EVENT
3790 || sp
->kind
== HORIZONTAL_SCROLL_BAR_CLICK_EVENT
)
3792 sp
->kind
= NO_EVENT
;
3798 /* Return true if there are any real events waiting in the event
3799 buffer, not counting `NO_EVENT's.
3801 Discard NO_EVENT events at the front of the input queue, possibly
3802 leaving the input queue empty if there are no real input events. */
3805 kbd_buffer_events_waiting (void)
3807 struct input_event
*sp
;
3809 for (sp
= kbd_fetch_ptr
;
3810 sp
!= kbd_store_ptr
&& sp
->kind
== NO_EVENT
;
3813 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3818 return sp
!= kbd_store_ptr
&& sp
->kind
!= NO_EVENT
;
3822 /* Clear input event EVENT. */
3825 clear_event (struct input_event
*event
)
3827 event
->kind
= NO_EVENT
;
3831 /* Read one event from the event buffer, waiting if necessary.
3832 The value is a Lisp object representing the event.
3833 The value is nil for an event that should be ignored,
3834 or that was handled here.
3835 We always read and discard one event. */
3838 kbd_buffer_get_event (KBOARD
**kbp
,
3839 bool *used_mouse_menu
,
3840 struct timespec
*end_time
)
3845 if (kbd_on_hold_p () && kbd_buffer_nr_stored () < KBD_BUFFER_SIZE
/ 4)
3847 /* Start reading input again because we have processed enough to
3848 be able to accept new events again. */
3849 unhold_keyboard_input ();
3852 #endif /* subprocesses */
3854 #if !defined HAVE_DBUS && !defined USE_FILE_NOTIFY
3856 /* In case we are running as a daemon, only do this before
3857 detaching from the terminal. */
3858 || (IS_DAEMON
&& DAEMON_RUNNING
))
3862 *kbp
= current_kboard
;
3865 #endif /* !defined HAVE_DBUS && !defined USE_FILE_NOTIFY */
3867 /* Wait until there is input available. */
3870 /* Break loop if there's an unread command event. Needed in
3871 moused window autoselection which uses a timer to insert such
3873 if (CONSP (Vunread_command_events
))
3876 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3878 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3881 /* If the quit flag is set, then read_char will return
3882 quit_char, so that counts as "available input." */
3883 if (!NILP (Vquit_flag
))
3884 quit_throw_to_read_char (0);
3886 /* One way or another, wait until input is available; then, if
3887 interrupt handlers have not read it, read it now. */
3892 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3894 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3898 struct timespec now
= current_timespec ();
3899 if (timespec_cmp (*end_time
, now
) <= 0)
3900 return Qnil
; /* Finished waiting. */
3903 struct timespec duration
= timespec_sub (*end_time
, now
);
3904 wait_reading_process_output (min (duration
.tv_sec
,
3907 -1, 1, Qnil
, NULL
, 0);
3912 bool do_display
= true;
3914 if (FRAME_TERMCAP_P (SELECTED_FRAME ()))
3916 struct tty_display_info
*tty
= CURTTY ();
3918 /* When this TTY is displaying a menu, we must prevent
3919 any redisplay, because we modify the frame's glyph
3920 matrix behind the back of the display engine. */
3921 if (tty
->showing_menu
)
3925 wait_reading_process_output (0, 0, -1, do_display
, Qnil
, NULL
, 0);
3928 if (!interrupt_input
&& kbd_fetch_ptr
== kbd_store_ptr
)
3932 if (CONSP (Vunread_command_events
))
3935 first
= XCAR (Vunread_command_events
);
3936 Vunread_command_events
= XCDR (Vunread_command_events
);
3937 *kbp
= current_kboard
;
3941 /* At this point, we know that there is a readable event available
3942 somewhere. If the event queue is empty, then there must be a
3943 mouse movement enabled and available. */
3944 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3946 struct input_event
*event
;
3948 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
3952 *kbp
= event_to_kboard (event
);
3954 *kbp
= current_kboard
; /* Better than returning null ptr? */
3958 /* These two kinds of events get special handling
3959 and don't actually appear to the command loop.
3960 We return nil for them. */
3961 if (event
->kind
== SELECTION_REQUEST_EVENT
3962 || event
->kind
== SELECTION_CLEAR_EVENT
)
3965 struct input_event copy
;
3967 /* Remove it from the buffer before processing it,
3968 since otherwise swallow_events will see it
3969 and process it again. */
3971 kbd_fetch_ptr
= event
+ 1;
3972 input_pending
= readable_events (0);
3973 x_handle_selection_event (©
);
3975 /* We're getting selection request events, but we don't have
3981 #if defined (HAVE_NS)
3982 else if (event
->kind
== NS_TEXT_EVENT
)
3984 if (event
->code
== KEY_NS_PUT_WORKING_TEXT
)
3985 obj
= list1 (intern ("ns-put-working-text"));
3987 obj
= list1 (intern ("ns-unput-working-text"));
3988 kbd_fetch_ptr
= event
+ 1;
3989 if (used_mouse_menu
)
3990 *used_mouse_menu
= 1;
3994 #if defined (HAVE_X11) || defined (HAVE_NTGUI) \
3995 || defined (HAVE_NS)
3996 else if (event
->kind
== DELETE_WINDOW_EVENT
)
3998 /* Make an event (delete-frame (FRAME)). */
3999 obj
= list2 (Qdelete_frame
, list1 (event
->frame_or_window
));
4000 kbd_fetch_ptr
= event
+ 1;
4003 #if defined (HAVE_X11) || defined (HAVE_NTGUI) \
4004 || defined (HAVE_NS)
4005 else if (event
->kind
== ICONIFY_EVENT
)
4007 /* Make an event (iconify-frame (FRAME)). */
4008 obj
= list2 (Qiconify_frame
, list1 (event
->frame_or_window
));
4009 kbd_fetch_ptr
= event
+ 1;
4011 else if (event
->kind
== DEICONIFY_EVENT
)
4013 /* Make an event (make-frame-visible (FRAME)). */
4014 obj
= list2 (Qmake_frame_visible
, list1 (event
->frame_or_window
));
4015 kbd_fetch_ptr
= event
+ 1;
4018 else if (event
->kind
== BUFFER_SWITCH_EVENT
)
4020 /* The value doesn't matter here; only the type is tested. */
4021 XSETBUFFER (obj
, current_buffer
);
4022 kbd_fetch_ptr
= event
+ 1;
4024 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
4025 || defined (HAVE_NS) || defined (USE_GTK)
4026 else if (event
->kind
== MENU_BAR_ACTIVATE_EVENT
)
4028 kbd_fetch_ptr
= event
+ 1;
4029 input_pending
= readable_events (0);
4030 if (FRAME_LIVE_P (XFRAME (event
->frame_or_window
)))
4031 x_activate_menubar (XFRAME (event
->frame_or_window
));
4035 else if (event
->kind
== LANGUAGE_CHANGE_EVENT
)
4037 /* Make an event (language-change FRAME CODEPAGE LANGUAGE-ID). */
4038 obj
= list4 (Qlanguage_change
,
4039 event
->frame_or_window
,
4040 make_number (event
->code
),
4041 make_number (event
->modifiers
));
4042 kbd_fetch_ptr
= event
+ 1;
4045 #ifdef USE_FILE_NOTIFY
4046 else if (event
->kind
== FILE_NOTIFY_EVENT
)
4048 #ifdef HAVE_W32NOTIFY
4049 /* Make an event (file-notify (DESCRIPTOR ACTION FILE) CALLBACK). */
4050 obj
= list3 (Qfile_notify
, event
->arg
, event
->frame_or_window
);
4052 obj
= make_lispy_event (event
);
4054 kbd_fetch_ptr
= event
+ 1;
4056 #endif /* USE_FILE_NOTIFY */
4057 else if (event
->kind
== SAVE_SESSION_EVENT
)
4059 obj
= list2 (Qsave_session
, event
->arg
);
4060 kbd_fetch_ptr
= event
+ 1;
4062 /* Just discard these, by returning nil.
4063 With MULTI_KBOARD, these events are used as placeholders
4064 when we need to randomly delete events from the queue.
4065 (They shouldn't otherwise be found in the buffer,
4066 but on some machines it appears they do show up
4067 even without MULTI_KBOARD.) */
4068 /* On Windows NT/9X, NO_EVENT is used to delete extraneous
4069 mouse events during a popup-menu call. */
4070 else if (event
->kind
== NO_EVENT
)
4071 kbd_fetch_ptr
= event
+ 1;
4072 else if (event
->kind
== HELP_EVENT
)
4074 Lisp_Object object
, position
, help
, frame
, window
;
4076 frame
= event
->frame_or_window
;
4077 object
= event
->arg
;
4078 position
= make_number (Time_to_position (event
->timestamp
));
4081 clear_event (event
);
4083 kbd_fetch_ptr
= event
+ 1;
4084 if (!WINDOWP (window
))
4086 obj
= Fcons (Qhelp_echo
,
4087 list5 (frame
, help
, window
, object
, position
));
4089 else if (event
->kind
== FOCUS_IN_EVENT
)
4091 /* Notification of a FocusIn event. The frame receiving the
4092 focus is in event->frame_or_window. Generate a
4093 switch-frame event if necessary. */
4094 Lisp_Object frame
, focus
;
4096 frame
= event
->frame_or_window
;
4097 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
4106 !EQ (frame
, internal_last_event_frame
)
4107 && !EQ (frame
, selected_frame
))
4108 obj
= make_lispy_switch_frame (frame
);
4110 obj
= make_lispy_focus_in (frame
);
4112 internal_last_event_frame
= frame
;
4113 kbd_fetch_ptr
= event
+ 1;
4115 else if (event
->kind
== FOCUS_OUT_EVENT
)
4117 #ifdef HAVE_WINDOW_SYSTEM
4120 Lisp_Object frame
= event
->frame_or_window
;
4121 bool focused
= false;
4123 for (di
= x_display_list
; di
&& ! focused
; di
= di
->next
)
4124 focused
= di
->x_highlight_frame
!= 0;
4127 obj
= make_lispy_focus_out (frame
);
4129 #endif /* HAVE_WINDOW_SYSTEM */
4131 kbd_fetch_ptr
= event
+ 1;
4134 else if (event
->kind
== DBUS_EVENT
)
4136 obj
= make_lispy_event (event
);
4137 kbd_fetch_ptr
= event
+ 1;
4140 else if (event
->kind
== CONFIG_CHANGED_EVENT
)
4142 obj
= make_lispy_event (event
);
4143 kbd_fetch_ptr
= event
+ 1;
4147 /* If this event is on a different frame, return a switch-frame this
4148 time, and leave the event in the queue for next time. */
4152 frame
= event
->frame_or_window
;
4154 frame
= XCAR (frame
);
4155 else if (WINDOWP (frame
))
4156 frame
= WINDOW_FRAME (XWINDOW (frame
));
4158 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
4162 if (! EQ (frame
, internal_last_event_frame
)
4163 && !EQ (frame
, selected_frame
))
4164 obj
= make_lispy_switch_frame (frame
);
4165 internal_last_event_frame
= frame
;
4167 /* If we didn't decide to make a switch-frame event, go ahead
4168 and build a real event from the queue entry. */
4172 obj
= make_lispy_event (event
);
4174 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
4175 || defined (HAVE_NS) || defined (USE_GTK)
4176 /* If this was a menu selection, then set the flag to inhibit
4177 writing to last_nonmenu_event. Don't do this if the event
4178 we're returning is (menu-bar), though; that indicates the
4179 beginning of the menu sequence, and we might as well leave
4180 that as the `event with parameters' for this selection. */
4182 && !EQ (event
->frame_or_window
, event
->arg
)
4183 && (event
->kind
== MENU_BAR_EVENT
4184 || event
->kind
== TOOL_BAR_EVENT
))
4185 *used_mouse_menu
= 1;
4188 /* Certain system events are non-key events. */
4190 && event
->kind
== NS_NONKEY_EVENT
)
4191 *used_mouse_menu
= 1;
4194 /* Wipe out this event, to catch bugs. */
4195 clear_event (event
);
4196 kbd_fetch_ptr
= event
+ 1;
4200 /* Try generating a mouse motion event. */
4201 else if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
4203 struct frame
*f
= some_mouse_moved ();
4204 Lisp_Object bar_window
;
4205 enum scroll_bar_part part
;
4209 *kbp
= current_kboard
;
4210 /* Note that this uses F to determine which terminal to look at.
4211 If there is no valid info, it does not store anything
4212 so x remains nil. */
4215 /* XXX Can f or mouse_position_hook be NULL here? */
4216 if (f
&& FRAME_TERMINAL (f
)->mouse_position_hook
)
4217 (*FRAME_TERMINAL (f
)->mouse_position_hook
) (&f
, 0, &bar_window
,
4222 /* Decide if we should generate a switch-frame event. Don't
4223 generate switch-frame events for motion outside of all Emacs
4229 frame
= FRAME_FOCUS_FRAME (f
);
4231 XSETFRAME (frame
, f
);
4233 if (! EQ (frame
, internal_last_event_frame
)
4234 && !EQ (frame
, selected_frame
))
4235 obj
= make_lispy_switch_frame (frame
);
4236 internal_last_event_frame
= frame
;
4239 /* If we didn't decide to make a switch-frame event, go ahead and
4240 return a mouse-motion event. */
4241 if (!NILP (x
) && NILP (obj
))
4242 obj
= make_lispy_movement (f
, bar_window
, part
, x
, y
, t
);
4245 /* We were promised by the above while loop that there was
4246 something for us to read! */
4249 input_pending
= readable_events (0);
4251 Vlast_event_frame
= internal_last_event_frame
;
4256 /* Process any non-user-visible events (currently X selection events),
4257 without reading any user-visible events. */
4260 process_special_events (void)
4262 struct input_event
*event
;
4264 for (event
= kbd_fetch_ptr
; event
!= kbd_store_ptr
; ++event
)
4266 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
4269 if (event
== kbd_store_ptr
)
4273 /* If we find a stored X selection request, handle it now. */
4274 if (event
->kind
== SELECTION_REQUEST_EVENT
4275 || event
->kind
== SELECTION_CLEAR_EVENT
)
4279 /* Remove the event from the fifo buffer before processing;
4280 otherwise swallow_events called recursively could see it
4281 and process it again. To do this, we move the events
4282 between kbd_fetch_ptr and EVENT one slot to the right,
4285 struct input_event copy
= *event
;
4286 struct input_event
*beg
4287 = (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
4288 ? kbd_buffer
: kbd_fetch_ptr
;
4291 memmove (beg
+ 1, beg
, (event
- beg
) * sizeof (struct input_event
));
4292 else if (event
< beg
)
4294 if (event
> kbd_buffer
)
4295 memmove (kbd_buffer
+ 1, kbd_buffer
,
4296 (event
- kbd_buffer
) * sizeof (struct input_event
));
4297 *kbd_buffer
= *(kbd_buffer
+ KBD_BUFFER_SIZE
- 1);
4298 if (beg
< kbd_buffer
+ KBD_BUFFER_SIZE
- 1)
4299 memmove (beg
+ 1, beg
,
4300 (kbd_buffer
+ KBD_BUFFER_SIZE
- 1 - beg
)
4301 * sizeof (struct input_event
));
4304 if (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
4305 kbd_fetch_ptr
= kbd_buffer
+ 1;
4309 input_pending
= readable_events (0);
4310 x_handle_selection_event (©
);
4312 /* We're getting selection request events, but we don't have
4320 /* Process any events that are not user-visible, run timer events that
4321 are ripe, and return, without reading any user-visible events. */
4324 swallow_events (bool do_display
)
4326 unsigned old_timers_run
;
4328 process_special_events ();
4330 old_timers_run
= timers_run
;
4331 get_input_pending (READABLE_EVENTS_DO_TIMERS_NOW
);
4333 if (!input_pending
&& timers_run
!= old_timers_run
&& do_display
)
4334 redisplay_preserve_echo_area (7);
4337 /* Record the start of when Emacs is idle,
4338 for the sake of running idle-time timers. */
4341 timer_start_idle (void)
4343 /* If we are already in the idle state, do nothing. */
4344 if (timespec_valid_p (timer_idleness_start_time
))
4347 timer_idleness_start_time
= current_timespec ();
4348 timer_last_idleness_start_time
= timer_idleness_start_time
;
4350 /* Mark all idle-time timers as once again candidates for running. */
4351 call0 (intern ("internal-timer-start-idle"));
4354 /* Record that Emacs is no longer idle, so stop running idle-time timers. */
4357 timer_stop_idle (void)
4359 timer_idleness_start_time
= invalid_timespec ();
4362 /* Resume idle timer from last idle start time. */
4365 timer_resume_idle (void)
4367 if (timespec_valid_p (timer_idleness_start_time
))
4370 timer_idleness_start_time
= timer_last_idleness_start_time
;
4373 /* This is only for debugging. */
4374 struct input_event last_timer_event EXTERNALLY_VISIBLE
;
4376 /* List of elisp functions to call, delayed because they were generated in
4377 a context where Elisp could not be safely run (e.g. redisplay, signal,
4378 ...). Each element has the form (FUN . ARGS). */
4379 Lisp_Object pending_funcalls
;
4381 /* Return true if TIMER is a valid timer, placing its value into *RESULT. */
4383 decode_timer (Lisp_Object timer
, struct timespec
*result
)
4387 if (! (VECTORP (timer
) && ASIZE (timer
) == 9))
4389 vec
= XVECTOR (timer
)->contents
;
4390 if (! NILP (vec
[0]))
4392 if (! INTEGERP (vec
[2]))
4396 if (decode_time_components (vec
[1], vec
[2], vec
[3], vec
[8], &t
, 0) <= 0)
4398 *result
= lisp_to_timespec (t
);
4399 return timespec_valid_p (*result
);
4403 /* Check whether a timer has fired. To prevent larger problems we simply
4404 disregard elements that are not proper timers. Do not make a circular
4405 timer list for the time being.
4407 Returns the time to wait until the next timer fires. If a
4408 timer is triggering now, return zero.
4409 If no timer is active, return -1.
4411 If a timer is ripe, we run it, with quitting turned off.
4412 In that case we return 0 to indicate that a new timer_check_2 call
4415 static struct timespec
4416 timer_check_2 (Lisp_Object timers
, Lisp_Object idle_timers
)
4418 struct timespec nexttime
;
4419 struct timespec now
;
4420 struct timespec idleness_now
;
4421 Lisp_Object chosen_timer
;
4422 struct gcpro gcpro1
;
4424 nexttime
= invalid_timespec ();
4426 chosen_timer
= Qnil
;
4427 GCPRO1 (chosen_timer
);
4429 /* First run the code that was delayed. */
4430 while (CONSP (pending_funcalls
))
4432 Lisp_Object funcall
= XCAR (pending_funcalls
);
4433 pending_funcalls
= XCDR (pending_funcalls
);
4434 safe_call2 (Qapply
, XCAR (funcall
), XCDR (funcall
));
4437 if (CONSP (timers
) || CONSP (idle_timers
))
4439 now
= current_timespec ();
4440 idleness_now
= (timespec_valid_p (timer_idleness_start_time
)
4441 ? timespec_sub (now
, timer_idleness_start_time
)
4442 : make_timespec (0, 0));
4445 while (CONSP (timers
) || CONSP (idle_timers
))
4447 Lisp_Object timer
= Qnil
, idle_timer
= Qnil
;
4448 struct timespec timer_time
, idle_timer_time
;
4449 struct timespec difference
;
4450 struct timespec timer_difference
= invalid_timespec ();
4451 struct timespec idle_timer_difference
= invalid_timespec ();
4452 bool ripe
, timer_ripe
= 0, idle_timer_ripe
= 0;
4454 /* Set TIMER and TIMER_DIFFERENCE
4455 based on the next ordinary timer.
4456 TIMER_DIFFERENCE is the distance in time from NOW to when
4457 this timer becomes ripe.
4458 Skip past invalid timers and timers already handled. */
4461 timer
= XCAR (timers
);
4462 if (! decode_timer (timer
, &timer_time
))
4464 timers
= XCDR (timers
);
4468 timer_ripe
= timespec_cmp (timer_time
, now
) <= 0;
4469 timer_difference
= (timer_ripe
4470 ? timespec_sub (now
, timer_time
)
4471 : timespec_sub (timer_time
, now
));
4474 /* Likewise for IDLE_TIMER and IDLE_TIMER_DIFFERENCE
4475 based on the next idle timer. */
4476 if (CONSP (idle_timers
))
4478 idle_timer
= XCAR (idle_timers
);
4479 if (! decode_timer (idle_timer
, &idle_timer_time
))
4481 idle_timers
= XCDR (idle_timers
);
4485 idle_timer_ripe
= timespec_cmp (idle_timer_time
, idleness_now
) <= 0;
4486 idle_timer_difference
4488 ? timespec_sub (idleness_now
, idle_timer_time
)
4489 : timespec_sub (idle_timer_time
, idleness_now
));
4492 /* Decide which timer is the next timer,
4493 and set CHOSEN_TIMER, DIFFERENCE, and RIPE accordingly.
4494 Also step down the list where we found that timer. */
4496 if (timespec_valid_p (timer_difference
)
4497 && (! timespec_valid_p (idle_timer_difference
)
4498 || idle_timer_ripe
< timer_ripe
4499 || (idle_timer_ripe
== timer_ripe
4501 ? timespec_cmp (idle_timer_difference
,
4503 : timespec_cmp (timer_difference
,
4504 idle_timer_difference
))
4507 chosen_timer
= timer
;
4508 timers
= XCDR (timers
);
4509 difference
= timer_difference
;
4514 chosen_timer
= idle_timer
;
4515 idle_timers
= XCDR (idle_timers
);
4516 difference
= idle_timer_difference
;
4517 ripe
= idle_timer_ripe
;
4520 /* If timer is ripe, run it if it hasn't been run. */
4523 if (NILP (AREF (chosen_timer
, 0)))
4525 ptrdiff_t count
= SPECPDL_INDEX ();
4526 Lisp_Object old_deactivate_mark
= Vdeactivate_mark
;
4528 /* Mark the timer as triggered to prevent problems if the lisp
4529 code fails to reschedule it right. */
4530 ASET (chosen_timer
, 0, Qt
);
4532 specbind (Qinhibit_quit
, Qt
);
4534 call1 (Qtimer_event_handler
, chosen_timer
);
4535 Vdeactivate_mark
= old_deactivate_mark
;
4537 unbind_to (count
, Qnil
);
4539 /* Since we have handled the event,
4540 we don't need to tell the caller to wake up and do it. */
4541 /* But the caller must still wait for the next timer, so
4542 return 0 to indicate that. */
4545 nexttime
= make_timespec (0, 0);
4549 /* When we encounter a timer that is still waiting,
4550 return the amount of time to wait before it is ripe. */
4557 /* No timers are pending in the future. */
4558 /* Return 0 if we generated an event, and -1 if not. */
4564 /* Check whether a timer has fired. To prevent larger problems we simply
4565 disregard elements that are not proper timers. Do not make a circular
4566 timer list for the time being.
4568 Returns the time to wait until the next timer fires.
4569 If no timer is active, return an invalid value.
4571 As long as any timer is ripe, we run it. */
4576 struct timespec nexttime
;
4577 Lisp_Object timers
, idle_timers
;
4578 struct gcpro gcpro1
, gcpro2
;
4580 Lisp_Object tem
= Vinhibit_quit
;
4583 /* We use copies of the timers' lists to allow a timer to add itself
4584 again, without locking up Emacs if the newly added timer is
4585 already ripe when added. */
4587 /* Always consider the ordinary timers. */
4588 timers
= Fcopy_sequence (Vtimer_list
);
4589 /* Consider the idle timers only if Emacs is idle. */
4590 if (timespec_valid_p (timer_idleness_start_time
))
4591 idle_timers
= Fcopy_sequence (Vtimer_idle_list
);
4595 Vinhibit_quit
= tem
;
4597 GCPRO2 (timers
, idle_timers
);
4601 nexttime
= timer_check_2 (timers
, idle_timers
);
4603 while (nexttime
.tv_sec
== 0 && nexttime
.tv_nsec
== 0);
4609 DEFUN ("current-idle-time", Fcurrent_idle_time
, Scurrent_idle_time
, 0, 0, 0,
4610 doc
: /* Return the current length of Emacs idleness, or nil.
4611 The value when Emacs is idle is a list of four integers (HIGH LOW USEC PSEC)
4612 in the same style as (current-time).
4614 The value when Emacs is not idle is nil.
4616 PSEC is a multiple of the system clock resolution. */)
4619 if (timespec_valid_p (timer_idleness_start_time
))
4620 return make_lisp_time (timespec_sub (current_timespec (),
4621 timer_idleness_start_time
));
4626 /* Caches for modify_event_symbol. */
4627 static Lisp_Object accent_key_syms
;
4628 static Lisp_Object func_key_syms
;
4629 static Lisp_Object mouse_syms
;
4630 static Lisp_Object wheel_syms
;
4631 static Lisp_Object drag_n_drop_syms
;
4633 /* This is a list of keysym codes for special "accent" characters.
4634 It parallels lispy_accent_keys. */
4636 static const int lispy_accent_codes
[] =
4638 #ifdef XK_dead_circumflex
4643 #ifdef XK_dead_grave
4648 #ifdef XK_dead_tilde
4653 #ifdef XK_dead_diaeresis
4658 #ifdef XK_dead_macron
4663 #ifdef XK_dead_degree
4668 #ifdef XK_dead_acute
4673 #ifdef XK_dead_cedilla
4678 #ifdef XK_dead_breve
4683 #ifdef XK_dead_ogonek
4688 #ifdef XK_dead_caron
4693 #ifdef XK_dead_doubleacute
4694 XK_dead_doubleacute
,
4698 #ifdef XK_dead_abovedot
4703 #ifdef XK_dead_abovering
4713 #ifdef XK_dead_belowdot
4718 #ifdef XK_dead_voiced_sound
4719 XK_dead_voiced_sound
,
4723 #ifdef XK_dead_semivoiced_sound
4724 XK_dead_semivoiced_sound
,
4740 /* This is a list of Lisp names for special "accent" characters.
4741 It parallels lispy_accent_codes. */
4743 static const char *const lispy_accent_keys
[] =
4761 "dead-voiced-sound",
4762 "dead-semivoiced-sound",
4768 #define FUNCTION_KEY_OFFSET 0x0
4770 const char *const lispy_function_keys
[] =
4774 0, /* VK_LBUTTON 0x01 */
4775 0, /* VK_RBUTTON 0x02 */
4776 "cancel", /* VK_CANCEL 0x03 */
4777 0, /* VK_MBUTTON 0x04 */
4779 0, 0, 0, /* 0x05 .. 0x07 */
4781 "backspace", /* VK_BACK 0x08 */
4782 "tab", /* VK_TAB 0x09 */
4784 0, 0, /* 0x0A .. 0x0B */
4786 "clear", /* VK_CLEAR 0x0C */
4787 "return", /* VK_RETURN 0x0D */
4789 0, 0, /* 0x0E .. 0x0F */
4791 0, /* VK_SHIFT 0x10 */
4792 0, /* VK_CONTROL 0x11 */
4793 0, /* VK_MENU 0x12 */
4794 "pause", /* VK_PAUSE 0x13 */
4795 "capslock", /* VK_CAPITAL 0x14 */
4796 "kana", /* VK_KANA/VK_HANGUL 0x15 */
4798 "junja", /* VK_JUNJA 0x17 */
4799 "final", /* VK_FINAL 0x18 */
4800 "kanji", /* VK_KANJI/VK_HANJA 0x19 */
4802 "escape", /* VK_ESCAPE 0x1B */
4803 "convert", /* VK_CONVERT 0x1C */
4804 "non-convert", /* VK_NONCONVERT 0x1D */
4805 "accept", /* VK_ACCEPT 0x1E */
4806 "mode-change", /* VK_MODECHANGE 0x1F */
4807 0, /* VK_SPACE 0x20 */
4808 "prior", /* VK_PRIOR 0x21 */
4809 "next", /* VK_NEXT 0x22 */
4810 "end", /* VK_END 0x23 */
4811 "home", /* VK_HOME 0x24 */
4812 "left", /* VK_LEFT 0x25 */
4813 "up", /* VK_UP 0x26 */
4814 "right", /* VK_RIGHT 0x27 */
4815 "down", /* VK_DOWN 0x28 */
4816 "select", /* VK_SELECT 0x29 */
4817 "print", /* VK_PRINT 0x2A */
4818 "execute", /* VK_EXECUTE 0x2B */
4819 "snapshot", /* VK_SNAPSHOT 0x2C */
4820 "insert", /* VK_INSERT 0x2D */
4821 "delete", /* VK_DELETE 0x2E */
4822 "help", /* VK_HELP 0x2F */
4824 /* VK_0 thru VK_9 are the same as ASCII '0' thru '9' (0x30 - 0x39) */
4826 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4828 0, 0, 0, 0, 0, 0, 0, /* 0x3A .. 0x40 */
4830 /* VK_A thru VK_Z are the same as ASCII 'A' thru 'Z' (0x41 - 0x5A) */
4832 0, 0, 0, 0, 0, 0, 0, 0, 0,
4833 0, 0, 0, 0, 0, 0, 0, 0, 0,
4834 0, 0, 0, 0, 0, 0, 0, 0,
4836 "lwindow", /* VK_LWIN 0x5B */
4837 "rwindow", /* VK_RWIN 0x5C */
4838 "apps", /* VK_APPS 0x5D */
4841 "kp-0", /* VK_NUMPAD0 0x60 */
4842 "kp-1", /* VK_NUMPAD1 0x61 */
4843 "kp-2", /* VK_NUMPAD2 0x62 */
4844 "kp-3", /* VK_NUMPAD3 0x63 */
4845 "kp-4", /* VK_NUMPAD4 0x64 */
4846 "kp-5", /* VK_NUMPAD5 0x65 */
4847 "kp-6", /* VK_NUMPAD6 0x66 */
4848 "kp-7", /* VK_NUMPAD7 0x67 */
4849 "kp-8", /* VK_NUMPAD8 0x68 */
4850 "kp-9", /* VK_NUMPAD9 0x69 */
4851 "kp-multiply", /* VK_MULTIPLY 0x6A */
4852 "kp-add", /* VK_ADD 0x6B */
4853 "kp-separator", /* VK_SEPARATOR 0x6C */
4854 "kp-subtract", /* VK_SUBTRACT 0x6D */
4855 "kp-decimal", /* VK_DECIMAL 0x6E */
4856 "kp-divide", /* VK_DIVIDE 0x6F */
4857 "f1", /* VK_F1 0x70 */
4858 "f2", /* VK_F2 0x71 */
4859 "f3", /* VK_F3 0x72 */
4860 "f4", /* VK_F4 0x73 */
4861 "f5", /* VK_F5 0x74 */
4862 "f6", /* VK_F6 0x75 */
4863 "f7", /* VK_F7 0x76 */
4864 "f8", /* VK_F8 0x77 */
4865 "f9", /* VK_F9 0x78 */
4866 "f10", /* VK_F10 0x79 */
4867 "f11", /* VK_F11 0x7A */
4868 "f12", /* VK_F12 0x7B */
4869 "f13", /* VK_F13 0x7C */
4870 "f14", /* VK_F14 0x7D */
4871 "f15", /* VK_F15 0x7E */
4872 "f16", /* VK_F16 0x7F */
4873 "f17", /* VK_F17 0x80 */
4874 "f18", /* VK_F18 0x81 */
4875 "f19", /* VK_F19 0x82 */
4876 "f20", /* VK_F20 0x83 */
4877 "f21", /* VK_F21 0x84 */
4878 "f22", /* VK_F22 0x85 */
4879 "f23", /* VK_F23 0x86 */
4880 "f24", /* VK_F24 0x87 */
4882 0, 0, 0, 0, /* 0x88 .. 0x8B */
4883 0, 0, 0, 0, /* 0x8C .. 0x8F */
4885 "kp-numlock", /* VK_NUMLOCK 0x90 */
4886 "scroll", /* VK_SCROLL 0x91 */
4887 /* Not sure where the following block comes from.
4888 Windows headers have NEC and Fujitsu specific keys in
4889 this block, but nothing generic. */
4890 "kp-space", /* VK_NUMPAD_CLEAR 0x92 */
4891 "kp-enter", /* VK_NUMPAD_ENTER 0x93 */
4892 "kp-prior", /* VK_NUMPAD_PRIOR 0x94 */
4893 "kp-next", /* VK_NUMPAD_NEXT 0x95 */
4894 "kp-end", /* VK_NUMPAD_END 0x96 */
4895 "kp-home", /* VK_NUMPAD_HOME 0x97 */
4896 "kp-left", /* VK_NUMPAD_LEFT 0x98 */
4897 "kp-up", /* VK_NUMPAD_UP 0x99 */
4898 "kp-right", /* VK_NUMPAD_RIGHT 0x9A */
4899 "kp-down", /* VK_NUMPAD_DOWN 0x9B */
4900 "kp-insert", /* VK_NUMPAD_INSERT 0x9C */
4901 "kp-delete", /* VK_NUMPAD_DELETE 0x9D */
4903 0, 0, /* 0x9E .. 0x9F */
4906 * VK_L* & VK_R* - left and right Alt, Ctrl and Shift virtual keys.
4907 * Used only as parameters to GetAsyncKeyState and GetKeyState.
4908 * No other API or message will distinguish left and right keys this way.
4913 /* Multimedia keys. These are handled as WM_APPCOMMAND, which allows us
4914 to enable them selectively, and gives access to a few more functions.
4915 See lispy_multimedia_keys below. */
4916 0, 0, 0, 0, 0, 0, 0, /* 0xA6 .. 0xAC Browser */
4917 0, 0, 0, /* 0xAD .. 0xAF Volume */
4918 0, 0, 0, 0, /* 0xB0 .. 0xB3 Media */
4919 0, 0, 0, 0, /* 0xB4 .. 0xB7 Apps */
4921 /* 0xB8 .. 0xC0 "OEM" keys - all seem to be punctuation. */
4922 0, 0, 0, 0, 0, 0, 0, 0, 0,
4924 /* 0xC1 - 0xDA unallocated, 0xDB-0xDF more OEM keys */
4925 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4926 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4929 "ax", /* VK_OEM_AX 0xE1 */
4930 0, /* VK_OEM_102 0xE2 */
4931 "ico-help", /* VK_ICO_HELP 0xE3 */
4932 "ico-00", /* VK_ICO_00 0xE4 */
4933 0, /* VK_PROCESSKEY 0xE5 - used by IME */
4934 "ico-clear", /* VK_ICO_CLEAR 0xE6 */
4935 0, /* VK_PACKET 0xE7 - used to pass Unicode chars */
4937 "reset", /* VK_OEM_RESET 0xE9 */
4938 "jump", /* VK_OEM_JUMP 0xEA */
4939 "oem-pa1", /* VK_OEM_PA1 0xEB */
4940 "oem-pa2", /* VK_OEM_PA2 0xEC */
4941 "oem-pa3", /* VK_OEM_PA3 0xED */
4942 "wsctrl", /* VK_OEM_WSCTRL 0xEE */
4943 "cusel", /* VK_OEM_CUSEL 0xEF */
4944 "oem-attn", /* VK_OEM_ATTN 0xF0 */
4945 "finish", /* VK_OEM_FINISH 0xF1 */
4946 "copy", /* VK_OEM_COPY 0xF2 */
4947 "auto", /* VK_OEM_AUTO 0xF3 */
4948 "enlw", /* VK_OEM_ENLW 0xF4 */
4949 "backtab", /* VK_OEM_BACKTAB 0xF5 */
4950 "attn", /* VK_ATTN 0xF6 */
4951 "crsel", /* VK_CRSEL 0xF7 */
4952 "exsel", /* VK_EXSEL 0xF8 */
4953 "ereof", /* VK_EREOF 0xF9 */
4954 "play", /* VK_PLAY 0xFA */
4955 "zoom", /* VK_ZOOM 0xFB */
4956 "noname", /* VK_NONAME 0xFC */
4957 "pa1", /* VK_PA1 0xFD */
4958 "oem_clear", /* VK_OEM_CLEAR 0xFE */
4962 /* Some of these duplicate the "Media keys" on newer keyboards,
4963 but they are delivered to the application in a different way. */
4964 static const char *const lispy_multimedia_keys
[] =
4972 "browser-favorites",
5009 "toggle-dictate-command",
5015 "media-fast-forward",
5018 "media-channel-down"
5021 #else /* not HAVE_NTGUI */
5023 /* This should be dealt with in XTread_socket now, and that doesn't
5024 depend on the client system having the Kana syms defined. See also
5025 the XK_kana_A case below. */
5028 static const char *const lispy_kana_keys
[] =
5030 /* X Keysym value */
5031 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x400 .. 0x40f */
5032 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x410 .. 0x41f */
5033 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x420 .. 0x42f */
5034 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x430 .. 0x43f */
5035 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x440 .. 0x44f */
5036 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x450 .. 0x45f */
5037 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x460 .. 0x46f */
5038 0,0,0,0,0,0,0,0,0,0,0,0,0,0,"overline",0,
5039 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x480 .. 0x48f */
5040 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x490 .. 0x49f */
5041 0, "kana-fullstop", "kana-openingbracket", "kana-closingbracket",
5042 "kana-comma", "kana-conjunctive", "kana-WO", "kana-a",
5043 "kana-i", "kana-u", "kana-e", "kana-o",
5044 "kana-ya", "kana-yu", "kana-yo", "kana-tsu",
5045 "prolongedsound", "kana-A", "kana-I", "kana-U",
5046 "kana-E", "kana-O", "kana-KA", "kana-KI",
5047 "kana-KU", "kana-KE", "kana-KO", "kana-SA",
5048 "kana-SHI", "kana-SU", "kana-SE", "kana-SO",
5049 "kana-TA", "kana-CHI", "kana-TSU", "kana-TE",
5050 "kana-TO", "kana-NA", "kana-NI", "kana-NU",
5051 "kana-NE", "kana-NO", "kana-HA", "kana-HI",
5052 "kana-FU", "kana-HE", "kana-HO", "kana-MA",
5053 "kana-MI", "kana-MU", "kana-ME", "kana-MO",
5054 "kana-YA", "kana-YU", "kana-YO", "kana-RA",
5055 "kana-RI", "kana-RU", "kana-RE", "kana-RO",
5056 "kana-WA", "kana-N", "voicedsound", "semivoicedsound",
5057 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4e0 .. 0x4ef */
5058 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4f0 .. 0x4ff */
5060 #endif /* XK_kana_A */
5063 #define FUNCTION_KEY_OFFSET 0xff00
5065 /* You'll notice that this table is arranged to be conveniently
5066 indexed by X Windows keysym values. */
5067 static const char *const lispy_function_keys
[] =
5069 /* X Keysym value */
5071 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff00...0f */
5072 "backspace", "tab", "linefeed", "clear",
5074 0, 0, 0, "pause", /* 0xff10...1f */
5075 0, 0, 0, 0, 0, 0, 0, "escape",
5077 0, "kanji", "muhenkan", "henkan", /* 0xff20...2f */
5078 "romaji", "hiragana", "katakana", "hiragana-katakana",
5079 "zenkaku", "hankaku", "zenkaku-hankaku", "touroku",
5080 "massyo", "kana-lock", "kana-shift", "eisu-shift",
5081 "eisu-toggle", /* 0xff30...3f */
5082 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
5083 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff40...4f */
5085 "home", "left", "up", "right", /* 0xff50 */ /* IsCursorKey */
5086 "down", "prior", "next", "end",
5087 "begin", 0, 0, 0, 0, 0, 0, 0,
5088 "select", /* 0xff60 */ /* IsMiscFunctionKey */
5099 "break", /* 0xff6b */
5102 0, 0, 0, 0, "backtab", 0, 0, 0, /* 0xff70... */
5103 0, 0, 0, 0, 0, 0, 0, "kp-numlock", /* 0xff78... */
5104 "kp-space", /* 0xff80 */ /* IsKeypadKey */
5105 0, 0, 0, 0, 0, 0, 0, 0,
5106 "kp-tab", /* 0xff89 */
5108 "kp-enter", /* 0xff8d */
5110 "kp-f1", /* 0xff91 */
5114 "kp-home", /* 0xff95 */
5119 "kp-prior", /* kp-page-up */
5120 "kp-next", /* kp-page-down */
5126 0, 0, 0, 0, 0, 0, 0, 0, 0,
5127 "kp-multiply", /* 0xffaa */
5132 "kp-divide", /* 0xffaf */
5133 "kp-0", /* 0xffb0 */
5134 "kp-1", "kp-2", "kp-3", "kp-4", "kp-5", "kp-6", "kp-7", "kp-8", "kp-9",
5137 "kp-equal", /* 0xffbd */
5138 "f1", /* 0xffbe */ /* IsFunctionKey */
5140 "f3", "f4", "f5", "f6", "f7", "f8", "f9", "f10", /* 0xffc0 */
5141 "f11", "f12", "f13", "f14", "f15", "f16", "f17", "f18",
5142 "f19", "f20", "f21", "f22", "f23", "f24", "f25", "f26", /* 0xffd0 */
5143 "f27", "f28", "f29", "f30", "f31", "f32", "f33", "f34",
5144 "f35", 0, 0, 0, 0, 0, 0, 0, /* 0xffe0 */
5145 0, 0, 0, 0, 0, 0, 0, 0,
5146 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfff0 */
5147 0, 0, 0, 0, 0, 0, 0, "delete"
5150 /* ISO 9995 Function and Modifier Keys; the first byte is 0xFE. */
5151 #define ISO_FUNCTION_KEY_OFFSET 0xfe00
5153 static const char *const iso_lispy_function_keys
[] =
5155 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe00 */
5156 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe08 */
5157 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe10 */
5158 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe18 */
5159 "iso-lefttab", /* 0xfe20 */
5160 "iso-move-line-up", "iso-move-line-down",
5161 "iso-partial-line-up", "iso-partial-line-down",
5162 "iso-partial-space-left", "iso-partial-space-right",
5163 "iso-set-margin-left", "iso-set-margin-right", /* 0xffe27, 28 */
5164 "iso-release-margin-left", "iso-release-margin-right",
5165 "iso-release-both-margins",
5166 "iso-fast-cursor-left", "iso-fast-cursor-right",
5167 "iso-fast-cursor-up", "iso-fast-cursor-down",
5168 "iso-continuous-underline", "iso-discontinuous-underline", /* 0xfe30, 31 */
5169 "iso-emphasize", "iso-center-object", "iso-enter", /* ... 0xfe34 */
5172 #endif /* not HAVE_NTGUI */
5174 static Lisp_Object Vlispy_mouse_stem
;
5176 static const char *const lispy_wheel_names
[] =
5178 "wheel-up", "wheel-down", "wheel-left", "wheel-right"
5181 /* drag-n-drop events are generated when a set of selected files are
5182 dragged from another application and dropped onto an Emacs window. */
5183 static const char *const lispy_drag_n_drop_names
[] =
5188 /* An array of symbol indexes of scroll bar parts, indexed by an enum
5189 scroll_bar_part value. Note that Qnil corresponds to
5190 scroll_bar_nowhere and should not appear in Lisp events. */
5191 static short const scroll_bar_parts
[] = {
5192 SYMBOL_INDEX (Qnil
), SYMBOL_INDEX (Qabove_handle
), SYMBOL_INDEX (Qhandle
),
5193 SYMBOL_INDEX (Qbelow_handle
), SYMBOL_INDEX (Qup
), SYMBOL_INDEX (Qdown
),
5194 SYMBOL_INDEX (Qtop
), SYMBOL_INDEX (Qbottom
), SYMBOL_INDEX (Qend_scroll
),
5195 SYMBOL_INDEX (Qratio
), SYMBOL_INDEX (Qbefore_handle
),
5196 SYMBOL_INDEX (Qhorizontal_handle
), SYMBOL_INDEX (Qafter_handle
),
5197 SYMBOL_INDEX (Qleft
), SYMBOL_INDEX (Qright
), SYMBOL_INDEX (Qleftmost
),
5198 SYMBOL_INDEX (Qrightmost
), SYMBOL_INDEX (Qend_scroll
), SYMBOL_INDEX (Qratio
)
5201 /* A vector, indexed by button number, giving the down-going location
5202 of currently depressed buttons, both scroll bar and non-scroll bar.
5204 The elements have the form
5205 (BUTTON-NUMBER MODIFIER-MASK . REST)
5206 where REST is the cdr of a position as it would be reported in the event.
5208 The make_lispy_event function stores positions here to tell the
5209 difference between click and drag events, and to store the starting
5210 location to be included in drag events. */
5212 static Lisp_Object button_down_location
;
5214 /* Information about the most recent up-going button event: Which
5215 button, what location, and what time. */
5217 static int last_mouse_button
;
5218 static int last_mouse_x
;
5219 static int last_mouse_y
;
5220 static Time button_down_time
;
5222 /* The number of clicks in this multiple-click. */
5224 static int double_click_count
;
5226 /* X and Y are frame-relative coordinates for a click or wheel event.
5227 Return a Lisp-style event list. */
5230 make_lispy_position (struct frame
*f
, Lisp_Object x
, Lisp_Object y
,
5233 enum window_part part
;
5234 Lisp_Object posn
= Qnil
;
5235 Lisp_Object extra_info
= Qnil
;
5236 /* Coordinate pixel positions to return. */
5237 int xret
= 0, yret
= 0;
5238 /* The window under frame pixel coordinates (x,y) */
5239 Lisp_Object window
= f
5240 ? window_from_coordinates (f
, XINT (x
), XINT (y
), &part
, 0)
5243 if (WINDOWP (window
))
5245 /* It's a click in window WINDOW at frame coordinates (X,Y) */
5246 struct window
*w
= XWINDOW (window
);
5247 Lisp_Object string_info
= Qnil
;
5248 ptrdiff_t textpos
= 0;
5249 int col
= -1, row
= -1;
5250 int dx
= -1, dy
= -1;
5251 int width
= -1, height
= -1;
5252 Lisp_Object object
= Qnil
;
5254 /* Pixel coordinates relative to the window corner. */
5255 int wx
= XINT (x
) - WINDOW_LEFT_EDGE_X (w
);
5256 int wy
= XINT (y
) - WINDOW_TOP_EDGE_Y (w
);
5258 /* For text area clicks, return X, Y relative to the corner of
5259 this text area. Note that dX, dY etc are set below, by
5260 buffer_posn_from_coords. */
5261 if (part
== ON_TEXT
)
5263 xret
= XINT (x
) - window_box_left (w
, TEXT_AREA
);
5264 yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5266 /* For mode line and header line clicks, return X, Y relative to
5267 the left window edge. Use mode_line_string to look for a
5268 string on the click position. */
5269 else if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
)
5274 posn
= (part
== ON_MODE_LINE
) ? Qmode_line
: Qheader_line
;
5275 /* Note that mode_line_string takes COL, ROW as pixels and
5276 converts them to characters. */
5279 string
= mode_line_string (w
, part
, &col
, &row
, &charpos
,
5280 &object
, &dx
, &dy
, &width
, &height
);
5281 if (STRINGP (string
))
5282 string_info
= Fcons (string
, make_number (charpos
));
5288 /* For fringes and margins, Y is relative to the area's (and the
5289 window's) top edge, while X is meaningless. */
5290 else if (part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
5295 posn
= (part
== ON_LEFT_MARGIN
) ? Qleft_margin
: Qright_margin
;
5298 string
= marginal_area_string (w
, part
, &col
, &row
, &charpos
,
5299 &object
, &dx
, &dy
, &width
, &height
);
5300 if (STRINGP (string
))
5301 string_info
= Fcons (string
, make_number (charpos
));
5303 yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5305 else if (part
== ON_LEFT_FRINGE
)
5307 posn
= Qleft_fringe
;
5311 - (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5312 ? 0 : window_box_width (w
, LEFT_MARGIN_AREA
));
5313 dy
= yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5315 else if (part
== ON_RIGHT_FRINGE
)
5317 posn
= Qright_fringe
;
5321 - window_box_width (w
, LEFT_MARGIN_AREA
)
5322 - window_box_width (w
, TEXT_AREA
)
5323 - (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5324 ? window_box_width (w
, RIGHT_MARGIN_AREA
)
5326 dy
= yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5328 else if (part
== ON_VERTICAL_BORDER
)
5330 posn
= Qvertical_line
;
5336 else if (part
== ON_VERTICAL_SCROLL_BAR
)
5338 posn
= Qvertical_scroll_bar
;
5339 width
= WINDOW_SCROLL_BAR_AREA_WIDTH (w
);
5343 else if (part
== ON_HORIZONTAL_SCROLL_BAR
)
5345 posn
= Qhorizontal_scroll_bar
;
5346 width
= WINDOW_SCROLL_BAR_AREA_HEIGHT (w
);
5350 else if (part
== ON_RIGHT_DIVIDER
)
5352 posn
= Qright_divider
;
5353 width
= WINDOW_RIGHT_DIVIDER_WIDTH (w
);
5357 else if (part
== ON_BOTTOM_DIVIDER
)
5359 posn
= Qbottom_divider
;
5360 width
= WINDOW_BOTTOM_DIVIDER_WIDTH (w
);
5365 /* For clicks in the text area, fringes, margins, or vertical
5366 scroll bar, call buffer_posn_from_coords to extract TEXTPOS,
5367 the buffer position nearest to the click. */
5370 Lisp_Object string2
, object2
= Qnil
;
5371 struct display_pos p
;
5373 int width2
, height2
;
5374 /* The pixel X coordinate passed to buffer_posn_from_coords
5375 is the X coordinate relative to the text area for clicks
5376 in text-area, right-margin/fringe and right-side vertical
5377 scroll bar, zero otherwise. */
5379 = (part
== ON_TEXT
) ? xret
5380 : (part
== ON_RIGHT_FRINGE
|| part
== ON_RIGHT_MARGIN
5381 || (part
== ON_VERTICAL_SCROLL_BAR
5382 && WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_RIGHT (w
)))
5383 ? (XINT (x
) - window_box_left (w
, TEXT_AREA
))
5387 string2
= buffer_posn_from_coords (w
, &x2
, &y2
, &p
,
5388 &object2
, &dx2
, &dy2
,
5390 textpos
= CHARPOS (p
.pos
);
5391 if (col
< 0) col
= x2
;
5392 if (row
< 0) row
= y2
;
5393 if (dx
< 0) dx
= dx2
;
5394 if (dy
< 0) dy
= dy2
;
5395 if (width
< 0) width
= width2
;
5396 if (height
< 0) height
= height2
;
5400 posn
= make_number (textpos
);
5401 if (STRINGP (string2
))
5402 string_info
= Fcons (string2
,
5403 make_number (CHARPOS (p
.string_pos
)));
5409 #ifdef HAVE_WINDOW_SYSTEM
5410 if (IMAGEP (object
))
5412 Lisp_Object image_map
, hotspot
;
5413 if ((image_map
= Fplist_get (XCDR (object
), QCmap
),
5415 && (hotspot
= find_hot_spot (image_map
, dx
, dy
),
5417 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
5418 posn
= XCAR (hotspot
);
5425 Fcons (make_number (dx
), make_number (dy
)),
5426 Fcons (make_number (width
), make_number (height
)));
5429 extra_info
= Fcons (string_info
,
5430 Fcons (textpos
< 0 ? Qnil
: make_number (textpos
),
5431 Fcons (Fcons (make_number (col
),
5437 /* Return mouse pixel coordinates here. */
5438 XSETFRAME (window
, f
);
5445 return Fcons (window
,
5447 Fcons (Fcons (make_number (xret
),
5448 make_number (yret
)),
5449 Fcons (make_number (t
),
5453 /* Return non-zero if F is a GUI frame that uses some toolkit-managed
5454 menu bar. This really means that Emacs draws and manages the menu
5455 bar as part of its normal display, and therefore can compute its
5458 toolkit_menubar_in_use (struct frame
*f
)
5460 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS) || defined (HAVE_NTGUI)
5461 return !(!FRAME_WINDOW_P (f
));
5467 /* Build the part of Lisp event which represents scroll bar state from
5468 EV. TYPE is one of Qvertical_scroll_bar or Qhorizontal_scroll_bar. */
5471 make_scroll_bar_position (struct input_event
*ev
, Lisp_Object type
)
5473 return list5 (ev
->frame_or_window
, type
, Fcons (ev
->x
, ev
->y
),
5474 make_number (ev
->timestamp
),
5475 builtin_lisp_symbol (scroll_bar_parts
[ev
->part
]));
5478 /* Given a struct input_event, build the lisp event which represents
5479 it. If EVENT is 0, build a mouse movement event from the mouse
5480 movement buffer, which should have a movement event in it.
5482 Note that events must be passed to this function in the order they
5483 are received; this function stores the location of button presses
5484 in order to build drag events when the button is released. */
5487 make_lispy_event (struct input_event
*event
)
5491 switch (event
->kind
)
5493 /* A simple keystroke. */
5494 case ASCII_KEYSTROKE_EVENT
:
5495 case MULTIBYTE_CHAR_KEYSTROKE_EVENT
:
5497 Lisp_Object lispy_c
;
5498 EMACS_INT c
= event
->code
;
5499 if (event
->kind
== ASCII_KEYSTROKE_EVENT
)
5502 eassert (c
== event
->code
);
5503 /* Turn ASCII characters into control characters
5505 if (event
->modifiers
& ctrl_modifier
)
5507 c
= make_ctrl_char (c
);
5508 event
->modifiers
&= ~ctrl_modifier
;
5512 /* Add in the other modifier bits. The shift key was taken care
5513 of by the X code. */
5514 c
|= (event
->modifiers
5515 & (meta_modifier
| alt_modifier
5516 | hyper_modifier
| super_modifier
| ctrl_modifier
));
5517 /* Distinguish Shift-SPC from SPC. */
5518 if ((event
->code
) == 040
5519 && event
->modifiers
& shift_modifier
)
5520 c
|= shift_modifier
;
5521 button_down_time
= 0;
5522 XSETFASTINT (lispy_c
, c
);
5527 /* NS_NONKEY_EVENTs are just like NON_ASCII_KEYSTROKE_EVENTs,
5528 except that they are non-key events (last-nonmenu-event is nil). */
5529 case NS_NONKEY_EVENT
:
5532 /* A function key. The symbol may need to have modifier prefixes
5534 case NON_ASCII_KEYSTROKE_EVENT
:
5535 button_down_time
= 0;
5537 for (i
= 0; i
< ARRAYELTS (lispy_accent_codes
); i
++)
5538 if (event
->code
== lispy_accent_codes
[i
])
5539 return modify_event_symbol (i
,
5541 Qfunction_key
, Qnil
,
5542 lispy_accent_keys
, &accent_key_syms
,
5543 ARRAYELTS (lispy_accent_keys
));
5547 if (event
->code
>= 0x400 && event
->code
< 0x500)
5548 return modify_event_symbol (event
->code
- 0x400,
5549 event
->modifiers
& ~shift_modifier
,
5550 Qfunction_key
, Qnil
,
5551 lispy_kana_keys
, &func_key_syms
,
5552 ARRAYELTS (lispy_kana_keys
));
5553 #endif /* XK_kana_A */
5556 #ifdef ISO_FUNCTION_KEY_OFFSET
5557 if (event
->code
< FUNCTION_KEY_OFFSET
5558 && event
->code
>= ISO_FUNCTION_KEY_OFFSET
)
5559 return modify_event_symbol (event
->code
- ISO_FUNCTION_KEY_OFFSET
,
5561 Qfunction_key
, Qnil
,
5562 iso_lispy_function_keys
, &func_key_syms
,
5563 ARRAYELTS (iso_lispy_function_keys
));
5566 if ((FUNCTION_KEY_OFFSET
<= event
->code
5568 < FUNCTION_KEY_OFFSET
+ ARRAYELTS (lispy_function_keys
)))
5569 && lispy_function_keys
[event
->code
- FUNCTION_KEY_OFFSET
])
5570 return modify_event_symbol (event
->code
- FUNCTION_KEY_OFFSET
,
5572 Qfunction_key
, Qnil
,
5573 lispy_function_keys
, &func_key_syms
,
5574 ARRAYELTS (lispy_function_keys
));
5576 /* Handle system-specific or unknown keysyms.
5577 We need to use an alist rather than a vector as the cache
5578 since we can't make a vector long enough. */
5579 if (NILP (KVAR (current_kboard
, system_key_syms
)))
5580 kset_system_key_syms (current_kboard
, Fcons (Qnil
, Qnil
));
5581 return modify_event_symbol (event
->code
,
5584 KVAR (current_kboard
, Vsystem_key_alist
),
5585 0, &KVAR (current_kboard
, system_key_syms
),
5589 case MULTIMEDIA_KEY_EVENT
:
5590 if (event
->code
< ARRAYELTS (lispy_multimedia_keys
)
5591 && event
->code
> 0 && lispy_multimedia_keys
[event
->code
])
5593 return modify_event_symbol (event
->code
, event
->modifiers
,
5594 Qfunction_key
, Qnil
,
5595 lispy_multimedia_keys
, &func_key_syms
,
5596 ARRAYELTS (lispy_multimedia_keys
));
5601 /* A mouse click. Figure out where it is, decide whether it's
5602 a press, click or drag, and build the appropriate structure. */
5603 case MOUSE_CLICK_EVENT
:
5605 case GPM_CLICK_EVENT
:
5607 #ifndef USE_TOOLKIT_SCROLL_BARS
5608 case SCROLL_BAR_CLICK_EVENT
:
5609 case HORIZONTAL_SCROLL_BAR_CLICK_EVENT
:
5612 int button
= event
->code
;
5614 Lisp_Object position
;
5615 Lisp_Object
*start_pos_ptr
;
5616 Lisp_Object start_pos
;
5620 /* Build the position as appropriate for this mouse click. */
5621 if (event
->kind
== MOUSE_CLICK_EVENT
5623 || event
->kind
== GPM_CLICK_EVENT
5627 struct frame
*f
= XFRAME (event
->frame_or_window
);
5630 /* Ignore mouse events that were made on frame that
5631 have been deleted. */
5632 if (! FRAME_LIVE_P (f
))
5635 /* EVENT->x and EVENT->y are frame-relative pixel
5636 coordinates at this place. Under old redisplay, COLUMN
5637 and ROW are set to frame relative glyph coordinates
5638 which are then used to determine whether this click is
5639 in a menu (non-toolkit version). */
5640 if (!toolkit_menubar_in_use (f
))
5642 pixel_to_glyph_coords (f
, XINT (event
->x
), XINT (event
->y
),
5643 &column
, &row
, NULL
, 1);
5645 /* In the non-toolkit version, clicks on the menu bar
5646 are ordinary button events in the event buffer.
5647 Distinguish them, and invoke the menu.
5649 (In the toolkit version, the toolkit handles the
5650 menu bar and Emacs doesn't know about it until
5651 after the user makes a selection.) */
5652 if (row
>= 0 && row
< FRAME_MENU_BAR_LINES (f
)
5653 && (event
->modifiers
& down_modifier
))
5655 Lisp_Object items
, item
;
5657 /* Find the menu bar item under `column'. */
5659 items
= FRAME_MENU_BAR_ITEMS (f
);
5660 for (i
= 0; i
< ASIZE (items
); i
+= 4)
5662 Lisp_Object pos
, string
;
5663 string
= AREF (items
, i
+ 1);
5664 pos
= AREF (items
, i
+ 3);
5667 if (column
>= XINT (pos
)
5668 && column
< XINT (pos
) + SCHARS (string
))
5670 item
= AREF (items
, i
);
5675 /* ELisp manual 2.4b says (x y) are window
5676 relative but code says they are
5678 position
= list4 (event
->frame_or_window
,
5680 Fcons (event
->x
, event
->y
),
5681 make_number (event
->timestamp
));
5683 return list2 (item
, position
);
5687 position
= make_lispy_position (f
, event
->x
, event
->y
,
5690 #ifndef USE_TOOLKIT_SCROLL_BARS
5692 /* It's a scrollbar click. */
5693 position
= make_scroll_bar_position (event
, Qvertical_scroll_bar
);
5694 #endif /* not USE_TOOLKIT_SCROLL_BARS */
5696 if (button
>= ASIZE (button_down_location
))
5698 ptrdiff_t incr
= button
- ASIZE (button_down_location
) + 1;
5699 button_down_location
= larger_vector (button_down_location
,
5701 mouse_syms
= larger_vector (mouse_syms
, incr
, -1);
5704 start_pos_ptr
= aref_addr (button_down_location
, button
);
5705 start_pos
= *start_pos_ptr
;
5706 *start_pos_ptr
= Qnil
;
5709 /* On window-system frames, use the value of
5710 double-click-fuzz as is. On other frames, interpret it
5711 as a multiple of 1/8 characters. */
5715 if (WINDOWP (event
->frame_or_window
))
5716 f
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5717 else if (FRAMEP (event
->frame_or_window
))
5718 f
= XFRAME (event
->frame_or_window
);
5722 if (FRAME_WINDOW_P (f
))
5723 fuzz
= double_click_fuzz
;
5725 fuzz
= double_click_fuzz
/ 8;
5727 is_double
= (button
== last_mouse_button
5728 && (eabs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5729 && (eabs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5730 && button_down_time
!= 0
5731 && (EQ (Vdouble_click_time
, Qt
)
5732 || (NATNUMP (Vdouble_click_time
)
5733 && (event
->timestamp
- button_down_time
5734 < XFASTINT (Vdouble_click_time
)))));
5737 last_mouse_button
= button
;
5738 last_mouse_x
= XINT (event
->x
);
5739 last_mouse_y
= XINT (event
->y
);
5741 /* If this is a button press, squirrel away the location, so
5742 we can decide later whether it was a click or a drag. */
5743 if (event
->modifiers
& down_modifier
)
5747 double_click_count
++;
5748 event
->modifiers
|= ((double_click_count
> 2)
5753 double_click_count
= 1;
5754 button_down_time
= event
->timestamp
;
5755 *start_pos_ptr
= Fcopy_alist (position
);
5756 ignore_mouse_drag_p
= 0;
5759 /* Now we're releasing a button - check the co-ordinates to
5760 see if this was a click or a drag. */
5761 else if (event
->modifiers
& up_modifier
)
5763 /* If we did not see a down before this up, ignore the up.
5764 Probably this happened because the down event chose a
5765 menu item. It would be an annoyance to treat the
5766 release of the button that chose the menu item as a
5769 if (!CONSP (start_pos
))
5772 event
->modifiers
&= ~up_modifier
;
5775 Lisp_Object new_down
, down
;
5776 EMACS_INT xdiff
= double_click_fuzz
, ydiff
= double_click_fuzz
;
5778 /* The third element of every position
5779 should be the (x,y) pair. */
5780 down
= Fcar (Fcdr (Fcdr (start_pos
)));
5781 new_down
= Fcar (Fcdr (Fcdr (position
)));
5784 && INTEGERP (XCAR (down
)) && INTEGERP (XCDR (down
)))
5786 xdiff
= XINT (XCAR (new_down
)) - XINT (XCAR (down
));
5787 ydiff
= XINT (XCDR (new_down
)) - XINT (XCDR (down
));
5790 if (ignore_mouse_drag_p
)
5792 event
->modifiers
|= click_modifier
;
5793 ignore_mouse_drag_p
= 0;
5795 else if (xdiff
< double_click_fuzz
&& xdiff
> - double_click_fuzz
5796 && ydiff
< double_click_fuzz
&& ydiff
> - double_click_fuzz
5797 /* Maybe the mouse has moved a lot, caused scrolling, and
5798 eventually ended up at the same screen position (but
5799 not buffer position) in which case it is a drag, not
5801 /* FIXME: OTOH if the buffer position has changed
5802 because of a timer or process filter rather than
5803 because of mouse movement, it should be considered as
5804 a click. But mouse-drag-region completely ignores
5805 this case and it hasn't caused any real problem, so
5806 it's probably OK to ignore it as well. */
5807 && EQ (Fcar (Fcdr (start_pos
)), Fcar (Fcdr (position
))))
5808 /* Mouse hasn't moved (much). */
5809 event
->modifiers
|= click_modifier
;
5812 button_down_time
= 0;
5813 event
->modifiers
|= drag_modifier
;
5816 /* Don't check is_double; treat this as multiple
5817 if the down-event was multiple. */
5818 if (double_click_count
> 1)
5819 event
->modifiers
|= ((double_click_count
> 2)
5825 /* Every mouse event should either have the down_modifier or
5826 the up_modifier set. */
5830 /* Get the symbol we should use for the mouse click. */
5833 head
= modify_event_symbol (button
,
5835 Qmouse_click
, Vlispy_mouse_stem
,
5838 ASIZE (mouse_syms
));
5839 if (event
->modifiers
& drag_modifier
)
5840 return list3 (head
, start_pos
, position
);
5841 else if (event
->modifiers
& (double_modifier
| triple_modifier
))
5842 return list3 (head
, position
, make_number (double_click_count
));
5844 return list2 (head
, position
);
5849 case HORIZ_WHEEL_EVENT
:
5851 Lisp_Object position
;
5854 /* Build the position as appropriate for this mouse click. */
5855 struct frame
*f
= XFRAME (event
->frame_or_window
);
5857 /* Ignore wheel events that were made on frame that have been
5859 if (! FRAME_LIVE_P (f
))
5862 position
= make_lispy_position (f
, event
->x
, event
->y
,
5865 /* Set double or triple modifiers to indicate the wheel speed. */
5867 /* On window-system frames, use the value of
5868 double-click-fuzz as is. On other frames, interpret it
5869 as a multiple of 1/8 characters. */
5875 if (WINDOWP (event
->frame_or_window
))
5876 fr
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5877 else if (FRAMEP (event
->frame_or_window
))
5878 fr
= XFRAME (event
->frame_or_window
);
5882 fuzz
= FRAME_WINDOW_P (fr
)
5883 ? double_click_fuzz
: double_click_fuzz
/ 8;
5885 if (event
->modifiers
& up_modifier
)
5887 /* Emit a wheel-up event. */
5888 event
->modifiers
&= ~up_modifier
;
5891 else if (event
->modifiers
& down_modifier
)
5893 /* Emit a wheel-down event. */
5894 event
->modifiers
&= ~down_modifier
;
5898 /* Every wheel event should either have the down_modifier or
5899 the up_modifier set. */
5902 if (event
->kind
== HORIZ_WHEEL_EVENT
)
5905 is_double
= (last_mouse_button
== - (1 + symbol_num
)
5906 && (eabs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5907 && (eabs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5908 && button_down_time
!= 0
5909 && (EQ (Vdouble_click_time
, Qt
)
5910 || (NATNUMP (Vdouble_click_time
)
5911 && (event
->timestamp
- button_down_time
5912 < XFASTINT (Vdouble_click_time
)))));
5915 double_click_count
++;
5916 event
->modifiers
|= ((double_click_count
> 2)
5922 double_click_count
= 1;
5923 event
->modifiers
|= click_modifier
;
5926 button_down_time
= event
->timestamp
;
5927 /* Use a negative value to distinguish wheel from mouse button. */
5928 last_mouse_button
= - (1 + symbol_num
);
5929 last_mouse_x
= XINT (event
->x
);
5930 last_mouse_y
= XINT (event
->y
);
5932 /* Get the symbol we should use for the wheel event. */
5933 head
= modify_event_symbol (symbol_num
,
5939 ASIZE (wheel_syms
));
5942 if (event
->modifiers
& (double_modifier
| triple_modifier
))
5943 return list3 (head
, position
, make_number (double_click_count
));
5945 return list2 (head
, position
);
5949 #ifdef USE_TOOLKIT_SCROLL_BARS
5951 /* We don't have down and up events if using toolkit scroll bars,
5952 so make this always a click event. Store in the `part' of
5953 the Lisp event a symbol which maps to the following actions:
5955 `above_handle' page up
5956 `below_handle' page down
5960 `bottom' bottom of buffer
5961 `handle' thumb has been dragged.
5962 `end-scroll' end of interaction with scroll bar
5964 The incoming input_event contains in its `part' member an
5965 index of type `enum scroll_bar_part' which we can use as an
5966 index in scroll_bar_parts to get the appropriate symbol. */
5968 case SCROLL_BAR_CLICK_EVENT
:
5970 Lisp_Object position
, head
;
5972 position
= make_scroll_bar_position (event
, Qvertical_scroll_bar
);
5974 /* Always treat scroll bar events as clicks. */
5975 event
->modifiers
|= click_modifier
;
5976 event
->modifiers
&= ~up_modifier
;
5978 if (event
->code
>= ASIZE (mouse_syms
))
5979 mouse_syms
= larger_vector (mouse_syms
,
5980 event
->code
- ASIZE (mouse_syms
) + 1,
5983 /* Get the symbol we should use for the mouse click. */
5984 head
= modify_event_symbol (event
->code
,
5989 ASIZE (mouse_syms
));
5990 return list2 (head
, position
);
5993 case HORIZONTAL_SCROLL_BAR_CLICK_EVENT
:
5995 Lisp_Object position
, head
;
5997 position
= make_scroll_bar_position (event
, Qhorizontal_scroll_bar
);
5999 /* Always treat scroll bar events as clicks. */
6000 event
->modifiers
|= click_modifier
;
6001 event
->modifiers
&= ~up_modifier
;
6003 if (event
->code
>= ASIZE (mouse_syms
))
6004 mouse_syms
= larger_vector (mouse_syms
,
6005 event
->code
- ASIZE (mouse_syms
) + 1,
6008 /* Get the symbol we should use for the mouse click. */
6009 head
= modify_event_symbol (event
->code
,
6014 ASIZE (mouse_syms
));
6015 return list2 (head
, position
);
6018 #endif /* USE_TOOLKIT_SCROLL_BARS */
6020 case DRAG_N_DROP_EVENT
:
6023 Lisp_Object head
, position
;
6026 f
= XFRAME (event
->frame_or_window
);
6029 /* Ignore mouse events that were made on frames that
6030 have been deleted. */
6031 if (! FRAME_LIVE_P (f
))
6034 position
= make_lispy_position (f
, event
->x
, event
->y
,
6037 head
= modify_event_symbol (0, event
->modifiers
,
6039 lispy_drag_n_drop_names
,
6040 &drag_n_drop_syms
, 1);
6041 return list3 (head
, position
, files
);
6044 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
6045 || defined (HAVE_NS) || defined (USE_GTK)
6046 case MENU_BAR_EVENT
:
6047 if (EQ (event
->arg
, event
->frame_or_window
))
6048 /* This is the prefix key. We translate this to
6049 `(menu_bar)' because the code in keyboard.c for menu
6050 events, which we use, relies on this. */
6051 return list1 (Qmenu_bar
);
6055 case SELECT_WINDOW_EVENT
:
6056 /* Make an event (select-window (WINDOW)). */
6057 return list2 (Qselect_window
, list1 (event
->frame_or_window
));
6059 case TOOL_BAR_EVENT
:
6060 if (EQ (event
->arg
, event
->frame_or_window
))
6061 /* This is the prefix key. We translate this to
6062 `(tool_bar)' because the code in keyboard.c for tool bar
6063 events, which we use, relies on this. */
6064 return list1 (Qtool_bar
);
6065 else if (SYMBOLP (event
->arg
))
6066 return apply_modifiers (event
->modifiers
, event
->arg
);
6069 case USER_SIGNAL_EVENT
:
6070 /* A user signal. */
6072 char *name
= find_user_signal_name (event
->code
);
6075 return intern (name
);
6078 case SAVE_SESSION_EVENT
:
6079 return Qsave_session
;
6084 return Fcons (Qdbus_event
, event
->arg
);
6086 #endif /* HAVE_DBUS */
6088 #if defined HAVE_GFILENOTIFY || defined HAVE_INOTIFY
6089 case FILE_NOTIFY_EVENT
:
6091 return Fcons (Qfile_notify
, event
->arg
);
6093 #endif /* defined HAVE_GFILENOTIFY || defined HAVE_INOTIFY */
6095 case CONFIG_CHANGED_EVENT
:
6096 return list3 (Qconfig_changed_event
,
6097 event
->arg
, event
->frame_or_window
);
6099 /* The 'kind' field of the event is something we don't recognize. */
6106 make_lispy_movement (struct frame
*frame
, Lisp_Object bar_window
, enum scroll_bar_part part
,
6107 Lisp_Object x
, Lisp_Object y
, Time t
)
6109 /* Is it a scroll bar movement? */
6110 if (frame
&& ! NILP (bar_window
))
6112 Lisp_Object part_sym
;
6114 part_sym
= builtin_lisp_symbol (scroll_bar_parts
[part
]);
6115 return list2 (Qscroll_bar_movement
,
6117 Qvertical_scroll_bar
,
6122 /* Or is it an ordinary mouse movement? */
6125 Lisp_Object position
;
6126 position
= make_lispy_position (frame
, x
, y
, t
);
6127 return list2 (Qmouse_movement
, position
);
6131 /* Construct a switch frame event. */
6133 make_lispy_switch_frame (Lisp_Object frame
)
6135 return list2 (Qswitch_frame
, frame
);
6139 make_lispy_focus_in (Lisp_Object frame
)
6141 return list2 (Qfocus_in
, frame
);
6144 #ifdef HAVE_WINDOW_SYSTEM
6147 make_lispy_focus_out (Lisp_Object frame
)
6149 return list2 (Qfocus_out
, frame
);
6152 #endif /* HAVE_WINDOW_SYSTEM */
6154 /* Manipulating modifiers. */
6156 /* Parse the name of SYMBOL, and return the set of modifiers it contains.
6158 If MODIFIER_END is non-zero, set *MODIFIER_END to the position in
6159 SYMBOL's name of the end of the modifiers; the string from this
6160 position is the unmodified symbol name.
6162 This doesn't use any caches. */
6165 parse_modifiers_uncached (Lisp_Object symbol
, ptrdiff_t *modifier_end
)
6171 CHECK_SYMBOL (symbol
);
6174 name
= SYMBOL_NAME (symbol
);
6176 for (i
= 0; i
< SBYTES (name
) - 1; )
6178 ptrdiff_t this_mod_end
= 0;
6181 /* See if the name continues with a modifier word.
6182 Check that the word appears, but don't check what follows it.
6183 Set this_mod and this_mod_end to record what we find. */
6185 switch (SREF (name
, i
))
6187 #define SINGLE_LETTER_MOD(BIT) \
6188 (this_mod_end = i + 1, this_mod = BIT)
6191 SINGLE_LETTER_MOD (alt_modifier
);
6195 SINGLE_LETTER_MOD (ctrl_modifier
);
6199 SINGLE_LETTER_MOD (hyper_modifier
);
6203 SINGLE_LETTER_MOD (meta_modifier
);
6207 SINGLE_LETTER_MOD (shift_modifier
);
6211 SINGLE_LETTER_MOD (super_modifier
);
6214 #undef SINGLE_LETTER_MOD
6216 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6217 if (i + LEN + 1 <= SBYTES (name) \
6218 && ! memcmp (SDATA (name) + i, NAME, LEN)) \
6220 this_mod_end = i + LEN; \
6225 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
6226 MULTI_LETTER_MOD (down_modifier
, "down", 4);
6227 MULTI_LETTER_MOD (double_modifier
, "double", 6);
6231 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
6233 #undef MULTI_LETTER_MOD
6237 /* If we found no modifier, stop looking for them. */
6238 if (this_mod_end
== 0)
6241 /* Check there is a dash after the modifier, so that it
6242 really is a modifier. */
6243 if (this_mod_end
>= SBYTES (name
)
6244 || SREF (name
, this_mod_end
) != '-')
6247 /* This modifier is real; look for another. */
6248 modifiers
|= this_mod
;
6249 i
= this_mod_end
+ 1;
6252 /* Should we include the `click' modifier? */
6253 if (! (modifiers
& (down_modifier
| drag_modifier
6254 | double_modifier
| triple_modifier
))
6255 && i
+ 7 == SBYTES (name
)
6256 && memcmp (SDATA (name
) + i
, "mouse-", 6) == 0
6257 && ('0' <= SREF (name
, i
+ 6) && SREF (name
, i
+ 6) <= '9'))
6258 modifiers
|= click_modifier
;
6260 if (! (modifiers
& (double_modifier
| triple_modifier
))
6261 && i
+ 6 < SBYTES (name
)
6262 && memcmp (SDATA (name
) + i
, "wheel-", 6) == 0)
6263 modifiers
|= click_modifier
;
6271 /* Return a symbol whose name is the modifier prefixes for MODIFIERS
6272 prepended to the string BASE[0..BASE_LEN-1].
6273 This doesn't use any caches. */
6275 apply_modifiers_uncached (int modifiers
, char *base
, int base_len
, int base_len_byte
)
6277 /* Since BASE could contain nulls, we can't use intern here; we have
6278 to use Fintern, which expects a genuine Lisp_String, and keeps a
6280 char new_mods
[sizeof "A-C-H-M-S-s-down-drag-double-triple-"];
6286 /* Only the event queue may use the `up' modifier; it should always
6287 be turned into a click or drag event before presented to lisp code. */
6288 if (modifiers
& up_modifier
)
6291 if (modifiers
& alt_modifier
) { *p
++ = 'A'; *p
++ = '-'; }
6292 if (modifiers
& ctrl_modifier
) { *p
++ = 'C'; *p
++ = '-'; }
6293 if (modifiers
& hyper_modifier
) { *p
++ = 'H'; *p
++ = '-'; }
6294 if (modifiers
& meta_modifier
) { *p
++ = 'M'; *p
++ = '-'; }
6295 if (modifiers
& shift_modifier
) { *p
++ = 'S'; *p
++ = '-'; }
6296 if (modifiers
& super_modifier
) { *p
++ = 's'; *p
++ = '-'; }
6297 if (modifiers
& double_modifier
) p
= stpcpy (p
, "double-");
6298 if (modifiers
& triple_modifier
) p
= stpcpy (p
, "triple-");
6299 if (modifiers
& down_modifier
) p
= stpcpy (p
, "down-");
6300 if (modifiers
& drag_modifier
) p
= stpcpy (p
, "drag-");
6301 /* The click modifier is denoted by the absence of other modifiers. */
6305 mod_len
= p
- new_mods
;
6309 Lisp_Object new_name
;
6311 new_name
= make_uninit_multibyte_string (mod_len
+ base_len
,
6312 mod_len
+ base_len_byte
);
6313 memcpy (SDATA (new_name
), new_mods
, mod_len
);
6314 memcpy (SDATA (new_name
) + mod_len
, base
, base_len_byte
);
6316 return Fintern (new_name
, Qnil
);
6321 static const char *const modifier_names
[] =
6323 "up", "down", "drag", "click", "double", "triple", 0, 0,
6324 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
6325 0, 0, "alt", "super", "hyper", "shift", "control", "meta"
6327 #define NUM_MOD_NAMES ARRAYELTS (modifier_names)
6329 static Lisp_Object modifier_symbols
;
6331 /* Return the list of modifier symbols corresponding to the mask MODIFIERS. */
6333 lispy_modifier_list (int modifiers
)
6335 Lisp_Object modifier_list
;
6338 modifier_list
= Qnil
;
6339 for (i
= 0; (1<<i
) <= modifiers
&& i
< NUM_MOD_NAMES
; i
++)
6340 if (modifiers
& (1<<i
))
6341 modifier_list
= Fcons (AREF (modifier_symbols
, i
),
6344 return modifier_list
;
6348 /* Parse the modifiers on SYMBOL, and return a list like (UNMODIFIED MASK),
6349 where UNMODIFIED is the unmodified form of SYMBOL,
6350 MASK is the set of modifiers present in SYMBOL's name.
6351 This is similar to parse_modifiers_uncached, but uses the cache in
6352 SYMBOL's Qevent_symbol_element_mask property, and maintains the
6353 Qevent_symbol_elements property. */
6355 #define KEY_TO_CHAR(k) (XINT (k) & ((1 << CHARACTERBITS) - 1))
6358 parse_modifiers (Lisp_Object symbol
)
6360 Lisp_Object elements
;
6362 if (INTEGERP (symbol
))
6363 return list2i (KEY_TO_CHAR (symbol
), XINT (symbol
) & CHAR_MODIFIER_MASK
);
6364 else if (!SYMBOLP (symbol
))
6367 elements
= Fget (symbol
, Qevent_symbol_element_mask
);
6368 if (CONSP (elements
))
6373 int modifiers
= parse_modifiers_uncached (symbol
, &end
);
6374 Lisp_Object unmodified
;
6377 unmodified
= Fintern (make_string (SSDATA (SYMBOL_NAME (symbol
)) + end
,
6378 SBYTES (SYMBOL_NAME (symbol
)) - end
),
6381 if (modifiers
& ~INTMASK
)
6383 XSETFASTINT (mask
, modifiers
);
6384 elements
= list2 (unmodified
, mask
);
6386 /* Cache the parsing results on SYMBOL. */
6387 Fput (symbol
, Qevent_symbol_element_mask
,
6389 Fput (symbol
, Qevent_symbol_elements
,
6390 Fcons (unmodified
, lispy_modifier_list (modifiers
)));
6392 /* Since we know that SYMBOL is modifiers applied to unmodified,
6393 it would be nice to put that in unmodified's cache.
6394 But we can't, since we're not sure that parse_modifiers is
6401 DEFUN ("internal-event-symbol-parse-modifiers", Fevent_symbol_parse_modifiers
,
6402 Sevent_symbol_parse_modifiers
, 1, 1, 0,
6403 doc
: /* Parse the event symbol. For internal use. */)
6404 (Lisp_Object symbol
)
6406 /* Fill the cache if needed. */
6407 parse_modifiers (symbol
);
6408 /* Ignore the result (which is stored on Qevent_symbol_element_mask)
6409 and use the Lispier representation stored on Qevent_symbol_elements
6411 return Fget (symbol
, Qevent_symbol_elements
);
6414 /* Apply the modifiers MODIFIERS to the symbol BASE.
6415 BASE must be unmodified.
6417 This is like apply_modifiers_uncached, but uses BASE's
6418 Qmodifier_cache property, if present. It also builds
6419 Qevent_symbol_elements properties, since it has that info anyway.
6421 apply_modifiers copies the value of BASE's Qevent_kind property to
6422 the modified symbol. */
6424 apply_modifiers (int modifiers
, Lisp_Object base
)
6426 Lisp_Object cache
, idx
, entry
, new_symbol
;
6428 /* Mask out upper bits. We don't know where this value's been. */
6429 modifiers
&= INTMASK
;
6431 if (INTEGERP (base
))
6432 return make_number (XINT (base
) | modifiers
);
6434 /* The click modifier never figures into cache indices. */
6435 cache
= Fget (base
, Qmodifier_cache
);
6436 XSETFASTINT (idx
, (modifiers
& ~click_modifier
));
6437 entry
= assq_no_quit (idx
, cache
);
6440 new_symbol
= XCDR (entry
);
6443 /* We have to create the symbol ourselves. */
6444 new_symbol
= apply_modifiers_uncached (modifiers
,
6445 SSDATA (SYMBOL_NAME (base
)),
6446 SCHARS (SYMBOL_NAME (base
)),
6447 SBYTES (SYMBOL_NAME (base
)));
6449 /* Add the new symbol to the base's cache. */
6450 entry
= Fcons (idx
, new_symbol
);
6451 Fput (base
, Qmodifier_cache
, Fcons (entry
, cache
));
6453 /* We have the parsing info now for free, so we could add it to
6455 XSETFASTINT (idx, modifiers);
6456 Fput (new_symbol, Qevent_symbol_element_mask,
6458 Fput (new_symbol, Qevent_symbol_elements,
6459 Fcons (base, lispy_modifier_list (modifiers)));
6460 Sadly, this is only correct if `base' is indeed a base event,
6461 which is not necessarily the case. -stef */
6464 /* Make sure this symbol is of the same kind as BASE.
6466 You'd think we could just set this once and for all when we
6467 intern the symbol above, but reorder_modifiers may call us when
6468 BASE's property isn't set right; we can't assume that just
6469 because it has a Qmodifier_cache property it must have its
6470 Qevent_kind set right as well. */
6471 if (NILP (Fget (new_symbol
, Qevent_kind
)))
6475 kind
= Fget (base
, Qevent_kind
);
6477 Fput (new_symbol
, Qevent_kind
, kind
);
6484 /* Given a symbol whose name begins with modifiers ("C-", "M-", etc),
6485 return a symbol with the modifiers placed in the canonical order.
6486 Canonical order is alphabetical, except for down and drag, which
6487 always come last. The 'click' modifier is never written out.
6489 Fdefine_key calls this to make sure that (for example) C-M-foo
6490 and M-C-foo end up being equivalent in the keymap. */
6493 reorder_modifiers (Lisp_Object symbol
)
6495 /* It's hopefully okay to write the code this way, since everything
6496 will soon be in caches, and no consing will be done at all. */
6499 parsed
= parse_modifiers (symbol
);
6500 return apply_modifiers (XFASTINT (XCAR (XCDR (parsed
))),
6505 /* For handling events, we often want to produce a symbol whose name
6506 is a series of modifier key prefixes ("M-", "C-", etcetera) attached
6507 to some base, like the name of a function key or mouse button.
6508 modify_event_symbol produces symbols of this sort.
6510 NAME_TABLE should point to an array of strings, such that NAME_TABLE[i]
6511 is the name of the i'th symbol. TABLE_SIZE is the number of elements
6514 Alternatively, NAME_ALIST_OR_STEM is either an alist mapping codes
6515 into symbol names, or a string specifying a name stem used to
6516 construct a symbol name or the form `STEM-N', where N is the decimal
6517 representation of SYMBOL_NUM. NAME_ALIST_OR_STEM is used if it is
6518 non-nil; otherwise NAME_TABLE is used.
6520 SYMBOL_TABLE should be a pointer to a Lisp_Object whose value will
6521 persist between calls to modify_event_symbol that it can use to
6522 store a cache of the symbols it's generated for this NAME_TABLE
6523 before. The object stored there may be a vector or an alist.
6525 SYMBOL_NUM is the number of the base name we want from NAME_TABLE.
6527 MODIFIERS is a set of modifier bits (as given in struct input_events)
6528 whose prefixes should be applied to the symbol name.
6530 SYMBOL_KIND is the value to be placed in the event_kind property of
6531 the returned symbol.
6533 The symbols we create are supposed to have an
6534 `event-symbol-elements' property, which lists the modifiers present
6535 in the symbol's name. */
6538 modify_event_symbol (ptrdiff_t symbol_num
, int modifiers
, Lisp_Object symbol_kind
,
6539 Lisp_Object name_alist_or_stem
, const char *const *name_table
,
6540 Lisp_Object
*symbol_table
, ptrdiff_t table_size
)
6543 Lisp_Object symbol_int
;
6545 /* Get rid of the "vendor-specific" bit here. */
6546 XSETINT (symbol_int
, symbol_num
& 0xffffff);
6548 /* Is this a request for a valid symbol? */
6549 if (symbol_num
< 0 || symbol_num
>= table_size
)
6552 if (CONSP (*symbol_table
))
6553 value
= Fcdr (assq_no_quit (symbol_int
, *symbol_table
));
6555 /* If *symbol_table doesn't seem to be initialized properly, fix that.
6556 *symbol_table should be a lisp vector TABLE_SIZE elements long,
6557 where the Nth element is the symbol for NAME_TABLE[N], or nil if
6558 we've never used that symbol before. */
6561 if (! VECTORP (*symbol_table
)
6562 || ASIZE (*symbol_table
) != table_size
)
6566 XSETFASTINT (size
, table_size
);
6567 *symbol_table
= Fmake_vector (size
, Qnil
);
6570 value
= AREF (*symbol_table
, symbol_num
);
6573 /* Have we already used this symbol before? */
6576 /* No; let's create it. */
6577 if (CONSP (name_alist_or_stem
))
6578 value
= Fcdr_safe (Fassq (symbol_int
, name_alist_or_stem
));
6579 else if (STRINGP (name_alist_or_stem
))
6582 ptrdiff_t len
= (SBYTES (name_alist_or_stem
)
6583 + sizeof "-" + INT_STRLEN_BOUND (EMACS_INT
));
6585 buf
= SAFE_ALLOCA (len
);
6586 esprintf (buf
, "%s-%"pI
"d", SDATA (name_alist_or_stem
),
6587 XINT (symbol_int
) + 1);
6588 value
= intern (buf
);
6591 else if (name_table
!= 0 && name_table
[symbol_num
])
6592 value
= intern (name_table
[symbol_num
]);
6594 #ifdef HAVE_WINDOW_SYSTEM
6597 char *name
= x_get_keysym_name (symbol_num
);
6599 value
= intern (name
);
6605 char buf
[sizeof "key-" + INT_STRLEN_BOUND (EMACS_INT
)];
6606 sprintf (buf
, "key-%"pD
"d", symbol_num
);
6607 value
= intern (buf
);
6610 if (CONSP (*symbol_table
))
6611 *symbol_table
= Fcons (Fcons (symbol_int
, value
), *symbol_table
);
6613 ASET (*symbol_table
, symbol_num
, value
);
6615 /* Fill in the cache entries for this symbol; this also
6616 builds the Qevent_symbol_elements property, which the user
6618 apply_modifiers (modifiers
& click_modifier
, value
);
6619 Fput (value
, Qevent_kind
, symbol_kind
);
6622 /* Apply modifiers to that symbol. */
6623 return apply_modifiers (modifiers
, value
);
6626 /* Convert a list that represents an event type,
6627 such as (ctrl meta backspace), into the usual representation of that
6628 event type as a number or a symbol. */
6630 DEFUN ("event-convert-list", Fevent_convert_list
, Sevent_convert_list
, 1, 1, 0,
6631 doc
: /* Convert the event description list EVENT-DESC to an event type.
6632 EVENT-DESC should contain one base event type (a character or symbol)
6633 and zero or more modifier names (control, meta, hyper, super, shift, alt,
6634 drag, down, double or triple). The base must be last.
6635 The return value is an event type (a character or symbol) which
6636 has the same base event type and all the specified modifiers. */)
6637 (Lisp_Object event_desc
)
6645 while (CONSP (rest
))
6653 /* Given a symbol, see if it is a modifier name. */
6654 if (SYMBOLP (elt
) && CONSP (rest
))
6655 this = parse_solitary_modifier (elt
);
6659 else if (!NILP (base
))
6660 error ("Two bases given in one event");
6666 /* Let the symbol A refer to the character A. */
6667 if (SYMBOLP (base
) && SCHARS (SYMBOL_NAME (base
)) == 1)
6668 XSETINT (base
, SREF (SYMBOL_NAME (base
), 0));
6670 if (INTEGERP (base
))
6672 /* Turn (shift a) into A. */
6673 if ((modifiers
& shift_modifier
) != 0
6674 && (XINT (base
) >= 'a' && XINT (base
) <= 'z'))
6676 XSETINT (base
, XINT (base
) - ('a' - 'A'));
6677 modifiers
&= ~shift_modifier
;
6680 /* Turn (control a) into C-a. */
6681 if (modifiers
& ctrl_modifier
)
6682 return make_number ((modifiers
& ~ctrl_modifier
)
6683 | make_ctrl_char (XINT (base
)));
6685 return make_number (modifiers
| XINT (base
));
6687 else if (SYMBOLP (base
))
6688 return apply_modifiers (modifiers
, base
);
6690 error ("Invalid base event");
6693 /* Try to recognize SYMBOL as a modifier name.
6694 Return the modifier flag bit, or 0 if not recognized. */
6697 parse_solitary_modifier (Lisp_Object symbol
)
6699 Lisp_Object name
= SYMBOL_NAME (symbol
);
6701 switch (SREF (name
, 0))
6703 #define SINGLE_LETTER_MOD(BIT) \
6704 if (SBYTES (name) == 1) \
6707 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6708 if (LEN == SBYTES (name) \
6709 && ! memcmp (SDATA (name), NAME, LEN)) \
6713 SINGLE_LETTER_MOD (alt_modifier
);
6717 MULTI_LETTER_MOD (alt_modifier
, "alt", 3);
6721 SINGLE_LETTER_MOD (ctrl_modifier
);
6725 MULTI_LETTER_MOD (ctrl_modifier
, "ctrl", 4);
6726 MULTI_LETTER_MOD (ctrl_modifier
, "control", 7);
6730 SINGLE_LETTER_MOD (hyper_modifier
);
6734 MULTI_LETTER_MOD (hyper_modifier
, "hyper", 5);
6738 SINGLE_LETTER_MOD (meta_modifier
);
6742 MULTI_LETTER_MOD (meta_modifier
, "meta", 4);
6746 SINGLE_LETTER_MOD (shift_modifier
);
6750 MULTI_LETTER_MOD (shift_modifier
, "shift", 5);
6751 MULTI_LETTER_MOD (super_modifier
, "super", 5);
6752 SINGLE_LETTER_MOD (super_modifier
);
6756 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
6757 MULTI_LETTER_MOD (down_modifier
, "down", 4);
6758 MULTI_LETTER_MOD (double_modifier
, "double", 6);
6762 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
6765 #undef SINGLE_LETTER_MOD
6766 #undef MULTI_LETTER_MOD
6772 /* Return true if EVENT is a list whose elements are all integers or symbols.
6773 Such a list is not valid as an event,
6774 but it can be a Lucid-style event type list. */
6777 lucid_event_type_list_p (Lisp_Object object
)
6781 if (! CONSP (object
))
6784 if (EQ (XCAR (object
), Qhelp_echo
)
6785 || EQ (XCAR (object
), Qvertical_line
)
6786 || EQ (XCAR (object
), Qmode_line
)
6787 || EQ (XCAR (object
), Qheader_line
))
6790 for (tail
= object
; CONSP (tail
); tail
= XCDR (tail
))
6794 if (! (INTEGERP (elt
) || SYMBOLP (elt
)))
6801 /* Return true if terminal input chars are available.
6802 Also, store the return value into INPUT_PENDING.
6804 Serves the purpose of ioctl (0, FIONREAD, ...)
6805 but works even if FIONREAD does not exist.
6806 (In fact, this may actually read some input.)
6808 If READABLE_EVENTS_DO_TIMERS_NOW is set in FLAGS, actually run
6809 timer events that are ripe.
6810 If READABLE_EVENTS_FILTER_EVENTS is set in FLAGS, ignore internal
6811 events (FOCUS_IN_EVENT).
6812 If READABLE_EVENTS_IGNORE_SQUEEZABLES is set in FLAGS, ignore mouse
6813 movements and toolkit scroll bar thumb drags. */
6816 get_input_pending (int flags
)
6818 /* First of all, have we already counted some input? */
6819 input_pending
= (!NILP (Vquit_flag
) || readable_events (flags
));
6821 /* If input is being read as it arrives, and we have none, there is none. */
6822 if (!input_pending
&& (!interrupt_input
|| interrupts_deferred
))
6824 /* Try to read some input and see how much we get. */
6826 input_pending
= (!NILP (Vquit_flag
) || readable_events (flags
));
6829 return input_pending
;
6832 /* Put a BUFFER_SWITCH_EVENT in the buffer
6833 so that read_key_sequence will notice the new current buffer. */
6836 record_asynch_buffer_change (void)
6838 /* We don't need a buffer-switch event unless Emacs is waiting for input.
6839 The purpose of the event is to make read_key_sequence look up the
6840 keymaps again. If we aren't in read_key_sequence, we don't need one,
6841 and the event could cause trouble by messing up (input-pending-p).
6842 Note: Fwaiting_for_user_input_p always returns nil when async
6843 subprocesses aren't supported. */
6844 if (!NILP (Fwaiting_for_user_input_p ()))
6846 struct input_event event
;
6849 event
.kind
= BUFFER_SWITCH_EVENT
;
6850 event
.frame_or_window
= Qnil
;
6853 /* Make sure no interrupt happens while storing the event. */
6855 if (interrupt_input
)
6856 kbd_buffer_store_event (&event
);
6861 kbd_buffer_store_event (&event
);
6867 /* Read any terminal input already buffered up by the system
6868 into the kbd_buffer, but do not wait.
6870 Return the number of keyboard chars read, or -1 meaning
6871 this is a bad time to try to read input. */
6880 /* Store pending user signal events, if any. */
6881 store_user_signal_events ();
6883 /* Loop through the available terminals, and call their input hooks. */
6887 struct terminal
*next
= t
->next_terminal
;
6889 if (t
->read_socket_hook
)
6892 struct input_event hold_quit
;
6894 if (input_blocked_p ())
6896 pending_signals
= 1;
6900 EVENT_INIT (hold_quit
);
6901 hold_quit
.kind
= NO_EVENT
;
6903 /* No need for FIONREAD or fcntl; just say don't wait. */
6904 while ((nr
= (*t
->read_socket_hook
) (t
, &hold_quit
)) > 0)
6907 if (nr
== -1) /* Not OK to read input now. */
6911 else if (nr
== -2) /* Non-transient error. */
6913 /* The terminal device terminated; it should be closed. */
6915 /* Kill Emacs if this was our last terminal. */
6916 if (!terminal_list
->next_terminal
)
6917 /* Formerly simply reported no input, but that
6918 sometimes led to a failure of Emacs to terminate.
6919 SIGHUP seems appropriate if we can't reach the
6921 /* ??? Is it really right to send the signal just to
6922 this process rather than to the whole process
6923 group? Perhaps on systems with FIONREAD Emacs is
6924 alone in its group. */
6925 terminate_due_to_signal (SIGHUP
, 10);
6927 /* XXX Is calling delete_terminal safe here? It calls delete_frame. */
6930 XSETTERMINAL (tmp
, t
);
6931 Fdelete_terminal (tmp
, Qnoelisp
);
6935 /* If there was no error, make sure the pointer
6936 is visible for all frames on this terminal. */
6939 Lisp_Object tail
, frame
;
6941 FOR_EACH_FRAME (tail
, frame
)
6943 struct frame
*f
= XFRAME (frame
);
6944 if (FRAME_TERMINAL (f
) == t
)
6945 frame_make_pointer_visible (f
);
6949 if (hold_quit
.kind
!= NO_EVENT
)
6950 kbd_buffer_store_event (&hold_quit
);
6962 /* This is the tty way of reading available input.
6964 Note that each terminal device has its own `struct terminal' object,
6965 and so this function is called once for each individual termcap
6966 terminal. The first parameter indicates which terminal to read from. */
6969 tty_read_avail_input (struct terminal
*terminal
,
6970 struct input_event
*hold_quit
)
6972 /* Using KBD_BUFFER_SIZE - 1 here avoids reading more than
6973 the kbd_buffer can really hold. That may prevent loss
6974 of characters on some systems when input is stuffed at us. */
6975 unsigned char cbuf
[KBD_BUFFER_SIZE
- 1];
6977 struct tty_display_info
*tty
= terminal
->display_info
.tty
;
6980 int buffer_free
= KBD_BUFFER_SIZE
- kbd_buffer_nr_stored () - 1;
6982 if (kbd_on_hold_p () || buffer_free
<= 0)
6984 #endif /* subprocesses */
6986 if (!terminal
->name
) /* Don't read from a dead terminal. */
6989 if (terminal
->type
!= output_termcap
6990 && terminal
->type
!= output_msdos_raw
)
6993 /* XXX I think the following code should be moved to separate hook
6994 functions in system-dependent files. */
6996 /* FIXME: AFAIK, tty_read_avail_input is not used under w32 since the non-GUI
6997 code sets read_socket_hook to w32_console_read_socket instead! */
6999 #else /* not WINDOWSNT */
7000 if (! tty
->term_initted
) /* In case we get called during bootstrap. */
7004 return 0; /* The terminal is suspended. */
7007 n_to_read
= dos_keysns ();
7011 cbuf
[0] = dos_keyread ();
7014 #else /* not MSDOS */
7019 struct input_event gpm_hold_quit
;
7020 int gpm
, fd
= gpm_fd
;
7022 EVENT_INIT (gpm_hold_quit
);
7023 gpm_hold_quit
.kind
= NO_EVENT
;
7025 /* gpm==1 if event received.
7026 gpm==0 if the GPM daemon has closed the connection, in which case
7027 Gpm_GetEvent closes gpm_fd and clears it to -1, which is why
7028 we save it in `fd' so close_gpm can remove it from the
7030 gpm==-1 if a protocol error or EWOULDBLOCK; the latter is normal. */
7031 while (gpm
= Gpm_GetEvent (&event
), gpm
== 1) {
7032 nread
+= handle_one_term_event (tty
, &event
, &gpm_hold_quit
);
7035 /* Presumably the GPM daemon has closed the connection. */
7037 if (gpm_hold_quit
.kind
!= NO_EVENT
)
7038 kbd_buffer_store_event (&gpm_hold_quit
);
7042 #endif /* HAVE_GPM */
7044 /* Determine how many characters we should *try* to read. */
7045 #ifdef USABLE_FIONREAD
7046 /* Find out how much input is available. */
7047 if (ioctl (fileno (tty
->input
), FIONREAD
, &n_to_read
) < 0)
7049 if (! noninteractive
)
7050 return -2; /* Close this terminal. */
7056 if (n_to_read
> sizeof cbuf
)
7057 n_to_read
= sizeof cbuf
;
7058 #elif defined USG || defined CYGWIN
7059 /* Read some input if available, but don't wait. */
7060 n_to_read
= sizeof cbuf
;
7061 fcntl (fileno (tty
->input
), F_SETFL
, O_NONBLOCK
);
7063 # error "Cannot read without possibly delaying"
7067 /* Don't read more than we can store. */
7068 if (n_to_read
> buffer_free
)
7069 n_to_read
= buffer_free
;
7070 #endif /* subprocesses */
7072 /* Now read; for one reason or another, this will not block.
7073 NREAD is set to the number of chars read. */
7076 nread
= emacs_read (fileno (tty
->input
), (char *) cbuf
, n_to_read
);
7077 /* POSIX infers that processes which are not in the session leader's
7078 process group won't get SIGHUPs at logout time. BSDI adheres to
7079 this part standard and returns -1 from read (0) with errno==EIO
7080 when the control tty is taken away.
7081 Jeffrey Honig <jch@bsdi.com> says this is generally safe. */
7082 if (nread
== -1 && errno
== EIO
)
7083 return -2; /* Close this terminal. */
7084 #if defined (AIX) && defined (_BSD)
7085 /* The kernel sometimes fails to deliver SIGHUP for ptys.
7086 This looks incorrect, but it isn't, because _BSD causes
7087 O_NDELAY to be defined in fcntl.h as O_NONBLOCK,
7088 and that causes a value other than 0 when there is no input. */
7090 return -2; /* Close this terminal. */
7094 /* We used to retry the read if it was interrupted.
7095 But this does the wrong thing when O_NONBLOCK causes
7096 an EAGAIN error. Does anybody know of a situation
7097 where a retry is actually needed? */
7099 nread
< 0 && (errno
== EAGAIN
|| errno
== EFAULT
7109 #ifndef USABLE_FIONREAD
7110 #if defined (USG) || defined (CYGWIN)
7111 fcntl (fileno (tty
->input
), F_SETFL
, 0);
7112 #endif /* USG or CYGWIN */
7113 #endif /* no FIONREAD */
7118 #endif /* not MSDOS */
7119 #endif /* not WINDOWSNT */
7121 for (i
= 0; i
< nread
; i
++)
7123 struct input_event buf
;
7125 buf
.kind
= ASCII_KEYSTROKE_EVENT
;
7127 if (tty
->meta_key
== 1 && (cbuf
[i
] & 0x80))
7128 buf
.modifiers
= meta_modifier
;
7129 if (tty
->meta_key
!= 2)
7133 /* Set the frame corresponding to the active tty. Note that the
7134 value of selected_frame is not reliable here, redisplay tends
7135 to temporarily change it. */
7136 buf
.frame_or_window
= tty
->top_frame
;
7139 kbd_buffer_store_event (&buf
);
7140 /* Don't look at input that follows a C-g too closely.
7141 This reduces lossage due to autorepeat on C-g. */
7142 if (buf
.kind
== ASCII_KEYSTROKE_EVENT
7143 && buf
.code
== quit_char
)
7151 handle_async_input (void)
7156 int nread
= gobble_input ();
7157 /* -1 means it's not ok to read the input now.
7158 UNBLOCK_INPUT will read it later; now, avoid infinite loop.
7159 0 means there was no keyboard input available. */
7167 process_pending_signals (void)
7169 pending_signals
= 0;
7170 handle_async_input ();
7171 do_pending_atimers ();
7174 /* Undo any number of BLOCK_INPUT calls down to level LEVEL,
7175 and reinvoke any pending signal if the level is now 0 and
7176 a fatal error is not already in progress. */
7179 unblock_input_to (int level
)
7181 interrupt_input_blocked
= level
;
7184 if (pending_signals
&& !fatal_error_in_progress
)
7185 process_pending_signals ();
7191 /* End critical section.
7193 If doing signal-driven input, and a signal came in when input was
7194 blocked, reinvoke the signal handler now to deal with it.
7196 It will also process queued input, if it was not read before.
7197 When a longer code sequence does not use block/unblock input
7198 at all, the whole input gathered up to the next call to
7199 unblock_input will be processed inside that call. */
7202 unblock_input (void)
7204 unblock_input_to (interrupt_input_blocked
- 1);
7207 /* Undo any number of BLOCK_INPUT calls,
7208 and also reinvoke any pending signal. */
7211 totally_unblock_input (void)
7213 unblock_input_to (0);
7219 handle_input_available_signal (int sig
)
7221 pending_signals
= 1;
7223 if (input_available_clear_time
)
7224 *input_available_clear_time
= make_timespec (0, 0);
7228 deliver_input_available_signal (int sig
)
7230 deliver_process_signal (sig
, handle_input_available_signal
);
7232 #endif /* USABLE_SIGIO */
7235 /* User signal events. */
7237 struct user_signal_info
7239 /* Signal number. */
7242 /* Name of the signal. */
7245 /* Number of pending signals. */
7248 struct user_signal_info
*next
;
7251 /* List of user signals. */
7252 static struct user_signal_info
*user_signals
= NULL
;
7255 add_user_signal (int sig
, const char *name
)
7257 struct sigaction action
;
7258 struct user_signal_info
*p
;
7260 for (p
= user_signals
; p
; p
= p
->next
)
7262 /* Already added. */
7265 p
= xmalloc (sizeof *p
);
7267 p
->name
= xstrdup (name
);
7269 p
->next
= user_signals
;
7272 emacs_sigaction_init (&action
, deliver_user_signal
);
7273 sigaction (sig
, &action
, 0);
7277 handle_user_signal (int sig
)
7279 struct user_signal_info
*p
;
7280 const char *special_event_name
= NULL
;
7282 if (SYMBOLP (Vdebug_on_event
))
7283 special_event_name
= SSDATA (SYMBOL_NAME (Vdebug_on_event
));
7285 for (p
= user_signals
; p
; p
= p
->next
)
7288 if (special_event_name
7289 && strcmp (special_event_name
, p
->name
) == 0)
7291 /* Enter the debugger in many ways. */
7292 debug_on_next_call
= 1;
7295 Vinhibit_quit
= Qnil
;
7297 /* Eat the event. */
7303 if (interrupt_input
)
7304 handle_input_available_signal (sig
);
7308 /* Tell wait_reading_process_output that it needs to wake
7309 up and look around. */
7310 if (input_available_clear_time
)
7311 *input_available_clear_time
= make_timespec (0, 0);
7318 deliver_user_signal (int sig
)
7320 deliver_process_signal (sig
, handle_user_signal
);
7324 find_user_signal_name (int sig
)
7326 struct user_signal_info
*p
;
7328 for (p
= user_signals
; p
; p
= p
->next
)
7336 store_user_signal_events (void)
7338 struct user_signal_info
*p
;
7339 struct input_event buf
;
7340 bool buf_initialized
= 0;
7342 for (p
= user_signals
; p
; p
= p
->next
)
7343 if (p
->npending
> 0)
7345 if (! buf_initialized
)
7347 memset (&buf
, 0, sizeof buf
);
7348 buf
.kind
= USER_SIGNAL_EVENT
;
7349 buf
.frame_or_window
= selected_frame
;
7350 buf_initialized
= 1;
7356 kbd_buffer_store_event (&buf
);
7359 while (p
->npending
> 0);
7364 static void menu_bar_item (Lisp_Object
, Lisp_Object
, Lisp_Object
, void *);
7365 static Lisp_Object menu_bar_one_keymap_changed_items
;
7367 /* These variables hold the vector under construction within
7368 menu_bar_items and its subroutines, and the current index
7369 for storing into that vector. */
7370 static Lisp_Object menu_bar_items_vector
;
7371 static int menu_bar_items_index
;
7374 static const char *separator_names
[] = {
7379 "single-dashed-line",
7380 "double-dashed-line",
7382 "shadow-etched-out",
7383 "shadow-etched-in-dash",
7384 "shadow-etched-out-dash",
7385 "shadow-double-etched-in",
7386 "shadow-double-etched-out",
7387 "shadow-double-etched-in-dash",
7388 "shadow-double-etched-out-dash",
7392 /* Return true if LABEL specifies a separator. */
7395 menu_separator_name_p (const char *label
)
7399 else if (strlen (label
) > 3
7400 && memcmp (label
, "--", 2) == 0
7405 for (i
= 0; separator_names
[i
]; ++i
)
7406 if (strcmp (label
, separator_names
[i
]) == 0)
7411 /* It's a separator if it contains only dashes. */
7412 while (*label
== '-')
7414 return (*label
== 0);
7421 /* Return a vector of menu items for a menu bar, appropriate
7422 to the current buffer. Each item has three elements in the vector:
7425 OLD is an old vector we can optionally reuse, or nil. */
7428 menu_bar_items (Lisp_Object old
)
7430 /* The number of keymaps we're scanning right now, and the number of
7431 keymaps we have allocated space for. */
7434 /* maps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
7435 in the current keymaps, or nil where it is not a prefix. */
7438 Lisp_Object mapsbuf
[3];
7439 Lisp_Object def
, tail
;
7446 /* In order to build the menus, we need to call the keymap
7447 accessors. They all call QUIT. But this function is called
7448 during redisplay, during which a quit is fatal. So inhibit
7449 quitting while building the menus.
7450 We do this instead of specbind because (1) errors will clear it anyway
7451 and (2) this avoids risk of specpdl overflow. */
7452 oquit
= Vinhibit_quit
;
7456 menu_bar_items_vector
= old
;
7458 menu_bar_items_vector
= Fmake_vector (make_number (24), Qnil
);
7459 menu_bar_items_index
= 0;
7461 /* Build our list of keymaps.
7462 If we recognize a function key and replace its escape sequence in
7463 keybuf with its symbol, or if the sequence starts with a mouse
7464 click and we need to switch buffers, we jump back here to rebuild
7465 the initial keymaps from the current buffer. */
7469 /* Should overriding-terminal-local-map and overriding-local-map apply? */
7470 if (!NILP (Voverriding_local_map_menu_flag
)
7471 && !NILP (Voverriding_local_map
))
7473 /* Yes, use them (if non-nil) as well as the global map. */
7476 if (!NILP (KVAR (current_kboard
, Voverriding_terminal_local_map
)))
7477 maps
[nmaps
++] = KVAR (current_kboard
, Voverriding_terminal_local_map
);
7478 if (!NILP (Voverriding_local_map
))
7479 maps
[nmaps
++] = Voverriding_local_map
;
7483 /* No, so use major and minor mode keymaps and keymap property.
7484 Note that menu-bar bindings in the local-map and keymap
7485 properties may not work reliable, as they are only
7486 recognized when the menu-bar (or mode-line) is updated,
7487 which does not normally happen after every command. */
7490 nminor
= current_minor_maps (NULL
, &tmaps
);
7491 SAFE_NALLOCA (maps
, 1, nminor
+ 4);
7493 tem
= KVAR (current_kboard
, Voverriding_terminal_local_map
);
7494 if (!NILP (tem
) && !NILP (Voverriding_local_map_menu_flag
))
7495 maps
[nmaps
++] = tem
;
7496 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
7497 maps
[nmaps
++] = tem
;
7498 memcpy (maps
+ nmaps
, tmaps
, nminor
* sizeof (maps
[0]));
7500 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
7502 maps
[nmaps
++] = current_global_map
;
7505 /* Look up in each map the dummy prefix key `menu-bar'. */
7507 for (mapno
= nmaps
- 1; mapno
>= 0; mapno
--)
7508 if (!NILP (maps
[mapno
]))
7510 def
= get_keymap (access_keymap (maps
[mapno
], Qmenu_bar
, 1, 0, 1),
7514 menu_bar_one_keymap_changed_items
= Qnil
;
7515 map_keymap_canonical (def
, menu_bar_item
, Qnil
, NULL
);
7519 /* Move to the end those items that should be at the end. */
7521 for (tail
= Vmenu_bar_final_items
; CONSP (tail
); tail
= XCDR (tail
))
7524 int end
= menu_bar_items_index
;
7526 for (i
= 0; i
< end
; i
+= 4)
7527 if (EQ (XCAR (tail
), AREF (menu_bar_items_vector
, i
)))
7529 Lisp_Object tem0
, tem1
, tem2
, tem3
;
7530 /* Move the item at index I to the end,
7531 shifting all the others forward. */
7532 tem0
= AREF (menu_bar_items_vector
, i
+ 0);
7533 tem1
= AREF (menu_bar_items_vector
, i
+ 1);
7534 tem2
= AREF (menu_bar_items_vector
, i
+ 2);
7535 tem3
= AREF (menu_bar_items_vector
, i
+ 3);
7537 memmove (aref_addr (menu_bar_items_vector
, i
),
7538 aref_addr (menu_bar_items_vector
, i
+ 4),
7539 (end
- i
- 4) * word_size
);
7540 ASET (menu_bar_items_vector
, end
- 4, tem0
);
7541 ASET (menu_bar_items_vector
, end
- 3, tem1
);
7542 ASET (menu_bar_items_vector
, end
- 2, tem2
);
7543 ASET (menu_bar_items_vector
, end
- 1, tem3
);
7548 /* Add nil, nil, nil, nil at the end. */
7550 int i
= menu_bar_items_index
;
7551 if (i
+ 4 > ASIZE (menu_bar_items_vector
))
7552 menu_bar_items_vector
7553 = larger_vector (menu_bar_items_vector
, 4, -1);
7554 /* Add this item. */
7555 ASET (menu_bar_items_vector
, i
, Qnil
); i
++;
7556 ASET (menu_bar_items_vector
, i
, Qnil
); i
++;
7557 ASET (menu_bar_items_vector
, i
, Qnil
); i
++;
7558 ASET (menu_bar_items_vector
, i
, Qnil
); i
++;
7559 menu_bar_items_index
= i
;
7562 Vinhibit_quit
= oquit
;
7564 return menu_bar_items_vector
;
7567 /* Add one item to menu_bar_items_vector, for KEY, ITEM_STRING and DEF.
7568 If there's already an item for KEY, add this DEF to it. */
7570 Lisp_Object item_properties
;
7573 menu_bar_item (Lisp_Object key
, Lisp_Object item
, Lisp_Object dummy1
, void *dummy2
)
7575 struct gcpro gcpro1
;
7580 if (EQ (item
, Qundefined
))
7582 /* If a map has an explicit `undefined' as definition,
7583 discard any previously made menu bar item. */
7585 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7586 if (EQ (key
, AREF (menu_bar_items_vector
, i
)))
7588 if (menu_bar_items_index
> i
+ 4)
7589 memmove (aref_addr (menu_bar_items_vector
, i
),
7590 aref_addr (menu_bar_items_vector
, i
+ 4),
7591 (menu_bar_items_index
- i
- 4) * word_size
);
7592 menu_bar_items_index
-= 4;
7596 /* If this keymap has already contributed to this KEY,
7597 don't contribute to it a second time. */
7598 tem
= Fmemq (key
, menu_bar_one_keymap_changed_items
);
7599 if (!NILP (tem
) || NILP (item
))
7602 menu_bar_one_keymap_changed_items
7603 = Fcons (key
, menu_bar_one_keymap_changed_items
);
7605 /* We add to menu_bar_one_keymap_changed_items before doing the
7606 parse_menu_item, so that if it turns out it wasn't a menu item,
7607 it still correctly hides any further menu item. */
7609 parsed
= parse_menu_item (item
, 1);
7614 item
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7616 /* Find any existing item for this KEY. */
7617 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7618 if (EQ (key
, AREF (menu_bar_items_vector
, i
)))
7621 /* If we did not find this KEY, add it at the end. */
7622 if (i
== menu_bar_items_index
)
7624 /* If vector is too small, get a bigger one. */
7625 if (i
+ 4 > ASIZE (menu_bar_items_vector
))
7626 menu_bar_items_vector
= larger_vector (menu_bar_items_vector
, 4, -1);
7627 /* Add this item. */
7628 ASET (menu_bar_items_vector
, i
, key
); i
++;
7629 ASET (menu_bar_items_vector
, i
,
7630 AREF (item_properties
, ITEM_PROPERTY_NAME
)); i
++;
7631 ASET (menu_bar_items_vector
, i
, list1 (item
)); i
++;
7632 ASET (menu_bar_items_vector
, i
, make_number (0)); i
++;
7633 menu_bar_items_index
= i
;
7635 /* We did find an item for this KEY. Add ITEM to its list of maps. */
7639 old
= AREF (menu_bar_items_vector
, i
+ 2);
7640 /* If the new and the old items are not both keymaps,
7641 the lookup will only find `item'. */
7642 item
= Fcons (item
, KEYMAPP (item
) && KEYMAPP (XCAR (old
)) ? old
: Qnil
);
7643 ASET (menu_bar_items_vector
, i
+ 2, item
);
7647 /* This is used as the handler when calling menu_item_eval_property. */
7649 menu_item_eval_property_1 (Lisp_Object arg
)
7651 /* If we got a quit from within the menu computation,
7652 quit all the way out of it. This takes care of C-] in the debugger. */
7653 if (CONSP (arg
) && EQ (XCAR (arg
), Qquit
))
7654 Fsignal (Qquit
, Qnil
);
7660 eval_dyn (Lisp_Object form
)
7662 return Feval (form
, Qnil
);
7665 /* Evaluate an expression and return the result (or nil if something
7666 went wrong). Used to evaluate dynamic parts of menu items. */
7668 menu_item_eval_property (Lisp_Object sexpr
)
7670 ptrdiff_t count
= SPECPDL_INDEX ();
7672 specbind (Qinhibit_redisplay
, Qt
);
7673 val
= internal_condition_case_1 (eval_dyn
, sexpr
, Qerror
,
7674 menu_item_eval_property_1
);
7675 return unbind_to (count
, val
);
7678 /* This function parses a menu item and leaves the result in the
7679 vector item_properties.
7680 ITEM is a key binding, a possible menu item.
7681 INMENUBAR is > 0 when this is considered for an entry in a menu bar
7683 INMENUBAR is < 0 when this is considered for an entry in a keyboard menu.
7684 parse_menu_item returns true if the item is a menu item and false
7688 parse_menu_item (Lisp_Object item
, int inmenubar
)
7690 Lisp_Object def
, tem
, item_string
, start
;
7692 Lisp_Object keyhint
;
7701 /* Create item_properties vector if necessary. */
7702 if (NILP (item_properties
))
7704 = Fmake_vector (make_number (ITEM_PROPERTY_ENABLE
+ 1), Qnil
);
7706 /* Initialize optional entries. */
7707 for (i
= ITEM_PROPERTY_DEF
; i
< ITEM_PROPERTY_ENABLE
; i
++)
7708 ASET (item_properties
, i
, Qnil
);
7709 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7711 /* Save the item here to protect it from GC. */
7712 ASET (item_properties
, ITEM_PROPERTY_ITEM
, item
);
7714 item_string
= XCAR (item
);
7718 if (STRINGP (item_string
))
7720 /* Old format menu item. */
7721 ASET (item_properties
, ITEM_PROPERTY_NAME
, item_string
);
7723 /* Maybe help string. */
7724 if (CONSP (item
) && STRINGP (XCAR (item
)))
7726 ASET (item_properties
, ITEM_PROPERTY_HELP
, XCAR (item
));
7731 /* Maybe an obsolete key binding cache. */
7732 if (CONSP (item
) && CONSP (XCAR (item
))
7733 && (NILP (XCAR (XCAR (item
)))
7734 || VECTORP (XCAR (XCAR (item
)))))
7737 /* This is the real definition--the function to run. */
7738 ASET (item_properties
, ITEM_PROPERTY_DEF
, item
);
7740 /* Get enable property, if any. */
7743 tem
= Fget (item
, Qmenu_enable
);
7744 if (!NILP (Venable_disabled_menus_and_buttons
))
7745 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7746 else if (!NILP (tem
))
7747 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, tem
);
7750 else if (EQ (item_string
, Qmenu_item
) && CONSP (item
))
7752 /* New format menu item. */
7753 ASET (item_properties
, ITEM_PROPERTY_NAME
, XCAR (item
));
7754 start
= XCDR (item
);
7757 /* We have a real binding. */
7758 ASET (item_properties
, ITEM_PROPERTY_DEF
, XCAR (start
));
7760 item
= XCDR (start
);
7761 /* Is there an obsolete cache list with key equivalences. */
7762 if (CONSP (item
) && CONSP (XCAR (item
)))
7765 /* Parse properties. */
7766 while (CONSP (item
) && CONSP (XCDR (item
)))
7771 if (EQ (tem
, QCenable
))
7773 if (!NILP (Venable_disabled_menus_and_buttons
))
7774 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7776 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, XCAR (item
));
7778 else if (EQ (tem
, QCvisible
))
7780 /* If got a visible property and that evaluates to nil
7781 then ignore this item. */
7782 tem
= menu_item_eval_property (XCAR (item
));
7786 else if (EQ (tem
, QChelp
))
7787 ASET (item_properties
, ITEM_PROPERTY_HELP
, XCAR (item
));
7788 else if (EQ (tem
, QCfilter
))
7790 else if (EQ (tem
, QCkey_sequence
))
7793 if (SYMBOLP (tem
) || STRINGP (tem
) || VECTORP (tem
))
7794 /* Be GC protected. Set keyhint to item instead of tem. */
7797 else if (EQ (tem
, QCkeys
))
7800 if (CONSP (tem
) || STRINGP (tem
))
7801 ASET (item_properties
, ITEM_PROPERTY_KEYEQ
, tem
);
7803 else if (EQ (tem
, QCbutton
) && CONSP (XCAR (item
)))
7808 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
7810 ASET (item_properties
, ITEM_PROPERTY_SELECTED
,
7812 ASET (item_properties
, ITEM_PROPERTY_TYPE
, type
);
7818 else if (inmenubar
|| !NILP (start
))
7822 return 0; /* not a menu item */
7824 /* If item string is not a string, evaluate it to get string.
7825 If we don't get a string, skip this item. */
7826 item_string
= AREF (item_properties
, ITEM_PROPERTY_NAME
);
7827 if (!(STRINGP (item_string
)))
7829 item_string
= menu_item_eval_property (item_string
);
7830 if (!STRINGP (item_string
))
7832 ASET (item_properties
, ITEM_PROPERTY_NAME
, item_string
);
7835 /* If got a filter apply it on definition. */
7836 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7839 def
= menu_item_eval_property (list2 (XCAR (filter
),
7840 list2 (Qquote
, def
)));
7842 ASET (item_properties
, ITEM_PROPERTY_DEF
, def
);
7845 /* Enable or disable selection of item. */
7846 tem
= AREF (item_properties
, ITEM_PROPERTY_ENABLE
);
7849 tem
= menu_item_eval_property (tem
);
7850 if (inmenubar
&& NILP (tem
))
7851 return 0; /* Ignore disabled items in menu bar. */
7852 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, tem
);
7855 /* If we got no definition, this item is just unselectable text which
7856 is OK in a submenu but not in the menubar. */
7858 return (!inmenubar
);
7860 /* See if this is a separate pane or a submenu. */
7861 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7862 tem
= get_keymap (def
, 0, 1);
7863 /* For a subkeymap, just record its details and exit. */
7866 ASET (item_properties
, ITEM_PROPERTY_MAP
, tem
);
7867 ASET (item_properties
, ITEM_PROPERTY_DEF
, tem
);
7871 /* At the top level in the menu bar, do likewise for commands also.
7872 The menu bar does not display equivalent key bindings anyway.
7873 ITEM_PROPERTY_DEF is already set up properly. */
7877 { /* This is a command. See if there is an equivalent key binding. */
7878 Lisp_Object keyeq
= AREF (item_properties
, ITEM_PROPERTY_KEYEQ
);
7879 AUTO_STRING (space_space
, " ");
7881 /* The previous code preferred :key-sequence to :keys, so we
7882 preserve this behavior. */
7883 if (STRINGP (keyeq
) && !CONSP (keyhint
))
7884 keyeq
= concat2 (space_space
, Fsubstitute_command_keys (keyeq
));
7887 Lisp_Object prefix
= keyeq
;
7888 Lisp_Object keys
= Qnil
;
7892 def
= XCAR (prefix
);
7893 prefix
= XCDR (prefix
);
7896 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7898 if (CONSP (keyhint
) && !NILP (XCAR (keyhint
)))
7900 keys
= XCAR (keyhint
);
7901 tem
= Fkey_binding (keys
, Qnil
, Qnil
, Qnil
);
7903 /* We have a suggested key. Is it bound to the command? */
7906 /* If the command is an alias for another
7907 (such as lmenu.el set it up), check if the
7908 original command matches the cached command. */
7910 && EQ (tem
, XSYMBOL (def
)->function
))))
7915 keys
= Fwhere_is_internal (def
, Qnil
, Qt
, Qnil
, Qnil
);
7919 tem
= Fkey_description (keys
, Qnil
);
7922 if (STRINGP (XCAR (prefix
)))
7923 tem
= concat2 (XCAR (prefix
), tem
);
7924 if (STRINGP (XCDR (prefix
)))
7925 tem
= concat2 (tem
, XCDR (prefix
));
7927 keyeq
= concat2 (space_space
, tem
);
7933 /* If we have an equivalent key binding, use that. */
7934 ASET (item_properties
, ITEM_PROPERTY_KEYEQ
, keyeq
);
7937 /* Include this when menu help is implemented.
7938 tem = XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP];
7939 if (!(NILP (tem) || STRINGP (tem)))
7941 tem = menu_item_eval_property (tem);
7944 XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP] = tem;
7948 /* Handle radio buttons or toggle boxes. */
7949 tem
= AREF (item_properties
, ITEM_PROPERTY_SELECTED
);
7951 ASET (item_properties
, ITEM_PROPERTY_SELECTED
,
7952 menu_item_eval_property (tem
));
7959 /***********************************************************************
7961 ***********************************************************************/
7963 /* A vector holding tool bar items while they are parsed in function
7964 tool_bar_items. Each item occupies TOOL_BAR_ITEM_NSCLOTS elements
7967 static Lisp_Object tool_bar_items_vector
;
7969 /* A vector holding the result of parse_tool_bar_item. Layout is like
7970 the one for a single item in tool_bar_items_vector. */
7972 static Lisp_Object tool_bar_item_properties
;
7974 /* Next free index in tool_bar_items_vector. */
7976 static int ntool_bar_items
;
7978 /* Function prototypes. */
7980 static void init_tool_bar_items (Lisp_Object
);
7981 static void process_tool_bar_item (Lisp_Object
, Lisp_Object
, Lisp_Object
,
7983 static bool parse_tool_bar_item (Lisp_Object
, Lisp_Object
);
7984 static void append_tool_bar_item (void);
7987 /* Return a vector of tool bar items for keymaps currently in effect.
7988 Reuse vector REUSE if non-nil. Return in *NITEMS the number of
7989 tool bar items found. */
7992 tool_bar_items (Lisp_Object reuse
, int *nitems
)
7995 Lisp_Object mapsbuf
[3];
8003 /* In order to build the menus, we need to call the keymap
8004 accessors. They all call QUIT. But this function is called
8005 during redisplay, during which a quit is fatal. So inhibit
8006 quitting while building the menus. We do this instead of
8007 specbind because (1) errors will clear it anyway and (2) this
8008 avoids risk of specpdl overflow. */
8009 oquit
= Vinhibit_quit
;
8012 /* Initialize tool_bar_items_vector and protect it from GC. */
8013 init_tool_bar_items (reuse
);
8015 /* Build list of keymaps in maps. Set nmaps to the number of maps
8018 /* Should overriding-terminal-local-map and overriding-local-map apply? */
8019 if (!NILP (Voverriding_local_map_menu_flag
)
8020 && !NILP (Voverriding_local_map
))
8022 /* Yes, use them (if non-nil) as well as the global map. */
8025 if (!NILP (KVAR (current_kboard
, Voverriding_terminal_local_map
)))
8026 maps
[nmaps
++] = KVAR (current_kboard
, Voverriding_terminal_local_map
);
8027 if (!NILP (Voverriding_local_map
))
8028 maps
[nmaps
++] = Voverriding_local_map
;
8032 /* No, so use major and minor mode keymaps and keymap property.
8033 Note that tool-bar bindings in the local-map and keymap
8034 properties may not work reliable, as they are only
8035 recognized when the tool-bar (or mode-line) is updated,
8036 which does not normally happen after every command. */
8039 nminor
= current_minor_maps (NULL
, &tmaps
);
8040 SAFE_NALLOCA (maps
, 1, nminor
+ 4);
8042 tem
= KVAR (current_kboard
, Voverriding_terminal_local_map
);
8043 if (!NILP (tem
) && !NILP (Voverriding_local_map_menu_flag
))
8044 maps
[nmaps
++] = tem
;
8045 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
8046 maps
[nmaps
++] = tem
;
8047 memcpy (maps
+ nmaps
, tmaps
, nminor
* sizeof (maps
[0]));
8049 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
8052 /* Add global keymap at the end. */
8053 maps
[nmaps
++] = current_global_map
;
8055 /* Process maps in reverse order and look up in each map the prefix
8057 for (i
= nmaps
- 1; i
>= 0; --i
)
8058 if (!NILP (maps
[i
]))
8062 keymap
= get_keymap (access_keymap (maps
[i
], Qtool_bar
, 1, 0, 1), 0, 1);
8064 map_keymap (keymap
, process_tool_bar_item
, Qnil
, NULL
, 1);
8067 Vinhibit_quit
= oquit
;
8068 *nitems
= ntool_bar_items
/ TOOL_BAR_ITEM_NSLOTS
;
8070 return tool_bar_items_vector
;
8074 /* Process the definition of KEY which is DEF. */
8077 process_tool_bar_item (Lisp_Object key
, Lisp_Object def
, Lisp_Object data
, void *args
)
8080 struct gcpro gcpro1
, gcpro2
;
8082 /* Protect KEY and DEF from GC because parse_tool_bar_item may call
8086 if (EQ (def
, Qundefined
))
8088 /* If a map has an explicit `undefined' as definition,
8089 discard any previously made item. */
8090 for (i
= 0; i
< ntool_bar_items
; i
+= TOOL_BAR_ITEM_NSLOTS
)
8092 Lisp_Object
*v
= XVECTOR (tool_bar_items_vector
)->contents
+ i
;
8094 if (EQ (key
, v
[TOOL_BAR_ITEM_KEY
]))
8096 if (ntool_bar_items
> i
+ TOOL_BAR_ITEM_NSLOTS
)
8097 memmove (v
, v
+ TOOL_BAR_ITEM_NSLOTS
,
8098 ((ntool_bar_items
- i
- TOOL_BAR_ITEM_NSLOTS
)
8100 ntool_bar_items
-= TOOL_BAR_ITEM_NSLOTS
;
8105 else if (parse_tool_bar_item (key
, def
))
8106 /* Append a new tool bar item to tool_bar_items_vector. Accept
8107 more than one definition for the same key. */
8108 append_tool_bar_item ();
8113 /* Access slot with index IDX of vector tool_bar_item_properties. */
8114 #define PROP(IDX) AREF (tool_bar_item_properties, (IDX))
8116 set_prop (ptrdiff_t idx
, Lisp_Object val
)
8118 ASET (tool_bar_item_properties
, idx
, val
);
8122 /* Parse a tool bar item specification ITEM for key KEY and return the
8123 result in tool_bar_item_properties. Value is false if ITEM is
8126 ITEM is a list `(menu-item CAPTION BINDING PROPS...)'.
8128 CAPTION is the caption of the item, If it's not a string, it is
8129 evaluated to get a string.
8131 BINDING is the tool bar item's binding. Tool-bar items with keymaps
8132 as binding are currently ignored.
8134 The following properties are recognized:
8138 FORM is evaluated and specifies whether the tool bar item is
8139 enabled or disabled.
8143 FORM is evaluated and specifies whether the tool bar item is visible.
8145 - `:filter FUNCTION'
8147 FUNCTION is invoked with one parameter `(quote BINDING)'. Its
8148 result is stored as the new binding.
8150 - `:button (TYPE SELECTED)'
8152 TYPE must be one of `:radio' or `:toggle'. SELECTED is evaluated
8153 and specifies whether the button is selected (pressed) or not.
8157 IMAGES is either a single image specification or a vector of four
8158 image specifications. See enum tool_bar_item_images.
8160 - `:help HELP-STRING'.
8162 Gives a help string to display for the tool bar item.
8164 - `:label LABEL-STRING'.
8166 A text label to show with the tool bar button if labels are enabled. */
8169 parse_tool_bar_item (Lisp_Object key
, Lisp_Object item
)
8171 Lisp_Object filter
= Qnil
;
8172 Lisp_Object caption
;
8174 bool have_label
= 0;
8176 /* Definition looks like `(menu-item CAPTION BINDING PROPS...)'.
8177 Rule out items that aren't lists, don't start with
8178 `menu-item' or whose rest following `tool-bar-item' is not a
8183 /* As an exception, allow old-style menu separators. */
8184 if (STRINGP (XCAR (item
)))
8185 item
= list1 (XCAR (item
));
8186 else if (!EQ (XCAR (item
), Qmenu_item
)
8187 || (item
= XCDR (item
), !CONSP (item
)))
8190 /* Create tool_bar_item_properties vector if necessary. Reset it to
8192 if (VECTORP (tool_bar_item_properties
))
8194 for (i
= 0; i
< TOOL_BAR_ITEM_NSLOTS
; ++i
)
8198 tool_bar_item_properties
8199 = Fmake_vector (make_number (TOOL_BAR_ITEM_NSLOTS
), Qnil
);
8202 set_prop (TOOL_BAR_ITEM_KEY
, key
);
8203 set_prop (TOOL_BAR_ITEM_ENABLED_P
, Qt
);
8205 /* Get the caption of the item. If the caption is not a string,
8206 evaluate it to get a string. If we don't get a string, skip this
8208 caption
= XCAR (item
);
8209 if (!STRINGP (caption
))
8211 caption
= menu_item_eval_property (caption
);
8212 if (!STRINGP (caption
))
8215 set_prop (TOOL_BAR_ITEM_CAPTION
, caption
);
8217 /* If the rest following the caption is not a list, the menu item is
8218 either a separator, or invalid. */
8222 if (menu_separator_name_p (SSDATA (caption
)))
8224 set_prop (TOOL_BAR_ITEM_TYPE
, Qt
);
8225 #if !defined (USE_GTK) && !defined (HAVE_NS)
8226 /* If we use build_desired_tool_bar_string to render the
8227 tool bar, the separator is rendered as an image. */
8228 set_prop (TOOL_BAR_ITEM_IMAGES
,
8229 (menu_item_eval_property
8230 (Vtool_bar_separator_image_expression
)));
8231 set_prop (TOOL_BAR_ITEM_ENABLED_P
, Qnil
);
8232 set_prop (TOOL_BAR_ITEM_SELECTED_P
, Qnil
);
8233 set_prop (TOOL_BAR_ITEM_CAPTION
, Qnil
);
8240 /* Store the binding. */
8241 set_prop (TOOL_BAR_ITEM_BINDING
, XCAR (item
));
8244 /* Ignore cached key binding, if any. */
8245 if (CONSP (item
) && CONSP (XCAR (item
)))
8248 /* Process the rest of the properties. */
8249 for (; CONSP (item
) && CONSP (XCDR (item
)); item
= XCDR (XCDR (item
)))
8251 Lisp_Object ikey
, value
;
8254 value
= XCAR (XCDR (item
));
8256 if (EQ (ikey
, QCenable
))
8258 /* `:enable FORM'. */
8259 if (!NILP (Venable_disabled_menus_and_buttons
))
8260 set_prop (TOOL_BAR_ITEM_ENABLED_P
, Qt
);
8262 set_prop (TOOL_BAR_ITEM_ENABLED_P
, value
);
8264 else if (EQ (ikey
, QCvisible
))
8266 /* `:visible FORM'. If got a visible property and that
8267 evaluates to nil then ignore this item. */
8268 if (NILP (menu_item_eval_property (value
)))
8271 else if (EQ (ikey
, QChelp
))
8272 /* `:help HELP-STRING'. */
8273 set_prop (TOOL_BAR_ITEM_HELP
, value
);
8274 else if (EQ (ikey
, QCvert_only
))
8275 /* `:vert-only t/nil'. */
8276 set_prop (TOOL_BAR_ITEM_VERT_ONLY
, value
);
8277 else if (EQ (ikey
, QClabel
))
8279 const char *bad_label
= "!!?GARBLED ITEM?!!";
8280 /* `:label LABEL-STRING'. */
8281 set_prop (TOOL_BAR_ITEM_LABEL
,
8282 STRINGP (value
) ? value
: build_string (bad_label
));
8285 else if (EQ (ikey
, QCfilter
))
8286 /* ':filter FORM'. */
8288 else if (EQ (ikey
, QCbutton
) && CONSP (value
))
8290 /* `:button (TYPE . SELECTED)'. */
8291 Lisp_Object type
, selected
;
8293 type
= XCAR (value
);
8294 selected
= XCDR (value
);
8295 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
8297 set_prop (TOOL_BAR_ITEM_SELECTED_P
, selected
);
8298 set_prop (TOOL_BAR_ITEM_TYPE
, type
);
8301 else if (EQ (ikey
, QCimage
)
8303 || (VECTORP (value
) && ASIZE (value
) == 4)))
8304 /* Value is either a single image specification or a vector
8305 of 4 such specifications for the different button states. */
8306 set_prop (TOOL_BAR_ITEM_IMAGES
, value
);
8307 else if (EQ (ikey
, QCrtl
))
8309 set_prop (TOOL_BAR_ITEM_RTL_IMAGE
, value
);
8315 /* Try to make one from caption and key. */
8316 Lisp_Object tkey
= PROP (TOOL_BAR_ITEM_KEY
);
8317 Lisp_Object tcapt
= PROP (TOOL_BAR_ITEM_CAPTION
);
8318 const char *label
= SYMBOLP (tkey
) ? SSDATA (SYMBOL_NAME (tkey
)) : "";
8319 const char *capt
= STRINGP (tcapt
) ? SSDATA (tcapt
) : "";
8321 2 * max (0, min (tool_bar_max_label_size
, STRING_BYTES_BOUND
/ 2));
8322 char *buf
= xmalloc (max_lbl
+ 1);
8323 Lisp_Object new_lbl
;
8324 ptrdiff_t caption_len
= strlen (capt
);
8326 if (caption_len
<= max_lbl
&& capt
[0] != '\0')
8329 while (caption_len
> 0 && buf
[caption_len
- 1] == '.')
8331 buf
[caption_len
] = '\0';
8335 if (strlen (label
) <= max_lbl
&& label
[0] != '\0')
8339 strcpy (buf
, label
);
8341 for (j
= 0; buf
[j
] != '\0'; ++j
)
8349 new_lbl
= Fupcase_initials (build_string (label
));
8350 if (SCHARS (new_lbl
) <= tool_bar_max_label_size
)
8351 set_prop (TOOL_BAR_ITEM_LABEL
, new_lbl
);
8353 set_prop (TOOL_BAR_ITEM_LABEL
, empty_unibyte_string
);
8357 /* If got a filter apply it on binding. */
8359 set_prop (TOOL_BAR_ITEM_BINDING
,
8360 (menu_item_eval_property
8363 PROP (TOOL_BAR_ITEM_BINDING
))))));
8365 /* See if the binding is a keymap. Give up if it is. */
8366 if (CONSP (get_keymap (PROP (TOOL_BAR_ITEM_BINDING
), 0, 1)))
8369 /* Enable or disable selection of item. */
8370 if (!EQ (PROP (TOOL_BAR_ITEM_ENABLED_P
), Qt
))
8371 set_prop (TOOL_BAR_ITEM_ENABLED_P
,
8372 menu_item_eval_property (PROP (TOOL_BAR_ITEM_ENABLED_P
)));
8374 /* Handle radio buttons or toggle boxes. */
8375 if (!NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
)))
8376 set_prop (TOOL_BAR_ITEM_SELECTED_P
,
8377 menu_item_eval_property (PROP (TOOL_BAR_ITEM_SELECTED_P
)));
8385 /* Initialize tool_bar_items_vector. REUSE, if non-nil, is a vector
8386 that can be reused. */
8389 init_tool_bar_items (Lisp_Object reuse
)
8391 if (VECTORP (reuse
))
8392 tool_bar_items_vector
= reuse
;
8394 tool_bar_items_vector
= Fmake_vector (make_number (64), Qnil
);
8395 ntool_bar_items
= 0;
8399 /* Append parsed tool bar item properties from
8400 tool_bar_item_properties */
8403 append_tool_bar_item (void)
8407 - (ASIZE (tool_bar_items_vector
) - TOOL_BAR_ITEM_NSLOTS
));
8409 /* Enlarge tool_bar_items_vector if necessary. */
8411 tool_bar_items_vector
= larger_vector (tool_bar_items_vector
, incr
, -1);
8413 /* Append entries from tool_bar_item_properties to the end of
8414 tool_bar_items_vector. */
8415 vcopy (tool_bar_items_vector
, ntool_bar_items
,
8416 XVECTOR (tool_bar_item_properties
)->contents
, TOOL_BAR_ITEM_NSLOTS
);
8417 ntool_bar_items
+= TOOL_BAR_ITEM_NSLOTS
;
8424 /* Read a character using menus based on the keymap MAP.
8425 Return nil if there are no menus in the maps.
8426 Return t if we displayed a menu but the user rejected it.
8428 PREV_EVENT is the previous input event, or nil if we are reading
8429 the first event of a key sequence.
8431 If USED_MOUSE_MENU is non-null, set *USED_MOUSE_MENU to true
8432 if we used a mouse menu to read the input, or false otherwise. If
8433 USED_MOUSE_MENU is null, don't dereference it.
8435 The prompting is done based on the prompt-string of the map
8436 and the strings associated with various map elements.
8438 This can be done with X menus or with menus put in the minibuf.
8439 These are done in different ways, depending on how the input will be read.
8440 Menus using X are done after auto-saving in read-char, getting the input
8441 event from Fx_popup_menu; menus using the minibuf use read_char recursively
8442 and do auto-saving in the inner call of read_char. */
8445 read_char_x_menu_prompt (Lisp_Object map
,
8446 Lisp_Object prev_event
, bool *used_mouse_menu
)
8448 if (used_mouse_menu
)
8449 *used_mouse_menu
= 0;
8451 /* Use local over global Menu maps. */
8453 if (! menu_prompting
)
8456 /* If we got to this point via a mouse click,
8457 use a real menu for mouse selection. */
8458 if (EVENT_HAS_PARAMETERS (prev_event
)
8459 && !EQ (XCAR (prev_event
), Qmenu_bar
)
8460 && !EQ (XCAR (prev_event
), Qtool_bar
))
8462 /* Display the menu and get the selection. */
8465 value
= Fx_popup_menu (prev_event
, get_keymap (map
, 0, 1));
8470 record_menu_key (XCAR (value
));
8472 /* If we got multiple events, unread all but
8474 There is no way to prevent those unread events
8475 from showing up later in last_nonmenu_event.
8476 So turn symbol and integer events into lists,
8477 to indicate that they came from a mouse menu,
8478 so that when present in last_nonmenu_event
8479 they won't confuse things. */
8480 for (tem
= XCDR (value
); CONSP (tem
); tem
= XCDR (tem
))
8482 record_menu_key (XCAR (tem
));
8483 if (SYMBOLP (XCAR (tem
))
8484 || INTEGERP (XCAR (tem
)))
8485 XSETCAR (tem
, Fcons (XCAR (tem
), Qdisabled
));
8488 /* If we got more than one event, put all but the first
8489 onto this list to be read later.
8490 Return just the first event now. */
8491 Vunread_command_events
8492 = nconc2 (XCDR (value
), Vunread_command_events
);
8493 value
= XCAR (value
);
8495 else if (NILP (value
))
8497 if (used_mouse_menu
)
8498 *used_mouse_menu
= 1;
8505 read_char_minibuf_menu_prompt (int commandflag
,
8510 /* FIXME: Use the minibuffer's frame width. */
8511 ptrdiff_t width
= FRAME_COLS (SELECTED_FRAME ()) - 4;
8513 bool nobindings
= 1;
8514 Lisp_Object rest
, vector
;
8515 Lisp_Object prompt_strings
= Qnil
;
8519 if (! menu_prompting
)
8522 map
= get_keymap (map
, 0, 1);
8523 name
= Fkeymap_prompt (map
);
8525 /* If we don't have any menus, just read a character normally. */
8526 if (!STRINGP (name
))
8529 #define PUSH_C_STR(str, listvar) \
8530 listvar = Fcons (build_unibyte_string (str), listvar)
8532 /* Prompt string always starts with map's prompt, and a space. */
8533 prompt_strings
= Fcons (name
, prompt_strings
);
8534 PUSH_C_STR (": ", prompt_strings
);
8535 nlength
= SCHARS (name
) + 2;
8539 /* Present the documented bindings, a line at a time. */
8543 Lisp_Object menu_strings
= prompt_strings
;
8544 ptrdiff_t i
= nlength
;
8546 Lisp_Object orig_defn_macro
;
8548 /* Loop over elements of map. */
8553 /* FIXME: Use map_keymap to handle new keymap formats. */
8555 /* At end of map, wrap around if just starting,
8556 or end this line if already have something on it. */
8559 if (notfirst
|| nobindings
)
8565 /* Look at the next element of the map. */
8567 elt
= AREF (vector
, idx
);
8569 elt
= Fcar_safe (rest
);
8571 if (idx
< 0 && VECTORP (elt
))
8573 /* If we found a dense table in the keymap,
8574 advanced past it, but start scanning its contents. */
8575 rest
= Fcdr_safe (rest
);
8581 /* An ordinary element. */
8582 Lisp_Object event
, tem
;
8586 event
= Fcar_safe (elt
); /* alist */
8587 elt
= Fcdr_safe (elt
);
8591 XSETINT (event
, idx
); /* vector */
8594 /* Ignore the element if it has no prompt string. */
8595 if (INTEGERP (event
) && parse_menu_item (elt
, -1))
8597 /* True if the char to type matches the string. */
8599 Lisp_Object upcased_event
, downcased_event
;
8600 Lisp_Object desc
= Qnil
;
8602 = AREF (item_properties
, ITEM_PROPERTY_NAME
);
8604 upcased_event
= Fupcase (event
);
8605 downcased_event
= Fdowncase (event
);
8606 char_matches
= (XINT (upcased_event
) == SREF (s
, 0)
8607 || XINT (downcased_event
) == SREF (s
, 0));
8609 desc
= Fsingle_key_description (event
, Qnil
);
8611 #if 0 /* It is redundant to list the equivalent key bindings because
8612 the prefix is what the user has already typed. */
8614 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_KEYEQ
];
8616 /* Insert equivalent keybinding. */
8617 s
= concat2 (s
, tem
);
8620 = AREF (item_properties
, ITEM_PROPERTY_TYPE
);
8621 if (EQ (tem
, QCradio
) || EQ (tem
, QCtoggle
))
8623 /* Insert button prefix. */
8624 Lisp_Object selected
8625 = AREF (item_properties
, ITEM_PROPERTY_SELECTED
);
8626 AUTO_STRING (radio_yes
, "(*) ");
8627 AUTO_STRING (radio_no
, "( ) ");
8628 AUTO_STRING (check_yes
, "[X] ");
8629 AUTO_STRING (check_no
, "[ ] ");
8630 if (EQ (tem
, QCradio
))
8631 tem
= NILP (selected
) ? radio_yes
: radio_no
;
8633 tem
= NILP (selected
) ? check_yes
: check_no
;
8634 s
= concat2 (tem
, s
);
8638 /* If we have room for the prompt string, add it to this line.
8639 If this is the first on the line, always add it. */
8640 if ((SCHARS (s
) + i
+ 2
8641 + (char_matches
? 0 : SCHARS (desc
) + 3))
8645 ptrdiff_t thiswidth
;
8647 /* Punctuate between strings. */
8650 PUSH_C_STR (", ", menu_strings
);
8656 /* If the char to type doesn't match the string's
8657 first char, explicitly show what char to type. */
8660 /* Add as much of string as fits. */
8661 thiswidth
= min (SCHARS (desc
), width
- i
);
8663 = Fcons (Fsubstring (desc
, make_number (0),
8664 make_number (thiswidth
)),
8667 PUSH_C_STR (" = ", menu_strings
);
8671 /* Add as much of string as fits. */
8672 thiswidth
= min (SCHARS (s
), width
- i
);
8674 = Fcons (Fsubstring (s
, make_number (0),
8675 make_number (thiswidth
)),
8681 /* If this element does not fit, end the line now,
8682 and save the element for the next line. */
8683 PUSH_C_STR ("...", menu_strings
);
8688 /* Move past this element. */
8689 if (idx
>= 0 && idx
+ 1 >= ASIZE (vector
))
8690 /* Handle reaching end of dense table. */
8695 rest
= Fcdr_safe (rest
);
8699 /* Prompt with that and read response. */
8700 message3_nolog (apply1 (intern ("concat"), Fnreverse (menu_strings
)));
8702 /* Make believe it's not a keyboard macro in case the help char
8703 is pressed. Help characters are not recorded because menu prompting
8704 is not used on replay. */
8705 orig_defn_macro
= KVAR (current_kboard
, defining_kbd_macro
);
8706 kset_defining_kbd_macro (current_kboard
, Qnil
);
8708 obj
= read_char (commandflag
, Qnil
, Qt
, 0, NULL
);
8709 while (BUFFERP (obj
));
8710 kset_defining_kbd_macro (current_kboard
, orig_defn_macro
);
8712 if (!INTEGERP (obj
) || XINT (obj
) == -2
8713 || (! EQ (obj
, menu_prompt_more_char
)
8714 && (!INTEGERP (menu_prompt_more_char
)
8715 || ! EQ (obj
, make_number (Ctl (XINT (menu_prompt_more_char
)))))))
8717 if (!NILP (KVAR (current_kboard
, defining_kbd_macro
)))
8718 store_kbd_macro_char (obj
);
8721 /* Help char - go round again. */
8725 /* Reading key sequences. */
8728 follow_key (Lisp_Object keymap
, Lisp_Object key
)
8730 return access_keymap (get_keymap (keymap
, 0, 1),
8735 active_maps (Lisp_Object first_event
)
8737 Lisp_Object position
8738 = CONSP (first_event
) ? CAR_SAFE (XCDR (first_event
)) : Qnil
;
8739 return Fcons (Qkeymap
, Fcurrent_active_maps (Qt
, position
));
8742 /* Structure used to keep track of partial application of key remapping
8743 such as Vfunction_key_map and Vkey_translation_map. */
8744 typedef struct keyremap
8746 /* This is the map originally specified for this use. */
8748 /* This is a submap reached by looking up, in PARENT,
8749 the events from START to END. */
8751 /* Positions [START, END) in the key sequence buffer
8752 are the key that we have scanned so far.
8753 Those events are the ones that we will replace
8754 if PARENT maps them into a key sequence. */
8758 /* Lookup KEY in MAP.
8759 MAP is a keymap mapping keys to key vectors or functions.
8760 If the mapping is a function and DO_FUNCALL is true,
8761 the function is called with PROMPT as parameter and its return
8762 value is used as the return value of this function (after checking
8763 that it is indeed a vector). */
8766 access_keymap_keyremap (Lisp_Object map
, Lisp_Object key
, Lisp_Object prompt
,
8771 next
= access_keymap (map
, key
, 1, 0, 1);
8773 /* Handle a symbol whose function definition is a keymap
8775 if (SYMBOLP (next
) && !NILP (Ffboundp (next
))
8776 && (ARRAYP (XSYMBOL (next
)->function
)
8777 || KEYMAPP (XSYMBOL (next
)->function
)))
8778 next
= Fautoload_do_load (XSYMBOL (next
)->function
, next
, Qnil
);
8780 /* If the keymap gives a function, not an
8781 array, then call the function with one arg and use
8782 its value instead. */
8783 if (do_funcall
&& FUNCTIONP (next
))
8788 next
= call1 (next
, prompt
);
8789 /* If the function returned something invalid,
8790 barf--don't ignore it.
8791 (To ignore it safely, we would need to gcpro a bunch of
8792 other variables.) */
8793 if (! (NILP (next
) || VECTORP (next
) || STRINGP (next
)))
8794 error ("Function %s returns invalid key sequence",
8795 SSDATA (SYMBOL_NAME (tem
)));
8800 /* Do one step of the key remapping used for function-key-map and
8801 key-translation-map:
8802 KEYBUF is the buffer holding the input events.
8803 BUFSIZE is its maximum size.
8804 FKEY is a pointer to the keyremap structure to use.
8805 INPUT is the index of the last element in KEYBUF.
8806 DOIT if true says that the remapping can actually take place.
8807 DIFF is used to return the number of keys added/removed by the remapping.
8808 PARENT is the root of the keymap.
8809 PROMPT is the prompt to use if the remapping happens through a function.
8810 Return true if the remapping actually took place. */
8813 keyremap_step (Lisp_Object
*keybuf
, int bufsize
, volatile keyremap
*fkey
,
8814 int input
, bool doit
, int *diff
, Lisp_Object prompt
)
8816 Lisp_Object next
, key
;
8818 key
= keybuf
[fkey
->end
++];
8820 if (KEYMAPP (fkey
->parent
))
8821 next
= access_keymap_keyremap (fkey
->map
, key
, prompt
, doit
);
8825 /* If keybuf[fkey->start..fkey->end] is bound in the
8826 map and we're in a position to do the key remapping, replace it with
8827 the binding and restart with fkey->start at the end. */
8828 if ((VECTORP (next
) || STRINGP (next
)) && doit
)
8830 int len
= XFASTINT (Flength (next
));
8833 *diff
= len
- (fkey
->end
- fkey
->start
);
8835 if (bufsize
- input
<= *diff
)
8836 error ("Key sequence too long");
8838 /* Shift the keys that follow fkey->end. */
8840 for (i
= fkey
->end
; i
< input
; i
++)
8841 keybuf
[i
+ *diff
] = keybuf
[i
];
8843 for (i
= input
- 1; i
>= fkey
->end
; i
--)
8844 keybuf
[i
+ *diff
] = keybuf
[i
];
8845 /* Overwrite the old keys with the new ones. */
8846 for (i
= 0; i
< len
; i
++)
8847 keybuf
[fkey
->start
+ i
]
8848 = Faref (next
, make_number (i
));
8850 fkey
->start
= fkey
->end
+= *diff
;
8851 fkey
->map
= fkey
->parent
;
8856 fkey
->map
= get_keymap (next
, 0, 1);
8858 /* If we no longer have a bound suffix, try a new position for
8860 if (!CONSP (fkey
->map
))
8862 fkey
->end
= ++fkey
->start
;
8863 fkey
->map
= fkey
->parent
;
8869 test_undefined (Lisp_Object binding
)
8871 return (NILP (binding
)
8872 || EQ (binding
, Qundefined
)
8873 || (SYMBOLP (binding
)
8874 && EQ (Fcommand_remapping (binding
, Qnil
, Qnil
), Qundefined
)));
8877 /* Read a sequence of keys that ends with a non prefix character,
8878 storing it in KEYBUF, a buffer of size BUFSIZE.
8880 Return the length of the key sequence stored.
8881 Return -1 if the user rejected a command menu.
8883 Echo starting immediately unless `prompt' is 0.
8885 If PREVENT_REDISPLAY is non-zero, avoid redisplay by calling
8886 read_char with a suitable COMMANDFLAG argument.
8888 Where a key sequence ends depends on the currently active keymaps.
8889 These include any minor mode keymaps active in the current buffer,
8890 the current buffer's local map, and the global map.
8892 If a key sequence has no other bindings, we check Vfunction_key_map
8893 to see if some trailing subsequence might be the beginning of a
8894 function key's sequence. If so, we try to read the whole function
8895 key, and substitute its symbolic name into the key sequence.
8897 We ignore unbound `down-' mouse clicks. We turn unbound `drag-' and
8898 `double-' events into similar click events, if that would make them
8899 bound. We try to turn `triple-' events first into `double-' events,
8902 If we get a mouse click in a mode line, vertical divider, or other
8903 non-text area, we treat the click as if it were prefixed by the
8904 symbol denoting that area - `mode-line', `vertical-line', or
8907 If the sequence starts with a mouse click, we read the key sequence
8908 with respect to the buffer clicked on, not the current buffer.
8910 If the user switches frames in the midst of a key sequence, we put
8911 off the switch-frame event until later; the next call to
8912 read_char will return it.
8914 If FIX_CURRENT_BUFFER, we restore current_buffer
8915 from the selected window's buffer. */
8918 read_key_sequence (Lisp_Object
*keybuf
, int bufsize
, Lisp_Object prompt
,
8919 bool dont_downcase_last
, bool can_return_switch_frame
,
8920 bool fix_current_buffer
, bool prevent_redisplay
)
8922 ptrdiff_t count
= SPECPDL_INDEX ();
8924 /* How many keys there are in the current key sequence. */
8927 /* The length of the echo buffer when we started reading, and
8928 the length of this_command_keys when we started reading. */
8929 ptrdiff_t echo_start
IF_LINT (= 0);
8930 ptrdiff_t keys_start
;
8932 Lisp_Object current_binding
= Qnil
;
8933 Lisp_Object first_event
= Qnil
;
8935 /* Index of the first key that has no binding.
8936 It is useless to try fkey.start larger than that. */
8939 /* If t < mock_input, then KEYBUF[t] should be read as the next
8942 We use this to recover after recognizing a function key. Once we
8943 realize that a suffix of the current key sequence is actually a
8944 function key's escape sequence, we replace the suffix with the
8945 function key's binding from Vfunction_key_map. Now keybuf
8946 contains a new and different key sequence, so the echo area,
8947 this_command_keys, and the submaps and defs arrays are wrong. In
8948 this situation, we set mock_input to t, set t to 0, and jump to
8949 restart_sequence; the loop will read keys from keybuf up until
8950 mock_input, thus rebuilding the state; and then it will resume
8951 reading characters from the keyboard. */
8954 /* If the sequence is unbound in submaps[], then
8955 keybuf[fkey.start..fkey.end-1] is a prefix in Vfunction_key_map,
8956 and fkey.map is its binding.
8958 These might be > t, indicating that all function key scanning
8959 should hold off until t reaches them. We do this when we've just
8960 recognized a function key, to avoid searching for the function
8961 key's again in Vfunction_key_map. */
8964 /* Likewise, for key_translation_map and input-decode-map. */
8965 keyremap keytran
, indec
;
8967 /* True if we are trying to map a key by changing an upper-case
8968 letter to lower case, or a shifted function key to an unshifted
8970 bool shift_translated
= 0;
8972 /* If we receive a `switch-frame' or `select-window' event in the middle of
8973 a key sequence, we put it off for later.
8974 While we're reading, we keep the event here. */
8975 Lisp_Object delayed_switch_frame
;
8977 Lisp_Object original_uppercase
IF_LINT (= Qnil
);
8978 int original_uppercase_position
= -1;
8980 /* Gets around Microsoft compiler limitations. */
8983 struct buffer
*starting_buffer
;
8985 /* List of events for which a fake prefix key has been generated. */
8986 Lisp_Object fake_prefixed_keys
= Qnil
;
8988 struct gcpro gcpro1
;
8990 GCPRO1 (fake_prefixed_keys
);
8991 raw_keybuf_count
= 0;
8993 last_nonmenu_event
= Qnil
;
8995 delayed_switch_frame
= Qnil
;
9001 /* Install the string PROMPT as the beginning of the string
9002 of echoing, so that it serves as a prompt for the next
9004 kset_echo_string (current_kboard
, prompt
);
9005 current_kboard
->echo_after_prompt
= SCHARS (prompt
);
9008 else if (cursor_in_echo_area
9009 && echo_keystrokes_p ())
9010 /* This doesn't put in a dash if the echo buffer is empty, so
9011 you don't always see a dash hanging out in the minibuffer. */
9015 /* Record the initial state of the echo area and this_command_keys;
9016 we will need to restore them if we replay a key sequence. */
9018 echo_start
= echo_length ();
9019 keys_start
= this_command_key_count
;
9020 this_single_command_key_start
= keys_start
;
9022 /* We jump here when we need to reinitialize fkey and keytran; this
9023 happens if we switch keyboards between rescans. */
9024 replay_entire_sequence
:
9026 indec
.map
= indec
.parent
= KVAR (current_kboard
, Vinput_decode_map
);
9027 fkey
.map
= fkey
.parent
= KVAR (current_kboard
, Vlocal_function_key_map
);
9028 keytran
.map
= keytran
.parent
= Vkey_translation_map
;
9029 indec
.start
= indec
.end
= 0;
9030 fkey
.start
= fkey
.end
= 0;
9031 keytran
.start
= keytran
.end
= 0;
9033 /* We jump here when the key sequence has been thoroughly changed, and
9034 we need to rescan it starting from the beginning. When we jump here,
9035 keybuf[0..mock_input] holds the sequence we should reread. */
9038 starting_buffer
= current_buffer
;
9039 first_unbound
= bufsize
+ 1;
9041 /* Build our list of keymaps.
9042 If we recognize a function key and replace its escape sequence in
9043 keybuf with its symbol, or if the sequence starts with a mouse
9044 click and we need to switch buffers, we jump back here to rebuild
9045 the initial keymaps from the current buffer. */
9046 current_binding
= active_maps (first_event
);
9048 /* Start from the beginning in keybuf. */
9051 /* These are no-ops the first time through, but if we restart, they
9052 revert the echo area and this_command_keys to their original state. */
9053 this_command_key_count
= keys_start
;
9054 if (INTERACTIVE
&& t
< mock_input
)
9055 echo_truncate (echo_start
);
9057 /* If the best binding for the current key sequence is a keymap, or
9058 we may be looking at a function key's escape sequence, keep on
9060 while (!NILP (current_binding
)
9061 /* Keep reading as long as there's a prefix binding. */
9062 ? KEYMAPP (current_binding
)
9063 /* Don't return in the middle of a possible function key sequence,
9064 if the only bindings we found were via case conversion.
9065 Thus, if ESC O a has a function-key-map translation
9066 and ESC o has a binding, don't return after ESC O,
9067 so that we can translate ESC O plus the next character. */
9068 : (/* indec.start < t || fkey.start < t || */ keytran
.start
< t
))
9071 bool used_mouse_menu
= 0;
9073 /* Where the last real key started. If we need to throw away a
9074 key that has expanded into more than one element of keybuf
9075 (say, a mouse click on the mode line which is being treated
9076 as [mode-line (mouse-...)], then we backtrack to this point
9078 int last_real_key_start
;
9080 /* These variables are analogous to echo_start and keys_start;
9081 while those allow us to restart the entire key sequence,
9082 echo_local_start and keys_local_start allow us to throw away
9084 ptrdiff_t echo_local_start
IF_LINT (= 0);
9085 int keys_local_start
;
9086 Lisp_Object new_binding
;
9088 eassert (indec
.end
== t
|| (indec
.end
> t
&& indec
.end
<= mock_input
));
9089 eassert (indec
.start
<= indec
.end
);
9090 eassert (fkey
.start
<= fkey
.end
);
9091 eassert (keytran
.start
<= keytran
.end
);
9092 /* key-translation-map is applied *after* function-key-map
9093 which is itself applied *after* input-decode-map. */
9094 eassert (fkey
.end
<= indec
.start
);
9095 eassert (keytran
.end
<= fkey
.start
);
9097 if (/* first_unbound < indec.start && first_unbound < fkey.start && */
9098 first_unbound
< keytran
.start
)
9099 { /* The prefix upto first_unbound has no binding and has
9100 no translation left to do either, so we know it's unbound.
9101 If we don't stop now, we risk staying here indefinitely
9102 (if the user keeps entering fkey or keytran prefixes
9103 like C-c ESC ESC ESC ESC ...) */
9105 for (i
= first_unbound
+ 1; i
< t
; i
++)
9106 keybuf
[i
- first_unbound
- 1] = keybuf
[i
];
9107 mock_input
= t
- first_unbound
- 1;
9108 indec
.end
= indec
.start
-= first_unbound
+ 1;
9109 indec
.map
= indec
.parent
;
9110 fkey
.end
= fkey
.start
-= first_unbound
+ 1;
9111 fkey
.map
= fkey
.parent
;
9112 keytran
.end
= keytran
.start
-= first_unbound
+ 1;
9113 keytran
.map
= keytran
.parent
;
9114 goto replay_sequence
;
9118 error ("Key sequence too long");
9121 echo_local_start
= echo_length ();
9122 keys_local_start
= this_command_key_count
;
9125 /* These are no-ops, unless we throw away a keystroke below and
9126 jumped back up to replay_key; in that case, these restore the
9127 variables to their original state, allowing us to replay the
9129 if (INTERACTIVE
&& t
< mock_input
)
9130 echo_truncate (echo_local_start
);
9131 this_command_key_count
= keys_local_start
;
9133 /* By default, assume each event is "real". */
9134 last_real_key_start
= t
;
9136 /* Does mock_input indicate that we are re-reading a key sequence? */
9140 add_command_key (key
);
9141 if (echo_keystrokes_p ()
9142 && current_kboard
->immediate_echo
)
9149 /* If not, we should actually read a character. */
9153 KBOARD
*interrupted_kboard
= current_kboard
;
9154 struct frame
*interrupted_frame
= SELECTED_FRAME ();
9155 /* Calling read_char with COMMANDFLAG = -2 avoids
9156 redisplay in read_char and its subroutines. */
9157 key
= read_char (prevent_redisplay
? -2 : NILP (prompt
),
9158 current_binding
, last_nonmenu_event
,
9159 &used_mouse_menu
, NULL
);
9160 if ((INTEGERP (key
) && XINT (key
) == -2) /* wrong_kboard_jmpbuf */
9161 /* When switching to a new tty (with a new keyboard),
9162 read_char returns the new buffer, rather than -2
9163 (Bug#5095). This is because `terminal-init-xterm'
9164 calls read-char, which eats the wrong_kboard_jmpbuf
9165 return. Any better way to fix this? -- cyd */
9166 || (interrupted_kboard
!= current_kboard
))
9171 for (k
= all_kboards
; k
; k
= k
->next_kboard
)
9172 if (k
== interrupted_kboard
)
9177 /* Don't touch interrupted_kboard when it's been
9179 delayed_switch_frame
= Qnil
;
9180 goto replay_entire_sequence
;
9183 if (!NILP (delayed_switch_frame
))
9186 (interrupted_kboard
,
9187 Fcons (delayed_switch_frame
,
9188 KVAR (interrupted_kboard
, kbd_queue
)));
9189 delayed_switch_frame
= Qnil
;
9194 (interrupted_kboard
,
9195 Fcons (keybuf
[--t
], KVAR (interrupted_kboard
, kbd_queue
)));
9197 /* If the side queue is non-empty, ensure it begins with a
9198 switch-frame, so we'll replay it in the right context. */
9199 if (CONSP (KVAR (interrupted_kboard
, kbd_queue
))
9200 && (key
= XCAR (KVAR (interrupted_kboard
, kbd_queue
)),
9201 !(EVENT_HAS_PARAMETERS (key
)
9202 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)),
9206 XSETFRAME (frame
, interrupted_frame
);
9208 (interrupted_kboard
,
9209 Fcons (make_lispy_switch_frame (frame
),
9210 KVAR (interrupted_kboard
, kbd_queue
)));
9213 goto replay_entire_sequence
;
9217 /* read_char returns t when it shows a menu and the user rejects it.
9221 unbind_to (count
, Qnil
);
9226 /* read_char returns -1 at the end of a macro.
9227 Emacs 18 handles this by returning immediately with a
9228 zero, so that's what we'll do. */
9229 if (INTEGERP (key
) && XINT (key
) == -1)
9232 /* The Microsoft C compiler can't handle the goto that
9238 /* If the current buffer has been changed from under us, the
9239 keymap may have changed, so replay the sequence. */
9242 timer_resume_idle ();
9245 /* Reset the current buffer from the selected window
9246 in case something changed the former and not the latter.
9247 This is to be more consistent with the behavior
9248 of the command_loop_1. */
9249 if (fix_current_buffer
)
9251 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
9253 if (XBUFFER (XWINDOW (selected_window
)->contents
)
9255 Fset_buffer (XWINDOW (selected_window
)->contents
);
9258 goto replay_sequence
;
9261 /* If we have a quit that was typed in another frame, and
9262 quit_throw_to_read_char switched buffers,
9263 replay to get the right keymap. */
9265 && XINT (key
) == quit_char
9266 && current_buffer
!= starting_buffer
)
9269 ASET (raw_keybuf
, raw_keybuf_count
, key
);
9274 goto replay_sequence
;
9279 if (EVENT_HAS_PARAMETERS (key
)
9280 /* Either a `switch-frame' or a `select-window' event. */
9281 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)), Qswitch_frame
))
9283 /* If we're at the beginning of a key sequence, and the caller
9284 says it's okay, go ahead and return this event. If we're
9285 in the midst of a key sequence, delay it until the end. */
9286 if (t
> 0 || !can_return_switch_frame
)
9288 delayed_switch_frame
= key
;
9293 if (NILP (first_event
))
9296 /* Even if first_event does not specify a particular
9297 window/position, it's important to recompute the maps here
9298 since a long time might have passed since we entered
9299 read_key_sequence, and a timer (or process-filter or
9300 special-event-map, ...) might have switched the current buffer
9301 or the selected window from under us in the mean time. */
9302 if (fix_current_buffer
9303 && (XBUFFER (XWINDOW (selected_window
)->contents
)
9305 Fset_buffer (XWINDOW (selected_window
)->contents
);
9306 current_binding
= active_maps (first_event
);
9310 ASET (raw_keybuf
, raw_keybuf_count
, key
);
9314 /* Clicks in non-text areas get prefixed by the symbol
9315 in their CHAR-ADDRESS field. For example, a click on
9316 the mode line is prefixed by the symbol `mode-line'.
9318 Furthermore, key sequences beginning with mouse clicks
9319 are read using the keymaps of the buffer clicked on, not
9320 the current buffer. So we may have to switch the buffer
9323 When we turn one event into two events, we must make sure
9324 that neither of the two looks like the original--so that,
9325 if we replay the events, they won't be expanded again.
9326 If not for this, such reexpansion could happen either here
9327 or when user programs play with this-command-keys. */
9328 if (EVENT_HAS_PARAMETERS (key
))
9330 Lisp_Object kind
= EVENT_HEAD_KIND (EVENT_HEAD (key
));
9331 if (EQ (kind
, Qmouse_click
))
9333 Lisp_Object window
= POSN_WINDOW (EVENT_START (key
));
9334 Lisp_Object posn
= POSN_POSN (EVENT_START (key
));
9337 || (!NILP (fake_prefixed_keys
)
9338 && !NILP (Fmemq (key
, fake_prefixed_keys
))))
9340 /* We're looking a second time at an event for which
9341 we generated a fake prefix key. Set
9342 last_real_key_start appropriately. */
9344 last_real_key_start
= t
- 1;
9347 if (last_real_key_start
== 0)
9349 /* Key sequences beginning with mouse clicks are
9350 read using the keymaps in the buffer clicked on,
9351 not the current buffer. If we're at the
9352 beginning of a key sequence, switch buffers. */
9353 if (WINDOWP (window
)
9354 && BUFFERP (XWINDOW (window
)->contents
)
9355 && XBUFFER (XWINDOW (window
)->contents
) != current_buffer
)
9357 ASET (raw_keybuf
, raw_keybuf_count
, key
);
9362 /* Arrange to go back to the original buffer once we're
9363 done reading the key sequence. Note that we can't
9364 use save_excursion_{save,restore} here, because they
9365 save point as well as the current buffer; we don't
9366 want to save point, because redisplay may change it,
9367 to accommodate a Fset_window_start or something. We
9368 don't want to do this at the top of the function,
9369 because we may get input from a subprocess which
9370 wants to change the selected window and stuff (say,
9372 record_unwind_current_buffer ();
9374 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
9376 set_buffer_internal (XBUFFER (XWINDOW (window
)->contents
));
9377 goto replay_sequence
;
9381 /* Expand mode-line and scroll-bar events into two events:
9382 use posn as a fake prefix key. */
9384 && (NILP (fake_prefixed_keys
)
9385 || NILP (Fmemq (key
, fake_prefixed_keys
))))
9387 if (bufsize
- t
<= 1)
9388 error ("Key sequence too long");
9391 keybuf
[t
+ 1] = key
;
9394 /* Record that a fake prefix key has been generated
9395 for KEY. Don't modify the event; this would
9396 prevent proper action when the event is pushed
9397 back into unread-command-events. */
9398 fake_prefixed_keys
= Fcons (key
, fake_prefixed_keys
);
9402 else if (CONSP (XCDR (key
))
9403 && CONSP (EVENT_START (key
))
9404 && CONSP (XCDR (EVENT_START (key
))))
9408 posn
= POSN_POSN (EVENT_START (key
));
9409 /* Handle menu-bar events:
9410 insert the dummy prefix event `menu-bar'. */
9411 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
9413 if (bufsize
- t
<= 1)
9414 error ("Key sequence too long");
9416 keybuf
[t
+ 1] = key
;
9418 /* Zap the position in key, so we know that we've
9419 expanded it, and don't try to do so again. */
9420 POSN_SET_POSN (EVENT_START (key
), list1 (posn
));
9423 goto replay_sequence
;
9425 else if (CONSP (posn
))
9427 /* We're looking at the second event of a
9428 sequence which we expanded before. Set
9429 last_real_key_start appropriately. */
9430 if (last_real_key_start
== t
&& t
> 0)
9431 last_real_key_start
= t
- 1;
9436 /* We have finally decided that KEY is something we might want
9438 new_binding
= follow_key (current_binding
, key
);
9440 /* If KEY wasn't bound, we'll try some fallbacks. */
9441 if (!NILP (new_binding
))
9442 /* This is needed for the following scenario:
9443 event 0: a down-event that gets dropped by calling replay_key.
9444 event 1: some normal prefix like C-h.
9445 After event 0, first_unbound is 0, after event 1 indec.start,
9446 fkey.start, and keytran.start are all 1, so when we see that
9447 C-h is bound, we need to update first_unbound. */
9448 first_unbound
= max (t
+ 1, first_unbound
);
9453 /* Remember the position to put an upper bound on indec.start. */
9454 first_unbound
= min (t
, first_unbound
);
9456 head
= EVENT_HEAD (key
);
9460 Lisp_Object breakdown
;
9463 breakdown
= parse_modifiers (head
);
9464 modifiers
= XINT (XCAR (XCDR (breakdown
)));
9465 /* Attempt to reduce an unbound mouse event to a simpler
9466 event that is bound:
9467 Drags reduce to clicks.
9468 Double-clicks reduce to clicks.
9469 Triple-clicks reduce to double-clicks, then to clicks.
9470 Down-clicks are eliminated.
9471 Double-downs reduce to downs, then are eliminated.
9472 Triple-downs reduce to double-downs, then to downs,
9473 then are eliminated. */
9474 if (modifiers
& (down_modifier
| drag_modifier
9475 | double_modifier
| triple_modifier
))
9477 while (modifiers
& (down_modifier
| drag_modifier
9478 | double_modifier
| triple_modifier
))
9480 Lisp_Object new_head
, new_click
;
9481 if (modifiers
& triple_modifier
)
9482 modifiers
^= (double_modifier
| triple_modifier
);
9483 else if (modifiers
& double_modifier
)
9484 modifiers
&= ~double_modifier
;
9485 else if (modifiers
& drag_modifier
)
9486 modifiers
&= ~drag_modifier
;
9489 /* Dispose of this `down' event by simply jumping
9490 back to replay_key, to get another event.
9492 Note that if this event came from mock input,
9493 then just jumping back to replay_key will just
9494 hand it to us again. So we have to wipe out any
9497 We could delete keybuf[t] and shift everything
9498 after that to the left by one spot, but we'd also
9499 have to fix up any variable that points into
9500 keybuf, and shifting isn't really necessary
9503 Adding prefixes for non-textual mouse clicks
9504 creates two characters of mock input, and both
9505 must be thrown away. If we're only looking at
9506 the prefix now, we can just jump back to
9507 replay_key. On the other hand, if we've already
9508 processed the prefix, and now the actual click
9509 itself is giving us trouble, then we've lost the
9510 state of the keymaps we want to backtrack to, and
9511 we need to replay the whole sequence to rebuild
9514 Beyond that, only function key expansion could
9515 create more than two keys, but that should never
9516 generate mouse events, so it's okay to zero
9517 mock_input in that case too.
9519 FIXME: The above paragraph seems just plain
9520 wrong, if you consider things like
9521 xterm-mouse-mode. -stef
9523 Isn't this just the most wonderful code ever? */
9525 /* If mock_input > t + 1, the above simplification
9526 will actually end up dropping keys on the floor.
9527 This is probably OK for now, but even
9528 if mock_input <= t + 1, we need to adjust indec,
9530 Typical case [header-line down-mouse-N]:
9531 mock_input = 2, t = 1, fkey.end = 1,
9532 last_real_key_start = 0. */
9533 if (indec
.end
> last_real_key_start
)
9535 indec
.end
= indec
.start
9536 = min (last_real_key_start
, indec
.start
);
9537 indec
.map
= indec
.parent
;
9538 if (fkey
.end
> last_real_key_start
)
9540 fkey
.end
= fkey
.start
9541 = min (last_real_key_start
, fkey
.start
);
9542 fkey
.map
= fkey
.parent
;
9543 if (keytran
.end
> last_real_key_start
)
9545 keytran
.end
= keytran
.start
9546 = min (last_real_key_start
, keytran
.start
);
9547 keytran
.map
= keytran
.parent
;
9551 if (t
== last_real_key_start
)
9558 mock_input
= last_real_key_start
;
9559 goto replay_sequence
;
9564 = apply_modifiers (modifiers
, XCAR (breakdown
));
9565 new_click
= list2 (new_head
, EVENT_START (key
));
9567 /* Look for a binding for this new key. */
9568 new_binding
= follow_key (current_binding
, new_click
);
9570 /* If that click is bound, go for it. */
9571 if (!NILP (new_binding
))
9573 current_binding
= new_binding
;
9577 /* Otherwise, we'll leave key set to the drag event. */
9582 current_binding
= new_binding
;
9585 /* Normally, last_nonmenu_event gets the previous key we read.
9586 But when a mouse popup menu is being used,
9587 we don't update last_nonmenu_event; it continues to hold the mouse
9588 event that preceded the first level of menu. */
9589 if (!used_mouse_menu
)
9590 last_nonmenu_event
= key
;
9592 /* Record what part of this_command_keys is the current key sequence. */
9593 this_single_command_key_start
= this_command_key_count
- t
;
9594 /* When 'input-method-function' called above causes events to be
9595 put on 'unread-post-input-method-events', and as result
9596 'reread' is set to 'true', the value of 't' can become larger
9597 than 'this_command_key_count', because 'add_command_key' is
9598 not called to update 'this_command_key_count'. If this
9599 happens, 'this_single_command_key_start' will become negative
9600 above, and any call to 'this-single-command-keys' will return
9601 a garbled vector. See bug #20223 for one such situation.
9602 Here we force 'this_single_command_key_start' to never become
9603 negative, to avoid that. */
9604 if (this_single_command_key_start
< 0)
9605 this_single_command_key_start
= 0;
9607 /* Look for this sequence in input-decode-map.
9608 Scan from indec.end until we find a bound suffix. */
9609 while (indec
.end
< t
)
9611 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9615 GCPRO4 (indec
.map
, fkey
.map
, keytran
.map
, delayed_switch_frame
);
9616 done
= keyremap_step (keybuf
, bufsize
, &indec
, max (t
, mock_input
),
9621 mock_input
= diff
+ max (t
, mock_input
);
9622 goto replay_sequence
;
9626 if (!KEYMAPP (current_binding
)
9627 && !test_undefined (current_binding
)
9628 && indec
.start
>= t
)
9629 /* There is a binding and it's not a prefix.
9630 (and it doesn't have any input-decode-map translation pending).
9631 There is thus no function-key in this sequence.
9632 Moving fkey.start is important in this case to allow keytran.start
9633 to go over the sequence before we return (since we keep the
9634 invariant that keytran.end <= fkey.start). */
9637 (fkey
.start
= fkey
.end
= t
, fkey
.map
= fkey
.parent
);
9640 /* If the sequence is unbound, see if we can hang a function key
9641 off the end of it. */
9642 /* Continue scan from fkey.end until we find a bound suffix. */
9643 while (fkey
.end
< indec
.start
)
9645 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9649 GCPRO4 (indec
.map
, fkey
.map
, keytran
.map
, delayed_switch_frame
);
9650 done
= keyremap_step (keybuf
, bufsize
, &fkey
,
9651 max (t
, mock_input
),
9652 /* If there's a binding (i.e.
9653 first_binding >= nmaps) we don't want
9654 to apply this function-key-mapping. */
9656 && (test_undefined (current_binding
)),
9661 mock_input
= diff
+ max (t
, mock_input
);
9662 /* Adjust the input-decode-map counters. */
9664 indec
.start
+= diff
;
9666 goto replay_sequence
;
9670 /* Look for this sequence in key-translation-map.
9671 Scan from keytran.end until we find a bound suffix. */
9672 while (keytran
.end
< fkey
.start
)
9674 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9678 GCPRO4 (indec
.map
, fkey
.map
, keytran
.map
, delayed_switch_frame
);
9679 done
= keyremap_step (keybuf
, bufsize
, &keytran
, max (t
, mock_input
),
9684 mock_input
= diff
+ max (t
, mock_input
);
9685 /* Adjust the function-key-map and input-decode-map counters. */
9687 indec
.start
+= diff
;
9691 goto replay_sequence
;
9695 /* If KEY is not defined in any of the keymaps,
9696 and cannot be part of a function key or translation,
9697 and is an upper case letter
9698 use the corresponding lower-case letter instead. */
9699 if (NILP (current_binding
)
9700 && /* indec.start >= t && fkey.start >= t && */ keytran
.start
>= t
9702 && ((CHARACTERP (make_number (XINT (key
) & ~CHAR_MODIFIER_MASK
))
9703 && uppercasep (XINT (key
) & ~CHAR_MODIFIER_MASK
))
9704 || (XINT (key
) & shift_modifier
)))
9706 Lisp_Object new_key
;
9708 original_uppercase
= key
;
9709 original_uppercase_position
= t
- 1;
9711 if (XINT (key
) & shift_modifier
)
9712 XSETINT (new_key
, XINT (key
) & ~shift_modifier
);
9714 XSETINT (new_key
, (downcase (XINT (key
) & ~CHAR_MODIFIER_MASK
)
9715 | (XINT (key
) & CHAR_MODIFIER_MASK
)));
9717 /* We have to do this unconditionally, regardless of whether
9718 the lower-case char is defined in the keymaps, because they
9719 might get translated through function-key-map. */
9720 keybuf
[t
- 1] = new_key
;
9721 mock_input
= max (t
, mock_input
);
9722 shift_translated
= 1;
9724 goto replay_sequence
;
9727 if (NILP (current_binding
)
9728 && help_char_p (EVENT_HEAD (key
)) && t
> 1)
9730 read_key_sequence_cmd
= Vprefix_help_command
;
9731 /* The Microsoft C compiler can't handle the goto that
9737 /* If KEY is not defined in any of the keymaps,
9738 and cannot be part of a function key or translation,
9739 and is a shifted function key,
9740 use the corresponding unshifted function key instead. */
9741 if (NILP (current_binding
)
9742 && /* indec.start >= t && fkey.start >= t && */ keytran
.start
>= t
)
9744 Lisp_Object breakdown
= parse_modifiers (key
);
9746 = CONSP (breakdown
) ? (XINT (XCAR (XCDR (breakdown
)))) : 0;
9748 if (modifiers
& shift_modifier
9749 /* Treat uppercase keys as shifted. */
9751 && (KEY_TO_CHAR (key
)
9752 < XCHAR_TABLE (BVAR (current_buffer
, downcase_table
))->header
.size
)
9753 && uppercasep (KEY_TO_CHAR (key
))))
9756 = (modifiers
& shift_modifier
9757 ? apply_modifiers (modifiers
& ~shift_modifier
,
9759 : make_number (downcase (KEY_TO_CHAR (key
)) | modifiers
));
9761 original_uppercase
= key
;
9762 original_uppercase_position
= t
- 1;
9764 /* We have to do this unconditionally, regardless of whether
9765 the lower-case char is defined in the keymaps, because they
9766 might get translated through function-key-map. */
9767 keybuf
[t
- 1] = new_key
;
9768 mock_input
= max (t
, mock_input
);
9769 /* Reset fkey (and consequently keytran) to apply
9770 function-key-map on the result, so that S-backspace is
9771 correctly mapped to DEL (via backspace). OTOH,
9772 input-decode-map doesn't need to go through it again. */
9773 fkey
.start
= fkey
.end
= 0;
9774 keytran
.start
= keytran
.end
= 0;
9775 shift_translated
= 1;
9777 goto replay_sequence
;
9782 read_key_sequence_cmd
= current_binding
;
9783 read_key_sequence_remapped
9784 /* Remap command through active keymaps.
9785 Do the remapping here, before the unbind_to so it uses the keymaps
9786 of the appropriate buffer. */
9787 = SYMBOLP (read_key_sequence_cmd
)
9788 ? Fcommand_remapping (read_key_sequence_cmd
, Qnil
, Qnil
)
9791 unread_switch_frame
= delayed_switch_frame
;
9792 unbind_to (count
, Qnil
);
9794 /* Don't downcase the last character if the caller says don't.
9795 Don't downcase it if the result is undefined, either. */
9796 if ((dont_downcase_last
|| NILP (current_binding
))
9798 && t
- 1 == original_uppercase_position
)
9800 keybuf
[t
- 1] = original_uppercase
;
9801 shift_translated
= 0;
9804 if (shift_translated
)
9805 Vthis_command_keys_shift_translated
= Qt
;
9807 /* Occasionally we fabricate events, perhaps by expanding something
9808 according to function-key-map, or by adding a prefix symbol to a
9809 mouse click in the scroll bar or modeline. In this cases, return
9810 the entire generated key sequence, even if we hit an unbound
9811 prefix or a definition before the end. This means that you will
9812 be able to push back the event properly, and also means that
9813 read-key-sequence will always return a logical unit.
9816 for (; t
< mock_input
; t
++)
9818 if (echo_keystrokes_p ())
9819 echo_char (keybuf
[t
]);
9820 add_command_key (keybuf
[t
]);
9828 read_key_sequence_vs (Lisp_Object prompt
, Lisp_Object continue_echo
,
9829 Lisp_Object dont_downcase_last
,
9830 Lisp_Object can_return_switch_frame
,
9831 Lisp_Object cmd_loop
, bool allow_string
)
9833 Lisp_Object keybuf
[30];
9835 struct gcpro gcpro1
;
9836 ptrdiff_t count
= SPECPDL_INDEX ();
9839 CHECK_STRING (prompt
);
9842 specbind (Qinput_method_exit_on_first_char
,
9843 (NILP (cmd_loop
) ? Qt
: Qnil
));
9844 specbind (Qinput_method_use_echo_area
,
9845 (NILP (cmd_loop
) ? Qt
: Qnil
));
9847 memset (keybuf
, 0, sizeof keybuf
);
9849 gcpro1
.nvars
= ARRAYELTS (keybuf
);
9851 if (NILP (continue_echo
))
9853 this_command_key_count
= 0;
9854 this_command_key_count_reset
= 0;
9855 this_single_command_key_start
= 0;
9858 #ifdef HAVE_WINDOW_SYSTEM
9859 if (display_hourglass_p
)
9860 cancel_hourglass ();
9863 i
= read_key_sequence (keybuf
, ARRAYELTS (keybuf
),
9864 prompt
, ! NILP (dont_downcase_last
),
9865 ! NILP (can_return_switch_frame
), 0, 0);
9867 #if 0 /* The following is fine for code reading a key sequence and
9868 then proceeding with a lengthy computation, but it's not good
9869 for code reading keys in a loop, like an input method. */
9870 #ifdef HAVE_WINDOW_SYSTEM
9871 if (display_hourglass_p
)
9882 return unbind_to (count
,
9883 ((allow_string
? make_event_array
: Fvector
)
9887 DEFUN ("read-key-sequence", Fread_key_sequence
, Sread_key_sequence
, 1, 5, 0,
9888 doc
: /* Read a sequence of keystrokes and return as a string or vector.
9889 The sequence is sufficient to specify a non-prefix command in the
9890 current local and global maps.
9892 First arg PROMPT is a prompt string. If nil, do not prompt specially.
9893 Second (optional) arg CONTINUE-ECHO, if non-nil, means this key echos
9894 as a continuation of the previous key.
9896 The third (optional) arg DONT-DOWNCASE-LAST, if non-nil, means do not
9897 convert the last event to lower case. (Normally any upper case event
9898 is converted to lower case if the original event is undefined and the lower
9899 case equivalent is defined.) A non-nil value is appropriate for reading
9900 a key sequence to be defined.
9902 A C-g typed while in this function is treated like any other character,
9903 and `quit-flag' is not set.
9905 If the key sequence starts with a mouse click, then the sequence is read
9906 using the keymaps of the buffer of the window clicked in, not the buffer
9907 of the selected window as normal.
9909 `read-key-sequence' drops unbound button-down events, since you normally
9910 only care about the click or drag events which follow them. If a drag
9911 or multi-click event is unbound, but the corresponding click event would
9912 be bound, `read-key-sequence' turns the event into a click event at the
9913 drag's starting position. This means that you don't have to distinguish
9914 between click and drag, double, or triple events unless you want to.
9916 `read-key-sequence' prefixes mouse events on mode lines, the vertical
9917 lines separating windows, and scroll bars with imaginary keys
9918 `mode-line', `vertical-line', and `vertical-scroll-bar'.
9920 Optional fourth argument CAN-RETURN-SWITCH-FRAME non-nil means that this
9921 function will process a switch-frame event if the user switches frames
9922 before typing anything. If the user switches frames in the middle of a
9923 key sequence, or at the start of the sequence but CAN-RETURN-SWITCH-FRAME
9924 is nil, then the event will be put off until after the current key sequence.
9926 `read-key-sequence' checks `function-key-map' for function key
9927 sequences, where they wouldn't conflict with ordinary bindings. See
9928 `function-key-map' for more details.
9930 The optional fifth argument CMD-LOOP, if non-nil, means
9931 that this key sequence is being read by something that will
9932 read commands one after another. It should be nil if the caller
9933 will read just one key sequence. */)
9934 (Lisp_Object prompt
, Lisp_Object continue_echo
, Lisp_Object dont_downcase_last
, Lisp_Object can_return_switch_frame
, Lisp_Object cmd_loop
)
9936 return read_key_sequence_vs (prompt
, continue_echo
, dont_downcase_last
,
9937 can_return_switch_frame
, cmd_loop
, true);
9940 DEFUN ("read-key-sequence-vector", Fread_key_sequence_vector
,
9941 Sread_key_sequence_vector
, 1, 5, 0,
9942 doc
: /* Like `read-key-sequence' but always return a vector. */)
9943 (Lisp_Object prompt
, Lisp_Object continue_echo
, Lisp_Object dont_downcase_last
, Lisp_Object can_return_switch_frame
, Lisp_Object cmd_loop
)
9945 return read_key_sequence_vs (prompt
, continue_echo
, dont_downcase_last
,
9946 can_return_switch_frame
, cmd_loop
, false);
9949 /* Return true if input events are pending. */
9952 detect_input_pending (void)
9954 return input_pending
|| get_input_pending (0);
9957 /* Return true if input events other than mouse movements are
9961 detect_input_pending_ignore_squeezables (void)
9963 return input_pending
|| get_input_pending (READABLE_EVENTS_IGNORE_SQUEEZABLES
);
9966 /* Return true if input events are pending, and run any pending timers. */
9969 detect_input_pending_run_timers (bool do_display
)
9971 unsigned old_timers_run
= timers_run
;
9974 get_input_pending (READABLE_EVENTS_DO_TIMERS_NOW
);
9976 if (old_timers_run
!= timers_run
&& do_display
)
9977 redisplay_preserve_echo_area (8);
9979 return input_pending
;
9982 /* This is called in some cases before a possible quit.
9983 It cases the next call to detect_input_pending to recompute input_pending.
9984 So calling this function unnecessarily can't do any harm. */
9987 clear_input_pending (void)
9992 /* Return true if there are pending requeued events.
9993 This isn't used yet. The hope is to make wait_reading_process_output
9994 call it, and return if it runs Lisp code that unreads something.
9995 The problem is, kbd_buffer_get_event needs to be fixed to know what
9996 to do in that case. It isn't trivial. */
9999 requeued_events_pending_p (void)
10001 return (!NILP (Vunread_command_events
));
10004 DEFUN ("input-pending-p", Finput_pending_p
, Sinput_pending_p
, 0, 1, 0,
10005 doc
: /* Return t if command input is currently available with no wait.
10006 Actually, the value is nil only if we can be sure that no input is available;
10007 if there is a doubt, the value is t.
10009 If CHECK-TIMERS is non-nil, timers that are ready to run will do so. */)
10010 (Lisp_Object check_timers
)
10012 if (!NILP (Vunread_command_events
)
10013 || !NILP (Vunread_post_input_method_events
)
10014 || !NILP (Vunread_input_method_events
))
10017 /* Process non-user-visible events (Bug#10195). */
10018 process_special_events ();
10020 return (get_input_pending ((NILP (check_timers
)
10021 ? 0 : READABLE_EVENTS_DO_TIMERS_NOW
)
10022 | READABLE_EVENTS_FILTER_EVENTS
)
10026 DEFUN ("recent-keys", Frecent_keys
, Srecent_keys
, 0, 1, 0,
10027 doc
: /* Return vector of last few events, not counting those from keyboard macros.
10028 If INCLUDE-CMDS is non-nil, include the commands that were run,
10029 represented as events of the form (nil . COMMAND). */)
10030 (Lisp_Object include_cmds
)
10032 bool cmds
= !NILP (include_cmds
);
10035 || (cmds
&& total_keys
< NUM_RECENT_KEYS
))
10036 return Fvector (total_keys
,
10037 XVECTOR (recent_keys
)->contents
);
10040 Lisp_Object es
= Qnil
;
10041 int i
= (total_keys
< NUM_RECENT_KEYS
10042 ? 0 : recent_keys_index
);
10043 eassert (recent_keys_index
< NUM_RECENT_KEYS
);
10046 Lisp_Object e
= AREF (recent_keys
, i
);
10047 if (cmds
|| !CONSP (e
) || !NILP (XCAR (e
)))
10048 es
= Fcons (e
, es
);
10049 if (++i
>= NUM_RECENT_KEYS
)
10051 } while (i
!= recent_keys_index
);
10052 es
= Fnreverse (es
);
10053 return Fvconcat (1, &es
);
10057 DEFUN ("this-command-keys", Fthis_command_keys
, Sthis_command_keys
, 0, 0, 0,
10058 doc
: /* Return the key sequence that invoked this command.
10059 However, if the command has called `read-key-sequence', it returns
10060 the last key sequence that has been read.
10061 The value is a string or a vector.
10063 See also `this-command-keys-vector'. */)
10066 return make_event_array (this_command_key_count
,
10067 XVECTOR (this_command_keys
)->contents
);
10070 DEFUN ("this-command-keys-vector", Fthis_command_keys_vector
, Sthis_command_keys_vector
, 0, 0, 0,
10071 doc
: /* Return the key sequence that invoked this command, as a vector.
10072 However, if the command has called `read-key-sequence', it returns
10073 the last key sequence that has been read.
10075 See also `this-command-keys'. */)
10078 return Fvector (this_command_key_count
,
10079 XVECTOR (this_command_keys
)->contents
);
10082 DEFUN ("this-single-command-keys", Fthis_single_command_keys
,
10083 Sthis_single_command_keys
, 0, 0, 0,
10084 doc
: /* Return the key sequence that invoked 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-command-keys', this function's value
10088 does not include prefix arguments.
10089 The value is always a vector. */)
10092 return Fvector (this_command_key_count
10093 - this_single_command_key_start
,
10094 (XVECTOR (this_command_keys
)->contents
10095 + this_single_command_key_start
));
10098 DEFUN ("this-single-command-raw-keys", Fthis_single_command_raw_keys
,
10099 Sthis_single_command_raw_keys
, 0, 0, 0,
10100 doc
: /* Return the raw events that were read for this command.
10101 More generally, it returns the last key sequence read, either by
10102 the command loop or by `read-key-sequence'.
10103 Unlike `this-single-command-keys', this function's value
10104 shows the events before all translations (except for input methods).
10105 The value is always a vector. */)
10108 return Fvector (raw_keybuf_count
, XVECTOR (raw_keybuf
)->contents
);
10111 DEFUN ("reset-this-command-lengths", Freset_this_command_lengths
,
10112 Sreset_this_command_lengths
, 0, 0, 0,
10113 doc
: /* Make the unread events replace the last command and echo.
10114 Used in `universal-argument-other-key'.
10116 `universal-argument-other-key' rereads the event just typed.
10117 It then gets translated through `function-key-map'.
10118 The translated event has to replace the real events,
10119 both in the value of (this-command-keys) and in echoing.
10120 To achieve this, `universal-argument-other-key' calls
10121 `reset-this-command-lengths', which discards the record of reading
10122 these events the first time. */)
10125 this_command_key_count
= before_command_key_count
;
10126 if (this_command_key_count
< this_single_command_key_start
)
10127 this_single_command_key_start
= this_command_key_count
;
10129 echo_truncate (before_command_echo_length
);
10131 /* Cause whatever we put into unread-command-events
10132 to echo as if it were being freshly read from the keyboard. */
10133 this_command_key_count_reset
= 1;
10138 DEFUN ("clear-this-command-keys", Fclear_this_command_keys
,
10139 Sclear_this_command_keys
, 0, 1, 0,
10140 doc
: /* Clear out the vector that `this-command-keys' returns.
10141 Also clear the record of the last 100 events, unless optional arg
10142 KEEP-RECORD is non-nil. */)
10143 (Lisp_Object keep_record
)
10147 this_command_key_count
= 0;
10148 this_command_key_count_reset
= 0;
10150 if (NILP (keep_record
))
10152 for (i
= 0; i
< ASIZE (recent_keys
); ++i
)
10153 ASET (recent_keys
, i
, Qnil
);
10155 recent_keys_index
= 0;
10160 DEFUN ("recursion-depth", Frecursion_depth
, Srecursion_depth
, 0, 0, 0,
10161 doc
: /* Return the current depth in recursive edits. */)
10165 /* Wrap around reliably on integer overflow. */
10166 EMACS_INT sum
= (command_loop_level
& INTMASK
) + (minibuf_level
& INTMASK
);
10167 XSETINT (temp
, sum
);
10171 DEFUN ("open-dribble-file", Fopen_dribble_file
, Sopen_dribble_file
, 1, 1,
10172 "FOpen dribble file: ",
10173 doc
: /* Start writing all keyboard characters to a dribble file called FILE.
10174 If FILE is nil, close any open dribble file.
10175 The file will be closed when Emacs exits.
10177 Be aware that this records ALL characters you type!
10178 This may include sensitive information such as passwords. */)
10191 Lisp_Object encfile
;
10193 file
= Fexpand_file_name (file
, Qnil
);
10194 encfile
= ENCODE_FILE (file
);
10195 fd
= emacs_open (SSDATA (encfile
), O_WRONLY
| O_CREAT
| O_EXCL
, 0600);
10196 if (fd
< 0 && errno
== EEXIST
&& unlink (SSDATA (encfile
)) == 0)
10197 fd
= emacs_open (SSDATA (encfile
), O_WRONLY
| O_CREAT
| O_EXCL
, 0600);
10198 dribble
= fd
< 0 ? 0 : fdopen (fd
, "w");
10200 report_file_error ("Opening dribble", file
);
10205 DEFUN ("discard-input", Fdiscard_input
, Sdiscard_input
, 0, 0, 0,
10206 doc
: /* Discard the contents of the terminal input buffer.
10207 Also end any kbd macro being defined. */)
10210 if (!NILP (KVAR (current_kboard
, defining_kbd_macro
)))
10212 /* Discard the last command from the macro. */
10213 Fcancel_kbd_macro_events ();
10217 Vunread_command_events
= Qnil
;
10219 discard_tty_input ();
10221 kbd_fetch_ptr
= kbd_store_ptr
;
10227 DEFUN ("suspend-emacs", Fsuspend_emacs
, Ssuspend_emacs
, 0, 1, "",
10228 doc
: /* Stop Emacs and return to superior process. You can resume later.
10229 If `cannot-suspend' is non-nil, or if the system doesn't support job
10230 control, run a subshell instead.
10232 If optional arg STUFFSTRING is non-nil, its characters are stuffed
10233 to be read as terminal input by Emacs's parent, after suspension.
10235 Before suspending, run the normal hook `suspend-hook'.
10236 After resumption run the normal hook `suspend-resume-hook'.
10238 Some operating systems cannot stop the Emacs process and resume it later.
10239 On such systems, Emacs starts a subshell instead of suspending. */)
10240 (Lisp_Object stuffstring
)
10242 ptrdiff_t count
= SPECPDL_INDEX ();
10243 int old_height
, old_width
;
10245 struct gcpro gcpro1
;
10247 if (tty_list
&& tty_list
->next
)
10248 error ("There are other tty frames open; close them before suspending Emacs");
10250 if (!NILP (stuffstring
))
10251 CHECK_STRING (stuffstring
);
10253 run_hook (intern ("suspend-hook"));
10255 GCPRO1 (stuffstring
);
10256 get_tty_size (fileno (CURTTY ()->input
), &old_width
, &old_height
);
10257 reset_all_sys_modes ();
10258 /* sys_suspend can get an error if it tries to fork a subshell
10259 and the system resources aren't available for that. */
10260 record_unwind_protect_void (init_all_sys_modes
);
10261 stuff_buffered_input (stuffstring
);
10262 if (cannot_suspend
)
10266 unbind_to (count
, Qnil
);
10268 /* Check if terminal/window size has changed.
10269 Note that this is not useful when we are running directly
10270 with a window system; but suspend should be disabled in that case. */
10271 get_tty_size (fileno (CURTTY ()->input
), &width
, &height
);
10272 if (width
!= old_width
|| height
!= old_height
)
10273 change_frame_size (SELECTED_FRAME (), width
,
10274 height
- FRAME_MENU_BAR_LINES (SELECTED_FRAME ()),
10277 run_hook (intern ("suspend-resume-hook"));
10283 /* If STUFFSTRING is a string, stuff its contents as pending terminal input.
10284 Then in any case stuff anything Emacs has read ahead and not used. */
10287 stuff_buffered_input (Lisp_Object stuffstring
)
10289 #ifdef SIGTSTP /* stuff_char is defined if SIGTSTP. */
10290 register unsigned char *p
;
10292 if (STRINGP (stuffstring
))
10294 register ptrdiff_t count
;
10296 p
= SDATA (stuffstring
);
10297 count
= SBYTES (stuffstring
);
10298 while (count
-- > 0)
10303 /* Anything we have read ahead, put back for the shell to read. */
10304 /* ?? What should this do when we have multiple keyboards??
10305 Should we ignore anything that was typed in at the "wrong" kboard?
10307 rms: we should stuff everything back into the kboard
10309 for (; kbd_fetch_ptr
!= kbd_store_ptr
; kbd_fetch_ptr
++)
10312 if (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
10313 kbd_fetch_ptr
= kbd_buffer
;
10314 if (kbd_fetch_ptr
->kind
== ASCII_KEYSTROKE_EVENT
)
10315 stuff_char (kbd_fetch_ptr
->code
);
10317 clear_event (kbd_fetch_ptr
);
10321 #endif /* SIGTSTP */
10325 set_waiting_for_input (struct timespec
*time_to_clear
)
10327 input_available_clear_time
= time_to_clear
;
10329 /* Tell handle_interrupt to throw back to read_char, */
10330 waiting_for_input
= 1;
10332 /* If handle_interrupt was called before and buffered a C-g,
10333 make it run again now, to avoid timing error. */
10334 if (!NILP (Vquit_flag
))
10335 quit_throw_to_read_char (0);
10339 clear_waiting_for_input (void)
10341 /* Tell handle_interrupt not to throw back to read_char, */
10342 waiting_for_input
= 0;
10343 input_available_clear_time
= 0;
10346 /* The SIGINT handler.
10348 If we have a frame on the controlling tty, we assume that the
10349 SIGINT was generated by C-g, so we call handle_interrupt.
10350 Otherwise, tell QUIT to kill Emacs. */
10353 handle_interrupt_signal (int sig
)
10355 /* See if we have an active terminal on our controlling tty. */
10356 struct terminal
*terminal
= get_named_terminal ("/dev/tty");
10359 /* If there are no frames there, let's pretend that we are a
10360 well-behaving UN*X program and quit. We must not call Lisp
10361 in a signal handler, so tell QUIT to exit when it is
10363 Vquit_flag
= Qkill_emacs
;
10367 /* Otherwise, the SIGINT was probably generated by C-g. */
10369 /* Set internal_last_event_frame to the top frame of the
10370 controlling tty, if we have a frame there. We disable the
10371 interrupt key on secondary ttys, so the SIGINT must have come
10372 from the controlling tty. */
10373 internal_last_event_frame
= terminal
->display_info
.tty
->top_frame
;
10375 handle_interrupt (1);
10380 deliver_interrupt_signal (int sig
)
10382 deliver_process_signal (sig
, handle_interrupt_signal
);
10386 /* If Emacs is stuck because `inhibit-quit' is true, then keep track
10387 of the number of times C-g has been requested. If C-g is pressed
10388 enough times, then quit anyway. See bug#6585. */
10389 static int volatile force_quit_count
;
10391 /* This routine is called at interrupt level in response to C-g.
10393 It is called from the SIGINT handler or kbd_buffer_store_event.
10395 If `waiting_for_input' is non zero, then unless `echoing' is
10396 nonzero, immediately throw back to read_char.
10398 Otherwise it sets the Lisp variable quit-flag not-nil. This causes
10399 eval to throw, when it gets a chance. If quit-flag is already
10400 non-nil, it stops the job right away. */
10403 handle_interrupt (bool in_signal_handler
)
10409 /* XXX This code needs to be revised for multi-tty support. */
10410 if (!NILP (Vquit_flag
) && get_named_terminal ("/dev/tty"))
10412 if (! in_signal_handler
)
10414 /* If SIGINT isn't blocked, don't let us be interrupted by
10415 a SIGINT. It might be harmful due to non-reentrancy
10416 in I/O functions. */
10418 sigemptyset (&blocked
);
10419 sigaddset (&blocked
, SIGINT
);
10420 pthread_sigmask (SIG_BLOCK
, &blocked
, 0);
10424 reset_all_sys_modes ();
10428 * On systems which can suspend the current process and return to the original
10429 * shell, this command causes the user to end up back at the shell.
10430 * The "Auto-save" and "Abort" questions are not asked until
10431 * the user elects to return to emacs, at which point he can save the current
10432 * job and either dump core or continue.
10436 /* Perhaps should really fork an inferior shell?
10437 But that would not provide any way to get back
10438 to the original shell, ever. */
10439 printf ("No support for stopping a process on this operating system;\n");
10440 printf ("you can continue or abort.\n");
10441 #endif /* not SIGTSTP */
10443 /* We must remain inside the screen area when the internal terminal
10444 is used. Note that [Enter] is not echoed by dos. */
10445 cursor_to (SELECTED_FRAME (), 0, 0);
10447 /* It doesn't work to autosave while GC is in progress;
10448 the code used for auto-saving doesn't cope with the mark bit. */
10449 if (!gc_in_progress
)
10451 printf ("Auto-save? (y or n) ");
10453 if (((c
= getchar ()) & ~040) == 'Y')
10455 Fdo_auto_save (Qt
, Qnil
);
10457 printf ("\r\nAuto-save done");
10458 #else /* not MSDOS */
10459 printf ("Auto-save done\n");
10460 #endif /* not MSDOS */
10462 while (c
!= '\n') c
= getchar ();
10466 /* During GC, it must be safe to reenable quitting again. */
10467 Vinhibit_quit
= Qnil
;
10470 #endif /* not MSDOS */
10471 printf ("Garbage collection in progress; cannot auto-save now\r\n");
10472 printf ("but will instead do a real quit after garbage collection ends\r\n");
10477 printf ("\r\nAbort? (y or n) ");
10478 #else /* not MSDOS */
10479 printf ("Abort (and dump core)? (y or n) ");
10480 #endif /* not MSDOS */
10482 if (((c
= getchar ()) & ~040) == 'Y')
10484 while (c
!= '\n') c
= getchar ();
10486 printf ("\r\nContinuing...\r\n");
10487 #else /* not MSDOS */
10488 printf ("Continuing...\n");
10489 #endif /* not MSDOS */
10491 init_all_sys_modes ();
10495 /* If executing a function that wants to be interrupted out of
10496 and the user has not deferred quitting by binding `inhibit-quit'
10497 then quit right away. */
10498 if (immediate_quit
&& NILP (Vinhibit_quit
))
10500 struct gl_state_s saved
;
10501 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
10503 immediate_quit
= 0;
10504 pthread_sigmask (SIG_SETMASK
, &empty_mask
, 0);
10506 GCPRO4 (saved
.object
, saved
.global_code
,
10507 saved
.current_syntax_table
, saved
.old_prop
);
10508 Fsignal (Qquit
, Qnil
);
10513 { /* Else request quit when it's safe. */
10514 int count
= NILP (Vquit_flag
) ? 1 : force_quit_count
+ 1;
10515 force_quit_count
= count
;
10518 immediate_quit
= 1;
10519 Vinhibit_quit
= Qnil
;
10525 pthread_sigmask (SIG_SETMASK
, &empty_mask
, 0);
10527 /* TODO: The longjmp in this call throws the NS event loop integration off,
10528 and it seems to do fine without this. Probably some attention
10529 needs to be paid to the setting of waiting_for_input in
10530 wait_reading_process_output() under HAVE_NS because of the call
10531 to ns_select there (needed because otherwise events aren't picked up
10532 outside of polling since we don't get SIGIO like X and we don't have a
10533 separate event loop thread like W32. */
10535 if (waiting_for_input
&& !echoing
)
10536 quit_throw_to_read_char (in_signal_handler
);
10540 /* Handle a C-g by making read_char return C-g. */
10543 quit_throw_to_read_char (bool from_signal
)
10545 /* When not called from a signal handler it is safe to call
10547 if (!from_signal
&& EQ (Vquit_flag
, Qkill_emacs
))
10548 Fkill_emacs (Qnil
);
10550 /* Prevent another signal from doing this before we finish. */
10551 clear_waiting_for_input ();
10554 Vunread_command_events
= Qnil
;
10556 if (FRAMEP (internal_last_event_frame
)
10557 && !EQ (internal_last_event_frame
, selected_frame
))
10558 do_switch_frame (make_lispy_switch_frame (internal_last_event_frame
),
10561 sys_longjmp (getcjmp
, 1);
10564 DEFUN ("set-input-interrupt-mode", Fset_input_interrupt_mode
,
10565 Sset_input_interrupt_mode
, 1, 1, 0,
10566 doc
: /* Set interrupt mode of reading keyboard input.
10567 If INTERRUPT is non-nil, Emacs will use input interrupts;
10568 otherwise Emacs uses CBREAK mode.
10570 See also `current-input-mode'. */)
10571 (Lisp_Object interrupt
)
10573 bool new_interrupt_input
;
10574 #ifdef USABLE_SIGIO
10575 #ifdef HAVE_X_WINDOWS
10576 if (x_display_list
!= NULL
)
10578 /* When using X, don't give the user a real choice,
10579 because we haven't implemented the mechanisms to support it. */
10580 new_interrupt_input
= 1;
10583 #endif /* HAVE_X_WINDOWS */
10584 new_interrupt_input
= !NILP (interrupt
);
10585 #else /* not USABLE_SIGIO */
10586 new_interrupt_input
= 0;
10587 #endif /* not USABLE_SIGIO */
10589 if (new_interrupt_input
!= interrupt_input
)
10591 #ifdef POLL_FOR_INPUT
10595 /* this causes startup screen to be restored and messes with the mouse */
10596 reset_all_sys_modes ();
10597 interrupt_input
= new_interrupt_input
;
10598 init_all_sys_modes ();
10600 interrupt_input
= new_interrupt_input
;
10603 #ifdef POLL_FOR_INPUT
10604 poll_suppress_count
= 1;
10611 DEFUN ("set-output-flow-control", Fset_output_flow_control
, Sset_output_flow_control
, 1, 2, 0,
10612 doc
: /* Enable or disable ^S/^Q flow control for output to TERMINAL.
10613 If FLOW is non-nil, flow control is enabled and you cannot use C-s or
10614 C-q in key sequences.
10616 This setting only has an effect on tty terminals and only when
10617 Emacs reads input in CBREAK mode; see `set-input-interrupt-mode'.
10619 See also `current-input-mode'. */)
10620 (Lisp_Object flow
, Lisp_Object terminal
)
10622 struct terminal
*t
= decode_tty_terminal (terminal
);
10623 struct tty_display_info
*tty
;
10627 tty
= t
->display_info
.tty
;
10629 if (tty
->flow_control
!= !NILP (flow
))
10632 /* This causes startup screen to be restored and messes with the mouse. */
10633 reset_sys_modes (tty
);
10636 tty
->flow_control
= !NILP (flow
);
10639 init_sys_modes (tty
);
10645 DEFUN ("set-input-meta-mode", Fset_input_meta_mode
, Sset_input_meta_mode
, 1, 2, 0,
10646 doc
: /* Enable or disable 8-bit input on TERMINAL.
10647 If META is t, Emacs will accept 8-bit input, and interpret the 8th
10648 bit as the Meta modifier.
10650 If META is nil, Emacs will ignore the top bit, on the assumption it is
10653 Otherwise, Emacs will accept and pass through 8-bit input without
10654 specially interpreting the top bit.
10656 This setting only has an effect on tty terminal devices.
10658 Optional parameter TERMINAL specifies the tty terminal device to use.
10659 It may be a terminal object, a frame, or nil for the terminal used by
10660 the currently selected frame.
10662 See also `current-input-mode'. */)
10663 (Lisp_Object meta
, Lisp_Object terminal
)
10665 struct terminal
*t
= decode_tty_terminal (terminal
);
10666 struct tty_display_info
*tty
;
10671 tty
= t
->display_info
.tty
;
10675 else if (EQ (meta
, Qt
))
10680 if (tty
->meta_key
!= new_meta
)
10683 /* this causes startup screen to be restored and messes with the mouse */
10684 reset_sys_modes (tty
);
10687 tty
->meta_key
= new_meta
;
10690 init_sys_modes (tty
);
10696 DEFUN ("set-quit-char", Fset_quit_char
, Sset_quit_char
, 1, 1, 0,
10697 doc
: /* Specify character used for quitting.
10698 QUIT must be an ASCII character.
10700 This function only has an effect on the controlling tty of the Emacs
10703 See also `current-input-mode'. */)
10706 struct terminal
*t
= get_named_terminal ("/dev/tty");
10707 struct tty_display_info
*tty
;
10711 tty
= t
->display_info
.tty
;
10713 if (NILP (quit
) || !INTEGERP (quit
) || XINT (quit
) < 0 || XINT (quit
) > 0400)
10714 error ("QUIT must be an ASCII character");
10717 /* this causes startup screen to be restored and messes with the mouse */
10718 reset_sys_modes (tty
);
10721 /* Don't let this value be out of range. */
10722 quit_char
= XINT (quit
) & (tty
->meta_key
== 0 ? 0177 : 0377);
10725 init_sys_modes (tty
);
10731 DEFUN ("set-input-mode", Fset_input_mode
, Sset_input_mode
, 3, 4, 0,
10732 doc
: /* Set mode of reading keyboard input.
10733 First arg INTERRUPT non-nil means use input interrupts;
10734 nil means use CBREAK mode.
10735 Second arg FLOW non-nil means use ^S/^Q flow control for output to terminal
10736 (no effect except in CBREAK mode).
10737 Third arg META t means accept 8-bit input (for a Meta key).
10738 META nil means ignore the top bit, on the assumption it is parity.
10739 Otherwise, accept 8-bit input and don't use the top bit for Meta.
10740 Optional fourth arg QUIT if non-nil specifies character to use for quitting.
10741 See also `current-input-mode'. */)
10742 (Lisp_Object interrupt
, Lisp_Object flow
, Lisp_Object meta
, Lisp_Object quit
)
10744 Fset_input_interrupt_mode (interrupt
);
10745 Fset_output_flow_control (flow
, Qnil
);
10746 Fset_input_meta_mode (meta
, Qnil
);
10748 Fset_quit_char (quit
);
10752 DEFUN ("current-input-mode", Fcurrent_input_mode
, Scurrent_input_mode
, 0, 0, 0,
10753 doc
: /* Return information about the way Emacs currently reads keyboard input.
10754 The value is a list of the form (INTERRUPT FLOW META QUIT), where
10755 INTERRUPT is non-nil if Emacs is using interrupt-driven input; if
10756 nil, Emacs is using CBREAK mode.
10757 FLOW is non-nil if Emacs uses ^S/^Q flow control for output to the
10758 terminal; this does not apply if Emacs uses interrupt-driven input.
10759 META is t if accepting 8-bit input with 8th bit as Meta flag.
10760 META nil means ignoring the top bit, on the assumption it is parity.
10761 META is neither t nor nil if accepting 8-bit input and using
10762 all 8 bits as the character code.
10763 QUIT is the character Emacs currently uses to quit.
10764 The elements of this list correspond to the arguments of
10765 `set-input-mode'. */)
10768 struct frame
*sf
= XFRAME (selected_frame
);
10770 Lisp_Object interrupt
= interrupt_input
? Qt
: Qnil
;
10771 Lisp_Object flow
, meta
;
10772 if (FRAME_TERMCAP_P (sf
) || FRAME_MSDOS_P (sf
))
10774 flow
= FRAME_TTY (sf
)->flow_control
? Qt
: Qnil
;
10775 meta
= (FRAME_TTY (sf
)->meta_key
== 2
10777 : (CURTTY ()->meta_key
== 1 ? Qt
: Qnil
));
10784 Lisp_Object quit
= make_number (quit_char
);
10786 return list4 (interrupt
, flow
, meta
, quit
);
10789 DEFUN ("posn-at-x-y", Fposn_at_x_y
, Sposn_at_x_y
, 2, 4, 0,
10790 doc
: /* Return position information for pixel coordinates X and Y.
10791 By default, X and Y are relative to text area of the selected window.
10792 Optional third arg FRAME-OR-WINDOW non-nil specifies frame or window.
10793 If optional fourth arg WHOLE is non-nil, X is relative to the left
10794 edge of the window.
10796 The return value is similar to a mouse click position:
10797 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
10798 IMAGE (DX . DY) (WIDTH . HEIGHT))
10799 The `posn-' functions access elements of such lists. */)
10800 (Lisp_Object x
, Lisp_Object y
, Lisp_Object frame_or_window
, Lisp_Object whole
)
10805 if (NILP (frame_or_window
))
10806 frame_or_window
= selected_window
;
10808 if (WINDOWP (frame_or_window
))
10810 struct window
*w
= decode_live_window (frame_or_window
);
10812 XSETINT (x
, (XINT (x
)
10813 + WINDOW_LEFT_EDGE_X (w
)
10815 ? window_box_left_offset (w
, TEXT_AREA
)
10817 XSETINT (y
, WINDOW_TO_FRAME_PIXEL_Y (w
, XINT (y
)));
10818 frame_or_window
= w
->frame
;
10821 CHECK_LIVE_FRAME (frame_or_window
);
10823 return make_lispy_position (XFRAME (frame_or_window
), x
, y
, 0);
10826 DEFUN ("posn-at-point", Fposn_at_point
, Sposn_at_point
, 0, 2, 0,
10827 doc
: /* Return position information for buffer POS in WINDOW.
10828 POS defaults to point in WINDOW; WINDOW defaults to the selected window.
10830 Return nil if position is not visible in window. Otherwise,
10831 the return value is similar to that returned by `event-start' for
10832 a mouse click at the upper left corner of the glyph corresponding
10833 to the given buffer position:
10834 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
10835 IMAGE (DX . DY) (WIDTH . HEIGHT))
10836 The `posn-' functions access elements of such lists. */)
10837 (Lisp_Object pos
, Lisp_Object window
)
10842 window
= selected_window
;
10844 tem
= Fpos_visible_in_window_p (pos
, window
, Qt
);
10847 Lisp_Object x
= XCAR (tem
);
10848 Lisp_Object y
= XCAR (XCDR (tem
));
10850 /* Point invisible due to hscrolling? */
10853 tem
= Fposn_at_x_y (x
, y
, window
, Qnil
);
10859 /* Set up a new kboard object with reasonable initial values.
10860 TYPE is a window system for which this keyboard is used. */
10863 init_kboard (KBOARD
*kb
, Lisp_Object type
)
10865 kset_overriding_terminal_local_map (kb
, Qnil
);
10866 kset_last_command (kb
, Qnil
);
10867 kset_real_last_command (kb
, Qnil
);
10868 kset_keyboard_translate_table (kb
, Qnil
);
10869 kset_last_repeatable_command (kb
, Qnil
);
10870 kset_prefix_arg (kb
, Qnil
);
10871 kset_last_prefix_arg (kb
, Qnil
);
10872 kset_kbd_queue (kb
, Qnil
);
10873 kb
->kbd_queue_has_data
= 0;
10874 kb
->immediate_echo
= 0;
10875 kset_echo_string (kb
, Qnil
);
10876 kb
->echo_after_prompt
= -1;
10877 kb
->kbd_macro_buffer
= 0;
10878 kb
->kbd_macro_bufsize
= 0;
10879 kset_defining_kbd_macro (kb
, Qnil
);
10880 kset_last_kbd_macro (kb
, Qnil
);
10881 kb
->reference_count
= 0;
10882 kset_system_key_alist (kb
, Qnil
);
10883 kset_system_key_syms (kb
, Qnil
);
10884 kset_window_system (kb
, type
);
10885 kset_input_decode_map (kb
, Fmake_sparse_keymap (Qnil
));
10886 kset_local_function_key_map (kb
, Fmake_sparse_keymap (Qnil
));
10887 Fset_keymap_parent (KVAR (kb
, Vlocal_function_key_map
), Vfunction_key_map
);
10888 kset_default_minibuffer_frame (kb
, Qnil
);
10891 /* Allocate and basically initialize keyboard
10892 object to use with window system TYPE. */
10895 allocate_kboard (Lisp_Object type
)
10897 KBOARD
*kb
= xmalloc (sizeof *kb
);
10899 init_kboard (kb
, type
);
10900 kb
->next_kboard
= all_kboards
;
10906 * Destroy the contents of a kboard object, but not the object itself.
10907 * We use this just before deleting it, or if we're going to initialize
10908 * it a second time.
10911 wipe_kboard (KBOARD
*kb
)
10913 xfree (kb
->kbd_macro_buffer
);
10916 /* Free KB and memory referenced from it. */
10919 delete_kboard (KBOARD
*kb
)
10923 for (kbp
= &all_kboards
; *kbp
!= kb
; kbp
= &(*kbp
)->next_kboard
)
10926 *kbp
= kb
->next_kboard
;
10928 /* Prevent a dangling reference to KB. */
10929 if (kb
== current_kboard
10930 && FRAMEP (selected_frame
)
10931 && FRAME_LIVE_P (XFRAME (selected_frame
)))
10933 current_kboard
= FRAME_KBOARD (XFRAME (selected_frame
));
10935 if (current_kboard
== kb
)
10944 init_keyboard (void)
10946 /* This is correct before outermost invocation of the editor loop. */
10947 command_loop_level
= -1;
10948 immediate_quit
= 0;
10949 quit_char
= Ctl ('g');
10950 Vunread_command_events
= Qnil
;
10951 timer_idleness_start_time
= invalid_timespec ();
10953 recent_keys_index
= 0;
10954 kbd_fetch_ptr
= kbd_buffer
;
10955 kbd_store_ptr
= kbd_buffer
;
10956 do_mouse_tracking
= Qnil
;
10958 interrupt_input_blocked
= 0;
10959 pending_signals
= 0;
10961 /* This means that command_loop_1 won't try to select anything the first
10963 internal_last_event_frame
= Qnil
;
10964 Vlast_event_frame
= internal_last_event_frame
;
10966 current_kboard
= initial_kboard
;
10967 /* Re-initialize the keyboard again. */
10968 wipe_kboard (current_kboard
);
10969 /* A value of nil for Vwindow_system normally means a tty, but we also use
10970 it for the initial terminal since there is no window system there. */
10971 init_kboard (current_kboard
, Qnil
);
10973 if (!noninteractive
)
10975 /* Before multi-tty support, these handlers used to be installed
10976 only if the current session was a tty session. Now an Emacs
10977 session may have multiple display types, so we always handle
10978 SIGINT. There is special code in handle_interrupt_signal to exit
10979 Emacs on SIGINT when there are no termcap frames on the
10980 controlling terminal. */
10981 struct sigaction action
;
10982 emacs_sigaction_init (&action
, deliver_interrupt_signal
);
10983 sigaction (SIGINT
, &action
, 0);
10985 /* For systems with SysV TERMIO, C-g is set up for both SIGINT and
10986 SIGQUIT and we can't tell which one it will give us. */
10987 sigaction (SIGQUIT
, &action
, 0);
10988 #endif /* not DOS_NT */
10990 #ifdef USABLE_SIGIO
10991 if (!noninteractive
)
10993 struct sigaction action
;
10994 emacs_sigaction_init (&action
, deliver_input_available_signal
);
10995 sigaction (SIGIO
, &action
, 0);
10999 /* Use interrupt input by default, if it works and noninterrupt input
11000 has deficiencies. */
11002 #ifdef INTERRUPT_INPUT
11003 interrupt_input
= 1;
11005 interrupt_input
= 0;
11008 pthread_sigmask (SIG_SETMASK
, &empty_mask
, 0);
11011 if (keyboard_init_hook
)
11012 (*keyboard_init_hook
) ();
11014 #ifdef POLL_FOR_INPUT
11016 poll_suppress_count
= 1;
11021 /* This type's only use is in syms_of_keyboard, to put properties on the
11022 event header symbols. */
11029 static const struct event_head head_table
[] = {
11030 {SYMBOL_INDEX (Qmouse_movement
), SYMBOL_INDEX (Qmouse_movement
)},
11031 {SYMBOL_INDEX (Qscroll_bar_movement
), SYMBOL_INDEX (Qmouse_movement
)},
11033 /* Some of the event heads. */
11034 {SYMBOL_INDEX (Qswitch_frame
), SYMBOL_INDEX (Qswitch_frame
)},
11036 {SYMBOL_INDEX (Qfocus_in
), SYMBOL_INDEX (Qfocus_in
)},
11037 {SYMBOL_INDEX (Qfocus_out
), SYMBOL_INDEX (Qfocus_out
)},
11038 {SYMBOL_INDEX (Qdelete_frame
), SYMBOL_INDEX (Qdelete_frame
)},
11039 {SYMBOL_INDEX (Qiconify_frame
), SYMBOL_INDEX (Qiconify_frame
)},
11040 {SYMBOL_INDEX (Qmake_frame_visible
), SYMBOL_INDEX (Qmake_frame_visible
)},
11041 /* `select-window' should be handled just like `switch-frame'
11042 in read_key_sequence. */
11043 {SYMBOL_INDEX (Qselect_window
), SYMBOL_INDEX (Qswitch_frame
)}
11047 syms_of_keyboard (void)
11049 pending_funcalls
= Qnil
;
11050 staticpro (&pending_funcalls
);
11052 Vlispy_mouse_stem
= build_pure_c_string ("mouse");
11053 staticpro (&Vlispy_mouse_stem
);
11055 regular_top_level_message
= build_pure_c_string ("Back to top level");
11056 #ifdef HAVE_STACK_OVERFLOW_HANDLING
11057 recover_top_level_message
11058 = build_pure_c_string ("Re-entering top level after C stack overflow");
11060 DEFVAR_LISP ("internal--top-level-message", Vinternal__top_level_message
,
11061 doc
: /* Message displayed by `normal-top-level'. */);
11062 Vinternal__top_level_message
= regular_top_level_message
;
11065 DEFSYM (QCimage
, ":image");
11066 DEFSYM (Qhelp_echo
, "help-echo");
11067 DEFSYM (QCrtl
, ":rtl");
11069 staticpro (&item_properties
);
11070 item_properties
= Qnil
;
11072 staticpro (&tool_bar_item_properties
);
11073 tool_bar_item_properties
= Qnil
;
11074 staticpro (&tool_bar_items_vector
);
11075 tool_bar_items_vector
= Qnil
;
11077 DEFSYM (Qtimer_event_handler
, "timer-event-handler");
11079 /* Non-nil disable property on a command means do not execute it;
11080 call disabled-command-function's value instead. */
11081 DEFSYM (Qdisabled
, "disabled");
11083 DEFSYM (Qundefined
, "undefined");
11085 /* Hooks to run before and after each command. */
11086 DEFSYM (Qpre_command_hook
, "pre-command-hook");
11087 DEFSYM (Qpost_command_hook
, "post-command-hook");
11089 DEFSYM (Qdeferred_action_function
, "deferred-action-function");
11090 DEFSYM (Qdelayed_warnings_hook
, "delayed-warnings-hook");
11091 DEFSYM (Qfunction_key
, "function-key");
11093 /* The values of Qevent_kind properties. */
11094 DEFSYM (Qmouse_click
, "mouse-click");
11096 DEFSYM (Qdrag_n_drop
, "drag-n-drop");
11097 DEFSYM (Qsave_session
, "save-session");
11098 DEFSYM (Qconfig_changed_event
, "config-changed-event");
11100 /* Menu and tool bar item parts. */
11101 DEFSYM (Qmenu_enable
, "menu-enable");
11104 DEFSYM (Qlanguage_change
, "language-change");
11108 DEFSYM (Qdbus_event
, "dbus-event");
11111 #ifdef USE_FILE_NOTIFY
11112 DEFSYM (Qfile_notify
, "file-notify");
11113 #endif /* USE_FILE_NOTIFY */
11115 /* Menu and tool bar item parts. */
11116 DEFSYM (QCenable
, ":enable");
11117 DEFSYM (QCvisible
, ":visible");
11118 DEFSYM (QChelp
, ":help");
11119 DEFSYM (QCfilter
, ":filter");
11120 DEFSYM (QCbutton
, ":button");
11121 DEFSYM (QCkeys
, ":keys");
11122 DEFSYM (QCkey_sequence
, ":key-sequence");
11124 /* Non-nil disable property on a command means
11125 do not execute it; call disabled-command-function's value instead. */
11126 DEFSYM (QCtoggle
, ":toggle");
11127 DEFSYM (QCradio
, ":radio");
11128 DEFSYM (QClabel
, ":label");
11129 DEFSYM (QCvert_only
, ":vert-only");
11131 /* Symbols to use for parts of windows. */
11132 DEFSYM (Qvertical_line
, "vertical-line");
11133 DEFSYM (Qright_divider
, "right-divider");
11134 DEFSYM (Qbottom_divider
, "bottom-divider");
11136 DEFSYM (Qmouse_fixup_help_message
, "mouse-fixup-help-message");
11138 DEFSYM (Qabove_handle
, "above-handle");
11139 DEFSYM (Qhandle
, "handle");
11140 DEFSYM (Qbelow_handle
, "below-handle");
11141 DEFSYM (Qup
, "up");
11142 DEFSYM (Qdown
, "down");
11143 DEFSYM (Qtop
, "top");
11144 DEFSYM (Qbottom
, "bottom");
11145 DEFSYM (Qend_scroll
, "end-scroll");
11146 DEFSYM (Qratio
, "ratio");
11147 DEFSYM (Qbefore_handle
, "before-handle");
11148 DEFSYM (Qhorizontal_handle
, "horizontal-handle");
11149 DEFSYM (Qafter_handle
, "after-handle");
11150 DEFSYM (Qleft
, "left");
11151 DEFSYM (Qright
, "right");
11152 DEFSYM (Qleftmost
, "leftmost");
11153 DEFSYM (Qrightmost
, "rightmost");
11155 /* Properties of event headers. */
11156 DEFSYM (Qevent_kind
, "event-kind");
11157 DEFSYM (Qevent_symbol_elements
, "event-symbol-elements");
11159 /* An event header symbol HEAD may have a property named
11160 Qevent_symbol_element_mask, which is of the form (BASE MODIFIERS);
11161 BASE is the base, unmodified version of HEAD, and MODIFIERS is the
11162 mask of modifiers applied to it. If present, this is used to help
11163 speed up parse_modifiers. */
11164 DEFSYM (Qevent_symbol_element_mask
, "event-symbol-element-mask");
11166 /* An unmodified event header BASE may have a property named
11167 Qmodifier_cache, which is an alist mapping modifier masks onto
11168 modified versions of BASE. If present, this helps speed up
11169 apply_modifiers. */
11170 DEFSYM (Qmodifier_cache
, "modifier-cache");
11172 DEFSYM (Qrecompute_lucid_menubar
, "recompute-lucid-menubar");
11173 DEFSYM (Qactivate_menubar_hook
, "activate-menubar-hook");
11175 DEFSYM (Qpolling_period
, "polling-period");
11177 DEFSYM (Qgui_set_selection
, "gui-set-selection");
11179 /* The primary selection. */
11180 DEFSYM (QPRIMARY
, "PRIMARY");
11182 DEFSYM (Qhandle_switch_frame
, "handle-switch-frame");
11183 DEFSYM (Qhandle_select_window
, "handle-select-window");
11185 DEFSYM (Qinput_method_exit_on_first_char
, "input-method-exit-on-first-char");
11186 DEFSYM (Qinput_method_use_echo_area
, "input-method-use-echo-area");
11188 DEFSYM (Qhelp_form_show
, "help-form-show");
11190 DEFSYM (Qecho_keystrokes
, "echo-keystrokes");
11192 Fset (Qinput_method_exit_on_first_char
, Qnil
);
11193 Fset (Qinput_method_use_echo_area
, Qnil
);
11195 /* Symbols to head events. */
11196 DEFSYM (Qmouse_movement
, "mouse-movement");
11197 DEFSYM (Qscroll_bar_movement
, "scroll-bar-movement");
11198 DEFSYM (Qswitch_frame
, "switch-frame");
11199 DEFSYM (Qfocus_in
, "focus-in");
11200 DEFSYM (Qfocus_out
, "focus-out");
11201 DEFSYM (Qdelete_frame
, "delete-frame");
11202 DEFSYM (Qiconify_frame
, "iconify-frame");
11203 DEFSYM (Qmake_frame_visible
, "make-frame-visible");
11204 DEFSYM (Qselect_window
, "select-window");
11208 for (i
= 0; i
< ARRAYELTS (head_table
); i
++)
11210 const struct event_head
*p
= &head_table
[i
];
11211 Lisp_Object var
= builtin_lisp_symbol (p
->var
);
11212 Lisp_Object kind
= builtin_lisp_symbol (p
->kind
);
11213 Fput (var
, Qevent_kind
, kind
);
11214 Fput (var
, Qevent_symbol_elements
, list1 (var
));
11218 button_down_location
= Fmake_vector (make_number (5), Qnil
);
11219 staticpro (&button_down_location
);
11220 mouse_syms
= Fmake_vector (make_number (5), Qnil
);
11221 staticpro (&mouse_syms
);
11222 wheel_syms
= Fmake_vector (make_number (ARRAYELTS (lispy_wheel_names
)),
11224 staticpro (&wheel_syms
);
11228 int len
= ARRAYELTS (modifier_names
);
11230 modifier_symbols
= Fmake_vector (make_number (len
), Qnil
);
11231 for (i
= 0; i
< len
; i
++)
11232 if (modifier_names
[i
])
11233 ASET (modifier_symbols
, i
, intern_c_string (modifier_names
[i
]));
11234 staticpro (&modifier_symbols
);
11237 recent_keys
= Fmake_vector (make_number (NUM_RECENT_KEYS
), Qnil
);
11238 staticpro (&recent_keys
);
11240 this_command_keys
= Fmake_vector (make_number (40), Qnil
);
11241 staticpro (&this_command_keys
);
11243 raw_keybuf
= Fmake_vector (make_number (30), Qnil
);
11244 staticpro (&raw_keybuf
);
11246 DEFSYM (Qcommand_execute
, "command-execute");
11248 accent_key_syms
= Qnil
;
11249 staticpro (&accent_key_syms
);
11251 func_key_syms
= Qnil
;
11252 staticpro (&func_key_syms
);
11254 drag_n_drop_syms
= Qnil
;
11255 staticpro (&drag_n_drop_syms
);
11257 unread_switch_frame
= Qnil
;
11258 staticpro (&unread_switch_frame
);
11260 internal_last_event_frame
= Qnil
;
11261 staticpro (&internal_last_event_frame
);
11263 read_key_sequence_cmd
= Qnil
;
11264 staticpro (&read_key_sequence_cmd
);
11265 read_key_sequence_remapped
= Qnil
;
11266 staticpro (&read_key_sequence_remapped
);
11268 menu_bar_one_keymap_changed_items
= Qnil
;
11269 staticpro (&menu_bar_one_keymap_changed_items
);
11271 menu_bar_items_vector
= Qnil
;
11272 staticpro (&menu_bar_items_vector
);
11274 help_form_saved_window_configs
= Qnil
;
11275 staticpro (&help_form_saved_window_configs
);
11277 defsubr (&Scurrent_idle_time
);
11278 defsubr (&Sevent_symbol_parse_modifiers
);
11279 defsubr (&Sevent_convert_list
);
11280 defsubr (&Sread_key_sequence
);
11281 defsubr (&Sread_key_sequence_vector
);
11282 defsubr (&Srecursive_edit
);
11283 defsubr (&Strack_mouse
);
11284 defsubr (&Sinput_pending_p
);
11285 defsubr (&Srecent_keys
);
11286 defsubr (&Sthis_command_keys
);
11287 defsubr (&Sthis_command_keys_vector
);
11288 defsubr (&Sthis_single_command_keys
);
11289 defsubr (&Sthis_single_command_raw_keys
);
11290 defsubr (&Sreset_this_command_lengths
);
11291 defsubr (&Sclear_this_command_keys
);
11292 defsubr (&Ssuspend_emacs
);
11293 defsubr (&Sabort_recursive_edit
);
11294 defsubr (&Sexit_recursive_edit
);
11295 defsubr (&Srecursion_depth
);
11296 defsubr (&Scommand_error_default_function
);
11297 defsubr (&Stop_level
);
11298 defsubr (&Sdiscard_input
);
11299 defsubr (&Sopen_dribble_file
);
11300 defsubr (&Sset_input_interrupt_mode
);
11301 defsubr (&Sset_output_flow_control
);
11302 defsubr (&Sset_input_meta_mode
);
11303 defsubr (&Sset_quit_char
);
11304 defsubr (&Sset_input_mode
);
11305 defsubr (&Scurrent_input_mode
);
11306 defsubr (&Sposn_at_point
);
11307 defsubr (&Sposn_at_x_y
);
11309 DEFVAR_LISP ("last-command-event", last_command_event
,
11310 doc
: /* Last input event that was part of a command. */);
11312 DEFVAR_LISP ("last-nonmenu-event", last_nonmenu_event
,
11313 doc
: /* Last input event in a command, except for mouse menu events.
11314 Mouse menus give back keys that don't look like mouse events;
11315 this variable holds the actual mouse event that led to the menu,
11316 so that you can determine whether the command was run by mouse or not. */);
11318 DEFVAR_LISP ("last-input-event", last_input_event
,
11319 doc
: /* Last input event. */);
11321 DEFVAR_LISP ("unread-command-events", Vunread_command_events
,
11322 doc
: /* List of events to be read as the command input.
11323 These events are processed first, before actual keyboard input.
11324 Events read from this list are not normally added to `this-command-keys',
11325 as they will already have been added once as they were read for the first time.
11326 An element of the form (t . EVENT) forces EVENT to be added to that list. */);
11327 Vunread_command_events
= Qnil
;
11329 DEFVAR_LISP ("unread-post-input-method-events", Vunread_post_input_method_events
,
11330 doc
: /* List of events to be processed as input by input methods.
11331 These events are processed before `unread-command-events'
11332 and actual keyboard input, but are not given to `input-method-function'. */);
11333 Vunread_post_input_method_events
= Qnil
;
11335 DEFVAR_LISP ("unread-input-method-events", Vunread_input_method_events
,
11336 doc
: /* List of events to be processed as input by input methods.
11337 These events are processed after `unread-command-events', but
11338 before actual keyboard input.
11339 If there's an active input method, the events are given to
11340 `input-method-function'. */);
11341 Vunread_input_method_events
= Qnil
;
11343 DEFVAR_LISP ("meta-prefix-char", meta_prefix_char
,
11344 doc
: /* Meta-prefix character code.
11345 Meta-foo as command input turns into this character followed by foo. */);
11346 XSETINT (meta_prefix_char
, 033);
11348 DEFVAR_KBOARD ("last-command", Vlast_command
,
11349 doc
: /* The last command executed.
11350 Normally a symbol with a function definition, but can be whatever was found
11351 in the keymap, or whatever the variable `this-command' was set to by that
11354 The value `mode-exit' is special; it means that the previous command
11355 read an event that told it to exit, and it did so and unread that event.
11356 In other words, the present command is the event that made the previous
11359 The value `kill-region' is special; it means that the previous command
11360 was a kill command.
11362 `last-command' has a separate binding for each terminal device.
11363 See Info node `(elisp)Multiple Terminals'. */);
11365 DEFVAR_KBOARD ("real-last-command", Vreal_last_command
,
11366 doc
: /* Same as `last-command', but never altered by Lisp code.
11367 Taken from the previous value of `real-this-command'. */);
11369 DEFVAR_KBOARD ("last-repeatable-command", Vlast_repeatable_command
,
11370 doc
: /* Last command that may be repeated.
11371 The last command executed that was not bound to an input event.
11372 This is the command `repeat' will try to repeat.
11373 Taken from a previous value of `real-this-command'. */);
11375 DEFVAR_LISP ("this-command", Vthis_command
,
11376 doc
: /* The command now being executed.
11377 The command can set this variable; whatever is put here
11378 will be in `last-command' during the following command. */);
11379 Vthis_command
= Qnil
;
11381 DEFVAR_LISP ("real-this-command", Vreal_this_command
,
11382 doc
: /* This is like `this-command', except that commands should never modify it. */);
11383 Vreal_this_command
= Qnil
;
11385 DEFVAR_LISP ("this-command-keys-shift-translated",
11386 Vthis_command_keys_shift_translated
,
11387 doc
: /* Non-nil if the key sequence activating this command was shift-translated.
11388 Shift-translation occurs when there is no binding for the key sequence
11389 as entered, but a binding was found by changing an upper-case letter
11390 to lower-case, or a shifted function key to an unshifted one. */);
11391 Vthis_command_keys_shift_translated
= Qnil
;
11393 DEFVAR_LISP ("this-original-command", Vthis_original_command
,
11394 doc
: /* The command bound to the current key sequence before remapping.
11395 It equals `this-command' if the original command was not remapped through
11396 any of the active keymaps. Otherwise, the value of `this-command' is the
11397 result of looking up the original command in the active keymaps. */);
11398 Vthis_original_command
= Qnil
;
11400 DEFVAR_INT ("auto-save-interval", auto_save_interval
,
11401 doc
: /* Number of input events between auto-saves.
11402 Zero means disable autosaving due to number of characters typed. */);
11403 auto_save_interval
= 300;
11405 DEFVAR_LISP ("auto-save-timeout", Vauto_save_timeout
,
11406 doc
: /* Number of seconds idle time before auto-save.
11407 Zero or nil means disable auto-saving due to idleness.
11408 After auto-saving due to this many seconds of idle time,
11409 Emacs also does a garbage collection if that seems to be warranted. */);
11410 XSETFASTINT (Vauto_save_timeout
, 30);
11412 DEFVAR_LISP ("echo-keystrokes", Vecho_keystrokes
,
11413 doc
: /* Nonzero means echo unfinished commands after this many seconds of pause.
11414 The value may be integer or floating point.
11415 If the value is zero, don't echo at all. */);
11416 Vecho_keystrokes
= make_number (1);
11418 DEFVAR_INT ("polling-period", polling_period
,
11419 doc
: /* Interval between polling for input during Lisp execution.
11420 The reason for polling is to make C-g work to stop a running program.
11421 Polling is needed only when using X windows and SIGIO does not work.
11422 Polling is automatically disabled in all other cases. */);
11423 polling_period
= 2;
11425 DEFVAR_LISP ("double-click-time", Vdouble_click_time
,
11426 doc
: /* Maximum time between mouse clicks to make a double-click.
11427 Measured in milliseconds. The value nil means disable double-click
11428 recognition; t means double-clicks have no time limit and are detected
11429 by position only. */);
11430 Vdouble_click_time
= make_number (500);
11432 DEFVAR_INT ("double-click-fuzz", double_click_fuzz
,
11433 doc
: /* Maximum mouse movement between clicks to make a double-click.
11434 On window-system frames, value is the number of pixels the mouse may have
11435 moved horizontally or vertically between two clicks to make a double-click.
11436 On non window-system frames, value is interpreted in units of 1/8 characters
11439 This variable is also the threshold for motion of the mouse
11440 to count as a drag. */);
11441 double_click_fuzz
= 3;
11443 DEFVAR_INT ("num-input-keys", num_input_keys
,
11444 doc
: /* Number of complete key sequences read as input so far.
11445 This includes key sequences read from keyboard macros.
11446 The number is effectively the number of interactive command invocations. */);
11447 num_input_keys
= 0;
11449 DEFVAR_INT ("num-nonmacro-input-events", num_nonmacro_input_events
,
11450 doc
: /* Number of input events read from the keyboard so far.
11451 This does not include events generated by keyboard macros. */);
11452 num_nonmacro_input_events
= 0;
11454 DEFVAR_LISP ("last-event-frame", Vlast_event_frame
,
11455 doc
: /* The frame in which the most recently read event occurred.
11456 If the last event came from a keyboard macro, this is set to `macro'. */);
11457 Vlast_event_frame
= Qnil
;
11459 /* This variable is set up in sysdep.c. */
11460 DEFVAR_LISP ("tty-erase-char", Vtty_erase_char
,
11461 doc
: /* The ERASE character as set by the user with stty. */);
11463 DEFVAR_LISP ("help-char", Vhelp_char
,
11464 doc
: /* Character to recognize as meaning Help.
11465 When it is read, do `(eval help-form)', and display result if it's a string.
11466 If the value of `help-form' is nil, this char can be read normally. */);
11467 XSETINT (Vhelp_char
, Ctl ('H'));
11469 DEFVAR_LISP ("help-event-list", Vhelp_event_list
,
11470 doc
: /* List of input events to recognize as meaning Help.
11471 These work just like the value of `help-char' (see that). */);
11472 Vhelp_event_list
= Qnil
;
11474 DEFVAR_LISP ("help-form", Vhelp_form
,
11475 doc
: /* Form to execute when character `help-char' is read.
11476 If the form returns a string, that string is displayed.
11477 If `help-form' is nil, the help char is not recognized. */);
11480 DEFVAR_LISP ("prefix-help-command", Vprefix_help_command
,
11481 doc
: /* Command to run when `help-char' character follows a prefix key.
11482 This command is used only when there is no actual binding
11483 for that character after that prefix key. */);
11484 Vprefix_help_command
= Qnil
;
11486 DEFVAR_LISP ("top-level", Vtop_level
,
11487 doc
: /* Form to evaluate when Emacs starts up.
11488 Useful to set before you dump a modified Emacs. */);
11490 XSYMBOL (Qtop_level
)->declared_special
= false;
11492 DEFVAR_KBOARD ("keyboard-translate-table", Vkeyboard_translate_table
,
11493 doc
: /* Translate table for local keyboard input, or nil.
11494 If non-nil, the value should be a char-table. Each character read
11495 from the keyboard is looked up in this char-table. If the value found
11496 there is non-nil, then it is used instead of the actual input character.
11498 The value can also be a string or vector, but this is considered obsolete.
11499 If it is a string or vector of length N, character codes N and up are left
11500 untranslated. In a vector, an element which is nil means "no translation".
11502 This is applied to the characters supplied to input methods, not their
11503 output. See also `translation-table-for-input'.
11505 This variable has a separate binding for each terminal.
11506 See Info node `(elisp)Multiple Terminals'. */);
11508 DEFVAR_BOOL ("cannot-suspend", cannot_suspend
,
11509 doc
: /* Non-nil means to always spawn a subshell instead of suspending.
11510 \(Even if the operating system has support for stopping a process.\) */);
11511 cannot_suspend
= 0;
11513 DEFVAR_BOOL ("menu-prompting", menu_prompting
,
11514 doc
: /* Non-nil means prompt with menus when appropriate.
11515 This is done when reading from a keymap that has a prompt string,
11516 for elements that have prompt strings.
11517 The menu is displayed on the screen
11518 if X menus were enabled at configuration
11519 time and the previous event was a mouse click prefix key.
11520 Otherwise, menu prompting uses the echo area. */);
11521 menu_prompting
= 1;
11523 DEFVAR_LISP ("menu-prompt-more-char", menu_prompt_more_char
,
11524 doc
: /* Character to see next line of menu prompt.
11525 Type this character while in a menu prompt to rotate around the lines of it. */);
11526 XSETINT (menu_prompt_more_char
, ' ');
11528 DEFVAR_INT ("extra-keyboard-modifiers", extra_keyboard_modifiers
,
11529 doc
: /* A mask of additional modifier keys to use with every keyboard character.
11530 Emacs applies the modifiers of the character stored here to each keyboard
11531 character it reads. For example, after evaluating the expression
11532 (setq extra-keyboard-modifiers ?\\C-x)
11533 all input characters will have the control modifier applied to them.
11535 Note that the character ?\\C-@, equivalent to the integer zero, does
11536 not count as a control character; rather, it counts as a character
11537 with no modifiers; thus, setting `extra-keyboard-modifiers' to zero
11538 cancels any modification. */);
11539 extra_keyboard_modifiers
= 0;
11541 DEFSYM (Qdeactivate_mark
, "deactivate-mark");
11542 DEFVAR_LISP ("deactivate-mark", Vdeactivate_mark
,
11543 doc
: /* If an editing command sets this to t, deactivate the mark afterward.
11544 The command loop sets this to nil before each command,
11545 and tests the value when the command returns.
11546 Buffer modification stores t in this variable. */);
11547 Vdeactivate_mark
= Qnil
;
11548 Fmake_variable_buffer_local (Qdeactivate_mark
);
11550 DEFVAR_LISP ("pre-command-hook", Vpre_command_hook
,
11551 doc
: /* Normal hook run before each command is executed.
11552 If an unhandled error happens in running this hook,
11553 the function in which the error occurred is unconditionally removed, since
11554 otherwise the error might happen repeatedly and make Emacs nonfunctional. */);
11555 Vpre_command_hook
= Qnil
;
11557 DEFVAR_LISP ("post-command-hook", Vpost_command_hook
,
11558 doc
: /* Normal hook run after each command is executed.
11559 If an unhandled error happens in running this hook,
11560 the function in which the error occurred is unconditionally removed, since
11561 otherwise the error might happen repeatedly and make Emacs nonfunctional. */);
11562 Vpost_command_hook
= Qnil
;
11565 DEFVAR_LISP ("echo-area-clear-hook", ...,
11566 doc
: /* Normal hook run when clearing the echo area. */);
11568 DEFSYM (Qecho_area_clear_hook
, "echo-area-clear-hook");
11569 Fset (Qecho_area_clear_hook
, Qnil
);
11571 DEFVAR_LISP ("lucid-menu-bar-dirty-flag", Vlucid_menu_bar_dirty_flag
,
11572 doc
: /* Non-nil means menu bar, specified Lucid style, needs to be recomputed. */);
11573 Vlucid_menu_bar_dirty_flag
= Qnil
;
11575 DEFVAR_LISP ("menu-bar-final-items", Vmenu_bar_final_items
,
11576 doc
: /* List of menu bar items to move to the end of the menu bar.
11577 The elements of the list are event types that may have menu bar bindings. */);
11578 Vmenu_bar_final_items
= Qnil
;
11580 DEFVAR_LISP ("tool-bar-separator-image-expression", Vtool_bar_separator_image_expression
,
11581 doc
: /* Expression evaluating to the image spec for a tool-bar separator.
11582 This is used internally by graphical displays that do not render
11583 tool-bar separators natively. Otherwise it is unused (e.g. on GTK). */);
11584 Vtool_bar_separator_image_expression
= Qnil
;
11586 DEFVAR_KBOARD ("overriding-terminal-local-map",
11587 Voverriding_terminal_local_map
,
11588 doc
: /* Per-terminal keymap that takes precedence over all other keymaps.
11589 This variable is intended to let commands such as `universal-argument'
11590 set up a different keymap for reading the next command.
11592 `overriding-terminal-local-map' has a separate binding for each
11593 terminal device. See Info node `(elisp)Multiple Terminals'. */);
11595 DEFVAR_LISP ("overriding-local-map", Voverriding_local_map
,
11596 doc
: /* Keymap that replaces (overrides) local keymaps.
11597 If this variable is non-nil, Emacs looks up key bindings in this
11598 keymap INSTEAD OF the keymap char property, minor mode maps, and the
11599 buffer's local map. Hence, the only active keymaps would be
11600 `overriding-terminal-local-map', this keymap, and `global-keymap', in
11601 order of precedence. */);
11602 Voverriding_local_map
= Qnil
;
11604 DEFVAR_LISP ("overriding-local-map-menu-flag", Voverriding_local_map_menu_flag
,
11605 doc
: /* Non-nil means `overriding-local-map' applies to the menu bar.
11606 Otherwise, the menu bar continues to reflect the buffer's local map
11607 and the minor mode maps regardless of `overriding-local-map'. */);
11608 Voverriding_local_map_menu_flag
= Qnil
;
11610 DEFVAR_LISP ("special-event-map", Vspecial_event_map
,
11611 doc
: /* Keymap defining bindings for special events to execute at low level. */);
11612 Vspecial_event_map
= list1 (Qkeymap
);
11614 DEFVAR_LISP ("track-mouse", do_mouse_tracking
,
11615 doc
: /* Non-nil means generate motion events for mouse motion. */);
11617 DEFVAR_KBOARD ("system-key-alist", Vsystem_key_alist
,
11618 doc
: /* Alist of system-specific X windows key symbols.
11619 Each element should have the form (N . SYMBOL) where N is the
11620 numeric keysym code (sans the \"system-specific\" bit 1<<28)
11621 and SYMBOL is its name.
11623 `system-key-alist' has a separate binding for each terminal device.
11624 See Info node `(elisp)Multiple Terminals'. */);
11626 DEFVAR_KBOARD ("local-function-key-map", Vlocal_function_key_map
,
11627 doc
: /* Keymap that translates key sequences to key sequences during input.
11628 This is used mainly for mapping key sequences into some preferred
11629 key events (symbols).
11631 The `read-key-sequence' function replaces any subsequence bound by
11632 `local-function-key-map' with its binding. More precisely, when the
11633 active keymaps have no binding for the current key sequence but
11634 `local-function-key-map' binds a suffix of the sequence to a vector or
11635 string, `read-key-sequence' replaces the matching suffix with its
11636 binding, and continues with the new sequence.
11638 If the binding is a function, it is called with one argument (the prompt)
11639 and its return value (a key sequence) is used.
11641 The events that come from bindings in `local-function-key-map' are not
11642 themselves looked up in `local-function-key-map'.
11644 For example, suppose `local-function-key-map' binds `ESC O P' to [f1].
11645 Typing `ESC O P' to `read-key-sequence' would return [f1]. Typing
11646 `C-x ESC O P' would return [?\\C-x f1]. If [f1] were a prefix key,
11647 typing `ESC O P x' would return [f1 x].
11649 `local-function-key-map' has a separate binding for each terminal
11650 device. See Info node `(elisp)Multiple Terminals'. If you need to
11651 define a binding on all terminals, change `function-key-map'
11652 instead. Initially, `local-function-key-map' is an empty keymap that
11653 has `function-key-map' as its parent on all terminal devices. */);
11655 DEFVAR_KBOARD ("input-decode-map", Vinput_decode_map
,
11656 doc
: /* Keymap that decodes input escape sequences.
11657 This is used mainly for mapping ASCII function key sequences into
11658 real Emacs function key events (symbols).
11660 The `read-key-sequence' function replaces any subsequence bound by
11661 `input-decode-map' with its binding. Contrary to `function-key-map',
11662 this map applies its rebinding regardless of the presence of an ordinary
11663 binding. So it is more like `key-translation-map' except that it applies
11664 before `function-key-map' rather than after.
11666 If the binding is a function, it is called with one argument (the prompt)
11667 and its return value (a key sequence) is used.
11669 The events that come from bindings in `input-decode-map' are not
11670 themselves looked up in `input-decode-map'. */);
11672 DEFVAR_LISP ("function-key-map", Vfunction_key_map
,
11673 doc
: /* The parent keymap of all `local-function-key-map' instances.
11674 Function key definitions that apply to all terminal devices should go
11675 here. If a mapping is defined in both the current
11676 `local-function-key-map' binding and this variable, then the local
11677 definition will take precedence. */);
11678 Vfunction_key_map
= Fmake_sparse_keymap (Qnil
);
11680 DEFVAR_LISP ("key-translation-map", Vkey_translation_map
,
11681 doc
: /* Keymap of key translations that can override keymaps.
11682 This keymap works like `input-decode-map', but comes after `function-key-map'.
11683 Another difference is that it is global rather than terminal-local. */);
11684 Vkey_translation_map
= Fmake_sparse_keymap (Qnil
);
11686 DEFVAR_LISP ("deferred-action-list", Vdeferred_action_list
,
11687 doc
: /* List of deferred actions to be performed at a later time.
11688 The precise format isn't relevant here; we just check whether it is nil. */);
11689 Vdeferred_action_list
= Qnil
;
11691 DEFVAR_LISP ("deferred-action-function", Vdeferred_action_function
,
11692 doc
: /* Function to call to handle deferred actions, after each command.
11693 This function is called with no arguments after each command
11694 whenever `deferred-action-list' is non-nil. */);
11695 Vdeferred_action_function
= Qnil
;
11697 DEFVAR_LISP ("delayed-warnings-list", Vdelayed_warnings_list
,
11698 doc
: /* List of warnings to be displayed after this command.
11699 Each element must be a list (TYPE MESSAGE [LEVEL [BUFFER-NAME]]),
11700 as per the args of `display-warning' (which see).
11701 If this variable is non-nil, `delayed-warnings-hook' will be run
11702 immediately after running `post-command-hook'. */);
11703 Vdelayed_warnings_list
= Qnil
;
11705 DEFVAR_LISP ("timer-list", Vtimer_list
,
11706 doc
: /* List of active absolute time timers in order of increasing time. */);
11707 Vtimer_list
= Qnil
;
11709 DEFVAR_LISP ("timer-idle-list", Vtimer_idle_list
,
11710 doc
: /* List of active idle-time timers in order of increasing time. */);
11711 Vtimer_idle_list
= Qnil
;
11713 DEFVAR_LISP ("input-method-function", Vinput_method_function
,
11714 doc
: /* If non-nil, the function that implements the current input method.
11715 It's called with one argument, a printing character that was just read.
11716 \(That means a character with code 040...0176.)
11717 Typically this function uses `read-event' to read additional events.
11718 When it does so, it should first bind `input-method-function' to nil
11719 so it will not be called recursively.
11721 The function should return a list of zero or more events
11722 to be used as input. If it wants to put back some events
11723 to be reconsidered, separately, by the input method,
11724 it can add them to the beginning of `unread-command-events'.
11726 The input method function can find in `input-method-previous-message'
11727 the previous echo area message.
11729 The input method function should refer to the variables
11730 `input-method-use-echo-area' and `input-method-exit-on-first-char'
11731 for guidance on what to do. */);
11732 Vinput_method_function
= Qlist
;
11734 DEFVAR_LISP ("input-method-previous-message",
11735 Vinput_method_previous_message
,
11736 doc
: /* When `input-method-function' is called, hold the previous echo area message.
11737 This variable exists because `read-event' clears the echo area
11738 before running the input method. It is nil if there was no message. */);
11739 Vinput_method_previous_message
= Qnil
;
11741 DEFVAR_LISP ("show-help-function", Vshow_help_function
,
11742 doc
: /* If non-nil, the function that implements the display of help.
11743 It's called with one argument, the help string to display. */);
11744 Vshow_help_function
= Qnil
;
11746 DEFVAR_LISP ("disable-point-adjustment", Vdisable_point_adjustment
,
11747 doc
: /* If non-nil, suppress point adjustment after executing a command.
11749 After a command is executed, if point is moved into a region that has
11750 special properties (e.g. composition, display), we adjust point to
11751 the boundary of the region. But, when a command sets this variable to
11752 non-nil, we suppress the point adjustment.
11754 This variable is set to nil before reading a command, and is checked
11755 just after executing the command. */);
11756 Vdisable_point_adjustment
= Qnil
;
11758 DEFVAR_LISP ("global-disable-point-adjustment",
11759 Vglobal_disable_point_adjustment
,
11760 doc
: /* If non-nil, always suppress point adjustment.
11762 The default value is nil, in which case, point adjustment are
11763 suppressed only after special commands that set
11764 `disable-point-adjustment' (which see) to non-nil. */);
11765 Vglobal_disable_point_adjustment
= Qnil
;
11767 DEFVAR_LISP ("minibuffer-message-timeout", Vminibuffer_message_timeout
,
11768 doc
: /* How long to display an echo-area message when the minibuffer is active.
11769 If the value is not a number, such messages don't time out. */);
11770 Vminibuffer_message_timeout
= make_number (2);
11772 DEFVAR_LISP ("throw-on-input", Vthrow_on_input
,
11773 doc
: /* If non-nil, any keyboard input throws to this symbol.
11774 The value of that variable is passed to `quit-flag' and later causes a
11775 peculiar kind of quitting. */);
11776 Vthrow_on_input
= Qnil
;
11778 DEFVAR_LISP ("command-error-function", Vcommand_error_function
,
11779 doc
: /* Function to output error messages.
11780 Called with three arguments:
11781 - the error data, a list of the form (SIGNALED-CONDITION . SIGNAL-DATA)
11782 such as what `condition-case' would bind its variable to,
11783 - the context (a string which normally goes at the start of the message),
11784 - the Lisp function within which the error was signaled. */);
11785 Vcommand_error_function
= intern ("command-error-default-function");
11787 DEFVAR_LISP ("enable-disabled-menus-and-buttons",
11788 Venable_disabled_menus_and_buttons
,
11789 doc
: /* If non-nil, don't ignore events produced by disabled menu items and tool-bar.
11791 Help functions bind this to allow help on disabled menu items
11792 and tool-bar buttons. */);
11793 Venable_disabled_menus_and_buttons
= Qnil
;
11795 DEFVAR_LISP ("select-active-regions",
11796 Vselect_active_regions
,
11797 doc
: /* If non-nil, an active region automatically sets the primary selection.
11798 If the value is `only', only temporarily active regions (usually made
11799 by mouse-dragging or shift-selection) set the window selection.
11801 This takes effect only when Transient Mark mode is enabled. */);
11802 Vselect_active_regions
= Qt
;
11804 DEFVAR_LISP ("saved-region-selection",
11805 Vsaved_region_selection
,
11806 doc
: /* Contents of active region prior to buffer modification.
11807 If `select-active-regions' is non-nil, Emacs sets this to the
11808 text in the region before modifying the buffer. The next call to
11809 the function `deactivate-mark' uses this to set the window selection. */);
11810 Vsaved_region_selection
= Qnil
;
11812 DEFVAR_LISP ("selection-inhibit-update-commands",
11813 Vselection_inhibit_update_commands
,
11814 doc
: /* List of commands which should not update the selection.
11815 Normally, if `select-active-regions' is non-nil and the mark remains
11816 active after a command (i.e. the mark was not deactivated), the Emacs
11817 command loop sets the selection to the text in the region. However,
11818 if the command is in this list, the selection is not updated. */);
11819 Vselection_inhibit_update_commands
11820 = list2 (Qhandle_switch_frame
, Qhandle_select_window
);
11822 DEFVAR_LISP ("debug-on-event",
11824 doc
: /* Enter debugger on this event. When Emacs
11825 receives the special event specified by this variable, it will try to
11826 break into the debugger as soon as possible instead of processing the
11827 event normally through `special-event-map'.
11829 Currently, the only supported values for this
11830 variable are `sigusr1' and `sigusr2'. */);
11831 Vdebug_on_event
= intern_c_string ("sigusr2");
11833 /* Create the initial keyboard. Qt means 'unset'. */
11834 initial_kboard
= allocate_kboard (Qt
);
11838 keys_of_keyboard (void)
11840 initial_define_key (global_map
, Ctl ('Z'), "suspend-emacs");
11841 initial_define_key (control_x_map
, Ctl ('Z'), "suspend-emacs");
11842 initial_define_key (meta_map
, Ctl ('C'), "exit-recursive-edit");
11843 initial_define_key (global_map
, Ctl (']'), "abort-recursive-edit");
11844 initial_define_key (meta_map
, 'x', "execute-extended-command");
11846 initial_define_lispy_key (Vspecial_event_map
, "delete-frame",
11847 "handle-delete-frame");
11848 initial_define_lispy_key (Vspecial_event_map
, "ns-put-working-text",
11849 "ns-put-working-text");
11850 initial_define_lispy_key (Vspecial_event_map
, "ns-unput-working-text",
11851 "ns-unput-working-text");
11852 /* Here we used to use `ignore-event' which would simple set prefix-arg to
11853 current-prefix-arg, as is done in `handle-switch-frame'.
11854 But `handle-switch-frame is not run from the special-map.
11855 Commands from that map are run in a special way that automatically
11856 preserves the prefix-arg. Restoring the prefix arg here is not just
11857 redundant but harmful:
11859 - current-prefix-arg is set to non-nil, prefix-arg is set to nil.
11860 - after the first prompt, the exit-minibuffer-hook is run which may
11861 iconify a frame and thus push a `iconify-frame' event.
11862 - after running exit-minibuffer-hook, current-prefix-arg is
11863 restored to the non-nil value it had before the prompt.
11864 - we enter the second prompt.
11865 current-prefix-arg is non-nil, prefix-arg is nil.
11866 - before running the first real event, we run the special iconify-frame
11867 event, but we pass the `special' arg to command-execute so
11868 current-prefix-arg and prefix-arg are left untouched.
11869 - here we foolishly copy the non-nil current-prefix-arg to prefix-arg.
11870 - the next key event will have a spuriously non-nil current-prefix-arg. */
11871 initial_define_lispy_key (Vspecial_event_map
, "iconify-frame",
11873 initial_define_lispy_key (Vspecial_event_map
, "make-frame-visible",
11875 /* Handling it at such a low-level causes read_key_sequence to get
11876 * confused because it doesn't realize that the current_buffer was
11877 * changed by read_char.
11879 * initial_define_lispy_key (Vspecial_event_map, "select-window",
11880 * "handle-select-window"); */
11881 initial_define_lispy_key (Vspecial_event_map
, "save-session",
11882 "handle-save-session");
11885 /* Define a special event which is raised for dbus callback
11887 initial_define_lispy_key (Vspecial_event_map
, "dbus-event",
11888 "dbus-handle-event");
11891 #ifdef USE_FILE_NOTIFY
11892 /* Define a special event which is raised for notification callback
11894 initial_define_lispy_key (Vspecial_event_map
, "file-notify",
11895 "file-notify-handle-event");
11896 #endif /* USE_FILE_NOTIFY */
11898 initial_define_lispy_key (Vspecial_event_map
, "config-changed-event",
11900 #if defined (WINDOWSNT)
11901 initial_define_lispy_key (Vspecial_event_map
, "language-change",
11904 initial_define_lispy_key (Vspecial_event_map
, "focus-in",
11905 "handle-focus-in");
11906 initial_define_lispy_key (Vspecial_event_map
, "focus-out",
11907 "handle-focus-out");
11910 /* Mark the pointers in the kboard objects.
11911 Called by Fgarbage_collect. */
11913 mark_kboards (void)
11917 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
11919 if (kb
->kbd_macro_buffer
)
11920 for (p
= kb
->kbd_macro_buffer
; p
< kb
->kbd_macro_ptr
; p
++)
11922 mark_object (KVAR (kb
, Voverriding_terminal_local_map
));
11923 mark_object (KVAR (kb
, Vlast_command
));
11924 mark_object (KVAR (kb
, Vreal_last_command
));
11925 mark_object (KVAR (kb
, Vkeyboard_translate_table
));
11926 mark_object (KVAR (kb
, Vlast_repeatable_command
));
11927 mark_object (KVAR (kb
, Vprefix_arg
));
11928 mark_object (KVAR (kb
, Vlast_prefix_arg
));
11929 mark_object (KVAR (kb
, kbd_queue
));
11930 mark_object (KVAR (kb
, defining_kbd_macro
));
11931 mark_object (KVAR (kb
, Vlast_kbd_macro
));
11932 mark_object (KVAR (kb
, Vsystem_key_alist
));
11933 mark_object (KVAR (kb
, system_key_syms
));
11934 mark_object (KVAR (kb
, Vwindow_system
));
11935 mark_object (KVAR (kb
, Vinput_decode_map
));
11936 mark_object (KVAR (kb
, Vlocal_function_key_map
));
11937 mark_object (KVAR (kb
, Vdefault_minibuffer_frame
));
11938 mark_object (KVAR (kb
, echo_string
));
11941 struct input_event
*event
;
11942 for (event
= kbd_fetch_ptr
; event
!= kbd_store_ptr
; event
++)
11944 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
11945 event
= kbd_buffer
;
11946 /* These two special event types has no Lisp_Objects to mark. */
11947 if (event
->kind
!= SELECTION_REQUEST_EVENT
11948 && event
->kind
!= SELECTION_CLEAR_EVENT
)
11950 mark_object (event
->x
);
11951 mark_object (event
->y
);
11952 mark_object (event
->frame_or_window
);
11953 mark_object (event
->arg
);