1 /* Keyboard and mouse input; editor command loop.
3 Copyright (C) 1985-1989, 1993-1997, 1999-2016 Free Software Foundation,
6 This file is part of GNU Emacs.
8 GNU Emacs is free software: you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation, either version 3 of the License, or
11 (at your option) any later version.
13 GNU Emacs is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
30 #include "termhooks.h"
35 #include "character.h"
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 /* Variables for blockinput.h: */
75 /* Positive if interrupt input is blocked right now. */
76 volatile int interrupt_input_blocked
;
78 /* True means an input interrupt or alarm signal has arrived.
79 The QUIT macro checks this. */
80 volatile bool pending_signals
;
82 #define KBD_BUFFER_SIZE 4096
84 KBOARD
*initial_kboard
;
85 KBOARD
*current_kboard
;
86 static KBOARD
*all_kboards
;
88 /* True in the single-kboard state, false in the any-kboard state. */
89 static bool single_kboard
;
91 #define NUM_RECENT_KEYS (300)
93 /* Index for storing next element into recent_keys. */
94 static int recent_keys_index
;
96 /* Total number of elements stored into recent_keys. */
97 static int total_keys
;
99 /* This vector holds the last NUM_RECENT_KEYS keystrokes. */
100 static Lisp_Object recent_keys
;
102 /* Vector holding the key sequence that invoked the current command.
103 It is reused for each command, and it may be longer than the current
104 sequence; this_command_key_count indicates how many elements
105 actually mean something.
106 It's easier to staticpro a single Lisp_Object than an array. */
107 Lisp_Object this_command_keys
;
108 ptrdiff_t this_command_key_count
;
110 /* This vector is used as a buffer to record the events that were actually read
111 by read_key_sequence. */
112 static Lisp_Object raw_keybuf
;
113 static int raw_keybuf_count
;
115 #define GROW_RAW_KEYBUF \
116 if (raw_keybuf_count == ASIZE (raw_keybuf)) \
117 raw_keybuf = larger_vector (raw_keybuf, 1, -1)
119 /* Number of elements of this_command_keys
120 that precede this key sequence. */
121 static ptrdiff_t this_single_command_key_start
;
123 #ifdef HAVE_STACK_OVERFLOW_HANDLING
125 /* For longjmp to recover from C stack overflow. */
126 sigjmp_buf return_to_command_loop
;
128 /* Message displayed by Vtop_level when recovering from C stack overflow. */
129 static Lisp_Object recover_top_level_message
;
131 #endif /* HAVE_STACK_OVERFLOW_HANDLING */
133 /* Message normally displayed by Vtop_level. */
134 static Lisp_Object regular_top_level_message
;
136 /* For longjmp to where kbd input is being done. */
138 static sys_jmp_buf getcjmp
;
140 /* True while doing kbd input. */
141 bool waiting_for_input
;
143 /* True while displaying for echoing. Delays C-g throwing. */
147 /* Non-null means we can start echoing at the next input pause even
148 though there is something in the echo area. */
150 static struct kboard
*ok_to_echo_at_next_pause
;
152 /* The kboard last echoing, or null for none. Reset to 0 in
153 cancel_echoing. If non-null, and a current echo area message
154 exists, and echo_message_buffer is eq to the current message
155 buffer, we know that the message comes from echo_kboard. */
157 struct kboard
*echo_kboard
;
159 /* The buffer used for echoing. Set in echo_now, reset in
162 Lisp_Object echo_message_buffer
;
164 /* True means C-g should cause immediate error-signal. */
167 /* Character that causes a quit. Normally C-g.
169 If we are running on an ordinary terminal, this must be an ordinary
170 ASCII char, since we want to make it our interrupt character.
172 If we are not running on an ordinary terminal, it still needs to be
173 an ordinary ASCII char. This character needs to be recognized in
174 the input interrupt handler. At this point, the keystroke is
175 represented as a struct input_event, while the desired quit
176 character is specified as a lispy event. The mapping from struct
177 input_events to lispy events cannot run in an interrupt handler,
178 and the reverse mapping is difficult for anything but ASCII
181 FOR THESE ELABORATE AND UNSATISFYING REASONS, quit_char must be an
185 /* Current depth in recursive edits. */
186 EMACS_INT command_loop_level
;
188 /* If not Qnil, this is a switch-frame event which we decided to put
189 off until the end of a key sequence. This should be read as the
190 next command input, after any unread_command_events.
192 read_key_sequence uses this to delay switch-frame events until the
193 end of the key sequence; Fread_char uses it to put off switch-frame
194 events until a non-ASCII event is acceptable as input. */
195 Lisp_Object unread_switch_frame
;
197 /* Last size recorded for a current buffer which is not a minibuffer. */
198 static ptrdiff_t last_non_minibuf_size
;
200 uintmax_t num_input_events
;
201 ptrdiff_t point_before_last_command_or_undo
;
202 struct buffer
*buffer_before_last_command_or_undo
;
204 /* Value of num_nonmacro_input_events as of last auto save. */
206 static EMACS_INT last_auto_save
;
208 /* The value of point when the last command was started. */
209 static ptrdiff_t last_point_position
;
211 /* The frame in which the last input event occurred, or Qmacro if the
212 last event came from a macro. We use this to determine when to
213 generate switch-frame events. This may be cleared by functions
214 like Fselect_frame, to make sure that a switch-frame event is
215 generated by the next character.
217 FIXME: This is modified by a signal handler so it should be volatile.
218 It's exported to Lisp, though, so it can't simply be marked
220 Lisp_Object internal_last_event_frame
;
222 /* `read_key_sequence' stores here the command definition of the
223 key sequence that it reads. */
224 static Lisp_Object read_key_sequence_cmd
;
225 static Lisp_Object read_key_sequence_remapped
;
227 /* File in which we write all commands we read. */
228 static FILE *dribble
;
230 /* True if input is available. */
233 /* True if more input was available last time we read an event.
235 Since redisplay can take a significant amount of time and is not
236 indispensable to perform the user's commands, when input arrives
237 "too fast", Emacs skips redisplay. More specifically, if the next
238 command has already been input when we finish the previous command,
239 we skip the intermediate redisplay.
241 This is useful to try and make sure Emacs keeps up with fast input
242 rates, such as auto-repeating keys. But in some cases, this proves
243 too conservative: we may end up disabling redisplay for the whole
244 duration of a key repetition, even though we could afford to
245 redisplay every once in a while.
247 So we "sample" the input_pending flag before running a command and
248 use *that* value after running the command to decide whether to
249 skip redisplay or not. This way, we only skip redisplay if we
250 really can't keep up with the repeat rate.
252 This only makes a difference if the next input arrives while running the
253 command, which is very unlikely if the command is executed quickly.
254 IOW this tends to avoid skipping redisplay after a long running command
255 (which is a case where skipping redisplay is not very useful since the
256 redisplay time is small compared to the time it took to run the command).
258 A typical use case is when scrolling. Scrolling time can be split into:
259 - Time to do jit-lock on the newly displayed portion of buffer.
260 - Time to run the actual scroll command.
261 - Time to perform the redisplay.
262 Jit-lock can happen either during the command or during the redisplay.
263 In the most painful cases, the jit-lock time is the one that dominates.
264 Also jit-lock can be tweaked (via jit-lock-defer) to delay its job, at the
265 cost of temporary inaccuracy in display and scrolling.
266 So without input_was_pending, what typically happens is the following:
267 - when the command starts, there's no pending input (yet).
268 - the scroll command triggers jit-lock.
269 - during the long jit-lock time the next input arrives.
270 - at the end of the command, we check input_pending and hence decide to
272 - we read the next input and start over.
273 End result: all the hard work of jit-locking is "wasted" since redisplay
274 doesn't actually happens (at least not before the input rate slows down).
275 With input_was_pending redisplay is still skipped if Emacs can't keep up
276 with the input rate, but if it can keep up just enough that there's no
277 input_pending when we begin the command, then redisplay is not skipped
278 which results in better feedback to the user. */
279 static bool input_was_pending
;
281 /* Circular buffer for pre-read keyboard input. */
283 static union buffered_input_event kbd_buffer
[KBD_BUFFER_SIZE
];
285 /* Pointer to next available character in kbd_buffer.
286 If kbd_fetch_ptr == kbd_store_ptr, the buffer is empty.
287 This may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the
288 next available char is in kbd_buffer[0]. */
289 static union buffered_input_event
*kbd_fetch_ptr
;
291 /* Pointer to next place to store character in kbd_buffer. This
292 may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the next
293 character should go in kbd_buffer[0]. */
294 static union buffered_input_event
*volatile kbd_store_ptr
;
296 /* The above pair of variables forms a "queue empty" flag. When we
297 enqueue a non-hook event, we increment kbd_store_ptr. When we
298 dequeue a non-hook event, we increment kbd_fetch_ptr. We say that
299 there is input available if the two pointers are not equal.
301 Why not just have a flag set and cleared by the enqueuing and
302 dequeuing functions? Such a flag could be screwed up by interrupts
303 at inopportune times. */
305 static void recursive_edit_unwind (Lisp_Object buffer
);
306 static Lisp_Object
command_loop (void);
308 static void echo_now (void);
309 static ptrdiff_t echo_length (void);
311 /* Incremented whenever a timer is run. */
314 /* Address (if not 0) of struct timespec to zero out if a SIGIO interrupt
316 struct timespec
*input_available_clear_time
;
318 /* True means use SIGIO interrupts; false means use CBREAK mode.
319 Default is true if INTERRUPT_INPUT is defined. */
320 bool interrupt_input
;
322 /* Nonzero while interrupts are temporarily deferred during redisplay. */
323 bool interrupts_deferred
;
325 /* The time when Emacs started being idle. */
327 static struct timespec timer_idleness_start_time
;
329 /* After Emacs stops being idle, this saves the last value
330 of timer_idleness_start_time from when it was idle. */
332 static struct timespec timer_last_idleness_start_time
;
335 /* Global variable declarations. */
337 /* Flags for readable_events. */
338 #define READABLE_EVENTS_DO_TIMERS_NOW (1 << 0)
339 #define READABLE_EVENTS_FILTER_EVENTS (1 << 1)
340 #define READABLE_EVENTS_IGNORE_SQUEEZABLES (1 << 2)
342 /* Function for init_keyboard to call with no args (if nonzero). */
343 static void (*keyboard_init_hook
) (void);
345 static bool get_input_pending (int);
346 static bool readable_events (int);
347 static Lisp_Object
read_char_x_menu_prompt (Lisp_Object
,
348 Lisp_Object
, bool *);
349 static Lisp_Object
read_char_minibuf_menu_prompt (int, Lisp_Object
);
350 static Lisp_Object
make_lispy_event (struct input_event
*);
351 static Lisp_Object
make_lispy_movement (struct frame
*, Lisp_Object
,
352 enum scroll_bar_part
,
353 Lisp_Object
, Lisp_Object
,
355 static Lisp_Object
modify_event_symbol (ptrdiff_t, int, Lisp_Object
,
356 Lisp_Object
, const char *const *,
357 Lisp_Object
*, ptrdiff_t);
358 static Lisp_Object
make_lispy_switch_frame (Lisp_Object
);
359 static Lisp_Object
make_lispy_focus_in (Lisp_Object
);
360 #ifdef HAVE_WINDOW_SYSTEM
361 static Lisp_Object
make_lispy_focus_out (Lisp_Object
);
362 #endif /* HAVE_WINDOW_SYSTEM */
363 static bool help_char_p (Lisp_Object
);
364 static void save_getcjmp (sys_jmp_buf
);
365 static void restore_getcjmp (sys_jmp_buf
);
366 static Lisp_Object
apply_modifiers (int, Lisp_Object
);
367 static void restore_kboard_configuration (int);
368 static void handle_interrupt (bool);
369 static _Noreturn
void quit_throw_to_read_char (bool);
370 static void timer_start_idle (void);
371 static void timer_stop_idle (void);
372 static void timer_resume_idle (void);
373 static void deliver_user_signal (int);
374 static char *find_user_signal_name (int);
375 static void store_user_signal_events (void);
377 /* These setters are used only in this file, so they can be private. */
379 kset_echo_string (struct kboard
*kb
, Lisp_Object val
)
381 kb
->echo_string_
= val
;
384 kset_echo_prompt (struct kboard
*kb
, Lisp_Object val
)
386 kb
->echo_prompt_
= val
;
389 kset_kbd_queue (struct kboard
*kb
, Lisp_Object val
)
391 kb
->kbd_queue_
= val
;
394 kset_keyboard_translate_table (struct kboard
*kb
, Lisp_Object val
)
396 kb
->Vkeyboard_translate_table_
= val
;
399 kset_last_prefix_arg (struct kboard
*kb
, Lisp_Object val
)
401 kb
->Vlast_prefix_arg_
= val
;
404 kset_last_repeatable_command (struct kboard
*kb
, Lisp_Object val
)
406 kb
->Vlast_repeatable_command_
= val
;
409 kset_local_function_key_map (struct kboard
*kb
, Lisp_Object val
)
411 kb
->Vlocal_function_key_map_
= val
;
414 kset_overriding_terminal_local_map (struct kboard
*kb
, Lisp_Object val
)
416 kb
->Voverriding_terminal_local_map_
= val
;
419 kset_real_last_command (struct kboard
*kb
, Lisp_Object val
)
421 kb
->Vreal_last_command_
= val
;
424 kset_system_key_syms (struct kboard
*kb
, Lisp_Object val
)
426 kb
->system_key_syms_
= val
;
430 /* Add C to the echo string, without echoing it immediately. C can be
431 a character, which is pretty-printed, or a symbol, whose name is
435 echo_add_key (Lisp_Object c
)
437 char initbuf
[KEY_DESCRIPTION_SIZE
+ 100];
438 ptrdiff_t size
= sizeof initbuf
;
439 char *buffer
= initbuf
;
441 Lisp_Object echo_string
= KVAR (current_kboard
, echo_string
);
444 if (STRINGP (echo_string
) && SCHARS (echo_string
) > 0)
445 /* Add a space at the end as a separator between keys. */
448 /* If someone has passed us a composite event, use its head symbol. */
452 ptr
= push_key_description (XINT (c
), ptr
);
453 else if (SYMBOLP (c
))
455 Lisp_Object name
= SYMBOL_NAME (c
);
456 ptrdiff_t nbytes
= SBYTES (name
);
458 if (size
- (ptr
- buffer
) < nbytes
)
460 ptrdiff_t offset
= ptr
- buffer
;
461 size
= max (2 * size
, size
+ nbytes
);
462 buffer
= SAFE_ALLOCA (size
);
463 ptr
= buffer
+ offset
;
466 ptr
+= copy_text (SDATA (name
), (unsigned char *) ptr
, nbytes
,
467 STRING_MULTIBYTE (name
), 1);
470 if ((NILP (echo_string
) || SCHARS (echo_string
) == 0)
473 static const char text
[] = " (Type ? for further options)";
474 int len
= sizeof text
- 1;
476 if (size
- (ptr
- buffer
) < len
)
478 ptrdiff_t offset
= ptr
- buffer
;
480 buffer
= SAFE_ALLOCA (size
);
481 ptr
= buffer
+ offset
;
484 memcpy (ptr
, text
, len
);
490 concat2 (echo_string
, make_string (buffer
, ptr
- buffer
)));
494 /* Temporarily add a dash to the end of the echo string if it's not
495 empty, so that it serves as a mini-prompt for the very next
501 /* Do nothing if not echoing at all. */
502 if (NILP (KVAR (current_kboard
, echo_string
)))
505 if (!current_kboard
->immediate_echo
506 && SCHARS (KVAR (current_kboard
, echo_string
)) == 0)
509 /* Do nothing if we just printed a prompt. */
510 if (STRINGP (KVAR (current_kboard
, echo_prompt
))
511 && (SCHARS (KVAR (current_kboard
, echo_prompt
))
512 == SCHARS (KVAR (current_kboard
, echo_string
))))
515 /* Do nothing if we have already put a dash at the end. */
516 if (SCHARS (KVAR (current_kboard
, echo_string
)) > 1)
518 Lisp_Object last_char
, prev_char
, idx
;
520 idx
= make_number (SCHARS (KVAR (current_kboard
, echo_string
)) - 2);
521 prev_char
= Faref (KVAR (current_kboard
, echo_string
), idx
);
523 idx
= make_number (SCHARS (KVAR (current_kboard
, echo_string
)) - 1);
524 last_char
= Faref (KVAR (current_kboard
, echo_string
), idx
);
526 if (XINT (last_char
) == '-' && XINT (prev_char
) != ' ')
530 /* Put a dash at the end of the buffer temporarily,
531 but make it go away when the next character is added. */
532 AUTO_STRING (dash
, "-");
533 kset_echo_string (current_kboard
,
534 concat2 (KVAR (current_kboard
, echo_string
), dash
));
541 if (current_kboard
->immediate_echo
)
544 Lisp_Object prompt
= KVAR (current_kboard
, echo_prompt
);
545 Lisp_Object prefix
= call0 (Qinternal_echo_keystrokes_prefix
);
546 kset_echo_string (current_kboard
,
547 NILP (prompt
) ? prefix
548 : NILP (prefix
) ? prompt
549 : concat2 (prompt
, prefix
));
551 for (i
= 0; i
< this_command_key_count
; i
++)
555 c
= AREF (this_command_keys
, i
);
556 if (! (EVENT_HAS_PARAMETERS (c
)
557 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
565 /* Display the current echo string, and begin echoing if not already
571 if (!current_kboard
->immediate_echo
)
573 current_kboard
->immediate_echo
= true;
575 /* Put a dash at the end to invite the user to type more. */
580 /* FIXME: Use call (Qmessage) so it can be advised (e.g. emacspeak). */
581 message3_nolog (KVAR (current_kboard
, echo_string
));
584 /* Record in what buffer we echoed, and from which kboard. */
585 echo_message_buffer
= echo_area_buffer
[0];
586 echo_kboard
= current_kboard
;
588 if (waiting_for_input
&& !NILP (Vquit_flag
))
589 quit_throw_to_read_char (0);
592 /* Turn off echoing, for the start of a new command. */
595 cancel_echoing (void)
597 current_kboard
->immediate_echo
= false;
598 kset_echo_prompt (current_kboard
, Qnil
);
599 kset_echo_string (current_kboard
, Qnil
);
600 ok_to_echo_at_next_pause
= NULL
;
602 echo_message_buffer
= Qnil
;
605 /* Return the length of the current echo string. */
610 return (STRINGP (KVAR (current_kboard
, echo_string
))
611 ? SCHARS (KVAR (current_kboard
, echo_string
))
615 /* Truncate the current echo message to its first LEN chars.
616 This and echo_char get used by read_key_sequence when the user
617 switches frames while entering a key sequence. */
620 echo_truncate (ptrdiff_t nchars
)
622 if (STRINGP (KVAR (current_kboard
, echo_string
)))
623 kset_echo_string (current_kboard
,
624 Fsubstring (KVAR (current_kboard
, echo_string
),
625 make_number (0), make_number (nchars
)));
626 truncate_echo_area (nchars
);
630 /* Functions for manipulating this_command_keys. */
632 add_command_key (Lisp_Object key
)
634 if (this_command_key_count
>= ASIZE (this_command_keys
))
635 this_command_keys
= larger_vector (this_command_keys
, 1, -1);
637 ASET (this_command_keys
, this_command_key_count
, key
);
638 ++this_command_key_count
;
643 recursive_edit_1 (void)
645 ptrdiff_t count
= SPECPDL_INDEX ();
648 if (command_loop_level
> 0)
650 specbind (Qstandard_output
, Qt
);
651 specbind (Qstandard_input
, Qt
);
654 #ifdef HAVE_WINDOW_SYSTEM
655 /* The command loop has started an hourglass timer, so we have to
656 cancel it here, otherwise it will fire because the recursive edit
657 can take some time. Do not check for display_hourglass_p here,
658 because it could already be nil. */
662 /* This function may have been called from a debugger called from
663 within redisplay, for instance by Edebugging a function called
664 from fontification-functions. We want to allow redisplay in
665 the debugging session.
667 The recursive edit is left with a `(throw exit ...)'. The `exit'
668 tag is not caught anywhere in redisplay, i.e. when we leave the
669 recursive edit, the original redisplay leading to the recursive
670 edit will be unwound. The outcome should therefore be safe. */
671 specbind (Qinhibit_redisplay
, Qnil
);
674 val
= command_loop ();
676 Fsignal (Qquit
, Qnil
);
677 /* Handle throw from read_minibuf when using minibuffer
678 while it's active but we're in another window. */
680 xsignal1 (Qerror
, val
);
682 return unbind_to (count
, Qnil
);
685 /* When an auto-save happens, record the "time", and don't do again soon. */
688 record_auto_save (void)
690 last_auto_save
= num_nonmacro_input_events
;
693 /* Make an auto save happen as soon as possible at command level. */
697 force_auto_save_soon (void)
699 last_auto_save
= - auto_save_interval
- 1;
701 record_asynch_buffer_change ();
705 DEFUN ("recursive-edit", Frecursive_edit
, Srecursive_edit
, 0, 0, "",
706 doc
: /* Invoke the editor command loop recursively.
707 To get out of the recursive edit, a command can throw to `exit' -- for
708 instance (throw \\='exit nil).
709 If you throw a value other than t, `recursive-edit' returns normally
710 to the function that called it. Throwing a t value causes
711 `recursive-edit' to quit, so that control returns to the command loop
714 This function is called by the editor initialization to begin editing. */)
717 ptrdiff_t count
= SPECPDL_INDEX ();
720 /* If we enter while input is blocked, don't lock up here.
721 This may happen through the debugger during redisplay. */
722 if (input_blocked_p ())
725 if (command_loop_level
>= 0
726 && current_buffer
!= XBUFFER (XWINDOW (selected_window
)->contents
))
727 buffer
= Fcurrent_buffer ();
731 /* Don't do anything interesting between the increment and the
732 record_unwind_protect! Otherwise, we could get distracted and
733 never decrement the counter again. */
734 command_loop_level
++;
735 update_mode_lines
= 17;
736 record_unwind_protect (recursive_edit_unwind
, buffer
);
738 /* If we leave recursive_edit_1 below with a `throw' for instance,
739 like it is done in the splash screen display, we have to
740 make sure that we restore single_kboard as command_loop_1
741 would have done if it were left normally. */
742 if (command_loop_level
> 0)
743 temporarily_switch_to_single_kboard (SELECTED_FRAME ());
746 return unbind_to (count
, Qnil
);
750 recursive_edit_unwind (Lisp_Object buffer
)
752 if (BUFFERP (buffer
))
753 Fset_buffer (buffer
);
755 command_loop_level
--;
756 update_mode_lines
= 18;
760 #if 0 /* These two functions are now replaced with
761 temporarily_switch_to_single_kboard. */
765 #if 0 /* Theory: if there's anything in Vunread_command_events,
766 it will right away be read by read_key_sequence,
767 and then if we do switch KBOARDS, it will go into the side
768 queue then. So we don't need to do anything special here -- rms. */
769 if (CONSP (Vunread_command_events
))
771 current_kboard
->kbd_queue
772 = nconc2 (Vunread_command_events
, current_kboard
->kbd_queue
);
773 current_kboard
->kbd_queue_has_data
= true;
775 Vunread_command_events
= Qnil
;
777 single_kboard
= false;
780 /* Switch to the single-kboard state, making current_kboard
781 the only KBOARD from which further input is accepted. */
784 single_kboard_state ()
786 single_kboard
= true;
790 /* If we're in single_kboard state for kboard KBOARD,
794 not_single_kboard_state (KBOARD
*kboard
)
796 if (kboard
== current_kboard
)
797 single_kboard
= false;
800 /* Maintain a stack of kboards, so other parts of Emacs
801 can switch temporarily to the kboard of a given frame
802 and then revert to the previous status. */
807 struct kboard_stack
*next
;
810 static struct kboard_stack
*kboard_stack
;
813 push_kboard (struct kboard
*k
)
815 struct kboard_stack
*p
= xmalloc (sizeof *p
);
817 p
->next
= kboard_stack
;
818 p
->kboard
= current_kboard
;
828 struct kboard_stack
*p
= kboard_stack
;
830 for (t
= terminal_list
; t
; t
= t
->next_terminal
)
832 if (t
->kboard
== p
->kboard
)
834 current_kboard
= p
->kboard
;
841 /* The terminal we remembered has been deleted. */
842 current_kboard
= FRAME_KBOARD (SELECTED_FRAME ());
843 single_kboard
= false;
845 kboard_stack
= p
->next
;
849 /* Switch to single_kboard mode, making current_kboard the only KBOARD
850 from which further input is accepted. If F is non-nil, set its
851 KBOARD as the current keyboard.
853 This function uses record_unwind_protect_int to return to the previous
856 If Emacs is already in single_kboard mode, and F's keyboard is
857 locked, then this function will throw an error. */
860 temporarily_switch_to_single_kboard (struct frame
*f
)
862 bool was_locked
= single_kboard
;
865 if (f
!= NULL
&& FRAME_KBOARD (f
) != current_kboard
)
866 /* We can not switch keyboards while in single_kboard mode.
867 In rare cases, Lisp code may call `recursive-edit' (or
868 `read-minibuffer' or `y-or-n-p') after it switched to a
869 locked frame. For example, this is likely to happen
870 when server.el connects to a new terminal while Emacs is in
871 single_kboard mode. It is best to throw an error instead
872 of presenting the user with a frozen screen. */
873 error ("Terminal %d is locked, cannot read from it",
874 FRAME_TERMINAL (f
)->id
);
876 /* This call is unnecessary, but helps
877 `restore_kboard_configuration' discover if somebody changed
878 `current_kboard' behind our back. */
879 push_kboard (current_kboard
);
882 current_kboard
= FRAME_KBOARD (f
);
883 single_kboard
= true;
884 record_unwind_protect_int (restore_kboard_configuration
, was_locked
);
887 #if 0 /* This function is not needed anymore. */
889 record_single_kboard_state ()
892 push_kboard (current_kboard
);
893 record_unwind_protect_int (restore_kboard_configuration
, single_kboard
);
898 restore_kboard_configuration (int was_locked
)
900 single_kboard
= was_locked
;
903 struct kboard
*prev
= current_kboard
;
905 /* The pop should not change the kboard. */
906 if (single_kboard
&& current_kboard
!= prev
)
912 /* Handle errors that are not handled at inner levels
913 by printing an error message and returning to the editor command loop. */
916 cmd_error (Lisp_Object data
)
918 Lisp_Object old_level
, old_length
;
919 char macroerror
[sizeof "After..kbd macro iterations: "
920 + INT_STRLEN_BOUND (EMACS_INT
)];
922 #ifdef HAVE_WINDOW_SYSTEM
923 if (display_hourglass_p
)
927 if (!NILP (executing_kbd_macro
))
929 if (executing_kbd_macro_iterations
== 1)
930 sprintf (macroerror
, "After 1 kbd macro iteration: ");
932 sprintf (macroerror
, "After %"pI
"d kbd macro iterations: ",
933 executing_kbd_macro_iterations
);
938 Vstandard_output
= Qt
;
939 Vstandard_input
= Qt
;
940 Vexecuting_kbd_macro
= Qnil
;
941 executing_kbd_macro
= Qnil
;
942 kset_prefix_arg (current_kboard
, Qnil
);
943 kset_last_prefix_arg (current_kboard
, Qnil
);
946 /* Avoid unquittable loop if data contains a circular list. */
947 old_level
= Vprint_level
;
948 old_length
= Vprint_length
;
949 XSETFASTINT (Vprint_level
, 10);
950 XSETFASTINT (Vprint_length
, 10);
951 cmd_error_internal (data
, macroerror
);
952 Vprint_level
= old_level
;
953 Vprint_length
= old_length
;
956 Vinhibit_quit
= Qnil
;
958 return make_number (0);
961 /* Take actions on handling an error. DATA is the data that describes
964 CONTEXT is a C-string containing ASCII characters only which
965 describes the context in which the error happened. If we need to
966 generalize CONTEXT to allow multibyte characters, make it a Lisp
970 cmd_error_internal (Lisp_Object data
, const char *context
)
972 /* The immediate context is not interesting for Quits,
973 since they are asynchronous. */
974 if (EQ (XCAR (data
), Qquit
))
975 Vsignaling_function
= Qnil
;
980 /* Use user's specified output function if any. */
981 if (!NILP (Vcommand_error_function
))
982 call3 (Vcommand_error_function
, data
,
983 context
? build_string (context
) : empty_unibyte_string
,
984 Vsignaling_function
);
986 Vsignaling_function
= Qnil
;
989 DEFUN ("command-error-default-function", Fcommand_error_default_function
,
990 Scommand_error_default_function
, 3, 3, 0,
991 doc
: /* Produce default output for unhandled error message.
992 Default value of `command-error-function'. */)
993 (Lisp_Object data
, Lisp_Object context
, Lisp_Object signal
)
995 struct frame
*sf
= SELECTED_FRAME ();
997 CHECK_STRING (context
);
999 /* If the window system or terminal frame hasn't been initialized
1000 yet, or we're not interactive, write the message to stderr and exit. */
1001 if (!sf
->glyphs_initialized_p
1002 /* The initial frame is a special non-displaying frame. It
1003 will be current in daemon mode when there are no frames
1004 to display, and in non-daemon mode before the real frame
1005 has finished initializing. If an error is thrown in the
1006 latter case while creating the frame, then the frame
1007 will never be displayed, so the safest thing to do is
1008 write to stderr and quit. In daemon mode, there are
1009 many other potential errors that do not prevent frames
1010 from being created, so continuing as normal is better in
1012 || (!IS_DAEMON
&& FRAME_INITIAL_P (sf
))
1015 print_error_message (data
, Qexternal_debugging_output
,
1016 SSDATA (context
), signal
);
1017 Fterpri (Qexternal_debugging_output
, Qnil
);
1018 Fkill_emacs (make_number (-1));
1022 clear_message (1, 0);
1024 message_log_maybe_newline ();
1027 print_error_message (data
, Qt
, SSDATA (context
), signal
);
1032 static Lisp_Object
command_loop_2 (Lisp_Object
);
1033 static Lisp_Object
top_level_1 (Lisp_Object
);
1035 /* Entry to editor-command-loop.
1036 This level has the catches for exiting/returning to editor command loop.
1037 It returns nil to exit recursive edit, t to abort it. */
1042 #ifdef HAVE_STACK_OVERFLOW_HANDLING
1043 /* At least on GNU/Linux, saving signal mask is important here. */
1044 if (sigsetjmp (return_to_command_loop
, 1) != 0)
1046 /* Comes here from handle_sigsegv (see sysdep.c) and
1047 stack_overflow_handler (see w32fns.c). */
1049 w32_reset_stack_overflow_guard ();
1052 Vinternal__top_level_message
= recover_top_level_message
;
1055 Vinternal__top_level_message
= regular_top_level_message
;
1056 #endif /* HAVE_STACK_OVERFLOW_HANDLING */
1057 if (command_loop_level
> 0 || minibuf_level
> 0)
1060 val
= internal_catch (Qexit
, command_loop_2
, Qnil
);
1061 executing_kbd_macro
= Qnil
;
1067 internal_catch (Qtop_level
, top_level_1
, Qnil
);
1068 internal_catch (Qtop_level
, command_loop_2
, Qnil
);
1069 executing_kbd_macro
= Qnil
;
1071 /* End of file in -batch run causes exit here. */
1077 /* Here we catch errors in execution of commands within the
1078 editing loop, and reenter the editing loop.
1079 When there is an error, cmd_error runs and returns a non-nil
1080 value to us. A value of nil means that command_loop_1 itself
1081 returned due to end of file (or end of kbd macro). */
1084 command_loop_2 (Lisp_Object ignore
)
1086 register Lisp_Object val
;
1089 val
= internal_condition_case (command_loop_1
, Qerror
, cmd_error
);
1090 while (!NILP (val
));
1098 return Feval (Vtop_level
, Qnil
);
1102 top_level_1 (Lisp_Object ignore
)
1104 /* On entry to the outer level, run the startup file. */
1105 if (!NILP (Vtop_level
))
1106 internal_condition_case (top_level_2
, Qerror
, cmd_error
);
1107 else if (!NILP (Vpurify_flag
))
1108 message1 ("Bare impure Emacs (standard Lisp code not loaded)");
1110 message1 ("Bare Emacs (standard Lisp code not loaded)");
1114 DEFUN ("top-level", Ftop_level
, Stop_level
, 0, 0, "",
1115 doc
: /* Exit all recursive editing levels.
1116 This also exits all active minibuffers. */
1117 attributes
: noreturn
)
1120 #ifdef HAVE_WINDOW_SYSTEM
1121 if (display_hourglass_p
)
1122 cancel_hourglass ();
1125 /* Unblock input if we enter with input blocked. This may happen if
1126 redisplay traps e.g. during tool-bar update with input blocked. */
1127 totally_unblock_input ();
1129 Fthrow (Qtop_level
, Qnil
);
1132 static _Noreturn
void
1133 user_error (const char *msg
)
1135 xsignal1 (Quser_error
, build_string (msg
));
1138 /* _Noreturn will be added to prototype by make-docfile. */
1139 DEFUN ("exit-recursive-edit", Fexit_recursive_edit
, Sexit_recursive_edit
, 0, 0, "",
1140 doc
: /* Exit from the innermost recursive edit or minibuffer. */
1141 attributes
: noreturn
)
1144 if (command_loop_level
> 0 || minibuf_level
> 0)
1145 Fthrow (Qexit
, Qnil
);
1147 user_error ("No recursive edit is in progress");
1150 /* _Noreturn will be added to prototype by make-docfile. */
1151 DEFUN ("abort-recursive-edit", Fabort_recursive_edit
, Sabort_recursive_edit
, 0, 0, "",
1152 doc
: /* Abort the command that requested this recursive edit or minibuffer input. */
1153 attributes
: noreturn
)
1156 if (command_loop_level
> 0 || minibuf_level
> 0)
1159 user_error ("No recursive edit is in progress");
1162 /* Restore mouse tracking enablement. See Ftrack_mouse for the only use
1163 of this function. */
1166 tracking_off (Lisp_Object old_value
)
1168 do_mouse_tracking
= old_value
;
1169 if (NILP (old_value
))
1171 /* Redisplay may have been preempted because there was input
1172 available, and it assumes it will be called again after the
1173 input has been processed. If the only input available was
1174 the sort that we have just disabled, then we need to call
1176 if (!readable_events (READABLE_EVENTS_DO_TIMERS_NOW
))
1178 redisplay_preserve_echo_area (6);
1179 get_input_pending (READABLE_EVENTS_DO_TIMERS_NOW
);
1184 DEFUN ("internal--track-mouse", Ftrack_mouse
, Strack_mouse
, 1, 1, 0,
1185 doc
: /* Call BODYFUN with mouse movement events enabled. */)
1186 (Lisp_Object bodyfun
)
1188 ptrdiff_t count
= SPECPDL_INDEX ();
1191 record_unwind_protect (tracking_off
, do_mouse_tracking
);
1193 do_mouse_tracking
= Qt
;
1195 val
= call0 (bodyfun
);
1196 return unbind_to (count
, val
);
1199 /* If mouse has moved on some frame, return one of those frames.
1203 If ignore_mouse_drag_p is non-zero, ignore (implicit) mouse movement
1204 after resizing the tool-bar window. */
1206 bool ignore_mouse_drag_p
;
1208 static struct frame
*
1209 some_mouse_moved (void)
1211 Lisp_Object tail
, frame
;
1213 if (ignore_mouse_drag_p
)
1215 /* ignore_mouse_drag_p = 0; */
1219 FOR_EACH_FRAME (tail
, frame
)
1221 if (XFRAME (frame
)->mouse_moved
)
1222 return XFRAME (frame
);
1229 /* This is the actual command reading loop,
1230 sans error-handling encapsulation. */
1232 static int read_key_sequence (Lisp_Object
*, int, Lisp_Object
,
1233 bool, bool, bool, bool);
1234 static void adjust_point_for_property (ptrdiff_t, bool);
1237 command_loop_1 (void)
1239 EMACS_INT prev_modiff
= 0;
1240 struct buffer
*prev_buffer
= NULL
;
1241 bool already_adjusted
= 0;
1243 kset_prefix_arg (current_kboard
, Qnil
);
1244 kset_last_prefix_arg (current_kboard
, Qnil
);
1245 Vdeactivate_mark
= Qnil
;
1246 waiting_for_input
= false;
1249 this_command_key_count
= 0;
1250 this_single_command_key_start
= 0;
1252 if (NILP (Vmemory_full
))
1254 /* Make sure this hook runs after commands that get errors and
1255 throw to top level. */
1256 /* Note that the value cell will never directly contain nil
1257 if the symbol is a local variable. */
1258 if (!NILP (Vpost_command_hook
) && !NILP (Vrun_hooks
))
1259 safe_run_hooks (Qpost_command_hook
);
1261 /* If displaying a message, resize the echo area window to fit
1262 that message's size exactly. */
1263 if (!NILP (echo_area_buffer
[0]))
1264 resize_echo_area_exactly ();
1266 /* If there are warnings waiting, process them. */
1267 if (!NILP (Vdelayed_warnings_list
))
1268 safe_run_hooks (Qdelayed_warnings_hook
);
1270 if (!NILP (Vdeferred_action_list
))
1271 safe_run_hooks (Qdeferred_action_function
);
1274 /* Do this after running Vpost_command_hook, for consistency. */
1275 kset_last_command (current_kboard
, Vthis_command
);
1276 kset_real_last_command (current_kboard
, Vreal_this_command
);
1277 if (!CONSP (last_command_event
))
1278 kset_last_repeatable_command (current_kboard
, Vreal_this_command
);
1283 Lisp_Object keybuf
[30];
1286 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1289 /* Make sure the current window's buffer is selected. */
1290 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->contents
));
1292 /* Display any malloc warning that just came out. Use while because
1293 displaying one warning can cause another. */
1295 while (pending_malloc_warning
)
1296 display_malloc_warning ();
1298 Vdeactivate_mark
= Qnil
;
1300 /* Don't ignore mouse movements for more than a single command
1301 loop. (This flag is set in xdisp.c whenever the tool bar is
1302 resized, because the resize moves text up or down, and would
1303 generate false mouse drag events if we don't ignore them.) */
1304 ignore_mouse_drag_p
= 0;
1306 /* If minibuffer on and echo area in use,
1307 wait a short time and redraw minibuffer. */
1310 && !NILP (echo_area_buffer
[0])
1311 && EQ (minibuf_window
, echo_area_window
)
1312 && NUMBERP (Vminibuffer_message_timeout
))
1314 /* Bind inhibit-quit to t so that C-g gets read in
1315 rather than quitting back to the minibuffer. */
1316 ptrdiff_t count
= SPECPDL_INDEX ();
1317 specbind (Qinhibit_quit
, Qt
);
1319 sit_for (Vminibuffer_message_timeout
, 0, 2);
1321 /* Clear the echo area. */
1323 safe_run_hooks (Qecho_area_clear_hook
);
1325 unbind_to (count
, Qnil
);
1327 /* If a C-g came in before, treat it as input now. */
1328 if (!NILP (Vquit_flag
))
1331 Vunread_command_events
= list1 (make_number (quit_char
));
1335 /* If it has changed current-menubar from previous value,
1336 really recompute the menubar from the value. */
1337 if (! NILP (Vlucid_menu_bar_dirty_flag
)
1338 && !NILP (Ffboundp (Qrecompute_lucid_menubar
)))
1339 call0 (Qrecompute_lucid_menubar
);
1341 Vthis_command
= Qnil
;
1342 Vreal_this_command
= Qnil
;
1343 Vthis_original_command
= Qnil
;
1344 Vthis_command_keys_shift_translated
= Qnil
;
1346 /* Read next key sequence; i gets its length. */
1347 i
= read_key_sequence (keybuf
, ARRAYELTS (keybuf
),
1350 /* A filter may have run while we were reading the input. */
1351 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1353 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->contents
));
1357 /* Now we have read a key sequence of length I,
1358 or else I is 0 and we found end of file. */
1360 if (i
== 0) /* End of file -- happens only in */
1361 return Qnil
; /* a kbd macro, at the end. */
1362 /* -1 means read_key_sequence got a menu that was rejected.
1363 Just loop around and read another command. */
1367 this_command_key_count
= 0;
1368 this_single_command_key_start
= 0;
1372 last_command_event
= keybuf
[i
- 1];
1374 /* If the previous command tried to force a specific window-start,
1375 forget about that, in case this command moves point far away
1376 from that position. But also throw away beg_unchanged and
1377 end_unchanged information in that case, so that redisplay will
1378 update the whole window properly. */
1379 if (XWINDOW (selected_window
)->force_start
)
1382 XWINDOW (selected_window
)->force_start
= 0;
1383 b
= XBUFFER (XWINDOW (selected_window
)->contents
);
1384 BUF_BEG_UNCHANGED (b
) = BUF_END_UNCHANGED (b
) = 0;
1387 cmd
= read_key_sequence_cmd
;
1388 if (!NILP (Vexecuting_kbd_macro
))
1390 if (!NILP (Vquit_flag
))
1392 Vexecuting_kbd_macro
= Qt
;
1393 QUIT
; /* Make some noise. */
1394 /* Will return since macro now empty. */
1398 /* Do redisplay processing after this command except in special
1399 cases identified below. */
1400 prev_buffer
= current_buffer
;
1401 prev_modiff
= MODIFF
;
1402 last_point_position
= PT
;
1404 /* By default, we adjust point to a boundary of a region that
1405 has such a property that should be treated intangible
1406 (e.g. composition, display). But, some commands will set
1407 this variable differently. */
1408 Vdisable_point_adjustment
= Qnil
;
1410 /* Process filters and timers may have messed with deactivate-mark.
1411 reset it before we execute the command. */
1412 Vdeactivate_mark
= Qnil
;
1414 /* Remap command through active keymaps. */
1415 Vthis_original_command
= cmd
;
1416 if (!NILP (read_key_sequence_remapped
))
1417 cmd
= read_key_sequence_remapped
;
1419 /* Execute the command. */
1422 total_keys
+= total_keys
< NUM_RECENT_KEYS
;
1423 ASET (recent_keys
, recent_keys_index
,
1425 if (++recent_keys_index
>= NUM_RECENT_KEYS
)
1426 recent_keys_index
= 0;
1428 Vthis_command
= cmd
;
1429 Vreal_this_command
= cmd
;
1430 safe_run_hooks (Qpre_command_hook
);
1432 already_adjusted
= 0;
1434 if (NILP (Vthis_command
))
1435 /* nil means key is undefined. */
1439 /* Here for a command that isn't executed directly. */
1441 #ifdef HAVE_WINDOW_SYSTEM
1442 ptrdiff_t scount
= SPECPDL_INDEX ();
1444 if (display_hourglass_p
1445 && NILP (Vexecuting_kbd_macro
))
1447 record_unwind_protect_void (cancel_hourglass
);
1452 /* Ensure that we have added appropriate undo-boundaries as a
1453 result of changes from the last command. */
1454 call0 (Qundo_auto__add_boundary
);
1456 /* Record point and buffer, so we can put point into the undo
1457 information if necessary. */
1458 point_before_last_command_or_undo
= PT
;
1459 buffer_before_last_command_or_undo
= current_buffer
;
1461 call1 (Qcommand_execute
, Vthis_command
);
1463 #ifdef HAVE_WINDOW_SYSTEM
1464 /* Do not check display_hourglass_p here, because
1465 `command-execute' could change it, but we should cancel
1466 hourglass cursor anyway.
1467 But don't cancel the hourglass within a macro
1468 just because a command in the macro finishes. */
1469 if (NILP (Vexecuting_kbd_macro
))
1470 unbind_to (scount
, Qnil
);
1473 kset_last_prefix_arg (current_kboard
, Vcurrent_prefix_arg
);
1475 safe_run_hooks (Qpost_command_hook
);
1477 /* If displaying a message, resize the echo area window to fit
1478 that message's size exactly. */
1479 if (!NILP (echo_area_buffer
[0]))
1480 resize_echo_area_exactly ();
1482 /* If there are warnings waiting, process them. */
1483 if (!NILP (Vdelayed_warnings_list
))
1484 safe_run_hooks (Qdelayed_warnings_hook
);
1486 safe_run_hooks (Qdeferred_action_function
);
1488 kset_last_command (current_kboard
, Vthis_command
);
1489 kset_real_last_command (current_kboard
, Vreal_this_command
);
1490 if (!CONSP (last_command_event
))
1491 kset_last_repeatable_command (current_kboard
, Vreal_this_command
);
1493 this_command_key_count
= 0;
1494 this_single_command_key_start
= 0;
1496 if (current_kboard
->immediate_echo
1497 && !NILP (call0 (Qinternal_echo_keystrokes_prefix
)))
1499 current_kboard
->immediate_echo
= false;
1500 /* Refresh the echo message. */
1506 if (!NILP (BVAR (current_buffer
, mark_active
))
1507 && !NILP (Vrun_hooks
))
1509 /* In Emacs 22, setting transient-mark-mode to `only' was a
1510 way of turning it on for just one command. This usage is
1511 obsolete, but support it anyway. */
1512 if (EQ (Vtransient_mark_mode
, Qidentity
))
1513 Vtransient_mark_mode
= Qnil
;
1514 else if (EQ (Vtransient_mark_mode
, Qonly
))
1515 Vtransient_mark_mode
= Qidentity
;
1517 if (!NILP (Vdeactivate_mark
))
1518 /* If `select-active-regions' is non-nil, this call to
1519 `deactivate-mark' also sets the PRIMARY selection. */
1520 call0 (Qdeactivate_mark
);
1523 /* Even if not deactivating the mark, set PRIMARY if
1524 `select-active-regions' is non-nil. */
1525 if (!NILP (Fwindow_system (Qnil
))
1526 /* Even if mark_active is non-nil, the actual buffer
1527 marker may not have been set yet (Bug#7044). */
1528 && XMARKER (BVAR (current_buffer
, mark
))->buffer
1529 && (EQ (Vselect_active_regions
, Qonly
)
1530 ? EQ (CAR_SAFE (Vtransient_mark_mode
), Qonly
)
1531 : (!NILP (Vselect_active_regions
)
1532 && !NILP (Vtransient_mark_mode
)))
1533 && NILP (Fmemq (Vthis_command
,
1534 Vselection_inhibit_update_commands
)))
1537 = call1 (Fsymbol_value (Qregion_extract_function
), Qnil
);
1538 if (XINT (Flength (txt
)) > 0)
1539 /* Don't set empty selections. */
1540 call2 (Qgui_set_selection
, QPRIMARY
, txt
);
1543 if (current_buffer
!= prev_buffer
|| MODIFF
!= prev_modiff
)
1544 run_hook (intern ("activate-mark-hook"));
1547 Vsaved_region_selection
= Qnil
;
1552 if (current_buffer
== prev_buffer
1553 && XBUFFER (XWINDOW (selected_window
)->contents
) == current_buffer
1554 && last_point_position
!= PT
1555 && NILP (Vdisable_point_adjustment
)
1556 && NILP (Vglobal_disable_point_adjustment
))
1558 if (last_point_position
> BEGV
1559 && last_point_position
< ZV
1560 && (composition_adjust_point (last_point_position
,
1561 last_point_position
)
1562 != last_point_position
))
1563 /* The last point was temporarily set within a grapheme
1564 cluster to prevent automatic composition. To recover
1565 the automatic composition, we must update the
1567 windows_or_buffers_changed
= 21;
1568 if (!already_adjusted
)
1569 adjust_point_for_property (last_point_position
,
1570 MODIFF
!= prev_modiff
);
1573 /* Install chars successfully executed in kbd macro. */
1575 if (!NILP (KVAR (current_kboard
, defining_kbd_macro
))
1576 && NILP (KVAR (current_kboard
, Vprefix_arg
)))
1577 finalize_kbd_macro_chars ();
1582 read_menu_command (void)
1584 Lisp_Object keybuf
[30];
1585 ptrdiff_t count
= SPECPDL_INDEX ();
1588 /* We don't want to echo the keystrokes while navigating the
1590 specbind (Qecho_keystrokes
, make_number (0));
1592 i
= read_key_sequence (keybuf
, ARRAYELTS (keybuf
),
1595 unbind_to (count
, Qnil
);
1597 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1599 if (i
== 0 || i
== -1)
1602 return read_key_sequence_cmd
;
1605 /* Adjust point to a boundary of a region that has such a property
1606 that should be treated intangible. For the moment, we check
1607 `composition', `display' and `invisible' properties.
1608 LAST_PT is the last position of point. */
1611 adjust_point_for_property (ptrdiff_t last_pt
, bool modified
)
1614 Lisp_Object val
, overlay
, tmp
;
1615 /* When called after buffer modification, we should temporarily
1616 suppress the point adjustment for automatic composition so that a
1617 user can keep inserting another character at point or keep
1618 deleting characters around point. */
1619 bool check_composition
= ! modified
;
1620 bool check_display
= true, check_invisible
= true;
1621 ptrdiff_t orig_pt
= PT
;
1623 eassert (XBUFFER (XWINDOW (selected_window
)->contents
) == current_buffer
);
1625 /* FIXME: cycling is probably not necessary because these properties
1626 can't be usefully combined anyway. */
1627 while (check_composition
|| check_display
|| check_invisible
)
1629 /* FIXME: check `intangible'. */
1630 if (check_composition
1631 && PT
> BEGV
&& PT
< ZV
1632 && (beg
= composition_adjust_point (last_pt
, PT
)) != PT
)
1635 check_display
= check_invisible
= true;
1637 check_composition
= false;
1639 && PT
> BEGV
&& PT
< ZV
1640 && !NILP (val
= get_char_property_and_overlay
1641 (make_number (PT
), Qdisplay
, selected_window
,
1643 && display_prop_intangible_p (val
, overlay
, PT
, PT_BYTE
)
1644 && (!OVERLAYP (overlay
)
1645 ? get_property_and_range (PT
, Qdisplay
, &val
, &beg
, &end
, Qnil
)
1646 : (beg
= OVERLAY_POSITION (OVERLAY_START (overlay
)),
1647 end
= OVERLAY_POSITION (OVERLAY_END (overlay
))))
1648 && (beg
< PT
/* && end > PT <- It's always the case. */
1649 || (beg
<= PT
&& STRINGP (val
) && SCHARS (val
) == 0)))
1652 SET_PT (PT
< last_pt
1653 ? (STRINGP (val
) && SCHARS (val
) == 0
1654 ? max (beg
- 1, BEGV
)
1657 check_composition
= check_invisible
= true;
1659 check_display
= false;
1660 if (check_invisible
&& PT
> BEGV
&& PT
< ZV
)
1663 bool ellipsis
= false;
1666 /* Find boundaries `beg' and `end' of the invisible area, if any. */
1669 /* FIXME: We should stop if we find a spot between
1670 two runs of `invisible' where inserted text would
1671 be visible. This is important when we have two
1672 invisible boundaries that enclose an area: if the
1673 area is empty, we need this test in order to make
1674 it possible to place point in the middle rather
1675 than skip both boundaries. However, this code
1676 also stops anywhere in a non-sticky text-property,
1677 which breaks (e.g.) Org mode. */
1678 && (val
= Fget_pos_property (make_number (end
),
1680 TEXT_PROP_MEANS_INVISIBLE (val
))
1682 && !NILP (val
= get_char_property_and_overlay
1683 (make_number (end
), Qinvisible
, Qnil
, &overlay
))
1684 && (inv
= TEXT_PROP_MEANS_INVISIBLE (val
)))
1686 ellipsis
= ellipsis
|| inv
> 1
1687 || (OVERLAYP (overlay
)
1688 && (!NILP (Foverlay_get (overlay
, Qafter_string
))
1689 || !NILP (Foverlay_get (overlay
, Qbefore_string
))));
1690 tmp
= Fnext_single_char_property_change
1691 (make_number (end
), Qinvisible
, Qnil
, Qnil
);
1692 end
= NATNUMP (tmp
) ? XFASTINT (tmp
) : ZV
;
1696 && (val
= Fget_pos_property (make_number (beg
),
1698 TEXT_PROP_MEANS_INVISIBLE (val
))
1700 && !NILP (val
= get_char_property_and_overlay
1701 (make_number (beg
- 1), Qinvisible
, Qnil
, &overlay
))
1702 && (inv
= TEXT_PROP_MEANS_INVISIBLE (val
)))
1704 ellipsis
= ellipsis
|| inv
> 1
1705 || (OVERLAYP (overlay
)
1706 && (!NILP (Foverlay_get (overlay
, Qafter_string
))
1707 || !NILP (Foverlay_get (overlay
, Qbefore_string
))));
1708 tmp
= Fprevious_single_char_property_change
1709 (make_number (beg
), Qinvisible
, Qnil
, Qnil
);
1710 beg
= NATNUMP (tmp
) ? XFASTINT (tmp
) : BEGV
;
1713 /* Move away from the inside area. */
1714 if (beg
< PT
&& end
> PT
)
1716 SET_PT ((orig_pt
== PT
&& (last_pt
< beg
|| last_pt
> end
))
1717 /* We haven't moved yet (so we don't need to fear
1718 infinite-looping) and we were outside the range
1719 before (so either end of the range still corresponds
1720 to a move in the right direction): pretend we moved
1721 less than we actually did, so that we still have
1722 more freedom below in choosing which end of the range
1724 ? (orig_pt
= -1, PT
< last_pt
? end
: beg
)
1725 /* We either have moved already or the last point
1726 was already in the range: we don't get to choose
1727 which end of the range we have to go to. */
1728 : (PT
< last_pt
? beg
: end
));
1729 check_composition
= check_display
= true;
1731 #if 0 /* This assertion isn't correct, because SET_PT may end up setting
1732 the point to something other than its argument, due to
1733 point-motion hooks, intangibility, etc. */
1734 eassert (PT
== beg
|| PT
== end
);
1737 /* Pretend the area doesn't exist if the buffer is not
1739 if (!modified
&& !ellipsis
&& beg
< end
)
1741 if (last_pt
== beg
&& PT
== end
&& end
< ZV
)
1742 (check_composition
= check_display
= true, SET_PT (end
+ 1));
1743 else if (last_pt
== end
&& PT
== beg
&& beg
> BEGV
)
1744 (check_composition
= check_display
= true, SET_PT (beg
- 1));
1745 else if (PT
== ((PT
< last_pt
) ? beg
: end
))
1746 /* We've already moved as far as we can. Trying to go
1747 to the other end would mean moving backwards and thus
1748 could lead to an infinite loop. */
1750 else if (val
= Fget_pos_property (make_number (PT
),
1752 TEXT_PROP_MEANS_INVISIBLE (val
)
1753 && (val
= (Fget_pos_property
1754 (make_number (PT
== beg
? end
: beg
),
1756 !TEXT_PROP_MEANS_INVISIBLE (val
)))
1757 (check_composition
= check_display
= true,
1758 SET_PT (PT
== beg
? end
: beg
));
1761 check_invisible
= false;
1765 /* Subroutine for safe_run_hooks: run the hook, which is ARGS[1]. */
1768 safe_run_hooks_1 (ptrdiff_t nargs
, Lisp_Object
*args
)
1770 eassert (nargs
== 2);
1771 return call0 (args
[1]);
1774 /* Subroutine for safe_run_hooks: handle an error by clearing out the function
1778 safe_run_hooks_error (Lisp_Object error
, ptrdiff_t nargs
, Lisp_Object
*args
)
1780 eassert (nargs
== 2);
1781 AUTO_STRING (format
, "Error in %s (%S): %S");
1782 Lisp_Object hook
= args
[0];
1783 Lisp_Object fun
= args
[1];
1784 CALLN (Fmessage
, format
, hook
, fun
, error
);
1790 Lisp_Object newval
= Qnil
;
1791 for (val
= find_symbol_value (hook
); CONSP (val
); val
= XCDR (val
))
1792 if (EQ (fun
, XCAR (val
)))
1795 newval
= Fcons (XCAR (val
), newval
);
1797 return Fset (hook
, Fnreverse (newval
));
1798 /* Not found in the local part of the hook. Let's look at the global
1801 for (val
= (NILP (Fdefault_boundp (hook
)) ? Qnil
1802 : Fdefault_value (hook
));
1803 CONSP (val
); val
= XCDR (val
))
1804 if (EQ (fun
, XCAR (val
)))
1807 newval
= Fcons (XCAR (val
), newval
);
1809 return Fset_default (hook
, Fnreverse (newval
));
1815 safe_run_hook_funcall (ptrdiff_t nargs
, Lisp_Object
*args
)
1817 eassert (nargs
== 2);
1818 /* Yes, run_hook_with_args works with args in the other order. */
1819 internal_condition_case_n (safe_run_hooks_1
,
1820 2, ((Lisp_Object
[]) {args
[1], args
[0]}),
1821 Qt
, safe_run_hooks_error
);
1825 /* If we get an error while running the hook, cause the hook variable
1826 to be nil. Also inhibit quits, so that C-g won't cause the hook
1827 to mysteriously evaporate. */
1830 safe_run_hooks (Lisp_Object hook
)
1832 ptrdiff_t count
= SPECPDL_INDEX ();
1834 specbind (Qinhibit_quit
, Qt
);
1835 run_hook_with_args (2, ((Lisp_Object
[]) {hook
, hook
}), safe_run_hook_funcall
);
1836 unbind_to (count
, Qnil
);
1840 /* Nonzero means polling for input is temporarily suppressed. */
1842 int poll_suppress_count
;
1845 #ifdef POLL_FOR_INPUT
1847 /* Asynchronous timer for polling. */
1849 static struct atimer
*poll_timer
;
1851 /* Poll for input, so that we catch a C-g if it comes in. */
1853 poll_for_input_1 (void)
1855 if (! input_blocked_p ()
1856 && !waiting_for_input
)
1860 /* Timer callback function for poll_timer. TIMER is equal to
1864 poll_for_input (struct atimer
*timer
)
1866 if (poll_suppress_count
== 0)
1867 pending_signals
= true;
1870 #endif /* POLL_FOR_INPUT */
1872 /* Begin signals to poll for input, if they are appropriate.
1873 This function is called unconditionally from various places. */
1876 start_polling (void)
1878 #ifdef POLL_FOR_INPUT
1879 /* XXX This condition was (read_socket_hook && !interrupt_input),
1880 but read_socket_hook is not global anymore. Let's pretend that
1882 if (!interrupt_input
)
1884 /* Turn alarm handling on unconditionally. It might have
1885 been turned off in process.c. */
1886 turn_on_atimers (1);
1888 /* If poll timer doesn't exist, or we need one with
1889 a different interval, start a new one. */
1890 if (poll_timer
== NULL
1891 || poll_timer
->interval
.tv_sec
!= polling_period
)
1893 time_t period
= max (1, min (polling_period
, TYPE_MAXIMUM (time_t)));
1894 struct timespec interval
= make_timespec (period
, 0);
1897 cancel_atimer (poll_timer
);
1899 poll_timer
= start_atimer (ATIMER_CONTINUOUS
, interval
,
1900 poll_for_input
, NULL
);
1903 /* Let the timer's callback function poll for input
1904 if this becomes zero. */
1905 --poll_suppress_count
;
1910 /* True if we are using polling to handle input asynchronously. */
1913 input_polling_used (void)
1915 #ifdef POLL_FOR_INPUT
1916 /* XXX This condition was (read_socket_hook && !interrupt_input),
1917 but read_socket_hook is not global anymore. Let's pretend that
1919 return !interrupt_input
;
1925 /* Turn off polling. */
1930 #ifdef POLL_FOR_INPUT
1931 /* XXX This condition was (read_socket_hook && !interrupt_input),
1932 but read_socket_hook is not global anymore. Let's pretend that
1934 if (!interrupt_input
)
1935 ++poll_suppress_count
;
1939 /* Set the value of poll_suppress_count to COUNT
1940 and start or stop polling accordingly. */
1943 set_poll_suppress_count (int count
)
1945 #ifdef POLL_FOR_INPUT
1946 if (count
== 0 && poll_suppress_count
!= 0)
1948 poll_suppress_count
= 1;
1951 else if (count
!= 0 && poll_suppress_count
== 0)
1955 poll_suppress_count
= count
;
1959 /* Bind polling_period to a value at least N.
1960 But don't decrease it. */
1963 bind_polling_period (int n
)
1965 #ifdef POLL_FOR_INPUT
1966 EMACS_INT
new = polling_period
;
1971 stop_other_atimers (poll_timer
);
1973 specbind (Qpolling_period
, make_number (new));
1974 /* Start a new alarm with the new period. */
1979 /* Apply the control modifier to CHARACTER. */
1982 make_ctrl_char (int c
)
1984 /* Save the upper bits here. */
1985 int upper
= c
& ~0177;
1987 if (! ASCII_CHAR_P (c
))
1988 return c
|= ctrl_modifier
;
1992 /* Everything in the columns containing the upper-case letters
1993 denotes a control character. */
1994 if (c
>= 0100 && c
< 0140)
1998 /* Set the shift modifier for a control char
1999 made from a shifted letter. But only for letters! */
2000 if (oc
>= 'A' && oc
<= 'Z')
2001 c
|= shift_modifier
;
2004 /* The lower-case letters denote control characters too. */
2005 else if (c
>= 'a' && c
<= 'z')
2008 /* Include the bits for control and shift
2009 only if the basic ASCII code can't indicate them. */
2013 /* Replace the high bits. */
2014 c
|= (upper
& ~ctrl_modifier
);
2019 /* Display the help-echo property of the character after the mouse pointer.
2020 Either show it in the echo area, or call show-help-function to display
2021 it by other means (maybe in a tooltip).
2023 If HELP is nil, that means clear the previous help echo.
2025 If HELP is a string, display that string. If HELP is a function,
2026 call it with OBJECT and POS as arguments; the function should
2027 return a help string or nil for none. For all other types of HELP,
2028 evaluate it to obtain a string.
2030 WINDOW is the window in which the help was generated, if any.
2031 It is nil if not in a window.
2033 If OBJECT is a buffer, POS is the position in the buffer where the
2034 `help-echo' text property was found.
2036 If OBJECT is an overlay, that overlay has a `help-echo' property,
2037 and POS is the position in the overlay's buffer under the mouse.
2039 If OBJECT is a string (an overlay string or a string displayed with
2040 the `display' property). POS is the position in that string under
2043 Note: this function may only be called with HELP nil or a string
2044 from X code running asynchronously. */
2047 show_help_echo (Lisp_Object help
, Lisp_Object window
, Lisp_Object object
,
2050 if (!NILP (help
) && !STRINGP (help
))
2052 if (FUNCTIONP (help
))
2053 help
= safe_call (4, help
, window
, object
, pos
);
2055 help
= safe_eval (help
);
2057 if (!STRINGP (help
))
2061 if (!noninteractive
&& STRINGP (help
))
2063 /* The mouse-fixup-help-message Lisp function can call
2064 mouse_position_hook, which resets the mouse_moved flags.
2065 This causes trouble if we are trying to read a mouse motion
2066 event (i.e., if we are inside a `track-mouse' form), so we
2067 restore the mouse_moved flag. */
2068 struct frame
*f
= NILP (do_mouse_tracking
) ? NULL
: some_mouse_moved ();
2069 help
= call1 (Qmouse_fixup_help_message
, help
);
2071 f
->mouse_moved
= true;
2074 if (STRINGP (help
) || NILP (help
))
2076 if (!NILP (Vshow_help_function
))
2077 call1 (Vshow_help_function
, Fsubstitute_command_keys (help
));
2078 help_echo_showing_p
= STRINGP (help
);
2084 /* Input of single characters from keyboard. */
2086 static Lisp_Object
kbd_buffer_get_event (KBOARD
**kbp
, bool *used_mouse_menu
,
2087 struct timespec
*end_time
);
2088 static void record_char (Lisp_Object c
);
2090 static Lisp_Object help_form_saved_window_configs
;
2092 read_char_help_form_unwind (void)
2094 Lisp_Object window_config
= XCAR (help_form_saved_window_configs
);
2095 help_form_saved_window_configs
= XCDR (help_form_saved_window_configs
);
2096 if (!NILP (window_config
))
2097 Fset_window_configuration (window_config
);
2100 #define STOP_POLLING \
2101 do { if (! polling_stopped_here) stop_polling (); \
2102 polling_stopped_here = true; } while (0)
2104 #define RESUME_POLLING \
2105 do { if (polling_stopped_here) start_polling (); \
2106 polling_stopped_here = false; } while (0)
2109 read_event_from_main_queue (struct timespec
*end_time
,
2110 sys_jmp_buf local_getcjmp
,
2111 bool *used_mouse_menu
)
2113 Lisp_Object c
= Qnil
;
2114 sys_jmp_buf save_jump
;
2115 KBOARD
*kb
IF_LINT (= NULL
);
2119 /* Read from the main queue, and if that gives us something we can't use yet,
2120 we put it on the appropriate side queue and try again. */
2122 if (end_time
&& timespec_cmp (*end_time
, current_timespec ()) <= 0)
2125 /* Actually read a character, waiting if necessary. */
2126 save_getcjmp (save_jump
);
2127 restore_getcjmp (local_getcjmp
);
2129 timer_start_idle ();
2130 c
= kbd_buffer_get_event (&kb
, used_mouse_menu
, end_time
);
2131 restore_getcjmp (save_jump
);
2133 if (! NILP (c
) && (kb
!= current_kboard
))
2135 Lisp_Object last
= KVAR (kb
, kbd_queue
);
2138 while (CONSP (XCDR (last
)))
2140 if (!NILP (XCDR (last
)))
2144 kset_kbd_queue (kb
, list1 (c
));
2146 XSETCDR (last
, list1 (c
));
2147 kb
->kbd_queue_has_data
= true;
2151 current_kboard
= kb
;
2152 return make_number (-2);
2155 /* Terminate Emacs in batch mode if at eof. */
2156 if (noninteractive
&& INTEGERP (c
) && XINT (c
) < 0)
2157 Fkill_emacs (make_number (1));
2161 /* Add in any extra modifiers, where appropriate. */
2162 if ((extra_keyboard_modifiers
& CHAR_CTL
)
2163 || ((extra_keyboard_modifiers
& 0177) < ' '
2164 && (extra_keyboard_modifiers
& 0177) != 0))
2165 XSETINT (c
, make_ctrl_char (XINT (c
)));
2167 /* Transfer any other modifier bits directly from
2168 extra_keyboard_modifiers to c. Ignore the actual character code
2169 in the low 16 bits of extra_keyboard_modifiers. */
2170 XSETINT (c
, XINT (c
) | (extra_keyboard_modifiers
& ~0xff7f & ~CHAR_CTL
));
2178 /* Like `read_event_from_main_queue' but applies keyboard-coding-system
2181 read_decoded_event_from_main_queue (struct timespec
*end_time
,
2182 sys_jmp_buf local_getcjmp
,
2183 Lisp_Object prev_event
,
2184 bool *used_mouse_menu
)
2186 #define MAX_ENCODED_BYTES 16
2188 Lisp_Object events
[MAX_ENCODED_BYTES
];
2194 = read_event_from_main_queue (end_time
, local_getcjmp
,
2197 /* w32_console already returns decoded events. It either reads
2198 Unicode characters from the Windows keyboard input, or
2199 converts characters encoded in the current codepage into
2200 Unicode. See w32inevt.c:key_event, near its end. */
2203 struct frame
*frame
= XFRAME (selected_frame
);
2204 struct terminal
*terminal
= frame
->terminal
;
2205 if (!((FRAME_TERMCAP_P (frame
) || FRAME_MSDOS_P (frame
))
2206 /* Don't apply decoding if we're just reading a raw event
2207 (e.g. reading bytes sent by the xterm to specify the position
2208 of a mouse click). */
2209 && (!EQ (prev_event
, Qt
))
2210 && (TERMINAL_KEYBOARD_CODING (terminal
)->common_flags
2211 & CODING_REQUIRE_DECODING_MASK
)))
2212 return nextevt
; /* No decoding needed. */
2215 int meta_key
= terminal
->display_info
.tty
->meta_key
;
2216 eassert (n
< MAX_ENCODED_BYTES
);
2217 events
[n
++] = nextevt
;
2218 if (NATNUMP (nextevt
)
2219 && XINT (nextevt
) < (meta_key
== 1 ? 0x80 : 0x100))
2220 { /* An encoded byte sequence, let's try to decode it. */
2221 struct coding_system
*coding
2222 = TERMINAL_KEYBOARD_CODING (terminal
);
2224 if (raw_text_coding_system_p (coding
))
2228 for (i
= 0; i
< n
; i
++)
2229 events
[i
] = make_number (XINT (events
[i
]) & ~0x80);
2233 unsigned char src
[MAX_ENCODED_BYTES
];
2234 unsigned char dest
[MAX_ENCODED_BYTES
* MAX_MULTIBYTE_LENGTH
];
2236 for (i
= 0; i
< n
; i
++)
2237 src
[i
] = XINT (events
[i
]);
2239 for (i
= 0; i
< n
; i
++)
2241 coding
->destination
= dest
;
2242 coding
->dst_bytes
= sizeof dest
;
2243 decode_coding_c_string (coding
, src
, n
, Qnil
);
2244 eassert (coding
->produced_char
<= n
);
2245 if (coding
->produced_char
== 0)
2246 { /* The encoded sequence is incomplete. */
2247 if (n
< MAX_ENCODED_BYTES
) /* Avoid buffer overflow. */
2248 continue; /* Read on! */
2252 const unsigned char *p
= coding
->destination
;
2253 eassert (coding
->carryover_bytes
== 0);
2255 while (n
< coding
->produced_char
)
2256 events
[n
++] = make_number (STRING_CHAR_ADVANCE (p
));
2260 /* Now `events' should hold decoded events.
2261 Normally, n should be equal to 1, but better not rely on it.
2262 We can only return one event here, so return the first we
2263 had and keep the others (if any) for later. */
2265 Vunread_command_events
2266 = Fcons (events
[--n
], Vunread_command_events
);
2274 echo_keystrokes_p (void)
2276 return (FLOATP (Vecho_keystrokes
) ? XFLOAT_DATA (Vecho_keystrokes
) > 0.0
2277 : INTEGERP (Vecho_keystrokes
) ? XINT (Vecho_keystrokes
) > 0 : false);
2280 /* Read a character from the keyboard; call the redisplay if needed. */
2281 /* commandflag 0 means do not autosave, but do redisplay.
2282 -1 means do not redisplay, but do autosave.
2283 -2 means do neither.
2286 The argument MAP is a keymap for menu prompting.
2288 PREV_EVENT is the previous input event, or nil if we are reading
2289 the first event of a key sequence (or not reading a key sequence).
2290 If PREV_EVENT is t, that is a "magic" value that says
2291 not to run input methods, but in other respects to act as if
2292 not reading a key sequence.
2294 If USED_MOUSE_MENU is non-null, then set *USED_MOUSE_MENU to true
2295 if we used a mouse menu to read the input, or false otherwise. If
2296 USED_MOUSE_MENU is null, don't dereference it.
2298 Value is -2 when we find input on another keyboard. A second call
2299 to read_char will read it.
2301 If END_TIME is non-null, it is a pointer to a struct timespec
2302 specifying the maximum time to wait until. If no input arrives by
2303 that time, stop waiting and return nil.
2305 Value is t if we showed a menu and the user rejected it. */
2308 read_char (int commandflag
, Lisp_Object map
,
2309 Lisp_Object prev_event
,
2310 bool *used_mouse_menu
, struct timespec
*end_time
)
2314 sys_jmp_buf local_getcjmp
;
2315 sys_jmp_buf save_jump
;
2316 Lisp_Object tem
, save
;
2317 volatile Lisp_Object previous_echo_area_message
;
2318 volatile Lisp_Object also_record
;
2319 volatile bool reread
, recorded
;
2320 bool volatile polling_stopped_here
= false;
2321 struct kboard
*orig_kboard
= current_kboard
;
2326 previous_echo_area_message
= Qnil
;
2332 if (CONSP (Vunread_post_input_method_events
))
2334 c
= XCAR (Vunread_post_input_method_events
);
2335 Vunread_post_input_method_events
2336 = XCDR (Vunread_post_input_method_events
);
2338 /* Undo what read_char_x_menu_prompt did when it unread
2339 additional keys returned by Fx_popup_menu. */
2341 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2352 if (CONSP (Vunread_command_events
))
2354 bool was_disabled
= false;
2356 c
= XCAR (Vunread_command_events
);
2357 Vunread_command_events
= XCDR (Vunread_command_events
);
2359 /* Undo what sit-for did when it unread additional keys
2360 inside universal-argument. */
2362 if (CONSP (c
) && EQ (XCAR (c
), Qt
))
2367 /* Undo what read_char_x_menu_prompt did when it unread
2368 additional keys returned by Fx_popup_menu. */
2370 && EQ (XCDR (c
), Qdisabled
)
2371 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
))))
2373 was_disabled
= true;
2377 /* If the queued event is something that used the mouse,
2378 set used_mouse_menu accordingly. */
2380 /* Also check was_disabled so last-nonmenu-event won't return
2381 a bad value when submenus are involved. (Bug#447) */
2382 && (EQ (c
, Qtool_bar
) || EQ (c
, Qmenu_bar
) || was_disabled
))
2383 *used_mouse_menu
= true;
2385 goto reread_for_input_method
;
2388 if (CONSP (Vunread_input_method_events
))
2390 c
= XCAR (Vunread_input_method_events
);
2391 Vunread_input_method_events
= XCDR (Vunread_input_method_events
);
2393 /* Undo what read_char_x_menu_prompt did when it unread
2394 additional keys returned by Fx_popup_menu. */
2396 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2400 goto reread_for_input_method
;
2403 if (!NILP (Vexecuting_kbd_macro
))
2405 /* We set this to Qmacro; since that's not a frame, nobody will
2406 try to switch frames on us, and the selected window will
2409 Since this event came from a macro, it would be misleading to
2410 leave internal_last_event_frame set to wherever the last
2411 real event came from. Normally, a switch-frame event selects
2412 internal_last_event_frame after each command is read, but
2413 events read from a macro should never cause a new frame to be
2415 Vlast_event_frame
= internal_last_event_frame
= Qmacro
;
2417 /* Exit the macro if we are at the end.
2418 Also, some things replace the macro with t
2419 to force an early exit. */
2420 if (EQ (Vexecuting_kbd_macro
, Qt
)
2421 || executing_kbd_macro_index
>= XFASTINT (Flength (Vexecuting_kbd_macro
)))
2427 c
= Faref (Vexecuting_kbd_macro
, make_number (executing_kbd_macro_index
));
2428 if (STRINGP (Vexecuting_kbd_macro
)
2429 && (XFASTINT (c
) & 0x80) && (XFASTINT (c
) <= 0xff))
2430 XSETFASTINT (c
, CHAR_META
| (XFASTINT (c
) & ~0x80));
2432 executing_kbd_macro_index
++;
2437 if (!NILP (unread_switch_frame
))
2439 c
= unread_switch_frame
;
2440 unread_switch_frame
= Qnil
;
2442 /* This event should make it into this_command_keys, and get echoed
2443 again, so we do not set `reread'. */
2447 /* If redisplay was requested. */
2448 if (commandflag
>= 0)
2450 bool echo_current
= EQ (echo_message_buffer
, echo_area_buffer
[0]);
2452 /* If there is pending input, process any events which are not
2453 user-visible, such as X selection_request events. */
2455 || detect_input_pending_run_timers (0))
2456 swallow_events (false); /* May clear input_pending. */
2458 /* Redisplay if no pending input. */
2459 while (!(input_pending
2460 && (input_was_pending
|| !redisplay_dont_pause
)))
2462 input_was_pending
= input_pending
;
2463 if (help_echo_showing_p
&& !EQ (selected_window
, minibuf_window
))
2464 redisplay_preserve_echo_area (5);
2469 /* Normal case: no input arrived during redisplay. */
2472 /* Input arrived and pre-empted redisplay.
2473 Process any events which are not user-visible. */
2474 swallow_events (false);
2475 /* If that cleared input_pending, try again to redisplay. */
2478 /* Prevent the redisplay we just did
2479 from messing up echoing of the input after the prompt. */
2480 if (commandflag
== 0 && echo_current
)
2481 echo_message_buffer
= echo_area_buffer
[0];
2485 /* Message turns off echoing unless more keystrokes turn it on again.
2487 The code in 20.x for the condition was
2489 1. echo_area_glyphs && *echo_area_glyphs
2490 2. && echo_area_glyphs != current_kboard->echobuf
2491 3. && ok_to_echo_at_next_pause != echo_area_glyphs
2493 (1) means there's a current message displayed
2495 (2) means it's not the message from echoing from the current
2498 (3) There's only one place in 20.x where ok_to_echo_at_next_pause
2499 is set to a non-null value. This is done in read_char and it is
2500 set to echo_area_glyphs. That means
2501 ok_to_echo_at_next_pause is either null or
2502 current_kboard->echobuf with the appropriate current_kboard at
2505 So, condition (3) means in clear text ok_to_echo_at_next_pause
2506 must be either null, or the current message isn't from echoing at
2507 all, or it's from echoing from a different kboard than the
2510 if (/* There currently is something in the echo area. */
2511 !NILP (echo_area_buffer
[0])
2512 && (/* It's an echo from a different kboard. */
2513 echo_kboard
!= current_kboard
2514 /* Or we explicitly allow overwriting whatever there is. */
2515 || ok_to_echo_at_next_pause
== NULL
))
2520 /* Try reading a character via menu prompting in the minibuf.
2521 Try this before the sit-for, because the sit-for
2522 would do the wrong thing if we are supposed to do
2523 menu prompting. If EVENT_HAS_PARAMETERS then we are reading
2524 after a mouse event so don't try a minibuf menu. */
2526 if (KEYMAPP (map
) && INTERACTIVE
2527 && !NILP (prev_event
) && ! EVENT_HAS_PARAMETERS (prev_event
)
2528 /* Don't bring up a menu if we already have another event. */
2529 && NILP (Vunread_command_events
)
2530 && !detect_input_pending_run_timers (0))
2532 c
= read_char_minibuf_menu_prompt (commandflag
, map
);
2534 if (INTEGERP (c
) && XINT (c
) == -2)
2535 return c
; /* wrong_kboard_jmpbuf */
2541 /* Make a longjmp point for quits to use, but don't alter getcjmp just yet.
2542 We will do that below, temporarily for short sections of code,
2543 when appropriate. local_getcjmp must be in effect
2544 around any call to sit_for or kbd_buffer_get_event;
2545 it *must not* be in effect when we call redisplay. */
2547 jmpcount
= SPECPDL_INDEX ();
2548 if (sys_setjmp (local_getcjmp
))
2550 /* Handle quits while reading the keyboard. */
2551 /* We must have saved the outer value of getcjmp here,
2552 so restore it now. */
2553 restore_getcjmp (save_jump
);
2554 pthread_sigmask (SIG_SETMASK
, &empty_mask
, 0);
2555 unbind_to (jmpcount
, Qnil
);
2556 XSETINT (c
, quit_char
);
2557 internal_last_event_frame
= selected_frame
;
2558 Vlast_event_frame
= internal_last_event_frame
;
2559 /* If we report the quit char as an event,
2560 don't do so more than once. */
2561 if (!NILP (Vinhibit_quit
))
2565 KBOARD
*kb
= FRAME_KBOARD (XFRAME (selected_frame
));
2566 if (kb
!= current_kboard
)
2568 Lisp_Object last
= KVAR (kb
, kbd_queue
);
2569 /* We shouldn't get here if we were in single-kboard mode! */
2574 while (CONSP (XCDR (last
)))
2576 if (!NILP (XCDR (last
)))
2580 kset_kbd_queue (kb
, list1 (c
));
2582 XSETCDR (last
, list1 (c
));
2583 kb
->kbd_queue_has_data
= true;
2584 current_kboard
= kb
;
2585 return make_number (-2); /* wrong_kboard_jmpbuf */
2591 /* Start idle timers if no time limit is supplied. We don't do it
2592 if a time limit is supplied to avoid an infinite recursion in the
2593 situation where an idle timer calls `sit-for'. */
2596 timer_start_idle ();
2598 /* If in middle of key sequence and minibuffer not active,
2599 start echoing if enough time elapses. */
2601 if (minibuf_level
== 0
2603 && !current_kboard
->immediate_echo
2604 && (this_command_key_count
> 0
2605 || !NILP (call0 (Qinternal_echo_keystrokes_prefix
)))
2607 && echo_keystrokes_p ()
2608 && (/* No message. */
2609 NILP (echo_area_buffer
[0])
2610 /* Or empty message. */
2611 || (BUF_BEG (XBUFFER (echo_area_buffer
[0]))
2612 == BUF_Z (XBUFFER (echo_area_buffer
[0])))
2613 /* Or already echoing from same kboard. */
2614 || (echo_kboard
&& ok_to_echo_at_next_pause
== echo_kboard
)
2615 /* Or not echoing before and echoing allowed. */
2616 || (!echo_kboard
&& ok_to_echo_at_next_pause
)))
2618 /* After a mouse event, start echoing right away.
2619 This is because we are probably about to display a menu,
2620 and we don't want to delay before doing so. */
2621 if (EVENT_HAS_PARAMETERS (prev_event
))
2627 save_getcjmp (save_jump
);
2628 restore_getcjmp (local_getcjmp
);
2629 tem0
= sit_for (Vecho_keystrokes
, 1, 1);
2630 restore_getcjmp (save_jump
);
2632 && ! CONSP (Vunread_command_events
))
2637 /* Maybe auto save due to number of keystrokes. */
2639 if (commandflag
!= 0 && commandflag
!= -2
2640 && auto_save_interval
> 0
2641 && num_nonmacro_input_events
- last_auto_save
> max (auto_save_interval
, 20)
2642 && !detect_input_pending_run_timers (0))
2644 Fdo_auto_save (Qnil
, Qnil
);
2645 /* Hooks can actually change some buffers in auto save. */
2649 /* Try reading using an X menu.
2650 This is never confused with reading using the minibuf
2651 because the recursive call of read_char in read_char_minibuf_menu_prompt
2652 does not pass on any keymaps. */
2654 if (KEYMAPP (map
) && INTERACTIVE
2655 && !NILP (prev_event
)
2656 && EVENT_HAS_PARAMETERS (prev_event
)
2657 && !EQ (XCAR (prev_event
), Qmenu_bar
)
2658 && !EQ (XCAR (prev_event
), Qtool_bar
)
2659 /* Don't bring up a menu if we already have another event. */
2660 && NILP (Vunread_command_events
))
2662 c
= read_char_x_menu_prompt (map
, prev_event
, used_mouse_menu
);
2664 /* Now that we have read an event, Emacs is not idle. */
2671 /* Maybe autosave and/or garbage collect due to idleness. */
2673 if (INTERACTIVE
&& NILP (c
))
2676 ptrdiff_t buffer_size
;
2678 /* Slow down auto saves logarithmically in size of current buffer,
2679 and garbage collect while we're at it. */
2680 if (! MINI_WINDOW_P (XWINDOW (selected_window
)))
2681 last_non_minibuf_size
= Z
- BEG
;
2682 buffer_size
= (last_non_minibuf_size
>> 8) + 1;
2684 while (buffer_size
> 64)
2685 delay_level
++, buffer_size
-= buffer_size
>> 2;
2686 if (delay_level
< 4) delay_level
= 4;
2687 /* delay_level is 4 for files under around 50k, 7 at 100k,
2688 9 at 200k, 11 at 300k, and 12 at 500k. It is 15 at 1 meg. */
2690 /* Auto save if enough time goes by without input. */
2691 if (commandflag
!= 0 && commandflag
!= -2
2692 && num_nonmacro_input_events
> last_auto_save
2693 && INTEGERP (Vauto_save_timeout
)
2694 && XINT (Vauto_save_timeout
) > 0)
2697 EMACS_INT timeout
= XFASTINT (Vauto_save_timeout
);
2699 timeout
= min (timeout
, MOST_POSITIVE_FIXNUM
/ delay_level
* 4);
2700 timeout
= delay_level
* timeout
/ 4;
2701 save_getcjmp (save_jump
);
2702 restore_getcjmp (local_getcjmp
);
2703 tem0
= sit_for (make_number (timeout
), 1, 1);
2704 restore_getcjmp (save_jump
);
2707 && ! CONSP (Vunread_command_events
))
2709 Fdo_auto_save (Qnil
, Qnil
);
2714 /* If there is still no input available, ask for GC. */
2715 if (!detect_input_pending_run_timers (0))
2719 /* Notify the caller if an autosave hook, or a timer, sentinel or
2720 filter in the sit_for calls above have changed the current
2721 kboard. This could happen if they use the minibuffer or start a
2722 recursive edit, like the fancy splash screen in server.el's
2723 filter. If this longjmp wasn't here, read_key_sequence would
2724 interpret the next key sequence using the wrong translation
2725 tables and function keymaps. */
2726 if (NILP (c
) && current_kboard
!= orig_kboard
)
2727 return make_number (-2); /* wrong_kboard_jmpbuf */
2729 /* If this has become non-nil here, it has been set by a timer
2730 or sentinel or filter. */
2731 if (CONSP (Vunread_command_events
))
2733 c
= XCAR (Vunread_command_events
);
2734 Vunread_command_events
= XCDR (Vunread_command_events
);
2736 if (CONSP (c
) && EQ (XCAR (c
), Qt
))
2742 /* Read something from current KBOARD's side queue, if possible. */
2746 if (current_kboard
->kbd_queue_has_data
)
2748 if (!CONSP (KVAR (current_kboard
, kbd_queue
)))
2750 c
= XCAR (KVAR (current_kboard
, kbd_queue
));
2751 kset_kbd_queue (current_kboard
,
2752 XCDR (KVAR (current_kboard
, kbd_queue
)));
2753 if (NILP (KVAR (current_kboard
, kbd_queue
)))
2754 current_kboard
->kbd_queue_has_data
= false;
2755 input_pending
= readable_events (0);
2756 if (EVENT_HAS_PARAMETERS (c
)
2757 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qswitch_frame
))
2758 internal_last_event_frame
= XCAR (XCDR (c
));
2759 Vlast_event_frame
= internal_last_event_frame
;
2763 /* If current_kboard's side queue is empty check the other kboards.
2764 If one of them has data that we have not yet seen here,
2765 switch to it and process the data waiting for it.
2767 Note: if the events queued up for another kboard
2768 have already been seen here, and therefore are not a complete command,
2769 the kbd_queue_has_data field is 0, so we skip that kboard here.
2770 That's to avoid an infinite loop switching between kboards here. */
2771 if (NILP (c
) && !single_kboard
)
2774 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
2775 if (kb
->kbd_queue_has_data
)
2777 current_kboard
= kb
;
2778 return make_number (-2); /* wrong_kboard_jmpbuf */
2788 c
= read_decoded_event_from_main_queue (end_time
, local_getcjmp
,
2789 prev_event
, used_mouse_menu
);
2790 if (NILP (c
) && end_time
2791 && timespec_cmp (*end_time
, current_timespec ()) <= 0)
2796 if (EQ (c
, make_number (-2)))
2808 if (commandflag
>= 0
2809 && !input_pending
&& !detect_input_pending_run_timers (0))
2815 /* Buffer switch events are only for internal wakeups
2816 so don't show them to the user.
2817 Also, don't record a key if we already did. */
2821 /* Process special events within read_char
2822 and loop around to read another event. */
2825 tem
= access_keymap (get_keymap (Vspecial_event_map
, 0, 1), c
, 0, 0, 1);
2830 struct buffer
*prev_buffer
= current_buffer
;
2831 last_input_event
= c
;
2832 call4 (Qcommand_execute
, tem
, Qnil
, Fvector (1, &last_input_event
), Qt
);
2834 if (CONSP (c
) && EQ (XCAR (c
), Qselect_window
) && !end_time
)
2835 /* We stopped being idle for this event; undo that. This
2836 prevents automatic window selection (under
2837 mouse_autoselect_window from acting as a real input event, for
2838 example banishing the mouse under mouse-avoidance-mode. */
2839 timer_resume_idle ();
2841 if (current_buffer
!= prev_buffer
)
2843 /* The command may have changed the keymaps. Pretend there
2844 is input in another keyboard and return. This will
2845 recalculate keymaps. */
2846 c
= make_number (-2);
2853 /* Handle things that only apply to characters. */
2856 /* If kbd_buffer_get_event gave us an EOF, return that. */
2860 if ((STRINGP (KVAR (current_kboard
, Vkeyboard_translate_table
))
2861 && UNSIGNED_CMP (XFASTINT (c
), <,
2862 SCHARS (KVAR (current_kboard
,
2863 Vkeyboard_translate_table
))))
2864 || (VECTORP (KVAR (current_kboard
, Vkeyboard_translate_table
))
2865 && UNSIGNED_CMP (XFASTINT (c
), <,
2866 ASIZE (KVAR (current_kboard
,
2867 Vkeyboard_translate_table
))))
2868 || (CHAR_TABLE_P (KVAR (current_kboard
, Vkeyboard_translate_table
))
2872 d
= Faref (KVAR (current_kboard
, Vkeyboard_translate_table
), c
);
2873 /* nil in keyboard-translate-table means no translation. */
2879 /* If this event is a mouse click in the menu bar,
2880 return just menu-bar for now. Modify the mouse click event
2881 so we won't do this twice, then queue it up. */
2882 if (EVENT_HAS_PARAMETERS (c
)
2884 && CONSP (EVENT_START (c
))
2885 && CONSP (XCDR (EVENT_START (c
))))
2889 posn
= POSN_POSN (EVENT_START (c
));
2890 /* Handle menu-bar events:
2891 insert the dummy prefix event `menu-bar'. */
2892 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
2894 /* Change menu-bar to (menu-bar) as the event "position". */
2895 POSN_SET_POSN (EVENT_START (c
), list1 (posn
));
2898 Vunread_command_events
= Fcons (c
, Vunread_command_events
);
2903 /* Store these characters into recent_keys, the dribble file if any,
2904 and the keyboard macro being defined, if any. */
2907 if (! NILP (also_record
))
2908 record_char (also_record
);
2910 /* Wipe the echo area.
2911 But first, if we are about to use an input method,
2912 save the echo area contents for it to refer to. */
2914 && ! NILP (Vinput_method_function
)
2915 && ' ' <= XINT (c
) && XINT (c
) < 256 && XINT (c
) != 127)
2917 previous_echo_area_message
= Fcurrent_message ();
2918 Vinput_method_previous_message
= previous_echo_area_message
;
2921 /* Now wipe the echo area, except for help events which do their
2922 own stuff with the echo area. */
2924 || (!(EQ (Qhelp_echo
, XCAR (c
)))
2925 && !(EQ (Qswitch_frame
, XCAR (c
)))
2926 /* Don't wipe echo area for select window events: These might
2927 get delayed via `mouse-autoselect-window' (Bug#11304). */
2928 && !(EQ (Qselect_window
, XCAR (c
)))))
2930 if (!NILP (echo_area_buffer
[0]))
2932 safe_run_hooks (Qecho_area_clear_hook
);
2933 clear_message (1, 0);
2937 reread_for_input_method
:
2939 /* Pass this to the input method, if appropriate. */
2941 && ! NILP (Vinput_method_function
)
2942 /* Don't run the input method within a key sequence,
2943 after the first event of the key sequence. */
2944 && NILP (prev_event
)
2945 && ' ' <= XINT (c
) && XINT (c
) < 256 && XINT (c
) != 127)
2948 ptrdiff_t key_count
;
2949 ptrdiff_t command_key_start
;
2950 ptrdiff_t count
= SPECPDL_INDEX ();
2952 /* Save the echo status. */
2953 bool saved_immediate_echo
= current_kboard
->immediate_echo
;
2954 struct kboard
*saved_ok_to_echo
= ok_to_echo_at_next_pause
;
2955 Lisp_Object saved_echo_string
= KVAR (current_kboard
, echo_string
);
2956 Lisp_Object saved_echo_prompt
= KVAR (current_kboard
, echo_prompt
);
2958 /* Save the this_command_keys status. */
2959 key_count
= this_command_key_count
;
2960 command_key_start
= this_single_command_key_start
;
2963 keys
= Fcopy_sequence (this_command_keys
);
2967 /* Clear out this_command_keys. */
2968 this_command_key_count
= 0;
2969 this_single_command_key_start
= 0;
2971 /* Now wipe the echo area. */
2972 if (!NILP (echo_area_buffer
[0]))
2973 safe_run_hooks (Qecho_area_clear_hook
);
2974 clear_message (1, 0);
2977 /* If we are not reading a key sequence,
2978 never use the echo area. */
2981 specbind (Qinput_method_use_echo_area
, Qt
);
2984 /* Call the input method. */
2985 tem
= call1 (Vinput_method_function
, c
);
2987 tem
= unbind_to (count
, tem
);
2989 /* Restore the saved echoing state
2990 and this_command_keys state. */
2991 this_command_key_count
= key_count
;
2992 this_single_command_key_start
= command_key_start
;
2994 this_command_keys
= keys
;
2997 ok_to_echo_at_next_pause
= saved_ok_to_echo
;
2998 kset_echo_string (current_kboard
, saved_echo_string
);
2999 kset_echo_prompt (current_kboard
, saved_echo_prompt
);
3000 if (saved_immediate_echo
)
3003 /* The input method can return no events. */
3006 /* Bring back the previous message, if any. */
3007 if (! NILP (previous_echo_area_message
))
3008 message_with_string ("%s", previous_echo_area_message
, 0);
3011 /* It returned one event or more. */
3013 Vunread_post_input_method_events
3014 = nconc2 (XCDR (tem
), Vunread_post_input_method_events
);
3016 /* When we consume events from the various unread-*-events lists, we
3017 bypass the code that records input, so record these events now if
3018 they were not recorded already. */
3027 /* Display help if not echoing. */
3028 if (CONSP (c
) && EQ (XCAR (c
), Qhelp_echo
))
3030 /* (help-echo FRAME HELP WINDOW OBJECT POS). */
3031 Lisp_Object help
, object
, position
, window
, htem
;
3033 htem
= Fcdr (XCDR (c
));
3036 window
= Fcar (htem
);
3038 object
= Fcar (htem
);
3040 position
= Fcar (htem
);
3042 show_help_echo (help
, window
, object
, position
);
3044 /* We stopped being idle for this event; undo that. */
3046 timer_resume_idle ();
3050 if ((! reread
|| this_command_key_count
== 0)
3054 /* Don't echo mouse motion events. */
3055 if (! (EVENT_HAS_PARAMETERS (c
)
3056 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
3057 /* Once we reread a character, echoing can happen
3058 the next time we pause to read a new one. */
3059 ok_to_echo_at_next_pause
= current_kboard
;
3061 /* Record this character as part of the current key. */
3062 add_command_key (c
);
3063 if (! NILP (also_record
))
3064 add_command_key (also_record
);
3069 last_input_event
= c
;
3072 /* Process the help character specially if enabled. */
3073 if (!NILP (Vhelp_form
) && help_char_p (c
))
3075 ptrdiff_t count
= SPECPDL_INDEX ();
3077 help_form_saved_window_configs
3078 = Fcons (Fcurrent_window_configuration (Qnil
),
3079 help_form_saved_window_configs
);
3080 record_unwind_protect_void (read_char_help_form_unwind
);
3081 call0 (Qhelp_form_show
);
3086 c
= read_char (0, Qnil
, Qnil
, 0, NULL
);
3087 if (EVENT_HAS_PARAMETERS (c
)
3088 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_click
))
3089 XSETCAR (help_form_saved_window_configs
, Qnil
);
3091 while (BUFFERP (c
));
3092 /* Remove the help from the frame. */
3093 unbind_to (count
, Qnil
);
3096 if (EQ (c
, make_number (040)))
3100 c
= read_char (0, Qnil
, Qnil
, 0, NULL
);
3101 while (BUFFERP (c
));
3107 input_was_pending
= input_pending
;
3111 /* Record a key that came from a mouse menu.
3112 Record it for echoing, for this-command-keys, and so on. */
3115 record_menu_key (Lisp_Object c
)
3117 /* Wipe the echo area. */
3118 clear_message (1, 0);
3122 /* Once we reread a character, echoing can happen
3123 the next time we pause to read a new one. */
3124 ok_to_echo_at_next_pause
= NULL
;
3126 /* Record this character as part of the current key. */
3127 add_command_key (c
);
3130 /* Re-reading in the middle of a command. */
3131 last_input_event
= c
;
3135 /* Return true if should recognize C as "the help character". */
3138 help_char_p (Lisp_Object c
)
3142 if (EQ (c
, Vhelp_char
))
3144 for (tail
= Vhelp_event_list
; CONSP (tail
); tail
= XCDR (tail
))
3145 if (EQ (c
, XCAR (tail
)))
3150 /* Record the input event C in various ways. */
3153 record_char (Lisp_Object c
)
3157 if (CONSP (c
) && (EQ (XCAR (c
), Qhelp_echo
) || EQ (XCAR (c
), Qmouse_movement
)))
3159 /* To avoid filling recent_keys with help-echo and mouse-movement
3160 events, we filter out repeated help-echo events, only store the
3161 first and last in a series of mouse-movement events, and don't
3162 store repeated help-echo events which are only separated by
3163 mouse-movement events. */
3165 Lisp_Object ev1
, ev2
, ev3
;
3168 if ((ix1
= recent_keys_index
- 1) < 0)
3169 ix1
= NUM_RECENT_KEYS
- 1;
3170 ev1
= AREF (recent_keys
, ix1
);
3172 if ((ix2
= ix1
- 1) < 0)
3173 ix2
= NUM_RECENT_KEYS
- 1;
3174 ev2
= AREF (recent_keys
, ix2
);
3176 if ((ix3
= ix2
- 1) < 0)
3177 ix3
= NUM_RECENT_KEYS
- 1;
3178 ev3
= AREF (recent_keys
, ix3
);
3180 if (EQ (XCAR (c
), Qhelp_echo
))
3182 /* Don't record `help-echo' in recent_keys unless it shows some help
3183 message, and a different help than the previously recorded
3185 Lisp_Object help
, last_help
;
3187 help
= Fcar_safe (Fcdr_safe (XCDR (c
)));
3188 if (!STRINGP (help
))
3190 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qhelp_echo
)
3191 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev1
))), EQ (last_help
, help
)))
3193 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3194 && CONSP (ev2
) && EQ (XCAR (ev2
), Qhelp_echo
)
3195 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev2
))), EQ (last_help
, help
)))
3197 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3198 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3199 && CONSP (ev3
) && EQ (XCAR (ev3
), Qhelp_echo
)
3200 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev3
))), EQ (last_help
, help
)))
3203 else if (EQ (XCAR (c
), Qmouse_movement
))
3205 /* Only record one pair of `mouse-movement' on a window in recent_keys.
3206 So additional mouse movement events replace the last element. */
3207 Lisp_Object last_window
, window
;
3209 window
= Fcar_safe (Fcar_safe (XCDR (c
)));
3210 if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3211 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev1
))), EQ (last_window
, window
))
3212 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3213 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev2
))), EQ (last_window
, window
)))
3215 ASET (recent_keys
, ix1
, c
);
3221 store_kbd_macro_char (c
);
3225 total_keys
+= total_keys
< NUM_RECENT_KEYS
;
3226 ASET (recent_keys
, recent_keys_index
, c
);
3227 if (++recent_keys_index
>= NUM_RECENT_KEYS
)
3228 recent_keys_index
= 0;
3230 else if (recorded
< 0)
3232 /* We need to remove one or two events from recent_keys.
3233 To do this, we simply put nil at those events and move the
3234 recent_keys_index backwards over those events. Usually,
3235 users will never see those nil events, as they will be
3236 overwritten by the command keys entered to see recent_keys
3239 while (recorded
++ < 0 && total_keys
> 0)
3241 if (total_keys
< NUM_RECENT_KEYS
)
3243 if (--recent_keys_index
< 0)
3244 recent_keys_index
= NUM_RECENT_KEYS
- 1;
3245 ASET (recent_keys
, recent_keys_index
, Qnil
);
3249 num_nonmacro_input_events
++;
3251 /* Write c to the dribble file. If c is a lispy event, write
3252 the event's symbol to the dribble file, in <brackets>. Bleaugh.
3253 If you, dear reader, have a better idea, you've got the source. :-) */
3259 if (XUINT (c
) < 0x100)
3260 putc (XUINT (c
), dribble
);
3262 fprintf (dribble
, " 0x%"pI
"x", XUINT (c
));
3266 Lisp_Object dribblee
;
3268 /* If it's a structured event, take the event header. */
3269 dribblee
= EVENT_HEAD (c
);
3271 if (SYMBOLP (dribblee
))
3273 putc ('<', dribble
);
3274 fwrite (SDATA (SYMBOL_NAME (dribblee
)), sizeof (char),
3275 SBYTES (SYMBOL_NAME (dribblee
)),
3277 putc ('>', dribble
);
3286 /* Copy out or in the info on where C-g should throw to.
3287 This is used when running Lisp code from within get_char,
3288 in case get_char is called recursively.
3289 See read_process_output. */
3292 save_getcjmp (sys_jmp_buf temp
)
3294 memcpy (temp
, getcjmp
, sizeof getcjmp
);
3298 restore_getcjmp (sys_jmp_buf temp
)
3300 memcpy (getcjmp
, temp
, sizeof getcjmp
);
3303 /* Low level keyboard/mouse input.
3304 kbd_buffer_store_event places events in kbd_buffer, and
3305 kbd_buffer_get_event retrieves them. */
3307 /* Return true if there are any events in the queue that read-char
3308 would return. If this returns false, a read-char would block. */
3310 readable_events (int flags
)
3312 if (flags
& READABLE_EVENTS_DO_TIMERS_NOW
)
3315 /* If the buffer contains only FOCUS_IN_EVENT events, and
3316 READABLE_EVENTS_FILTER_EVENTS is set, report it as empty. */
3317 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3319 if (flags
& (READABLE_EVENTS_FILTER_EVENTS
3320 #ifdef USE_TOOLKIT_SCROLL_BARS
3321 | READABLE_EVENTS_IGNORE_SQUEEZABLES
3325 union buffered_input_event
*event
= kbd_fetch_ptr
;
3329 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3332 #ifdef USE_TOOLKIT_SCROLL_BARS
3333 (flags
& READABLE_EVENTS_FILTER_EVENTS
) &&
3335 event
->kind
== FOCUS_IN_EVENT
)
3336 #ifdef USE_TOOLKIT_SCROLL_BARS
3337 && !((flags
& READABLE_EVENTS_IGNORE_SQUEEZABLES
)
3338 && (event
->kind
== SCROLL_BAR_CLICK_EVENT
3339 || event
->kind
== HORIZONTAL_SCROLL_BAR_CLICK_EVENT
)
3340 && event
->ie
.part
== scroll_bar_handle
3341 && event
->ie
.modifiers
== 0)
3343 && !((flags
& READABLE_EVENTS_FILTER_EVENTS
)
3344 && event
->kind
== BUFFER_SWITCH_EVENT
))
3348 while (event
!= kbd_store_ptr
);
3354 if (!(flags
& READABLE_EVENTS_IGNORE_SQUEEZABLES
)
3355 && !NILP (do_mouse_tracking
) && some_mouse_moved ())
3359 if (current_kboard
->kbd_queue_has_data
)
3365 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
3366 if (kb
->kbd_queue_has_data
)
3372 /* Set this for debugging, to have a way to get out */
3373 int stop_character EXTERNALLY_VISIBLE
;
3376 event_to_kboard (struct input_event
*event
)
3378 /* Not applicable for these special events. */
3379 if (event
->kind
== SELECTION_REQUEST_EVENT
3380 || event
->kind
== SELECTION_CLEAR_EVENT
)
3384 Lisp_Object obj
= event
->frame_or_window
;
3385 /* There are some events that set this field to nil or string. */
3387 obj
= WINDOW_FRAME (XWINDOW (obj
));
3388 /* Also ignore dead frames here. */
3389 return ((FRAMEP (obj
) && FRAME_LIVE_P (XFRAME (obj
)))
3390 ? FRAME_KBOARD (XFRAME (obj
)) : NULL
);
3395 /* Return the number of slots occupied in kbd_buffer. */
3398 kbd_buffer_nr_stored (void)
3400 return kbd_fetch_ptr
== kbd_store_ptr
3402 : (kbd_fetch_ptr
< kbd_store_ptr
3403 ? kbd_store_ptr
- kbd_fetch_ptr
3404 : ((kbd_buffer
+ KBD_BUFFER_SIZE
) - kbd_fetch_ptr
3405 + (kbd_store_ptr
- kbd_buffer
)));
3407 #endif /* Store an event obtained at interrupt level into kbd_buffer, fifo */
3410 kbd_buffer_store_event (register struct input_event
*event
)
3412 kbd_buffer_store_event_hold (event
, 0);
3415 /* Store EVENT obtained at interrupt level into kbd_buffer, fifo.
3417 If HOLD_QUIT is 0, just stuff EVENT into the fifo.
3418 Else, if HOLD_QUIT.kind != NO_EVENT, discard EVENT.
3419 Else, if EVENT is a quit event, store the quit event
3420 in HOLD_QUIT, and return (thus ignoring further events).
3422 This is used to postpone the processing of the quit event until all
3423 subsequent input events have been parsed (and discarded). */
3426 kbd_buffer_store_buffered_event (union buffered_input_event
*event
,
3427 struct input_event
*hold_quit
)
3429 if (event
->kind
== NO_EVENT
)
3432 if (hold_quit
&& hold_quit
->kind
!= NO_EVENT
)
3435 if (event
->kind
== ASCII_KEYSTROKE_EVENT
)
3437 int c
= event
->ie
.code
& 0377;
3439 if (event
->ie
.modifiers
& ctrl_modifier
)
3440 c
= make_ctrl_char (c
);
3442 c
|= (event
->ie
.modifiers
3443 & (meta_modifier
| alt_modifier
3444 | hyper_modifier
| super_modifier
));
3448 KBOARD
*kb
= FRAME_KBOARD (XFRAME (event
->ie
.frame_or_window
));
3450 if (single_kboard
&& kb
!= current_kboard
)
3453 (kb
, list2 (make_lispy_switch_frame (event
->ie
.frame_or_window
),
3455 kb
->kbd_queue_has_data
= true;
3456 union buffered_input_event
*sp
;
3457 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3459 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3462 if (event_to_kboard (&sp
->ie
) == kb
)
3464 sp
->ie
.kind
= NO_EVENT
;
3465 sp
->ie
.frame_or_window
= Qnil
;
3474 *hold_quit
= event
->ie
;
3478 /* If this results in a quit_char being returned to Emacs as
3479 input, set Vlast_event_frame properly. If this doesn't
3480 get returned to Emacs as an event, the next event read
3481 will set Vlast_event_frame again, so this is safe to do. */
3485 focus
= FRAME_FOCUS_FRAME (XFRAME (event
->ie
.frame_or_window
));
3487 focus
= event
->ie
.frame_or_window
;
3488 internal_last_event_frame
= focus
;
3489 Vlast_event_frame
= focus
;
3492 handle_interrupt (0);
3496 if (c
&& c
== stop_character
)
3502 /* Don't insert two BUFFER_SWITCH_EVENT's in a row.
3503 Just ignore the second one. */
3504 else if (event
->kind
== BUFFER_SWITCH_EVENT
3505 && kbd_fetch_ptr
!= kbd_store_ptr
3506 && ((kbd_store_ptr
== kbd_buffer
3507 ? kbd_buffer
+ KBD_BUFFER_SIZE
- 1
3508 : kbd_store_ptr
- 1)->kind
) == BUFFER_SWITCH_EVENT
)
3511 if (kbd_store_ptr
- kbd_buffer
== KBD_BUFFER_SIZE
)
3512 kbd_store_ptr
= kbd_buffer
;
3514 /* Don't let the very last slot in the buffer become full,
3515 since that would make the two pointers equal,
3516 and that is indistinguishable from an empty buffer.
3517 Discard the event if it would fill the last slot. */
3518 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
3520 *kbd_store_ptr
= *event
;
3523 if (kbd_buffer_nr_stored () > KBD_BUFFER_SIZE
/ 2
3524 && ! kbd_on_hold_p ())
3526 /* Don't read keyboard input until we have processed kbd_buffer.
3527 This happens when pasting text longer than KBD_BUFFER_SIZE/2. */
3528 hold_keyboard_input ();
3532 #endif /* subprocesses */
3535 /* If we're inside while-no-input, and this event qualifies
3536 as input, set quit-flag to cause an interrupt. */
3537 if (!NILP (Vthrow_on_input
)
3538 && event
->kind
!= FOCUS_IN_EVENT
3539 && event
->kind
!= FOCUS_OUT_EVENT
3540 && event
->kind
!= HELP_EVENT
3541 && event
->kind
!= ICONIFY_EVENT
3542 && event
->kind
!= DEICONIFY_EVENT
)
3544 Vquit_flag
= Vthrow_on_input
;
3545 /* If we're inside a function that wants immediate quits,
3547 if (immediate_quit
&& NILP (Vinhibit_quit
))
3549 immediate_quit
= false;
3558 /* Put a selection input event back in the head of the event queue. */
3561 kbd_buffer_unget_event (struct selection_input_event
*event
)
3563 if (kbd_fetch_ptr
== kbd_buffer
)
3564 kbd_fetch_ptr
= kbd_buffer
+ KBD_BUFFER_SIZE
;
3566 /* Don't let the very last slot in the buffer become full, */
3567 union buffered_input_event
*kp
= kbd_fetch_ptr
- 1;
3568 if (kp
!= kbd_store_ptr
)
3577 /* Limit help event positions to this range, to avoid overflow problems. */
3578 #define INPUT_EVENT_POS_MAX \
3579 ((ptrdiff_t) min (PTRDIFF_MAX, min (TYPE_MAXIMUM (Time) / 2, \
3580 MOST_POSITIVE_FIXNUM)))
3581 #define INPUT_EVENT_POS_MIN (-1 - INPUT_EVENT_POS_MAX)
3583 /* Return a Time that encodes position POS. POS must be in range. */
3586 position_to_Time (ptrdiff_t pos
)
3588 eassert (INPUT_EVENT_POS_MIN
<= pos
&& pos
<= INPUT_EVENT_POS_MAX
);
3592 /* Return the position that ENCODED_POS encodes.
3593 Avoid signed integer overflow. */
3596 Time_to_position (Time encoded_pos
)
3598 if (encoded_pos
<= INPUT_EVENT_POS_MAX
)
3600 Time encoded_pos_min
= INPUT_EVENT_POS_MIN
;
3601 eassert (encoded_pos_min
<= encoded_pos
);
3602 ptrdiff_t notpos
= -1 - encoded_pos
;
3606 /* Generate a HELP_EVENT input_event and store it in the keyboard
3609 HELP is the help form.
3611 FRAME and WINDOW are the frame and window where the help is
3612 generated. OBJECT is the Lisp object where the help was found (a
3613 buffer, a string, an overlay, or nil if neither from a string nor
3614 from a buffer). POS is the position within OBJECT where the help
3618 gen_help_event (Lisp_Object help
, Lisp_Object frame
, Lisp_Object window
,
3619 Lisp_Object object
, ptrdiff_t pos
)
3621 struct input_event event
;
3623 event
.kind
= HELP_EVENT
;
3624 event
.frame_or_window
= frame
;
3626 event
.x
= WINDOWP (window
) ? window
: frame
;
3628 event
.timestamp
= position_to_Time (pos
);
3629 kbd_buffer_store_event (&event
);
3633 /* Store HELP_EVENTs for HELP on FRAME in the input queue. */
3636 kbd_buffer_store_help_event (Lisp_Object frame
, Lisp_Object help
)
3638 struct input_event event
;
3640 event
.kind
= HELP_EVENT
;
3641 event
.frame_or_window
= frame
;
3645 event
.timestamp
= 0;
3646 kbd_buffer_store_event (&event
);
3650 /* Discard any mouse events in the event buffer by setting them to
3653 discard_mouse_events (void)
3655 union buffered_input_event
*sp
;
3656 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3658 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3661 if (sp
->kind
== MOUSE_CLICK_EVENT
3662 || sp
->kind
== WHEEL_EVENT
3663 || sp
->kind
== HORIZ_WHEEL_EVENT
3665 || sp
->kind
== GPM_CLICK_EVENT
3667 || sp
->kind
== SCROLL_BAR_CLICK_EVENT
3668 || sp
->kind
== HORIZONTAL_SCROLL_BAR_CLICK_EVENT
)
3670 sp
->kind
= NO_EVENT
;
3676 /* Return true if there are any real events waiting in the event
3677 buffer, not counting `NO_EVENT's.
3679 Discard NO_EVENT events at the front of the input queue, possibly
3680 leaving the input queue empty if there are no real input events. */
3683 kbd_buffer_events_waiting (void)
3685 union buffered_input_event
*sp
;
3687 for (sp
= kbd_fetch_ptr
;
3688 sp
!= kbd_store_ptr
&& sp
->kind
== NO_EVENT
;
3691 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3696 return sp
!= kbd_store_ptr
&& sp
->kind
!= NO_EVENT
;
3700 /* Clear input event EVENT. */
3703 clear_event (union buffered_input_event
*event
)
3705 event
->kind
= NO_EVENT
;
3709 /* Read one event from the event buffer, waiting if necessary.
3710 The value is a Lisp object representing the event.
3711 The value is nil for an event that should be ignored,
3712 or that was handled here.
3713 We always read and discard one event. */
3716 kbd_buffer_get_event (KBOARD
**kbp
,
3717 bool *used_mouse_menu
,
3718 struct timespec
*end_time
)
3723 if (kbd_on_hold_p () && kbd_buffer_nr_stored () < KBD_BUFFER_SIZE
/ 4)
3725 /* Start reading input again because we have processed enough to
3726 be able to accept new events again. */
3727 unhold_keyboard_input ();
3731 #endif /* subprocesses */
3733 #if !defined HAVE_DBUS && !defined USE_FILE_NOTIFY
3735 /* In case we are running as a daemon, only do this before
3736 detaching from the terminal. */
3737 || (IS_DAEMON
&& DAEMON_RUNNING
))
3741 *kbp
= current_kboard
;
3744 #endif /* !defined HAVE_DBUS && !defined USE_FILE_NOTIFY */
3746 /* Wait until there is input available. */
3749 /* Break loop if there's an unread command event. Needed in
3750 moused window autoselection which uses a timer to insert such
3752 if (CONSP (Vunread_command_events
))
3755 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3757 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3760 /* If the quit flag is set, then read_char will return
3761 quit_char, so that counts as "available input." */
3762 if (!NILP (Vquit_flag
))
3763 quit_throw_to_read_char (0);
3765 /* One way or another, wait until input is available; then, if
3766 interrupt handlers have not read it, read it now. */
3771 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3773 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3777 struct timespec now
= current_timespec ();
3778 if (timespec_cmp (*end_time
, now
) <= 0)
3779 return Qnil
; /* Finished waiting. */
3782 struct timespec duration
= timespec_sub (*end_time
, now
);
3783 wait_reading_process_output (min (duration
.tv_sec
,
3786 -1, 1, Qnil
, NULL
, 0);
3791 bool do_display
= true;
3793 if (FRAME_TERMCAP_P (SELECTED_FRAME ()))
3795 struct tty_display_info
*tty
= CURTTY ();
3797 /* When this TTY is displaying a menu, we must prevent
3798 any redisplay, because we modify the frame's glyph
3799 matrix behind the back of the display engine. */
3800 if (tty
->showing_menu
)
3804 wait_reading_process_output (0, 0, -1, do_display
, Qnil
, NULL
, 0);
3807 if (!interrupt_input
&& kbd_fetch_ptr
== kbd_store_ptr
)
3811 if (CONSP (Vunread_command_events
))
3814 first
= XCAR (Vunread_command_events
);
3815 Vunread_command_events
= XCDR (Vunread_command_events
);
3816 *kbp
= current_kboard
;
3820 /* At this point, we know that there is a readable event available
3821 somewhere. If the event queue is empty, then there must be a
3822 mouse movement enabled and available. */
3823 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3825 union buffered_input_event
*event
;
3827 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
3831 *kbp
= event_to_kboard (&event
->ie
);
3833 *kbp
= current_kboard
; /* Better than returning null ptr? */
3837 /* These two kinds of events get special handling
3838 and don't actually appear to the command loop.
3839 We return nil for them. */
3840 if (event
->kind
== SELECTION_REQUEST_EVENT
3841 || event
->kind
== SELECTION_CLEAR_EVENT
)
3844 /* Remove it from the buffer before processing it,
3845 since otherwise swallow_events will see it
3846 and process it again. */
3847 struct selection_input_event copy
= event
->sie
;
3848 kbd_fetch_ptr
= event
+ 1;
3849 input_pending
= readable_events (0);
3850 x_handle_selection_event (©
);
3852 /* We're getting selection request events, but we don't have
3858 #if defined (HAVE_NS)
3859 else if (event
->kind
== NS_TEXT_EVENT
)
3861 if (event
->ie
.code
== KEY_NS_PUT_WORKING_TEXT
)
3862 obj
= list1 (intern ("ns-put-working-text"));
3864 obj
= list1 (intern ("ns-unput-working-text"));
3865 kbd_fetch_ptr
= event
+ 1;
3866 if (used_mouse_menu
)
3867 *used_mouse_menu
= true;
3871 #if defined (HAVE_X11) || defined (HAVE_NTGUI) \
3872 || defined (HAVE_NS)
3873 else if (event
->kind
== DELETE_WINDOW_EVENT
)
3875 /* Make an event (delete-frame (FRAME)). */
3876 obj
= list2 (Qdelete_frame
, list1 (event
->ie
.frame_or_window
));
3877 kbd_fetch_ptr
= event
+ 1;
3880 #if defined (HAVE_X11) || defined (HAVE_NTGUI) \
3881 || defined (HAVE_NS)
3882 else if (event
->kind
== ICONIFY_EVENT
)
3884 /* Make an event (iconify-frame (FRAME)). */
3885 obj
= list2 (Qiconify_frame
, list1 (event
->ie
.frame_or_window
));
3886 kbd_fetch_ptr
= event
+ 1;
3888 else if (event
->kind
== DEICONIFY_EVENT
)
3890 /* Make an event (make-frame-visible (FRAME)). */
3891 obj
= list2 (Qmake_frame_visible
, list1 (event
->ie
.frame_or_window
));
3892 kbd_fetch_ptr
= event
+ 1;
3895 else if (event
->kind
== BUFFER_SWITCH_EVENT
)
3897 /* The value doesn't matter here; only the type is tested. */
3898 XSETBUFFER (obj
, current_buffer
);
3899 kbd_fetch_ptr
= event
+ 1;
3901 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
3902 || defined (HAVE_NS) || defined (USE_GTK)
3903 else if (event
->kind
== MENU_BAR_ACTIVATE_EVENT
)
3905 kbd_fetch_ptr
= event
+ 1;
3906 input_pending
= readable_events (0);
3907 if (FRAME_LIVE_P (XFRAME (event
->ie
.frame_or_window
)))
3908 x_activate_menubar (XFRAME (event
->ie
.frame_or_window
));
3912 else if (event
->kind
== LANGUAGE_CHANGE_EVENT
)
3914 /* Make an event (language-change FRAME CODEPAGE LANGUAGE-ID). */
3915 obj
= list4 (Qlanguage_change
,
3916 event
->ie
.frame_or_window
,
3917 make_number (event
->ie
.code
),
3918 make_number (event
->ie
.modifiers
));
3919 kbd_fetch_ptr
= event
+ 1;
3922 #ifdef USE_FILE_NOTIFY
3923 else if (event
->kind
== FILE_NOTIFY_EVENT
)
3925 #ifdef HAVE_W32NOTIFY
3926 /* Make an event (file-notify (DESCRIPTOR ACTION FILE) CALLBACK). */
3927 obj
= list3 (Qfile_notify
, event
->ie
.arg
, event
->ie
.frame_or_window
);
3929 obj
= make_lispy_event (&event
->ie
);
3931 kbd_fetch_ptr
= event
+ 1;
3933 #endif /* USE_FILE_NOTIFY */
3934 else if (event
->kind
== SAVE_SESSION_EVENT
)
3936 obj
= list2 (Qsave_session
, event
->ie
.arg
);
3937 kbd_fetch_ptr
= event
+ 1;
3939 /* Just discard these, by returning nil.
3940 With MULTI_KBOARD, these events are used as placeholders
3941 when we need to randomly delete events from the queue.
3942 (They shouldn't otherwise be found in the buffer,
3943 but on some machines it appears they do show up
3944 even without MULTI_KBOARD.) */
3945 /* On Windows NT/9X, NO_EVENT is used to delete extraneous
3946 mouse events during a popup-menu call. */
3947 else if (event
->kind
== NO_EVENT
)
3948 kbd_fetch_ptr
= event
+ 1;
3949 else if (event
->kind
== HELP_EVENT
)
3951 Lisp_Object object
, position
, help
, frame
, window
;
3953 frame
= event
->ie
.frame_or_window
;
3954 object
= event
->ie
.arg
;
3955 position
= make_number (Time_to_position (event
->ie
.timestamp
));
3956 window
= event
->ie
.x
;
3958 clear_event (event
);
3960 kbd_fetch_ptr
= event
+ 1;
3961 if (!WINDOWP (window
))
3963 obj
= Fcons (Qhelp_echo
,
3964 list5 (frame
, help
, window
, object
, position
));
3966 else if (event
->kind
== FOCUS_IN_EVENT
)
3968 /* Notification of a FocusIn event. The frame receiving the
3969 focus is in event->frame_or_window. Generate a
3970 switch-frame event if necessary. */
3971 Lisp_Object frame
, focus
;
3973 frame
= event
->ie
.frame_or_window
;
3974 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
3980 ! NILP (event
->ie
.arg
)
3983 !EQ (frame
, internal_last_event_frame
)
3984 && !EQ (frame
, selected_frame
))
3985 obj
= make_lispy_switch_frame (frame
);
3987 obj
= make_lispy_focus_in (frame
);
3989 internal_last_event_frame
= frame
;
3990 kbd_fetch_ptr
= event
+ 1;
3992 else if (event
->kind
== FOCUS_OUT_EVENT
)
3994 #ifdef HAVE_WINDOW_SYSTEM
3997 Lisp_Object frame
= event
->ie
.frame_or_window
;
3998 bool focused
= false;
4000 for (di
= x_display_list
; di
&& ! focused
; di
= di
->next
)
4001 focused
= di
->x_highlight_frame
!= 0;
4004 obj
= make_lispy_focus_out (frame
);
4006 #endif /* HAVE_WINDOW_SYSTEM */
4008 kbd_fetch_ptr
= event
+ 1;
4011 else if (event
->kind
== DBUS_EVENT
)
4013 obj
= make_lispy_event (&event
->ie
);
4014 kbd_fetch_ptr
= event
+ 1;
4017 #ifdef HAVE_XWIDGETS
4018 else if (event
->kind
== XWIDGET_EVENT
)
4020 obj
= make_lispy_event (&event
->ie
);
4021 kbd_fetch_ptr
= event
+ 1;
4024 else if (event
->kind
== CONFIG_CHANGED_EVENT
)
4026 obj
= make_lispy_event (&event
->ie
);
4027 kbd_fetch_ptr
= event
+ 1;
4031 /* If this event is on a different frame, return a switch-frame this
4032 time, and leave the event in the queue for next time. */
4036 frame
= event
->ie
.frame_or_window
;
4038 frame
= XCAR (frame
);
4039 else if (WINDOWP (frame
))
4040 frame
= WINDOW_FRAME (XWINDOW (frame
));
4042 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
4046 if (! EQ (frame
, internal_last_event_frame
)
4047 && !EQ (frame
, selected_frame
))
4048 obj
= make_lispy_switch_frame (frame
);
4049 internal_last_event_frame
= frame
;
4051 /* If we didn't decide to make a switch-frame event, go ahead
4052 and build a real event from the queue entry. */
4056 obj
= make_lispy_event (&event
->ie
);
4058 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
4059 || defined (HAVE_NS) || defined (USE_GTK)
4060 /* If this was a menu selection, then set the flag to inhibit
4061 writing to last_nonmenu_event. Don't do this if the event
4062 we're returning is (menu-bar), though; that indicates the
4063 beginning of the menu sequence, and we might as well leave
4064 that as the `event with parameters' for this selection. */
4066 && !EQ (event
->ie
.frame_or_window
, event
->ie
.arg
)
4067 && (event
->kind
== MENU_BAR_EVENT
4068 || event
->kind
== TOOL_BAR_EVENT
))
4069 *used_mouse_menu
= true;
4072 /* Certain system events are non-key events. */
4074 && event
->kind
== NS_NONKEY_EVENT
)
4075 *used_mouse_menu
= true;
4078 /* Wipe out this event, to catch bugs. */
4079 clear_event (event
);
4080 kbd_fetch_ptr
= event
+ 1;
4084 /* Try generating a mouse motion event. */
4085 else if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
4087 struct frame
*f
= some_mouse_moved ();
4088 Lisp_Object bar_window
;
4089 enum scroll_bar_part part
;
4093 *kbp
= current_kboard
;
4094 /* Note that this uses F to determine which terminal to look at.
4095 If there is no valid info, it does not store anything
4096 so x remains nil. */
4099 /* XXX Can f or mouse_position_hook be NULL here? */
4100 if (f
&& FRAME_TERMINAL (f
)->mouse_position_hook
)
4101 (*FRAME_TERMINAL (f
)->mouse_position_hook
) (&f
, 0, &bar_window
,
4106 /* Decide if we should generate a switch-frame event. Don't
4107 generate switch-frame events for motion outside of all Emacs
4113 frame
= FRAME_FOCUS_FRAME (f
);
4115 XSETFRAME (frame
, f
);
4117 if (! EQ (frame
, internal_last_event_frame
)
4118 && !EQ (frame
, selected_frame
))
4119 obj
= make_lispy_switch_frame (frame
);
4120 internal_last_event_frame
= frame
;
4123 /* If we didn't decide to make a switch-frame event, go ahead and
4124 return a mouse-motion event. */
4125 if (!NILP (x
) && NILP (obj
))
4126 obj
= make_lispy_movement (f
, bar_window
, part
, x
, y
, t
);
4129 /* We were promised by the above while loop that there was
4130 something for us to read! */
4133 input_pending
= readable_events (0);
4135 Vlast_event_frame
= internal_last_event_frame
;
4140 /* Process any non-user-visible events (currently X selection events),
4141 without reading any user-visible events. */
4144 process_special_events (void)
4146 union buffered_input_event
*event
;
4148 for (event
= kbd_fetch_ptr
; event
!= kbd_store_ptr
; ++event
)
4150 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
4153 if (event
== kbd_store_ptr
)
4157 /* If we find a stored X selection request, handle it now. */
4158 if (event
->kind
== SELECTION_REQUEST_EVENT
4159 || event
->kind
== SELECTION_CLEAR_EVENT
)
4163 /* Remove the event from the fifo buffer before processing;
4164 otherwise swallow_events called recursively could see it
4165 and process it again. To do this, we move the events
4166 between kbd_fetch_ptr and EVENT one slot to the right,
4169 struct selection_input_event copy
= event
->sie
;
4170 union buffered_input_event
*beg
4171 = (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
4172 ? kbd_buffer
: kbd_fetch_ptr
;
4175 memmove (beg
+ 1, beg
, (event
- beg
) * sizeof *beg
);
4176 else if (event
< beg
)
4178 if (event
> kbd_buffer
)
4179 memmove (kbd_buffer
+ 1, kbd_buffer
,
4180 (event
- kbd_buffer
) * sizeof *kbd_buffer
);
4181 *kbd_buffer
= *(kbd_buffer
+ KBD_BUFFER_SIZE
- 1);
4182 if (beg
< kbd_buffer
+ KBD_BUFFER_SIZE
- 1)
4183 memmove (beg
+ 1, beg
,
4184 (kbd_buffer
+ KBD_BUFFER_SIZE
- 1 - beg
) * sizeof *beg
);
4187 if (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
4188 kbd_fetch_ptr
= kbd_buffer
+ 1;
4192 input_pending
= readable_events (0);
4193 x_handle_selection_event (©
);
4195 /* We're getting selection request events, but we don't have
4203 /* Process any events that are not user-visible, run timer events that
4204 are ripe, and return, without reading any user-visible events. */
4207 swallow_events (bool do_display
)
4209 unsigned old_timers_run
;
4211 process_special_events ();
4213 old_timers_run
= timers_run
;
4214 get_input_pending (READABLE_EVENTS_DO_TIMERS_NOW
);
4216 if (!input_pending
&& timers_run
!= old_timers_run
&& do_display
)
4217 redisplay_preserve_echo_area (7);
4220 /* Record the start of when Emacs is idle,
4221 for the sake of running idle-time timers. */
4224 timer_start_idle (void)
4226 /* If we are already in the idle state, do nothing. */
4227 if (timespec_valid_p (timer_idleness_start_time
))
4230 timer_idleness_start_time
= current_timespec ();
4231 timer_last_idleness_start_time
= timer_idleness_start_time
;
4233 /* Mark all idle-time timers as once again candidates for running. */
4234 call0 (intern ("internal-timer-start-idle"));
4237 /* Record that Emacs is no longer idle, so stop running idle-time timers. */
4240 timer_stop_idle (void)
4242 timer_idleness_start_time
= invalid_timespec ();
4245 /* Resume idle timer from last idle start time. */
4248 timer_resume_idle (void)
4250 if (timespec_valid_p (timer_idleness_start_time
))
4253 timer_idleness_start_time
= timer_last_idleness_start_time
;
4256 /* List of elisp functions to call, delayed because they were generated in
4257 a context where Elisp could not be safely run (e.g. redisplay, signal,
4258 ...). Each element has the form (FUN . ARGS). */
4259 Lisp_Object pending_funcalls
;
4261 /* Return true if TIMER is a valid timer, placing its value into *RESULT. */
4263 decode_timer (Lisp_Object timer
, struct timespec
*result
)
4267 if (! (VECTORP (timer
) && ASIZE (timer
) == 9))
4269 vec
= XVECTOR (timer
)->contents
;
4270 if (! NILP (vec
[0]))
4272 if (! INTEGERP (vec
[2]))
4276 if (decode_time_components (vec
[1], vec
[2], vec
[3], vec
[8], &t
, 0) <= 0)
4278 *result
= lisp_to_timespec (t
);
4279 return timespec_valid_p (*result
);
4283 /* Check whether a timer has fired. To prevent larger problems we simply
4284 disregard elements that are not proper timers. Do not make a circular
4285 timer list for the time being.
4287 Returns the time to wait until the next timer fires. If a
4288 timer is triggering now, return zero.
4289 If no timer is active, return -1.
4291 If a timer is ripe, we run it, with quitting turned off.
4292 In that case we return 0 to indicate that a new timer_check_2 call
4295 static struct timespec
4296 timer_check_2 (Lisp_Object timers
, Lisp_Object idle_timers
)
4298 struct timespec nexttime
;
4299 struct timespec now
;
4300 struct timespec idleness_now
;
4301 Lisp_Object chosen_timer
;
4303 nexttime
= invalid_timespec ();
4305 chosen_timer
= Qnil
;
4307 /* First run the code that was delayed. */
4308 while (CONSP (pending_funcalls
))
4310 Lisp_Object funcall
= XCAR (pending_funcalls
);
4311 pending_funcalls
= XCDR (pending_funcalls
);
4312 safe_call2 (Qapply
, XCAR (funcall
), XCDR (funcall
));
4315 if (CONSP (timers
) || CONSP (idle_timers
))
4317 now
= current_timespec ();
4318 idleness_now
= (timespec_valid_p (timer_idleness_start_time
)
4319 ? timespec_sub (now
, timer_idleness_start_time
)
4320 : make_timespec (0, 0));
4323 while (CONSP (timers
) || CONSP (idle_timers
))
4325 Lisp_Object timer
= Qnil
, idle_timer
= Qnil
;
4326 struct timespec timer_time
, idle_timer_time
;
4327 struct timespec difference
;
4328 struct timespec timer_difference
= invalid_timespec ();
4329 struct timespec idle_timer_difference
= invalid_timespec ();
4330 bool ripe
, timer_ripe
= 0, idle_timer_ripe
= 0;
4332 /* Set TIMER and TIMER_DIFFERENCE
4333 based on the next ordinary timer.
4334 TIMER_DIFFERENCE is the distance in time from NOW to when
4335 this timer becomes ripe.
4336 Skip past invalid timers and timers already handled. */
4339 timer
= XCAR (timers
);
4340 if (! decode_timer (timer
, &timer_time
))
4342 timers
= XCDR (timers
);
4346 timer_ripe
= timespec_cmp (timer_time
, now
) <= 0;
4347 timer_difference
= (timer_ripe
4348 ? timespec_sub (now
, timer_time
)
4349 : timespec_sub (timer_time
, now
));
4352 /* Likewise for IDLE_TIMER and IDLE_TIMER_DIFFERENCE
4353 based on the next idle timer. */
4354 if (CONSP (idle_timers
))
4356 idle_timer
= XCAR (idle_timers
);
4357 if (! decode_timer (idle_timer
, &idle_timer_time
))
4359 idle_timers
= XCDR (idle_timers
);
4363 idle_timer_ripe
= timespec_cmp (idle_timer_time
, idleness_now
) <= 0;
4364 idle_timer_difference
4366 ? timespec_sub (idleness_now
, idle_timer_time
)
4367 : timespec_sub (idle_timer_time
, idleness_now
));
4370 /* Decide which timer is the next timer,
4371 and set CHOSEN_TIMER, DIFFERENCE, and RIPE accordingly.
4372 Also step down the list where we found that timer. */
4374 if (timespec_valid_p (timer_difference
)
4375 && (! timespec_valid_p (idle_timer_difference
)
4376 || idle_timer_ripe
< timer_ripe
4377 || (idle_timer_ripe
== timer_ripe
4379 ? timespec_cmp (idle_timer_difference
,
4381 : timespec_cmp (timer_difference
,
4382 idle_timer_difference
))
4385 chosen_timer
= timer
;
4386 timers
= XCDR (timers
);
4387 difference
= timer_difference
;
4392 chosen_timer
= idle_timer
;
4393 idle_timers
= XCDR (idle_timers
);
4394 difference
= idle_timer_difference
;
4395 ripe
= idle_timer_ripe
;
4398 /* If timer is ripe, run it if it hasn't been run. */
4401 if (NILP (AREF (chosen_timer
, 0)))
4403 ptrdiff_t count
= SPECPDL_INDEX ();
4404 Lisp_Object old_deactivate_mark
= Vdeactivate_mark
;
4406 /* Mark the timer as triggered to prevent problems if the lisp
4407 code fails to reschedule it right. */
4408 ASET (chosen_timer
, 0, Qt
);
4410 specbind (Qinhibit_quit
, Qt
);
4412 call1 (Qtimer_event_handler
, chosen_timer
);
4413 Vdeactivate_mark
= old_deactivate_mark
;
4415 unbind_to (count
, Qnil
);
4417 /* Since we have handled the event,
4418 we don't need to tell the caller to wake up and do it. */
4419 /* But the caller must still wait for the next timer, so
4420 return 0 to indicate that. */
4423 nexttime
= make_timespec (0, 0);
4427 /* When we encounter a timer that is still waiting,
4428 return the amount of time to wait before it is ripe. */
4434 /* No timers are pending in the future. */
4435 /* Return 0 if we generated an event, and -1 if not. */
4440 /* Check whether a timer has fired. To prevent larger problems we simply
4441 disregard elements that are not proper timers. Do not make a circular
4442 timer list for the time being.
4444 Returns the time to wait until the next timer fires.
4445 If no timer is active, return an invalid value.
4447 As long as any timer is ripe, we run it. */
4452 struct timespec nexttime
;
4453 Lisp_Object timers
, idle_timers
;
4455 Lisp_Object tem
= Vinhibit_quit
;
4458 /* We use copies of the timers' lists to allow a timer to add itself
4459 again, without locking up Emacs if the newly added timer is
4460 already ripe when added. */
4462 /* Always consider the ordinary timers. */
4463 timers
= Fcopy_sequence (Vtimer_list
);
4464 /* Consider the idle timers only if Emacs is idle. */
4465 if (timespec_valid_p (timer_idleness_start_time
))
4466 idle_timers
= Fcopy_sequence (Vtimer_idle_list
);
4470 Vinhibit_quit
= tem
;
4474 nexttime
= timer_check_2 (timers
, idle_timers
);
4476 while (nexttime
.tv_sec
== 0 && nexttime
.tv_nsec
== 0);
4481 DEFUN ("current-idle-time", Fcurrent_idle_time
, Scurrent_idle_time
, 0, 0, 0,
4482 doc
: /* Return the current length of Emacs idleness, or nil.
4483 The value when Emacs is idle is a list of four integers (HIGH LOW USEC PSEC)
4484 in the same style as (current-time).
4486 The value when Emacs is not idle is nil.
4488 PSEC is a multiple of the system clock resolution. */)
4491 if (timespec_valid_p (timer_idleness_start_time
))
4492 return make_lisp_time (timespec_sub (current_timespec (),
4493 timer_idleness_start_time
));
4498 /* Caches for modify_event_symbol. */
4499 static Lisp_Object accent_key_syms
;
4500 static Lisp_Object func_key_syms
;
4501 static Lisp_Object mouse_syms
;
4502 static Lisp_Object wheel_syms
;
4503 static Lisp_Object drag_n_drop_syms
;
4505 /* This is a list of keysym codes for special "accent" characters.
4506 It parallels lispy_accent_keys. */
4508 static const int lispy_accent_codes
[] =
4510 #ifdef XK_dead_circumflex
4515 #ifdef XK_dead_grave
4520 #ifdef XK_dead_tilde
4525 #ifdef XK_dead_diaeresis
4530 #ifdef XK_dead_macron
4535 #ifdef XK_dead_degree
4540 #ifdef XK_dead_acute
4545 #ifdef XK_dead_cedilla
4550 #ifdef XK_dead_breve
4555 #ifdef XK_dead_ogonek
4560 #ifdef XK_dead_caron
4565 #ifdef XK_dead_doubleacute
4566 XK_dead_doubleacute
,
4570 #ifdef XK_dead_abovedot
4575 #ifdef XK_dead_abovering
4585 #ifdef XK_dead_belowdot
4590 #ifdef XK_dead_voiced_sound
4591 XK_dead_voiced_sound
,
4595 #ifdef XK_dead_semivoiced_sound
4596 XK_dead_semivoiced_sound
,
4612 /* This is a list of Lisp names for special "accent" characters.
4613 It parallels lispy_accent_codes. */
4615 static const char *const lispy_accent_keys
[] =
4633 "dead-voiced-sound",
4634 "dead-semivoiced-sound",
4640 #define FUNCTION_KEY_OFFSET 0x0
4642 const char *const lispy_function_keys
[] =
4646 0, /* VK_LBUTTON 0x01 */
4647 0, /* VK_RBUTTON 0x02 */
4648 "cancel", /* VK_CANCEL 0x03 */
4649 0, /* VK_MBUTTON 0x04 */
4651 0, 0, 0, /* 0x05 .. 0x07 */
4653 "backspace", /* VK_BACK 0x08 */
4654 "tab", /* VK_TAB 0x09 */
4656 0, 0, /* 0x0A .. 0x0B */
4658 "clear", /* VK_CLEAR 0x0C */
4659 "return", /* VK_RETURN 0x0D */
4661 0, 0, /* 0x0E .. 0x0F */
4663 0, /* VK_SHIFT 0x10 */
4664 0, /* VK_CONTROL 0x11 */
4665 0, /* VK_MENU 0x12 */
4666 "pause", /* VK_PAUSE 0x13 */
4667 "capslock", /* VK_CAPITAL 0x14 */
4668 "kana", /* VK_KANA/VK_HANGUL 0x15 */
4670 "junja", /* VK_JUNJA 0x17 */
4671 "final", /* VK_FINAL 0x18 */
4672 "kanji", /* VK_KANJI/VK_HANJA 0x19 */
4674 "escape", /* VK_ESCAPE 0x1B */
4675 "convert", /* VK_CONVERT 0x1C */
4676 "non-convert", /* VK_NONCONVERT 0x1D */
4677 "accept", /* VK_ACCEPT 0x1E */
4678 "mode-change", /* VK_MODECHANGE 0x1F */
4679 0, /* VK_SPACE 0x20 */
4680 "prior", /* VK_PRIOR 0x21 */
4681 "next", /* VK_NEXT 0x22 */
4682 "end", /* VK_END 0x23 */
4683 "home", /* VK_HOME 0x24 */
4684 "left", /* VK_LEFT 0x25 */
4685 "up", /* VK_UP 0x26 */
4686 "right", /* VK_RIGHT 0x27 */
4687 "down", /* VK_DOWN 0x28 */
4688 "select", /* VK_SELECT 0x29 */
4689 "print", /* VK_PRINT 0x2A */
4690 "execute", /* VK_EXECUTE 0x2B */
4691 "snapshot", /* VK_SNAPSHOT 0x2C */
4692 "insert", /* VK_INSERT 0x2D */
4693 "delete", /* VK_DELETE 0x2E */
4694 "help", /* VK_HELP 0x2F */
4696 /* VK_0 thru VK_9 are the same as ASCII '0' thru '9' (0x30 - 0x39) */
4698 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4700 0, 0, 0, 0, 0, 0, 0, /* 0x3A .. 0x40 */
4702 /* VK_A thru VK_Z are the same as ASCII 'A' thru 'Z' (0x41 - 0x5A) */
4704 0, 0, 0, 0, 0, 0, 0, 0, 0,
4705 0, 0, 0, 0, 0, 0, 0, 0, 0,
4706 0, 0, 0, 0, 0, 0, 0, 0,
4708 "lwindow", /* VK_LWIN 0x5B */
4709 "rwindow", /* VK_RWIN 0x5C */
4710 "apps", /* VK_APPS 0x5D */
4713 "kp-0", /* VK_NUMPAD0 0x60 */
4714 "kp-1", /* VK_NUMPAD1 0x61 */
4715 "kp-2", /* VK_NUMPAD2 0x62 */
4716 "kp-3", /* VK_NUMPAD3 0x63 */
4717 "kp-4", /* VK_NUMPAD4 0x64 */
4718 "kp-5", /* VK_NUMPAD5 0x65 */
4719 "kp-6", /* VK_NUMPAD6 0x66 */
4720 "kp-7", /* VK_NUMPAD7 0x67 */
4721 "kp-8", /* VK_NUMPAD8 0x68 */
4722 "kp-9", /* VK_NUMPAD9 0x69 */
4723 "kp-multiply", /* VK_MULTIPLY 0x6A */
4724 "kp-add", /* VK_ADD 0x6B */
4725 "kp-separator", /* VK_SEPARATOR 0x6C */
4726 "kp-subtract", /* VK_SUBTRACT 0x6D */
4727 "kp-decimal", /* VK_DECIMAL 0x6E */
4728 "kp-divide", /* VK_DIVIDE 0x6F */
4729 "f1", /* VK_F1 0x70 */
4730 "f2", /* VK_F2 0x71 */
4731 "f3", /* VK_F3 0x72 */
4732 "f4", /* VK_F4 0x73 */
4733 "f5", /* VK_F5 0x74 */
4734 "f6", /* VK_F6 0x75 */
4735 "f7", /* VK_F7 0x76 */
4736 "f8", /* VK_F8 0x77 */
4737 "f9", /* VK_F9 0x78 */
4738 "f10", /* VK_F10 0x79 */
4739 "f11", /* VK_F11 0x7A */
4740 "f12", /* VK_F12 0x7B */
4741 "f13", /* VK_F13 0x7C */
4742 "f14", /* VK_F14 0x7D */
4743 "f15", /* VK_F15 0x7E */
4744 "f16", /* VK_F16 0x7F */
4745 "f17", /* VK_F17 0x80 */
4746 "f18", /* VK_F18 0x81 */
4747 "f19", /* VK_F19 0x82 */
4748 "f20", /* VK_F20 0x83 */
4749 "f21", /* VK_F21 0x84 */
4750 "f22", /* VK_F22 0x85 */
4751 "f23", /* VK_F23 0x86 */
4752 "f24", /* VK_F24 0x87 */
4754 0, 0, 0, 0, /* 0x88 .. 0x8B */
4755 0, 0, 0, 0, /* 0x8C .. 0x8F */
4757 "kp-numlock", /* VK_NUMLOCK 0x90 */
4758 "scroll", /* VK_SCROLL 0x91 */
4759 /* Not sure where the following block comes from.
4760 Windows headers have NEC and Fujitsu specific keys in
4761 this block, but nothing generic. */
4762 "kp-space", /* VK_NUMPAD_CLEAR 0x92 */
4763 "kp-enter", /* VK_NUMPAD_ENTER 0x93 */
4764 "kp-prior", /* VK_NUMPAD_PRIOR 0x94 */
4765 "kp-next", /* VK_NUMPAD_NEXT 0x95 */
4766 "kp-end", /* VK_NUMPAD_END 0x96 */
4767 "kp-home", /* VK_NUMPAD_HOME 0x97 */
4768 "kp-left", /* VK_NUMPAD_LEFT 0x98 */
4769 "kp-up", /* VK_NUMPAD_UP 0x99 */
4770 "kp-right", /* VK_NUMPAD_RIGHT 0x9A */
4771 "kp-down", /* VK_NUMPAD_DOWN 0x9B */
4772 "kp-insert", /* VK_NUMPAD_INSERT 0x9C */
4773 "kp-delete", /* VK_NUMPAD_DELETE 0x9D */
4775 0, 0, /* 0x9E .. 0x9F */
4778 * VK_L* & VK_R* - left and right Alt, Ctrl and Shift virtual keys.
4779 * Used only as parameters to GetAsyncKeyState and GetKeyState.
4780 * No other API or message will distinguish left and right keys this way.
4785 /* Multimedia keys. These are handled as WM_APPCOMMAND, which allows us
4786 to enable them selectively, and gives access to a few more functions.
4787 See lispy_multimedia_keys below. */
4788 0, 0, 0, 0, 0, 0, 0, /* 0xA6 .. 0xAC Browser */
4789 0, 0, 0, /* 0xAD .. 0xAF Volume */
4790 0, 0, 0, 0, /* 0xB0 .. 0xB3 Media */
4791 0, 0, 0, 0, /* 0xB4 .. 0xB7 Apps */
4793 /* 0xB8 .. 0xC0 "OEM" keys - all seem to be punctuation. */
4794 0, 0, 0, 0, 0, 0, 0, 0, 0,
4796 /* 0xC1 - 0xDA unallocated, 0xDB-0xDF more OEM keys */
4797 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4798 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4801 "ax", /* VK_OEM_AX 0xE1 */
4802 0, /* VK_OEM_102 0xE2 */
4803 "ico-help", /* VK_ICO_HELP 0xE3 */
4804 "ico-00", /* VK_ICO_00 0xE4 */
4805 0, /* VK_PROCESSKEY 0xE5 - used by IME */
4806 "ico-clear", /* VK_ICO_CLEAR 0xE6 */
4807 0, /* VK_PACKET 0xE7 - used to pass Unicode chars */
4809 "reset", /* VK_OEM_RESET 0xE9 */
4810 "jump", /* VK_OEM_JUMP 0xEA */
4811 "oem-pa1", /* VK_OEM_PA1 0xEB */
4812 "oem-pa2", /* VK_OEM_PA2 0xEC */
4813 "oem-pa3", /* VK_OEM_PA3 0xED */
4814 "wsctrl", /* VK_OEM_WSCTRL 0xEE */
4815 "cusel", /* VK_OEM_CUSEL 0xEF */
4816 "oem-attn", /* VK_OEM_ATTN 0xF0 */
4817 "finish", /* VK_OEM_FINISH 0xF1 */
4818 "copy", /* VK_OEM_COPY 0xF2 */
4819 "auto", /* VK_OEM_AUTO 0xF3 */
4820 "enlw", /* VK_OEM_ENLW 0xF4 */
4821 "backtab", /* VK_OEM_BACKTAB 0xF5 */
4822 "attn", /* VK_ATTN 0xF6 */
4823 "crsel", /* VK_CRSEL 0xF7 */
4824 "exsel", /* VK_EXSEL 0xF8 */
4825 "ereof", /* VK_EREOF 0xF9 */
4826 "play", /* VK_PLAY 0xFA */
4827 "zoom", /* VK_ZOOM 0xFB */
4828 "noname", /* VK_NONAME 0xFC */
4829 "pa1", /* VK_PA1 0xFD */
4830 "oem_clear", /* VK_OEM_CLEAR 0xFE */
4834 /* Some of these duplicate the "Media keys" on newer keyboards,
4835 but they are delivered to the application in a different way. */
4836 static const char *const lispy_multimedia_keys
[] =
4844 "browser-favorites",
4881 "toggle-dictate-command",
4887 "media-fast-forward",
4890 "media-channel-down"
4893 #else /* not HAVE_NTGUI */
4895 /* This should be dealt with in XTread_socket now, and that doesn't
4896 depend on the client system having the Kana syms defined. See also
4897 the XK_kana_A case below. */
4900 static const char *const lispy_kana_keys
[] =
4902 /* X Keysym value */
4903 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x400 .. 0x40f */
4904 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x410 .. 0x41f */
4905 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x420 .. 0x42f */
4906 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x430 .. 0x43f */
4907 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x440 .. 0x44f */
4908 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x450 .. 0x45f */
4909 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x460 .. 0x46f */
4910 0,0,0,0,0,0,0,0,0,0,0,0,0,0,"overline",0,
4911 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x480 .. 0x48f */
4912 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x490 .. 0x49f */
4913 0, "kana-fullstop", "kana-openingbracket", "kana-closingbracket",
4914 "kana-comma", "kana-conjunctive", "kana-WO", "kana-a",
4915 "kana-i", "kana-u", "kana-e", "kana-o",
4916 "kana-ya", "kana-yu", "kana-yo", "kana-tsu",
4917 "prolongedsound", "kana-A", "kana-I", "kana-U",
4918 "kana-E", "kana-O", "kana-KA", "kana-KI",
4919 "kana-KU", "kana-KE", "kana-KO", "kana-SA",
4920 "kana-SHI", "kana-SU", "kana-SE", "kana-SO",
4921 "kana-TA", "kana-CHI", "kana-TSU", "kana-TE",
4922 "kana-TO", "kana-NA", "kana-NI", "kana-NU",
4923 "kana-NE", "kana-NO", "kana-HA", "kana-HI",
4924 "kana-FU", "kana-HE", "kana-HO", "kana-MA",
4925 "kana-MI", "kana-MU", "kana-ME", "kana-MO",
4926 "kana-YA", "kana-YU", "kana-YO", "kana-RA",
4927 "kana-RI", "kana-RU", "kana-RE", "kana-RO",
4928 "kana-WA", "kana-N", "voicedsound", "semivoicedsound",
4929 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4e0 .. 0x4ef */
4930 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4f0 .. 0x4ff */
4932 #endif /* XK_kana_A */
4935 #define FUNCTION_KEY_OFFSET 0xff00
4937 /* You'll notice that this table is arranged to be conveniently
4938 indexed by X Windows keysym values. */
4939 static const char *const lispy_function_keys
[] =
4941 /* X Keysym value */
4943 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff00...0f */
4944 "backspace", "tab", "linefeed", "clear",
4946 0, 0, 0, "pause", /* 0xff10...1f */
4947 0, 0, 0, 0, 0, 0, 0, "escape",
4949 0, "kanji", "muhenkan", "henkan", /* 0xff20...2f */
4950 "romaji", "hiragana", "katakana", "hiragana-katakana",
4951 "zenkaku", "hankaku", "zenkaku-hankaku", "touroku",
4952 "massyo", "kana-lock", "kana-shift", "eisu-shift",
4953 "eisu-toggle", /* 0xff30...3f */
4954 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4955 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff40...4f */
4957 "home", "left", "up", "right", /* 0xff50 */ /* IsCursorKey */
4958 "down", "prior", "next", "end",
4959 "begin", 0, 0, 0, 0, 0, 0, 0,
4960 "select", /* 0xff60 */ /* IsMiscFunctionKey */
4971 "break", /* 0xff6b */
4974 0, 0, 0, 0, "backtab", 0, 0, 0, /* 0xff70... */
4975 0, 0, 0, 0, 0, 0, 0, "kp-numlock", /* 0xff78... */
4976 "kp-space", /* 0xff80 */ /* IsKeypadKey */
4977 0, 0, 0, 0, 0, 0, 0, 0,
4978 "kp-tab", /* 0xff89 */
4980 "kp-enter", /* 0xff8d */
4982 "kp-f1", /* 0xff91 */
4986 "kp-home", /* 0xff95 */
4991 "kp-prior", /* kp-page-up */
4992 "kp-next", /* kp-page-down */
4998 0, 0, 0, 0, 0, 0, 0, 0, 0,
4999 "kp-multiply", /* 0xffaa */
5004 "kp-divide", /* 0xffaf */
5005 "kp-0", /* 0xffb0 */
5006 "kp-1", "kp-2", "kp-3", "kp-4", "kp-5", "kp-6", "kp-7", "kp-8", "kp-9",
5009 "kp-equal", /* 0xffbd */
5010 "f1", /* 0xffbe */ /* IsFunctionKey */
5012 "f3", "f4", "f5", "f6", "f7", "f8", "f9", "f10", /* 0xffc0 */
5013 "f11", "f12", "f13", "f14", "f15", "f16", "f17", "f18",
5014 "f19", "f20", "f21", "f22", "f23", "f24", "f25", "f26", /* 0xffd0 */
5015 "f27", "f28", "f29", "f30", "f31", "f32", "f33", "f34",
5016 "f35", 0, 0, 0, 0, 0, 0, 0, /* 0xffe0 */
5017 0, 0, 0, 0, 0, 0, 0, 0,
5018 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfff0 */
5019 0, 0, 0, 0, 0, 0, 0, "delete"
5022 /* ISO 9995 Function and Modifier Keys; the first byte is 0xFE. */
5023 #define ISO_FUNCTION_KEY_OFFSET 0xfe00
5025 static const char *const iso_lispy_function_keys
[] =
5027 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe00 */
5028 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe08 */
5029 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe10 */
5030 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe18 */
5031 "iso-lefttab", /* 0xfe20 */
5032 "iso-move-line-up", "iso-move-line-down",
5033 "iso-partial-line-up", "iso-partial-line-down",
5034 "iso-partial-space-left", "iso-partial-space-right",
5035 "iso-set-margin-left", "iso-set-margin-right", /* 0xffe27, 28 */
5036 "iso-release-margin-left", "iso-release-margin-right",
5037 "iso-release-both-margins",
5038 "iso-fast-cursor-left", "iso-fast-cursor-right",
5039 "iso-fast-cursor-up", "iso-fast-cursor-down",
5040 "iso-continuous-underline", "iso-discontinuous-underline", /* 0xfe30, 31 */
5041 "iso-emphasize", "iso-center-object", "iso-enter", /* ... 0xfe34 */
5044 #endif /* not HAVE_NTGUI */
5046 static Lisp_Object Vlispy_mouse_stem
;
5048 static const char *const lispy_wheel_names
[] =
5050 "wheel-up", "wheel-down", "wheel-left", "wheel-right"
5053 /* drag-n-drop events are generated when a set of selected files are
5054 dragged from another application and dropped onto an Emacs window. */
5055 static const char *const lispy_drag_n_drop_names
[] =
5060 /* An array of symbol indexes of scroll bar parts, indexed by an enum
5061 scroll_bar_part value. Note that Qnil corresponds to
5062 scroll_bar_nowhere and should not appear in Lisp events. */
5063 static short const scroll_bar_parts
[] = {
5064 SYMBOL_INDEX (Qnil
), SYMBOL_INDEX (Qabove_handle
), SYMBOL_INDEX (Qhandle
),
5065 SYMBOL_INDEX (Qbelow_handle
), SYMBOL_INDEX (Qup
), SYMBOL_INDEX (Qdown
),
5066 SYMBOL_INDEX (Qtop
), SYMBOL_INDEX (Qbottom
), SYMBOL_INDEX (Qend_scroll
),
5067 SYMBOL_INDEX (Qratio
), SYMBOL_INDEX (Qbefore_handle
),
5068 SYMBOL_INDEX (Qhorizontal_handle
), SYMBOL_INDEX (Qafter_handle
),
5069 SYMBOL_INDEX (Qleft
), SYMBOL_INDEX (Qright
), SYMBOL_INDEX (Qleftmost
),
5070 SYMBOL_INDEX (Qrightmost
), SYMBOL_INDEX (Qend_scroll
), SYMBOL_INDEX (Qratio
)
5073 /* A vector, indexed by button number, giving the down-going location
5074 of currently depressed buttons, both scroll bar and non-scroll bar.
5076 The elements have the form
5077 (BUTTON-NUMBER MODIFIER-MASK . REST)
5078 where REST is the cdr of a position as it would be reported in the event.
5080 The make_lispy_event function stores positions here to tell the
5081 difference between click and drag events, and to store the starting
5082 location to be included in drag events. */
5084 static Lisp_Object button_down_location
;
5086 /* Information about the most recent up-going button event: Which
5087 button, what location, and what time. */
5089 static int last_mouse_button
;
5090 static int last_mouse_x
;
5091 static int last_mouse_y
;
5092 static Time button_down_time
;
5094 /* The number of clicks in this multiple-click. */
5096 static int double_click_count
;
5098 /* X and Y are frame-relative coordinates for a click or wheel event.
5099 Return a Lisp-style event list. */
5102 make_lispy_position (struct frame
*f
, Lisp_Object x
, Lisp_Object y
,
5105 enum window_part part
;
5106 Lisp_Object posn
= Qnil
;
5107 Lisp_Object extra_info
= Qnil
;
5108 /* Coordinate pixel positions to return. */
5109 int xret
= 0, yret
= 0;
5110 /* The window under frame pixel coordinates (x,y) */
5111 Lisp_Object window
= f
5112 ? window_from_coordinates (f
, XINT (x
), XINT (y
), &part
, 0)
5115 if (WINDOWP (window
))
5117 /* It's a click in window WINDOW at frame coordinates (X,Y) */
5118 struct window
*w
= XWINDOW (window
);
5119 Lisp_Object string_info
= Qnil
;
5120 ptrdiff_t textpos
= 0;
5121 int col
= -1, row
= -1;
5122 int dx
= -1, dy
= -1;
5123 int width
= -1, height
= -1;
5124 Lisp_Object object
= Qnil
;
5126 /* Pixel coordinates relative to the window corner. */
5127 int wx
= XINT (x
) - WINDOW_LEFT_EDGE_X (w
);
5128 int wy
= XINT (y
) - WINDOW_TOP_EDGE_Y (w
);
5130 /* For text area clicks, return X, Y relative to the corner of
5131 this text area. Note that dX, dY etc are set below, by
5132 buffer_posn_from_coords. */
5133 if (part
== ON_TEXT
)
5135 xret
= XINT (x
) - window_box_left (w
, TEXT_AREA
);
5136 yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5138 /* For mode line and header line clicks, return X, Y relative to
5139 the left window edge. Use mode_line_string to look for a
5140 string on the click position. */
5141 else if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
)
5146 posn
= (part
== ON_MODE_LINE
) ? Qmode_line
: Qheader_line
;
5147 /* Note that mode_line_string takes COL, ROW as pixels and
5148 converts them to characters. */
5151 string
= mode_line_string (w
, part
, &col
, &row
, &charpos
,
5152 &object
, &dx
, &dy
, &width
, &height
);
5153 if (STRINGP (string
))
5154 string_info
= Fcons (string
, make_number (charpos
));
5160 /* For fringes and margins, Y is relative to the area's (and the
5161 window's) top edge, while X is meaningless. */
5162 else if (part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
5167 posn
= (part
== ON_LEFT_MARGIN
) ? Qleft_margin
: Qright_margin
;
5170 string
= marginal_area_string (w
, part
, &col
, &row
, &charpos
,
5171 &object
, &dx
, &dy
, &width
, &height
);
5172 if (STRINGP (string
))
5173 string_info
= Fcons (string
, make_number (charpos
));
5175 yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5177 else if (part
== ON_LEFT_FRINGE
)
5179 posn
= Qleft_fringe
;
5183 - (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5184 ? 0 : window_box_width (w
, LEFT_MARGIN_AREA
));
5185 dy
= yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5187 else if (part
== ON_RIGHT_FRINGE
)
5189 posn
= Qright_fringe
;
5193 - window_box_width (w
, LEFT_MARGIN_AREA
)
5194 - window_box_width (w
, TEXT_AREA
)
5195 - (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5196 ? window_box_width (w
, RIGHT_MARGIN_AREA
)
5198 dy
= yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5200 else if (part
== ON_VERTICAL_BORDER
)
5202 posn
= Qvertical_line
;
5208 else if (part
== ON_VERTICAL_SCROLL_BAR
)
5210 posn
= Qvertical_scroll_bar
;
5211 width
= WINDOW_SCROLL_BAR_AREA_WIDTH (w
);
5215 else if (part
== ON_HORIZONTAL_SCROLL_BAR
)
5217 posn
= Qhorizontal_scroll_bar
;
5218 width
= WINDOW_SCROLL_BAR_AREA_HEIGHT (w
);
5222 else if (part
== ON_RIGHT_DIVIDER
)
5224 posn
= Qright_divider
;
5225 width
= WINDOW_RIGHT_DIVIDER_WIDTH (w
);
5229 else if (part
== ON_BOTTOM_DIVIDER
)
5231 posn
= Qbottom_divider
;
5232 width
= WINDOW_BOTTOM_DIVIDER_WIDTH (w
);
5237 /* For clicks in the text area, fringes, margins, or vertical
5238 scroll bar, call buffer_posn_from_coords to extract TEXTPOS,
5239 the buffer position nearest to the click. */
5242 Lisp_Object string2
, object2
= Qnil
;
5243 struct display_pos p
;
5245 int width2
, height2
;
5246 /* The pixel X coordinate passed to buffer_posn_from_coords
5247 is the X coordinate relative to the text area for clicks
5248 in text-area, right-margin/fringe and right-side vertical
5249 scroll bar, zero otherwise. */
5251 = (part
== ON_TEXT
) ? xret
5252 : (part
== ON_RIGHT_FRINGE
|| part
== ON_RIGHT_MARGIN
5253 || (part
== ON_VERTICAL_SCROLL_BAR
5254 && WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_RIGHT (w
)))
5255 ? (XINT (x
) - window_box_left (w
, TEXT_AREA
))
5259 string2
= buffer_posn_from_coords (w
, &x2
, &y2
, &p
,
5260 &object2
, &dx2
, &dy2
,
5262 textpos
= CHARPOS (p
.pos
);
5263 if (col
< 0) col
= x2
;
5264 if (row
< 0) row
= y2
;
5265 if (dx
< 0) dx
= dx2
;
5266 if (dy
< 0) dy
= dy2
;
5267 if (width
< 0) width
= width2
;
5268 if (height
< 0) height
= height2
;
5272 posn
= make_number (textpos
);
5273 if (STRINGP (string2
))
5274 string_info
= Fcons (string2
,
5275 make_number (CHARPOS (p
.string_pos
)));
5281 #ifdef HAVE_WINDOW_SYSTEM
5282 if (IMAGEP (object
))
5284 Lisp_Object image_map
, hotspot
;
5285 if ((image_map
= Fplist_get (XCDR (object
), QCmap
),
5287 && (hotspot
= find_hot_spot (image_map
, dx
, dy
),
5289 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
5290 posn
= XCAR (hotspot
);
5297 Fcons (make_number (dx
), make_number (dy
)),
5298 Fcons (make_number (width
), make_number (height
)));
5301 extra_info
= Fcons (string_info
,
5302 Fcons (textpos
< 0 ? Qnil
: make_number (textpos
),
5303 Fcons (Fcons (make_number (col
),
5309 /* Return mouse pixel coordinates here. */
5310 XSETFRAME (window
, f
);
5317 return Fcons (window
,
5319 Fcons (Fcons (make_number (xret
),
5320 make_number (yret
)),
5321 Fcons (make_number (t
),
5325 /* Return non-zero if F is a GUI frame that uses some toolkit-managed
5326 menu bar. This really means that Emacs draws and manages the menu
5327 bar as part of its normal display, and therefore can compute its
5330 toolkit_menubar_in_use (struct frame
*f
)
5332 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS) || defined (HAVE_NTGUI)
5333 return !(!FRAME_WINDOW_P (f
));
5339 /* Build the part of Lisp event which represents scroll bar state from
5340 EV. TYPE is one of Qvertical_scroll_bar or Qhorizontal_scroll_bar. */
5343 make_scroll_bar_position (struct input_event
*ev
, Lisp_Object type
)
5345 return list5 (ev
->frame_or_window
, type
, Fcons (ev
->x
, ev
->y
),
5346 make_number (ev
->timestamp
),
5347 builtin_lisp_symbol (scroll_bar_parts
[ev
->part
]));
5350 /* Given a struct input_event, build the lisp event which represents
5351 it. If EVENT is 0, build a mouse movement event from the mouse
5352 movement buffer, which should have a movement event in it.
5354 Note that events must be passed to this function in the order they
5355 are received; this function stores the location of button presses
5356 in order to build drag events when the button is released. */
5359 make_lispy_event (struct input_event
*event
)
5363 switch (event
->kind
)
5365 /* A simple keystroke. */
5366 case ASCII_KEYSTROKE_EVENT
:
5367 case MULTIBYTE_CHAR_KEYSTROKE_EVENT
:
5369 Lisp_Object lispy_c
;
5370 EMACS_INT c
= event
->code
;
5371 if (event
->kind
== ASCII_KEYSTROKE_EVENT
)
5374 eassert (c
== event
->code
);
5375 /* Turn ASCII characters into control characters
5377 if (event
->modifiers
& ctrl_modifier
)
5379 c
= make_ctrl_char (c
);
5380 event
->modifiers
&= ~ctrl_modifier
;
5384 /* Add in the other modifier bits. The shift key was taken care
5385 of by the X code. */
5386 c
|= (event
->modifiers
5387 & (meta_modifier
| alt_modifier
5388 | hyper_modifier
| super_modifier
| ctrl_modifier
));
5389 /* Distinguish Shift-SPC from SPC. */
5390 if ((event
->code
) == 040
5391 && event
->modifiers
& shift_modifier
)
5392 c
|= shift_modifier
;
5393 button_down_time
= 0;
5394 XSETFASTINT (lispy_c
, c
);
5399 /* NS_NONKEY_EVENTs are just like NON_ASCII_KEYSTROKE_EVENTs,
5400 except that they are non-key events (last-nonmenu-event is nil). */
5401 case NS_NONKEY_EVENT
:
5404 /* A function key. The symbol may need to have modifier prefixes
5406 case NON_ASCII_KEYSTROKE_EVENT
:
5407 button_down_time
= 0;
5409 for (i
= 0; i
< ARRAYELTS (lispy_accent_codes
); i
++)
5410 if (event
->code
== lispy_accent_codes
[i
])
5411 return modify_event_symbol (i
,
5413 Qfunction_key
, Qnil
,
5414 lispy_accent_keys
, &accent_key_syms
,
5415 ARRAYELTS (lispy_accent_keys
));
5419 if (event
->code
>= 0x400 && event
->code
< 0x500)
5420 return modify_event_symbol (event
->code
- 0x400,
5421 event
->modifiers
& ~shift_modifier
,
5422 Qfunction_key
, Qnil
,
5423 lispy_kana_keys
, &func_key_syms
,
5424 ARRAYELTS (lispy_kana_keys
));
5425 #endif /* XK_kana_A */
5428 #ifdef ISO_FUNCTION_KEY_OFFSET
5429 if (event
->code
< FUNCTION_KEY_OFFSET
5430 && event
->code
>= ISO_FUNCTION_KEY_OFFSET
)
5431 return modify_event_symbol (event
->code
- ISO_FUNCTION_KEY_OFFSET
,
5433 Qfunction_key
, Qnil
,
5434 iso_lispy_function_keys
, &func_key_syms
,
5435 ARRAYELTS (iso_lispy_function_keys
));
5438 if ((FUNCTION_KEY_OFFSET
<= event
->code
5440 < FUNCTION_KEY_OFFSET
+ ARRAYELTS (lispy_function_keys
)))
5441 && lispy_function_keys
[event
->code
- FUNCTION_KEY_OFFSET
])
5442 return modify_event_symbol (event
->code
- FUNCTION_KEY_OFFSET
,
5444 Qfunction_key
, Qnil
,
5445 lispy_function_keys
, &func_key_syms
,
5446 ARRAYELTS (lispy_function_keys
));
5448 /* Handle system-specific or unknown keysyms.
5449 We need to use an alist rather than a vector as the cache
5450 since we can't make a vector long enough. */
5451 if (NILP (KVAR (current_kboard
, system_key_syms
)))
5452 kset_system_key_syms (current_kboard
, Fcons (Qnil
, Qnil
));
5453 return modify_event_symbol (event
->code
,
5456 KVAR (current_kboard
, Vsystem_key_alist
),
5457 0, &KVAR (current_kboard
, system_key_syms
),
5461 case MULTIMEDIA_KEY_EVENT
:
5462 if (event
->code
< ARRAYELTS (lispy_multimedia_keys
)
5463 && event
->code
> 0 && lispy_multimedia_keys
[event
->code
])
5465 return modify_event_symbol (event
->code
, event
->modifiers
,
5466 Qfunction_key
, Qnil
,
5467 lispy_multimedia_keys
, &func_key_syms
,
5468 ARRAYELTS (lispy_multimedia_keys
));
5473 /* A mouse click. Figure out where it is, decide whether it's
5474 a press, click or drag, and build the appropriate structure. */
5475 case MOUSE_CLICK_EVENT
:
5477 case GPM_CLICK_EVENT
:
5479 #ifndef USE_TOOLKIT_SCROLL_BARS
5480 case SCROLL_BAR_CLICK_EVENT
:
5481 case HORIZONTAL_SCROLL_BAR_CLICK_EVENT
:
5484 int button
= event
->code
;
5486 Lisp_Object position
;
5487 Lisp_Object
*start_pos_ptr
;
5488 Lisp_Object start_pos
;
5492 /* Build the position as appropriate for this mouse click. */
5493 if (event
->kind
== MOUSE_CLICK_EVENT
5495 || event
->kind
== GPM_CLICK_EVENT
5499 struct frame
*f
= XFRAME (event
->frame_or_window
);
5502 /* Ignore mouse events that were made on frame that
5503 have been deleted. */
5504 if (! FRAME_LIVE_P (f
))
5507 /* EVENT->x and EVENT->y are frame-relative pixel
5508 coordinates at this place. Under old redisplay, COLUMN
5509 and ROW are set to frame relative glyph coordinates
5510 which are then used to determine whether this click is
5511 in a menu (non-toolkit version). */
5512 if (!toolkit_menubar_in_use (f
))
5514 pixel_to_glyph_coords (f
, XINT (event
->x
), XINT (event
->y
),
5515 &column
, &row
, NULL
, 1);
5517 /* In the non-toolkit version, clicks on the menu bar
5518 are ordinary button events in the event buffer.
5519 Distinguish them, and invoke the menu.
5521 (In the toolkit version, the toolkit handles the
5522 menu bar and Emacs doesn't know about it until
5523 after the user makes a selection.) */
5524 if (row
>= 0 && row
< FRAME_MENU_BAR_LINES (f
)
5525 && (event
->modifiers
& down_modifier
))
5527 Lisp_Object items
, item
;
5529 /* Find the menu bar item under `column'. */
5531 items
= FRAME_MENU_BAR_ITEMS (f
);
5532 for (i
= 0; i
< ASIZE (items
); i
+= 4)
5534 Lisp_Object pos
, string
;
5535 string
= AREF (items
, i
+ 1);
5536 pos
= AREF (items
, i
+ 3);
5539 if (column
>= XINT (pos
)
5540 && column
< XINT (pos
) + SCHARS (string
))
5542 item
= AREF (items
, i
);
5547 /* ELisp manual 2.4b says (x y) are window
5548 relative but code says they are
5550 position
= list4 (event
->frame_or_window
,
5552 Fcons (event
->x
, event
->y
),
5553 make_number (event
->timestamp
));
5555 return list2 (item
, position
);
5559 position
= make_lispy_position (f
, event
->x
, event
->y
,
5562 #ifndef USE_TOOLKIT_SCROLL_BARS
5564 /* It's a scrollbar click. */
5565 position
= make_scroll_bar_position (event
, Qvertical_scroll_bar
);
5566 #endif /* not USE_TOOLKIT_SCROLL_BARS */
5568 if (button
>= ASIZE (button_down_location
))
5570 ptrdiff_t incr
= button
- ASIZE (button_down_location
) + 1;
5571 button_down_location
= larger_vector (button_down_location
,
5573 mouse_syms
= larger_vector (mouse_syms
, incr
, -1);
5576 start_pos_ptr
= aref_addr (button_down_location
, button
);
5577 start_pos
= *start_pos_ptr
;
5578 *start_pos_ptr
= Qnil
;
5581 /* On window-system frames, use the value of
5582 double-click-fuzz as is. On other frames, interpret it
5583 as a multiple of 1/8 characters. */
5587 if (WINDOWP (event
->frame_or_window
))
5588 f
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5589 else if (FRAMEP (event
->frame_or_window
))
5590 f
= XFRAME (event
->frame_or_window
);
5594 if (FRAME_WINDOW_P (f
))
5595 fuzz
= double_click_fuzz
;
5597 fuzz
= double_click_fuzz
/ 8;
5599 is_double
= (button
== last_mouse_button
5600 && (eabs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5601 && (eabs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5602 && button_down_time
!= 0
5603 && (EQ (Vdouble_click_time
, Qt
)
5604 || (NATNUMP (Vdouble_click_time
)
5605 && (event
->timestamp
- button_down_time
5606 < XFASTINT (Vdouble_click_time
)))));
5609 last_mouse_button
= button
;
5610 last_mouse_x
= XINT (event
->x
);
5611 last_mouse_y
= XINT (event
->y
);
5613 /* If this is a button press, squirrel away the location, so
5614 we can decide later whether it was a click or a drag. */
5615 if (event
->modifiers
& down_modifier
)
5619 double_click_count
++;
5620 event
->modifiers
|= ((double_click_count
> 2)
5625 double_click_count
= 1;
5626 button_down_time
= event
->timestamp
;
5627 *start_pos_ptr
= Fcopy_alist (position
);
5628 ignore_mouse_drag_p
= 0;
5631 /* Now we're releasing a button - check the co-ordinates to
5632 see if this was a click or a drag. */
5633 else if (event
->modifiers
& up_modifier
)
5635 /* If we did not see a down before this up, ignore the up.
5636 Probably this happened because the down event chose a
5637 menu item. It would be an annoyance to treat the
5638 release of the button that chose the menu item as a
5641 if (!CONSP (start_pos
))
5644 event
->modifiers
&= ~up_modifier
;
5647 Lisp_Object new_down
, down
;
5648 EMACS_INT xdiff
= double_click_fuzz
, ydiff
= double_click_fuzz
;
5650 /* The third element of every position
5651 should be the (x,y) pair. */
5652 down
= Fcar (Fcdr (Fcdr (start_pos
)));
5653 new_down
= Fcar (Fcdr (Fcdr (position
)));
5656 && INTEGERP (XCAR (down
)) && INTEGERP (XCDR (down
)))
5658 xdiff
= XINT (XCAR (new_down
)) - XINT (XCAR (down
));
5659 ydiff
= XINT (XCDR (new_down
)) - XINT (XCDR (down
));
5662 if (ignore_mouse_drag_p
)
5664 event
->modifiers
|= click_modifier
;
5665 ignore_mouse_drag_p
= 0;
5667 else if (xdiff
< double_click_fuzz
&& xdiff
> - double_click_fuzz
5668 && ydiff
< double_click_fuzz
&& ydiff
> - double_click_fuzz
5669 /* Maybe the mouse has moved a lot, caused scrolling, and
5670 eventually ended up at the same screen position (but
5671 not buffer position) in which case it is a drag, not
5673 /* FIXME: OTOH if the buffer position has changed
5674 because of a timer or process filter rather than
5675 because of mouse movement, it should be considered as
5676 a click. But mouse-drag-region completely ignores
5677 this case and it hasn't caused any real problem, so
5678 it's probably OK to ignore it as well. */
5679 && EQ (Fcar (Fcdr (start_pos
)), Fcar (Fcdr (position
))))
5680 /* Mouse hasn't moved (much). */
5681 event
->modifiers
|= click_modifier
;
5684 button_down_time
= 0;
5685 event
->modifiers
|= drag_modifier
;
5688 /* Don't check is_double; treat this as multiple
5689 if the down-event was multiple. */
5690 if (double_click_count
> 1)
5691 event
->modifiers
|= ((double_click_count
> 2)
5697 /* Every mouse event should either have the down_modifier or
5698 the up_modifier set. */
5702 /* Get the symbol we should use for the mouse click. */
5705 head
= modify_event_symbol (button
,
5707 Qmouse_click
, Vlispy_mouse_stem
,
5710 ASIZE (mouse_syms
));
5711 if (event
->modifiers
& drag_modifier
)
5712 return list3 (head
, start_pos
, position
);
5713 else if (event
->modifiers
& (double_modifier
| triple_modifier
))
5714 return list3 (head
, position
, make_number (double_click_count
));
5716 return list2 (head
, position
);
5721 case HORIZ_WHEEL_EVENT
:
5723 Lisp_Object position
;
5726 /* Build the position as appropriate for this mouse click. */
5727 struct frame
*f
= XFRAME (event
->frame_or_window
);
5729 /* Ignore wheel events that were made on frame that have been
5731 if (! FRAME_LIVE_P (f
))
5734 position
= make_lispy_position (f
, event
->x
, event
->y
,
5737 /* Set double or triple modifiers to indicate the wheel speed. */
5739 /* On window-system frames, use the value of
5740 double-click-fuzz as is. On other frames, interpret it
5741 as a multiple of 1/8 characters. */
5747 if (WINDOWP (event
->frame_or_window
))
5748 fr
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5749 else if (FRAMEP (event
->frame_or_window
))
5750 fr
= XFRAME (event
->frame_or_window
);
5754 fuzz
= FRAME_WINDOW_P (fr
)
5755 ? double_click_fuzz
: double_click_fuzz
/ 8;
5757 if (event
->modifiers
& up_modifier
)
5759 /* Emit a wheel-up event. */
5760 event
->modifiers
&= ~up_modifier
;
5763 else if (event
->modifiers
& down_modifier
)
5765 /* Emit a wheel-down event. */
5766 event
->modifiers
&= ~down_modifier
;
5770 /* Every wheel event should either have the down_modifier or
5771 the up_modifier set. */
5774 if (event
->kind
== HORIZ_WHEEL_EVENT
)
5777 is_double
= (last_mouse_button
== - (1 + symbol_num
)
5778 && (eabs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5779 && (eabs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5780 && button_down_time
!= 0
5781 && (EQ (Vdouble_click_time
, Qt
)
5782 || (NATNUMP (Vdouble_click_time
)
5783 && (event
->timestamp
- button_down_time
5784 < XFASTINT (Vdouble_click_time
)))));
5787 double_click_count
++;
5788 event
->modifiers
|= ((double_click_count
> 2)
5794 double_click_count
= 1;
5795 event
->modifiers
|= click_modifier
;
5798 button_down_time
= event
->timestamp
;
5799 /* Use a negative value to distinguish wheel from mouse button. */
5800 last_mouse_button
= - (1 + symbol_num
);
5801 last_mouse_x
= XINT (event
->x
);
5802 last_mouse_y
= XINT (event
->y
);
5804 /* Get the symbol we should use for the wheel event. */
5805 head
= modify_event_symbol (symbol_num
,
5811 ASIZE (wheel_syms
));
5814 if (event
->modifiers
& (double_modifier
| triple_modifier
))
5815 return list3 (head
, position
, make_number (double_click_count
));
5817 return list2 (head
, position
);
5821 #ifdef USE_TOOLKIT_SCROLL_BARS
5823 /* We don't have down and up events if using toolkit scroll bars,
5824 so make this always a click event. Store in the `part' of
5825 the Lisp event a symbol which maps to the following actions:
5827 `above_handle' page up
5828 `below_handle' page down
5832 `bottom' bottom of buffer
5833 `handle' thumb has been dragged.
5834 `end-scroll' end of interaction with scroll bar
5836 The incoming input_event contains in its `part' member an
5837 index of type `enum scroll_bar_part' which we can use as an
5838 index in scroll_bar_parts to get the appropriate symbol. */
5840 case SCROLL_BAR_CLICK_EVENT
:
5842 Lisp_Object position
, head
;
5844 position
= make_scroll_bar_position (event
, Qvertical_scroll_bar
);
5846 /* Always treat scroll bar events as clicks. */
5847 event
->modifiers
|= click_modifier
;
5848 event
->modifiers
&= ~up_modifier
;
5850 if (event
->code
>= ASIZE (mouse_syms
))
5851 mouse_syms
= larger_vector (mouse_syms
,
5852 event
->code
- ASIZE (mouse_syms
) + 1,
5855 /* Get the symbol we should use for the mouse click. */
5856 head
= modify_event_symbol (event
->code
,
5861 ASIZE (mouse_syms
));
5862 return list2 (head
, position
);
5865 case HORIZONTAL_SCROLL_BAR_CLICK_EVENT
:
5867 Lisp_Object position
, head
;
5869 position
= make_scroll_bar_position (event
, Qhorizontal_scroll_bar
);
5871 /* Always treat scroll bar events as clicks. */
5872 event
->modifiers
|= click_modifier
;
5873 event
->modifiers
&= ~up_modifier
;
5875 if (event
->code
>= ASIZE (mouse_syms
))
5876 mouse_syms
= larger_vector (mouse_syms
,
5877 event
->code
- ASIZE (mouse_syms
) + 1,
5880 /* Get the symbol we should use for the mouse click. */
5881 head
= modify_event_symbol (event
->code
,
5886 ASIZE (mouse_syms
));
5887 return list2 (head
, position
);
5890 #endif /* USE_TOOLKIT_SCROLL_BARS */
5892 case DRAG_N_DROP_EVENT
:
5895 Lisp_Object head
, position
;
5898 f
= XFRAME (event
->frame_or_window
);
5901 /* Ignore mouse events that were made on frames that
5902 have been deleted. */
5903 if (! FRAME_LIVE_P (f
))
5906 position
= make_lispy_position (f
, event
->x
, event
->y
,
5909 head
= modify_event_symbol (0, event
->modifiers
,
5911 lispy_drag_n_drop_names
,
5912 &drag_n_drop_syms
, 1);
5913 return list3 (head
, position
, files
);
5916 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
5917 || defined (HAVE_NS) || defined (USE_GTK)
5918 case MENU_BAR_EVENT
:
5919 if (EQ (event
->arg
, event
->frame_or_window
))
5920 /* This is the prefix key. We translate this to
5921 `(menu_bar)' because the code in keyboard.c for menu
5922 events, which we use, relies on this. */
5923 return list1 (Qmenu_bar
);
5927 case SELECT_WINDOW_EVENT
:
5928 /* Make an event (select-window (WINDOW)). */
5929 return list2 (Qselect_window
, list1 (event
->frame_or_window
));
5931 case TOOL_BAR_EVENT
:
5932 if (EQ (event
->arg
, event
->frame_or_window
))
5933 /* This is the prefix key. We translate this to
5934 `(tool_bar)' because the code in keyboard.c for tool bar
5935 events, which we use, relies on this. */
5936 return list1 (Qtool_bar
);
5937 else if (SYMBOLP (event
->arg
))
5938 return apply_modifiers (event
->modifiers
, event
->arg
);
5941 case USER_SIGNAL_EVENT
:
5942 /* A user signal. */
5944 char *name
= find_user_signal_name (event
->code
);
5947 return intern (name
);
5950 case SAVE_SESSION_EVENT
:
5951 return Qsave_session
;
5956 return Fcons (Qdbus_event
, event
->arg
);
5958 #endif /* HAVE_DBUS */
5960 #ifdef HAVE_XWIDGETS
5963 return Fcons (Qxwidget_event
,event
->arg
);
5968 #if defined HAVE_GFILENOTIFY || defined HAVE_INOTIFY
5969 case FILE_NOTIFY_EVENT
:
5971 return Fcons (Qfile_notify
, event
->arg
);
5973 #endif /* defined HAVE_GFILENOTIFY || defined HAVE_INOTIFY */
5975 case CONFIG_CHANGED_EVENT
:
5976 return list3 (Qconfig_changed_event
,
5977 event
->arg
, event
->frame_or_window
);
5979 /* The 'kind' field of the event is something we don't recognize. */
5986 make_lispy_movement (struct frame
*frame
, Lisp_Object bar_window
, enum scroll_bar_part part
,
5987 Lisp_Object x
, Lisp_Object y
, Time t
)
5989 /* Is it a scroll bar movement? */
5990 if (frame
&& ! NILP (bar_window
))
5992 Lisp_Object part_sym
;
5994 part_sym
= builtin_lisp_symbol (scroll_bar_parts
[part
]);
5995 return list2 (Qscroll_bar_movement
,
5997 Qvertical_scroll_bar
,
6002 /* Or is it an ordinary mouse movement? */
6005 Lisp_Object position
;
6006 position
= make_lispy_position (frame
, x
, y
, t
);
6007 return list2 (Qmouse_movement
, position
);
6011 /* Construct a switch frame event. */
6013 make_lispy_switch_frame (Lisp_Object frame
)
6015 return list2 (Qswitch_frame
, frame
);
6019 make_lispy_focus_in (Lisp_Object frame
)
6021 return list2 (Qfocus_in
, frame
);
6024 #ifdef HAVE_WINDOW_SYSTEM
6027 make_lispy_focus_out (Lisp_Object frame
)
6029 return list2 (Qfocus_out
, frame
);
6032 #endif /* HAVE_WINDOW_SYSTEM */
6034 /* Manipulating modifiers. */
6036 /* Parse the name of SYMBOL, and return the set of modifiers it contains.
6038 If MODIFIER_END is non-zero, set *MODIFIER_END to the position in
6039 SYMBOL's name of the end of the modifiers; the string from this
6040 position is the unmodified symbol name.
6042 This doesn't use any caches. */
6045 parse_modifiers_uncached (Lisp_Object symbol
, ptrdiff_t *modifier_end
)
6051 CHECK_SYMBOL (symbol
);
6054 name
= SYMBOL_NAME (symbol
);
6056 for (i
= 0; i
< SBYTES (name
) - 1; )
6058 ptrdiff_t this_mod_end
= 0;
6061 /* See if the name continues with a modifier word.
6062 Check that the word appears, but don't check what follows it.
6063 Set this_mod and this_mod_end to record what we find. */
6065 switch (SREF (name
, i
))
6067 #define SINGLE_LETTER_MOD(BIT) \
6068 (this_mod_end = i + 1, this_mod = BIT)
6071 SINGLE_LETTER_MOD (alt_modifier
);
6075 SINGLE_LETTER_MOD (ctrl_modifier
);
6079 SINGLE_LETTER_MOD (hyper_modifier
);
6083 SINGLE_LETTER_MOD (meta_modifier
);
6087 SINGLE_LETTER_MOD (shift_modifier
);
6091 SINGLE_LETTER_MOD (super_modifier
);
6094 #undef SINGLE_LETTER_MOD
6096 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6097 if (i + LEN + 1 <= SBYTES (name) \
6098 && ! memcmp (SDATA (name) + i, NAME, LEN)) \
6100 this_mod_end = i + LEN; \
6105 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
6106 MULTI_LETTER_MOD (down_modifier
, "down", 4);
6107 MULTI_LETTER_MOD (double_modifier
, "double", 6);
6111 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
6115 MULTI_LETTER_MOD (up_modifier
, "up", 2);
6117 #undef MULTI_LETTER_MOD
6121 /* If we found no modifier, stop looking for them. */
6122 if (this_mod_end
== 0)
6125 /* Check there is a dash after the modifier, so that it
6126 really is a modifier. */
6127 if (this_mod_end
>= SBYTES (name
)
6128 || SREF (name
, this_mod_end
) != '-')
6131 /* This modifier is real; look for another. */
6132 modifiers
|= this_mod
;
6133 i
= this_mod_end
+ 1;
6136 /* Should we include the `click' modifier? */
6137 if (! (modifiers
& (down_modifier
| drag_modifier
6138 | double_modifier
| triple_modifier
))
6139 && i
+ 7 == SBYTES (name
)
6140 && memcmp (SDATA (name
) + i
, "mouse-", 6) == 0
6141 && ('0' <= SREF (name
, i
+ 6) && SREF (name
, i
+ 6) <= '9'))
6142 modifiers
|= click_modifier
;
6144 if (! (modifiers
& (double_modifier
| triple_modifier
))
6145 && i
+ 6 < SBYTES (name
)
6146 && memcmp (SDATA (name
) + i
, "wheel-", 6) == 0)
6147 modifiers
|= click_modifier
;
6155 /* Return a symbol whose name is the modifier prefixes for MODIFIERS
6156 prepended to the string BASE[0..BASE_LEN-1].
6157 This doesn't use any caches. */
6159 apply_modifiers_uncached (int modifiers
, char *base
, int base_len
, int base_len_byte
)
6161 /* Since BASE could contain nulls, we can't use intern here; we have
6162 to use Fintern, which expects a genuine Lisp_String, and keeps a
6164 char new_mods
[sizeof "A-C-H-M-S-s-up-down-drag-double-triple-"];
6170 /* Mouse events should not exhibit the `up' modifier once they
6171 leave the event queue only accessible to C code; `up' will
6172 always be turned into a click or drag event before being
6173 presented to lisp code. But since lisp events can be
6174 synthesized bypassing the event queue and pushed into
6175 `unread-command-events' or its companions, it's better to just
6176 deal with unexpected modifier combinations. */
6178 if (modifiers
& alt_modifier
) { *p
++ = 'A'; *p
++ = '-'; }
6179 if (modifiers
& ctrl_modifier
) { *p
++ = 'C'; *p
++ = '-'; }
6180 if (modifiers
& hyper_modifier
) { *p
++ = 'H'; *p
++ = '-'; }
6181 if (modifiers
& meta_modifier
) { *p
++ = 'M'; *p
++ = '-'; }
6182 if (modifiers
& shift_modifier
) { *p
++ = 'S'; *p
++ = '-'; }
6183 if (modifiers
& super_modifier
) { *p
++ = 's'; *p
++ = '-'; }
6184 if (modifiers
& double_modifier
) p
= stpcpy (p
, "double-");
6185 if (modifiers
& triple_modifier
) p
= stpcpy (p
, "triple-");
6186 if (modifiers
& up_modifier
) p
= stpcpy (p
, "up-");
6187 if (modifiers
& down_modifier
) p
= stpcpy (p
, "down-");
6188 if (modifiers
& drag_modifier
) p
= stpcpy (p
, "drag-");
6189 /* The click modifier is denoted by the absence of other modifiers. */
6193 mod_len
= p
- new_mods
;
6197 Lisp_Object new_name
;
6199 new_name
= make_uninit_multibyte_string (mod_len
+ base_len
,
6200 mod_len
+ base_len_byte
);
6201 memcpy (SDATA (new_name
), new_mods
, mod_len
);
6202 memcpy (SDATA (new_name
) + mod_len
, base
, base_len_byte
);
6204 return Fintern (new_name
, Qnil
);
6209 static const char *const modifier_names
[] =
6211 "up", "down", "drag", "click", "double", "triple", 0, 0,
6212 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
6213 0, 0, "alt", "super", "hyper", "shift", "control", "meta"
6215 #define NUM_MOD_NAMES ARRAYELTS (modifier_names)
6217 static Lisp_Object modifier_symbols
;
6219 /* Return the list of modifier symbols corresponding to the mask MODIFIERS. */
6221 lispy_modifier_list (int modifiers
)
6223 Lisp_Object modifier_list
;
6226 modifier_list
= Qnil
;
6227 for (i
= 0; (1<<i
) <= modifiers
&& i
< NUM_MOD_NAMES
; i
++)
6228 if (modifiers
& (1<<i
))
6229 modifier_list
= Fcons (AREF (modifier_symbols
, i
),
6232 return modifier_list
;
6236 /* Parse the modifiers on SYMBOL, and return a list like (UNMODIFIED MASK),
6237 where UNMODIFIED is the unmodified form of SYMBOL,
6238 MASK is the set of modifiers present in SYMBOL's name.
6239 This is similar to parse_modifiers_uncached, but uses the cache in
6240 SYMBOL's Qevent_symbol_element_mask property, and maintains the
6241 Qevent_symbol_elements property. */
6243 #define KEY_TO_CHAR(k) (XINT (k) & ((1 << CHARACTERBITS) - 1))
6246 parse_modifiers (Lisp_Object symbol
)
6248 Lisp_Object elements
;
6250 if (INTEGERP (symbol
))
6251 return list2i (KEY_TO_CHAR (symbol
), XINT (symbol
) & CHAR_MODIFIER_MASK
);
6252 else if (!SYMBOLP (symbol
))
6255 elements
= Fget (symbol
, Qevent_symbol_element_mask
);
6256 if (CONSP (elements
))
6261 int modifiers
= parse_modifiers_uncached (symbol
, &end
);
6262 Lisp_Object unmodified
;
6265 unmodified
= Fintern (make_string (SSDATA (SYMBOL_NAME (symbol
)) + end
,
6266 SBYTES (SYMBOL_NAME (symbol
)) - end
),
6269 if (modifiers
& ~INTMASK
)
6271 XSETFASTINT (mask
, modifiers
);
6272 elements
= list2 (unmodified
, mask
);
6274 /* Cache the parsing results on SYMBOL. */
6275 Fput (symbol
, Qevent_symbol_element_mask
,
6277 Fput (symbol
, Qevent_symbol_elements
,
6278 Fcons (unmodified
, lispy_modifier_list (modifiers
)));
6280 /* Since we know that SYMBOL is modifiers applied to unmodified,
6281 it would be nice to put that in unmodified's cache.
6282 But we can't, since we're not sure that parse_modifiers is
6289 DEFUN ("internal-event-symbol-parse-modifiers", Fevent_symbol_parse_modifiers
,
6290 Sevent_symbol_parse_modifiers
, 1, 1, 0,
6291 doc
: /* Parse the event symbol. For internal use. */)
6292 (Lisp_Object symbol
)
6294 /* Fill the cache if needed. */
6295 parse_modifiers (symbol
);
6296 /* Ignore the result (which is stored on Qevent_symbol_element_mask)
6297 and use the Lispier representation stored on Qevent_symbol_elements
6299 return Fget (symbol
, Qevent_symbol_elements
);
6302 /* Apply the modifiers MODIFIERS to the symbol BASE.
6303 BASE must be unmodified.
6305 This is like apply_modifiers_uncached, but uses BASE's
6306 Qmodifier_cache property, if present.
6308 apply_modifiers copies the value of BASE's Qevent_kind property to
6309 the modified symbol. */
6311 apply_modifiers (int modifiers
, Lisp_Object base
)
6313 Lisp_Object cache
, idx
, entry
, new_symbol
;
6315 /* Mask out upper bits. We don't know where this value's been. */
6316 modifiers
&= INTMASK
;
6318 if (INTEGERP (base
))
6319 return make_number (XINT (base
) | modifiers
);
6321 /* The click modifier never figures into cache indices. */
6322 cache
= Fget (base
, Qmodifier_cache
);
6323 XSETFASTINT (idx
, (modifiers
& ~click_modifier
));
6324 entry
= assq_no_quit (idx
, cache
);
6327 new_symbol
= XCDR (entry
);
6330 /* We have to create the symbol ourselves. */
6331 new_symbol
= apply_modifiers_uncached (modifiers
,
6332 SSDATA (SYMBOL_NAME (base
)),
6333 SCHARS (SYMBOL_NAME (base
)),
6334 SBYTES (SYMBOL_NAME (base
)));
6336 /* Add the new symbol to the base's cache. */
6337 entry
= Fcons (idx
, new_symbol
);
6338 Fput (base
, Qmodifier_cache
, Fcons (entry
, cache
));
6340 /* We have the parsing info now for free, so we could add it to
6342 XSETFASTINT (idx, modifiers);
6343 Fput (new_symbol, Qevent_symbol_element_mask,
6345 Fput (new_symbol, Qevent_symbol_elements,
6346 Fcons (base, lispy_modifier_list (modifiers)));
6347 Sadly, this is only correct if `base' is indeed a base event,
6348 which is not necessarily the case. -stef */
6351 /* Make sure this symbol is of the same kind as BASE.
6353 You'd think we could just set this once and for all when we
6354 intern the symbol above, but reorder_modifiers may call us when
6355 BASE's property isn't set right; we can't assume that just
6356 because it has a Qmodifier_cache property it must have its
6357 Qevent_kind set right as well. */
6358 if (NILP (Fget (new_symbol
, Qevent_kind
)))
6362 kind
= Fget (base
, Qevent_kind
);
6364 Fput (new_symbol
, Qevent_kind
, kind
);
6371 /* Given a symbol whose name begins with modifiers ("C-", "M-", etc),
6372 return a symbol with the modifiers placed in the canonical order.
6373 Canonical order is alphabetical, except for down and drag, which
6374 always come last. The 'click' modifier is never written out.
6376 Fdefine_key calls this to make sure that (for example) C-M-foo
6377 and M-C-foo end up being equivalent in the keymap. */
6380 reorder_modifiers (Lisp_Object symbol
)
6382 /* It's hopefully okay to write the code this way, since everything
6383 will soon be in caches, and no consing will be done at all. */
6386 parsed
= parse_modifiers (symbol
);
6387 return apply_modifiers (XFASTINT (XCAR (XCDR (parsed
))),
6392 /* For handling events, we often want to produce a symbol whose name
6393 is a series of modifier key prefixes ("M-", "C-", etcetera) attached
6394 to some base, like the name of a function key or mouse button.
6395 modify_event_symbol produces symbols of this sort.
6397 NAME_TABLE should point to an array of strings, such that NAME_TABLE[i]
6398 is the name of the i'th symbol. TABLE_SIZE is the number of elements
6401 Alternatively, NAME_ALIST_OR_STEM is either an alist mapping codes
6402 into symbol names, or a string specifying a name stem used to
6403 construct a symbol name or the form `STEM-N', where N is the decimal
6404 representation of SYMBOL_NUM. NAME_ALIST_OR_STEM is used if it is
6405 non-nil; otherwise NAME_TABLE is used.
6407 SYMBOL_TABLE should be a pointer to a Lisp_Object whose value will
6408 persist between calls to modify_event_symbol that it can use to
6409 store a cache of the symbols it's generated for this NAME_TABLE
6410 before. The object stored there may be a vector or an alist.
6412 SYMBOL_NUM is the number of the base name we want from NAME_TABLE.
6414 MODIFIERS is a set of modifier bits (as given in struct input_events)
6415 whose prefixes should be applied to the symbol name.
6417 SYMBOL_KIND is the value to be placed in the event_kind property of
6418 the returned symbol.
6420 The symbols we create are supposed to have an
6421 `event-symbol-elements' property, which lists the modifiers present
6422 in the symbol's name. */
6425 modify_event_symbol (ptrdiff_t symbol_num
, int modifiers
, Lisp_Object symbol_kind
,
6426 Lisp_Object name_alist_or_stem
, const char *const *name_table
,
6427 Lisp_Object
*symbol_table
, ptrdiff_t table_size
)
6430 Lisp_Object symbol_int
;
6432 /* Get rid of the "vendor-specific" bit here. */
6433 XSETINT (symbol_int
, symbol_num
& 0xffffff);
6435 /* Is this a request for a valid symbol? */
6436 if (symbol_num
< 0 || symbol_num
>= table_size
)
6439 if (CONSP (*symbol_table
))
6440 value
= Fcdr (assq_no_quit (symbol_int
, *symbol_table
));
6442 /* If *symbol_table doesn't seem to be initialized properly, fix that.
6443 *symbol_table should be a lisp vector TABLE_SIZE elements long,
6444 where the Nth element is the symbol for NAME_TABLE[N], or nil if
6445 we've never used that symbol before. */
6448 if (! VECTORP (*symbol_table
)
6449 || ASIZE (*symbol_table
) != table_size
)
6453 XSETFASTINT (size
, table_size
);
6454 *symbol_table
= Fmake_vector (size
, Qnil
);
6457 value
= AREF (*symbol_table
, symbol_num
);
6460 /* Have we already used this symbol before? */
6463 /* No; let's create it. */
6464 if (CONSP (name_alist_or_stem
))
6465 value
= Fcdr_safe (Fassq (symbol_int
, name_alist_or_stem
));
6466 else if (STRINGP (name_alist_or_stem
))
6469 ptrdiff_t len
= (SBYTES (name_alist_or_stem
)
6470 + sizeof "-" + INT_STRLEN_BOUND (EMACS_INT
));
6472 buf
= SAFE_ALLOCA (len
);
6473 esprintf (buf
, "%s-%"pI
"d", SDATA (name_alist_or_stem
),
6474 XINT (symbol_int
) + 1);
6475 value
= intern (buf
);
6478 else if (name_table
!= 0 && name_table
[symbol_num
])
6479 value
= intern (name_table
[symbol_num
]);
6481 #ifdef HAVE_WINDOW_SYSTEM
6484 char *name
= x_get_keysym_name (symbol_num
);
6486 value
= intern (name
);
6492 char buf
[sizeof "key-" + INT_STRLEN_BOUND (EMACS_INT
)];
6493 sprintf (buf
, "key-%"pD
"d", symbol_num
);
6494 value
= intern (buf
);
6497 if (CONSP (*symbol_table
))
6498 *symbol_table
= Fcons (Fcons (symbol_int
, value
), *symbol_table
);
6500 ASET (*symbol_table
, symbol_num
, value
);
6502 /* Fill in the cache entries for this symbol; this also
6503 builds the Qevent_symbol_elements property, which the user
6505 apply_modifiers (modifiers
& click_modifier
, value
);
6506 Fput (value
, Qevent_kind
, symbol_kind
);
6509 /* Apply modifiers to that symbol. */
6510 return apply_modifiers (modifiers
, value
);
6513 /* Convert a list that represents an event type,
6514 such as (ctrl meta backspace), into the usual representation of that
6515 event type as a number or a symbol. */
6517 DEFUN ("event-convert-list", Fevent_convert_list
, Sevent_convert_list
, 1, 1, 0,
6518 doc
: /* Convert the event description list EVENT-DESC to an event type.
6519 EVENT-DESC should contain one base event type (a character or symbol)
6520 and zero or more modifier names (control, meta, hyper, super, shift, alt,
6521 drag, down, double or triple). The base must be last.
6522 The return value is an event type (a character or symbol) which
6523 has the same base event type and all the specified modifiers. */)
6524 (Lisp_Object event_desc
)
6532 while (CONSP (rest
))
6540 /* Given a symbol, see if it is a modifier name. */
6541 if (SYMBOLP (elt
) && CONSP (rest
))
6542 this = parse_solitary_modifier (elt
);
6546 else if (!NILP (base
))
6547 error ("Two bases given in one event");
6553 /* Let the symbol A refer to the character A. */
6554 if (SYMBOLP (base
) && SCHARS (SYMBOL_NAME (base
)) == 1)
6555 XSETINT (base
, SREF (SYMBOL_NAME (base
), 0));
6557 if (INTEGERP (base
))
6559 /* Turn (shift a) into A. */
6560 if ((modifiers
& shift_modifier
) != 0
6561 && (XINT (base
) >= 'a' && XINT (base
) <= 'z'))
6563 XSETINT (base
, XINT (base
) - ('a' - 'A'));
6564 modifiers
&= ~shift_modifier
;
6567 /* Turn (control a) into C-a. */
6568 if (modifiers
& ctrl_modifier
)
6569 return make_number ((modifiers
& ~ctrl_modifier
)
6570 | make_ctrl_char (XINT (base
)));
6572 return make_number (modifiers
| XINT (base
));
6574 else if (SYMBOLP (base
))
6575 return apply_modifiers (modifiers
, base
);
6577 error ("Invalid base event");
6580 /* Try to recognize SYMBOL as a modifier name.
6581 Return the modifier flag bit, or 0 if not recognized. */
6584 parse_solitary_modifier (Lisp_Object symbol
)
6586 Lisp_Object name
= SYMBOL_NAME (symbol
);
6588 switch (SREF (name
, 0))
6590 #define SINGLE_LETTER_MOD(BIT) \
6591 if (SBYTES (name) == 1) \
6594 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6595 if (LEN == SBYTES (name) \
6596 && ! memcmp (SDATA (name), NAME, LEN)) \
6600 SINGLE_LETTER_MOD (alt_modifier
);
6604 MULTI_LETTER_MOD (alt_modifier
, "alt", 3);
6608 SINGLE_LETTER_MOD (ctrl_modifier
);
6612 MULTI_LETTER_MOD (ctrl_modifier
, "ctrl", 4);
6613 MULTI_LETTER_MOD (ctrl_modifier
, "control", 7);
6617 SINGLE_LETTER_MOD (hyper_modifier
);
6621 MULTI_LETTER_MOD (hyper_modifier
, "hyper", 5);
6625 SINGLE_LETTER_MOD (meta_modifier
);
6629 MULTI_LETTER_MOD (meta_modifier
, "meta", 4);
6633 SINGLE_LETTER_MOD (shift_modifier
);
6637 MULTI_LETTER_MOD (shift_modifier
, "shift", 5);
6638 MULTI_LETTER_MOD (super_modifier
, "super", 5);
6639 SINGLE_LETTER_MOD (super_modifier
);
6643 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
6644 MULTI_LETTER_MOD (down_modifier
, "down", 4);
6645 MULTI_LETTER_MOD (double_modifier
, "double", 6);
6649 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
6653 MULTI_LETTER_MOD (up_modifier
, "up", 2);
6656 #undef SINGLE_LETTER_MOD
6657 #undef MULTI_LETTER_MOD
6663 /* Return true if EVENT is a list whose elements are all integers or symbols.
6664 Such a list is not valid as an event,
6665 but it can be a Lucid-style event type list. */
6668 lucid_event_type_list_p (Lisp_Object object
)
6672 if (! CONSP (object
))
6675 if (EQ (XCAR (object
), Qhelp_echo
)
6676 || EQ (XCAR (object
), Qvertical_line
)
6677 || EQ (XCAR (object
), Qmode_line
)
6678 || EQ (XCAR (object
), Qheader_line
))
6681 for (tail
= object
; CONSP (tail
); tail
= XCDR (tail
))
6685 if (! (INTEGERP (elt
) || SYMBOLP (elt
)))
6692 /* Return true if terminal input chars are available.
6693 Also, store the return value into INPUT_PENDING.
6695 Serves the purpose of ioctl (0, FIONREAD, ...)
6696 but works even if FIONREAD does not exist.
6697 (In fact, this may actually read some input.)
6699 If READABLE_EVENTS_DO_TIMERS_NOW is set in FLAGS, actually run
6700 timer events that are ripe.
6701 If READABLE_EVENTS_FILTER_EVENTS is set in FLAGS, ignore internal
6702 events (FOCUS_IN_EVENT).
6703 If READABLE_EVENTS_IGNORE_SQUEEZABLES is set in FLAGS, ignore mouse
6704 movements and toolkit scroll bar thumb drags. */
6707 get_input_pending (int flags
)
6709 /* First of all, have we already counted some input? */
6710 input_pending
= (!NILP (Vquit_flag
) || readable_events (flags
));
6712 /* If input is being read as it arrives, and we have none, there is none. */
6713 if (!input_pending
&& (!interrupt_input
|| interrupts_deferred
))
6715 /* Try to read some input and see how much we get. */
6717 input_pending
= (!NILP (Vquit_flag
) || readable_events (flags
));
6720 return input_pending
;
6723 /* Put a BUFFER_SWITCH_EVENT in the buffer
6724 so that read_key_sequence will notice the new current buffer. */
6727 record_asynch_buffer_change (void)
6729 /* We don't need a buffer-switch event unless Emacs is waiting for input.
6730 The purpose of the event is to make read_key_sequence look up the
6731 keymaps again. If we aren't in read_key_sequence, we don't need one,
6732 and the event could cause trouble by messing up (input-pending-p).
6733 Note: Fwaiting_for_user_input_p always returns nil when async
6734 subprocesses aren't supported. */
6735 if (!NILP (Fwaiting_for_user_input_p ()))
6737 struct input_event event
;
6740 event
.kind
= BUFFER_SWITCH_EVENT
;
6741 event
.frame_or_window
= Qnil
;
6744 /* Make sure no interrupt happens while storing the event. */
6746 if (interrupt_input
)
6747 kbd_buffer_store_event (&event
);
6752 kbd_buffer_store_event (&event
);
6758 /* Read any terminal input already buffered up by the system
6759 into the kbd_buffer, but do not wait.
6761 Return the number of keyboard chars read, or -1 meaning
6762 this is a bad time to try to read input. */
6771 /* Store pending user signal events, if any. */
6772 store_user_signal_events ();
6774 /* Loop through the available terminals, and call their input hooks. */
6778 struct terminal
*next
= t
->next_terminal
;
6780 if (t
->read_socket_hook
)
6783 struct input_event hold_quit
;
6785 if (input_blocked_p ())
6787 pending_signals
= true;
6791 EVENT_INIT (hold_quit
);
6792 hold_quit
.kind
= NO_EVENT
;
6794 /* No need for FIONREAD or fcntl; just say don't wait. */
6795 while ((nr
= (*t
->read_socket_hook
) (t
, &hold_quit
)) > 0)
6798 if (nr
== -1) /* Not OK to read input now. */
6802 else if (nr
== -2) /* Non-transient error. */
6804 /* The terminal device terminated; it should be closed. */
6806 /* Kill Emacs if this was our last terminal. */
6807 if (!terminal_list
->next_terminal
)
6808 /* Formerly simply reported no input, but that
6809 sometimes led to a failure of Emacs to terminate.
6810 SIGHUP seems appropriate if we can't reach the
6812 /* ??? Is it really right to send the signal just to
6813 this process rather than to the whole process
6814 group? Perhaps on systems with FIONREAD Emacs is
6815 alone in its group. */
6816 terminate_due_to_signal (SIGHUP
, 10);
6818 /* XXX Is calling delete_terminal safe here? It calls delete_frame. */
6821 XSETTERMINAL (tmp
, t
);
6822 Fdelete_terminal (tmp
, Qnoelisp
);
6826 /* If there was no error, make sure the pointer
6827 is visible for all frames on this terminal. */
6830 Lisp_Object tail
, frame
;
6832 FOR_EACH_FRAME (tail
, frame
)
6834 struct frame
*f
= XFRAME (frame
);
6835 if (FRAME_TERMINAL (f
) == t
)
6836 frame_make_pointer_visible (f
);
6840 if (hold_quit
.kind
!= NO_EVENT
)
6841 kbd_buffer_store_event (&hold_quit
);
6853 /* This is the tty way of reading available input.
6855 Note that each terminal device has its own `struct terminal' object,
6856 and so this function is called once for each individual termcap
6857 terminal. The first parameter indicates which terminal to read from. */
6860 tty_read_avail_input (struct terminal
*terminal
,
6861 struct input_event
*hold_quit
)
6863 /* Using KBD_BUFFER_SIZE - 1 here avoids reading more than
6864 the kbd_buffer can really hold. That may prevent loss
6865 of characters on some systems when input is stuffed at us. */
6866 unsigned char cbuf
[KBD_BUFFER_SIZE
- 1];
6868 struct tty_display_info
*tty
= terminal
->display_info
.tty
;
6871 int buffer_free
= KBD_BUFFER_SIZE
- kbd_buffer_nr_stored () - 1;
6873 if (kbd_on_hold_p () || buffer_free
<= 0)
6875 #endif /* subprocesses */
6877 if (!terminal
->name
) /* Don't read from a dead terminal. */
6880 if (terminal
->type
!= output_termcap
6881 && terminal
->type
!= output_msdos_raw
)
6884 /* XXX I think the following code should be moved to separate hook
6885 functions in system-dependent files. */
6887 /* FIXME: AFAIK, tty_read_avail_input is not used under w32 since the non-GUI
6888 code sets read_socket_hook to w32_console_read_socket instead! */
6890 #else /* not WINDOWSNT */
6891 if (! tty
->term_initted
) /* In case we get called during bootstrap. */
6895 return 0; /* The terminal is suspended. */
6898 n_to_read
= dos_keysns ();
6902 cbuf
[0] = dos_keyread ();
6905 #else /* not MSDOS */
6910 struct input_event gpm_hold_quit
;
6911 int gpm
, fd
= gpm_fd
;
6913 EVENT_INIT (gpm_hold_quit
);
6914 gpm_hold_quit
.kind
= NO_EVENT
;
6916 /* gpm==1 if event received.
6917 gpm==0 if the GPM daemon has closed the connection, in which case
6918 Gpm_GetEvent closes gpm_fd and clears it to -1, which is why
6919 we save it in `fd' so close_gpm can remove it from the
6921 gpm==-1 if a protocol error or EWOULDBLOCK; the latter is normal. */
6922 while (gpm
= Gpm_GetEvent (&event
), gpm
== 1) {
6923 nread
+= handle_one_term_event (tty
, &event
, &gpm_hold_quit
);
6926 /* Presumably the GPM daemon has closed the connection. */
6928 if (gpm_hold_quit
.kind
!= NO_EVENT
)
6929 kbd_buffer_store_event (&gpm_hold_quit
);
6933 #endif /* HAVE_GPM */
6935 /* Determine how many characters we should *try* to read. */
6936 #ifdef USABLE_FIONREAD
6937 /* Find out how much input is available. */
6938 if (ioctl (fileno (tty
->input
), FIONREAD
, &n_to_read
) < 0)
6940 if (! noninteractive
)
6941 return -2; /* Close this terminal. */
6947 if (n_to_read
> sizeof cbuf
)
6948 n_to_read
= sizeof cbuf
;
6949 #elif defined USG || defined CYGWIN
6950 /* Read some input if available, but don't wait. */
6951 n_to_read
= sizeof cbuf
;
6952 fcntl (fileno (tty
->input
), F_SETFL
, O_NONBLOCK
);
6954 # error "Cannot read without possibly delaying"
6958 /* Don't read more than we can store. */
6959 if (n_to_read
> buffer_free
)
6960 n_to_read
= buffer_free
;
6961 #endif /* subprocesses */
6963 /* Now read; for one reason or another, this will not block.
6964 NREAD is set to the number of chars read. */
6967 nread
= emacs_read (fileno (tty
->input
), (char *) cbuf
, n_to_read
);
6968 /* POSIX infers that processes which are not in the session leader's
6969 process group won't get SIGHUPs at logout time. BSDI adheres to
6970 this part standard and returns -1 from read (0) with errno==EIO
6971 when the control tty is taken away.
6972 Jeffrey Honig <jch@bsdi.com> says this is generally safe. */
6973 if (nread
== -1 && errno
== EIO
)
6974 return -2; /* Close this terminal. */
6975 #if defined (AIX) && defined (_BSD)
6976 /* The kernel sometimes fails to deliver SIGHUP for ptys.
6977 This looks incorrect, but it isn't, because _BSD causes
6978 O_NDELAY to be defined in fcntl.h as O_NONBLOCK,
6979 and that causes a value other than 0 when there is no input. */
6981 return -2; /* Close this terminal. */
6985 /* We used to retry the read if it was interrupted.
6986 But this does the wrong thing when O_NONBLOCK causes
6987 an EAGAIN error. Does anybody know of a situation
6988 where a retry is actually needed? */
6990 nread
< 0 && (errno
== EAGAIN
|| errno
== EFAULT
7000 #ifndef USABLE_FIONREAD
7001 #if defined (USG) || defined (CYGWIN)
7002 fcntl (fileno (tty
->input
), F_SETFL
, 0);
7003 #endif /* USG or CYGWIN */
7004 #endif /* no FIONREAD */
7009 #endif /* not MSDOS */
7010 #endif /* not WINDOWSNT */
7012 for (i
= 0; i
< nread
; i
++)
7014 struct input_event buf
;
7016 buf
.kind
= ASCII_KEYSTROKE_EVENT
;
7018 if (tty
->meta_key
== 1 && (cbuf
[i
] & 0x80))
7019 buf
.modifiers
= meta_modifier
;
7020 if (tty
->meta_key
!= 2)
7024 /* Set the frame corresponding to the active tty. Note that the
7025 value of selected_frame is not reliable here, redisplay tends
7026 to temporarily change it. */
7027 buf
.frame_or_window
= tty
->top_frame
;
7030 kbd_buffer_store_event (&buf
);
7031 /* Don't look at input that follows a C-g too closely.
7032 This reduces lossage due to autorepeat on C-g. */
7033 if (buf
.kind
== ASCII_KEYSTROKE_EVENT
7034 && buf
.code
== quit_char
)
7042 handle_async_input (void)
7047 int nread
= gobble_input ();
7048 /* -1 means it's not ok to read the input now.
7049 UNBLOCK_INPUT will read it later; now, avoid infinite loop.
7050 0 means there was no keyboard input available. */
7058 process_pending_signals (void)
7060 pending_signals
= false;
7061 handle_async_input ();
7062 do_pending_atimers ();
7065 /* Undo any number of BLOCK_INPUT calls down to level LEVEL,
7066 and reinvoke any pending signal if the level is now 0 and
7067 a fatal error is not already in progress. */
7070 unblock_input_to (int level
)
7072 interrupt_input_blocked
= level
;
7075 if (pending_signals
&& !fatal_error_in_progress
)
7076 process_pending_signals ();
7082 /* End critical section.
7084 If doing signal-driven input, and a signal came in when input was
7085 blocked, reinvoke the signal handler now to deal with it.
7087 It will also process queued input, if it was not read before.
7088 When a longer code sequence does not use block/unblock input
7089 at all, the whole input gathered up to the next call to
7090 unblock_input will be processed inside that call. */
7093 unblock_input (void)
7095 unblock_input_to (interrupt_input_blocked
- 1);
7098 /* Undo any number of BLOCK_INPUT calls,
7099 and also reinvoke any pending signal. */
7102 totally_unblock_input (void)
7104 unblock_input_to (0);
7110 handle_input_available_signal (int sig
)
7112 pending_signals
= true;
7114 if (input_available_clear_time
)
7115 *input_available_clear_time
= make_timespec (0, 0);
7119 deliver_input_available_signal (int sig
)
7121 deliver_process_signal (sig
, handle_input_available_signal
);
7123 #endif /* USABLE_SIGIO */
7126 /* User signal events. */
7128 struct user_signal_info
7130 /* Signal number. */
7133 /* Name of the signal. */
7136 /* Number of pending signals. */
7139 struct user_signal_info
*next
;
7142 /* List of user signals. */
7143 static struct user_signal_info
*user_signals
= NULL
;
7145 /* Function called when handling user signals. */
7146 void (*handle_user_signal_hook
) (int);
7149 add_user_signal (int sig
, const char *name
)
7151 struct sigaction action
;
7152 struct user_signal_info
*p
;
7154 for (p
= user_signals
; p
; p
= p
->next
)
7156 /* Already added. */
7159 p
= xmalloc (sizeof *p
);
7161 p
->name
= xstrdup (name
);
7163 p
->next
= user_signals
;
7166 emacs_sigaction_init (&action
, deliver_user_signal
);
7167 sigaction (sig
, &action
, 0);
7171 handle_user_signal (int sig
)
7173 struct user_signal_info
*p
;
7174 const char *special_event_name
= NULL
;
7176 if (SYMBOLP (Vdebug_on_event
))
7177 special_event_name
= SSDATA (SYMBOL_NAME (Vdebug_on_event
));
7179 for (p
= user_signals
; p
; p
= p
->next
)
7182 if (special_event_name
7183 && strcmp (special_event_name
, p
->name
) == 0)
7185 /* Enter the debugger in many ways. */
7186 debug_on_next_call
= true;
7187 debug_on_quit
= true;
7189 Vinhibit_quit
= Qnil
;
7191 /* Eat the event. */
7196 if (handle_user_signal_hook
)
7197 (*handle_user_signal_hook
) (sig
);
7199 if (interrupt_input
)
7200 handle_input_available_signal (sig
);
7204 /* Tell wait_reading_process_output that it needs to wake
7205 up and look around. */
7206 if (input_available_clear_time
)
7207 *input_available_clear_time
= make_timespec (0, 0);
7214 deliver_user_signal (int sig
)
7216 deliver_process_signal (sig
, handle_user_signal
);
7220 find_user_signal_name (int sig
)
7222 struct user_signal_info
*p
;
7224 for (p
= user_signals
; p
; p
= p
->next
)
7232 store_user_signal_events (void)
7234 struct user_signal_info
*p
;
7235 struct input_event buf
;
7236 bool buf_initialized
= false;
7238 for (p
= user_signals
; p
; p
= p
->next
)
7239 if (p
->npending
> 0)
7241 if (! buf_initialized
)
7243 memset (&buf
, 0, sizeof buf
);
7244 buf
.kind
= USER_SIGNAL_EVENT
;
7245 buf
.frame_or_window
= selected_frame
;
7246 buf_initialized
= true;
7252 kbd_buffer_store_event (&buf
);
7255 while (p
->npending
> 0);
7260 static void menu_bar_item (Lisp_Object
, Lisp_Object
, Lisp_Object
, void *);
7261 static Lisp_Object menu_bar_one_keymap_changed_items
;
7263 /* These variables hold the vector under construction within
7264 menu_bar_items and its subroutines, and the current index
7265 for storing into that vector. */
7266 static Lisp_Object menu_bar_items_vector
;
7267 static int menu_bar_items_index
;
7270 static const char *separator_names
[] = {
7275 "single-dashed-line",
7276 "double-dashed-line",
7278 "shadow-etched-out",
7279 "shadow-etched-in-dash",
7280 "shadow-etched-out-dash",
7281 "shadow-double-etched-in",
7282 "shadow-double-etched-out",
7283 "shadow-double-etched-in-dash",
7284 "shadow-double-etched-out-dash",
7288 /* Return true if LABEL specifies a separator. */
7291 menu_separator_name_p (const char *label
)
7295 else if (strlen (label
) > 3
7296 && memcmp (label
, "--", 2) == 0
7301 for (i
= 0; separator_names
[i
]; ++i
)
7302 if (strcmp (label
, separator_names
[i
]) == 0)
7307 /* It's a separator if it contains only dashes. */
7308 while (*label
== '-')
7310 return (*label
== 0);
7317 /* Return a vector of menu items for a menu bar, appropriate
7318 to the current buffer. Each item has three elements in the vector:
7321 OLD is an old vector we can optionally reuse, or nil. */
7324 menu_bar_items (Lisp_Object old
)
7326 /* The number of keymaps we're scanning right now, and the number of
7327 keymaps we have allocated space for. */
7330 /* maps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
7331 in the current keymaps, or nil where it is not a prefix. */
7334 Lisp_Object mapsbuf
[3];
7335 Lisp_Object def
, tail
;
7342 /* In order to build the menus, we need to call the keymap
7343 accessors. They all call QUIT. But this function is called
7344 during redisplay, during which a quit is fatal. So inhibit
7345 quitting while building the menus.
7346 We do this instead of specbind because (1) errors will clear it anyway
7347 and (2) this avoids risk of specpdl overflow. */
7348 oquit
= Vinhibit_quit
;
7352 menu_bar_items_vector
= old
;
7354 menu_bar_items_vector
= Fmake_vector (make_number (24), Qnil
);
7355 menu_bar_items_index
= 0;
7357 /* Build our list of keymaps.
7358 If we recognize a function key and replace its escape sequence in
7359 keybuf with its symbol, or if the sequence starts with a mouse
7360 click and we need to switch buffers, we jump back here to rebuild
7361 the initial keymaps from the current buffer. */
7365 /* Should overriding-terminal-local-map and overriding-local-map apply? */
7366 if (!NILP (Voverriding_local_map_menu_flag
)
7367 && !NILP (Voverriding_local_map
))
7369 /* Yes, use them (if non-nil) as well as the global map. */
7372 if (!NILP (KVAR (current_kboard
, Voverriding_terminal_local_map
)))
7373 maps
[nmaps
++] = KVAR (current_kboard
, Voverriding_terminal_local_map
);
7374 if (!NILP (Voverriding_local_map
))
7375 maps
[nmaps
++] = Voverriding_local_map
;
7379 /* No, so use major and minor mode keymaps and keymap property.
7380 Note that menu-bar bindings in the local-map and keymap
7381 properties may not work reliable, as they are only
7382 recognized when the menu-bar (or mode-line) is updated,
7383 which does not normally happen after every command. */
7384 ptrdiff_t nminor
= current_minor_maps (NULL
, &tmaps
);
7385 SAFE_NALLOCA (maps
, 1, nminor
+ 4);
7387 Lisp_Object tem
= KVAR (current_kboard
, Voverriding_terminal_local_map
);
7388 if (!NILP (tem
) && !NILP (Voverriding_local_map_menu_flag
))
7389 maps
[nmaps
++] = tem
;
7390 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
7391 maps
[nmaps
++] = tem
;
7394 memcpy (maps
+ nmaps
, tmaps
, nminor
* sizeof (maps
[0]));
7397 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
7399 maps
[nmaps
++] = current_global_map
;
7402 /* Look up in each map the dummy prefix key `menu-bar'. */
7404 for (mapno
= nmaps
- 1; mapno
>= 0; mapno
--)
7405 if (!NILP (maps
[mapno
]))
7407 def
= get_keymap (access_keymap (maps
[mapno
], Qmenu_bar
, 1, 0, 1),
7411 menu_bar_one_keymap_changed_items
= Qnil
;
7412 map_keymap_canonical (def
, menu_bar_item
, Qnil
, NULL
);
7416 /* Move to the end those items that should be at the end. */
7418 for (tail
= Vmenu_bar_final_items
; CONSP (tail
); tail
= XCDR (tail
))
7421 int end
= menu_bar_items_index
;
7423 for (i
= 0; i
< end
; i
+= 4)
7424 if (EQ (XCAR (tail
), AREF (menu_bar_items_vector
, i
)))
7426 Lisp_Object tem0
, tem1
, tem2
, tem3
;
7427 /* Move the item at index I to the end,
7428 shifting all the others forward. */
7429 tem0
= AREF (menu_bar_items_vector
, i
+ 0);
7430 tem1
= AREF (menu_bar_items_vector
, i
+ 1);
7431 tem2
= AREF (menu_bar_items_vector
, i
+ 2);
7432 tem3
= AREF (menu_bar_items_vector
, i
+ 3);
7434 memmove (aref_addr (menu_bar_items_vector
, i
),
7435 aref_addr (menu_bar_items_vector
, i
+ 4),
7436 (end
- i
- 4) * word_size
);
7437 ASET (menu_bar_items_vector
, end
- 4, tem0
);
7438 ASET (menu_bar_items_vector
, end
- 3, tem1
);
7439 ASET (menu_bar_items_vector
, end
- 2, tem2
);
7440 ASET (menu_bar_items_vector
, end
- 1, tem3
);
7445 /* Add nil, nil, nil, nil at the end. */
7447 int i
= menu_bar_items_index
;
7448 if (i
+ 4 > ASIZE (menu_bar_items_vector
))
7449 menu_bar_items_vector
7450 = larger_vector (menu_bar_items_vector
, 4, -1);
7451 /* Add this item. */
7452 ASET (menu_bar_items_vector
, i
, Qnil
); i
++;
7453 ASET (menu_bar_items_vector
, i
, Qnil
); i
++;
7454 ASET (menu_bar_items_vector
, i
, Qnil
); i
++;
7455 ASET (menu_bar_items_vector
, i
, Qnil
); i
++;
7456 menu_bar_items_index
= i
;
7459 Vinhibit_quit
= oquit
;
7461 return menu_bar_items_vector
;
7464 /* Add one item to menu_bar_items_vector, for KEY, ITEM_STRING and DEF.
7465 If there's already an item for KEY, add this DEF to it. */
7467 Lisp_Object item_properties
;
7470 menu_bar_item (Lisp_Object key
, Lisp_Object item
, Lisp_Object dummy1
, void *dummy2
)
7476 if (EQ (item
, Qundefined
))
7478 /* If a map has an explicit `undefined' as definition,
7479 discard any previously made menu bar item. */
7481 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7482 if (EQ (key
, AREF (menu_bar_items_vector
, i
)))
7484 if (menu_bar_items_index
> i
+ 4)
7485 memmove (aref_addr (menu_bar_items_vector
, i
),
7486 aref_addr (menu_bar_items_vector
, i
+ 4),
7487 (menu_bar_items_index
- i
- 4) * word_size
);
7488 menu_bar_items_index
-= 4;
7492 /* If this keymap has already contributed to this KEY,
7493 don't contribute to it a second time. */
7494 tem
= Fmemq (key
, menu_bar_one_keymap_changed_items
);
7495 if (!NILP (tem
) || NILP (item
))
7498 menu_bar_one_keymap_changed_items
7499 = Fcons (key
, menu_bar_one_keymap_changed_items
);
7501 /* We add to menu_bar_one_keymap_changed_items before doing the
7502 parse_menu_item, so that if it turns out it wasn't a menu item,
7503 it still correctly hides any further menu item. */
7504 parsed
= parse_menu_item (item
, 1);
7508 item
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7510 /* Find any existing item for this KEY. */
7511 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7512 if (EQ (key
, AREF (menu_bar_items_vector
, i
)))
7515 /* If we did not find this KEY, add it at the end. */
7516 if (i
== menu_bar_items_index
)
7518 /* If vector is too small, get a bigger one. */
7519 if (i
+ 4 > ASIZE (menu_bar_items_vector
))
7520 menu_bar_items_vector
= larger_vector (menu_bar_items_vector
, 4, -1);
7521 /* Add this item. */
7522 ASET (menu_bar_items_vector
, i
, key
); i
++;
7523 ASET (menu_bar_items_vector
, i
,
7524 AREF (item_properties
, ITEM_PROPERTY_NAME
)); i
++;
7525 ASET (menu_bar_items_vector
, i
, list1 (item
)); i
++;
7526 ASET (menu_bar_items_vector
, i
, make_number (0)); i
++;
7527 menu_bar_items_index
= i
;
7529 /* We did find an item for this KEY. Add ITEM to its list of maps. */
7533 old
= AREF (menu_bar_items_vector
, i
+ 2);
7534 /* If the new and the old items are not both keymaps,
7535 the lookup will only find `item'. */
7536 item
= Fcons (item
, KEYMAPP (item
) && KEYMAPP (XCAR (old
)) ? old
: Qnil
);
7537 ASET (menu_bar_items_vector
, i
+ 2, item
);
7541 /* This is used as the handler when calling menu_item_eval_property. */
7543 menu_item_eval_property_1 (Lisp_Object arg
)
7545 /* If we got a quit from within the menu computation,
7546 quit all the way out of it. This takes care of C-] in the debugger. */
7547 if (CONSP (arg
) && EQ (XCAR (arg
), Qquit
))
7548 Fsignal (Qquit
, Qnil
);
7554 eval_dyn (Lisp_Object form
)
7556 return Feval (form
, Qnil
);
7559 /* Evaluate an expression and return the result (or nil if something
7560 went wrong). Used to evaluate dynamic parts of menu items. */
7562 menu_item_eval_property (Lisp_Object sexpr
)
7564 ptrdiff_t count
= SPECPDL_INDEX ();
7566 specbind (Qinhibit_redisplay
, Qt
);
7567 val
= internal_condition_case_1 (eval_dyn
, sexpr
, Qerror
,
7568 menu_item_eval_property_1
);
7569 return unbind_to (count
, val
);
7572 /* This function parses a menu item and leaves the result in the
7573 vector item_properties.
7574 ITEM is a key binding, a possible menu item.
7575 INMENUBAR is > 0 when this is considered for an entry in a menu bar
7577 INMENUBAR is < 0 when this is considered for an entry in a keyboard menu.
7578 parse_menu_item returns true if the item is a menu item and false
7582 parse_menu_item (Lisp_Object item
, int inmenubar
)
7584 Lisp_Object def
, tem
, item_string
, start
;
7586 Lisp_Object keyhint
;
7595 /* Create item_properties vector if necessary. */
7596 if (NILP (item_properties
))
7598 = Fmake_vector (make_number (ITEM_PROPERTY_ENABLE
+ 1), Qnil
);
7600 /* Initialize optional entries. */
7601 for (i
= ITEM_PROPERTY_DEF
; i
< ITEM_PROPERTY_ENABLE
; i
++)
7602 ASET (item_properties
, i
, Qnil
);
7603 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7605 /* Save the item here to protect it from GC. */
7606 ASET (item_properties
, ITEM_PROPERTY_ITEM
, item
);
7608 item_string
= XCAR (item
);
7612 if (STRINGP (item_string
))
7614 /* Old format menu item. */
7615 ASET (item_properties
, ITEM_PROPERTY_NAME
, item_string
);
7617 /* Maybe help string. */
7618 if (CONSP (item
) && STRINGP (XCAR (item
)))
7620 ASET (item_properties
, ITEM_PROPERTY_HELP
,
7621 Fsubstitute_command_keys (XCAR (item
)));
7626 /* Maybe an obsolete key binding cache. */
7627 if (CONSP (item
) && CONSP (XCAR (item
))
7628 && (NILP (XCAR (XCAR (item
)))
7629 || VECTORP (XCAR (XCAR (item
)))))
7632 /* This is the real definition--the function to run. */
7633 ASET (item_properties
, ITEM_PROPERTY_DEF
, item
);
7635 /* Get enable property, if any. */
7638 tem
= Fget (item
, Qmenu_enable
);
7639 if (!NILP (Venable_disabled_menus_and_buttons
))
7640 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7641 else if (!NILP (tem
))
7642 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, tem
);
7645 else if (EQ (item_string
, Qmenu_item
) && CONSP (item
))
7647 /* New format menu item. */
7648 ASET (item_properties
, ITEM_PROPERTY_NAME
, XCAR (item
));
7649 start
= XCDR (item
);
7652 /* We have a real binding. */
7653 ASET (item_properties
, ITEM_PROPERTY_DEF
, XCAR (start
));
7655 item
= XCDR (start
);
7656 /* Is there an obsolete cache list with key equivalences. */
7657 if (CONSP (item
) && CONSP (XCAR (item
)))
7660 /* Parse properties. */
7661 while (CONSP (item
) && CONSP (XCDR (item
)))
7666 if (EQ (tem
, QCenable
))
7668 if (!NILP (Venable_disabled_menus_and_buttons
))
7669 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7671 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, XCAR (item
));
7673 else if (EQ (tem
, QCvisible
))
7675 /* If got a visible property and that evaluates to nil
7676 then ignore this item. */
7677 tem
= menu_item_eval_property (XCAR (item
));
7681 else if (EQ (tem
, QChelp
))
7683 Lisp_Object help
= XCAR (item
);
7685 help
= Fsubstitute_command_keys (help
);
7686 ASET (item_properties
, ITEM_PROPERTY_HELP
, help
);
7688 else if (EQ (tem
, QCfilter
))
7690 else if (EQ (tem
, QCkey_sequence
))
7693 if (SYMBOLP (tem
) || STRINGP (tem
) || VECTORP (tem
))
7694 /* Be GC protected. Set keyhint to item instead of tem. */
7697 else if (EQ (tem
, QCkeys
))
7700 if (CONSP (tem
) || STRINGP (tem
))
7701 ASET (item_properties
, ITEM_PROPERTY_KEYEQ
, tem
);
7703 else if (EQ (tem
, QCbutton
) && CONSP (XCAR (item
)))
7708 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
7710 ASET (item_properties
, ITEM_PROPERTY_SELECTED
,
7712 ASET (item_properties
, ITEM_PROPERTY_TYPE
, type
);
7718 else if (inmenubar
|| !NILP (start
))
7722 return 0; /* not a menu item */
7724 /* If item string is not a string, evaluate it to get string.
7725 If we don't get a string, skip this item. */
7726 item_string
= AREF (item_properties
, ITEM_PROPERTY_NAME
);
7727 if (!(STRINGP (item_string
)))
7729 item_string
= menu_item_eval_property (item_string
);
7730 if (!STRINGP (item_string
))
7732 ASET (item_properties
, ITEM_PROPERTY_NAME
, item_string
);
7735 /* If got a filter apply it on definition. */
7736 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7739 def
= menu_item_eval_property (list2 (XCAR (filter
),
7740 list2 (Qquote
, def
)));
7742 ASET (item_properties
, ITEM_PROPERTY_DEF
, def
);
7745 /* Enable or disable selection of item. */
7746 tem
= AREF (item_properties
, ITEM_PROPERTY_ENABLE
);
7749 tem
= menu_item_eval_property (tem
);
7750 if (inmenubar
&& NILP (tem
))
7751 return 0; /* Ignore disabled items in menu bar. */
7752 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, tem
);
7755 /* If we got no definition, this item is just unselectable text which
7756 is OK in a submenu but not in the menubar. */
7758 return (!inmenubar
);
7760 /* See if this is a separate pane or a submenu. */
7761 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7762 tem
= get_keymap (def
, 0, 1);
7763 /* For a subkeymap, just record its details and exit. */
7766 ASET (item_properties
, ITEM_PROPERTY_MAP
, tem
);
7767 ASET (item_properties
, ITEM_PROPERTY_DEF
, tem
);
7771 /* At the top level in the menu bar, do likewise for commands also.
7772 The menu bar does not display equivalent key bindings anyway.
7773 ITEM_PROPERTY_DEF is already set up properly. */
7777 { /* This is a command. See if there is an equivalent key binding. */
7778 Lisp_Object keyeq
= AREF (item_properties
, ITEM_PROPERTY_KEYEQ
);
7779 AUTO_STRING (space_space
, " ");
7781 /* The previous code preferred :key-sequence to :keys, so we
7782 preserve this behavior. */
7783 if (STRINGP (keyeq
) && !CONSP (keyhint
))
7784 keyeq
= concat2 (space_space
, Fsubstitute_command_keys (keyeq
));
7787 Lisp_Object prefix
= keyeq
;
7788 Lisp_Object keys
= Qnil
;
7792 def
= XCAR (prefix
);
7793 prefix
= XCDR (prefix
);
7796 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7798 if (CONSP (keyhint
) && !NILP (XCAR (keyhint
)))
7800 keys
= XCAR (keyhint
);
7801 tem
= Fkey_binding (keys
, Qnil
, Qnil
, Qnil
);
7803 /* We have a suggested key. Is it bound to the command? */
7806 /* If the command is an alias for another
7807 (such as lmenu.el set it up), check if the
7808 original command matches the cached command. */
7810 && EQ (tem
, XSYMBOL (def
)->function
))))
7815 keys
= Fwhere_is_internal (def
, Qnil
, Qt
, Qnil
, Qnil
);
7819 tem
= Fkey_description (keys
, Qnil
);
7822 if (STRINGP (XCAR (prefix
)))
7823 tem
= concat2 (XCAR (prefix
), tem
);
7824 if (STRINGP (XCDR (prefix
)))
7825 tem
= concat2 (tem
, XCDR (prefix
));
7827 keyeq
= concat2 (space_space
, tem
);
7833 /* If we have an equivalent key binding, use that. */
7834 ASET (item_properties
, ITEM_PROPERTY_KEYEQ
, keyeq
);
7837 /* Include this when menu help is implemented.
7838 tem = XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP];
7839 if (!(NILP (tem) || STRINGP (tem)))
7841 tem = menu_item_eval_property (tem);
7844 XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP] = tem;
7848 /* Handle radio buttons or toggle boxes. */
7849 tem
= AREF (item_properties
, ITEM_PROPERTY_SELECTED
);
7851 ASET (item_properties
, ITEM_PROPERTY_SELECTED
,
7852 menu_item_eval_property (tem
));
7859 /***********************************************************************
7861 ***********************************************************************/
7863 /* A vector holding tool bar items while they are parsed in function
7864 tool_bar_items. Each item occupies TOOL_BAR_ITEM_NSCLOTS elements
7867 static Lisp_Object tool_bar_items_vector
;
7869 /* A vector holding the result of parse_tool_bar_item. Layout is like
7870 the one for a single item in tool_bar_items_vector. */
7872 static Lisp_Object tool_bar_item_properties
;
7874 /* Next free index in tool_bar_items_vector. */
7876 static int ntool_bar_items
;
7878 /* Function prototypes. */
7880 static void init_tool_bar_items (Lisp_Object
);
7881 static void process_tool_bar_item (Lisp_Object
, Lisp_Object
, Lisp_Object
,
7883 static bool parse_tool_bar_item (Lisp_Object
, Lisp_Object
);
7884 static void append_tool_bar_item (void);
7887 /* Return a vector of tool bar items for keymaps currently in effect.
7888 Reuse vector REUSE if non-nil. Return in *NITEMS the number of
7889 tool bar items found. */
7892 tool_bar_items (Lisp_Object reuse
, int *nitems
)
7895 Lisp_Object mapsbuf
[3];
7903 /* In order to build the menus, we need to call the keymap
7904 accessors. They all call QUIT. But this function is called
7905 during redisplay, during which a quit is fatal. So inhibit
7906 quitting while building the menus. We do this instead of
7907 specbind because (1) errors will clear it anyway and (2) this
7908 avoids risk of specpdl overflow. */
7909 oquit
= Vinhibit_quit
;
7912 /* Initialize tool_bar_items_vector and protect it from GC. */
7913 init_tool_bar_items (reuse
);
7915 /* Build list of keymaps in maps. Set nmaps to the number of maps
7918 /* Should overriding-terminal-local-map and overriding-local-map apply? */
7919 if (!NILP (Voverriding_local_map_menu_flag
)
7920 && !NILP (Voverriding_local_map
))
7922 /* Yes, use them (if non-nil) as well as the global map. */
7925 if (!NILP (KVAR (current_kboard
, Voverriding_terminal_local_map
)))
7926 maps
[nmaps
++] = KVAR (current_kboard
, Voverriding_terminal_local_map
);
7927 if (!NILP (Voverriding_local_map
))
7928 maps
[nmaps
++] = Voverriding_local_map
;
7932 /* No, so use major and minor mode keymaps and keymap property.
7933 Note that tool-bar bindings in the local-map and keymap
7934 properties may not work reliable, as they are only
7935 recognized when the tool-bar (or mode-line) is updated,
7936 which does not normally happen after every command. */
7937 ptrdiff_t nminor
= current_minor_maps (NULL
, &tmaps
);
7938 SAFE_NALLOCA (maps
, 1, nminor
+ 4);
7940 Lisp_Object tem
= KVAR (current_kboard
, Voverriding_terminal_local_map
);
7941 if (!NILP (tem
) && !NILP (Voverriding_local_map_menu_flag
))
7942 maps
[nmaps
++] = tem
;
7943 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
7944 maps
[nmaps
++] = tem
;
7947 memcpy (maps
+ nmaps
, tmaps
, nminor
* sizeof (maps
[0]));
7950 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
7953 /* Add global keymap at the end. */
7954 maps
[nmaps
++] = current_global_map
;
7956 /* Process maps in reverse order and look up in each map the prefix
7958 for (i
= nmaps
- 1; i
>= 0; --i
)
7959 if (!NILP (maps
[i
]))
7963 keymap
= get_keymap (access_keymap (maps
[i
], Qtool_bar
, 1, 0, 1), 0, 1);
7965 map_keymap (keymap
, process_tool_bar_item
, Qnil
, NULL
, 1);
7968 Vinhibit_quit
= oquit
;
7969 *nitems
= ntool_bar_items
/ TOOL_BAR_ITEM_NSLOTS
;
7971 return tool_bar_items_vector
;
7975 /* Process the definition of KEY which is DEF. */
7978 process_tool_bar_item (Lisp_Object key
, Lisp_Object def
, Lisp_Object data
, void *args
)
7982 if (EQ (def
, Qundefined
))
7984 /* If a map has an explicit `undefined' as definition,
7985 discard any previously made item. */
7986 for (i
= 0; i
< ntool_bar_items
; i
+= TOOL_BAR_ITEM_NSLOTS
)
7988 Lisp_Object
*v
= XVECTOR (tool_bar_items_vector
)->contents
+ i
;
7990 if (EQ (key
, v
[TOOL_BAR_ITEM_KEY
]))
7992 if (ntool_bar_items
> i
+ TOOL_BAR_ITEM_NSLOTS
)
7993 memmove (v
, v
+ TOOL_BAR_ITEM_NSLOTS
,
7994 ((ntool_bar_items
- i
- TOOL_BAR_ITEM_NSLOTS
)
7996 ntool_bar_items
-= TOOL_BAR_ITEM_NSLOTS
;
8001 else if (parse_tool_bar_item (key
, def
))
8002 /* Append a new tool bar item to tool_bar_items_vector. Accept
8003 more than one definition for the same key. */
8004 append_tool_bar_item ();
8007 /* Access slot with index IDX of vector tool_bar_item_properties. */
8008 #define PROP(IDX) AREF (tool_bar_item_properties, (IDX))
8010 set_prop (ptrdiff_t idx
, Lisp_Object val
)
8012 ASET (tool_bar_item_properties
, idx
, val
);
8016 /* Parse a tool bar item specification ITEM for key KEY and return the
8017 result in tool_bar_item_properties. Value is false if ITEM is
8020 ITEM is a list `(menu-item CAPTION BINDING PROPS...)'.
8022 CAPTION is the caption of the item, If it's not a string, it is
8023 evaluated to get a string.
8025 BINDING is the tool bar item's binding. Tool-bar items with keymaps
8026 as binding are currently ignored.
8028 The following properties are recognized:
8032 FORM is evaluated and specifies whether the tool bar item is
8033 enabled or disabled.
8037 FORM is evaluated and specifies whether the tool bar item is visible.
8039 - `:filter FUNCTION'
8041 FUNCTION is invoked with one parameter `(quote BINDING)'. Its
8042 result is stored as the new binding.
8044 - `:button (TYPE SELECTED)'
8046 TYPE must be one of `:radio' or `:toggle'. SELECTED is evaluated
8047 and specifies whether the button is selected (pressed) or not.
8051 IMAGES is either a single image specification or a vector of four
8052 image specifications. See enum tool_bar_item_images.
8054 - `:help HELP-STRING'.
8056 Gives a help string to display for the tool bar item.
8058 - `:label LABEL-STRING'.
8060 A text label to show with the tool bar button if labels are enabled. */
8063 parse_tool_bar_item (Lisp_Object key
, Lisp_Object item
)
8065 Lisp_Object filter
= Qnil
;
8066 Lisp_Object caption
;
8068 bool have_label
= false;
8070 /* Definition looks like `(menu-item CAPTION BINDING PROPS...)'.
8071 Rule out items that aren't lists, don't start with
8072 `menu-item' or whose rest following `tool-bar-item' is not a
8077 /* As an exception, allow old-style menu separators. */
8078 if (STRINGP (XCAR (item
)))
8079 item
= list1 (XCAR (item
));
8080 else if (!EQ (XCAR (item
), Qmenu_item
)
8081 || (item
= XCDR (item
), !CONSP (item
)))
8084 /* Create tool_bar_item_properties vector if necessary. Reset it to
8086 if (VECTORP (tool_bar_item_properties
))
8088 for (i
= 0; i
< TOOL_BAR_ITEM_NSLOTS
; ++i
)
8092 tool_bar_item_properties
8093 = Fmake_vector (make_number (TOOL_BAR_ITEM_NSLOTS
), Qnil
);
8096 set_prop (TOOL_BAR_ITEM_KEY
, key
);
8097 set_prop (TOOL_BAR_ITEM_ENABLED_P
, Qt
);
8099 /* Get the caption of the item. If the caption is not a string,
8100 evaluate it to get a string. If we don't get a string, skip this
8102 caption
= XCAR (item
);
8103 if (!STRINGP (caption
))
8105 caption
= menu_item_eval_property (caption
);
8106 if (!STRINGP (caption
))
8109 set_prop (TOOL_BAR_ITEM_CAPTION
, caption
);
8111 /* If the rest following the caption is not a list, the menu item is
8112 either a separator, or invalid. */
8116 if (menu_separator_name_p (SSDATA (caption
)))
8118 set_prop (TOOL_BAR_ITEM_TYPE
, Qt
);
8119 #if !defined (USE_GTK) && !defined (HAVE_NS)
8120 /* If we use build_desired_tool_bar_string to render the
8121 tool bar, the separator is rendered as an image. */
8122 set_prop (TOOL_BAR_ITEM_IMAGES
,
8123 (menu_item_eval_property
8124 (Vtool_bar_separator_image_expression
)));
8125 set_prop (TOOL_BAR_ITEM_ENABLED_P
, Qnil
);
8126 set_prop (TOOL_BAR_ITEM_SELECTED_P
, Qnil
);
8127 set_prop (TOOL_BAR_ITEM_CAPTION
, Qnil
);
8134 /* Store the binding. */
8135 set_prop (TOOL_BAR_ITEM_BINDING
, XCAR (item
));
8138 /* Ignore cached key binding, if any. */
8139 if (CONSP (item
) && CONSP (XCAR (item
)))
8142 /* Process the rest of the properties. */
8143 for (; CONSP (item
) && CONSP (XCDR (item
)); item
= XCDR (XCDR (item
)))
8145 Lisp_Object ikey
, value
;
8148 value
= XCAR (XCDR (item
));
8150 if (EQ (ikey
, QCenable
))
8152 /* `:enable FORM'. */
8153 if (!NILP (Venable_disabled_menus_and_buttons
))
8154 set_prop (TOOL_BAR_ITEM_ENABLED_P
, Qt
);
8156 set_prop (TOOL_BAR_ITEM_ENABLED_P
, value
);
8158 else if (EQ (ikey
, QCvisible
))
8160 /* `:visible FORM'. If got a visible property and that
8161 evaluates to nil then ignore this item. */
8162 if (NILP (menu_item_eval_property (value
)))
8165 else if (EQ (ikey
, QChelp
))
8166 /* `:help HELP-STRING'. */
8167 set_prop (TOOL_BAR_ITEM_HELP
, value
);
8168 else if (EQ (ikey
, QCvert_only
))
8169 /* `:vert-only t/nil'. */
8170 set_prop (TOOL_BAR_ITEM_VERT_ONLY
, value
);
8171 else if (EQ (ikey
, QClabel
))
8173 const char *bad_label
= "!!?GARBLED ITEM?!!";
8174 /* `:label LABEL-STRING'. */
8175 set_prop (TOOL_BAR_ITEM_LABEL
,
8176 STRINGP (value
) ? value
: build_string (bad_label
));
8179 else if (EQ (ikey
, QCfilter
))
8180 /* ':filter FORM'. */
8182 else if (EQ (ikey
, QCbutton
) && CONSP (value
))
8184 /* `:button (TYPE . SELECTED)'. */
8185 Lisp_Object type
, selected
;
8187 type
= XCAR (value
);
8188 selected
= XCDR (value
);
8189 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
8191 set_prop (TOOL_BAR_ITEM_SELECTED_P
, selected
);
8192 set_prop (TOOL_BAR_ITEM_TYPE
, type
);
8195 else if (EQ (ikey
, QCimage
)
8197 || (VECTORP (value
) && ASIZE (value
) == 4)))
8198 /* Value is either a single image specification or a vector
8199 of 4 such specifications for the different button states. */
8200 set_prop (TOOL_BAR_ITEM_IMAGES
, value
);
8201 else if (EQ (ikey
, QCrtl
))
8203 set_prop (TOOL_BAR_ITEM_RTL_IMAGE
, value
);
8209 /* Try to make one from caption and key. */
8210 Lisp_Object tkey
= PROP (TOOL_BAR_ITEM_KEY
);
8211 Lisp_Object tcapt
= PROP (TOOL_BAR_ITEM_CAPTION
);
8212 const char *label
= SYMBOLP (tkey
) ? SSDATA (SYMBOL_NAME (tkey
)) : "";
8213 const char *capt
= STRINGP (tcapt
) ? SSDATA (tcapt
) : "";
8215 2 * max (0, min (tool_bar_max_label_size
, STRING_BYTES_BOUND
/ 2));
8216 char *buf
= xmalloc (max_lbl
+ 1);
8217 Lisp_Object new_lbl
;
8218 ptrdiff_t caption_len
= strlen (capt
);
8220 if (caption_len
<= max_lbl
&& capt
[0] != '\0')
8223 while (caption_len
> 0 && buf
[caption_len
- 1] == '.')
8225 buf
[caption_len
] = '\0';
8229 if (strlen (label
) <= max_lbl
&& label
[0] != '\0')
8233 strcpy (buf
, label
);
8235 for (j
= 0; buf
[j
] != '\0'; ++j
)
8243 new_lbl
= Fupcase_initials (build_string (label
));
8244 if (SCHARS (new_lbl
) <= tool_bar_max_label_size
)
8245 set_prop (TOOL_BAR_ITEM_LABEL
, new_lbl
);
8247 set_prop (TOOL_BAR_ITEM_LABEL
, empty_unibyte_string
);
8251 /* If got a filter apply it on binding. */
8253 set_prop (TOOL_BAR_ITEM_BINDING
,
8254 (menu_item_eval_property
8257 PROP (TOOL_BAR_ITEM_BINDING
))))));
8259 /* See if the binding is a keymap. Give up if it is. */
8260 if (CONSP (get_keymap (PROP (TOOL_BAR_ITEM_BINDING
), 0, 1)))
8263 /* Enable or disable selection of item. */
8264 if (!EQ (PROP (TOOL_BAR_ITEM_ENABLED_P
), Qt
))
8265 set_prop (TOOL_BAR_ITEM_ENABLED_P
,
8266 menu_item_eval_property (PROP (TOOL_BAR_ITEM_ENABLED_P
)));
8268 /* Handle radio buttons or toggle boxes. */
8269 if (!NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
)))
8270 set_prop (TOOL_BAR_ITEM_SELECTED_P
,
8271 menu_item_eval_property (PROP (TOOL_BAR_ITEM_SELECTED_P
)));
8279 /* Initialize tool_bar_items_vector. REUSE, if non-nil, is a vector
8280 that can be reused. */
8283 init_tool_bar_items (Lisp_Object reuse
)
8285 if (VECTORP (reuse
))
8286 tool_bar_items_vector
= reuse
;
8288 tool_bar_items_vector
= Fmake_vector (make_number (64), Qnil
);
8289 ntool_bar_items
= 0;
8293 /* Append parsed tool bar item properties from
8294 tool_bar_item_properties */
8297 append_tool_bar_item (void)
8301 - (ASIZE (tool_bar_items_vector
) - TOOL_BAR_ITEM_NSLOTS
));
8303 /* Enlarge tool_bar_items_vector if necessary. */
8305 tool_bar_items_vector
= larger_vector (tool_bar_items_vector
, incr
, -1);
8307 /* Append entries from tool_bar_item_properties to the end of
8308 tool_bar_items_vector. */
8309 vcopy (tool_bar_items_vector
, ntool_bar_items
,
8310 XVECTOR (tool_bar_item_properties
)->contents
, TOOL_BAR_ITEM_NSLOTS
);
8311 ntool_bar_items
+= TOOL_BAR_ITEM_NSLOTS
;
8318 /* Read a character using menus based on the keymap MAP.
8319 Return nil if there are no menus in the maps.
8320 Return t if we displayed a menu but the user rejected it.
8322 PREV_EVENT is the previous input event, or nil if we are reading
8323 the first event of a key sequence.
8325 If USED_MOUSE_MENU is non-null, set *USED_MOUSE_MENU to true
8326 if we used a mouse menu to read the input, or false otherwise. If
8327 USED_MOUSE_MENU is null, don't dereference it.
8329 The prompting is done based on the prompt-string of the map
8330 and the strings associated with various map elements.
8332 This can be done with X menus or with menus put in the minibuf.
8333 These are done in different ways, depending on how the input will be read.
8334 Menus using X are done after auto-saving in read-char, getting the input
8335 event from Fx_popup_menu; menus using the minibuf use read_char recursively
8336 and do auto-saving in the inner call of read_char. */
8339 read_char_x_menu_prompt (Lisp_Object map
,
8340 Lisp_Object prev_event
, bool *used_mouse_menu
)
8342 if (used_mouse_menu
)
8343 *used_mouse_menu
= false;
8345 /* Use local over global Menu maps. */
8347 if (! menu_prompting
)
8350 /* If we got to this point via a mouse click,
8351 use a real menu for mouse selection. */
8352 if (EVENT_HAS_PARAMETERS (prev_event
)
8353 && !EQ (XCAR (prev_event
), Qmenu_bar
)
8354 && !EQ (XCAR (prev_event
), Qtool_bar
))
8356 /* Display the menu and get the selection. */
8359 value
= Fx_popup_menu (prev_event
, get_keymap (map
, 0, 1));
8364 record_menu_key (XCAR (value
));
8366 /* If we got multiple events, unread all but
8368 There is no way to prevent those unread events
8369 from showing up later in last_nonmenu_event.
8370 So turn symbol and integer events into lists,
8371 to indicate that they came from a mouse menu,
8372 so that when present in last_nonmenu_event
8373 they won't confuse things. */
8374 for (tem
= XCDR (value
); CONSP (tem
); tem
= XCDR (tem
))
8376 record_menu_key (XCAR (tem
));
8377 if (SYMBOLP (XCAR (tem
))
8378 || INTEGERP (XCAR (tem
)))
8379 XSETCAR (tem
, Fcons (XCAR (tem
), Qdisabled
));
8382 /* If we got more than one event, put all but the first
8383 onto this list to be read later.
8384 Return just the first event now. */
8385 Vunread_command_events
8386 = nconc2 (XCDR (value
), Vunread_command_events
);
8387 value
= XCAR (value
);
8389 else if (NILP (value
))
8391 if (used_mouse_menu
)
8392 *used_mouse_menu
= true;
8399 read_char_minibuf_menu_prompt (int commandflag
,
8404 /* FIXME: Use the minibuffer's frame width. */
8405 ptrdiff_t width
= FRAME_COLS (SELECTED_FRAME ()) - 4;
8407 bool nobindings
= true;
8408 Lisp_Object rest
, vector
;
8409 Lisp_Object prompt_strings
= Qnil
;
8413 if (! menu_prompting
)
8416 map
= get_keymap (map
, 0, 1);
8417 name
= Fkeymap_prompt (map
);
8419 /* If we don't have any menus, just read a character normally. */
8420 if (!STRINGP (name
))
8423 #define PUSH_C_STR(str, listvar) \
8424 listvar = Fcons (build_unibyte_string (str), listvar)
8426 /* Prompt string always starts with map's prompt, and a space. */
8427 prompt_strings
= Fcons (name
, prompt_strings
);
8428 PUSH_C_STR (": ", prompt_strings
);
8429 nlength
= SCHARS (name
) + 2;
8433 /* Present the documented bindings, a line at a time. */
8436 bool notfirst
= false;
8437 Lisp_Object menu_strings
= prompt_strings
;
8438 ptrdiff_t i
= nlength
;
8440 Lisp_Object orig_defn_macro
;
8442 /* Loop over elements of map. */
8447 /* FIXME: Use map_keymap to handle new keymap formats. */
8449 /* At end of map, wrap around if just starting,
8450 or end this line if already have something on it. */
8453 if (notfirst
|| nobindings
)
8459 /* Look at the next element of the map. */
8461 elt
= AREF (vector
, idx
);
8463 elt
= Fcar_safe (rest
);
8465 if (idx
< 0 && VECTORP (elt
))
8467 /* If we found a dense table in the keymap,
8468 advanced past it, but start scanning its contents. */
8469 rest
= Fcdr_safe (rest
);
8475 /* An ordinary element. */
8476 Lisp_Object event
, tem
;
8480 event
= Fcar_safe (elt
); /* alist */
8481 elt
= Fcdr_safe (elt
);
8485 XSETINT (event
, idx
); /* vector */
8488 /* Ignore the element if it has no prompt string. */
8489 if (INTEGERP (event
) && parse_menu_item (elt
, -1))
8491 /* True if the char to type matches the string. */
8493 Lisp_Object upcased_event
, downcased_event
;
8494 Lisp_Object desc
= Qnil
;
8496 = AREF (item_properties
, ITEM_PROPERTY_NAME
);
8498 upcased_event
= Fupcase (event
);
8499 downcased_event
= Fdowncase (event
);
8500 char_matches
= (XINT (upcased_event
) == SREF (s
, 0)
8501 || XINT (downcased_event
) == SREF (s
, 0));
8503 desc
= Fsingle_key_description (event
, Qnil
);
8505 #if 0 /* It is redundant to list the equivalent key bindings because
8506 the prefix is what the user has already typed. */
8508 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_KEYEQ
];
8510 /* Insert equivalent keybinding. */
8511 s
= concat2 (s
, tem
);
8514 = AREF (item_properties
, ITEM_PROPERTY_TYPE
);
8515 if (EQ (tem
, QCradio
) || EQ (tem
, QCtoggle
))
8517 /* Insert button prefix. */
8518 Lisp_Object selected
8519 = AREF (item_properties
, ITEM_PROPERTY_SELECTED
);
8520 AUTO_STRING (radio_yes
, "(*) ");
8521 AUTO_STRING (radio_no
, "( ) ");
8522 AUTO_STRING (check_yes
, "[X] ");
8523 AUTO_STRING (check_no
, "[ ] ");
8524 if (EQ (tem
, QCradio
))
8525 tem
= NILP (selected
) ? radio_yes
: radio_no
;
8527 tem
= NILP (selected
) ? check_yes
: check_no
;
8528 s
= concat2 (tem
, s
);
8532 /* If we have room for the prompt string, add it to this line.
8533 If this is the first on the line, always add it. */
8534 if ((SCHARS (s
) + i
+ 2
8535 + (char_matches
? 0 : SCHARS (desc
) + 3))
8539 ptrdiff_t thiswidth
;
8541 /* Punctuate between strings. */
8544 PUSH_C_STR (", ", menu_strings
);
8550 /* If the char to type doesn't match the string's
8551 first char, explicitly show what char to type. */
8554 /* Add as much of string as fits. */
8555 thiswidth
= min (SCHARS (desc
), width
- i
);
8557 = Fcons (Fsubstring (desc
, make_number (0),
8558 make_number (thiswidth
)),
8561 PUSH_C_STR (" = ", menu_strings
);
8565 /* Add as much of string as fits. */
8566 thiswidth
= min (SCHARS (s
), width
- i
);
8568 = Fcons (Fsubstring (s
, make_number (0),
8569 make_number (thiswidth
)),
8575 /* If this element does not fit, end the line now,
8576 and save the element for the next line. */
8577 PUSH_C_STR ("...", menu_strings
);
8582 /* Move past this element. */
8583 if (idx
>= 0 && idx
+ 1 >= ASIZE (vector
))
8584 /* Handle reaching end of dense table. */
8589 rest
= Fcdr_safe (rest
);
8593 /* Prompt with that and read response. */
8594 message3_nolog (apply1 (intern ("concat"), Fnreverse (menu_strings
)));
8596 /* Make believe it's not a keyboard macro in case the help char
8597 is pressed. Help characters are not recorded because menu prompting
8598 is not used on replay. */
8599 orig_defn_macro
= KVAR (current_kboard
, defining_kbd_macro
);
8600 kset_defining_kbd_macro (current_kboard
, Qnil
);
8602 obj
= read_char (commandflag
, Qnil
, Qt
, 0, NULL
);
8603 while (BUFFERP (obj
));
8604 kset_defining_kbd_macro (current_kboard
, orig_defn_macro
);
8606 if (!INTEGERP (obj
) || XINT (obj
) == -2
8607 || (! EQ (obj
, menu_prompt_more_char
)
8608 && (!INTEGERP (menu_prompt_more_char
)
8609 || ! EQ (obj
, make_number (Ctl (XINT (menu_prompt_more_char
)))))))
8611 if (!NILP (KVAR (current_kboard
, defining_kbd_macro
)))
8612 store_kbd_macro_char (obj
);
8615 /* Help char - go round again. */
8619 /* Reading key sequences. */
8622 follow_key (Lisp_Object keymap
, Lisp_Object key
)
8624 return access_keymap (get_keymap (keymap
, 0, 1),
8629 active_maps (Lisp_Object first_event
)
8631 Lisp_Object position
8632 = CONSP (first_event
) ? CAR_SAFE (XCDR (first_event
)) : Qnil
;
8633 return Fcons (Qkeymap
, Fcurrent_active_maps (Qt
, position
));
8636 /* Structure used to keep track of partial application of key remapping
8637 such as Vfunction_key_map and Vkey_translation_map. */
8638 typedef struct keyremap
8640 /* This is the map originally specified for this use. */
8642 /* This is a submap reached by looking up, in PARENT,
8643 the events from START to END. */
8645 /* Positions [START, END) in the key sequence buffer
8646 are the key that we have scanned so far.
8647 Those events are the ones that we will replace
8648 if PARENT maps them into a key sequence. */
8652 /* Lookup KEY in MAP.
8653 MAP is a keymap mapping keys to key vectors or functions.
8654 If the mapping is a function and DO_FUNCALL is true,
8655 the function is called with PROMPT as parameter and its return
8656 value is used as the return value of this function (after checking
8657 that it is indeed a vector). */
8660 access_keymap_keyremap (Lisp_Object map
, Lisp_Object key
, Lisp_Object prompt
,
8665 next
= access_keymap (map
, key
, 1, 0, 1);
8667 /* Handle a symbol whose function definition is a keymap
8669 if (SYMBOLP (next
) && !NILP (Ffboundp (next
))
8670 && (ARRAYP (XSYMBOL (next
)->function
)
8671 || KEYMAPP (XSYMBOL (next
)->function
)))
8672 next
= Fautoload_do_load (XSYMBOL (next
)->function
, next
, Qnil
);
8674 /* If the keymap gives a function, not an
8675 array, then call the function with one arg and use
8676 its value instead. */
8677 if (do_funcall
&& FUNCTIONP (next
))
8682 next
= call1 (next
, prompt
);
8683 /* If the function returned something invalid,
8684 barf--don't ignore it. */
8685 if (! (NILP (next
) || VECTORP (next
) || STRINGP (next
)))
8686 error ("Function %s returns invalid key sequence",
8687 SSDATA (SYMBOL_NAME (tem
)));
8692 /* Do one step of the key remapping used for function-key-map and
8693 key-translation-map:
8694 KEYBUF is the buffer holding the input events.
8695 BUFSIZE is its maximum size.
8696 FKEY is a pointer to the keyremap structure to use.
8697 INPUT is the index of the last element in KEYBUF.
8698 DOIT if true says that the remapping can actually take place.
8699 DIFF is used to return the number of keys added/removed by the remapping.
8700 PARENT is the root of the keymap.
8701 PROMPT is the prompt to use if the remapping happens through a function.
8702 Return true if the remapping actually took place. */
8705 keyremap_step (Lisp_Object
*keybuf
, int bufsize
, volatile keyremap
*fkey
,
8706 int input
, bool doit
, int *diff
, Lisp_Object prompt
)
8708 Lisp_Object next
, key
;
8710 key
= keybuf
[fkey
->end
++];
8712 if (KEYMAPP (fkey
->parent
))
8713 next
= access_keymap_keyremap (fkey
->map
, key
, prompt
, doit
);
8717 /* If keybuf[fkey->start..fkey->end] is bound in the
8718 map and we're in a position to do the key remapping, replace it with
8719 the binding and restart with fkey->start at the end. */
8720 if ((VECTORP (next
) || STRINGP (next
)) && doit
)
8722 int len
= XFASTINT (Flength (next
));
8725 *diff
= len
- (fkey
->end
- fkey
->start
);
8727 if (bufsize
- input
<= *diff
)
8728 error ("Key sequence too long");
8730 /* Shift the keys that follow fkey->end. */
8732 for (i
= fkey
->end
; i
< input
; i
++)
8733 keybuf
[i
+ *diff
] = keybuf
[i
];
8735 for (i
= input
- 1; i
>= fkey
->end
; i
--)
8736 keybuf
[i
+ *diff
] = keybuf
[i
];
8737 /* Overwrite the old keys with the new ones. */
8738 for (i
= 0; i
< len
; i
++)
8739 keybuf
[fkey
->start
+ i
]
8740 = Faref (next
, make_number (i
));
8742 fkey
->start
= fkey
->end
+= *diff
;
8743 fkey
->map
= fkey
->parent
;
8748 fkey
->map
= get_keymap (next
, 0, 1);
8750 /* If we no longer have a bound suffix, try a new position for
8752 if (!CONSP (fkey
->map
))
8754 fkey
->end
= ++fkey
->start
;
8755 fkey
->map
= fkey
->parent
;
8761 test_undefined (Lisp_Object binding
)
8763 return (NILP (binding
)
8764 || EQ (binding
, Qundefined
)
8765 || (SYMBOLP (binding
)
8766 && EQ (Fcommand_remapping (binding
, Qnil
, Qnil
), Qundefined
)));
8769 /* Read a sequence of keys that ends with a non prefix character,
8770 storing it in KEYBUF, a buffer of size BUFSIZE.
8772 Return the length of the key sequence stored.
8773 Return -1 if the user rejected a command menu.
8775 Echo starting immediately unless `prompt' is 0.
8777 If PREVENT_REDISPLAY is non-zero, avoid redisplay by calling
8778 read_char with a suitable COMMANDFLAG argument.
8780 Where a key sequence ends depends on the currently active keymaps.
8781 These include any minor mode keymaps active in the current buffer,
8782 the current buffer's local map, and the global map.
8784 If a key sequence has no other bindings, we check Vfunction_key_map
8785 to see if some trailing subsequence might be the beginning of a
8786 function key's sequence. If so, we try to read the whole function
8787 key, and substitute its symbolic name into the key sequence.
8789 We ignore unbound `down-' mouse clicks. We turn unbound `drag-' and
8790 `double-' events into similar click events, if that would make them
8791 bound. We try to turn `triple-' events first into `double-' events,
8794 If we get a mouse click in a mode line, vertical divider, or other
8795 non-text area, we treat the click as if it were prefixed by the
8796 symbol denoting that area - `mode-line', `vertical-line', or
8799 If the sequence starts with a mouse click, we read the key sequence
8800 with respect to the buffer clicked on, not the current buffer.
8802 If the user switches frames in the midst of a key sequence, we put
8803 off the switch-frame event until later; the next call to
8804 read_char will return it.
8806 If FIX_CURRENT_BUFFER, we restore current_buffer
8807 from the selected window's buffer. */
8810 read_key_sequence (Lisp_Object
*keybuf
, int bufsize
, Lisp_Object prompt
,
8811 bool dont_downcase_last
, bool can_return_switch_frame
,
8812 bool fix_current_buffer
, bool prevent_redisplay
)
8814 ptrdiff_t count
= SPECPDL_INDEX ();
8816 /* How many keys there are in the current key sequence. */
8819 /* The length of the echo buffer when we started reading, and
8820 the length of this_command_keys when we started reading. */
8821 ptrdiff_t echo_start
IF_LINT (= 0);
8822 ptrdiff_t keys_start
;
8824 Lisp_Object current_binding
= Qnil
;
8825 Lisp_Object first_event
= Qnil
;
8827 /* Index of the first key that has no binding.
8828 It is useless to try fkey.start larger than that. */
8831 /* If t < mock_input, then KEYBUF[t] should be read as the next
8834 We use this to recover after recognizing a function key. Once we
8835 realize that a suffix of the current key sequence is actually a
8836 function key's escape sequence, we replace the suffix with the
8837 function key's binding from Vfunction_key_map. Now keybuf
8838 contains a new and different key sequence, so the echo area,
8839 this_command_keys, and the submaps and defs arrays are wrong. In
8840 this situation, we set mock_input to t, set t to 0, and jump to
8841 restart_sequence; the loop will read keys from keybuf up until
8842 mock_input, thus rebuilding the state; and then it will resume
8843 reading characters from the keyboard. */
8846 /* If the sequence is unbound in submaps[], then
8847 keybuf[fkey.start..fkey.end-1] is a prefix in Vfunction_key_map,
8848 and fkey.map is its binding.
8850 These might be > t, indicating that all function key scanning
8851 should hold off until t reaches them. We do this when we've just
8852 recognized a function key, to avoid searching for the function
8853 key's again in Vfunction_key_map. */
8856 /* Likewise, for key_translation_map and input-decode-map. */
8857 keyremap keytran
, indec
;
8859 /* True if we are trying to map a key by changing an upper-case
8860 letter to lower case, or a shifted function key to an unshifted
8862 bool shift_translated
= false;
8864 /* If we receive a `switch-frame' or `select-window' event in the middle of
8865 a key sequence, we put it off for later.
8866 While we're reading, we keep the event here. */
8867 Lisp_Object delayed_switch_frame
;
8869 Lisp_Object original_uppercase
IF_LINT (= Qnil
);
8870 int original_uppercase_position
= -1;
8872 /* Gets around Microsoft compiler limitations. */
8873 bool dummyflag
= false;
8875 struct buffer
*starting_buffer
;
8877 /* List of events for which a fake prefix key has been generated. */
8878 Lisp_Object fake_prefixed_keys
= Qnil
;
8880 raw_keybuf_count
= 0;
8882 last_nonmenu_event
= Qnil
;
8884 delayed_switch_frame
= Qnil
;
8890 /* Install the string PROMPT as the beginning of the string
8891 of echoing, so that it serves as a prompt for the next
8893 kset_echo_prompt (current_kboard
, prompt
);
8894 current_kboard
->immediate_echo
= false;
8897 else if (cursor_in_echo_area
8898 && echo_keystrokes_p ())
8899 /* This doesn't put in a dash if the echo buffer is empty, so
8900 you don't always see a dash hanging out in the minibuffer. */
8904 /* Record the initial state of the echo area and this_command_keys;
8905 we will need to restore them if we replay a key sequence. */
8907 echo_start
= echo_length ();
8908 keys_start
= this_command_key_count
;
8909 this_single_command_key_start
= keys_start
;
8911 /* We jump here when we need to reinitialize fkey and keytran; this
8912 happens if we switch keyboards between rescans. */
8913 replay_entire_sequence
:
8915 indec
.map
= indec
.parent
= KVAR (current_kboard
, Vinput_decode_map
);
8916 fkey
.map
= fkey
.parent
= KVAR (current_kboard
, Vlocal_function_key_map
);
8917 keytran
.map
= keytran
.parent
= Vkey_translation_map
;
8918 indec
.start
= indec
.end
= 0;
8919 fkey
.start
= fkey
.end
= 0;
8920 keytran
.start
= keytran
.end
= 0;
8922 /* We jump here when the key sequence has been thoroughly changed, and
8923 we need to rescan it starting from the beginning. When we jump here,
8924 keybuf[0..mock_input] holds the sequence we should reread. */
8927 starting_buffer
= current_buffer
;
8928 first_unbound
= bufsize
+ 1;
8930 /* Build our list of keymaps.
8931 If we recognize a function key and replace its escape sequence in
8932 keybuf with its symbol, or if the sequence starts with a mouse
8933 click and we need to switch buffers, we jump back here to rebuild
8934 the initial keymaps from the current buffer. */
8935 current_binding
= active_maps (first_event
);
8937 /* Start from the beginning in keybuf. */
8940 /* These are no-ops the first time through, but if we restart, they
8941 revert the echo area and this_command_keys to their original state. */
8942 this_command_key_count
= keys_start
;
8943 if (INTERACTIVE
&& t
< mock_input
)
8944 echo_truncate (echo_start
);
8946 /* If the best binding for the current key sequence is a keymap, or
8947 we may be looking at a function key's escape sequence, keep on
8949 while (!NILP (current_binding
)
8950 /* Keep reading as long as there's a prefix binding. */
8951 ? KEYMAPP (current_binding
)
8952 /* Don't return in the middle of a possible function key sequence,
8953 if the only bindings we found were via case conversion.
8954 Thus, if ESC O a has a function-key-map translation
8955 and ESC o has a binding, don't return after ESC O,
8956 so that we can translate ESC O plus the next character. */
8957 : (/* indec.start < t || fkey.start < t || */ keytran
.start
< t
))
8960 bool used_mouse_menu
= false;
8962 /* Where the last real key started. If we need to throw away a
8963 key that has expanded into more than one element of keybuf
8964 (say, a mouse click on the mode line which is being treated
8965 as [mode-line (mouse-...)], then we backtrack to this point
8967 int last_real_key_start
;
8969 /* These variables are analogous to echo_start and keys_start;
8970 while those allow us to restart the entire key sequence,
8971 echo_local_start and keys_local_start allow us to throw away
8973 ptrdiff_t echo_local_start
IF_LINT (= 0);
8974 int keys_local_start
;
8975 Lisp_Object new_binding
;
8977 eassert (indec
.end
== t
|| (indec
.end
> t
&& indec
.end
<= mock_input
));
8978 eassert (indec
.start
<= indec
.end
);
8979 eassert (fkey
.start
<= fkey
.end
);
8980 eassert (keytran
.start
<= keytran
.end
);
8981 /* key-translation-map is applied *after* function-key-map
8982 which is itself applied *after* input-decode-map. */
8983 eassert (fkey
.end
<= indec
.start
);
8984 eassert (keytran
.end
<= fkey
.start
);
8986 if (/* first_unbound < indec.start && first_unbound < fkey.start && */
8987 first_unbound
< keytran
.start
)
8988 { /* The prefix upto first_unbound has no binding and has
8989 no translation left to do either, so we know it's unbound.
8990 If we don't stop now, we risk staying here indefinitely
8991 (if the user keeps entering fkey or keytran prefixes
8992 like C-c ESC ESC ESC ESC ...) */
8994 for (i
= first_unbound
+ 1; i
< t
; i
++)
8995 keybuf
[i
- first_unbound
- 1] = keybuf
[i
];
8996 mock_input
= t
- first_unbound
- 1;
8997 indec
.end
= indec
.start
-= first_unbound
+ 1;
8998 indec
.map
= indec
.parent
;
8999 fkey
.end
= fkey
.start
-= first_unbound
+ 1;
9000 fkey
.map
= fkey
.parent
;
9001 keytran
.end
= keytran
.start
-= first_unbound
+ 1;
9002 keytran
.map
= keytran
.parent
;
9003 goto replay_sequence
;
9007 error ("Key sequence too long");
9010 echo_local_start
= echo_length ();
9011 keys_local_start
= this_command_key_count
;
9014 /* These are no-ops, unless we throw away a keystroke below and
9015 jumped back up to replay_key; in that case, these restore the
9016 variables to their original state, allowing us to replay the
9018 if (INTERACTIVE
&& t
< mock_input
)
9019 echo_truncate (echo_local_start
);
9020 this_command_key_count
= keys_local_start
;
9022 /* By default, assume each event is "real". */
9023 last_real_key_start
= t
;
9025 /* Does mock_input indicate that we are re-reading a key sequence? */
9029 add_command_key (key
);
9030 if (current_kboard
->immediate_echo
)
9032 /* Set immediate_echo to false so as to force echo_now to
9033 redisplay (it will set immediate_echo right back to true). */
9034 current_kboard
->immediate_echo
= false;
9039 /* If not, we should actually read a character. */
9043 KBOARD
*interrupted_kboard
= current_kboard
;
9044 struct frame
*interrupted_frame
= SELECTED_FRAME ();
9045 /* Calling read_char with COMMANDFLAG = -2 avoids
9046 redisplay in read_char and its subroutines. */
9047 key
= read_char (prevent_redisplay
? -2 : NILP (prompt
),
9048 current_binding
, last_nonmenu_event
,
9049 &used_mouse_menu
, NULL
);
9050 if ((INTEGERP (key
) && XINT (key
) == -2) /* wrong_kboard_jmpbuf */
9051 /* When switching to a new tty (with a new keyboard),
9052 read_char returns the new buffer, rather than -2
9053 (Bug#5095). This is because `terminal-init-xterm'
9054 calls read-char, which eats the wrong_kboard_jmpbuf
9055 return. Any better way to fix this? -- cyd */
9056 || (interrupted_kboard
!= current_kboard
))
9061 for (k
= all_kboards
; k
; k
= k
->next_kboard
)
9062 if (k
== interrupted_kboard
)
9067 /* Don't touch interrupted_kboard when it's been
9069 delayed_switch_frame
= Qnil
;
9070 goto replay_entire_sequence
;
9073 if (!NILP (delayed_switch_frame
))
9076 (interrupted_kboard
,
9077 Fcons (delayed_switch_frame
,
9078 KVAR (interrupted_kboard
, kbd_queue
)));
9079 delayed_switch_frame
= Qnil
;
9084 (interrupted_kboard
,
9085 Fcons (keybuf
[--t
], KVAR (interrupted_kboard
, kbd_queue
)));
9087 /* If the side queue is non-empty, ensure it begins with a
9088 switch-frame, so we'll replay it in the right context. */
9089 if (CONSP (KVAR (interrupted_kboard
, kbd_queue
))
9090 && (key
= XCAR (KVAR (interrupted_kboard
, kbd_queue
)),
9091 !(EVENT_HAS_PARAMETERS (key
)
9092 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)),
9096 XSETFRAME (frame
, interrupted_frame
);
9098 (interrupted_kboard
,
9099 Fcons (make_lispy_switch_frame (frame
),
9100 KVAR (interrupted_kboard
, kbd_queue
)));
9103 goto replay_entire_sequence
;
9107 /* read_char returns t when it shows a menu and the user rejects it.
9111 unbind_to (count
, Qnil
);
9115 /* read_char returns -1 at the end of a macro.
9116 Emacs 18 handles this by returning immediately with a
9117 zero, so that's what we'll do. */
9118 if (INTEGERP (key
) && XINT (key
) == -1)
9121 /* The Microsoft C compiler can't handle the goto that
9127 /* If the current buffer has been changed from under us, the
9128 keymap may have changed, so replay the sequence. */
9131 timer_resume_idle ();
9134 /* Reset the current buffer from the selected window
9135 in case something changed the former and not the latter.
9136 This is to be more consistent with the behavior
9137 of the command_loop_1. */
9138 if (fix_current_buffer
)
9140 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
9142 if (XBUFFER (XWINDOW (selected_window
)->contents
)
9144 Fset_buffer (XWINDOW (selected_window
)->contents
);
9147 goto replay_sequence
;
9150 /* If we have a quit that was typed in another frame, and
9151 quit_throw_to_read_char switched buffers,
9152 replay to get the right keymap. */
9154 && XINT (key
) == quit_char
9155 && current_buffer
!= starting_buffer
)
9158 ASET (raw_keybuf
, raw_keybuf_count
, key
);
9163 goto replay_sequence
;
9168 if (EVENT_HAS_PARAMETERS (key
)
9169 /* Either a `switch-frame' or a `select-window' event. */
9170 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)), Qswitch_frame
))
9172 /* If we're at the beginning of a key sequence, and the caller
9173 says it's okay, go ahead and return this event. If we're
9174 in the midst of a key sequence, delay it until the end. */
9175 if (t
> 0 || !can_return_switch_frame
)
9177 delayed_switch_frame
= key
;
9182 if (NILP (first_event
))
9185 /* Even if first_event does not specify a particular
9186 window/position, it's important to recompute the maps here
9187 since a long time might have passed since we entered
9188 read_key_sequence, and a timer (or process-filter or
9189 special-event-map, ...) might have switched the current buffer
9190 or the selected window from under us in the mean time. */
9191 if (fix_current_buffer
9192 && (XBUFFER (XWINDOW (selected_window
)->contents
)
9194 Fset_buffer (XWINDOW (selected_window
)->contents
);
9195 current_binding
= active_maps (first_event
);
9199 ASET (raw_keybuf
, raw_keybuf_count
, key
);
9203 /* Clicks in non-text areas get prefixed by the symbol
9204 in their CHAR-ADDRESS field. For example, a click on
9205 the mode line is prefixed by the symbol `mode-line'.
9207 Furthermore, key sequences beginning with mouse clicks
9208 are read using the keymaps of the buffer clicked on, not
9209 the current buffer. So we may have to switch the buffer
9212 When we turn one event into two events, we must make sure
9213 that neither of the two looks like the original--so that,
9214 if we replay the events, they won't be expanded again.
9215 If not for this, such reexpansion could happen either here
9216 or when user programs play with this-command-keys. */
9217 if (EVENT_HAS_PARAMETERS (key
))
9219 Lisp_Object kind
= EVENT_HEAD_KIND (EVENT_HEAD (key
));
9220 if (EQ (kind
, Qmouse_click
))
9222 Lisp_Object window
= POSN_WINDOW (EVENT_START (key
));
9223 Lisp_Object posn
= POSN_POSN (EVENT_START (key
));
9226 || (!NILP (fake_prefixed_keys
)
9227 && !NILP (Fmemq (key
, fake_prefixed_keys
))))
9229 /* We're looking a second time at an event for which
9230 we generated a fake prefix key. Set
9231 last_real_key_start appropriately. */
9233 last_real_key_start
= t
- 1;
9236 if (last_real_key_start
== 0)
9238 /* Key sequences beginning with mouse clicks are
9239 read using the keymaps in the buffer clicked on,
9240 not the current buffer. If we're at the
9241 beginning of a key sequence, switch buffers. */
9242 if (WINDOWP (window
)
9243 && BUFFERP (XWINDOW (window
)->contents
)
9244 && XBUFFER (XWINDOW (window
)->contents
) != current_buffer
)
9246 ASET (raw_keybuf
, raw_keybuf_count
, key
);
9251 /* Arrange to go back to the original buffer once we're
9252 done reading the key sequence. Note that we can't
9253 use save_excursion_{save,restore} here, because they
9254 save point as well as the current buffer; we don't
9255 want to save point, because redisplay may change it,
9256 to accommodate a Fset_window_start or something. We
9257 don't want to do this at the top of the function,
9258 because we may get input from a subprocess which
9259 wants to change the selected window and stuff (say,
9261 record_unwind_current_buffer ();
9263 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
9265 set_buffer_internal (XBUFFER (XWINDOW (window
)->contents
));
9266 goto replay_sequence
;
9270 /* Expand mode-line and scroll-bar events into two events:
9271 use posn as a fake prefix key. */
9273 && (NILP (fake_prefixed_keys
)
9274 || NILP (Fmemq (key
, fake_prefixed_keys
))))
9276 if (bufsize
- t
<= 1)
9277 error ("Key sequence too long");
9280 keybuf
[t
+ 1] = key
;
9283 /* Record that a fake prefix key has been generated
9284 for KEY. Don't modify the event; this would
9285 prevent proper action when the event is pushed
9286 back into unread-command-events. */
9287 fake_prefixed_keys
= Fcons (key
, fake_prefixed_keys
);
9291 else if (CONSP (XCDR (key
))
9292 && CONSP (EVENT_START (key
))
9293 && CONSP (XCDR (EVENT_START (key
))))
9297 posn
= POSN_POSN (EVENT_START (key
));
9298 /* Handle menu-bar events:
9299 insert the dummy prefix event `menu-bar'. */
9300 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
9302 if (bufsize
- t
<= 1)
9303 error ("Key sequence too long");
9305 keybuf
[t
+ 1] = key
;
9307 /* Zap the position in key, so we know that we've
9308 expanded it, and don't try to do so again. */
9309 POSN_SET_POSN (EVENT_START (key
), list1 (posn
));
9312 goto replay_sequence
;
9314 else if (CONSP (posn
))
9316 /* We're looking at the second event of a
9317 sequence which we expanded before. Set
9318 last_real_key_start appropriately. */
9319 if (last_real_key_start
== t
&& t
> 0)
9320 last_real_key_start
= t
- 1;
9325 /* We have finally decided that KEY is something we might want
9327 new_binding
= follow_key (current_binding
, key
);
9329 /* If KEY wasn't bound, we'll try some fallbacks. */
9330 if (!NILP (new_binding
))
9331 /* This is needed for the following scenario:
9332 event 0: a down-event that gets dropped by calling replay_key.
9333 event 1: some normal prefix like C-h.
9334 After event 0, first_unbound is 0, after event 1 indec.start,
9335 fkey.start, and keytran.start are all 1, so when we see that
9336 C-h is bound, we need to update first_unbound. */
9337 first_unbound
= max (t
+ 1, first_unbound
);
9342 /* Remember the position to put an upper bound on indec.start. */
9343 first_unbound
= min (t
, first_unbound
);
9345 head
= EVENT_HEAD (key
);
9349 Lisp_Object breakdown
;
9352 breakdown
= parse_modifiers (head
);
9353 modifiers
= XINT (XCAR (XCDR (breakdown
)));
9354 /* Attempt to reduce an unbound mouse event to a simpler
9355 event that is bound:
9356 Drags reduce to clicks.
9357 Double-clicks reduce to clicks.
9358 Triple-clicks reduce to double-clicks, then to clicks.
9359 Up/Down-clicks are eliminated.
9360 Double-downs reduce to downs, then are eliminated.
9361 Triple-downs reduce to double-downs, then to downs,
9362 then are eliminated. */
9363 if (modifiers
& (up_modifier
| down_modifier
9365 | double_modifier
| triple_modifier
))
9367 while (modifiers
& (up_modifier
| down_modifier
9369 | double_modifier
| triple_modifier
))
9371 Lisp_Object new_head
, new_click
;
9372 if (modifiers
& triple_modifier
)
9373 modifiers
^= (double_modifier
| triple_modifier
);
9374 else if (modifiers
& double_modifier
)
9375 modifiers
&= ~double_modifier
;
9376 else if (modifiers
& drag_modifier
)
9377 modifiers
&= ~drag_modifier
;
9380 /* Dispose of this `up/down' event by simply jumping
9381 back to replay_key, to get another event.
9383 Note that if this event came from mock input,
9384 then just jumping back to replay_key will just
9385 hand it to us again. So we have to wipe out any
9388 We could delete keybuf[t] and shift everything
9389 after that to the left by one spot, but we'd also
9390 have to fix up any variable that points into
9391 keybuf, and shifting isn't really necessary
9394 Adding prefixes for non-textual mouse clicks
9395 creates two characters of mock input, and both
9396 must be thrown away. If we're only looking at
9397 the prefix now, we can just jump back to
9398 replay_key. On the other hand, if we've already
9399 processed the prefix, and now the actual click
9400 itself is giving us trouble, then we've lost the
9401 state of the keymaps we want to backtrack to, and
9402 we need to replay the whole sequence to rebuild
9405 Beyond that, only function key expansion could
9406 create more than two keys, but that should never
9407 generate mouse events, so it's okay to zero
9408 mock_input in that case too.
9410 FIXME: The above paragraph seems just plain
9411 wrong, if you consider things like
9412 xterm-mouse-mode. -stef
9414 Isn't this just the most wonderful code ever? */
9416 /* If mock_input > t + 1, the above simplification
9417 will actually end up dropping keys on the floor.
9418 This is probably OK for now, but even
9419 if mock_input <= t + 1, we need to adjust indec,
9421 Typical case [header-line down-mouse-N]:
9422 mock_input = 2, t = 1, fkey.end = 1,
9423 last_real_key_start = 0. */
9424 if (indec
.end
> last_real_key_start
)
9426 indec
.end
= indec
.start
9427 = min (last_real_key_start
, indec
.start
);
9428 indec
.map
= indec
.parent
;
9429 if (fkey
.end
> last_real_key_start
)
9431 fkey
.end
= fkey
.start
9432 = min (last_real_key_start
, fkey
.start
);
9433 fkey
.map
= fkey
.parent
;
9434 if (keytran
.end
> last_real_key_start
)
9436 keytran
.end
= keytran
.start
9437 = min (last_real_key_start
, keytran
.start
);
9438 keytran
.map
= keytran
.parent
;
9442 if (t
== last_real_key_start
)
9449 mock_input
= last_real_key_start
;
9450 goto replay_sequence
;
9455 = apply_modifiers (modifiers
, XCAR (breakdown
));
9456 new_click
= list2 (new_head
, EVENT_START (key
));
9458 /* Look for a binding for this new key. */
9459 new_binding
= follow_key (current_binding
, new_click
);
9461 /* If that click is bound, go for it. */
9462 if (!NILP (new_binding
))
9464 current_binding
= new_binding
;
9468 /* Otherwise, we'll leave key set to the drag event. */
9473 current_binding
= new_binding
;
9476 /* Normally, last_nonmenu_event gets the previous key we read.
9477 But when a mouse popup menu is being used,
9478 we don't update last_nonmenu_event; it continues to hold the mouse
9479 event that preceded the first level of menu. */
9480 if (!used_mouse_menu
)
9481 last_nonmenu_event
= key
;
9483 /* Record what part of this_command_keys is the current key sequence. */
9484 this_single_command_key_start
= this_command_key_count
- t
;
9485 /* When 'input-method-function' called above causes events to be
9486 put on 'unread-post-input-method-events', and as result
9487 'reread' is set to 'true', the value of 't' can become larger
9488 than 'this_command_key_count', because 'add_command_key' is
9489 not called to update 'this_command_key_count'. If this
9490 happens, 'this_single_command_key_start' will become negative
9491 above, and any call to 'this-single-command-keys' will return
9492 a garbled vector. See bug #20223 for one such situation.
9493 Here we force 'this_single_command_key_start' to never become
9494 negative, to avoid that. */
9495 if (this_single_command_key_start
< 0)
9496 this_single_command_key_start
= 0;
9498 /* Look for this sequence in input-decode-map.
9499 Scan from indec.end until we find a bound suffix. */
9500 while (indec
.end
< t
)
9505 done
= keyremap_step (keybuf
, bufsize
, &indec
, max (t
, mock_input
),
9509 mock_input
= diff
+ max (t
, mock_input
);
9510 goto replay_sequence
;
9514 if (!KEYMAPP (current_binding
)
9515 && !test_undefined (current_binding
)
9516 && indec
.start
>= t
)
9517 /* There is a binding and it's not a prefix.
9518 (and it doesn't have any input-decode-map translation pending).
9519 There is thus no function-key in this sequence.
9520 Moving fkey.start is important in this case to allow keytran.start
9521 to go over the sequence before we return (since we keep the
9522 invariant that keytran.end <= fkey.start). */
9525 (fkey
.start
= fkey
.end
= t
, fkey
.map
= fkey
.parent
);
9528 /* If the sequence is unbound, see if we can hang a function key
9529 off the end of it. */
9530 /* Continue scan from fkey.end until we find a bound suffix. */
9531 while (fkey
.end
< indec
.start
)
9536 done
= keyremap_step (keybuf
, bufsize
, &fkey
,
9537 max (t
, mock_input
),
9538 /* If there's a binding (i.e.
9539 first_binding >= nmaps) we don't want
9540 to apply this function-key-mapping. */
9542 && (test_undefined (current_binding
)),
9546 mock_input
= diff
+ max (t
, mock_input
);
9547 /* Adjust the input-decode-map counters. */
9549 indec
.start
+= diff
;
9551 goto replay_sequence
;
9555 /* Look for this sequence in key-translation-map.
9556 Scan from keytran.end until we find a bound suffix. */
9557 while (keytran
.end
< fkey
.start
)
9562 done
= keyremap_step (keybuf
, bufsize
, &keytran
, max (t
, mock_input
),
9566 mock_input
= diff
+ max (t
, mock_input
);
9567 /* Adjust the function-key-map and input-decode-map counters. */
9569 indec
.start
+= diff
;
9573 goto replay_sequence
;
9577 /* If KEY is not defined in any of the keymaps,
9578 and cannot be part of a function key or translation,
9579 and is an upper case letter
9580 use the corresponding lower-case letter instead. */
9581 if (NILP (current_binding
)
9582 && /* indec.start >= t && fkey.start >= t && */ keytran
.start
>= t
9584 && ((CHARACTERP (make_number (XINT (key
) & ~CHAR_MODIFIER_MASK
))
9585 && uppercasep (XINT (key
) & ~CHAR_MODIFIER_MASK
))
9586 || (XINT (key
) & shift_modifier
)))
9588 Lisp_Object new_key
;
9590 original_uppercase
= key
;
9591 original_uppercase_position
= t
- 1;
9593 if (XINT (key
) & shift_modifier
)
9594 XSETINT (new_key
, XINT (key
) & ~shift_modifier
);
9596 XSETINT (new_key
, (downcase (XINT (key
) & ~CHAR_MODIFIER_MASK
)
9597 | (XINT (key
) & CHAR_MODIFIER_MASK
)));
9599 /* We have to do this unconditionally, regardless of whether
9600 the lower-case char is defined in the keymaps, because they
9601 might get translated through function-key-map. */
9602 keybuf
[t
- 1] = new_key
;
9603 mock_input
= max (t
, mock_input
);
9604 shift_translated
= true;
9606 goto replay_sequence
;
9609 if (NILP (current_binding
)
9610 && help_char_p (EVENT_HEAD (key
)) && t
> 1)
9612 read_key_sequence_cmd
= Vprefix_help_command
;
9613 /* The Microsoft C compiler can't handle the goto that
9619 /* If KEY is not defined in any of the keymaps,
9620 and cannot be part of a function key or translation,
9621 and is a shifted function key,
9622 use the corresponding unshifted function key instead. */
9623 if (NILP (current_binding
)
9624 && /* indec.start >= t && fkey.start >= t && */ keytran
.start
>= t
)
9626 Lisp_Object breakdown
= parse_modifiers (key
);
9628 = CONSP (breakdown
) ? (XINT (XCAR (XCDR (breakdown
)))) : 0;
9630 if (modifiers
& shift_modifier
9631 /* Treat uppercase keys as shifted. */
9633 && (KEY_TO_CHAR (key
)
9634 < XCHAR_TABLE (BVAR (current_buffer
, downcase_table
))->header
.size
)
9635 && uppercasep (KEY_TO_CHAR (key
))))
9638 = (modifiers
& shift_modifier
9639 ? apply_modifiers (modifiers
& ~shift_modifier
,
9641 : make_number (downcase (KEY_TO_CHAR (key
)) | modifiers
));
9643 original_uppercase
= key
;
9644 original_uppercase_position
= t
- 1;
9646 /* We have to do this unconditionally, regardless of whether
9647 the lower-case char is defined in the keymaps, because they
9648 might get translated through function-key-map. */
9649 keybuf
[t
- 1] = new_key
;
9650 mock_input
= max (t
, mock_input
);
9651 /* Reset fkey (and consequently keytran) to apply
9652 function-key-map on the result, so that S-backspace is
9653 correctly mapped to DEL (via backspace). OTOH,
9654 input-decode-map doesn't need to go through it again. */
9655 fkey
.start
= fkey
.end
= 0;
9656 keytran
.start
= keytran
.end
= 0;
9657 shift_translated
= true;
9659 goto replay_sequence
;
9664 read_key_sequence_cmd
= current_binding
;
9665 read_key_sequence_remapped
9666 /* Remap command through active keymaps.
9667 Do the remapping here, before the unbind_to so it uses the keymaps
9668 of the appropriate buffer. */
9669 = SYMBOLP (read_key_sequence_cmd
)
9670 ? Fcommand_remapping (read_key_sequence_cmd
, Qnil
, Qnil
)
9673 unread_switch_frame
= delayed_switch_frame
;
9674 unbind_to (count
, Qnil
);
9676 /* Don't downcase the last character if the caller says don't.
9677 Don't downcase it if the result is undefined, either. */
9678 if ((dont_downcase_last
|| NILP (current_binding
))
9680 && t
- 1 == original_uppercase_position
)
9682 keybuf
[t
- 1] = original_uppercase
;
9683 shift_translated
= false;
9686 if (shift_translated
)
9687 Vthis_command_keys_shift_translated
= Qt
;
9689 /* Occasionally we fabricate events, perhaps by expanding something
9690 according to function-key-map, or by adding a prefix symbol to a
9691 mouse click in the scroll bar or modeline. In this cases, return
9692 the entire generated key sequence, even if we hit an unbound
9693 prefix or a definition before the end. This means that you will
9694 be able to push back the event properly, and also means that
9695 read-key-sequence will always return a logical unit.
9698 for (; t
< mock_input
; t
++)
9699 add_command_key (keybuf
[t
]);
9706 read_key_sequence_vs (Lisp_Object prompt
, Lisp_Object continue_echo
,
9707 Lisp_Object dont_downcase_last
,
9708 Lisp_Object can_return_switch_frame
,
9709 Lisp_Object cmd_loop
, bool allow_string
)
9711 Lisp_Object keybuf
[30];
9713 ptrdiff_t count
= SPECPDL_INDEX ();
9716 CHECK_STRING (prompt
);
9719 specbind (Qinput_method_exit_on_first_char
,
9720 (NILP (cmd_loop
) ? Qt
: Qnil
));
9721 specbind (Qinput_method_use_echo_area
,
9722 (NILP (cmd_loop
) ? Qt
: Qnil
));
9724 if (NILP (continue_echo
))
9726 this_command_key_count
= 0;
9727 this_single_command_key_start
= 0;
9730 #ifdef HAVE_WINDOW_SYSTEM
9731 if (display_hourglass_p
)
9732 cancel_hourglass ();
9735 i
= read_key_sequence (keybuf
, ARRAYELTS (keybuf
),
9736 prompt
, ! NILP (dont_downcase_last
),
9737 ! NILP (can_return_switch_frame
), 0, 0);
9739 #if 0 /* The following is fine for code reading a key sequence and
9740 then proceeding with a lengthy computation, but it's not good
9741 for code reading keys in a loop, like an input method. */
9742 #ifdef HAVE_WINDOW_SYSTEM
9743 if (display_hourglass_p
)
9754 return unbind_to (count
,
9755 ((allow_string
? make_event_array
: Fvector
)
9759 DEFUN ("read-key-sequence", Fread_key_sequence
, Sread_key_sequence
, 1, 5, 0,
9760 doc
: /* Read a sequence of keystrokes and return as a string or vector.
9761 The sequence is sufficient to specify a non-prefix command in the
9762 current local and global maps.
9764 First arg PROMPT is a prompt string. If nil, do not prompt specially.
9765 Second (optional) arg CONTINUE-ECHO, if non-nil, means this key echos
9766 as a continuation of the previous key.
9768 The third (optional) arg DONT-DOWNCASE-LAST, if non-nil, means do not
9769 convert the last event to lower case. (Normally any upper case event
9770 is converted to lower case if the original event is undefined and the lower
9771 case equivalent is defined.) A non-nil value is appropriate for reading
9772 a key sequence to be defined.
9774 A C-g typed while in this function is treated like any other character,
9775 and `quit-flag' is not set.
9777 If the key sequence starts with a mouse click, then the sequence is read
9778 using the keymaps of the buffer of the window clicked in, not the buffer
9779 of the selected window as normal.
9781 `read-key-sequence' drops unbound button-down events, since you normally
9782 only care about the click or drag events which follow them. If a drag
9783 or multi-click event is unbound, but the corresponding click event would
9784 be bound, `read-key-sequence' turns the event into a click event at the
9785 drag's starting position. This means that you don't have to distinguish
9786 between click and drag, double, or triple events unless you want to.
9788 `read-key-sequence' prefixes mouse events on mode lines, the vertical
9789 lines separating windows, and scroll bars with imaginary keys
9790 `mode-line', `vertical-line', and `vertical-scroll-bar'.
9792 Optional fourth argument CAN-RETURN-SWITCH-FRAME non-nil means that this
9793 function will process a switch-frame event if the user switches frames
9794 before typing anything. If the user switches frames in the middle of a
9795 key sequence, or at the start of the sequence but CAN-RETURN-SWITCH-FRAME
9796 is nil, then the event will be put off until after the current key sequence.
9798 `read-key-sequence' checks `function-key-map' for function key
9799 sequences, where they wouldn't conflict with ordinary bindings. See
9800 `function-key-map' for more details.
9802 The optional fifth argument CMD-LOOP, if non-nil, means
9803 that this key sequence is being read by something that will
9804 read commands one after another. It should be nil if the caller
9805 will read just one key sequence. */)
9806 (Lisp_Object prompt
, Lisp_Object continue_echo
, Lisp_Object dont_downcase_last
, Lisp_Object can_return_switch_frame
, Lisp_Object cmd_loop
)
9808 return read_key_sequence_vs (prompt
, continue_echo
, dont_downcase_last
,
9809 can_return_switch_frame
, cmd_loop
, true);
9812 DEFUN ("read-key-sequence-vector", Fread_key_sequence_vector
,
9813 Sread_key_sequence_vector
, 1, 5, 0,
9814 doc
: /* Like `read-key-sequence' but always return a vector. */)
9815 (Lisp_Object prompt
, Lisp_Object continue_echo
, Lisp_Object dont_downcase_last
, Lisp_Object can_return_switch_frame
, Lisp_Object cmd_loop
)
9817 return read_key_sequence_vs (prompt
, continue_echo
, dont_downcase_last
,
9818 can_return_switch_frame
, cmd_loop
, false);
9821 /* Return true if input events are pending. */
9824 detect_input_pending (void)
9826 return input_pending
|| get_input_pending (0);
9829 /* Return true if input events other than mouse movements are
9833 detect_input_pending_ignore_squeezables (void)
9835 return input_pending
|| get_input_pending (READABLE_EVENTS_IGNORE_SQUEEZABLES
);
9838 /* Return true if input events are pending, and run any pending timers. */
9841 detect_input_pending_run_timers (bool do_display
)
9843 unsigned old_timers_run
= timers_run
;
9846 get_input_pending (READABLE_EVENTS_DO_TIMERS_NOW
);
9848 if (old_timers_run
!= timers_run
&& do_display
)
9849 redisplay_preserve_echo_area (8);
9851 return input_pending
;
9854 /* This is called in some cases before a possible quit.
9855 It cases the next call to detect_input_pending to recompute input_pending.
9856 So calling this function unnecessarily can't do any harm. */
9859 clear_input_pending (void)
9861 input_pending
= false;
9864 /* Return true if there are pending requeued events.
9865 This isn't used yet. The hope is to make wait_reading_process_output
9866 call it, and return if it runs Lisp code that unreads something.
9867 The problem is, kbd_buffer_get_event needs to be fixed to know what
9868 to do in that case. It isn't trivial. */
9871 requeued_events_pending_p (void)
9873 return (!NILP (Vunread_command_events
));
9876 DEFUN ("input-pending-p", Finput_pending_p
, Sinput_pending_p
, 0, 1, 0,
9877 doc
: /* Return t if command input is currently available with no wait.
9878 Actually, the value is nil only if we can be sure that no input is available;
9879 if there is a doubt, the value is t.
9881 If CHECK-TIMERS is non-nil, timers that are ready to run will do so. */)
9882 (Lisp_Object check_timers
)
9884 if (!NILP (Vunread_command_events
)
9885 || !NILP (Vunread_post_input_method_events
)
9886 || !NILP (Vunread_input_method_events
))
9889 /* Process non-user-visible events (Bug#10195). */
9890 process_special_events ();
9892 return (get_input_pending ((NILP (check_timers
)
9893 ? 0 : READABLE_EVENTS_DO_TIMERS_NOW
)
9894 | READABLE_EVENTS_FILTER_EVENTS
)
9898 DEFUN ("recent-keys", Frecent_keys
, Srecent_keys
, 0, 1, 0,
9899 doc
: /* Return vector of last few events, not counting those from keyboard macros.
9900 If INCLUDE-CMDS is non-nil, include the commands that were run,
9901 represented as events of the form (nil . COMMAND). */)
9902 (Lisp_Object include_cmds
)
9904 bool cmds
= !NILP (include_cmds
);
9907 || (cmds
&& total_keys
< NUM_RECENT_KEYS
))
9908 return Fvector (total_keys
,
9909 XVECTOR (recent_keys
)->contents
);
9912 Lisp_Object es
= Qnil
;
9913 int i
= (total_keys
< NUM_RECENT_KEYS
9914 ? 0 : recent_keys_index
);
9915 eassert (recent_keys_index
< NUM_RECENT_KEYS
);
9918 Lisp_Object e
= AREF (recent_keys
, i
);
9919 if (cmds
|| !CONSP (e
) || !NILP (XCAR (e
)))
9921 if (++i
>= NUM_RECENT_KEYS
)
9923 } while (i
!= recent_keys_index
);
9924 es
= Fnreverse (es
);
9925 return Fvconcat (1, &es
);
9929 DEFUN ("this-command-keys", Fthis_command_keys
, Sthis_command_keys
, 0, 0, 0,
9930 doc
: /* Return the key sequence that invoked this command.
9931 However, if the command has called `read-key-sequence', it returns
9932 the last key sequence that has been read.
9933 The value is a string or a vector.
9935 See also `this-command-keys-vector'. */)
9938 return make_event_array (this_command_key_count
,
9939 XVECTOR (this_command_keys
)->contents
);
9942 DEFUN ("this-command-keys-vector", Fthis_command_keys_vector
, Sthis_command_keys_vector
, 0, 0, 0,
9943 doc
: /* Return the key sequence that invoked this command, as a vector.
9944 However, if the command has called `read-key-sequence', it returns
9945 the last key sequence that has been read.
9947 See also `this-command-keys'. */)
9950 return Fvector (this_command_key_count
,
9951 XVECTOR (this_command_keys
)->contents
);
9954 DEFUN ("this-single-command-keys", Fthis_single_command_keys
,
9955 Sthis_single_command_keys
, 0, 0, 0,
9956 doc
: /* Return the key sequence that invoked this command.
9957 More generally, it returns the last key sequence read, either by
9958 the command loop or by `read-key-sequence'.
9959 Unlike `this-command-keys', this function's value
9960 does not include prefix arguments.
9961 The value is always a vector. */)
9964 return Fvector (this_command_key_count
9965 - this_single_command_key_start
,
9966 (XVECTOR (this_command_keys
)->contents
9967 + this_single_command_key_start
));
9970 DEFUN ("this-single-command-raw-keys", Fthis_single_command_raw_keys
,
9971 Sthis_single_command_raw_keys
, 0, 0, 0,
9972 doc
: /* Return the raw events that were read for this command.
9973 More generally, it returns the last key sequence read, either by
9974 the command loop or by `read-key-sequence'.
9975 Unlike `this-single-command-keys', this function's value
9976 shows the events before all translations (except for input methods).
9977 The value is always a vector. */)
9980 return Fvector (raw_keybuf_count
, XVECTOR (raw_keybuf
)->contents
);
9983 DEFUN ("clear-this-command-keys", Fclear_this_command_keys
,
9984 Sclear_this_command_keys
, 0, 1, 0,
9985 doc
: /* Clear out the vector that `this-command-keys' returns.
9986 Also clear the record of the last 100 events, unless optional arg
9987 KEEP-RECORD is non-nil. */)
9988 (Lisp_Object keep_record
)
9992 this_command_key_count
= 0;
9994 if (NILP (keep_record
))
9996 for (i
= 0; i
< ASIZE (recent_keys
); ++i
)
9997 ASET (recent_keys
, i
, Qnil
);
9999 recent_keys_index
= 0;
10004 DEFUN ("recursion-depth", Frecursion_depth
, Srecursion_depth
, 0, 0, 0,
10005 doc
: /* Return the current depth in recursive edits. */)
10009 /* Wrap around reliably on integer overflow. */
10010 EMACS_INT sum
= (command_loop_level
& INTMASK
) + (minibuf_level
& INTMASK
);
10011 XSETINT (temp
, sum
);
10015 DEFUN ("open-dribble-file", Fopen_dribble_file
, Sopen_dribble_file
, 1, 1,
10016 "FOpen dribble file: ",
10017 doc
: /* Start writing all keyboard characters to a dribble file called FILE.
10018 If FILE is nil, close any open dribble file.
10019 The file will be closed when Emacs exits.
10021 Be aware that this records ALL characters you type!
10022 This may include sensitive information such as passwords. */)
10035 Lisp_Object encfile
;
10037 file
= Fexpand_file_name (file
, Qnil
);
10038 encfile
= ENCODE_FILE (file
);
10039 fd
= emacs_open (SSDATA (encfile
), O_WRONLY
| O_CREAT
| O_EXCL
, 0600);
10040 if (fd
< 0 && errno
== EEXIST
&& unlink (SSDATA (encfile
)) == 0)
10041 fd
= emacs_open (SSDATA (encfile
), O_WRONLY
| O_CREAT
| O_EXCL
, 0600);
10042 dribble
= fd
< 0 ? 0 : fdopen (fd
, "w");
10044 report_file_error ("Opening dribble", file
);
10049 DEFUN ("discard-input", Fdiscard_input
, Sdiscard_input
, 0, 0, 0,
10050 doc
: /* Discard the contents of the terminal input buffer.
10051 Also end any kbd macro being defined. */)
10054 if (!NILP (KVAR (current_kboard
, defining_kbd_macro
)))
10056 /* Discard the last command from the macro. */
10057 Fcancel_kbd_macro_events ();
10061 Vunread_command_events
= Qnil
;
10063 discard_tty_input ();
10065 kbd_fetch_ptr
= kbd_store_ptr
;
10066 input_pending
= false;
10071 DEFUN ("suspend-emacs", Fsuspend_emacs
, Ssuspend_emacs
, 0, 1, "",
10072 doc
: /* Stop Emacs and return to superior process. You can resume later.
10073 If `cannot-suspend' is non-nil, or if the system doesn't support job
10074 control, run a subshell instead.
10076 If optional arg STUFFSTRING is non-nil, its characters are stuffed
10077 to be read as terminal input by Emacs's parent, after suspension.
10079 Before suspending, run the normal hook `suspend-hook'.
10080 After resumption run the normal hook `suspend-resume-hook'.
10082 Some operating systems cannot stop the Emacs process and resume it later.
10083 On such systems, Emacs starts a subshell instead of suspending. */)
10084 (Lisp_Object stuffstring
)
10086 ptrdiff_t count
= SPECPDL_INDEX ();
10087 int old_height
, old_width
;
10090 if (tty_list
&& tty_list
->next
)
10091 error ("There are other tty frames open; close them before suspending Emacs");
10093 if (!NILP (stuffstring
))
10094 CHECK_STRING (stuffstring
);
10096 run_hook (intern ("suspend-hook"));
10098 get_tty_size (fileno (CURTTY ()->input
), &old_width
, &old_height
);
10099 reset_all_sys_modes ();
10100 /* sys_suspend can get an error if it tries to fork a subshell
10101 and the system resources aren't available for that. */
10102 record_unwind_protect_void (init_all_sys_modes
);
10103 stuff_buffered_input (stuffstring
);
10104 if (cannot_suspend
)
10108 unbind_to (count
, Qnil
);
10110 /* Check if terminal/window size has changed.
10111 Note that this is not useful when we are running directly
10112 with a window system; but suspend should be disabled in that case. */
10113 get_tty_size (fileno (CURTTY ()->input
), &width
, &height
);
10114 if (width
!= old_width
|| height
!= old_height
)
10115 change_frame_size (SELECTED_FRAME (), width
,
10116 height
- FRAME_MENU_BAR_LINES (SELECTED_FRAME ()),
10119 run_hook (intern ("suspend-resume-hook"));
10124 /* If STUFFSTRING is a string, stuff its contents as pending terminal input.
10125 Then in any case stuff anything Emacs has read ahead and not used. */
10128 stuff_buffered_input (Lisp_Object stuffstring
)
10130 #ifdef SIGTSTP /* stuff_char is defined if SIGTSTP. */
10131 register unsigned char *p
;
10133 if (STRINGP (stuffstring
))
10135 register ptrdiff_t count
;
10137 p
= SDATA (stuffstring
);
10138 count
= SBYTES (stuffstring
);
10139 while (count
-- > 0)
10144 /* Anything we have read ahead, put back for the shell to read. */
10145 /* ?? What should this do when we have multiple keyboards??
10146 Should we ignore anything that was typed in at the "wrong" kboard?
10148 rms: we should stuff everything back into the kboard
10150 for (; kbd_fetch_ptr
!= kbd_store_ptr
; kbd_fetch_ptr
++)
10153 if (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
10154 kbd_fetch_ptr
= kbd_buffer
;
10155 if (kbd_fetch_ptr
->kind
== ASCII_KEYSTROKE_EVENT
)
10156 stuff_char (kbd_fetch_ptr
->ie
.code
);
10158 clear_event (kbd_fetch_ptr
);
10161 input_pending
= false;
10162 #endif /* SIGTSTP */
10166 set_waiting_for_input (struct timespec
*time_to_clear
)
10168 input_available_clear_time
= time_to_clear
;
10170 /* Tell handle_interrupt to throw back to read_char, */
10171 waiting_for_input
= true;
10173 /* If handle_interrupt was called before and buffered a C-g,
10174 make it run again now, to avoid timing error. */
10175 if (!NILP (Vquit_flag
))
10176 quit_throw_to_read_char (0);
10180 clear_waiting_for_input (void)
10182 /* Tell handle_interrupt not to throw back to read_char, */
10183 waiting_for_input
= false;
10184 input_available_clear_time
= 0;
10187 /* The SIGINT handler.
10189 If we have a frame on the controlling tty, we assume that the
10190 SIGINT was generated by C-g, so we call handle_interrupt.
10191 Otherwise, tell QUIT to kill Emacs. */
10194 handle_interrupt_signal (int sig
)
10196 /* See if we have an active terminal on our controlling tty. */
10197 struct terminal
*terminal
= get_named_terminal ("/dev/tty");
10200 /* If there are no frames there, let's pretend that we are a
10201 well-behaving UN*X program and quit. We must not call Lisp
10202 in a signal handler, so tell QUIT to exit when it is
10204 Vquit_flag
= Qkill_emacs
;
10208 /* Otherwise, the SIGINT was probably generated by C-g. */
10210 /* Set internal_last_event_frame to the top frame of the
10211 controlling tty, if we have a frame there. We disable the
10212 interrupt key on secondary ttys, so the SIGINT must have come
10213 from the controlling tty. */
10214 internal_last_event_frame
= terminal
->display_info
.tty
->top_frame
;
10216 handle_interrupt (1);
10221 deliver_interrupt_signal (int sig
)
10223 deliver_process_signal (sig
, handle_interrupt_signal
);
10226 /* Output MSG directly to standard output, without buffering. Ignore
10227 failures. This is safe in a signal handler. */
10229 write_stdout (char const *msg
)
10231 ignore_value (write (STDOUT_FILENO
, msg
, strlen (msg
)));
10234 /* Read a byte from stdin, without buffering. Safe in signal handlers. */
10239 return read (STDIN_FILENO
, &c
, 1) == 1 ? c
: EOF
;
10242 /* If Emacs is stuck because `inhibit-quit' is true, then keep track
10243 of the number of times C-g has been requested. If C-g is pressed
10244 enough times, then quit anyway. See bug#6585. */
10245 static int volatile force_quit_count
;
10247 /* This routine is called at interrupt level in response to C-g.
10249 It is called from the SIGINT handler or kbd_buffer_store_event.
10251 If `waiting_for_input' is non zero, then unless `echoing' is
10252 nonzero, immediately throw back to read_char.
10254 Otherwise it sets the Lisp variable quit-flag not-nil. This causes
10255 eval to throw, when it gets a chance. If quit-flag is already
10256 non-nil, it stops the job right away. */
10259 handle_interrupt (bool in_signal_handler
)
10265 /* XXX This code needs to be revised for multi-tty support. */
10266 if (!NILP (Vquit_flag
) && get_named_terminal ("/dev/tty"))
10268 if (! in_signal_handler
)
10270 /* If SIGINT isn't blocked, don't let us be interrupted by
10271 a SIGINT. It might be harmful due to non-reentrancy
10272 in I/O functions. */
10274 sigemptyset (&blocked
);
10275 sigaddset (&blocked
, SIGINT
);
10276 pthread_sigmask (SIG_BLOCK
, &blocked
, 0);
10280 reset_all_sys_modes ();
10284 * On systems which can suspend the current process and return to the original
10285 * shell, this command causes the user to end up back at the shell.
10286 * The "Auto-save" and "Abort" questions are not asked until
10287 * the user elects to return to emacs, at which point he can save the current
10288 * job and either dump core or continue.
10292 /* Perhaps should really fork an inferior shell?
10293 But that would not provide any way to get back
10294 to the original shell, ever. */
10295 write_stdout ("No support for stopping a process"
10296 " on this operating system;\n"
10297 "you can continue or abort.\n");
10298 #endif /* not SIGTSTP */
10300 /* We must remain inside the screen area when the internal terminal
10301 is used. Note that [Enter] is not echoed by dos. */
10302 cursor_to (SELECTED_FRAME (), 0, 0);
10304 /* It doesn't work to autosave while GC is in progress;
10305 the code used for auto-saving doesn't cope with the mark bit. */
10306 if (!gc_in_progress
)
10308 write_stdout ("Auto-save? (y or n) ");
10310 if ((c
& 040) == 'Y')
10312 Fdo_auto_save (Qt
, Qnil
);
10314 write_stdout ("\r\nAuto-save done");
10316 write_stdout ("Auto-save done\n");
10324 /* During GC, it must be safe to reenable quitting again. */
10325 Vinhibit_quit
= Qnil
;
10331 "Garbage collection in progress; cannot auto-save now\r\n"
10332 "but will instead do a real quit"
10333 " after garbage collection ends\r\n");
10337 write_stdout ("\r\nAbort? (y or n) ");
10339 write_stdout ("Abort (and dump core)? (y or n) ");
10342 if ((c
& ~040) == 'Y')
10347 write_stdout ("\r\nContinuing...\r\n");
10348 #else /* not MSDOS */
10349 write_stdout ("Continuing...\n");
10350 #endif /* not MSDOS */
10351 init_all_sys_modes ();
10355 /* If executing a function that wants to be interrupted out of
10356 and the user has not deferred quitting by binding `inhibit-quit'
10357 then quit right away. */
10358 if (immediate_quit
&& NILP (Vinhibit_quit
))
10360 struct gl_state_s saved
;
10362 immediate_quit
= false;
10363 pthread_sigmask (SIG_SETMASK
, &empty_mask
, 0);
10365 Fsignal (Qquit
, Qnil
);
10369 { /* Else request quit when it's safe. */
10370 int count
= NILP (Vquit_flag
) ? 1 : force_quit_count
+ 1;
10371 force_quit_count
= count
;
10374 immediate_quit
= true;
10375 Vinhibit_quit
= Qnil
;
10381 pthread_sigmask (SIG_SETMASK
, &empty_mask
, 0);
10383 /* TODO: The longjmp in this call throws the NS event loop integration off,
10384 and it seems to do fine without this. Probably some attention
10385 needs to be paid to the setting of waiting_for_input in
10386 wait_reading_process_output() under HAVE_NS because of the call
10387 to ns_select there (needed because otherwise events aren't picked up
10388 outside of polling since we don't get SIGIO like X and we don't have a
10389 separate event loop thread like W32. */
10391 if (waiting_for_input
&& !echoing
)
10392 quit_throw_to_read_char (in_signal_handler
);
10396 /* Handle a C-g by making read_char return C-g. */
10399 quit_throw_to_read_char (bool from_signal
)
10401 /* When not called from a signal handler it is safe to call
10403 if (!from_signal
&& EQ (Vquit_flag
, Qkill_emacs
))
10404 Fkill_emacs (Qnil
);
10406 /* Prevent another signal from doing this before we finish. */
10407 clear_waiting_for_input ();
10408 input_pending
= false;
10410 Vunread_command_events
= Qnil
;
10412 if (FRAMEP (internal_last_event_frame
)
10413 && !EQ (internal_last_event_frame
, selected_frame
))
10414 do_switch_frame (make_lispy_switch_frame (internal_last_event_frame
),
10417 sys_longjmp (getcjmp
, 1);
10420 DEFUN ("set-input-interrupt-mode", Fset_input_interrupt_mode
,
10421 Sset_input_interrupt_mode
, 1, 1, 0,
10422 doc
: /* Set interrupt mode of reading keyboard input.
10423 If INTERRUPT is non-nil, Emacs will use input interrupts;
10424 otherwise Emacs uses CBREAK mode.
10426 See also `current-input-mode'. */)
10427 (Lisp_Object interrupt
)
10429 bool new_interrupt_input
;
10430 #ifdef USABLE_SIGIO
10431 #ifdef HAVE_X_WINDOWS
10432 if (x_display_list
!= NULL
)
10434 /* When using X, don't give the user a real choice,
10435 because we haven't implemented the mechanisms to support it. */
10436 new_interrupt_input
= true;
10439 #endif /* HAVE_X_WINDOWS */
10440 new_interrupt_input
= !NILP (interrupt
);
10441 #else /* not USABLE_SIGIO */
10442 new_interrupt_input
= false;
10443 #endif /* not USABLE_SIGIO */
10445 if (new_interrupt_input
!= interrupt_input
)
10447 #ifdef POLL_FOR_INPUT
10451 /* this causes startup screen to be restored and messes with the mouse */
10452 reset_all_sys_modes ();
10453 interrupt_input
= new_interrupt_input
;
10454 init_all_sys_modes ();
10456 interrupt_input
= new_interrupt_input
;
10459 #ifdef POLL_FOR_INPUT
10460 poll_suppress_count
= 1;
10467 DEFUN ("set-output-flow-control", Fset_output_flow_control
, Sset_output_flow_control
, 1, 2, 0,
10468 doc
: /* Enable or disable ^S/^Q flow control for output to TERMINAL.
10469 If FLOW is non-nil, flow control is enabled and you cannot use C-s or
10470 C-q in key sequences.
10472 This setting only has an effect on tty terminals and only when
10473 Emacs reads input in CBREAK mode; see `set-input-interrupt-mode'.
10475 See also `current-input-mode'. */)
10476 (Lisp_Object flow
, Lisp_Object terminal
)
10478 struct terminal
*t
= decode_tty_terminal (terminal
);
10479 struct tty_display_info
*tty
;
10483 tty
= t
->display_info
.tty
;
10485 if (tty
->flow_control
!= !NILP (flow
))
10488 /* This causes startup screen to be restored and messes with the mouse. */
10489 reset_sys_modes (tty
);
10492 tty
->flow_control
= !NILP (flow
);
10495 init_sys_modes (tty
);
10501 DEFUN ("set-input-meta-mode", Fset_input_meta_mode
, Sset_input_meta_mode
, 1, 2, 0,
10502 doc
: /* Enable or disable 8-bit input on TERMINAL.
10503 If META is t, Emacs will accept 8-bit input, and interpret the 8th
10504 bit as the Meta modifier.
10506 If META is nil, Emacs will ignore the top bit, on the assumption it is
10509 Otherwise, Emacs will accept and pass through 8-bit input without
10510 specially interpreting the top bit.
10512 This setting only has an effect on tty terminal devices.
10514 Optional parameter TERMINAL specifies the tty terminal device to use.
10515 It may be a terminal object, a frame, or nil for the terminal used by
10516 the currently selected frame.
10518 See also `current-input-mode'. */)
10519 (Lisp_Object meta
, Lisp_Object terminal
)
10521 struct terminal
*t
= decode_tty_terminal (terminal
);
10522 struct tty_display_info
*tty
;
10527 tty
= t
->display_info
.tty
;
10531 else if (EQ (meta
, Qt
))
10536 if (tty
->meta_key
!= new_meta
)
10539 /* this causes startup screen to be restored and messes with the mouse */
10540 reset_sys_modes (tty
);
10543 tty
->meta_key
= new_meta
;
10546 init_sys_modes (tty
);
10552 DEFUN ("set-quit-char", Fset_quit_char
, Sset_quit_char
, 1, 1, 0,
10553 doc
: /* Specify character used for quitting.
10554 QUIT must be an ASCII character.
10556 This function only has an effect on the controlling tty of the Emacs
10559 See also `current-input-mode'. */)
10562 struct terminal
*t
= get_named_terminal ("/dev/tty");
10563 struct tty_display_info
*tty
;
10567 tty
= t
->display_info
.tty
;
10569 if (NILP (quit
) || !INTEGERP (quit
) || XINT (quit
) < 0 || XINT (quit
) > 0400)
10570 error ("QUIT must be an ASCII character");
10573 /* this causes startup screen to be restored and messes with the mouse */
10574 reset_sys_modes (tty
);
10577 /* Don't let this value be out of range. */
10578 quit_char
= XINT (quit
) & (tty
->meta_key
== 0 ? 0177 : 0377);
10581 init_sys_modes (tty
);
10587 DEFUN ("set-input-mode", Fset_input_mode
, Sset_input_mode
, 3, 4, 0,
10588 doc
: /* Set mode of reading keyboard input.
10589 First arg INTERRUPT non-nil means use input interrupts;
10590 nil means use CBREAK mode.
10591 Second arg FLOW non-nil means use ^S/^Q flow control for output to terminal
10592 (no effect except in CBREAK mode).
10593 Third arg META t means accept 8-bit input (for a Meta key).
10594 META nil means ignore the top bit, on the assumption it is parity.
10595 Otherwise, accept 8-bit input and don't use the top bit for Meta.
10596 Optional fourth arg QUIT if non-nil specifies character to use for quitting.
10597 See also `current-input-mode'. */)
10598 (Lisp_Object interrupt
, Lisp_Object flow
, Lisp_Object meta
, Lisp_Object quit
)
10600 Fset_input_interrupt_mode (interrupt
);
10601 Fset_output_flow_control (flow
, Qnil
);
10602 Fset_input_meta_mode (meta
, Qnil
);
10604 Fset_quit_char (quit
);
10608 DEFUN ("current-input-mode", Fcurrent_input_mode
, Scurrent_input_mode
, 0, 0, 0,
10609 doc
: /* Return information about the way Emacs currently reads keyboard input.
10610 The value is a list of the form (INTERRUPT FLOW META QUIT), where
10611 INTERRUPT is non-nil if Emacs is using interrupt-driven input; if
10612 nil, Emacs is using CBREAK mode.
10613 FLOW is non-nil if Emacs uses ^S/^Q flow control for output to the
10614 terminal; this does not apply if Emacs uses interrupt-driven input.
10615 META is t if accepting 8-bit input with 8th bit as Meta flag.
10616 META nil means ignoring the top bit, on the assumption it is parity.
10617 META is neither t nor nil if accepting 8-bit input and using
10618 all 8 bits as the character code.
10619 QUIT is the character Emacs currently uses to quit.
10620 The elements of this list correspond to the arguments of
10621 `set-input-mode'. */)
10624 struct frame
*sf
= XFRAME (selected_frame
);
10626 Lisp_Object interrupt
= interrupt_input
? Qt
: Qnil
;
10627 Lisp_Object flow
, meta
;
10628 if (FRAME_TERMCAP_P (sf
) || FRAME_MSDOS_P (sf
))
10630 flow
= FRAME_TTY (sf
)->flow_control
? Qt
: Qnil
;
10631 meta
= (FRAME_TTY (sf
)->meta_key
== 2
10633 : (CURTTY ()->meta_key
== 1 ? Qt
: Qnil
));
10640 Lisp_Object quit
= make_number (quit_char
);
10642 return list4 (interrupt
, flow
, meta
, quit
);
10645 DEFUN ("posn-at-x-y", Fposn_at_x_y
, Sposn_at_x_y
, 2, 4, 0,
10646 doc
: /* Return position information for pixel coordinates X and Y.
10647 By default, X and Y are relative to text area of the selected window.
10648 Optional third arg FRAME-OR-WINDOW non-nil specifies frame or window.
10649 If optional fourth arg WHOLE is non-nil, X is relative to the left
10650 edge of the window.
10652 The return value is similar to a mouse click position:
10653 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
10654 IMAGE (DX . DY) (WIDTH . HEIGHT))
10655 The `posn-' functions access elements of such lists. */)
10656 (Lisp_Object x
, Lisp_Object y
, Lisp_Object frame_or_window
, Lisp_Object whole
)
10659 /* We allow X of -1, for the newline in a R2L line that overflowed
10660 into the left fringe. */
10661 if (XINT (x
) != -1)
10665 if (NILP (frame_or_window
))
10666 frame_or_window
= selected_window
;
10668 if (WINDOWP (frame_or_window
))
10670 struct window
*w
= decode_live_window (frame_or_window
);
10672 XSETINT (x
, (XINT (x
)
10673 + WINDOW_LEFT_EDGE_X (w
)
10675 ? window_box_left_offset (w
, TEXT_AREA
)
10677 XSETINT (y
, WINDOW_TO_FRAME_PIXEL_Y (w
, XINT (y
)));
10678 frame_or_window
= w
->frame
;
10681 CHECK_LIVE_FRAME (frame_or_window
);
10683 return make_lispy_position (XFRAME (frame_or_window
), x
, y
, 0);
10686 DEFUN ("posn-at-point", Fposn_at_point
, Sposn_at_point
, 0, 2, 0,
10687 doc
: /* Return position information for buffer POS in WINDOW.
10688 POS defaults to point in WINDOW; WINDOW defaults to the selected window.
10690 Return nil if position is not visible in window. Otherwise,
10691 the return value is similar to that returned by `event-start' for
10692 a mouse click at the upper left corner of the glyph corresponding
10693 to the given buffer position:
10694 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
10695 IMAGE (DX . DY) (WIDTH . HEIGHT))
10696 The `posn-' functions access elements of such lists. */)
10697 (Lisp_Object pos
, Lisp_Object window
)
10702 window
= selected_window
;
10704 tem
= Fpos_visible_in_window_p (pos
, window
, Qt
);
10707 Lisp_Object x
= XCAR (tem
);
10708 Lisp_Object y
= XCAR (XCDR (tem
));
10710 /* Point invisible due to hscrolling? X can be -1 when a
10711 newline in a R2L line overflows into the left fringe. */
10714 tem
= Fposn_at_x_y (x
, y
, window
, Qnil
);
10720 /* Set up a new kboard object with reasonable initial values.
10721 TYPE is a window system for which this keyboard is used. */
10724 init_kboard (KBOARD
*kb
, Lisp_Object type
)
10726 kset_overriding_terminal_local_map (kb
, Qnil
);
10727 kset_last_command (kb
, Qnil
);
10728 kset_real_last_command (kb
, Qnil
);
10729 kset_keyboard_translate_table (kb
, Qnil
);
10730 kset_last_repeatable_command (kb
, Qnil
);
10731 kset_prefix_arg (kb
, Qnil
);
10732 kset_last_prefix_arg (kb
, Qnil
);
10733 kset_kbd_queue (kb
, Qnil
);
10734 kb
->kbd_queue_has_data
= false;
10735 kb
->immediate_echo
= false;
10736 kset_echo_string (kb
, Qnil
);
10737 kset_echo_prompt (kb
, Qnil
);
10738 kb
->kbd_macro_buffer
= 0;
10739 kb
->kbd_macro_bufsize
= 0;
10740 kset_defining_kbd_macro (kb
, Qnil
);
10741 kset_last_kbd_macro (kb
, Qnil
);
10742 kb
->reference_count
= 0;
10743 kset_system_key_alist (kb
, Qnil
);
10744 kset_system_key_syms (kb
, Qnil
);
10745 kset_window_system (kb
, type
);
10746 kset_input_decode_map (kb
, Fmake_sparse_keymap (Qnil
));
10747 kset_local_function_key_map (kb
, Fmake_sparse_keymap (Qnil
));
10748 Fset_keymap_parent (KVAR (kb
, Vlocal_function_key_map
), Vfunction_key_map
);
10749 kset_default_minibuffer_frame (kb
, Qnil
);
10752 /* Allocate and basically initialize keyboard
10753 object to use with window system TYPE. */
10756 allocate_kboard (Lisp_Object type
)
10758 KBOARD
*kb
= xmalloc (sizeof *kb
);
10760 init_kboard (kb
, type
);
10761 kb
->next_kboard
= all_kboards
;
10767 * Destroy the contents of a kboard object, but not the object itself.
10768 * We use this just before deleting it, or if we're going to initialize
10769 * it a second time.
10772 wipe_kboard (KBOARD
*kb
)
10774 xfree (kb
->kbd_macro_buffer
);
10777 /* Free KB and memory referenced from it. */
10780 delete_kboard (KBOARD
*kb
)
10784 for (kbp
= &all_kboards
; *kbp
!= kb
; kbp
= &(*kbp
)->next_kboard
)
10787 *kbp
= kb
->next_kboard
;
10789 /* Prevent a dangling reference to KB. */
10790 if (kb
== current_kboard
10791 && FRAMEP (selected_frame
)
10792 && FRAME_LIVE_P (XFRAME (selected_frame
)))
10794 current_kboard
= FRAME_KBOARD (XFRAME (selected_frame
));
10795 single_kboard
= false;
10796 if (current_kboard
== kb
)
10805 init_keyboard (void)
10807 /* This is correct before outermost invocation of the editor loop. */
10808 command_loop_level
= -1;
10809 immediate_quit
= false;
10810 quit_char
= Ctl ('g');
10811 Vunread_command_events
= Qnil
;
10812 timer_idleness_start_time
= invalid_timespec ();
10814 recent_keys_index
= 0;
10815 kbd_fetch_ptr
= kbd_buffer
;
10816 kbd_store_ptr
= kbd_buffer
;
10817 do_mouse_tracking
= Qnil
;
10818 input_pending
= false;
10819 interrupt_input_blocked
= 0;
10820 pending_signals
= false;
10822 /* This means that command_loop_1 won't try to select anything the first
10824 internal_last_event_frame
= Qnil
;
10825 Vlast_event_frame
= internal_last_event_frame
;
10827 current_kboard
= initial_kboard
;
10828 /* Re-initialize the keyboard again. */
10829 wipe_kboard (current_kboard
);
10830 /* A value of nil for Vwindow_system normally means a tty, but we also use
10831 it for the initial terminal since there is no window system there. */
10832 init_kboard (current_kboard
, Qnil
);
10834 if (!noninteractive
)
10836 /* Before multi-tty support, these handlers used to be installed
10837 only if the current session was a tty session. Now an Emacs
10838 session may have multiple display types, so we always handle
10839 SIGINT. There is special code in handle_interrupt_signal to exit
10840 Emacs on SIGINT when there are no termcap frames on the
10841 controlling terminal. */
10842 struct sigaction action
;
10843 emacs_sigaction_init (&action
, deliver_interrupt_signal
);
10844 sigaction (SIGINT
, &action
, 0);
10846 /* For systems with SysV TERMIO, C-g is set up for both SIGINT and
10847 SIGQUIT and we can't tell which one it will give us. */
10848 sigaction (SIGQUIT
, &action
, 0);
10849 #endif /* not DOS_NT */
10851 #ifdef USABLE_SIGIO
10852 if (!noninteractive
)
10854 struct sigaction action
;
10855 emacs_sigaction_init (&action
, deliver_input_available_signal
);
10856 sigaction (SIGIO
, &action
, 0);
10860 /* Use interrupt input by default, if it works and noninterrupt input
10861 has deficiencies. */
10863 #ifdef INTERRUPT_INPUT
10864 interrupt_input
= 1;
10866 interrupt_input
= 0;
10869 pthread_sigmask (SIG_SETMASK
, &empty_mask
, 0);
10872 if (keyboard_init_hook
)
10873 (*keyboard_init_hook
) ();
10875 #ifdef POLL_FOR_INPUT
10877 poll_suppress_count
= 1;
10882 /* This type's only use is in syms_of_keyboard, to put properties on the
10883 event header symbols. */
10890 static const struct event_head head_table
[] = {
10891 {SYMBOL_INDEX (Qmouse_movement
), SYMBOL_INDEX (Qmouse_movement
)},
10892 {SYMBOL_INDEX (Qscroll_bar_movement
), SYMBOL_INDEX (Qmouse_movement
)},
10894 /* Some of the event heads. */
10895 {SYMBOL_INDEX (Qswitch_frame
), SYMBOL_INDEX (Qswitch_frame
)},
10897 {SYMBOL_INDEX (Qfocus_in
), SYMBOL_INDEX (Qfocus_in
)},
10898 {SYMBOL_INDEX (Qfocus_out
), SYMBOL_INDEX (Qfocus_out
)},
10899 {SYMBOL_INDEX (Qdelete_frame
), SYMBOL_INDEX (Qdelete_frame
)},
10900 {SYMBOL_INDEX (Qiconify_frame
), SYMBOL_INDEX (Qiconify_frame
)},
10901 {SYMBOL_INDEX (Qmake_frame_visible
), SYMBOL_INDEX (Qmake_frame_visible
)},
10902 /* `select-window' should be handled just like `switch-frame'
10903 in read_key_sequence. */
10904 {SYMBOL_INDEX (Qselect_window
), SYMBOL_INDEX (Qswitch_frame
)}
10908 syms_of_keyboard (void)
10910 pending_funcalls
= Qnil
;
10911 staticpro (&pending_funcalls
);
10913 Vlispy_mouse_stem
= build_pure_c_string ("mouse");
10914 staticpro (&Vlispy_mouse_stem
);
10916 regular_top_level_message
= build_pure_c_string ("Back to top level");
10917 #ifdef HAVE_STACK_OVERFLOW_HANDLING
10918 recover_top_level_message
10919 = build_pure_c_string ("Re-entering top level after C stack overflow");
10921 DEFVAR_LISP ("internal--top-level-message", Vinternal__top_level_message
,
10922 doc
: /* Message displayed by `normal-top-level'. */);
10923 Vinternal__top_level_message
= regular_top_level_message
;
10926 DEFSYM (QCimage
, ":image");
10927 DEFSYM (Qhelp_echo
, "help-echo");
10928 DEFSYM (QCrtl
, ":rtl");
10930 staticpro (&item_properties
);
10931 item_properties
= Qnil
;
10933 staticpro (&tool_bar_item_properties
);
10934 tool_bar_item_properties
= Qnil
;
10935 staticpro (&tool_bar_items_vector
);
10936 tool_bar_items_vector
= Qnil
;
10938 DEFSYM (Qtimer_event_handler
, "timer-event-handler");
10940 /* Non-nil disable property on a command means do not execute it;
10941 call disabled-command-function's value instead. */
10942 DEFSYM (Qdisabled
, "disabled");
10944 DEFSYM (Qundefined
, "undefined");
10946 /* Hooks to run before and after each command. */
10947 DEFSYM (Qpre_command_hook
, "pre-command-hook");
10948 DEFSYM (Qpost_command_hook
, "post-command-hook");
10950 DEFSYM (Qundo_auto__add_boundary
, "undo-auto--add-boundary");
10952 DEFSYM (Qdeferred_action_function
, "deferred-action-function");
10953 DEFSYM (Qdelayed_warnings_hook
, "delayed-warnings-hook");
10954 DEFSYM (Qfunction_key
, "function-key");
10956 /* The values of Qevent_kind properties. */
10957 DEFSYM (Qmouse_click
, "mouse-click");
10959 DEFSYM (Qdrag_n_drop
, "drag-n-drop");
10960 DEFSYM (Qsave_session
, "save-session");
10961 DEFSYM (Qconfig_changed_event
, "config-changed-event");
10963 /* Menu and tool bar item parts. */
10964 DEFSYM (Qmenu_enable
, "menu-enable");
10967 DEFSYM (Qlanguage_change
, "language-change");
10971 DEFSYM (Qdbus_event
, "dbus-event");
10974 #ifdef HAVE_XWIDGETS
10975 DEFSYM (Qxwidget_event
,"xwidget-event");
10978 #ifdef USE_FILE_NOTIFY
10979 DEFSYM (Qfile_notify
, "file-notify");
10980 #endif /* USE_FILE_NOTIFY */
10982 /* Menu and tool bar item parts. */
10983 DEFSYM (QCenable
, ":enable");
10984 DEFSYM (QCvisible
, ":visible");
10985 DEFSYM (QChelp
, ":help");
10986 DEFSYM (QCfilter
, ":filter");
10987 DEFSYM (QCbutton
, ":button");
10988 DEFSYM (QCkeys
, ":keys");
10989 DEFSYM (QCkey_sequence
, ":key-sequence");
10991 /* Non-nil disable property on a command means
10992 do not execute it; call disabled-command-function's value instead. */
10993 DEFSYM (QCtoggle
, ":toggle");
10994 DEFSYM (QCradio
, ":radio");
10995 DEFSYM (QClabel
, ":label");
10996 DEFSYM (QCvert_only
, ":vert-only");
10998 /* Symbols to use for parts of windows. */
10999 DEFSYM (Qvertical_line
, "vertical-line");
11000 DEFSYM (Qright_divider
, "right-divider");
11001 DEFSYM (Qbottom_divider
, "bottom-divider");
11003 DEFSYM (Qmouse_fixup_help_message
, "mouse-fixup-help-message");
11005 DEFSYM (Qabove_handle
, "above-handle");
11006 DEFSYM (Qhandle
, "handle");
11007 DEFSYM (Qbelow_handle
, "below-handle");
11008 DEFSYM (Qup
, "up");
11009 DEFSYM (Qdown
, "down");
11010 DEFSYM (Qtop
, "top");
11011 DEFSYM (Qbottom
, "bottom");
11012 DEFSYM (Qend_scroll
, "end-scroll");
11013 DEFSYM (Qratio
, "ratio");
11014 DEFSYM (Qbefore_handle
, "before-handle");
11015 DEFSYM (Qhorizontal_handle
, "horizontal-handle");
11016 DEFSYM (Qafter_handle
, "after-handle");
11017 DEFSYM (Qleft
, "left");
11018 DEFSYM (Qright
, "right");
11019 DEFSYM (Qleftmost
, "leftmost");
11020 DEFSYM (Qrightmost
, "rightmost");
11022 /* Properties of event headers. */
11023 DEFSYM (Qevent_kind
, "event-kind");
11024 DEFSYM (Qevent_symbol_elements
, "event-symbol-elements");
11026 /* An event header symbol HEAD may have a property named
11027 Qevent_symbol_element_mask, which is of the form (BASE MODIFIERS);
11028 BASE is the base, unmodified version of HEAD, and MODIFIERS is the
11029 mask of modifiers applied to it. If present, this is used to help
11030 speed up parse_modifiers. */
11031 DEFSYM (Qevent_symbol_element_mask
, "event-symbol-element-mask");
11033 /* An unmodified event header BASE may have a property named
11034 Qmodifier_cache, which is an alist mapping modifier masks onto
11035 modified versions of BASE. If present, this helps speed up
11036 apply_modifiers. */
11037 DEFSYM (Qmodifier_cache
, "modifier-cache");
11039 DEFSYM (Qrecompute_lucid_menubar
, "recompute-lucid-menubar");
11040 DEFSYM (Qactivate_menubar_hook
, "activate-menubar-hook");
11042 DEFSYM (Qpolling_period
, "polling-period");
11044 DEFSYM (Qgui_set_selection
, "gui-set-selection");
11046 /* The primary selection. */
11047 DEFSYM (QPRIMARY
, "PRIMARY");
11049 DEFSYM (Qhandle_switch_frame
, "handle-switch-frame");
11050 DEFSYM (Qhandle_select_window
, "handle-select-window");
11052 DEFSYM (Qinput_method_exit_on_first_char
, "input-method-exit-on-first-char");
11053 DEFSYM (Qinput_method_use_echo_area
, "input-method-use-echo-area");
11055 DEFSYM (Qhelp_form_show
, "help-form-show");
11057 DEFSYM (Qecho_keystrokes
, "echo-keystrokes");
11059 Fset (Qinput_method_exit_on_first_char
, Qnil
);
11060 Fset (Qinput_method_use_echo_area
, Qnil
);
11062 /* Symbols to head events. */
11063 DEFSYM (Qmouse_movement
, "mouse-movement");
11064 DEFSYM (Qscroll_bar_movement
, "scroll-bar-movement");
11065 DEFSYM (Qswitch_frame
, "switch-frame");
11066 DEFSYM (Qfocus_in
, "focus-in");
11067 DEFSYM (Qfocus_out
, "focus-out");
11068 DEFSYM (Qdelete_frame
, "delete-frame");
11069 DEFSYM (Qiconify_frame
, "iconify-frame");
11070 DEFSYM (Qmake_frame_visible
, "make-frame-visible");
11071 DEFSYM (Qselect_window
, "select-window");
11075 for (i
= 0; i
< ARRAYELTS (head_table
); i
++)
11077 const struct event_head
*p
= &head_table
[i
];
11078 Lisp_Object var
= builtin_lisp_symbol (p
->var
);
11079 Lisp_Object kind
= builtin_lisp_symbol (p
->kind
);
11080 Fput (var
, Qevent_kind
, kind
);
11081 Fput (var
, Qevent_symbol_elements
, list1 (var
));
11085 button_down_location
= Fmake_vector (make_number (5), Qnil
);
11086 staticpro (&button_down_location
);
11087 mouse_syms
= Fmake_vector (make_number (5), Qnil
);
11088 staticpro (&mouse_syms
);
11089 wheel_syms
= Fmake_vector (make_number (ARRAYELTS (lispy_wheel_names
)),
11091 staticpro (&wheel_syms
);
11095 int len
= ARRAYELTS (modifier_names
);
11097 modifier_symbols
= Fmake_vector (make_number (len
), Qnil
);
11098 for (i
= 0; i
< len
; i
++)
11099 if (modifier_names
[i
])
11100 ASET (modifier_symbols
, i
, intern_c_string (modifier_names
[i
]));
11101 staticpro (&modifier_symbols
);
11104 recent_keys
= Fmake_vector (make_number (NUM_RECENT_KEYS
), Qnil
);
11105 staticpro (&recent_keys
);
11107 this_command_keys
= Fmake_vector (make_number (40), Qnil
);
11108 staticpro (&this_command_keys
);
11110 raw_keybuf
= Fmake_vector (make_number (30), Qnil
);
11111 staticpro (&raw_keybuf
);
11113 DEFSYM (Qcommand_execute
, "command-execute");
11114 DEFSYM (Qinternal_echo_keystrokes_prefix
, "internal-echo-keystrokes-prefix");
11116 accent_key_syms
= Qnil
;
11117 staticpro (&accent_key_syms
);
11119 func_key_syms
= Qnil
;
11120 staticpro (&func_key_syms
);
11122 drag_n_drop_syms
= Qnil
;
11123 staticpro (&drag_n_drop_syms
);
11125 unread_switch_frame
= Qnil
;
11126 staticpro (&unread_switch_frame
);
11128 internal_last_event_frame
= Qnil
;
11129 staticpro (&internal_last_event_frame
);
11131 read_key_sequence_cmd
= Qnil
;
11132 staticpro (&read_key_sequence_cmd
);
11133 read_key_sequence_remapped
= Qnil
;
11134 staticpro (&read_key_sequence_remapped
);
11136 menu_bar_one_keymap_changed_items
= Qnil
;
11137 staticpro (&menu_bar_one_keymap_changed_items
);
11139 menu_bar_items_vector
= Qnil
;
11140 staticpro (&menu_bar_items_vector
);
11142 help_form_saved_window_configs
= Qnil
;
11143 staticpro (&help_form_saved_window_configs
);
11145 defsubr (&Scurrent_idle_time
);
11146 defsubr (&Sevent_symbol_parse_modifiers
);
11147 defsubr (&Sevent_convert_list
);
11148 defsubr (&Sread_key_sequence
);
11149 defsubr (&Sread_key_sequence_vector
);
11150 defsubr (&Srecursive_edit
);
11151 defsubr (&Strack_mouse
);
11152 defsubr (&Sinput_pending_p
);
11153 defsubr (&Srecent_keys
);
11154 defsubr (&Sthis_command_keys
);
11155 defsubr (&Sthis_command_keys_vector
);
11156 defsubr (&Sthis_single_command_keys
);
11157 defsubr (&Sthis_single_command_raw_keys
);
11158 defsubr (&Sclear_this_command_keys
);
11159 defsubr (&Ssuspend_emacs
);
11160 defsubr (&Sabort_recursive_edit
);
11161 defsubr (&Sexit_recursive_edit
);
11162 defsubr (&Srecursion_depth
);
11163 defsubr (&Scommand_error_default_function
);
11164 defsubr (&Stop_level
);
11165 defsubr (&Sdiscard_input
);
11166 defsubr (&Sopen_dribble_file
);
11167 defsubr (&Sset_input_interrupt_mode
);
11168 defsubr (&Sset_output_flow_control
);
11169 defsubr (&Sset_input_meta_mode
);
11170 defsubr (&Sset_quit_char
);
11171 defsubr (&Sset_input_mode
);
11172 defsubr (&Scurrent_input_mode
);
11173 defsubr (&Sposn_at_point
);
11174 defsubr (&Sposn_at_x_y
);
11176 DEFVAR_LISP ("last-command-event", last_command_event
,
11177 doc
: /* Last input event that was part of a command. */);
11179 DEFVAR_LISP ("last-nonmenu-event", last_nonmenu_event
,
11180 doc
: /* Last input event in a command, except for mouse menu events.
11181 Mouse menus give back keys that don't look like mouse events;
11182 this variable holds the actual mouse event that led to the menu,
11183 so that you can determine whether the command was run by mouse or not. */);
11185 DEFVAR_LISP ("last-input-event", last_input_event
,
11186 doc
: /* Last input event. */);
11188 DEFVAR_LISP ("unread-command-events", Vunread_command_events
,
11189 doc
: /* List of events to be read as the command input.
11190 These events are processed first, before actual keyboard input.
11191 Events read from this list are not normally added to `this-command-keys',
11192 as they will already have been added once as they were read for the first time.
11193 An element of the form (t . EVENT) forces EVENT to be added to that list. */);
11194 Vunread_command_events
= Qnil
;
11196 DEFVAR_LISP ("unread-post-input-method-events", Vunread_post_input_method_events
,
11197 doc
: /* List of events to be processed as input by input methods.
11198 These events are processed before `unread-command-events'
11199 and actual keyboard input, but are not given to `input-method-function'. */);
11200 Vunread_post_input_method_events
= Qnil
;
11202 DEFVAR_LISP ("unread-input-method-events", Vunread_input_method_events
,
11203 doc
: /* List of events to be processed as input by input methods.
11204 These events are processed after `unread-command-events', but
11205 before actual keyboard input.
11206 If there's an active input method, the events are given to
11207 `input-method-function'. */);
11208 Vunread_input_method_events
= Qnil
;
11210 DEFVAR_LISP ("meta-prefix-char", meta_prefix_char
,
11211 doc
: /* Meta-prefix character code.
11212 Meta-foo as command input turns into this character followed by foo. */);
11213 XSETINT (meta_prefix_char
, 033);
11215 DEFVAR_KBOARD ("last-command", Vlast_command
,
11216 doc
: /* The last command executed.
11217 Normally a symbol with a function definition, but can be whatever was found
11218 in the keymap, or whatever the variable `this-command' was set to by that
11221 The value `mode-exit' is special; it means that the previous command
11222 read an event that told it to exit, and it did so and unread that event.
11223 In other words, the present command is the event that made the previous
11226 The value `kill-region' is special; it means that the previous command
11227 was a kill command.
11229 `last-command' has a separate binding for each terminal device.
11230 See Info node `(elisp)Multiple Terminals'. */);
11232 DEFVAR_KBOARD ("real-last-command", Vreal_last_command
,
11233 doc
: /* Same as `last-command', but never altered by Lisp code.
11234 Taken from the previous value of `real-this-command'. */);
11236 DEFVAR_KBOARD ("last-repeatable-command", Vlast_repeatable_command
,
11237 doc
: /* Last command that may be repeated.
11238 The last command executed that was not bound to an input event.
11239 This is the command `repeat' will try to repeat.
11240 Taken from a previous value of `real-this-command'. */);
11242 DEFVAR_LISP ("this-command", Vthis_command
,
11243 doc
: /* The command now being executed.
11244 The command can set this variable; whatever is put here
11245 will be in `last-command' during the following command. */);
11246 Vthis_command
= Qnil
;
11248 DEFVAR_LISP ("real-this-command", Vreal_this_command
,
11249 doc
: /* This is like `this-command', except that commands should never modify it. */);
11250 Vreal_this_command
= Qnil
;
11252 DEFVAR_LISP ("this-command-keys-shift-translated",
11253 Vthis_command_keys_shift_translated
,
11254 doc
: /* Non-nil if the key sequence activating this command was shift-translated.
11255 Shift-translation occurs when there is no binding for the key sequence
11256 as entered, but a binding was found by changing an upper-case letter
11257 to lower-case, or a shifted function key to an unshifted one. */);
11258 Vthis_command_keys_shift_translated
= Qnil
;
11260 DEFVAR_LISP ("this-original-command", Vthis_original_command
,
11261 doc
: /* The command bound to the current key sequence before remapping.
11262 It equals `this-command' if the original command was not remapped through
11263 any of the active keymaps. Otherwise, the value of `this-command' is the
11264 result of looking up the original command in the active keymaps. */);
11265 Vthis_original_command
= Qnil
;
11267 DEFVAR_INT ("auto-save-interval", auto_save_interval
,
11268 doc
: /* Number of input events between auto-saves.
11269 Zero means disable autosaving due to number of characters typed. */);
11270 auto_save_interval
= 300;
11272 DEFVAR_LISP ("auto-save-timeout", Vauto_save_timeout
,
11273 doc
: /* Number of seconds idle time before auto-save.
11274 Zero or nil means disable auto-saving due to idleness.
11275 After auto-saving due to this many seconds of idle time,
11276 Emacs also does a garbage collection if that seems to be warranted. */);
11277 XSETFASTINT (Vauto_save_timeout
, 30);
11279 DEFVAR_LISP ("echo-keystrokes", Vecho_keystrokes
,
11280 doc
: /* Nonzero means echo unfinished commands after this many seconds of pause.
11281 The value may be integer or floating point.
11282 If the value is zero, don't echo at all. */);
11283 Vecho_keystrokes
= make_number (1);
11285 DEFVAR_INT ("polling-period", polling_period
,
11286 doc
: /* Interval between polling for input during Lisp execution.
11287 The reason for polling is to make C-g work to stop a running program.
11288 Polling is needed only when using X windows and SIGIO does not work.
11289 Polling is automatically disabled in all other cases. */);
11290 polling_period
= 2;
11292 DEFVAR_LISP ("double-click-time", Vdouble_click_time
,
11293 doc
: /* Maximum time between mouse clicks to make a double-click.
11294 Measured in milliseconds. The value nil means disable double-click
11295 recognition; t means double-clicks have no time limit and are detected
11296 by position only. */);
11297 Vdouble_click_time
= make_number (500);
11299 DEFVAR_INT ("double-click-fuzz", double_click_fuzz
,
11300 doc
: /* Maximum mouse movement between clicks to make a double-click.
11301 On window-system frames, value is the number of pixels the mouse may have
11302 moved horizontally or vertically between two clicks to make a double-click.
11303 On non window-system frames, value is interpreted in units of 1/8 characters
11306 This variable is also the threshold for motion of the mouse
11307 to count as a drag. */);
11308 double_click_fuzz
= 3;
11310 DEFVAR_INT ("num-input-keys", num_input_keys
,
11311 doc
: /* Number of complete key sequences read as input so far.
11312 This includes key sequences read from keyboard macros.
11313 The number is effectively the number of interactive command invocations. */);
11314 num_input_keys
= 0;
11316 DEFVAR_INT ("num-nonmacro-input-events", num_nonmacro_input_events
,
11317 doc
: /* Number of input events read from the keyboard so far.
11318 This does not include events generated by keyboard macros. */);
11319 num_nonmacro_input_events
= 0;
11321 DEFVAR_LISP ("last-event-frame", Vlast_event_frame
,
11322 doc
: /* The frame in which the most recently read event occurred.
11323 If the last event came from a keyboard macro, this is set to `macro'. */);
11324 Vlast_event_frame
= Qnil
;
11326 /* This variable is set up in sysdep.c. */
11327 DEFVAR_LISP ("tty-erase-char", Vtty_erase_char
,
11328 doc
: /* The ERASE character as set by the user with stty. */);
11330 DEFVAR_LISP ("help-char", Vhelp_char
,
11331 doc
: /* Character to recognize as meaning Help.
11332 When it is read, do `(eval help-form)', and display result if it's a string.
11333 If the value of `help-form' is nil, this char can be read normally. */);
11334 XSETINT (Vhelp_char
, Ctl ('H'));
11336 DEFVAR_LISP ("help-event-list", Vhelp_event_list
,
11337 doc
: /* List of input events to recognize as meaning Help.
11338 These work just like the value of `help-char' (see that). */);
11339 Vhelp_event_list
= Qnil
;
11341 DEFVAR_LISP ("help-form", Vhelp_form
,
11342 doc
: /* Form to execute when character `help-char' is read.
11343 If the form returns a string, that string is displayed.
11344 If `help-form' is nil, the help char is not recognized. */);
11347 DEFVAR_LISP ("prefix-help-command", Vprefix_help_command
,
11348 doc
: /* Command to run when `help-char' character follows a prefix key.
11349 This command is used only when there is no actual binding
11350 for that character after that prefix key. */);
11351 Vprefix_help_command
= Qnil
;
11353 DEFVAR_LISP ("top-level", Vtop_level
,
11354 doc
: /* Form to evaluate when Emacs starts up.
11355 Useful to set before you dump a modified Emacs. */);
11357 XSYMBOL (Qtop_level
)->declared_special
= false;
11359 DEFVAR_KBOARD ("keyboard-translate-table", Vkeyboard_translate_table
,
11360 doc
: /* Translate table for local keyboard input, or nil.
11361 If non-nil, the value should be a char-table. Each character read
11362 from the keyboard is looked up in this char-table. If the value found
11363 there is non-nil, then it is used instead of the actual input character.
11365 The value can also be a string or vector, but this is considered obsolete.
11366 If it is a string or vector of length N, character codes N and up are left
11367 untranslated. In a vector, an element which is nil means "no translation".
11369 This is applied to the characters supplied to input methods, not their
11370 output. See also `translation-table-for-input'.
11372 This variable has a separate binding for each terminal.
11373 See Info node `(elisp)Multiple Terminals'. */);
11375 DEFVAR_BOOL ("cannot-suspend", cannot_suspend
,
11376 doc
: /* Non-nil means to always spawn a subshell instead of suspending.
11377 (Even if the operating system has support for stopping a process.) */);
11378 cannot_suspend
= false;
11380 DEFVAR_BOOL ("menu-prompting", menu_prompting
,
11381 doc
: /* Non-nil means prompt with menus when appropriate.
11382 This is done when reading from a keymap that has a prompt string,
11383 for elements that have prompt strings.
11384 The menu is displayed on the screen
11385 if X menus were enabled at configuration
11386 time and the previous event was a mouse click prefix key.
11387 Otherwise, menu prompting uses the echo area. */);
11388 menu_prompting
= true;
11390 DEFVAR_LISP ("menu-prompt-more-char", menu_prompt_more_char
,
11391 doc
: /* Character to see next line of menu prompt.
11392 Type this character while in a menu prompt to rotate around the lines of it. */);
11393 XSETINT (menu_prompt_more_char
, ' ');
11395 DEFVAR_INT ("extra-keyboard-modifiers", extra_keyboard_modifiers
,
11396 doc
: /* A mask of additional modifier keys to use with every keyboard character.
11397 Emacs applies the modifiers of the character stored here to each keyboard
11398 character it reads. For example, after evaluating the expression
11399 (setq extra-keyboard-modifiers ?\\C-x)
11400 all input characters will have the control modifier applied to them.
11402 Note that the character ?\\C-@, equivalent to the integer zero, does
11403 not count as a control character; rather, it counts as a character
11404 with no modifiers; thus, setting `extra-keyboard-modifiers' to zero
11405 cancels any modification. */);
11406 extra_keyboard_modifiers
= 0;
11408 DEFSYM (Qdeactivate_mark
, "deactivate-mark");
11409 DEFVAR_LISP ("deactivate-mark", Vdeactivate_mark
,
11410 doc
: /* If an editing command sets this to t, deactivate the mark afterward.
11411 The command loop sets this to nil before each command,
11412 and tests the value when the command returns.
11413 Buffer modification stores t in this variable. */);
11414 Vdeactivate_mark
= Qnil
;
11415 Fmake_variable_buffer_local (Qdeactivate_mark
);
11417 DEFVAR_LISP ("pre-command-hook", Vpre_command_hook
,
11418 doc
: /* Normal hook run before each command is executed.
11419 If an unhandled error happens in running this hook,
11420 the function in which the error occurred is unconditionally removed, since
11421 otherwise the error might happen repeatedly and make Emacs nonfunctional.
11423 See also `post-command-hook'. */);
11424 Vpre_command_hook
= Qnil
;
11426 DEFVAR_LISP ("post-command-hook", Vpost_command_hook
,
11427 doc
: /* Normal hook run after each command is executed.
11428 If an unhandled error happens in running this hook,
11429 the function in which the error occurred is unconditionally removed, since
11430 otherwise the error might happen repeatedly and make Emacs nonfunctional.
11432 It is a bad idea to use this hook for expensive processing. If
11433 unavoidable, wrap your code in `(while-no-input (redisplay) CODE)' to
11434 avoid making Emacs unresponsive while the user types.
11436 See also `pre-command-hook'. */);
11437 Vpost_command_hook
= Qnil
;
11440 DEFVAR_LISP ("echo-area-clear-hook", ...,
11441 doc
: /* Normal hook run when clearing the echo area. */);
11443 DEFSYM (Qecho_area_clear_hook
, "echo-area-clear-hook");
11444 Fset (Qecho_area_clear_hook
, Qnil
);
11446 DEFVAR_LISP ("lucid-menu-bar-dirty-flag", Vlucid_menu_bar_dirty_flag
,
11447 doc
: /* Non-nil means menu bar, specified Lucid style, needs to be recomputed. */);
11448 Vlucid_menu_bar_dirty_flag
= Qnil
;
11450 DEFVAR_LISP ("menu-bar-final-items", Vmenu_bar_final_items
,
11451 doc
: /* List of menu bar items to move to the end of the menu bar.
11452 The elements of the list are event types that may have menu bar bindings. */);
11453 Vmenu_bar_final_items
= Qnil
;
11455 DEFVAR_LISP ("tool-bar-separator-image-expression", Vtool_bar_separator_image_expression
,
11456 doc
: /* Expression evaluating to the image spec for a tool-bar separator.
11457 This is used internally by graphical displays that do not render
11458 tool-bar separators natively. Otherwise it is unused (e.g. on GTK). */);
11459 Vtool_bar_separator_image_expression
= Qnil
;
11461 DEFVAR_KBOARD ("overriding-terminal-local-map",
11462 Voverriding_terminal_local_map
,
11463 doc
: /* Per-terminal keymap that takes precedence over all other keymaps.
11464 This variable is intended to let commands such as `universal-argument'
11465 set up a different keymap for reading the next command.
11467 `overriding-terminal-local-map' has a separate binding for each
11468 terminal device. See Info node `(elisp)Multiple Terminals'. */);
11470 DEFVAR_LISP ("overriding-local-map", Voverriding_local_map
,
11471 doc
: /* Keymap that replaces (overrides) local keymaps.
11472 If this variable is non-nil, Emacs looks up key bindings in this
11473 keymap INSTEAD OF the keymap char property, minor mode maps, and the
11474 buffer's local map. Hence, the only active keymaps would be
11475 `overriding-terminal-local-map', this keymap, and `global-keymap', in
11476 order of precedence. */);
11477 Voverriding_local_map
= Qnil
;
11479 DEFVAR_LISP ("overriding-local-map-menu-flag", Voverriding_local_map_menu_flag
,
11480 doc
: /* Non-nil means `overriding-local-map' applies to the menu bar.
11481 Otherwise, the menu bar continues to reflect the buffer's local map
11482 and the minor mode maps regardless of `overriding-local-map'. */);
11483 Voverriding_local_map_menu_flag
= Qnil
;
11485 DEFVAR_LISP ("special-event-map", Vspecial_event_map
,
11486 doc
: /* Keymap defining bindings for special events to execute at low level. */);
11487 Vspecial_event_map
= list1 (Qkeymap
);
11489 DEFVAR_LISP ("track-mouse", do_mouse_tracking
,
11490 doc
: /* Non-nil means generate motion events for mouse motion. */);
11492 DEFVAR_KBOARD ("system-key-alist", Vsystem_key_alist
,
11493 doc
: /* Alist of system-specific X windows key symbols.
11494 Each element should have the form (N . SYMBOL) where N is the
11495 numeric keysym code (sans the \"system-specific\" bit 1<<28)
11496 and SYMBOL is its name.
11498 `system-key-alist' has a separate binding for each terminal device.
11499 See Info node `(elisp)Multiple Terminals'. */);
11501 DEFVAR_KBOARD ("local-function-key-map", Vlocal_function_key_map
,
11502 doc
: /* Keymap that translates key sequences to key sequences during input.
11503 This is used mainly for mapping key sequences into some preferred
11504 key events (symbols).
11506 The `read-key-sequence' function replaces any subsequence bound by
11507 `local-function-key-map' with its binding. More precisely, when the
11508 active keymaps have no binding for the current key sequence but
11509 `local-function-key-map' binds a suffix of the sequence to a vector or
11510 string, `read-key-sequence' replaces the matching suffix with its
11511 binding, and continues with the new sequence.
11513 If the binding is a function, it is called with one argument (the prompt)
11514 and its return value (a key sequence) is used.
11516 The events that come from bindings in `local-function-key-map' are not
11517 themselves looked up in `local-function-key-map'.
11519 For example, suppose `local-function-key-map' binds `ESC O P' to [f1].
11520 Typing `ESC O P' to `read-key-sequence' would return [f1]. Typing
11521 `C-x ESC O P' would return [?\\C-x f1]. If [f1] were a prefix key,
11522 typing `ESC O P x' would return [f1 x].
11524 `local-function-key-map' has a separate binding for each terminal
11525 device. See Info node `(elisp)Multiple Terminals'. If you need to
11526 define a binding on all terminals, change `function-key-map'
11527 instead. Initially, `local-function-key-map' is an empty keymap that
11528 has `function-key-map' as its parent on all terminal devices. */);
11530 DEFVAR_KBOARD ("input-decode-map", Vinput_decode_map
,
11531 doc
: /* Keymap that decodes input escape sequences.
11532 This is used mainly for mapping ASCII function key sequences into
11533 real Emacs function key events (symbols).
11535 The `read-key-sequence' function replaces any subsequence bound by
11536 `input-decode-map' with its binding. Contrary to `function-key-map',
11537 this map applies its rebinding regardless of the presence of an ordinary
11538 binding. So it is more like `key-translation-map' except that it applies
11539 before `function-key-map' rather than after.
11541 If the binding is a function, it is called with one argument (the prompt)
11542 and its return value (a key sequence) is used.
11544 The events that come from bindings in `input-decode-map' are not
11545 themselves looked up in `input-decode-map'. */);
11547 DEFVAR_LISP ("function-key-map", Vfunction_key_map
,
11548 doc
: /* The parent keymap of all `local-function-key-map' instances.
11549 Function key definitions that apply to all terminal devices should go
11550 here. If a mapping is defined in both the current
11551 `local-function-key-map' binding and this variable, then the local
11552 definition will take precedence. */);
11553 Vfunction_key_map
= Fmake_sparse_keymap (Qnil
);
11555 DEFVAR_LISP ("key-translation-map", Vkey_translation_map
,
11556 doc
: /* Keymap of key translations that can override keymaps.
11557 This keymap works like `input-decode-map', but comes after `function-key-map'.
11558 Another difference is that it is global rather than terminal-local. */);
11559 Vkey_translation_map
= Fmake_sparse_keymap (Qnil
);
11561 DEFVAR_LISP ("deferred-action-list", Vdeferred_action_list
,
11562 doc
: /* List of deferred actions to be performed at a later time.
11563 The precise format isn't relevant here; we just check whether it is nil. */);
11564 Vdeferred_action_list
= Qnil
;
11566 DEFVAR_LISP ("deferred-action-function", Vdeferred_action_function
,
11567 doc
: /* Function to call to handle deferred actions, after each command.
11568 This function is called with no arguments after each command
11569 whenever `deferred-action-list' is non-nil. */);
11570 Vdeferred_action_function
= Qnil
;
11572 DEFVAR_LISP ("delayed-warnings-list", Vdelayed_warnings_list
,
11573 doc
: /* List of warnings to be displayed after this command.
11574 Each element must be a list (TYPE MESSAGE [LEVEL [BUFFER-NAME]]),
11575 as per the args of `display-warning' (which see).
11576 If this variable is non-nil, `delayed-warnings-hook' will be run
11577 immediately after running `post-command-hook'. */);
11578 Vdelayed_warnings_list
= Qnil
;
11580 DEFVAR_LISP ("timer-list", Vtimer_list
,
11581 doc
: /* List of active absolute time timers in order of increasing time. */);
11582 Vtimer_list
= Qnil
;
11584 DEFVAR_LISP ("timer-idle-list", Vtimer_idle_list
,
11585 doc
: /* List of active idle-time timers in order of increasing time. */);
11586 Vtimer_idle_list
= Qnil
;
11588 DEFVAR_LISP ("input-method-function", Vinput_method_function
,
11589 doc
: /* If non-nil, the function that implements the current input method.
11590 It's called with one argument, a printing character that was just read.
11591 (That means a character with code 040...0176.)
11592 Typically this function uses `read-event' to read additional events.
11593 When it does so, it should first bind `input-method-function' to nil
11594 so it will not be called recursively.
11596 The function should return a list of zero or more events
11597 to be used as input. If it wants to put back some events
11598 to be reconsidered, separately, by the input method,
11599 it can add them to the beginning of `unread-command-events'.
11601 The input method function can find in `input-method-previous-message'
11602 the previous echo area message.
11604 The input method function should refer to the variables
11605 `input-method-use-echo-area' and `input-method-exit-on-first-char'
11606 for guidance on what to do. */);
11607 Vinput_method_function
= Qlist
;
11609 DEFVAR_LISP ("input-method-previous-message",
11610 Vinput_method_previous_message
,
11611 doc
: /* When `input-method-function' is called, hold the previous echo area message.
11612 This variable exists because `read-event' clears the echo area
11613 before running the input method. It is nil if there was no message. */);
11614 Vinput_method_previous_message
= Qnil
;
11616 DEFVAR_LISP ("show-help-function", Vshow_help_function
,
11617 doc
: /* If non-nil, the function that implements the display of help.
11618 It's called with one argument, the help string to display. */);
11619 Vshow_help_function
= Qnil
;
11621 DEFVAR_LISP ("disable-point-adjustment", Vdisable_point_adjustment
,
11622 doc
: /* If non-nil, suppress point adjustment after executing a command.
11624 After a command is executed, if point is moved into a region that has
11625 special properties (e.g. composition, display), we adjust point to
11626 the boundary of the region. But, when a command sets this variable to
11627 non-nil, we suppress the point adjustment.
11629 This variable is set to nil before reading a command, and is checked
11630 just after executing the command. */);
11631 Vdisable_point_adjustment
= Qnil
;
11633 DEFVAR_LISP ("global-disable-point-adjustment",
11634 Vglobal_disable_point_adjustment
,
11635 doc
: /* If non-nil, always suppress point adjustment.
11637 The default value is nil, in which case, point adjustment are
11638 suppressed only after special commands that set
11639 `disable-point-adjustment' (which see) to non-nil. */);
11640 Vglobal_disable_point_adjustment
= Qnil
;
11642 DEFVAR_LISP ("minibuffer-message-timeout", Vminibuffer_message_timeout
,
11643 doc
: /* How long to display an echo-area message when the minibuffer is active.
11644 If the value is not a number, such messages don't time out. */);
11645 Vminibuffer_message_timeout
= make_number (2);
11647 DEFVAR_LISP ("throw-on-input", Vthrow_on_input
,
11648 doc
: /* If non-nil, any keyboard input throws to this symbol.
11649 The value of that variable is passed to `quit-flag' and later causes a
11650 peculiar kind of quitting. */);
11651 Vthrow_on_input
= Qnil
;
11653 DEFVAR_LISP ("command-error-function", Vcommand_error_function
,
11654 doc
: /* Function to output error messages.
11655 Called with three arguments:
11656 - the error data, a list of the form (SIGNALED-CONDITION . SIGNAL-DATA)
11657 such as what `condition-case' would bind its variable to,
11658 - the context (a string which normally goes at the start of the message),
11659 - the Lisp function within which the error was signaled. */);
11660 Vcommand_error_function
= intern ("command-error-default-function");
11662 DEFVAR_LISP ("enable-disabled-menus-and-buttons",
11663 Venable_disabled_menus_and_buttons
,
11664 doc
: /* If non-nil, don't ignore events produced by disabled menu items and tool-bar.
11666 Help functions bind this to allow help on disabled menu items
11667 and tool-bar buttons. */);
11668 Venable_disabled_menus_and_buttons
= Qnil
;
11670 DEFVAR_LISP ("select-active-regions",
11671 Vselect_active_regions
,
11672 doc
: /* If non-nil, an active region automatically sets the primary selection.
11673 If the value is `only', only temporarily active regions (usually made
11674 by mouse-dragging or shift-selection) set the window selection.
11676 This takes effect only when Transient Mark mode is enabled. */);
11677 Vselect_active_regions
= Qt
;
11679 DEFVAR_LISP ("saved-region-selection",
11680 Vsaved_region_selection
,
11681 doc
: /* Contents of active region prior to buffer modification.
11682 If `select-active-regions' is non-nil, Emacs sets this to the
11683 text in the region before modifying the buffer. The next call to
11684 the function `deactivate-mark' uses this to set the window selection. */);
11685 Vsaved_region_selection
= Qnil
;
11687 DEFVAR_LISP ("selection-inhibit-update-commands",
11688 Vselection_inhibit_update_commands
,
11689 doc
: /* List of commands which should not update the selection.
11690 Normally, if `select-active-regions' is non-nil and the mark remains
11691 active after a command (i.e. the mark was not deactivated), the Emacs
11692 command loop sets the selection to the text in the region. However,
11693 if the command is in this list, the selection is not updated. */);
11694 Vselection_inhibit_update_commands
11695 = list2 (Qhandle_switch_frame
, Qhandle_select_window
);
11697 DEFVAR_LISP ("debug-on-event",
11699 doc
: /* Enter debugger on this event. When Emacs
11700 receives the special event specified by this variable, it will try to
11701 break into the debugger as soon as possible instead of processing the
11702 event normally through `special-event-map'.
11704 Currently, the only supported values for this
11705 variable are `sigusr1' and `sigusr2'. */);
11706 Vdebug_on_event
= intern_c_string ("sigusr2");
11708 /* Create the initial keyboard. Qt means 'unset'. */
11709 initial_kboard
= allocate_kboard (Qt
);
11713 keys_of_keyboard (void)
11715 initial_define_key (global_map
, Ctl ('Z'), "suspend-emacs");
11716 initial_define_key (control_x_map
, Ctl ('Z'), "suspend-emacs");
11717 initial_define_key (meta_map
, Ctl ('C'), "exit-recursive-edit");
11718 initial_define_key (global_map
, Ctl (']'), "abort-recursive-edit");
11719 initial_define_key (meta_map
, 'x', "execute-extended-command");
11721 initial_define_lispy_key (Vspecial_event_map
, "delete-frame",
11722 "handle-delete-frame");
11723 initial_define_lispy_key (Vspecial_event_map
, "ns-put-working-text",
11724 "ns-put-working-text");
11725 initial_define_lispy_key (Vspecial_event_map
, "ns-unput-working-text",
11726 "ns-unput-working-text");
11727 /* Here we used to use `ignore-event' which would simple set prefix-arg to
11728 current-prefix-arg, as is done in `handle-switch-frame'.
11729 But `handle-switch-frame is not run from the special-map.
11730 Commands from that map are run in a special way that automatically
11731 preserves the prefix-arg. Restoring the prefix arg here is not just
11732 redundant but harmful:
11734 - current-prefix-arg is set to non-nil, prefix-arg is set to nil.
11735 - after the first prompt, the exit-minibuffer-hook is run which may
11736 iconify a frame and thus push a `iconify-frame' event.
11737 - after running exit-minibuffer-hook, current-prefix-arg is
11738 restored to the non-nil value it had before the prompt.
11739 - we enter the second prompt.
11740 current-prefix-arg is non-nil, prefix-arg is nil.
11741 - before running the first real event, we run the special iconify-frame
11742 event, but we pass the `special' arg to command-execute so
11743 current-prefix-arg and prefix-arg are left untouched.
11744 - here we foolishly copy the non-nil current-prefix-arg to prefix-arg.
11745 - the next key event will have a spuriously non-nil current-prefix-arg. */
11746 initial_define_lispy_key (Vspecial_event_map
, "iconify-frame",
11748 initial_define_lispy_key (Vspecial_event_map
, "make-frame-visible",
11750 /* Handling it at such a low-level causes read_key_sequence to get
11751 * confused because it doesn't realize that the current_buffer was
11752 * changed by read_char.
11754 * initial_define_lispy_key (Vspecial_event_map, "select-window",
11755 * "handle-select-window"); */
11756 initial_define_lispy_key (Vspecial_event_map
, "save-session",
11757 "handle-save-session");
11760 /* Define a special event which is raised for dbus callback
11762 initial_define_lispy_key (Vspecial_event_map
, "dbus-event",
11763 "dbus-handle-event");
11766 #ifdef USE_FILE_NOTIFY
11767 /* Define a special event which is raised for notification callback
11769 initial_define_lispy_key (Vspecial_event_map
, "file-notify",
11770 "file-notify-handle-event");
11771 #endif /* USE_FILE_NOTIFY */
11773 initial_define_lispy_key (Vspecial_event_map
, "config-changed-event",
11775 #if defined (WINDOWSNT)
11776 initial_define_lispy_key (Vspecial_event_map
, "language-change",
11779 initial_define_lispy_key (Vspecial_event_map
, "focus-in",
11780 "handle-focus-in");
11781 initial_define_lispy_key (Vspecial_event_map
, "focus-out",
11782 "handle-focus-out");
11785 /* Mark the pointers in the kboard objects.
11786 Called by Fgarbage_collect. */
11788 mark_kboards (void)
11792 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
11794 if (kb
->kbd_macro_buffer
)
11795 for (p
= kb
->kbd_macro_buffer
; p
< kb
->kbd_macro_ptr
; p
++)
11797 mark_object (KVAR (kb
, Voverriding_terminal_local_map
));
11798 mark_object (KVAR (kb
, Vlast_command
));
11799 mark_object (KVAR (kb
, Vreal_last_command
));
11800 mark_object (KVAR (kb
, Vkeyboard_translate_table
));
11801 mark_object (KVAR (kb
, Vlast_repeatable_command
));
11802 mark_object (KVAR (kb
, Vprefix_arg
));
11803 mark_object (KVAR (kb
, Vlast_prefix_arg
));
11804 mark_object (KVAR (kb
, kbd_queue
));
11805 mark_object (KVAR (kb
, defining_kbd_macro
));
11806 mark_object (KVAR (kb
, Vlast_kbd_macro
));
11807 mark_object (KVAR (kb
, Vsystem_key_alist
));
11808 mark_object (KVAR (kb
, system_key_syms
));
11809 mark_object (KVAR (kb
, Vwindow_system
));
11810 mark_object (KVAR (kb
, Vinput_decode_map
));
11811 mark_object (KVAR (kb
, Vlocal_function_key_map
));
11812 mark_object (KVAR (kb
, Vdefault_minibuffer_frame
));
11813 mark_object (KVAR (kb
, echo_string
));
11814 mark_object (KVAR (kb
, echo_prompt
));
11817 union buffered_input_event
*event
;
11818 for (event
= kbd_fetch_ptr
; event
!= kbd_store_ptr
; event
++)
11820 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
11821 event
= kbd_buffer
;
11822 /* These two special event types has no Lisp_Objects to mark. */
11823 if (event
->kind
!= SELECTION_REQUEST_EVENT
11824 && event
->kind
!= SELECTION_CLEAR_EVENT
)
11826 mark_object (event
->ie
.x
);
11827 mark_object (event
->ie
.y
);
11828 mark_object (event
->ie
.frame_or_window
);
11829 mark_object (event
->ie
.arg
);