1 /* Keyboard and mouse input; editor command loop.
3 Copyright (C) 1985-1989, 1993-1997, 1999-2019 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 (at
11 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 <https://www.gnu.org/licenses/>. */
30 #include "termhooks.h"
35 #include "character.h"
37 #include "dispextern.h"
39 #include "intervals.h"
41 #include "blockinput.h"
55 #include <sys/ioctl.h>
56 #endif /* not MSDOS */
58 #if defined USABLE_FIONREAD && defined USG5_4
59 # include <sys/filio.h>
62 #include "syssignal.h"
64 #include <sys/types.h>
68 #include <ignore-value.h>
70 #ifdef HAVE_WINDOW_SYSTEM
72 #endif /* HAVE_WINDOW_SYSTEM */
74 /* Work around GCC bug 54561. */
75 #if GNUC_PREREQ (4, 3, 0)
76 # pragma GCC diagnostic ignored "-Wclobbered"
80 char const DEV_TTY
[] = "CONOUT$";
82 char const DEV_TTY
[] = "/dev/tty";
85 /* Variables for blockinput.h: */
87 /* Positive if interrupt input is blocked right now. */
88 volatile int interrupt_input_blocked
;
90 /* True means an input interrupt or alarm signal has arrived.
91 The maybe_quit function checks this. */
92 volatile bool pending_signals
;
94 #define KBD_BUFFER_SIZE 4096
96 KBOARD
*initial_kboard
;
97 KBOARD
*current_kboard
;
98 static KBOARD
*all_kboards
;
100 /* True in the single-kboard state, false in the any-kboard state. */
101 static bool single_kboard
;
103 #define NUM_RECENT_KEYS (300)
105 /* Index for storing next element into recent_keys. */
106 static int recent_keys_index
;
108 /* Total number of elements stored into recent_keys. */
109 static int total_keys
;
111 /* This vector holds the last NUM_RECENT_KEYS keystrokes. */
112 static Lisp_Object recent_keys
;
114 /* Vector holding the key sequence that invoked the current command.
115 It is reused for each command, and it may be longer than the current
116 sequence; this_command_key_count indicates how many elements
117 actually mean something.
118 It's easier to staticpro a single Lisp_Object than an array. */
119 Lisp_Object this_command_keys
;
120 ptrdiff_t this_command_key_count
;
122 /* This vector is used as a buffer to record the events that were actually read
123 by read_key_sequence. */
124 static Lisp_Object raw_keybuf
;
125 static int raw_keybuf_count
;
127 #define GROW_RAW_KEYBUF \
128 if (raw_keybuf_count == ASIZE (raw_keybuf)) \
129 raw_keybuf = larger_vector (raw_keybuf, 1, -1)
131 /* Number of elements of this_command_keys
132 that precede this key sequence. */
133 static ptrdiff_t this_single_command_key_start
;
135 #ifdef HAVE_STACK_OVERFLOW_HANDLING
137 /* For longjmp to recover from C stack overflow. */
138 sigjmp_buf return_to_command_loop
;
140 /* Message displayed by Vtop_level when recovering from C stack overflow. */
141 static Lisp_Object recover_top_level_message
;
143 #endif /* HAVE_STACK_OVERFLOW_HANDLING */
145 /* Message normally displayed by Vtop_level. */
146 static Lisp_Object regular_top_level_message
;
148 /* True while displaying for echoing. Delays C-g throwing. */
152 /* Non-null means we can start echoing at the next input pause even
153 though there is something in the echo area. */
155 static struct kboard
*ok_to_echo_at_next_pause
;
157 /* The kboard last echoing, or null for none. Reset to 0 in
158 cancel_echoing. If non-null, and a current echo area message
159 exists, and echo_message_buffer is eq to the current message
160 buffer, we know that the message comes from echo_kboard. */
162 struct kboard
*echo_kboard
;
164 /* The buffer used for echoing. Set in echo_now, reset in
167 Lisp_Object echo_message_buffer
;
169 /* Character that causes a quit. Normally C-g.
171 If we are running on an ordinary terminal, this must be an ordinary
172 ASCII char, since we want to make it our interrupt character.
174 If we are not running on an ordinary terminal, it still needs to be
175 an ordinary ASCII char. This character needs to be recognized in
176 the input interrupt handler. At this point, the keystroke is
177 represented as a struct input_event, while the desired quit
178 character is specified as a lispy event. The mapping from struct
179 input_events to lispy events cannot run in an interrupt handler,
180 and the reverse mapping is difficult for anything but ASCII
183 FOR THESE ELABORATE AND UNSATISFYING REASONS, quit_char must be an
187 /* Current depth in recursive edits. */
188 EMACS_INT command_loop_level
;
190 /* If not Qnil, this is a switch-frame event which we decided to put
191 off until the end of a key sequence. This should be read as the
192 next command input, after any unread_command_events.
194 read_key_sequence uses this to delay switch-frame events until the
195 end of the key sequence; Fread_char uses it to put off switch-frame
196 events until a non-ASCII event is acceptable as input. */
197 Lisp_Object unread_switch_frame
;
199 /* Last size recorded for a current buffer which is not a minibuffer. */
200 static ptrdiff_t last_non_minibuf_size
;
202 uintmax_t num_input_events
;
203 ptrdiff_t point_before_last_command_or_undo
;
204 struct buffer
*buffer_before_last_command_or_undo
;
206 /* Value of num_nonmacro_input_events as of last auto save. */
208 static EMACS_INT last_auto_save
;
210 /* The value of point when the last command was started. */
211 static ptrdiff_t last_point_position
;
213 /* The frame in which the last input event occurred, or Qmacro if the
214 last event came from a macro. We use this to determine when to
215 generate switch-frame events. This may be cleared by functions
216 like Fselect_frame, to make sure that a switch-frame event is
217 generated by the next character.
219 FIXME: This is modified by a signal handler so it should be volatile.
220 It's exported to Lisp, though, so it can't simply be marked
222 Lisp_Object internal_last_event_frame
;
224 /* `read_key_sequence' stores here the command definition of the
225 key sequence that it reads. */
226 static Lisp_Object read_key_sequence_cmd
;
227 static Lisp_Object read_key_sequence_remapped
;
229 /* File in which we write all commands we read. */
230 static FILE *dribble
;
232 /* True if input is available. */
235 /* True if more input was available last time we read an event.
237 Since redisplay can take a significant amount of time and is not
238 indispensable to perform the user's commands, when input arrives
239 "too fast", Emacs skips redisplay. More specifically, if the next
240 command has already been input when we finish the previous command,
241 we skip the intermediate redisplay.
243 This is useful to try and make sure Emacs keeps up with fast input
244 rates, such as auto-repeating keys. But in some cases, this proves
245 too conservative: we may end up disabling redisplay for the whole
246 duration of a key repetition, even though we could afford to
247 redisplay every once in a while.
249 So we "sample" the input_pending flag before running a command and
250 use *that* value after running the command to decide whether to
251 skip redisplay or not. This way, we only skip redisplay if we
252 really can't keep up with the repeat rate.
254 This only makes a difference if the next input arrives while running the
255 command, which is very unlikely if the command is executed quickly.
256 IOW this tends to avoid skipping redisplay after a long running command
257 (which is a case where skipping redisplay is not very useful since the
258 redisplay time is small compared to the time it took to run the command).
260 A typical use case is when scrolling. Scrolling time can be split into:
261 - Time to do jit-lock on the newly displayed portion of buffer.
262 - Time to run the actual scroll command.
263 - Time to perform the redisplay.
264 Jit-lock can happen either during the command or during the redisplay.
265 In the most painful cases, the jit-lock time is the one that dominates.
266 Also jit-lock can be tweaked (via jit-lock-defer) to delay its job, at the
267 cost of temporary inaccuracy in display and scrolling.
268 So without input_was_pending, what typically happens is the following:
269 - when the command starts, there's no pending input (yet).
270 - the scroll command triggers jit-lock.
271 - during the long jit-lock time the next input arrives.
272 - at the end of the command, we check input_pending and hence decide to
274 - we read the next input and start over.
275 End result: all the hard work of jit-locking is "wasted" since redisplay
276 doesn't actually happens (at least not before the input rate slows down).
277 With input_was_pending redisplay is still skipped if Emacs can't keep up
278 with the input rate, but if it can keep up just enough that there's no
279 input_pending when we begin the command, then redisplay is not skipped
280 which results in better feedback to the user. */
281 static bool input_was_pending
;
283 /* Circular buffer for pre-read keyboard input. */
285 static union buffered_input_event kbd_buffer
[KBD_BUFFER_SIZE
];
287 /* Pointer to next available character in kbd_buffer.
288 If kbd_fetch_ptr == kbd_store_ptr, the buffer is empty.
289 This may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the
290 next available char is in kbd_buffer[0]. */
291 static union buffered_input_event
*kbd_fetch_ptr
;
293 /* Pointer to next place to store character in kbd_buffer. This
294 may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the next
295 character should go in kbd_buffer[0]. */
296 static union buffered_input_event
*volatile kbd_store_ptr
;
298 /* The above pair of variables forms a "queue empty" flag. When we
299 enqueue a non-hook event, we increment kbd_store_ptr. When we
300 dequeue a non-hook event, we increment kbd_fetch_ptr. We say that
301 there is input available if the two pointers are not equal.
303 Why not just have a flag set and cleared by the enqueuing and
304 dequeuing functions? Such a flag could be screwed up by interrupts
305 at inopportune times. */
307 static void recursive_edit_unwind (Lisp_Object buffer
);
308 static Lisp_Object
command_loop (void);
310 static void echo_now (void);
311 static ptrdiff_t echo_length (void);
313 /* Incremented whenever a timer is run. */
316 /* Address (if not 0) of struct timespec to zero out if a SIGIO interrupt
318 struct timespec
*input_available_clear_time
;
320 /* True means use SIGIO interrupts; false means use CBREAK mode.
321 Default is true if INTERRUPT_INPUT is defined. */
322 bool interrupt_input
;
324 /* Nonzero while interrupts are temporarily deferred during redisplay. */
325 bool interrupts_deferred
;
327 /* The time when Emacs started being idle. */
329 static struct timespec timer_idleness_start_time
;
331 /* After Emacs stops being idle, this saves the last value
332 of timer_idleness_start_time from when it was idle. */
334 static struct timespec timer_last_idleness_start_time
;
337 /* Global variable declarations. */
339 /* Flags for readable_events. */
340 #define READABLE_EVENTS_DO_TIMERS_NOW (1 << 0)
341 #define READABLE_EVENTS_FILTER_EVENTS (1 << 1)
342 #define READABLE_EVENTS_IGNORE_SQUEEZABLES (1 << 2)
344 /* Function for init_keyboard to call with no args (if nonzero). */
345 static void (*keyboard_init_hook
) (void);
347 static bool get_input_pending (int);
348 static bool readable_events (int);
349 static Lisp_Object
read_char_x_menu_prompt (Lisp_Object
,
350 Lisp_Object
, bool *);
351 static Lisp_Object
read_char_minibuf_menu_prompt (int, Lisp_Object
);
352 static Lisp_Object
make_lispy_event (struct input_event
*);
353 static Lisp_Object
make_lispy_movement (struct frame
*, Lisp_Object
,
354 enum scroll_bar_part
,
355 Lisp_Object
, Lisp_Object
,
357 static Lisp_Object
modify_event_symbol (ptrdiff_t, int, Lisp_Object
,
358 Lisp_Object
, const char *const *,
359 Lisp_Object
*, ptrdiff_t);
360 static Lisp_Object
make_lispy_switch_frame (Lisp_Object
);
361 static Lisp_Object
make_lispy_focus_in (Lisp_Object
);
362 #ifdef HAVE_WINDOW_SYSTEM
363 static Lisp_Object
make_lispy_focus_out (Lisp_Object
);
364 #endif /* HAVE_WINDOW_SYSTEM */
365 static bool help_char_p (Lisp_Object
);
366 static void save_getcjmp (sys_jmp_buf
);
367 static void restore_getcjmp (void *);
368 static Lisp_Object
apply_modifiers (int, Lisp_Object
);
369 static void restore_kboard_configuration (int);
370 static void handle_interrupt (bool);
371 static _Noreturn
void quit_throw_to_read_char (bool);
372 static void timer_start_idle (void);
373 static void timer_stop_idle (void);
374 static void timer_resume_idle (void);
375 static void deliver_user_signal (int);
376 static char *find_user_signal_name (int);
377 static void store_user_signal_events (void);
379 /* These setters are used only in this file, so they can be private. */
381 kset_echo_string (struct kboard
*kb
, Lisp_Object val
)
383 kb
->echo_string_
= val
;
386 kset_echo_prompt (struct kboard
*kb
, Lisp_Object val
)
388 kb
->echo_prompt_
= val
;
391 kset_kbd_queue (struct kboard
*kb
, Lisp_Object val
)
393 kb
->kbd_queue_
= val
;
396 kset_keyboard_translate_table (struct kboard
*kb
, Lisp_Object val
)
398 kb
->Vkeyboard_translate_table_
= val
;
401 kset_last_prefix_arg (struct kboard
*kb
, Lisp_Object val
)
403 kb
->Vlast_prefix_arg_
= val
;
406 kset_last_repeatable_command (struct kboard
*kb
, Lisp_Object val
)
408 kb
->Vlast_repeatable_command_
= val
;
411 kset_local_function_key_map (struct kboard
*kb
, Lisp_Object val
)
413 kb
->Vlocal_function_key_map_
= val
;
416 kset_overriding_terminal_local_map (struct kboard
*kb
, Lisp_Object val
)
418 kb
->Voverriding_terminal_local_map_
= val
;
421 kset_real_last_command (struct kboard
*kb
, Lisp_Object val
)
423 kb
->Vreal_last_command_
= val
;
426 kset_system_key_syms (struct kboard
*kb
, Lisp_Object val
)
428 kb
->system_key_syms_
= val
;
433 echo_keystrokes_p (void)
435 return (FLOATP (Vecho_keystrokes
) ? XFLOAT_DATA (Vecho_keystrokes
) > 0.0
436 : INTEGERP (Vecho_keystrokes
) ? XINT (Vecho_keystrokes
) > 0
440 /* Add C to the echo string, without echoing it immediately. C can be
441 a character, which is pretty-printed, or a symbol, whose name is
445 echo_add_key (Lisp_Object c
)
447 char initbuf
[KEY_DESCRIPTION_SIZE
+ 100];
448 ptrdiff_t size
= sizeof initbuf
;
449 char *buffer
= initbuf
;
451 Lisp_Object echo_string
= KVAR (current_kboard
, echo_string
);
454 if (STRINGP (echo_string
) && SCHARS (echo_string
) > 0)
455 /* Add a space at the end as a separator between keys. */
458 /* If someone has passed us a composite event, use its head symbol. */
462 ptr
= push_key_description (XINT (c
), ptr
);
463 else if (SYMBOLP (c
))
465 Lisp_Object name
= SYMBOL_NAME (c
);
466 ptrdiff_t nbytes
= SBYTES (name
);
468 if (size
- (ptr
- buffer
) < nbytes
)
470 ptrdiff_t offset
= ptr
- buffer
;
471 size
= max (2 * size
, size
+ nbytes
);
472 buffer
= SAFE_ALLOCA (size
);
473 ptr
= buffer
+ offset
;
476 ptr
+= copy_text (SDATA (name
), (unsigned char *) ptr
, nbytes
,
477 STRING_MULTIBYTE (name
), 1);
480 if ((NILP (echo_string
) || SCHARS (echo_string
) == 0)
483 static const char text
[] = " (Type ? for further options)";
484 int len
= sizeof text
- 1;
486 if (size
- (ptr
- buffer
) < len
)
488 ptrdiff_t offset
= ptr
- buffer
;
490 buffer
= SAFE_ALLOCA (size
);
491 ptr
= buffer
+ offset
;
494 memcpy (ptr
, text
, len
);
500 concat2 (echo_string
, make_string (buffer
, ptr
- buffer
)));
504 /* Temporarily add a dash to the end of the echo string if it's not
505 empty, so that it serves as a mini-prompt for the very next
511 /* Do nothing if not echoing at all. */
512 if (NILP (KVAR (current_kboard
, echo_string
)))
515 if (!current_kboard
->immediate_echo
516 && SCHARS (KVAR (current_kboard
, echo_string
)) == 0)
519 /* Do nothing if we just printed a prompt. */
520 if (STRINGP (KVAR (current_kboard
, echo_prompt
))
521 && (SCHARS (KVAR (current_kboard
, echo_prompt
))
522 == SCHARS (KVAR (current_kboard
, echo_string
))))
525 /* Do nothing if we have already put a dash at the end. */
526 if (SCHARS (KVAR (current_kboard
, echo_string
)) > 1)
528 Lisp_Object last_char
, prev_char
, idx
;
530 idx
= make_number (SCHARS (KVAR (current_kboard
, echo_string
)) - 2);
531 prev_char
= Faref (KVAR (current_kboard
, echo_string
), idx
);
533 idx
= make_number (SCHARS (KVAR (current_kboard
, echo_string
)) - 1);
534 last_char
= Faref (KVAR (current_kboard
, echo_string
), idx
);
536 if (XINT (last_char
) == '-' && XINT (prev_char
) != ' ')
540 /* Put a dash at the end of the buffer temporarily,
541 but make it go away when the next character is added. */
542 AUTO_STRING (dash
, "-");
543 kset_echo_string (current_kboard
,
544 concat2 (KVAR (current_kboard
, echo_string
), dash
));
551 if (current_kboard
->immediate_echo
)
554 Lisp_Object prompt
= KVAR (current_kboard
, echo_prompt
);
555 Lisp_Object prefix
= call0 (Qinternal_echo_keystrokes_prefix
);
556 kset_echo_string (current_kboard
,
557 NILP (prompt
) ? prefix
558 : NILP (prefix
) ? prompt
559 : concat2 (prompt
, prefix
));
561 for (i
= 0; i
< this_command_key_count
; i
++)
565 c
= AREF (this_command_keys
, i
);
566 if (! (EVENT_HAS_PARAMETERS (c
)
567 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
575 /* Display the current echo string, and begin echoing if not already
581 if (!current_kboard
->immediate_echo
582 /* This test breaks calls that use `echo_now' to display the echo_prompt.
583 && echo_keystrokes_p () */)
585 current_kboard
->immediate_echo
= true;
587 /* Put a dash at the end to invite the user to type more. */
592 /* FIXME: Use call (Qmessage) so it can be advised (e.g. emacspeak). */
593 message3_nolog (KVAR (current_kboard
, echo_string
));
596 /* Record in what buffer we echoed, and from which kboard. */
597 echo_message_buffer
= echo_area_buffer
[0];
598 echo_kboard
= current_kboard
;
600 if (waiting_for_input
&& !NILP (Vquit_flag
))
601 quit_throw_to_read_char (0);
604 /* Turn off echoing, for the start of a new command. */
607 cancel_echoing (void)
609 current_kboard
->immediate_echo
= false;
610 kset_echo_prompt (current_kboard
, Qnil
);
611 kset_echo_string (current_kboard
, Qnil
);
612 ok_to_echo_at_next_pause
= NULL
;
614 echo_message_buffer
= Qnil
;
617 /* Return the length of the current echo string. */
622 return (STRINGP (KVAR (current_kboard
, echo_string
))
623 ? SCHARS (KVAR (current_kboard
, echo_string
))
627 /* Truncate the current echo message to its first LEN chars.
628 This and echo_char get used by read_key_sequence when the user
629 switches frames while entering a key sequence. */
632 echo_truncate (ptrdiff_t nchars
)
634 Lisp_Object es
= KVAR (current_kboard
, echo_string
);
635 if (STRINGP (es
) && SCHARS (es
) > nchars
)
636 kset_echo_string (current_kboard
,
637 Fsubstring (KVAR (current_kboard
, echo_string
),
638 make_number (0), make_number (nchars
)));
639 truncate_echo_area (nchars
);
643 /* Functions for manipulating this_command_keys. */
645 add_command_key (Lisp_Object key
)
647 if (this_command_key_count
>= ASIZE (this_command_keys
))
648 this_command_keys
= larger_vector (this_command_keys
, 1, -1);
650 ASET (this_command_keys
, this_command_key_count
, key
);
651 ++this_command_key_count
;
656 recursive_edit_1 (void)
658 ptrdiff_t count
= SPECPDL_INDEX ();
661 if (command_loop_level
> 0)
663 specbind (Qstandard_output
, Qt
);
664 specbind (Qstandard_input
, Qt
);
667 #ifdef HAVE_WINDOW_SYSTEM
668 /* The command loop has started an hourglass timer, so we have to
669 cancel it here, otherwise it will fire because the recursive edit
670 can take some time. Do not check for display_hourglass_p here,
671 because it could already be nil. */
675 /* This function may have been called from a debugger called from
676 within redisplay, for instance by Edebugging a function called
677 from fontification-functions. We want to allow redisplay in
678 the debugging session.
680 The recursive edit is left with a `(throw exit ...)'. The `exit'
681 tag is not caught anywhere in redisplay, i.e. when we leave the
682 recursive edit, the original redisplay leading to the recursive
683 edit will be unwound. The outcome should therefore be safe. */
684 specbind (Qinhibit_redisplay
, Qnil
);
687 /* This variable stores buffers that have changed so that an undo
688 boundary can be added. specbind this so that changes in the
689 recursive edit will not result in undo boundaries in buffers
690 changed before we entered there recursive edit.
693 specbind (Qundo_auto__undoably_changed_buffers
, Qnil
);
695 val
= command_loop ();
698 /* Handle throw from read_minibuf when using minibuffer
699 while it's active but we're in another window. */
701 xsignal1 (Qerror
, val
);
703 return unbind_to (count
, Qnil
);
706 /* When an auto-save happens, record the "time", and don't do again soon. */
709 record_auto_save (void)
711 last_auto_save
= num_nonmacro_input_events
;
714 /* Make an auto save happen as soon as possible at command level. */
718 force_auto_save_soon (void)
720 last_auto_save
= - auto_save_interval
- 1;
722 record_asynch_buffer_change ();
726 DEFUN ("recursive-edit", Frecursive_edit
, Srecursive_edit
, 0, 0, "",
727 doc
: /* Invoke the editor command loop recursively.
728 To get out of the recursive edit, a command can throw to `exit' -- for
729 instance (throw \\='exit nil).
730 If you throw a value other than t, `recursive-edit' returns normally
731 to the function that called it. Throwing a t value causes
732 `recursive-edit' to quit, so that control returns to the command loop
735 This function is called by the editor initialization to begin editing. */)
738 ptrdiff_t count
= SPECPDL_INDEX ();
741 /* If we enter while input is blocked, don't lock up here.
742 This may happen through the debugger during redisplay. */
743 if (input_blocked_p ())
746 if (command_loop_level
>= 0
747 && current_buffer
!= XBUFFER (XWINDOW (selected_window
)->contents
))
748 buffer
= Fcurrent_buffer ();
752 /* Don't do anything interesting between the increment and the
753 record_unwind_protect! Otherwise, we could get distracted and
754 never decrement the counter again. */
755 command_loop_level
++;
756 update_mode_lines
= 17;
757 record_unwind_protect (recursive_edit_unwind
, buffer
);
759 /* If we leave recursive_edit_1 below with a `throw' for instance,
760 like it is done in the splash screen display, we have to
761 make sure that we restore single_kboard as command_loop_1
762 would have done if it were left normally. */
763 if (command_loop_level
> 0)
764 temporarily_switch_to_single_kboard (SELECTED_FRAME ());
767 return unbind_to (count
, Qnil
);
771 recursive_edit_unwind (Lisp_Object buffer
)
773 if (BUFFERP (buffer
))
774 Fset_buffer (buffer
);
776 command_loop_level
--;
777 update_mode_lines
= 18;
781 #if 0 /* These two functions are now replaced with
782 temporarily_switch_to_single_kboard. */
786 #if 0 /* Theory: if there's anything in Vunread_command_events,
787 it will right away be read by read_key_sequence,
788 and then if we do switch KBOARDS, it will go into the side
789 queue then. So we don't need to do anything special here -- rms. */
790 if (CONSP (Vunread_command_events
))
792 current_kboard
->kbd_queue
793 = nconc2 (Vunread_command_events
, current_kboard
->kbd_queue
);
794 current_kboard
->kbd_queue_has_data
= true;
796 Vunread_command_events
= Qnil
;
798 single_kboard
= false;
801 /* Switch to the single-kboard state, making current_kboard
802 the only KBOARD from which further input is accepted. */
805 single_kboard_state ()
807 single_kboard
= true;
811 /* If we're in single_kboard state for kboard KBOARD,
815 not_single_kboard_state (KBOARD
*kboard
)
817 if (kboard
== current_kboard
)
818 single_kboard
= false;
821 /* Maintain a stack of kboards, so other parts of Emacs
822 can switch temporarily to the kboard of a given frame
823 and then revert to the previous status. */
828 struct kboard_stack
*next
;
831 static struct kboard_stack
*kboard_stack
;
834 push_kboard (struct kboard
*k
)
836 struct kboard_stack
*p
= xmalloc (sizeof *p
);
838 p
->next
= kboard_stack
;
839 p
->kboard
= current_kboard
;
849 struct kboard_stack
*p
= kboard_stack
;
851 for (t
= terminal_list
; t
; t
= t
->next_terminal
)
853 if (t
->kboard
== p
->kboard
)
855 current_kboard
= p
->kboard
;
862 /* The terminal we remembered has been deleted. */
863 current_kboard
= FRAME_KBOARD (SELECTED_FRAME ());
864 single_kboard
= false;
866 kboard_stack
= p
->next
;
870 /* Switch to single_kboard mode, making current_kboard the only KBOARD
871 from which further input is accepted. If F is non-nil, set its
872 KBOARD as the current keyboard.
874 This function uses record_unwind_protect_int to return to the previous
877 If Emacs is already in single_kboard mode, and F's keyboard is
878 locked, then this function will throw an error. */
881 temporarily_switch_to_single_kboard (struct frame
*f
)
883 bool was_locked
= single_kboard
;
886 if (f
!= NULL
&& FRAME_KBOARD (f
) != current_kboard
)
887 /* We can not switch keyboards while in single_kboard mode.
888 In rare cases, Lisp code may call `recursive-edit' (or
889 `read-minibuffer' or `y-or-n-p') after it switched to a
890 locked frame. For example, this is likely to happen
891 when server.el connects to a new terminal while Emacs is in
892 single_kboard mode. It is best to throw an error instead
893 of presenting the user with a frozen screen. */
894 error ("Terminal %d is locked, cannot read from it",
895 FRAME_TERMINAL (f
)->id
);
897 /* This call is unnecessary, but helps
898 `restore_kboard_configuration' discover if somebody changed
899 `current_kboard' behind our back. */
900 push_kboard (current_kboard
);
903 current_kboard
= FRAME_KBOARD (f
);
904 single_kboard
= true;
905 record_unwind_protect_int (restore_kboard_configuration
, was_locked
);
908 #if 0 /* This function is not needed anymore. */
910 record_single_kboard_state ()
913 push_kboard (current_kboard
);
914 record_unwind_protect_int (restore_kboard_configuration
, single_kboard
);
919 restore_kboard_configuration (int was_locked
)
921 single_kboard
= was_locked
;
924 struct kboard
*prev
= current_kboard
;
926 /* The pop should not change the kboard. */
927 if (single_kboard
&& current_kboard
!= prev
)
933 /* Handle errors that are not handled at inner levels
934 by printing an error message and returning to the editor command loop. */
937 cmd_error (Lisp_Object data
)
939 Lisp_Object old_level
, old_length
;
940 char macroerror
[sizeof "After..kbd macro iterations: "
941 + INT_STRLEN_BOUND (EMACS_INT
)];
943 #ifdef HAVE_WINDOW_SYSTEM
944 if (display_hourglass_p
)
948 if (!NILP (executing_kbd_macro
))
950 if (executing_kbd_macro_iterations
== 1)
951 sprintf (macroerror
, "After 1 kbd macro iteration: ");
953 sprintf (macroerror
, "After %"pI
"d kbd macro iterations: ",
954 executing_kbd_macro_iterations
);
959 Vstandard_output
= Qt
;
960 Vstandard_input
= Qt
;
961 Vexecuting_kbd_macro
= Qnil
;
962 executing_kbd_macro
= Qnil
;
963 kset_prefix_arg (current_kboard
, Qnil
);
964 kset_last_prefix_arg (current_kboard
, Qnil
);
967 /* Avoid unquittable loop if data contains a circular list. */
968 old_level
= Vprint_level
;
969 old_length
= Vprint_length
;
970 XSETFASTINT (Vprint_level
, 10);
971 XSETFASTINT (Vprint_length
, 10);
972 cmd_error_internal (data
, macroerror
);
973 Vprint_level
= old_level
;
974 Vprint_length
= old_length
;
977 Vinhibit_quit
= Qnil
;
979 return make_number (0);
982 /* Take actions on handling an error. DATA is the data that describes
985 CONTEXT is a C-string containing ASCII characters only which
986 describes the context in which the error happened. If we need to
987 generalize CONTEXT to allow multibyte characters, make it a Lisp
991 cmd_error_internal (Lisp_Object data
, const char *context
)
993 /* The immediate context is not interesting for Quits,
994 since they are asynchronous. */
995 if (EQ (XCAR (data
), Qquit
))
996 Vsignaling_function
= Qnil
;
1001 /* Use user's specified output function if any. */
1002 if (!NILP (Vcommand_error_function
))
1003 call3 (Vcommand_error_function
, data
,
1004 context
? build_string (context
) : empty_unibyte_string
,
1005 Vsignaling_function
);
1007 Vsignaling_function
= Qnil
;
1010 DEFUN ("command-error-default-function", Fcommand_error_default_function
,
1011 Scommand_error_default_function
, 3, 3, 0,
1012 doc
: /* Produce default output for unhandled error message.
1013 Default value of `command-error-function'. */)
1014 (Lisp_Object data
, Lisp_Object context
, Lisp_Object signal
)
1016 struct frame
*sf
= SELECTED_FRAME ();
1018 CHECK_STRING (context
);
1020 /* If the window system or terminal frame hasn't been initialized
1021 yet, or we're not interactive, write the message to stderr and exit. */
1022 if (!sf
->glyphs_initialized_p
1023 /* The initial frame is a special non-displaying frame. It
1024 will be current in daemon mode when there are no frames
1025 to display, and in non-daemon mode before the real frame
1026 has finished initializing. If an error is thrown in the
1027 latter case while creating the frame, then the frame
1028 will never be displayed, so the safest thing to do is
1029 write to stderr and quit. In daemon mode, there are
1030 many other potential errors that do not prevent frames
1031 from being created, so continuing as normal is better in
1033 || (!IS_DAEMON
&& FRAME_INITIAL_P (sf
))
1036 print_error_message (data
, Qexternal_debugging_output
,
1037 SSDATA (context
), signal
);
1038 Fterpri (Qexternal_debugging_output
, Qnil
);
1039 Fkill_emacs (make_number (-1));
1043 clear_message (1, 0);
1045 message_log_maybe_newline ();
1048 print_error_message (data
, Qt
, SSDATA (context
), signal
);
1053 static Lisp_Object
command_loop_2 (Lisp_Object
);
1054 static Lisp_Object
top_level_1 (Lisp_Object
);
1056 /* Entry to editor-command-loop.
1057 This level has the catches for exiting/returning to editor command loop.
1058 It returns nil to exit recursive edit, t to abort it. */
1063 #ifdef HAVE_STACK_OVERFLOW_HANDLING
1064 /* At least on GNU/Linux, saving signal mask is important here. */
1065 if (sigsetjmp (return_to_command_loop
, 1) != 0)
1067 /* Comes here from handle_sigsegv (see sysdep.c) and
1068 stack_overflow_handler (see w32fns.c). */
1070 w32_reset_stack_overflow_guard ();
1073 Vinternal__top_level_message
= recover_top_level_message
;
1076 Vinternal__top_level_message
= regular_top_level_message
;
1077 #endif /* HAVE_STACK_OVERFLOW_HANDLING */
1078 if (command_loop_level
> 0 || minibuf_level
> 0)
1081 val
= internal_catch (Qexit
, command_loop_2
, Qnil
);
1082 executing_kbd_macro
= Qnil
;
1088 internal_catch (Qtop_level
, top_level_1
, Qnil
);
1089 internal_catch (Qtop_level
, command_loop_2
, Qnil
);
1090 executing_kbd_macro
= Qnil
;
1092 /* End of file in -batch run causes exit here. */
1098 /* Here we catch errors in execution of commands within the
1099 editing loop, and reenter the editing loop.
1100 When there is an error, cmd_error runs and returns a non-nil
1101 value to us. A value of nil means that command_loop_1 itself
1102 returned due to end of file (or end of kbd macro). */
1105 command_loop_2 (Lisp_Object ignore
)
1107 register Lisp_Object val
;
1110 val
= internal_condition_case (command_loop_1
, Qerror
, cmd_error
);
1111 while (!NILP (val
));
1119 return Feval (Vtop_level
, Qnil
);
1123 top_level_1 (Lisp_Object ignore
)
1125 /* On entry to the outer level, run the startup file. */
1126 if (!NILP (Vtop_level
))
1127 internal_condition_case (top_level_2
, Qerror
, cmd_error
);
1128 else if (!NILP (Vpurify_flag
))
1129 message1 ("Bare impure Emacs (standard Lisp code not loaded)");
1131 message1 ("Bare Emacs (standard Lisp code not loaded)");
1135 DEFUN ("top-level", Ftop_level
, Stop_level
, 0, 0, "",
1136 doc
: /* Exit all recursive editing levels.
1137 This also exits all active minibuffers. */
1138 attributes
: noreturn
)
1141 #ifdef HAVE_WINDOW_SYSTEM
1142 if (display_hourglass_p
)
1143 cancel_hourglass ();
1146 /* Unblock input if we enter with input blocked. This may happen if
1147 redisplay traps e.g. during tool-bar update with input blocked. */
1148 totally_unblock_input ();
1150 Fthrow (Qtop_level
, Qnil
);
1153 static _Noreturn
void
1154 user_error (const char *msg
)
1156 xsignal1 (Quser_error
, build_string (msg
));
1159 /* _Noreturn will be added to prototype by make-docfile. */
1160 DEFUN ("exit-recursive-edit", Fexit_recursive_edit
, Sexit_recursive_edit
, 0, 0, "",
1161 doc
: /* Exit from the innermost recursive edit or minibuffer. */
1162 attributes
: noreturn
)
1165 if (command_loop_level
> 0 || minibuf_level
> 0)
1166 Fthrow (Qexit
, Qnil
);
1168 user_error ("No recursive edit is in progress");
1171 /* _Noreturn will be added to prototype by make-docfile. */
1172 DEFUN ("abort-recursive-edit", Fabort_recursive_edit
, Sabort_recursive_edit
, 0, 0, "",
1173 doc
: /* Abort the command that requested this recursive edit or minibuffer input. */
1174 attributes
: noreturn
)
1177 if (command_loop_level
> 0 || minibuf_level
> 0)
1180 user_error ("No recursive edit is in progress");
1183 /* Restore mouse tracking enablement. See Ftrack_mouse for the only use
1184 of this function. */
1187 tracking_off (Lisp_Object old_value
)
1189 do_mouse_tracking
= old_value
;
1190 if (NILP (old_value
))
1192 /* Redisplay may have been preempted because there was input
1193 available, and it assumes it will be called again after the
1194 input has been processed. If the only input available was
1195 the sort that we have just disabled, then we need to call
1197 if (!readable_events (READABLE_EVENTS_DO_TIMERS_NOW
))
1199 redisplay_preserve_echo_area (6);
1200 get_input_pending (READABLE_EVENTS_DO_TIMERS_NOW
);
1205 DEFUN ("internal--track-mouse", Ftrack_mouse
, Strack_mouse
, 1, 1, 0,
1206 doc
: /* Call BODYFUN with mouse movement events enabled. */)
1207 (Lisp_Object bodyfun
)
1209 ptrdiff_t count
= SPECPDL_INDEX ();
1212 record_unwind_protect (tracking_off
, do_mouse_tracking
);
1214 do_mouse_tracking
= Qt
;
1216 val
= call0 (bodyfun
);
1217 return unbind_to (count
, val
);
1220 /* If mouse has moved on some frame, return one of those frames.
1224 If ignore_mouse_drag_p is non-zero, ignore (implicit) mouse movement
1225 after resizing the tool-bar window. */
1227 bool ignore_mouse_drag_p
;
1229 static struct frame
*
1230 some_mouse_moved (void)
1232 Lisp_Object tail
, frame
;
1234 if (ignore_mouse_drag_p
)
1236 /* ignore_mouse_drag_p = 0; */
1240 FOR_EACH_FRAME (tail
, frame
)
1242 if (XFRAME (frame
)->mouse_moved
)
1243 return XFRAME (frame
);
1250 /* This is the actual command reading loop,
1251 sans error-handling encapsulation. */
1253 static int read_key_sequence (Lisp_Object
*, int, Lisp_Object
,
1254 bool, bool, bool, bool);
1255 static void adjust_point_for_property (ptrdiff_t, bool);
1258 command_loop_1 (void)
1260 EMACS_INT prev_modiff
= 0;
1261 struct buffer
*prev_buffer
= NULL
;
1262 bool already_adjusted
= 0;
1264 kset_prefix_arg (current_kboard
, Qnil
);
1265 kset_last_prefix_arg (current_kboard
, Qnil
);
1266 Vdeactivate_mark
= Qnil
;
1267 waiting_for_input
= false;
1270 this_command_key_count
= 0;
1271 this_single_command_key_start
= 0;
1273 if (NILP (Vmemory_full
))
1275 /* Make sure this hook runs after commands that get errors and
1276 throw to top level. */
1277 /* Note that the value cell will never directly contain nil
1278 if the symbol is a local variable. */
1279 if (!NILP (Vpost_command_hook
) && !NILP (Vrun_hooks
))
1280 safe_run_hooks (Qpost_command_hook
);
1282 /* If displaying a message, resize the echo area window to fit
1283 that message's size exactly. */
1284 if (!NILP (echo_area_buffer
[0]))
1285 resize_echo_area_exactly ();
1287 /* If there are warnings waiting, process them. */
1288 if (!NILP (Vdelayed_warnings_list
))
1289 safe_run_hooks (Qdelayed_warnings_hook
);
1291 if (!NILP (Vdeferred_action_list
))
1292 safe_run_hooks (Qdeferred_action_function
);
1295 /* Do this after running Vpost_command_hook, for consistency. */
1296 kset_last_command (current_kboard
, Vthis_command
);
1297 kset_real_last_command (current_kboard
, Vreal_this_command
);
1298 if (!CONSP (last_command_event
))
1299 kset_last_repeatable_command (current_kboard
, Vreal_this_command
);
1304 Lisp_Object keybuf
[30];
1307 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1310 /* Make sure the current window's buffer is selected. */
1311 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->contents
));
1313 /* Display any malloc warning that just came out. Use while because
1314 displaying one warning can cause another. */
1316 while (pending_malloc_warning
)
1317 display_malloc_warning ();
1319 Vdeactivate_mark
= Qnil
;
1321 /* Don't ignore mouse movements for more than a single command
1322 loop. (This flag is set in xdisp.c whenever the tool bar is
1323 resized, because the resize moves text up or down, and would
1324 generate false mouse drag events if we don't ignore them.) */
1325 ignore_mouse_drag_p
= 0;
1327 /* If minibuffer on and echo area in use,
1328 wait a short time and redraw minibuffer. */
1331 && !NILP (echo_area_buffer
[0])
1332 && EQ (minibuf_window
, echo_area_window
)
1333 && NUMBERP (Vminibuffer_message_timeout
))
1335 /* Bind inhibit-quit to t so that C-g gets read in
1336 rather than quitting back to the minibuffer. */
1337 ptrdiff_t count
= SPECPDL_INDEX ();
1338 specbind (Qinhibit_quit
, Qt
);
1340 sit_for (Vminibuffer_message_timeout
, 0, 2);
1342 /* Clear the echo area. */
1344 safe_run_hooks (Qecho_area_clear_hook
);
1346 unbind_to (count
, Qnil
);
1348 /* If a C-g came in before, treat it as input now. */
1349 if (!NILP (Vquit_flag
))
1352 Vunread_command_events
= list1 (make_number (quit_char
));
1356 /* If it has changed current-menubar from previous value,
1357 really recompute the menubar from the value. */
1358 if (! NILP (Vlucid_menu_bar_dirty_flag
)
1359 && !NILP (Ffboundp (Qrecompute_lucid_menubar
)))
1360 call0 (Qrecompute_lucid_menubar
);
1362 Vthis_command
= Qnil
;
1363 Vreal_this_command
= Qnil
;
1364 Vthis_original_command
= Qnil
;
1365 Vthis_command_keys_shift_translated
= Qnil
;
1367 /* Read next key sequence; i gets its length. */
1368 i
= read_key_sequence (keybuf
, ARRAYELTS (keybuf
),
1371 /* A filter may have run while we were reading the input. */
1372 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1374 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->contents
));
1378 /* Now we have read a key sequence of length I,
1379 or else I is 0 and we found end of file. */
1381 if (i
== 0) /* End of file -- happens only in */
1382 return Qnil
; /* a kbd macro, at the end. */
1383 /* -1 means read_key_sequence got a menu that was rejected.
1384 Just loop around and read another command. */
1388 this_command_key_count
= 0;
1389 this_single_command_key_start
= 0;
1393 last_command_event
= keybuf
[i
- 1];
1395 /* If the previous command tried to force a specific window-start,
1396 forget about that, in case this command moves point far away
1397 from that position. But also throw away beg_unchanged and
1398 end_unchanged information in that case, so that redisplay will
1399 update the whole window properly. */
1400 if (XWINDOW (selected_window
)->force_start
)
1403 XWINDOW (selected_window
)->force_start
= 0;
1404 b
= XBUFFER (XWINDOW (selected_window
)->contents
);
1405 BUF_BEG_UNCHANGED (b
) = BUF_END_UNCHANGED (b
) = 0;
1408 cmd
= read_key_sequence_cmd
;
1409 if (!NILP (Vexecuting_kbd_macro
))
1411 if (!NILP (Vquit_flag
))
1413 Vexecuting_kbd_macro
= Qt
;
1414 maybe_quit (); /* Make some noise. */
1415 /* Will return since macro now empty. */
1419 /* Do redisplay processing after this command except in special
1420 cases identified below. */
1421 prev_buffer
= current_buffer
;
1422 prev_modiff
= MODIFF
;
1423 last_point_position
= PT
;
1425 /* By default, we adjust point to a boundary of a region that
1426 has such a property that should be treated intangible
1427 (e.g. composition, display). But, some commands will set
1428 this variable differently. */
1429 Vdisable_point_adjustment
= Qnil
;
1431 /* Process filters and timers may have messed with deactivate-mark.
1432 reset it before we execute the command. */
1433 Vdeactivate_mark
= Qnil
;
1435 /* Remap command through active keymaps. */
1436 Vthis_original_command
= cmd
;
1437 if (!NILP (read_key_sequence_remapped
))
1438 cmd
= read_key_sequence_remapped
;
1440 /* Execute the command. */
1443 total_keys
+= total_keys
< NUM_RECENT_KEYS
;
1444 ASET (recent_keys
, recent_keys_index
,
1446 if (++recent_keys_index
>= NUM_RECENT_KEYS
)
1447 recent_keys_index
= 0;
1449 Vthis_command
= cmd
;
1450 Vreal_this_command
= cmd
;
1451 safe_run_hooks (Qpre_command_hook
);
1453 already_adjusted
= 0;
1455 if (NILP (Vthis_command
))
1456 /* nil means key is undefined. */
1460 /* Here for a command that isn't executed directly. */
1462 #ifdef HAVE_WINDOW_SYSTEM
1463 ptrdiff_t scount
= SPECPDL_INDEX ();
1465 if (display_hourglass_p
1466 && NILP (Vexecuting_kbd_macro
))
1468 record_unwind_protect_void (cancel_hourglass
);
1473 /* Ensure that we have added appropriate undo-boundaries as a
1474 result of changes from the last command. */
1475 call0 (Qundo_auto__add_boundary
);
1477 /* Record point and buffer, so we can put point into the undo
1478 information if necessary. */
1479 point_before_last_command_or_undo
= PT
;
1480 buffer_before_last_command_or_undo
= current_buffer
;
1482 call1 (Qcommand_execute
, Vthis_command
);
1484 #ifdef HAVE_WINDOW_SYSTEM
1485 /* Do not check display_hourglass_p here, because
1486 `command-execute' could change it, but we should cancel
1487 hourglass cursor anyway.
1488 But don't cancel the hourglass within a macro
1489 just because a command in the macro finishes. */
1490 if (NILP (Vexecuting_kbd_macro
))
1491 unbind_to (scount
, Qnil
);
1494 kset_last_prefix_arg (current_kboard
, Vcurrent_prefix_arg
);
1496 safe_run_hooks (Qpost_command_hook
);
1498 /* If displaying a message, resize the echo area window to fit
1499 that message's size exactly. */
1500 if (!NILP (echo_area_buffer
[0]))
1501 resize_echo_area_exactly ();
1503 /* If there are warnings waiting, process them. */
1504 if (!NILP (Vdelayed_warnings_list
))
1505 safe_run_hooks (Qdelayed_warnings_hook
);
1507 safe_run_hooks (Qdeferred_action_function
);
1509 kset_last_command (current_kboard
, Vthis_command
);
1510 kset_real_last_command (current_kboard
, Vreal_this_command
);
1511 if (!CONSP (last_command_event
))
1512 kset_last_repeatable_command (current_kboard
, Vreal_this_command
);
1514 this_command_key_count
= 0;
1515 this_single_command_key_start
= 0;
1517 if (current_kboard
->immediate_echo
1518 && !NILP (call0 (Qinternal_echo_keystrokes_prefix
)))
1520 current_kboard
->immediate_echo
= false;
1521 /* Refresh the echo message. */
1527 if (!NILP (BVAR (current_buffer
, mark_active
))
1528 && !NILP (Vrun_hooks
))
1530 /* In Emacs 22, setting transient-mark-mode to `only' was a
1531 way of turning it on for just one command. This usage is
1532 obsolete, but support it anyway. */
1533 if (EQ (Vtransient_mark_mode
, Qidentity
))
1534 Vtransient_mark_mode
= Qnil
;
1535 else if (EQ (Vtransient_mark_mode
, Qonly
))
1536 Vtransient_mark_mode
= Qidentity
;
1538 if (!NILP (Vdeactivate_mark
))
1539 /* If `select-active-regions' is non-nil, this call to
1540 `deactivate-mark' also sets the PRIMARY selection. */
1541 call0 (Qdeactivate_mark
);
1544 /* Even if not deactivating the mark, set PRIMARY if
1545 `select-active-regions' is non-nil. */
1546 if (!NILP (Fwindow_system (Qnil
))
1547 /* Even if mark_active is non-nil, the actual buffer
1548 marker may not have been set yet (Bug#7044). */
1549 && XMARKER (BVAR (current_buffer
, mark
))->buffer
1550 && (EQ (Vselect_active_regions
, Qonly
)
1551 ? EQ (CAR_SAFE (Vtransient_mark_mode
), Qonly
)
1552 : (!NILP (Vselect_active_regions
)
1553 && !NILP (Vtransient_mark_mode
)))
1554 && NILP (Fmemq (Vthis_command
,
1555 Vselection_inhibit_update_commands
)))
1558 = call1 (Fsymbol_value (Qregion_extract_function
), Qnil
);
1559 if (XINT (Flength (txt
)) > 0)
1560 /* Don't set empty selections. */
1561 call2 (Qgui_set_selection
, QPRIMARY
, txt
);
1564 if (current_buffer
!= prev_buffer
|| MODIFF
!= prev_modiff
)
1565 run_hook (intern ("activate-mark-hook"));
1568 Vsaved_region_selection
= Qnil
;
1573 if (current_buffer
== prev_buffer
1574 && XBUFFER (XWINDOW (selected_window
)->contents
) == current_buffer
1575 && last_point_position
!= PT
1576 && NILP (Vdisable_point_adjustment
)
1577 && NILP (Vglobal_disable_point_adjustment
))
1579 if (last_point_position
> BEGV
1580 && last_point_position
< ZV
1581 && (composition_adjust_point (last_point_position
,
1582 last_point_position
)
1583 != last_point_position
))
1584 /* The last point was temporarily set within a grapheme
1585 cluster to prevent automatic composition. To recover
1586 the automatic composition, we must update the
1588 windows_or_buffers_changed
= 21;
1589 if (!already_adjusted
)
1590 adjust_point_for_property (last_point_position
,
1591 MODIFF
!= prev_modiff
);
1594 /* Install chars successfully executed in kbd macro. */
1596 if (!NILP (KVAR (current_kboard
, defining_kbd_macro
))
1597 && NILP (KVAR (current_kboard
, Vprefix_arg
)))
1598 finalize_kbd_macro_chars ();
1603 read_menu_command (void)
1605 Lisp_Object keybuf
[30];
1606 ptrdiff_t count
= SPECPDL_INDEX ();
1609 /* We don't want to echo the keystrokes while navigating the
1611 specbind (Qecho_keystrokes
, make_number (0));
1613 i
= read_key_sequence (keybuf
, ARRAYELTS (keybuf
),
1616 unbind_to (count
, Qnil
);
1618 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1620 if (i
== 0 || i
== -1)
1623 return read_key_sequence_cmd
;
1626 /* Adjust point to a boundary of a region that has such a property
1627 that should be treated intangible. For the moment, we check
1628 `composition', `display' and `invisible' properties.
1629 LAST_PT is the last position of point. */
1632 adjust_point_for_property (ptrdiff_t last_pt
, bool modified
)
1635 Lisp_Object val
, overlay
, tmp
;
1636 /* When called after buffer modification, we should temporarily
1637 suppress the point adjustment for automatic composition so that a
1638 user can keep inserting another character at point or keep
1639 deleting characters around point. */
1640 bool check_composition
= ! modified
;
1641 bool check_display
= true, check_invisible
= true;
1642 ptrdiff_t orig_pt
= PT
;
1644 eassert (XBUFFER (XWINDOW (selected_window
)->contents
) == current_buffer
);
1646 /* FIXME: cycling is probably not necessary because these properties
1647 can't be usefully combined anyway. */
1648 while (check_composition
|| check_display
|| check_invisible
)
1650 /* FIXME: check `intangible'. */
1651 if (check_composition
1652 && PT
> BEGV
&& PT
< ZV
1653 && (beg
= composition_adjust_point (last_pt
, PT
)) != PT
)
1656 check_display
= check_invisible
= true;
1658 check_composition
= false;
1660 && PT
> BEGV
&& PT
< ZV
1661 && !NILP (val
= get_char_property_and_overlay
1662 (make_number (PT
), Qdisplay
, selected_window
,
1664 && display_prop_intangible_p (val
, overlay
, PT
, PT_BYTE
)
1665 && (!OVERLAYP (overlay
)
1666 ? get_property_and_range (PT
, Qdisplay
, &val
, &beg
, &end
, Qnil
)
1667 : (beg
= OVERLAY_POSITION (OVERLAY_START (overlay
)),
1668 end
= OVERLAY_POSITION (OVERLAY_END (overlay
))))
1669 && (beg
< PT
/* && end > PT <- It's always the case. */
1670 || (beg
<= PT
&& STRINGP (val
) && SCHARS (val
) == 0)))
1673 SET_PT (PT
< last_pt
1674 ? (STRINGP (val
) && SCHARS (val
) == 0
1675 ? max (beg
- 1, BEGV
)
1678 check_composition
= check_invisible
= true;
1680 check_display
= false;
1681 if (check_invisible
&& PT
> BEGV
&& PT
< ZV
)
1684 bool ellipsis
= false;
1687 /* Find boundaries `beg' and `end' of the invisible area, if any. */
1690 /* FIXME: We should stop if we find a spot between
1691 two runs of `invisible' where inserted text would
1692 be visible. This is important when we have two
1693 invisible boundaries that enclose an area: if the
1694 area is empty, we need this test in order to make
1695 it possible to place point in the middle rather
1696 than skip both boundaries. However, this code
1697 also stops anywhere in a non-sticky text-property,
1698 which breaks (e.g.) Org mode. */
1699 && (val
= Fget_pos_property (make_number (end
),
1701 TEXT_PROP_MEANS_INVISIBLE (val
))
1703 && !NILP (val
= get_char_property_and_overlay
1704 (make_number (end
), Qinvisible
, Qnil
, &overlay
))
1705 && (inv
= TEXT_PROP_MEANS_INVISIBLE (val
)))
1707 ellipsis
= ellipsis
|| inv
> 1
1708 || (OVERLAYP (overlay
)
1709 && (!NILP (Foverlay_get (overlay
, Qafter_string
))
1710 || !NILP (Foverlay_get (overlay
, Qbefore_string
))));
1711 tmp
= Fnext_single_char_property_change
1712 (make_number (end
), Qinvisible
, Qnil
, Qnil
);
1713 end
= NATNUMP (tmp
) ? XFASTINT (tmp
) : ZV
;
1717 && (val
= Fget_pos_property (make_number (beg
),
1719 TEXT_PROP_MEANS_INVISIBLE (val
))
1721 && !NILP (val
= get_char_property_and_overlay
1722 (make_number (beg
- 1), Qinvisible
, Qnil
, &overlay
))
1723 && (inv
= TEXT_PROP_MEANS_INVISIBLE (val
)))
1725 ellipsis
= ellipsis
|| inv
> 1
1726 || (OVERLAYP (overlay
)
1727 && (!NILP (Foverlay_get (overlay
, Qafter_string
))
1728 || !NILP (Foverlay_get (overlay
, Qbefore_string
))));
1729 tmp
= Fprevious_single_char_property_change
1730 (make_number (beg
), Qinvisible
, Qnil
, Qnil
);
1731 beg
= NATNUMP (tmp
) ? XFASTINT (tmp
) : BEGV
;
1734 /* Move away from the inside area. */
1735 if (beg
< PT
&& end
> PT
)
1737 SET_PT ((orig_pt
== PT
&& (last_pt
< beg
|| last_pt
> end
))
1738 /* We haven't moved yet (so we don't need to fear
1739 infinite-looping) and we were outside the range
1740 before (so either end of the range still corresponds
1741 to a move in the right direction): pretend we moved
1742 less than we actually did, so that we still have
1743 more freedom below in choosing which end of the range
1745 ? (orig_pt
= -1, PT
< last_pt
? end
: beg
)
1746 /* We either have moved already or the last point
1747 was already in the range: we don't get to choose
1748 which end of the range we have to go to. */
1749 : (PT
< last_pt
? beg
: end
));
1750 check_composition
= check_display
= true;
1752 #if 0 /* This assertion isn't correct, because SET_PT may end up setting
1753 the point to something other than its argument, due to
1754 point-motion hooks, intangibility, etc. */
1755 eassert (PT
== beg
|| PT
== end
);
1758 /* Pretend the area doesn't exist if the buffer is not
1760 if (!modified
&& !ellipsis
&& beg
< end
)
1762 if (last_pt
== beg
&& PT
== end
&& end
< ZV
)
1763 (check_composition
= check_display
= true, SET_PT (end
+ 1));
1764 else if (last_pt
== end
&& PT
== beg
&& beg
> BEGV
)
1765 (check_composition
= check_display
= true, SET_PT (beg
- 1));
1766 else if (PT
== ((PT
< last_pt
) ? beg
: end
))
1767 /* We've already moved as far as we can. Trying to go
1768 to the other end would mean moving backwards and thus
1769 could lead to an infinite loop. */
1771 else if (val
= Fget_pos_property (make_number (PT
),
1773 TEXT_PROP_MEANS_INVISIBLE (val
)
1774 && (val
= (Fget_pos_property
1775 (make_number (PT
== beg
? end
: beg
),
1777 !TEXT_PROP_MEANS_INVISIBLE (val
)))
1778 (check_composition
= check_display
= true,
1779 SET_PT (PT
== beg
? end
: beg
));
1782 check_invisible
= false;
1786 /* Subroutine for safe_run_hooks: run the hook, which is ARGS[1]. */
1789 safe_run_hooks_1 (ptrdiff_t nargs
, Lisp_Object
*args
)
1791 eassert (nargs
== 2);
1792 return call0 (args
[1]);
1795 /* Subroutine for safe_run_hooks: handle an error by clearing out the function
1799 safe_run_hooks_error (Lisp_Object error
, ptrdiff_t nargs
, Lisp_Object
*args
)
1801 eassert (nargs
== 2);
1802 AUTO_STRING (format
, "Error in %s (%S): %S");
1803 Lisp_Object hook
= args
[0];
1804 Lisp_Object fun
= args
[1];
1805 CALLN (Fmessage
, format
, hook
, fun
, error
);
1811 Lisp_Object newval
= Qnil
;
1812 for (val
= find_symbol_value (hook
); CONSP (val
); val
= XCDR (val
))
1813 if (EQ (fun
, XCAR (val
)))
1816 newval
= Fcons (XCAR (val
), newval
);
1818 return Fset (hook
, Fnreverse (newval
));
1819 /* Not found in the local part of the hook. Let's look at the global
1822 for (val
= (NILP (Fdefault_boundp (hook
)) ? Qnil
1823 : Fdefault_value (hook
));
1824 CONSP (val
); val
= XCDR (val
))
1825 if (EQ (fun
, XCAR (val
)))
1828 newval
= Fcons (XCAR (val
), newval
);
1830 return Fset_default (hook
, Fnreverse (newval
));
1836 safe_run_hook_funcall (ptrdiff_t nargs
, Lisp_Object
*args
)
1838 eassert (nargs
== 2);
1839 /* Yes, run_hook_with_args works with args in the other order. */
1840 internal_condition_case_n (safe_run_hooks_1
,
1841 2, ((Lisp_Object
[]) {args
[1], args
[0]}),
1842 Qt
, safe_run_hooks_error
);
1846 /* If we get an error while running the hook, cause the hook variable
1847 to be nil. Also inhibit quits, so that C-g won't cause the hook
1848 to mysteriously evaporate. */
1851 safe_run_hooks (Lisp_Object hook
)
1853 ptrdiff_t count
= SPECPDL_INDEX ();
1855 specbind (Qinhibit_quit
, Qt
);
1856 run_hook_with_args (2, ((Lisp_Object
[]) {hook
, hook
}), safe_run_hook_funcall
);
1857 unbind_to (count
, Qnil
);
1861 /* Nonzero means polling for input is temporarily suppressed. */
1863 int poll_suppress_count
;
1866 #ifdef POLL_FOR_INPUT
1868 /* Asynchronous timer for polling. */
1870 static struct atimer
*poll_timer
;
1872 /* Poll for input, so that we catch a C-g if it comes in. */
1874 poll_for_input_1 (void)
1876 if (! input_blocked_p ()
1877 && !waiting_for_input
)
1881 /* Timer callback function for poll_timer. TIMER is equal to
1885 poll_for_input (struct atimer
*timer
)
1887 if (poll_suppress_count
== 0)
1888 pending_signals
= true;
1891 #endif /* POLL_FOR_INPUT */
1893 /* Begin signals to poll for input, if they are appropriate.
1894 This function is called unconditionally from various places. */
1897 start_polling (void)
1899 #ifdef POLL_FOR_INPUT
1900 /* XXX This condition was (read_socket_hook && !interrupt_input),
1901 but read_socket_hook is not global anymore. Let's pretend that
1903 if (!interrupt_input
)
1905 /* Turn alarm handling on unconditionally. It might have
1906 been turned off in process.c. */
1907 turn_on_atimers (1);
1909 /* If poll timer doesn't exist, or we need one with
1910 a different interval, start a new one. */
1911 if (poll_timer
== NULL
1912 || poll_timer
->interval
.tv_sec
!= polling_period
)
1914 time_t period
= max (1, min (polling_period
, TYPE_MAXIMUM (time_t)));
1915 struct timespec interval
= make_timespec (period
, 0);
1918 cancel_atimer (poll_timer
);
1920 poll_timer
= start_atimer (ATIMER_CONTINUOUS
, interval
,
1921 poll_for_input
, NULL
);
1924 /* Let the timer's callback function poll for input
1925 if this becomes zero. */
1926 --poll_suppress_count
;
1931 /* True if we are using polling to handle input asynchronously. */
1934 input_polling_used (void)
1936 #ifdef POLL_FOR_INPUT
1937 /* XXX This condition was (read_socket_hook && !interrupt_input),
1938 but read_socket_hook is not global anymore. Let's pretend that
1940 return !interrupt_input
;
1946 /* Turn off polling. */
1951 #ifdef POLL_FOR_INPUT
1952 /* XXX This condition was (read_socket_hook && !interrupt_input),
1953 but read_socket_hook is not global anymore. Let's pretend that
1955 if (!interrupt_input
)
1956 ++poll_suppress_count
;
1960 /* Set the value of poll_suppress_count to COUNT
1961 and start or stop polling accordingly. */
1964 set_poll_suppress_count (int count
)
1966 #ifdef POLL_FOR_INPUT
1967 if (count
== 0 && poll_suppress_count
!= 0)
1969 poll_suppress_count
= 1;
1972 else if (count
!= 0 && poll_suppress_count
== 0)
1976 poll_suppress_count
= count
;
1980 /* Bind polling_period to a value at least N.
1981 But don't decrease it. */
1984 bind_polling_period (int n
)
1986 #ifdef POLL_FOR_INPUT
1987 EMACS_INT
new = polling_period
;
1992 stop_other_atimers (poll_timer
);
1994 specbind (Qpolling_period
, make_number (new));
1995 /* Start a new alarm with the new period. */
2000 /* Apply the control modifier to CHARACTER. */
2003 make_ctrl_char (int c
)
2005 /* Save the upper bits here. */
2006 int upper
= c
& ~0177;
2008 if (! ASCII_CHAR_P (c
))
2009 return c
|= ctrl_modifier
;
2013 /* Everything in the columns containing the upper-case letters
2014 denotes a control character. */
2015 if (c
>= 0100 && c
< 0140)
2019 /* Set the shift modifier for a control char
2020 made from a shifted letter. But only for letters! */
2021 if (oc
>= 'A' && oc
<= 'Z')
2022 c
|= shift_modifier
;
2025 /* The lower-case letters denote control characters too. */
2026 else if (c
>= 'a' && c
<= 'z')
2029 /* Include the bits for control and shift
2030 only if the basic ASCII code can't indicate them. */
2034 /* Replace the high bits. */
2035 c
|= (upper
& ~ctrl_modifier
);
2040 /* Display the help-echo property of the character after the mouse pointer.
2041 Either show it in the echo area, or call show-help-function to display
2042 it by other means (maybe in a tooltip).
2044 If HELP is nil, that means clear the previous help echo.
2046 If HELP is a string, display that string. If HELP is a function,
2047 call it with OBJECT and POS as arguments; the function should
2048 return a help string or nil for none. For all other types of HELP,
2049 evaluate it to obtain a string.
2051 WINDOW is the window in which the help was generated, if any.
2052 It is nil if not in a window.
2054 If OBJECT is a buffer, POS is the position in the buffer where the
2055 `help-echo' text property was found.
2057 If OBJECT is an overlay, that overlay has a `help-echo' property,
2058 and POS is the position in the overlay's buffer under the mouse.
2060 If OBJECT is a string (an overlay string or a string displayed with
2061 the `display' property). POS is the position in that string under
2064 Note: this function may only be called with HELP nil or a string
2065 from X code running asynchronously. */
2068 show_help_echo (Lisp_Object help
, Lisp_Object window
, Lisp_Object object
,
2071 if (!NILP (help
) && !STRINGP (help
))
2073 if (FUNCTIONP (help
))
2074 help
= safe_call (4, help
, window
, object
, pos
);
2076 help
= safe_eval (help
);
2078 if (!STRINGP (help
))
2082 if (!noninteractive
&& STRINGP (help
))
2084 /* The mouse-fixup-help-message Lisp function can call
2085 mouse_position_hook, which resets the mouse_moved flags.
2086 This causes trouble if we are trying to read a mouse motion
2087 event (i.e., if we are inside a `track-mouse' form), so we
2088 restore the mouse_moved flag. */
2089 struct frame
*f
= NILP (do_mouse_tracking
) ? NULL
: some_mouse_moved ();
2090 help
= call1 (Qmouse_fixup_help_message
, help
);
2092 f
->mouse_moved
= true;
2095 if (STRINGP (help
) || NILP (help
))
2097 if (!NILP (Vshow_help_function
))
2098 call1 (Vshow_help_function
, Fsubstitute_command_keys (help
));
2099 help_echo_showing_p
= STRINGP (help
);
2105 /* Input of single characters from keyboard. */
2107 static Lisp_Object
kbd_buffer_get_event (KBOARD
**kbp
, bool *used_mouse_menu
,
2108 struct timespec
*end_time
);
2109 static void record_char (Lisp_Object c
);
2111 static Lisp_Object help_form_saved_window_configs
;
2113 read_char_help_form_unwind (void)
2115 Lisp_Object window_config
= XCAR (help_form_saved_window_configs
);
2116 help_form_saved_window_configs
= XCDR (help_form_saved_window_configs
);
2117 if (!NILP (window_config
))
2118 Fset_window_configuration (window_config
);
2121 #define STOP_POLLING \
2122 do { if (! polling_stopped_here) stop_polling (); \
2123 polling_stopped_here = true; } while (0)
2125 #define RESUME_POLLING \
2126 do { if (polling_stopped_here) start_polling (); \
2127 polling_stopped_here = false; } while (0)
2130 read_event_from_main_queue (struct timespec
*end_time
,
2131 sys_jmp_buf local_getcjmp
,
2132 bool *used_mouse_menu
)
2134 Lisp_Object c
= Qnil
;
2135 sys_jmp_buf save_jump
;
2140 /* Read from the main queue, and if that gives us something we can't use yet,
2141 we put it on the appropriate side queue and try again. */
2143 if (end_time
&& timespec_cmp (*end_time
, current_timespec ()) <= 0)
2146 /* Actually read a character, waiting if necessary. */
2147 ptrdiff_t count
= SPECPDL_INDEX ();
2148 save_getcjmp (save_jump
);
2149 record_unwind_protect_ptr (restore_getcjmp
, save_jump
);
2150 restore_getcjmp (local_getcjmp
);
2152 timer_start_idle ();
2153 c
= kbd_buffer_get_event (&kb
, used_mouse_menu
, end_time
);
2154 unbind_to (count
, Qnil
);
2156 if (! NILP (c
) && (kb
!= current_kboard
))
2158 Lisp_Object last
= KVAR (kb
, kbd_queue
);
2161 while (CONSP (XCDR (last
)))
2163 if (!NILP (XCDR (last
)))
2167 kset_kbd_queue (kb
, list1 (c
));
2169 XSETCDR (last
, list1 (c
));
2170 kb
->kbd_queue_has_data
= true;
2174 current_kboard
= kb
;
2175 return make_number (-2);
2178 /* Terminate Emacs in batch mode if at eof. */
2179 if (noninteractive
&& INTEGERP (c
) && XINT (c
) < 0)
2180 Fkill_emacs (make_number (1));
2184 /* Add in any extra modifiers, where appropriate. */
2185 if ((extra_keyboard_modifiers
& CHAR_CTL
)
2186 || ((extra_keyboard_modifiers
& 0177) < ' '
2187 && (extra_keyboard_modifiers
& 0177) != 0))
2188 XSETINT (c
, make_ctrl_char (XINT (c
)));
2190 /* Transfer any other modifier bits directly from
2191 extra_keyboard_modifiers to c. Ignore the actual character code
2192 in the low 16 bits of extra_keyboard_modifiers. */
2193 XSETINT (c
, XINT (c
) | (extra_keyboard_modifiers
& ~0xff7f & ~CHAR_CTL
));
2201 /* Like `read_event_from_main_queue' but applies keyboard-coding-system
2204 read_decoded_event_from_main_queue (struct timespec
*end_time
,
2205 sys_jmp_buf local_getcjmp
,
2206 Lisp_Object prev_event
,
2207 bool *used_mouse_menu
)
2210 #define MAX_ENCODED_BYTES 16
2211 Lisp_Object events
[MAX_ENCODED_BYTES
];
2217 = read_event_from_main_queue (end_time
, local_getcjmp
,
2220 /* w32_console already returns decoded events. It either reads
2221 Unicode characters from the Windows keyboard input, or
2222 converts characters encoded in the current codepage into
2223 Unicode. See w32inevt.c:key_event, near its end. */
2226 struct frame
*frame
= XFRAME (selected_frame
);
2227 struct terminal
*terminal
= frame
->terminal
;
2228 if (!((FRAME_TERMCAP_P (frame
) || FRAME_MSDOS_P (frame
))
2229 /* Don't apply decoding if we're just reading a raw event
2230 (e.g. reading bytes sent by the xterm to specify the position
2231 of a mouse click). */
2232 && (!EQ (prev_event
, Qt
))
2233 && (TERMINAL_KEYBOARD_CODING (terminal
)->common_flags
2234 & CODING_REQUIRE_DECODING_MASK
)))
2235 return nextevt
; /* No decoding needed. */
2238 int meta_key
= terminal
->display_info
.tty
->meta_key
;
2239 eassert (n
< MAX_ENCODED_BYTES
);
2240 events
[n
++] = nextevt
;
2241 if (NATNUMP (nextevt
)
2242 && XINT (nextevt
) < (meta_key
== 1 ? 0x80 : 0x100))
2243 { /* An encoded byte sequence, let's try to decode it. */
2244 struct coding_system
*coding
2245 = TERMINAL_KEYBOARD_CODING (terminal
);
2247 if (raw_text_coding_system_p (coding
))
2251 for (i
= 0; i
< n
; i
++)
2252 events
[i
] = make_number (XINT (events
[i
]) & ~0x80);
2256 unsigned char src
[MAX_ENCODED_BYTES
];
2257 unsigned char dest
[MAX_ENCODED_BYTES
* MAX_MULTIBYTE_LENGTH
];
2259 for (i
= 0; i
< n
; i
++)
2260 src
[i
] = XINT (events
[i
]);
2262 for (i
= 0; i
< n
; i
++)
2264 coding
->destination
= dest
;
2265 coding
->dst_bytes
= sizeof dest
;
2266 decode_coding_c_string (coding
, src
, n
, Qnil
);
2267 eassert (coding
->produced_char
<= n
);
2268 if (coding
->produced_char
== 0)
2269 { /* The encoded sequence is incomplete. */
2270 if (n
< MAX_ENCODED_BYTES
) /* Avoid buffer overflow. */
2271 continue; /* Read on! */
2275 const unsigned char *p
= coding
->destination
;
2276 eassert (coding
->carryover_bytes
== 0);
2278 while (n
< coding
->produced_char
)
2279 events
[n
++] = make_number (STRING_CHAR_ADVANCE (p
));
2283 /* Now `events' should hold decoded events.
2284 Normally, n should be equal to 1, but better not rely on it.
2285 We can only return one event here, so return the first we
2286 had and keep the others (if any) for later. */
2288 Vunread_command_events
2289 = Fcons (events
[--n
], Vunread_command_events
);
2296 /* Read a character from the keyboard; call the redisplay if needed. */
2297 /* commandflag 0 means do not autosave, but do redisplay.
2298 -1 means do not redisplay, but do autosave.
2299 -2 means do neither.
2302 The argument MAP is a keymap for menu prompting.
2304 PREV_EVENT is the previous input event, or nil if we are reading
2305 the first event of a key sequence (or not reading a key sequence).
2306 If PREV_EVENT is t, that is a "magic" value that says
2307 not to run input methods, but in other respects to act as if
2308 not reading a key sequence.
2310 If USED_MOUSE_MENU is non-null, then set *USED_MOUSE_MENU to true
2311 if we used a mouse menu to read the input, or false otherwise. If
2312 USED_MOUSE_MENU is null, don't dereference it.
2314 Value is -2 when we find input on another keyboard. A second call
2315 to read_char will read it.
2317 If END_TIME is non-null, it is a pointer to a struct timespec
2318 specifying the maximum time to wait until. If no input arrives by
2319 that time, stop waiting and return nil.
2321 Value is t if we showed a menu and the user rejected it. */
2324 read_char (int commandflag
, Lisp_Object map
,
2325 Lisp_Object prev_event
,
2326 bool *used_mouse_menu
, struct timespec
*end_time
)
2330 sys_jmp_buf local_getcjmp
;
2331 sys_jmp_buf save_jump
;
2332 Lisp_Object tem
, save
;
2333 volatile Lisp_Object previous_echo_area_message
;
2334 volatile Lisp_Object also_record
;
2335 volatile bool reread
, recorded
;
2336 bool volatile polling_stopped_here
= false;
2337 struct kboard
*orig_kboard
= current_kboard
;
2342 previous_echo_area_message
= Qnil
;
2348 if (CONSP (Vunread_post_input_method_events
))
2350 c
= XCAR (Vunread_post_input_method_events
);
2351 Vunread_post_input_method_events
2352 = XCDR (Vunread_post_input_method_events
);
2354 /* Undo what read_char_x_menu_prompt did when it unread
2355 additional keys returned by Fx_popup_menu. */
2357 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2368 if (CONSP (Vunread_command_events
))
2370 bool was_disabled
= false;
2372 c
= XCAR (Vunread_command_events
);
2373 Vunread_command_events
= XCDR (Vunread_command_events
);
2375 /* Undo what sit-for did when it unread additional keys
2376 inside universal-argument. */
2378 if (CONSP (c
) && EQ (XCAR (c
), Qt
))
2383 /* Undo what read_char_x_menu_prompt did when it unread
2384 additional keys returned by Fx_popup_menu. */
2386 && EQ (XCDR (c
), Qdisabled
)
2387 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
))))
2389 was_disabled
= true;
2393 /* If the queued event is something that used the mouse,
2394 set used_mouse_menu accordingly. */
2396 /* Also check was_disabled so last-nonmenu-event won't return
2397 a bad value when submenus are involved. (Bug#447) */
2398 && (EQ (c
, Qtool_bar
) || EQ (c
, Qmenu_bar
) || was_disabled
))
2399 *used_mouse_menu
= true;
2401 goto reread_for_input_method
;
2404 if (CONSP (Vunread_input_method_events
))
2406 c
= XCAR (Vunread_input_method_events
);
2407 Vunread_input_method_events
= XCDR (Vunread_input_method_events
);
2409 /* Undo what read_char_x_menu_prompt did when it unread
2410 additional keys returned by Fx_popup_menu. */
2412 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2416 goto reread_for_input_method
;
2419 if (!NILP (Vexecuting_kbd_macro
))
2421 /* We set this to Qmacro; since that's not a frame, nobody will
2422 try to switch frames on us, and the selected window will
2425 Since this event came from a macro, it would be misleading to
2426 leave internal_last_event_frame set to wherever the last
2427 real event came from. Normally, a switch-frame event selects
2428 internal_last_event_frame after each command is read, but
2429 events read from a macro should never cause a new frame to be
2431 Vlast_event_frame
= internal_last_event_frame
= Qmacro
;
2433 /* Exit the macro if we are at the end.
2434 Also, some things replace the macro with t
2435 to force an early exit. */
2436 if (EQ (Vexecuting_kbd_macro
, Qt
)
2437 || executing_kbd_macro_index
>= XFASTINT (Flength (Vexecuting_kbd_macro
)))
2443 c
= Faref (Vexecuting_kbd_macro
, make_number (executing_kbd_macro_index
));
2444 if (STRINGP (Vexecuting_kbd_macro
)
2445 && (XFASTINT (c
) & 0x80) && (XFASTINT (c
) <= 0xff))
2446 XSETFASTINT (c
, CHAR_META
| (XFASTINT (c
) & ~0x80));
2448 executing_kbd_macro_index
++;
2453 if (!NILP (unread_switch_frame
))
2455 c
= unread_switch_frame
;
2456 unread_switch_frame
= Qnil
;
2458 /* This event should make it into this_command_keys, and get echoed
2459 again, so we do not set `reread'. */
2463 /* If redisplay was requested. */
2464 if (commandflag
>= 0)
2466 bool echo_current
= EQ (echo_message_buffer
, echo_area_buffer
[0]);
2468 /* If there is pending input, process any events which are not
2469 user-visible, such as X selection_request events. */
2471 || detect_input_pending_run_timers (0))
2472 swallow_events (false); /* May clear input_pending. */
2474 /* Redisplay if no pending input. */
2475 while (!(input_pending
2476 && (input_was_pending
|| !redisplay_dont_pause
)))
2478 input_was_pending
= input_pending
;
2479 if (help_echo_showing_p
&& !EQ (selected_window
, minibuf_window
))
2480 redisplay_preserve_echo_area (5);
2485 /* Normal case: no input arrived during redisplay. */
2488 /* Input arrived and pre-empted redisplay.
2489 Process any events which are not user-visible. */
2490 swallow_events (false);
2491 /* If that cleared input_pending, try again to redisplay. */
2494 /* Prevent the redisplay we just did
2495 from messing up echoing of the input after the prompt. */
2496 if (commandflag
== 0 && echo_current
)
2497 echo_message_buffer
= echo_area_buffer
[0];
2501 /* Message turns off echoing unless more keystrokes turn it on again.
2503 The code in 20.x for the condition was
2505 1. echo_area_glyphs && *echo_area_glyphs
2506 2. && echo_area_glyphs != current_kboard->echobuf
2507 3. && ok_to_echo_at_next_pause != echo_area_glyphs
2509 (1) means there's a current message displayed
2511 (2) means it's not the message from echoing from the current
2514 (3) There's only one place in 20.x where ok_to_echo_at_next_pause
2515 is set to a non-null value. This is done in read_char and it is
2516 set to echo_area_glyphs. That means
2517 ok_to_echo_at_next_pause is either null or
2518 current_kboard->echobuf with the appropriate current_kboard at
2521 So, condition (3) means in clear text ok_to_echo_at_next_pause
2522 must be either null, or the current message isn't from echoing at
2523 all, or it's from echoing from a different kboard than the
2526 if (/* There currently is something in the echo area. */
2527 !NILP (echo_area_buffer
[0])
2528 && (/* It's an echo from a different kboard. */
2529 echo_kboard
!= current_kboard
2530 /* Or we explicitly allow overwriting whatever there is. */
2531 || ok_to_echo_at_next_pause
== NULL
))
2536 /* Try reading a character via menu prompting in the minibuf.
2537 Try this before the sit-for, because the sit-for
2538 would do the wrong thing if we are supposed to do
2539 menu prompting. If EVENT_HAS_PARAMETERS then we are reading
2540 after a mouse event so don't try a minibuf menu. */
2542 if (KEYMAPP (map
) && INTERACTIVE
2543 && !NILP (prev_event
) && ! EVENT_HAS_PARAMETERS (prev_event
)
2544 /* Don't bring up a menu if we already have another event. */
2545 && !CONSP (Vunread_command_events
)
2546 && !detect_input_pending_run_timers (0))
2548 c
= read_char_minibuf_menu_prompt (commandflag
, map
);
2550 if (INTEGERP (c
) && XINT (c
) == -2)
2551 return c
; /* wrong_kboard_jmpbuf */
2557 /* Make a longjmp point for quits to use, but don't alter getcjmp just yet.
2558 We will do that below, temporarily for short sections of code,
2559 when appropriate. local_getcjmp must be in effect
2560 around any call to sit_for or kbd_buffer_get_event;
2561 it *must not* be in effect when we call redisplay. */
2563 jmpcount
= SPECPDL_INDEX ();
2564 if (sys_setjmp (local_getcjmp
))
2566 /* Handle quits while reading the keyboard. */
2567 /* We must have saved the outer value of getcjmp here,
2568 so restore it now. */
2569 restore_getcjmp (save_jump
);
2570 pthread_sigmask (SIG_SETMASK
, &empty_mask
, 0);
2571 unbind_to (jmpcount
, Qnil
);
2572 XSETINT (c
, quit_char
);
2573 internal_last_event_frame
= selected_frame
;
2574 Vlast_event_frame
= internal_last_event_frame
;
2575 /* If we report the quit char as an event,
2576 don't do so more than once. */
2577 if (!NILP (Vinhibit_quit
))
2581 KBOARD
*kb
= FRAME_KBOARD (XFRAME (selected_frame
));
2582 if (kb
!= current_kboard
)
2584 Lisp_Object last
= KVAR (kb
, kbd_queue
);
2585 /* We shouldn't get here if we were in single-kboard mode! */
2590 while (CONSP (XCDR (last
)))
2592 if (!NILP (XCDR (last
)))
2596 kset_kbd_queue (kb
, list1 (c
));
2598 XSETCDR (last
, list1 (c
));
2599 kb
->kbd_queue_has_data
= true;
2600 current_kboard
= kb
;
2601 return make_number (-2); /* wrong_kboard_jmpbuf */
2607 /* Start idle timers if no time limit is supplied. We don't do it
2608 if a time limit is supplied to avoid an infinite recursion in the
2609 situation where an idle timer calls `sit-for'. */
2612 timer_start_idle ();
2614 /* If in middle of key sequence and minibuffer not active,
2615 start echoing if enough time elapses. */
2617 if (minibuf_level
== 0
2619 && !current_kboard
->immediate_echo
2620 && (this_command_key_count
> 0
2621 || !NILP (call0 (Qinternal_echo_keystrokes_prefix
)))
2623 && echo_keystrokes_p ()
2624 && (/* No message. */
2625 NILP (echo_area_buffer
[0])
2626 /* Or empty message. */
2627 || (BUF_BEG (XBUFFER (echo_area_buffer
[0]))
2628 == BUF_Z (XBUFFER (echo_area_buffer
[0])))
2629 /* Or already echoing from same kboard. */
2630 || (echo_kboard
&& ok_to_echo_at_next_pause
== echo_kboard
)
2631 /* Or not echoing before and echoing allowed. */
2632 || (!echo_kboard
&& ok_to_echo_at_next_pause
)))
2634 /* After a mouse event, start echoing right away.
2635 This is because we are probably about to display a menu,
2636 and we don't want to delay before doing so. */
2637 if (EVENT_HAS_PARAMETERS (prev_event
))
2643 ptrdiff_t count
= SPECPDL_INDEX ();
2644 save_getcjmp (save_jump
);
2645 record_unwind_protect_ptr (restore_getcjmp
, save_jump
);
2646 restore_getcjmp (local_getcjmp
);
2647 tem0
= sit_for (Vecho_keystrokes
, 1, 1);
2648 unbind_to (count
, Qnil
);
2650 && ! CONSP (Vunread_command_events
))
2655 /* Maybe auto save due to number of keystrokes. */
2657 if (commandflag
!= 0 && commandflag
!= -2
2658 && auto_save_interval
> 0
2659 && num_nonmacro_input_events
- last_auto_save
> max (auto_save_interval
, 20)
2660 && !detect_input_pending_run_timers (0))
2662 Fdo_auto_save (Qnil
, Qnil
);
2663 /* Hooks can actually change some buffers in auto save. */
2667 /* Try reading using an X menu.
2668 This is never confused with reading using the minibuf
2669 because the recursive call of read_char in read_char_minibuf_menu_prompt
2670 does not pass on any keymaps. */
2672 if (KEYMAPP (map
) && INTERACTIVE
2673 && !NILP (prev_event
)
2674 && EVENT_HAS_PARAMETERS (prev_event
)
2675 && !EQ (XCAR (prev_event
), Qmenu_bar
)
2676 && !EQ (XCAR (prev_event
), Qtool_bar
)
2677 /* Don't bring up a menu if we already have another event. */
2678 && !CONSP (Vunread_command_events
))
2680 c
= read_char_x_menu_prompt (map
, prev_event
, used_mouse_menu
);
2682 /* Now that we have read an event, Emacs is not idle. */
2689 /* Maybe autosave and/or garbage collect due to idleness. */
2691 if (INTERACTIVE
&& NILP (c
))
2694 ptrdiff_t buffer_size
;
2696 /* Slow down auto saves logarithmically in size of current buffer,
2697 and garbage collect while we're at it. */
2698 if (! MINI_WINDOW_P (XWINDOW (selected_window
)))
2699 last_non_minibuf_size
= Z
- BEG
;
2700 buffer_size
= (last_non_minibuf_size
>> 8) + 1;
2702 while (buffer_size
> 64)
2703 delay_level
++, buffer_size
-= buffer_size
>> 2;
2704 if (delay_level
< 4) delay_level
= 4;
2705 /* delay_level is 4 for files under around 50k, 7 at 100k,
2706 9 at 200k, 11 at 300k, and 12 at 500k. It is 15 at 1 meg. */
2708 /* Auto save if enough time goes by without input. */
2709 if (commandflag
!= 0 && commandflag
!= -2
2710 && num_nonmacro_input_events
> last_auto_save
2711 && INTEGERP (Vauto_save_timeout
)
2712 && XINT (Vauto_save_timeout
) > 0)
2715 EMACS_INT timeout
= XFASTINT (Vauto_save_timeout
);
2717 timeout
= min (timeout
, MOST_POSITIVE_FIXNUM
/ delay_level
* 4);
2718 timeout
= delay_level
* timeout
/ 4;
2719 ptrdiff_t count1
= SPECPDL_INDEX ();
2720 save_getcjmp (save_jump
);
2721 record_unwind_protect_ptr (restore_getcjmp
, save_jump
);
2722 restore_getcjmp (local_getcjmp
);
2723 tem0
= sit_for (make_number (timeout
), 1, 1);
2724 unbind_to (count1
, Qnil
);
2727 && ! CONSP (Vunread_command_events
))
2729 Fdo_auto_save (Qnil
, Qnil
);
2734 /* If there is still no input available, ask for GC. */
2735 if (!detect_input_pending_run_timers (0))
2739 /* Notify the caller if an autosave hook, or a timer, sentinel or
2740 filter in the sit_for calls above have changed the current
2741 kboard. This could happen if they use the minibuffer or start a
2742 recursive edit, like the fancy splash screen in server.el's
2743 filter. If this longjmp wasn't here, read_key_sequence would
2744 interpret the next key sequence using the wrong translation
2745 tables and function keymaps. */
2746 if (NILP (c
) && current_kboard
!= orig_kboard
)
2747 return make_number (-2); /* wrong_kboard_jmpbuf */
2749 /* If this has become non-nil here, it has been set by a timer
2750 or sentinel or filter. */
2751 if (CONSP (Vunread_command_events
))
2753 c
= XCAR (Vunread_command_events
);
2754 Vunread_command_events
= XCDR (Vunread_command_events
);
2756 if (CONSP (c
) && EQ (XCAR (c
), Qt
))
2762 /* Read something from current KBOARD's side queue, if possible. */
2766 if (current_kboard
->kbd_queue_has_data
)
2768 if (!CONSP (KVAR (current_kboard
, kbd_queue
)))
2770 c
= XCAR (KVAR (current_kboard
, kbd_queue
));
2771 kset_kbd_queue (current_kboard
,
2772 XCDR (KVAR (current_kboard
, kbd_queue
)));
2773 if (NILP (KVAR (current_kboard
, kbd_queue
)))
2774 current_kboard
->kbd_queue_has_data
= false;
2775 input_pending
= readable_events (0);
2776 if (EVENT_HAS_PARAMETERS (c
)
2777 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qswitch_frame
))
2778 internal_last_event_frame
= XCAR (XCDR (c
));
2779 Vlast_event_frame
= internal_last_event_frame
;
2783 /* If current_kboard's side queue is empty check the other kboards.
2784 If one of them has data that we have not yet seen here,
2785 switch to it and process the data waiting for it.
2787 Note: if the events queued up for another kboard
2788 have already been seen here, and therefore are not a complete command,
2789 the kbd_queue_has_data field is 0, so we skip that kboard here.
2790 That's to avoid an infinite loop switching between kboards here. */
2791 if (NILP (c
) && !single_kboard
)
2794 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
2795 if (kb
->kbd_queue_has_data
)
2797 current_kboard
= kb
;
2798 return make_number (-2); /* wrong_kboard_jmpbuf */
2808 c
= read_decoded_event_from_main_queue (end_time
, local_getcjmp
,
2809 prev_event
, used_mouse_menu
);
2810 if (NILP (c
) && end_time
2811 && timespec_cmp (*end_time
, current_timespec ()) <= 0)
2816 if (EQ (c
, make_number (-2)))
2819 if (CONSP (c
) && EQ (XCAR (c
), Qt
))
2831 if (commandflag
>= 0
2832 && !input_pending
&& !detect_input_pending_run_timers (0))
2838 /* Buffer switch events are only for internal wakeups
2839 so don't show them to the user.
2840 Also, don't record a key if we already did. */
2844 /* Process special events within read_char
2845 and loop around to read another event. */
2848 tem
= access_keymap (get_keymap (Vspecial_event_map
, 0, 1), c
, 0, 0, 1);
2853 struct buffer
*prev_buffer
= current_buffer
;
2854 last_input_event
= c
;
2855 call4 (Qcommand_execute
, tem
, Qnil
, Fvector (1, &last_input_event
), Qt
);
2858 && (EQ (XCAR (c
), Qselect_window
)
2860 || EQ (XCAR (c
), Qdbus_event
)
2862 #ifdef USE_FILE_NOTIFY
2863 || EQ (XCAR (c
), Qfile_notify
)
2865 || EQ (XCAR (c
), Qconfig_changed_event
))
2867 /* We stopped being idle for this event; undo that. This
2868 prevents automatic window selection (under
2869 mouse-autoselect-window) from acting as a real input event, for
2870 example banishing the mouse under mouse-avoidance-mode. */
2871 timer_resume_idle ();
2873 if (current_buffer
!= prev_buffer
)
2875 /* The command may have changed the keymaps. Pretend there
2876 is input in another keyboard and return. This will
2877 recalculate keymaps. */
2878 c
= make_number (-2);
2885 /* Handle things that only apply to characters. */
2888 /* If kbd_buffer_get_event gave us an EOF, return that. */
2892 if ((STRINGP (KVAR (current_kboard
, Vkeyboard_translate_table
))
2893 && UNSIGNED_CMP (XFASTINT (c
), <,
2894 SCHARS (KVAR (current_kboard
,
2895 Vkeyboard_translate_table
))))
2896 || (VECTORP (KVAR (current_kboard
, Vkeyboard_translate_table
))
2897 && UNSIGNED_CMP (XFASTINT (c
), <,
2898 ASIZE (KVAR (current_kboard
,
2899 Vkeyboard_translate_table
))))
2900 || (CHAR_TABLE_P (KVAR (current_kboard
, Vkeyboard_translate_table
))
2904 d
= Faref (KVAR (current_kboard
, Vkeyboard_translate_table
), c
);
2905 /* nil in keyboard-translate-table means no translation. */
2911 /* If this event is a mouse click in the menu bar,
2912 return just menu-bar for now. Modify the mouse click event
2913 so we won't do this twice, then queue it up. */
2914 if (EVENT_HAS_PARAMETERS (c
)
2916 && CONSP (EVENT_START (c
))
2917 && CONSP (XCDR (EVENT_START (c
))))
2921 posn
= POSN_POSN (EVENT_START (c
));
2922 /* Handle menu-bar events:
2923 insert the dummy prefix event `menu-bar'. */
2924 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
2926 /* Change menu-bar to (menu-bar) as the event "position". */
2927 POSN_SET_POSN (EVENT_START (c
), list1 (posn
));
2930 Vunread_command_events
= Fcons (c
, Vunread_command_events
);
2935 /* Store these characters into recent_keys, the dribble file if any,
2936 and the keyboard macro being defined, if any. */
2939 if (! NILP (also_record
))
2940 record_char (also_record
);
2942 /* Wipe the echo area.
2943 But first, if we are about to use an input method,
2944 save the echo area contents for it to refer to. */
2946 && ! NILP (Vinput_method_function
)
2947 && ' ' <= XINT (c
) && XINT (c
) < 256 && XINT (c
) != 127)
2949 previous_echo_area_message
= Fcurrent_message ();
2950 Vinput_method_previous_message
= previous_echo_area_message
;
2953 /* Now wipe the echo area, except for help events which do their
2954 own stuff with the echo area. */
2956 || (!(EQ (Qhelp_echo
, XCAR (c
)))
2957 && !(EQ (Qswitch_frame
, XCAR (c
)))
2958 /* Don't wipe echo area for select window events: These might
2959 get delayed via `mouse-autoselect-window' (Bug#11304). */
2960 && !(EQ (Qselect_window
, XCAR (c
)))))
2962 if (!NILP (echo_area_buffer
[0]))
2964 safe_run_hooks (Qecho_area_clear_hook
);
2965 clear_message (1, 0);
2969 reread_for_input_method
:
2971 /* Pass this to the input method, if appropriate. */
2973 && ! NILP (Vinput_method_function
)
2974 /* Don't run the input method within a key sequence,
2975 after the first event of the key sequence. */
2976 && NILP (prev_event
)
2977 && ' ' <= XINT (c
) && XINT (c
) < 256 && XINT (c
) != 127)
2980 ptrdiff_t key_count
;
2981 ptrdiff_t command_key_start
;
2982 ptrdiff_t count
= SPECPDL_INDEX ();
2984 /* Save the echo status. */
2985 bool saved_immediate_echo
= current_kboard
->immediate_echo
;
2986 struct kboard
*saved_ok_to_echo
= ok_to_echo_at_next_pause
;
2987 Lisp_Object saved_echo_string
= KVAR (current_kboard
, echo_string
);
2988 Lisp_Object saved_echo_prompt
= KVAR (current_kboard
, echo_prompt
);
2990 /* Save the this_command_keys status. */
2991 key_count
= this_command_key_count
;
2992 command_key_start
= this_single_command_key_start
;
2995 keys
= Fcopy_sequence (this_command_keys
);
2999 /* Clear out this_command_keys. */
3000 this_command_key_count
= 0;
3001 this_single_command_key_start
= 0;
3003 /* Now wipe the echo area. */
3004 if (!NILP (echo_area_buffer
[0]))
3005 safe_run_hooks (Qecho_area_clear_hook
);
3006 clear_message (1, 0);
3009 /* If we are not reading a key sequence,
3010 never use the echo area. */
3013 specbind (Qinput_method_use_echo_area
, Qt
);
3016 /* Call the input method. */
3017 tem
= call1 (Vinput_method_function
, c
);
3019 tem
= unbind_to (count
, tem
);
3021 /* Restore the saved echoing state
3022 and this_command_keys state. */
3023 this_command_key_count
= key_count
;
3024 this_single_command_key_start
= command_key_start
;
3026 this_command_keys
= keys
;
3029 ok_to_echo_at_next_pause
= saved_ok_to_echo
;
3030 kset_echo_string (current_kboard
, saved_echo_string
);
3031 kset_echo_prompt (current_kboard
, saved_echo_prompt
);
3032 if (saved_immediate_echo
)
3035 /* The input method can return no events. */
3038 /* Bring back the previous message, if any. */
3039 if (! NILP (previous_echo_area_message
))
3040 message_with_string ("%s", previous_echo_area_message
, 0);
3043 /* It returned one event or more. */
3045 Vunread_post_input_method_events
3046 = nconc2 (XCDR (tem
), Vunread_post_input_method_events
);
3048 /* When we consume events from the various unread-*-events lists, we
3049 bypass the code that records input, so record these events now if
3050 they were not recorded already. */
3059 /* Display help if not echoing. */
3060 if (CONSP (c
) && EQ (XCAR (c
), Qhelp_echo
))
3062 /* (help-echo FRAME HELP WINDOW OBJECT POS). */
3063 Lisp_Object help
, object
, position
, window
, htem
;
3065 htem
= Fcdr (XCDR (c
));
3068 window
= Fcar (htem
);
3070 object
= Fcar (htem
);
3072 position
= Fcar (htem
);
3074 show_help_echo (help
, window
, object
, position
);
3076 /* We stopped being idle for this event; undo that. */
3078 timer_resume_idle ();
3082 if ((! reread
|| this_command_key_count
== 0)
3086 /* Don't echo mouse motion events. */
3087 if (! (EVENT_HAS_PARAMETERS (c
)
3088 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
3089 /* Once we reread a character, echoing can happen
3090 the next time we pause to read a new one. */
3091 ok_to_echo_at_next_pause
= current_kboard
;
3093 /* Record this character as part of the current key. */
3094 add_command_key (c
);
3095 if (! NILP (also_record
))
3096 add_command_key (also_record
);
3101 last_input_event
= c
;
3104 /* Process the help character specially if enabled. */
3105 if (!NILP (Vhelp_form
) && help_char_p (c
))
3107 ptrdiff_t count
= SPECPDL_INDEX ();
3109 help_form_saved_window_configs
3110 = Fcons (Fcurrent_window_configuration (Qnil
),
3111 help_form_saved_window_configs
);
3112 record_unwind_protect_void (read_char_help_form_unwind
);
3113 call0 (Qhelp_form_show
);
3118 c
= read_char (0, Qnil
, Qnil
, 0, NULL
);
3119 if (EVENT_HAS_PARAMETERS (c
)
3120 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_click
))
3121 XSETCAR (help_form_saved_window_configs
, Qnil
);
3123 while (BUFFERP (c
));
3124 /* Remove the help from the frame. */
3125 unbind_to (count
, Qnil
);
3128 if (EQ (c
, make_number (040)))
3132 c
= read_char (0, Qnil
, Qnil
, 0, NULL
);
3133 while (BUFFERP (c
));
3139 input_was_pending
= input_pending
;
3143 /* Record a key that came from a mouse menu.
3144 Record it for echoing, for this-command-keys, and so on. */
3147 record_menu_key (Lisp_Object c
)
3149 /* Wipe the echo area. */
3150 clear_message (1, 0);
3154 /* Once we reread a character, echoing can happen
3155 the next time we pause to read a new one. */
3156 ok_to_echo_at_next_pause
= NULL
;
3158 /* Record this character as part of the current key. */
3159 add_command_key (c
);
3162 /* Re-reading in the middle of a command. */
3163 last_input_event
= c
;
3167 /* Return true if should recognize C as "the help character". */
3170 help_char_p (Lisp_Object c
)
3174 if (EQ (c
, Vhelp_char
))
3176 for (tail
= Vhelp_event_list
; CONSP (tail
); tail
= XCDR (tail
))
3177 if (EQ (c
, XCAR (tail
)))
3182 /* Record the input event C in various ways. */
3185 record_char (Lisp_Object c
)
3189 if (CONSP (c
) && (EQ (XCAR (c
), Qhelp_echo
) || EQ (XCAR (c
), Qmouse_movement
)))
3191 /* To avoid filling recent_keys with help-echo and mouse-movement
3192 events, we filter out repeated help-echo events, only store the
3193 first and last in a series of mouse-movement events, and don't
3194 store repeated help-echo events which are only separated by
3195 mouse-movement events. */
3197 Lisp_Object ev1
, ev2
, ev3
;
3200 if ((ix1
= recent_keys_index
- 1) < 0)
3201 ix1
= NUM_RECENT_KEYS
- 1;
3202 ev1
= AREF (recent_keys
, ix1
);
3204 if ((ix2
= ix1
- 1) < 0)
3205 ix2
= NUM_RECENT_KEYS
- 1;
3206 ev2
= AREF (recent_keys
, ix2
);
3208 if ((ix3
= ix2
- 1) < 0)
3209 ix3
= NUM_RECENT_KEYS
- 1;
3210 ev3
= AREF (recent_keys
, ix3
);
3212 if (EQ (XCAR (c
), Qhelp_echo
))
3214 /* Don't record `help-echo' in recent_keys unless it shows some help
3215 message, and a different help than the previously recorded
3217 Lisp_Object help
, last_help
;
3219 help
= Fcar_safe (Fcdr_safe (XCDR (c
)));
3220 if (!STRINGP (help
))
3222 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qhelp_echo
)
3223 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev1
))), EQ (last_help
, help
)))
3225 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3226 && CONSP (ev2
) && EQ (XCAR (ev2
), Qhelp_echo
)
3227 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev2
))), EQ (last_help
, help
)))
3229 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3230 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3231 && CONSP (ev3
) && EQ (XCAR (ev3
), Qhelp_echo
)
3232 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev3
))), EQ (last_help
, help
)))
3235 else if (EQ (XCAR (c
), Qmouse_movement
))
3237 /* Only record one pair of `mouse-movement' on a window in recent_keys.
3238 So additional mouse movement events replace the last element. */
3239 Lisp_Object last_window
, window
;
3241 window
= Fcar_safe (Fcar_safe (XCDR (c
)));
3242 if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3243 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev1
))), EQ (last_window
, window
))
3244 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3245 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev2
))), EQ (last_window
, window
)))
3247 ASET (recent_keys
, ix1
, c
);
3252 else if (NILP (Vexecuting_kbd_macro
))
3253 store_kbd_macro_char (c
);
3255 /* recent_keys should not include events from keyboard macros. */
3256 if (NILP (Vexecuting_kbd_macro
))
3260 total_keys
+= total_keys
< NUM_RECENT_KEYS
;
3261 ASET (recent_keys
, recent_keys_index
, c
);
3262 if (++recent_keys_index
>= NUM_RECENT_KEYS
)
3263 recent_keys_index
= 0;
3265 else if (recorded
< 0)
3267 /* We need to remove one or two events from recent_keys.
3268 To do this, we simply put nil at those events and move the
3269 recent_keys_index backwards over those events. Usually,
3270 users will never see those nil events, as they will be
3271 overwritten by the command keys entered to see recent_keys
3274 while (recorded
++ < 0 && total_keys
> 0)
3276 if (total_keys
< NUM_RECENT_KEYS
)
3278 if (--recent_keys_index
< 0)
3279 recent_keys_index
= NUM_RECENT_KEYS
- 1;
3280 ASET (recent_keys
, recent_keys_index
, Qnil
);
3284 num_nonmacro_input_events
++;
3287 /* Write c to the dribble file. If c is a lispy event, write
3288 the event's symbol to the dribble file, in <brackets>. Bleaugh.
3289 If you, dear reader, have a better idea, you've got the source. :-) */
3295 if (XUINT (c
) < 0x100)
3296 putc_unlocked (XUINT (c
), dribble
);
3298 fprintf (dribble
, " 0x%"pI
"x", XUINT (c
));
3302 Lisp_Object dribblee
;
3304 /* If it's a structured event, take the event header. */
3305 dribblee
= EVENT_HEAD (c
);
3307 if (SYMBOLP (dribblee
))
3309 putc_unlocked ('<', dribble
);
3310 fwrite_unlocked (SDATA (SYMBOL_NAME (dribblee
)), sizeof (char),
3311 SBYTES (SYMBOL_NAME (dribblee
)),
3313 putc_unlocked ('>', dribble
);
3317 fflush_unlocked (dribble
);
3322 /* Copy out or in the info on where C-g should throw to.
3323 This is used when running Lisp code from within get_char,
3324 in case get_char is called recursively.
3325 See read_process_output. */
3328 save_getcjmp (sys_jmp_buf temp
)
3330 memcpy (temp
, getcjmp
, sizeof getcjmp
);
3334 restore_getcjmp (void *temp
)
3336 memcpy (getcjmp
, temp
, sizeof getcjmp
);
3339 /* Low level keyboard/mouse input.
3340 kbd_buffer_store_event places events in kbd_buffer, and
3341 kbd_buffer_get_event retrieves them. */
3343 /* Return true if there are any events in the queue that read-char
3344 would return. If this returns false, a read-char would block. */
3346 readable_events (int flags
)
3348 if (flags
& READABLE_EVENTS_DO_TIMERS_NOW
)
3351 /* If the buffer contains only FOCUS_IN_EVENT events, and
3352 READABLE_EVENTS_FILTER_EVENTS is set, report it as empty. */
3353 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3355 if (flags
& (READABLE_EVENTS_FILTER_EVENTS
3356 #ifdef USE_TOOLKIT_SCROLL_BARS
3357 | READABLE_EVENTS_IGNORE_SQUEEZABLES
3361 union buffered_input_event
*event
= kbd_fetch_ptr
;
3365 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3368 #ifdef USE_TOOLKIT_SCROLL_BARS
3369 (flags
& READABLE_EVENTS_FILTER_EVENTS
) &&
3371 event
->kind
== FOCUS_IN_EVENT
)
3372 #ifdef USE_TOOLKIT_SCROLL_BARS
3373 && !((flags
& READABLE_EVENTS_IGNORE_SQUEEZABLES
)
3374 && (event
->kind
== SCROLL_BAR_CLICK_EVENT
3375 || event
->kind
== HORIZONTAL_SCROLL_BAR_CLICK_EVENT
)
3376 && event
->ie
.part
== scroll_bar_handle
3377 && event
->ie
.modifiers
== 0)
3379 && !((flags
& READABLE_EVENTS_FILTER_EVENTS
)
3380 && event
->kind
== BUFFER_SWITCH_EVENT
))
3384 while (event
!= kbd_store_ptr
);
3390 if (!(flags
& READABLE_EVENTS_IGNORE_SQUEEZABLES
)
3391 && !NILP (do_mouse_tracking
) && some_mouse_moved ())
3395 if (current_kboard
->kbd_queue_has_data
)
3401 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
3402 if (kb
->kbd_queue_has_data
)
3408 /* Set this for debugging, to have a way to get out */
3409 int stop_character EXTERNALLY_VISIBLE
;
3412 event_to_kboard (struct input_event
*event
)
3414 /* Not applicable for these special events. */
3415 if (event
->kind
== SELECTION_REQUEST_EVENT
3416 || event
->kind
== SELECTION_CLEAR_EVENT
)
3420 Lisp_Object obj
= event
->frame_or_window
;
3421 /* There are some events that set this field to nil or string. */
3423 obj
= WINDOW_FRAME (XWINDOW (obj
));
3424 /* Also ignore dead frames here. */
3425 return ((FRAMEP (obj
) && FRAME_LIVE_P (XFRAME (obj
)))
3426 ? FRAME_KBOARD (XFRAME (obj
)) : NULL
);
3431 /* Return the number of slots occupied in kbd_buffer. */
3434 kbd_buffer_nr_stored (void)
3436 return kbd_fetch_ptr
== kbd_store_ptr
3438 : (kbd_fetch_ptr
< kbd_store_ptr
3439 ? kbd_store_ptr
- kbd_fetch_ptr
3440 : ((kbd_buffer
+ KBD_BUFFER_SIZE
) - kbd_fetch_ptr
3441 + (kbd_store_ptr
- kbd_buffer
)));
3443 #endif /* Store an event obtained at interrupt level into kbd_buffer, fifo */
3446 kbd_buffer_store_event (register struct input_event
*event
)
3448 kbd_buffer_store_event_hold (event
, 0);
3451 /* Store EVENT obtained at interrupt level into kbd_buffer, fifo.
3453 If HOLD_QUIT is 0, just stuff EVENT into the fifo.
3454 Else, if HOLD_QUIT.kind != NO_EVENT, discard EVENT.
3455 Else, if EVENT is a quit event, store the quit event
3456 in HOLD_QUIT, and return (thus ignoring further events).
3458 This is used to postpone the processing of the quit event until all
3459 subsequent input events have been parsed (and discarded). */
3462 kbd_buffer_store_buffered_event (union buffered_input_event
*event
,
3463 struct input_event
*hold_quit
)
3465 if (event
->kind
== NO_EVENT
)
3468 if (hold_quit
&& hold_quit
->kind
!= NO_EVENT
)
3471 if (event
->kind
== ASCII_KEYSTROKE_EVENT
)
3473 int c
= event
->ie
.code
& 0377;
3475 if (event
->ie
.modifiers
& ctrl_modifier
)
3476 c
= make_ctrl_char (c
);
3478 c
|= (event
->ie
.modifiers
3479 & (meta_modifier
| alt_modifier
3480 | hyper_modifier
| super_modifier
));
3484 KBOARD
*kb
= FRAME_KBOARD (XFRAME (event
->ie
.frame_or_window
));
3486 if (single_kboard
&& kb
!= current_kboard
)
3489 (kb
, list2 (make_lispy_switch_frame (event
->ie
.frame_or_window
),
3491 kb
->kbd_queue_has_data
= true;
3492 union buffered_input_event
*sp
;
3493 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3495 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3498 if (event_to_kboard (&sp
->ie
) == kb
)
3500 sp
->ie
.kind
= NO_EVENT
;
3501 sp
->ie
.frame_or_window
= Qnil
;
3510 *hold_quit
= event
->ie
;
3514 /* If this results in a quit_char being returned to Emacs as
3515 input, set Vlast_event_frame properly. If this doesn't
3516 get returned to Emacs as an event, the next event read
3517 will set Vlast_event_frame again, so this is safe to do. */
3521 focus
= FRAME_FOCUS_FRAME (XFRAME (event
->ie
.frame_or_window
));
3523 focus
= event
->ie
.frame_or_window
;
3524 internal_last_event_frame
= focus
;
3525 Vlast_event_frame
= focus
;
3528 handle_interrupt (0);
3532 if (c
&& c
== stop_character
)
3538 /* Don't insert two BUFFER_SWITCH_EVENT's in a row.
3539 Just ignore the second one. */
3540 else if (event
->kind
== BUFFER_SWITCH_EVENT
3541 && kbd_fetch_ptr
!= kbd_store_ptr
3542 && ((kbd_store_ptr
== kbd_buffer
3543 ? kbd_buffer
+ KBD_BUFFER_SIZE
- 1
3544 : kbd_store_ptr
- 1)->kind
) == BUFFER_SWITCH_EVENT
)
3547 if (kbd_store_ptr
- kbd_buffer
== KBD_BUFFER_SIZE
)
3548 kbd_store_ptr
= kbd_buffer
;
3550 /* Don't let the very last slot in the buffer become full,
3551 since that would make the two pointers equal,
3552 and that is indistinguishable from an empty buffer.
3553 Discard the event if it would fill the last slot. */
3554 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
3556 *kbd_store_ptr
= *event
;
3559 if (kbd_buffer_nr_stored () > KBD_BUFFER_SIZE
/ 2
3560 && ! kbd_on_hold_p ())
3562 /* Don't read keyboard input until we have processed kbd_buffer.
3563 This happens when pasting text longer than KBD_BUFFER_SIZE/2. */
3564 hold_keyboard_input ();
3568 #endif /* subprocesses */
3571 Lisp_Object ignore_event
;
3573 switch (event
->kind
)
3575 case FOCUS_IN_EVENT
: ignore_event
= Qfocus_in
; break;
3576 case FOCUS_OUT_EVENT
: ignore_event
= Qfocus_out
; break;
3577 case HELP_EVENT
: ignore_event
= Qhelp_echo
; break;
3578 case ICONIFY_EVENT
: ignore_event
= Qiconify_frame
; break;
3579 case DEICONIFY_EVENT
: ignore_event
= Qmake_frame_visible
; break;
3580 case SELECTION_REQUEST_EVENT
: ignore_event
= Qselection_request
; break;
3581 case BUFFER_SWITCH_EVENT
: ignore_event
= Qbuffer_switch
; break;
3582 default: ignore_event
= Qnil
; break;
3585 /* If we're inside while-no-input, and this event qualifies
3586 as input, set quit-flag to cause an interrupt. */
3587 if (!NILP (Vthrow_on_input
)
3588 && NILP (Fmemq (ignore_event
, Vwhile_no_input_ignore_events
)))
3589 Vquit_flag
= Vthrow_on_input
;
3595 /* Put a selection input event back in the head of the event queue. */
3598 kbd_buffer_unget_event (struct selection_input_event
*event
)
3600 if (kbd_fetch_ptr
== kbd_buffer
)
3601 kbd_fetch_ptr
= kbd_buffer
+ KBD_BUFFER_SIZE
;
3603 /* Don't let the very last slot in the buffer become full, */
3604 union buffered_input_event
*kp
= kbd_fetch_ptr
- 1;
3605 if (kp
!= kbd_store_ptr
)
3614 /* Limit help event positions to this range, to avoid overflow problems. */
3615 #define INPUT_EVENT_POS_MAX \
3616 ((ptrdiff_t) min (PTRDIFF_MAX, min (TYPE_MAXIMUM (Time) / 2, \
3617 MOST_POSITIVE_FIXNUM)))
3618 #define INPUT_EVENT_POS_MIN (-1 - INPUT_EVENT_POS_MAX)
3620 /* Return a Time that encodes position POS. POS must be in range. */
3623 position_to_Time (ptrdiff_t pos
)
3625 eassert (INPUT_EVENT_POS_MIN
<= pos
&& pos
<= INPUT_EVENT_POS_MAX
);
3629 /* Return the position that ENCODED_POS encodes.
3630 Avoid signed integer overflow. */
3633 Time_to_position (Time encoded_pos
)
3635 if (encoded_pos
<= INPUT_EVENT_POS_MAX
)
3637 Time encoded_pos_min
= INPUT_EVENT_POS_MIN
;
3638 eassert (encoded_pos_min
<= encoded_pos
);
3639 ptrdiff_t notpos
= -1 - encoded_pos
;
3643 /* Generate a HELP_EVENT input_event and store it in the keyboard
3646 HELP is the help form.
3648 FRAME and WINDOW are the frame and window where the help is
3649 generated. OBJECT is the Lisp object where the help was found (a
3650 buffer, a string, an overlay, or nil if neither from a string nor
3651 from a buffer). POS is the position within OBJECT where the help
3655 gen_help_event (Lisp_Object help
, Lisp_Object frame
, Lisp_Object window
,
3656 Lisp_Object object
, ptrdiff_t pos
)
3658 struct input_event event
;
3660 event
.kind
= HELP_EVENT
;
3661 event
.frame_or_window
= frame
;
3663 event
.x
= WINDOWP (window
) ? window
: frame
;
3665 event
.timestamp
= position_to_Time (pos
);
3666 kbd_buffer_store_event (&event
);
3670 /* Store HELP_EVENTs for HELP on FRAME in the input queue. */
3673 kbd_buffer_store_help_event (Lisp_Object frame
, Lisp_Object help
)
3675 struct input_event event
;
3677 event
.kind
= HELP_EVENT
;
3678 event
.frame_or_window
= frame
;
3682 event
.timestamp
= 0;
3683 kbd_buffer_store_event (&event
);
3687 /* Discard any mouse events in the event buffer by setting them to
3690 discard_mouse_events (void)
3692 union buffered_input_event
*sp
;
3693 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3695 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3698 if (sp
->kind
== MOUSE_CLICK_EVENT
3699 || sp
->kind
== WHEEL_EVENT
3700 || sp
->kind
== HORIZ_WHEEL_EVENT
3702 || sp
->kind
== GPM_CLICK_EVENT
3704 || sp
->kind
== SCROLL_BAR_CLICK_EVENT
3705 || sp
->kind
== HORIZONTAL_SCROLL_BAR_CLICK_EVENT
)
3707 sp
->kind
= NO_EVENT
;
3713 /* Return true if there are any real events waiting in the event
3714 buffer, not counting `NO_EVENT's.
3716 Discard NO_EVENT events at the front of the input queue, possibly
3717 leaving the input queue empty if there are no real input events. */
3720 kbd_buffer_events_waiting (void)
3722 union buffered_input_event
*sp
;
3724 for (sp
= kbd_fetch_ptr
;
3725 sp
!= kbd_store_ptr
&& sp
->kind
== NO_EVENT
;
3728 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3733 return sp
!= kbd_store_ptr
&& sp
->kind
!= NO_EVENT
;
3737 /* Clear input event EVENT. */
3740 clear_event (union buffered_input_event
*event
)
3742 event
->kind
= NO_EVENT
;
3746 /* Read one event from the event buffer, waiting if necessary.
3747 The value is a Lisp object representing the event.
3748 The value is nil for an event that should be ignored,
3749 or that was handled here.
3750 We always read and discard one event. */
3753 kbd_buffer_get_event (KBOARD
**kbp
,
3754 bool *used_mouse_menu
,
3755 struct timespec
*end_time
)
3760 if (kbd_on_hold_p () && kbd_buffer_nr_stored () < KBD_BUFFER_SIZE
/ 4)
3762 /* Start reading input again because we have processed enough to
3763 be able to accept new events again. */
3764 unhold_keyboard_input ();
3768 #endif /* subprocesses */
3770 #if !defined HAVE_DBUS && !defined USE_FILE_NOTIFY
3772 /* In case we are running as a daemon, only do this before
3773 detaching from the terminal. */
3774 || (IS_DAEMON
&& DAEMON_RUNNING
))
3776 int c
= getchar_unlocked ();
3778 *kbp
= current_kboard
;
3781 #endif /* !defined HAVE_DBUS && !defined USE_FILE_NOTIFY */
3783 /* Wait until there is input available. */
3786 /* Break loop if there's an unread command event. Needed in
3787 moused window autoselection which uses a timer to insert such
3789 if (CONSP (Vunread_command_events
))
3792 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3794 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3797 /* If the quit flag is set, then read_char will return
3798 quit_char, so that counts as "available input." */
3799 if (!NILP (Vquit_flag
))
3800 quit_throw_to_read_char (0);
3802 /* One way or another, wait until input is available; then, if
3803 interrupt handlers have not read it, read it now. */
3808 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3810 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3814 struct timespec now
= current_timespec ();
3815 if (timespec_cmp (*end_time
, now
) <= 0)
3816 return Qnil
; /* Finished waiting. */
3819 struct timespec duration
= timespec_sub (*end_time
, now
);
3820 wait_reading_process_output (min (duration
.tv_sec
,
3823 -1, 1, Qnil
, NULL
, 0);
3828 bool do_display
= true;
3830 if (FRAME_TERMCAP_P (SELECTED_FRAME ()))
3832 struct tty_display_info
*tty
= CURTTY ();
3834 /* When this TTY is displaying a menu, we must prevent
3835 any redisplay, because we modify the frame's glyph
3836 matrix behind the back of the display engine. */
3837 if (tty
->showing_menu
)
3841 wait_reading_process_output (0, 0, -1, do_display
, Qnil
, NULL
, 0);
3844 if (!interrupt_input
&& kbd_fetch_ptr
== kbd_store_ptr
)
3848 if (CONSP (Vunread_command_events
))
3851 first
= XCAR (Vunread_command_events
);
3852 Vunread_command_events
= XCDR (Vunread_command_events
);
3853 *kbp
= current_kboard
;
3857 /* At this point, we know that there is a readable event available
3858 somewhere. If the event queue is empty, then there must be a
3859 mouse movement enabled and available. */
3860 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3862 union buffered_input_event
*event
;
3864 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
3868 *kbp
= event_to_kboard (&event
->ie
);
3870 *kbp
= current_kboard
; /* Better than returning null ptr? */
3874 /* These two kinds of events get special handling
3875 and don't actually appear to the command loop.
3876 We return nil for them. */
3877 if (event
->kind
== SELECTION_REQUEST_EVENT
3878 || event
->kind
== SELECTION_CLEAR_EVENT
)
3881 /* Remove it from the buffer before processing it,
3882 since otherwise swallow_events will see it
3883 and process it again. */
3884 struct selection_input_event copy
= event
->sie
;
3885 kbd_fetch_ptr
= event
+ 1;
3886 input_pending
= readable_events (0);
3887 x_handle_selection_event (©
);
3889 /* We're getting selection request events, but we don't have
3895 #if defined (HAVE_NS)
3896 else if (event
->kind
== NS_TEXT_EVENT
)
3898 if (event
->ie
.code
== KEY_NS_PUT_WORKING_TEXT
)
3899 obj
= list1 (intern ("ns-put-working-text"));
3901 obj
= list1 (intern ("ns-unput-working-text"));
3902 kbd_fetch_ptr
= event
+ 1;
3903 if (used_mouse_menu
)
3904 *used_mouse_menu
= true;
3908 #if defined (HAVE_X11) || defined (HAVE_NTGUI) \
3909 || defined (HAVE_NS)
3910 else if (event
->kind
== DELETE_WINDOW_EVENT
)
3912 /* Make an event (delete-frame (FRAME)). */
3913 obj
= list2 (Qdelete_frame
, list1 (event
->ie
.frame_or_window
));
3914 kbd_fetch_ptr
= event
+ 1;
3919 else if (event
->kind
== END_SESSION_EVENT
)
3921 /* Make an event (end-session). */
3922 obj
= list1 (Qend_session
);
3923 kbd_fetch_ptr
= event
+ 1;
3927 #if defined (HAVE_X11) || defined (HAVE_NTGUI) \
3928 || defined (HAVE_NS)
3929 else if (event
->kind
== ICONIFY_EVENT
)
3931 /* Make an event (iconify-frame (FRAME)). */
3932 obj
= list2 (Qiconify_frame
, list1 (event
->ie
.frame_or_window
));
3933 kbd_fetch_ptr
= event
+ 1;
3935 else if (event
->kind
== DEICONIFY_EVENT
)
3937 /* Make an event (make-frame-visible (FRAME)). */
3938 obj
= list2 (Qmake_frame_visible
, list1 (event
->ie
.frame_or_window
));
3939 kbd_fetch_ptr
= event
+ 1;
3942 else if (event
->kind
== BUFFER_SWITCH_EVENT
)
3944 /* The value doesn't matter here; only the type is tested. */
3945 XSETBUFFER (obj
, current_buffer
);
3946 kbd_fetch_ptr
= event
+ 1;
3948 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
3949 || defined (HAVE_NS) || defined (USE_GTK)
3950 else if (event
->kind
== MENU_BAR_ACTIVATE_EVENT
)
3952 kbd_fetch_ptr
= event
+ 1;
3953 input_pending
= readable_events (0);
3954 if (FRAME_LIVE_P (XFRAME (event
->ie
.frame_or_window
)))
3955 x_activate_menubar (XFRAME (event
->ie
.frame_or_window
));
3959 else if (event
->kind
== LANGUAGE_CHANGE_EVENT
)
3961 /* Make an event (language-change FRAME CODEPAGE LANGUAGE-ID). */
3962 obj
= list4 (Qlanguage_change
,
3963 event
->ie
.frame_or_window
,
3964 make_number (event
->ie
.code
),
3965 make_number (event
->ie
.modifiers
));
3966 kbd_fetch_ptr
= event
+ 1;
3969 #ifdef USE_FILE_NOTIFY
3970 else if (event
->kind
== FILE_NOTIFY_EVENT
)
3972 #ifdef HAVE_W32NOTIFY
3973 /* Make an event (file-notify (DESCRIPTOR ACTION FILE) CALLBACK). */
3974 obj
= list3 (Qfile_notify
, event
->ie
.arg
, event
->ie
.frame_or_window
);
3976 obj
= make_lispy_event (&event
->ie
);
3978 kbd_fetch_ptr
= event
+ 1;
3980 #endif /* USE_FILE_NOTIFY */
3981 else if (event
->kind
== SAVE_SESSION_EVENT
)
3983 obj
= list2 (Qsave_session
, event
->ie
.arg
);
3984 kbd_fetch_ptr
= event
+ 1;
3986 /* Just discard these, by returning nil.
3987 With MULTI_KBOARD, these events are used as placeholders
3988 when we need to randomly delete events from the queue.
3989 (They shouldn't otherwise be found in the buffer,
3990 but on some machines it appears they do show up
3991 even without MULTI_KBOARD.) */
3992 /* On Windows NT/9X, NO_EVENT is used to delete extraneous
3993 mouse events during a popup-menu call. */
3994 else if (event
->kind
== NO_EVENT
)
3995 kbd_fetch_ptr
= event
+ 1;
3996 else if (event
->kind
== HELP_EVENT
)
3998 Lisp_Object object
, position
, help
, frame
, window
;
4000 frame
= event
->ie
.frame_or_window
;
4001 object
= event
->ie
.arg
;
4002 position
= make_number (Time_to_position (event
->ie
.timestamp
));
4003 window
= event
->ie
.x
;
4005 clear_event (event
);
4007 kbd_fetch_ptr
= event
+ 1;
4008 if (!WINDOWP (window
))
4010 obj
= Fcons (Qhelp_echo
,
4011 list5 (frame
, help
, window
, object
, position
));
4013 else if (event
->kind
== FOCUS_IN_EVENT
)
4015 /* Notification of a FocusIn event. The frame receiving the
4016 focus is in event->frame_or_window. Generate a
4017 switch-frame event if necessary. */
4018 Lisp_Object frame
, focus
;
4020 frame
= event
->ie
.frame_or_window
;
4021 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
4027 ! NILP (event
->ie
.arg
)
4030 !EQ (frame
, internal_last_event_frame
)
4031 && !EQ (frame
, selected_frame
))
4032 obj
= make_lispy_switch_frame (frame
);
4034 obj
= make_lispy_focus_in (frame
);
4036 internal_last_event_frame
= frame
;
4037 kbd_fetch_ptr
= event
+ 1;
4039 else if (event
->kind
== FOCUS_OUT_EVENT
)
4041 #ifdef HAVE_WINDOW_SYSTEM
4044 Lisp_Object frame
= event
->ie
.frame_or_window
;
4045 bool focused
= false;
4047 for (di
= x_display_list
; di
&& ! focused
; di
= di
->next
)
4048 focused
= di
->x_highlight_frame
!= 0;
4051 obj
= make_lispy_focus_out (frame
);
4053 #endif /* HAVE_WINDOW_SYSTEM */
4055 kbd_fetch_ptr
= event
+ 1;
4058 else if (event
->kind
== DBUS_EVENT
)
4060 obj
= make_lispy_event (&event
->ie
);
4061 kbd_fetch_ptr
= event
+ 1;
4064 #if defined (HAVE_X11) || defined (HAVE_NTGUI) || defined (HAVE_NS)
4065 else if (event
->kind
== MOVE_FRAME_EVENT
)
4067 /* Make an event (move-frame (FRAME)). */
4068 obj
= list2 (Qmove_frame
, list1 (event
->ie
.frame_or_window
));
4069 kbd_fetch_ptr
= event
+ 1;
4072 #ifdef HAVE_XWIDGETS
4073 else if (event
->kind
== XWIDGET_EVENT
)
4075 obj
= make_lispy_event (&event
->ie
);
4076 kbd_fetch_ptr
= event
+ 1;
4079 else if (event
->kind
== CONFIG_CHANGED_EVENT
)
4081 obj
= make_lispy_event (&event
->ie
);
4082 kbd_fetch_ptr
= event
+ 1;
4084 else if (event
->kind
== SELECT_WINDOW_EVENT
)
4086 obj
= list2 (Qselect_window
, list1 (event
->ie
.frame_or_window
));
4087 kbd_fetch_ptr
= event
+ 1;
4091 /* If this event is on a different frame, return a switch-frame this
4092 time, and leave the event in the queue for next time. */
4096 frame
= event
->ie
.frame_or_window
;
4098 frame
= XCAR (frame
);
4099 else if (WINDOWP (frame
))
4100 frame
= WINDOW_FRAME (XWINDOW (frame
));
4102 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
4106 if (! EQ (frame
, internal_last_event_frame
)
4107 && !EQ (frame
, selected_frame
))
4108 obj
= make_lispy_switch_frame (frame
);
4109 internal_last_event_frame
= frame
;
4111 /* If we didn't decide to make a switch-frame event, go ahead
4112 and build a real event from the queue entry. */
4116 obj
= make_lispy_event (&event
->ie
);
4118 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
4119 || defined (HAVE_NS) || defined (USE_GTK)
4120 /* If this was a menu selection, then set the flag to inhibit
4121 writing to last_nonmenu_event. Don't do this if the event
4122 we're returning is (menu-bar), though; that indicates the
4123 beginning of the menu sequence, and we might as well leave
4124 that as the `event with parameters' for this selection. */
4126 && !EQ (event
->ie
.frame_or_window
, event
->ie
.arg
)
4127 && (event
->kind
== MENU_BAR_EVENT
4128 || event
->kind
== TOOL_BAR_EVENT
))
4129 *used_mouse_menu
= true;
4132 /* Certain system events are non-key events. */
4134 && event
->kind
== NS_NONKEY_EVENT
)
4135 *used_mouse_menu
= true;
4138 /* Wipe out this event, to catch bugs. */
4139 clear_event (event
);
4140 kbd_fetch_ptr
= event
+ 1;
4144 /* Try generating a mouse motion event. */
4145 else if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
4147 struct frame
*f
= some_mouse_moved ();
4148 Lisp_Object bar_window
;
4149 enum scroll_bar_part part
;
4153 *kbp
= current_kboard
;
4154 /* Note that this uses F to determine which terminal to look at.
4155 If there is no valid info, it does not store anything
4156 so x remains nil. */
4159 /* XXX Can f or mouse_position_hook be NULL here? */
4160 if (f
&& FRAME_TERMINAL (f
)->mouse_position_hook
)
4161 (*FRAME_TERMINAL (f
)->mouse_position_hook
) (&f
, 0, &bar_window
,
4166 /* Decide if we should generate a switch-frame event. Don't
4167 generate switch-frame events for motion outside of all Emacs
4173 frame
= FRAME_FOCUS_FRAME (f
);
4175 XSETFRAME (frame
, f
);
4177 if (! EQ (frame
, internal_last_event_frame
)
4178 && !EQ (frame
, selected_frame
))
4179 obj
= make_lispy_switch_frame (frame
);
4180 internal_last_event_frame
= frame
;
4183 /* If we didn't decide to make a switch-frame event, go ahead and
4184 return a mouse-motion event. */
4185 if (!NILP (x
) && NILP (obj
))
4186 obj
= make_lispy_movement (f
, bar_window
, part
, x
, y
, t
);
4189 /* We were promised by the above while loop that there was
4190 something for us to read! */
4193 input_pending
= readable_events (0);
4195 Vlast_event_frame
= internal_last_event_frame
;
4200 /* Process any non-user-visible events (currently X selection events),
4201 without reading any user-visible events. */
4204 process_special_events (void)
4206 union buffered_input_event
*event
;
4208 for (event
= kbd_fetch_ptr
; event
!= kbd_store_ptr
; ++event
)
4210 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
4213 if (event
== kbd_store_ptr
)
4217 /* If we find a stored X selection request, handle it now. */
4218 if (event
->kind
== SELECTION_REQUEST_EVENT
4219 || event
->kind
== SELECTION_CLEAR_EVENT
)
4223 /* Remove the event from the fifo buffer before processing;
4224 otherwise swallow_events called recursively could see it
4225 and process it again. To do this, we move the events
4226 between kbd_fetch_ptr and EVENT one slot to the right,
4229 struct selection_input_event copy
= event
->sie
;
4230 union buffered_input_event
*beg
4231 = (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
4232 ? kbd_buffer
: kbd_fetch_ptr
;
4235 memmove (beg
+ 1, beg
, (event
- beg
) * sizeof *beg
);
4236 else if (event
< beg
)
4238 if (event
> kbd_buffer
)
4239 memmove (kbd_buffer
+ 1, kbd_buffer
,
4240 (event
- kbd_buffer
) * sizeof *kbd_buffer
);
4241 *kbd_buffer
= *(kbd_buffer
+ KBD_BUFFER_SIZE
- 1);
4242 if (beg
< kbd_buffer
+ KBD_BUFFER_SIZE
- 1)
4243 memmove (beg
+ 1, beg
,
4244 (kbd_buffer
+ KBD_BUFFER_SIZE
- 1 - beg
) * sizeof *beg
);
4247 if (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
4248 kbd_fetch_ptr
= kbd_buffer
+ 1;
4252 input_pending
= readable_events (0);
4253 x_handle_selection_event (©
);
4255 /* We're getting selection request events, but we don't have
4263 /* Process any events that are not user-visible, run timer events that
4264 are ripe, and return, without reading any user-visible events. */
4267 swallow_events (bool do_display
)
4269 unsigned old_timers_run
;
4271 process_special_events ();
4273 old_timers_run
= timers_run
;
4274 get_input_pending (READABLE_EVENTS_DO_TIMERS_NOW
);
4276 if (!input_pending
&& timers_run
!= old_timers_run
&& do_display
)
4277 redisplay_preserve_echo_area (7);
4280 /* Record the start of when Emacs is idle,
4281 for the sake of running idle-time timers. */
4284 timer_start_idle (void)
4286 /* If we are already in the idle state, do nothing. */
4287 if (timespec_valid_p (timer_idleness_start_time
))
4290 timer_idleness_start_time
= current_timespec ();
4291 timer_last_idleness_start_time
= timer_idleness_start_time
;
4293 /* Mark all idle-time timers as once again candidates for running. */
4294 call0 (intern ("internal-timer-start-idle"));
4297 /* Record that Emacs is no longer idle, so stop running idle-time timers. */
4300 timer_stop_idle (void)
4302 timer_idleness_start_time
= invalid_timespec ();
4305 /* Resume idle timer from last idle start time. */
4308 timer_resume_idle (void)
4310 if (timespec_valid_p (timer_idleness_start_time
))
4313 timer_idleness_start_time
= timer_last_idleness_start_time
;
4316 /* List of elisp functions to call, delayed because they were generated in
4317 a context where Elisp could not be safely run (e.g. redisplay, signal,
4318 ...). Each element has the form (FUN . ARGS). */
4319 Lisp_Object pending_funcalls
;
4321 /* Return true if TIMER is a valid timer, placing its value into *RESULT. */
4323 decode_timer (Lisp_Object timer
, struct timespec
*result
)
4327 if (! (VECTORP (timer
) && ASIZE (timer
) == 9))
4329 vec
= XVECTOR (timer
)->contents
;
4330 if (! NILP (vec
[0]))
4332 if (! INTEGERP (vec
[2]))
4336 if (decode_time_components (vec
[1], vec
[2], vec
[3], vec
[8], &t
, 0) <= 0)
4338 *result
= lisp_to_timespec (t
);
4339 return timespec_valid_p (*result
);
4343 /* Check whether a timer has fired. To prevent larger problems we simply
4344 disregard elements that are not proper timers. Do not make a circular
4345 timer list for the time being.
4347 Returns the time to wait until the next timer fires. If a
4348 timer is triggering now, return zero.
4349 If no timer is active, return -1.
4351 If a timer is ripe, we run it, with quitting turned off.
4352 In that case we return 0 to indicate that a new timer_check_2 call
4355 static struct timespec
4356 timer_check_2 (Lisp_Object timers
, Lisp_Object idle_timers
)
4358 struct timespec nexttime
;
4359 struct timespec now
;
4360 struct timespec idleness_now
;
4361 Lisp_Object chosen_timer
;
4363 nexttime
= invalid_timespec ();
4365 chosen_timer
= Qnil
;
4367 /* First run the code that was delayed. */
4368 while (CONSP (pending_funcalls
))
4370 Lisp_Object funcall
= XCAR (pending_funcalls
);
4371 pending_funcalls
= XCDR (pending_funcalls
);
4372 safe_call2 (Qapply
, XCAR (funcall
), XCDR (funcall
));
4375 if (CONSP (timers
) || CONSP (idle_timers
))
4377 now
= current_timespec ();
4378 idleness_now
= (timespec_valid_p (timer_idleness_start_time
)
4379 ? timespec_sub (now
, timer_idleness_start_time
)
4380 : make_timespec (0, 0));
4383 while (CONSP (timers
) || CONSP (idle_timers
))
4385 Lisp_Object timer
= Qnil
, idle_timer
= Qnil
;
4386 struct timespec timer_time
, idle_timer_time
;
4387 struct timespec difference
;
4388 struct timespec timer_difference
= invalid_timespec ();
4389 struct timespec idle_timer_difference
= invalid_timespec ();
4390 bool ripe
, timer_ripe
= 0, idle_timer_ripe
= 0;
4392 /* Set TIMER and TIMER_DIFFERENCE
4393 based on the next ordinary timer.
4394 TIMER_DIFFERENCE is the distance in time from NOW to when
4395 this timer becomes ripe.
4396 Skip past invalid timers and timers already handled. */
4399 timer
= XCAR (timers
);
4400 if (! decode_timer (timer
, &timer_time
))
4402 timers
= XCDR (timers
);
4406 timer_ripe
= timespec_cmp (timer_time
, now
) <= 0;
4407 timer_difference
= (timer_ripe
4408 ? timespec_sub (now
, timer_time
)
4409 : timespec_sub (timer_time
, now
));
4412 /* Likewise for IDLE_TIMER and IDLE_TIMER_DIFFERENCE
4413 based on the next idle timer. */
4414 if (CONSP (idle_timers
))
4416 idle_timer
= XCAR (idle_timers
);
4417 if (! decode_timer (idle_timer
, &idle_timer_time
))
4419 idle_timers
= XCDR (idle_timers
);
4423 idle_timer_ripe
= timespec_cmp (idle_timer_time
, idleness_now
) <= 0;
4424 idle_timer_difference
4426 ? timespec_sub (idleness_now
, idle_timer_time
)
4427 : timespec_sub (idle_timer_time
, idleness_now
));
4430 /* Decide which timer is the next timer,
4431 and set CHOSEN_TIMER, DIFFERENCE, and RIPE accordingly.
4432 Also step down the list where we found that timer. */
4434 if (timespec_valid_p (timer_difference
)
4435 && (! timespec_valid_p (idle_timer_difference
)
4436 || idle_timer_ripe
< timer_ripe
4437 || (idle_timer_ripe
== timer_ripe
4439 ? timespec_cmp (idle_timer_difference
,
4441 : timespec_cmp (timer_difference
,
4442 idle_timer_difference
))
4445 chosen_timer
= timer
;
4446 timers
= XCDR (timers
);
4447 difference
= timer_difference
;
4452 chosen_timer
= idle_timer
;
4453 idle_timers
= XCDR (idle_timers
);
4454 difference
= idle_timer_difference
;
4455 ripe
= idle_timer_ripe
;
4458 /* If timer is ripe, run it if it hasn't been run. */
4461 if (NILP (AREF (chosen_timer
, 0)))
4463 ptrdiff_t count
= SPECPDL_INDEX ();
4464 Lisp_Object old_deactivate_mark
= Vdeactivate_mark
;
4466 /* Mark the timer as triggered to prevent problems if the lisp
4467 code fails to reschedule it right. */
4468 ASET (chosen_timer
, 0, Qt
);
4470 specbind (Qinhibit_quit
, Qt
);
4472 call1 (Qtimer_event_handler
, chosen_timer
);
4473 Vdeactivate_mark
= old_deactivate_mark
;
4475 unbind_to (count
, Qnil
);
4477 /* Since we have handled the event,
4478 we don't need to tell the caller to wake up and do it. */
4479 /* But the caller must still wait for the next timer, so
4480 return 0 to indicate that. */
4483 nexttime
= make_timespec (0, 0);
4487 /* When we encounter a timer that is still waiting,
4488 return the amount of time to wait before it is ripe. */
4494 /* No timers are pending in the future. */
4495 /* Return 0 if we generated an event, and -1 if not. */
4500 /* Check whether a timer has fired. To prevent larger problems we simply
4501 disregard elements that are not proper timers. Do not make a circular
4502 timer list for the time being.
4504 Returns the time to wait until the next timer fires.
4505 If no timer is active, return an invalid value.
4507 As long as any timer is ripe, we run it. */
4512 struct timespec nexttime
;
4513 Lisp_Object timers
, idle_timers
;
4515 Lisp_Object tem
= Vinhibit_quit
;
4518 /* We use copies of the timers' lists to allow a timer to add itself
4519 again, without locking up Emacs if the newly added timer is
4520 already ripe when added. */
4522 /* Always consider the ordinary timers. */
4523 timers
= Fcopy_sequence (Vtimer_list
);
4524 /* Consider the idle timers only if Emacs is idle. */
4525 if (timespec_valid_p (timer_idleness_start_time
))
4526 idle_timers
= Fcopy_sequence (Vtimer_idle_list
);
4530 Vinhibit_quit
= tem
;
4534 nexttime
= timer_check_2 (timers
, idle_timers
);
4536 while (nexttime
.tv_sec
== 0 && nexttime
.tv_nsec
== 0);
4541 DEFUN ("current-idle-time", Fcurrent_idle_time
, Scurrent_idle_time
, 0, 0, 0,
4542 doc
: /* Return the current length of Emacs idleness, or nil.
4543 The value when Emacs is idle is a list of four integers (HIGH LOW USEC PSEC)
4544 in the same style as (current-time).
4546 The value when Emacs is not idle is nil.
4548 PSEC is a multiple of the system clock resolution. */)
4551 if (timespec_valid_p (timer_idleness_start_time
))
4552 return make_lisp_time (timespec_sub (current_timespec (),
4553 timer_idleness_start_time
));
4558 /* Caches for modify_event_symbol. */
4559 static Lisp_Object accent_key_syms
;
4560 static Lisp_Object func_key_syms
;
4561 static Lisp_Object mouse_syms
;
4562 static Lisp_Object wheel_syms
;
4563 static Lisp_Object drag_n_drop_syms
;
4565 /* This is a list of keysym codes for special "accent" characters.
4566 It parallels lispy_accent_keys. */
4568 static const int lispy_accent_codes
[] =
4570 #ifdef XK_dead_circumflex
4575 #ifdef XK_dead_grave
4580 #ifdef XK_dead_tilde
4585 #ifdef XK_dead_diaeresis
4590 #ifdef XK_dead_macron
4595 #ifdef XK_dead_degree
4600 #ifdef XK_dead_acute
4605 #ifdef XK_dead_cedilla
4610 #ifdef XK_dead_breve
4615 #ifdef XK_dead_ogonek
4620 #ifdef XK_dead_caron
4625 #ifdef XK_dead_doubleacute
4626 XK_dead_doubleacute
,
4630 #ifdef XK_dead_abovedot
4635 #ifdef XK_dead_abovering
4645 #ifdef XK_dead_belowdot
4650 #ifdef XK_dead_voiced_sound
4651 XK_dead_voiced_sound
,
4655 #ifdef XK_dead_semivoiced_sound
4656 XK_dead_semivoiced_sound
,
4672 /* This is a list of Lisp names for special "accent" characters.
4673 It parallels lispy_accent_codes. */
4675 static const char *const lispy_accent_keys
[] =
4693 "dead-voiced-sound",
4694 "dead-semivoiced-sound",
4700 #define FUNCTION_KEY_OFFSET 0x0
4702 const char *const lispy_function_keys
[] =
4706 0, /* VK_LBUTTON 0x01 */
4707 0, /* VK_RBUTTON 0x02 */
4708 "cancel", /* VK_CANCEL 0x03 */
4709 0, /* VK_MBUTTON 0x04 */
4711 0, 0, 0, /* 0x05 .. 0x07 */
4713 "backspace", /* VK_BACK 0x08 */
4714 "tab", /* VK_TAB 0x09 */
4716 0, 0, /* 0x0A .. 0x0B */
4718 "clear", /* VK_CLEAR 0x0C */
4719 "return", /* VK_RETURN 0x0D */
4721 0, 0, /* 0x0E .. 0x0F */
4723 0, /* VK_SHIFT 0x10 */
4724 0, /* VK_CONTROL 0x11 */
4725 0, /* VK_MENU 0x12 */
4726 "pause", /* VK_PAUSE 0x13 */
4727 "capslock", /* VK_CAPITAL 0x14 */
4728 "kana", /* VK_KANA/VK_HANGUL 0x15 */
4730 "junja", /* VK_JUNJA 0x17 */
4731 "final", /* VK_FINAL 0x18 */
4732 "kanji", /* VK_KANJI/VK_HANJA 0x19 */
4734 "escape", /* VK_ESCAPE 0x1B */
4735 "convert", /* VK_CONVERT 0x1C */
4736 "non-convert", /* VK_NONCONVERT 0x1D */
4737 "accept", /* VK_ACCEPT 0x1E */
4738 "mode-change", /* VK_MODECHANGE 0x1F */
4739 0, /* VK_SPACE 0x20 */
4740 "prior", /* VK_PRIOR 0x21 */
4741 "next", /* VK_NEXT 0x22 */
4742 "end", /* VK_END 0x23 */
4743 "home", /* VK_HOME 0x24 */
4744 "left", /* VK_LEFT 0x25 */
4745 "up", /* VK_UP 0x26 */
4746 "right", /* VK_RIGHT 0x27 */
4747 "down", /* VK_DOWN 0x28 */
4748 "select", /* VK_SELECT 0x29 */
4749 "print", /* VK_PRINT 0x2A */
4750 "execute", /* VK_EXECUTE 0x2B */
4751 "snapshot", /* VK_SNAPSHOT 0x2C */
4752 "insert", /* VK_INSERT 0x2D */
4753 "delete", /* VK_DELETE 0x2E */
4754 "help", /* VK_HELP 0x2F */
4756 /* VK_0 thru VK_9 are the same as ASCII '0' thru '9' (0x30 - 0x39) */
4758 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4760 0, 0, 0, 0, 0, 0, 0, /* 0x3A .. 0x40 */
4762 /* VK_A thru VK_Z are the same as ASCII 'A' thru 'Z' (0x41 - 0x5A) */
4764 0, 0, 0, 0, 0, 0, 0, 0, 0,
4765 0, 0, 0, 0, 0, 0, 0, 0, 0,
4766 0, 0, 0, 0, 0, 0, 0, 0,
4768 "lwindow", /* VK_LWIN 0x5B */
4769 "rwindow", /* VK_RWIN 0x5C */
4770 "apps", /* VK_APPS 0x5D */
4773 "kp-0", /* VK_NUMPAD0 0x60 */
4774 "kp-1", /* VK_NUMPAD1 0x61 */
4775 "kp-2", /* VK_NUMPAD2 0x62 */
4776 "kp-3", /* VK_NUMPAD3 0x63 */
4777 "kp-4", /* VK_NUMPAD4 0x64 */
4778 "kp-5", /* VK_NUMPAD5 0x65 */
4779 "kp-6", /* VK_NUMPAD6 0x66 */
4780 "kp-7", /* VK_NUMPAD7 0x67 */
4781 "kp-8", /* VK_NUMPAD8 0x68 */
4782 "kp-9", /* VK_NUMPAD9 0x69 */
4783 "kp-multiply", /* VK_MULTIPLY 0x6A */
4784 "kp-add", /* VK_ADD 0x6B */
4785 "kp-separator", /* VK_SEPARATOR 0x6C */
4786 "kp-subtract", /* VK_SUBTRACT 0x6D */
4787 "kp-decimal", /* VK_DECIMAL 0x6E */
4788 "kp-divide", /* VK_DIVIDE 0x6F */
4789 "f1", /* VK_F1 0x70 */
4790 "f2", /* VK_F2 0x71 */
4791 "f3", /* VK_F3 0x72 */
4792 "f4", /* VK_F4 0x73 */
4793 "f5", /* VK_F5 0x74 */
4794 "f6", /* VK_F6 0x75 */
4795 "f7", /* VK_F7 0x76 */
4796 "f8", /* VK_F8 0x77 */
4797 "f9", /* VK_F9 0x78 */
4798 "f10", /* VK_F10 0x79 */
4799 "f11", /* VK_F11 0x7A */
4800 "f12", /* VK_F12 0x7B */
4801 "f13", /* VK_F13 0x7C */
4802 "f14", /* VK_F14 0x7D */
4803 "f15", /* VK_F15 0x7E */
4804 "f16", /* VK_F16 0x7F */
4805 "f17", /* VK_F17 0x80 */
4806 "f18", /* VK_F18 0x81 */
4807 "f19", /* VK_F19 0x82 */
4808 "f20", /* VK_F20 0x83 */
4809 "f21", /* VK_F21 0x84 */
4810 "f22", /* VK_F22 0x85 */
4811 "f23", /* VK_F23 0x86 */
4812 "f24", /* VK_F24 0x87 */
4814 0, 0, 0, 0, /* 0x88 .. 0x8B */
4815 0, 0, 0, 0, /* 0x8C .. 0x8F */
4817 "kp-numlock", /* VK_NUMLOCK 0x90 */
4818 "scroll", /* VK_SCROLL 0x91 */
4819 /* Not sure where the following block comes from.
4820 Windows headers have NEC and Fujitsu specific keys in
4821 this block, but nothing generic. */
4822 "kp-space", /* VK_NUMPAD_CLEAR 0x92 */
4823 "kp-enter", /* VK_NUMPAD_ENTER 0x93 */
4824 "kp-prior", /* VK_NUMPAD_PRIOR 0x94 */
4825 "kp-next", /* VK_NUMPAD_NEXT 0x95 */
4826 "kp-end", /* VK_NUMPAD_END 0x96 */
4827 "kp-home", /* VK_NUMPAD_HOME 0x97 */
4828 "kp-left", /* VK_NUMPAD_LEFT 0x98 */
4829 "kp-up", /* VK_NUMPAD_UP 0x99 */
4830 "kp-right", /* VK_NUMPAD_RIGHT 0x9A */
4831 "kp-down", /* VK_NUMPAD_DOWN 0x9B */
4832 "kp-insert", /* VK_NUMPAD_INSERT 0x9C */
4833 "kp-delete", /* VK_NUMPAD_DELETE 0x9D */
4835 0, 0, /* 0x9E .. 0x9F */
4838 * VK_L* & VK_R* - left and right Alt, Ctrl and Shift virtual keys.
4839 * Used only as parameters to GetAsyncKeyState and GetKeyState.
4840 * No other API or message will distinguish left and right keys this way.
4845 /* Multimedia keys. These are handled as WM_APPCOMMAND, which allows us
4846 to enable them selectively, and gives access to a few more functions.
4847 See lispy_multimedia_keys below. */
4848 0, 0, 0, 0, 0, 0, 0, /* 0xA6 .. 0xAC Browser */
4849 0, 0, 0, /* 0xAD .. 0xAF Volume */
4850 0, 0, 0, 0, /* 0xB0 .. 0xB3 Media */
4851 0, 0, 0, 0, /* 0xB4 .. 0xB7 Apps */
4853 /* 0xB8 .. 0xC0 "OEM" keys - all seem to be punctuation. */
4854 0, 0, 0, 0, 0, 0, 0, 0, 0,
4856 /* 0xC1 - 0xDA unallocated, 0xDB-0xDF more OEM keys */
4857 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4858 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4861 "ax", /* VK_OEM_AX 0xE1 */
4862 0, /* VK_OEM_102 0xE2 */
4863 "ico-help", /* VK_ICO_HELP 0xE3 */
4864 "ico-00", /* VK_ICO_00 0xE4 */
4865 0, /* VK_PROCESSKEY 0xE5 - used by IME */
4866 "ico-clear", /* VK_ICO_CLEAR 0xE6 */
4867 0, /* VK_PACKET 0xE7 - used to pass Unicode chars */
4869 "reset", /* VK_OEM_RESET 0xE9 */
4870 "jump", /* VK_OEM_JUMP 0xEA */
4871 "oem-pa1", /* VK_OEM_PA1 0xEB */
4872 "oem-pa2", /* VK_OEM_PA2 0xEC */
4873 "oem-pa3", /* VK_OEM_PA3 0xED */
4874 "wsctrl", /* VK_OEM_WSCTRL 0xEE */
4875 "cusel", /* VK_OEM_CUSEL 0xEF */
4876 "oem-attn", /* VK_OEM_ATTN 0xF0 */
4877 "finish", /* VK_OEM_FINISH 0xF1 */
4878 "copy", /* VK_OEM_COPY 0xF2 */
4879 "auto", /* VK_OEM_AUTO 0xF3 */
4880 "enlw", /* VK_OEM_ENLW 0xF4 */
4881 "backtab", /* VK_OEM_BACKTAB 0xF5 */
4882 "attn", /* VK_ATTN 0xF6 */
4883 "crsel", /* VK_CRSEL 0xF7 */
4884 "exsel", /* VK_EXSEL 0xF8 */
4885 "ereof", /* VK_EREOF 0xF9 */
4886 "play", /* VK_PLAY 0xFA */
4887 "zoom", /* VK_ZOOM 0xFB */
4888 "noname", /* VK_NONAME 0xFC */
4889 "pa1", /* VK_PA1 0xFD */
4890 "oem_clear", /* VK_OEM_CLEAR 0xFE */
4894 /* Some of these duplicate the "Media keys" on newer keyboards,
4895 but they are delivered to the application in a different way. */
4896 static const char *const lispy_multimedia_keys
[] =
4904 "browser-favorites",
4941 "toggle-dictate-command",
4947 "media-fast-forward",
4950 "media-channel-down"
4953 #else /* not HAVE_NTGUI */
4955 /* This should be dealt with in XTread_socket now, and that doesn't
4956 depend on the client system having the Kana syms defined. See also
4957 the XK_kana_A case below. */
4960 static const char *const lispy_kana_keys
[] =
4962 /* X Keysym value */
4963 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x400 .. 0x40f */
4964 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x410 .. 0x41f */
4965 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x420 .. 0x42f */
4966 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x430 .. 0x43f */
4967 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x440 .. 0x44f */
4968 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x450 .. 0x45f */
4969 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x460 .. 0x46f */
4970 0,0,0,0,0,0,0,0,0,0,0,0,0,0,"overline",0,
4971 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x480 .. 0x48f */
4972 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x490 .. 0x49f */
4973 0, "kana-fullstop", "kana-openingbracket", "kana-closingbracket",
4974 "kana-comma", "kana-conjunctive", "kana-WO", "kana-a",
4975 "kana-i", "kana-u", "kana-e", "kana-o",
4976 "kana-ya", "kana-yu", "kana-yo", "kana-tsu",
4977 "prolongedsound", "kana-A", "kana-I", "kana-U",
4978 "kana-E", "kana-O", "kana-KA", "kana-KI",
4979 "kana-KU", "kana-KE", "kana-KO", "kana-SA",
4980 "kana-SHI", "kana-SU", "kana-SE", "kana-SO",
4981 "kana-TA", "kana-CHI", "kana-TSU", "kana-TE",
4982 "kana-TO", "kana-NA", "kana-NI", "kana-NU",
4983 "kana-NE", "kana-NO", "kana-HA", "kana-HI",
4984 "kana-FU", "kana-HE", "kana-HO", "kana-MA",
4985 "kana-MI", "kana-MU", "kana-ME", "kana-MO",
4986 "kana-YA", "kana-YU", "kana-YO", "kana-RA",
4987 "kana-RI", "kana-RU", "kana-RE", "kana-RO",
4988 "kana-WA", "kana-N", "voicedsound", "semivoicedsound",
4989 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4e0 .. 0x4ef */
4990 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4f0 .. 0x4ff */
4992 #endif /* XK_kana_A */
4995 #define FUNCTION_KEY_OFFSET 0xff00
4997 /* You'll notice that this table is arranged to be conveniently
4998 indexed by X Windows keysym values. */
4999 static const char *const lispy_function_keys
[] =
5001 /* X Keysym value */
5003 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff00...0f */
5004 "backspace", "tab", "linefeed", "clear",
5006 0, 0, 0, "pause", /* 0xff10...1f */
5007 0, 0, 0, 0, 0, 0, 0, "escape",
5009 0, "kanji", "muhenkan", "henkan", /* 0xff20...2f */
5010 "romaji", "hiragana", "katakana", "hiragana-katakana",
5011 "zenkaku", "hankaku", "zenkaku-hankaku", "touroku",
5012 "massyo", "kana-lock", "kana-shift", "eisu-shift",
5013 "eisu-toggle", /* 0xff30...3f */
5014 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
5015 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff40...4f */
5017 "home", "left", "up", "right", /* 0xff50 */ /* IsCursorKey */
5018 "down", "prior", "next", "end",
5019 "begin", 0, 0, 0, 0, 0, 0, 0,
5020 "select", /* 0xff60 */ /* IsMiscFunctionKey */
5031 "break", /* 0xff6b */
5034 0, 0, 0, 0, "backtab", 0, 0, 0, /* 0xff70... */
5035 0, 0, 0, 0, 0, 0, 0, "kp-numlock", /* 0xff78... */
5036 "kp-space", /* 0xff80 */ /* IsKeypadKey */
5037 0, 0, 0, 0, 0, 0, 0, 0,
5038 "kp-tab", /* 0xff89 */
5040 "kp-enter", /* 0xff8d */
5042 "kp-f1", /* 0xff91 */
5046 "kp-home", /* 0xff95 */
5051 "kp-prior", /* kp-page-up */
5052 "kp-next", /* kp-page-down */
5058 0, 0, 0, 0, 0, 0, 0, 0, 0,
5059 "kp-multiply", /* 0xffaa */
5064 "kp-divide", /* 0xffaf */
5065 "kp-0", /* 0xffb0 */
5066 "kp-1", "kp-2", "kp-3", "kp-4", "kp-5", "kp-6", "kp-7", "kp-8", "kp-9",
5069 "kp-equal", /* 0xffbd */
5070 "f1", /* 0xffbe */ /* IsFunctionKey */
5072 "f3", "f4", "f5", "f6", "f7", "f8", "f9", "f10", /* 0xffc0 */
5073 "f11", "f12", "f13", "f14", "f15", "f16", "f17", "f18",
5074 "f19", "f20", "f21", "f22", "f23", "f24", "f25", "f26", /* 0xffd0 */
5075 "f27", "f28", "f29", "f30", "f31", "f32", "f33", "f34",
5076 "f35", 0, 0, 0, 0, 0, 0, 0, /* 0xffe0 */
5077 0, 0, 0, 0, 0, 0, 0, 0,
5078 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfff0 */
5079 0, 0, 0, 0, 0, 0, 0, "delete"
5082 /* ISO 9995 Function and Modifier Keys; the first byte is 0xFE. */
5083 #define ISO_FUNCTION_KEY_OFFSET 0xfe00
5085 static const char *const iso_lispy_function_keys
[] =
5087 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe00 */
5088 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe08 */
5089 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe10 */
5090 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe18 */
5091 "iso-lefttab", /* 0xfe20 */
5092 "iso-move-line-up", "iso-move-line-down",
5093 "iso-partial-line-up", "iso-partial-line-down",
5094 "iso-partial-space-left", "iso-partial-space-right",
5095 "iso-set-margin-left", "iso-set-margin-right", /* 0xffe27, 28 */
5096 "iso-release-margin-left", "iso-release-margin-right",
5097 "iso-release-both-margins",
5098 "iso-fast-cursor-left", "iso-fast-cursor-right",
5099 "iso-fast-cursor-up", "iso-fast-cursor-down",
5100 "iso-continuous-underline", "iso-discontinuous-underline", /* 0xfe30, 31 */
5101 "iso-emphasize", "iso-center-object", "iso-enter", /* ... 0xfe34 */
5104 #endif /* not HAVE_NTGUI */
5106 static Lisp_Object Vlispy_mouse_stem
;
5108 static const char *const lispy_wheel_names
[] =
5110 "wheel-up", "wheel-down", "wheel-left", "wheel-right"
5113 /* drag-n-drop events are generated when a set of selected files are
5114 dragged from another application and dropped onto an Emacs window. */
5115 static const char *const lispy_drag_n_drop_names
[] =
5120 /* An array of symbol indexes of scroll bar parts, indexed by an enum
5121 scroll_bar_part value. Note that Qnil corresponds to
5122 scroll_bar_nowhere and should not appear in Lisp events. */
5123 static short const scroll_bar_parts
[] = {
5124 SYMBOL_INDEX (Qnil
), SYMBOL_INDEX (Qabove_handle
), SYMBOL_INDEX (Qhandle
),
5125 SYMBOL_INDEX (Qbelow_handle
), SYMBOL_INDEX (Qup
), SYMBOL_INDEX (Qdown
),
5126 SYMBOL_INDEX (Qtop
), SYMBOL_INDEX (Qbottom
), SYMBOL_INDEX (Qend_scroll
),
5127 SYMBOL_INDEX (Qratio
), SYMBOL_INDEX (Qbefore_handle
),
5128 SYMBOL_INDEX (Qhorizontal_handle
), SYMBOL_INDEX (Qafter_handle
),
5129 SYMBOL_INDEX (Qleft
), SYMBOL_INDEX (Qright
), SYMBOL_INDEX (Qleftmost
),
5130 SYMBOL_INDEX (Qrightmost
), SYMBOL_INDEX (Qend_scroll
), SYMBOL_INDEX (Qratio
)
5133 #ifdef HAVE_WINDOW_SYSTEM
5134 /* An array of symbol indexes of internal border parts, indexed by an enum
5135 internal_border_part value. Note that Qnil corresponds to
5136 internal_border_part_none and should not appear in Lisp events. */
5137 static short const internal_border_parts
[] = {
5138 SYMBOL_INDEX (Qnil
), SYMBOL_INDEX (Qleft_edge
),
5139 SYMBOL_INDEX (Qtop_left_corner
), SYMBOL_INDEX (Qtop_edge
),
5140 SYMBOL_INDEX (Qtop_right_corner
), SYMBOL_INDEX (Qright_edge
),
5141 SYMBOL_INDEX (Qbottom_right_corner
), SYMBOL_INDEX (Qbottom_edge
),
5142 SYMBOL_INDEX (Qbottom_left_corner
)
5146 /* A vector, indexed by button number, giving the down-going location
5147 of currently depressed buttons, both scroll bar and non-scroll bar.
5149 The elements have the form
5150 (BUTTON-NUMBER MODIFIER-MASK . REST)
5151 where REST is the cdr of a position as it would be reported in the event.
5153 The make_lispy_event function stores positions here to tell the
5154 difference between click and drag events, and to store the starting
5155 location to be included in drag events. */
5157 static Lisp_Object button_down_location
;
5159 /* Information about the most recent up-going button event: Which
5160 button, what location, and what time. */
5162 static int last_mouse_button
;
5163 static int last_mouse_x
;
5164 static int last_mouse_y
;
5165 static Time button_down_time
;
5167 /* The number of clicks in this multiple-click. */
5169 static int double_click_count
;
5171 /* X and Y are frame-relative coordinates for a click or wheel event.
5172 Return a Lisp-style event list. */
5175 make_lispy_position (struct frame
*f
, Lisp_Object x
, Lisp_Object y
,
5178 enum window_part part
;
5179 Lisp_Object posn
= Qnil
;
5180 Lisp_Object extra_info
= Qnil
;
5181 /* Coordinate pixel positions to return. */
5182 int xret
= 0, yret
= 0;
5183 /* The window or frame under frame pixel coordinates (x,y) */
5184 Lisp_Object window_or_frame
= f
5185 ? window_from_coordinates (f
, XINT (x
), XINT (y
), &part
, 0)
5188 if (WINDOWP (window_or_frame
))
5190 /* It's a click in window WINDOW at frame coordinates (X,Y) */
5191 struct window
*w
= XWINDOW (window_or_frame
);
5192 Lisp_Object string_info
= Qnil
;
5193 ptrdiff_t textpos
= 0;
5194 int col
= -1, row
= -1;
5195 int dx
= -1, dy
= -1;
5196 int width
= -1, height
= -1;
5197 Lisp_Object object
= Qnil
;
5199 /* Pixel coordinates relative to the window corner. */
5200 int wx
= XINT (x
) - WINDOW_LEFT_EDGE_X (w
);
5201 int wy
= XINT (y
) - WINDOW_TOP_EDGE_Y (w
);
5203 /* For text area clicks, return X, Y relative to the corner of
5204 this text area. Note that dX, dY etc are set below, by
5205 buffer_posn_from_coords. */
5206 if (part
== ON_TEXT
)
5208 xret
= XINT (x
) - window_box_left (w
, TEXT_AREA
);
5209 yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5211 /* For mode line and header line clicks, return X, Y relative to
5212 the left window edge. Use mode_line_string to look for a
5213 string on the click position. */
5214 else if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
)
5219 posn
= (part
== ON_MODE_LINE
) ? Qmode_line
: Qheader_line
;
5220 /* Note that mode_line_string takes COL, ROW as pixels and
5221 converts them to characters. */
5224 string
= mode_line_string (w
, part
, &col
, &row
, &charpos
,
5225 &object
, &dx
, &dy
, &width
, &height
);
5226 if (STRINGP (string
))
5227 string_info
= Fcons (string
, make_number (charpos
));
5233 /* For fringes and margins, Y is relative to the area's (and the
5234 window's) top edge, while X is meaningless. */
5235 else if (part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
5240 posn
= (part
== ON_LEFT_MARGIN
) ? Qleft_margin
: Qright_margin
;
5243 string
= marginal_area_string (w
, part
, &col
, &row
, &charpos
,
5244 &object
, &dx
, &dy
, &width
, &height
);
5245 if (STRINGP (string
))
5246 string_info
= Fcons (string
, make_number (charpos
));
5248 yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5250 else if (part
== ON_LEFT_FRINGE
)
5252 posn
= Qleft_fringe
;
5256 - (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5257 ? 0 : window_box_width (w
, LEFT_MARGIN_AREA
));
5258 dy
= yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5260 else if (part
== ON_RIGHT_FRINGE
)
5262 posn
= Qright_fringe
;
5266 - window_box_width (w
, LEFT_MARGIN_AREA
)
5267 - window_box_width (w
, TEXT_AREA
)
5268 - (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5269 ? window_box_width (w
, RIGHT_MARGIN_AREA
)
5271 dy
= yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5273 else if (part
== ON_VERTICAL_BORDER
)
5275 posn
= Qvertical_line
;
5281 else if (part
== ON_VERTICAL_SCROLL_BAR
)
5283 posn
= Qvertical_scroll_bar
;
5284 width
= WINDOW_SCROLL_BAR_AREA_WIDTH (w
);
5288 else if (part
== ON_HORIZONTAL_SCROLL_BAR
)
5290 posn
= Qhorizontal_scroll_bar
;
5291 width
= WINDOW_SCROLL_BAR_AREA_HEIGHT (w
);
5295 else if (part
== ON_RIGHT_DIVIDER
)
5297 posn
= Qright_divider
;
5298 width
= WINDOW_RIGHT_DIVIDER_WIDTH (w
);
5302 else if (part
== ON_BOTTOM_DIVIDER
)
5304 posn
= Qbottom_divider
;
5305 width
= WINDOW_BOTTOM_DIVIDER_WIDTH (w
);
5310 /* For clicks in the text area, fringes, margins, or vertical
5311 scroll bar, call buffer_posn_from_coords to extract TEXTPOS,
5312 the buffer position nearest to the click. */
5315 Lisp_Object string2
, object2
= Qnil
;
5316 struct display_pos p
;
5318 int width2
, height2
;
5319 /* The pixel X coordinate passed to buffer_posn_from_coords
5320 is the X coordinate relative to the text area for clicks
5321 in text-area, right-margin/fringe and right-side vertical
5322 scroll bar, zero otherwise. */
5324 = (part
== ON_TEXT
) ? xret
5325 : (part
== ON_RIGHT_FRINGE
|| part
== ON_RIGHT_MARGIN
5326 || (part
== ON_VERTICAL_SCROLL_BAR
5327 && WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_RIGHT (w
)))
5328 ? (XINT (x
) - window_box_left (w
, TEXT_AREA
))
5332 string2
= buffer_posn_from_coords (w
, &x2
, &y2
, &p
,
5333 &object2
, &dx2
, &dy2
,
5335 textpos
= CHARPOS (p
.pos
);
5336 if (col
< 0) col
= x2
;
5337 if (row
< 0) row
= y2
;
5338 if (dx
< 0) dx
= dx2
;
5339 if (dy
< 0) dy
= dy2
;
5340 if (width
< 0) width
= width2
;
5341 if (height
< 0) height
= height2
;
5345 posn
= make_number (textpos
);
5346 if (STRINGP (string2
))
5347 string_info
= Fcons (string2
,
5348 make_number (CHARPOS (p
.string_pos
)));
5354 #ifdef HAVE_WINDOW_SYSTEM
5355 if (IMAGEP (object
))
5357 Lisp_Object image_map
, hotspot
;
5358 if ((image_map
= Fplist_get (XCDR (object
), QCmap
),
5360 && (hotspot
= find_hot_spot (image_map
, dx
, dy
),
5362 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
5363 posn
= XCAR (hotspot
);
5370 Fcons (make_number (dx
), make_number (dy
)),
5371 Fcons (make_number (width
), make_number (height
)));
5374 extra_info
= Fcons (string_info
,
5375 Fcons (textpos
< 0 ? Qnil
: make_number (textpos
),
5376 Fcons (Fcons (make_number (col
),
5381 #ifdef HAVE_WINDOW_SYSTEM
5384 /* Return mouse pixel coordinates here. */
5385 XSETFRAME (window_or_frame
, f
);
5389 if (FRAME_LIVE_P (f
)
5390 && FRAME_INTERNAL_BORDER_WIDTH (f
) > 0
5391 && !NILP (get_frame_param (f
, Qdrag_internal_border
)))
5393 enum internal_border_part part
5394 = frame_internal_border_part (f
, xret
, yret
);
5396 posn
= builtin_lisp_symbol (internal_border_parts
[part
]);
5402 window_or_frame
= Qnil
;
5404 return Fcons (window_or_frame
,
5406 Fcons (Fcons (make_number (xret
),
5407 make_number (yret
)),
5408 Fcons (make_number (t
),
5412 /* Return non-zero if F is a GUI frame that uses some toolkit-managed
5413 menu bar. This really means that Emacs draws and manages the menu
5414 bar as part of its normal display, and therefore can compute its
5417 toolkit_menubar_in_use (struct frame
*f
)
5419 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS) || defined (HAVE_NTGUI)
5420 return !(!FRAME_WINDOW_P (f
));
5426 /* Build the part of Lisp event which represents scroll bar state from
5427 EV. TYPE is one of Qvertical_scroll_bar or Qhorizontal_scroll_bar. */
5430 make_scroll_bar_position (struct input_event
*ev
, Lisp_Object type
)
5432 return list5 (ev
->frame_or_window
, type
, Fcons (ev
->x
, ev
->y
),
5433 make_number (ev
->timestamp
),
5434 builtin_lisp_symbol (scroll_bar_parts
[ev
->part
]));
5437 /* Given a struct input_event, build the lisp event which represents
5438 it. If EVENT is 0, build a mouse movement event from the mouse
5439 movement buffer, which should have a movement event in it.
5441 Note that events must be passed to this function in the order they
5442 are received; this function stores the location of button presses
5443 in order to build drag events when the button is released. */
5446 make_lispy_event (struct input_event
*event
)
5450 switch (event
->kind
)
5452 /* A simple keystroke. */
5453 case ASCII_KEYSTROKE_EVENT
:
5454 case MULTIBYTE_CHAR_KEYSTROKE_EVENT
:
5456 Lisp_Object lispy_c
;
5457 EMACS_INT c
= event
->code
;
5458 if (event
->kind
== ASCII_KEYSTROKE_EVENT
)
5461 eassert (c
== event
->code
);
5464 /* Caps-lock shouldn't affect interpretation of key chords:
5465 Control+s should produce C-s whether caps-lock is on or
5466 not. And Control+Shift+s should produce C-S-s whether
5467 caps-lock is on or not. */
5468 if (event
->modifiers
& ~shift_modifier
)
5470 /* This is a key chord: some non-shift modifier is
5473 if (uppercasep (c
) &&
5474 !(event
->modifiers
& shift_modifier
))
5476 /* Got a capital letter without a shift. The caps
5477 lock is on. Un-capitalize the letter. */
5480 else if (lowercasep (c
) &&
5481 (event
->modifiers
& shift_modifier
))
5483 /* Got a lower-case letter even though shift is
5484 depressed. The caps lock is on. Capitalize the
5490 if (event
->kind
== ASCII_KEYSTROKE_EVENT
)
5492 /* Turn ASCII characters into control characters
5494 if (event
->modifiers
& ctrl_modifier
)
5496 c
= make_ctrl_char (c
);
5497 event
->modifiers
&= ~ctrl_modifier
;
5501 /* Add in the other modifier bits. The shift key was taken care
5502 of by the X code. */
5503 c
|= (event
->modifiers
5504 & (meta_modifier
| alt_modifier
5505 | hyper_modifier
| super_modifier
| ctrl_modifier
));
5506 /* Distinguish Shift-SPC from SPC. */
5507 if ((event
->code
) == 040
5508 && event
->modifiers
& shift_modifier
)
5509 c
|= shift_modifier
;
5510 button_down_time
= 0;
5511 XSETFASTINT (lispy_c
, c
);
5516 /* NS_NONKEY_EVENTs are just like NON_ASCII_KEYSTROKE_EVENTs,
5517 except that they are non-key events (last-nonmenu-event is nil). */
5518 case NS_NONKEY_EVENT
:
5521 /* A function key. The symbol may need to have modifier prefixes
5523 case NON_ASCII_KEYSTROKE_EVENT
:
5524 button_down_time
= 0;
5526 for (i
= 0; i
< ARRAYELTS (lispy_accent_codes
); i
++)
5527 if (event
->code
== lispy_accent_codes
[i
])
5528 return modify_event_symbol (i
,
5530 Qfunction_key
, Qnil
,
5531 lispy_accent_keys
, &accent_key_syms
,
5532 ARRAYELTS (lispy_accent_keys
));
5536 if (event
->code
>= 0x400 && event
->code
< 0x500)
5537 return modify_event_symbol (event
->code
- 0x400,
5538 event
->modifiers
& ~shift_modifier
,
5539 Qfunction_key
, Qnil
,
5540 lispy_kana_keys
, &func_key_syms
,
5541 ARRAYELTS (lispy_kana_keys
));
5542 #endif /* XK_kana_A */
5545 #ifdef ISO_FUNCTION_KEY_OFFSET
5546 if (event
->code
< FUNCTION_KEY_OFFSET
5547 && event
->code
>= ISO_FUNCTION_KEY_OFFSET
)
5548 return modify_event_symbol (event
->code
- ISO_FUNCTION_KEY_OFFSET
,
5550 Qfunction_key
, Qnil
,
5551 iso_lispy_function_keys
, &func_key_syms
,
5552 ARRAYELTS (iso_lispy_function_keys
));
5555 if ((FUNCTION_KEY_OFFSET
<= event
->code
5557 < FUNCTION_KEY_OFFSET
+ ARRAYELTS (lispy_function_keys
)))
5558 && lispy_function_keys
[event
->code
- FUNCTION_KEY_OFFSET
])
5559 return modify_event_symbol (event
->code
- FUNCTION_KEY_OFFSET
,
5561 Qfunction_key
, Qnil
,
5562 lispy_function_keys
, &func_key_syms
,
5563 ARRAYELTS (lispy_function_keys
));
5565 /* Handle system-specific or unknown keysyms.
5566 We need to use an alist rather than a vector as the cache
5567 since we can't make a vector long enough. */
5568 if (NILP (KVAR (current_kboard
, system_key_syms
)))
5569 kset_system_key_syms (current_kboard
, Fcons (Qnil
, Qnil
));
5570 return modify_event_symbol (event
->code
,
5573 KVAR (current_kboard
, Vsystem_key_alist
),
5574 0, &KVAR (current_kboard
, system_key_syms
),
5578 case MULTIMEDIA_KEY_EVENT
:
5579 if (event
->code
< ARRAYELTS (lispy_multimedia_keys
)
5580 && event
->code
> 0 && lispy_multimedia_keys
[event
->code
])
5582 return modify_event_symbol (event
->code
, event
->modifiers
,
5583 Qfunction_key
, Qnil
,
5584 lispy_multimedia_keys
, &func_key_syms
,
5585 ARRAYELTS (lispy_multimedia_keys
));
5590 /* A mouse click. Figure out where it is, decide whether it's
5591 a press, click or drag, and build the appropriate structure. */
5592 case MOUSE_CLICK_EVENT
:
5594 case GPM_CLICK_EVENT
:
5596 #ifndef USE_TOOLKIT_SCROLL_BARS
5597 case SCROLL_BAR_CLICK_EVENT
:
5598 case HORIZONTAL_SCROLL_BAR_CLICK_EVENT
:
5601 int button
= event
->code
;
5603 Lisp_Object position
;
5604 Lisp_Object
*start_pos_ptr
;
5605 Lisp_Object start_pos
;
5609 /* Build the position as appropriate for this mouse click. */
5610 if (event
->kind
== MOUSE_CLICK_EVENT
5612 || event
->kind
== GPM_CLICK_EVENT
5616 struct frame
*f
= XFRAME (event
->frame_or_window
);
5619 /* Ignore mouse events that were made on frame that
5620 have been deleted. */
5621 if (! FRAME_LIVE_P (f
))
5624 /* EVENT->x and EVENT->y are frame-relative pixel
5625 coordinates at this place. Under old redisplay, COLUMN
5626 and ROW are set to frame relative glyph coordinates
5627 which are then used to determine whether this click is
5628 in a menu (non-toolkit version). */
5629 if (!toolkit_menubar_in_use (f
))
5631 pixel_to_glyph_coords (f
, XINT (event
->x
), XINT (event
->y
),
5632 &column
, &row
, NULL
, 1);
5634 /* In the non-toolkit version, clicks on the menu bar
5635 are ordinary button events in the event buffer.
5636 Distinguish them, and invoke the menu.
5638 (In the toolkit version, the toolkit handles the
5639 menu bar and Emacs doesn't know about it until
5640 after the user makes a selection.) */
5641 if (row
>= 0 && row
< FRAME_MENU_BAR_LINES (f
)
5642 && (event
->modifiers
& down_modifier
))
5644 Lisp_Object items
, item
;
5646 /* Find the menu bar item under `column'. */
5648 items
= FRAME_MENU_BAR_ITEMS (f
);
5649 for (i
= 0; i
< ASIZE (items
); i
+= 4)
5651 Lisp_Object pos
, string
;
5652 string
= AREF (items
, i
+ 1);
5653 pos
= AREF (items
, i
+ 3);
5656 if (column
>= XINT (pos
)
5657 && column
< XINT (pos
) + SCHARS (string
))
5659 item
= AREF (items
, i
);
5664 /* ELisp manual 2.4b says (x y) are window
5665 relative but code says they are
5667 position
= list4 (event
->frame_or_window
,
5669 Fcons (event
->x
, event
->y
),
5670 make_number (event
->timestamp
));
5672 return list2 (item
, position
);
5676 position
= make_lispy_position (f
, event
->x
, event
->y
,
5679 #ifndef USE_TOOLKIT_SCROLL_BARS
5681 /* It's a scrollbar click. */
5682 position
= make_scroll_bar_position (event
, Qvertical_scroll_bar
);
5683 #endif /* not USE_TOOLKIT_SCROLL_BARS */
5685 if (button
>= ASIZE (button_down_location
))
5687 ptrdiff_t incr
= button
- ASIZE (button_down_location
) + 1;
5688 button_down_location
= larger_vector (button_down_location
,
5690 mouse_syms
= larger_vector (mouse_syms
, incr
, -1);
5693 start_pos_ptr
= aref_addr (button_down_location
, button
);
5694 start_pos
= *start_pos_ptr
;
5695 *start_pos_ptr
= Qnil
;
5698 /* On window-system frames, use the value of
5699 double-click-fuzz as is. On other frames, interpret it
5700 as a multiple of 1/8 characters. */
5704 if (WINDOWP (event
->frame_or_window
))
5705 f
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5706 else if (FRAMEP (event
->frame_or_window
))
5707 f
= XFRAME (event
->frame_or_window
);
5711 if (FRAME_WINDOW_P (f
))
5712 fuzz
= double_click_fuzz
;
5714 fuzz
= double_click_fuzz
/ 8;
5716 is_double
= (button
== last_mouse_button
5717 && (eabs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5718 && (eabs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5719 && button_down_time
!= 0
5720 && (EQ (Vdouble_click_time
, Qt
)
5721 || (NATNUMP (Vdouble_click_time
)
5722 && (event
->timestamp
- button_down_time
5723 < XFASTINT (Vdouble_click_time
)))));
5726 last_mouse_button
= button
;
5727 last_mouse_x
= XINT (event
->x
);
5728 last_mouse_y
= XINT (event
->y
);
5730 /* If this is a button press, squirrel away the location, so
5731 we can decide later whether it was a click or a drag. */
5732 if (event
->modifiers
& down_modifier
)
5736 double_click_count
++;
5737 event
->modifiers
|= ((double_click_count
> 2)
5742 double_click_count
= 1;
5743 button_down_time
= event
->timestamp
;
5744 *start_pos_ptr
= Fcopy_alist (position
);
5745 ignore_mouse_drag_p
= 0;
5748 /* Now we're releasing a button - check the co-ordinates to
5749 see if this was a click or a drag. */
5750 else if (event
->modifiers
& up_modifier
)
5752 /* If we did not see a down before this up, ignore the up.
5753 Probably this happened because the down event chose a
5754 menu item. It would be an annoyance to treat the
5755 release of the button that chose the menu item as a
5758 if (!CONSP (start_pos
))
5761 event
->modifiers
&= ~up_modifier
;
5764 Lisp_Object new_down
, down
;
5765 EMACS_INT xdiff
= double_click_fuzz
, ydiff
= double_click_fuzz
;
5767 /* The third element of every position
5768 should be the (x,y) pair. */
5769 down
= Fcar (Fcdr (Fcdr (start_pos
)));
5770 new_down
= Fcar (Fcdr (Fcdr (position
)));
5773 && INTEGERP (XCAR (down
)) && INTEGERP (XCDR (down
)))
5775 xdiff
= XINT (XCAR (new_down
)) - XINT (XCAR (down
));
5776 ydiff
= XINT (XCDR (new_down
)) - XINT (XCDR (down
));
5779 if (ignore_mouse_drag_p
)
5781 event
->modifiers
|= click_modifier
;
5782 ignore_mouse_drag_p
= 0;
5784 else if (xdiff
< double_click_fuzz
&& xdiff
> - double_click_fuzz
5785 && ydiff
< double_click_fuzz
&& ydiff
> - double_click_fuzz
5786 /* Maybe the mouse has moved a lot, caused scrolling, and
5787 eventually ended up at the same screen position (but
5788 not buffer position) in which case it is a drag, not
5790 /* FIXME: OTOH if the buffer position has changed
5791 because of a timer or process filter rather than
5792 because of mouse movement, it should be considered as
5793 a click. But mouse-drag-region completely ignores
5794 this case and it hasn't caused any real problem, so
5795 it's probably OK to ignore it as well. */
5796 && EQ (Fcar (Fcdr (start_pos
)), Fcar (Fcdr (position
))))
5797 /* Mouse hasn't moved (much). */
5798 event
->modifiers
|= click_modifier
;
5801 button_down_time
= 0;
5802 event
->modifiers
|= drag_modifier
;
5805 /* Don't check is_double; treat this as multiple
5806 if the down-event was multiple. */
5807 if (double_click_count
> 1)
5808 event
->modifiers
|= ((double_click_count
> 2)
5814 /* Every mouse event should either have the down_modifier or
5815 the up_modifier set. */
5819 /* Get the symbol we should use for the mouse click. */
5822 head
= modify_event_symbol (button
,
5824 Qmouse_click
, Vlispy_mouse_stem
,
5827 ASIZE (mouse_syms
));
5828 if (event
->modifiers
& drag_modifier
)
5829 return list3 (head
, start_pos
, position
);
5830 else if (event
->modifiers
& (double_modifier
| triple_modifier
))
5831 return list3 (head
, position
, make_number (double_click_count
));
5833 return list2 (head
, position
);
5838 case HORIZ_WHEEL_EVENT
:
5840 Lisp_Object position
;
5843 /* Build the position as appropriate for this mouse click. */
5844 struct frame
*f
= XFRAME (event
->frame_or_window
);
5846 /* Ignore wheel events that were made on frame that have been
5848 if (! FRAME_LIVE_P (f
))
5851 position
= make_lispy_position (f
, event
->x
, event
->y
,
5854 /* Set double or triple modifiers to indicate the wheel speed. */
5856 /* On window-system frames, use the value of
5857 double-click-fuzz as is. On other frames, interpret it
5858 as a multiple of 1/8 characters. */
5864 if (WINDOWP (event
->frame_or_window
))
5865 fr
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5866 else if (FRAMEP (event
->frame_or_window
))
5867 fr
= XFRAME (event
->frame_or_window
);
5871 fuzz
= FRAME_WINDOW_P (fr
)
5872 ? double_click_fuzz
: double_click_fuzz
/ 8;
5874 if (event
->modifiers
& up_modifier
)
5876 /* Emit a wheel-up event. */
5877 event
->modifiers
&= ~up_modifier
;
5880 else if (event
->modifiers
& down_modifier
)
5882 /* Emit a wheel-down event. */
5883 event
->modifiers
&= ~down_modifier
;
5887 /* Every wheel event should either have the down_modifier or
5888 the up_modifier set. */
5891 if (event
->kind
== HORIZ_WHEEL_EVENT
)
5894 is_double
= (last_mouse_button
== - (1 + symbol_num
)
5895 && (eabs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5896 && (eabs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5897 && button_down_time
!= 0
5898 && (EQ (Vdouble_click_time
, Qt
)
5899 || (NATNUMP (Vdouble_click_time
)
5900 && (event
->timestamp
- button_down_time
5901 < XFASTINT (Vdouble_click_time
)))));
5904 double_click_count
++;
5905 event
->modifiers
|= ((double_click_count
> 2)
5911 double_click_count
= 1;
5912 event
->modifiers
|= click_modifier
;
5915 button_down_time
= event
->timestamp
;
5916 /* Use a negative value to distinguish wheel from mouse button. */
5917 last_mouse_button
= - (1 + symbol_num
);
5918 last_mouse_x
= XINT (event
->x
);
5919 last_mouse_y
= XINT (event
->y
);
5921 /* Get the symbol we should use for the wheel event. */
5922 head
= modify_event_symbol (symbol_num
,
5928 ASIZE (wheel_syms
));
5931 if (NUMBERP (event
->arg
))
5932 return list4 (head
, position
, make_number (double_click_count
),
5934 else if (event
->modifiers
& (double_modifier
| triple_modifier
))
5935 return list3 (head
, position
, make_number (double_click_count
));
5937 return list2 (head
, position
);
5941 #ifdef USE_TOOLKIT_SCROLL_BARS
5943 /* We don't have down and up events if using toolkit scroll bars,
5944 so make this always a click event. Store in the `part' of
5945 the Lisp event a symbol which maps to the following actions:
5947 `above_handle' page up
5948 `below_handle' page down
5952 `bottom' bottom of buffer
5953 `handle' thumb has been dragged.
5954 `end-scroll' end of interaction with scroll bar
5956 The incoming input_event contains in its `part' member an
5957 index of type `enum scroll_bar_part' which we can use as an
5958 index in scroll_bar_parts to get the appropriate symbol. */
5960 case SCROLL_BAR_CLICK_EVENT
:
5962 Lisp_Object position
, head
;
5964 position
= make_scroll_bar_position (event
, Qvertical_scroll_bar
);
5966 /* Always treat scroll bar events as clicks. */
5967 event
->modifiers
|= click_modifier
;
5968 event
->modifiers
&= ~up_modifier
;
5970 if (event
->code
>= ASIZE (mouse_syms
))
5971 mouse_syms
= larger_vector (mouse_syms
,
5972 event
->code
- ASIZE (mouse_syms
) + 1,
5975 /* Get the symbol we should use for the mouse click. */
5976 head
= modify_event_symbol (event
->code
,
5981 ASIZE (mouse_syms
));
5982 return list2 (head
, position
);
5985 case HORIZONTAL_SCROLL_BAR_CLICK_EVENT
:
5987 Lisp_Object position
, head
;
5989 position
= make_scroll_bar_position (event
, Qhorizontal_scroll_bar
);
5991 /* Always treat scroll bar events as clicks. */
5992 event
->modifiers
|= click_modifier
;
5993 event
->modifiers
&= ~up_modifier
;
5995 if (event
->code
>= ASIZE (mouse_syms
))
5996 mouse_syms
= larger_vector (mouse_syms
,
5997 event
->code
- ASIZE (mouse_syms
) + 1,
6000 /* Get the symbol we should use for the mouse click. */
6001 head
= modify_event_symbol (event
->code
,
6006 ASIZE (mouse_syms
));
6007 return list2 (head
, position
);
6010 #endif /* USE_TOOLKIT_SCROLL_BARS */
6012 case DRAG_N_DROP_EVENT
:
6015 Lisp_Object head
, position
;
6018 f
= XFRAME (event
->frame_or_window
);
6021 /* Ignore mouse events that were made on frames that
6022 have been deleted. */
6023 if (! FRAME_LIVE_P (f
))
6026 position
= make_lispy_position (f
, event
->x
, event
->y
,
6029 head
= modify_event_symbol (0, event
->modifiers
,
6031 lispy_drag_n_drop_names
,
6032 &drag_n_drop_syms
, 1);
6033 return list3 (head
, position
, files
);
6036 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
6037 || defined (HAVE_NS) || defined (USE_GTK)
6038 case MENU_BAR_EVENT
:
6039 if (EQ (event
->arg
, event
->frame_or_window
))
6040 /* This is the prefix key. We translate this to
6041 `(menu_bar)' because the code in keyboard.c for menu
6042 events, which we use, relies on this. */
6043 return list1 (Qmenu_bar
);
6047 case SELECT_WINDOW_EVENT
:
6048 /* Make an event (select-window (WINDOW)). */
6049 return list2 (Qselect_window
, list1 (event
->frame_or_window
));
6051 case TOOL_BAR_EVENT
:
6052 if (EQ (event
->arg
, event
->frame_or_window
))
6053 /* This is the prefix key. We translate this to
6054 `(tool_bar)' because the code in keyboard.c for tool bar
6055 events, which we use, relies on this. */
6056 return list1 (Qtool_bar
);
6057 else if (SYMBOLP (event
->arg
))
6058 return apply_modifiers (event
->modifiers
, event
->arg
);
6061 case USER_SIGNAL_EVENT
:
6062 /* A user signal. */
6064 char *name
= find_user_signal_name (event
->code
);
6067 return intern (name
);
6070 case SAVE_SESSION_EVENT
:
6071 return Qsave_session
;
6076 return Fcons (Qdbus_event
, event
->arg
);
6078 #endif /* HAVE_DBUS */
6080 #ifdef HAVE_XWIDGETS
6083 return Fcons (Qxwidget_event
, event
->arg
);
6087 #if defined HAVE_INOTIFY || defined HAVE_KQUEUE || defined HAVE_GFILENOTIFY
6088 case FILE_NOTIFY_EVENT
:
6090 return Fcons (Qfile_notify
, event
->arg
);
6092 #endif /* HAVE_INOTIFY || HAVE_KQUEUE || HAVE_GFILENOTIFY */
6094 case CONFIG_CHANGED_EVENT
:
6095 return list3 (Qconfig_changed_event
,
6096 event
->arg
, event
->frame_or_window
);
6098 /* The 'kind' field of the event is something we don't recognize. */
6105 make_lispy_movement (struct frame
*frame
, Lisp_Object bar_window
, enum scroll_bar_part part
,
6106 Lisp_Object x
, Lisp_Object y
, Time t
)
6108 /* Is it a scroll bar movement? */
6109 if (frame
&& ! NILP (bar_window
))
6111 Lisp_Object part_sym
;
6113 part_sym
= builtin_lisp_symbol (scroll_bar_parts
[part
]);
6114 return list2 (Qscroll_bar_movement
,
6116 Qvertical_scroll_bar
,
6121 /* Or is it an ordinary mouse movement? */
6124 Lisp_Object position
;
6125 position
= make_lispy_position (frame
, x
, y
, t
);
6126 return list2 (Qmouse_movement
, position
);
6130 /* Construct a switch frame event. */
6132 make_lispy_switch_frame (Lisp_Object frame
)
6134 return list2 (Qswitch_frame
, frame
);
6138 make_lispy_focus_in (Lisp_Object frame
)
6140 return list2 (Qfocus_in
, frame
);
6143 #ifdef HAVE_WINDOW_SYSTEM
6146 make_lispy_focus_out (Lisp_Object frame
)
6148 return list2 (Qfocus_out
, frame
);
6151 #endif /* HAVE_WINDOW_SYSTEM */
6153 /* Manipulating modifiers. */
6155 /* Parse the name of SYMBOL, and return the set of modifiers it contains.
6157 If MODIFIER_END is non-zero, set *MODIFIER_END to the position in
6158 SYMBOL's name of the end of the modifiers; the string from this
6159 position is the unmodified symbol name.
6161 This doesn't use any caches. */
6164 parse_modifiers_uncached (Lisp_Object symbol
, ptrdiff_t *modifier_end
)
6170 CHECK_SYMBOL (symbol
);
6173 name
= SYMBOL_NAME (symbol
);
6175 for (i
= 0; i
< SBYTES (name
) - 1; )
6177 ptrdiff_t this_mod_end
= 0;
6180 /* See if the name continues with a modifier word.
6181 Check that the word appears, but don't check what follows it.
6182 Set this_mod and this_mod_end to record what we find. */
6184 switch (SREF (name
, i
))
6186 #define SINGLE_LETTER_MOD(BIT) \
6187 (this_mod_end = i + 1, this_mod = BIT)
6190 SINGLE_LETTER_MOD (alt_modifier
);
6194 SINGLE_LETTER_MOD (ctrl_modifier
);
6198 SINGLE_LETTER_MOD (hyper_modifier
);
6202 SINGLE_LETTER_MOD (meta_modifier
);
6206 SINGLE_LETTER_MOD (shift_modifier
);
6210 SINGLE_LETTER_MOD (super_modifier
);
6213 #undef SINGLE_LETTER_MOD
6215 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6216 if (i + LEN + 1 <= SBYTES (name) \
6217 && ! memcmp (SDATA (name) + i, NAME, LEN)) \
6219 this_mod_end = i + LEN; \
6224 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
6225 MULTI_LETTER_MOD (down_modifier
, "down", 4);
6226 MULTI_LETTER_MOD (double_modifier
, "double", 6);
6230 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
6234 MULTI_LETTER_MOD (up_modifier
, "up", 2);
6236 #undef MULTI_LETTER_MOD
6240 /* If we found no modifier, stop looking for them. */
6241 if (this_mod_end
== 0)
6244 /* Check there is a dash after the modifier, so that it
6245 really is a modifier. */
6246 if (this_mod_end
>= SBYTES (name
)
6247 || SREF (name
, this_mod_end
) != '-')
6250 /* This modifier is real; look for another. */
6251 modifiers
|= this_mod
;
6252 i
= this_mod_end
+ 1;
6255 /* Should we include the `click' modifier? */
6256 if (! (modifiers
& (down_modifier
| drag_modifier
6257 | double_modifier
| triple_modifier
))
6258 && i
+ 7 == SBYTES (name
)
6259 && memcmp (SDATA (name
) + i
, "mouse-", 6) == 0
6260 && ('0' <= SREF (name
, i
+ 6) && SREF (name
, i
+ 6) <= '9'))
6261 modifiers
|= click_modifier
;
6263 if (! (modifiers
& (double_modifier
| triple_modifier
))
6264 && i
+ 6 < SBYTES (name
)
6265 && memcmp (SDATA (name
) + i
, "wheel-", 6) == 0)
6266 modifiers
|= click_modifier
;
6274 /* Return a symbol whose name is the modifier prefixes for MODIFIERS
6275 prepended to the string BASE[0..BASE_LEN-1].
6276 This doesn't use any caches. */
6278 apply_modifiers_uncached (int modifiers
, char *base
, int base_len
, int base_len_byte
)
6280 /* Since BASE could contain nulls, we can't use intern here; we have
6281 to use Fintern, which expects a genuine Lisp_String, and keeps a
6283 char new_mods
[sizeof "A-C-H-M-S-s-up-down-drag-double-triple-"];
6289 /* Mouse events should not exhibit the `up' modifier once they
6290 leave the event queue only accessible to C code; `up' will
6291 always be turned into a click or drag event before being
6292 presented to lisp code. But since lisp events can be
6293 synthesized bypassing the event queue and pushed into
6294 `unread-command-events' or its companions, it's better to just
6295 deal with unexpected modifier combinations. */
6297 if (modifiers
& alt_modifier
) { *p
++ = 'A'; *p
++ = '-'; }
6298 if (modifiers
& ctrl_modifier
) { *p
++ = 'C'; *p
++ = '-'; }
6299 if (modifiers
& hyper_modifier
) { *p
++ = 'H'; *p
++ = '-'; }
6300 if (modifiers
& meta_modifier
) { *p
++ = 'M'; *p
++ = '-'; }
6301 if (modifiers
& shift_modifier
) { *p
++ = 'S'; *p
++ = '-'; }
6302 if (modifiers
& super_modifier
) { *p
++ = 's'; *p
++ = '-'; }
6303 if (modifiers
& double_modifier
) p
= stpcpy (p
, "double-");
6304 if (modifiers
& triple_modifier
) p
= stpcpy (p
, "triple-");
6305 if (modifiers
& up_modifier
) p
= stpcpy (p
, "up-");
6306 if (modifiers
& down_modifier
) p
= stpcpy (p
, "down-");
6307 if (modifiers
& drag_modifier
) p
= stpcpy (p
, "drag-");
6308 /* The click modifier is denoted by the absence of other modifiers. */
6312 mod_len
= p
- new_mods
;
6316 Lisp_Object new_name
;
6318 new_name
= make_uninit_multibyte_string (mod_len
+ base_len
,
6319 mod_len
+ base_len_byte
);
6320 memcpy (SDATA (new_name
), new_mods
, mod_len
);
6321 memcpy (SDATA (new_name
) + mod_len
, base
, base_len_byte
);
6323 return Fintern (new_name
, Qnil
);
6328 static const char *const modifier_names
[] =
6330 "up", "down", "drag", "click", "double", "triple", 0, 0,
6331 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
6332 0, 0, "alt", "super", "hyper", "shift", "control", "meta"
6334 #define NUM_MOD_NAMES ARRAYELTS (modifier_names)
6336 static Lisp_Object modifier_symbols
;
6338 /* Return the list of modifier symbols corresponding to the mask MODIFIERS. */
6340 lispy_modifier_list (int modifiers
)
6342 Lisp_Object modifier_list
;
6345 modifier_list
= Qnil
;
6346 for (i
= 0; (1<<i
) <= modifiers
&& i
< NUM_MOD_NAMES
; i
++)
6347 if (modifiers
& (1<<i
))
6348 modifier_list
= Fcons (AREF (modifier_symbols
, i
),
6351 return modifier_list
;
6355 /* Parse the modifiers on SYMBOL, and return a list like (UNMODIFIED MASK),
6356 where UNMODIFIED is the unmodified form of SYMBOL,
6357 MASK is the set of modifiers present in SYMBOL's name.
6358 This is similar to parse_modifiers_uncached, but uses the cache in
6359 SYMBOL's Qevent_symbol_element_mask property, and maintains the
6360 Qevent_symbol_elements property. */
6362 #define KEY_TO_CHAR(k) (XINT (k) & ((1 << CHARACTERBITS) - 1))
6365 parse_modifiers (Lisp_Object symbol
)
6367 Lisp_Object elements
;
6369 if (INTEGERP (symbol
))
6370 return list2i (KEY_TO_CHAR (symbol
), XINT (symbol
) & CHAR_MODIFIER_MASK
);
6371 else if (!SYMBOLP (symbol
))
6374 elements
= Fget (symbol
, Qevent_symbol_element_mask
);
6375 if (CONSP (elements
))
6380 int modifiers
= parse_modifiers_uncached (symbol
, &end
);
6381 Lisp_Object unmodified
;
6384 unmodified
= Fintern (make_string (SSDATA (SYMBOL_NAME (symbol
)) + end
,
6385 SBYTES (SYMBOL_NAME (symbol
)) - end
),
6388 if (modifiers
& ~INTMASK
)
6390 XSETFASTINT (mask
, modifiers
);
6391 elements
= list2 (unmodified
, mask
);
6393 /* Cache the parsing results on SYMBOL. */
6394 Fput (symbol
, Qevent_symbol_element_mask
,
6396 Fput (symbol
, Qevent_symbol_elements
,
6397 Fcons (unmodified
, lispy_modifier_list (modifiers
)));
6399 /* Since we know that SYMBOL is modifiers applied to unmodified,
6400 it would be nice to put that in unmodified's cache.
6401 But we can't, since we're not sure that parse_modifiers is
6408 DEFUN ("internal-event-symbol-parse-modifiers", Fevent_symbol_parse_modifiers
,
6409 Sevent_symbol_parse_modifiers
, 1, 1, 0,
6410 doc
: /* Parse the event symbol. For internal use. */)
6411 (Lisp_Object symbol
)
6413 /* Fill the cache if needed. */
6414 parse_modifiers (symbol
);
6415 /* Ignore the result (which is stored on Qevent_symbol_element_mask)
6416 and use the Lispier representation stored on Qevent_symbol_elements
6418 return Fget (symbol
, Qevent_symbol_elements
);
6421 /* Apply the modifiers MODIFIERS to the symbol BASE.
6422 BASE must be unmodified.
6424 This is like apply_modifiers_uncached, but uses BASE's
6425 Qmodifier_cache property, if present.
6427 apply_modifiers copies the value of BASE's Qevent_kind property to
6428 the modified symbol. */
6430 apply_modifiers (int modifiers
, Lisp_Object base
)
6432 Lisp_Object cache
, idx
, entry
, new_symbol
;
6434 /* Mask out upper bits. We don't know where this value's been. */
6435 modifiers
&= INTMASK
;
6437 if (INTEGERP (base
))
6438 return make_number (XINT (base
) | modifiers
);
6440 /* The click modifier never figures into cache indices. */
6441 cache
= Fget (base
, Qmodifier_cache
);
6442 XSETFASTINT (idx
, (modifiers
& ~click_modifier
));
6443 entry
= assq_no_quit (idx
, cache
);
6446 new_symbol
= XCDR (entry
);
6449 /* We have to create the symbol ourselves. */
6450 new_symbol
= apply_modifiers_uncached (modifiers
,
6451 SSDATA (SYMBOL_NAME (base
)),
6452 SCHARS (SYMBOL_NAME (base
)),
6453 SBYTES (SYMBOL_NAME (base
)));
6455 /* Add the new symbol to the base's cache. */
6456 entry
= Fcons (idx
, new_symbol
);
6457 Fput (base
, Qmodifier_cache
, Fcons (entry
, cache
));
6459 /* We have the parsing info now for free, so we could add it to
6461 XSETFASTINT (idx, modifiers);
6462 Fput (new_symbol, Qevent_symbol_element_mask,
6464 Fput (new_symbol, Qevent_symbol_elements,
6465 Fcons (base, lispy_modifier_list (modifiers)));
6466 Sadly, this is only correct if `base' is indeed a base event,
6467 which is not necessarily the case. -stef */
6470 /* Make sure this symbol is of the same kind as BASE.
6472 You'd think we could just set this once and for all when we
6473 intern the symbol above, but reorder_modifiers may call us when
6474 BASE's property isn't set right; we can't assume that just
6475 because it has a Qmodifier_cache property it must have its
6476 Qevent_kind set right as well. */
6477 if (NILP (Fget (new_symbol
, Qevent_kind
)))
6481 kind
= Fget (base
, Qevent_kind
);
6483 Fput (new_symbol
, Qevent_kind
, kind
);
6490 /* Given a symbol whose name begins with modifiers ("C-", "M-", etc),
6491 return a symbol with the modifiers placed in the canonical order.
6492 Canonical order is alphabetical, except for down and drag, which
6493 always come last. The 'click' modifier is never written out.
6495 Fdefine_key calls this to make sure that (for example) C-M-foo
6496 and M-C-foo end up being equivalent in the keymap. */
6499 reorder_modifiers (Lisp_Object symbol
)
6501 /* It's hopefully okay to write the code this way, since everything
6502 will soon be in caches, and no consing will be done at all. */
6505 parsed
= parse_modifiers (symbol
);
6506 return apply_modifiers (XFASTINT (XCAR (XCDR (parsed
))),
6511 /* For handling events, we often want to produce a symbol whose name
6512 is a series of modifier key prefixes ("M-", "C-", etcetera) attached
6513 to some base, like the name of a function key or mouse button.
6514 modify_event_symbol produces symbols of this sort.
6516 NAME_TABLE should point to an array of strings, such that NAME_TABLE[i]
6517 is the name of the i'th symbol. TABLE_SIZE is the number of elements
6520 Alternatively, NAME_ALIST_OR_STEM is either an alist mapping codes
6521 into symbol names, or a string specifying a name stem used to
6522 construct a symbol name or the form `STEM-N', where N is the decimal
6523 representation of SYMBOL_NUM. NAME_ALIST_OR_STEM is used if it is
6524 non-nil; otherwise NAME_TABLE is used.
6526 SYMBOL_TABLE should be a pointer to a Lisp_Object whose value will
6527 persist between calls to modify_event_symbol that it can use to
6528 store a cache of the symbols it's generated for this NAME_TABLE
6529 before. The object stored there may be a vector or an alist.
6531 SYMBOL_NUM is the number of the base name we want from NAME_TABLE.
6533 MODIFIERS is a set of modifier bits (as given in struct input_events)
6534 whose prefixes should be applied to the symbol name.
6536 SYMBOL_KIND is the value to be placed in the event_kind property of
6537 the returned symbol.
6539 The symbols we create are supposed to have an
6540 `event-symbol-elements' property, which lists the modifiers present
6541 in the symbol's name. */
6544 modify_event_symbol (ptrdiff_t symbol_num
, int modifiers
, Lisp_Object symbol_kind
,
6545 Lisp_Object name_alist_or_stem
, const char *const *name_table
,
6546 Lisp_Object
*symbol_table
, ptrdiff_t table_size
)
6549 Lisp_Object symbol_int
;
6551 /* Get rid of the "vendor-specific" bit here. */
6552 XSETINT (symbol_int
, symbol_num
& 0xffffff);
6554 /* Is this a request for a valid symbol? */
6555 if (symbol_num
< 0 || symbol_num
>= table_size
)
6558 if (CONSP (*symbol_table
))
6559 value
= Fcdr (assq_no_quit (symbol_int
, *symbol_table
));
6561 /* If *symbol_table doesn't seem to be initialized properly, fix that.
6562 *symbol_table should be a lisp vector TABLE_SIZE elements long,
6563 where the Nth element is the symbol for NAME_TABLE[N], or nil if
6564 we've never used that symbol before. */
6567 if (! VECTORP (*symbol_table
)
6568 || ASIZE (*symbol_table
) != table_size
)
6572 XSETFASTINT (size
, table_size
);
6573 *symbol_table
= Fmake_vector (size
, Qnil
);
6576 value
= AREF (*symbol_table
, symbol_num
);
6579 /* Have we already used this symbol before? */
6582 /* No; let's create it. */
6583 if (CONSP (name_alist_or_stem
))
6584 value
= Fcdr_safe (Fassq (symbol_int
, name_alist_or_stem
));
6585 else if (STRINGP (name_alist_or_stem
))
6588 ptrdiff_t len
= (SBYTES (name_alist_or_stem
)
6589 + sizeof "-" + INT_STRLEN_BOUND (EMACS_INT
));
6591 buf
= SAFE_ALLOCA (len
);
6592 esprintf (buf
, "%s-%"pI
"d", SDATA (name_alist_or_stem
),
6593 XINT (symbol_int
) + 1);
6594 value
= intern (buf
);
6597 else if (name_table
!= 0 && name_table
[symbol_num
])
6598 value
= intern (name_table
[symbol_num
]);
6600 #ifdef HAVE_WINDOW_SYSTEM
6603 char *name
= x_get_keysym_name (symbol_num
);
6605 value
= intern (name
);
6611 char buf
[sizeof "key-" + INT_STRLEN_BOUND (EMACS_INT
)];
6612 sprintf (buf
, "key-%"pD
"d", symbol_num
);
6613 value
= intern (buf
);
6616 if (CONSP (*symbol_table
))
6617 *symbol_table
= Fcons (Fcons (symbol_int
, value
), *symbol_table
);
6619 ASET (*symbol_table
, symbol_num
, value
);
6621 /* Fill in the cache entries for this symbol; this also
6622 builds the Qevent_symbol_elements property, which the user
6624 apply_modifiers (modifiers
& click_modifier
, value
);
6625 Fput (value
, Qevent_kind
, symbol_kind
);
6628 /* Apply modifiers to that symbol. */
6629 return apply_modifiers (modifiers
, value
);
6632 /* Convert a list that represents an event type,
6633 such as (ctrl meta backspace), into the usual representation of that
6634 event type as a number or a symbol. */
6636 DEFUN ("event-convert-list", Fevent_convert_list
, Sevent_convert_list
, 1, 1, 0,
6637 doc
: /* Convert the event description list EVENT-DESC to an event type.
6638 EVENT-DESC should contain one base event type (a character or symbol)
6639 and zero or more modifier names (control, meta, hyper, super, shift, alt,
6640 drag, down, double or triple). The base must be last.
6641 The return value is an event type (a character or symbol) which
6642 has the same base event type and all the specified modifiers. */)
6643 (Lisp_Object event_desc
)
6651 while (CONSP (rest
))
6659 /* Given a symbol, see if it is a modifier name. */
6660 if (SYMBOLP (elt
) && CONSP (rest
))
6661 this = parse_solitary_modifier (elt
);
6665 else if (!NILP (base
))
6666 error ("Two bases given in one event");
6672 /* Let the symbol A refer to the character A. */
6673 if (SYMBOLP (base
) && SCHARS (SYMBOL_NAME (base
)) == 1)
6674 XSETINT (base
, SREF (SYMBOL_NAME (base
), 0));
6676 if (INTEGERP (base
))
6678 /* Turn (shift a) into A. */
6679 if ((modifiers
& shift_modifier
) != 0
6680 && (XINT (base
) >= 'a' && XINT (base
) <= 'z'))
6682 XSETINT (base
, XINT (base
) - ('a' - 'A'));
6683 modifiers
&= ~shift_modifier
;
6686 /* Turn (control a) into C-a. */
6687 if (modifiers
& ctrl_modifier
)
6688 return make_number ((modifiers
& ~ctrl_modifier
)
6689 | make_ctrl_char (XINT (base
)));
6691 return make_number (modifiers
| XINT (base
));
6693 else if (SYMBOLP (base
))
6694 return apply_modifiers (modifiers
, base
);
6696 error ("Invalid base event");
6699 /* Try to recognize SYMBOL as a modifier name.
6700 Return the modifier flag bit, or 0 if not recognized. */
6703 parse_solitary_modifier (Lisp_Object symbol
)
6707 if (!SYMBOLP (symbol
))
6710 name
= SYMBOL_NAME (symbol
);
6712 switch (SREF (name
, 0))
6714 #define SINGLE_LETTER_MOD(BIT) \
6715 if (SBYTES (name) == 1) \
6718 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6719 if (LEN == SBYTES (name) \
6720 && ! memcmp (SDATA (name), NAME, LEN)) \
6724 SINGLE_LETTER_MOD (alt_modifier
);
6728 MULTI_LETTER_MOD (alt_modifier
, "alt", 3);
6732 SINGLE_LETTER_MOD (ctrl_modifier
);
6736 MULTI_LETTER_MOD (ctrl_modifier
, "ctrl", 4);
6737 MULTI_LETTER_MOD (ctrl_modifier
, "control", 7);
6741 SINGLE_LETTER_MOD (hyper_modifier
);
6745 MULTI_LETTER_MOD (hyper_modifier
, "hyper", 5);
6749 SINGLE_LETTER_MOD (meta_modifier
);
6753 MULTI_LETTER_MOD (meta_modifier
, "meta", 4);
6757 SINGLE_LETTER_MOD (shift_modifier
);
6761 MULTI_LETTER_MOD (shift_modifier
, "shift", 5);
6762 MULTI_LETTER_MOD (super_modifier
, "super", 5);
6763 SINGLE_LETTER_MOD (super_modifier
);
6767 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
6768 MULTI_LETTER_MOD (down_modifier
, "down", 4);
6769 MULTI_LETTER_MOD (double_modifier
, "double", 6);
6773 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
6777 MULTI_LETTER_MOD (up_modifier
, "up", 2);
6780 #undef SINGLE_LETTER_MOD
6781 #undef MULTI_LETTER_MOD
6787 /* Return true if EVENT is a list whose elements are all integers or symbols.
6788 Such a list is not valid as an event,
6789 but it can be a Lucid-style event type list. */
6792 lucid_event_type_list_p (Lisp_Object object
)
6796 if (! CONSP (object
))
6799 if (EQ (XCAR (object
), Qhelp_echo
)
6800 || EQ (XCAR (object
), Qvertical_line
)
6801 || EQ (XCAR (object
), Qmode_line
)
6802 || EQ (XCAR (object
), Qheader_line
))
6805 for (tail
= object
; CONSP (tail
); tail
= XCDR (tail
))
6809 if (! (INTEGERP (elt
) || SYMBOLP (elt
)))
6816 /* Return true if terminal input chars are available.
6817 Also, store the return value into INPUT_PENDING.
6819 Serves the purpose of ioctl (0, FIONREAD, ...)
6820 but works even if FIONREAD does not exist.
6821 (In fact, this may actually read some input.)
6823 If READABLE_EVENTS_DO_TIMERS_NOW is set in FLAGS, actually run
6824 timer events that are ripe.
6825 If READABLE_EVENTS_FILTER_EVENTS is set in FLAGS, ignore internal
6826 events (FOCUS_IN_EVENT).
6827 If READABLE_EVENTS_IGNORE_SQUEEZABLES is set in FLAGS, ignore mouse
6828 movements and toolkit scroll bar thumb drags. */
6831 get_input_pending (int flags
)
6833 /* First of all, have we already counted some input? */
6834 input_pending
= (!NILP (Vquit_flag
) || readable_events (flags
));
6836 /* If input is being read as it arrives, and we have none, there is none. */
6837 if (!input_pending
&& (!interrupt_input
|| interrupts_deferred
))
6839 /* Try to read some input and see how much we get. */
6841 input_pending
= (!NILP (Vquit_flag
) || readable_events (flags
));
6844 return input_pending
;
6847 /* Put a BUFFER_SWITCH_EVENT in the buffer
6848 so that read_key_sequence will notice the new current buffer. */
6851 record_asynch_buffer_change (void)
6853 /* We don't need a buffer-switch event unless Emacs is waiting for input.
6854 The purpose of the event is to make read_key_sequence look up the
6855 keymaps again. If we aren't in read_key_sequence, we don't need one,
6856 and the event could cause trouble by messing up (input-pending-p).
6857 Note: Fwaiting_for_user_input_p always returns nil when async
6858 subprocesses aren't supported. */
6859 if (!NILP (Fwaiting_for_user_input_p ()))
6861 struct input_event event
;
6864 event
.kind
= BUFFER_SWITCH_EVENT
;
6865 event
.frame_or_window
= Qnil
;
6868 /* Make sure no interrupt happens while storing the event. */
6870 if (interrupt_input
)
6871 kbd_buffer_store_event (&event
);
6876 kbd_buffer_store_event (&event
);
6882 /* Read any terminal input already buffered up by the system
6883 into the kbd_buffer, but do not wait.
6885 Return the number of keyboard chars read, or -1 meaning
6886 this is a bad time to try to read input. */
6895 /* Store pending user signal events, if any. */
6896 store_user_signal_events ();
6898 /* Loop through the available terminals, and call their input hooks. */
6902 struct terminal
*next
= t
->next_terminal
;
6904 if (t
->read_socket_hook
)
6907 struct input_event hold_quit
;
6909 if (input_blocked_p ())
6911 pending_signals
= true;
6915 EVENT_INIT (hold_quit
);
6916 hold_quit
.kind
= NO_EVENT
;
6918 /* No need for FIONREAD or fcntl; just say don't wait. */
6919 while ((nr
= (*t
->read_socket_hook
) (t
, &hold_quit
)) > 0)
6922 if (nr
== -1) /* Not OK to read input now. */
6926 else if (nr
== -2) /* Non-transient error. */
6928 /* The terminal device terminated; it should be closed. */
6930 /* Kill Emacs if this was our last terminal. */
6931 if (!terminal_list
->next_terminal
)
6932 /* Formerly simply reported no input, but that
6933 sometimes led to a failure of Emacs to terminate.
6934 SIGHUP seems appropriate if we can't reach the
6936 /* ??? Is it really right to send the signal just to
6937 this process rather than to the whole process
6938 group? Perhaps on systems with FIONREAD Emacs is
6939 alone in its group. */
6940 terminate_due_to_signal (SIGHUP
, 10);
6942 /* XXX Is calling delete_terminal safe here? It calls delete_frame. */
6945 XSETTERMINAL (tmp
, t
);
6946 Fdelete_terminal (tmp
, Qnoelisp
);
6950 /* If there was no error, make sure the pointer
6951 is visible for all frames on this terminal. */
6954 Lisp_Object tail
, frame
;
6956 FOR_EACH_FRAME (tail
, frame
)
6958 struct frame
*f
= XFRAME (frame
);
6959 if (FRAME_TERMINAL (f
) == t
)
6960 frame_make_pointer_visible (f
);
6964 if (hold_quit
.kind
!= NO_EVENT
)
6965 kbd_buffer_store_event (&hold_quit
);
6977 /* This is the tty way of reading available input.
6979 Note that each terminal device has its own `struct terminal' object,
6980 and so this function is called once for each individual termcap
6981 terminal. The first parameter indicates which terminal to read from. */
6984 tty_read_avail_input (struct terminal
*terminal
,
6985 struct input_event
*hold_quit
)
6987 /* Using KBD_BUFFER_SIZE - 1 here avoids reading more than
6988 the kbd_buffer can really hold. That may prevent loss
6989 of characters on some systems when input is stuffed at us. */
6990 unsigned char cbuf
[KBD_BUFFER_SIZE
- 1];
6995 struct tty_display_info
*tty
= terminal
->display_info
.tty
;
6998 int buffer_free
= KBD_BUFFER_SIZE
- kbd_buffer_nr_stored () - 1;
7000 if (kbd_on_hold_p () || buffer_free
<= 0)
7002 #endif /* subprocesses */
7004 if (!terminal
->name
) /* Don't read from a dead terminal. */
7007 if (terminal
->type
!= output_termcap
7008 && terminal
->type
!= output_msdos_raw
)
7011 /* XXX I think the following code should be moved to separate hook
7012 functions in system-dependent files. */
7014 /* FIXME: AFAIK, tty_read_avail_input is not used under w32 since the non-GUI
7015 code sets read_socket_hook to w32_console_read_socket instead! */
7017 #else /* not WINDOWSNT */
7018 if (! tty
->term_initted
) /* In case we get called during bootstrap. */
7022 return 0; /* The terminal is suspended. */
7025 n_to_read
= dos_keysns ();
7029 cbuf
[0] = dos_keyread ();
7032 #else /* not MSDOS */
7037 struct input_event gpm_hold_quit
;
7038 int gpm
, fd
= gpm_fd
;
7040 EVENT_INIT (gpm_hold_quit
);
7041 gpm_hold_quit
.kind
= NO_EVENT
;
7043 /* gpm==1 if event received.
7044 gpm==0 if the GPM daemon has closed the connection, in which case
7045 Gpm_GetEvent closes gpm_fd and clears it to -1, which is why
7046 we save it in `fd' so close_gpm can remove it from the
7048 gpm==-1 if a protocol error or EWOULDBLOCK; the latter is normal. */
7049 while (gpm
= Gpm_GetEvent (&event
), gpm
== 1) {
7050 nread
+= handle_one_term_event (tty
, &event
, &gpm_hold_quit
);
7053 /* Presumably the GPM daemon has closed the connection. */
7055 if (gpm_hold_quit
.kind
!= NO_EVENT
)
7056 kbd_buffer_store_event (&gpm_hold_quit
);
7060 #endif /* HAVE_GPM */
7062 /* Determine how many characters we should *try* to read. */
7063 #ifdef USABLE_FIONREAD
7064 /* Find out how much input is available. */
7065 if (ioctl (fileno (tty
->input
), FIONREAD
, &n_to_read
) < 0)
7067 if (! noninteractive
)
7068 return -2; /* Close this terminal. */
7074 if (n_to_read
> sizeof cbuf
)
7075 n_to_read
= sizeof cbuf
;
7076 #elif defined USG || defined CYGWIN
7077 /* Read some input if available, but don't wait. */
7078 n_to_read
= sizeof cbuf
;
7079 fcntl (fileno (tty
->input
), F_SETFL
, O_NONBLOCK
);
7081 # error "Cannot read without possibly delaying"
7085 /* Don't read more than we can store. */
7086 if (n_to_read
> buffer_free
)
7087 n_to_read
= buffer_free
;
7088 #endif /* subprocesses */
7090 /* Now read; for one reason or another, this will not block.
7091 NREAD is set to the number of chars read. */
7092 nread
= emacs_read (fileno (tty
->input
), (char *) cbuf
, n_to_read
);
7093 /* POSIX infers that processes which are not in the session leader's
7094 process group won't get SIGHUPs at logout time. BSDI adheres to
7095 this part standard and returns -1 from read (0) with errno==EIO
7096 when the control tty is taken away.
7097 Jeffrey Honig <jch@bsdi.com> says this is generally safe. */
7098 if (nread
== -1 && errno
== EIO
)
7099 return -2; /* Close this terminal. */
7100 #if defined AIX && defined _BSD
7101 /* The kernel sometimes fails to deliver SIGHUP for ptys.
7102 This looks incorrect, but it isn't, because _BSD causes
7103 O_NDELAY to be defined in fcntl.h as O_NONBLOCK,
7104 and that causes a value other than 0 when there is no input. */
7106 return -2; /* Close this terminal. */
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
= false;
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
= true;
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
= true;
7293 debug_on_quit
= true;
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
= false;
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
= true;
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 maybe_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. */
7488 ptrdiff_t nminor
= current_minor_maps (NULL
, &tmaps
);
7489 SAFE_NALLOCA (maps
, 1, nminor
+ 4);
7491 Lisp_Object tem
= KVAR (current_kboard
, Voverriding_terminal_local_map
);
7492 if (!NILP (tem
) && !NILP (Voverriding_local_map_menu_flag
))
7493 maps
[nmaps
++] = tem
;
7494 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
7495 maps
[nmaps
++] = tem
;
7498 memcpy (maps
+ nmaps
, tmaps
, nminor
* sizeof (maps
[0]));
7501 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
7503 maps
[nmaps
++] = current_global_map
;
7506 /* Look up in each map the dummy prefix key `menu-bar'. */
7508 for (mapno
= nmaps
- 1; mapno
>= 0; mapno
--)
7509 if (!NILP (maps
[mapno
]))
7511 def
= get_keymap (access_keymap (maps
[mapno
], Qmenu_bar
, 1, 0, 1),
7515 menu_bar_one_keymap_changed_items
= Qnil
;
7516 map_keymap_canonical (def
, menu_bar_item
, Qnil
, NULL
);
7520 /* Move to the end those items that should be at the end. */
7522 for (tail
= Vmenu_bar_final_items
; CONSP (tail
); tail
= XCDR (tail
))
7525 int end
= menu_bar_items_index
;
7527 for (i
= 0; i
< end
; i
+= 4)
7528 if (EQ (XCAR (tail
), AREF (menu_bar_items_vector
, i
)))
7530 Lisp_Object tem0
, tem1
, tem2
, tem3
;
7531 /* Move the item at index I to the end,
7532 shifting all the others forward. */
7533 tem0
= AREF (menu_bar_items_vector
, i
+ 0);
7534 tem1
= AREF (menu_bar_items_vector
, i
+ 1);
7535 tem2
= AREF (menu_bar_items_vector
, i
+ 2);
7536 tem3
= AREF (menu_bar_items_vector
, i
+ 3);
7538 memmove (aref_addr (menu_bar_items_vector
, i
),
7539 aref_addr (menu_bar_items_vector
, i
+ 4),
7540 (end
- i
- 4) * word_size
);
7541 ASET (menu_bar_items_vector
, end
- 4, tem0
);
7542 ASET (menu_bar_items_vector
, end
- 3, tem1
);
7543 ASET (menu_bar_items_vector
, end
- 2, tem2
);
7544 ASET (menu_bar_items_vector
, end
- 1, tem3
);
7549 /* Add nil, nil, nil, nil at the end. */
7551 int i
= menu_bar_items_index
;
7552 if (i
+ 4 > ASIZE (menu_bar_items_vector
))
7553 menu_bar_items_vector
7554 = larger_vector (menu_bar_items_vector
, 4, -1);
7555 /* Add this item. */
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 ASET (menu_bar_items_vector
, i
, Qnil
); i
++;
7560 menu_bar_items_index
= i
;
7563 Vinhibit_quit
= oquit
;
7565 return menu_bar_items_vector
;
7568 /* Add one item to menu_bar_items_vector, for KEY, ITEM_STRING and DEF.
7569 If there's already an item for KEY, add this DEF to it. */
7571 Lisp_Object item_properties
;
7574 menu_bar_item (Lisp_Object key
, Lisp_Object item
, Lisp_Object dummy1
, void *dummy2
)
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. */
7608 parsed
= parse_menu_item (item
, 1);
7612 item
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7614 /* Find any existing item for this KEY. */
7615 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7616 if (EQ (key
, AREF (menu_bar_items_vector
, i
)))
7619 /* If we did not find this KEY, add it at the end. */
7620 if (i
== menu_bar_items_index
)
7622 /* If vector is too small, get a bigger one. */
7623 if (i
+ 4 > ASIZE (menu_bar_items_vector
))
7624 menu_bar_items_vector
= larger_vector (menu_bar_items_vector
, 4, -1);
7625 /* Add this item. */
7626 ASET (menu_bar_items_vector
, i
, key
); i
++;
7627 ASET (menu_bar_items_vector
, i
,
7628 AREF (item_properties
, ITEM_PROPERTY_NAME
)); i
++;
7629 ASET (menu_bar_items_vector
, i
, list1 (item
)); i
++;
7630 ASET (menu_bar_items_vector
, i
, make_number (0)); i
++;
7631 menu_bar_items_index
= i
;
7633 /* We did find an item for this KEY. Add ITEM to its list of maps. */
7637 old
= AREF (menu_bar_items_vector
, i
+ 2);
7638 /* If the new and the old items are not both keymaps,
7639 the lookup will only find `item'. */
7640 item
= Fcons (item
, KEYMAPP (item
) && KEYMAPP (XCAR (old
)) ? old
: Qnil
);
7641 ASET (menu_bar_items_vector
, i
+ 2, item
);
7645 /* This is used as the handler when calling menu_item_eval_property. */
7647 menu_item_eval_property_1 (Lisp_Object arg
)
7649 /* If we got a quit from within the menu computation,
7650 quit all the way out of it. This takes care of C-] in the debugger. */
7651 if (CONSP (arg
) && EQ (XCAR (arg
), Qquit
))
7658 eval_dyn (Lisp_Object form
)
7660 return Feval (form
, Qnil
);
7663 /* Evaluate an expression and return the result (or nil if something
7664 went wrong). Used to evaluate dynamic parts of menu items. */
7666 menu_item_eval_property (Lisp_Object sexpr
)
7668 ptrdiff_t count
= SPECPDL_INDEX ();
7670 specbind (Qinhibit_redisplay
, Qt
);
7671 val
= internal_condition_case_1 (eval_dyn
, sexpr
, Qerror
,
7672 menu_item_eval_property_1
);
7673 return unbind_to (count
, val
);
7676 /* This function parses a menu item and leaves the result in the
7677 vector item_properties.
7678 ITEM is a key binding, a possible menu item.
7679 INMENUBAR is > 0 when this is considered for an entry in a menu bar
7681 INMENUBAR is < 0 when this is considered for an entry in a keyboard menu.
7682 parse_menu_item returns true if the item is a menu item and false
7686 parse_menu_item (Lisp_Object item
, int inmenubar
)
7688 Lisp_Object def
, tem
, item_string
, start
;
7690 Lisp_Object keyhint
;
7699 /* Create item_properties vector if necessary. */
7700 if (NILP (item_properties
))
7702 = Fmake_vector (make_number (ITEM_PROPERTY_ENABLE
+ 1), Qnil
);
7704 /* Initialize optional entries. */
7705 for (i
= ITEM_PROPERTY_DEF
; i
< ITEM_PROPERTY_ENABLE
; i
++)
7706 ASET (item_properties
, i
, Qnil
);
7707 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7709 /* Save the item here to protect it from GC. */
7710 ASET (item_properties
, ITEM_PROPERTY_ITEM
, item
);
7712 item_string
= XCAR (item
);
7716 if (STRINGP (item_string
))
7718 /* Old format menu item. */
7719 ASET (item_properties
, ITEM_PROPERTY_NAME
, item_string
);
7721 /* Maybe help string. */
7722 if (CONSP (item
) && STRINGP (XCAR (item
)))
7724 ASET (item_properties
, ITEM_PROPERTY_HELP
,
7725 Fsubstitute_command_keys (XCAR (item
)));
7730 /* Maybe an obsolete key binding cache. */
7731 if (CONSP (item
) && CONSP (XCAR (item
))
7732 && (NILP (XCAR (XCAR (item
)))
7733 || VECTORP (XCAR (XCAR (item
)))))
7736 /* This is the real definition--the function to run. */
7737 ASET (item_properties
, ITEM_PROPERTY_DEF
, item
);
7739 /* Get enable property, if any. */
7742 tem
= Fget (item
, Qmenu_enable
);
7743 if (!NILP (Venable_disabled_menus_and_buttons
))
7744 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7745 else if (!NILP (tem
))
7746 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, tem
);
7749 else if (EQ (item_string
, Qmenu_item
) && CONSP (item
))
7751 /* New format menu item. */
7752 ASET (item_properties
, ITEM_PROPERTY_NAME
, XCAR (item
));
7753 start
= XCDR (item
);
7756 /* We have a real binding. */
7757 ASET (item_properties
, ITEM_PROPERTY_DEF
, XCAR (start
));
7759 item
= XCDR (start
);
7760 /* Is there an obsolete cache list with key equivalences. */
7761 if (CONSP (item
) && CONSP (XCAR (item
)))
7764 /* Parse properties. */
7765 while (CONSP (item
) && CONSP (XCDR (item
)))
7770 if (EQ (tem
, QCenable
))
7772 if (!NILP (Venable_disabled_menus_and_buttons
))
7773 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7775 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, XCAR (item
));
7777 else if (EQ (tem
, QCvisible
))
7779 /* If got a visible property and that evaluates to nil
7780 then ignore this item. */
7781 tem
= menu_item_eval_property (XCAR (item
));
7785 else if (EQ (tem
, QChelp
))
7787 Lisp_Object help
= XCAR (item
);
7789 help
= Fsubstitute_command_keys (help
);
7790 ASET (item_properties
, ITEM_PROPERTY_HELP
, help
);
7792 else if (EQ (tem
, QCfilter
))
7794 else if (EQ (tem
, QCkey_sequence
))
7797 if (SYMBOLP (tem
) || STRINGP (tem
) || VECTORP (tem
))
7798 /* Be GC protected. Set keyhint to item instead of tem. */
7801 else if (EQ (tem
, QCkeys
))
7804 if (CONSP (tem
) || STRINGP (tem
))
7805 ASET (item_properties
, ITEM_PROPERTY_KEYEQ
, tem
);
7807 else if (EQ (tem
, QCbutton
) && CONSP (XCAR (item
)))
7812 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
7814 ASET (item_properties
, ITEM_PROPERTY_SELECTED
,
7816 ASET (item_properties
, ITEM_PROPERTY_TYPE
, type
);
7822 else if (inmenubar
|| !NILP (start
))
7826 return 0; /* not a menu item */
7828 /* If item string is not a string, evaluate it to get string.
7829 If we don't get a string, skip this item. */
7830 item_string
= AREF (item_properties
, ITEM_PROPERTY_NAME
);
7831 if (!(STRINGP (item_string
)))
7833 item_string
= menu_item_eval_property (item_string
);
7834 if (!STRINGP (item_string
))
7836 ASET (item_properties
, ITEM_PROPERTY_NAME
, item_string
);
7839 /* If got a filter apply it on definition. */
7840 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7843 def
= menu_item_eval_property (list2 (XCAR (filter
),
7844 list2 (Qquote
, def
)));
7846 ASET (item_properties
, ITEM_PROPERTY_DEF
, def
);
7849 /* Enable or disable selection of item. */
7850 tem
= AREF (item_properties
, ITEM_PROPERTY_ENABLE
);
7853 tem
= menu_item_eval_property (tem
);
7854 if (inmenubar
&& NILP (tem
))
7855 return 0; /* Ignore disabled items in menu bar. */
7856 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, tem
);
7859 /* If we got no definition, this item is just unselectable text which
7860 is OK in a submenu but not in the menubar. */
7862 return (!inmenubar
);
7864 /* See if this is a separate pane or a submenu. */
7865 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7866 tem
= get_keymap (def
, 0, 1);
7867 /* For a subkeymap, just record its details and exit. */
7870 ASET (item_properties
, ITEM_PROPERTY_MAP
, tem
);
7871 ASET (item_properties
, ITEM_PROPERTY_DEF
, tem
);
7875 /* At the top level in the menu bar, do likewise for commands also.
7876 The menu bar does not display equivalent key bindings anyway.
7877 ITEM_PROPERTY_DEF is already set up properly. */
7881 { /* This is a command. See if there is an equivalent key binding. */
7882 Lisp_Object keyeq
= AREF (item_properties
, ITEM_PROPERTY_KEYEQ
);
7883 AUTO_STRING (space_space
, " ");
7885 /* The previous code preferred :key-sequence to :keys, so we
7886 preserve this behavior. */
7887 if (STRINGP (keyeq
) && !CONSP (keyhint
))
7888 keyeq
= concat2 (space_space
, Fsubstitute_command_keys (keyeq
));
7891 Lisp_Object prefix
= keyeq
;
7892 Lisp_Object keys
= Qnil
;
7896 def
= XCAR (prefix
);
7897 prefix
= XCDR (prefix
);
7900 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7902 if (CONSP (keyhint
) && !NILP (XCAR (keyhint
)))
7904 keys
= XCAR (keyhint
);
7905 tem
= Fkey_binding (keys
, Qnil
, Qnil
, Qnil
);
7907 /* We have a suggested key. Is it bound to the command? */
7910 /* If the command is an alias for another
7911 (such as lmenu.el set it up), check if the
7912 original command matches the cached command. */
7914 && EQ (tem
, XSYMBOL (def
)->u
.s
.function
))))
7919 keys
= Fwhere_is_internal (def
, Qnil
, Qt
, Qnil
, Qnil
);
7923 tem
= Fkey_description (keys
, Qnil
);
7926 if (STRINGP (XCAR (prefix
)))
7927 tem
= concat2 (XCAR (prefix
), tem
);
7928 if (STRINGP (XCDR (prefix
)))
7929 tem
= concat2 (tem
, XCDR (prefix
));
7931 keyeq
= concat2 (space_space
, tem
);
7937 /* If we have an equivalent key binding, use that. */
7938 ASET (item_properties
, ITEM_PROPERTY_KEYEQ
, keyeq
);
7941 /* Include this when menu help is implemented.
7942 tem = XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP];
7943 if (!(NILP (tem) || STRINGP (tem)))
7945 tem = menu_item_eval_property (tem);
7948 XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP] = tem;
7952 /* Handle radio buttons or toggle boxes. */
7953 tem
= AREF (item_properties
, ITEM_PROPERTY_SELECTED
);
7955 ASET (item_properties
, ITEM_PROPERTY_SELECTED
,
7956 menu_item_eval_property (tem
));
7963 /***********************************************************************
7965 ***********************************************************************/
7967 /* A vector holding tool bar items while they are parsed in function
7968 tool_bar_items. Each item occupies TOOL_BAR_ITEM_NSCLOTS elements
7971 static Lisp_Object tool_bar_items_vector
;
7973 /* A vector holding the result of parse_tool_bar_item. Layout is like
7974 the one for a single item in tool_bar_items_vector. */
7976 static Lisp_Object tool_bar_item_properties
;
7978 /* Next free index in tool_bar_items_vector. */
7980 static int ntool_bar_items
;
7982 /* Function prototypes. */
7984 static void init_tool_bar_items (Lisp_Object
);
7985 static void process_tool_bar_item (Lisp_Object
, Lisp_Object
, Lisp_Object
,
7987 static bool parse_tool_bar_item (Lisp_Object
, Lisp_Object
);
7988 static void append_tool_bar_item (void);
7991 /* Return a vector of tool bar items for keymaps currently in effect.
7992 Reuse vector REUSE if non-nil. Return in *NITEMS the number of
7993 tool bar items found. */
7996 tool_bar_items (Lisp_Object reuse
, int *nitems
)
7999 Lisp_Object mapsbuf
[3];
8007 /* In order to build the menus, we need to call the keymap
8008 accessors. They all call maybe_quit. But this function is called
8009 during redisplay, during which a quit is fatal. So inhibit
8010 quitting while building the menus. We do this instead of
8011 specbind because (1) errors will clear it anyway and (2) this
8012 avoids risk of specpdl overflow. */
8013 oquit
= Vinhibit_quit
;
8016 /* Initialize tool_bar_items_vector and protect it from GC. */
8017 init_tool_bar_items (reuse
);
8019 /* Build list of keymaps in maps. Set nmaps to the number of maps
8022 /* Should overriding-terminal-local-map and overriding-local-map apply? */
8023 if (!NILP (Voverriding_local_map_menu_flag
)
8024 && !NILP (Voverriding_local_map
))
8026 /* Yes, use them (if non-nil) as well as the global map. */
8029 if (!NILP (KVAR (current_kboard
, Voverriding_terminal_local_map
)))
8030 maps
[nmaps
++] = KVAR (current_kboard
, Voverriding_terminal_local_map
);
8031 if (!NILP (Voverriding_local_map
))
8032 maps
[nmaps
++] = Voverriding_local_map
;
8036 /* No, so use major and minor mode keymaps and keymap property.
8037 Note that tool-bar bindings in the local-map and keymap
8038 properties may not work reliable, as they are only
8039 recognized when the tool-bar (or mode-line) is updated,
8040 which does not normally happen after every command. */
8041 ptrdiff_t nminor
= current_minor_maps (NULL
, &tmaps
);
8042 SAFE_NALLOCA (maps
, 1, nminor
+ 4);
8044 Lisp_Object tem
= KVAR (current_kboard
, Voverriding_terminal_local_map
);
8045 if (!NILP (tem
) && !NILP (Voverriding_local_map_menu_flag
))
8046 maps
[nmaps
++] = tem
;
8047 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
8048 maps
[nmaps
++] = tem
;
8051 memcpy (maps
+ nmaps
, tmaps
, nminor
* sizeof (maps
[0]));
8054 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
8057 /* Add global keymap at the end. */
8058 maps
[nmaps
++] = current_global_map
;
8060 /* Process maps in reverse order and look up in each map the prefix
8062 for (i
= nmaps
- 1; i
>= 0; --i
)
8063 if (!NILP (maps
[i
]))
8067 keymap
= get_keymap (access_keymap (maps
[i
], Qtool_bar
, 1, 0, 1), 0, 1);
8069 map_keymap (keymap
, process_tool_bar_item
, Qnil
, NULL
, 1);
8072 Vinhibit_quit
= oquit
;
8073 *nitems
= ntool_bar_items
/ TOOL_BAR_ITEM_NSLOTS
;
8075 return tool_bar_items_vector
;
8079 /* Process the definition of KEY which is DEF. */
8082 process_tool_bar_item (Lisp_Object key
, Lisp_Object def
, Lisp_Object data
, void *args
)
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 ();
8111 /* Access slot with index IDX of vector tool_bar_item_properties. */
8112 #define PROP(IDX) AREF (tool_bar_item_properties, (IDX))
8114 set_prop (ptrdiff_t idx
, Lisp_Object val
)
8116 ASET (tool_bar_item_properties
, idx
, val
);
8120 /* Parse a tool bar item specification ITEM for key KEY and return the
8121 result in tool_bar_item_properties. Value is false if ITEM is
8124 ITEM is a list `(menu-item CAPTION BINDING PROPS...)'.
8126 CAPTION is the caption of the item, If it's not a string, it is
8127 evaluated to get a string.
8129 BINDING is the tool bar item's binding. Tool-bar items with keymaps
8130 as binding are currently ignored.
8132 The following properties are recognized:
8136 FORM is evaluated and specifies whether the tool bar item is
8137 enabled or disabled.
8141 FORM is evaluated and specifies whether the tool bar item is visible.
8143 - `:filter FUNCTION'
8145 FUNCTION is invoked with one parameter `(quote BINDING)'. Its
8146 result is stored as the new binding.
8148 - `:button (TYPE SELECTED)'
8150 TYPE must be one of `:radio' or `:toggle'. SELECTED is evaluated
8151 and specifies whether the button is selected (pressed) or not.
8155 IMAGES is either a single image specification or a vector of four
8156 image specifications. See enum tool_bar_item_images.
8158 - `:help HELP-STRING'.
8160 Gives a help string to display for the tool bar item.
8162 - `:label LABEL-STRING'.
8164 A text label to show with the tool bar button if labels are enabled. */
8167 parse_tool_bar_item (Lisp_Object key
, Lisp_Object item
)
8169 Lisp_Object filter
= Qnil
;
8170 Lisp_Object caption
;
8172 bool have_label
= false;
8174 /* Definition looks like `(menu-item CAPTION BINDING PROPS...)'.
8175 Rule out items that aren't lists, don't start with
8176 `menu-item' or whose rest following `tool-bar-item' is not a
8181 /* As an exception, allow old-style menu separators. */
8182 if (STRINGP (XCAR (item
)))
8183 item
= list1 (XCAR (item
));
8184 else if (!EQ (XCAR (item
), Qmenu_item
)
8185 || (item
= XCDR (item
), !CONSP (item
)))
8188 /* Create tool_bar_item_properties vector if necessary. Reset it to
8190 if (VECTORP (tool_bar_item_properties
))
8192 for (i
= 0; i
< TOOL_BAR_ITEM_NSLOTS
; ++i
)
8196 tool_bar_item_properties
8197 = Fmake_vector (make_number (TOOL_BAR_ITEM_NSLOTS
), Qnil
);
8200 set_prop (TOOL_BAR_ITEM_KEY
, key
);
8201 set_prop (TOOL_BAR_ITEM_ENABLED_P
, Qt
);
8203 /* Get the caption of the item. If the caption is not a string,
8204 evaluate it to get a string. If we don't get a string, skip this
8206 caption
= XCAR (item
);
8207 if (!STRINGP (caption
))
8209 caption
= menu_item_eval_property (caption
);
8210 if (!STRINGP (caption
))
8213 set_prop (TOOL_BAR_ITEM_CAPTION
, caption
);
8215 /* If the rest following the caption is not a list, the menu item is
8216 either a separator, or invalid. */
8220 if (menu_separator_name_p (SSDATA (caption
)))
8222 set_prop (TOOL_BAR_ITEM_TYPE
, Qt
);
8223 #if !defined (USE_GTK) && !defined (HAVE_NS)
8224 /* If we use build_desired_tool_bar_string to render the
8225 tool bar, the separator is rendered as an image. */
8226 set_prop (TOOL_BAR_ITEM_IMAGES
,
8227 (menu_item_eval_property
8228 (Vtool_bar_separator_image_expression
)));
8229 set_prop (TOOL_BAR_ITEM_ENABLED_P
, Qnil
);
8230 set_prop (TOOL_BAR_ITEM_SELECTED_P
, Qnil
);
8231 set_prop (TOOL_BAR_ITEM_CAPTION
, Qnil
);
8238 /* Store the binding. */
8239 set_prop (TOOL_BAR_ITEM_BINDING
, XCAR (item
));
8242 /* Ignore cached key binding, if any. */
8243 if (CONSP (item
) && CONSP (XCAR (item
)))
8246 /* Process the rest of the properties. */
8247 for (; CONSP (item
) && CONSP (XCDR (item
)); item
= XCDR (XCDR (item
)))
8249 Lisp_Object ikey
, value
;
8252 value
= XCAR (XCDR (item
));
8254 if (EQ (ikey
, QCenable
))
8256 /* `:enable FORM'. */
8257 if (!NILP (Venable_disabled_menus_and_buttons
))
8258 set_prop (TOOL_BAR_ITEM_ENABLED_P
, Qt
);
8260 set_prop (TOOL_BAR_ITEM_ENABLED_P
, value
);
8262 else if (EQ (ikey
, QCvisible
))
8264 /* `:visible FORM'. If got a visible property and that
8265 evaluates to nil then ignore this item. */
8266 if (NILP (menu_item_eval_property (value
)))
8269 else if (EQ (ikey
, QChelp
))
8270 /* `:help HELP-STRING'. */
8271 set_prop (TOOL_BAR_ITEM_HELP
, value
);
8272 else if (EQ (ikey
, QCvert_only
))
8273 /* `:vert-only t/nil'. */
8274 set_prop (TOOL_BAR_ITEM_VERT_ONLY
, value
);
8275 else if (EQ (ikey
, QClabel
))
8277 const char *bad_label
= "!!?GARBLED ITEM?!!";
8278 /* `:label LABEL-STRING'. */
8279 set_prop (TOOL_BAR_ITEM_LABEL
,
8280 STRINGP (value
) ? value
: build_string (bad_label
));
8283 else if (EQ (ikey
, QCfilter
))
8284 /* ':filter FORM'. */
8286 else if (EQ (ikey
, QCbutton
) && CONSP (value
))
8288 /* `:button (TYPE . SELECTED)'. */
8289 Lisp_Object type
, selected
;
8291 type
= XCAR (value
);
8292 selected
= XCDR (value
);
8293 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
8295 set_prop (TOOL_BAR_ITEM_SELECTED_P
, selected
);
8296 set_prop (TOOL_BAR_ITEM_TYPE
, type
);
8299 else if (EQ (ikey
, QCimage
)
8301 || (VECTORP (value
) && ASIZE (value
) == 4)))
8302 /* Value is either a single image specification or a vector
8303 of 4 such specifications for the different button states. */
8304 set_prop (TOOL_BAR_ITEM_IMAGES
, value
);
8305 else if (EQ (ikey
, QCrtl
))
8307 set_prop (TOOL_BAR_ITEM_RTL_IMAGE
, value
);
8313 /* Try to make one from caption and key. */
8314 Lisp_Object tkey
= PROP (TOOL_BAR_ITEM_KEY
);
8315 Lisp_Object tcapt
= PROP (TOOL_BAR_ITEM_CAPTION
);
8316 const char *label
= SYMBOLP (tkey
) ? SSDATA (SYMBOL_NAME (tkey
)) : "";
8317 const char *capt
= STRINGP (tcapt
) ? SSDATA (tcapt
) : "";
8319 2 * max (0, min (tool_bar_max_label_size
, STRING_BYTES_BOUND
/ 2));
8320 char *buf
= xmalloc (max_lbl
+ 1);
8321 Lisp_Object new_lbl
;
8322 ptrdiff_t caption_len
= strlen (capt
);
8324 if (caption_len
<= max_lbl
&& capt
[0] != '\0')
8327 while (caption_len
> 0 && buf
[caption_len
- 1] == '.')
8329 buf
[caption_len
] = '\0';
8333 if (strlen (label
) <= max_lbl
&& label
[0] != '\0')
8337 strcpy (buf
, label
);
8339 for (j
= 0; buf
[j
] != '\0'; ++j
)
8347 new_lbl
= Fupcase_initials (build_string (label
));
8348 if (SCHARS (new_lbl
) <= tool_bar_max_label_size
)
8349 set_prop (TOOL_BAR_ITEM_LABEL
, new_lbl
);
8351 set_prop (TOOL_BAR_ITEM_LABEL
, empty_unibyte_string
);
8355 /* If got a filter apply it on binding. */
8357 set_prop (TOOL_BAR_ITEM_BINDING
,
8358 (menu_item_eval_property
8361 PROP (TOOL_BAR_ITEM_BINDING
))))));
8363 /* See if the binding is a keymap. Give up if it is. */
8364 if (CONSP (get_keymap (PROP (TOOL_BAR_ITEM_BINDING
), 0, 1)))
8367 /* Enable or disable selection of item. */
8368 if (!EQ (PROP (TOOL_BAR_ITEM_ENABLED_P
), Qt
))
8369 set_prop (TOOL_BAR_ITEM_ENABLED_P
,
8370 menu_item_eval_property (PROP (TOOL_BAR_ITEM_ENABLED_P
)));
8372 /* Handle radio buttons or toggle boxes. */
8373 if (!NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
)))
8374 set_prop (TOOL_BAR_ITEM_SELECTED_P
,
8375 menu_item_eval_property (PROP (TOOL_BAR_ITEM_SELECTED_P
)));
8383 /* Initialize tool_bar_items_vector. REUSE, if non-nil, is a vector
8384 that can be reused. */
8387 init_tool_bar_items (Lisp_Object reuse
)
8389 if (VECTORP (reuse
))
8390 tool_bar_items_vector
= reuse
;
8392 tool_bar_items_vector
= Fmake_vector (make_number (64), Qnil
);
8393 ntool_bar_items
= 0;
8397 /* Append parsed tool bar item properties from
8398 tool_bar_item_properties */
8401 append_tool_bar_item (void)
8405 - (ASIZE (tool_bar_items_vector
) - TOOL_BAR_ITEM_NSLOTS
));
8407 /* Enlarge tool_bar_items_vector if necessary. */
8409 tool_bar_items_vector
= larger_vector (tool_bar_items_vector
, incr
, -1);
8411 /* Append entries from tool_bar_item_properties to the end of
8412 tool_bar_items_vector. */
8413 vcopy (tool_bar_items_vector
, ntool_bar_items
,
8414 XVECTOR (tool_bar_item_properties
)->contents
, TOOL_BAR_ITEM_NSLOTS
);
8415 ntool_bar_items
+= TOOL_BAR_ITEM_NSLOTS
;
8422 /* Read a character using menus based on the keymap MAP.
8423 Return nil if there are no menus in the maps.
8424 Return t if we displayed a menu but the user rejected it.
8426 PREV_EVENT is the previous input event, or nil if we are reading
8427 the first event of a key sequence.
8429 If USED_MOUSE_MENU is non-null, set *USED_MOUSE_MENU to true
8430 if we used a mouse menu to read the input, or false otherwise. If
8431 USED_MOUSE_MENU is null, don't dereference it.
8433 The prompting is done based on the prompt-string of the map
8434 and the strings associated with various map elements.
8436 This can be done with X menus or with menus put in the minibuf.
8437 These are done in different ways, depending on how the input will be read.
8438 Menus using X are done after auto-saving in read-char, getting the input
8439 event from Fx_popup_menu; menus using the minibuf use read_char recursively
8440 and do auto-saving in the inner call of read_char. */
8443 read_char_x_menu_prompt (Lisp_Object map
,
8444 Lisp_Object prev_event
, bool *used_mouse_menu
)
8446 if (used_mouse_menu
)
8447 *used_mouse_menu
= false;
8449 /* Use local over global Menu maps. */
8451 if (! menu_prompting
)
8454 /* If we got to this point via a mouse click,
8455 use a real menu for mouse selection. */
8456 if (EVENT_HAS_PARAMETERS (prev_event
)
8457 && !EQ (XCAR (prev_event
), Qmenu_bar
)
8458 && !EQ (XCAR (prev_event
), Qtool_bar
))
8460 /* Display the menu and get the selection. */
8463 value
= Fx_popup_menu (prev_event
, get_keymap (map
, 0, 1));
8468 record_menu_key (XCAR (value
));
8470 /* If we got multiple events, unread all but
8472 There is no way to prevent those unread events
8473 from showing up later in last_nonmenu_event.
8474 So turn symbol and integer events into lists,
8475 to indicate that they came from a mouse menu,
8476 so that when present in last_nonmenu_event
8477 they won't confuse things. */
8478 for (tem
= XCDR (value
); CONSP (tem
); tem
= XCDR (tem
))
8480 record_menu_key (XCAR (tem
));
8481 if (SYMBOLP (XCAR (tem
))
8482 || INTEGERP (XCAR (tem
)))
8483 XSETCAR (tem
, Fcons (XCAR (tem
), Qdisabled
));
8486 /* If we got more than one event, put all but the first
8487 onto this list to be read later.
8488 Return just the first event now. */
8489 Vunread_command_events
8490 = nconc2 (XCDR (value
), Vunread_command_events
);
8491 value
= XCAR (value
);
8493 else if (NILP (value
))
8495 if (used_mouse_menu
)
8496 *used_mouse_menu
= true;
8503 read_char_minibuf_menu_prompt (int commandflag
,
8508 /* FIXME: Use the minibuffer's frame width. */
8509 ptrdiff_t width
= FRAME_COLS (SELECTED_FRAME ()) - 4;
8511 bool nobindings
= true;
8512 Lisp_Object rest
, vector
;
8513 Lisp_Object prompt_strings
= Qnil
;
8517 if (! menu_prompting
)
8520 map
= get_keymap (map
, 0, 1);
8521 name
= Fkeymap_prompt (map
);
8523 /* If we don't have any menus, just read a character normally. */
8524 if (!STRINGP (name
))
8527 #define PUSH_C_STR(str, listvar) \
8528 listvar = Fcons (build_unibyte_string (str), listvar)
8530 /* Prompt string always starts with map's prompt, and a space. */
8531 prompt_strings
= Fcons (name
, prompt_strings
);
8532 PUSH_C_STR (": ", prompt_strings
);
8533 nlength
= SCHARS (name
) + 2;
8537 /* Present the documented bindings, a line at a time. */
8540 bool notfirst
= false;
8541 Lisp_Object menu_strings
= prompt_strings
;
8542 ptrdiff_t i
= nlength
;
8544 Lisp_Object orig_defn_macro
;
8546 /* Loop over elements of map. */
8551 /* FIXME: Use map_keymap to handle new keymap formats. */
8553 /* At end of map, wrap around if just starting,
8554 or end this line if already have something on it. */
8557 if (notfirst
|| nobindings
)
8563 /* Look at the next element of the map. */
8565 elt
= AREF (vector
, idx
);
8567 elt
= Fcar_safe (rest
);
8569 if (idx
< 0 && VECTORP (elt
))
8571 /* If we found a dense table in the keymap,
8572 advanced past it, but start scanning its contents. */
8573 rest
= Fcdr_safe (rest
);
8579 /* An ordinary element. */
8580 Lisp_Object event
, tem
;
8584 event
= Fcar_safe (elt
); /* alist */
8585 elt
= Fcdr_safe (elt
);
8589 XSETINT (event
, idx
); /* vector */
8592 /* Ignore the element if it has no prompt string. */
8593 if (INTEGERP (event
) && parse_menu_item (elt
, -1))
8595 /* True if the char to type matches the string. */
8597 Lisp_Object upcased_event
, downcased_event
;
8598 Lisp_Object desc
= Qnil
;
8600 = AREF (item_properties
, ITEM_PROPERTY_NAME
);
8602 upcased_event
= Fupcase (event
);
8603 downcased_event
= Fdowncase (event
);
8604 char_matches
= (XINT (upcased_event
) == SREF (s
, 0)
8605 || XINT (downcased_event
) == SREF (s
, 0));
8607 desc
= Fsingle_key_description (event
, Qnil
);
8609 #if 0 /* It is redundant to list the equivalent key bindings because
8610 the prefix is what the user has already typed. */
8612 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_KEYEQ
];
8614 /* Insert equivalent keybinding. */
8615 s
= concat2 (s
, tem
);
8618 = AREF (item_properties
, ITEM_PROPERTY_TYPE
);
8619 if (EQ (tem
, QCradio
) || EQ (tem
, QCtoggle
))
8621 /* Insert button prefix. */
8622 Lisp_Object selected
8623 = AREF (item_properties
, ITEM_PROPERTY_SELECTED
);
8624 AUTO_STRING (radio_yes
, "(*) ");
8625 AUTO_STRING (radio_no
, "( ) ");
8626 AUTO_STRING (check_yes
, "[X] ");
8627 AUTO_STRING (check_no
, "[ ] ");
8628 if (EQ (tem
, QCradio
))
8629 tem
= NILP (selected
) ? radio_yes
: radio_no
;
8631 tem
= NILP (selected
) ? check_yes
: check_no
;
8632 s
= concat2 (tem
, s
);
8636 /* If we have room for the prompt string, add it to this line.
8637 If this is the first on the line, always add it. */
8638 if ((SCHARS (s
) + i
+ 2
8639 + (char_matches
? 0 : SCHARS (desc
) + 3))
8643 ptrdiff_t thiswidth
;
8645 /* Punctuate between strings. */
8648 PUSH_C_STR (", ", menu_strings
);
8654 /* If the char to type doesn't match the string's
8655 first char, explicitly show what char to type. */
8658 /* Add as much of string as fits. */
8659 thiswidth
= min (SCHARS (desc
), width
- i
);
8661 = Fcons (Fsubstring (desc
, make_number (0),
8662 make_number (thiswidth
)),
8665 PUSH_C_STR (" = ", menu_strings
);
8669 /* Add as much of string as fits. */
8670 thiswidth
= min (SCHARS (s
), width
- i
);
8672 = Fcons (Fsubstring (s
, make_number (0),
8673 make_number (thiswidth
)),
8679 /* If this element does not fit, end the line now,
8680 and save the element for the next line. */
8681 PUSH_C_STR ("...", menu_strings
);
8686 /* Move past this element. */
8687 if (idx
>= 0 && idx
+ 1 >= ASIZE (vector
))
8688 /* Handle reaching end of dense table. */
8693 rest
= Fcdr_safe (rest
);
8697 /* Prompt with that and read response. */
8698 message3_nolog (apply1 (intern ("concat"), Fnreverse (menu_strings
)));
8700 /* Make believe it's not a keyboard macro in case the help char
8701 is pressed. Help characters are not recorded because menu prompting
8702 is not used on replay. */
8703 orig_defn_macro
= KVAR (current_kboard
, defining_kbd_macro
);
8704 kset_defining_kbd_macro (current_kboard
, Qnil
);
8706 obj
= read_char (commandflag
, Qnil
, Qt
, 0, NULL
);
8707 while (BUFFERP (obj
));
8708 kset_defining_kbd_macro (current_kboard
, orig_defn_macro
);
8710 if (!INTEGERP (obj
) || XINT (obj
) == -2
8711 || (! EQ (obj
, menu_prompt_more_char
)
8712 && (!INTEGERP (menu_prompt_more_char
)
8713 || ! EQ (obj
, make_number (Ctl (XINT (menu_prompt_more_char
)))))))
8715 if (!NILP (KVAR (current_kboard
, defining_kbd_macro
)))
8716 store_kbd_macro_char (obj
);
8719 /* Help char - go round again. */
8723 /* Reading key sequences. */
8726 follow_key (Lisp_Object keymap
, Lisp_Object key
)
8728 return access_keymap (get_keymap (keymap
, 0, 1),
8733 active_maps (Lisp_Object first_event
)
8735 Lisp_Object position
8736 = CONSP (first_event
) ? CAR_SAFE (XCDR (first_event
)) : Qnil
;
8737 return Fcons (Qkeymap
, Fcurrent_active_maps (Qt
, position
));
8740 /* Structure used to keep track of partial application of key remapping
8741 such as Vfunction_key_map and Vkey_translation_map. */
8742 typedef struct keyremap
8744 /* This is the map originally specified for this use. */
8746 /* This is a submap reached by looking up, in PARENT,
8747 the events from START to END. */
8749 /* Positions [START, END) in the key sequence buffer
8750 are the key that we have scanned so far.
8751 Those events are the ones that we will replace
8752 if PARENT maps them into a key sequence. */
8756 /* Lookup KEY in MAP.
8757 MAP is a keymap mapping keys to key vectors or functions.
8758 If the mapping is a function and DO_FUNCALL is true,
8759 the function is called with PROMPT as parameter and its return
8760 value is used as the return value of this function (after checking
8761 that it is indeed a vector). */
8764 access_keymap_keyremap (Lisp_Object map
, Lisp_Object key
, Lisp_Object prompt
,
8769 next
= access_keymap (map
, key
, 1, 0, 1);
8771 /* Handle a symbol whose function definition is a keymap
8773 if (SYMBOLP (next
) && !NILP (Ffboundp (next
))
8774 && (ARRAYP (XSYMBOL (next
)->u
.s
.function
)
8775 || KEYMAPP (XSYMBOL (next
)->u
.s
.function
)))
8776 next
= Fautoload_do_load (XSYMBOL (next
)->u
.s
.function
, next
, Qnil
);
8778 /* If the keymap gives a function, not an
8779 array, then call the function with one arg and use
8780 its value instead. */
8781 if (do_funcall
&& FUNCTIONP (next
))
8786 next
= call1 (next
, prompt
);
8787 /* If the function returned something invalid,
8788 barf--don't ignore it. */
8789 if (! (NILP (next
) || VECTORP (next
) || STRINGP (next
)))
8790 error ("Function %s returns invalid key sequence",
8791 SSDATA (SYMBOL_NAME (tem
)));
8796 /* Do one step of the key remapping used for function-key-map and
8797 key-translation-map:
8798 KEYBUF is the buffer holding the input events.
8799 BUFSIZE is its maximum size.
8800 FKEY is a pointer to the keyremap structure to use.
8801 INPUT is the index of the last element in KEYBUF.
8802 DOIT if true says that the remapping can actually take place.
8803 DIFF is used to return the number of keys added/removed by the remapping.
8804 PARENT is the root of the keymap.
8805 PROMPT is the prompt to use if the remapping happens through a function.
8806 Return true if the remapping actually took place. */
8809 keyremap_step (Lisp_Object
*keybuf
, int bufsize
, volatile keyremap
*fkey
,
8810 int input
, bool doit
, int *diff
, Lisp_Object prompt
)
8812 Lisp_Object next
, key
;
8814 key
= keybuf
[fkey
->end
++];
8816 if (KEYMAPP (fkey
->parent
))
8817 next
= access_keymap_keyremap (fkey
->map
, key
, prompt
, doit
);
8821 /* If keybuf[fkey->start..fkey->end] is bound in the
8822 map and we're in a position to do the key remapping, replace it with
8823 the binding and restart with fkey->start at the end. */
8824 if ((VECTORP (next
) || STRINGP (next
)) && doit
)
8826 int len
= XFASTINT (Flength (next
));
8829 *diff
= len
- (fkey
->end
- fkey
->start
);
8831 if (bufsize
- input
<= *diff
)
8832 error ("Key sequence too long");
8834 /* Shift the keys that follow fkey->end. */
8836 for (i
= fkey
->end
; i
< input
; i
++)
8837 keybuf
[i
+ *diff
] = keybuf
[i
];
8839 for (i
= input
- 1; i
>= fkey
->end
; i
--)
8840 keybuf
[i
+ *diff
] = keybuf
[i
];
8841 /* Overwrite the old keys with the new ones. */
8842 for (i
= 0; i
< len
; i
++)
8843 keybuf
[fkey
->start
+ i
]
8844 = Faref (next
, make_number (i
));
8846 fkey
->start
= fkey
->end
+= *diff
;
8847 fkey
->map
= fkey
->parent
;
8852 fkey
->map
= get_keymap (next
, 0, 1);
8854 /* If we no longer have a bound suffix, try a new position for
8856 if (!CONSP (fkey
->map
))
8858 fkey
->end
= ++fkey
->start
;
8859 fkey
->map
= fkey
->parent
;
8865 test_undefined (Lisp_Object binding
)
8867 return (NILP (binding
)
8868 || EQ (binding
, Qundefined
)
8869 || (SYMBOLP (binding
)
8870 && EQ (Fcommand_remapping (binding
, Qnil
, Qnil
), Qundefined
)));
8873 /* Read a sequence of keys that ends with a non prefix character,
8874 storing it in KEYBUF, a buffer of size BUFSIZE.
8876 Return the length of the key sequence stored.
8877 Return -1 if the user rejected a command menu.
8879 Echo starting immediately unless `prompt' is 0.
8881 If PREVENT_REDISPLAY is non-zero, avoid redisplay by calling
8882 read_char with a suitable COMMANDFLAG argument.
8884 Where a key sequence ends depends on the currently active keymaps.
8885 These include any minor mode keymaps active in the current buffer,
8886 the current buffer's local map, and the global map.
8888 If a key sequence has no other bindings, we check Vfunction_key_map
8889 to see if some trailing subsequence might be the beginning of a
8890 function key's sequence. If so, we try to read the whole function
8891 key, and substitute its symbolic name into the key sequence.
8893 We ignore unbound `down-' mouse clicks. We turn unbound `drag-' and
8894 `double-' events into similar click events, if that would make them
8895 bound. We try to turn `triple-' events first into `double-' events,
8898 If we get a mouse click in a mode line, vertical divider, or other
8899 non-text area, we treat the click as if it were prefixed by the
8900 symbol denoting that area - `mode-line', `vertical-line', or
8903 If the sequence starts with a mouse click, we read the key sequence
8904 with respect to the buffer clicked on, not the current buffer.
8906 If the user switches frames in the midst of a key sequence, we put
8907 off the switch-frame event until later; the next call to
8908 read_char will return it.
8910 If FIX_CURRENT_BUFFER, we restore current_buffer
8911 from the selected window's buffer. */
8914 read_key_sequence (Lisp_Object
*keybuf
, int bufsize
, Lisp_Object prompt
,
8915 bool dont_downcase_last
, bool can_return_switch_frame
,
8916 bool fix_current_buffer
, bool prevent_redisplay
)
8918 ptrdiff_t count
= SPECPDL_INDEX ();
8920 /* How many keys there are in the current key sequence. */
8923 /* The length of the echo buffer when we started reading, and
8924 the length of this_command_keys when we started reading. */
8925 ptrdiff_t echo_start UNINIT
;
8926 ptrdiff_t keys_start
;
8928 Lisp_Object current_binding
= Qnil
;
8929 Lisp_Object first_event
= Qnil
;
8931 /* Index of the first key that has no binding.
8932 It is useless to try fkey.start larger than that. */
8935 /* If t < mock_input, then KEYBUF[t] should be read as the next
8938 We use this to recover after recognizing a function key. Once we
8939 realize that a suffix of the current key sequence is actually a
8940 function key's escape sequence, we replace the suffix with the
8941 function key's binding from Vfunction_key_map. Now keybuf
8942 contains a new and different key sequence, so the echo area,
8943 this_command_keys, and the submaps and defs arrays are wrong. In
8944 this situation, we set mock_input to t, set t to 0, and jump to
8945 restart_sequence; the loop will read keys from keybuf up until
8946 mock_input, thus rebuilding the state; and then it will resume
8947 reading characters from the keyboard. */
8950 /* If the sequence is unbound in submaps[], then
8951 keybuf[fkey.start..fkey.end-1] is a prefix in Vfunction_key_map,
8952 and fkey.map is its binding.
8954 These might be > t, indicating that all function key scanning
8955 should hold off until t reaches them. We do this when we've just
8956 recognized a function key, to avoid searching for the function
8957 key's again in Vfunction_key_map. */
8960 /* Likewise, for key_translation_map and input-decode-map. */
8961 keyremap keytran
, indec
;
8963 /* True if we are trying to map a key by changing an upper-case
8964 letter to lower case, or a shifted function key to an unshifted
8966 bool shift_translated
= false;
8968 /* If we receive a `switch-frame' or `select-window' event in the middle of
8969 a key sequence, we put it off for later.
8970 While we're reading, we keep the event here. */
8971 Lisp_Object delayed_switch_frame
;
8973 Lisp_Object original_uppercase UNINIT
;
8974 int original_uppercase_position
= -1;
8976 /* Gets around Microsoft compiler limitations. */
8977 bool dummyflag
= false;
8979 struct buffer
*starting_buffer
;
8981 /* List of events for which a fake prefix key has been generated. */
8982 Lisp_Object fake_prefixed_keys
= Qnil
;
8984 raw_keybuf_count
= 0;
8986 last_nonmenu_event
= Qnil
;
8988 delayed_switch_frame
= Qnil
;
8994 /* Install the string PROMPT as the beginning of the string
8995 of echoing, so that it serves as a prompt for the next
8997 kset_echo_prompt (current_kboard
, prompt
);
8998 /* FIXME: This use of echo_now doesn't look quite right and is ugly
8999 since it forces us to fiddle with current_kboard->immediate_echo
9000 before and after. */
9001 current_kboard
->immediate_echo
= false;
9003 if (!echo_keystrokes_p ())
9004 current_kboard
->immediate_echo
= false;
9006 else if (cursor_in_echo_area
/* FIXME: Not sure why we test this here,
9007 maybe we should just drop this test. */
9008 && echo_keystrokes_p ())
9009 /* This doesn't put in a dash if the echo buffer is empty, so
9010 you don't always see a dash hanging out in the minibuffer. */
9014 /* Record the initial state of the echo area and this_command_keys;
9015 we will need to restore them if we replay a key sequence. */
9017 echo_start
= echo_length ();
9018 keys_start
= this_command_key_count
;
9019 this_single_command_key_start
= keys_start
;
9021 /* We jump here when we need to reinitialize fkey and keytran; this
9022 happens if we switch keyboards between rescans. */
9023 replay_entire_sequence
:
9025 indec
.map
= indec
.parent
= KVAR (current_kboard
, Vinput_decode_map
);
9026 fkey
.map
= fkey
.parent
= KVAR (current_kboard
, Vlocal_function_key_map
);
9027 keytran
.map
= keytran
.parent
= Vkey_translation_map
;
9028 indec
.start
= indec
.end
= 0;
9029 fkey
.start
= fkey
.end
= 0;
9030 keytran
.start
= keytran
.end
= 0;
9032 /* We jump here when the key sequence has been thoroughly changed, and
9033 we need to rescan it starting from the beginning. When we jump here,
9034 keybuf[0..mock_input] holds the sequence we should reread. */
9037 starting_buffer
= current_buffer
;
9038 first_unbound
= bufsize
+ 1;
9040 /* Build our list of keymaps.
9041 If we recognize a function key and replace its escape sequence in
9042 keybuf with its symbol, or if the sequence starts with a mouse
9043 click and we need to switch buffers, we jump back here to rebuild
9044 the initial keymaps from the current buffer. */
9045 current_binding
= active_maps (first_event
);
9047 /* Start from the beginning in keybuf. */
9050 /* These are no-ops the first time through, but if we restart, they
9051 revert the echo area and this_command_keys to their original state. */
9052 this_command_key_count
= keys_start
;
9053 if (INTERACTIVE
&& t
< mock_input
)
9054 echo_truncate (echo_start
);
9056 /* If the best binding for the current key sequence is a keymap, or
9057 we may be looking at a function key's escape sequence, keep on
9059 while (!NILP (current_binding
)
9060 /* Keep reading as long as there's a prefix binding. */
9061 ? KEYMAPP (current_binding
)
9062 /* Don't return in the middle of a possible function key sequence,
9063 if the only bindings we found were via case conversion.
9064 Thus, if ESC O a has a function-key-map translation
9065 and ESC o has a binding, don't return after ESC O,
9066 so that we can translate ESC O plus the next character. */
9067 : (/* indec.start < t || fkey.start < t || */ keytran
.start
< t
))
9070 bool used_mouse_menu
= false;
9072 /* Where the last real key started. If we need to throw away a
9073 key that has expanded into more than one element of keybuf
9074 (say, a mouse click on the mode line which is being treated
9075 as [mode-line (mouse-...)], then we backtrack to this point
9077 int last_real_key_start
;
9079 /* These variables are analogous to echo_start and keys_start;
9080 while those allow us to restart the entire key sequence,
9081 echo_local_start and keys_local_start allow us to throw away
9083 ptrdiff_t echo_local_start UNINIT
;
9084 int keys_local_start
;
9085 Lisp_Object new_binding
;
9087 eassert (indec
.end
== t
|| (indec
.end
> t
&& indec
.end
<= mock_input
));
9088 eassert (indec
.start
<= indec
.end
);
9089 eassert (fkey
.start
<= fkey
.end
);
9090 eassert (keytran
.start
<= keytran
.end
);
9091 /* key-translation-map is applied *after* function-key-map
9092 which is itself applied *after* input-decode-map. */
9093 eassert (fkey
.end
<= indec
.start
);
9094 eassert (keytran
.end
<= fkey
.start
);
9096 if (/* first_unbound < indec.start && first_unbound < fkey.start && */
9097 first_unbound
< keytran
.start
)
9098 { /* The prefix upto first_unbound has no binding and has
9099 no translation left to do either, so we know it's unbound.
9100 If we don't stop now, we risk staying here indefinitely
9101 (if the user keeps entering fkey or keytran prefixes
9102 like C-c ESC ESC ESC ESC ...) */
9104 for (i
= first_unbound
+ 1; i
< t
; i
++)
9105 keybuf
[i
- first_unbound
- 1] = keybuf
[i
];
9106 mock_input
= t
- first_unbound
- 1;
9107 indec
.end
= indec
.start
-= first_unbound
+ 1;
9108 indec
.map
= indec
.parent
;
9109 fkey
.end
= fkey
.start
-= first_unbound
+ 1;
9110 fkey
.map
= fkey
.parent
;
9111 keytran
.end
= keytran
.start
-= first_unbound
+ 1;
9112 keytran
.map
= keytran
.parent
;
9113 goto replay_sequence
;
9117 error ("Key sequence too long");
9120 echo_local_start
= echo_length ();
9121 keys_local_start
= this_command_key_count
;
9124 /* These are no-ops, unless we throw away a keystroke below and
9125 jumped back up to replay_key; in that case, these restore the
9126 variables to their original state, allowing us to replay the
9128 if (INTERACTIVE
&& t
< mock_input
)
9129 echo_truncate (echo_local_start
);
9130 this_command_key_count
= keys_local_start
;
9132 /* By default, assume each event is "real". */
9133 last_real_key_start
= t
;
9135 /* Does mock_input indicate that we are re-reading a key sequence? */
9139 add_command_key (key
);
9140 if (current_kboard
->immediate_echo
)
9142 /* Set immediate_echo to false so as to force echo_now to
9143 redisplay (it will set immediate_echo right back to true). */
9144 current_kboard
->immediate_echo
= false;
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
);
9225 /* read_char returns -1 at the end of a macro.
9226 Emacs 18 handles this by returning immediately with a
9227 zero, so that's what we'll do. */
9228 if (INTEGERP (key
) && XINT (key
) == -1)
9231 /* The Microsoft C compiler can't handle the goto that
9237 /* If the current buffer has been changed from under us, the
9238 keymap may have changed, so replay the sequence. */
9241 timer_resume_idle ();
9244 /* Reset the current buffer from the selected window
9245 in case something changed the former and not the latter.
9246 This is to be more consistent with the behavior
9247 of the command_loop_1. */
9248 if (fix_current_buffer
)
9250 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
9252 if (XBUFFER (XWINDOW (selected_window
)->contents
)
9254 Fset_buffer (XWINDOW (selected_window
)->contents
);
9257 goto replay_sequence
;
9260 /* If we have a quit that was typed in another frame, and
9261 quit_throw_to_read_char switched buffers,
9262 replay to get the right keymap. */
9264 && XINT (key
) == quit_char
9265 && current_buffer
!= starting_buffer
)
9268 ASET (raw_keybuf
, raw_keybuf_count
, key
);
9273 goto replay_sequence
;
9278 if (EVENT_HAS_PARAMETERS (key
)
9279 /* Either a `switch-frame' or a `select-window' event. */
9280 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)), Qswitch_frame
))
9282 /* If we're at the beginning of a key sequence, and the caller
9283 says it's okay, go ahead and return this event. If we're
9284 in the midst of a key sequence, delay it until the end. */
9285 if (t
> 0 || !can_return_switch_frame
)
9287 delayed_switch_frame
= key
;
9292 if (NILP (first_event
))
9295 /* Even if first_event does not specify a particular
9296 window/position, it's important to recompute the maps here
9297 since a long time might have passed since we entered
9298 read_key_sequence, and a timer (or process-filter or
9299 special-event-map, ...) might have switched the current buffer
9300 or the selected window from under us in the mean time. */
9301 if (fix_current_buffer
9302 && (XBUFFER (XWINDOW (selected_window
)->contents
)
9304 Fset_buffer (XWINDOW (selected_window
)->contents
);
9305 current_binding
= active_maps (first_event
);
9309 ASET (raw_keybuf
, raw_keybuf_count
, key
);
9313 /* Clicks in non-text areas get prefixed by the symbol
9314 in their CHAR-ADDRESS field. For example, a click on
9315 the mode line is prefixed by the symbol `mode-line'.
9317 Furthermore, key sequences beginning with mouse clicks
9318 are read using the keymaps of the buffer clicked on, not
9319 the current buffer. So we may have to switch the buffer
9322 When we turn one event into two events, we must make sure
9323 that neither of the two looks like the original--so that,
9324 if we replay the events, they won't be expanded again.
9325 If not for this, such reexpansion could happen either here
9326 or when user programs play with this-command-keys. */
9327 if (EVENT_HAS_PARAMETERS (key
))
9329 Lisp_Object kind
= EVENT_HEAD_KIND (EVENT_HEAD (key
));
9330 if (EQ (kind
, Qmouse_click
))
9332 Lisp_Object window
= POSN_WINDOW (EVENT_START (key
));
9333 Lisp_Object posn
= POSN_POSN (EVENT_START (key
));
9336 || (!NILP (fake_prefixed_keys
)
9337 && !NILP (Fmemq (key
, fake_prefixed_keys
))))
9339 /* We're looking a second time at an event for which
9340 we generated a fake prefix key. Set
9341 last_real_key_start appropriately. */
9343 last_real_key_start
= t
- 1;
9346 if (last_real_key_start
== 0)
9348 /* Key sequences beginning with mouse clicks are
9349 read using the keymaps in the buffer clicked on,
9350 not the current buffer. If we're at the
9351 beginning of a key sequence, switch buffers. */
9352 if (WINDOWP (window
)
9353 && BUFFERP (XWINDOW (window
)->contents
)
9354 && XBUFFER (XWINDOW (window
)->contents
) != current_buffer
)
9356 ASET (raw_keybuf
, raw_keybuf_count
, key
);
9361 /* Arrange to go back to the original buffer once we're
9362 done reading the key sequence. Note that we can't
9363 use save_excursion_{save,restore} here, because they
9364 save point as well as the current buffer; we don't
9365 want to save point, because redisplay may change it,
9366 to accommodate a Fset_window_start or something. We
9367 don't want to do this at the top of the function,
9368 because we may get input from a subprocess which
9369 wants to change the selected window and stuff (say,
9371 record_unwind_current_buffer ();
9373 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
9375 set_buffer_internal (XBUFFER (XWINDOW (window
)->contents
));
9376 goto replay_sequence
;
9380 /* Expand mode-line and scroll-bar events into two events:
9381 use posn as a fake prefix key. */
9383 && (NILP (fake_prefixed_keys
)
9384 || NILP (Fmemq (key
, fake_prefixed_keys
))))
9386 if (bufsize
- t
<= 1)
9387 error ("Key sequence too long");
9390 keybuf
[t
+ 1] = key
;
9393 /* Record that a fake prefix key has been generated
9394 for KEY. Don't modify the event; this would
9395 prevent proper action when the event is pushed
9396 back into unread-command-events. */
9397 fake_prefixed_keys
= Fcons (key
, fake_prefixed_keys
);
9401 else if (CONSP (XCDR (key
))
9402 && CONSP (EVENT_START (key
))
9403 && CONSP (XCDR (EVENT_START (key
))))
9407 posn
= POSN_POSN (EVENT_START (key
));
9408 /* Handle menu-bar events:
9409 insert the dummy prefix event `menu-bar'. */
9410 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
9412 if (bufsize
- t
<= 1)
9413 error ("Key sequence too long");
9415 keybuf
[t
+ 1] = key
;
9417 /* Zap the position in key, so we know that we've
9418 expanded it, and don't try to do so again. */
9419 POSN_SET_POSN (EVENT_START (key
), list1 (posn
));
9422 goto replay_sequence
;
9424 else if (CONSP (posn
))
9426 /* We're looking at the second event of a
9427 sequence which we expanded before. Set
9428 last_real_key_start appropriately. */
9429 if (last_real_key_start
== t
&& t
> 0)
9430 last_real_key_start
= t
- 1;
9435 /* We have finally decided that KEY is something we might want
9437 new_binding
= follow_key (current_binding
, key
);
9439 /* If KEY wasn't bound, we'll try some fallbacks. */
9440 if (!NILP (new_binding
))
9441 /* This is needed for the following scenario:
9442 event 0: a down-event that gets dropped by calling replay_key.
9443 event 1: some normal prefix like C-h.
9444 After event 0, first_unbound is 0, after event 1 indec.start,
9445 fkey.start, and keytran.start are all 1, so when we see that
9446 C-h is bound, we need to update first_unbound. */
9447 first_unbound
= max (t
+ 1, first_unbound
);
9452 /* Remember the position to put an upper bound on indec.start. */
9453 first_unbound
= min (t
, first_unbound
);
9455 head
= EVENT_HEAD (key
);
9459 Lisp_Object breakdown
;
9462 breakdown
= parse_modifiers (head
);
9463 modifiers
= XINT (XCAR (XCDR (breakdown
)));
9464 /* Attempt to reduce an unbound mouse event to a simpler
9465 event that is bound:
9466 Drags reduce to clicks.
9467 Double-clicks reduce to clicks.
9468 Triple-clicks reduce to double-clicks, then to clicks.
9469 Up/Down-clicks are eliminated.
9470 Double-downs reduce to downs, then are eliminated.
9471 Triple-downs reduce to double-downs, then to downs,
9472 then are eliminated. */
9473 if (modifiers
& (up_modifier
| down_modifier
9475 | double_modifier
| triple_modifier
))
9477 while (modifiers
& (up_modifier
| down_modifier
9479 | double_modifier
| triple_modifier
))
9481 Lisp_Object new_head
, new_click
;
9482 if (modifiers
& triple_modifier
)
9483 modifiers
^= (double_modifier
| triple_modifier
);
9484 else if (modifiers
& double_modifier
)
9485 modifiers
&= ~double_modifier
;
9486 else if (modifiers
& drag_modifier
)
9487 modifiers
&= ~drag_modifier
;
9490 /* Dispose of this `up/down' event by simply jumping
9491 back to replay_key, to get another event.
9493 Note that if this event came from mock input,
9494 then just jumping back to replay_key will just
9495 hand it to us again. So we have to wipe out any
9498 We could delete keybuf[t] and shift everything
9499 after that to the left by one spot, but we'd also
9500 have to fix up any variable that points into
9501 keybuf, and shifting isn't really necessary
9504 Adding prefixes for non-textual mouse clicks
9505 creates two characters of mock input, and both
9506 must be thrown away. If we're only looking at
9507 the prefix now, we can just jump back to
9508 replay_key. On the other hand, if we've already
9509 processed the prefix, and now the actual click
9510 itself is giving us trouble, then we've lost the
9511 state of the keymaps we want to backtrack to, and
9512 we need to replay the whole sequence to rebuild
9515 Beyond that, only function key expansion could
9516 create more than two keys, but that should never
9517 generate mouse events, so it's okay to zero
9518 mock_input in that case too.
9520 FIXME: The above paragraph seems just plain
9521 wrong, if you consider things like
9522 xterm-mouse-mode. -stef
9524 Isn't this just the most wonderful code ever? */
9526 /* If mock_input > t + 1, the above simplification
9527 will actually end up dropping keys on the floor.
9528 This is probably OK for now, but even
9529 if mock_input <= t + 1, we need to adjust indec,
9531 Typical case [header-line down-mouse-N]:
9532 mock_input = 2, t = 1, fkey.end = 1,
9533 last_real_key_start = 0. */
9534 if (indec
.end
> last_real_key_start
)
9536 indec
.end
= indec
.start
9537 = min (last_real_key_start
, indec
.start
);
9538 indec
.map
= indec
.parent
;
9539 if (fkey
.end
> last_real_key_start
)
9541 fkey
.end
= fkey
.start
9542 = min (last_real_key_start
, fkey
.start
);
9543 fkey
.map
= fkey
.parent
;
9544 if (keytran
.end
> last_real_key_start
)
9546 keytran
.end
= keytran
.start
9547 = min (last_real_key_start
, keytran
.start
);
9548 keytran
.map
= keytran
.parent
;
9552 if (t
== last_real_key_start
)
9559 mock_input
= last_real_key_start
;
9560 goto replay_sequence
;
9565 = apply_modifiers (modifiers
, XCAR (breakdown
));
9566 new_click
= list2 (new_head
, EVENT_START (key
));
9568 /* Look for a binding for this new key. */
9569 new_binding
= follow_key (current_binding
, new_click
);
9571 /* If that click is bound, go for it. */
9572 if (!NILP (new_binding
))
9574 current_binding
= new_binding
;
9578 /* Otherwise, we'll leave key set to the drag event. */
9583 current_binding
= new_binding
;
9586 /* Normally, last_nonmenu_event gets the previous key we read.
9587 But when a mouse popup menu is being used,
9588 we don't update last_nonmenu_event; it continues to hold the mouse
9589 event that preceded the first level of menu. */
9590 if (!used_mouse_menu
)
9591 last_nonmenu_event
= key
;
9593 /* Record what part of this_command_keys is the current key sequence. */
9594 this_single_command_key_start
= this_command_key_count
- t
;
9595 /* When 'input-method-function' called above causes events to be
9596 put on 'unread-post-input-method-events', and as result
9597 'reread' is set to 'true', the value of 't' can become larger
9598 than 'this_command_key_count', because 'add_command_key' is
9599 not called to update 'this_command_key_count'. If this
9600 happens, 'this_single_command_key_start' will become negative
9601 above, and any call to 'this-single-command-keys' will return
9602 a garbled vector. See bug #20223 for one such situation.
9603 Here we force 'this_single_command_key_start' to never become
9604 negative, to avoid that. */
9605 if (this_single_command_key_start
< 0)
9606 this_single_command_key_start
= 0;
9608 /* Look for this sequence in input-decode-map.
9609 Scan from indec.end until we find a bound suffix. */
9610 while (indec
.end
< t
)
9615 done
= keyremap_step (keybuf
, bufsize
, &indec
, max (t
, mock_input
),
9619 mock_input
= diff
+ max (t
, mock_input
);
9620 goto replay_sequence
;
9624 if (!KEYMAPP (current_binding
)
9625 && !test_undefined (current_binding
)
9626 && indec
.start
>= t
)
9627 /* There is a binding and it's not a prefix.
9628 (and it doesn't have any input-decode-map translation pending).
9629 There is thus no function-key in this sequence.
9630 Moving fkey.start is important in this case to allow keytran.start
9631 to go over the sequence before we return (since we keep the
9632 invariant that keytran.end <= fkey.start). */
9635 (fkey
.start
= fkey
.end
= t
, fkey
.map
= fkey
.parent
);
9638 /* If the sequence is unbound, see if we can hang a function key
9639 off the end of it. */
9640 /* Continue scan from fkey.end until we find a bound suffix. */
9641 while (fkey
.end
< indec
.start
)
9646 done
= keyremap_step (keybuf
, bufsize
, &fkey
,
9647 max (t
, mock_input
),
9648 /* If there's a binding (i.e.
9649 first_binding >= nmaps) we don't want
9650 to apply this function-key-mapping. */
9652 && (test_undefined (current_binding
)),
9656 mock_input
= diff
+ max (t
, mock_input
);
9657 /* Adjust the input-decode-map counters. */
9659 indec
.start
+= diff
;
9661 goto replay_sequence
;
9665 /* Look for this sequence in key-translation-map.
9666 Scan from keytran.end until we find a bound suffix. */
9667 while (keytran
.end
< fkey
.start
)
9672 done
= keyremap_step (keybuf
, bufsize
, &keytran
, max (t
, mock_input
),
9676 mock_input
= diff
+ max (t
, mock_input
);
9677 /* Adjust the function-key-map and input-decode-map counters. */
9679 indec
.start
+= diff
;
9683 goto replay_sequence
;
9687 /* If KEY is not defined in any of the keymaps,
9688 and cannot be part of a function key or translation,
9689 and is an upper case letter
9690 use the corresponding lower-case letter instead. */
9691 if (NILP (current_binding
)
9692 && /* indec.start >= t && fkey.start >= t && */ keytran
.start
>= t
9695 Lisp_Object new_key
;
9696 EMACS_INT k
= XINT (key
);
9698 if (k
& shift_modifier
)
9699 XSETINT (new_key
, k
& ~shift_modifier
);
9700 else if (CHARACTERP (make_number (k
& ~CHAR_MODIFIER_MASK
)))
9702 int dc
= downcase (k
& ~CHAR_MODIFIER_MASK
);
9703 if (dc
== (k
& ~CHAR_MODIFIER_MASK
))
9705 XSETINT (new_key
, dc
| (k
& CHAR_MODIFIER_MASK
));
9710 original_uppercase
= key
;
9711 original_uppercase_position
= t
- 1;
9713 /* We have to do this unconditionally, regardless of whether
9714 the lower-case char is defined in the keymaps, because they
9715 might get translated through function-key-map. */
9716 keybuf
[t
- 1] = new_key
;
9717 mock_input
= max (t
, mock_input
);
9718 shift_translated
= true;
9720 goto replay_sequence
;
9724 if (NILP (current_binding
)
9725 && help_char_p (EVENT_HEAD (key
)) && t
> 1)
9727 read_key_sequence_cmd
= Vprefix_help_command
;
9728 /* The Microsoft C compiler can't handle the goto that
9734 /* If KEY is not defined in any of the keymaps,
9735 and cannot be part of a function key or translation,
9736 and is a shifted function key,
9737 use the corresponding unshifted function key instead. */
9738 if (NILP (current_binding
)
9739 && /* indec.start >= t && fkey.start >= t && */ keytran
.start
>= t
)
9741 Lisp_Object breakdown
= parse_modifiers (key
);
9743 = CONSP (breakdown
) ? (XINT (XCAR (XCDR (breakdown
)))) : 0;
9745 if (modifiers
& shift_modifier
9746 /* Treat uppercase keys as shifted. */
9748 && (KEY_TO_CHAR (key
)
9749 < XCHAR_TABLE (BVAR (current_buffer
, downcase_table
))->header
.size
)
9750 && uppercasep (KEY_TO_CHAR (key
))))
9753 = (modifiers
& shift_modifier
9754 ? apply_modifiers (modifiers
& ~shift_modifier
,
9756 : make_number (downcase (KEY_TO_CHAR (key
)) | modifiers
));
9758 original_uppercase
= key
;
9759 original_uppercase_position
= t
- 1;
9761 /* We have to do this unconditionally, regardless of whether
9762 the lower-case char is defined in the keymaps, because they
9763 might get translated through function-key-map. */
9764 keybuf
[t
- 1] = new_key
;
9765 mock_input
= max (t
, mock_input
);
9766 /* Reset fkey (and consequently keytran) to apply
9767 function-key-map on the result, so that S-backspace is
9768 correctly mapped to DEL (via backspace). OTOH,
9769 input-decode-map doesn't need to go through it again. */
9770 fkey
.start
= fkey
.end
= 0;
9771 keytran
.start
= keytran
.end
= 0;
9772 shift_translated
= true;
9774 goto replay_sequence
;
9779 read_key_sequence_cmd
= current_binding
;
9780 read_key_sequence_remapped
9781 /* Remap command through active keymaps.
9782 Do the remapping here, before the unbind_to so it uses the keymaps
9783 of the appropriate buffer. */
9784 = SYMBOLP (read_key_sequence_cmd
)
9785 ? Fcommand_remapping (read_key_sequence_cmd
, Qnil
, Qnil
)
9788 unread_switch_frame
= delayed_switch_frame
;
9789 unbind_to (count
, Qnil
);
9791 /* Don't downcase the last character if the caller says don't.
9792 Don't downcase it if the result is undefined, either. */
9793 if ((dont_downcase_last
|| NILP (current_binding
))
9795 && t
- 1 == original_uppercase_position
)
9797 keybuf
[t
- 1] = original_uppercase
;
9798 shift_translated
= false;
9801 if (shift_translated
)
9802 Vthis_command_keys_shift_translated
= Qt
;
9804 /* Occasionally we fabricate events, perhaps by expanding something
9805 according to function-key-map, or by adding a prefix symbol to a
9806 mouse click in the scroll bar or modeline. In this cases, return
9807 the entire generated key sequence, even if we hit an unbound
9808 prefix or a definition before the end. This means that you will
9809 be able to push back the event properly, and also means that
9810 read-key-sequence will always return a logical unit.
9813 for (; t
< mock_input
; t
++)
9814 add_command_key (keybuf
[t
]);
9821 read_key_sequence_vs (Lisp_Object prompt
, Lisp_Object continue_echo
,
9822 Lisp_Object dont_downcase_last
,
9823 Lisp_Object can_return_switch_frame
,
9824 Lisp_Object cmd_loop
, bool allow_string
)
9826 Lisp_Object keybuf
[30];
9828 ptrdiff_t count
= SPECPDL_INDEX ();
9831 CHECK_STRING (prompt
);
9834 specbind (Qinput_method_exit_on_first_char
,
9835 (NILP (cmd_loop
) ? Qt
: Qnil
));
9836 specbind (Qinput_method_use_echo_area
,
9837 (NILP (cmd_loop
) ? Qt
: Qnil
));
9839 if (NILP (continue_echo
))
9841 this_command_key_count
= 0;
9842 this_single_command_key_start
= 0;
9845 #ifdef HAVE_WINDOW_SYSTEM
9846 if (display_hourglass_p
)
9847 cancel_hourglass ();
9850 i
= read_key_sequence (keybuf
, ARRAYELTS (keybuf
),
9851 prompt
, ! NILP (dont_downcase_last
),
9852 ! NILP (can_return_switch_frame
), 0, 0);
9854 #if 0 /* The following is fine for code reading a key sequence and
9855 then proceeding with a lengthy computation, but it's not good
9856 for code reading keys in a loop, like an input method. */
9857 #ifdef HAVE_WINDOW_SYSTEM
9858 if (display_hourglass_p
)
9869 return unbind_to (count
,
9870 ((allow_string
? make_event_array
: Fvector
)
9874 DEFUN ("read-key-sequence", Fread_key_sequence
, Sread_key_sequence
, 1, 5, 0,
9875 doc
: /* Read a sequence of keystrokes and return as a string or vector.
9876 The sequence is sufficient to specify a non-prefix command in the
9877 current local and global maps.
9879 First arg PROMPT is a prompt string. If nil, do not prompt specially.
9880 Second (optional) arg CONTINUE-ECHO, if non-nil, means this key echos
9881 as a continuation of the previous key.
9883 The third (optional) arg DONT-DOWNCASE-LAST, if non-nil, means do not
9884 convert the last event to lower case. (Normally any upper case event
9885 is converted to lower case if the original event is undefined and the lower
9886 case equivalent is defined.) A non-nil value is appropriate for reading
9887 a key sequence to be defined.
9889 A C-g typed while in this function is treated like any other character,
9890 and `quit-flag' is not set.
9892 If the key sequence starts with a mouse click, then the sequence is read
9893 using the keymaps of the buffer of the window clicked in, not the buffer
9894 of the selected window as normal.
9896 `read-key-sequence' drops unbound button-down events, since you normally
9897 only care about the click or drag events which follow them. If a drag
9898 or multi-click event is unbound, but the corresponding click event would
9899 be bound, `read-key-sequence' turns the event into a click event at the
9900 drag's starting position. This means that you don't have to distinguish
9901 between click and drag, double, or triple events unless you want to.
9903 `read-key-sequence' prefixes mouse events on mode lines, the vertical
9904 lines separating windows, and scroll bars with imaginary keys
9905 `mode-line', `vertical-line', and `vertical-scroll-bar'.
9907 Optional fourth argument CAN-RETURN-SWITCH-FRAME non-nil means that this
9908 function will process a switch-frame event if the user switches frames
9909 before typing anything. If the user switches frames in the middle of a
9910 key sequence, or at the start of the sequence but CAN-RETURN-SWITCH-FRAME
9911 is nil, then the event will be put off until after the current key sequence.
9913 `read-key-sequence' checks `function-key-map' for function key
9914 sequences, where they wouldn't conflict with ordinary bindings. See
9915 `function-key-map' for more details.
9917 The optional fifth argument CMD-LOOP, if non-nil, means
9918 that this key sequence is being read by something that will
9919 read commands one after another. It should be nil if the caller
9920 will read just one key sequence. */)
9921 (Lisp_Object prompt
, Lisp_Object continue_echo
, Lisp_Object dont_downcase_last
, Lisp_Object can_return_switch_frame
, Lisp_Object cmd_loop
)
9923 return read_key_sequence_vs (prompt
, continue_echo
, dont_downcase_last
,
9924 can_return_switch_frame
, cmd_loop
, true);
9927 DEFUN ("read-key-sequence-vector", Fread_key_sequence_vector
,
9928 Sread_key_sequence_vector
, 1, 5, 0,
9929 doc
: /* Like `read-key-sequence' but always return a vector. */)
9930 (Lisp_Object prompt
, Lisp_Object continue_echo
, Lisp_Object dont_downcase_last
, Lisp_Object can_return_switch_frame
, Lisp_Object cmd_loop
)
9932 return read_key_sequence_vs (prompt
, continue_echo
, dont_downcase_last
,
9933 can_return_switch_frame
, cmd_loop
, false);
9936 /* Return true if input events are pending. */
9939 detect_input_pending (void)
9941 return input_pending
|| get_input_pending (0);
9944 /* Return true if input events other than mouse movements are
9948 detect_input_pending_ignore_squeezables (void)
9950 return input_pending
|| get_input_pending (READABLE_EVENTS_IGNORE_SQUEEZABLES
);
9953 /* Return true if input events are pending, and run any pending timers. */
9956 detect_input_pending_run_timers (bool do_display
)
9958 unsigned old_timers_run
= timers_run
;
9961 get_input_pending (READABLE_EVENTS_DO_TIMERS_NOW
);
9963 if (old_timers_run
!= timers_run
&& do_display
)
9964 redisplay_preserve_echo_area (8);
9966 return input_pending
;
9969 /* This is called in some cases before a possible quit.
9970 It cases the next call to detect_input_pending to recompute input_pending.
9971 So calling this function unnecessarily can't do any harm. */
9974 clear_input_pending (void)
9976 input_pending
= false;
9979 /* Return true if there are pending requeued events.
9980 This isn't used yet. The hope is to make wait_reading_process_output
9981 call it, and return if it runs Lisp code that unreads something.
9982 The problem is, kbd_buffer_get_event needs to be fixed to know what
9983 to do in that case. It isn't trivial. */
9986 requeued_events_pending_p (void)
9988 return (CONSP (Vunread_command_events
));
9991 DEFUN ("input-pending-p", Finput_pending_p
, Sinput_pending_p
, 0, 1, 0,
9992 doc
: /* Return t if command input is currently available with no wait.
9993 Actually, the value is nil only if we can be sure that no input is available;
9994 if there is a doubt, the value is t.
9996 If CHECK-TIMERS is non-nil, timers that are ready to run will do so. */)
9997 (Lisp_Object check_timers
)
9999 if (CONSP (Vunread_command_events
)
10000 || !NILP (Vunread_post_input_method_events
)
10001 || !NILP (Vunread_input_method_events
))
10004 /* Process non-user-visible events (Bug#10195). */
10005 process_special_events ();
10007 return (get_input_pending ((NILP (check_timers
)
10008 ? 0 : READABLE_EVENTS_DO_TIMERS_NOW
)
10009 | READABLE_EVENTS_FILTER_EVENTS
)
10013 DEFUN ("recent-keys", Frecent_keys
, Srecent_keys
, 0, 1, 0,
10014 doc
: /* Return vector of last few events, not counting those from keyboard macros.
10015 If INCLUDE-CMDS is non-nil, include the commands that were run,
10016 represented as events of the form (nil . COMMAND). */)
10017 (Lisp_Object include_cmds
)
10019 bool cmds
= !NILP (include_cmds
);
10022 || (cmds
&& total_keys
< NUM_RECENT_KEYS
))
10023 return Fvector (total_keys
,
10024 XVECTOR (recent_keys
)->contents
);
10027 Lisp_Object es
= Qnil
;
10028 int i
= (total_keys
< NUM_RECENT_KEYS
10029 ? 0 : recent_keys_index
);
10030 eassert (recent_keys_index
< NUM_RECENT_KEYS
);
10033 Lisp_Object e
= AREF (recent_keys
, i
);
10034 if (cmds
|| !CONSP (e
) || !NILP (XCAR (e
)))
10035 es
= Fcons (e
, es
);
10036 if (++i
>= NUM_RECENT_KEYS
)
10038 } while (i
!= recent_keys_index
);
10039 es
= Fnreverse (es
);
10040 return Fvconcat (1, &es
);
10044 DEFUN ("this-command-keys", Fthis_command_keys
, Sthis_command_keys
, 0, 0, 0,
10045 doc
: /* Return the key sequence that invoked this command.
10046 However, if the command has called `read-key-sequence', it returns
10047 the last key sequence that has been read.
10048 The value is a string or a vector.
10050 See also `this-command-keys-vector'. */)
10053 return make_event_array (this_command_key_count
,
10054 XVECTOR (this_command_keys
)->contents
);
10057 DEFUN ("set--this-command-keys", Fset__this_command_keys
,
10058 Sset__this_command_keys
, 1, 1, 0,
10059 doc
: /* Set the vector to be returned by `this-command-keys'.
10060 The argument KEYS must be a string.
10061 Internal use only. */)
10064 CHECK_STRING (keys
);
10066 this_command_key_count
= 0;
10067 this_single_command_key_start
= 0;
10069 int charidx
= 0, byteidx
= 0;
10071 FETCH_STRING_CHAR_ADVANCE (key0
, keys
, charidx
, byteidx
);
10072 if (CHAR_BYTE8_P (key0
))
10073 key0
= CHAR_TO_BYTE8 (key0
);
10075 /* Kludge alert: this makes M-x be in the form expected by
10076 novice.el. (248 is \370, a.k.a. "Meta-x".) Any better ideas? */
10078 add_command_key (make_number ('x' | meta_modifier
));
10080 add_command_key (make_number (key0
));
10081 for (ptrdiff_t i
= 1; i
< SCHARS (keys
); i
++)
10084 FETCH_STRING_CHAR_ADVANCE (key_i
, keys
, charidx
, byteidx
);
10085 if (CHAR_BYTE8_P (key_i
))
10086 key_i
= CHAR_TO_BYTE8 (key_i
);
10087 add_command_key (make_number (key_i
));
10092 DEFUN ("this-command-keys-vector", Fthis_command_keys_vector
, Sthis_command_keys_vector
, 0, 0, 0,
10093 doc
: /* Return the key sequence that invoked this command, as a vector.
10094 However, if the command has called `read-key-sequence', it returns
10095 the last key sequence that has been read.
10097 See also `this-command-keys'. */)
10100 return Fvector (this_command_key_count
,
10101 XVECTOR (this_command_keys
)->contents
);
10104 DEFUN ("this-single-command-keys", Fthis_single_command_keys
,
10105 Sthis_single_command_keys
, 0, 0, 0,
10106 doc
: /* Return the key sequence that invoked this command.
10107 More generally, it returns the last key sequence read, either by
10108 the command loop or by `read-key-sequence'.
10109 Unlike `this-command-keys', this function's value
10110 does not include prefix arguments.
10111 The value is always a vector. */)
10114 return Fvector (this_command_key_count
10115 - this_single_command_key_start
,
10116 (XVECTOR (this_command_keys
)->contents
10117 + this_single_command_key_start
));
10120 DEFUN ("this-single-command-raw-keys", Fthis_single_command_raw_keys
,
10121 Sthis_single_command_raw_keys
, 0, 0, 0,
10122 doc
: /* Return the raw events that were read for this command.
10123 More generally, it returns the last key sequence read, either by
10124 the command loop or by `read-key-sequence'.
10125 Unlike `this-single-command-keys', this function's value
10126 shows the events before all translations (except for input methods).
10127 The value is always a vector. */)
10130 return Fvector (raw_keybuf_count
, XVECTOR (raw_keybuf
)->contents
);
10133 DEFUN ("clear-this-command-keys", Fclear_this_command_keys
,
10134 Sclear_this_command_keys
, 0, 1, 0,
10135 doc
: /* Clear out the vector that `this-command-keys' returns.
10136 Also clear the record of the last 100 events, unless optional arg
10137 KEEP-RECORD is non-nil. */)
10138 (Lisp_Object keep_record
)
10142 this_command_key_count
= 0;
10144 if (NILP (keep_record
))
10146 for (i
= 0; i
< ASIZE (recent_keys
); ++i
)
10147 ASET (recent_keys
, i
, Qnil
);
10149 recent_keys_index
= 0;
10154 DEFUN ("recursion-depth", Frecursion_depth
, Srecursion_depth
, 0, 0, 0,
10155 doc
: /* Return the current depth in recursive edits. */)
10159 INT_ADD_WRAPV (command_loop_level
, minibuf_level
, &sum
);
10160 return make_number (sum
);
10163 DEFUN ("open-dribble-file", Fopen_dribble_file
, Sopen_dribble_file
, 1, 1,
10164 "FOpen dribble file: ",
10165 doc
: /* Start writing all keyboard characters to a dribble file called FILE.
10166 If FILE is nil, close any open dribble file.
10167 The file will be closed when Emacs exits.
10169 Be aware that this records ALL characters you type!
10170 This may include sensitive information such as passwords. */)
10183 Lisp_Object encfile
;
10185 file
= Fexpand_file_name (file
, Qnil
);
10186 encfile
= ENCODE_FILE (file
);
10187 fd
= emacs_open (SSDATA (encfile
), O_WRONLY
| O_CREAT
| O_EXCL
, 0600);
10188 if (fd
< 0 && errno
== EEXIST
10189 && (unlink (SSDATA (encfile
)) == 0 || errno
== ENOENT
))
10190 fd
= emacs_open (SSDATA (encfile
), O_WRONLY
| O_CREAT
| O_EXCL
, 0600);
10191 dribble
= fd
< 0 ? 0 : fdopen (fd
, "w");
10193 report_file_error ("Opening dribble", file
);
10198 DEFUN ("discard-input", Fdiscard_input
, Sdiscard_input
, 0, 0, 0,
10199 doc
: /* Discard the contents of the terminal input buffer.
10200 Also end any kbd macro being defined. */)
10203 if (!NILP (KVAR (current_kboard
, defining_kbd_macro
)))
10205 /* Discard the last command from the macro. */
10206 Fcancel_kbd_macro_events ();
10210 Vunread_command_events
= Qnil
;
10212 discard_tty_input ();
10214 kbd_fetch_ptr
= kbd_store_ptr
;
10215 input_pending
= false;
10220 DEFUN ("suspend-emacs", Fsuspend_emacs
, Ssuspend_emacs
, 0, 1, "",
10221 doc
: /* Stop Emacs and return to superior process. You can resume later.
10222 If `cannot-suspend' is non-nil, or if the system doesn't support job
10223 control, run a subshell instead.
10225 If optional arg STUFFSTRING is non-nil, its characters are stuffed
10226 to be read as terminal input by Emacs's parent, after suspension.
10228 Before suspending, run the normal hook `suspend-hook'.
10229 After resumption run the normal hook `suspend-resume-hook'.
10231 Some operating systems cannot stop the Emacs process and resume it later.
10232 On such systems, Emacs starts a subshell instead of suspending. */)
10233 (Lisp_Object stuffstring
)
10235 ptrdiff_t count
= SPECPDL_INDEX ();
10236 int old_height
, old_width
;
10239 if (tty_list
&& tty_list
->next
)
10240 error ("There are other tty frames open; close them before suspending Emacs");
10242 if (!NILP (stuffstring
))
10243 CHECK_STRING (stuffstring
);
10245 run_hook (intern ("suspend-hook"));
10247 get_tty_size (fileno (CURTTY ()->input
), &old_width
, &old_height
);
10248 reset_all_sys_modes ();
10249 /* sys_suspend can get an error if it tries to fork a subshell
10250 and the system resources aren't available for that. */
10251 record_unwind_protect_void (init_all_sys_modes
);
10252 stuff_buffered_input (stuffstring
);
10253 if (cannot_suspend
)
10257 unbind_to (count
, Qnil
);
10259 /* Check if terminal/window size has changed.
10260 Note that this is not useful when we are running directly
10261 with a window system; but suspend should be disabled in that case. */
10262 get_tty_size (fileno (CURTTY ()->input
), &width
, &height
);
10263 if (width
!= old_width
|| height
!= old_height
)
10264 change_frame_size (SELECTED_FRAME (), width
,
10265 height
- FRAME_MENU_BAR_LINES (SELECTED_FRAME ()),
10268 run_hook (intern ("suspend-resume-hook"));
10273 /* If STUFFSTRING is a string, stuff its contents as pending terminal input.
10274 Then in any case stuff anything Emacs has read ahead and not used. */
10277 stuff_buffered_input (Lisp_Object stuffstring
)
10279 #ifdef SIGTSTP /* stuff_char is defined if SIGTSTP. */
10280 register unsigned char *p
;
10282 if (STRINGP (stuffstring
))
10284 register ptrdiff_t count
;
10286 p
= SDATA (stuffstring
);
10287 count
= SBYTES (stuffstring
);
10288 while (count
-- > 0)
10293 /* Anything we have read ahead, put back for the shell to read. */
10294 /* ?? What should this do when we have multiple keyboards??
10295 Should we ignore anything that was typed in at the "wrong" kboard?
10297 rms: we should stuff everything back into the kboard
10299 for (; kbd_fetch_ptr
!= kbd_store_ptr
; kbd_fetch_ptr
++)
10302 if (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
10303 kbd_fetch_ptr
= kbd_buffer
;
10304 if (kbd_fetch_ptr
->kind
== ASCII_KEYSTROKE_EVENT
)
10305 stuff_char (kbd_fetch_ptr
->ie
.code
);
10307 clear_event (kbd_fetch_ptr
);
10310 input_pending
= false;
10311 #endif /* SIGTSTP */
10315 set_waiting_for_input (struct timespec
*time_to_clear
)
10317 input_available_clear_time
= time_to_clear
;
10319 /* Tell handle_interrupt to throw back to read_char, */
10320 waiting_for_input
= true;
10322 /* If handle_interrupt was called before and buffered a C-g,
10323 make it run again now, to avoid timing error. */
10324 if (!NILP (Vquit_flag
))
10325 quit_throw_to_read_char (0);
10329 clear_waiting_for_input (void)
10331 /* Tell handle_interrupt not to throw back to read_char, */
10332 waiting_for_input
= false;
10333 input_available_clear_time
= 0;
10336 /* The SIGINT handler.
10338 If we have a frame on the controlling tty, we assume that the
10339 SIGINT was generated by C-g, so we call handle_interrupt.
10340 Otherwise, tell maybe_quit to kill Emacs. */
10343 handle_interrupt_signal (int sig
)
10345 /* See if we have an active terminal on our controlling tty. */
10346 struct terminal
*terminal
= get_named_terminal (DEV_TTY
);
10349 /* If there are no frames there, let's pretend that we are a
10350 well-behaving UN*X program and quit. We must not call Lisp
10351 in a signal handler, so tell maybe_quit to exit when it is
10353 Vquit_flag
= Qkill_emacs
;
10357 /* Otherwise, the SIGINT was probably generated by C-g. */
10359 /* Set internal_last_event_frame to the top frame of the
10360 controlling tty, if we have a frame there. We disable the
10361 interrupt key on secondary ttys, so the SIGINT must have come
10362 from the controlling tty. */
10363 internal_last_event_frame
= terminal
->display_info
.tty
->top_frame
;
10365 handle_interrupt (1);
10370 deliver_interrupt_signal (int sig
)
10372 deliver_process_signal (sig
, handle_interrupt_signal
);
10375 /* Output MSG directly to standard output, without buffering. Ignore
10376 failures. This is safe in a signal handler. */
10378 write_stdout (char const *msg
)
10380 ignore_value (write (STDOUT_FILENO
, msg
, strlen (msg
)));
10383 /* Read a byte from stdin, without buffering. Safe in signal handlers. */
10388 return read (STDIN_FILENO
, &c
, 1) == 1 ? c
: EOF
;
10391 /* If Emacs is stuck because `inhibit-quit' is true, then keep track
10392 of the number of times C-g has been requested. If C-g is pressed
10393 enough times, then quit anyway. See bug#6585. */
10394 static int volatile force_quit_count
;
10396 /* This routine is called at interrupt level in response to C-g.
10398 It is called from the SIGINT handler or kbd_buffer_store_event.
10400 If `waiting_for_input' is non zero, then unless `echoing' is
10401 nonzero, immediately throw back to read_char.
10403 Otherwise it sets the Lisp variable quit-flag not-nil. This causes
10404 eval to throw, when it gets a chance. If quit-flag is already
10405 non-nil, it stops the job right away. */
10408 handle_interrupt (bool in_signal_handler
)
10414 /* XXX This code needs to be revised for multi-tty support. */
10415 if (!NILP (Vquit_flag
) && get_named_terminal (DEV_TTY
))
10417 if (! in_signal_handler
)
10419 /* If SIGINT isn't blocked, don't let us be interrupted by
10420 a SIGINT. It might be harmful due to non-reentrancy
10421 in I/O functions. */
10423 sigemptyset (&blocked
);
10424 sigaddset (&blocked
, SIGINT
);
10425 pthread_sigmask (SIG_BLOCK
, &blocked
, 0);
10426 fflush_unlocked (stdout
);
10429 reset_all_sys_modes ();
10433 * On systems which can suspend the current process and return to the original
10434 * shell, this command causes the user to end up back at the shell.
10435 * The "Auto-save" and "Abort" questions are not asked until
10436 * the user elects to return to emacs, at which point he can save the current
10437 * job and either dump core or continue.
10441 /* Perhaps should really fork an inferior shell?
10442 But that would not provide any way to get back
10443 to the original shell, ever. */
10444 write_stdout ("No support for stopping a process"
10445 " on this operating system;\n"
10446 "you can continue or abort.\n");
10447 #endif /* not SIGTSTP */
10449 /* We must remain inside the screen area when the internal terminal
10450 is used. Note that [Enter] is not echoed by dos. */
10451 cursor_to (SELECTED_FRAME (), 0, 0);
10454 write_stdout ("Emacs is resuming after an emergency escape.\n");
10456 /* It doesn't work to autosave while GC is in progress;
10457 the code used for auto-saving doesn't cope with the mark bit. */
10458 if (!gc_in_progress
)
10460 write_stdout ("Auto-save? (y or n) ");
10462 if (c
== 'y' || c
== 'Y')
10464 Fdo_auto_save (Qt
, Qnil
);
10466 write_stdout ("\r\nAuto-save done");
10468 write_stdout ("Auto-save done\n");
10476 /* During GC, it must be safe to reenable quitting again. */
10477 Vinhibit_quit
= Qnil
;
10483 "Garbage collection in progress; cannot auto-save now\r\n"
10484 "but will instead do a real quit"
10485 " after garbage collection ends\r\n");
10489 write_stdout ("\r\nAbort? (y or n) ");
10491 write_stdout ("Abort (and dump core)? (y or n) ");
10494 if (c
== 'y' || c
== 'Y')
10499 write_stdout ("\r\nContinuing...\r\n");
10500 #else /* not MSDOS */
10501 write_stdout ("Continuing...\n");
10502 #endif /* not MSDOS */
10503 init_all_sys_modes ();
10507 /* Request quit when it's safe. */
10508 int count
= NILP (Vquit_flag
) ? 1 : force_quit_count
+ 1;
10509 force_quit_count
= count
;
10511 Vinhibit_quit
= Qnil
;
10515 pthread_sigmask (SIG_SETMASK
, &empty_mask
, 0);
10517 /* TODO: The longjmp in this call throws the NS event loop integration off,
10518 and it seems to do fine without this. Probably some attention
10519 needs to be paid to the setting of waiting_for_input in
10520 wait_reading_process_output() under HAVE_NS because of the call
10521 to ns_select there (needed because otherwise events aren't picked up
10522 outside of polling since we don't get SIGIO like X and we don't have a
10523 separate event loop thread like W32. */
10525 #ifdef THREADS_ENABLED
10526 /* If we were called from a signal handler, we must be in the main
10527 thread, see deliver_process_signal. So we must make sure the
10528 main thread holds the global lock. */
10529 if (in_signal_handler
)
10530 maybe_reacquire_global_lock ();
10532 if (waiting_for_input
&& !echoing
)
10533 quit_throw_to_read_char (in_signal_handler
);
10537 /* Handle a C-g by making read_char return C-g. */
10540 quit_throw_to_read_char (bool from_signal
)
10542 /* When not called from a signal handler it is safe to call
10544 if (!from_signal
&& EQ (Vquit_flag
, Qkill_emacs
))
10545 Fkill_emacs (Qnil
);
10547 /* Prevent another signal from doing this before we finish. */
10548 clear_waiting_for_input ();
10549 input_pending
= false;
10551 Vunread_command_events
= Qnil
;
10553 if (FRAMEP (internal_last_event_frame
)
10554 && !EQ (internal_last_event_frame
, selected_frame
))
10555 do_switch_frame (make_lispy_switch_frame (internal_last_event_frame
),
10558 sys_longjmp (getcjmp
, 1);
10561 DEFUN ("set-input-interrupt-mode", Fset_input_interrupt_mode
,
10562 Sset_input_interrupt_mode
, 1, 1, 0,
10563 doc
: /* Set interrupt mode of reading keyboard input.
10564 If INTERRUPT is non-nil, Emacs will use input interrupts;
10565 otherwise Emacs uses CBREAK mode.
10567 See also `current-input-mode'. */)
10568 (Lisp_Object interrupt
)
10570 bool new_interrupt_input
;
10571 #ifdef USABLE_SIGIO
10572 #ifdef HAVE_X_WINDOWS
10573 if (x_display_list
!= NULL
)
10575 /* When using X, don't give the user a real choice,
10576 because we haven't implemented the mechanisms to support it. */
10577 new_interrupt_input
= true;
10580 #endif /* HAVE_X_WINDOWS */
10581 new_interrupt_input
= !NILP (interrupt
);
10582 #else /* not USABLE_SIGIO */
10583 new_interrupt_input
= false;
10584 #endif /* not USABLE_SIGIO */
10586 if (new_interrupt_input
!= interrupt_input
)
10588 #ifdef POLL_FOR_INPUT
10592 /* this causes startup screen to be restored and messes with the mouse */
10593 reset_all_sys_modes ();
10594 interrupt_input
= new_interrupt_input
;
10595 init_all_sys_modes ();
10597 interrupt_input
= new_interrupt_input
;
10600 #ifdef POLL_FOR_INPUT
10601 poll_suppress_count
= 1;
10608 DEFUN ("set-output-flow-control", Fset_output_flow_control
, Sset_output_flow_control
, 1, 2, 0,
10609 doc
: /* Enable or disable ^S/^Q flow control for output to TERMINAL.
10610 If FLOW is non-nil, flow control is enabled and you cannot use C-s or
10611 C-q in key sequences.
10613 This setting only has an effect on tty terminals and only when
10614 Emacs reads input in CBREAK mode; see `set-input-interrupt-mode'.
10616 See also `current-input-mode'. */)
10617 (Lisp_Object flow
, Lisp_Object terminal
)
10619 struct terminal
*t
= decode_tty_terminal (terminal
);
10620 struct tty_display_info
*tty
;
10624 tty
= t
->display_info
.tty
;
10626 if (tty
->flow_control
!= !NILP (flow
))
10629 /* This causes startup screen to be restored and messes with the mouse. */
10630 reset_sys_modes (tty
);
10633 tty
->flow_control
= !NILP (flow
);
10636 init_sys_modes (tty
);
10642 DEFUN ("set-input-meta-mode", Fset_input_meta_mode
, Sset_input_meta_mode
, 1, 2, 0,
10643 doc
: /* Enable or disable 8-bit input on TERMINAL.
10644 If META is t, Emacs will accept 8-bit input, and interpret the 8th
10645 bit as the Meta modifier.
10647 If META is nil, Emacs will ignore the top bit, on the assumption it is
10650 Otherwise, Emacs will accept and pass through 8-bit input without
10651 specially interpreting the top bit.
10653 This setting only has an effect on tty terminal devices.
10655 Optional parameter TERMINAL specifies the tty terminal device to use.
10656 It may be a terminal object, a frame, or nil for the terminal used by
10657 the currently selected frame.
10659 See also `current-input-mode'. */)
10660 (Lisp_Object meta
, Lisp_Object terminal
)
10662 struct terminal
*t
= decode_tty_terminal (terminal
);
10663 struct tty_display_info
*tty
;
10668 tty
= t
->display_info
.tty
;
10672 else if (EQ (meta
, Qt
))
10677 if (tty
->meta_key
!= new_meta
)
10680 /* this causes startup screen to be restored and messes with the mouse */
10681 reset_sys_modes (tty
);
10684 tty
->meta_key
= new_meta
;
10687 init_sys_modes (tty
);
10693 DEFUN ("set-quit-char", Fset_quit_char
, Sset_quit_char
, 1, 1, 0,
10694 doc
: /* Specify character used for quitting.
10695 QUIT must be an ASCII character.
10697 This function only has an effect on the controlling tty of the Emacs
10700 See also `current-input-mode'. */)
10703 struct terminal
*t
= get_named_terminal (DEV_TTY
);
10704 struct tty_display_info
*tty
;
10708 tty
= t
->display_info
.tty
;
10710 if (NILP (quit
) || !INTEGERP (quit
) || XINT (quit
) < 0 || XINT (quit
) > 0400)
10711 error ("QUIT must be an ASCII character");
10714 /* this causes startup screen to be restored and messes with the mouse */
10715 reset_sys_modes (tty
);
10718 /* Don't let this value be out of range. */
10719 quit_char
= XINT (quit
) & (tty
->meta_key
== 0 ? 0177 : 0377);
10722 init_sys_modes (tty
);
10728 DEFUN ("set-input-mode", Fset_input_mode
, Sset_input_mode
, 3, 4, 0,
10729 doc
: /* Set mode of reading keyboard input.
10730 First arg INTERRUPT non-nil means use input interrupts;
10731 nil means use CBREAK mode.
10732 Second arg FLOW non-nil means use ^S/^Q flow control for output to terminal
10733 (no effect except in CBREAK mode).
10734 Third arg META t means accept 8-bit input (for a Meta key).
10735 META nil means ignore the top bit, on the assumption it is parity.
10736 Otherwise, accept 8-bit input and don't use the top bit for Meta.
10737 Optional fourth arg QUIT if non-nil specifies character to use for quitting.
10738 See also `current-input-mode'. */)
10739 (Lisp_Object interrupt
, Lisp_Object flow
, Lisp_Object meta
, Lisp_Object quit
)
10741 Fset_input_interrupt_mode (interrupt
);
10742 Fset_output_flow_control (flow
, Qnil
);
10743 Fset_input_meta_mode (meta
, Qnil
);
10745 Fset_quit_char (quit
);
10749 DEFUN ("current-input-mode", Fcurrent_input_mode
, Scurrent_input_mode
, 0, 0, 0,
10750 doc
: /* Return information about the way Emacs currently reads keyboard input.
10751 The value is a list of the form (INTERRUPT FLOW META QUIT), where
10752 INTERRUPT is non-nil if Emacs is using interrupt-driven input; if
10753 nil, Emacs is using CBREAK mode.
10754 FLOW is non-nil if Emacs uses ^S/^Q flow control for output to the
10755 terminal; this does not apply if Emacs uses interrupt-driven input.
10756 META is t if accepting 8-bit input with 8th bit as Meta flag.
10757 META nil means ignoring the top bit, on the assumption it is parity.
10758 META is neither t nor nil if accepting 8-bit input and using
10759 all 8 bits as the character code.
10760 QUIT is the character Emacs currently uses to quit.
10761 The elements of this list correspond to the arguments of
10762 `set-input-mode'. */)
10765 struct frame
*sf
= XFRAME (selected_frame
);
10767 Lisp_Object interrupt
= interrupt_input
? Qt
: Qnil
;
10768 Lisp_Object flow
, meta
;
10769 if (FRAME_TERMCAP_P (sf
) || FRAME_MSDOS_P (sf
))
10771 flow
= FRAME_TTY (sf
)->flow_control
? Qt
: Qnil
;
10772 meta
= (FRAME_TTY (sf
)->meta_key
== 2
10774 : (CURTTY ()->meta_key
== 1 ? Qt
: Qnil
));
10781 Lisp_Object quit
= make_number (quit_char
);
10783 return list4 (interrupt
, flow
, meta
, quit
);
10786 DEFUN ("posn-at-x-y", Fposn_at_x_y
, Sposn_at_x_y
, 2, 4, 0,
10787 doc
: /* Return position information for pixel coordinates X and Y.
10788 By default, X and Y are relative to text area of the selected window.
10789 Optional third arg FRAME-OR-WINDOW non-nil specifies frame or window.
10790 If optional fourth arg WHOLE is non-nil, X is relative to the left
10791 edge of the window.
10793 The return value is similar to a mouse click position:
10794 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
10795 IMAGE (DX . DY) (WIDTH . HEIGHT))
10796 The `posn-' functions access elements of such lists. */)
10797 (Lisp_Object x
, Lisp_Object y
, Lisp_Object frame_or_window
, Lisp_Object whole
)
10800 /* We allow X of -1, for the newline in a R2L line that overflowed
10801 into the left fringe. */
10802 if (XINT (x
) != -1)
10806 if (NILP (frame_or_window
))
10807 frame_or_window
= selected_window
;
10809 if (WINDOWP (frame_or_window
))
10811 struct window
*w
= decode_live_window (frame_or_window
);
10813 XSETINT (x
, (XINT (x
)
10814 + WINDOW_LEFT_EDGE_X (w
)
10816 ? window_box_left_offset (w
, TEXT_AREA
)
10818 XSETINT (y
, WINDOW_TO_FRAME_PIXEL_Y (w
, XINT (y
)));
10819 frame_or_window
= w
->frame
;
10822 CHECK_LIVE_FRAME (frame_or_window
);
10824 return make_lispy_position (XFRAME (frame_or_window
), x
, y
, 0);
10827 DEFUN ("posn-at-point", Fposn_at_point
, Sposn_at_point
, 0, 2, 0,
10828 doc
: /* Return position information for buffer position POS in WINDOW.
10829 POS defaults to point in WINDOW; WINDOW defaults to the selected window.
10831 Return nil if POS is not visible in WINDOW. Otherwise,
10832 the return value is similar to that returned by `event-start' for
10833 a mouse click at the upper left corner of the glyph corresponding
10835 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
10836 IMAGE (DX . DY) (WIDTH . HEIGHT))
10837 The `posn-' functions access elements of such lists. */)
10838 (Lisp_Object pos
, Lisp_Object window
)
10843 window
= selected_window
;
10845 tem
= Fpos_visible_in_window_p (pos
, window
, Qt
);
10848 Lisp_Object x
= XCAR (tem
);
10849 Lisp_Object y
= XCAR (XCDR (tem
));
10850 Lisp_Object aux_info
= XCDR (XCDR (tem
));
10851 int y_coord
= XINT (y
);
10853 /* Point invisible due to hscrolling? X can be -1 when a
10854 newline in a R2L line overflows into the left fringe. */
10857 if (!NILP (aux_info
) && y_coord
< 0)
10859 int rtop
= XINT (XCAR (aux_info
));
10861 y
= make_number (y_coord
+ rtop
);
10863 tem
= Fposn_at_x_y (x
, y
, window
, Qnil
);
10869 /* Set up a new kboard object with reasonable initial values.
10870 TYPE is a window system for which this keyboard is used. */
10873 init_kboard (KBOARD
*kb
, Lisp_Object type
)
10875 kset_overriding_terminal_local_map (kb
, Qnil
);
10876 kset_last_command (kb
, Qnil
);
10877 kset_real_last_command (kb
, Qnil
);
10878 kset_keyboard_translate_table (kb
, Qnil
);
10879 kset_last_repeatable_command (kb
, Qnil
);
10880 kset_prefix_arg (kb
, Qnil
);
10881 kset_last_prefix_arg (kb
, Qnil
);
10882 kset_kbd_queue (kb
, Qnil
);
10883 kb
->kbd_queue_has_data
= false;
10884 kb
->immediate_echo
= false;
10885 kset_echo_string (kb
, Qnil
);
10886 kset_echo_prompt (kb
, Qnil
);
10887 kb
->kbd_macro_buffer
= 0;
10888 kb
->kbd_macro_bufsize
= 0;
10889 kset_defining_kbd_macro (kb
, Qnil
);
10890 kset_last_kbd_macro (kb
, Qnil
);
10891 kb
->reference_count
= 0;
10892 kset_system_key_alist (kb
, Qnil
);
10893 kset_system_key_syms (kb
, Qnil
);
10894 kset_window_system (kb
, type
);
10895 kset_input_decode_map (kb
, Fmake_sparse_keymap (Qnil
));
10896 kset_local_function_key_map (kb
, Fmake_sparse_keymap (Qnil
));
10897 Fset_keymap_parent (KVAR (kb
, Vlocal_function_key_map
), Vfunction_key_map
);
10898 kset_default_minibuffer_frame (kb
, Qnil
);
10901 /* Allocate and basically initialize keyboard
10902 object to use with window system TYPE. */
10905 allocate_kboard (Lisp_Object type
)
10907 KBOARD
*kb
= xmalloc (sizeof *kb
);
10909 init_kboard (kb
, type
);
10910 kb
->next_kboard
= all_kboards
;
10916 * Destroy the contents of a kboard object, but not the object itself.
10917 * We use this just before deleting it, or if we're going to initialize
10918 * it a second time.
10921 wipe_kboard (KBOARD
*kb
)
10923 xfree (kb
->kbd_macro_buffer
);
10926 /* Free KB and memory referenced from it. */
10929 delete_kboard (KBOARD
*kb
)
10933 for (kbp
= &all_kboards
; *kbp
!= kb
; kbp
= &(*kbp
)->next_kboard
)
10936 *kbp
= kb
->next_kboard
;
10938 /* Prevent a dangling reference to KB. */
10939 if (kb
== current_kboard
10940 && FRAMEP (selected_frame
)
10941 && FRAME_LIVE_P (XFRAME (selected_frame
)))
10943 current_kboard
= FRAME_KBOARD (XFRAME (selected_frame
));
10944 single_kboard
= false;
10945 if (current_kboard
== kb
)
10954 init_keyboard (void)
10956 /* This is correct before outermost invocation of the editor loop. */
10957 command_loop_level
= -1;
10958 quit_char
= Ctl ('g');
10959 Vunread_command_events
= Qnil
;
10960 timer_idleness_start_time
= invalid_timespec ();
10962 recent_keys_index
= 0;
10963 kbd_fetch_ptr
= kbd_buffer
;
10964 kbd_store_ptr
= kbd_buffer
;
10965 do_mouse_tracking
= Qnil
;
10966 input_pending
= false;
10967 interrupt_input_blocked
= 0;
10968 pending_signals
= false;
10970 /* This means that command_loop_1 won't try to select anything the first
10972 internal_last_event_frame
= Qnil
;
10973 Vlast_event_frame
= internal_last_event_frame
;
10975 current_kboard
= initial_kboard
;
10976 /* Re-initialize the keyboard again. */
10977 wipe_kboard (current_kboard
);
10978 /* A value of nil for Vwindow_system normally means a tty, but we also use
10979 it for the initial terminal since there is no window system there. */
10980 init_kboard (current_kboard
, Qnil
);
10982 if (!noninteractive
)
10984 /* Before multi-tty support, these handlers used to be installed
10985 only if the current session was a tty session. Now an Emacs
10986 session may have multiple display types, so we always handle
10987 SIGINT. There is special code in handle_interrupt_signal to exit
10988 Emacs on SIGINT when there are no termcap frames on the
10989 controlling terminal. */
10990 struct sigaction action
;
10991 emacs_sigaction_init (&action
, deliver_interrupt_signal
);
10992 sigaction (SIGINT
, &action
, 0);
10994 /* For systems with SysV TERMIO, C-g is set up for both SIGINT and
10995 SIGQUIT and we can't tell which one it will give us. */
10996 sigaction (SIGQUIT
, &action
, 0);
10997 #endif /* not DOS_NT */
10999 #ifdef USABLE_SIGIO
11000 if (!noninteractive
)
11002 struct sigaction action
;
11003 emacs_sigaction_init (&action
, deliver_input_available_signal
);
11004 sigaction (SIGIO
, &action
, 0);
11008 /* Use interrupt input by default, if it works and noninterrupt input
11009 has deficiencies. */
11011 #ifdef INTERRUPT_INPUT
11012 interrupt_input
= 1;
11014 interrupt_input
= 0;
11017 pthread_sigmask (SIG_SETMASK
, &empty_mask
, 0);
11020 if (keyboard_init_hook
)
11021 (*keyboard_init_hook
) ();
11023 #ifdef POLL_FOR_INPUT
11025 poll_suppress_count
= 1;
11030 /* This type's only use is in syms_of_keyboard, to put properties on the
11031 event header symbols. */
11038 static const struct event_head head_table
[] = {
11039 {SYMBOL_INDEX (Qmouse_movement
), SYMBOL_INDEX (Qmouse_movement
)},
11040 {SYMBOL_INDEX (Qscroll_bar_movement
), SYMBOL_INDEX (Qmouse_movement
)},
11042 /* Some of the event heads. */
11043 {SYMBOL_INDEX (Qswitch_frame
), SYMBOL_INDEX (Qswitch_frame
)},
11045 {SYMBOL_INDEX (Qfocus_in
), SYMBOL_INDEX (Qfocus_in
)},
11046 {SYMBOL_INDEX (Qfocus_out
), SYMBOL_INDEX (Qfocus_out
)},
11047 {SYMBOL_INDEX (Qmove_frame
), SYMBOL_INDEX (Qmove_frame
)},
11048 {SYMBOL_INDEX (Qdelete_frame
), SYMBOL_INDEX (Qdelete_frame
)},
11049 {SYMBOL_INDEX (Qiconify_frame
), SYMBOL_INDEX (Qiconify_frame
)},
11050 {SYMBOL_INDEX (Qmake_frame_visible
), SYMBOL_INDEX (Qmake_frame_visible
)},
11051 /* `select-window' should be handled just like `switch-frame'
11052 in read_key_sequence. */
11053 {SYMBOL_INDEX (Qselect_window
), SYMBOL_INDEX (Qswitch_frame
)}
11057 syms_of_keyboard (void)
11059 pending_funcalls
= Qnil
;
11060 staticpro (&pending_funcalls
);
11062 Vlispy_mouse_stem
= build_pure_c_string ("mouse");
11063 staticpro (&Vlispy_mouse_stem
);
11065 regular_top_level_message
= build_pure_c_string ("Back to top level");
11066 #ifdef HAVE_STACK_OVERFLOW_HANDLING
11067 recover_top_level_message
11068 = build_pure_c_string ("Re-entering top level after C stack overflow");
11070 DEFVAR_LISP ("internal--top-level-message", Vinternal__top_level_message
,
11071 doc
: /* Message displayed by `normal-top-level'. */);
11072 Vinternal__top_level_message
= regular_top_level_message
;
11075 DEFSYM (QCimage
, ":image");
11076 DEFSYM (Qhelp_echo
, "help-echo");
11077 DEFSYM (QCrtl
, ":rtl");
11079 staticpro (&item_properties
);
11080 item_properties
= Qnil
;
11082 staticpro (&tool_bar_item_properties
);
11083 tool_bar_item_properties
= Qnil
;
11084 staticpro (&tool_bar_items_vector
);
11085 tool_bar_items_vector
= Qnil
;
11087 DEFSYM (Qtimer_event_handler
, "timer-event-handler");
11089 /* Non-nil disable property on a command means do not execute it;
11090 call disabled-command-function's value instead. */
11091 DEFSYM (Qdisabled
, "disabled");
11093 DEFSYM (Qundefined
, "undefined");
11095 /* Hooks to run before and after each command. */
11096 DEFSYM (Qpre_command_hook
, "pre-command-hook");
11097 DEFSYM (Qpost_command_hook
, "post-command-hook");
11099 DEFSYM (Qundo_auto__add_boundary
, "undo-auto--add-boundary");
11100 DEFSYM (Qundo_auto__undoably_changed_buffers
,
11101 "undo-auto--undoably-changed-buffers");
11103 DEFSYM (Qdeferred_action_function
, "deferred-action-function");
11104 DEFSYM (Qdelayed_warnings_hook
, "delayed-warnings-hook");
11105 DEFSYM (Qfunction_key
, "function-key");
11107 /* The values of Qevent_kind properties. */
11108 DEFSYM (Qmouse_click
, "mouse-click");
11110 DEFSYM (Qdrag_n_drop
, "drag-n-drop");
11111 DEFSYM (Qsave_session
, "save-session");
11112 DEFSYM (Qconfig_changed_event
, "config-changed-event");
11114 /* Menu and tool bar item parts. */
11115 DEFSYM (Qmenu_enable
, "menu-enable");
11117 DEFSYM (Qbuffer_switch
, "buffer-switch");
11120 DEFSYM (Qlanguage_change
, "language-change");
11121 DEFSYM (Qend_session
, "end-session");
11125 DEFSYM (Qdbus_event
, "dbus-event");
11128 #ifdef HAVE_XWIDGETS
11129 DEFSYM (Qxwidget_event
, "xwidget-event");
11132 #ifdef USE_FILE_NOTIFY
11133 DEFSYM (Qfile_notify
, "file-notify");
11134 #endif /* USE_FILE_NOTIFY */
11136 /* Menu and tool bar item parts. */
11137 DEFSYM (QCenable
, ":enable");
11138 DEFSYM (QCvisible
, ":visible");
11139 DEFSYM (QChelp
, ":help");
11140 DEFSYM (QCfilter
, ":filter");
11141 DEFSYM (QCbutton
, ":button");
11142 DEFSYM (QCkeys
, ":keys");
11143 DEFSYM (QCkey_sequence
, ":key-sequence");
11145 /* Non-nil disable property on a command means
11146 do not execute it; call disabled-command-function's value instead. */
11147 DEFSYM (QCtoggle
, ":toggle");
11148 DEFSYM (QCradio
, ":radio");
11149 DEFSYM (QClabel
, ":label");
11150 DEFSYM (QCvert_only
, ":vert-only");
11152 /* Symbols to use for parts of windows. */
11153 DEFSYM (Qvertical_line
, "vertical-line");
11154 DEFSYM (Qright_divider
, "right-divider");
11155 DEFSYM (Qbottom_divider
, "bottom-divider");
11157 DEFSYM (Qmouse_fixup_help_message
, "mouse-fixup-help-message");
11159 DEFSYM (Qabove_handle
, "above-handle");
11160 DEFSYM (Qhandle
, "handle");
11161 DEFSYM (Qbelow_handle
, "below-handle");
11162 DEFSYM (Qup
, "up");
11163 DEFSYM (Qdown
, "down");
11164 DEFSYM (Qtop
, "top");
11165 DEFSYM (Qbottom
, "bottom");
11166 DEFSYM (Qend_scroll
, "end-scroll");
11167 DEFSYM (Qratio
, "ratio");
11168 DEFSYM (Qbefore_handle
, "before-handle");
11169 DEFSYM (Qhorizontal_handle
, "horizontal-handle");
11170 DEFSYM (Qafter_handle
, "after-handle");
11171 DEFSYM (Qleft
, "left");
11172 DEFSYM (Qright
, "right");
11173 DEFSYM (Qleftmost
, "leftmost");
11174 DEFSYM (Qrightmost
, "rightmost");
11176 /* Properties of event headers. */
11177 DEFSYM (Qevent_kind
, "event-kind");
11178 DEFSYM (Qevent_symbol_elements
, "event-symbol-elements");
11180 /* An event header symbol HEAD may have a property named
11181 Qevent_symbol_element_mask, which is of the form (BASE MODIFIERS);
11182 BASE is the base, unmodified version of HEAD, and MODIFIERS is the
11183 mask of modifiers applied to it. If present, this is used to help
11184 speed up parse_modifiers. */
11185 DEFSYM (Qevent_symbol_element_mask
, "event-symbol-element-mask");
11187 /* An unmodified event header BASE may have a property named
11188 Qmodifier_cache, which is an alist mapping modifier masks onto
11189 modified versions of BASE. If present, this helps speed up
11190 apply_modifiers. */
11191 DEFSYM (Qmodifier_cache
, "modifier-cache");
11193 DEFSYM (Qrecompute_lucid_menubar
, "recompute-lucid-menubar");
11194 DEFSYM (Qactivate_menubar_hook
, "activate-menubar-hook");
11196 DEFSYM (Qpolling_period
, "polling-period");
11198 DEFSYM (Qgui_set_selection
, "gui-set-selection");
11200 /* The primary selection. */
11201 DEFSYM (QPRIMARY
, "PRIMARY");
11203 DEFSYM (Qhandle_switch_frame
, "handle-switch-frame");
11204 DEFSYM (Qhandle_select_window
, "handle-select-window");
11206 DEFSYM (Qinput_method_exit_on_first_char
, "input-method-exit-on-first-char");
11207 DEFSYM (Qinput_method_use_echo_area
, "input-method-use-echo-area");
11209 DEFSYM (Qhelp_form_show
, "help-form-show");
11211 DEFSYM (Qecho_keystrokes
, "echo-keystrokes");
11213 Fset (Qinput_method_exit_on_first_char
, Qnil
);
11214 Fset (Qinput_method_use_echo_area
, Qnil
);
11216 /* Symbols for dragging internal borders. */
11217 DEFSYM (Qdrag_internal_border
, "drag-internal-border");
11218 DEFSYM (Qleft_edge
, "left-edge");
11219 DEFSYM (Qtop_left_corner
, "top-left-corner");
11220 DEFSYM (Qtop_edge
, "top-edge");
11221 DEFSYM (Qtop_right_corner
, "top-right-corner");
11222 DEFSYM (Qright_edge
, "right-edge");
11223 DEFSYM (Qbottom_right_corner
, "bottom-right-corner");
11224 DEFSYM (Qbottom_edge
, "bottom-edge");
11225 DEFSYM (Qbottom_left_corner
, "bottom-left-corner");
11227 /* Symbols to head events. */
11228 DEFSYM (Qmouse_movement
, "mouse-movement");
11229 DEFSYM (Qscroll_bar_movement
, "scroll-bar-movement");
11230 DEFSYM (Qswitch_frame
, "switch-frame");
11231 DEFSYM (Qfocus_in
, "focus-in");
11232 DEFSYM (Qfocus_out
, "focus-out");
11233 DEFSYM (Qmove_frame
, "move-frame");
11234 DEFSYM (Qdelete_frame
, "delete-frame");
11235 DEFSYM (Qiconify_frame
, "iconify-frame");
11236 DEFSYM (Qmake_frame_visible
, "make-frame-visible");
11237 DEFSYM (Qselect_window
, "select-window");
11238 DEFSYM (Qselection_request
, "selection-request");
11242 for (i
= 0; i
< ARRAYELTS (head_table
); i
++)
11244 const struct event_head
*p
= &head_table
[i
];
11245 Lisp_Object var
= builtin_lisp_symbol (p
->var
);
11246 Lisp_Object kind
= builtin_lisp_symbol (p
->kind
);
11247 Fput (var
, Qevent_kind
, kind
);
11248 Fput (var
, Qevent_symbol_elements
, list1 (var
));
11252 button_down_location
= Fmake_vector (make_number (5), Qnil
);
11253 staticpro (&button_down_location
);
11254 mouse_syms
= Fmake_vector (make_number (5), Qnil
);
11255 staticpro (&mouse_syms
);
11256 wheel_syms
= Fmake_vector (make_number (ARRAYELTS (lispy_wheel_names
)),
11258 staticpro (&wheel_syms
);
11262 int len
= ARRAYELTS (modifier_names
);
11264 modifier_symbols
= Fmake_vector (make_number (len
), Qnil
);
11265 for (i
= 0; i
< len
; i
++)
11266 if (modifier_names
[i
])
11267 ASET (modifier_symbols
, i
, intern_c_string (modifier_names
[i
]));
11268 staticpro (&modifier_symbols
);
11271 recent_keys
= Fmake_vector (make_number (NUM_RECENT_KEYS
), Qnil
);
11272 staticpro (&recent_keys
);
11274 this_command_keys
= Fmake_vector (make_number (40), Qnil
);
11275 staticpro (&this_command_keys
);
11277 raw_keybuf
= Fmake_vector (make_number (30), Qnil
);
11278 staticpro (&raw_keybuf
);
11280 DEFSYM (Qcommand_execute
, "command-execute");
11281 DEFSYM (Qinternal_echo_keystrokes_prefix
, "internal-echo-keystrokes-prefix");
11283 accent_key_syms
= Qnil
;
11284 staticpro (&accent_key_syms
);
11286 func_key_syms
= Qnil
;
11287 staticpro (&func_key_syms
);
11289 drag_n_drop_syms
= Qnil
;
11290 staticpro (&drag_n_drop_syms
);
11292 unread_switch_frame
= Qnil
;
11293 staticpro (&unread_switch_frame
);
11295 internal_last_event_frame
= Qnil
;
11296 staticpro (&internal_last_event_frame
);
11298 read_key_sequence_cmd
= Qnil
;
11299 staticpro (&read_key_sequence_cmd
);
11300 read_key_sequence_remapped
= Qnil
;
11301 staticpro (&read_key_sequence_remapped
);
11303 menu_bar_one_keymap_changed_items
= Qnil
;
11304 staticpro (&menu_bar_one_keymap_changed_items
);
11306 menu_bar_items_vector
= Qnil
;
11307 staticpro (&menu_bar_items_vector
);
11309 help_form_saved_window_configs
= Qnil
;
11310 staticpro (&help_form_saved_window_configs
);
11312 defsubr (&Scurrent_idle_time
);
11313 defsubr (&Sevent_symbol_parse_modifiers
);
11314 defsubr (&Sevent_convert_list
);
11315 defsubr (&Sread_key_sequence
);
11316 defsubr (&Sread_key_sequence_vector
);
11317 defsubr (&Srecursive_edit
);
11318 defsubr (&Strack_mouse
);
11319 defsubr (&Sinput_pending_p
);
11320 defsubr (&Srecent_keys
);
11321 defsubr (&Sthis_command_keys
);
11322 defsubr (&Sthis_command_keys_vector
);
11323 defsubr (&Sthis_single_command_keys
);
11324 defsubr (&Sthis_single_command_raw_keys
);
11325 defsubr (&Sset__this_command_keys
);
11326 defsubr (&Sclear_this_command_keys
);
11327 defsubr (&Ssuspend_emacs
);
11328 defsubr (&Sabort_recursive_edit
);
11329 defsubr (&Sexit_recursive_edit
);
11330 defsubr (&Srecursion_depth
);
11331 defsubr (&Scommand_error_default_function
);
11332 defsubr (&Stop_level
);
11333 defsubr (&Sdiscard_input
);
11334 defsubr (&Sopen_dribble_file
);
11335 defsubr (&Sset_input_interrupt_mode
);
11336 defsubr (&Sset_output_flow_control
);
11337 defsubr (&Sset_input_meta_mode
);
11338 defsubr (&Sset_quit_char
);
11339 defsubr (&Sset_input_mode
);
11340 defsubr (&Scurrent_input_mode
);
11341 defsubr (&Sposn_at_point
);
11342 defsubr (&Sposn_at_x_y
);
11344 DEFVAR_LISP ("last-command-event", last_command_event
,
11345 doc
: /* Last input event that was part of a command. */);
11347 DEFVAR_LISP ("last-nonmenu-event", last_nonmenu_event
,
11348 doc
: /* Last input event in a command, except for mouse menu events.
11349 Mouse menus give back keys that don't look like mouse events;
11350 this variable holds the actual mouse event that led to the menu,
11351 so that you can determine whether the command was run by mouse or not. */);
11353 DEFVAR_LISP ("last-input-event", last_input_event
,
11354 doc
: /* Last input event. */);
11356 DEFVAR_LISP ("unread-command-events", Vunread_command_events
,
11357 doc
: /* List of events to be read as the command input.
11358 These events are processed first, before actual keyboard input.
11359 Events read from this list are not normally added to `this-command-keys',
11360 as they will already have been added once as they were read for the first time.
11361 An element of the form (t . EVENT) forces EVENT to be added to that list. */);
11362 Vunread_command_events
= Qnil
;
11364 DEFVAR_LISP ("unread-post-input-method-events", Vunread_post_input_method_events
,
11365 doc
: /* List of events to be processed as input by input methods.
11366 These events are processed before `unread-command-events'
11367 and actual keyboard input, but are not given to `input-method-function'. */);
11368 Vunread_post_input_method_events
= Qnil
;
11370 DEFVAR_LISP ("unread-input-method-events", Vunread_input_method_events
,
11371 doc
: /* List of events to be processed as input by input methods.
11372 These events are processed after `unread-command-events', but
11373 before actual keyboard input.
11374 If there's an active input method, the events are given to
11375 `input-method-function'. */);
11376 Vunread_input_method_events
= Qnil
;
11378 DEFVAR_LISP ("meta-prefix-char", meta_prefix_char
,
11379 doc
: /* Meta-prefix character code.
11380 Meta-foo as command input turns into this character followed by foo. */);
11381 XSETINT (meta_prefix_char
, 033);
11383 DEFVAR_KBOARD ("last-command", Vlast_command
,
11384 doc
: /* The last command executed.
11385 Normally a symbol with a function definition, but can be whatever was found
11386 in the keymap, or whatever the variable `this-command' was set to by that
11389 The value `mode-exit' is special; it means that the previous command
11390 read an event that told it to exit, and it did so and unread that event.
11391 In other words, the present command is the event that made the previous
11394 The value `kill-region' is special; it means that the previous command
11395 was a kill command.
11397 `last-command' has a separate binding for each terminal device.
11398 See Info node `(elisp)Multiple Terminals'. */);
11400 DEFVAR_KBOARD ("real-last-command", Vreal_last_command
,
11401 doc
: /* Same as `last-command', but never altered by Lisp code.
11402 Taken from the previous value of `real-this-command'. */);
11404 DEFVAR_KBOARD ("last-repeatable-command", Vlast_repeatable_command
,
11405 doc
: /* Last command that may be repeated.
11406 The last command executed that was not bound to an input event.
11407 This is the command `repeat' will try to repeat.
11408 Taken from a previous value of `real-this-command'. */);
11410 DEFVAR_LISP ("this-command", Vthis_command
,
11411 doc
: /* The command now being executed.
11412 The command can set this variable; whatever is put here
11413 will be in `last-command' during the following command. */);
11414 Vthis_command
= Qnil
;
11416 DEFVAR_LISP ("real-this-command", Vreal_this_command
,
11417 doc
: /* This is like `this-command', except that commands should never modify it. */);
11418 Vreal_this_command
= Qnil
;
11420 DEFVAR_LISP ("this-command-keys-shift-translated",
11421 Vthis_command_keys_shift_translated
,
11422 doc
: /* Non-nil if the key sequence activating this command was shift-translated.
11423 Shift-translation occurs when there is no binding for the key sequence
11424 as entered, but a binding was found by changing an upper-case letter
11425 to lower-case, or a shifted function key to an unshifted one. */);
11426 Vthis_command_keys_shift_translated
= Qnil
;
11428 DEFVAR_LISP ("this-original-command", Vthis_original_command
,
11429 doc
: /* The command bound to the current key sequence before remapping.
11430 It equals `this-command' if the original command was not remapped through
11431 any of the active keymaps. Otherwise, the value of `this-command' is the
11432 result of looking up the original command in the active keymaps. */);
11433 Vthis_original_command
= Qnil
;
11435 DEFVAR_INT ("auto-save-interval", auto_save_interval
,
11436 doc
: /* Number of input events between auto-saves.
11437 Zero means disable autosaving due to number of characters typed. */);
11438 auto_save_interval
= 300;
11440 DEFVAR_LISP ("auto-save-timeout", Vauto_save_timeout
,
11441 doc
: /* Number of seconds idle time before auto-save.
11442 Zero or nil means disable auto-saving due to idleness.
11443 After auto-saving due to this many seconds of idle time,
11444 Emacs also does a garbage collection if that seems to be warranted. */);
11445 XSETFASTINT (Vauto_save_timeout
, 30);
11447 DEFVAR_LISP ("echo-keystrokes", Vecho_keystrokes
,
11448 doc
: /* Nonzero means echo unfinished commands after this many seconds of pause.
11449 The value may be integer or floating point.
11450 If the value is zero, don't echo at all. */);
11451 Vecho_keystrokes
= make_number (1);
11453 DEFVAR_INT ("polling-period", polling_period
,
11454 doc
: /* Interval between polling for input during Lisp execution.
11455 The reason for polling is to make C-g work to stop a running program.
11456 Polling is needed only when using X windows and SIGIO does not work.
11457 Polling is automatically disabled in all other cases. */);
11458 polling_period
= 2;
11460 DEFVAR_LISP ("double-click-time", Vdouble_click_time
,
11461 doc
: /* Maximum time between mouse clicks to make a double-click.
11462 Measured in milliseconds. The value nil means disable double-click
11463 recognition; t means double-clicks have no time limit and are detected
11464 by position only. */);
11465 Vdouble_click_time
= make_number (500);
11467 DEFVAR_INT ("double-click-fuzz", double_click_fuzz
,
11468 doc
: /* Maximum mouse movement between clicks to make a double-click.
11469 On window-system frames, value is the number of pixels the mouse may have
11470 moved horizontally or vertically between two clicks to make a double-click.
11471 On non window-system frames, value is interpreted in units of 1/8 characters
11474 This variable is also the threshold for motion of the mouse
11475 to count as a drag. */);
11476 double_click_fuzz
= 3;
11478 DEFVAR_INT ("num-input-keys", num_input_keys
,
11479 doc
: /* Number of complete key sequences read as input so far.
11480 This includes key sequences read from keyboard macros.
11481 The number is effectively the number of interactive command invocations. */);
11482 num_input_keys
= 0;
11484 DEFVAR_INT ("num-nonmacro-input-events", num_nonmacro_input_events
,
11485 doc
: /* Number of input events read from the keyboard so far.
11486 This does not include events generated by keyboard macros. */);
11487 num_nonmacro_input_events
= 0;
11489 DEFVAR_LISP ("last-event-frame", Vlast_event_frame
,
11490 doc
: /* The frame in which the most recently read event occurred.
11491 If the last event came from a keyboard macro, this is set to `macro'. */);
11492 Vlast_event_frame
= Qnil
;
11494 /* This variable is set up in sysdep.c. */
11495 DEFVAR_LISP ("tty-erase-char", Vtty_erase_char
,
11496 doc
: /* The ERASE character as set by the user with stty. */);
11498 DEFVAR_LISP ("help-char", Vhelp_char
,
11499 doc
: /* Character to recognize as meaning Help.
11500 When it is read, do `(eval help-form)', and display result if it's a string.
11501 If the value of `help-form' is nil, this char can be read normally. */);
11502 XSETINT (Vhelp_char
, Ctl ('H'));
11504 DEFVAR_LISP ("help-event-list", Vhelp_event_list
,
11505 doc
: /* List of input events to recognize as meaning Help.
11506 These work just like the value of `help-char' (see that). */);
11507 Vhelp_event_list
= Qnil
;
11509 DEFVAR_LISP ("help-form", Vhelp_form
,
11510 doc
: /* Form to execute when character `help-char' is read.
11511 If the form returns a string, that string is displayed.
11512 If `help-form' is nil, the help char is not recognized. */);
11515 DEFVAR_LISP ("prefix-help-command", Vprefix_help_command
,
11516 doc
: /* Command to run when `help-char' character follows a prefix key.
11517 This command is used only when there is no actual binding
11518 for that character after that prefix key. */);
11519 Vprefix_help_command
= Qnil
;
11521 DEFVAR_LISP ("top-level", Vtop_level
,
11522 doc
: /* Form to evaluate when Emacs starts up.
11523 Useful to set before you dump a modified Emacs. */);
11525 XSYMBOL (Qtop_level
)->u
.s
.declared_special
= false;
11527 DEFVAR_KBOARD ("keyboard-translate-table", Vkeyboard_translate_table
,
11528 doc
: /* Translate table for local keyboard input, or nil.
11529 If non-nil, the value should be a char-table. Each character read
11530 from the keyboard is looked up in this char-table. If the value found
11531 there is non-nil, then it is used instead of the actual input character.
11533 The value can also be a string or vector, but this is considered obsolete.
11534 If it is a string or vector of length N, character codes N and up are left
11535 untranslated. In a vector, an element which is nil means "no translation".
11537 This is applied to the characters supplied to input methods, not their
11538 output. See also `translation-table-for-input'.
11540 This variable has a separate binding for each terminal.
11541 See Info node `(elisp)Multiple Terminals'. */);
11543 DEFVAR_BOOL ("cannot-suspend", cannot_suspend
,
11544 doc
: /* Non-nil means to always spawn a subshell instead of suspending.
11545 \(Even if the operating system has support for stopping a process.) */);
11546 cannot_suspend
= false;
11548 DEFVAR_BOOL ("menu-prompting", menu_prompting
,
11549 doc
: /* Non-nil means prompt with menus when appropriate.
11550 This is done when reading from a keymap that has a prompt string,
11551 for elements that have prompt strings.
11552 The menu is displayed on the screen
11553 if X menus were enabled at configuration
11554 time and the previous event was a mouse click prefix key.
11555 Otherwise, menu prompting uses the echo area. */);
11556 menu_prompting
= true;
11558 DEFVAR_LISP ("menu-prompt-more-char", menu_prompt_more_char
,
11559 doc
: /* Character to see next line of menu prompt.
11560 Type this character while in a menu prompt to rotate around the lines of it. */);
11561 XSETINT (menu_prompt_more_char
, ' ');
11563 DEFVAR_INT ("extra-keyboard-modifiers", extra_keyboard_modifiers
,
11564 doc
: /* A mask of additional modifier keys to use with every keyboard character.
11565 Emacs applies the modifiers of the character stored here to each keyboard
11566 character it reads. For example, after evaluating the expression
11567 (setq extra-keyboard-modifiers ?\\C-x)
11568 all input characters will have the control modifier applied to them.
11570 Note that the character ?\\C-@, equivalent to the integer zero, does
11571 not count as a control character; rather, it counts as a character
11572 with no modifiers; thus, setting `extra-keyboard-modifiers' to zero
11573 cancels any modification. */);
11574 extra_keyboard_modifiers
= 0;
11576 DEFSYM (Qdeactivate_mark
, "deactivate-mark");
11577 DEFVAR_LISP ("deactivate-mark", Vdeactivate_mark
,
11578 doc
: /* If an editing command sets this to t, deactivate the mark afterward.
11579 The command loop sets this to nil before each command,
11580 and tests the value when the command returns.
11581 Buffer modification stores t in this variable. */);
11582 Vdeactivate_mark
= Qnil
;
11583 Fmake_variable_buffer_local (Qdeactivate_mark
);
11585 DEFVAR_LISP ("pre-command-hook", Vpre_command_hook
,
11586 doc
: /* Normal hook run before each command is executed.
11587 If an unhandled error happens in running this hook,
11588 the function in which the error occurred is unconditionally removed, since
11589 otherwise the error might happen repeatedly and make Emacs nonfunctional.
11591 See also `post-command-hook'. */);
11592 Vpre_command_hook
= Qnil
;
11594 DEFVAR_LISP ("post-command-hook", Vpost_command_hook
,
11595 doc
: /* Normal hook run after each command is executed.
11596 If an unhandled error happens in running this hook,
11597 the function in which the error occurred is unconditionally removed, since
11598 otherwise the error might happen repeatedly and make Emacs nonfunctional.
11600 It is a bad idea to use this hook for expensive processing. If
11601 unavoidable, wrap your code in `(while-no-input (redisplay) CODE)' to
11602 avoid making Emacs unresponsive while the user types.
11604 See also `pre-command-hook'. */);
11605 Vpost_command_hook
= Qnil
;
11608 DEFVAR_LISP ("echo-area-clear-hook", ...,
11609 doc
: /* Normal hook run when clearing the echo area. */);
11611 DEFSYM (Qecho_area_clear_hook
, "echo-area-clear-hook");
11612 Fset (Qecho_area_clear_hook
, Qnil
);
11614 DEFVAR_LISP ("lucid-menu-bar-dirty-flag", Vlucid_menu_bar_dirty_flag
,
11615 doc
: /* Non-nil means menu bar, specified Lucid style, needs to be recomputed. */);
11616 Vlucid_menu_bar_dirty_flag
= Qnil
;
11618 DEFVAR_LISP ("menu-bar-final-items", Vmenu_bar_final_items
,
11619 doc
: /* List of menu bar items to move to the end of the menu bar.
11620 The elements of the list are event types that may have menu bar bindings. */);
11621 Vmenu_bar_final_items
= Qnil
;
11623 DEFVAR_LISP ("tool-bar-separator-image-expression", Vtool_bar_separator_image_expression
,
11624 doc
: /* Expression evaluating to the image spec for a tool-bar separator.
11625 This is used internally by graphical displays that do not render
11626 tool-bar separators natively. Otherwise it is unused (e.g. on GTK). */);
11627 Vtool_bar_separator_image_expression
= Qnil
;
11629 DEFVAR_KBOARD ("overriding-terminal-local-map",
11630 Voverriding_terminal_local_map
,
11631 doc
: /* Per-terminal keymap that takes precedence over all other keymaps.
11632 This variable is intended to let commands such as `universal-argument'
11633 set up a different keymap for reading the next command.
11635 `overriding-terminal-local-map' has a separate binding for each
11636 terminal device. See Info node `(elisp)Multiple Terminals'. */);
11638 DEFVAR_LISP ("overriding-local-map", Voverriding_local_map
,
11639 doc
: /* Keymap that replaces (overrides) local keymaps.
11640 If this variable is non-nil, Emacs looks up key bindings in this
11641 keymap INSTEAD OF the keymap char property, minor mode maps, and the
11642 buffer's local map. Hence, the only active keymaps would be
11643 `overriding-terminal-local-map', this keymap, and `global-keymap', in
11644 order of precedence. */);
11645 Voverriding_local_map
= Qnil
;
11647 DEFVAR_LISP ("overriding-local-map-menu-flag", Voverriding_local_map_menu_flag
,
11648 doc
: /* Non-nil means `overriding-local-map' applies to the menu bar.
11649 Otherwise, the menu bar continues to reflect the buffer's local map
11650 and the minor mode maps regardless of `overriding-local-map'. */);
11651 Voverriding_local_map_menu_flag
= Qnil
;
11653 DEFVAR_LISP ("special-event-map", Vspecial_event_map
,
11654 doc
: /* Keymap defining bindings for special events to execute at low level. */);
11655 Vspecial_event_map
= list1 (Qkeymap
);
11657 DEFVAR_LISP ("track-mouse", do_mouse_tracking
,
11658 doc
: /* Non-nil means generate motion events for mouse motion. */);
11660 DEFVAR_KBOARD ("system-key-alist", Vsystem_key_alist
,
11661 doc
: /* Alist of system-specific X windows key symbols.
11662 Each element should have the form (N . SYMBOL) where N is the
11663 numeric keysym code (sans the \"system-specific\" bit 1<<28)
11664 and SYMBOL is its name.
11666 `system-key-alist' has a separate binding for each terminal device.
11667 See Info node `(elisp)Multiple Terminals'. */);
11669 DEFVAR_KBOARD ("local-function-key-map", Vlocal_function_key_map
,
11670 doc
: /* Keymap that translates key sequences to key sequences during input.
11671 This is used mainly for mapping key sequences into some preferred
11672 key events (symbols).
11674 The `read-key-sequence' function replaces any subsequence bound by
11675 `local-function-key-map' with its binding. More precisely, when the
11676 active keymaps have no binding for the current key sequence but
11677 `local-function-key-map' binds a suffix of the sequence to a vector or
11678 string, `read-key-sequence' replaces the matching suffix with its
11679 binding, and continues with the new sequence.
11681 If the binding is a function, it is called with one argument (the prompt)
11682 and its return value (a key sequence) is used.
11684 The events that come from bindings in `local-function-key-map' are not
11685 themselves looked up in `local-function-key-map'.
11687 For example, suppose `local-function-key-map' binds `ESC O P' to [f1].
11688 Typing `ESC O P' to `read-key-sequence' would return [f1]. Typing
11689 `C-x ESC O P' would return [?\\C-x f1]. If [f1] were a prefix key,
11690 typing `ESC O P x' would return [f1 x].
11692 `local-function-key-map' has a separate binding for each terminal
11693 device. See Info node `(elisp)Multiple Terminals'. If you need to
11694 define a binding on all terminals, change `function-key-map'
11695 instead. Initially, `local-function-key-map' is an empty keymap that
11696 has `function-key-map' as its parent on all terminal devices. */);
11698 DEFVAR_KBOARD ("input-decode-map", Vinput_decode_map
,
11699 doc
: /* Keymap that decodes input escape sequences.
11700 This is used mainly for mapping ASCII function key sequences into
11701 real Emacs function key events (symbols).
11703 The `read-key-sequence' function replaces any subsequence bound by
11704 `input-decode-map' with its binding. Contrary to `function-key-map',
11705 this map applies its rebinding regardless of the presence of an ordinary
11706 binding. So it is more like `key-translation-map' except that it applies
11707 before `function-key-map' rather than after.
11709 If the binding is a function, it is called with one argument (the prompt)
11710 and its return value (a key sequence) is used.
11712 The events that come from bindings in `input-decode-map' are not
11713 themselves looked up in `input-decode-map'. */);
11715 DEFVAR_LISP ("function-key-map", Vfunction_key_map
,
11716 doc
: /* The parent keymap of all `local-function-key-map' instances.
11717 Function key definitions that apply to all terminal devices should go
11718 here. If a mapping is defined in both the current
11719 `local-function-key-map' binding and this variable, then the local
11720 definition will take precedence. */);
11721 Vfunction_key_map
= Fmake_sparse_keymap (Qnil
);
11723 DEFVAR_LISP ("key-translation-map", Vkey_translation_map
,
11724 doc
: /* Keymap of key translations that can override keymaps.
11725 This keymap works like `input-decode-map', but comes after `function-key-map'.
11726 Another difference is that it is global rather than terminal-local. */);
11727 Vkey_translation_map
= Fmake_sparse_keymap (Qnil
);
11729 DEFVAR_LISP ("deferred-action-list", Vdeferred_action_list
,
11730 doc
: /* List of deferred actions to be performed at a later time.
11731 The precise format isn't relevant here; we just check whether it is nil. */);
11732 Vdeferred_action_list
= Qnil
;
11734 DEFVAR_LISP ("deferred-action-function", Vdeferred_action_function
,
11735 doc
: /* Function to call to handle deferred actions, after each command.
11736 This function is called with no arguments after each command
11737 whenever `deferred-action-list' is non-nil. */);
11738 Vdeferred_action_function
= Qnil
;
11740 DEFVAR_LISP ("delayed-warnings-list", Vdelayed_warnings_list
,
11741 doc
: /* List of warnings to be displayed after this command.
11742 Each element must be a list (TYPE MESSAGE [LEVEL [BUFFER-NAME]]),
11743 as per the args of `display-warning' (which see).
11744 If this variable is non-nil, `delayed-warnings-hook' will be run
11745 immediately after running `post-command-hook'. */);
11746 Vdelayed_warnings_list
= Qnil
;
11748 DEFVAR_LISP ("timer-list", Vtimer_list
,
11749 doc
: /* List of active absolute time timers in order of increasing time. */);
11750 Vtimer_list
= Qnil
;
11752 DEFVAR_LISP ("timer-idle-list", Vtimer_idle_list
,
11753 doc
: /* List of active idle-time timers in order of increasing time. */);
11754 Vtimer_idle_list
= Qnil
;
11756 DEFVAR_LISP ("input-method-function", Vinput_method_function
,
11757 doc
: /* If non-nil, the function that implements the current input method.
11758 It's called with one argument, which must be a single-byte
11759 character that was just read. Any single-byte character is
11760 acceptable, except the DEL character, codepoint 127 decimal, 177 octal.
11761 Typically this function uses `read-event' to read additional events.
11762 When it does so, it should first bind `input-method-function' to nil
11763 so it will not be called recursively.
11765 The function should return a list of zero or more events
11766 to be used as input. If it wants to put back some events
11767 to be reconsidered, separately, by the input method,
11768 it can add them to the beginning of `unread-command-events'.
11770 The input method function can find in `input-method-previous-message'
11771 the previous echo area message.
11773 The input method function should refer to the variables
11774 `input-method-use-echo-area' and `input-method-exit-on-first-char'
11775 for guidance on what to do. */);
11776 Vinput_method_function
= Qlist
;
11778 DEFVAR_LISP ("input-method-previous-message",
11779 Vinput_method_previous_message
,
11780 doc
: /* When `input-method-function' is called, hold the previous echo area message.
11781 This variable exists because `read-event' clears the echo area
11782 before running the input method. It is nil if there was no message. */);
11783 Vinput_method_previous_message
= Qnil
;
11785 DEFVAR_LISP ("show-help-function", Vshow_help_function
,
11786 doc
: /* If non-nil, the function that implements the display of help.
11787 It's called with one argument, the help string to display. */);
11788 Vshow_help_function
= Qnil
;
11790 DEFVAR_LISP ("disable-point-adjustment", Vdisable_point_adjustment
,
11791 doc
: /* If non-nil, suppress point adjustment after executing a command.
11793 After a command is executed, if point moved into a region that has
11794 special properties (e.g. composition, display), Emacs adjusts point to
11795 the boundary of the region. But when a command leaves this variable at
11796 a non-nil value (e.g., with a setq), this point adjustment is suppressed.
11798 This variable is set to nil before reading a command, and is checked
11799 just after executing the command. */);
11800 Vdisable_point_adjustment
= Qnil
;
11802 DEFVAR_LISP ("global-disable-point-adjustment",
11803 Vglobal_disable_point_adjustment
,
11804 doc
: /* If non-nil, always suppress point adjustments.
11806 The default value is nil, in which case point adjustments are
11807 suppressed only after special commands that leave
11808 `disable-point-adjustment' (which see) at a non-nil value. */);
11809 Vglobal_disable_point_adjustment
= Qnil
;
11811 DEFVAR_LISP ("minibuffer-message-timeout", Vminibuffer_message_timeout
,
11812 doc
: /* How long to display an echo-area message when the minibuffer is active.
11813 If the value is a number, it should be specified in seconds.
11814 If the value is not a number, such messages never time out. */);
11815 Vminibuffer_message_timeout
= make_number (2);
11817 DEFVAR_LISP ("throw-on-input", Vthrow_on_input
,
11818 doc
: /* If non-nil, any keyboard input throws to this symbol.
11819 The value of that variable is passed to `quit-flag' and later causes a
11820 peculiar kind of quitting. */);
11821 Vthrow_on_input
= Qnil
;
11823 DEFVAR_LISP ("command-error-function", Vcommand_error_function
,
11824 doc
: /* Function to output error messages.
11825 Called with three arguments:
11826 - the error data, a list of the form (SIGNALED-CONDITION . SIGNAL-DATA)
11827 such as what `condition-case' would bind its variable to,
11828 - the context (a string which normally goes at the start of the message),
11829 - the Lisp function within which the error was signaled. */);
11830 Vcommand_error_function
= intern ("command-error-default-function");
11832 DEFVAR_LISP ("enable-disabled-menus-and-buttons",
11833 Venable_disabled_menus_and_buttons
,
11834 doc
: /* If non-nil, don't ignore events produced by disabled menu items and tool-bar.
11836 Help functions bind this to allow help on disabled menu items
11837 and tool-bar buttons. */);
11838 Venable_disabled_menus_and_buttons
= Qnil
;
11840 DEFVAR_LISP ("select-active-regions",
11841 Vselect_active_regions
,
11842 doc
: /* If non-nil, an active region automatically sets the primary selection.
11843 If the value is `only', only temporarily active regions (usually made
11844 by mouse-dragging or shift-selection) set the window selection.
11846 This takes effect only when Transient Mark mode is enabled. */);
11847 Vselect_active_regions
= Qt
;
11849 DEFVAR_LISP ("saved-region-selection",
11850 Vsaved_region_selection
,
11851 doc
: /* Contents of active region prior to buffer modification.
11852 If `select-active-regions' is non-nil, Emacs sets this to the
11853 text in the region before modifying the buffer. The next call to
11854 the function `deactivate-mark' uses this to set the window selection. */);
11855 Vsaved_region_selection
= Qnil
;
11857 DEFVAR_LISP ("selection-inhibit-update-commands",
11858 Vselection_inhibit_update_commands
,
11859 doc
: /* List of commands which should not update the selection.
11860 Normally, if `select-active-regions' is non-nil and the mark remains
11861 active after a command (i.e. the mark was not deactivated), the Emacs
11862 command loop sets the selection to the text in the region. However,
11863 if the command is in this list, the selection is not updated. */);
11864 Vselection_inhibit_update_commands
11865 = list2 (Qhandle_switch_frame
, Qhandle_select_window
);
11867 DEFVAR_LISP ("debug-on-event",
11869 doc
: /* Enter debugger on this event.
11870 When Emacs receives the special event specified by this variable,
11871 it will try to break into the debugger as soon as possible instead
11872 of processing the event normally through `special-event-map'.
11874 Currently, the only supported values for this
11875 variable are `sigusr1' and `sigusr2'. */);
11876 Vdebug_on_event
= intern_c_string ("sigusr2");
11878 DEFVAR_BOOL ("attempt-stack-overflow-recovery",
11879 attempt_stack_overflow_recovery
,
11880 doc
: /* If non-nil, attempt to recover from C stack overflows.
11881 This recovery is potentially unsafe and may lead to deadlocks or data
11882 corruption, but it usually works and may preserve modified buffers
11883 that would otherwise be lost. If nil, treat stack overflow like any
11884 other kind of crash or fatal error. */);
11885 attempt_stack_overflow_recovery
= true;
11887 DEFVAR_BOOL ("attempt-orderly-shutdown-on-fatal-signal",
11888 attempt_orderly_shutdown_on_fatal_signal
,
11889 doc
: /* If non-nil, attempt orderly shutdown on fatal signals.
11890 By default this variable is non-nil, and Emacs attempts to perform
11891 an orderly shutdown when it catches a fatal signal (e.g., a crash).
11892 The orderly shutdown includes an attempt to auto-save your unsaved edits
11893 and other useful cleanups. These cleanups are potentially unsafe and may
11894 lead to deadlocks or data corruption, but it usually works and may
11895 preserve data in modified buffers that would otherwise be lost.
11896 If nil, Emacs crashes immediately in response to fatal signals. */);
11897 attempt_orderly_shutdown_on_fatal_signal
= true;
11899 /* Create the initial keyboard. Qt means 'unset'. */
11900 initial_kboard
= allocate_kboard (Qt
);
11902 DEFVAR_LISP ("while-no-input-ignore-events",
11903 Vwhile_no_input_ignore_events
,
11904 doc
: /* Ignored events from while-no-input. */);
11905 Vwhile_no_input_ignore_events
= Qnil
;
11909 keys_of_keyboard (void)
11911 initial_define_key (global_map
, Ctl ('Z'), "suspend-emacs");
11912 initial_define_key (control_x_map
, Ctl ('Z'), "suspend-emacs");
11913 initial_define_key (meta_map
, Ctl ('C'), "exit-recursive-edit");
11914 initial_define_key (global_map
, Ctl (']'), "abort-recursive-edit");
11915 initial_define_key (meta_map
, 'x', "execute-extended-command");
11917 initial_define_lispy_key (Vspecial_event_map
, "delete-frame",
11918 "handle-delete-frame");
11920 initial_define_lispy_key (Vspecial_event_map
, "end-session",
11923 initial_define_lispy_key (Vspecial_event_map
, "ns-put-working-text",
11924 "ns-put-working-text");
11925 initial_define_lispy_key (Vspecial_event_map
, "ns-unput-working-text",
11926 "ns-unput-working-text");
11927 /* Here we used to use `ignore-event' which would simple set prefix-arg to
11928 current-prefix-arg, as is done in `handle-switch-frame'.
11929 But `handle-switch-frame is not run from the special-map.
11930 Commands from that map are run in a special way that automatically
11931 preserves the prefix-arg. Restoring the prefix arg here is not just
11932 redundant but harmful:
11934 - current-prefix-arg is set to non-nil, prefix-arg is set to nil.
11935 - after the first prompt, the exit-minibuffer-hook is run which may
11936 iconify a frame and thus push a `iconify-frame' event.
11937 - after running exit-minibuffer-hook, current-prefix-arg is
11938 restored to the non-nil value it had before the prompt.
11939 - we enter the second prompt.
11940 current-prefix-arg is non-nil, prefix-arg is nil.
11941 - before running the first real event, we run the special iconify-frame
11942 event, but we pass the `special' arg to command-execute so
11943 current-prefix-arg and prefix-arg are left untouched.
11944 - here we foolishly copy the non-nil current-prefix-arg to prefix-arg.
11945 - the next key event will have a spuriously non-nil current-prefix-arg. */
11946 initial_define_lispy_key (Vspecial_event_map
, "iconify-frame",
11948 initial_define_lispy_key (Vspecial_event_map
, "make-frame-visible",
11950 /* Handling it at such a low-level causes read_key_sequence to get
11951 * confused because it doesn't realize that the current_buffer was
11952 * changed by read_char.
11954 * initial_define_lispy_key (Vspecial_event_map, "select-window",
11955 * "handle-select-window"); */
11956 initial_define_lispy_key (Vspecial_event_map
, "save-session",
11957 "handle-save-session");
11960 /* Define a special event which is raised for dbus callback
11962 initial_define_lispy_key (Vspecial_event_map
, "dbus-event",
11963 "dbus-handle-event");
11966 #ifdef USE_FILE_NOTIFY
11967 /* Define a special event which is raised for notification callback
11969 initial_define_lispy_key (Vspecial_event_map
, "file-notify",
11970 "file-notify-handle-event");
11971 #endif /* USE_FILE_NOTIFY */
11973 initial_define_lispy_key (Vspecial_event_map
, "config-changed-event",
11975 #if defined (WINDOWSNT)
11976 initial_define_lispy_key (Vspecial_event_map
, "language-change",
11979 initial_define_lispy_key (Vspecial_event_map
, "focus-in",
11980 "handle-focus-in");
11981 initial_define_lispy_key (Vspecial_event_map
, "focus-out",
11982 "handle-focus-out");
11983 initial_define_lispy_key (Vspecial_event_map
, "move-frame",
11984 "handle-move-frame");
11987 /* Mark the pointers in the kboard objects.
11988 Called by Fgarbage_collect. */
11990 mark_kboards (void)
11994 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
11996 if (kb
->kbd_macro_buffer
)
11997 for (p
= kb
->kbd_macro_buffer
; p
< kb
->kbd_macro_ptr
; p
++)
11999 mark_object (KVAR (kb
, Voverriding_terminal_local_map
));
12000 mark_object (KVAR (kb
, Vlast_command
));
12001 mark_object (KVAR (kb
, Vreal_last_command
));
12002 mark_object (KVAR (kb
, Vkeyboard_translate_table
));
12003 mark_object (KVAR (kb
, Vlast_repeatable_command
));
12004 mark_object (KVAR (kb
, Vprefix_arg
));
12005 mark_object (KVAR (kb
, Vlast_prefix_arg
));
12006 mark_object (KVAR (kb
, kbd_queue
));
12007 mark_object (KVAR (kb
, defining_kbd_macro
));
12008 mark_object (KVAR (kb
, Vlast_kbd_macro
));
12009 mark_object (KVAR (kb
, Vsystem_key_alist
));
12010 mark_object (KVAR (kb
, system_key_syms
));
12011 mark_object (KVAR (kb
, Vwindow_system
));
12012 mark_object (KVAR (kb
, Vinput_decode_map
));
12013 mark_object (KVAR (kb
, Vlocal_function_key_map
));
12014 mark_object (KVAR (kb
, Vdefault_minibuffer_frame
));
12015 mark_object (KVAR (kb
, echo_string
));
12016 mark_object (KVAR (kb
, echo_prompt
));
12019 union buffered_input_event
*event
;
12020 for (event
= kbd_fetch_ptr
; event
!= kbd_store_ptr
; event
++)
12022 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
12024 event
= kbd_buffer
;
12025 if (event
== kbd_store_ptr
)
12029 /* These two special event types has no Lisp_Objects to mark. */
12030 if (event
->kind
!= SELECTION_REQUEST_EVENT
12031 && event
->kind
!= SELECTION_CLEAR_EVENT
)
12033 mark_object (event
->ie
.x
);
12034 mark_object (event
->ie
.y
);
12035 mark_object (event
->ie
.frame_or_window
);
12036 mark_object (event
->ie
.arg
);