1 /* Keyboard and mouse input; editor command loop.
3 Copyright (C) 1985-1989, 1993-1997, 1999-2017 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 <http://www.gnu.org/licenses/>. */
30 #include "termhooks.h"
35 #include "character.h"
37 #include "dispextern.h"
39 #include "intervals.h"
41 #include "blockinput.h"
54 #include <sys/ioctl.h>
55 #endif /* not MSDOS */
57 #if defined USABLE_FIONREAD && defined USG5_4
58 # include <sys/filio.h>
61 #include "syssignal.h"
63 #include <sys/types.h>
67 #include <ignore-value.h>
69 #ifdef HAVE_WINDOW_SYSTEM
71 #endif /* HAVE_WINDOW_SYSTEM */
73 /* Work around GCC bug 54561. */
74 #if GNUC_PREREQ (4, 3, 0)
75 # pragma GCC diagnostic ignored "-Wclobbered"
79 char const DEV_TTY
[] = "CONOUT$";
81 char const DEV_TTY
[] = "/dev/tty";
84 /* Variables for blockinput.h: */
86 /* Positive if interrupt input is blocked right now. */
87 volatile int interrupt_input_blocked
;
89 /* True means an input interrupt or alarm signal has arrived.
90 The maybe_quit function checks this. */
91 volatile bool pending_signals
;
93 #define KBD_BUFFER_SIZE 4096
95 KBOARD
*initial_kboard
;
96 KBOARD
*current_kboard
;
97 static KBOARD
*all_kboards
;
99 /* True in the single-kboard state, false in the any-kboard state. */
100 static bool single_kboard
;
102 #define NUM_RECENT_KEYS (300)
104 /* Index for storing next element into recent_keys. */
105 static int recent_keys_index
;
107 /* Total number of elements stored into recent_keys. */
108 static int total_keys
;
110 /* This vector holds the last NUM_RECENT_KEYS keystrokes. */
111 static Lisp_Object recent_keys
;
113 /* Vector holding the key sequence that invoked the current command.
114 It is reused for each command, and it may be longer than the current
115 sequence; this_command_key_count indicates how many elements
116 actually mean something.
117 It's easier to staticpro a single Lisp_Object than an array. */
118 Lisp_Object this_command_keys
;
119 ptrdiff_t this_command_key_count
;
121 /* This vector is used as a buffer to record the events that were actually read
122 by read_key_sequence. */
123 static Lisp_Object raw_keybuf
;
124 static int raw_keybuf_count
;
126 #define GROW_RAW_KEYBUF \
127 if (raw_keybuf_count == ASIZE (raw_keybuf)) \
128 raw_keybuf = larger_vector (raw_keybuf, 1, -1)
130 /* Number of elements of this_command_keys
131 that precede this key sequence. */
132 static ptrdiff_t this_single_command_key_start
;
134 #ifdef HAVE_STACK_OVERFLOW_HANDLING
136 /* For longjmp to recover from C stack overflow. */
137 sigjmp_buf return_to_command_loop
;
139 /* Message displayed by Vtop_level when recovering from C stack overflow. */
140 static Lisp_Object recover_top_level_message
;
142 #endif /* HAVE_STACK_OVERFLOW_HANDLING */
144 /* Message normally displayed by Vtop_level. */
145 static Lisp_Object regular_top_level_message
;
147 /* For longjmp to where kbd input is being done. */
149 static sys_jmp_buf getcjmp
;
151 /* True while displaying for echoing. Delays C-g throwing. */
155 /* Non-null means we can start echoing at the next input pause even
156 though there is something in the echo area. */
158 static struct kboard
*ok_to_echo_at_next_pause
;
160 /* The kboard last echoing, or null for none. Reset to 0 in
161 cancel_echoing. If non-null, and a current echo area message
162 exists, and echo_message_buffer is eq to the current message
163 buffer, we know that the message comes from echo_kboard. */
165 struct kboard
*echo_kboard
;
167 /* The buffer used for echoing. Set in echo_now, reset in
170 Lisp_Object echo_message_buffer
;
172 /* Character that causes a quit. Normally C-g.
174 If we are running on an ordinary terminal, this must be an ordinary
175 ASCII char, since we want to make it our interrupt character.
177 If we are not running on an ordinary terminal, it still needs to be
178 an ordinary ASCII char. This character needs to be recognized in
179 the input interrupt handler. At this point, the keystroke is
180 represented as a struct input_event, while the desired quit
181 character is specified as a lispy event. The mapping from struct
182 input_events to lispy events cannot run in an interrupt handler,
183 and the reverse mapping is difficult for anything but ASCII
186 FOR THESE ELABORATE AND UNSATISFYING REASONS, quit_char must be an
190 /* Current depth in recursive edits. */
191 EMACS_INT command_loop_level
;
193 /* If not Qnil, this is a switch-frame event which we decided to put
194 off until the end of a key sequence. This should be read as the
195 next command input, after any unread_command_events.
197 read_key_sequence uses this to delay switch-frame events until the
198 end of the key sequence; Fread_char uses it to put off switch-frame
199 events until a non-ASCII event is acceptable as input. */
200 Lisp_Object unread_switch_frame
;
202 /* Last size recorded for a current buffer which is not a minibuffer. */
203 static ptrdiff_t last_non_minibuf_size
;
205 uintmax_t num_input_events
;
206 ptrdiff_t point_before_last_command_or_undo
;
207 struct buffer
*buffer_before_last_command_or_undo
;
209 /* Value of num_nonmacro_input_events as of last auto save. */
211 static EMACS_INT last_auto_save
;
213 /* The value of point when the last command was started. */
214 static ptrdiff_t last_point_position
;
216 /* The frame in which the last input event occurred, or Qmacro if the
217 last event came from a macro. We use this to determine when to
218 generate switch-frame events. This may be cleared by functions
219 like Fselect_frame, to make sure that a switch-frame event is
220 generated by the next character.
222 FIXME: This is modified by a signal handler so it should be volatile.
223 It's exported to Lisp, though, so it can't simply be marked
225 Lisp_Object internal_last_event_frame
;
227 /* `read_key_sequence' stores here the command definition of the
228 key sequence that it reads. */
229 static Lisp_Object read_key_sequence_cmd
;
230 static Lisp_Object read_key_sequence_remapped
;
232 /* File in which we write all commands we read. */
233 static FILE *dribble
;
235 /* True if input is available. */
238 /* True if more input was available last time we read an event.
240 Since redisplay can take a significant amount of time and is not
241 indispensable to perform the user's commands, when input arrives
242 "too fast", Emacs skips redisplay. More specifically, if the next
243 command has already been input when we finish the previous command,
244 we skip the intermediate redisplay.
246 This is useful to try and make sure Emacs keeps up with fast input
247 rates, such as auto-repeating keys. But in some cases, this proves
248 too conservative: we may end up disabling redisplay for the whole
249 duration of a key repetition, even though we could afford to
250 redisplay every once in a while.
252 So we "sample" the input_pending flag before running a command and
253 use *that* value after running the command to decide whether to
254 skip redisplay or not. This way, we only skip redisplay if we
255 really can't keep up with the repeat rate.
257 This only makes a difference if the next input arrives while running the
258 command, which is very unlikely if the command is executed quickly.
259 IOW this tends to avoid skipping redisplay after a long running command
260 (which is a case where skipping redisplay is not very useful since the
261 redisplay time is small compared to the time it took to run the command).
263 A typical use case is when scrolling. Scrolling time can be split into:
264 - Time to do jit-lock on the newly displayed portion of buffer.
265 - Time to run the actual scroll command.
266 - Time to perform the redisplay.
267 Jit-lock can happen either during the command or during the redisplay.
268 In the most painful cases, the jit-lock time is the one that dominates.
269 Also jit-lock can be tweaked (via jit-lock-defer) to delay its job, at the
270 cost of temporary inaccuracy in display and scrolling.
271 So without input_was_pending, what typically happens is the following:
272 - when the command starts, there's no pending input (yet).
273 - the scroll command triggers jit-lock.
274 - during the long jit-lock time the next input arrives.
275 - at the end of the command, we check input_pending and hence decide to
277 - we read the next input and start over.
278 End result: all the hard work of jit-locking is "wasted" since redisplay
279 doesn't actually happens (at least not before the input rate slows down).
280 With input_was_pending redisplay is still skipped if Emacs can't keep up
281 with the input rate, but if it can keep up just enough that there's no
282 input_pending when we begin the command, then redisplay is not skipped
283 which results in better feedback to the user. */
284 static bool input_was_pending
;
286 /* Circular buffer for pre-read keyboard input. */
288 static union buffered_input_event kbd_buffer
[KBD_BUFFER_SIZE
];
290 /* Pointer to next available character in kbd_buffer.
291 If kbd_fetch_ptr == kbd_store_ptr, the buffer is empty.
292 This may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the
293 next available char is in kbd_buffer[0]. */
294 static union buffered_input_event
*kbd_fetch_ptr
;
296 /* Pointer to next place to store character in kbd_buffer. This
297 may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the next
298 character should go in kbd_buffer[0]. */
299 static union buffered_input_event
*volatile kbd_store_ptr
;
301 /* The above pair of variables forms a "queue empty" flag. When we
302 enqueue a non-hook event, we increment kbd_store_ptr. When we
303 dequeue a non-hook event, we increment kbd_fetch_ptr. We say that
304 there is input available if the two pointers are not equal.
306 Why not just have a flag set and cleared by the enqueuing and
307 dequeuing functions? Such a flag could be screwed up by interrupts
308 at inopportune times. */
310 static void recursive_edit_unwind (Lisp_Object buffer
);
311 static Lisp_Object
command_loop (void);
313 static void echo_now (void);
314 static ptrdiff_t echo_length (void);
316 /* Incremented whenever a timer is run. */
319 /* Address (if not 0) of struct timespec to zero out if a SIGIO interrupt
321 struct timespec
*input_available_clear_time
;
323 /* True means use SIGIO interrupts; false means use CBREAK mode.
324 Default is true if INTERRUPT_INPUT is defined. */
325 bool interrupt_input
;
327 /* Nonzero while interrupts are temporarily deferred during redisplay. */
328 bool interrupts_deferred
;
330 /* The time when Emacs started being idle. */
332 static struct timespec timer_idleness_start_time
;
334 /* After Emacs stops being idle, this saves the last value
335 of timer_idleness_start_time from when it was idle. */
337 static struct timespec timer_last_idleness_start_time
;
340 /* Global variable declarations. */
342 /* Flags for readable_events. */
343 #define READABLE_EVENTS_DO_TIMERS_NOW (1 << 0)
344 #define READABLE_EVENTS_FILTER_EVENTS (1 << 1)
345 #define READABLE_EVENTS_IGNORE_SQUEEZABLES (1 << 2)
347 /* Function for init_keyboard to call with no args (if nonzero). */
348 static void (*keyboard_init_hook
) (void);
350 static bool get_input_pending (int);
351 static bool readable_events (int);
352 static Lisp_Object
read_char_x_menu_prompt (Lisp_Object
,
353 Lisp_Object
, bool *);
354 static Lisp_Object
read_char_minibuf_menu_prompt (int, Lisp_Object
);
355 static Lisp_Object
make_lispy_event (struct input_event
*);
356 static Lisp_Object
make_lispy_movement (struct frame
*, Lisp_Object
,
357 enum scroll_bar_part
,
358 Lisp_Object
, Lisp_Object
,
360 static Lisp_Object
modify_event_symbol (ptrdiff_t, int, Lisp_Object
,
361 Lisp_Object
, const char *const *,
362 Lisp_Object
*, ptrdiff_t);
363 static Lisp_Object
make_lispy_switch_frame (Lisp_Object
);
364 static Lisp_Object
make_lispy_focus_in (Lisp_Object
);
365 #ifdef HAVE_WINDOW_SYSTEM
366 static Lisp_Object
make_lispy_focus_out (Lisp_Object
);
367 #endif /* HAVE_WINDOW_SYSTEM */
368 static bool help_char_p (Lisp_Object
);
369 static void save_getcjmp (sys_jmp_buf
);
370 static void restore_getcjmp (sys_jmp_buf
);
371 static Lisp_Object
apply_modifiers (int, Lisp_Object
);
372 static void restore_kboard_configuration (int);
373 static void handle_interrupt (bool);
374 static _Noreturn
void quit_throw_to_read_char (bool);
375 static void timer_start_idle (void);
376 static void timer_stop_idle (void);
377 static void timer_resume_idle (void);
378 static void deliver_user_signal (int);
379 static char *find_user_signal_name (int);
380 static void store_user_signal_events (void);
382 /* These setters are used only in this file, so they can be private. */
384 kset_echo_string (struct kboard
*kb
, Lisp_Object val
)
386 kb
->echo_string_
= val
;
389 kset_echo_prompt (struct kboard
*kb
, Lisp_Object val
)
391 kb
->echo_prompt_
= val
;
394 kset_kbd_queue (struct kboard
*kb
, Lisp_Object val
)
396 kb
->kbd_queue_
= val
;
399 kset_keyboard_translate_table (struct kboard
*kb
, Lisp_Object val
)
401 kb
->Vkeyboard_translate_table_
= val
;
404 kset_last_prefix_arg (struct kboard
*kb
, Lisp_Object val
)
406 kb
->Vlast_prefix_arg_
= val
;
409 kset_last_repeatable_command (struct kboard
*kb
, Lisp_Object val
)
411 kb
->Vlast_repeatable_command_
= val
;
414 kset_local_function_key_map (struct kboard
*kb
, Lisp_Object val
)
416 kb
->Vlocal_function_key_map_
= val
;
419 kset_overriding_terminal_local_map (struct kboard
*kb
, Lisp_Object val
)
421 kb
->Voverriding_terminal_local_map_
= val
;
424 kset_real_last_command (struct kboard
*kb
, Lisp_Object val
)
426 kb
->Vreal_last_command_
= val
;
429 kset_system_key_syms (struct kboard
*kb
, Lisp_Object val
)
431 kb
->system_key_syms_
= val
;
436 echo_keystrokes_p (void)
438 return (FLOATP (Vecho_keystrokes
) ? XFLOAT_DATA (Vecho_keystrokes
) > 0.0
439 : INTEGERP (Vecho_keystrokes
) ? XINT (Vecho_keystrokes
) > 0
443 /* Add C to the echo string, without echoing it immediately. C can be
444 a character, which is pretty-printed, or a symbol, whose name is
448 echo_add_key (Lisp_Object c
)
450 char initbuf
[KEY_DESCRIPTION_SIZE
+ 100];
451 ptrdiff_t size
= sizeof initbuf
;
452 char *buffer
= initbuf
;
454 Lisp_Object echo_string
= KVAR (current_kboard
, echo_string
);
457 if (STRINGP (echo_string
) && SCHARS (echo_string
) > 0)
458 /* Add a space at the end as a separator between keys. */
461 /* If someone has passed us a composite event, use its head symbol. */
465 ptr
= push_key_description (XINT (c
), ptr
);
466 else if (SYMBOLP (c
))
468 Lisp_Object name
= SYMBOL_NAME (c
);
469 ptrdiff_t nbytes
= SBYTES (name
);
471 if (size
- (ptr
- buffer
) < nbytes
)
473 ptrdiff_t offset
= ptr
- buffer
;
474 size
= max (2 * size
, size
+ nbytes
);
475 buffer
= SAFE_ALLOCA (size
);
476 ptr
= buffer
+ offset
;
479 ptr
+= copy_text (SDATA (name
), (unsigned char *) ptr
, nbytes
,
480 STRING_MULTIBYTE (name
), 1);
483 if ((NILP (echo_string
) || SCHARS (echo_string
) == 0)
486 static const char text
[] = " (Type ? for further options)";
487 int len
= sizeof text
- 1;
489 if (size
- (ptr
- buffer
) < len
)
491 ptrdiff_t offset
= ptr
- buffer
;
493 buffer
= SAFE_ALLOCA (size
);
494 ptr
= buffer
+ offset
;
497 memcpy (ptr
, text
, len
);
503 concat2 (echo_string
, make_string (buffer
, ptr
- buffer
)));
507 /* Temporarily add a dash to the end of the echo string if it's not
508 empty, so that it serves as a mini-prompt for the very next
514 /* Do nothing if not echoing at all. */
515 if (NILP (KVAR (current_kboard
, echo_string
)))
518 if (!current_kboard
->immediate_echo
519 && SCHARS (KVAR (current_kboard
, echo_string
)) == 0)
522 /* Do nothing if we just printed a prompt. */
523 if (STRINGP (KVAR (current_kboard
, echo_prompt
))
524 && (SCHARS (KVAR (current_kboard
, echo_prompt
))
525 == SCHARS (KVAR (current_kboard
, echo_string
))))
528 /* Do nothing if we have already put a dash at the end. */
529 if (SCHARS (KVAR (current_kboard
, echo_string
)) > 1)
531 Lisp_Object last_char
, prev_char
, idx
;
533 idx
= make_number (SCHARS (KVAR (current_kboard
, echo_string
)) - 2);
534 prev_char
= Faref (KVAR (current_kboard
, echo_string
), idx
);
536 idx
= make_number (SCHARS (KVAR (current_kboard
, echo_string
)) - 1);
537 last_char
= Faref (KVAR (current_kboard
, echo_string
), idx
);
539 if (XINT (last_char
) == '-' && XINT (prev_char
) != ' ')
543 /* Put a dash at the end of the buffer temporarily,
544 but make it go away when the next character is added. */
545 AUTO_STRING (dash
, "-");
546 kset_echo_string (current_kboard
,
547 concat2 (KVAR (current_kboard
, echo_string
), dash
));
554 if (current_kboard
->immediate_echo
)
557 Lisp_Object prompt
= KVAR (current_kboard
, echo_prompt
);
558 Lisp_Object prefix
= call0 (Qinternal_echo_keystrokes_prefix
);
559 kset_echo_string (current_kboard
,
560 NILP (prompt
) ? prefix
561 : NILP (prefix
) ? prompt
562 : concat2 (prompt
, prefix
));
564 for (i
= 0; i
< this_command_key_count
; i
++)
568 c
= AREF (this_command_keys
, i
);
569 if (! (EVENT_HAS_PARAMETERS (c
)
570 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
578 /* Display the current echo string, and begin echoing if not already
584 if (!current_kboard
->immediate_echo
585 /* This test breaks calls that use `echo_now' to display the echo_prompt.
586 && echo_keystrokes_p () */)
588 current_kboard
->immediate_echo
= true;
590 /* Put a dash at the end to invite the user to type more. */
595 /* FIXME: Use call (Qmessage) so it can be advised (e.g. emacspeak). */
596 message3_nolog (KVAR (current_kboard
, echo_string
));
599 /* Record in what buffer we echoed, and from which kboard. */
600 echo_message_buffer
= echo_area_buffer
[0];
601 echo_kboard
= current_kboard
;
603 if (waiting_for_input
&& !NILP (Vquit_flag
))
604 quit_throw_to_read_char (0);
607 /* Turn off echoing, for the start of a new command. */
610 cancel_echoing (void)
612 current_kboard
->immediate_echo
= false;
613 kset_echo_prompt (current_kboard
, Qnil
);
614 kset_echo_string (current_kboard
, Qnil
);
615 ok_to_echo_at_next_pause
= NULL
;
617 echo_message_buffer
= Qnil
;
620 /* Return the length of the current echo string. */
625 return (STRINGP (KVAR (current_kboard
, echo_string
))
626 ? SCHARS (KVAR (current_kboard
, echo_string
))
630 /* Truncate the current echo message to its first LEN chars.
631 This and echo_char get used by read_key_sequence when the user
632 switches frames while entering a key sequence. */
635 echo_truncate (ptrdiff_t nchars
)
637 if (STRINGP (KVAR (current_kboard
, echo_string
)))
638 kset_echo_string (current_kboard
,
639 Fsubstring (KVAR (current_kboard
, echo_string
),
640 make_number (0), make_number (nchars
)));
641 truncate_echo_area (nchars
);
645 /* Functions for manipulating this_command_keys. */
647 add_command_key (Lisp_Object key
)
649 if (this_command_key_count
>= ASIZE (this_command_keys
))
650 this_command_keys
= larger_vector (this_command_keys
, 1, -1);
652 ASET (this_command_keys
, this_command_key_count
, key
);
653 ++this_command_key_count
;
658 recursive_edit_1 (void)
660 ptrdiff_t count
= SPECPDL_INDEX ();
663 if (command_loop_level
> 0)
665 specbind (Qstandard_output
, Qt
);
666 specbind (Qstandard_input
, Qt
);
669 #ifdef HAVE_WINDOW_SYSTEM
670 /* The command loop has started an hourglass timer, so we have to
671 cancel it here, otherwise it will fire because the recursive edit
672 can take some time. Do not check for display_hourglass_p here,
673 because it could already be nil. */
677 /* This function may have been called from a debugger called from
678 within redisplay, for instance by Edebugging a function called
679 from fontification-functions. We want to allow redisplay in
680 the debugging session.
682 The recursive edit is left with a `(throw exit ...)'. The `exit'
683 tag is not caught anywhere in redisplay, i.e. when we leave the
684 recursive edit, the original redisplay leading to the recursive
685 edit will be unwound. The outcome should therefore be safe. */
686 specbind (Qinhibit_redisplay
, Qnil
);
689 /* This variable stores buffers that have changed so that an undo
690 boundary can be added. specbind this so that changes in the
691 recursive edit will not result in undo boundaries in buffers
692 changed before we entered there recursive edit.
695 specbind (Qundo_auto__undoably_changed_buffers
, Qnil
);
697 val
= command_loop ();
700 /* Handle throw from read_minibuf when using minibuffer
701 while it's active but we're in another window. */
703 xsignal1 (Qerror
, val
);
705 return unbind_to (count
, Qnil
);
708 /* When an auto-save happens, record the "time", and don't do again soon. */
711 record_auto_save (void)
713 last_auto_save
= num_nonmacro_input_events
;
716 /* Make an auto save happen as soon as possible at command level. */
720 force_auto_save_soon (void)
722 last_auto_save
= - auto_save_interval
- 1;
724 record_asynch_buffer_change ();
728 DEFUN ("recursive-edit", Frecursive_edit
, Srecursive_edit
, 0, 0, "",
729 doc
: /* Invoke the editor command loop recursively.
730 To get out of the recursive edit, a command can throw to `exit' -- for
731 instance (throw \\='exit nil).
732 If you throw a value other than t, `recursive-edit' returns normally
733 to the function that called it. Throwing a t value causes
734 `recursive-edit' to quit, so that control returns to the command loop
737 This function is called by the editor initialization to begin editing. */)
740 ptrdiff_t count
= SPECPDL_INDEX ();
743 /* If we enter while input is blocked, don't lock up here.
744 This may happen through the debugger during redisplay. */
745 if (input_blocked_p ())
748 if (command_loop_level
>= 0
749 && current_buffer
!= XBUFFER (XWINDOW (selected_window
)->contents
))
750 buffer
= Fcurrent_buffer ();
754 /* Don't do anything interesting between the increment and the
755 record_unwind_protect! Otherwise, we could get distracted and
756 never decrement the counter again. */
757 command_loop_level
++;
758 update_mode_lines
= 17;
759 record_unwind_protect (recursive_edit_unwind
, buffer
);
761 /* If we leave recursive_edit_1 below with a `throw' for instance,
762 like it is done in the splash screen display, we have to
763 make sure that we restore single_kboard as command_loop_1
764 would have done if it were left normally. */
765 if (command_loop_level
> 0)
766 temporarily_switch_to_single_kboard (SELECTED_FRAME ());
769 return unbind_to (count
, Qnil
);
773 recursive_edit_unwind (Lisp_Object buffer
)
775 if (BUFFERP (buffer
))
776 Fset_buffer (buffer
);
778 command_loop_level
--;
779 update_mode_lines
= 18;
783 #if 0 /* These two functions are now replaced with
784 temporarily_switch_to_single_kboard. */
788 #if 0 /* Theory: if there's anything in Vunread_command_events,
789 it will right away be read by read_key_sequence,
790 and then if we do switch KBOARDS, it will go into the side
791 queue then. So we don't need to do anything special here -- rms. */
792 if (CONSP (Vunread_command_events
))
794 current_kboard
->kbd_queue
795 = nconc2 (Vunread_command_events
, current_kboard
->kbd_queue
);
796 current_kboard
->kbd_queue_has_data
= true;
798 Vunread_command_events
= Qnil
;
800 single_kboard
= false;
803 /* Switch to the single-kboard state, making current_kboard
804 the only KBOARD from which further input is accepted. */
807 single_kboard_state ()
809 single_kboard
= true;
813 /* If we're in single_kboard state for kboard KBOARD,
817 not_single_kboard_state (KBOARD
*kboard
)
819 if (kboard
== current_kboard
)
820 single_kboard
= false;
823 /* Maintain a stack of kboards, so other parts of Emacs
824 can switch temporarily to the kboard of a given frame
825 and then revert to the previous status. */
830 struct kboard_stack
*next
;
833 static struct kboard_stack
*kboard_stack
;
836 push_kboard (struct kboard
*k
)
838 struct kboard_stack
*p
= xmalloc (sizeof *p
);
840 p
->next
= kboard_stack
;
841 p
->kboard
= current_kboard
;
851 struct kboard_stack
*p
= kboard_stack
;
853 for (t
= terminal_list
; t
; t
= t
->next_terminal
)
855 if (t
->kboard
== p
->kboard
)
857 current_kboard
= p
->kboard
;
864 /* The terminal we remembered has been deleted. */
865 current_kboard
= FRAME_KBOARD (SELECTED_FRAME ());
866 single_kboard
= false;
868 kboard_stack
= p
->next
;
872 /* Switch to single_kboard mode, making current_kboard the only KBOARD
873 from which further input is accepted. If F is non-nil, set its
874 KBOARD as the current keyboard.
876 This function uses record_unwind_protect_int to return to the previous
879 If Emacs is already in single_kboard mode, and F's keyboard is
880 locked, then this function will throw an error. */
883 temporarily_switch_to_single_kboard (struct frame
*f
)
885 bool was_locked
= single_kboard
;
888 if (f
!= NULL
&& FRAME_KBOARD (f
) != current_kboard
)
889 /* We can not switch keyboards while in single_kboard mode.
890 In rare cases, Lisp code may call `recursive-edit' (or
891 `read-minibuffer' or `y-or-n-p') after it switched to a
892 locked frame. For example, this is likely to happen
893 when server.el connects to a new terminal while Emacs is in
894 single_kboard mode. It is best to throw an error instead
895 of presenting the user with a frozen screen. */
896 error ("Terminal %d is locked, cannot read from it",
897 FRAME_TERMINAL (f
)->id
);
899 /* This call is unnecessary, but helps
900 `restore_kboard_configuration' discover if somebody changed
901 `current_kboard' behind our back. */
902 push_kboard (current_kboard
);
905 current_kboard
= FRAME_KBOARD (f
);
906 single_kboard
= true;
907 record_unwind_protect_int (restore_kboard_configuration
, was_locked
);
910 #if 0 /* This function is not needed anymore. */
912 record_single_kboard_state ()
915 push_kboard (current_kboard
);
916 record_unwind_protect_int (restore_kboard_configuration
, single_kboard
);
921 restore_kboard_configuration (int was_locked
)
923 single_kboard
= was_locked
;
926 struct kboard
*prev
= current_kboard
;
928 /* The pop should not change the kboard. */
929 if (single_kboard
&& current_kboard
!= prev
)
935 /* Handle errors that are not handled at inner levels
936 by printing an error message and returning to the editor command loop. */
939 cmd_error (Lisp_Object data
)
941 Lisp_Object old_level
, old_length
;
942 char macroerror
[sizeof "After..kbd macro iterations: "
943 + INT_STRLEN_BOUND (EMACS_INT
)];
945 #ifdef HAVE_WINDOW_SYSTEM
946 if (display_hourglass_p
)
950 if (!NILP (executing_kbd_macro
))
952 if (executing_kbd_macro_iterations
== 1)
953 sprintf (macroerror
, "After 1 kbd macro iteration: ");
955 sprintf (macroerror
, "After %"pI
"d kbd macro iterations: ",
956 executing_kbd_macro_iterations
);
961 Vstandard_output
= Qt
;
962 Vstandard_input
= Qt
;
963 Vexecuting_kbd_macro
= Qnil
;
964 executing_kbd_macro
= Qnil
;
965 kset_prefix_arg (current_kboard
, Qnil
);
966 kset_last_prefix_arg (current_kboard
, Qnil
);
969 /* Avoid unquittable loop if data contains a circular list. */
970 old_level
= Vprint_level
;
971 old_length
= Vprint_length
;
972 XSETFASTINT (Vprint_level
, 10);
973 XSETFASTINT (Vprint_length
, 10);
974 cmd_error_internal (data
, macroerror
);
975 Vprint_level
= old_level
;
976 Vprint_length
= old_length
;
979 Vinhibit_quit
= Qnil
;
981 return make_number (0);
984 /* Take actions on handling an error. DATA is the data that describes
987 CONTEXT is a C-string containing ASCII characters only which
988 describes the context in which the error happened. If we need to
989 generalize CONTEXT to allow multibyte characters, make it a Lisp
993 cmd_error_internal (Lisp_Object data
, const char *context
)
995 /* The immediate context is not interesting for Quits,
996 since they are asynchronous. */
997 if (EQ (XCAR (data
), Qquit
))
998 Vsignaling_function
= Qnil
;
1003 /* Use user's specified output function if any. */
1004 if (!NILP (Vcommand_error_function
))
1005 call3 (Vcommand_error_function
, data
,
1006 context
? build_string (context
) : empty_unibyte_string
,
1007 Vsignaling_function
);
1009 Vsignaling_function
= Qnil
;
1012 DEFUN ("command-error-default-function", Fcommand_error_default_function
,
1013 Scommand_error_default_function
, 3, 3, 0,
1014 doc
: /* Produce default output for unhandled error message.
1015 Default value of `command-error-function'. */)
1016 (Lisp_Object data
, Lisp_Object context
, Lisp_Object signal
)
1018 struct frame
*sf
= SELECTED_FRAME ();
1020 CHECK_STRING (context
);
1022 /* If the window system or terminal frame hasn't been initialized
1023 yet, or we're not interactive, write the message to stderr and exit. */
1024 if (!sf
->glyphs_initialized_p
1025 /* The initial frame is a special non-displaying frame. It
1026 will be current in daemon mode when there are no frames
1027 to display, and in non-daemon mode before the real frame
1028 has finished initializing. If an error is thrown in the
1029 latter case while creating the frame, then the frame
1030 will never be displayed, so the safest thing to do is
1031 write to stderr and quit. In daemon mode, there are
1032 many other potential errors that do not prevent frames
1033 from being created, so continuing as normal is better in
1035 || (!IS_DAEMON
&& FRAME_INITIAL_P (sf
))
1038 print_error_message (data
, Qexternal_debugging_output
,
1039 SSDATA (context
), signal
);
1040 Fterpri (Qexternal_debugging_output
, Qnil
);
1041 Fkill_emacs (make_number (-1));
1045 clear_message (1, 0);
1047 message_log_maybe_newline ();
1050 print_error_message (data
, Qt
, SSDATA (context
), signal
);
1055 static Lisp_Object
command_loop_2 (Lisp_Object
);
1056 static Lisp_Object
top_level_1 (Lisp_Object
);
1058 /* Entry to editor-command-loop.
1059 This level has the catches for exiting/returning to editor command loop.
1060 It returns nil to exit recursive edit, t to abort it. */
1065 #ifdef HAVE_STACK_OVERFLOW_HANDLING
1066 /* At least on GNU/Linux, saving signal mask is important here. */
1067 if (sigsetjmp (return_to_command_loop
, 1) != 0)
1069 /* Comes here from handle_sigsegv (see sysdep.c) and
1070 stack_overflow_handler (see w32fns.c). */
1072 w32_reset_stack_overflow_guard ();
1075 Vinternal__top_level_message
= recover_top_level_message
;
1078 Vinternal__top_level_message
= regular_top_level_message
;
1079 #endif /* HAVE_STACK_OVERFLOW_HANDLING */
1080 if (command_loop_level
> 0 || minibuf_level
> 0)
1083 val
= internal_catch (Qexit
, command_loop_2
, Qnil
);
1084 executing_kbd_macro
= Qnil
;
1090 internal_catch (Qtop_level
, top_level_1
, Qnil
);
1091 internal_catch (Qtop_level
, command_loop_2
, Qnil
);
1092 executing_kbd_macro
= Qnil
;
1094 /* End of file in -batch run causes exit here. */
1100 /* Here we catch errors in execution of commands within the
1101 editing loop, and reenter the editing loop.
1102 When there is an error, cmd_error runs and returns a non-nil
1103 value to us. A value of nil means that command_loop_1 itself
1104 returned due to end of file (or end of kbd macro). */
1107 command_loop_2 (Lisp_Object ignore
)
1109 register Lisp_Object val
;
1112 val
= internal_condition_case (command_loop_1
, Qerror
, cmd_error
);
1113 while (!NILP (val
));
1121 return Feval (Vtop_level
, Qnil
);
1125 top_level_1 (Lisp_Object ignore
)
1127 /* On entry to the outer level, run the startup file. */
1128 if (!NILP (Vtop_level
))
1129 internal_condition_case (top_level_2
, Qerror
, cmd_error
);
1130 else if (!NILP (Vpurify_flag
))
1131 message1 ("Bare impure Emacs (standard Lisp code not loaded)");
1133 message1 ("Bare Emacs (standard Lisp code not loaded)");
1137 DEFUN ("top-level", Ftop_level
, Stop_level
, 0, 0, "",
1138 doc
: /* Exit all recursive editing levels.
1139 This also exits all active minibuffers. */
1140 attributes
: noreturn
)
1143 #ifdef HAVE_WINDOW_SYSTEM
1144 if (display_hourglass_p
)
1145 cancel_hourglass ();
1148 /* Unblock input if we enter with input blocked. This may happen if
1149 redisplay traps e.g. during tool-bar update with input blocked. */
1150 totally_unblock_input ();
1152 Fthrow (Qtop_level
, Qnil
);
1155 static _Noreturn
void
1156 user_error (const char *msg
)
1158 xsignal1 (Quser_error
, build_string (msg
));
1161 /* _Noreturn will be added to prototype by make-docfile. */
1162 DEFUN ("exit-recursive-edit", Fexit_recursive_edit
, Sexit_recursive_edit
, 0, 0, "",
1163 doc
: /* Exit from the innermost recursive edit or minibuffer. */
1164 attributes
: noreturn
)
1167 if (command_loop_level
> 0 || minibuf_level
> 0)
1168 Fthrow (Qexit
, Qnil
);
1170 user_error ("No recursive edit is in progress");
1173 /* _Noreturn will be added to prototype by make-docfile. */
1174 DEFUN ("abort-recursive-edit", Fabort_recursive_edit
, Sabort_recursive_edit
, 0, 0, "",
1175 doc
: /* Abort the command that requested this recursive edit or minibuffer input. */
1176 attributes
: noreturn
)
1179 if (command_loop_level
> 0 || minibuf_level
> 0)
1182 user_error ("No recursive edit is in progress");
1185 /* Restore mouse tracking enablement. See Ftrack_mouse for the only use
1186 of this function. */
1189 tracking_off (Lisp_Object old_value
)
1191 do_mouse_tracking
= old_value
;
1192 if (NILP (old_value
))
1194 /* Redisplay may have been preempted because there was input
1195 available, and it assumes it will be called again after the
1196 input has been processed. If the only input available was
1197 the sort that we have just disabled, then we need to call
1199 if (!readable_events (READABLE_EVENTS_DO_TIMERS_NOW
))
1201 redisplay_preserve_echo_area (6);
1202 get_input_pending (READABLE_EVENTS_DO_TIMERS_NOW
);
1207 DEFUN ("internal--track-mouse", Ftrack_mouse
, Strack_mouse
, 1, 1, 0,
1208 doc
: /* Call BODYFUN with mouse movement events enabled. */)
1209 (Lisp_Object bodyfun
)
1211 ptrdiff_t count
= SPECPDL_INDEX ();
1214 record_unwind_protect (tracking_off
, do_mouse_tracking
);
1216 do_mouse_tracking
= Qt
;
1218 val
= call0 (bodyfun
);
1219 return unbind_to (count
, val
);
1222 /* If mouse has moved on some frame, return one of those frames.
1226 If ignore_mouse_drag_p is non-zero, ignore (implicit) mouse movement
1227 after resizing the tool-bar window. */
1229 bool ignore_mouse_drag_p
;
1231 static struct frame
*
1232 some_mouse_moved (void)
1234 Lisp_Object tail
, frame
;
1236 if (ignore_mouse_drag_p
)
1238 /* ignore_mouse_drag_p = 0; */
1242 FOR_EACH_FRAME (tail
, frame
)
1244 if (XFRAME (frame
)->mouse_moved
)
1245 return XFRAME (frame
);
1252 /* This is the actual command reading loop,
1253 sans error-handling encapsulation. */
1255 static int read_key_sequence (Lisp_Object
*, int, Lisp_Object
,
1256 bool, bool, bool, bool);
1257 static void adjust_point_for_property (ptrdiff_t, bool);
1260 command_loop_1 (void)
1262 EMACS_INT prev_modiff
= 0;
1263 struct buffer
*prev_buffer
= NULL
;
1264 bool already_adjusted
= 0;
1266 kset_prefix_arg (current_kboard
, Qnil
);
1267 kset_last_prefix_arg (current_kboard
, Qnil
);
1268 Vdeactivate_mark
= Qnil
;
1269 waiting_for_input
= false;
1272 this_command_key_count
= 0;
1273 this_single_command_key_start
= 0;
1275 if (NILP (Vmemory_full
))
1277 /* Make sure this hook runs after commands that get errors and
1278 throw to top level. */
1279 /* Note that the value cell will never directly contain nil
1280 if the symbol is a local variable. */
1281 if (!NILP (Vpost_command_hook
) && !NILP (Vrun_hooks
))
1282 safe_run_hooks (Qpost_command_hook
);
1284 /* If displaying a message, resize the echo area window to fit
1285 that message's size exactly. */
1286 if (!NILP (echo_area_buffer
[0]))
1287 resize_echo_area_exactly ();
1289 /* If there are warnings waiting, process them. */
1290 if (!NILP (Vdelayed_warnings_list
))
1291 safe_run_hooks (Qdelayed_warnings_hook
);
1293 if (!NILP (Vdeferred_action_list
))
1294 safe_run_hooks (Qdeferred_action_function
);
1297 /* Do this after running Vpost_command_hook, for consistency. */
1298 kset_last_command (current_kboard
, Vthis_command
);
1299 kset_real_last_command (current_kboard
, Vreal_this_command
);
1300 if (!CONSP (last_command_event
))
1301 kset_last_repeatable_command (current_kboard
, Vreal_this_command
);
1306 Lisp_Object keybuf
[30];
1309 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1312 /* Make sure the current window's buffer is selected. */
1313 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->contents
));
1315 /* Display any malloc warning that just came out. Use while because
1316 displaying one warning can cause another. */
1318 while (pending_malloc_warning
)
1319 display_malloc_warning ();
1321 Vdeactivate_mark
= Qnil
;
1323 /* Don't ignore mouse movements for more than a single command
1324 loop. (This flag is set in xdisp.c whenever the tool bar is
1325 resized, because the resize moves text up or down, and would
1326 generate false mouse drag events if we don't ignore them.) */
1327 ignore_mouse_drag_p
= 0;
1329 /* If minibuffer on and echo area in use,
1330 wait a short time and redraw minibuffer. */
1333 && !NILP (echo_area_buffer
[0])
1334 && EQ (minibuf_window
, echo_area_window
)
1335 && NUMBERP (Vminibuffer_message_timeout
))
1337 /* Bind inhibit-quit to t so that C-g gets read in
1338 rather than quitting back to the minibuffer. */
1339 ptrdiff_t count
= SPECPDL_INDEX ();
1340 specbind (Qinhibit_quit
, Qt
);
1342 sit_for (Vminibuffer_message_timeout
, 0, 2);
1344 /* Clear the echo area. */
1346 safe_run_hooks (Qecho_area_clear_hook
);
1348 unbind_to (count
, Qnil
);
1350 /* If a C-g came in before, treat it as input now. */
1351 if (!NILP (Vquit_flag
))
1354 Vunread_command_events
= list1 (make_number (quit_char
));
1358 /* If it has changed current-menubar from previous value,
1359 really recompute the menubar from the value. */
1360 if (! NILP (Vlucid_menu_bar_dirty_flag
)
1361 && !NILP (Ffboundp (Qrecompute_lucid_menubar
)))
1362 call0 (Qrecompute_lucid_menubar
);
1364 Vthis_command
= Qnil
;
1365 Vreal_this_command
= Qnil
;
1366 Vthis_original_command
= Qnil
;
1367 Vthis_command_keys_shift_translated
= Qnil
;
1369 /* Read next key sequence; i gets its length. */
1370 i
= read_key_sequence (keybuf
, ARRAYELTS (keybuf
),
1373 /* A filter may have run while we were reading the input. */
1374 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1376 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->contents
));
1380 /* Now we have read a key sequence of length I,
1381 or else I is 0 and we found end of file. */
1383 if (i
== 0) /* End of file -- happens only in */
1384 return Qnil
; /* a kbd macro, at the end. */
1385 /* -1 means read_key_sequence got a menu that was rejected.
1386 Just loop around and read another command. */
1390 this_command_key_count
= 0;
1391 this_single_command_key_start
= 0;
1395 last_command_event
= keybuf
[i
- 1];
1397 /* If the previous command tried to force a specific window-start,
1398 forget about that, in case this command moves point far away
1399 from that position. But also throw away beg_unchanged and
1400 end_unchanged information in that case, so that redisplay will
1401 update the whole window properly. */
1402 if (XWINDOW (selected_window
)->force_start
)
1405 XWINDOW (selected_window
)->force_start
= 0;
1406 b
= XBUFFER (XWINDOW (selected_window
)->contents
);
1407 BUF_BEG_UNCHANGED (b
) = BUF_END_UNCHANGED (b
) = 0;
1410 cmd
= read_key_sequence_cmd
;
1411 if (!NILP (Vexecuting_kbd_macro
))
1413 if (!NILP (Vquit_flag
))
1415 Vexecuting_kbd_macro
= Qt
;
1416 maybe_quit (); /* Make some noise. */
1417 /* Will return since macro now empty. */
1421 /* Do redisplay processing after this command except in special
1422 cases identified below. */
1423 prev_buffer
= current_buffer
;
1424 prev_modiff
= MODIFF
;
1425 last_point_position
= PT
;
1427 /* By default, we adjust point to a boundary of a region that
1428 has such a property that should be treated intangible
1429 (e.g. composition, display). But, some commands will set
1430 this variable differently. */
1431 Vdisable_point_adjustment
= Qnil
;
1433 /* Process filters and timers may have messed with deactivate-mark.
1434 reset it before we execute the command. */
1435 Vdeactivate_mark
= Qnil
;
1437 /* Remap command through active keymaps. */
1438 Vthis_original_command
= cmd
;
1439 if (!NILP (read_key_sequence_remapped
))
1440 cmd
= read_key_sequence_remapped
;
1442 /* Execute the command. */
1445 total_keys
+= total_keys
< NUM_RECENT_KEYS
;
1446 ASET (recent_keys
, recent_keys_index
,
1448 if (++recent_keys_index
>= NUM_RECENT_KEYS
)
1449 recent_keys_index
= 0;
1451 Vthis_command
= cmd
;
1452 Vreal_this_command
= cmd
;
1453 safe_run_hooks (Qpre_command_hook
);
1455 already_adjusted
= 0;
1457 if (NILP (Vthis_command
))
1458 /* nil means key is undefined. */
1462 /* Here for a command that isn't executed directly. */
1464 #ifdef HAVE_WINDOW_SYSTEM
1465 ptrdiff_t scount
= SPECPDL_INDEX ();
1467 if (display_hourglass_p
1468 && NILP (Vexecuting_kbd_macro
))
1470 record_unwind_protect_void (cancel_hourglass
);
1475 /* Ensure that we have added appropriate undo-boundaries as a
1476 result of changes from the last command. */
1477 call0 (Qundo_auto__add_boundary
);
1479 /* Record point and buffer, so we can put point into the undo
1480 information if necessary. */
1481 point_before_last_command_or_undo
= PT
;
1482 buffer_before_last_command_or_undo
= current_buffer
;
1484 call1 (Qcommand_execute
, Vthis_command
);
1486 #ifdef HAVE_WINDOW_SYSTEM
1487 /* Do not check display_hourglass_p here, because
1488 `command-execute' could change it, but we should cancel
1489 hourglass cursor anyway.
1490 But don't cancel the hourglass within a macro
1491 just because a command in the macro finishes. */
1492 if (NILP (Vexecuting_kbd_macro
))
1493 unbind_to (scount
, Qnil
);
1496 kset_last_prefix_arg (current_kboard
, Vcurrent_prefix_arg
);
1498 safe_run_hooks (Qpost_command_hook
);
1500 /* If displaying a message, resize the echo area window to fit
1501 that message's size exactly. */
1502 if (!NILP (echo_area_buffer
[0]))
1503 resize_echo_area_exactly ();
1505 /* If there are warnings waiting, process them. */
1506 if (!NILP (Vdelayed_warnings_list
))
1507 safe_run_hooks (Qdelayed_warnings_hook
);
1509 safe_run_hooks (Qdeferred_action_function
);
1511 kset_last_command (current_kboard
, Vthis_command
);
1512 kset_real_last_command (current_kboard
, Vreal_this_command
);
1513 if (!CONSP (last_command_event
))
1514 kset_last_repeatable_command (current_kboard
, Vreal_this_command
);
1516 this_command_key_count
= 0;
1517 this_single_command_key_start
= 0;
1519 if (current_kboard
->immediate_echo
1520 && !NILP (call0 (Qinternal_echo_keystrokes_prefix
)))
1522 current_kboard
->immediate_echo
= false;
1523 /* Refresh the echo message. */
1529 if (!NILP (BVAR (current_buffer
, mark_active
))
1530 && !NILP (Vrun_hooks
))
1532 /* In Emacs 22, setting transient-mark-mode to `only' was a
1533 way of turning it on for just one command. This usage is
1534 obsolete, but support it anyway. */
1535 if (EQ (Vtransient_mark_mode
, Qidentity
))
1536 Vtransient_mark_mode
= Qnil
;
1537 else if (EQ (Vtransient_mark_mode
, Qonly
))
1538 Vtransient_mark_mode
= Qidentity
;
1540 if (!NILP (Vdeactivate_mark
))
1541 /* If `select-active-regions' is non-nil, this call to
1542 `deactivate-mark' also sets the PRIMARY selection. */
1543 call0 (Qdeactivate_mark
);
1546 /* Even if not deactivating the mark, set PRIMARY if
1547 `select-active-regions' is non-nil. */
1548 if (!NILP (Fwindow_system (Qnil
))
1549 /* Even if mark_active is non-nil, the actual buffer
1550 marker may not have been set yet (Bug#7044). */
1551 && XMARKER (BVAR (current_buffer
, mark
))->buffer
1552 && (EQ (Vselect_active_regions
, Qonly
)
1553 ? EQ (CAR_SAFE (Vtransient_mark_mode
), Qonly
)
1554 : (!NILP (Vselect_active_regions
)
1555 && !NILP (Vtransient_mark_mode
)))
1556 && NILP (Fmemq (Vthis_command
,
1557 Vselection_inhibit_update_commands
)))
1560 = call1 (Fsymbol_value (Qregion_extract_function
), Qnil
);
1561 if (XINT (Flength (txt
)) > 0)
1562 /* Don't set empty selections. */
1563 call2 (Qgui_set_selection
, QPRIMARY
, txt
);
1566 if (current_buffer
!= prev_buffer
|| MODIFF
!= prev_modiff
)
1567 run_hook (intern ("activate-mark-hook"));
1570 Vsaved_region_selection
= Qnil
;
1575 if (current_buffer
== prev_buffer
1576 && XBUFFER (XWINDOW (selected_window
)->contents
) == current_buffer
1577 && last_point_position
!= PT
1578 && NILP (Vdisable_point_adjustment
)
1579 && NILP (Vglobal_disable_point_adjustment
))
1581 if (last_point_position
> BEGV
1582 && last_point_position
< ZV
1583 && (composition_adjust_point (last_point_position
,
1584 last_point_position
)
1585 != last_point_position
))
1586 /* The last point was temporarily set within a grapheme
1587 cluster to prevent automatic composition. To recover
1588 the automatic composition, we must update the
1590 windows_or_buffers_changed
= 21;
1591 if (!already_adjusted
)
1592 adjust_point_for_property (last_point_position
,
1593 MODIFF
!= prev_modiff
);
1596 /* Install chars successfully executed in kbd macro. */
1598 if (!NILP (KVAR (current_kboard
, defining_kbd_macro
))
1599 && NILP (KVAR (current_kboard
, Vprefix_arg
)))
1600 finalize_kbd_macro_chars ();
1605 read_menu_command (void)
1607 Lisp_Object keybuf
[30];
1608 ptrdiff_t count
= SPECPDL_INDEX ();
1611 /* We don't want to echo the keystrokes while navigating the
1613 specbind (Qecho_keystrokes
, make_number (0));
1615 i
= read_key_sequence (keybuf
, ARRAYELTS (keybuf
),
1618 unbind_to (count
, Qnil
);
1620 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1622 if (i
== 0 || i
== -1)
1625 return read_key_sequence_cmd
;
1628 /* Adjust point to a boundary of a region that has such a property
1629 that should be treated intangible. For the moment, we check
1630 `composition', `display' and `invisible' properties.
1631 LAST_PT is the last position of point. */
1634 adjust_point_for_property (ptrdiff_t last_pt
, bool modified
)
1637 Lisp_Object val
, overlay
, tmp
;
1638 /* When called after buffer modification, we should temporarily
1639 suppress the point adjustment for automatic composition so that a
1640 user can keep inserting another character at point or keep
1641 deleting characters around point. */
1642 bool check_composition
= ! modified
;
1643 bool check_display
= true, check_invisible
= true;
1644 ptrdiff_t orig_pt
= PT
;
1646 eassert (XBUFFER (XWINDOW (selected_window
)->contents
) == current_buffer
);
1648 /* FIXME: cycling is probably not necessary because these properties
1649 can't be usefully combined anyway. */
1650 while (check_composition
|| check_display
|| check_invisible
)
1652 /* FIXME: check `intangible'. */
1653 if (check_composition
1654 && PT
> BEGV
&& PT
< ZV
1655 && (beg
= composition_adjust_point (last_pt
, PT
)) != PT
)
1658 check_display
= check_invisible
= true;
1660 check_composition
= false;
1662 && PT
> BEGV
&& PT
< ZV
1663 && !NILP (val
= get_char_property_and_overlay
1664 (make_number (PT
), Qdisplay
, selected_window
,
1666 && display_prop_intangible_p (val
, overlay
, PT
, PT_BYTE
)
1667 && (!OVERLAYP (overlay
)
1668 ? get_property_and_range (PT
, Qdisplay
, &val
, &beg
, &end
, Qnil
)
1669 : (beg
= OVERLAY_POSITION (OVERLAY_START (overlay
)),
1670 end
= OVERLAY_POSITION (OVERLAY_END (overlay
))))
1671 && (beg
< PT
/* && end > PT <- It's always the case. */
1672 || (beg
<= PT
&& STRINGP (val
) && SCHARS (val
) == 0)))
1675 SET_PT (PT
< last_pt
1676 ? (STRINGP (val
) && SCHARS (val
) == 0
1677 ? max (beg
- 1, BEGV
)
1680 check_composition
= check_invisible
= true;
1682 check_display
= false;
1683 if (check_invisible
&& PT
> BEGV
&& PT
< ZV
)
1686 bool ellipsis
= false;
1689 /* Find boundaries `beg' and `end' of the invisible area, if any. */
1692 /* FIXME: We should stop if we find a spot between
1693 two runs of `invisible' where inserted text would
1694 be visible. This is important when we have two
1695 invisible boundaries that enclose an area: if the
1696 area is empty, we need this test in order to make
1697 it possible to place point in the middle rather
1698 than skip both boundaries. However, this code
1699 also stops anywhere in a non-sticky text-property,
1700 which breaks (e.g.) Org mode. */
1701 && (val
= Fget_pos_property (make_number (end
),
1703 TEXT_PROP_MEANS_INVISIBLE (val
))
1705 && !NILP (val
= get_char_property_and_overlay
1706 (make_number (end
), Qinvisible
, Qnil
, &overlay
))
1707 && (inv
= TEXT_PROP_MEANS_INVISIBLE (val
)))
1709 ellipsis
= ellipsis
|| inv
> 1
1710 || (OVERLAYP (overlay
)
1711 && (!NILP (Foverlay_get (overlay
, Qafter_string
))
1712 || !NILP (Foverlay_get (overlay
, Qbefore_string
))));
1713 tmp
= Fnext_single_char_property_change
1714 (make_number (end
), Qinvisible
, Qnil
, Qnil
);
1715 end
= NATNUMP (tmp
) ? XFASTINT (tmp
) : ZV
;
1719 && (val
= Fget_pos_property (make_number (beg
),
1721 TEXT_PROP_MEANS_INVISIBLE (val
))
1723 && !NILP (val
= get_char_property_and_overlay
1724 (make_number (beg
- 1), Qinvisible
, Qnil
, &overlay
))
1725 && (inv
= TEXT_PROP_MEANS_INVISIBLE (val
)))
1727 ellipsis
= ellipsis
|| inv
> 1
1728 || (OVERLAYP (overlay
)
1729 && (!NILP (Foverlay_get (overlay
, Qafter_string
))
1730 || !NILP (Foverlay_get (overlay
, Qbefore_string
))));
1731 tmp
= Fprevious_single_char_property_change
1732 (make_number (beg
), Qinvisible
, Qnil
, Qnil
);
1733 beg
= NATNUMP (tmp
) ? XFASTINT (tmp
) : BEGV
;
1736 /* Move away from the inside area. */
1737 if (beg
< PT
&& end
> PT
)
1739 SET_PT ((orig_pt
== PT
&& (last_pt
< beg
|| last_pt
> end
))
1740 /* We haven't moved yet (so we don't need to fear
1741 infinite-looping) and we were outside the range
1742 before (so either end of the range still corresponds
1743 to a move in the right direction): pretend we moved
1744 less than we actually did, so that we still have
1745 more freedom below in choosing which end of the range
1747 ? (orig_pt
= -1, PT
< last_pt
? end
: beg
)
1748 /* We either have moved already or the last point
1749 was already in the range: we don't get to choose
1750 which end of the range we have to go to. */
1751 : (PT
< last_pt
? beg
: end
));
1752 check_composition
= check_display
= true;
1754 #if 0 /* This assertion isn't correct, because SET_PT may end up setting
1755 the point to something other than its argument, due to
1756 point-motion hooks, intangibility, etc. */
1757 eassert (PT
== beg
|| PT
== end
);
1760 /* Pretend the area doesn't exist if the buffer is not
1762 if (!modified
&& !ellipsis
&& beg
< end
)
1764 if (last_pt
== beg
&& PT
== end
&& end
< ZV
)
1765 (check_composition
= check_display
= true, SET_PT (end
+ 1));
1766 else if (last_pt
== end
&& PT
== beg
&& beg
> BEGV
)
1767 (check_composition
= check_display
= true, SET_PT (beg
- 1));
1768 else if (PT
== ((PT
< last_pt
) ? beg
: end
))
1769 /* We've already moved as far as we can. Trying to go
1770 to the other end would mean moving backwards and thus
1771 could lead to an infinite loop. */
1773 else if (val
= Fget_pos_property (make_number (PT
),
1775 TEXT_PROP_MEANS_INVISIBLE (val
)
1776 && (val
= (Fget_pos_property
1777 (make_number (PT
== beg
? end
: beg
),
1779 !TEXT_PROP_MEANS_INVISIBLE (val
)))
1780 (check_composition
= check_display
= true,
1781 SET_PT (PT
== beg
? end
: beg
));
1784 check_invisible
= false;
1788 /* Subroutine for safe_run_hooks: run the hook, which is ARGS[1]. */
1791 safe_run_hooks_1 (ptrdiff_t nargs
, Lisp_Object
*args
)
1793 eassert (nargs
== 2);
1794 return call0 (args
[1]);
1797 /* Subroutine for safe_run_hooks: handle an error by clearing out the function
1801 safe_run_hooks_error (Lisp_Object error
, ptrdiff_t nargs
, Lisp_Object
*args
)
1803 eassert (nargs
== 2);
1804 AUTO_STRING (format
, "Error in %s (%S): %S");
1805 Lisp_Object hook
= args
[0];
1806 Lisp_Object fun
= args
[1];
1807 CALLN (Fmessage
, format
, hook
, fun
, error
);
1813 Lisp_Object newval
= Qnil
;
1814 for (val
= find_symbol_value (hook
); CONSP (val
); val
= XCDR (val
))
1815 if (EQ (fun
, XCAR (val
)))
1818 newval
= Fcons (XCAR (val
), newval
);
1820 return Fset (hook
, Fnreverse (newval
));
1821 /* Not found in the local part of the hook. Let's look at the global
1824 for (val
= (NILP (Fdefault_boundp (hook
)) ? Qnil
1825 : Fdefault_value (hook
));
1826 CONSP (val
); val
= XCDR (val
))
1827 if (EQ (fun
, XCAR (val
)))
1830 newval
= Fcons (XCAR (val
), newval
);
1832 return Fset_default (hook
, Fnreverse (newval
));
1838 safe_run_hook_funcall (ptrdiff_t nargs
, Lisp_Object
*args
)
1840 eassert (nargs
== 2);
1841 /* Yes, run_hook_with_args works with args in the other order. */
1842 internal_condition_case_n (safe_run_hooks_1
,
1843 2, ((Lisp_Object
[]) {args
[1], args
[0]}),
1844 Qt
, safe_run_hooks_error
);
1848 /* If we get an error while running the hook, cause the hook variable
1849 to be nil. Also inhibit quits, so that C-g won't cause the hook
1850 to mysteriously evaporate. */
1853 safe_run_hooks (Lisp_Object hook
)
1855 ptrdiff_t count
= SPECPDL_INDEX ();
1857 specbind (Qinhibit_quit
, Qt
);
1858 run_hook_with_args (2, ((Lisp_Object
[]) {hook
, hook
}), safe_run_hook_funcall
);
1859 unbind_to (count
, Qnil
);
1863 /* Nonzero means polling for input is temporarily suppressed. */
1865 int poll_suppress_count
;
1868 #ifdef POLL_FOR_INPUT
1870 /* Asynchronous timer for polling. */
1872 static struct atimer
*poll_timer
;
1874 /* Poll for input, so that we catch a C-g if it comes in. */
1876 poll_for_input_1 (void)
1878 if (! input_blocked_p ()
1879 && !waiting_for_input
)
1883 /* Timer callback function for poll_timer. TIMER is equal to
1887 poll_for_input (struct atimer
*timer
)
1889 if (poll_suppress_count
== 0)
1890 pending_signals
= true;
1893 #endif /* POLL_FOR_INPUT */
1895 /* Begin signals to poll for input, if they are appropriate.
1896 This function is called unconditionally from various places. */
1899 start_polling (void)
1901 #ifdef POLL_FOR_INPUT
1902 /* XXX This condition was (read_socket_hook && !interrupt_input),
1903 but read_socket_hook is not global anymore. Let's pretend that
1905 if (!interrupt_input
)
1907 /* Turn alarm handling on unconditionally. It might have
1908 been turned off in process.c. */
1909 turn_on_atimers (1);
1911 /* If poll timer doesn't exist, or we need one with
1912 a different interval, start a new one. */
1913 if (poll_timer
== NULL
1914 || poll_timer
->interval
.tv_sec
!= polling_period
)
1916 time_t period
= max (1, min (polling_period
, TYPE_MAXIMUM (time_t)));
1917 struct timespec interval
= make_timespec (period
, 0);
1920 cancel_atimer (poll_timer
);
1922 poll_timer
= start_atimer (ATIMER_CONTINUOUS
, interval
,
1923 poll_for_input
, NULL
);
1926 /* Let the timer's callback function poll for input
1927 if this becomes zero. */
1928 --poll_suppress_count
;
1933 /* True if we are using polling to handle input asynchronously. */
1936 input_polling_used (void)
1938 #ifdef POLL_FOR_INPUT
1939 /* XXX This condition was (read_socket_hook && !interrupt_input),
1940 but read_socket_hook is not global anymore. Let's pretend that
1942 return !interrupt_input
;
1948 /* Turn off polling. */
1953 #ifdef POLL_FOR_INPUT
1954 /* XXX This condition was (read_socket_hook && !interrupt_input),
1955 but read_socket_hook is not global anymore. Let's pretend that
1957 if (!interrupt_input
)
1958 ++poll_suppress_count
;
1962 /* Set the value of poll_suppress_count to COUNT
1963 and start or stop polling accordingly. */
1966 set_poll_suppress_count (int count
)
1968 #ifdef POLL_FOR_INPUT
1969 if (count
== 0 && poll_suppress_count
!= 0)
1971 poll_suppress_count
= 1;
1974 else if (count
!= 0 && poll_suppress_count
== 0)
1978 poll_suppress_count
= count
;
1982 /* Bind polling_period to a value at least N.
1983 But don't decrease it. */
1986 bind_polling_period (int n
)
1988 #ifdef POLL_FOR_INPUT
1989 EMACS_INT
new = polling_period
;
1994 stop_other_atimers (poll_timer
);
1996 specbind (Qpolling_period
, make_number (new));
1997 /* Start a new alarm with the new period. */
2002 /* Apply the control modifier to CHARACTER. */
2005 make_ctrl_char (int c
)
2007 /* Save the upper bits here. */
2008 int upper
= c
& ~0177;
2010 if (! ASCII_CHAR_P (c
))
2011 return c
|= ctrl_modifier
;
2015 /* Everything in the columns containing the upper-case letters
2016 denotes a control character. */
2017 if (c
>= 0100 && c
< 0140)
2021 /* Set the shift modifier for a control char
2022 made from a shifted letter. But only for letters! */
2023 if (oc
>= 'A' && oc
<= 'Z')
2024 c
|= shift_modifier
;
2027 /* The lower-case letters denote control characters too. */
2028 else if (c
>= 'a' && c
<= 'z')
2031 /* Include the bits for control and shift
2032 only if the basic ASCII code can't indicate them. */
2036 /* Replace the high bits. */
2037 c
|= (upper
& ~ctrl_modifier
);
2042 /* Display the help-echo property of the character after the mouse pointer.
2043 Either show it in the echo area, or call show-help-function to display
2044 it by other means (maybe in a tooltip).
2046 If HELP is nil, that means clear the previous help echo.
2048 If HELP is a string, display that string. If HELP is a function,
2049 call it with OBJECT and POS as arguments; the function should
2050 return a help string or nil for none. For all other types of HELP,
2051 evaluate it to obtain a string.
2053 WINDOW is the window in which the help was generated, if any.
2054 It is nil if not in a window.
2056 If OBJECT is a buffer, POS is the position in the buffer where the
2057 `help-echo' text property was found.
2059 If OBJECT is an overlay, that overlay has a `help-echo' property,
2060 and POS is the position in the overlay's buffer under the mouse.
2062 If OBJECT is a string (an overlay string or a string displayed with
2063 the `display' property). POS is the position in that string under
2066 Note: this function may only be called with HELP nil or a string
2067 from X code running asynchronously. */
2070 show_help_echo (Lisp_Object help
, Lisp_Object window
, Lisp_Object object
,
2073 if (!NILP (help
) && !STRINGP (help
))
2075 if (FUNCTIONP (help
))
2076 help
= safe_call (4, help
, window
, object
, pos
);
2078 help
= safe_eval (help
);
2080 if (!STRINGP (help
))
2084 if (!noninteractive
&& STRINGP (help
))
2086 /* The mouse-fixup-help-message Lisp function can call
2087 mouse_position_hook, which resets the mouse_moved flags.
2088 This causes trouble if we are trying to read a mouse motion
2089 event (i.e., if we are inside a `track-mouse' form), so we
2090 restore the mouse_moved flag. */
2091 struct frame
*f
= NILP (do_mouse_tracking
) ? NULL
: some_mouse_moved ();
2092 help
= call1 (Qmouse_fixup_help_message
, help
);
2094 f
->mouse_moved
= true;
2097 if (STRINGP (help
) || NILP (help
))
2099 if (!NILP (Vshow_help_function
))
2100 call1 (Vshow_help_function
, Fsubstitute_command_keys (help
));
2101 help_echo_showing_p
= STRINGP (help
);
2107 /* Input of single characters from keyboard. */
2109 static Lisp_Object
kbd_buffer_get_event (KBOARD
**kbp
, bool *used_mouse_menu
,
2110 struct timespec
*end_time
);
2111 static void record_char (Lisp_Object c
);
2113 static Lisp_Object help_form_saved_window_configs
;
2115 read_char_help_form_unwind (void)
2117 Lisp_Object window_config
= XCAR (help_form_saved_window_configs
);
2118 help_form_saved_window_configs
= XCDR (help_form_saved_window_configs
);
2119 if (!NILP (window_config
))
2120 Fset_window_configuration (window_config
);
2123 #define STOP_POLLING \
2124 do { if (! polling_stopped_here) stop_polling (); \
2125 polling_stopped_here = true; } while (0)
2127 #define RESUME_POLLING \
2128 do { if (polling_stopped_here) start_polling (); \
2129 polling_stopped_here = false; } while (0)
2132 read_event_from_main_queue (struct timespec
*end_time
,
2133 sys_jmp_buf local_getcjmp
,
2134 bool *used_mouse_menu
)
2136 Lisp_Object c
= Qnil
;
2137 sys_jmp_buf save_jump
;
2142 /* Read from the main queue, and if that gives us something we can't use yet,
2143 we put it on the appropriate side queue and try again. */
2145 if (end_time
&& timespec_cmp (*end_time
, current_timespec ()) <= 0)
2148 /* Actually read a character, waiting if necessary. */
2149 save_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 restore_getcjmp (save_jump
);
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);
2572 maybe_reacquire_global_lock ();
2574 unbind_to (jmpcount
, Qnil
);
2575 XSETINT (c
, quit_char
);
2576 internal_last_event_frame
= selected_frame
;
2577 Vlast_event_frame
= internal_last_event_frame
;
2578 /* If we report the quit char as an event,
2579 don't do so more than once. */
2580 if (!NILP (Vinhibit_quit
))
2584 KBOARD
*kb
= FRAME_KBOARD (XFRAME (selected_frame
));
2585 if (kb
!= current_kboard
)
2587 Lisp_Object last
= KVAR (kb
, kbd_queue
);
2588 /* We shouldn't get here if we were in single-kboard mode! */
2593 while (CONSP (XCDR (last
)))
2595 if (!NILP (XCDR (last
)))
2599 kset_kbd_queue (kb
, list1 (c
));
2601 XSETCDR (last
, list1 (c
));
2602 kb
->kbd_queue_has_data
= true;
2603 current_kboard
= kb
;
2604 return make_number (-2); /* wrong_kboard_jmpbuf */
2610 /* Start idle timers if no time limit is supplied. We don't do it
2611 if a time limit is supplied to avoid an infinite recursion in the
2612 situation where an idle timer calls `sit-for'. */
2615 timer_start_idle ();
2617 /* If in middle of key sequence and minibuffer not active,
2618 start echoing if enough time elapses. */
2620 if (minibuf_level
== 0
2622 && !current_kboard
->immediate_echo
2623 && (this_command_key_count
> 0
2624 || !NILP (call0 (Qinternal_echo_keystrokes_prefix
)))
2626 && echo_keystrokes_p ()
2627 && (/* No message. */
2628 NILP (echo_area_buffer
[0])
2629 /* Or empty message. */
2630 || (BUF_BEG (XBUFFER (echo_area_buffer
[0]))
2631 == BUF_Z (XBUFFER (echo_area_buffer
[0])))
2632 /* Or already echoing from same kboard. */
2633 || (echo_kboard
&& ok_to_echo_at_next_pause
== echo_kboard
)
2634 /* Or not echoing before and echoing allowed. */
2635 || (!echo_kboard
&& ok_to_echo_at_next_pause
)))
2637 /* After a mouse event, start echoing right away.
2638 This is because we are probably about to display a menu,
2639 and we don't want to delay before doing so. */
2640 if (EVENT_HAS_PARAMETERS (prev_event
))
2646 save_getcjmp (save_jump
);
2647 restore_getcjmp (local_getcjmp
);
2648 tem0
= sit_for (Vecho_keystrokes
, 1, 1);
2649 restore_getcjmp (save_jump
);
2651 && ! CONSP (Vunread_command_events
))
2656 /* Maybe auto save due to number of keystrokes. */
2658 if (commandflag
!= 0 && commandflag
!= -2
2659 && auto_save_interval
> 0
2660 && num_nonmacro_input_events
- last_auto_save
> max (auto_save_interval
, 20)
2661 && !detect_input_pending_run_timers (0))
2663 Fdo_auto_save (Qnil
, Qnil
);
2664 /* Hooks can actually change some buffers in auto save. */
2668 /* Try reading using an X menu.
2669 This is never confused with reading using the minibuf
2670 because the recursive call of read_char in read_char_minibuf_menu_prompt
2671 does not pass on any keymaps. */
2673 if (KEYMAPP (map
) && INTERACTIVE
2674 && !NILP (prev_event
)
2675 && EVENT_HAS_PARAMETERS (prev_event
)
2676 && !EQ (XCAR (prev_event
), Qmenu_bar
)
2677 && !EQ (XCAR (prev_event
), Qtool_bar
)
2678 /* Don't bring up a menu if we already have another event. */
2679 && !CONSP (Vunread_command_events
))
2681 c
= read_char_x_menu_prompt (map
, prev_event
, used_mouse_menu
);
2683 /* Now that we have read an event, Emacs is not idle. */
2690 /* Maybe autosave and/or garbage collect due to idleness. */
2692 if (INTERACTIVE
&& NILP (c
))
2695 ptrdiff_t buffer_size
;
2697 /* Slow down auto saves logarithmically in size of current buffer,
2698 and garbage collect while we're at it. */
2699 if (! MINI_WINDOW_P (XWINDOW (selected_window
)))
2700 last_non_minibuf_size
= Z
- BEG
;
2701 buffer_size
= (last_non_minibuf_size
>> 8) + 1;
2703 while (buffer_size
> 64)
2704 delay_level
++, buffer_size
-= buffer_size
>> 2;
2705 if (delay_level
< 4) delay_level
= 4;
2706 /* delay_level is 4 for files under around 50k, 7 at 100k,
2707 9 at 200k, 11 at 300k, and 12 at 500k. It is 15 at 1 meg. */
2709 /* Auto save if enough time goes by without input. */
2710 if (commandflag
!= 0 && commandflag
!= -2
2711 && num_nonmacro_input_events
> last_auto_save
2712 && INTEGERP (Vauto_save_timeout
)
2713 && XINT (Vauto_save_timeout
) > 0)
2716 EMACS_INT timeout
= XFASTINT (Vauto_save_timeout
);
2718 timeout
= min (timeout
, MOST_POSITIVE_FIXNUM
/ delay_level
* 4);
2719 timeout
= delay_level
* timeout
/ 4;
2720 save_getcjmp (save_jump
);
2721 restore_getcjmp (local_getcjmp
);
2722 tem0
= sit_for (make_number (timeout
), 1, 1);
2723 restore_getcjmp (save_jump
);
2726 && ! CONSP (Vunread_command_events
))
2728 Fdo_auto_save (Qnil
, Qnil
);
2733 /* If there is still no input available, ask for GC. */
2734 if (!detect_input_pending_run_timers (0))
2738 /* Notify the caller if an autosave hook, or a timer, sentinel or
2739 filter in the sit_for calls above have changed the current
2740 kboard. This could happen if they use the minibuffer or start a
2741 recursive edit, like the fancy splash screen in server.el's
2742 filter. If this longjmp wasn't here, read_key_sequence would
2743 interpret the next key sequence using the wrong translation
2744 tables and function keymaps. */
2745 if (NILP (c
) && current_kboard
!= orig_kboard
)
2746 return make_number (-2); /* wrong_kboard_jmpbuf */
2748 /* If this has become non-nil here, it has been set by a timer
2749 or sentinel or filter. */
2750 if (CONSP (Vunread_command_events
))
2752 c
= XCAR (Vunread_command_events
);
2753 Vunread_command_events
= XCDR (Vunread_command_events
);
2755 if (CONSP (c
) && EQ (XCAR (c
), Qt
))
2761 /* Read something from current KBOARD's side queue, if possible. */
2765 if (current_kboard
->kbd_queue_has_data
)
2767 if (!CONSP (KVAR (current_kboard
, kbd_queue
)))
2769 c
= XCAR (KVAR (current_kboard
, kbd_queue
));
2770 kset_kbd_queue (current_kboard
,
2771 XCDR (KVAR (current_kboard
, kbd_queue
)));
2772 if (NILP (KVAR (current_kboard
, kbd_queue
)))
2773 current_kboard
->kbd_queue_has_data
= false;
2774 input_pending
= readable_events (0);
2775 if (EVENT_HAS_PARAMETERS (c
)
2776 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qswitch_frame
))
2777 internal_last_event_frame
= XCAR (XCDR (c
));
2778 Vlast_event_frame
= internal_last_event_frame
;
2782 /* If current_kboard's side queue is empty check the other kboards.
2783 If one of them has data that we have not yet seen here,
2784 switch to it and process the data waiting for it.
2786 Note: if the events queued up for another kboard
2787 have already been seen here, and therefore are not a complete command,
2788 the kbd_queue_has_data field is 0, so we skip that kboard here.
2789 That's to avoid an infinite loop switching between kboards here. */
2790 if (NILP (c
) && !single_kboard
)
2793 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
2794 if (kb
->kbd_queue_has_data
)
2796 current_kboard
= kb
;
2797 return make_number (-2); /* wrong_kboard_jmpbuf */
2807 c
= read_decoded_event_from_main_queue (end_time
, local_getcjmp
,
2808 prev_event
, used_mouse_menu
);
2809 if (NILP (c
) && end_time
2810 && timespec_cmp (*end_time
, current_timespec ()) <= 0)
2815 if (EQ (c
, make_number (-2)))
2827 if (commandflag
>= 0
2828 && !input_pending
&& !detect_input_pending_run_timers (0))
2834 /* Buffer switch events are only for internal wakeups
2835 so don't show them to the user.
2836 Also, don't record a key if we already did. */
2840 /* Process special events within read_char
2841 and loop around to read another event. */
2844 tem
= access_keymap (get_keymap (Vspecial_event_map
, 0, 1), c
, 0, 0, 1);
2849 struct buffer
*prev_buffer
= current_buffer
;
2850 last_input_event
= c
;
2851 call4 (Qcommand_execute
, tem
, Qnil
, Fvector (1, &last_input_event
), Qt
);
2854 && (EQ (XCAR (c
), Qselect_window
)
2856 || EQ (XCAR (c
), Qdbus_event
)
2858 #ifdef USE_FILE_NOTIFY
2859 || EQ (XCAR (c
), Qfile_notify
)
2861 || EQ (XCAR (c
), Qconfig_changed_event
))
2863 /* We stopped being idle for this event; undo that. This
2864 prevents automatic window selection (under
2865 mouse-autoselect-window) from acting as a real input event, for
2866 example banishing the mouse under mouse-avoidance-mode. */
2867 timer_resume_idle ();
2869 if (current_buffer
!= prev_buffer
)
2871 /* The command may have changed the keymaps. Pretend there
2872 is input in another keyboard and return. This will
2873 recalculate keymaps. */
2874 c
= make_number (-2);
2881 /* Handle things that only apply to characters. */
2884 /* If kbd_buffer_get_event gave us an EOF, return that. */
2888 if ((STRINGP (KVAR (current_kboard
, Vkeyboard_translate_table
))
2889 && UNSIGNED_CMP (XFASTINT (c
), <,
2890 SCHARS (KVAR (current_kboard
,
2891 Vkeyboard_translate_table
))))
2892 || (VECTORP (KVAR (current_kboard
, Vkeyboard_translate_table
))
2893 && UNSIGNED_CMP (XFASTINT (c
), <,
2894 ASIZE (KVAR (current_kboard
,
2895 Vkeyboard_translate_table
))))
2896 || (CHAR_TABLE_P (KVAR (current_kboard
, Vkeyboard_translate_table
))
2900 d
= Faref (KVAR (current_kboard
, Vkeyboard_translate_table
), c
);
2901 /* nil in keyboard-translate-table means no translation. */
2907 /* If this event is a mouse click in the menu bar,
2908 return just menu-bar for now. Modify the mouse click event
2909 so we won't do this twice, then queue it up. */
2910 if (EVENT_HAS_PARAMETERS (c
)
2912 && CONSP (EVENT_START (c
))
2913 && CONSP (XCDR (EVENT_START (c
))))
2917 posn
= POSN_POSN (EVENT_START (c
));
2918 /* Handle menu-bar events:
2919 insert the dummy prefix event `menu-bar'. */
2920 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
2922 /* Change menu-bar to (menu-bar) as the event "position". */
2923 POSN_SET_POSN (EVENT_START (c
), list1 (posn
));
2926 Vunread_command_events
= Fcons (c
, Vunread_command_events
);
2931 /* Store these characters into recent_keys, the dribble file if any,
2932 and the keyboard macro being defined, if any. */
2935 if (! NILP (also_record
))
2936 record_char (also_record
);
2938 /* Wipe the echo area.
2939 But first, if we are about to use an input method,
2940 save the echo area contents for it to refer to. */
2942 && ! NILP (Vinput_method_function
)
2943 && ' ' <= XINT (c
) && XINT (c
) < 256 && XINT (c
) != 127)
2945 previous_echo_area_message
= Fcurrent_message ();
2946 Vinput_method_previous_message
= previous_echo_area_message
;
2949 /* Now wipe the echo area, except for help events which do their
2950 own stuff with the echo area. */
2952 || (!(EQ (Qhelp_echo
, XCAR (c
)))
2953 && !(EQ (Qswitch_frame
, XCAR (c
)))
2954 /* Don't wipe echo area for select window events: These might
2955 get delayed via `mouse-autoselect-window' (Bug#11304). */
2956 && !(EQ (Qselect_window
, XCAR (c
)))))
2958 if (!NILP (echo_area_buffer
[0]))
2960 safe_run_hooks (Qecho_area_clear_hook
);
2961 clear_message (1, 0);
2965 reread_for_input_method
:
2967 /* Pass this to the input method, if appropriate. */
2969 && ! NILP (Vinput_method_function
)
2970 /* Don't run the input method within a key sequence,
2971 after the first event of the key sequence. */
2972 && NILP (prev_event
)
2973 && ' ' <= XINT (c
) && XINT (c
) < 256 && XINT (c
) != 127)
2976 ptrdiff_t key_count
;
2977 ptrdiff_t command_key_start
;
2978 ptrdiff_t count
= SPECPDL_INDEX ();
2980 /* Save the echo status. */
2981 bool saved_immediate_echo
= current_kboard
->immediate_echo
;
2982 struct kboard
*saved_ok_to_echo
= ok_to_echo_at_next_pause
;
2983 Lisp_Object saved_echo_string
= KVAR (current_kboard
, echo_string
);
2984 Lisp_Object saved_echo_prompt
= KVAR (current_kboard
, echo_prompt
);
2986 /* Save the this_command_keys status. */
2987 key_count
= this_command_key_count
;
2988 command_key_start
= this_single_command_key_start
;
2991 keys
= Fcopy_sequence (this_command_keys
);
2995 /* Clear out this_command_keys. */
2996 this_command_key_count
= 0;
2997 this_single_command_key_start
= 0;
2999 /* Now wipe the echo area. */
3000 if (!NILP (echo_area_buffer
[0]))
3001 safe_run_hooks (Qecho_area_clear_hook
);
3002 clear_message (1, 0);
3005 /* If we are not reading a key sequence,
3006 never use the echo area. */
3009 specbind (Qinput_method_use_echo_area
, Qt
);
3012 /* Call the input method. */
3013 tem
= call1 (Vinput_method_function
, c
);
3015 tem
= unbind_to (count
, tem
);
3017 /* Restore the saved echoing state
3018 and this_command_keys state. */
3019 this_command_key_count
= key_count
;
3020 this_single_command_key_start
= command_key_start
;
3022 this_command_keys
= keys
;
3025 ok_to_echo_at_next_pause
= saved_ok_to_echo
;
3026 kset_echo_string (current_kboard
, saved_echo_string
);
3027 kset_echo_prompt (current_kboard
, saved_echo_prompt
);
3028 if (saved_immediate_echo
)
3031 /* The input method can return no events. */
3034 /* Bring back the previous message, if any. */
3035 if (! NILP (previous_echo_area_message
))
3036 message_with_string ("%s", previous_echo_area_message
, 0);
3039 /* It returned one event or more. */
3041 Vunread_post_input_method_events
3042 = nconc2 (XCDR (tem
), Vunread_post_input_method_events
);
3044 /* When we consume events from the various unread-*-events lists, we
3045 bypass the code that records input, so record these events now if
3046 they were not recorded already. */
3055 /* Display help if not echoing. */
3056 if (CONSP (c
) && EQ (XCAR (c
), Qhelp_echo
))
3058 /* (help-echo FRAME HELP WINDOW OBJECT POS). */
3059 Lisp_Object help
, object
, position
, window
, htem
;
3061 htem
= Fcdr (XCDR (c
));
3064 window
= Fcar (htem
);
3066 object
= Fcar (htem
);
3068 position
= Fcar (htem
);
3070 show_help_echo (help
, window
, object
, position
);
3072 /* We stopped being idle for this event; undo that. */
3074 timer_resume_idle ();
3078 if ((! reread
|| this_command_key_count
== 0)
3082 /* Don't echo mouse motion events. */
3083 if (! (EVENT_HAS_PARAMETERS (c
)
3084 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
3085 /* Once we reread a character, echoing can happen
3086 the next time we pause to read a new one. */
3087 ok_to_echo_at_next_pause
= current_kboard
;
3089 /* Record this character as part of the current key. */
3090 add_command_key (c
);
3091 if (! NILP (also_record
))
3092 add_command_key (also_record
);
3097 last_input_event
= c
;
3100 /* Process the help character specially if enabled. */
3101 if (!NILP (Vhelp_form
) && help_char_p (c
))
3103 ptrdiff_t count
= SPECPDL_INDEX ();
3105 help_form_saved_window_configs
3106 = Fcons (Fcurrent_window_configuration (Qnil
),
3107 help_form_saved_window_configs
);
3108 record_unwind_protect_void (read_char_help_form_unwind
);
3109 call0 (Qhelp_form_show
);
3114 c
= read_char (0, Qnil
, Qnil
, 0, NULL
);
3115 if (EVENT_HAS_PARAMETERS (c
)
3116 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_click
))
3117 XSETCAR (help_form_saved_window_configs
, Qnil
);
3119 while (BUFFERP (c
));
3120 /* Remove the help from the frame. */
3121 unbind_to (count
, Qnil
);
3124 if (EQ (c
, make_number (040)))
3128 c
= read_char (0, Qnil
, Qnil
, 0, NULL
);
3129 while (BUFFERP (c
));
3135 input_was_pending
= input_pending
;
3139 /* Record a key that came from a mouse menu.
3140 Record it for echoing, for this-command-keys, and so on. */
3143 record_menu_key (Lisp_Object c
)
3145 /* Wipe the echo area. */
3146 clear_message (1, 0);
3150 /* Once we reread a character, echoing can happen
3151 the next time we pause to read a new one. */
3152 ok_to_echo_at_next_pause
= NULL
;
3154 /* Record this character as part of the current key. */
3155 add_command_key (c
);
3158 /* Re-reading in the middle of a command. */
3159 last_input_event
= c
;
3163 /* Return true if should recognize C as "the help character". */
3166 help_char_p (Lisp_Object c
)
3170 if (EQ (c
, Vhelp_char
))
3172 for (tail
= Vhelp_event_list
; CONSP (tail
); tail
= XCDR (tail
))
3173 if (EQ (c
, XCAR (tail
)))
3178 /* Record the input event C in various ways. */
3181 record_char (Lisp_Object c
)
3185 if (CONSP (c
) && (EQ (XCAR (c
), Qhelp_echo
) || EQ (XCAR (c
), Qmouse_movement
)))
3187 /* To avoid filling recent_keys with help-echo and mouse-movement
3188 events, we filter out repeated help-echo events, only store the
3189 first and last in a series of mouse-movement events, and don't
3190 store repeated help-echo events which are only separated by
3191 mouse-movement events. */
3193 Lisp_Object ev1
, ev2
, ev3
;
3196 if ((ix1
= recent_keys_index
- 1) < 0)
3197 ix1
= NUM_RECENT_KEYS
- 1;
3198 ev1
= AREF (recent_keys
, ix1
);
3200 if ((ix2
= ix1
- 1) < 0)
3201 ix2
= NUM_RECENT_KEYS
- 1;
3202 ev2
= AREF (recent_keys
, ix2
);
3204 if ((ix3
= ix2
- 1) < 0)
3205 ix3
= NUM_RECENT_KEYS
- 1;
3206 ev3
= AREF (recent_keys
, ix3
);
3208 if (EQ (XCAR (c
), Qhelp_echo
))
3210 /* Don't record `help-echo' in recent_keys unless it shows some help
3211 message, and a different help than the previously recorded
3213 Lisp_Object help
, last_help
;
3215 help
= Fcar_safe (Fcdr_safe (XCDR (c
)));
3216 if (!STRINGP (help
))
3218 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qhelp_echo
)
3219 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev1
))), EQ (last_help
, help
)))
3221 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3222 && CONSP (ev2
) && EQ (XCAR (ev2
), Qhelp_echo
)
3223 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev2
))), EQ (last_help
, help
)))
3225 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3226 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3227 && CONSP (ev3
) && EQ (XCAR (ev3
), Qhelp_echo
)
3228 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev3
))), EQ (last_help
, help
)))
3231 else if (EQ (XCAR (c
), Qmouse_movement
))
3233 /* Only record one pair of `mouse-movement' on a window in recent_keys.
3234 So additional mouse movement events replace the last element. */
3235 Lisp_Object last_window
, window
;
3237 window
= Fcar_safe (Fcar_safe (XCDR (c
)));
3238 if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3239 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev1
))), EQ (last_window
, window
))
3240 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3241 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev2
))), EQ (last_window
, window
)))
3243 ASET (recent_keys
, ix1
, c
);
3249 store_kbd_macro_char (c
);
3251 /* recent_keys should not include events from keyboard macros. */
3252 if (NILP (Vexecuting_kbd_macro
))
3256 total_keys
+= total_keys
< NUM_RECENT_KEYS
;
3257 ASET (recent_keys
, recent_keys_index
, c
);
3258 if (++recent_keys_index
>= NUM_RECENT_KEYS
)
3259 recent_keys_index
= 0;
3261 else if (recorded
< 0)
3263 /* We need to remove one or two events from recent_keys.
3264 To do this, we simply put nil at those events and move the
3265 recent_keys_index backwards over those events. Usually,
3266 users will never see those nil events, as they will be
3267 overwritten by the command keys entered to see recent_keys
3270 while (recorded
++ < 0 && total_keys
> 0)
3272 if (total_keys
< NUM_RECENT_KEYS
)
3274 if (--recent_keys_index
< 0)
3275 recent_keys_index
= NUM_RECENT_KEYS
- 1;
3276 ASET (recent_keys
, recent_keys_index
, Qnil
);
3280 num_nonmacro_input_events
++;
3283 /* Write c to the dribble file. If c is a lispy event, write
3284 the event's symbol to the dribble file, in <brackets>. Bleaugh.
3285 If you, dear reader, have a better idea, you've got the source. :-) */
3291 if (XUINT (c
) < 0x100)
3292 putc (XUINT (c
), dribble
);
3294 fprintf (dribble
, " 0x%"pI
"x", XUINT (c
));
3298 Lisp_Object dribblee
;
3300 /* If it's a structured event, take the event header. */
3301 dribblee
= EVENT_HEAD (c
);
3303 if (SYMBOLP (dribblee
))
3305 putc ('<', dribble
);
3306 fwrite (SDATA (SYMBOL_NAME (dribblee
)), sizeof (char),
3307 SBYTES (SYMBOL_NAME (dribblee
)),
3309 putc ('>', dribble
);
3318 /* Copy out or in the info on where C-g should throw to.
3319 This is used when running Lisp code from within get_char,
3320 in case get_char is called recursively.
3321 See read_process_output. */
3324 save_getcjmp (sys_jmp_buf temp
)
3326 memcpy (temp
, getcjmp
, sizeof getcjmp
);
3330 restore_getcjmp (sys_jmp_buf temp
)
3332 memcpy (getcjmp
, temp
, sizeof getcjmp
);
3335 /* Low level keyboard/mouse input.
3336 kbd_buffer_store_event places events in kbd_buffer, and
3337 kbd_buffer_get_event retrieves them. */
3339 /* Return true if there are any events in the queue that read-char
3340 would return. If this returns false, a read-char would block. */
3342 readable_events (int flags
)
3344 if (flags
& READABLE_EVENTS_DO_TIMERS_NOW
)
3347 /* If the buffer contains only FOCUS_IN_EVENT events, and
3348 READABLE_EVENTS_FILTER_EVENTS is set, report it as empty. */
3349 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3351 if (flags
& (READABLE_EVENTS_FILTER_EVENTS
3352 #ifdef USE_TOOLKIT_SCROLL_BARS
3353 | READABLE_EVENTS_IGNORE_SQUEEZABLES
3357 union buffered_input_event
*event
= kbd_fetch_ptr
;
3361 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3364 #ifdef USE_TOOLKIT_SCROLL_BARS
3365 (flags
& READABLE_EVENTS_FILTER_EVENTS
) &&
3367 event
->kind
== FOCUS_IN_EVENT
)
3368 #ifdef USE_TOOLKIT_SCROLL_BARS
3369 && !((flags
& READABLE_EVENTS_IGNORE_SQUEEZABLES
)
3370 && (event
->kind
== SCROLL_BAR_CLICK_EVENT
3371 || event
->kind
== HORIZONTAL_SCROLL_BAR_CLICK_EVENT
)
3372 && event
->ie
.part
== scroll_bar_handle
3373 && event
->ie
.modifiers
== 0)
3375 && !((flags
& READABLE_EVENTS_FILTER_EVENTS
)
3376 && event
->kind
== BUFFER_SWITCH_EVENT
))
3380 while (event
!= kbd_store_ptr
);
3386 if (!(flags
& READABLE_EVENTS_IGNORE_SQUEEZABLES
)
3387 && !NILP (do_mouse_tracking
) && some_mouse_moved ())
3391 if (current_kboard
->kbd_queue_has_data
)
3397 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
3398 if (kb
->kbd_queue_has_data
)
3404 /* Set this for debugging, to have a way to get out */
3405 int stop_character EXTERNALLY_VISIBLE
;
3408 event_to_kboard (struct input_event
*event
)
3410 /* Not applicable for these special events. */
3411 if (event
->kind
== SELECTION_REQUEST_EVENT
3412 || event
->kind
== SELECTION_CLEAR_EVENT
)
3416 Lisp_Object obj
= event
->frame_or_window
;
3417 /* There are some events that set this field to nil or string. */
3419 obj
= WINDOW_FRAME (XWINDOW (obj
));
3420 /* Also ignore dead frames here. */
3421 return ((FRAMEP (obj
) && FRAME_LIVE_P (XFRAME (obj
)))
3422 ? FRAME_KBOARD (XFRAME (obj
)) : NULL
);
3427 /* Return the number of slots occupied in kbd_buffer. */
3430 kbd_buffer_nr_stored (void)
3432 return kbd_fetch_ptr
== kbd_store_ptr
3434 : (kbd_fetch_ptr
< kbd_store_ptr
3435 ? kbd_store_ptr
- kbd_fetch_ptr
3436 : ((kbd_buffer
+ KBD_BUFFER_SIZE
) - kbd_fetch_ptr
3437 + (kbd_store_ptr
- kbd_buffer
)));
3439 #endif /* Store an event obtained at interrupt level into kbd_buffer, fifo */
3442 kbd_buffer_store_event (register struct input_event
*event
)
3444 kbd_buffer_store_event_hold (event
, 0);
3447 /* Store EVENT obtained at interrupt level into kbd_buffer, fifo.
3449 If HOLD_QUIT is 0, just stuff EVENT into the fifo.
3450 Else, if HOLD_QUIT.kind != NO_EVENT, discard EVENT.
3451 Else, if EVENT is a quit event, store the quit event
3452 in HOLD_QUIT, and return (thus ignoring further events).
3454 This is used to postpone the processing of the quit event until all
3455 subsequent input events have been parsed (and discarded). */
3458 kbd_buffer_store_buffered_event (union buffered_input_event
*event
,
3459 struct input_event
*hold_quit
)
3461 if (event
->kind
== NO_EVENT
)
3464 if (hold_quit
&& hold_quit
->kind
!= NO_EVENT
)
3467 if (event
->kind
== ASCII_KEYSTROKE_EVENT
)
3469 int c
= event
->ie
.code
& 0377;
3471 if (event
->ie
.modifiers
& ctrl_modifier
)
3472 c
= make_ctrl_char (c
);
3474 c
|= (event
->ie
.modifiers
3475 & (meta_modifier
| alt_modifier
3476 | hyper_modifier
| super_modifier
));
3480 KBOARD
*kb
= FRAME_KBOARD (XFRAME (event
->ie
.frame_or_window
));
3482 if (single_kboard
&& kb
!= current_kboard
)
3485 (kb
, list2 (make_lispy_switch_frame (event
->ie
.frame_or_window
),
3487 kb
->kbd_queue_has_data
= true;
3488 union buffered_input_event
*sp
;
3489 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3491 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3494 if (event_to_kboard (&sp
->ie
) == kb
)
3496 sp
->ie
.kind
= NO_EVENT
;
3497 sp
->ie
.frame_or_window
= Qnil
;
3506 *hold_quit
= event
->ie
;
3510 /* If this results in a quit_char being returned to Emacs as
3511 input, set Vlast_event_frame properly. If this doesn't
3512 get returned to Emacs as an event, the next event read
3513 will set Vlast_event_frame again, so this is safe to do. */
3517 focus
= FRAME_FOCUS_FRAME (XFRAME (event
->ie
.frame_or_window
));
3519 focus
= event
->ie
.frame_or_window
;
3520 internal_last_event_frame
= focus
;
3521 Vlast_event_frame
= focus
;
3524 handle_interrupt (0);
3528 if (c
&& c
== stop_character
)
3534 /* Don't insert two BUFFER_SWITCH_EVENT's in a row.
3535 Just ignore the second one. */
3536 else if (event
->kind
== BUFFER_SWITCH_EVENT
3537 && kbd_fetch_ptr
!= kbd_store_ptr
3538 && ((kbd_store_ptr
== kbd_buffer
3539 ? kbd_buffer
+ KBD_BUFFER_SIZE
- 1
3540 : kbd_store_ptr
- 1)->kind
) == BUFFER_SWITCH_EVENT
)
3543 if (kbd_store_ptr
- kbd_buffer
== KBD_BUFFER_SIZE
)
3544 kbd_store_ptr
= kbd_buffer
;
3546 /* Don't let the very last slot in the buffer become full,
3547 since that would make the two pointers equal,
3548 and that is indistinguishable from an empty buffer.
3549 Discard the event if it would fill the last slot. */
3550 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
3552 *kbd_store_ptr
= *event
;
3555 if (kbd_buffer_nr_stored () > KBD_BUFFER_SIZE
/ 2
3556 && ! kbd_on_hold_p ())
3558 /* Don't read keyboard input until we have processed kbd_buffer.
3559 This happens when pasting text longer than KBD_BUFFER_SIZE/2. */
3560 hold_keyboard_input ();
3564 #endif /* subprocesses */
3567 Lisp_Object ignore_event
;
3569 switch (event
->kind
)
3571 case FOCUS_IN_EVENT
: ignore_event
= Qfocus_in
; break;
3572 case FOCUS_OUT_EVENT
: ignore_event
= Qfocus_out
; break;
3573 case HELP_EVENT
: ignore_event
= Qhelp_echo
; break;
3574 case ICONIFY_EVENT
: ignore_event
= Qiconify_frame
; break;
3575 case DEICONIFY_EVENT
: ignore_event
= Qmake_frame_visible
; break;
3576 case SELECTION_REQUEST_EVENT
: ignore_event
= Qselection_request
; break;
3577 default: ignore_event
= Qnil
; break;
3580 /* If we're inside while-no-input, and this event qualifies
3581 as input, set quit-flag to cause an interrupt. */
3582 if (!NILP (Vthrow_on_input
)
3583 && NILP (Fmemq (ignore_event
, Vwhile_no_input_ignore_events
)))
3584 Vquit_flag
= Vthrow_on_input
;
3590 /* Put a selection input event back in the head of the event queue. */
3593 kbd_buffer_unget_event (struct selection_input_event
*event
)
3595 if (kbd_fetch_ptr
== kbd_buffer
)
3596 kbd_fetch_ptr
= kbd_buffer
+ KBD_BUFFER_SIZE
;
3598 /* Don't let the very last slot in the buffer become full, */
3599 union buffered_input_event
*kp
= kbd_fetch_ptr
- 1;
3600 if (kp
!= kbd_store_ptr
)
3609 /* Limit help event positions to this range, to avoid overflow problems. */
3610 #define INPUT_EVENT_POS_MAX \
3611 ((ptrdiff_t) min (PTRDIFF_MAX, min (TYPE_MAXIMUM (Time) / 2, \
3612 MOST_POSITIVE_FIXNUM)))
3613 #define INPUT_EVENT_POS_MIN (-1 - INPUT_EVENT_POS_MAX)
3615 /* Return a Time that encodes position POS. POS must be in range. */
3618 position_to_Time (ptrdiff_t pos
)
3620 eassert (INPUT_EVENT_POS_MIN
<= pos
&& pos
<= INPUT_EVENT_POS_MAX
);
3624 /* Return the position that ENCODED_POS encodes.
3625 Avoid signed integer overflow. */
3628 Time_to_position (Time encoded_pos
)
3630 if (encoded_pos
<= INPUT_EVENT_POS_MAX
)
3632 Time encoded_pos_min
= INPUT_EVENT_POS_MIN
;
3633 eassert (encoded_pos_min
<= encoded_pos
);
3634 ptrdiff_t notpos
= -1 - encoded_pos
;
3638 /* Generate a HELP_EVENT input_event and store it in the keyboard
3641 HELP is the help form.
3643 FRAME and WINDOW are the frame and window where the help is
3644 generated. OBJECT is the Lisp object where the help was found (a
3645 buffer, a string, an overlay, or nil if neither from a string nor
3646 from a buffer). POS is the position within OBJECT where the help
3650 gen_help_event (Lisp_Object help
, Lisp_Object frame
, Lisp_Object window
,
3651 Lisp_Object object
, ptrdiff_t pos
)
3653 struct input_event event
;
3655 event
.kind
= HELP_EVENT
;
3656 event
.frame_or_window
= frame
;
3658 event
.x
= WINDOWP (window
) ? window
: frame
;
3660 event
.timestamp
= position_to_Time (pos
);
3661 kbd_buffer_store_event (&event
);
3665 /* Store HELP_EVENTs for HELP on FRAME in the input queue. */
3668 kbd_buffer_store_help_event (Lisp_Object frame
, Lisp_Object help
)
3670 struct input_event event
;
3672 event
.kind
= HELP_EVENT
;
3673 event
.frame_or_window
= frame
;
3677 event
.timestamp
= 0;
3678 kbd_buffer_store_event (&event
);
3682 /* Discard any mouse events in the event buffer by setting them to
3685 discard_mouse_events (void)
3687 union buffered_input_event
*sp
;
3688 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3690 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3693 if (sp
->kind
== MOUSE_CLICK_EVENT
3694 || sp
->kind
== WHEEL_EVENT
3695 || sp
->kind
== HORIZ_WHEEL_EVENT
3697 || sp
->kind
== GPM_CLICK_EVENT
3699 || sp
->kind
== SCROLL_BAR_CLICK_EVENT
3700 || sp
->kind
== HORIZONTAL_SCROLL_BAR_CLICK_EVENT
)
3702 sp
->kind
= NO_EVENT
;
3708 /* Return true if there are any real events waiting in the event
3709 buffer, not counting `NO_EVENT's.
3711 Discard NO_EVENT events at the front of the input queue, possibly
3712 leaving the input queue empty if there are no real input events. */
3715 kbd_buffer_events_waiting (void)
3717 union buffered_input_event
*sp
;
3719 for (sp
= kbd_fetch_ptr
;
3720 sp
!= kbd_store_ptr
&& sp
->kind
== NO_EVENT
;
3723 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3728 return sp
!= kbd_store_ptr
&& sp
->kind
!= NO_EVENT
;
3732 /* Clear input event EVENT. */
3735 clear_event (union buffered_input_event
*event
)
3737 event
->kind
= NO_EVENT
;
3741 /* Read one event from the event buffer, waiting if necessary.
3742 The value is a Lisp object representing the event.
3743 The value is nil for an event that should be ignored,
3744 or that was handled here.
3745 We always read and discard one event. */
3748 kbd_buffer_get_event (KBOARD
**kbp
,
3749 bool *used_mouse_menu
,
3750 struct timespec
*end_time
)
3755 if (kbd_on_hold_p () && kbd_buffer_nr_stored () < KBD_BUFFER_SIZE
/ 4)
3757 /* Start reading input again because we have processed enough to
3758 be able to accept new events again. */
3759 unhold_keyboard_input ();
3763 #endif /* subprocesses */
3765 #if !defined HAVE_DBUS && !defined USE_FILE_NOTIFY
3767 /* In case we are running as a daemon, only do this before
3768 detaching from the terminal. */
3769 || (IS_DAEMON
&& DAEMON_RUNNING
))
3773 *kbp
= current_kboard
;
3776 #endif /* !defined HAVE_DBUS && !defined USE_FILE_NOTIFY */
3778 /* Wait until there is input available. */
3781 /* Break loop if there's an unread command event. Needed in
3782 moused window autoselection which uses a timer to insert such
3784 if (CONSP (Vunread_command_events
))
3787 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3789 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3792 /* If the quit flag is set, then read_char will return
3793 quit_char, so that counts as "available input." */
3794 if (!NILP (Vquit_flag
))
3795 quit_throw_to_read_char (0);
3797 /* One way or another, wait until input is available; then, if
3798 interrupt handlers have not read it, read it now. */
3803 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3805 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3809 struct timespec now
= current_timespec ();
3810 if (timespec_cmp (*end_time
, now
) <= 0)
3811 return Qnil
; /* Finished waiting. */
3814 struct timespec duration
= timespec_sub (*end_time
, now
);
3815 wait_reading_process_output (min (duration
.tv_sec
,
3818 -1, 1, Qnil
, NULL
, 0);
3823 bool do_display
= true;
3825 if (FRAME_TERMCAP_P (SELECTED_FRAME ()))
3827 struct tty_display_info
*tty
= CURTTY ();
3829 /* When this TTY is displaying a menu, we must prevent
3830 any redisplay, because we modify the frame's glyph
3831 matrix behind the back of the display engine. */
3832 if (tty
->showing_menu
)
3836 wait_reading_process_output (0, 0, -1, do_display
, Qnil
, NULL
, 0);
3839 if (!interrupt_input
&& kbd_fetch_ptr
== kbd_store_ptr
)
3843 if (CONSP (Vunread_command_events
))
3846 first
= XCAR (Vunread_command_events
);
3847 Vunread_command_events
= XCDR (Vunread_command_events
);
3848 *kbp
= current_kboard
;
3852 /* At this point, we know that there is a readable event available
3853 somewhere. If the event queue is empty, then there must be a
3854 mouse movement enabled and available. */
3855 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3857 union buffered_input_event
*event
;
3859 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
3863 *kbp
= event_to_kboard (&event
->ie
);
3865 *kbp
= current_kboard
; /* Better than returning null ptr? */
3869 /* These two kinds of events get special handling
3870 and don't actually appear to the command loop.
3871 We return nil for them. */
3872 if (event
->kind
== SELECTION_REQUEST_EVENT
3873 || event
->kind
== SELECTION_CLEAR_EVENT
)
3876 /* Remove it from the buffer before processing it,
3877 since otherwise swallow_events will see it
3878 and process it again. */
3879 struct selection_input_event copy
= event
->sie
;
3880 kbd_fetch_ptr
= event
+ 1;
3881 input_pending
= readable_events (0);
3882 x_handle_selection_event (©
);
3884 /* We're getting selection request events, but we don't have
3890 #if defined (HAVE_NS)
3891 else if (event
->kind
== NS_TEXT_EVENT
)
3893 if (event
->ie
.code
== KEY_NS_PUT_WORKING_TEXT
)
3894 obj
= list1 (intern ("ns-put-working-text"));
3896 obj
= list1 (intern ("ns-unput-working-text"));
3897 kbd_fetch_ptr
= event
+ 1;
3898 if (used_mouse_menu
)
3899 *used_mouse_menu
= true;
3903 #if defined (HAVE_X11) || defined (HAVE_NTGUI) \
3904 || defined (HAVE_NS)
3905 else if (event
->kind
== DELETE_WINDOW_EVENT
)
3907 /* Make an event (delete-frame (FRAME)). */
3908 obj
= list2 (Qdelete_frame
, list1 (event
->ie
.frame_or_window
));
3909 kbd_fetch_ptr
= event
+ 1;
3914 else if (event
->kind
== END_SESSION_EVENT
)
3916 /* Make an event (end-session). */
3917 obj
= list1 (Qend_session
);
3918 kbd_fetch_ptr
= event
+ 1;
3922 #if defined (HAVE_X11) || defined (HAVE_NTGUI) \
3923 || defined (HAVE_NS)
3924 else if (event
->kind
== ICONIFY_EVENT
)
3926 /* Make an event (iconify-frame (FRAME)). */
3927 obj
= list2 (Qiconify_frame
, list1 (event
->ie
.frame_or_window
));
3928 kbd_fetch_ptr
= event
+ 1;
3930 else if (event
->kind
== DEICONIFY_EVENT
)
3932 /* Make an event (make-frame-visible (FRAME)). */
3933 obj
= list2 (Qmake_frame_visible
, list1 (event
->ie
.frame_or_window
));
3934 kbd_fetch_ptr
= event
+ 1;
3937 else if (event
->kind
== BUFFER_SWITCH_EVENT
)
3939 /* The value doesn't matter here; only the type is tested. */
3940 XSETBUFFER (obj
, current_buffer
);
3941 kbd_fetch_ptr
= event
+ 1;
3943 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
3944 || defined (HAVE_NS) || defined (USE_GTK)
3945 else if (event
->kind
== MENU_BAR_ACTIVATE_EVENT
)
3947 kbd_fetch_ptr
= event
+ 1;
3948 input_pending
= readable_events (0);
3949 if (FRAME_LIVE_P (XFRAME (event
->ie
.frame_or_window
)))
3950 x_activate_menubar (XFRAME (event
->ie
.frame_or_window
));
3954 else if (event
->kind
== LANGUAGE_CHANGE_EVENT
)
3956 /* Make an event (language-change FRAME CODEPAGE LANGUAGE-ID). */
3957 obj
= list4 (Qlanguage_change
,
3958 event
->ie
.frame_or_window
,
3959 make_number (event
->ie
.code
),
3960 make_number (event
->ie
.modifiers
));
3961 kbd_fetch_ptr
= event
+ 1;
3964 #ifdef USE_FILE_NOTIFY
3965 else if (event
->kind
== FILE_NOTIFY_EVENT
)
3967 #ifdef HAVE_W32NOTIFY
3968 /* Make an event (file-notify (DESCRIPTOR ACTION FILE) CALLBACK). */
3969 obj
= list3 (Qfile_notify
, event
->ie
.arg
, event
->ie
.frame_or_window
);
3971 obj
= make_lispy_event (&event
->ie
);
3973 kbd_fetch_ptr
= event
+ 1;
3975 #endif /* USE_FILE_NOTIFY */
3976 else if (event
->kind
== SAVE_SESSION_EVENT
)
3978 obj
= list2 (Qsave_session
, event
->ie
.arg
);
3979 kbd_fetch_ptr
= event
+ 1;
3981 /* Just discard these, by returning nil.
3982 With MULTI_KBOARD, these events are used as placeholders
3983 when we need to randomly delete events from the queue.
3984 (They shouldn't otherwise be found in the buffer,
3985 but on some machines it appears they do show up
3986 even without MULTI_KBOARD.) */
3987 /* On Windows NT/9X, NO_EVENT is used to delete extraneous
3988 mouse events during a popup-menu call. */
3989 else if (event
->kind
== NO_EVENT
)
3990 kbd_fetch_ptr
= event
+ 1;
3991 else if (event
->kind
== HELP_EVENT
)
3993 Lisp_Object object
, position
, help
, frame
, window
;
3995 frame
= event
->ie
.frame_or_window
;
3996 object
= event
->ie
.arg
;
3997 position
= make_number (Time_to_position (event
->ie
.timestamp
));
3998 window
= event
->ie
.x
;
4000 clear_event (event
);
4002 kbd_fetch_ptr
= event
+ 1;
4003 if (!WINDOWP (window
))
4005 obj
= Fcons (Qhelp_echo
,
4006 list5 (frame
, help
, window
, object
, position
));
4008 else if (event
->kind
== FOCUS_IN_EVENT
)
4010 /* Notification of a FocusIn event. The frame receiving the
4011 focus is in event->frame_or_window. Generate a
4012 switch-frame event if necessary. */
4013 Lisp_Object frame
, focus
;
4015 frame
= event
->ie
.frame_or_window
;
4016 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
4022 ! NILP (event
->ie
.arg
)
4025 !EQ (frame
, internal_last_event_frame
)
4026 && !EQ (frame
, selected_frame
))
4027 obj
= make_lispy_switch_frame (frame
);
4029 obj
= make_lispy_focus_in (frame
);
4031 internal_last_event_frame
= frame
;
4032 kbd_fetch_ptr
= event
+ 1;
4034 else if (event
->kind
== FOCUS_OUT_EVENT
)
4036 #ifdef HAVE_WINDOW_SYSTEM
4039 Lisp_Object frame
= event
->ie
.frame_or_window
;
4040 bool focused
= false;
4042 for (di
= x_display_list
; di
&& ! focused
; di
= di
->next
)
4043 focused
= di
->x_highlight_frame
!= 0;
4046 obj
= make_lispy_focus_out (frame
);
4048 #endif /* HAVE_WINDOW_SYSTEM */
4050 kbd_fetch_ptr
= event
+ 1;
4053 else if (event
->kind
== DBUS_EVENT
)
4055 obj
= make_lispy_event (&event
->ie
);
4056 kbd_fetch_ptr
= event
+ 1;
4059 #ifdef HAVE_XWIDGETS
4060 else if (event
->kind
== XWIDGET_EVENT
)
4062 obj
= make_lispy_event (&event
->ie
);
4063 kbd_fetch_ptr
= event
+ 1;
4066 else if (event
->kind
== CONFIG_CHANGED_EVENT
)
4068 obj
= make_lispy_event (&event
->ie
);
4069 kbd_fetch_ptr
= event
+ 1;
4073 /* If this event is on a different frame, return a switch-frame this
4074 time, and leave the event in the queue for next time. */
4078 frame
= event
->ie
.frame_or_window
;
4080 frame
= XCAR (frame
);
4081 else if (WINDOWP (frame
))
4082 frame
= WINDOW_FRAME (XWINDOW (frame
));
4084 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
4088 if (! EQ (frame
, internal_last_event_frame
)
4089 && !EQ (frame
, selected_frame
))
4090 obj
= make_lispy_switch_frame (frame
);
4091 internal_last_event_frame
= frame
;
4093 /* If we didn't decide to make a switch-frame event, go ahead
4094 and build a real event from the queue entry. */
4098 obj
= make_lispy_event (&event
->ie
);
4100 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
4101 || defined (HAVE_NS) || defined (USE_GTK)
4102 /* If this was a menu selection, then set the flag to inhibit
4103 writing to last_nonmenu_event. Don't do this if the event
4104 we're returning is (menu-bar), though; that indicates the
4105 beginning of the menu sequence, and we might as well leave
4106 that as the `event with parameters' for this selection. */
4108 && !EQ (event
->ie
.frame_or_window
, event
->ie
.arg
)
4109 && (event
->kind
== MENU_BAR_EVENT
4110 || event
->kind
== TOOL_BAR_EVENT
))
4111 *used_mouse_menu
= true;
4114 /* Certain system events are non-key events. */
4116 && event
->kind
== NS_NONKEY_EVENT
)
4117 *used_mouse_menu
= true;
4120 /* Wipe out this event, to catch bugs. */
4121 clear_event (event
);
4122 kbd_fetch_ptr
= event
+ 1;
4126 /* Try generating a mouse motion event. */
4127 else if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
4129 struct frame
*f
= some_mouse_moved ();
4130 Lisp_Object bar_window
;
4131 enum scroll_bar_part part
;
4135 *kbp
= current_kboard
;
4136 /* Note that this uses F to determine which terminal to look at.
4137 If there is no valid info, it does not store anything
4138 so x remains nil. */
4141 /* XXX Can f or mouse_position_hook be NULL here? */
4142 if (f
&& FRAME_TERMINAL (f
)->mouse_position_hook
)
4143 (*FRAME_TERMINAL (f
)->mouse_position_hook
) (&f
, 0, &bar_window
,
4148 /* Decide if we should generate a switch-frame event. Don't
4149 generate switch-frame events for motion outside of all Emacs
4155 frame
= FRAME_FOCUS_FRAME (f
);
4157 XSETFRAME (frame
, f
);
4159 if (! EQ (frame
, internal_last_event_frame
)
4160 && !EQ (frame
, selected_frame
))
4161 obj
= make_lispy_switch_frame (frame
);
4162 internal_last_event_frame
= frame
;
4165 /* If we didn't decide to make a switch-frame event, go ahead and
4166 return a mouse-motion event. */
4167 if (!NILP (x
) && NILP (obj
))
4168 obj
= make_lispy_movement (f
, bar_window
, part
, x
, y
, t
);
4171 /* We were promised by the above while loop that there was
4172 something for us to read! */
4175 input_pending
= readable_events (0);
4177 Vlast_event_frame
= internal_last_event_frame
;
4182 /* Process any non-user-visible events (currently X selection events),
4183 without reading any user-visible events. */
4186 process_special_events (void)
4188 union buffered_input_event
*event
;
4190 for (event
= kbd_fetch_ptr
; event
!= kbd_store_ptr
; ++event
)
4192 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
4195 if (event
== kbd_store_ptr
)
4199 /* If we find a stored X selection request, handle it now. */
4200 if (event
->kind
== SELECTION_REQUEST_EVENT
4201 || event
->kind
== SELECTION_CLEAR_EVENT
)
4205 /* Remove the event from the fifo buffer before processing;
4206 otherwise swallow_events called recursively could see it
4207 and process it again. To do this, we move the events
4208 between kbd_fetch_ptr and EVENT one slot to the right,
4211 struct selection_input_event copy
= event
->sie
;
4212 union buffered_input_event
*beg
4213 = (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
4214 ? kbd_buffer
: kbd_fetch_ptr
;
4217 memmove (beg
+ 1, beg
, (event
- beg
) * sizeof *beg
);
4218 else if (event
< beg
)
4220 if (event
> kbd_buffer
)
4221 memmove (kbd_buffer
+ 1, kbd_buffer
,
4222 (event
- kbd_buffer
) * sizeof *kbd_buffer
);
4223 *kbd_buffer
= *(kbd_buffer
+ KBD_BUFFER_SIZE
- 1);
4224 if (beg
< kbd_buffer
+ KBD_BUFFER_SIZE
- 1)
4225 memmove (beg
+ 1, beg
,
4226 (kbd_buffer
+ KBD_BUFFER_SIZE
- 1 - beg
) * sizeof *beg
);
4229 if (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
4230 kbd_fetch_ptr
= kbd_buffer
+ 1;
4234 input_pending
= readable_events (0);
4235 x_handle_selection_event (©
);
4237 /* We're getting selection request events, but we don't have
4245 /* Process any events that are not user-visible, run timer events that
4246 are ripe, and return, without reading any user-visible events. */
4249 swallow_events (bool do_display
)
4251 unsigned old_timers_run
;
4253 process_special_events ();
4255 old_timers_run
= timers_run
;
4256 get_input_pending (READABLE_EVENTS_DO_TIMERS_NOW
);
4258 if (!input_pending
&& timers_run
!= old_timers_run
&& do_display
)
4259 redisplay_preserve_echo_area (7);
4262 /* Record the start of when Emacs is idle,
4263 for the sake of running idle-time timers. */
4266 timer_start_idle (void)
4268 /* If we are already in the idle state, do nothing. */
4269 if (timespec_valid_p (timer_idleness_start_time
))
4272 timer_idleness_start_time
= current_timespec ();
4273 timer_last_idleness_start_time
= timer_idleness_start_time
;
4275 /* Mark all idle-time timers as once again candidates for running. */
4276 call0 (intern ("internal-timer-start-idle"));
4279 /* Record that Emacs is no longer idle, so stop running idle-time timers. */
4282 timer_stop_idle (void)
4284 timer_idleness_start_time
= invalid_timespec ();
4287 /* Resume idle timer from last idle start time. */
4290 timer_resume_idle (void)
4292 if (timespec_valid_p (timer_idleness_start_time
))
4295 timer_idleness_start_time
= timer_last_idleness_start_time
;
4298 /* List of elisp functions to call, delayed because they were generated in
4299 a context where Elisp could not be safely run (e.g. redisplay, signal,
4300 ...). Each element has the form (FUN . ARGS). */
4301 Lisp_Object pending_funcalls
;
4303 /* Return true if TIMER is a valid timer, placing its value into *RESULT. */
4305 decode_timer (Lisp_Object timer
, struct timespec
*result
)
4309 if (! (VECTORP (timer
) && ASIZE (timer
) == 9))
4311 vec
= XVECTOR (timer
)->contents
;
4312 if (! NILP (vec
[0]))
4314 if (! INTEGERP (vec
[2]))
4318 if (decode_time_components (vec
[1], vec
[2], vec
[3], vec
[8], &t
, 0) <= 0)
4320 *result
= lisp_to_timespec (t
);
4321 return timespec_valid_p (*result
);
4325 /* Check whether a timer has fired. To prevent larger problems we simply
4326 disregard elements that are not proper timers. Do not make a circular
4327 timer list for the time being.
4329 Returns the time to wait until the next timer fires. If a
4330 timer is triggering now, return zero.
4331 If no timer is active, return -1.
4333 If a timer is ripe, we run it, with quitting turned off.
4334 In that case we return 0 to indicate that a new timer_check_2 call
4337 static struct timespec
4338 timer_check_2 (Lisp_Object timers
, Lisp_Object idle_timers
)
4340 struct timespec nexttime
;
4341 struct timespec now
;
4342 struct timespec idleness_now
;
4343 Lisp_Object chosen_timer
;
4345 nexttime
= invalid_timespec ();
4347 chosen_timer
= Qnil
;
4349 /* First run the code that was delayed. */
4350 while (CONSP (pending_funcalls
))
4352 Lisp_Object funcall
= XCAR (pending_funcalls
);
4353 pending_funcalls
= XCDR (pending_funcalls
);
4354 safe_call2 (Qapply
, XCAR (funcall
), XCDR (funcall
));
4357 if (CONSP (timers
) || CONSP (idle_timers
))
4359 now
= current_timespec ();
4360 idleness_now
= (timespec_valid_p (timer_idleness_start_time
)
4361 ? timespec_sub (now
, timer_idleness_start_time
)
4362 : make_timespec (0, 0));
4365 while (CONSP (timers
) || CONSP (idle_timers
))
4367 Lisp_Object timer
= Qnil
, idle_timer
= Qnil
;
4368 struct timespec timer_time
, idle_timer_time
;
4369 struct timespec difference
;
4370 struct timespec timer_difference
= invalid_timespec ();
4371 struct timespec idle_timer_difference
= invalid_timespec ();
4372 bool ripe
, timer_ripe
= 0, idle_timer_ripe
= 0;
4374 /* Set TIMER and TIMER_DIFFERENCE
4375 based on the next ordinary timer.
4376 TIMER_DIFFERENCE is the distance in time from NOW to when
4377 this timer becomes ripe.
4378 Skip past invalid timers and timers already handled. */
4381 timer
= XCAR (timers
);
4382 if (! decode_timer (timer
, &timer_time
))
4384 timers
= XCDR (timers
);
4388 timer_ripe
= timespec_cmp (timer_time
, now
) <= 0;
4389 timer_difference
= (timer_ripe
4390 ? timespec_sub (now
, timer_time
)
4391 : timespec_sub (timer_time
, now
));
4394 /* Likewise for IDLE_TIMER and IDLE_TIMER_DIFFERENCE
4395 based on the next idle timer. */
4396 if (CONSP (idle_timers
))
4398 idle_timer
= XCAR (idle_timers
);
4399 if (! decode_timer (idle_timer
, &idle_timer_time
))
4401 idle_timers
= XCDR (idle_timers
);
4405 idle_timer_ripe
= timespec_cmp (idle_timer_time
, idleness_now
) <= 0;
4406 idle_timer_difference
4408 ? timespec_sub (idleness_now
, idle_timer_time
)
4409 : timespec_sub (idle_timer_time
, idleness_now
));
4412 /* Decide which timer is the next timer,
4413 and set CHOSEN_TIMER, DIFFERENCE, and RIPE accordingly.
4414 Also step down the list where we found that timer. */
4416 if (timespec_valid_p (timer_difference
)
4417 && (! timespec_valid_p (idle_timer_difference
)
4418 || idle_timer_ripe
< timer_ripe
4419 || (idle_timer_ripe
== timer_ripe
4421 ? timespec_cmp (idle_timer_difference
,
4423 : timespec_cmp (timer_difference
,
4424 idle_timer_difference
))
4427 chosen_timer
= timer
;
4428 timers
= XCDR (timers
);
4429 difference
= timer_difference
;
4434 chosen_timer
= idle_timer
;
4435 idle_timers
= XCDR (idle_timers
);
4436 difference
= idle_timer_difference
;
4437 ripe
= idle_timer_ripe
;
4440 /* If timer is ripe, run it if it hasn't been run. */
4443 if (NILP (AREF (chosen_timer
, 0)))
4445 ptrdiff_t count
= SPECPDL_INDEX ();
4446 Lisp_Object old_deactivate_mark
= Vdeactivate_mark
;
4448 /* Mark the timer as triggered to prevent problems if the lisp
4449 code fails to reschedule it right. */
4450 ASET (chosen_timer
, 0, Qt
);
4452 specbind (Qinhibit_quit
, Qt
);
4454 call1 (Qtimer_event_handler
, chosen_timer
);
4455 Vdeactivate_mark
= old_deactivate_mark
;
4457 unbind_to (count
, Qnil
);
4459 /* Since we have handled the event,
4460 we don't need to tell the caller to wake up and do it. */
4461 /* But the caller must still wait for the next timer, so
4462 return 0 to indicate that. */
4465 nexttime
= make_timespec (0, 0);
4469 /* When we encounter a timer that is still waiting,
4470 return the amount of time to wait before it is ripe. */
4476 /* No timers are pending in the future. */
4477 /* Return 0 if we generated an event, and -1 if not. */
4482 /* Check whether a timer has fired. To prevent larger problems we simply
4483 disregard elements that are not proper timers. Do not make a circular
4484 timer list for the time being.
4486 Returns the time to wait until the next timer fires.
4487 If no timer is active, return an invalid value.
4489 As long as any timer is ripe, we run it. */
4494 struct timespec nexttime
;
4495 Lisp_Object timers
, idle_timers
;
4497 Lisp_Object tem
= Vinhibit_quit
;
4500 /* We use copies of the timers' lists to allow a timer to add itself
4501 again, without locking up Emacs if the newly added timer is
4502 already ripe when added. */
4504 /* Always consider the ordinary timers. */
4505 timers
= Fcopy_sequence (Vtimer_list
);
4506 /* Consider the idle timers only if Emacs is idle. */
4507 if (timespec_valid_p (timer_idleness_start_time
))
4508 idle_timers
= Fcopy_sequence (Vtimer_idle_list
);
4512 Vinhibit_quit
= tem
;
4516 nexttime
= timer_check_2 (timers
, idle_timers
);
4518 while (nexttime
.tv_sec
== 0 && nexttime
.tv_nsec
== 0);
4523 DEFUN ("current-idle-time", Fcurrent_idle_time
, Scurrent_idle_time
, 0, 0, 0,
4524 doc
: /* Return the current length of Emacs idleness, or nil.
4525 The value when Emacs is idle is a list of four integers (HIGH LOW USEC PSEC)
4526 in the same style as (current-time).
4528 The value when Emacs is not idle is nil.
4530 PSEC is a multiple of the system clock resolution. */)
4533 if (timespec_valid_p (timer_idleness_start_time
))
4534 return make_lisp_time (timespec_sub (current_timespec (),
4535 timer_idleness_start_time
));
4540 /* Caches for modify_event_symbol. */
4541 static Lisp_Object accent_key_syms
;
4542 static Lisp_Object func_key_syms
;
4543 static Lisp_Object mouse_syms
;
4544 static Lisp_Object wheel_syms
;
4545 static Lisp_Object drag_n_drop_syms
;
4547 /* This is a list of keysym codes for special "accent" characters.
4548 It parallels lispy_accent_keys. */
4550 static const int lispy_accent_codes
[] =
4552 #ifdef XK_dead_circumflex
4557 #ifdef XK_dead_grave
4562 #ifdef XK_dead_tilde
4567 #ifdef XK_dead_diaeresis
4572 #ifdef XK_dead_macron
4577 #ifdef XK_dead_degree
4582 #ifdef XK_dead_acute
4587 #ifdef XK_dead_cedilla
4592 #ifdef XK_dead_breve
4597 #ifdef XK_dead_ogonek
4602 #ifdef XK_dead_caron
4607 #ifdef XK_dead_doubleacute
4608 XK_dead_doubleacute
,
4612 #ifdef XK_dead_abovedot
4617 #ifdef XK_dead_abovering
4627 #ifdef XK_dead_belowdot
4632 #ifdef XK_dead_voiced_sound
4633 XK_dead_voiced_sound
,
4637 #ifdef XK_dead_semivoiced_sound
4638 XK_dead_semivoiced_sound
,
4654 /* This is a list of Lisp names for special "accent" characters.
4655 It parallels lispy_accent_codes. */
4657 static const char *const lispy_accent_keys
[] =
4675 "dead-voiced-sound",
4676 "dead-semivoiced-sound",
4682 #define FUNCTION_KEY_OFFSET 0x0
4684 const char *const lispy_function_keys
[] =
4688 0, /* VK_LBUTTON 0x01 */
4689 0, /* VK_RBUTTON 0x02 */
4690 "cancel", /* VK_CANCEL 0x03 */
4691 0, /* VK_MBUTTON 0x04 */
4693 0, 0, 0, /* 0x05 .. 0x07 */
4695 "backspace", /* VK_BACK 0x08 */
4696 "tab", /* VK_TAB 0x09 */
4698 0, 0, /* 0x0A .. 0x0B */
4700 "clear", /* VK_CLEAR 0x0C */
4701 "return", /* VK_RETURN 0x0D */
4703 0, 0, /* 0x0E .. 0x0F */
4705 0, /* VK_SHIFT 0x10 */
4706 0, /* VK_CONTROL 0x11 */
4707 0, /* VK_MENU 0x12 */
4708 "pause", /* VK_PAUSE 0x13 */
4709 "capslock", /* VK_CAPITAL 0x14 */
4710 "kana", /* VK_KANA/VK_HANGUL 0x15 */
4712 "junja", /* VK_JUNJA 0x17 */
4713 "final", /* VK_FINAL 0x18 */
4714 "kanji", /* VK_KANJI/VK_HANJA 0x19 */
4716 "escape", /* VK_ESCAPE 0x1B */
4717 "convert", /* VK_CONVERT 0x1C */
4718 "non-convert", /* VK_NONCONVERT 0x1D */
4719 "accept", /* VK_ACCEPT 0x1E */
4720 "mode-change", /* VK_MODECHANGE 0x1F */
4721 0, /* VK_SPACE 0x20 */
4722 "prior", /* VK_PRIOR 0x21 */
4723 "next", /* VK_NEXT 0x22 */
4724 "end", /* VK_END 0x23 */
4725 "home", /* VK_HOME 0x24 */
4726 "left", /* VK_LEFT 0x25 */
4727 "up", /* VK_UP 0x26 */
4728 "right", /* VK_RIGHT 0x27 */
4729 "down", /* VK_DOWN 0x28 */
4730 "select", /* VK_SELECT 0x29 */
4731 "print", /* VK_PRINT 0x2A */
4732 "execute", /* VK_EXECUTE 0x2B */
4733 "snapshot", /* VK_SNAPSHOT 0x2C */
4734 "insert", /* VK_INSERT 0x2D */
4735 "delete", /* VK_DELETE 0x2E */
4736 "help", /* VK_HELP 0x2F */
4738 /* VK_0 thru VK_9 are the same as ASCII '0' thru '9' (0x30 - 0x39) */
4740 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4742 0, 0, 0, 0, 0, 0, 0, /* 0x3A .. 0x40 */
4744 /* VK_A thru VK_Z are the same as ASCII 'A' thru 'Z' (0x41 - 0x5A) */
4746 0, 0, 0, 0, 0, 0, 0, 0, 0,
4747 0, 0, 0, 0, 0, 0, 0, 0, 0,
4748 0, 0, 0, 0, 0, 0, 0, 0,
4750 "lwindow", /* VK_LWIN 0x5B */
4751 "rwindow", /* VK_RWIN 0x5C */
4752 "apps", /* VK_APPS 0x5D */
4755 "kp-0", /* VK_NUMPAD0 0x60 */
4756 "kp-1", /* VK_NUMPAD1 0x61 */
4757 "kp-2", /* VK_NUMPAD2 0x62 */
4758 "kp-3", /* VK_NUMPAD3 0x63 */
4759 "kp-4", /* VK_NUMPAD4 0x64 */
4760 "kp-5", /* VK_NUMPAD5 0x65 */
4761 "kp-6", /* VK_NUMPAD6 0x66 */
4762 "kp-7", /* VK_NUMPAD7 0x67 */
4763 "kp-8", /* VK_NUMPAD8 0x68 */
4764 "kp-9", /* VK_NUMPAD9 0x69 */
4765 "kp-multiply", /* VK_MULTIPLY 0x6A */
4766 "kp-add", /* VK_ADD 0x6B */
4767 "kp-separator", /* VK_SEPARATOR 0x6C */
4768 "kp-subtract", /* VK_SUBTRACT 0x6D */
4769 "kp-decimal", /* VK_DECIMAL 0x6E */
4770 "kp-divide", /* VK_DIVIDE 0x6F */
4771 "f1", /* VK_F1 0x70 */
4772 "f2", /* VK_F2 0x71 */
4773 "f3", /* VK_F3 0x72 */
4774 "f4", /* VK_F4 0x73 */
4775 "f5", /* VK_F5 0x74 */
4776 "f6", /* VK_F6 0x75 */
4777 "f7", /* VK_F7 0x76 */
4778 "f8", /* VK_F8 0x77 */
4779 "f9", /* VK_F9 0x78 */
4780 "f10", /* VK_F10 0x79 */
4781 "f11", /* VK_F11 0x7A */
4782 "f12", /* VK_F12 0x7B */
4783 "f13", /* VK_F13 0x7C */
4784 "f14", /* VK_F14 0x7D */
4785 "f15", /* VK_F15 0x7E */
4786 "f16", /* VK_F16 0x7F */
4787 "f17", /* VK_F17 0x80 */
4788 "f18", /* VK_F18 0x81 */
4789 "f19", /* VK_F19 0x82 */
4790 "f20", /* VK_F20 0x83 */
4791 "f21", /* VK_F21 0x84 */
4792 "f22", /* VK_F22 0x85 */
4793 "f23", /* VK_F23 0x86 */
4794 "f24", /* VK_F24 0x87 */
4796 0, 0, 0, 0, /* 0x88 .. 0x8B */
4797 0, 0, 0, 0, /* 0x8C .. 0x8F */
4799 "kp-numlock", /* VK_NUMLOCK 0x90 */
4800 "scroll", /* VK_SCROLL 0x91 */
4801 /* Not sure where the following block comes from.
4802 Windows headers have NEC and Fujitsu specific keys in
4803 this block, but nothing generic. */
4804 "kp-space", /* VK_NUMPAD_CLEAR 0x92 */
4805 "kp-enter", /* VK_NUMPAD_ENTER 0x93 */
4806 "kp-prior", /* VK_NUMPAD_PRIOR 0x94 */
4807 "kp-next", /* VK_NUMPAD_NEXT 0x95 */
4808 "kp-end", /* VK_NUMPAD_END 0x96 */
4809 "kp-home", /* VK_NUMPAD_HOME 0x97 */
4810 "kp-left", /* VK_NUMPAD_LEFT 0x98 */
4811 "kp-up", /* VK_NUMPAD_UP 0x99 */
4812 "kp-right", /* VK_NUMPAD_RIGHT 0x9A */
4813 "kp-down", /* VK_NUMPAD_DOWN 0x9B */
4814 "kp-insert", /* VK_NUMPAD_INSERT 0x9C */
4815 "kp-delete", /* VK_NUMPAD_DELETE 0x9D */
4817 0, 0, /* 0x9E .. 0x9F */
4820 * VK_L* & VK_R* - left and right Alt, Ctrl and Shift virtual keys.
4821 * Used only as parameters to GetAsyncKeyState and GetKeyState.
4822 * No other API or message will distinguish left and right keys this way.
4827 /* Multimedia keys. These are handled as WM_APPCOMMAND, which allows us
4828 to enable them selectively, and gives access to a few more functions.
4829 See lispy_multimedia_keys below. */
4830 0, 0, 0, 0, 0, 0, 0, /* 0xA6 .. 0xAC Browser */
4831 0, 0, 0, /* 0xAD .. 0xAF Volume */
4832 0, 0, 0, 0, /* 0xB0 .. 0xB3 Media */
4833 0, 0, 0, 0, /* 0xB4 .. 0xB7 Apps */
4835 /* 0xB8 .. 0xC0 "OEM" keys - all seem to be punctuation. */
4836 0, 0, 0, 0, 0, 0, 0, 0, 0,
4838 /* 0xC1 - 0xDA unallocated, 0xDB-0xDF more OEM keys */
4839 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4840 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4843 "ax", /* VK_OEM_AX 0xE1 */
4844 0, /* VK_OEM_102 0xE2 */
4845 "ico-help", /* VK_ICO_HELP 0xE3 */
4846 "ico-00", /* VK_ICO_00 0xE4 */
4847 0, /* VK_PROCESSKEY 0xE5 - used by IME */
4848 "ico-clear", /* VK_ICO_CLEAR 0xE6 */
4849 0, /* VK_PACKET 0xE7 - used to pass Unicode chars */
4851 "reset", /* VK_OEM_RESET 0xE9 */
4852 "jump", /* VK_OEM_JUMP 0xEA */
4853 "oem-pa1", /* VK_OEM_PA1 0xEB */
4854 "oem-pa2", /* VK_OEM_PA2 0xEC */
4855 "oem-pa3", /* VK_OEM_PA3 0xED */
4856 "wsctrl", /* VK_OEM_WSCTRL 0xEE */
4857 "cusel", /* VK_OEM_CUSEL 0xEF */
4858 "oem-attn", /* VK_OEM_ATTN 0xF0 */
4859 "finish", /* VK_OEM_FINISH 0xF1 */
4860 "copy", /* VK_OEM_COPY 0xF2 */
4861 "auto", /* VK_OEM_AUTO 0xF3 */
4862 "enlw", /* VK_OEM_ENLW 0xF4 */
4863 "backtab", /* VK_OEM_BACKTAB 0xF5 */
4864 "attn", /* VK_ATTN 0xF6 */
4865 "crsel", /* VK_CRSEL 0xF7 */
4866 "exsel", /* VK_EXSEL 0xF8 */
4867 "ereof", /* VK_EREOF 0xF9 */
4868 "play", /* VK_PLAY 0xFA */
4869 "zoom", /* VK_ZOOM 0xFB */
4870 "noname", /* VK_NONAME 0xFC */
4871 "pa1", /* VK_PA1 0xFD */
4872 "oem_clear", /* VK_OEM_CLEAR 0xFE */
4876 /* Some of these duplicate the "Media keys" on newer keyboards,
4877 but they are delivered to the application in a different way. */
4878 static const char *const lispy_multimedia_keys
[] =
4886 "browser-favorites",
4923 "toggle-dictate-command",
4929 "media-fast-forward",
4932 "media-channel-down"
4935 #else /* not HAVE_NTGUI */
4937 /* This should be dealt with in XTread_socket now, and that doesn't
4938 depend on the client system having the Kana syms defined. See also
4939 the XK_kana_A case below. */
4942 static const char *const lispy_kana_keys
[] =
4944 /* X Keysym value */
4945 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x400 .. 0x40f */
4946 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x410 .. 0x41f */
4947 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x420 .. 0x42f */
4948 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x430 .. 0x43f */
4949 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x440 .. 0x44f */
4950 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x450 .. 0x45f */
4951 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x460 .. 0x46f */
4952 0,0,0,0,0,0,0,0,0,0,0,0,0,0,"overline",0,
4953 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x480 .. 0x48f */
4954 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x490 .. 0x49f */
4955 0, "kana-fullstop", "kana-openingbracket", "kana-closingbracket",
4956 "kana-comma", "kana-conjunctive", "kana-WO", "kana-a",
4957 "kana-i", "kana-u", "kana-e", "kana-o",
4958 "kana-ya", "kana-yu", "kana-yo", "kana-tsu",
4959 "prolongedsound", "kana-A", "kana-I", "kana-U",
4960 "kana-E", "kana-O", "kana-KA", "kana-KI",
4961 "kana-KU", "kana-KE", "kana-KO", "kana-SA",
4962 "kana-SHI", "kana-SU", "kana-SE", "kana-SO",
4963 "kana-TA", "kana-CHI", "kana-TSU", "kana-TE",
4964 "kana-TO", "kana-NA", "kana-NI", "kana-NU",
4965 "kana-NE", "kana-NO", "kana-HA", "kana-HI",
4966 "kana-FU", "kana-HE", "kana-HO", "kana-MA",
4967 "kana-MI", "kana-MU", "kana-ME", "kana-MO",
4968 "kana-YA", "kana-YU", "kana-YO", "kana-RA",
4969 "kana-RI", "kana-RU", "kana-RE", "kana-RO",
4970 "kana-WA", "kana-N", "voicedsound", "semivoicedsound",
4971 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4e0 .. 0x4ef */
4972 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4f0 .. 0x4ff */
4974 #endif /* XK_kana_A */
4977 #define FUNCTION_KEY_OFFSET 0xff00
4979 /* You'll notice that this table is arranged to be conveniently
4980 indexed by X Windows keysym values. */
4981 static const char *const lispy_function_keys
[] =
4983 /* X Keysym value */
4985 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff00...0f */
4986 "backspace", "tab", "linefeed", "clear",
4988 0, 0, 0, "pause", /* 0xff10...1f */
4989 0, 0, 0, 0, 0, 0, 0, "escape",
4991 0, "kanji", "muhenkan", "henkan", /* 0xff20...2f */
4992 "romaji", "hiragana", "katakana", "hiragana-katakana",
4993 "zenkaku", "hankaku", "zenkaku-hankaku", "touroku",
4994 "massyo", "kana-lock", "kana-shift", "eisu-shift",
4995 "eisu-toggle", /* 0xff30...3f */
4996 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4997 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff40...4f */
4999 "home", "left", "up", "right", /* 0xff50 */ /* IsCursorKey */
5000 "down", "prior", "next", "end",
5001 "begin", 0, 0, 0, 0, 0, 0, 0,
5002 "select", /* 0xff60 */ /* IsMiscFunctionKey */
5013 "break", /* 0xff6b */
5016 0, 0, 0, 0, "backtab", 0, 0, 0, /* 0xff70... */
5017 0, 0, 0, 0, 0, 0, 0, "kp-numlock", /* 0xff78... */
5018 "kp-space", /* 0xff80 */ /* IsKeypadKey */
5019 0, 0, 0, 0, 0, 0, 0, 0,
5020 "kp-tab", /* 0xff89 */
5022 "kp-enter", /* 0xff8d */
5024 "kp-f1", /* 0xff91 */
5028 "kp-home", /* 0xff95 */
5033 "kp-prior", /* kp-page-up */
5034 "kp-next", /* kp-page-down */
5040 0, 0, 0, 0, 0, 0, 0, 0, 0,
5041 "kp-multiply", /* 0xffaa */
5046 "kp-divide", /* 0xffaf */
5047 "kp-0", /* 0xffb0 */
5048 "kp-1", "kp-2", "kp-3", "kp-4", "kp-5", "kp-6", "kp-7", "kp-8", "kp-9",
5051 "kp-equal", /* 0xffbd */
5052 "f1", /* 0xffbe */ /* IsFunctionKey */
5054 "f3", "f4", "f5", "f6", "f7", "f8", "f9", "f10", /* 0xffc0 */
5055 "f11", "f12", "f13", "f14", "f15", "f16", "f17", "f18",
5056 "f19", "f20", "f21", "f22", "f23", "f24", "f25", "f26", /* 0xffd0 */
5057 "f27", "f28", "f29", "f30", "f31", "f32", "f33", "f34",
5058 "f35", 0, 0, 0, 0, 0, 0, 0, /* 0xffe0 */
5059 0, 0, 0, 0, 0, 0, 0, 0,
5060 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfff0 */
5061 0, 0, 0, 0, 0, 0, 0, "delete"
5064 /* ISO 9995 Function and Modifier Keys; the first byte is 0xFE. */
5065 #define ISO_FUNCTION_KEY_OFFSET 0xfe00
5067 static const char *const iso_lispy_function_keys
[] =
5069 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe00 */
5070 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe08 */
5071 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe10 */
5072 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe18 */
5073 "iso-lefttab", /* 0xfe20 */
5074 "iso-move-line-up", "iso-move-line-down",
5075 "iso-partial-line-up", "iso-partial-line-down",
5076 "iso-partial-space-left", "iso-partial-space-right",
5077 "iso-set-margin-left", "iso-set-margin-right", /* 0xffe27, 28 */
5078 "iso-release-margin-left", "iso-release-margin-right",
5079 "iso-release-both-margins",
5080 "iso-fast-cursor-left", "iso-fast-cursor-right",
5081 "iso-fast-cursor-up", "iso-fast-cursor-down",
5082 "iso-continuous-underline", "iso-discontinuous-underline", /* 0xfe30, 31 */
5083 "iso-emphasize", "iso-center-object", "iso-enter", /* ... 0xfe34 */
5086 #endif /* not HAVE_NTGUI */
5088 static Lisp_Object Vlispy_mouse_stem
;
5090 static const char *const lispy_wheel_names
[] =
5092 "wheel-up", "wheel-down", "wheel-left", "wheel-right"
5095 /* drag-n-drop events are generated when a set of selected files are
5096 dragged from another application and dropped onto an Emacs window. */
5097 static const char *const lispy_drag_n_drop_names
[] =
5102 /* An array of symbol indexes of scroll bar parts, indexed by an enum
5103 scroll_bar_part value. Note that Qnil corresponds to
5104 scroll_bar_nowhere and should not appear in Lisp events. */
5105 static short const scroll_bar_parts
[] = {
5106 SYMBOL_INDEX (Qnil
), SYMBOL_INDEX (Qabove_handle
), SYMBOL_INDEX (Qhandle
),
5107 SYMBOL_INDEX (Qbelow_handle
), SYMBOL_INDEX (Qup
), SYMBOL_INDEX (Qdown
),
5108 SYMBOL_INDEX (Qtop
), SYMBOL_INDEX (Qbottom
), SYMBOL_INDEX (Qend_scroll
),
5109 SYMBOL_INDEX (Qratio
), SYMBOL_INDEX (Qbefore_handle
),
5110 SYMBOL_INDEX (Qhorizontal_handle
), SYMBOL_INDEX (Qafter_handle
),
5111 SYMBOL_INDEX (Qleft
), SYMBOL_INDEX (Qright
), SYMBOL_INDEX (Qleftmost
),
5112 SYMBOL_INDEX (Qrightmost
), SYMBOL_INDEX (Qend_scroll
), SYMBOL_INDEX (Qratio
)
5115 /* A vector, indexed by button number, giving the down-going location
5116 of currently depressed buttons, both scroll bar and non-scroll bar.
5118 The elements have the form
5119 (BUTTON-NUMBER MODIFIER-MASK . REST)
5120 where REST is the cdr of a position as it would be reported in the event.
5122 The make_lispy_event function stores positions here to tell the
5123 difference between click and drag events, and to store the starting
5124 location to be included in drag events. */
5126 static Lisp_Object button_down_location
;
5128 /* Information about the most recent up-going button event: Which
5129 button, what location, and what time. */
5131 static int last_mouse_button
;
5132 static int last_mouse_x
;
5133 static int last_mouse_y
;
5134 static Time button_down_time
;
5136 /* The number of clicks in this multiple-click. */
5138 static int double_click_count
;
5140 /* X and Y are frame-relative coordinates for a click or wheel event.
5141 Return a Lisp-style event list. */
5144 make_lispy_position (struct frame
*f
, Lisp_Object x
, Lisp_Object y
,
5147 enum window_part part
;
5148 Lisp_Object posn
= Qnil
;
5149 Lisp_Object extra_info
= Qnil
;
5150 /* Coordinate pixel positions to return. */
5151 int xret
= 0, yret
= 0;
5152 /* The window under frame pixel coordinates (x,y) */
5153 Lisp_Object window
= f
5154 ? window_from_coordinates (f
, XINT (x
), XINT (y
), &part
, 0)
5157 if (WINDOWP (window
))
5159 /* It's a click in window WINDOW at frame coordinates (X,Y) */
5160 struct window
*w
= XWINDOW (window
);
5161 Lisp_Object string_info
= Qnil
;
5162 ptrdiff_t textpos
= 0;
5163 int col
= -1, row
= -1;
5164 int dx
= -1, dy
= -1;
5165 int width
= -1, height
= -1;
5166 Lisp_Object object
= Qnil
;
5168 /* Pixel coordinates relative to the window corner. */
5169 int wx
= XINT (x
) - WINDOW_LEFT_EDGE_X (w
);
5170 int wy
= XINT (y
) - WINDOW_TOP_EDGE_Y (w
);
5172 /* For text area clicks, return X, Y relative to the corner of
5173 this text area. Note that dX, dY etc are set below, by
5174 buffer_posn_from_coords. */
5175 if (part
== ON_TEXT
)
5177 xret
= XINT (x
) - window_box_left (w
, TEXT_AREA
);
5178 yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5180 /* For mode line and header line clicks, return X, Y relative to
5181 the left window edge. Use mode_line_string to look for a
5182 string on the click position. */
5183 else if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
)
5188 posn
= (part
== ON_MODE_LINE
) ? Qmode_line
: Qheader_line
;
5189 /* Note that mode_line_string takes COL, ROW as pixels and
5190 converts them to characters. */
5193 string
= mode_line_string (w
, part
, &col
, &row
, &charpos
,
5194 &object
, &dx
, &dy
, &width
, &height
);
5195 if (STRINGP (string
))
5196 string_info
= Fcons (string
, make_number (charpos
));
5202 /* For fringes and margins, Y is relative to the area's (and the
5203 window's) top edge, while X is meaningless. */
5204 else if (part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
5209 posn
= (part
== ON_LEFT_MARGIN
) ? Qleft_margin
: Qright_margin
;
5212 string
= marginal_area_string (w
, part
, &col
, &row
, &charpos
,
5213 &object
, &dx
, &dy
, &width
, &height
);
5214 if (STRINGP (string
))
5215 string_info
= Fcons (string
, make_number (charpos
));
5217 yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5219 else if (part
== ON_LEFT_FRINGE
)
5221 posn
= Qleft_fringe
;
5225 - (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5226 ? 0 : window_box_width (w
, LEFT_MARGIN_AREA
));
5227 dy
= yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5229 else if (part
== ON_RIGHT_FRINGE
)
5231 posn
= Qright_fringe
;
5235 - window_box_width (w
, LEFT_MARGIN_AREA
)
5236 - window_box_width (w
, TEXT_AREA
)
5237 - (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5238 ? window_box_width (w
, RIGHT_MARGIN_AREA
)
5240 dy
= yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5242 else if (part
== ON_VERTICAL_BORDER
)
5244 posn
= Qvertical_line
;
5250 else if (part
== ON_VERTICAL_SCROLL_BAR
)
5252 posn
= Qvertical_scroll_bar
;
5253 width
= WINDOW_SCROLL_BAR_AREA_WIDTH (w
);
5257 else if (part
== ON_HORIZONTAL_SCROLL_BAR
)
5259 posn
= Qhorizontal_scroll_bar
;
5260 width
= WINDOW_SCROLL_BAR_AREA_HEIGHT (w
);
5264 else if (part
== ON_RIGHT_DIVIDER
)
5266 posn
= Qright_divider
;
5267 width
= WINDOW_RIGHT_DIVIDER_WIDTH (w
);
5271 else if (part
== ON_BOTTOM_DIVIDER
)
5273 posn
= Qbottom_divider
;
5274 width
= WINDOW_BOTTOM_DIVIDER_WIDTH (w
);
5279 /* For clicks in the text area, fringes, margins, or vertical
5280 scroll bar, call buffer_posn_from_coords to extract TEXTPOS,
5281 the buffer position nearest to the click. */
5284 Lisp_Object string2
, object2
= Qnil
;
5285 struct display_pos p
;
5287 int width2
, height2
;
5288 /* The pixel X coordinate passed to buffer_posn_from_coords
5289 is the X coordinate relative to the text area for clicks
5290 in text-area, right-margin/fringe and right-side vertical
5291 scroll bar, zero otherwise. */
5293 = (part
== ON_TEXT
) ? xret
5294 : (part
== ON_RIGHT_FRINGE
|| part
== ON_RIGHT_MARGIN
5295 || (part
== ON_VERTICAL_SCROLL_BAR
5296 && WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_RIGHT (w
)))
5297 ? (XINT (x
) - window_box_left (w
, TEXT_AREA
))
5301 string2
= buffer_posn_from_coords (w
, &x2
, &y2
, &p
,
5302 &object2
, &dx2
, &dy2
,
5304 textpos
= CHARPOS (p
.pos
);
5305 if (col
< 0) col
= x2
;
5306 if (row
< 0) row
= y2
;
5307 if (dx
< 0) dx
= dx2
;
5308 if (dy
< 0) dy
= dy2
;
5309 if (width
< 0) width
= width2
;
5310 if (height
< 0) height
= height2
;
5314 posn
= make_number (textpos
);
5315 if (STRINGP (string2
))
5316 string_info
= Fcons (string2
,
5317 make_number (CHARPOS (p
.string_pos
)));
5323 #ifdef HAVE_WINDOW_SYSTEM
5324 if (IMAGEP (object
))
5326 Lisp_Object image_map
, hotspot
;
5327 if ((image_map
= Fplist_get (XCDR (object
), QCmap
),
5329 && (hotspot
= find_hot_spot (image_map
, dx
, dy
),
5331 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
5332 posn
= XCAR (hotspot
);
5339 Fcons (make_number (dx
), make_number (dy
)),
5340 Fcons (make_number (width
), make_number (height
)));
5343 extra_info
= Fcons (string_info
,
5344 Fcons (textpos
< 0 ? Qnil
: make_number (textpos
),
5345 Fcons (Fcons (make_number (col
),
5351 /* Return mouse pixel coordinates here. */
5352 XSETFRAME (window
, f
);
5359 return Fcons (window
,
5361 Fcons (Fcons (make_number (xret
),
5362 make_number (yret
)),
5363 Fcons (make_number (t
),
5367 /* Return non-zero if F is a GUI frame that uses some toolkit-managed
5368 menu bar. This really means that Emacs draws and manages the menu
5369 bar as part of its normal display, and therefore can compute its
5372 toolkit_menubar_in_use (struct frame
*f
)
5374 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS) || defined (HAVE_NTGUI)
5375 return !(!FRAME_WINDOW_P (f
));
5381 /* Build the part of Lisp event which represents scroll bar state from
5382 EV. TYPE is one of Qvertical_scroll_bar or Qhorizontal_scroll_bar. */
5385 make_scroll_bar_position (struct input_event
*ev
, Lisp_Object type
)
5387 return list5 (ev
->frame_or_window
, type
, Fcons (ev
->x
, ev
->y
),
5388 make_number (ev
->timestamp
),
5389 builtin_lisp_symbol (scroll_bar_parts
[ev
->part
]));
5392 /* Given a struct input_event, build the lisp event which represents
5393 it. If EVENT is 0, build a mouse movement event from the mouse
5394 movement buffer, which should have a movement event in it.
5396 Note that events must be passed to this function in the order they
5397 are received; this function stores the location of button presses
5398 in order to build drag events when the button is released. */
5401 make_lispy_event (struct input_event
*event
)
5405 switch (event
->kind
)
5407 /* A simple keystroke. */
5408 case ASCII_KEYSTROKE_EVENT
:
5409 case MULTIBYTE_CHAR_KEYSTROKE_EVENT
:
5411 Lisp_Object lispy_c
;
5412 EMACS_INT c
= event
->code
;
5413 if (event
->kind
== ASCII_KEYSTROKE_EVENT
)
5416 eassert (c
== event
->code
);
5419 /* Caps-lock shouldn't affect interpretation of key chords:
5420 Control+s should produce C-s whether caps-lock is on or
5421 not. And Control+Shift+s should produce C-S-s whether
5422 caps-lock is on or not. */
5423 if (event
->modifiers
& ~shift_modifier
)
5425 /* This is a key chord: some non-shift modifier is
5428 if (uppercasep (c
) &&
5429 !(event
->modifiers
& shift_modifier
))
5431 /* Got a capital letter without a shift. The caps
5432 lock is on. Un-capitalize the letter. */
5435 else if (lowercasep (c
) &&
5436 (event
->modifiers
& shift_modifier
))
5438 /* Got a lower-case letter even though shift is
5439 depressed. The caps lock is on. Capitalize the
5445 if (event
->kind
== ASCII_KEYSTROKE_EVENT
)
5447 /* Turn ASCII characters into control characters
5449 if (event
->modifiers
& ctrl_modifier
)
5451 c
= make_ctrl_char (c
);
5452 event
->modifiers
&= ~ctrl_modifier
;
5456 /* Add in the other modifier bits. The shift key was taken care
5457 of by the X code. */
5458 c
|= (event
->modifiers
5459 & (meta_modifier
| alt_modifier
5460 | hyper_modifier
| super_modifier
| ctrl_modifier
));
5461 /* Distinguish Shift-SPC from SPC. */
5462 if ((event
->code
) == 040
5463 && event
->modifiers
& shift_modifier
)
5464 c
|= shift_modifier
;
5465 button_down_time
= 0;
5466 XSETFASTINT (lispy_c
, c
);
5471 /* NS_NONKEY_EVENTs are just like NON_ASCII_KEYSTROKE_EVENTs,
5472 except that they are non-key events (last-nonmenu-event is nil). */
5473 case NS_NONKEY_EVENT
:
5476 /* A function key. The symbol may need to have modifier prefixes
5478 case NON_ASCII_KEYSTROKE_EVENT
:
5479 button_down_time
= 0;
5481 for (i
= 0; i
< ARRAYELTS (lispy_accent_codes
); i
++)
5482 if (event
->code
== lispy_accent_codes
[i
])
5483 return modify_event_symbol (i
,
5485 Qfunction_key
, Qnil
,
5486 lispy_accent_keys
, &accent_key_syms
,
5487 ARRAYELTS (lispy_accent_keys
));
5491 if (event
->code
>= 0x400 && event
->code
< 0x500)
5492 return modify_event_symbol (event
->code
- 0x400,
5493 event
->modifiers
& ~shift_modifier
,
5494 Qfunction_key
, Qnil
,
5495 lispy_kana_keys
, &func_key_syms
,
5496 ARRAYELTS (lispy_kana_keys
));
5497 #endif /* XK_kana_A */
5500 #ifdef ISO_FUNCTION_KEY_OFFSET
5501 if (event
->code
< FUNCTION_KEY_OFFSET
5502 && event
->code
>= ISO_FUNCTION_KEY_OFFSET
)
5503 return modify_event_symbol (event
->code
- ISO_FUNCTION_KEY_OFFSET
,
5505 Qfunction_key
, Qnil
,
5506 iso_lispy_function_keys
, &func_key_syms
,
5507 ARRAYELTS (iso_lispy_function_keys
));
5510 if ((FUNCTION_KEY_OFFSET
<= event
->code
5512 < FUNCTION_KEY_OFFSET
+ ARRAYELTS (lispy_function_keys
)))
5513 && lispy_function_keys
[event
->code
- FUNCTION_KEY_OFFSET
])
5514 return modify_event_symbol (event
->code
- FUNCTION_KEY_OFFSET
,
5516 Qfunction_key
, Qnil
,
5517 lispy_function_keys
, &func_key_syms
,
5518 ARRAYELTS (lispy_function_keys
));
5520 /* Handle system-specific or unknown keysyms.
5521 We need to use an alist rather than a vector as the cache
5522 since we can't make a vector long enough. */
5523 if (NILP (KVAR (current_kboard
, system_key_syms
)))
5524 kset_system_key_syms (current_kboard
, Fcons (Qnil
, Qnil
));
5525 return modify_event_symbol (event
->code
,
5528 KVAR (current_kboard
, Vsystem_key_alist
),
5529 0, &KVAR (current_kboard
, system_key_syms
),
5533 case MULTIMEDIA_KEY_EVENT
:
5534 if (event
->code
< ARRAYELTS (lispy_multimedia_keys
)
5535 && event
->code
> 0 && lispy_multimedia_keys
[event
->code
])
5537 return modify_event_symbol (event
->code
, event
->modifiers
,
5538 Qfunction_key
, Qnil
,
5539 lispy_multimedia_keys
, &func_key_syms
,
5540 ARRAYELTS (lispy_multimedia_keys
));
5545 /* A mouse click. Figure out where it is, decide whether it's
5546 a press, click or drag, and build the appropriate structure. */
5547 case MOUSE_CLICK_EVENT
:
5549 case GPM_CLICK_EVENT
:
5551 #ifndef USE_TOOLKIT_SCROLL_BARS
5552 case SCROLL_BAR_CLICK_EVENT
:
5553 case HORIZONTAL_SCROLL_BAR_CLICK_EVENT
:
5556 int button
= event
->code
;
5558 Lisp_Object position
;
5559 Lisp_Object
*start_pos_ptr
;
5560 Lisp_Object start_pos
;
5564 /* Build the position as appropriate for this mouse click. */
5565 if (event
->kind
== MOUSE_CLICK_EVENT
5567 || event
->kind
== GPM_CLICK_EVENT
5571 struct frame
*f
= XFRAME (event
->frame_or_window
);
5574 /* Ignore mouse events that were made on frame that
5575 have been deleted. */
5576 if (! FRAME_LIVE_P (f
))
5579 /* EVENT->x and EVENT->y are frame-relative pixel
5580 coordinates at this place. Under old redisplay, COLUMN
5581 and ROW are set to frame relative glyph coordinates
5582 which are then used to determine whether this click is
5583 in a menu (non-toolkit version). */
5584 if (!toolkit_menubar_in_use (f
))
5586 pixel_to_glyph_coords (f
, XINT (event
->x
), XINT (event
->y
),
5587 &column
, &row
, NULL
, 1);
5589 /* In the non-toolkit version, clicks on the menu bar
5590 are ordinary button events in the event buffer.
5591 Distinguish them, and invoke the menu.
5593 (In the toolkit version, the toolkit handles the
5594 menu bar and Emacs doesn't know about it until
5595 after the user makes a selection.) */
5596 if (row
>= 0 && row
< FRAME_MENU_BAR_LINES (f
)
5597 && (event
->modifiers
& down_modifier
))
5599 Lisp_Object items
, item
;
5601 /* Find the menu bar item under `column'. */
5603 items
= FRAME_MENU_BAR_ITEMS (f
);
5604 for (i
= 0; i
< ASIZE (items
); i
+= 4)
5606 Lisp_Object pos
, string
;
5607 string
= AREF (items
, i
+ 1);
5608 pos
= AREF (items
, i
+ 3);
5611 if (column
>= XINT (pos
)
5612 && column
< XINT (pos
) + SCHARS (string
))
5614 item
= AREF (items
, i
);
5619 /* ELisp manual 2.4b says (x y) are window
5620 relative but code says they are
5622 position
= list4 (event
->frame_or_window
,
5624 Fcons (event
->x
, event
->y
),
5625 make_number (event
->timestamp
));
5627 return list2 (item
, position
);
5631 position
= make_lispy_position (f
, event
->x
, event
->y
,
5634 #ifndef USE_TOOLKIT_SCROLL_BARS
5636 /* It's a scrollbar click. */
5637 position
= make_scroll_bar_position (event
, Qvertical_scroll_bar
);
5638 #endif /* not USE_TOOLKIT_SCROLL_BARS */
5640 if (button
>= ASIZE (button_down_location
))
5642 ptrdiff_t incr
= button
- ASIZE (button_down_location
) + 1;
5643 button_down_location
= larger_vector (button_down_location
,
5645 mouse_syms
= larger_vector (mouse_syms
, incr
, -1);
5648 start_pos_ptr
= aref_addr (button_down_location
, button
);
5649 start_pos
= *start_pos_ptr
;
5650 *start_pos_ptr
= Qnil
;
5653 /* On window-system frames, use the value of
5654 double-click-fuzz as is. On other frames, interpret it
5655 as a multiple of 1/8 characters. */
5659 if (WINDOWP (event
->frame_or_window
))
5660 f
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5661 else if (FRAMEP (event
->frame_or_window
))
5662 f
= XFRAME (event
->frame_or_window
);
5666 if (FRAME_WINDOW_P (f
))
5667 fuzz
= double_click_fuzz
;
5669 fuzz
= double_click_fuzz
/ 8;
5671 is_double
= (button
== last_mouse_button
5672 && (eabs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5673 && (eabs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5674 && button_down_time
!= 0
5675 && (EQ (Vdouble_click_time
, Qt
)
5676 || (NATNUMP (Vdouble_click_time
)
5677 && (event
->timestamp
- button_down_time
5678 < XFASTINT (Vdouble_click_time
)))));
5681 last_mouse_button
= button
;
5682 last_mouse_x
= XINT (event
->x
);
5683 last_mouse_y
= XINT (event
->y
);
5685 /* If this is a button press, squirrel away the location, so
5686 we can decide later whether it was a click or a drag. */
5687 if (event
->modifiers
& down_modifier
)
5691 double_click_count
++;
5692 event
->modifiers
|= ((double_click_count
> 2)
5697 double_click_count
= 1;
5698 button_down_time
= event
->timestamp
;
5699 *start_pos_ptr
= Fcopy_alist (position
);
5700 ignore_mouse_drag_p
= 0;
5703 /* Now we're releasing a button - check the co-ordinates to
5704 see if this was a click or a drag. */
5705 else if (event
->modifiers
& up_modifier
)
5707 /* If we did not see a down before this up, ignore the up.
5708 Probably this happened because the down event chose a
5709 menu item. It would be an annoyance to treat the
5710 release of the button that chose the menu item as a
5713 if (!CONSP (start_pos
))
5716 event
->modifiers
&= ~up_modifier
;
5719 Lisp_Object new_down
, down
;
5720 EMACS_INT xdiff
= double_click_fuzz
, ydiff
= double_click_fuzz
;
5722 /* The third element of every position
5723 should be the (x,y) pair. */
5724 down
= Fcar (Fcdr (Fcdr (start_pos
)));
5725 new_down
= Fcar (Fcdr (Fcdr (position
)));
5728 && INTEGERP (XCAR (down
)) && INTEGERP (XCDR (down
)))
5730 xdiff
= XINT (XCAR (new_down
)) - XINT (XCAR (down
));
5731 ydiff
= XINT (XCDR (new_down
)) - XINT (XCDR (down
));
5734 if (ignore_mouse_drag_p
)
5736 event
->modifiers
|= click_modifier
;
5737 ignore_mouse_drag_p
= 0;
5739 else if (xdiff
< double_click_fuzz
&& xdiff
> - double_click_fuzz
5740 && ydiff
< double_click_fuzz
&& ydiff
> - double_click_fuzz
5741 /* Maybe the mouse has moved a lot, caused scrolling, and
5742 eventually ended up at the same screen position (but
5743 not buffer position) in which case it is a drag, not
5745 /* FIXME: OTOH if the buffer position has changed
5746 because of a timer or process filter rather than
5747 because of mouse movement, it should be considered as
5748 a click. But mouse-drag-region completely ignores
5749 this case and it hasn't caused any real problem, so
5750 it's probably OK to ignore it as well. */
5751 && EQ (Fcar (Fcdr (start_pos
)), Fcar (Fcdr (position
))))
5752 /* Mouse hasn't moved (much). */
5753 event
->modifiers
|= click_modifier
;
5756 button_down_time
= 0;
5757 event
->modifiers
|= drag_modifier
;
5760 /* Don't check is_double; treat this as multiple
5761 if the down-event was multiple. */
5762 if (double_click_count
> 1)
5763 event
->modifiers
|= ((double_click_count
> 2)
5769 /* Every mouse event should either have the down_modifier or
5770 the up_modifier set. */
5774 /* Get the symbol we should use for the mouse click. */
5777 head
= modify_event_symbol (button
,
5779 Qmouse_click
, Vlispy_mouse_stem
,
5782 ASIZE (mouse_syms
));
5783 if (event
->modifiers
& drag_modifier
)
5784 return list3 (head
, start_pos
, position
);
5785 else if (event
->modifiers
& (double_modifier
| triple_modifier
))
5786 return list3 (head
, position
, make_number (double_click_count
));
5788 return list2 (head
, position
);
5793 case HORIZ_WHEEL_EVENT
:
5795 Lisp_Object position
;
5798 /* Build the position as appropriate for this mouse click. */
5799 struct frame
*f
= XFRAME (event
->frame_or_window
);
5801 /* Ignore wheel events that were made on frame that have been
5803 if (! FRAME_LIVE_P (f
))
5806 position
= make_lispy_position (f
, event
->x
, event
->y
,
5809 /* Set double or triple modifiers to indicate the wheel speed. */
5811 /* On window-system frames, use the value of
5812 double-click-fuzz as is. On other frames, interpret it
5813 as a multiple of 1/8 characters. */
5819 if (WINDOWP (event
->frame_or_window
))
5820 fr
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5821 else if (FRAMEP (event
->frame_or_window
))
5822 fr
= XFRAME (event
->frame_or_window
);
5826 fuzz
= FRAME_WINDOW_P (fr
)
5827 ? double_click_fuzz
: double_click_fuzz
/ 8;
5829 if (event
->modifiers
& up_modifier
)
5831 /* Emit a wheel-up event. */
5832 event
->modifiers
&= ~up_modifier
;
5835 else if (event
->modifiers
& down_modifier
)
5837 /* Emit a wheel-down event. */
5838 event
->modifiers
&= ~down_modifier
;
5842 /* Every wheel event should either have the down_modifier or
5843 the up_modifier set. */
5846 if (event
->kind
== HORIZ_WHEEL_EVENT
)
5849 is_double
= (last_mouse_button
== - (1 + symbol_num
)
5850 && (eabs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5851 && (eabs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5852 && button_down_time
!= 0
5853 && (EQ (Vdouble_click_time
, Qt
)
5854 || (NATNUMP (Vdouble_click_time
)
5855 && (event
->timestamp
- button_down_time
5856 < XFASTINT (Vdouble_click_time
)))));
5859 double_click_count
++;
5860 event
->modifiers
|= ((double_click_count
> 2)
5866 double_click_count
= 1;
5867 event
->modifiers
|= click_modifier
;
5870 button_down_time
= event
->timestamp
;
5871 /* Use a negative value to distinguish wheel from mouse button. */
5872 last_mouse_button
= - (1 + symbol_num
);
5873 last_mouse_x
= XINT (event
->x
);
5874 last_mouse_y
= XINT (event
->y
);
5876 /* Get the symbol we should use for the wheel event. */
5877 head
= modify_event_symbol (symbol_num
,
5883 ASIZE (wheel_syms
));
5886 if (event
->modifiers
& (double_modifier
| triple_modifier
))
5887 return list3 (head
, position
, make_number (double_click_count
));
5889 return list2 (head
, position
);
5893 #ifdef USE_TOOLKIT_SCROLL_BARS
5895 /* We don't have down and up events if using toolkit scroll bars,
5896 so make this always a click event. Store in the `part' of
5897 the Lisp event a symbol which maps to the following actions:
5899 `above_handle' page up
5900 `below_handle' page down
5904 `bottom' bottom of buffer
5905 `handle' thumb has been dragged.
5906 `end-scroll' end of interaction with scroll bar
5908 The incoming input_event contains in its `part' member an
5909 index of type `enum scroll_bar_part' which we can use as an
5910 index in scroll_bar_parts to get the appropriate symbol. */
5912 case SCROLL_BAR_CLICK_EVENT
:
5914 Lisp_Object position
, head
;
5916 position
= make_scroll_bar_position (event
, Qvertical_scroll_bar
);
5918 /* Always treat scroll bar events as clicks. */
5919 event
->modifiers
|= click_modifier
;
5920 event
->modifiers
&= ~up_modifier
;
5922 if (event
->code
>= ASIZE (mouse_syms
))
5923 mouse_syms
= larger_vector (mouse_syms
,
5924 event
->code
- ASIZE (mouse_syms
) + 1,
5927 /* Get the symbol we should use for the mouse click. */
5928 head
= modify_event_symbol (event
->code
,
5933 ASIZE (mouse_syms
));
5934 return list2 (head
, position
);
5937 case HORIZONTAL_SCROLL_BAR_CLICK_EVENT
:
5939 Lisp_Object position
, head
;
5941 position
= make_scroll_bar_position (event
, Qhorizontal_scroll_bar
);
5943 /* Always treat scroll bar events as clicks. */
5944 event
->modifiers
|= click_modifier
;
5945 event
->modifiers
&= ~up_modifier
;
5947 if (event
->code
>= ASIZE (mouse_syms
))
5948 mouse_syms
= larger_vector (mouse_syms
,
5949 event
->code
- ASIZE (mouse_syms
) + 1,
5952 /* Get the symbol we should use for the mouse click. */
5953 head
= modify_event_symbol (event
->code
,
5958 ASIZE (mouse_syms
));
5959 return list2 (head
, position
);
5962 #endif /* USE_TOOLKIT_SCROLL_BARS */
5964 case DRAG_N_DROP_EVENT
:
5967 Lisp_Object head
, position
;
5970 f
= XFRAME (event
->frame_or_window
);
5973 /* Ignore mouse events that were made on frames that
5974 have been deleted. */
5975 if (! FRAME_LIVE_P (f
))
5978 position
= make_lispy_position (f
, event
->x
, event
->y
,
5981 head
= modify_event_symbol (0, event
->modifiers
,
5983 lispy_drag_n_drop_names
,
5984 &drag_n_drop_syms
, 1);
5985 return list3 (head
, position
, files
);
5988 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
5989 || defined (HAVE_NS) || defined (USE_GTK)
5990 case MENU_BAR_EVENT
:
5991 if (EQ (event
->arg
, event
->frame_or_window
))
5992 /* This is the prefix key. We translate this to
5993 `(menu_bar)' because the code in keyboard.c for menu
5994 events, which we use, relies on this. */
5995 return list1 (Qmenu_bar
);
5999 case SELECT_WINDOW_EVENT
:
6000 /* Make an event (select-window (WINDOW)). */
6001 return list2 (Qselect_window
, list1 (event
->frame_or_window
));
6003 case TOOL_BAR_EVENT
:
6004 if (EQ (event
->arg
, event
->frame_or_window
))
6005 /* This is the prefix key. We translate this to
6006 `(tool_bar)' because the code in keyboard.c for tool bar
6007 events, which we use, relies on this. */
6008 return list1 (Qtool_bar
);
6009 else if (SYMBOLP (event
->arg
))
6010 return apply_modifiers (event
->modifiers
, event
->arg
);
6013 case USER_SIGNAL_EVENT
:
6014 /* A user signal. */
6016 char *name
= find_user_signal_name (event
->code
);
6019 return intern (name
);
6022 case SAVE_SESSION_EVENT
:
6023 return Qsave_session
;
6028 return Fcons (Qdbus_event
, event
->arg
);
6030 #endif /* HAVE_DBUS */
6032 #ifdef HAVE_XWIDGETS
6035 return Fcons (Qxwidget_event
, event
->arg
);
6039 #if defined HAVE_INOTIFY || defined HAVE_KQUEUE || defined HAVE_GFILENOTIFY
6040 case FILE_NOTIFY_EVENT
:
6042 return Fcons (Qfile_notify
, event
->arg
);
6044 #endif /* HAVE_INOTIFY || HAVE_KQUEUE || HAVE_GFILENOTIFY */
6046 case CONFIG_CHANGED_EVENT
:
6047 return list3 (Qconfig_changed_event
,
6048 event
->arg
, event
->frame_or_window
);
6050 /* The 'kind' field of the event is something we don't recognize. */
6057 make_lispy_movement (struct frame
*frame
, Lisp_Object bar_window
, enum scroll_bar_part part
,
6058 Lisp_Object x
, Lisp_Object y
, Time t
)
6060 /* Is it a scroll bar movement? */
6061 if (frame
&& ! NILP (bar_window
))
6063 Lisp_Object part_sym
;
6065 part_sym
= builtin_lisp_symbol (scroll_bar_parts
[part
]);
6066 return list2 (Qscroll_bar_movement
,
6068 Qvertical_scroll_bar
,
6073 /* Or is it an ordinary mouse movement? */
6076 Lisp_Object position
;
6077 position
= make_lispy_position (frame
, x
, y
, t
);
6078 return list2 (Qmouse_movement
, position
);
6082 /* Construct a switch frame event. */
6084 make_lispy_switch_frame (Lisp_Object frame
)
6086 return list2 (Qswitch_frame
, frame
);
6090 make_lispy_focus_in (Lisp_Object frame
)
6092 return list2 (Qfocus_in
, frame
);
6095 #ifdef HAVE_WINDOW_SYSTEM
6098 make_lispy_focus_out (Lisp_Object frame
)
6100 return list2 (Qfocus_out
, frame
);
6103 #endif /* HAVE_WINDOW_SYSTEM */
6105 /* Manipulating modifiers. */
6107 /* Parse the name of SYMBOL, and return the set of modifiers it contains.
6109 If MODIFIER_END is non-zero, set *MODIFIER_END to the position in
6110 SYMBOL's name of the end of the modifiers; the string from this
6111 position is the unmodified symbol name.
6113 This doesn't use any caches. */
6116 parse_modifiers_uncached (Lisp_Object symbol
, ptrdiff_t *modifier_end
)
6122 CHECK_SYMBOL (symbol
);
6125 name
= SYMBOL_NAME (symbol
);
6127 for (i
= 0; i
< SBYTES (name
) - 1; )
6129 ptrdiff_t this_mod_end
= 0;
6132 /* See if the name continues with a modifier word.
6133 Check that the word appears, but don't check what follows it.
6134 Set this_mod and this_mod_end to record what we find. */
6136 switch (SREF (name
, i
))
6138 #define SINGLE_LETTER_MOD(BIT) \
6139 (this_mod_end = i + 1, this_mod = BIT)
6142 SINGLE_LETTER_MOD (alt_modifier
);
6146 SINGLE_LETTER_MOD (ctrl_modifier
);
6150 SINGLE_LETTER_MOD (hyper_modifier
);
6154 SINGLE_LETTER_MOD (meta_modifier
);
6158 SINGLE_LETTER_MOD (shift_modifier
);
6162 SINGLE_LETTER_MOD (super_modifier
);
6165 #undef SINGLE_LETTER_MOD
6167 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6168 if (i + LEN + 1 <= SBYTES (name) \
6169 && ! memcmp (SDATA (name) + i, NAME, LEN)) \
6171 this_mod_end = i + LEN; \
6176 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
6177 MULTI_LETTER_MOD (down_modifier
, "down", 4);
6178 MULTI_LETTER_MOD (double_modifier
, "double", 6);
6182 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
6186 MULTI_LETTER_MOD (up_modifier
, "up", 2);
6188 #undef MULTI_LETTER_MOD
6192 /* If we found no modifier, stop looking for them. */
6193 if (this_mod_end
== 0)
6196 /* Check there is a dash after the modifier, so that it
6197 really is a modifier. */
6198 if (this_mod_end
>= SBYTES (name
)
6199 || SREF (name
, this_mod_end
) != '-')
6202 /* This modifier is real; look for another. */
6203 modifiers
|= this_mod
;
6204 i
= this_mod_end
+ 1;
6207 /* Should we include the `click' modifier? */
6208 if (! (modifiers
& (down_modifier
| drag_modifier
6209 | double_modifier
| triple_modifier
))
6210 && i
+ 7 == SBYTES (name
)
6211 && memcmp (SDATA (name
) + i
, "mouse-", 6) == 0
6212 && ('0' <= SREF (name
, i
+ 6) && SREF (name
, i
+ 6) <= '9'))
6213 modifiers
|= click_modifier
;
6215 if (! (modifiers
& (double_modifier
| triple_modifier
))
6216 && i
+ 6 < SBYTES (name
)
6217 && memcmp (SDATA (name
) + i
, "wheel-", 6) == 0)
6218 modifiers
|= click_modifier
;
6226 /* Return a symbol whose name is the modifier prefixes for MODIFIERS
6227 prepended to the string BASE[0..BASE_LEN-1].
6228 This doesn't use any caches. */
6230 apply_modifiers_uncached (int modifiers
, char *base
, int base_len
, int base_len_byte
)
6232 /* Since BASE could contain nulls, we can't use intern here; we have
6233 to use Fintern, which expects a genuine Lisp_String, and keeps a
6235 char new_mods
[sizeof "A-C-H-M-S-s-up-down-drag-double-triple-"];
6241 /* Mouse events should not exhibit the `up' modifier once they
6242 leave the event queue only accessible to C code; `up' will
6243 always be turned into a click or drag event before being
6244 presented to lisp code. But since lisp events can be
6245 synthesized bypassing the event queue and pushed into
6246 `unread-command-events' or its companions, it's better to just
6247 deal with unexpected modifier combinations. */
6249 if (modifiers
& alt_modifier
) { *p
++ = 'A'; *p
++ = '-'; }
6250 if (modifiers
& ctrl_modifier
) { *p
++ = 'C'; *p
++ = '-'; }
6251 if (modifiers
& hyper_modifier
) { *p
++ = 'H'; *p
++ = '-'; }
6252 if (modifiers
& meta_modifier
) { *p
++ = 'M'; *p
++ = '-'; }
6253 if (modifiers
& shift_modifier
) { *p
++ = 'S'; *p
++ = '-'; }
6254 if (modifiers
& super_modifier
) { *p
++ = 's'; *p
++ = '-'; }
6255 if (modifiers
& double_modifier
) p
= stpcpy (p
, "double-");
6256 if (modifiers
& triple_modifier
) p
= stpcpy (p
, "triple-");
6257 if (modifiers
& up_modifier
) p
= stpcpy (p
, "up-");
6258 if (modifiers
& down_modifier
) p
= stpcpy (p
, "down-");
6259 if (modifiers
& drag_modifier
) p
= stpcpy (p
, "drag-");
6260 /* The click modifier is denoted by the absence of other modifiers. */
6264 mod_len
= p
- new_mods
;
6268 Lisp_Object new_name
;
6270 new_name
= make_uninit_multibyte_string (mod_len
+ base_len
,
6271 mod_len
+ base_len_byte
);
6272 memcpy (SDATA (new_name
), new_mods
, mod_len
);
6273 memcpy (SDATA (new_name
) + mod_len
, base
, base_len_byte
);
6275 return Fintern (new_name
, Qnil
);
6280 static const char *const modifier_names
[] =
6282 "up", "down", "drag", "click", "double", "triple", 0, 0,
6283 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
6284 0, 0, "alt", "super", "hyper", "shift", "control", "meta"
6286 #define NUM_MOD_NAMES ARRAYELTS (modifier_names)
6288 static Lisp_Object modifier_symbols
;
6290 /* Return the list of modifier symbols corresponding to the mask MODIFIERS. */
6292 lispy_modifier_list (int modifiers
)
6294 Lisp_Object modifier_list
;
6297 modifier_list
= Qnil
;
6298 for (i
= 0; (1<<i
) <= modifiers
&& i
< NUM_MOD_NAMES
; i
++)
6299 if (modifiers
& (1<<i
))
6300 modifier_list
= Fcons (AREF (modifier_symbols
, i
),
6303 return modifier_list
;
6307 /* Parse the modifiers on SYMBOL, and return a list like (UNMODIFIED MASK),
6308 where UNMODIFIED is the unmodified form of SYMBOL,
6309 MASK is the set of modifiers present in SYMBOL's name.
6310 This is similar to parse_modifiers_uncached, but uses the cache in
6311 SYMBOL's Qevent_symbol_element_mask property, and maintains the
6312 Qevent_symbol_elements property. */
6314 #define KEY_TO_CHAR(k) (XINT (k) & ((1 << CHARACTERBITS) - 1))
6317 parse_modifiers (Lisp_Object symbol
)
6319 Lisp_Object elements
;
6321 if (INTEGERP (symbol
))
6322 return list2i (KEY_TO_CHAR (symbol
), XINT (symbol
) & CHAR_MODIFIER_MASK
);
6323 else if (!SYMBOLP (symbol
))
6326 elements
= Fget (symbol
, Qevent_symbol_element_mask
);
6327 if (CONSP (elements
))
6332 int modifiers
= parse_modifiers_uncached (symbol
, &end
);
6333 Lisp_Object unmodified
;
6336 unmodified
= Fintern (make_string (SSDATA (SYMBOL_NAME (symbol
)) + end
,
6337 SBYTES (SYMBOL_NAME (symbol
)) - end
),
6340 if (modifiers
& ~INTMASK
)
6342 XSETFASTINT (mask
, modifiers
);
6343 elements
= list2 (unmodified
, mask
);
6345 /* Cache the parsing results on SYMBOL. */
6346 Fput (symbol
, Qevent_symbol_element_mask
,
6348 Fput (symbol
, Qevent_symbol_elements
,
6349 Fcons (unmodified
, lispy_modifier_list (modifiers
)));
6351 /* Since we know that SYMBOL is modifiers applied to unmodified,
6352 it would be nice to put that in unmodified's cache.
6353 But we can't, since we're not sure that parse_modifiers is
6360 DEFUN ("internal-event-symbol-parse-modifiers", Fevent_symbol_parse_modifiers
,
6361 Sevent_symbol_parse_modifiers
, 1, 1, 0,
6362 doc
: /* Parse the event symbol. For internal use. */)
6363 (Lisp_Object symbol
)
6365 /* Fill the cache if needed. */
6366 parse_modifiers (symbol
);
6367 /* Ignore the result (which is stored on Qevent_symbol_element_mask)
6368 and use the Lispier representation stored on Qevent_symbol_elements
6370 return Fget (symbol
, Qevent_symbol_elements
);
6373 /* Apply the modifiers MODIFIERS to the symbol BASE.
6374 BASE must be unmodified.
6376 This is like apply_modifiers_uncached, but uses BASE's
6377 Qmodifier_cache property, if present.
6379 apply_modifiers copies the value of BASE's Qevent_kind property to
6380 the modified symbol. */
6382 apply_modifiers (int modifiers
, Lisp_Object base
)
6384 Lisp_Object cache
, idx
, entry
, new_symbol
;
6386 /* Mask out upper bits. We don't know where this value's been. */
6387 modifiers
&= INTMASK
;
6389 if (INTEGERP (base
))
6390 return make_number (XINT (base
) | modifiers
);
6392 /* The click modifier never figures into cache indices. */
6393 cache
= Fget (base
, Qmodifier_cache
);
6394 XSETFASTINT (idx
, (modifiers
& ~click_modifier
));
6395 entry
= assq_no_quit (idx
, cache
);
6398 new_symbol
= XCDR (entry
);
6401 /* We have to create the symbol ourselves. */
6402 new_symbol
= apply_modifiers_uncached (modifiers
,
6403 SSDATA (SYMBOL_NAME (base
)),
6404 SCHARS (SYMBOL_NAME (base
)),
6405 SBYTES (SYMBOL_NAME (base
)));
6407 /* Add the new symbol to the base's cache. */
6408 entry
= Fcons (idx
, new_symbol
);
6409 Fput (base
, Qmodifier_cache
, Fcons (entry
, cache
));
6411 /* We have the parsing info now for free, so we could add it to
6413 XSETFASTINT (idx, modifiers);
6414 Fput (new_symbol, Qevent_symbol_element_mask,
6416 Fput (new_symbol, Qevent_symbol_elements,
6417 Fcons (base, lispy_modifier_list (modifiers)));
6418 Sadly, this is only correct if `base' is indeed a base event,
6419 which is not necessarily the case. -stef */
6422 /* Make sure this symbol is of the same kind as BASE.
6424 You'd think we could just set this once and for all when we
6425 intern the symbol above, but reorder_modifiers may call us when
6426 BASE's property isn't set right; we can't assume that just
6427 because it has a Qmodifier_cache property it must have its
6428 Qevent_kind set right as well. */
6429 if (NILP (Fget (new_symbol
, Qevent_kind
)))
6433 kind
= Fget (base
, Qevent_kind
);
6435 Fput (new_symbol
, Qevent_kind
, kind
);
6442 /* Given a symbol whose name begins with modifiers ("C-", "M-", etc),
6443 return a symbol with the modifiers placed in the canonical order.
6444 Canonical order is alphabetical, except for down and drag, which
6445 always come last. The 'click' modifier is never written out.
6447 Fdefine_key calls this to make sure that (for example) C-M-foo
6448 and M-C-foo end up being equivalent in the keymap. */
6451 reorder_modifiers (Lisp_Object symbol
)
6453 /* It's hopefully okay to write the code this way, since everything
6454 will soon be in caches, and no consing will be done at all. */
6457 parsed
= parse_modifiers (symbol
);
6458 return apply_modifiers (XFASTINT (XCAR (XCDR (parsed
))),
6463 /* For handling events, we often want to produce a symbol whose name
6464 is a series of modifier key prefixes ("M-", "C-", etcetera) attached
6465 to some base, like the name of a function key or mouse button.
6466 modify_event_symbol produces symbols of this sort.
6468 NAME_TABLE should point to an array of strings, such that NAME_TABLE[i]
6469 is the name of the i'th symbol. TABLE_SIZE is the number of elements
6472 Alternatively, NAME_ALIST_OR_STEM is either an alist mapping codes
6473 into symbol names, or a string specifying a name stem used to
6474 construct a symbol name or the form `STEM-N', where N is the decimal
6475 representation of SYMBOL_NUM. NAME_ALIST_OR_STEM is used if it is
6476 non-nil; otherwise NAME_TABLE is used.
6478 SYMBOL_TABLE should be a pointer to a Lisp_Object whose value will
6479 persist between calls to modify_event_symbol that it can use to
6480 store a cache of the symbols it's generated for this NAME_TABLE
6481 before. The object stored there may be a vector or an alist.
6483 SYMBOL_NUM is the number of the base name we want from NAME_TABLE.
6485 MODIFIERS is a set of modifier bits (as given in struct input_events)
6486 whose prefixes should be applied to the symbol name.
6488 SYMBOL_KIND is the value to be placed in the event_kind property of
6489 the returned symbol.
6491 The symbols we create are supposed to have an
6492 `event-symbol-elements' property, which lists the modifiers present
6493 in the symbol's name. */
6496 modify_event_symbol (ptrdiff_t symbol_num
, int modifiers
, Lisp_Object symbol_kind
,
6497 Lisp_Object name_alist_or_stem
, const char *const *name_table
,
6498 Lisp_Object
*symbol_table
, ptrdiff_t table_size
)
6501 Lisp_Object symbol_int
;
6503 /* Get rid of the "vendor-specific" bit here. */
6504 XSETINT (symbol_int
, symbol_num
& 0xffffff);
6506 /* Is this a request for a valid symbol? */
6507 if (symbol_num
< 0 || symbol_num
>= table_size
)
6510 if (CONSP (*symbol_table
))
6511 value
= Fcdr (assq_no_quit (symbol_int
, *symbol_table
));
6513 /* If *symbol_table doesn't seem to be initialized properly, fix that.
6514 *symbol_table should be a lisp vector TABLE_SIZE elements long,
6515 where the Nth element is the symbol for NAME_TABLE[N], or nil if
6516 we've never used that symbol before. */
6519 if (! VECTORP (*symbol_table
)
6520 || ASIZE (*symbol_table
) != table_size
)
6524 XSETFASTINT (size
, table_size
);
6525 *symbol_table
= Fmake_vector (size
, Qnil
);
6528 value
= AREF (*symbol_table
, symbol_num
);
6531 /* Have we already used this symbol before? */
6534 /* No; let's create it. */
6535 if (CONSP (name_alist_or_stem
))
6536 value
= Fcdr_safe (Fassq (symbol_int
, name_alist_or_stem
));
6537 else if (STRINGP (name_alist_or_stem
))
6540 ptrdiff_t len
= (SBYTES (name_alist_or_stem
)
6541 + sizeof "-" + INT_STRLEN_BOUND (EMACS_INT
));
6543 buf
= SAFE_ALLOCA (len
);
6544 esprintf (buf
, "%s-%"pI
"d", SDATA (name_alist_or_stem
),
6545 XINT (symbol_int
) + 1);
6546 value
= intern (buf
);
6549 else if (name_table
!= 0 && name_table
[symbol_num
])
6550 value
= intern (name_table
[symbol_num
]);
6552 #ifdef HAVE_WINDOW_SYSTEM
6555 char *name
= x_get_keysym_name (symbol_num
);
6557 value
= intern (name
);
6563 char buf
[sizeof "key-" + INT_STRLEN_BOUND (EMACS_INT
)];
6564 sprintf (buf
, "key-%"pD
"d", symbol_num
);
6565 value
= intern (buf
);
6568 if (CONSP (*symbol_table
))
6569 *symbol_table
= Fcons (Fcons (symbol_int
, value
), *symbol_table
);
6571 ASET (*symbol_table
, symbol_num
, value
);
6573 /* Fill in the cache entries for this symbol; this also
6574 builds the Qevent_symbol_elements property, which the user
6576 apply_modifiers (modifiers
& click_modifier
, value
);
6577 Fput (value
, Qevent_kind
, symbol_kind
);
6580 /* Apply modifiers to that symbol. */
6581 return apply_modifiers (modifiers
, value
);
6584 /* Convert a list that represents an event type,
6585 such as (ctrl meta backspace), into the usual representation of that
6586 event type as a number or a symbol. */
6588 DEFUN ("event-convert-list", Fevent_convert_list
, Sevent_convert_list
, 1, 1, 0,
6589 doc
: /* Convert the event description list EVENT-DESC to an event type.
6590 EVENT-DESC should contain one base event type (a character or symbol)
6591 and zero or more modifier names (control, meta, hyper, super, shift, alt,
6592 drag, down, double or triple). The base must be last.
6593 The return value is an event type (a character or symbol) which
6594 has the same base event type and all the specified modifiers. */)
6595 (Lisp_Object event_desc
)
6603 while (CONSP (rest
))
6611 /* Given a symbol, see if it is a modifier name. */
6612 if (SYMBOLP (elt
) && CONSP (rest
))
6613 this = parse_solitary_modifier (elt
);
6617 else if (!NILP (base
))
6618 error ("Two bases given in one event");
6624 /* Let the symbol A refer to the character A. */
6625 if (SYMBOLP (base
) && SCHARS (SYMBOL_NAME (base
)) == 1)
6626 XSETINT (base
, SREF (SYMBOL_NAME (base
), 0));
6628 if (INTEGERP (base
))
6630 /* Turn (shift a) into A. */
6631 if ((modifiers
& shift_modifier
) != 0
6632 && (XINT (base
) >= 'a' && XINT (base
) <= 'z'))
6634 XSETINT (base
, XINT (base
) - ('a' - 'A'));
6635 modifiers
&= ~shift_modifier
;
6638 /* Turn (control a) into C-a. */
6639 if (modifiers
& ctrl_modifier
)
6640 return make_number ((modifiers
& ~ctrl_modifier
)
6641 | make_ctrl_char (XINT (base
)));
6643 return make_number (modifiers
| XINT (base
));
6645 else if (SYMBOLP (base
))
6646 return apply_modifiers (modifiers
, base
);
6648 error ("Invalid base event");
6651 /* Try to recognize SYMBOL as a modifier name.
6652 Return the modifier flag bit, or 0 if not recognized. */
6655 parse_solitary_modifier (Lisp_Object symbol
)
6659 if (!SYMBOLP (symbol
))
6662 name
= SYMBOL_NAME (symbol
);
6664 switch (SREF (name
, 0))
6666 #define SINGLE_LETTER_MOD(BIT) \
6667 if (SBYTES (name) == 1) \
6670 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6671 if (LEN == SBYTES (name) \
6672 && ! memcmp (SDATA (name), NAME, LEN)) \
6676 SINGLE_LETTER_MOD (alt_modifier
);
6680 MULTI_LETTER_MOD (alt_modifier
, "alt", 3);
6684 SINGLE_LETTER_MOD (ctrl_modifier
);
6688 MULTI_LETTER_MOD (ctrl_modifier
, "ctrl", 4);
6689 MULTI_LETTER_MOD (ctrl_modifier
, "control", 7);
6693 SINGLE_LETTER_MOD (hyper_modifier
);
6697 MULTI_LETTER_MOD (hyper_modifier
, "hyper", 5);
6701 SINGLE_LETTER_MOD (meta_modifier
);
6705 MULTI_LETTER_MOD (meta_modifier
, "meta", 4);
6709 SINGLE_LETTER_MOD (shift_modifier
);
6713 MULTI_LETTER_MOD (shift_modifier
, "shift", 5);
6714 MULTI_LETTER_MOD (super_modifier
, "super", 5);
6715 SINGLE_LETTER_MOD (super_modifier
);
6719 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
6720 MULTI_LETTER_MOD (down_modifier
, "down", 4);
6721 MULTI_LETTER_MOD (double_modifier
, "double", 6);
6725 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
6729 MULTI_LETTER_MOD (up_modifier
, "up", 2);
6732 #undef SINGLE_LETTER_MOD
6733 #undef MULTI_LETTER_MOD
6739 /* Return true if EVENT is a list whose elements are all integers or symbols.
6740 Such a list is not valid as an event,
6741 but it can be a Lucid-style event type list. */
6744 lucid_event_type_list_p (Lisp_Object object
)
6748 if (! CONSP (object
))
6751 if (EQ (XCAR (object
), Qhelp_echo
)
6752 || EQ (XCAR (object
), Qvertical_line
)
6753 || EQ (XCAR (object
), Qmode_line
)
6754 || EQ (XCAR (object
), Qheader_line
))
6757 for (tail
= object
; CONSP (tail
); tail
= XCDR (tail
))
6761 if (! (INTEGERP (elt
) || SYMBOLP (elt
)))
6768 /* Return true if terminal input chars are available.
6769 Also, store the return value into INPUT_PENDING.
6771 Serves the purpose of ioctl (0, FIONREAD, ...)
6772 but works even if FIONREAD does not exist.
6773 (In fact, this may actually read some input.)
6775 If READABLE_EVENTS_DO_TIMERS_NOW is set in FLAGS, actually run
6776 timer events that are ripe.
6777 If READABLE_EVENTS_FILTER_EVENTS is set in FLAGS, ignore internal
6778 events (FOCUS_IN_EVENT).
6779 If READABLE_EVENTS_IGNORE_SQUEEZABLES is set in FLAGS, ignore mouse
6780 movements and toolkit scroll bar thumb drags. */
6783 get_input_pending (int flags
)
6785 /* First of all, have we already counted some input? */
6786 input_pending
= (!NILP (Vquit_flag
) || readable_events (flags
));
6788 /* If input is being read as it arrives, and we have none, there is none. */
6789 if (!input_pending
&& (!interrupt_input
|| interrupts_deferred
))
6791 /* Try to read some input and see how much we get. */
6793 input_pending
= (!NILP (Vquit_flag
) || readable_events (flags
));
6796 return input_pending
;
6799 /* Put a BUFFER_SWITCH_EVENT in the buffer
6800 so that read_key_sequence will notice the new current buffer. */
6803 record_asynch_buffer_change (void)
6805 /* We don't need a buffer-switch event unless Emacs is waiting for input.
6806 The purpose of the event is to make read_key_sequence look up the
6807 keymaps again. If we aren't in read_key_sequence, we don't need one,
6808 and the event could cause trouble by messing up (input-pending-p).
6809 Note: Fwaiting_for_user_input_p always returns nil when async
6810 subprocesses aren't supported. */
6811 if (!NILP (Fwaiting_for_user_input_p ()))
6813 struct input_event event
;
6816 event
.kind
= BUFFER_SWITCH_EVENT
;
6817 event
.frame_or_window
= Qnil
;
6820 /* Make sure no interrupt happens while storing the event. */
6822 if (interrupt_input
)
6823 kbd_buffer_store_event (&event
);
6828 kbd_buffer_store_event (&event
);
6834 /* Read any terminal input already buffered up by the system
6835 into the kbd_buffer, but do not wait.
6837 Return the number of keyboard chars read, or -1 meaning
6838 this is a bad time to try to read input. */
6847 /* Store pending user signal events, if any. */
6848 store_user_signal_events ();
6850 /* Loop through the available terminals, and call their input hooks. */
6854 struct terminal
*next
= t
->next_terminal
;
6856 if (t
->read_socket_hook
)
6859 struct input_event hold_quit
;
6861 if (input_blocked_p ())
6863 pending_signals
= true;
6867 EVENT_INIT (hold_quit
);
6868 hold_quit
.kind
= NO_EVENT
;
6870 /* No need for FIONREAD or fcntl; just say don't wait. */
6871 while ((nr
= (*t
->read_socket_hook
) (t
, &hold_quit
)) > 0)
6874 if (nr
== -1) /* Not OK to read input now. */
6878 else if (nr
== -2) /* Non-transient error. */
6880 /* The terminal device terminated; it should be closed. */
6882 /* Kill Emacs if this was our last terminal. */
6883 if (!terminal_list
->next_terminal
)
6884 /* Formerly simply reported no input, but that
6885 sometimes led to a failure of Emacs to terminate.
6886 SIGHUP seems appropriate if we can't reach the
6888 /* ??? Is it really right to send the signal just to
6889 this process rather than to the whole process
6890 group? Perhaps on systems with FIONREAD Emacs is
6891 alone in its group. */
6892 terminate_due_to_signal (SIGHUP
, 10);
6894 /* XXX Is calling delete_terminal safe here? It calls delete_frame. */
6897 XSETTERMINAL (tmp
, t
);
6898 Fdelete_terminal (tmp
, Qnoelisp
);
6902 /* If there was no error, make sure the pointer
6903 is visible for all frames on this terminal. */
6906 Lisp_Object tail
, frame
;
6908 FOR_EACH_FRAME (tail
, frame
)
6910 struct frame
*f
= XFRAME (frame
);
6911 if (FRAME_TERMINAL (f
) == t
)
6912 frame_make_pointer_visible (f
);
6916 if (hold_quit
.kind
!= NO_EVENT
)
6917 kbd_buffer_store_event (&hold_quit
);
6929 /* This is the tty way of reading available input.
6931 Note that each terminal device has its own `struct terminal' object,
6932 and so this function is called once for each individual termcap
6933 terminal. The first parameter indicates which terminal to read from. */
6936 tty_read_avail_input (struct terminal
*terminal
,
6937 struct input_event
*hold_quit
)
6939 /* Using KBD_BUFFER_SIZE - 1 here avoids reading more than
6940 the kbd_buffer can really hold. That may prevent loss
6941 of characters on some systems when input is stuffed at us. */
6942 unsigned char cbuf
[KBD_BUFFER_SIZE
- 1];
6947 struct tty_display_info
*tty
= terminal
->display_info
.tty
;
6950 int buffer_free
= KBD_BUFFER_SIZE
- kbd_buffer_nr_stored () - 1;
6952 if (kbd_on_hold_p () || buffer_free
<= 0)
6954 #endif /* subprocesses */
6956 if (!terminal
->name
) /* Don't read from a dead terminal. */
6959 if (terminal
->type
!= output_termcap
6960 && terminal
->type
!= output_msdos_raw
)
6963 /* XXX I think the following code should be moved to separate hook
6964 functions in system-dependent files. */
6966 /* FIXME: AFAIK, tty_read_avail_input is not used under w32 since the non-GUI
6967 code sets read_socket_hook to w32_console_read_socket instead! */
6969 #else /* not WINDOWSNT */
6970 if (! tty
->term_initted
) /* In case we get called during bootstrap. */
6974 return 0; /* The terminal is suspended. */
6977 n_to_read
= dos_keysns ();
6981 cbuf
[0] = dos_keyread ();
6984 #else /* not MSDOS */
6989 struct input_event gpm_hold_quit
;
6990 int gpm
, fd
= gpm_fd
;
6992 EVENT_INIT (gpm_hold_quit
);
6993 gpm_hold_quit
.kind
= NO_EVENT
;
6995 /* gpm==1 if event received.
6996 gpm==0 if the GPM daemon has closed the connection, in which case
6997 Gpm_GetEvent closes gpm_fd and clears it to -1, which is why
6998 we save it in `fd' so close_gpm can remove it from the
7000 gpm==-1 if a protocol error or EWOULDBLOCK; the latter is normal. */
7001 while (gpm
= Gpm_GetEvent (&event
), gpm
== 1) {
7002 nread
+= handle_one_term_event (tty
, &event
, &gpm_hold_quit
);
7005 /* Presumably the GPM daemon has closed the connection. */
7007 if (gpm_hold_quit
.kind
!= NO_EVENT
)
7008 kbd_buffer_store_event (&gpm_hold_quit
);
7012 #endif /* HAVE_GPM */
7014 /* Determine how many characters we should *try* to read. */
7015 #ifdef USABLE_FIONREAD
7016 /* Find out how much input is available. */
7017 if (ioctl (fileno (tty
->input
), FIONREAD
, &n_to_read
) < 0)
7019 if (! noninteractive
)
7020 return -2; /* Close this terminal. */
7026 if (n_to_read
> sizeof cbuf
)
7027 n_to_read
= sizeof cbuf
;
7028 #elif defined USG || defined CYGWIN
7029 /* Read some input if available, but don't wait. */
7030 n_to_read
= sizeof cbuf
;
7031 fcntl (fileno (tty
->input
), F_SETFL
, O_NONBLOCK
);
7033 # error "Cannot read without possibly delaying"
7037 /* Don't read more than we can store. */
7038 if (n_to_read
> buffer_free
)
7039 n_to_read
= buffer_free
;
7040 #endif /* subprocesses */
7042 /* Now read; for one reason or another, this will not block.
7043 NREAD is set to the number of chars read. */
7046 nread
= emacs_read (fileno (tty
->input
), (char *) cbuf
, n_to_read
);
7047 /* POSIX infers that processes which are not in the session leader's
7048 process group won't get SIGHUPs at logout time. BSDI adheres to
7049 this part standard and returns -1 from read (0) with errno==EIO
7050 when the control tty is taken away.
7051 Jeffrey Honig <jch@bsdi.com> says this is generally safe. */
7052 if (nread
== -1 && errno
== EIO
)
7053 return -2; /* Close this terminal. */
7054 #if defined (AIX) && defined (_BSD)
7055 /* The kernel sometimes fails to deliver SIGHUP for ptys.
7056 This looks incorrect, but it isn't, because _BSD causes
7057 O_NDELAY to be defined in fcntl.h as O_NONBLOCK,
7058 and that causes a value other than 0 when there is no input. */
7060 return -2; /* Close this terminal. */
7064 /* We used to retry the read if it was interrupted.
7065 But this does the wrong thing when O_NONBLOCK causes
7066 an EAGAIN error. Does anybody know of a situation
7067 where a retry is actually needed? */
7069 nread
< 0 && (errno
== EAGAIN
|| errno
== EFAULT
7079 #ifndef USABLE_FIONREAD
7080 #if defined (USG) || defined (CYGWIN)
7081 fcntl (fileno (tty
->input
), F_SETFL
, 0);
7082 #endif /* USG or CYGWIN */
7083 #endif /* no FIONREAD */
7088 #endif /* not MSDOS */
7089 #endif /* not WINDOWSNT */
7091 for (i
= 0; i
< nread
; i
++)
7093 struct input_event buf
;
7095 buf
.kind
= ASCII_KEYSTROKE_EVENT
;
7097 if (tty
->meta_key
== 1 && (cbuf
[i
] & 0x80))
7098 buf
.modifiers
= meta_modifier
;
7099 if (tty
->meta_key
!= 2)
7103 /* Set the frame corresponding to the active tty. Note that the
7104 value of selected_frame is not reliable here, redisplay tends
7105 to temporarily change it. */
7106 buf
.frame_or_window
= tty
->top_frame
;
7109 kbd_buffer_store_event (&buf
);
7110 /* Don't look at input that follows a C-g too closely.
7111 This reduces lossage due to autorepeat on C-g. */
7112 if (buf
.kind
== ASCII_KEYSTROKE_EVENT
7113 && buf
.code
== quit_char
)
7121 handle_async_input (void)
7126 int nread
= gobble_input ();
7127 /* -1 means it's not ok to read the input now.
7128 UNBLOCK_INPUT will read it later; now, avoid infinite loop.
7129 0 means there was no keyboard input available. */
7137 process_pending_signals (void)
7139 pending_signals
= false;
7140 handle_async_input ();
7141 do_pending_atimers ();
7144 /* Undo any number of BLOCK_INPUT calls down to level LEVEL,
7145 and reinvoke any pending signal if the level is now 0 and
7146 a fatal error is not already in progress. */
7149 unblock_input_to (int level
)
7151 interrupt_input_blocked
= level
;
7154 if (pending_signals
&& !fatal_error_in_progress
)
7155 process_pending_signals ();
7161 /* End critical section.
7163 If doing signal-driven input, and a signal came in when input was
7164 blocked, reinvoke the signal handler now to deal with it.
7166 It will also process queued input, if it was not read before.
7167 When a longer code sequence does not use block/unblock input
7168 at all, the whole input gathered up to the next call to
7169 unblock_input will be processed inside that call. */
7172 unblock_input (void)
7174 unblock_input_to (interrupt_input_blocked
- 1);
7177 /* Undo any number of BLOCK_INPUT calls,
7178 and also reinvoke any pending signal. */
7181 totally_unblock_input (void)
7183 unblock_input_to (0);
7189 handle_input_available_signal (int sig
)
7191 pending_signals
= true;
7193 if (input_available_clear_time
)
7194 *input_available_clear_time
= make_timespec (0, 0);
7198 deliver_input_available_signal (int sig
)
7200 deliver_process_signal (sig
, handle_input_available_signal
);
7202 #endif /* USABLE_SIGIO */
7205 /* User signal events. */
7207 struct user_signal_info
7209 /* Signal number. */
7212 /* Name of the signal. */
7215 /* Number of pending signals. */
7218 struct user_signal_info
*next
;
7221 /* List of user signals. */
7222 static struct user_signal_info
*user_signals
= NULL
;
7225 add_user_signal (int sig
, const char *name
)
7227 struct sigaction action
;
7228 struct user_signal_info
*p
;
7230 for (p
= user_signals
; p
; p
= p
->next
)
7232 /* Already added. */
7235 p
= xmalloc (sizeof *p
);
7237 p
->name
= xstrdup (name
);
7239 p
->next
= user_signals
;
7242 emacs_sigaction_init (&action
, deliver_user_signal
);
7243 sigaction (sig
, &action
, 0);
7247 handle_user_signal (int sig
)
7249 struct user_signal_info
*p
;
7250 const char *special_event_name
= NULL
;
7252 if (SYMBOLP (Vdebug_on_event
))
7253 special_event_name
= SSDATA (SYMBOL_NAME (Vdebug_on_event
));
7255 for (p
= user_signals
; p
; p
= p
->next
)
7258 if (special_event_name
7259 && strcmp (special_event_name
, p
->name
) == 0)
7261 /* Enter the debugger in many ways. */
7262 debug_on_next_call
= true;
7263 debug_on_quit
= true;
7265 Vinhibit_quit
= Qnil
;
7267 /* Eat the event. */
7273 if (interrupt_input
)
7274 handle_input_available_signal (sig
);
7278 /* Tell wait_reading_process_output that it needs to wake
7279 up and look around. */
7280 if (input_available_clear_time
)
7281 *input_available_clear_time
= make_timespec (0, 0);
7288 deliver_user_signal (int sig
)
7290 deliver_process_signal (sig
, handle_user_signal
);
7294 find_user_signal_name (int sig
)
7296 struct user_signal_info
*p
;
7298 for (p
= user_signals
; p
; p
= p
->next
)
7306 store_user_signal_events (void)
7308 struct user_signal_info
*p
;
7309 struct input_event buf
;
7310 bool buf_initialized
= false;
7312 for (p
= user_signals
; p
; p
= p
->next
)
7313 if (p
->npending
> 0)
7315 if (! buf_initialized
)
7317 memset (&buf
, 0, sizeof buf
);
7318 buf
.kind
= USER_SIGNAL_EVENT
;
7319 buf
.frame_or_window
= selected_frame
;
7320 buf_initialized
= true;
7326 kbd_buffer_store_event (&buf
);
7329 while (p
->npending
> 0);
7334 static void menu_bar_item (Lisp_Object
, Lisp_Object
, Lisp_Object
, void *);
7335 static Lisp_Object menu_bar_one_keymap_changed_items
;
7337 /* These variables hold the vector under construction within
7338 menu_bar_items and its subroutines, and the current index
7339 for storing into that vector. */
7340 static Lisp_Object menu_bar_items_vector
;
7341 static int menu_bar_items_index
;
7344 static const char *separator_names
[] = {
7349 "single-dashed-line",
7350 "double-dashed-line",
7352 "shadow-etched-out",
7353 "shadow-etched-in-dash",
7354 "shadow-etched-out-dash",
7355 "shadow-double-etched-in",
7356 "shadow-double-etched-out",
7357 "shadow-double-etched-in-dash",
7358 "shadow-double-etched-out-dash",
7362 /* Return true if LABEL specifies a separator. */
7365 menu_separator_name_p (const char *label
)
7369 else if (strlen (label
) > 3
7370 && memcmp (label
, "--", 2) == 0
7375 for (i
= 0; separator_names
[i
]; ++i
)
7376 if (strcmp (label
, separator_names
[i
]) == 0)
7381 /* It's a separator if it contains only dashes. */
7382 while (*label
== '-')
7384 return (*label
== 0);
7391 /* Return a vector of menu items for a menu bar, appropriate
7392 to the current buffer. Each item has three elements in the vector:
7395 OLD is an old vector we can optionally reuse, or nil. */
7398 menu_bar_items (Lisp_Object old
)
7400 /* The number of keymaps we're scanning right now, and the number of
7401 keymaps we have allocated space for. */
7404 /* maps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
7405 in the current keymaps, or nil where it is not a prefix. */
7408 Lisp_Object mapsbuf
[3];
7409 Lisp_Object def
, tail
;
7416 /* In order to build the menus, we need to call the keymap
7417 accessors. They all call maybe_quit. But this function is called
7418 during redisplay, during which a quit is fatal. So inhibit
7419 quitting while building the menus.
7420 We do this instead of specbind because (1) errors will clear it anyway
7421 and (2) this avoids risk of specpdl overflow. */
7422 oquit
= Vinhibit_quit
;
7426 menu_bar_items_vector
= old
;
7428 menu_bar_items_vector
= Fmake_vector (make_number (24), Qnil
);
7429 menu_bar_items_index
= 0;
7431 /* Build our list of keymaps.
7432 If we recognize a function key and replace its escape sequence in
7433 keybuf with its symbol, or if the sequence starts with a mouse
7434 click and we need to switch buffers, we jump back here to rebuild
7435 the initial keymaps from the current buffer. */
7439 /* Should overriding-terminal-local-map and overriding-local-map apply? */
7440 if (!NILP (Voverriding_local_map_menu_flag
)
7441 && !NILP (Voverriding_local_map
))
7443 /* Yes, use them (if non-nil) as well as the global map. */
7446 if (!NILP (KVAR (current_kboard
, Voverriding_terminal_local_map
)))
7447 maps
[nmaps
++] = KVAR (current_kboard
, Voverriding_terminal_local_map
);
7448 if (!NILP (Voverriding_local_map
))
7449 maps
[nmaps
++] = Voverriding_local_map
;
7453 /* No, so use major and minor mode keymaps and keymap property.
7454 Note that menu-bar bindings in the local-map and keymap
7455 properties may not work reliable, as they are only
7456 recognized when the menu-bar (or mode-line) is updated,
7457 which does not normally happen after every command. */
7458 ptrdiff_t nminor
= current_minor_maps (NULL
, &tmaps
);
7459 SAFE_NALLOCA (maps
, 1, nminor
+ 4);
7461 Lisp_Object tem
= KVAR (current_kboard
, Voverriding_terminal_local_map
);
7462 if (!NILP (tem
) && !NILP (Voverriding_local_map_menu_flag
))
7463 maps
[nmaps
++] = tem
;
7464 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
7465 maps
[nmaps
++] = tem
;
7468 memcpy (maps
+ nmaps
, tmaps
, nminor
* sizeof (maps
[0]));
7471 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
7473 maps
[nmaps
++] = current_global_map
;
7476 /* Look up in each map the dummy prefix key `menu-bar'. */
7478 for (mapno
= nmaps
- 1; mapno
>= 0; mapno
--)
7479 if (!NILP (maps
[mapno
]))
7481 def
= get_keymap (access_keymap (maps
[mapno
], Qmenu_bar
, 1, 0, 1),
7485 menu_bar_one_keymap_changed_items
= Qnil
;
7486 map_keymap_canonical (def
, menu_bar_item
, Qnil
, NULL
);
7490 /* Move to the end those items that should be at the end. */
7492 for (tail
= Vmenu_bar_final_items
; CONSP (tail
); tail
= XCDR (tail
))
7495 int end
= menu_bar_items_index
;
7497 for (i
= 0; i
< end
; i
+= 4)
7498 if (EQ (XCAR (tail
), AREF (menu_bar_items_vector
, i
)))
7500 Lisp_Object tem0
, tem1
, tem2
, tem3
;
7501 /* Move the item at index I to the end,
7502 shifting all the others forward. */
7503 tem0
= AREF (menu_bar_items_vector
, i
+ 0);
7504 tem1
= AREF (menu_bar_items_vector
, i
+ 1);
7505 tem2
= AREF (menu_bar_items_vector
, i
+ 2);
7506 tem3
= AREF (menu_bar_items_vector
, i
+ 3);
7508 memmove (aref_addr (menu_bar_items_vector
, i
),
7509 aref_addr (menu_bar_items_vector
, i
+ 4),
7510 (end
- i
- 4) * word_size
);
7511 ASET (menu_bar_items_vector
, end
- 4, tem0
);
7512 ASET (menu_bar_items_vector
, end
- 3, tem1
);
7513 ASET (menu_bar_items_vector
, end
- 2, tem2
);
7514 ASET (menu_bar_items_vector
, end
- 1, tem3
);
7519 /* Add nil, nil, nil, nil at the end. */
7521 int i
= menu_bar_items_index
;
7522 if (i
+ 4 > ASIZE (menu_bar_items_vector
))
7523 menu_bar_items_vector
7524 = larger_vector (menu_bar_items_vector
, 4, -1);
7525 /* Add this item. */
7526 ASET (menu_bar_items_vector
, i
, Qnil
); i
++;
7527 ASET (menu_bar_items_vector
, i
, Qnil
); i
++;
7528 ASET (menu_bar_items_vector
, i
, Qnil
); i
++;
7529 ASET (menu_bar_items_vector
, i
, Qnil
); i
++;
7530 menu_bar_items_index
= i
;
7533 Vinhibit_quit
= oquit
;
7535 return menu_bar_items_vector
;
7538 /* Add one item to menu_bar_items_vector, for KEY, ITEM_STRING and DEF.
7539 If there's already an item for KEY, add this DEF to it. */
7541 Lisp_Object item_properties
;
7544 menu_bar_item (Lisp_Object key
, Lisp_Object item
, Lisp_Object dummy1
, void *dummy2
)
7550 if (EQ (item
, Qundefined
))
7552 /* If a map has an explicit `undefined' as definition,
7553 discard any previously made menu bar item. */
7555 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7556 if (EQ (key
, AREF (menu_bar_items_vector
, i
)))
7558 if (menu_bar_items_index
> i
+ 4)
7559 memmove (aref_addr (menu_bar_items_vector
, i
),
7560 aref_addr (menu_bar_items_vector
, i
+ 4),
7561 (menu_bar_items_index
- i
- 4) * word_size
);
7562 menu_bar_items_index
-= 4;
7566 /* If this keymap has already contributed to this KEY,
7567 don't contribute to it a second time. */
7568 tem
= Fmemq (key
, menu_bar_one_keymap_changed_items
);
7569 if (!NILP (tem
) || NILP (item
))
7572 menu_bar_one_keymap_changed_items
7573 = Fcons (key
, menu_bar_one_keymap_changed_items
);
7575 /* We add to menu_bar_one_keymap_changed_items before doing the
7576 parse_menu_item, so that if it turns out it wasn't a menu item,
7577 it still correctly hides any further menu item. */
7578 parsed
= parse_menu_item (item
, 1);
7582 item
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7584 /* Find any existing item for this KEY. */
7585 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7586 if (EQ (key
, AREF (menu_bar_items_vector
, i
)))
7589 /* If we did not find this KEY, add it at the end. */
7590 if (i
== menu_bar_items_index
)
7592 /* If vector is too small, get a bigger one. */
7593 if (i
+ 4 > ASIZE (menu_bar_items_vector
))
7594 menu_bar_items_vector
= larger_vector (menu_bar_items_vector
, 4, -1);
7595 /* Add this item. */
7596 ASET (menu_bar_items_vector
, i
, key
); i
++;
7597 ASET (menu_bar_items_vector
, i
,
7598 AREF (item_properties
, ITEM_PROPERTY_NAME
)); i
++;
7599 ASET (menu_bar_items_vector
, i
, list1 (item
)); i
++;
7600 ASET (menu_bar_items_vector
, i
, make_number (0)); i
++;
7601 menu_bar_items_index
= i
;
7603 /* We did find an item for this KEY. Add ITEM to its list of maps. */
7607 old
= AREF (menu_bar_items_vector
, i
+ 2);
7608 /* If the new and the old items are not both keymaps,
7609 the lookup will only find `item'. */
7610 item
= Fcons (item
, KEYMAPP (item
) && KEYMAPP (XCAR (old
)) ? old
: Qnil
);
7611 ASET (menu_bar_items_vector
, i
+ 2, item
);
7615 /* This is used as the handler when calling menu_item_eval_property. */
7617 menu_item_eval_property_1 (Lisp_Object arg
)
7619 /* If we got a quit from within the menu computation,
7620 quit all the way out of it. This takes care of C-] in the debugger. */
7621 if (CONSP (arg
) && EQ (XCAR (arg
), Qquit
))
7628 eval_dyn (Lisp_Object form
)
7630 return Feval (form
, Qnil
);
7633 /* Evaluate an expression and return the result (or nil if something
7634 went wrong). Used to evaluate dynamic parts of menu items. */
7636 menu_item_eval_property (Lisp_Object sexpr
)
7638 ptrdiff_t count
= SPECPDL_INDEX ();
7640 specbind (Qinhibit_redisplay
, Qt
);
7641 val
= internal_condition_case_1 (eval_dyn
, sexpr
, Qerror
,
7642 menu_item_eval_property_1
);
7643 return unbind_to (count
, val
);
7646 /* This function parses a menu item and leaves the result in the
7647 vector item_properties.
7648 ITEM is a key binding, a possible menu item.
7649 INMENUBAR is > 0 when this is considered for an entry in a menu bar
7651 INMENUBAR is < 0 when this is considered for an entry in a keyboard menu.
7652 parse_menu_item returns true if the item is a menu item and false
7656 parse_menu_item (Lisp_Object item
, int inmenubar
)
7658 Lisp_Object def
, tem
, item_string
, start
;
7660 Lisp_Object keyhint
;
7669 /* Create item_properties vector if necessary. */
7670 if (NILP (item_properties
))
7672 = Fmake_vector (make_number (ITEM_PROPERTY_ENABLE
+ 1), Qnil
);
7674 /* Initialize optional entries. */
7675 for (i
= ITEM_PROPERTY_DEF
; i
< ITEM_PROPERTY_ENABLE
; i
++)
7676 ASET (item_properties
, i
, Qnil
);
7677 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7679 /* Save the item here to protect it from GC. */
7680 ASET (item_properties
, ITEM_PROPERTY_ITEM
, item
);
7682 item_string
= XCAR (item
);
7686 if (STRINGP (item_string
))
7688 /* Old format menu item. */
7689 ASET (item_properties
, ITEM_PROPERTY_NAME
, item_string
);
7691 /* Maybe help string. */
7692 if (CONSP (item
) && STRINGP (XCAR (item
)))
7694 ASET (item_properties
, ITEM_PROPERTY_HELP
,
7695 Fsubstitute_command_keys (XCAR (item
)));
7700 /* Maybe an obsolete key binding cache. */
7701 if (CONSP (item
) && CONSP (XCAR (item
))
7702 && (NILP (XCAR (XCAR (item
)))
7703 || VECTORP (XCAR (XCAR (item
)))))
7706 /* This is the real definition--the function to run. */
7707 ASET (item_properties
, ITEM_PROPERTY_DEF
, item
);
7709 /* Get enable property, if any. */
7712 tem
= Fget (item
, Qmenu_enable
);
7713 if (!NILP (Venable_disabled_menus_and_buttons
))
7714 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7715 else if (!NILP (tem
))
7716 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, tem
);
7719 else if (EQ (item_string
, Qmenu_item
) && CONSP (item
))
7721 /* New format menu item. */
7722 ASET (item_properties
, ITEM_PROPERTY_NAME
, XCAR (item
));
7723 start
= XCDR (item
);
7726 /* We have a real binding. */
7727 ASET (item_properties
, ITEM_PROPERTY_DEF
, XCAR (start
));
7729 item
= XCDR (start
);
7730 /* Is there an obsolete cache list with key equivalences. */
7731 if (CONSP (item
) && CONSP (XCAR (item
)))
7734 /* Parse properties. */
7735 while (CONSP (item
) && CONSP (XCDR (item
)))
7740 if (EQ (tem
, QCenable
))
7742 if (!NILP (Venable_disabled_menus_and_buttons
))
7743 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7745 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, XCAR (item
));
7747 else if (EQ (tem
, QCvisible
))
7749 /* If got a visible property and that evaluates to nil
7750 then ignore this item. */
7751 tem
= menu_item_eval_property (XCAR (item
));
7755 else if (EQ (tem
, QChelp
))
7757 Lisp_Object help
= XCAR (item
);
7759 help
= Fsubstitute_command_keys (help
);
7760 ASET (item_properties
, ITEM_PROPERTY_HELP
, help
);
7762 else if (EQ (tem
, QCfilter
))
7764 else if (EQ (tem
, QCkey_sequence
))
7767 if (SYMBOLP (tem
) || STRINGP (tem
) || VECTORP (tem
))
7768 /* Be GC protected. Set keyhint to item instead of tem. */
7771 else if (EQ (tem
, QCkeys
))
7774 if (CONSP (tem
) || STRINGP (tem
))
7775 ASET (item_properties
, ITEM_PROPERTY_KEYEQ
, tem
);
7777 else if (EQ (tem
, QCbutton
) && CONSP (XCAR (item
)))
7782 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
7784 ASET (item_properties
, ITEM_PROPERTY_SELECTED
,
7786 ASET (item_properties
, ITEM_PROPERTY_TYPE
, type
);
7792 else if (inmenubar
|| !NILP (start
))
7796 return 0; /* not a menu item */
7798 /* If item string is not a string, evaluate it to get string.
7799 If we don't get a string, skip this item. */
7800 item_string
= AREF (item_properties
, ITEM_PROPERTY_NAME
);
7801 if (!(STRINGP (item_string
)))
7803 item_string
= menu_item_eval_property (item_string
);
7804 if (!STRINGP (item_string
))
7806 ASET (item_properties
, ITEM_PROPERTY_NAME
, item_string
);
7809 /* If got a filter apply it on definition. */
7810 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7813 def
= menu_item_eval_property (list2 (XCAR (filter
),
7814 list2 (Qquote
, def
)));
7816 ASET (item_properties
, ITEM_PROPERTY_DEF
, def
);
7819 /* Enable or disable selection of item. */
7820 tem
= AREF (item_properties
, ITEM_PROPERTY_ENABLE
);
7823 tem
= menu_item_eval_property (tem
);
7824 if (inmenubar
&& NILP (tem
))
7825 return 0; /* Ignore disabled items in menu bar. */
7826 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, tem
);
7829 /* If we got no definition, this item is just unselectable text which
7830 is OK in a submenu but not in the menubar. */
7832 return (!inmenubar
);
7834 /* See if this is a separate pane or a submenu. */
7835 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7836 tem
= get_keymap (def
, 0, 1);
7837 /* For a subkeymap, just record its details and exit. */
7840 ASET (item_properties
, ITEM_PROPERTY_MAP
, tem
);
7841 ASET (item_properties
, ITEM_PROPERTY_DEF
, tem
);
7845 /* At the top level in the menu bar, do likewise for commands also.
7846 The menu bar does not display equivalent key bindings anyway.
7847 ITEM_PROPERTY_DEF is already set up properly. */
7851 { /* This is a command. See if there is an equivalent key binding. */
7852 Lisp_Object keyeq
= AREF (item_properties
, ITEM_PROPERTY_KEYEQ
);
7853 AUTO_STRING (space_space
, " ");
7855 /* The previous code preferred :key-sequence to :keys, so we
7856 preserve this behavior. */
7857 if (STRINGP (keyeq
) && !CONSP (keyhint
))
7858 keyeq
= concat2 (space_space
, Fsubstitute_command_keys (keyeq
));
7861 Lisp_Object prefix
= keyeq
;
7862 Lisp_Object keys
= Qnil
;
7866 def
= XCAR (prefix
);
7867 prefix
= XCDR (prefix
);
7870 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7872 if (CONSP (keyhint
) && !NILP (XCAR (keyhint
)))
7874 keys
= XCAR (keyhint
);
7875 tem
= Fkey_binding (keys
, Qnil
, Qnil
, Qnil
);
7877 /* We have a suggested key. Is it bound to the command? */
7880 /* If the command is an alias for another
7881 (such as lmenu.el set it up), check if the
7882 original command matches the cached command. */
7884 && EQ (tem
, XSYMBOL (def
)->function
))))
7889 keys
= Fwhere_is_internal (def
, Qnil
, Qt
, Qnil
, Qnil
);
7893 tem
= Fkey_description (keys
, Qnil
);
7896 if (STRINGP (XCAR (prefix
)))
7897 tem
= concat2 (XCAR (prefix
), tem
);
7898 if (STRINGP (XCDR (prefix
)))
7899 tem
= concat2 (tem
, XCDR (prefix
));
7901 keyeq
= concat2 (space_space
, tem
);
7907 /* If we have an equivalent key binding, use that. */
7908 ASET (item_properties
, ITEM_PROPERTY_KEYEQ
, keyeq
);
7911 /* Include this when menu help is implemented.
7912 tem = XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP];
7913 if (!(NILP (tem) || STRINGP (tem)))
7915 tem = menu_item_eval_property (tem);
7918 XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP] = tem;
7922 /* Handle radio buttons or toggle boxes. */
7923 tem
= AREF (item_properties
, ITEM_PROPERTY_SELECTED
);
7925 ASET (item_properties
, ITEM_PROPERTY_SELECTED
,
7926 menu_item_eval_property (tem
));
7933 /***********************************************************************
7935 ***********************************************************************/
7937 /* A vector holding tool bar items while they are parsed in function
7938 tool_bar_items. Each item occupies TOOL_BAR_ITEM_NSCLOTS elements
7941 static Lisp_Object tool_bar_items_vector
;
7943 /* A vector holding the result of parse_tool_bar_item. Layout is like
7944 the one for a single item in tool_bar_items_vector. */
7946 static Lisp_Object tool_bar_item_properties
;
7948 /* Next free index in tool_bar_items_vector. */
7950 static int ntool_bar_items
;
7952 /* Function prototypes. */
7954 static void init_tool_bar_items (Lisp_Object
);
7955 static void process_tool_bar_item (Lisp_Object
, Lisp_Object
, Lisp_Object
,
7957 static bool parse_tool_bar_item (Lisp_Object
, Lisp_Object
);
7958 static void append_tool_bar_item (void);
7961 /* Return a vector of tool bar items for keymaps currently in effect.
7962 Reuse vector REUSE if non-nil. Return in *NITEMS the number of
7963 tool bar items found. */
7966 tool_bar_items (Lisp_Object reuse
, int *nitems
)
7969 Lisp_Object mapsbuf
[3];
7977 /* In order to build the menus, we need to call the keymap
7978 accessors. They all call maybe_quit. But this function is called
7979 during redisplay, during which a quit is fatal. So inhibit
7980 quitting while building the menus. We do this instead of
7981 specbind because (1) errors will clear it anyway and (2) this
7982 avoids risk of specpdl overflow. */
7983 oquit
= Vinhibit_quit
;
7986 /* Initialize tool_bar_items_vector and protect it from GC. */
7987 init_tool_bar_items (reuse
);
7989 /* Build list of keymaps in maps. Set nmaps to the number of maps
7992 /* Should overriding-terminal-local-map and overriding-local-map apply? */
7993 if (!NILP (Voverriding_local_map_menu_flag
)
7994 && !NILP (Voverriding_local_map
))
7996 /* Yes, use them (if non-nil) as well as the global map. */
7999 if (!NILP (KVAR (current_kboard
, Voverriding_terminal_local_map
)))
8000 maps
[nmaps
++] = KVAR (current_kboard
, Voverriding_terminal_local_map
);
8001 if (!NILP (Voverriding_local_map
))
8002 maps
[nmaps
++] = Voverriding_local_map
;
8006 /* No, so use major and minor mode keymaps and keymap property.
8007 Note that tool-bar bindings in the local-map and keymap
8008 properties may not work reliable, as they are only
8009 recognized when the tool-bar (or mode-line) is updated,
8010 which does not normally happen after every command. */
8011 ptrdiff_t nminor
= current_minor_maps (NULL
, &tmaps
);
8012 SAFE_NALLOCA (maps
, 1, nminor
+ 4);
8014 Lisp_Object tem
= KVAR (current_kboard
, Voverriding_terminal_local_map
);
8015 if (!NILP (tem
) && !NILP (Voverriding_local_map_menu_flag
))
8016 maps
[nmaps
++] = tem
;
8017 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
8018 maps
[nmaps
++] = tem
;
8021 memcpy (maps
+ nmaps
, tmaps
, nminor
* sizeof (maps
[0]));
8024 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
8027 /* Add global keymap at the end. */
8028 maps
[nmaps
++] = current_global_map
;
8030 /* Process maps in reverse order and look up in each map the prefix
8032 for (i
= nmaps
- 1; i
>= 0; --i
)
8033 if (!NILP (maps
[i
]))
8037 keymap
= get_keymap (access_keymap (maps
[i
], Qtool_bar
, 1, 0, 1), 0, 1);
8039 map_keymap (keymap
, process_tool_bar_item
, Qnil
, NULL
, 1);
8042 Vinhibit_quit
= oquit
;
8043 *nitems
= ntool_bar_items
/ TOOL_BAR_ITEM_NSLOTS
;
8045 return tool_bar_items_vector
;
8049 /* Process the definition of KEY which is DEF. */
8052 process_tool_bar_item (Lisp_Object key
, Lisp_Object def
, Lisp_Object data
, void *args
)
8056 if (EQ (def
, Qundefined
))
8058 /* If a map has an explicit `undefined' as definition,
8059 discard any previously made item. */
8060 for (i
= 0; i
< ntool_bar_items
; i
+= TOOL_BAR_ITEM_NSLOTS
)
8062 Lisp_Object
*v
= XVECTOR (tool_bar_items_vector
)->contents
+ i
;
8064 if (EQ (key
, v
[TOOL_BAR_ITEM_KEY
]))
8066 if (ntool_bar_items
> i
+ TOOL_BAR_ITEM_NSLOTS
)
8067 memmove (v
, v
+ TOOL_BAR_ITEM_NSLOTS
,
8068 ((ntool_bar_items
- i
- TOOL_BAR_ITEM_NSLOTS
)
8070 ntool_bar_items
-= TOOL_BAR_ITEM_NSLOTS
;
8075 else if (parse_tool_bar_item (key
, def
))
8076 /* Append a new tool bar item to tool_bar_items_vector. Accept
8077 more than one definition for the same key. */
8078 append_tool_bar_item ();
8081 /* Access slot with index IDX of vector tool_bar_item_properties. */
8082 #define PROP(IDX) AREF (tool_bar_item_properties, (IDX))
8084 set_prop (ptrdiff_t idx
, Lisp_Object val
)
8086 ASET (tool_bar_item_properties
, idx
, val
);
8090 /* Parse a tool bar item specification ITEM for key KEY and return the
8091 result in tool_bar_item_properties. Value is false if ITEM is
8094 ITEM is a list `(menu-item CAPTION BINDING PROPS...)'.
8096 CAPTION is the caption of the item, If it's not a string, it is
8097 evaluated to get a string.
8099 BINDING is the tool bar item's binding. Tool-bar items with keymaps
8100 as binding are currently ignored.
8102 The following properties are recognized:
8106 FORM is evaluated and specifies whether the tool bar item is
8107 enabled or disabled.
8111 FORM is evaluated and specifies whether the tool bar item is visible.
8113 - `:filter FUNCTION'
8115 FUNCTION is invoked with one parameter `(quote BINDING)'. Its
8116 result is stored as the new binding.
8118 - `:button (TYPE SELECTED)'
8120 TYPE must be one of `:radio' or `:toggle'. SELECTED is evaluated
8121 and specifies whether the button is selected (pressed) or not.
8125 IMAGES is either a single image specification or a vector of four
8126 image specifications. See enum tool_bar_item_images.
8128 - `:help HELP-STRING'.
8130 Gives a help string to display for the tool bar item.
8132 - `:label LABEL-STRING'.
8134 A text label to show with the tool bar button if labels are enabled. */
8137 parse_tool_bar_item (Lisp_Object key
, Lisp_Object item
)
8139 Lisp_Object filter
= Qnil
;
8140 Lisp_Object caption
;
8142 bool have_label
= false;
8144 /* Definition looks like `(menu-item CAPTION BINDING PROPS...)'.
8145 Rule out items that aren't lists, don't start with
8146 `menu-item' or whose rest following `tool-bar-item' is not a
8151 /* As an exception, allow old-style menu separators. */
8152 if (STRINGP (XCAR (item
)))
8153 item
= list1 (XCAR (item
));
8154 else if (!EQ (XCAR (item
), Qmenu_item
)
8155 || (item
= XCDR (item
), !CONSP (item
)))
8158 /* Create tool_bar_item_properties vector if necessary. Reset it to
8160 if (VECTORP (tool_bar_item_properties
))
8162 for (i
= 0; i
< TOOL_BAR_ITEM_NSLOTS
; ++i
)
8166 tool_bar_item_properties
8167 = Fmake_vector (make_number (TOOL_BAR_ITEM_NSLOTS
), Qnil
);
8170 set_prop (TOOL_BAR_ITEM_KEY
, key
);
8171 set_prop (TOOL_BAR_ITEM_ENABLED_P
, Qt
);
8173 /* Get the caption of the item. If the caption is not a string,
8174 evaluate it to get a string. If we don't get a string, skip this
8176 caption
= XCAR (item
);
8177 if (!STRINGP (caption
))
8179 caption
= menu_item_eval_property (caption
);
8180 if (!STRINGP (caption
))
8183 set_prop (TOOL_BAR_ITEM_CAPTION
, caption
);
8185 /* If the rest following the caption is not a list, the menu item is
8186 either a separator, or invalid. */
8190 if (menu_separator_name_p (SSDATA (caption
)))
8192 set_prop (TOOL_BAR_ITEM_TYPE
, Qt
);
8193 #if !defined (USE_GTK) && !defined (HAVE_NS)
8194 /* If we use build_desired_tool_bar_string to render the
8195 tool bar, the separator is rendered as an image. */
8196 set_prop (TOOL_BAR_ITEM_IMAGES
,
8197 (menu_item_eval_property
8198 (Vtool_bar_separator_image_expression
)));
8199 set_prop (TOOL_BAR_ITEM_ENABLED_P
, Qnil
);
8200 set_prop (TOOL_BAR_ITEM_SELECTED_P
, Qnil
);
8201 set_prop (TOOL_BAR_ITEM_CAPTION
, Qnil
);
8208 /* Store the binding. */
8209 set_prop (TOOL_BAR_ITEM_BINDING
, XCAR (item
));
8212 /* Ignore cached key binding, if any. */
8213 if (CONSP (item
) && CONSP (XCAR (item
)))
8216 /* Process the rest of the properties. */
8217 for (; CONSP (item
) && CONSP (XCDR (item
)); item
= XCDR (XCDR (item
)))
8219 Lisp_Object ikey
, value
;
8222 value
= XCAR (XCDR (item
));
8224 if (EQ (ikey
, QCenable
))
8226 /* `:enable FORM'. */
8227 if (!NILP (Venable_disabled_menus_and_buttons
))
8228 set_prop (TOOL_BAR_ITEM_ENABLED_P
, Qt
);
8230 set_prop (TOOL_BAR_ITEM_ENABLED_P
, value
);
8232 else if (EQ (ikey
, QCvisible
))
8234 /* `:visible FORM'. If got a visible property and that
8235 evaluates to nil then ignore this item. */
8236 if (NILP (menu_item_eval_property (value
)))
8239 else if (EQ (ikey
, QChelp
))
8240 /* `:help HELP-STRING'. */
8241 set_prop (TOOL_BAR_ITEM_HELP
, value
);
8242 else if (EQ (ikey
, QCvert_only
))
8243 /* `:vert-only t/nil'. */
8244 set_prop (TOOL_BAR_ITEM_VERT_ONLY
, value
);
8245 else if (EQ (ikey
, QClabel
))
8247 const char *bad_label
= "!!?GARBLED ITEM?!!";
8248 /* `:label LABEL-STRING'. */
8249 set_prop (TOOL_BAR_ITEM_LABEL
,
8250 STRINGP (value
) ? value
: build_string (bad_label
));
8253 else if (EQ (ikey
, QCfilter
))
8254 /* ':filter FORM'. */
8256 else if (EQ (ikey
, QCbutton
) && CONSP (value
))
8258 /* `:button (TYPE . SELECTED)'. */
8259 Lisp_Object type
, selected
;
8261 type
= XCAR (value
);
8262 selected
= XCDR (value
);
8263 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
8265 set_prop (TOOL_BAR_ITEM_SELECTED_P
, selected
);
8266 set_prop (TOOL_BAR_ITEM_TYPE
, type
);
8269 else if (EQ (ikey
, QCimage
)
8271 || (VECTORP (value
) && ASIZE (value
) == 4)))
8272 /* Value is either a single image specification or a vector
8273 of 4 such specifications for the different button states. */
8274 set_prop (TOOL_BAR_ITEM_IMAGES
, value
);
8275 else if (EQ (ikey
, QCrtl
))
8277 set_prop (TOOL_BAR_ITEM_RTL_IMAGE
, value
);
8283 /* Try to make one from caption and key. */
8284 Lisp_Object tkey
= PROP (TOOL_BAR_ITEM_KEY
);
8285 Lisp_Object tcapt
= PROP (TOOL_BAR_ITEM_CAPTION
);
8286 const char *label
= SYMBOLP (tkey
) ? SSDATA (SYMBOL_NAME (tkey
)) : "";
8287 const char *capt
= STRINGP (tcapt
) ? SSDATA (tcapt
) : "";
8289 2 * max (0, min (tool_bar_max_label_size
, STRING_BYTES_BOUND
/ 2));
8290 char *buf
= xmalloc (max_lbl
+ 1);
8291 Lisp_Object new_lbl
;
8292 ptrdiff_t caption_len
= strlen (capt
);
8294 if (caption_len
<= max_lbl
&& capt
[0] != '\0')
8297 while (caption_len
> 0 && buf
[caption_len
- 1] == '.')
8299 buf
[caption_len
] = '\0';
8303 if (strlen (label
) <= max_lbl
&& label
[0] != '\0')
8307 strcpy (buf
, label
);
8309 for (j
= 0; buf
[j
] != '\0'; ++j
)
8317 new_lbl
= Fupcase_initials (build_string (label
));
8318 if (SCHARS (new_lbl
) <= tool_bar_max_label_size
)
8319 set_prop (TOOL_BAR_ITEM_LABEL
, new_lbl
);
8321 set_prop (TOOL_BAR_ITEM_LABEL
, empty_unibyte_string
);
8325 /* If got a filter apply it on binding. */
8327 set_prop (TOOL_BAR_ITEM_BINDING
,
8328 (menu_item_eval_property
8331 PROP (TOOL_BAR_ITEM_BINDING
))))));
8333 /* See if the binding is a keymap. Give up if it is. */
8334 if (CONSP (get_keymap (PROP (TOOL_BAR_ITEM_BINDING
), 0, 1)))
8337 /* Enable or disable selection of item. */
8338 if (!EQ (PROP (TOOL_BAR_ITEM_ENABLED_P
), Qt
))
8339 set_prop (TOOL_BAR_ITEM_ENABLED_P
,
8340 menu_item_eval_property (PROP (TOOL_BAR_ITEM_ENABLED_P
)));
8342 /* Handle radio buttons or toggle boxes. */
8343 if (!NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
)))
8344 set_prop (TOOL_BAR_ITEM_SELECTED_P
,
8345 menu_item_eval_property (PROP (TOOL_BAR_ITEM_SELECTED_P
)));
8353 /* Initialize tool_bar_items_vector. REUSE, if non-nil, is a vector
8354 that can be reused. */
8357 init_tool_bar_items (Lisp_Object reuse
)
8359 if (VECTORP (reuse
))
8360 tool_bar_items_vector
= reuse
;
8362 tool_bar_items_vector
= Fmake_vector (make_number (64), Qnil
);
8363 ntool_bar_items
= 0;
8367 /* Append parsed tool bar item properties from
8368 tool_bar_item_properties */
8371 append_tool_bar_item (void)
8375 - (ASIZE (tool_bar_items_vector
) - TOOL_BAR_ITEM_NSLOTS
));
8377 /* Enlarge tool_bar_items_vector if necessary. */
8379 tool_bar_items_vector
= larger_vector (tool_bar_items_vector
, incr
, -1);
8381 /* Append entries from tool_bar_item_properties to the end of
8382 tool_bar_items_vector. */
8383 vcopy (tool_bar_items_vector
, ntool_bar_items
,
8384 XVECTOR (tool_bar_item_properties
)->contents
, TOOL_BAR_ITEM_NSLOTS
);
8385 ntool_bar_items
+= TOOL_BAR_ITEM_NSLOTS
;
8392 /* Read a character using menus based on the keymap MAP.
8393 Return nil if there are no menus in the maps.
8394 Return t if we displayed a menu but the user rejected it.
8396 PREV_EVENT is the previous input event, or nil if we are reading
8397 the first event of a key sequence.
8399 If USED_MOUSE_MENU is non-null, set *USED_MOUSE_MENU to true
8400 if we used a mouse menu to read the input, or false otherwise. If
8401 USED_MOUSE_MENU is null, don't dereference it.
8403 The prompting is done based on the prompt-string of the map
8404 and the strings associated with various map elements.
8406 This can be done with X menus or with menus put in the minibuf.
8407 These are done in different ways, depending on how the input will be read.
8408 Menus using X are done after auto-saving in read-char, getting the input
8409 event from Fx_popup_menu; menus using the minibuf use read_char recursively
8410 and do auto-saving in the inner call of read_char. */
8413 read_char_x_menu_prompt (Lisp_Object map
,
8414 Lisp_Object prev_event
, bool *used_mouse_menu
)
8416 if (used_mouse_menu
)
8417 *used_mouse_menu
= false;
8419 /* Use local over global Menu maps. */
8421 if (! menu_prompting
)
8424 /* If we got to this point via a mouse click,
8425 use a real menu for mouse selection. */
8426 if (EVENT_HAS_PARAMETERS (prev_event
)
8427 && !EQ (XCAR (prev_event
), Qmenu_bar
)
8428 && !EQ (XCAR (prev_event
), Qtool_bar
))
8430 /* Display the menu and get the selection. */
8433 value
= Fx_popup_menu (prev_event
, get_keymap (map
, 0, 1));
8438 record_menu_key (XCAR (value
));
8440 /* If we got multiple events, unread all but
8442 There is no way to prevent those unread events
8443 from showing up later in last_nonmenu_event.
8444 So turn symbol and integer events into lists,
8445 to indicate that they came from a mouse menu,
8446 so that when present in last_nonmenu_event
8447 they won't confuse things. */
8448 for (tem
= XCDR (value
); CONSP (tem
); tem
= XCDR (tem
))
8450 record_menu_key (XCAR (tem
));
8451 if (SYMBOLP (XCAR (tem
))
8452 || INTEGERP (XCAR (tem
)))
8453 XSETCAR (tem
, Fcons (XCAR (tem
), Qdisabled
));
8456 /* If we got more than one event, put all but the first
8457 onto this list to be read later.
8458 Return just the first event now. */
8459 Vunread_command_events
8460 = nconc2 (XCDR (value
), Vunread_command_events
);
8461 value
= XCAR (value
);
8463 else if (NILP (value
))
8465 if (used_mouse_menu
)
8466 *used_mouse_menu
= true;
8473 read_char_minibuf_menu_prompt (int commandflag
,
8478 /* FIXME: Use the minibuffer's frame width. */
8479 ptrdiff_t width
= FRAME_COLS (SELECTED_FRAME ()) - 4;
8481 bool nobindings
= true;
8482 Lisp_Object rest
, vector
;
8483 Lisp_Object prompt_strings
= Qnil
;
8487 if (! menu_prompting
)
8490 map
= get_keymap (map
, 0, 1);
8491 name
= Fkeymap_prompt (map
);
8493 /* If we don't have any menus, just read a character normally. */
8494 if (!STRINGP (name
))
8497 #define PUSH_C_STR(str, listvar) \
8498 listvar = Fcons (build_unibyte_string (str), listvar)
8500 /* Prompt string always starts with map's prompt, and a space. */
8501 prompt_strings
= Fcons (name
, prompt_strings
);
8502 PUSH_C_STR (": ", prompt_strings
);
8503 nlength
= SCHARS (name
) + 2;
8507 /* Present the documented bindings, a line at a time. */
8510 bool notfirst
= false;
8511 Lisp_Object menu_strings
= prompt_strings
;
8512 ptrdiff_t i
= nlength
;
8514 Lisp_Object orig_defn_macro
;
8516 /* Loop over elements of map. */
8521 /* FIXME: Use map_keymap to handle new keymap formats. */
8523 /* At end of map, wrap around if just starting,
8524 or end this line if already have something on it. */
8527 if (notfirst
|| nobindings
)
8533 /* Look at the next element of the map. */
8535 elt
= AREF (vector
, idx
);
8537 elt
= Fcar_safe (rest
);
8539 if (idx
< 0 && VECTORP (elt
))
8541 /* If we found a dense table in the keymap,
8542 advanced past it, but start scanning its contents. */
8543 rest
= Fcdr_safe (rest
);
8549 /* An ordinary element. */
8550 Lisp_Object event
, tem
;
8554 event
= Fcar_safe (elt
); /* alist */
8555 elt
= Fcdr_safe (elt
);
8559 XSETINT (event
, idx
); /* vector */
8562 /* Ignore the element if it has no prompt string. */
8563 if (INTEGERP (event
) && parse_menu_item (elt
, -1))
8565 /* True if the char to type matches the string. */
8567 Lisp_Object upcased_event
, downcased_event
;
8568 Lisp_Object desc
= Qnil
;
8570 = AREF (item_properties
, ITEM_PROPERTY_NAME
);
8572 upcased_event
= Fupcase (event
);
8573 downcased_event
= Fdowncase (event
);
8574 char_matches
= (XINT (upcased_event
) == SREF (s
, 0)
8575 || XINT (downcased_event
) == SREF (s
, 0));
8577 desc
= Fsingle_key_description (event
, Qnil
);
8579 #if 0 /* It is redundant to list the equivalent key bindings because
8580 the prefix is what the user has already typed. */
8582 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_KEYEQ
];
8584 /* Insert equivalent keybinding. */
8585 s
= concat2 (s
, tem
);
8588 = AREF (item_properties
, ITEM_PROPERTY_TYPE
);
8589 if (EQ (tem
, QCradio
) || EQ (tem
, QCtoggle
))
8591 /* Insert button prefix. */
8592 Lisp_Object selected
8593 = AREF (item_properties
, ITEM_PROPERTY_SELECTED
);
8594 AUTO_STRING (radio_yes
, "(*) ");
8595 AUTO_STRING (radio_no
, "( ) ");
8596 AUTO_STRING (check_yes
, "[X] ");
8597 AUTO_STRING (check_no
, "[ ] ");
8598 if (EQ (tem
, QCradio
))
8599 tem
= NILP (selected
) ? radio_yes
: radio_no
;
8601 tem
= NILP (selected
) ? check_yes
: check_no
;
8602 s
= concat2 (tem
, s
);
8606 /* If we have room for the prompt string, add it to this line.
8607 If this is the first on the line, always add it. */
8608 if ((SCHARS (s
) + i
+ 2
8609 + (char_matches
? 0 : SCHARS (desc
) + 3))
8613 ptrdiff_t thiswidth
;
8615 /* Punctuate between strings. */
8618 PUSH_C_STR (", ", menu_strings
);
8624 /* If the char to type doesn't match the string's
8625 first char, explicitly show what char to type. */
8628 /* Add as much of string as fits. */
8629 thiswidth
= min (SCHARS (desc
), width
- i
);
8631 = Fcons (Fsubstring (desc
, make_number (0),
8632 make_number (thiswidth
)),
8635 PUSH_C_STR (" = ", menu_strings
);
8639 /* Add as much of string as fits. */
8640 thiswidth
= min (SCHARS (s
), width
- i
);
8642 = Fcons (Fsubstring (s
, make_number (0),
8643 make_number (thiswidth
)),
8649 /* If this element does not fit, end the line now,
8650 and save the element for the next line. */
8651 PUSH_C_STR ("...", menu_strings
);
8656 /* Move past this element. */
8657 if (idx
>= 0 && idx
+ 1 >= ASIZE (vector
))
8658 /* Handle reaching end of dense table. */
8663 rest
= Fcdr_safe (rest
);
8667 /* Prompt with that and read response. */
8668 message3_nolog (apply1 (intern ("concat"), Fnreverse (menu_strings
)));
8670 /* Make believe it's not a keyboard macro in case the help char
8671 is pressed. Help characters are not recorded because menu prompting
8672 is not used on replay. */
8673 orig_defn_macro
= KVAR (current_kboard
, defining_kbd_macro
);
8674 kset_defining_kbd_macro (current_kboard
, Qnil
);
8676 obj
= read_char (commandflag
, Qnil
, Qt
, 0, NULL
);
8677 while (BUFFERP (obj
));
8678 kset_defining_kbd_macro (current_kboard
, orig_defn_macro
);
8680 if (!INTEGERP (obj
) || XINT (obj
) == -2
8681 || (! EQ (obj
, menu_prompt_more_char
)
8682 && (!INTEGERP (menu_prompt_more_char
)
8683 || ! EQ (obj
, make_number (Ctl (XINT (menu_prompt_more_char
)))))))
8685 if (!NILP (KVAR (current_kboard
, defining_kbd_macro
)))
8686 store_kbd_macro_char (obj
);
8689 /* Help char - go round again. */
8693 /* Reading key sequences. */
8696 follow_key (Lisp_Object keymap
, Lisp_Object key
)
8698 return access_keymap (get_keymap (keymap
, 0, 1),
8703 active_maps (Lisp_Object first_event
)
8705 Lisp_Object position
8706 = CONSP (first_event
) ? CAR_SAFE (XCDR (first_event
)) : Qnil
;
8707 return Fcons (Qkeymap
, Fcurrent_active_maps (Qt
, position
));
8710 /* Structure used to keep track of partial application of key remapping
8711 such as Vfunction_key_map and Vkey_translation_map. */
8712 typedef struct keyremap
8714 /* This is the map originally specified for this use. */
8716 /* This is a submap reached by looking up, in PARENT,
8717 the events from START to END. */
8719 /* Positions [START, END) in the key sequence buffer
8720 are the key that we have scanned so far.
8721 Those events are the ones that we will replace
8722 if PARENT maps them into a key sequence. */
8726 /* Lookup KEY in MAP.
8727 MAP is a keymap mapping keys to key vectors or functions.
8728 If the mapping is a function and DO_FUNCALL is true,
8729 the function is called with PROMPT as parameter and its return
8730 value is used as the return value of this function (after checking
8731 that it is indeed a vector). */
8734 access_keymap_keyremap (Lisp_Object map
, Lisp_Object key
, Lisp_Object prompt
,
8739 next
= access_keymap (map
, key
, 1, 0, 1);
8741 /* Handle a symbol whose function definition is a keymap
8743 if (SYMBOLP (next
) && !NILP (Ffboundp (next
))
8744 && (ARRAYP (XSYMBOL (next
)->function
)
8745 || KEYMAPP (XSYMBOL (next
)->function
)))
8746 next
= Fautoload_do_load (XSYMBOL (next
)->function
, next
, Qnil
);
8748 /* If the keymap gives a function, not an
8749 array, then call the function with one arg and use
8750 its value instead. */
8751 if (do_funcall
&& FUNCTIONP (next
))
8756 next
= call1 (next
, prompt
);
8757 /* If the function returned something invalid,
8758 barf--don't ignore it. */
8759 if (! (NILP (next
) || VECTORP (next
) || STRINGP (next
)))
8760 error ("Function %s returns invalid key sequence",
8761 SSDATA (SYMBOL_NAME (tem
)));
8766 /* Do one step of the key remapping used for function-key-map and
8767 key-translation-map:
8768 KEYBUF is the buffer holding the input events.
8769 BUFSIZE is its maximum size.
8770 FKEY is a pointer to the keyremap structure to use.
8771 INPUT is the index of the last element in KEYBUF.
8772 DOIT if true says that the remapping can actually take place.
8773 DIFF is used to return the number of keys added/removed by the remapping.
8774 PARENT is the root of the keymap.
8775 PROMPT is the prompt to use if the remapping happens through a function.
8776 Return true if the remapping actually took place. */
8779 keyremap_step (Lisp_Object
*keybuf
, int bufsize
, volatile keyremap
*fkey
,
8780 int input
, bool doit
, int *diff
, Lisp_Object prompt
)
8782 Lisp_Object next
, key
;
8784 key
= keybuf
[fkey
->end
++];
8786 if (KEYMAPP (fkey
->parent
))
8787 next
= access_keymap_keyremap (fkey
->map
, key
, prompt
, doit
);
8791 /* If keybuf[fkey->start..fkey->end] is bound in the
8792 map and we're in a position to do the key remapping, replace it with
8793 the binding and restart with fkey->start at the end. */
8794 if ((VECTORP (next
) || STRINGP (next
)) && doit
)
8796 int len
= XFASTINT (Flength (next
));
8799 *diff
= len
- (fkey
->end
- fkey
->start
);
8801 if (bufsize
- input
<= *diff
)
8802 error ("Key sequence too long");
8804 /* Shift the keys that follow fkey->end. */
8806 for (i
= fkey
->end
; i
< input
; i
++)
8807 keybuf
[i
+ *diff
] = keybuf
[i
];
8809 for (i
= input
- 1; i
>= fkey
->end
; i
--)
8810 keybuf
[i
+ *diff
] = keybuf
[i
];
8811 /* Overwrite the old keys with the new ones. */
8812 for (i
= 0; i
< len
; i
++)
8813 keybuf
[fkey
->start
+ i
]
8814 = Faref (next
, make_number (i
));
8816 fkey
->start
= fkey
->end
+= *diff
;
8817 fkey
->map
= fkey
->parent
;
8822 fkey
->map
= get_keymap (next
, 0, 1);
8824 /* If we no longer have a bound suffix, try a new position for
8826 if (!CONSP (fkey
->map
))
8828 fkey
->end
= ++fkey
->start
;
8829 fkey
->map
= fkey
->parent
;
8835 test_undefined (Lisp_Object binding
)
8837 return (NILP (binding
)
8838 || EQ (binding
, Qundefined
)
8839 || (SYMBOLP (binding
)
8840 && EQ (Fcommand_remapping (binding
, Qnil
, Qnil
), Qundefined
)));
8843 /* Read a sequence of keys that ends with a non prefix character,
8844 storing it in KEYBUF, a buffer of size BUFSIZE.
8846 Return the length of the key sequence stored.
8847 Return -1 if the user rejected a command menu.
8849 Echo starting immediately unless `prompt' is 0.
8851 If PREVENT_REDISPLAY is non-zero, avoid redisplay by calling
8852 read_char with a suitable COMMANDFLAG argument.
8854 Where a key sequence ends depends on the currently active keymaps.
8855 These include any minor mode keymaps active in the current buffer,
8856 the current buffer's local map, and the global map.
8858 If a key sequence has no other bindings, we check Vfunction_key_map
8859 to see if some trailing subsequence might be the beginning of a
8860 function key's sequence. If so, we try to read the whole function
8861 key, and substitute its symbolic name into the key sequence.
8863 We ignore unbound `down-' mouse clicks. We turn unbound `drag-' and
8864 `double-' events into similar click events, if that would make them
8865 bound. We try to turn `triple-' events first into `double-' events,
8868 If we get a mouse click in a mode line, vertical divider, or other
8869 non-text area, we treat the click as if it were prefixed by the
8870 symbol denoting that area - `mode-line', `vertical-line', or
8873 If the sequence starts with a mouse click, we read the key sequence
8874 with respect to the buffer clicked on, not the current buffer.
8876 If the user switches frames in the midst of a key sequence, we put
8877 off the switch-frame event until later; the next call to
8878 read_char will return it.
8880 If FIX_CURRENT_BUFFER, we restore current_buffer
8881 from the selected window's buffer. */
8884 read_key_sequence (Lisp_Object
*keybuf
, int bufsize
, Lisp_Object prompt
,
8885 bool dont_downcase_last
, bool can_return_switch_frame
,
8886 bool fix_current_buffer
, bool prevent_redisplay
)
8888 ptrdiff_t count
= SPECPDL_INDEX ();
8890 /* How many keys there are in the current key sequence. */
8893 /* The length of the echo buffer when we started reading, and
8894 the length of this_command_keys when we started reading. */
8895 ptrdiff_t echo_start UNINIT
;
8896 ptrdiff_t keys_start
;
8898 Lisp_Object current_binding
= Qnil
;
8899 Lisp_Object first_event
= Qnil
;
8901 /* Index of the first key that has no binding.
8902 It is useless to try fkey.start larger than that. */
8905 /* If t < mock_input, then KEYBUF[t] should be read as the next
8908 We use this to recover after recognizing a function key. Once we
8909 realize that a suffix of the current key sequence is actually a
8910 function key's escape sequence, we replace the suffix with the
8911 function key's binding from Vfunction_key_map. Now keybuf
8912 contains a new and different key sequence, so the echo area,
8913 this_command_keys, and the submaps and defs arrays are wrong. In
8914 this situation, we set mock_input to t, set t to 0, and jump to
8915 restart_sequence; the loop will read keys from keybuf up until
8916 mock_input, thus rebuilding the state; and then it will resume
8917 reading characters from the keyboard. */
8920 /* If the sequence is unbound in submaps[], then
8921 keybuf[fkey.start..fkey.end-1] is a prefix in Vfunction_key_map,
8922 and fkey.map is its binding.
8924 These might be > t, indicating that all function key scanning
8925 should hold off until t reaches them. We do this when we've just
8926 recognized a function key, to avoid searching for the function
8927 key's again in Vfunction_key_map. */
8930 /* Likewise, for key_translation_map and input-decode-map. */
8931 keyremap keytran
, indec
;
8933 /* True if we are trying to map a key by changing an upper-case
8934 letter to lower case, or a shifted function key to an unshifted
8936 bool shift_translated
= false;
8938 /* If we receive a `switch-frame' or `select-window' event in the middle of
8939 a key sequence, we put it off for later.
8940 While we're reading, we keep the event here. */
8941 Lisp_Object delayed_switch_frame
;
8943 Lisp_Object original_uppercase UNINIT
;
8944 int original_uppercase_position
= -1;
8946 /* Gets around Microsoft compiler limitations. */
8947 bool dummyflag
= false;
8949 struct buffer
*starting_buffer
;
8951 /* List of events for which a fake prefix key has been generated. */
8952 Lisp_Object fake_prefixed_keys
= Qnil
;
8954 raw_keybuf_count
= 0;
8956 last_nonmenu_event
= Qnil
;
8958 delayed_switch_frame
= Qnil
;
8964 /* Install the string PROMPT as the beginning of the string
8965 of echoing, so that it serves as a prompt for the next
8967 kset_echo_prompt (current_kboard
, prompt
);
8968 /* FIXME: This use of echo_now doesn't look quite right and is ugly
8969 since it forces us to fiddle with current_kboard->immediate_echo
8970 before and after. */
8971 current_kboard
->immediate_echo
= false;
8973 if (!echo_keystrokes_p ())
8974 current_kboard
->immediate_echo
= false;
8976 else if (cursor_in_echo_area
/* FIXME: Not sure why we test this here,
8977 maybe we should just drop this test. */
8978 && echo_keystrokes_p ())
8979 /* This doesn't put in a dash if the echo buffer is empty, so
8980 you don't always see a dash hanging out in the minibuffer. */
8984 /* Record the initial state of the echo area and this_command_keys;
8985 we will need to restore them if we replay a key sequence. */
8987 echo_start
= echo_length ();
8988 keys_start
= this_command_key_count
;
8989 this_single_command_key_start
= keys_start
;
8991 /* We jump here when we need to reinitialize fkey and keytran; this
8992 happens if we switch keyboards between rescans. */
8993 replay_entire_sequence
:
8995 indec
.map
= indec
.parent
= KVAR (current_kboard
, Vinput_decode_map
);
8996 fkey
.map
= fkey
.parent
= KVAR (current_kboard
, Vlocal_function_key_map
);
8997 keytran
.map
= keytran
.parent
= Vkey_translation_map
;
8998 indec
.start
= indec
.end
= 0;
8999 fkey
.start
= fkey
.end
= 0;
9000 keytran
.start
= keytran
.end
= 0;
9002 /* We jump here when the key sequence has been thoroughly changed, and
9003 we need to rescan it starting from the beginning. When we jump here,
9004 keybuf[0..mock_input] holds the sequence we should reread. */
9007 starting_buffer
= current_buffer
;
9008 first_unbound
= bufsize
+ 1;
9010 /* Build our list of keymaps.
9011 If we recognize a function key and replace its escape sequence in
9012 keybuf with its symbol, or if the sequence starts with a mouse
9013 click and we need to switch buffers, we jump back here to rebuild
9014 the initial keymaps from the current buffer. */
9015 current_binding
= active_maps (first_event
);
9017 /* Start from the beginning in keybuf. */
9020 /* These are no-ops the first time through, but if we restart, they
9021 revert the echo area and this_command_keys to their original state. */
9022 this_command_key_count
= keys_start
;
9023 if (INTERACTIVE
&& t
< mock_input
)
9024 echo_truncate (echo_start
);
9026 /* If the best binding for the current key sequence is a keymap, or
9027 we may be looking at a function key's escape sequence, keep on
9029 while (!NILP (current_binding
)
9030 /* Keep reading as long as there's a prefix binding. */
9031 ? KEYMAPP (current_binding
)
9032 /* Don't return in the middle of a possible function key sequence,
9033 if the only bindings we found were via case conversion.
9034 Thus, if ESC O a has a function-key-map translation
9035 and ESC o has a binding, don't return after ESC O,
9036 so that we can translate ESC O plus the next character. */
9037 : (/* indec.start < t || fkey.start < t || */ keytran
.start
< t
))
9040 bool used_mouse_menu
= false;
9042 /* Where the last real key started. If we need to throw away a
9043 key that has expanded into more than one element of keybuf
9044 (say, a mouse click on the mode line which is being treated
9045 as [mode-line (mouse-...)], then we backtrack to this point
9047 int last_real_key_start
;
9049 /* These variables are analogous to echo_start and keys_start;
9050 while those allow us to restart the entire key sequence,
9051 echo_local_start and keys_local_start allow us to throw away
9053 ptrdiff_t echo_local_start UNINIT
;
9054 int keys_local_start
;
9055 Lisp_Object new_binding
;
9057 eassert (indec
.end
== t
|| (indec
.end
> t
&& indec
.end
<= mock_input
));
9058 eassert (indec
.start
<= indec
.end
);
9059 eassert (fkey
.start
<= fkey
.end
);
9060 eassert (keytran
.start
<= keytran
.end
);
9061 /* key-translation-map is applied *after* function-key-map
9062 which is itself applied *after* input-decode-map. */
9063 eassert (fkey
.end
<= indec
.start
);
9064 eassert (keytran
.end
<= fkey
.start
);
9066 if (/* first_unbound < indec.start && first_unbound < fkey.start && */
9067 first_unbound
< keytran
.start
)
9068 { /* The prefix upto first_unbound has no binding and has
9069 no translation left to do either, so we know it's unbound.
9070 If we don't stop now, we risk staying here indefinitely
9071 (if the user keeps entering fkey or keytran prefixes
9072 like C-c ESC ESC ESC ESC ...) */
9074 for (i
= first_unbound
+ 1; i
< t
; i
++)
9075 keybuf
[i
- first_unbound
- 1] = keybuf
[i
];
9076 mock_input
= t
- first_unbound
- 1;
9077 indec
.end
= indec
.start
-= first_unbound
+ 1;
9078 indec
.map
= indec
.parent
;
9079 fkey
.end
= fkey
.start
-= first_unbound
+ 1;
9080 fkey
.map
= fkey
.parent
;
9081 keytran
.end
= keytran
.start
-= first_unbound
+ 1;
9082 keytran
.map
= keytran
.parent
;
9083 goto replay_sequence
;
9087 error ("Key sequence too long");
9090 echo_local_start
= echo_length ();
9091 keys_local_start
= this_command_key_count
;
9094 /* These are no-ops, unless we throw away a keystroke below and
9095 jumped back up to replay_key; in that case, these restore the
9096 variables to their original state, allowing us to replay the
9098 if (INTERACTIVE
&& t
< mock_input
)
9099 echo_truncate (echo_local_start
);
9100 this_command_key_count
= keys_local_start
;
9102 /* By default, assume each event is "real". */
9103 last_real_key_start
= t
;
9105 /* Does mock_input indicate that we are re-reading a key sequence? */
9109 add_command_key (key
);
9110 if (current_kboard
->immediate_echo
)
9112 /* Set immediate_echo to false so as to force echo_now to
9113 redisplay (it will set immediate_echo right back to true). */
9114 current_kboard
->immediate_echo
= false;
9119 /* If not, we should actually read a character. */
9123 KBOARD
*interrupted_kboard
= current_kboard
;
9124 struct frame
*interrupted_frame
= SELECTED_FRAME ();
9125 /* Calling read_char with COMMANDFLAG = -2 avoids
9126 redisplay in read_char and its subroutines. */
9127 key
= read_char (prevent_redisplay
? -2 : NILP (prompt
),
9128 current_binding
, last_nonmenu_event
,
9129 &used_mouse_menu
, NULL
);
9130 if ((INTEGERP (key
) && XINT (key
) == -2) /* wrong_kboard_jmpbuf */
9131 /* When switching to a new tty (with a new keyboard),
9132 read_char returns the new buffer, rather than -2
9133 (Bug#5095). This is because `terminal-init-xterm'
9134 calls read-char, which eats the wrong_kboard_jmpbuf
9135 return. Any better way to fix this? -- cyd */
9136 || (interrupted_kboard
!= current_kboard
))
9141 for (k
= all_kboards
; k
; k
= k
->next_kboard
)
9142 if (k
== interrupted_kboard
)
9147 /* Don't touch interrupted_kboard when it's been
9149 delayed_switch_frame
= Qnil
;
9150 goto replay_entire_sequence
;
9153 if (!NILP (delayed_switch_frame
))
9156 (interrupted_kboard
,
9157 Fcons (delayed_switch_frame
,
9158 KVAR (interrupted_kboard
, kbd_queue
)));
9159 delayed_switch_frame
= Qnil
;
9164 (interrupted_kboard
,
9165 Fcons (keybuf
[--t
], KVAR (interrupted_kboard
, kbd_queue
)));
9167 /* If the side queue is non-empty, ensure it begins with a
9168 switch-frame, so we'll replay it in the right context. */
9169 if (CONSP (KVAR (interrupted_kboard
, kbd_queue
))
9170 && (key
= XCAR (KVAR (interrupted_kboard
, kbd_queue
)),
9171 !(EVENT_HAS_PARAMETERS (key
)
9172 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)),
9176 XSETFRAME (frame
, interrupted_frame
);
9178 (interrupted_kboard
,
9179 Fcons (make_lispy_switch_frame (frame
),
9180 KVAR (interrupted_kboard
, kbd_queue
)));
9183 goto replay_entire_sequence
;
9187 /* read_char returns t when it shows a menu and the user rejects it.
9191 unbind_to (count
, Qnil
);
9195 /* read_char returns -1 at the end of a macro.
9196 Emacs 18 handles this by returning immediately with a
9197 zero, so that's what we'll do. */
9198 if (INTEGERP (key
) && XINT (key
) == -1)
9201 /* The Microsoft C compiler can't handle the goto that
9207 /* If the current buffer has been changed from under us, the
9208 keymap may have changed, so replay the sequence. */
9211 timer_resume_idle ();
9214 /* Reset the current buffer from the selected window
9215 in case something changed the former and not the latter.
9216 This is to be more consistent with the behavior
9217 of the command_loop_1. */
9218 if (fix_current_buffer
)
9220 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
9222 if (XBUFFER (XWINDOW (selected_window
)->contents
)
9224 Fset_buffer (XWINDOW (selected_window
)->contents
);
9227 goto replay_sequence
;
9230 /* If we have a quit that was typed in another frame, and
9231 quit_throw_to_read_char switched buffers,
9232 replay to get the right keymap. */
9234 && XINT (key
) == quit_char
9235 && current_buffer
!= starting_buffer
)
9238 ASET (raw_keybuf
, raw_keybuf_count
, key
);
9243 goto replay_sequence
;
9248 if (EVENT_HAS_PARAMETERS (key
)
9249 /* Either a `switch-frame' or a `select-window' event. */
9250 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)), Qswitch_frame
))
9252 /* If we're at the beginning of a key sequence, and the caller
9253 says it's okay, go ahead and return this event. If we're
9254 in the midst of a key sequence, delay it until the end. */
9255 if (t
> 0 || !can_return_switch_frame
)
9257 delayed_switch_frame
= key
;
9262 if (NILP (first_event
))
9265 /* Even if first_event does not specify a particular
9266 window/position, it's important to recompute the maps here
9267 since a long time might have passed since we entered
9268 read_key_sequence, and a timer (or process-filter or
9269 special-event-map, ...) might have switched the current buffer
9270 or the selected window from under us in the mean time. */
9271 if (fix_current_buffer
9272 && (XBUFFER (XWINDOW (selected_window
)->contents
)
9274 Fset_buffer (XWINDOW (selected_window
)->contents
);
9275 current_binding
= active_maps (first_event
);
9279 ASET (raw_keybuf
, raw_keybuf_count
, key
);
9283 /* Clicks in non-text areas get prefixed by the symbol
9284 in their CHAR-ADDRESS field. For example, a click on
9285 the mode line is prefixed by the symbol `mode-line'.
9287 Furthermore, key sequences beginning with mouse clicks
9288 are read using the keymaps of the buffer clicked on, not
9289 the current buffer. So we may have to switch the buffer
9292 When we turn one event into two events, we must make sure
9293 that neither of the two looks like the original--so that,
9294 if we replay the events, they won't be expanded again.
9295 If not for this, such reexpansion could happen either here
9296 or when user programs play with this-command-keys. */
9297 if (EVENT_HAS_PARAMETERS (key
))
9299 Lisp_Object kind
= EVENT_HEAD_KIND (EVENT_HEAD (key
));
9300 if (EQ (kind
, Qmouse_click
))
9302 Lisp_Object window
= POSN_WINDOW (EVENT_START (key
));
9303 Lisp_Object posn
= POSN_POSN (EVENT_START (key
));
9306 || (!NILP (fake_prefixed_keys
)
9307 && !NILP (Fmemq (key
, fake_prefixed_keys
))))
9309 /* We're looking a second time at an event for which
9310 we generated a fake prefix key. Set
9311 last_real_key_start appropriately. */
9313 last_real_key_start
= t
- 1;
9316 if (last_real_key_start
== 0)
9318 /* Key sequences beginning with mouse clicks are
9319 read using the keymaps in the buffer clicked on,
9320 not the current buffer. If we're at the
9321 beginning of a key sequence, switch buffers. */
9322 if (WINDOWP (window
)
9323 && BUFFERP (XWINDOW (window
)->contents
)
9324 && XBUFFER (XWINDOW (window
)->contents
) != current_buffer
)
9326 ASET (raw_keybuf
, raw_keybuf_count
, key
);
9331 /* Arrange to go back to the original buffer once we're
9332 done reading the key sequence. Note that we can't
9333 use save_excursion_{save,restore} here, because they
9334 save point as well as the current buffer; we don't
9335 want to save point, because redisplay may change it,
9336 to accommodate a Fset_window_start or something. We
9337 don't want to do this at the top of the function,
9338 because we may get input from a subprocess which
9339 wants to change the selected window and stuff (say,
9341 record_unwind_current_buffer ();
9343 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
9345 set_buffer_internal (XBUFFER (XWINDOW (window
)->contents
));
9346 goto replay_sequence
;
9350 /* Expand mode-line and scroll-bar events into two events:
9351 use posn as a fake prefix key. */
9353 && (NILP (fake_prefixed_keys
)
9354 || NILP (Fmemq (key
, fake_prefixed_keys
))))
9356 if (bufsize
- t
<= 1)
9357 error ("Key sequence too long");
9360 keybuf
[t
+ 1] = key
;
9363 /* Record that a fake prefix key has been generated
9364 for KEY. Don't modify the event; this would
9365 prevent proper action when the event is pushed
9366 back into unread-command-events. */
9367 fake_prefixed_keys
= Fcons (key
, fake_prefixed_keys
);
9371 else if (CONSP (XCDR (key
))
9372 && CONSP (EVENT_START (key
))
9373 && CONSP (XCDR (EVENT_START (key
))))
9377 posn
= POSN_POSN (EVENT_START (key
));
9378 /* Handle menu-bar events:
9379 insert the dummy prefix event `menu-bar'. */
9380 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
9382 if (bufsize
- t
<= 1)
9383 error ("Key sequence too long");
9385 keybuf
[t
+ 1] = key
;
9387 /* Zap the position in key, so we know that we've
9388 expanded it, and don't try to do so again. */
9389 POSN_SET_POSN (EVENT_START (key
), list1 (posn
));
9392 goto replay_sequence
;
9394 else if (CONSP (posn
))
9396 /* We're looking at the second event of a
9397 sequence which we expanded before. Set
9398 last_real_key_start appropriately. */
9399 if (last_real_key_start
== t
&& t
> 0)
9400 last_real_key_start
= t
- 1;
9405 /* We have finally decided that KEY is something we might want
9407 new_binding
= follow_key (current_binding
, key
);
9409 /* If KEY wasn't bound, we'll try some fallbacks. */
9410 if (!NILP (new_binding
))
9411 /* This is needed for the following scenario:
9412 event 0: a down-event that gets dropped by calling replay_key.
9413 event 1: some normal prefix like C-h.
9414 After event 0, first_unbound is 0, after event 1 indec.start,
9415 fkey.start, and keytran.start are all 1, so when we see that
9416 C-h is bound, we need to update first_unbound. */
9417 first_unbound
= max (t
+ 1, first_unbound
);
9422 /* Remember the position to put an upper bound on indec.start. */
9423 first_unbound
= min (t
, first_unbound
);
9425 head
= EVENT_HEAD (key
);
9429 Lisp_Object breakdown
;
9432 breakdown
= parse_modifiers (head
);
9433 modifiers
= XINT (XCAR (XCDR (breakdown
)));
9434 /* Attempt to reduce an unbound mouse event to a simpler
9435 event that is bound:
9436 Drags reduce to clicks.
9437 Double-clicks reduce to clicks.
9438 Triple-clicks reduce to double-clicks, then to clicks.
9439 Up/Down-clicks are eliminated.
9440 Double-downs reduce to downs, then are eliminated.
9441 Triple-downs reduce to double-downs, then to downs,
9442 then are eliminated. */
9443 if (modifiers
& (up_modifier
| down_modifier
9445 | double_modifier
| triple_modifier
))
9447 while (modifiers
& (up_modifier
| down_modifier
9449 | double_modifier
| triple_modifier
))
9451 Lisp_Object new_head
, new_click
;
9452 if (modifiers
& triple_modifier
)
9453 modifiers
^= (double_modifier
| triple_modifier
);
9454 else if (modifiers
& double_modifier
)
9455 modifiers
&= ~double_modifier
;
9456 else if (modifiers
& drag_modifier
)
9457 modifiers
&= ~drag_modifier
;
9460 /* Dispose of this `up/down' event by simply jumping
9461 back to replay_key, to get another event.
9463 Note that if this event came from mock input,
9464 then just jumping back to replay_key will just
9465 hand it to us again. So we have to wipe out any
9468 We could delete keybuf[t] and shift everything
9469 after that to the left by one spot, but we'd also
9470 have to fix up any variable that points into
9471 keybuf, and shifting isn't really necessary
9474 Adding prefixes for non-textual mouse clicks
9475 creates two characters of mock input, and both
9476 must be thrown away. If we're only looking at
9477 the prefix now, we can just jump back to
9478 replay_key. On the other hand, if we've already
9479 processed the prefix, and now the actual click
9480 itself is giving us trouble, then we've lost the
9481 state of the keymaps we want to backtrack to, and
9482 we need to replay the whole sequence to rebuild
9485 Beyond that, only function key expansion could
9486 create more than two keys, but that should never
9487 generate mouse events, so it's okay to zero
9488 mock_input in that case too.
9490 FIXME: The above paragraph seems just plain
9491 wrong, if you consider things like
9492 xterm-mouse-mode. -stef
9494 Isn't this just the most wonderful code ever? */
9496 /* If mock_input > t + 1, the above simplification
9497 will actually end up dropping keys on the floor.
9498 This is probably OK for now, but even
9499 if mock_input <= t + 1, we need to adjust indec,
9501 Typical case [header-line down-mouse-N]:
9502 mock_input = 2, t = 1, fkey.end = 1,
9503 last_real_key_start = 0. */
9504 if (indec
.end
> last_real_key_start
)
9506 indec
.end
= indec
.start
9507 = min (last_real_key_start
, indec
.start
);
9508 indec
.map
= indec
.parent
;
9509 if (fkey
.end
> last_real_key_start
)
9511 fkey
.end
= fkey
.start
9512 = min (last_real_key_start
, fkey
.start
);
9513 fkey
.map
= fkey
.parent
;
9514 if (keytran
.end
> last_real_key_start
)
9516 keytran
.end
= keytran
.start
9517 = min (last_real_key_start
, keytran
.start
);
9518 keytran
.map
= keytran
.parent
;
9522 if (t
== last_real_key_start
)
9529 mock_input
= last_real_key_start
;
9530 goto replay_sequence
;
9535 = apply_modifiers (modifiers
, XCAR (breakdown
));
9536 new_click
= list2 (new_head
, EVENT_START (key
));
9538 /* Look for a binding for this new key. */
9539 new_binding
= follow_key (current_binding
, new_click
);
9541 /* If that click is bound, go for it. */
9542 if (!NILP (new_binding
))
9544 current_binding
= new_binding
;
9548 /* Otherwise, we'll leave key set to the drag event. */
9553 current_binding
= new_binding
;
9556 /* Normally, last_nonmenu_event gets the previous key we read.
9557 But when a mouse popup menu is being used,
9558 we don't update last_nonmenu_event; it continues to hold the mouse
9559 event that preceded the first level of menu. */
9560 if (!used_mouse_menu
)
9561 last_nonmenu_event
= key
;
9563 /* Record what part of this_command_keys is the current key sequence. */
9564 this_single_command_key_start
= this_command_key_count
- t
;
9565 /* When 'input-method-function' called above causes events to be
9566 put on 'unread-post-input-method-events', and as result
9567 'reread' is set to 'true', the value of 't' can become larger
9568 than 'this_command_key_count', because 'add_command_key' is
9569 not called to update 'this_command_key_count'. If this
9570 happens, 'this_single_command_key_start' will become negative
9571 above, and any call to 'this-single-command-keys' will return
9572 a garbled vector. See bug #20223 for one such situation.
9573 Here we force 'this_single_command_key_start' to never become
9574 negative, to avoid that. */
9575 if (this_single_command_key_start
< 0)
9576 this_single_command_key_start
= 0;
9578 /* Look for this sequence in input-decode-map.
9579 Scan from indec.end until we find a bound suffix. */
9580 while (indec
.end
< t
)
9585 done
= keyremap_step (keybuf
, bufsize
, &indec
, max (t
, mock_input
),
9589 mock_input
= diff
+ max (t
, mock_input
);
9590 goto replay_sequence
;
9594 if (!KEYMAPP (current_binding
)
9595 && !test_undefined (current_binding
)
9596 && indec
.start
>= t
)
9597 /* There is a binding and it's not a prefix.
9598 (and it doesn't have any input-decode-map translation pending).
9599 There is thus no function-key in this sequence.
9600 Moving fkey.start is important in this case to allow keytran.start
9601 to go over the sequence before we return (since we keep the
9602 invariant that keytran.end <= fkey.start). */
9605 (fkey
.start
= fkey
.end
= t
, fkey
.map
= fkey
.parent
);
9608 /* If the sequence is unbound, see if we can hang a function key
9609 off the end of it. */
9610 /* Continue scan from fkey.end until we find a bound suffix. */
9611 while (fkey
.end
< indec
.start
)
9616 done
= keyremap_step (keybuf
, bufsize
, &fkey
,
9617 max (t
, mock_input
),
9618 /* If there's a binding (i.e.
9619 first_binding >= nmaps) we don't want
9620 to apply this function-key-mapping. */
9622 && (test_undefined (current_binding
)),
9626 mock_input
= diff
+ max (t
, mock_input
);
9627 /* Adjust the input-decode-map counters. */
9629 indec
.start
+= diff
;
9631 goto replay_sequence
;
9635 /* Look for this sequence in key-translation-map.
9636 Scan from keytran.end until we find a bound suffix. */
9637 while (keytran
.end
< fkey
.start
)
9642 done
= keyremap_step (keybuf
, bufsize
, &keytran
, max (t
, mock_input
),
9646 mock_input
= diff
+ max (t
, mock_input
);
9647 /* Adjust the function-key-map and input-decode-map counters. */
9649 indec
.start
+= diff
;
9653 goto replay_sequence
;
9657 /* If KEY is not defined in any of the keymaps,
9658 and cannot be part of a function key or translation,
9659 and is an upper case letter
9660 use the corresponding lower-case letter instead. */
9661 if (NILP (current_binding
)
9662 && /* indec.start >= t && fkey.start >= t && */ keytran
.start
>= t
9664 && ((CHARACTERP (make_number (XINT (key
) & ~CHAR_MODIFIER_MASK
))
9665 && uppercasep (XINT (key
) & ~CHAR_MODIFIER_MASK
))
9666 || (XINT (key
) & shift_modifier
)))
9668 Lisp_Object new_key
;
9670 original_uppercase
= key
;
9671 original_uppercase_position
= t
- 1;
9673 if (XINT (key
) & shift_modifier
)
9674 XSETINT (new_key
, XINT (key
) & ~shift_modifier
);
9676 XSETINT (new_key
, (downcase (XINT (key
) & ~CHAR_MODIFIER_MASK
)
9677 | (XINT (key
) & CHAR_MODIFIER_MASK
)));
9679 /* We have to do this unconditionally, regardless of whether
9680 the lower-case char is defined in the keymaps, because they
9681 might get translated through function-key-map. */
9682 keybuf
[t
- 1] = new_key
;
9683 mock_input
= max (t
, mock_input
);
9684 shift_translated
= true;
9686 goto replay_sequence
;
9689 if (NILP (current_binding
)
9690 && help_char_p (EVENT_HEAD (key
)) && t
> 1)
9692 read_key_sequence_cmd
= Vprefix_help_command
;
9693 /* The Microsoft C compiler can't handle the goto that
9699 /* If KEY is not defined in any of the keymaps,
9700 and cannot be part of a function key or translation,
9701 and is a shifted function key,
9702 use the corresponding unshifted function key instead. */
9703 if (NILP (current_binding
)
9704 && /* indec.start >= t && fkey.start >= t && */ keytran
.start
>= t
)
9706 Lisp_Object breakdown
= parse_modifiers (key
);
9708 = CONSP (breakdown
) ? (XINT (XCAR (XCDR (breakdown
)))) : 0;
9710 if (modifiers
& shift_modifier
9711 /* Treat uppercase keys as shifted. */
9713 && (KEY_TO_CHAR (key
)
9714 < XCHAR_TABLE (BVAR (current_buffer
, downcase_table
))->header
.size
)
9715 && uppercasep (KEY_TO_CHAR (key
))))
9718 = (modifiers
& shift_modifier
9719 ? apply_modifiers (modifiers
& ~shift_modifier
,
9721 : make_number (downcase (KEY_TO_CHAR (key
)) | modifiers
));
9723 original_uppercase
= key
;
9724 original_uppercase_position
= t
- 1;
9726 /* We have to do this unconditionally, regardless of whether
9727 the lower-case char is defined in the keymaps, because they
9728 might get translated through function-key-map. */
9729 keybuf
[t
- 1] = new_key
;
9730 mock_input
= max (t
, mock_input
);
9731 /* Reset fkey (and consequently keytran) to apply
9732 function-key-map on the result, so that S-backspace is
9733 correctly mapped to DEL (via backspace). OTOH,
9734 input-decode-map doesn't need to go through it again. */
9735 fkey
.start
= fkey
.end
= 0;
9736 keytran
.start
= keytran
.end
= 0;
9737 shift_translated
= true;
9739 goto replay_sequence
;
9744 read_key_sequence_cmd
= current_binding
;
9745 read_key_sequence_remapped
9746 /* Remap command through active keymaps.
9747 Do the remapping here, before the unbind_to so it uses the keymaps
9748 of the appropriate buffer. */
9749 = SYMBOLP (read_key_sequence_cmd
)
9750 ? Fcommand_remapping (read_key_sequence_cmd
, Qnil
, Qnil
)
9753 unread_switch_frame
= delayed_switch_frame
;
9754 unbind_to (count
, Qnil
);
9756 /* Don't downcase the last character if the caller says don't.
9757 Don't downcase it if the result is undefined, either. */
9758 if ((dont_downcase_last
|| NILP (current_binding
))
9760 && t
- 1 == original_uppercase_position
)
9762 keybuf
[t
- 1] = original_uppercase
;
9763 shift_translated
= false;
9766 if (shift_translated
)
9767 Vthis_command_keys_shift_translated
= Qt
;
9769 /* Occasionally we fabricate events, perhaps by expanding something
9770 according to function-key-map, or by adding a prefix symbol to a
9771 mouse click in the scroll bar or modeline. In this cases, return
9772 the entire generated key sequence, even if we hit an unbound
9773 prefix or a definition before the end. This means that you will
9774 be able to push back the event properly, and also means that
9775 read-key-sequence will always return a logical unit.
9778 for (; t
< mock_input
; t
++)
9779 add_command_key (keybuf
[t
]);
9786 read_key_sequence_vs (Lisp_Object prompt
, Lisp_Object continue_echo
,
9787 Lisp_Object dont_downcase_last
,
9788 Lisp_Object can_return_switch_frame
,
9789 Lisp_Object cmd_loop
, bool allow_string
)
9791 Lisp_Object keybuf
[30];
9793 ptrdiff_t count
= SPECPDL_INDEX ();
9796 CHECK_STRING (prompt
);
9799 specbind (Qinput_method_exit_on_first_char
,
9800 (NILP (cmd_loop
) ? Qt
: Qnil
));
9801 specbind (Qinput_method_use_echo_area
,
9802 (NILP (cmd_loop
) ? Qt
: Qnil
));
9804 if (NILP (continue_echo
))
9806 this_command_key_count
= 0;
9807 this_single_command_key_start
= 0;
9810 #ifdef HAVE_WINDOW_SYSTEM
9811 if (display_hourglass_p
)
9812 cancel_hourglass ();
9815 i
= read_key_sequence (keybuf
, ARRAYELTS (keybuf
),
9816 prompt
, ! NILP (dont_downcase_last
),
9817 ! NILP (can_return_switch_frame
), 0, 0);
9819 #if 0 /* The following is fine for code reading a key sequence and
9820 then proceeding with a lengthy computation, but it's not good
9821 for code reading keys in a loop, like an input method. */
9822 #ifdef HAVE_WINDOW_SYSTEM
9823 if (display_hourglass_p
)
9834 return unbind_to (count
,
9835 ((allow_string
? make_event_array
: Fvector
)
9839 DEFUN ("read-key-sequence", Fread_key_sequence
, Sread_key_sequence
, 1, 5, 0,
9840 doc
: /* Read a sequence of keystrokes and return as a string or vector.
9841 The sequence is sufficient to specify a non-prefix command in the
9842 current local and global maps.
9844 First arg PROMPT is a prompt string. If nil, do not prompt specially.
9845 Second (optional) arg CONTINUE-ECHO, if non-nil, means this key echos
9846 as a continuation of the previous key.
9848 The third (optional) arg DONT-DOWNCASE-LAST, if non-nil, means do not
9849 convert the last event to lower case. (Normally any upper case event
9850 is converted to lower case if the original event is undefined and the lower
9851 case equivalent is defined.) A non-nil value is appropriate for reading
9852 a key sequence to be defined.
9854 A C-g typed while in this function is treated like any other character,
9855 and `quit-flag' is not set.
9857 If the key sequence starts with a mouse click, then the sequence is read
9858 using the keymaps of the buffer of the window clicked in, not the buffer
9859 of the selected window as normal.
9861 `read-key-sequence' drops unbound button-down events, since you normally
9862 only care about the click or drag events which follow them. If a drag
9863 or multi-click event is unbound, but the corresponding click event would
9864 be bound, `read-key-sequence' turns the event into a click event at the
9865 drag's starting position. This means that you don't have to distinguish
9866 between click and drag, double, or triple events unless you want to.
9868 `read-key-sequence' prefixes mouse events on mode lines, the vertical
9869 lines separating windows, and scroll bars with imaginary keys
9870 `mode-line', `vertical-line', and `vertical-scroll-bar'.
9872 Optional fourth argument CAN-RETURN-SWITCH-FRAME non-nil means that this
9873 function will process a switch-frame event if the user switches frames
9874 before typing anything. If the user switches frames in the middle of a
9875 key sequence, or at the start of the sequence but CAN-RETURN-SWITCH-FRAME
9876 is nil, then the event will be put off until after the current key sequence.
9878 `read-key-sequence' checks `function-key-map' for function key
9879 sequences, where they wouldn't conflict with ordinary bindings. See
9880 `function-key-map' for more details.
9882 The optional fifth argument CMD-LOOP, if non-nil, means
9883 that this key sequence is being read by something that will
9884 read commands one after another. It should be nil if the caller
9885 will read just one key sequence. */)
9886 (Lisp_Object prompt
, Lisp_Object continue_echo
, Lisp_Object dont_downcase_last
, Lisp_Object can_return_switch_frame
, Lisp_Object cmd_loop
)
9888 return read_key_sequence_vs (prompt
, continue_echo
, dont_downcase_last
,
9889 can_return_switch_frame
, cmd_loop
, true);
9892 DEFUN ("read-key-sequence-vector", Fread_key_sequence_vector
,
9893 Sread_key_sequence_vector
, 1, 5, 0,
9894 doc
: /* Like `read-key-sequence' but always return a vector. */)
9895 (Lisp_Object prompt
, Lisp_Object continue_echo
, Lisp_Object dont_downcase_last
, Lisp_Object can_return_switch_frame
, Lisp_Object cmd_loop
)
9897 return read_key_sequence_vs (prompt
, continue_echo
, dont_downcase_last
,
9898 can_return_switch_frame
, cmd_loop
, false);
9901 /* Return true if input events are pending. */
9904 detect_input_pending (void)
9906 return input_pending
|| get_input_pending (0);
9909 /* Return true if input events other than mouse movements are
9913 detect_input_pending_ignore_squeezables (void)
9915 return input_pending
|| get_input_pending (READABLE_EVENTS_IGNORE_SQUEEZABLES
);
9918 /* Return true if input events are pending, and run any pending timers. */
9921 detect_input_pending_run_timers (bool do_display
)
9923 unsigned old_timers_run
= timers_run
;
9926 get_input_pending (READABLE_EVENTS_DO_TIMERS_NOW
);
9928 if (old_timers_run
!= timers_run
&& do_display
)
9929 redisplay_preserve_echo_area (8);
9931 return input_pending
;
9934 /* This is called in some cases before a possible quit.
9935 It cases the next call to detect_input_pending to recompute input_pending.
9936 So calling this function unnecessarily can't do any harm. */
9939 clear_input_pending (void)
9941 input_pending
= false;
9944 /* Return true if there are pending requeued events.
9945 This isn't used yet. The hope is to make wait_reading_process_output
9946 call it, and return if it runs Lisp code that unreads something.
9947 The problem is, kbd_buffer_get_event needs to be fixed to know what
9948 to do in that case. It isn't trivial. */
9951 requeued_events_pending_p (void)
9953 return (CONSP (Vunread_command_events
));
9956 DEFUN ("input-pending-p", Finput_pending_p
, Sinput_pending_p
, 0, 1, 0,
9957 doc
: /* Return t if command input is currently available with no wait.
9958 Actually, the value is nil only if we can be sure that no input is available;
9959 if there is a doubt, the value is t.
9961 If CHECK-TIMERS is non-nil, timers that are ready to run will do so. */)
9962 (Lisp_Object check_timers
)
9964 if (CONSP (Vunread_command_events
)
9965 || !NILP (Vunread_post_input_method_events
)
9966 || !NILP (Vunread_input_method_events
))
9969 /* Process non-user-visible events (Bug#10195). */
9970 process_special_events ();
9972 return (get_input_pending ((NILP (check_timers
)
9973 ? 0 : READABLE_EVENTS_DO_TIMERS_NOW
)
9974 | READABLE_EVENTS_FILTER_EVENTS
)
9978 DEFUN ("recent-keys", Frecent_keys
, Srecent_keys
, 0, 1, 0,
9979 doc
: /* Return vector of last few events, not counting those from keyboard macros.
9980 If INCLUDE-CMDS is non-nil, include the commands that were run,
9981 represented as events of the form (nil . COMMAND). */)
9982 (Lisp_Object include_cmds
)
9984 bool cmds
= !NILP (include_cmds
);
9987 || (cmds
&& total_keys
< NUM_RECENT_KEYS
))
9988 return Fvector (total_keys
,
9989 XVECTOR (recent_keys
)->contents
);
9992 Lisp_Object es
= Qnil
;
9993 int i
= (total_keys
< NUM_RECENT_KEYS
9994 ? 0 : recent_keys_index
);
9995 eassert (recent_keys_index
< NUM_RECENT_KEYS
);
9998 Lisp_Object e
= AREF (recent_keys
, i
);
9999 if (cmds
|| !CONSP (e
) || !NILP (XCAR (e
)))
10000 es
= Fcons (e
, es
);
10001 if (++i
>= NUM_RECENT_KEYS
)
10003 } while (i
!= recent_keys_index
);
10004 es
= Fnreverse (es
);
10005 return Fvconcat (1, &es
);
10009 DEFUN ("this-command-keys", Fthis_command_keys
, Sthis_command_keys
, 0, 0, 0,
10010 doc
: /* Return the key sequence that invoked this command.
10011 However, if the command has called `read-key-sequence', it returns
10012 the last key sequence that has been read.
10013 The value is a string or a vector.
10015 See also `this-command-keys-vector'. */)
10018 return make_event_array (this_command_key_count
,
10019 XVECTOR (this_command_keys
)->contents
);
10022 DEFUN ("this-command-keys-vector", Fthis_command_keys_vector
, Sthis_command_keys_vector
, 0, 0, 0,
10023 doc
: /* Return the key sequence that invoked this command, as a vector.
10024 However, if the command has called `read-key-sequence', it returns
10025 the last key sequence that has been read.
10027 See also `this-command-keys'. */)
10030 return Fvector (this_command_key_count
,
10031 XVECTOR (this_command_keys
)->contents
);
10034 DEFUN ("this-single-command-keys", Fthis_single_command_keys
,
10035 Sthis_single_command_keys
, 0, 0, 0,
10036 doc
: /* Return the key sequence that invoked this command.
10037 More generally, it returns the last key sequence read, either by
10038 the command loop or by `read-key-sequence'.
10039 Unlike `this-command-keys', this function's value
10040 does not include prefix arguments.
10041 The value is always a vector. */)
10044 return Fvector (this_command_key_count
10045 - this_single_command_key_start
,
10046 (XVECTOR (this_command_keys
)->contents
10047 + this_single_command_key_start
));
10050 DEFUN ("this-single-command-raw-keys", Fthis_single_command_raw_keys
,
10051 Sthis_single_command_raw_keys
, 0, 0, 0,
10052 doc
: /* Return the raw events that were read for this command.
10053 More generally, it returns the last key sequence read, either by
10054 the command loop or by `read-key-sequence'.
10055 Unlike `this-single-command-keys', this function's value
10056 shows the events before all translations (except for input methods).
10057 The value is always a vector. */)
10060 return Fvector (raw_keybuf_count
, XVECTOR (raw_keybuf
)->contents
);
10063 DEFUN ("clear-this-command-keys", Fclear_this_command_keys
,
10064 Sclear_this_command_keys
, 0, 1, 0,
10065 doc
: /* Clear out the vector that `this-command-keys' returns.
10066 Also clear the record of the last 100 events, unless optional arg
10067 KEEP-RECORD is non-nil. */)
10068 (Lisp_Object keep_record
)
10072 this_command_key_count
= 0;
10074 if (NILP (keep_record
))
10076 for (i
= 0; i
< ASIZE (recent_keys
); ++i
)
10077 ASET (recent_keys
, i
, Qnil
);
10079 recent_keys_index
= 0;
10084 DEFUN ("recursion-depth", Frecursion_depth
, Srecursion_depth
, 0, 0, 0,
10085 doc
: /* Return the current depth in recursive edits. */)
10089 INT_ADD_WRAPV (command_loop_level
, minibuf_level
, &sum
);
10090 return make_number (sum
);
10093 DEFUN ("open-dribble-file", Fopen_dribble_file
, Sopen_dribble_file
, 1, 1,
10094 "FOpen dribble file: ",
10095 doc
: /* Start writing all keyboard characters to a dribble file called FILE.
10096 If FILE is nil, close any open dribble file.
10097 The file will be closed when Emacs exits.
10099 Be aware that this records ALL characters you type!
10100 This may include sensitive information such as passwords. */)
10113 Lisp_Object encfile
;
10115 file
= Fexpand_file_name (file
, Qnil
);
10116 encfile
= ENCODE_FILE (file
);
10117 fd
= emacs_open (SSDATA (encfile
), O_WRONLY
| O_CREAT
| O_EXCL
, 0600);
10118 if (fd
< 0 && errno
== EEXIST
&& unlink (SSDATA (encfile
)) == 0)
10119 fd
= emacs_open (SSDATA (encfile
), O_WRONLY
| O_CREAT
| O_EXCL
, 0600);
10120 dribble
= fd
< 0 ? 0 : fdopen (fd
, "w");
10122 report_file_error ("Opening dribble", file
);
10127 DEFUN ("discard-input", Fdiscard_input
, Sdiscard_input
, 0, 0, 0,
10128 doc
: /* Discard the contents of the terminal input buffer.
10129 Also end any kbd macro being defined. */)
10132 if (!NILP (KVAR (current_kboard
, defining_kbd_macro
)))
10134 /* Discard the last command from the macro. */
10135 Fcancel_kbd_macro_events ();
10139 Vunread_command_events
= Qnil
;
10141 discard_tty_input ();
10143 kbd_fetch_ptr
= kbd_store_ptr
;
10144 input_pending
= false;
10149 DEFUN ("suspend-emacs", Fsuspend_emacs
, Ssuspend_emacs
, 0, 1, "",
10150 doc
: /* Stop Emacs and return to superior process. You can resume later.
10151 If `cannot-suspend' is non-nil, or if the system doesn't support job
10152 control, run a subshell instead.
10154 If optional arg STUFFSTRING is non-nil, its characters are stuffed
10155 to be read as terminal input by Emacs's parent, after suspension.
10157 Before suspending, run the normal hook `suspend-hook'.
10158 After resumption run the normal hook `suspend-resume-hook'.
10160 Some operating systems cannot stop the Emacs process and resume it later.
10161 On such systems, Emacs starts a subshell instead of suspending. */)
10162 (Lisp_Object stuffstring
)
10164 ptrdiff_t count
= SPECPDL_INDEX ();
10165 int old_height
, old_width
;
10168 if (tty_list
&& tty_list
->next
)
10169 error ("There are other tty frames open; close them before suspending Emacs");
10171 if (!NILP (stuffstring
))
10172 CHECK_STRING (stuffstring
);
10174 run_hook (intern ("suspend-hook"));
10176 get_tty_size (fileno (CURTTY ()->input
), &old_width
, &old_height
);
10177 reset_all_sys_modes ();
10178 /* sys_suspend can get an error if it tries to fork a subshell
10179 and the system resources aren't available for that. */
10180 record_unwind_protect_void (init_all_sys_modes
);
10181 stuff_buffered_input (stuffstring
);
10182 if (cannot_suspend
)
10186 unbind_to (count
, Qnil
);
10188 /* Check if terminal/window size has changed.
10189 Note that this is not useful when we are running directly
10190 with a window system; but suspend should be disabled in that case. */
10191 get_tty_size (fileno (CURTTY ()->input
), &width
, &height
);
10192 if (width
!= old_width
|| height
!= old_height
)
10193 change_frame_size (SELECTED_FRAME (), width
,
10194 height
- FRAME_MENU_BAR_LINES (SELECTED_FRAME ()),
10197 run_hook (intern ("suspend-resume-hook"));
10202 /* If STUFFSTRING is a string, stuff its contents as pending terminal input.
10203 Then in any case stuff anything Emacs has read ahead and not used. */
10206 stuff_buffered_input (Lisp_Object stuffstring
)
10208 #ifdef SIGTSTP /* stuff_char is defined if SIGTSTP. */
10209 register unsigned char *p
;
10211 if (STRINGP (stuffstring
))
10213 register ptrdiff_t count
;
10215 p
= SDATA (stuffstring
);
10216 count
= SBYTES (stuffstring
);
10217 while (count
-- > 0)
10222 /* Anything we have read ahead, put back for the shell to read. */
10223 /* ?? What should this do when we have multiple keyboards??
10224 Should we ignore anything that was typed in at the "wrong" kboard?
10226 rms: we should stuff everything back into the kboard
10228 for (; kbd_fetch_ptr
!= kbd_store_ptr
; kbd_fetch_ptr
++)
10231 if (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
10232 kbd_fetch_ptr
= kbd_buffer
;
10233 if (kbd_fetch_ptr
->kind
== ASCII_KEYSTROKE_EVENT
)
10234 stuff_char (kbd_fetch_ptr
->ie
.code
);
10236 clear_event (kbd_fetch_ptr
);
10239 input_pending
= false;
10240 #endif /* SIGTSTP */
10244 set_waiting_for_input (struct timespec
*time_to_clear
)
10246 input_available_clear_time
= time_to_clear
;
10248 /* Tell handle_interrupt to throw back to read_char, */
10249 waiting_for_input
= true;
10251 /* If handle_interrupt was called before and buffered a C-g,
10252 make it run again now, to avoid timing error. */
10253 if (!NILP (Vquit_flag
))
10254 quit_throw_to_read_char (0);
10258 clear_waiting_for_input (void)
10260 /* Tell handle_interrupt not to throw back to read_char, */
10261 waiting_for_input
= false;
10262 input_available_clear_time
= 0;
10265 /* The SIGINT handler.
10267 If we have a frame on the controlling tty, we assume that the
10268 SIGINT was generated by C-g, so we call handle_interrupt.
10269 Otherwise, tell maybe_quit to kill Emacs. */
10272 handle_interrupt_signal (int sig
)
10274 /* See if we have an active terminal on our controlling tty. */
10275 struct terminal
*terminal
= get_named_terminal (DEV_TTY
);
10278 /* If there are no frames there, let's pretend that we are a
10279 well-behaving UN*X program and quit. We must not call Lisp
10280 in a signal handler, so tell maybe_quit to exit when it is
10282 Vquit_flag
= Qkill_emacs
;
10286 /* Otherwise, the SIGINT was probably generated by C-g. */
10288 /* Set internal_last_event_frame to the top frame of the
10289 controlling tty, if we have a frame there. We disable the
10290 interrupt key on secondary ttys, so the SIGINT must have come
10291 from the controlling tty. */
10292 internal_last_event_frame
= terminal
->display_info
.tty
->top_frame
;
10294 handle_interrupt (1);
10299 deliver_interrupt_signal (int sig
)
10301 deliver_process_signal (sig
, handle_interrupt_signal
);
10304 /* Output MSG directly to standard output, without buffering. Ignore
10305 failures. This is safe in a signal handler. */
10307 write_stdout (char const *msg
)
10309 ignore_value (write (STDOUT_FILENO
, msg
, strlen (msg
)));
10312 /* Read a byte from stdin, without buffering. Safe in signal handlers. */
10317 return read (STDIN_FILENO
, &c
, 1) == 1 ? c
: EOF
;
10320 /* If Emacs is stuck because `inhibit-quit' is true, then keep track
10321 of the number of times C-g has been requested. If C-g is pressed
10322 enough times, then quit anyway. See bug#6585. */
10323 static int volatile force_quit_count
;
10325 /* This routine is called at interrupt level in response to C-g.
10327 It is called from the SIGINT handler or kbd_buffer_store_event.
10329 If `waiting_for_input' is non zero, then unless `echoing' is
10330 nonzero, immediately throw back to read_char.
10332 Otherwise it sets the Lisp variable quit-flag not-nil. This causes
10333 eval to throw, when it gets a chance. If quit-flag is already
10334 non-nil, it stops the job right away. */
10337 handle_interrupt (bool in_signal_handler
)
10343 /* XXX This code needs to be revised for multi-tty support. */
10344 if (!NILP (Vquit_flag
) && get_named_terminal (DEV_TTY
))
10346 if (! in_signal_handler
)
10348 /* If SIGINT isn't blocked, don't let us be interrupted by
10349 a SIGINT. It might be harmful due to non-reentrancy
10350 in I/O functions. */
10352 sigemptyset (&blocked
);
10353 sigaddset (&blocked
, SIGINT
);
10354 pthread_sigmask (SIG_BLOCK
, &blocked
, 0);
10358 reset_all_sys_modes ();
10362 * On systems which can suspend the current process and return to the original
10363 * shell, this command causes the user to end up back at the shell.
10364 * The "Auto-save" and "Abort" questions are not asked until
10365 * the user elects to return to emacs, at which point he can save the current
10366 * job and either dump core or continue.
10370 /* Perhaps should really fork an inferior shell?
10371 But that would not provide any way to get back
10372 to the original shell, ever. */
10373 write_stdout ("No support for stopping a process"
10374 " on this operating system;\n"
10375 "you can continue or abort.\n");
10376 #endif /* not SIGTSTP */
10378 /* We must remain inside the screen area when the internal terminal
10379 is used. Note that [Enter] is not echoed by dos. */
10380 cursor_to (SELECTED_FRAME (), 0, 0);
10383 write_stdout ("Emacs is resuming after an emergency escape.\n");
10385 /* It doesn't work to autosave while GC is in progress;
10386 the code used for auto-saving doesn't cope with the mark bit. */
10387 if (!gc_in_progress
)
10389 write_stdout ("Auto-save? (y or n) ");
10391 if (c
== 'y' || c
== 'Y')
10393 Fdo_auto_save (Qt
, Qnil
);
10395 write_stdout ("\r\nAuto-save done");
10397 write_stdout ("Auto-save done\n");
10405 /* During GC, it must be safe to reenable quitting again. */
10406 Vinhibit_quit
= Qnil
;
10412 "Garbage collection in progress; cannot auto-save now\r\n"
10413 "but will instead do a real quit"
10414 " after garbage collection ends\r\n");
10418 write_stdout ("\r\nAbort? (y or n) ");
10420 write_stdout ("Abort (and dump core)? (y or n) ");
10423 if (c
== 'y' || c
== 'Y')
10428 write_stdout ("\r\nContinuing...\r\n");
10429 #else /* not MSDOS */
10430 write_stdout ("Continuing...\n");
10431 #endif /* not MSDOS */
10432 init_all_sys_modes ();
10436 /* Request quit when it's safe. */
10437 int count
= NILP (Vquit_flag
) ? 1 : force_quit_count
+ 1;
10438 force_quit_count
= count
;
10440 Vinhibit_quit
= Qnil
;
10444 pthread_sigmask (SIG_SETMASK
, &empty_mask
, 0);
10446 /* TODO: The longjmp in this call throws the NS event loop integration off,
10447 and it seems to do fine without this. Probably some attention
10448 needs to be paid to the setting of waiting_for_input in
10449 wait_reading_process_output() under HAVE_NS because of the call
10450 to ns_select there (needed because otherwise events aren't picked up
10451 outside of polling since we don't get SIGIO like X and we don't have a
10452 separate event loop thread like W32. */
10454 if (waiting_for_input
&& !echoing
)
10455 quit_throw_to_read_char (in_signal_handler
);
10459 /* Handle a C-g by making read_char return C-g. */
10462 quit_throw_to_read_char (bool from_signal
)
10464 /* When not called from a signal handler it is safe to call
10466 if (!from_signal
&& EQ (Vquit_flag
, Qkill_emacs
))
10467 Fkill_emacs (Qnil
);
10469 /* Prevent another signal from doing this before we finish. */
10470 clear_waiting_for_input ();
10471 input_pending
= false;
10473 Vunread_command_events
= Qnil
;
10475 if (FRAMEP (internal_last_event_frame
)
10476 && !EQ (internal_last_event_frame
, selected_frame
))
10477 do_switch_frame (make_lispy_switch_frame (internal_last_event_frame
),
10480 sys_longjmp (getcjmp
, 1);
10483 DEFUN ("set-input-interrupt-mode", Fset_input_interrupt_mode
,
10484 Sset_input_interrupt_mode
, 1, 1, 0,
10485 doc
: /* Set interrupt mode of reading keyboard input.
10486 If INTERRUPT is non-nil, Emacs will use input interrupts;
10487 otherwise Emacs uses CBREAK mode.
10489 See also `current-input-mode'. */)
10490 (Lisp_Object interrupt
)
10492 bool new_interrupt_input
;
10493 #ifdef USABLE_SIGIO
10494 #ifdef HAVE_X_WINDOWS
10495 if (x_display_list
!= NULL
)
10497 /* When using X, don't give the user a real choice,
10498 because we haven't implemented the mechanisms to support it. */
10499 new_interrupt_input
= true;
10502 #endif /* HAVE_X_WINDOWS */
10503 new_interrupt_input
= !NILP (interrupt
);
10504 #else /* not USABLE_SIGIO */
10505 new_interrupt_input
= false;
10506 #endif /* not USABLE_SIGIO */
10508 if (new_interrupt_input
!= interrupt_input
)
10510 #ifdef POLL_FOR_INPUT
10514 /* this causes startup screen to be restored and messes with the mouse */
10515 reset_all_sys_modes ();
10516 interrupt_input
= new_interrupt_input
;
10517 init_all_sys_modes ();
10519 interrupt_input
= new_interrupt_input
;
10522 #ifdef POLL_FOR_INPUT
10523 poll_suppress_count
= 1;
10530 DEFUN ("set-output-flow-control", Fset_output_flow_control
, Sset_output_flow_control
, 1, 2, 0,
10531 doc
: /* Enable or disable ^S/^Q flow control for output to TERMINAL.
10532 If FLOW is non-nil, flow control is enabled and you cannot use C-s or
10533 C-q in key sequences.
10535 This setting only has an effect on tty terminals and only when
10536 Emacs reads input in CBREAK mode; see `set-input-interrupt-mode'.
10538 See also `current-input-mode'. */)
10539 (Lisp_Object flow
, Lisp_Object terminal
)
10541 struct terminal
*t
= decode_tty_terminal (terminal
);
10542 struct tty_display_info
*tty
;
10546 tty
= t
->display_info
.tty
;
10548 if (tty
->flow_control
!= !NILP (flow
))
10551 /* This causes startup screen to be restored and messes with the mouse. */
10552 reset_sys_modes (tty
);
10555 tty
->flow_control
= !NILP (flow
);
10558 init_sys_modes (tty
);
10564 DEFUN ("set-input-meta-mode", Fset_input_meta_mode
, Sset_input_meta_mode
, 1, 2, 0,
10565 doc
: /* Enable or disable 8-bit input on TERMINAL.
10566 If META is t, Emacs will accept 8-bit input, and interpret the 8th
10567 bit as the Meta modifier.
10569 If META is nil, Emacs will ignore the top bit, on the assumption it is
10572 Otherwise, Emacs will accept and pass through 8-bit input without
10573 specially interpreting the top bit.
10575 This setting only has an effect on tty terminal devices.
10577 Optional parameter TERMINAL specifies the tty terminal device to use.
10578 It may be a terminal object, a frame, or nil for the terminal used by
10579 the currently selected frame.
10581 See also `current-input-mode'. */)
10582 (Lisp_Object meta
, Lisp_Object terminal
)
10584 struct terminal
*t
= decode_tty_terminal (terminal
);
10585 struct tty_display_info
*tty
;
10590 tty
= t
->display_info
.tty
;
10594 else if (EQ (meta
, Qt
))
10599 if (tty
->meta_key
!= new_meta
)
10602 /* this causes startup screen to be restored and messes with the mouse */
10603 reset_sys_modes (tty
);
10606 tty
->meta_key
= new_meta
;
10609 init_sys_modes (tty
);
10615 DEFUN ("set-quit-char", Fset_quit_char
, Sset_quit_char
, 1, 1, 0,
10616 doc
: /* Specify character used for quitting.
10617 QUIT must be an ASCII character.
10619 This function only has an effect on the controlling tty of the Emacs
10622 See also `current-input-mode'. */)
10625 struct terminal
*t
= get_named_terminal (DEV_TTY
);
10626 struct tty_display_info
*tty
;
10630 tty
= t
->display_info
.tty
;
10632 if (NILP (quit
) || !INTEGERP (quit
) || XINT (quit
) < 0 || XINT (quit
) > 0400)
10633 error ("QUIT must be an ASCII character");
10636 /* this causes startup screen to be restored and messes with the mouse */
10637 reset_sys_modes (tty
);
10640 /* Don't let this value be out of range. */
10641 quit_char
= XINT (quit
) & (tty
->meta_key
== 0 ? 0177 : 0377);
10644 init_sys_modes (tty
);
10650 DEFUN ("set-input-mode", Fset_input_mode
, Sset_input_mode
, 3, 4, 0,
10651 doc
: /* Set mode of reading keyboard input.
10652 First arg INTERRUPT non-nil means use input interrupts;
10653 nil means use CBREAK mode.
10654 Second arg FLOW non-nil means use ^S/^Q flow control for output to terminal
10655 (no effect except in CBREAK mode).
10656 Third arg META t means accept 8-bit input (for a Meta key).
10657 META nil means ignore the top bit, on the assumption it is parity.
10658 Otherwise, accept 8-bit input and don't use the top bit for Meta.
10659 Optional fourth arg QUIT if non-nil specifies character to use for quitting.
10660 See also `current-input-mode'. */)
10661 (Lisp_Object interrupt
, Lisp_Object flow
, Lisp_Object meta
, Lisp_Object quit
)
10663 Fset_input_interrupt_mode (interrupt
);
10664 Fset_output_flow_control (flow
, Qnil
);
10665 Fset_input_meta_mode (meta
, Qnil
);
10667 Fset_quit_char (quit
);
10671 DEFUN ("current-input-mode", Fcurrent_input_mode
, Scurrent_input_mode
, 0, 0, 0,
10672 doc
: /* Return information about the way Emacs currently reads keyboard input.
10673 The value is a list of the form (INTERRUPT FLOW META QUIT), where
10674 INTERRUPT is non-nil if Emacs is using interrupt-driven input; if
10675 nil, Emacs is using CBREAK mode.
10676 FLOW is non-nil if Emacs uses ^S/^Q flow control for output to the
10677 terminal; this does not apply if Emacs uses interrupt-driven input.
10678 META is t if accepting 8-bit input with 8th bit as Meta flag.
10679 META nil means ignoring the top bit, on the assumption it is parity.
10680 META is neither t nor nil if accepting 8-bit input and using
10681 all 8 bits as the character code.
10682 QUIT is the character Emacs currently uses to quit.
10683 The elements of this list correspond to the arguments of
10684 `set-input-mode'. */)
10687 struct frame
*sf
= XFRAME (selected_frame
);
10689 Lisp_Object interrupt
= interrupt_input
? Qt
: Qnil
;
10690 Lisp_Object flow
, meta
;
10691 if (FRAME_TERMCAP_P (sf
) || FRAME_MSDOS_P (sf
))
10693 flow
= FRAME_TTY (sf
)->flow_control
? Qt
: Qnil
;
10694 meta
= (FRAME_TTY (sf
)->meta_key
== 2
10696 : (CURTTY ()->meta_key
== 1 ? Qt
: Qnil
));
10703 Lisp_Object quit
= make_number (quit_char
);
10705 return list4 (interrupt
, flow
, meta
, quit
);
10708 DEFUN ("posn-at-x-y", Fposn_at_x_y
, Sposn_at_x_y
, 2, 4, 0,
10709 doc
: /* Return position information for pixel coordinates X and Y.
10710 By default, X and Y are relative to text area of the selected window.
10711 Optional third arg FRAME-OR-WINDOW non-nil specifies frame or window.
10712 If optional fourth arg WHOLE is non-nil, X is relative to the left
10713 edge of the window.
10715 The return value is similar to a mouse click position:
10716 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
10717 IMAGE (DX . DY) (WIDTH . HEIGHT))
10718 The `posn-' functions access elements of such lists. */)
10719 (Lisp_Object x
, Lisp_Object y
, Lisp_Object frame_or_window
, Lisp_Object whole
)
10722 /* We allow X of -1, for the newline in a R2L line that overflowed
10723 into the left fringe. */
10724 if (XINT (x
) != -1)
10728 if (NILP (frame_or_window
))
10729 frame_or_window
= selected_window
;
10731 if (WINDOWP (frame_or_window
))
10733 struct window
*w
= decode_live_window (frame_or_window
);
10735 XSETINT (x
, (XINT (x
)
10736 + WINDOW_LEFT_EDGE_X (w
)
10738 ? window_box_left_offset (w
, TEXT_AREA
)
10740 XSETINT (y
, WINDOW_TO_FRAME_PIXEL_Y (w
, XINT (y
)));
10741 frame_or_window
= w
->frame
;
10744 CHECK_LIVE_FRAME (frame_or_window
);
10746 return make_lispy_position (XFRAME (frame_or_window
), x
, y
, 0);
10749 DEFUN ("posn-at-point", Fposn_at_point
, Sposn_at_point
, 0, 2, 0,
10750 doc
: /* Return position information for buffer POS in WINDOW.
10751 POS defaults to point in WINDOW; WINDOW defaults to the selected window.
10753 Return nil if position is not visible in window. Otherwise,
10754 the return value is similar to that returned by `event-start' for
10755 a mouse click at the upper left corner of the glyph corresponding
10756 to the given buffer position:
10757 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
10758 IMAGE (DX . DY) (WIDTH . HEIGHT))
10759 The `posn-' functions access elements of such lists. */)
10760 (Lisp_Object pos
, Lisp_Object window
)
10765 window
= selected_window
;
10767 tem
= Fpos_visible_in_window_p (pos
, window
, Qt
);
10770 Lisp_Object x
= XCAR (tem
);
10771 Lisp_Object y
= XCAR (XCDR (tem
));
10772 Lisp_Object aux_info
= XCDR (XCDR (tem
));
10773 int y_coord
= XINT (y
);
10775 /* Point invisible due to hscrolling? X can be -1 when a
10776 newline in a R2L line overflows into the left fringe. */
10779 if (!NILP (aux_info
) && y_coord
< 0)
10781 int rtop
= XINT (XCAR (aux_info
));
10783 y
= make_number (y_coord
+ rtop
);
10785 tem
= Fposn_at_x_y (x
, y
, window
, Qnil
);
10791 /* Set up a new kboard object with reasonable initial values.
10792 TYPE is a window system for which this keyboard is used. */
10795 init_kboard (KBOARD
*kb
, Lisp_Object type
)
10797 kset_overriding_terminal_local_map (kb
, Qnil
);
10798 kset_last_command (kb
, Qnil
);
10799 kset_real_last_command (kb
, Qnil
);
10800 kset_keyboard_translate_table (kb
, Qnil
);
10801 kset_last_repeatable_command (kb
, Qnil
);
10802 kset_prefix_arg (kb
, Qnil
);
10803 kset_last_prefix_arg (kb
, Qnil
);
10804 kset_kbd_queue (kb
, Qnil
);
10805 kb
->kbd_queue_has_data
= false;
10806 kb
->immediate_echo
= false;
10807 kset_echo_string (kb
, Qnil
);
10808 kset_echo_prompt (kb
, Qnil
);
10809 kb
->kbd_macro_buffer
= 0;
10810 kb
->kbd_macro_bufsize
= 0;
10811 kset_defining_kbd_macro (kb
, Qnil
);
10812 kset_last_kbd_macro (kb
, Qnil
);
10813 kb
->reference_count
= 0;
10814 kset_system_key_alist (kb
, Qnil
);
10815 kset_system_key_syms (kb
, Qnil
);
10816 kset_window_system (kb
, type
);
10817 kset_input_decode_map (kb
, Fmake_sparse_keymap (Qnil
));
10818 kset_local_function_key_map (kb
, Fmake_sparse_keymap (Qnil
));
10819 Fset_keymap_parent (KVAR (kb
, Vlocal_function_key_map
), Vfunction_key_map
);
10820 kset_default_minibuffer_frame (kb
, Qnil
);
10823 /* Allocate and basically initialize keyboard
10824 object to use with window system TYPE. */
10827 allocate_kboard (Lisp_Object type
)
10829 KBOARD
*kb
= xmalloc (sizeof *kb
);
10831 init_kboard (kb
, type
);
10832 kb
->next_kboard
= all_kboards
;
10838 * Destroy the contents of a kboard object, but not the object itself.
10839 * We use this just before deleting it, or if we're going to initialize
10840 * it a second time.
10843 wipe_kboard (KBOARD
*kb
)
10845 xfree (kb
->kbd_macro_buffer
);
10848 /* Free KB and memory referenced from it. */
10851 delete_kboard (KBOARD
*kb
)
10855 for (kbp
= &all_kboards
; *kbp
!= kb
; kbp
= &(*kbp
)->next_kboard
)
10858 *kbp
= kb
->next_kboard
;
10860 /* Prevent a dangling reference to KB. */
10861 if (kb
== current_kboard
10862 && FRAMEP (selected_frame
)
10863 && FRAME_LIVE_P (XFRAME (selected_frame
)))
10865 current_kboard
= FRAME_KBOARD (XFRAME (selected_frame
));
10866 single_kboard
= false;
10867 if (current_kboard
== kb
)
10876 init_keyboard (void)
10878 /* This is correct before outermost invocation of the editor loop. */
10879 command_loop_level
= -1;
10880 quit_char
= Ctl ('g');
10881 Vunread_command_events
= Qnil
;
10882 timer_idleness_start_time
= invalid_timespec ();
10884 recent_keys_index
= 0;
10885 kbd_fetch_ptr
= kbd_buffer
;
10886 kbd_store_ptr
= kbd_buffer
;
10887 do_mouse_tracking
= Qnil
;
10888 input_pending
= false;
10889 interrupt_input_blocked
= 0;
10890 pending_signals
= false;
10892 /* This means that command_loop_1 won't try to select anything the first
10894 internal_last_event_frame
= Qnil
;
10895 Vlast_event_frame
= internal_last_event_frame
;
10897 current_kboard
= initial_kboard
;
10898 /* Re-initialize the keyboard again. */
10899 wipe_kboard (current_kboard
);
10900 /* A value of nil for Vwindow_system normally means a tty, but we also use
10901 it for the initial terminal since there is no window system there. */
10902 init_kboard (current_kboard
, Qnil
);
10904 if (!noninteractive
)
10906 /* Before multi-tty support, these handlers used to be installed
10907 only if the current session was a tty session. Now an Emacs
10908 session may have multiple display types, so we always handle
10909 SIGINT. There is special code in handle_interrupt_signal to exit
10910 Emacs on SIGINT when there are no termcap frames on the
10911 controlling terminal. */
10912 struct sigaction action
;
10913 emacs_sigaction_init (&action
, deliver_interrupt_signal
);
10914 sigaction (SIGINT
, &action
, 0);
10916 /* For systems with SysV TERMIO, C-g is set up for both SIGINT and
10917 SIGQUIT and we can't tell which one it will give us. */
10918 sigaction (SIGQUIT
, &action
, 0);
10919 #endif /* not DOS_NT */
10921 #ifdef USABLE_SIGIO
10922 if (!noninteractive
)
10924 struct sigaction action
;
10925 emacs_sigaction_init (&action
, deliver_input_available_signal
);
10926 sigaction (SIGIO
, &action
, 0);
10930 /* Use interrupt input by default, if it works and noninterrupt input
10931 has deficiencies. */
10933 #ifdef INTERRUPT_INPUT
10934 interrupt_input
= 1;
10936 interrupt_input
= 0;
10939 pthread_sigmask (SIG_SETMASK
, &empty_mask
, 0);
10942 if (keyboard_init_hook
)
10943 (*keyboard_init_hook
) ();
10945 #ifdef POLL_FOR_INPUT
10947 poll_suppress_count
= 1;
10952 /* This type's only use is in syms_of_keyboard, to put properties on the
10953 event header symbols. */
10960 static const struct event_head head_table
[] = {
10961 {SYMBOL_INDEX (Qmouse_movement
), SYMBOL_INDEX (Qmouse_movement
)},
10962 {SYMBOL_INDEX (Qscroll_bar_movement
), SYMBOL_INDEX (Qmouse_movement
)},
10964 /* Some of the event heads. */
10965 {SYMBOL_INDEX (Qswitch_frame
), SYMBOL_INDEX (Qswitch_frame
)},
10967 {SYMBOL_INDEX (Qfocus_in
), SYMBOL_INDEX (Qfocus_in
)},
10968 {SYMBOL_INDEX (Qfocus_out
), SYMBOL_INDEX (Qfocus_out
)},
10969 {SYMBOL_INDEX (Qdelete_frame
), SYMBOL_INDEX (Qdelete_frame
)},
10970 {SYMBOL_INDEX (Qiconify_frame
), SYMBOL_INDEX (Qiconify_frame
)},
10971 {SYMBOL_INDEX (Qmake_frame_visible
), SYMBOL_INDEX (Qmake_frame_visible
)},
10972 /* `select-window' should be handled just like `switch-frame'
10973 in read_key_sequence. */
10974 {SYMBOL_INDEX (Qselect_window
), SYMBOL_INDEX (Qswitch_frame
)}
10978 syms_of_keyboard (void)
10980 pending_funcalls
= Qnil
;
10981 staticpro (&pending_funcalls
);
10983 Vlispy_mouse_stem
= build_pure_c_string ("mouse");
10984 staticpro (&Vlispy_mouse_stem
);
10986 regular_top_level_message
= build_pure_c_string ("Back to top level");
10987 #ifdef HAVE_STACK_OVERFLOW_HANDLING
10988 recover_top_level_message
10989 = build_pure_c_string ("Re-entering top level after C stack overflow");
10991 DEFVAR_LISP ("internal--top-level-message", Vinternal__top_level_message
,
10992 doc
: /* Message displayed by `normal-top-level'. */);
10993 Vinternal__top_level_message
= regular_top_level_message
;
10996 DEFSYM (QCimage
, ":image");
10997 DEFSYM (Qhelp_echo
, "help-echo");
10998 DEFSYM (QCrtl
, ":rtl");
11000 staticpro (&item_properties
);
11001 item_properties
= Qnil
;
11003 staticpro (&tool_bar_item_properties
);
11004 tool_bar_item_properties
= Qnil
;
11005 staticpro (&tool_bar_items_vector
);
11006 tool_bar_items_vector
= Qnil
;
11008 DEFSYM (Qtimer_event_handler
, "timer-event-handler");
11010 /* Non-nil disable property on a command means do not execute it;
11011 call disabled-command-function's value instead. */
11012 DEFSYM (Qdisabled
, "disabled");
11014 DEFSYM (Qundefined
, "undefined");
11016 /* Hooks to run before and after each command. */
11017 DEFSYM (Qpre_command_hook
, "pre-command-hook");
11018 DEFSYM (Qpost_command_hook
, "post-command-hook");
11020 DEFSYM (Qundo_auto__add_boundary
, "undo-auto--add-boundary");
11021 DEFSYM (Qundo_auto__undoably_changed_buffers
,
11022 "undo-auto--undoably-changed-buffers");
11024 DEFSYM (Qdeferred_action_function
, "deferred-action-function");
11025 DEFSYM (Qdelayed_warnings_hook
, "delayed-warnings-hook");
11026 DEFSYM (Qfunction_key
, "function-key");
11028 /* The values of Qevent_kind properties. */
11029 DEFSYM (Qmouse_click
, "mouse-click");
11031 DEFSYM (Qdrag_n_drop
, "drag-n-drop");
11032 DEFSYM (Qsave_session
, "save-session");
11033 DEFSYM (Qconfig_changed_event
, "config-changed-event");
11035 /* Menu and tool bar item parts. */
11036 DEFSYM (Qmenu_enable
, "menu-enable");
11039 DEFSYM (Qlanguage_change
, "language-change");
11040 DEFSYM (Qend_session
, "end-session");
11044 DEFSYM (Qdbus_event
, "dbus-event");
11047 #ifdef HAVE_XWIDGETS
11048 DEFSYM (Qxwidget_event
, "xwidget-event");
11051 #ifdef USE_FILE_NOTIFY
11052 DEFSYM (Qfile_notify
, "file-notify");
11053 #endif /* USE_FILE_NOTIFY */
11055 /* Menu and tool bar item parts. */
11056 DEFSYM (QCenable
, ":enable");
11057 DEFSYM (QCvisible
, ":visible");
11058 DEFSYM (QChelp
, ":help");
11059 DEFSYM (QCfilter
, ":filter");
11060 DEFSYM (QCbutton
, ":button");
11061 DEFSYM (QCkeys
, ":keys");
11062 DEFSYM (QCkey_sequence
, ":key-sequence");
11064 /* Non-nil disable property on a command means
11065 do not execute it; call disabled-command-function's value instead. */
11066 DEFSYM (QCtoggle
, ":toggle");
11067 DEFSYM (QCradio
, ":radio");
11068 DEFSYM (QClabel
, ":label");
11069 DEFSYM (QCvert_only
, ":vert-only");
11071 /* Symbols to use for parts of windows. */
11072 DEFSYM (Qvertical_line
, "vertical-line");
11073 DEFSYM (Qright_divider
, "right-divider");
11074 DEFSYM (Qbottom_divider
, "bottom-divider");
11076 DEFSYM (Qmouse_fixup_help_message
, "mouse-fixup-help-message");
11078 DEFSYM (Qabove_handle
, "above-handle");
11079 DEFSYM (Qhandle
, "handle");
11080 DEFSYM (Qbelow_handle
, "below-handle");
11081 DEFSYM (Qup
, "up");
11082 DEFSYM (Qdown
, "down");
11083 DEFSYM (Qtop
, "top");
11084 DEFSYM (Qbottom
, "bottom");
11085 DEFSYM (Qend_scroll
, "end-scroll");
11086 DEFSYM (Qratio
, "ratio");
11087 DEFSYM (Qbefore_handle
, "before-handle");
11088 DEFSYM (Qhorizontal_handle
, "horizontal-handle");
11089 DEFSYM (Qafter_handle
, "after-handle");
11090 DEFSYM (Qleft
, "left");
11091 DEFSYM (Qright
, "right");
11092 DEFSYM (Qleftmost
, "leftmost");
11093 DEFSYM (Qrightmost
, "rightmost");
11095 /* Properties of event headers. */
11096 DEFSYM (Qevent_kind
, "event-kind");
11097 DEFSYM (Qevent_symbol_elements
, "event-symbol-elements");
11099 /* An event header symbol HEAD may have a property named
11100 Qevent_symbol_element_mask, which is of the form (BASE MODIFIERS);
11101 BASE is the base, unmodified version of HEAD, and MODIFIERS is the
11102 mask of modifiers applied to it. If present, this is used to help
11103 speed up parse_modifiers. */
11104 DEFSYM (Qevent_symbol_element_mask
, "event-symbol-element-mask");
11106 /* An unmodified event header BASE may have a property named
11107 Qmodifier_cache, which is an alist mapping modifier masks onto
11108 modified versions of BASE. If present, this helps speed up
11109 apply_modifiers. */
11110 DEFSYM (Qmodifier_cache
, "modifier-cache");
11112 DEFSYM (Qrecompute_lucid_menubar
, "recompute-lucid-menubar");
11113 DEFSYM (Qactivate_menubar_hook
, "activate-menubar-hook");
11115 DEFSYM (Qpolling_period
, "polling-period");
11117 DEFSYM (Qgui_set_selection
, "gui-set-selection");
11119 /* The primary selection. */
11120 DEFSYM (QPRIMARY
, "PRIMARY");
11122 DEFSYM (Qhandle_switch_frame
, "handle-switch-frame");
11123 DEFSYM (Qhandle_select_window
, "handle-select-window");
11125 DEFSYM (Qinput_method_exit_on_first_char
, "input-method-exit-on-first-char");
11126 DEFSYM (Qinput_method_use_echo_area
, "input-method-use-echo-area");
11128 DEFSYM (Qhelp_form_show
, "help-form-show");
11130 DEFSYM (Qecho_keystrokes
, "echo-keystrokes");
11132 Fset (Qinput_method_exit_on_first_char
, Qnil
);
11133 Fset (Qinput_method_use_echo_area
, Qnil
);
11135 /* Symbols to head events. */
11136 DEFSYM (Qmouse_movement
, "mouse-movement");
11137 DEFSYM (Qscroll_bar_movement
, "scroll-bar-movement");
11138 DEFSYM (Qswitch_frame
, "switch-frame");
11139 DEFSYM (Qfocus_in
, "focus-in");
11140 DEFSYM (Qfocus_out
, "focus-out");
11141 DEFSYM (Qdelete_frame
, "delete-frame");
11142 DEFSYM (Qiconify_frame
, "iconify-frame");
11143 DEFSYM (Qmake_frame_visible
, "make-frame-visible");
11144 DEFSYM (Qselect_window
, "select-window");
11145 DEFSYM (Qselection_request
, "selection-request");
11149 for (i
= 0; i
< ARRAYELTS (head_table
); i
++)
11151 const struct event_head
*p
= &head_table
[i
];
11152 Lisp_Object var
= builtin_lisp_symbol (p
->var
);
11153 Lisp_Object kind
= builtin_lisp_symbol (p
->kind
);
11154 Fput (var
, Qevent_kind
, kind
);
11155 Fput (var
, Qevent_symbol_elements
, list1 (var
));
11159 button_down_location
= Fmake_vector (make_number (5), Qnil
);
11160 staticpro (&button_down_location
);
11161 mouse_syms
= Fmake_vector (make_number (5), Qnil
);
11162 staticpro (&mouse_syms
);
11163 wheel_syms
= Fmake_vector (make_number (ARRAYELTS (lispy_wheel_names
)),
11165 staticpro (&wheel_syms
);
11169 int len
= ARRAYELTS (modifier_names
);
11171 modifier_symbols
= Fmake_vector (make_number (len
), Qnil
);
11172 for (i
= 0; i
< len
; i
++)
11173 if (modifier_names
[i
])
11174 ASET (modifier_symbols
, i
, intern_c_string (modifier_names
[i
]));
11175 staticpro (&modifier_symbols
);
11178 recent_keys
= Fmake_vector (make_number (NUM_RECENT_KEYS
), Qnil
);
11179 staticpro (&recent_keys
);
11181 this_command_keys
= Fmake_vector (make_number (40), Qnil
);
11182 staticpro (&this_command_keys
);
11184 raw_keybuf
= Fmake_vector (make_number (30), Qnil
);
11185 staticpro (&raw_keybuf
);
11187 DEFSYM (Qcommand_execute
, "command-execute");
11188 DEFSYM (Qinternal_echo_keystrokes_prefix
, "internal-echo-keystrokes-prefix");
11190 accent_key_syms
= Qnil
;
11191 staticpro (&accent_key_syms
);
11193 func_key_syms
= Qnil
;
11194 staticpro (&func_key_syms
);
11196 drag_n_drop_syms
= Qnil
;
11197 staticpro (&drag_n_drop_syms
);
11199 unread_switch_frame
= Qnil
;
11200 staticpro (&unread_switch_frame
);
11202 internal_last_event_frame
= Qnil
;
11203 staticpro (&internal_last_event_frame
);
11205 read_key_sequence_cmd
= Qnil
;
11206 staticpro (&read_key_sequence_cmd
);
11207 read_key_sequence_remapped
= Qnil
;
11208 staticpro (&read_key_sequence_remapped
);
11210 menu_bar_one_keymap_changed_items
= Qnil
;
11211 staticpro (&menu_bar_one_keymap_changed_items
);
11213 menu_bar_items_vector
= Qnil
;
11214 staticpro (&menu_bar_items_vector
);
11216 help_form_saved_window_configs
= Qnil
;
11217 staticpro (&help_form_saved_window_configs
);
11219 defsubr (&Scurrent_idle_time
);
11220 defsubr (&Sevent_symbol_parse_modifiers
);
11221 defsubr (&Sevent_convert_list
);
11222 defsubr (&Sread_key_sequence
);
11223 defsubr (&Sread_key_sequence_vector
);
11224 defsubr (&Srecursive_edit
);
11225 defsubr (&Strack_mouse
);
11226 defsubr (&Sinput_pending_p
);
11227 defsubr (&Srecent_keys
);
11228 defsubr (&Sthis_command_keys
);
11229 defsubr (&Sthis_command_keys_vector
);
11230 defsubr (&Sthis_single_command_keys
);
11231 defsubr (&Sthis_single_command_raw_keys
);
11232 defsubr (&Sclear_this_command_keys
);
11233 defsubr (&Ssuspend_emacs
);
11234 defsubr (&Sabort_recursive_edit
);
11235 defsubr (&Sexit_recursive_edit
);
11236 defsubr (&Srecursion_depth
);
11237 defsubr (&Scommand_error_default_function
);
11238 defsubr (&Stop_level
);
11239 defsubr (&Sdiscard_input
);
11240 defsubr (&Sopen_dribble_file
);
11241 defsubr (&Sset_input_interrupt_mode
);
11242 defsubr (&Sset_output_flow_control
);
11243 defsubr (&Sset_input_meta_mode
);
11244 defsubr (&Sset_quit_char
);
11245 defsubr (&Sset_input_mode
);
11246 defsubr (&Scurrent_input_mode
);
11247 defsubr (&Sposn_at_point
);
11248 defsubr (&Sposn_at_x_y
);
11250 DEFVAR_LISP ("last-command-event", last_command_event
,
11251 doc
: /* Last input event that was part of a command. */);
11253 DEFVAR_LISP ("last-nonmenu-event", last_nonmenu_event
,
11254 doc
: /* Last input event in a command, except for mouse menu events.
11255 Mouse menus give back keys that don't look like mouse events;
11256 this variable holds the actual mouse event that led to the menu,
11257 so that you can determine whether the command was run by mouse or not. */);
11259 DEFVAR_LISP ("last-input-event", last_input_event
,
11260 doc
: /* Last input event. */);
11262 DEFVAR_LISP ("unread-command-events", Vunread_command_events
,
11263 doc
: /* List of events to be read as the command input.
11264 These events are processed first, before actual keyboard input.
11265 Events read from this list are not normally added to `this-command-keys',
11266 as they will already have been added once as they were read for the first time.
11267 An element of the form (t . EVENT) forces EVENT to be added to that list. */);
11268 Vunread_command_events
= Qnil
;
11270 DEFVAR_LISP ("unread-post-input-method-events", Vunread_post_input_method_events
,
11271 doc
: /* List of events to be processed as input by input methods.
11272 These events are processed before `unread-command-events'
11273 and actual keyboard input, but are not given to `input-method-function'. */);
11274 Vunread_post_input_method_events
= Qnil
;
11276 DEFVAR_LISP ("unread-input-method-events", Vunread_input_method_events
,
11277 doc
: /* List of events to be processed as input by input methods.
11278 These events are processed after `unread-command-events', but
11279 before actual keyboard input.
11280 If there's an active input method, the events are given to
11281 `input-method-function'. */);
11282 Vunread_input_method_events
= Qnil
;
11284 DEFVAR_LISP ("meta-prefix-char", meta_prefix_char
,
11285 doc
: /* Meta-prefix character code.
11286 Meta-foo as command input turns into this character followed by foo. */);
11287 XSETINT (meta_prefix_char
, 033);
11289 DEFVAR_KBOARD ("last-command", Vlast_command
,
11290 doc
: /* The last command executed.
11291 Normally a symbol with a function definition, but can be whatever was found
11292 in the keymap, or whatever the variable `this-command' was set to by that
11295 The value `mode-exit' is special; it means that the previous command
11296 read an event that told it to exit, and it did so and unread that event.
11297 In other words, the present command is the event that made the previous
11300 The value `kill-region' is special; it means that the previous command
11301 was a kill command.
11303 `last-command' has a separate binding for each terminal device.
11304 See Info node `(elisp)Multiple Terminals'. */);
11306 DEFVAR_KBOARD ("real-last-command", Vreal_last_command
,
11307 doc
: /* Same as `last-command', but never altered by Lisp code.
11308 Taken from the previous value of `real-this-command'. */);
11310 DEFVAR_KBOARD ("last-repeatable-command", Vlast_repeatable_command
,
11311 doc
: /* Last command that may be repeated.
11312 The last command executed that was not bound to an input event.
11313 This is the command `repeat' will try to repeat.
11314 Taken from a previous value of `real-this-command'. */);
11316 DEFVAR_LISP ("this-command", Vthis_command
,
11317 doc
: /* The command now being executed.
11318 The command can set this variable; whatever is put here
11319 will be in `last-command' during the following command. */);
11320 Vthis_command
= Qnil
;
11322 DEFVAR_LISP ("real-this-command", Vreal_this_command
,
11323 doc
: /* This is like `this-command', except that commands should never modify it. */);
11324 Vreal_this_command
= Qnil
;
11326 DEFVAR_LISP ("this-command-keys-shift-translated",
11327 Vthis_command_keys_shift_translated
,
11328 doc
: /* Non-nil if the key sequence activating this command was shift-translated.
11329 Shift-translation occurs when there is no binding for the key sequence
11330 as entered, but a binding was found by changing an upper-case letter
11331 to lower-case, or a shifted function key to an unshifted one. */);
11332 Vthis_command_keys_shift_translated
= Qnil
;
11334 DEFVAR_LISP ("this-original-command", Vthis_original_command
,
11335 doc
: /* The command bound to the current key sequence before remapping.
11336 It equals `this-command' if the original command was not remapped through
11337 any of the active keymaps. Otherwise, the value of `this-command' is the
11338 result of looking up the original command in the active keymaps. */);
11339 Vthis_original_command
= Qnil
;
11341 DEFVAR_INT ("auto-save-interval", auto_save_interval
,
11342 doc
: /* Number of input events between auto-saves.
11343 Zero means disable autosaving due to number of characters typed. */);
11344 auto_save_interval
= 300;
11346 DEFVAR_LISP ("auto-save-timeout", Vauto_save_timeout
,
11347 doc
: /* Number of seconds idle time before auto-save.
11348 Zero or nil means disable auto-saving due to idleness.
11349 After auto-saving due to this many seconds of idle time,
11350 Emacs also does a garbage collection if that seems to be warranted. */);
11351 XSETFASTINT (Vauto_save_timeout
, 30);
11353 DEFVAR_LISP ("echo-keystrokes", Vecho_keystrokes
,
11354 doc
: /* Nonzero means echo unfinished commands after this many seconds of pause.
11355 The value may be integer or floating point.
11356 If the value is zero, don't echo at all. */);
11357 Vecho_keystrokes
= make_number (1);
11359 DEFVAR_INT ("polling-period", polling_period
,
11360 doc
: /* Interval between polling for input during Lisp execution.
11361 The reason for polling is to make C-g work to stop a running program.
11362 Polling is needed only when using X windows and SIGIO does not work.
11363 Polling is automatically disabled in all other cases. */);
11364 polling_period
= 2;
11366 DEFVAR_LISP ("double-click-time", Vdouble_click_time
,
11367 doc
: /* Maximum time between mouse clicks to make a double-click.
11368 Measured in milliseconds. The value nil means disable double-click
11369 recognition; t means double-clicks have no time limit and are detected
11370 by position only. */);
11371 Vdouble_click_time
= make_number (500);
11373 DEFVAR_INT ("double-click-fuzz", double_click_fuzz
,
11374 doc
: /* Maximum mouse movement between clicks to make a double-click.
11375 On window-system frames, value is the number of pixels the mouse may have
11376 moved horizontally or vertically between two clicks to make a double-click.
11377 On non window-system frames, value is interpreted in units of 1/8 characters
11380 This variable is also the threshold for motion of the mouse
11381 to count as a drag. */);
11382 double_click_fuzz
= 3;
11384 DEFVAR_INT ("num-input-keys", num_input_keys
,
11385 doc
: /* Number of complete key sequences read as input so far.
11386 This includes key sequences read from keyboard macros.
11387 The number is effectively the number of interactive command invocations. */);
11388 num_input_keys
= 0;
11390 DEFVAR_INT ("num-nonmacro-input-events", num_nonmacro_input_events
,
11391 doc
: /* Number of input events read from the keyboard so far.
11392 This does not include events generated by keyboard macros. */);
11393 num_nonmacro_input_events
= 0;
11395 DEFVAR_LISP ("last-event-frame", Vlast_event_frame
,
11396 doc
: /* The frame in which the most recently read event occurred.
11397 If the last event came from a keyboard macro, this is set to `macro'. */);
11398 Vlast_event_frame
= Qnil
;
11400 /* This variable is set up in sysdep.c. */
11401 DEFVAR_LISP ("tty-erase-char", Vtty_erase_char
,
11402 doc
: /* The ERASE character as set by the user with stty. */);
11404 DEFVAR_LISP ("help-char", Vhelp_char
,
11405 doc
: /* Character to recognize as meaning Help.
11406 When it is read, do `(eval help-form)', and display result if it's a string.
11407 If the value of `help-form' is nil, this char can be read normally. */);
11408 XSETINT (Vhelp_char
, Ctl ('H'));
11410 DEFVAR_LISP ("help-event-list", Vhelp_event_list
,
11411 doc
: /* List of input events to recognize as meaning Help.
11412 These work just like the value of `help-char' (see that). */);
11413 Vhelp_event_list
= Qnil
;
11415 DEFVAR_LISP ("help-form", Vhelp_form
,
11416 doc
: /* Form to execute when character `help-char' is read.
11417 If the form returns a string, that string is displayed.
11418 If `help-form' is nil, the help char is not recognized. */);
11421 DEFVAR_LISP ("prefix-help-command", Vprefix_help_command
,
11422 doc
: /* Command to run when `help-char' character follows a prefix key.
11423 This command is used only when there is no actual binding
11424 for that character after that prefix key. */);
11425 Vprefix_help_command
= Qnil
;
11427 DEFVAR_LISP ("top-level", Vtop_level
,
11428 doc
: /* Form to evaluate when Emacs starts up.
11429 Useful to set before you dump a modified Emacs. */);
11431 XSYMBOL (Qtop_level
)->declared_special
= false;
11433 DEFVAR_KBOARD ("keyboard-translate-table", Vkeyboard_translate_table
,
11434 doc
: /* Translate table for local keyboard input, or nil.
11435 If non-nil, the value should be a char-table. Each character read
11436 from the keyboard is looked up in this char-table. If the value found
11437 there is non-nil, then it is used instead of the actual input character.
11439 The value can also be a string or vector, but this is considered obsolete.
11440 If it is a string or vector of length N, character codes N and up are left
11441 untranslated. In a vector, an element which is nil means "no translation".
11443 This is applied to the characters supplied to input methods, not their
11444 output. See also `translation-table-for-input'.
11446 This variable has a separate binding for each terminal.
11447 See Info node `(elisp)Multiple Terminals'. */);
11449 DEFVAR_BOOL ("cannot-suspend", cannot_suspend
,
11450 doc
: /* Non-nil means to always spawn a subshell instead of suspending.
11451 \(Even if the operating system has support for stopping a process.) */);
11452 cannot_suspend
= false;
11454 DEFVAR_BOOL ("menu-prompting", menu_prompting
,
11455 doc
: /* Non-nil means prompt with menus when appropriate.
11456 This is done when reading from a keymap that has a prompt string,
11457 for elements that have prompt strings.
11458 The menu is displayed on the screen
11459 if X menus were enabled at configuration
11460 time and the previous event was a mouse click prefix key.
11461 Otherwise, menu prompting uses the echo area. */);
11462 menu_prompting
= true;
11464 DEFVAR_LISP ("menu-prompt-more-char", menu_prompt_more_char
,
11465 doc
: /* Character to see next line of menu prompt.
11466 Type this character while in a menu prompt to rotate around the lines of it. */);
11467 XSETINT (menu_prompt_more_char
, ' ');
11469 DEFVAR_INT ("extra-keyboard-modifiers", extra_keyboard_modifiers
,
11470 doc
: /* A mask of additional modifier keys to use with every keyboard character.
11471 Emacs applies the modifiers of the character stored here to each keyboard
11472 character it reads. For example, after evaluating the expression
11473 (setq extra-keyboard-modifiers ?\\C-x)
11474 all input characters will have the control modifier applied to them.
11476 Note that the character ?\\C-@, equivalent to the integer zero, does
11477 not count as a control character; rather, it counts as a character
11478 with no modifiers; thus, setting `extra-keyboard-modifiers' to zero
11479 cancels any modification. */);
11480 extra_keyboard_modifiers
= 0;
11482 DEFSYM (Qdeactivate_mark
, "deactivate-mark");
11483 DEFVAR_LISP ("deactivate-mark", Vdeactivate_mark
,
11484 doc
: /* If an editing command sets this to t, deactivate the mark afterward.
11485 The command loop sets this to nil before each command,
11486 and tests the value when the command returns.
11487 Buffer modification stores t in this variable. */);
11488 Vdeactivate_mark
= Qnil
;
11489 Fmake_variable_buffer_local (Qdeactivate_mark
);
11491 DEFVAR_LISP ("pre-command-hook", Vpre_command_hook
,
11492 doc
: /* Normal hook run before each command is executed.
11493 If an unhandled error happens in running this hook,
11494 the function in which the error occurred is unconditionally removed, since
11495 otherwise the error might happen repeatedly and make Emacs nonfunctional.
11497 See also `post-command-hook'. */);
11498 Vpre_command_hook
= Qnil
;
11500 DEFVAR_LISP ("post-command-hook", Vpost_command_hook
,
11501 doc
: /* Normal hook run after each command is executed.
11502 If an unhandled error happens in running this hook,
11503 the function in which the error occurred is unconditionally removed, since
11504 otherwise the error might happen repeatedly and make Emacs nonfunctional.
11506 It is a bad idea to use this hook for expensive processing. If
11507 unavoidable, wrap your code in `(while-no-input (redisplay) CODE)' to
11508 avoid making Emacs unresponsive while the user types.
11510 See also `pre-command-hook'. */);
11511 Vpost_command_hook
= Qnil
;
11514 DEFVAR_LISP ("echo-area-clear-hook", ...,
11515 doc
: /* Normal hook run when clearing the echo area. */);
11517 DEFSYM (Qecho_area_clear_hook
, "echo-area-clear-hook");
11518 Fset (Qecho_area_clear_hook
, Qnil
);
11520 DEFVAR_LISP ("lucid-menu-bar-dirty-flag", Vlucid_menu_bar_dirty_flag
,
11521 doc
: /* Non-nil means menu bar, specified Lucid style, needs to be recomputed. */);
11522 Vlucid_menu_bar_dirty_flag
= Qnil
;
11524 DEFVAR_LISP ("menu-bar-final-items", Vmenu_bar_final_items
,
11525 doc
: /* List of menu bar items to move to the end of the menu bar.
11526 The elements of the list are event types that may have menu bar bindings. */);
11527 Vmenu_bar_final_items
= Qnil
;
11529 DEFVAR_LISP ("tool-bar-separator-image-expression", Vtool_bar_separator_image_expression
,
11530 doc
: /* Expression evaluating to the image spec for a tool-bar separator.
11531 This is used internally by graphical displays that do not render
11532 tool-bar separators natively. Otherwise it is unused (e.g. on GTK). */);
11533 Vtool_bar_separator_image_expression
= Qnil
;
11535 DEFVAR_KBOARD ("overriding-terminal-local-map",
11536 Voverriding_terminal_local_map
,
11537 doc
: /* Per-terminal keymap that takes precedence over all other keymaps.
11538 This variable is intended to let commands such as `universal-argument'
11539 set up a different keymap for reading the next command.
11541 `overriding-terminal-local-map' has a separate binding for each
11542 terminal device. See Info node `(elisp)Multiple Terminals'. */);
11544 DEFVAR_LISP ("overriding-local-map", Voverriding_local_map
,
11545 doc
: /* Keymap that replaces (overrides) local keymaps.
11546 If this variable is non-nil, Emacs looks up key bindings in this
11547 keymap INSTEAD OF the keymap char property, minor mode maps, and the
11548 buffer's local map. Hence, the only active keymaps would be
11549 `overriding-terminal-local-map', this keymap, and `global-keymap', in
11550 order of precedence. */);
11551 Voverriding_local_map
= Qnil
;
11553 DEFVAR_LISP ("overriding-local-map-menu-flag", Voverriding_local_map_menu_flag
,
11554 doc
: /* Non-nil means `overriding-local-map' applies to the menu bar.
11555 Otherwise, the menu bar continues to reflect the buffer's local map
11556 and the minor mode maps regardless of `overriding-local-map'. */);
11557 Voverriding_local_map_menu_flag
= Qnil
;
11559 DEFVAR_LISP ("special-event-map", Vspecial_event_map
,
11560 doc
: /* Keymap defining bindings for special events to execute at low level. */);
11561 Vspecial_event_map
= list1 (Qkeymap
);
11563 DEFVAR_LISP ("track-mouse", do_mouse_tracking
,
11564 doc
: /* Non-nil means generate motion events for mouse motion. */);
11566 DEFVAR_KBOARD ("system-key-alist", Vsystem_key_alist
,
11567 doc
: /* Alist of system-specific X windows key symbols.
11568 Each element should have the form (N . SYMBOL) where N is the
11569 numeric keysym code (sans the \"system-specific\" bit 1<<28)
11570 and SYMBOL is its name.
11572 `system-key-alist' has a separate binding for each terminal device.
11573 See Info node `(elisp)Multiple Terminals'. */);
11575 DEFVAR_KBOARD ("local-function-key-map", Vlocal_function_key_map
,
11576 doc
: /* Keymap that translates key sequences to key sequences during input.
11577 This is used mainly for mapping key sequences into some preferred
11578 key events (symbols).
11580 The `read-key-sequence' function replaces any subsequence bound by
11581 `local-function-key-map' with its binding. More precisely, when the
11582 active keymaps have no binding for the current key sequence but
11583 `local-function-key-map' binds a suffix of the sequence to a vector or
11584 string, `read-key-sequence' replaces the matching suffix with its
11585 binding, and continues with the new sequence.
11587 If the binding is a function, it is called with one argument (the prompt)
11588 and its return value (a key sequence) is used.
11590 The events that come from bindings in `local-function-key-map' are not
11591 themselves looked up in `local-function-key-map'.
11593 For example, suppose `local-function-key-map' binds `ESC O P' to [f1].
11594 Typing `ESC O P' to `read-key-sequence' would return [f1]. Typing
11595 `C-x ESC O P' would return [?\\C-x f1]. If [f1] were a prefix key,
11596 typing `ESC O P x' would return [f1 x].
11598 `local-function-key-map' has a separate binding for each terminal
11599 device. See Info node `(elisp)Multiple Terminals'. If you need to
11600 define a binding on all terminals, change `function-key-map'
11601 instead. Initially, `local-function-key-map' is an empty keymap that
11602 has `function-key-map' as its parent on all terminal devices. */);
11604 DEFVAR_KBOARD ("input-decode-map", Vinput_decode_map
,
11605 doc
: /* Keymap that decodes input escape sequences.
11606 This is used mainly for mapping ASCII function key sequences into
11607 real Emacs function key events (symbols).
11609 The `read-key-sequence' function replaces any subsequence bound by
11610 `input-decode-map' with its binding. Contrary to `function-key-map',
11611 this map applies its rebinding regardless of the presence of an ordinary
11612 binding. So it is more like `key-translation-map' except that it applies
11613 before `function-key-map' rather than after.
11615 If the binding is a function, it is called with one argument (the prompt)
11616 and its return value (a key sequence) is used.
11618 The events that come from bindings in `input-decode-map' are not
11619 themselves looked up in `input-decode-map'. */);
11621 DEFVAR_LISP ("function-key-map", Vfunction_key_map
,
11622 doc
: /* The parent keymap of all `local-function-key-map' instances.
11623 Function key definitions that apply to all terminal devices should go
11624 here. If a mapping is defined in both the current
11625 `local-function-key-map' binding and this variable, then the local
11626 definition will take precedence. */);
11627 Vfunction_key_map
= Fmake_sparse_keymap (Qnil
);
11629 DEFVAR_LISP ("key-translation-map", Vkey_translation_map
,
11630 doc
: /* Keymap of key translations that can override keymaps.
11631 This keymap works like `input-decode-map', but comes after `function-key-map'.
11632 Another difference is that it is global rather than terminal-local. */);
11633 Vkey_translation_map
= Fmake_sparse_keymap (Qnil
);
11635 DEFVAR_LISP ("deferred-action-list", Vdeferred_action_list
,
11636 doc
: /* List of deferred actions to be performed at a later time.
11637 The precise format isn't relevant here; we just check whether it is nil. */);
11638 Vdeferred_action_list
= Qnil
;
11640 DEFVAR_LISP ("deferred-action-function", Vdeferred_action_function
,
11641 doc
: /* Function to call to handle deferred actions, after each command.
11642 This function is called with no arguments after each command
11643 whenever `deferred-action-list' is non-nil. */);
11644 Vdeferred_action_function
= Qnil
;
11646 DEFVAR_LISP ("delayed-warnings-list", Vdelayed_warnings_list
,
11647 doc
: /* List of warnings to be displayed after this command.
11648 Each element must be a list (TYPE MESSAGE [LEVEL [BUFFER-NAME]]),
11649 as per the args of `display-warning' (which see).
11650 If this variable is non-nil, `delayed-warnings-hook' will be run
11651 immediately after running `post-command-hook'. */);
11652 Vdelayed_warnings_list
= Qnil
;
11654 DEFVAR_LISP ("timer-list", Vtimer_list
,
11655 doc
: /* List of active absolute time timers in order of increasing time. */);
11656 Vtimer_list
= Qnil
;
11658 DEFVAR_LISP ("timer-idle-list", Vtimer_idle_list
,
11659 doc
: /* List of active idle-time timers in order of increasing time. */);
11660 Vtimer_idle_list
= Qnil
;
11662 DEFVAR_LISP ("input-method-function", Vinput_method_function
,
11663 doc
: /* If non-nil, the function that implements the current input method.
11664 It's called with one argument, a printing character that was just read.
11665 \(That means a character with code 040...0176.)
11666 Typically this function uses `read-event' to read additional events.
11667 When it does so, it should first bind `input-method-function' to nil
11668 so it will not be called recursively.
11670 The function should return a list of zero or more events
11671 to be used as input. If it wants to put back some events
11672 to be reconsidered, separately, by the input method,
11673 it can add them to the beginning of `unread-command-events'.
11675 The input method function can find in `input-method-previous-message'
11676 the previous echo area message.
11678 The input method function should refer to the variables
11679 `input-method-use-echo-area' and `input-method-exit-on-first-char'
11680 for guidance on what to do. */);
11681 Vinput_method_function
= Qlist
;
11683 DEFVAR_LISP ("input-method-previous-message",
11684 Vinput_method_previous_message
,
11685 doc
: /* When `input-method-function' is called, hold the previous echo area message.
11686 This variable exists because `read-event' clears the echo area
11687 before running the input method. It is nil if there was no message. */);
11688 Vinput_method_previous_message
= Qnil
;
11690 DEFVAR_LISP ("show-help-function", Vshow_help_function
,
11691 doc
: /* If non-nil, the function that implements the display of help.
11692 It's called with one argument, the help string to display. */);
11693 Vshow_help_function
= Qnil
;
11695 DEFVAR_LISP ("disable-point-adjustment", Vdisable_point_adjustment
,
11696 doc
: /* If non-nil, suppress point adjustment after executing a command.
11698 After a command is executed, if point moved into a region that has
11699 special properties (e.g. composition, display), Emacs adjusts point to
11700 the boundary of the region. But when a command leaves this variable at
11701 a non-nil value (e.g., with a setq), this point adjustment is suppressed.
11703 This variable is set to nil before reading a command, and is checked
11704 just after executing the command. */);
11705 Vdisable_point_adjustment
= Qnil
;
11707 DEFVAR_LISP ("global-disable-point-adjustment",
11708 Vglobal_disable_point_adjustment
,
11709 doc
: /* If non-nil, always suppress point adjustments.
11711 The default value is nil, in which case point adjustments are
11712 suppressed only after special commands that leave
11713 `disable-point-adjustment' (which see) at a non-nil value. */);
11714 Vglobal_disable_point_adjustment
= Qnil
;
11716 DEFVAR_LISP ("minibuffer-message-timeout", Vminibuffer_message_timeout
,
11717 doc
: /* How long to display an echo-area message when the minibuffer is active.
11718 If the value is a number, it should be specified in seconds.
11719 If the value is not a number, such messages never time out. */);
11720 Vminibuffer_message_timeout
= make_number (2);
11722 DEFVAR_LISP ("throw-on-input", Vthrow_on_input
,
11723 doc
: /* If non-nil, any keyboard input throws to this symbol.
11724 The value of that variable is passed to `quit-flag' and later causes a
11725 peculiar kind of quitting. */);
11726 Vthrow_on_input
= Qnil
;
11728 DEFVAR_LISP ("command-error-function", Vcommand_error_function
,
11729 doc
: /* Function to output error messages.
11730 Called with three arguments:
11731 - the error data, a list of the form (SIGNALED-CONDITION . SIGNAL-DATA)
11732 such as what `condition-case' would bind its variable to,
11733 - the context (a string which normally goes at the start of the message),
11734 - the Lisp function within which the error was signaled. */);
11735 Vcommand_error_function
= intern ("command-error-default-function");
11737 DEFVAR_LISP ("enable-disabled-menus-and-buttons",
11738 Venable_disabled_menus_and_buttons
,
11739 doc
: /* If non-nil, don't ignore events produced by disabled menu items and tool-bar.
11741 Help functions bind this to allow help on disabled menu items
11742 and tool-bar buttons. */);
11743 Venable_disabled_menus_and_buttons
= Qnil
;
11745 DEFVAR_LISP ("select-active-regions",
11746 Vselect_active_regions
,
11747 doc
: /* If non-nil, an active region automatically sets the primary selection.
11748 If the value is `only', only temporarily active regions (usually made
11749 by mouse-dragging or shift-selection) set the window selection.
11751 This takes effect only when Transient Mark mode is enabled. */);
11752 Vselect_active_regions
= Qt
;
11754 DEFVAR_LISP ("saved-region-selection",
11755 Vsaved_region_selection
,
11756 doc
: /* Contents of active region prior to buffer modification.
11757 If `select-active-regions' is non-nil, Emacs sets this to the
11758 text in the region before modifying the buffer. The next call to
11759 the function `deactivate-mark' uses this to set the window selection. */);
11760 Vsaved_region_selection
= Qnil
;
11762 DEFVAR_LISP ("selection-inhibit-update-commands",
11763 Vselection_inhibit_update_commands
,
11764 doc
: /* List of commands which should not update the selection.
11765 Normally, if `select-active-regions' is non-nil and the mark remains
11766 active after a command (i.e. the mark was not deactivated), the Emacs
11767 command loop sets the selection to the text in the region. However,
11768 if the command is in this list, the selection is not updated. */);
11769 Vselection_inhibit_update_commands
11770 = list2 (Qhandle_switch_frame
, Qhandle_select_window
);
11772 DEFVAR_LISP ("debug-on-event",
11774 doc
: /* Enter debugger on this event. When Emacs
11775 receives the special event specified by this variable, it will try to
11776 break into the debugger as soon as possible instead of processing the
11777 event normally through `special-event-map'.
11779 Currently, the only supported values for this
11780 variable are `sigusr1' and `sigusr2'. */);
11781 Vdebug_on_event
= intern_c_string ("sigusr2");
11783 DEFVAR_BOOL ("attempt-stack-overflow-recovery",
11784 attempt_stack_overflow_recovery
,
11785 doc
: /* If non-nil, attempt to recover from C stack
11786 overflow. This recovery is unsafe and may lead to deadlocks or data
11787 corruption, but it usually works and may preserve modified buffers
11788 that would otherwise be lost. If nil, treat stack overflow like any
11789 other kind of crash. */);
11790 attempt_stack_overflow_recovery
= true;
11792 DEFVAR_BOOL ("attempt-orderly-shutdown-on-fatal-signal",
11793 attempt_orderly_shutdown_on_fatal_signal
,
11794 doc
: /* If non-nil, attempt to perform an orderly
11795 shutdown when Emacs receives a fatal signal (e.g., a crash).
11796 This cleanup is unsafe and may lead to deadlocks or data corruption,
11797 but it usually works and may preserve modified buffers that would
11798 otherwise be lost. If nil, crash immediately in response to fatal
11800 attempt_orderly_shutdown_on_fatal_signal
= true;
11802 /* Create the initial keyboard. Qt means 'unset'. */
11803 initial_kboard
= allocate_kboard (Qt
);
11805 DEFVAR_LISP ("while-no-input-ignore-events",
11806 Vwhile_no_input_ignore_events
,
11807 doc
: /* Ignored events from while-no-input. */);
11808 Vwhile_no_input_ignore_events
= Qnil
;
11812 keys_of_keyboard (void)
11814 initial_define_key (global_map
, Ctl ('Z'), "suspend-emacs");
11815 initial_define_key (control_x_map
, Ctl ('Z'), "suspend-emacs");
11816 initial_define_key (meta_map
, Ctl ('C'), "exit-recursive-edit");
11817 initial_define_key (global_map
, Ctl (']'), "abort-recursive-edit");
11818 initial_define_key (meta_map
, 'x', "execute-extended-command");
11820 initial_define_lispy_key (Vspecial_event_map
, "delete-frame",
11821 "handle-delete-frame");
11823 initial_define_lispy_key (Vspecial_event_map
, "end-session",
11826 initial_define_lispy_key (Vspecial_event_map
, "ns-put-working-text",
11827 "ns-put-working-text");
11828 initial_define_lispy_key (Vspecial_event_map
, "ns-unput-working-text",
11829 "ns-unput-working-text");
11830 /* Here we used to use `ignore-event' which would simple set prefix-arg to
11831 current-prefix-arg, as is done in `handle-switch-frame'.
11832 But `handle-switch-frame is not run from the special-map.
11833 Commands from that map are run in a special way that automatically
11834 preserves the prefix-arg. Restoring the prefix arg here is not just
11835 redundant but harmful:
11837 - current-prefix-arg is set to non-nil, prefix-arg is set to nil.
11838 - after the first prompt, the exit-minibuffer-hook is run which may
11839 iconify a frame and thus push a `iconify-frame' event.
11840 - after running exit-minibuffer-hook, current-prefix-arg is
11841 restored to the non-nil value it had before the prompt.
11842 - we enter the second prompt.
11843 current-prefix-arg is non-nil, prefix-arg is nil.
11844 - before running the first real event, we run the special iconify-frame
11845 event, but we pass the `special' arg to command-execute so
11846 current-prefix-arg and prefix-arg are left untouched.
11847 - here we foolishly copy the non-nil current-prefix-arg to prefix-arg.
11848 - the next key event will have a spuriously non-nil current-prefix-arg. */
11849 initial_define_lispy_key (Vspecial_event_map
, "iconify-frame",
11851 initial_define_lispy_key (Vspecial_event_map
, "make-frame-visible",
11853 /* Handling it at such a low-level causes read_key_sequence to get
11854 * confused because it doesn't realize that the current_buffer was
11855 * changed by read_char.
11857 * initial_define_lispy_key (Vspecial_event_map, "select-window",
11858 * "handle-select-window"); */
11859 initial_define_lispy_key (Vspecial_event_map
, "save-session",
11860 "handle-save-session");
11863 /* Define a special event which is raised for dbus callback
11865 initial_define_lispy_key (Vspecial_event_map
, "dbus-event",
11866 "dbus-handle-event");
11869 #ifdef USE_FILE_NOTIFY
11870 /* Define a special event which is raised for notification callback
11872 initial_define_lispy_key (Vspecial_event_map
, "file-notify",
11873 "file-notify-handle-event");
11874 #endif /* USE_FILE_NOTIFY */
11876 initial_define_lispy_key (Vspecial_event_map
, "config-changed-event",
11878 #if defined (WINDOWSNT)
11879 initial_define_lispy_key (Vspecial_event_map
, "language-change",
11882 initial_define_lispy_key (Vspecial_event_map
, "focus-in",
11883 "handle-focus-in");
11884 initial_define_lispy_key (Vspecial_event_map
, "focus-out",
11885 "handle-focus-out");
11888 /* Mark the pointers in the kboard objects.
11889 Called by Fgarbage_collect. */
11891 mark_kboards (void)
11895 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
11897 if (kb
->kbd_macro_buffer
)
11898 for (p
= kb
->kbd_macro_buffer
; p
< kb
->kbd_macro_ptr
; p
++)
11900 mark_object (KVAR (kb
, Voverriding_terminal_local_map
));
11901 mark_object (KVAR (kb
, Vlast_command
));
11902 mark_object (KVAR (kb
, Vreal_last_command
));
11903 mark_object (KVAR (kb
, Vkeyboard_translate_table
));
11904 mark_object (KVAR (kb
, Vlast_repeatable_command
));
11905 mark_object (KVAR (kb
, Vprefix_arg
));
11906 mark_object (KVAR (kb
, Vlast_prefix_arg
));
11907 mark_object (KVAR (kb
, kbd_queue
));
11908 mark_object (KVAR (kb
, defining_kbd_macro
));
11909 mark_object (KVAR (kb
, Vlast_kbd_macro
));
11910 mark_object (KVAR (kb
, Vsystem_key_alist
));
11911 mark_object (KVAR (kb
, system_key_syms
));
11912 mark_object (KVAR (kb
, Vwindow_system
));
11913 mark_object (KVAR (kb
, Vinput_decode_map
));
11914 mark_object (KVAR (kb
, Vlocal_function_key_map
));
11915 mark_object (KVAR (kb
, Vdefault_minibuffer_frame
));
11916 mark_object (KVAR (kb
, echo_string
));
11917 mark_object (KVAR (kb
, echo_prompt
));
11920 union buffered_input_event
*event
;
11921 for (event
= kbd_fetch_ptr
; event
!= kbd_store_ptr
; event
++)
11923 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
11924 event
= kbd_buffer
;
11925 /* These two special event types has no Lisp_Objects to mark. */
11926 if (event
->kind
!= SELECTION_REQUEST_EVENT
11927 && event
->kind
!= SELECTION_CLEAR_EVENT
)
11929 mark_object (event
->ie
.x
);
11930 mark_object (event
->ie
.y
);
11931 mark_object (event
->ie
.frame_or_window
);
11932 mark_object (event
->ie
.arg
);