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
);
3223 /* recent_keys should not include events from keyboard macros. */
3224 if (NILP (Vexecuting_kbd_macro
))
3228 total_keys
+= total_keys
< NUM_RECENT_KEYS
;
3229 ASET (recent_keys
, recent_keys_index
, c
);
3230 if (++recent_keys_index
>= NUM_RECENT_KEYS
)
3231 recent_keys_index
= 0;
3233 else if (recorded
< 0)
3235 /* We need to remove one or two events from recent_keys.
3236 To do this, we simply put nil at those events and move the
3237 recent_keys_index backwards over those events. Usually,
3238 users will never see those nil events, as they will be
3239 overwritten by the command keys entered to see recent_keys
3242 while (recorded
++ < 0 && total_keys
> 0)
3244 if (total_keys
< NUM_RECENT_KEYS
)
3246 if (--recent_keys_index
< 0)
3247 recent_keys_index
= NUM_RECENT_KEYS
- 1;
3248 ASET (recent_keys
, recent_keys_index
, Qnil
);
3252 num_nonmacro_input_events
++;
3255 /* Write c to the dribble file. If c is a lispy event, write
3256 the event's symbol to the dribble file, in <brackets>. Bleaugh.
3257 If you, dear reader, have a better idea, you've got the source. :-) */
3263 if (XUINT (c
) < 0x100)
3264 putc (XUINT (c
), dribble
);
3266 fprintf (dribble
, " 0x%"pI
"x", XUINT (c
));
3270 Lisp_Object dribblee
;
3272 /* If it's a structured event, take the event header. */
3273 dribblee
= EVENT_HEAD (c
);
3275 if (SYMBOLP (dribblee
))
3277 putc ('<', dribble
);
3278 fwrite (SDATA (SYMBOL_NAME (dribblee
)), sizeof (char),
3279 SBYTES (SYMBOL_NAME (dribblee
)),
3281 putc ('>', dribble
);
3290 /* Copy out or in the info on where C-g should throw to.
3291 This is used when running Lisp code from within get_char,
3292 in case get_char is called recursively.
3293 See read_process_output. */
3296 save_getcjmp (sys_jmp_buf temp
)
3298 memcpy (temp
, getcjmp
, sizeof getcjmp
);
3302 restore_getcjmp (sys_jmp_buf temp
)
3304 memcpy (getcjmp
, temp
, sizeof getcjmp
);
3307 /* Low level keyboard/mouse input.
3308 kbd_buffer_store_event places events in kbd_buffer, and
3309 kbd_buffer_get_event retrieves them. */
3311 /* Return true if there are any events in the queue that read-char
3312 would return. If this returns false, a read-char would block. */
3314 readable_events (int flags
)
3316 if (flags
& READABLE_EVENTS_DO_TIMERS_NOW
)
3319 /* If the buffer contains only FOCUS_IN_EVENT events, and
3320 READABLE_EVENTS_FILTER_EVENTS is set, report it as empty. */
3321 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3323 if (flags
& (READABLE_EVENTS_FILTER_EVENTS
3324 #ifdef USE_TOOLKIT_SCROLL_BARS
3325 | READABLE_EVENTS_IGNORE_SQUEEZABLES
3329 union buffered_input_event
*event
= kbd_fetch_ptr
;
3333 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3336 #ifdef USE_TOOLKIT_SCROLL_BARS
3337 (flags
& READABLE_EVENTS_FILTER_EVENTS
) &&
3339 event
->kind
== FOCUS_IN_EVENT
)
3340 #ifdef USE_TOOLKIT_SCROLL_BARS
3341 && !((flags
& READABLE_EVENTS_IGNORE_SQUEEZABLES
)
3342 && (event
->kind
== SCROLL_BAR_CLICK_EVENT
3343 || event
->kind
== HORIZONTAL_SCROLL_BAR_CLICK_EVENT
)
3344 && event
->ie
.part
== scroll_bar_handle
3345 && event
->ie
.modifiers
== 0)
3347 && !((flags
& READABLE_EVENTS_FILTER_EVENTS
)
3348 && event
->kind
== BUFFER_SWITCH_EVENT
))
3352 while (event
!= kbd_store_ptr
);
3358 if (!(flags
& READABLE_EVENTS_IGNORE_SQUEEZABLES
)
3359 && !NILP (do_mouse_tracking
) && some_mouse_moved ())
3363 if (current_kboard
->kbd_queue_has_data
)
3369 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
3370 if (kb
->kbd_queue_has_data
)
3376 /* Set this for debugging, to have a way to get out */
3377 int stop_character EXTERNALLY_VISIBLE
;
3380 event_to_kboard (struct input_event
*event
)
3382 /* Not applicable for these special events. */
3383 if (event
->kind
== SELECTION_REQUEST_EVENT
3384 || event
->kind
== SELECTION_CLEAR_EVENT
)
3388 Lisp_Object obj
= event
->frame_or_window
;
3389 /* There are some events that set this field to nil or string. */
3391 obj
= WINDOW_FRAME (XWINDOW (obj
));
3392 /* Also ignore dead frames here. */
3393 return ((FRAMEP (obj
) && FRAME_LIVE_P (XFRAME (obj
)))
3394 ? FRAME_KBOARD (XFRAME (obj
)) : NULL
);
3399 /* Return the number of slots occupied in kbd_buffer. */
3402 kbd_buffer_nr_stored (void)
3404 return kbd_fetch_ptr
== kbd_store_ptr
3406 : (kbd_fetch_ptr
< kbd_store_ptr
3407 ? kbd_store_ptr
- kbd_fetch_ptr
3408 : ((kbd_buffer
+ KBD_BUFFER_SIZE
) - kbd_fetch_ptr
3409 + (kbd_store_ptr
- kbd_buffer
)));
3411 #endif /* Store an event obtained at interrupt level into kbd_buffer, fifo */
3414 kbd_buffer_store_event (register struct input_event
*event
)
3416 kbd_buffer_store_event_hold (event
, 0);
3419 /* Store EVENT obtained at interrupt level into kbd_buffer, fifo.
3421 If HOLD_QUIT is 0, just stuff EVENT into the fifo.
3422 Else, if HOLD_QUIT.kind != NO_EVENT, discard EVENT.
3423 Else, if EVENT is a quit event, store the quit event
3424 in HOLD_QUIT, and return (thus ignoring further events).
3426 This is used to postpone the processing of the quit event until all
3427 subsequent input events have been parsed (and discarded). */
3430 kbd_buffer_store_buffered_event (union buffered_input_event
*event
,
3431 struct input_event
*hold_quit
)
3433 if (event
->kind
== NO_EVENT
)
3436 if (hold_quit
&& hold_quit
->kind
!= NO_EVENT
)
3439 if (event
->kind
== ASCII_KEYSTROKE_EVENT
)
3441 int c
= event
->ie
.code
& 0377;
3443 if (event
->ie
.modifiers
& ctrl_modifier
)
3444 c
= make_ctrl_char (c
);
3446 c
|= (event
->ie
.modifiers
3447 & (meta_modifier
| alt_modifier
3448 | hyper_modifier
| super_modifier
));
3452 KBOARD
*kb
= FRAME_KBOARD (XFRAME (event
->ie
.frame_or_window
));
3454 if (single_kboard
&& kb
!= current_kboard
)
3457 (kb
, list2 (make_lispy_switch_frame (event
->ie
.frame_or_window
),
3459 kb
->kbd_queue_has_data
= true;
3460 union buffered_input_event
*sp
;
3461 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3463 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3466 if (event_to_kboard (&sp
->ie
) == kb
)
3468 sp
->ie
.kind
= NO_EVENT
;
3469 sp
->ie
.frame_or_window
= Qnil
;
3478 *hold_quit
= event
->ie
;
3482 /* If this results in a quit_char being returned to Emacs as
3483 input, set Vlast_event_frame properly. If this doesn't
3484 get returned to Emacs as an event, the next event read
3485 will set Vlast_event_frame again, so this is safe to do. */
3489 focus
= FRAME_FOCUS_FRAME (XFRAME (event
->ie
.frame_or_window
));
3491 focus
= event
->ie
.frame_or_window
;
3492 internal_last_event_frame
= focus
;
3493 Vlast_event_frame
= focus
;
3496 handle_interrupt (0);
3500 if (c
&& c
== stop_character
)
3506 /* Don't insert two BUFFER_SWITCH_EVENT's in a row.
3507 Just ignore the second one. */
3508 else if (event
->kind
== BUFFER_SWITCH_EVENT
3509 && kbd_fetch_ptr
!= kbd_store_ptr
3510 && ((kbd_store_ptr
== kbd_buffer
3511 ? kbd_buffer
+ KBD_BUFFER_SIZE
- 1
3512 : kbd_store_ptr
- 1)->kind
) == BUFFER_SWITCH_EVENT
)
3515 if (kbd_store_ptr
- kbd_buffer
== KBD_BUFFER_SIZE
)
3516 kbd_store_ptr
= kbd_buffer
;
3518 /* Don't let the very last slot in the buffer become full,
3519 since that would make the two pointers equal,
3520 and that is indistinguishable from an empty buffer.
3521 Discard the event if it would fill the last slot. */
3522 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
3524 *kbd_store_ptr
= *event
;
3527 if (kbd_buffer_nr_stored () > KBD_BUFFER_SIZE
/ 2
3528 && ! kbd_on_hold_p ())
3530 /* Don't read keyboard input until we have processed kbd_buffer.
3531 This happens when pasting text longer than KBD_BUFFER_SIZE/2. */
3532 hold_keyboard_input ();
3536 #endif /* subprocesses */
3539 /* If we're inside while-no-input, and this event qualifies
3540 as input, set quit-flag to cause an interrupt. */
3541 if (!NILP (Vthrow_on_input
)
3542 && event
->kind
!= FOCUS_IN_EVENT
3543 && event
->kind
!= FOCUS_OUT_EVENT
3544 && event
->kind
!= HELP_EVENT
3545 && event
->kind
!= ICONIFY_EVENT
3546 && event
->kind
!= DEICONIFY_EVENT
)
3548 Vquit_flag
= Vthrow_on_input
;
3549 /* If we're inside a function that wants immediate quits,
3551 if (immediate_quit
&& NILP (Vinhibit_quit
))
3553 immediate_quit
= false;
3562 /* Put a selection input event back in the head of the event queue. */
3565 kbd_buffer_unget_event (struct selection_input_event
*event
)
3567 if (kbd_fetch_ptr
== kbd_buffer
)
3568 kbd_fetch_ptr
= kbd_buffer
+ KBD_BUFFER_SIZE
;
3570 /* Don't let the very last slot in the buffer become full, */
3571 union buffered_input_event
*kp
= kbd_fetch_ptr
- 1;
3572 if (kp
!= kbd_store_ptr
)
3581 /* Limit help event positions to this range, to avoid overflow problems. */
3582 #define INPUT_EVENT_POS_MAX \
3583 ((ptrdiff_t) min (PTRDIFF_MAX, min (TYPE_MAXIMUM (Time) / 2, \
3584 MOST_POSITIVE_FIXNUM)))
3585 #define INPUT_EVENT_POS_MIN (-1 - INPUT_EVENT_POS_MAX)
3587 /* Return a Time that encodes position POS. POS must be in range. */
3590 position_to_Time (ptrdiff_t pos
)
3592 eassert (INPUT_EVENT_POS_MIN
<= pos
&& pos
<= INPUT_EVENT_POS_MAX
);
3596 /* Return the position that ENCODED_POS encodes.
3597 Avoid signed integer overflow. */
3600 Time_to_position (Time encoded_pos
)
3602 if (encoded_pos
<= INPUT_EVENT_POS_MAX
)
3604 Time encoded_pos_min
= INPUT_EVENT_POS_MIN
;
3605 eassert (encoded_pos_min
<= encoded_pos
);
3606 ptrdiff_t notpos
= -1 - encoded_pos
;
3610 /* Generate a HELP_EVENT input_event and store it in the keyboard
3613 HELP is the help form.
3615 FRAME and WINDOW are the frame and window where the help is
3616 generated. OBJECT is the Lisp object where the help was found (a
3617 buffer, a string, an overlay, or nil if neither from a string nor
3618 from a buffer). POS is the position within OBJECT where the help
3622 gen_help_event (Lisp_Object help
, Lisp_Object frame
, Lisp_Object window
,
3623 Lisp_Object object
, ptrdiff_t pos
)
3625 struct input_event event
;
3627 event
.kind
= HELP_EVENT
;
3628 event
.frame_or_window
= frame
;
3630 event
.x
= WINDOWP (window
) ? window
: frame
;
3632 event
.timestamp
= position_to_Time (pos
);
3633 kbd_buffer_store_event (&event
);
3637 /* Store HELP_EVENTs for HELP on FRAME in the input queue. */
3640 kbd_buffer_store_help_event (Lisp_Object frame
, Lisp_Object help
)
3642 struct input_event event
;
3644 event
.kind
= HELP_EVENT
;
3645 event
.frame_or_window
= frame
;
3649 event
.timestamp
= 0;
3650 kbd_buffer_store_event (&event
);
3654 /* Discard any mouse events in the event buffer by setting them to
3657 discard_mouse_events (void)
3659 union buffered_input_event
*sp
;
3660 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3662 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3665 if (sp
->kind
== MOUSE_CLICK_EVENT
3666 || sp
->kind
== WHEEL_EVENT
3667 || sp
->kind
== HORIZ_WHEEL_EVENT
3669 || sp
->kind
== GPM_CLICK_EVENT
3671 || sp
->kind
== SCROLL_BAR_CLICK_EVENT
3672 || sp
->kind
== HORIZONTAL_SCROLL_BAR_CLICK_EVENT
)
3674 sp
->kind
= NO_EVENT
;
3680 /* Return true if there are any real events waiting in the event
3681 buffer, not counting `NO_EVENT's.
3683 Discard NO_EVENT events at the front of the input queue, possibly
3684 leaving the input queue empty if there are no real input events. */
3687 kbd_buffer_events_waiting (void)
3689 union buffered_input_event
*sp
;
3691 for (sp
= kbd_fetch_ptr
;
3692 sp
!= kbd_store_ptr
&& sp
->kind
== NO_EVENT
;
3695 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3700 return sp
!= kbd_store_ptr
&& sp
->kind
!= NO_EVENT
;
3704 /* Clear input event EVENT. */
3707 clear_event (union buffered_input_event
*event
)
3709 event
->kind
= NO_EVENT
;
3713 /* Read one event from the event buffer, waiting if necessary.
3714 The value is a Lisp object representing the event.
3715 The value is nil for an event that should be ignored,
3716 or that was handled here.
3717 We always read and discard one event. */
3720 kbd_buffer_get_event (KBOARD
**kbp
,
3721 bool *used_mouse_menu
,
3722 struct timespec
*end_time
)
3727 if (kbd_on_hold_p () && kbd_buffer_nr_stored () < KBD_BUFFER_SIZE
/ 4)
3729 /* Start reading input again because we have processed enough to
3730 be able to accept new events again. */
3731 unhold_keyboard_input ();
3735 #endif /* subprocesses */
3737 #if !defined HAVE_DBUS && !defined USE_FILE_NOTIFY
3739 /* In case we are running as a daemon, only do this before
3740 detaching from the terminal. */
3741 || (IS_DAEMON
&& DAEMON_RUNNING
))
3745 *kbp
= current_kboard
;
3748 #endif /* !defined HAVE_DBUS && !defined USE_FILE_NOTIFY */
3750 /* Wait until there is input available. */
3753 /* Break loop if there's an unread command event. Needed in
3754 moused window autoselection which uses a timer to insert such
3756 if (CONSP (Vunread_command_events
))
3759 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3761 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3764 /* If the quit flag is set, then read_char will return
3765 quit_char, so that counts as "available input." */
3766 if (!NILP (Vquit_flag
))
3767 quit_throw_to_read_char (0);
3769 /* One way or another, wait until input is available; then, if
3770 interrupt handlers have not read it, read it now. */
3775 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3777 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3781 struct timespec now
= current_timespec ();
3782 if (timespec_cmp (*end_time
, now
) <= 0)
3783 return Qnil
; /* Finished waiting. */
3786 struct timespec duration
= timespec_sub (*end_time
, now
);
3787 wait_reading_process_output (min (duration
.tv_sec
,
3790 -1, 1, Qnil
, NULL
, 0);
3795 bool do_display
= true;
3797 if (FRAME_TERMCAP_P (SELECTED_FRAME ()))
3799 struct tty_display_info
*tty
= CURTTY ();
3801 /* When this TTY is displaying a menu, we must prevent
3802 any redisplay, because we modify the frame's glyph
3803 matrix behind the back of the display engine. */
3804 if (tty
->showing_menu
)
3808 wait_reading_process_output (0, 0, -1, do_display
, Qnil
, NULL
, 0);
3811 if (!interrupt_input
&& kbd_fetch_ptr
== kbd_store_ptr
)
3815 if (CONSP (Vunread_command_events
))
3818 first
= XCAR (Vunread_command_events
);
3819 Vunread_command_events
= XCDR (Vunread_command_events
);
3820 *kbp
= current_kboard
;
3824 /* At this point, we know that there is a readable event available
3825 somewhere. If the event queue is empty, then there must be a
3826 mouse movement enabled and available. */
3827 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3829 union buffered_input_event
*event
;
3831 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
3835 *kbp
= event_to_kboard (&event
->ie
);
3837 *kbp
= current_kboard
; /* Better than returning null ptr? */
3841 /* These two kinds of events get special handling
3842 and don't actually appear to the command loop.
3843 We return nil for them. */
3844 if (event
->kind
== SELECTION_REQUEST_EVENT
3845 || event
->kind
== SELECTION_CLEAR_EVENT
)
3848 /* Remove it from the buffer before processing it,
3849 since otherwise swallow_events will see it
3850 and process it again. */
3851 struct selection_input_event copy
= event
->sie
;
3852 kbd_fetch_ptr
= event
+ 1;
3853 input_pending
= readable_events (0);
3854 x_handle_selection_event (©
);
3856 /* We're getting selection request events, but we don't have
3862 #if defined (HAVE_NS)
3863 else if (event
->kind
== NS_TEXT_EVENT
)
3865 if (event
->ie
.code
== KEY_NS_PUT_WORKING_TEXT
)
3866 obj
= list1 (intern ("ns-put-working-text"));
3868 obj
= list1 (intern ("ns-unput-working-text"));
3869 kbd_fetch_ptr
= event
+ 1;
3870 if (used_mouse_menu
)
3871 *used_mouse_menu
= true;
3875 #if defined (HAVE_X11) || defined (HAVE_NTGUI) \
3876 || defined (HAVE_NS)
3877 else if (event
->kind
== DELETE_WINDOW_EVENT
)
3879 /* Make an event (delete-frame (FRAME)). */
3880 obj
= list2 (Qdelete_frame
, list1 (event
->ie
.frame_or_window
));
3881 kbd_fetch_ptr
= event
+ 1;
3884 #if defined (HAVE_X11) || defined (HAVE_NTGUI) \
3885 || defined (HAVE_NS)
3886 else if (event
->kind
== ICONIFY_EVENT
)
3888 /* Make an event (iconify-frame (FRAME)). */
3889 obj
= list2 (Qiconify_frame
, list1 (event
->ie
.frame_or_window
));
3890 kbd_fetch_ptr
= event
+ 1;
3892 else if (event
->kind
== DEICONIFY_EVENT
)
3894 /* Make an event (make-frame-visible (FRAME)). */
3895 obj
= list2 (Qmake_frame_visible
, list1 (event
->ie
.frame_or_window
));
3896 kbd_fetch_ptr
= event
+ 1;
3899 else if (event
->kind
== BUFFER_SWITCH_EVENT
)
3901 /* The value doesn't matter here; only the type is tested. */
3902 XSETBUFFER (obj
, current_buffer
);
3903 kbd_fetch_ptr
= event
+ 1;
3905 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
3906 || defined (HAVE_NS) || defined (USE_GTK)
3907 else if (event
->kind
== MENU_BAR_ACTIVATE_EVENT
)
3909 kbd_fetch_ptr
= event
+ 1;
3910 input_pending
= readable_events (0);
3911 if (FRAME_LIVE_P (XFRAME (event
->ie
.frame_or_window
)))
3912 x_activate_menubar (XFRAME (event
->ie
.frame_or_window
));
3916 else if (event
->kind
== LANGUAGE_CHANGE_EVENT
)
3918 /* Make an event (language-change FRAME CODEPAGE LANGUAGE-ID). */
3919 obj
= list4 (Qlanguage_change
,
3920 event
->ie
.frame_or_window
,
3921 make_number (event
->ie
.code
),
3922 make_number (event
->ie
.modifiers
));
3923 kbd_fetch_ptr
= event
+ 1;
3926 #ifdef USE_FILE_NOTIFY
3927 else if (event
->kind
== FILE_NOTIFY_EVENT
)
3929 #ifdef HAVE_W32NOTIFY
3930 /* Make an event (file-notify (DESCRIPTOR ACTION FILE) CALLBACK). */
3931 obj
= list3 (Qfile_notify
, event
->ie
.arg
, event
->ie
.frame_or_window
);
3933 obj
= make_lispy_event (&event
->ie
);
3935 kbd_fetch_ptr
= event
+ 1;
3937 #endif /* USE_FILE_NOTIFY */
3938 else if (event
->kind
== SAVE_SESSION_EVENT
)
3940 obj
= list2 (Qsave_session
, event
->ie
.arg
);
3941 kbd_fetch_ptr
= event
+ 1;
3943 /* Just discard these, by returning nil.
3944 With MULTI_KBOARD, these events are used as placeholders
3945 when we need to randomly delete events from the queue.
3946 (They shouldn't otherwise be found in the buffer,
3947 but on some machines it appears they do show up
3948 even without MULTI_KBOARD.) */
3949 /* On Windows NT/9X, NO_EVENT is used to delete extraneous
3950 mouse events during a popup-menu call. */
3951 else if (event
->kind
== NO_EVENT
)
3952 kbd_fetch_ptr
= event
+ 1;
3953 else if (event
->kind
== HELP_EVENT
)
3955 Lisp_Object object
, position
, help
, frame
, window
;
3957 frame
= event
->ie
.frame_or_window
;
3958 object
= event
->ie
.arg
;
3959 position
= make_number (Time_to_position (event
->ie
.timestamp
));
3960 window
= event
->ie
.x
;
3962 clear_event (event
);
3964 kbd_fetch_ptr
= event
+ 1;
3965 if (!WINDOWP (window
))
3967 obj
= Fcons (Qhelp_echo
,
3968 list5 (frame
, help
, window
, object
, position
));
3970 else if (event
->kind
== FOCUS_IN_EVENT
)
3972 /* Notification of a FocusIn event. The frame receiving the
3973 focus is in event->frame_or_window. Generate a
3974 switch-frame event if necessary. */
3975 Lisp_Object frame
, focus
;
3977 frame
= event
->ie
.frame_or_window
;
3978 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
3984 ! NILP (event
->ie
.arg
)
3987 !EQ (frame
, internal_last_event_frame
)
3988 && !EQ (frame
, selected_frame
))
3989 obj
= make_lispy_switch_frame (frame
);
3991 obj
= make_lispy_focus_in (frame
);
3993 internal_last_event_frame
= frame
;
3994 kbd_fetch_ptr
= event
+ 1;
3996 else if (event
->kind
== FOCUS_OUT_EVENT
)
3998 #ifdef HAVE_WINDOW_SYSTEM
4001 Lisp_Object frame
= event
->ie
.frame_or_window
;
4002 bool focused
= false;
4004 for (di
= x_display_list
; di
&& ! focused
; di
= di
->next
)
4005 focused
= di
->x_highlight_frame
!= 0;
4008 obj
= make_lispy_focus_out (frame
);
4010 #endif /* HAVE_WINDOW_SYSTEM */
4012 kbd_fetch_ptr
= event
+ 1;
4015 else if (event
->kind
== DBUS_EVENT
)
4017 obj
= make_lispy_event (&event
->ie
);
4018 kbd_fetch_ptr
= event
+ 1;
4021 #ifdef HAVE_XWIDGETS
4022 else if (event
->kind
== XWIDGET_EVENT
)
4024 obj
= make_lispy_event (&event
->ie
);
4025 kbd_fetch_ptr
= event
+ 1;
4028 else if (event
->kind
== CONFIG_CHANGED_EVENT
)
4030 obj
= make_lispy_event (&event
->ie
);
4031 kbd_fetch_ptr
= event
+ 1;
4035 /* If this event is on a different frame, return a switch-frame this
4036 time, and leave the event in the queue for next time. */
4040 frame
= event
->ie
.frame_or_window
;
4042 frame
= XCAR (frame
);
4043 else if (WINDOWP (frame
))
4044 frame
= WINDOW_FRAME (XWINDOW (frame
));
4046 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
4050 if (! EQ (frame
, internal_last_event_frame
)
4051 && !EQ (frame
, selected_frame
))
4052 obj
= make_lispy_switch_frame (frame
);
4053 internal_last_event_frame
= frame
;
4055 /* If we didn't decide to make a switch-frame event, go ahead
4056 and build a real event from the queue entry. */
4060 obj
= make_lispy_event (&event
->ie
);
4062 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
4063 || defined (HAVE_NS) || defined (USE_GTK)
4064 /* If this was a menu selection, then set the flag to inhibit
4065 writing to last_nonmenu_event. Don't do this if the event
4066 we're returning is (menu-bar), though; that indicates the
4067 beginning of the menu sequence, and we might as well leave
4068 that as the `event with parameters' for this selection. */
4070 && !EQ (event
->ie
.frame_or_window
, event
->ie
.arg
)
4071 && (event
->kind
== MENU_BAR_EVENT
4072 || event
->kind
== TOOL_BAR_EVENT
))
4073 *used_mouse_menu
= true;
4076 /* Certain system events are non-key events. */
4078 && event
->kind
== NS_NONKEY_EVENT
)
4079 *used_mouse_menu
= true;
4082 /* Wipe out this event, to catch bugs. */
4083 clear_event (event
);
4084 kbd_fetch_ptr
= event
+ 1;
4088 /* Try generating a mouse motion event. */
4089 else if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
4091 struct frame
*f
= some_mouse_moved ();
4092 Lisp_Object bar_window
;
4093 enum scroll_bar_part part
;
4097 *kbp
= current_kboard
;
4098 /* Note that this uses F to determine which terminal to look at.
4099 If there is no valid info, it does not store anything
4100 so x remains nil. */
4103 /* XXX Can f or mouse_position_hook be NULL here? */
4104 if (f
&& FRAME_TERMINAL (f
)->mouse_position_hook
)
4105 (*FRAME_TERMINAL (f
)->mouse_position_hook
) (&f
, 0, &bar_window
,
4110 /* Decide if we should generate a switch-frame event. Don't
4111 generate switch-frame events for motion outside of all Emacs
4117 frame
= FRAME_FOCUS_FRAME (f
);
4119 XSETFRAME (frame
, f
);
4121 if (! EQ (frame
, internal_last_event_frame
)
4122 && !EQ (frame
, selected_frame
))
4123 obj
= make_lispy_switch_frame (frame
);
4124 internal_last_event_frame
= frame
;
4127 /* If we didn't decide to make a switch-frame event, go ahead and
4128 return a mouse-motion event. */
4129 if (!NILP (x
) && NILP (obj
))
4130 obj
= make_lispy_movement (f
, bar_window
, part
, x
, y
, t
);
4133 /* We were promised by the above while loop that there was
4134 something for us to read! */
4137 input_pending
= readable_events (0);
4139 Vlast_event_frame
= internal_last_event_frame
;
4144 /* Process any non-user-visible events (currently X selection events),
4145 without reading any user-visible events. */
4148 process_special_events (void)
4150 union buffered_input_event
*event
;
4152 for (event
= kbd_fetch_ptr
; event
!= kbd_store_ptr
; ++event
)
4154 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
4157 if (event
== kbd_store_ptr
)
4161 /* If we find a stored X selection request, handle it now. */
4162 if (event
->kind
== SELECTION_REQUEST_EVENT
4163 || event
->kind
== SELECTION_CLEAR_EVENT
)
4167 /* Remove the event from the fifo buffer before processing;
4168 otherwise swallow_events called recursively could see it
4169 and process it again. To do this, we move the events
4170 between kbd_fetch_ptr and EVENT one slot to the right,
4173 struct selection_input_event copy
= event
->sie
;
4174 union buffered_input_event
*beg
4175 = (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
4176 ? kbd_buffer
: kbd_fetch_ptr
;
4179 memmove (beg
+ 1, beg
, (event
- beg
) * sizeof *beg
);
4180 else if (event
< beg
)
4182 if (event
> kbd_buffer
)
4183 memmove (kbd_buffer
+ 1, kbd_buffer
,
4184 (event
- kbd_buffer
) * sizeof *kbd_buffer
);
4185 *kbd_buffer
= *(kbd_buffer
+ KBD_BUFFER_SIZE
- 1);
4186 if (beg
< kbd_buffer
+ KBD_BUFFER_SIZE
- 1)
4187 memmove (beg
+ 1, beg
,
4188 (kbd_buffer
+ KBD_BUFFER_SIZE
- 1 - beg
) * sizeof *beg
);
4191 if (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
4192 kbd_fetch_ptr
= kbd_buffer
+ 1;
4196 input_pending
= readable_events (0);
4197 x_handle_selection_event (©
);
4199 /* We're getting selection request events, but we don't have
4207 /* Process any events that are not user-visible, run timer events that
4208 are ripe, and return, without reading any user-visible events. */
4211 swallow_events (bool do_display
)
4213 unsigned old_timers_run
;
4215 process_special_events ();
4217 old_timers_run
= timers_run
;
4218 get_input_pending (READABLE_EVENTS_DO_TIMERS_NOW
);
4220 if (!input_pending
&& timers_run
!= old_timers_run
&& do_display
)
4221 redisplay_preserve_echo_area (7);
4224 /* Record the start of when Emacs is idle,
4225 for the sake of running idle-time timers. */
4228 timer_start_idle (void)
4230 /* If we are already in the idle state, do nothing. */
4231 if (timespec_valid_p (timer_idleness_start_time
))
4234 timer_idleness_start_time
= current_timespec ();
4235 timer_last_idleness_start_time
= timer_idleness_start_time
;
4237 /* Mark all idle-time timers as once again candidates for running. */
4238 call0 (intern ("internal-timer-start-idle"));
4241 /* Record that Emacs is no longer idle, so stop running idle-time timers. */
4244 timer_stop_idle (void)
4246 timer_idleness_start_time
= invalid_timespec ();
4249 /* Resume idle timer from last idle start time. */
4252 timer_resume_idle (void)
4254 if (timespec_valid_p (timer_idleness_start_time
))
4257 timer_idleness_start_time
= timer_last_idleness_start_time
;
4260 /* List of elisp functions to call, delayed because they were generated in
4261 a context where Elisp could not be safely run (e.g. redisplay, signal,
4262 ...). Each element has the form (FUN . ARGS). */
4263 Lisp_Object pending_funcalls
;
4265 /* Return true if TIMER is a valid timer, placing its value into *RESULT. */
4267 decode_timer (Lisp_Object timer
, struct timespec
*result
)
4271 if (! (VECTORP (timer
) && ASIZE (timer
) == 9))
4273 vec
= XVECTOR (timer
)->contents
;
4274 if (! NILP (vec
[0]))
4276 if (! INTEGERP (vec
[2]))
4280 if (decode_time_components (vec
[1], vec
[2], vec
[3], vec
[8], &t
, 0) <= 0)
4282 *result
= lisp_to_timespec (t
);
4283 return timespec_valid_p (*result
);
4287 /* Check whether a timer has fired. To prevent larger problems we simply
4288 disregard elements that are not proper timers. Do not make a circular
4289 timer list for the time being.
4291 Returns the time to wait until the next timer fires. If a
4292 timer is triggering now, return zero.
4293 If no timer is active, return -1.
4295 If a timer is ripe, we run it, with quitting turned off.
4296 In that case we return 0 to indicate that a new timer_check_2 call
4299 static struct timespec
4300 timer_check_2 (Lisp_Object timers
, Lisp_Object idle_timers
)
4302 struct timespec nexttime
;
4303 struct timespec now
;
4304 struct timespec idleness_now
;
4305 Lisp_Object chosen_timer
;
4307 nexttime
= invalid_timespec ();
4309 chosen_timer
= Qnil
;
4311 /* First run the code that was delayed. */
4312 while (CONSP (pending_funcalls
))
4314 Lisp_Object funcall
= XCAR (pending_funcalls
);
4315 pending_funcalls
= XCDR (pending_funcalls
);
4316 safe_call2 (Qapply
, XCAR (funcall
), XCDR (funcall
));
4319 if (CONSP (timers
) || CONSP (idle_timers
))
4321 now
= current_timespec ();
4322 idleness_now
= (timespec_valid_p (timer_idleness_start_time
)
4323 ? timespec_sub (now
, timer_idleness_start_time
)
4324 : make_timespec (0, 0));
4327 while (CONSP (timers
) || CONSP (idle_timers
))
4329 Lisp_Object timer
= Qnil
, idle_timer
= Qnil
;
4330 struct timespec timer_time
, idle_timer_time
;
4331 struct timespec difference
;
4332 struct timespec timer_difference
= invalid_timespec ();
4333 struct timespec idle_timer_difference
= invalid_timespec ();
4334 bool ripe
, timer_ripe
= 0, idle_timer_ripe
= 0;
4336 /* Set TIMER and TIMER_DIFFERENCE
4337 based on the next ordinary timer.
4338 TIMER_DIFFERENCE is the distance in time from NOW to when
4339 this timer becomes ripe.
4340 Skip past invalid timers and timers already handled. */
4343 timer
= XCAR (timers
);
4344 if (! decode_timer (timer
, &timer_time
))
4346 timers
= XCDR (timers
);
4350 timer_ripe
= timespec_cmp (timer_time
, now
) <= 0;
4351 timer_difference
= (timer_ripe
4352 ? timespec_sub (now
, timer_time
)
4353 : timespec_sub (timer_time
, now
));
4356 /* Likewise for IDLE_TIMER and IDLE_TIMER_DIFFERENCE
4357 based on the next idle timer. */
4358 if (CONSP (idle_timers
))
4360 idle_timer
= XCAR (idle_timers
);
4361 if (! decode_timer (idle_timer
, &idle_timer_time
))
4363 idle_timers
= XCDR (idle_timers
);
4367 idle_timer_ripe
= timespec_cmp (idle_timer_time
, idleness_now
) <= 0;
4368 idle_timer_difference
4370 ? timespec_sub (idleness_now
, idle_timer_time
)
4371 : timespec_sub (idle_timer_time
, idleness_now
));
4374 /* Decide which timer is the next timer,
4375 and set CHOSEN_TIMER, DIFFERENCE, and RIPE accordingly.
4376 Also step down the list where we found that timer. */
4378 if (timespec_valid_p (timer_difference
)
4379 && (! timespec_valid_p (idle_timer_difference
)
4380 || idle_timer_ripe
< timer_ripe
4381 || (idle_timer_ripe
== timer_ripe
4383 ? timespec_cmp (idle_timer_difference
,
4385 : timespec_cmp (timer_difference
,
4386 idle_timer_difference
))
4389 chosen_timer
= timer
;
4390 timers
= XCDR (timers
);
4391 difference
= timer_difference
;
4396 chosen_timer
= idle_timer
;
4397 idle_timers
= XCDR (idle_timers
);
4398 difference
= idle_timer_difference
;
4399 ripe
= idle_timer_ripe
;
4402 /* If timer is ripe, run it if it hasn't been run. */
4405 if (NILP (AREF (chosen_timer
, 0)))
4407 ptrdiff_t count
= SPECPDL_INDEX ();
4408 Lisp_Object old_deactivate_mark
= Vdeactivate_mark
;
4410 /* Mark the timer as triggered to prevent problems if the lisp
4411 code fails to reschedule it right. */
4412 ASET (chosen_timer
, 0, Qt
);
4414 specbind (Qinhibit_quit
, Qt
);
4416 call1 (Qtimer_event_handler
, chosen_timer
);
4417 Vdeactivate_mark
= old_deactivate_mark
;
4419 unbind_to (count
, Qnil
);
4421 /* Since we have handled the event,
4422 we don't need to tell the caller to wake up and do it. */
4423 /* But the caller must still wait for the next timer, so
4424 return 0 to indicate that. */
4427 nexttime
= make_timespec (0, 0);
4431 /* When we encounter a timer that is still waiting,
4432 return the amount of time to wait before it is ripe. */
4438 /* No timers are pending in the future. */
4439 /* Return 0 if we generated an event, and -1 if not. */
4444 /* Check whether a timer has fired. To prevent larger problems we simply
4445 disregard elements that are not proper timers. Do not make a circular
4446 timer list for the time being.
4448 Returns the time to wait until the next timer fires.
4449 If no timer is active, return an invalid value.
4451 As long as any timer is ripe, we run it. */
4456 struct timespec nexttime
;
4457 Lisp_Object timers
, idle_timers
;
4459 Lisp_Object tem
= Vinhibit_quit
;
4462 /* We use copies of the timers' lists to allow a timer to add itself
4463 again, without locking up Emacs if the newly added timer is
4464 already ripe when added. */
4466 /* Always consider the ordinary timers. */
4467 timers
= Fcopy_sequence (Vtimer_list
);
4468 /* Consider the idle timers only if Emacs is idle. */
4469 if (timespec_valid_p (timer_idleness_start_time
))
4470 idle_timers
= Fcopy_sequence (Vtimer_idle_list
);
4474 Vinhibit_quit
= tem
;
4478 nexttime
= timer_check_2 (timers
, idle_timers
);
4480 while (nexttime
.tv_sec
== 0 && nexttime
.tv_nsec
== 0);
4485 DEFUN ("current-idle-time", Fcurrent_idle_time
, Scurrent_idle_time
, 0, 0, 0,
4486 doc
: /* Return the current length of Emacs idleness, or nil.
4487 The value when Emacs is idle is a list of four integers (HIGH LOW USEC PSEC)
4488 in the same style as (current-time).
4490 The value when Emacs is not idle is nil.
4492 PSEC is a multiple of the system clock resolution. */)
4495 if (timespec_valid_p (timer_idleness_start_time
))
4496 return make_lisp_time (timespec_sub (current_timespec (),
4497 timer_idleness_start_time
));
4502 /* Caches for modify_event_symbol. */
4503 static Lisp_Object accent_key_syms
;
4504 static Lisp_Object func_key_syms
;
4505 static Lisp_Object mouse_syms
;
4506 static Lisp_Object wheel_syms
;
4507 static Lisp_Object drag_n_drop_syms
;
4509 /* This is a list of keysym codes for special "accent" characters.
4510 It parallels lispy_accent_keys. */
4512 static const int lispy_accent_codes
[] =
4514 #ifdef XK_dead_circumflex
4519 #ifdef XK_dead_grave
4524 #ifdef XK_dead_tilde
4529 #ifdef XK_dead_diaeresis
4534 #ifdef XK_dead_macron
4539 #ifdef XK_dead_degree
4544 #ifdef XK_dead_acute
4549 #ifdef XK_dead_cedilla
4554 #ifdef XK_dead_breve
4559 #ifdef XK_dead_ogonek
4564 #ifdef XK_dead_caron
4569 #ifdef XK_dead_doubleacute
4570 XK_dead_doubleacute
,
4574 #ifdef XK_dead_abovedot
4579 #ifdef XK_dead_abovering
4589 #ifdef XK_dead_belowdot
4594 #ifdef XK_dead_voiced_sound
4595 XK_dead_voiced_sound
,
4599 #ifdef XK_dead_semivoiced_sound
4600 XK_dead_semivoiced_sound
,
4616 /* This is a list of Lisp names for special "accent" characters.
4617 It parallels lispy_accent_codes. */
4619 static const char *const lispy_accent_keys
[] =
4637 "dead-voiced-sound",
4638 "dead-semivoiced-sound",
4644 #define FUNCTION_KEY_OFFSET 0x0
4646 const char *const lispy_function_keys
[] =
4650 0, /* VK_LBUTTON 0x01 */
4651 0, /* VK_RBUTTON 0x02 */
4652 "cancel", /* VK_CANCEL 0x03 */
4653 0, /* VK_MBUTTON 0x04 */
4655 0, 0, 0, /* 0x05 .. 0x07 */
4657 "backspace", /* VK_BACK 0x08 */
4658 "tab", /* VK_TAB 0x09 */
4660 0, 0, /* 0x0A .. 0x0B */
4662 "clear", /* VK_CLEAR 0x0C */
4663 "return", /* VK_RETURN 0x0D */
4665 0, 0, /* 0x0E .. 0x0F */
4667 0, /* VK_SHIFT 0x10 */
4668 0, /* VK_CONTROL 0x11 */
4669 0, /* VK_MENU 0x12 */
4670 "pause", /* VK_PAUSE 0x13 */
4671 "capslock", /* VK_CAPITAL 0x14 */
4672 "kana", /* VK_KANA/VK_HANGUL 0x15 */
4674 "junja", /* VK_JUNJA 0x17 */
4675 "final", /* VK_FINAL 0x18 */
4676 "kanji", /* VK_KANJI/VK_HANJA 0x19 */
4678 "escape", /* VK_ESCAPE 0x1B */
4679 "convert", /* VK_CONVERT 0x1C */
4680 "non-convert", /* VK_NONCONVERT 0x1D */
4681 "accept", /* VK_ACCEPT 0x1E */
4682 "mode-change", /* VK_MODECHANGE 0x1F */
4683 0, /* VK_SPACE 0x20 */
4684 "prior", /* VK_PRIOR 0x21 */
4685 "next", /* VK_NEXT 0x22 */
4686 "end", /* VK_END 0x23 */
4687 "home", /* VK_HOME 0x24 */
4688 "left", /* VK_LEFT 0x25 */
4689 "up", /* VK_UP 0x26 */
4690 "right", /* VK_RIGHT 0x27 */
4691 "down", /* VK_DOWN 0x28 */
4692 "select", /* VK_SELECT 0x29 */
4693 "print", /* VK_PRINT 0x2A */
4694 "execute", /* VK_EXECUTE 0x2B */
4695 "snapshot", /* VK_SNAPSHOT 0x2C */
4696 "insert", /* VK_INSERT 0x2D */
4697 "delete", /* VK_DELETE 0x2E */
4698 "help", /* VK_HELP 0x2F */
4700 /* VK_0 thru VK_9 are the same as ASCII '0' thru '9' (0x30 - 0x39) */
4702 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4704 0, 0, 0, 0, 0, 0, 0, /* 0x3A .. 0x40 */
4706 /* VK_A thru VK_Z are the same as ASCII 'A' thru 'Z' (0x41 - 0x5A) */
4708 0, 0, 0, 0, 0, 0, 0, 0, 0,
4709 0, 0, 0, 0, 0, 0, 0, 0, 0,
4710 0, 0, 0, 0, 0, 0, 0, 0,
4712 "lwindow", /* VK_LWIN 0x5B */
4713 "rwindow", /* VK_RWIN 0x5C */
4714 "apps", /* VK_APPS 0x5D */
4717 "kp-0", /* VK_NUMPAD0 0x60 */
4718 "kp-1", /* VK_NUMPAD1 0x61 */
4719 "kp-2", /* VK_NUMPAD2 0x62 */
4720 "kp-3", /* VK_NUMPAD3 0x63 */
4721 "kp-4", /* VK_NUMPAD4 0x64 */
4722 "kp-5", /* VK_NUMPAD5 0x65 */
4723 "kp-6", /* VK_NUMPAD6 0x66 */
4724 "kp-7", /* VK_NUMPAD7 0x67 */
4725 "kp-8", /* VK_NUMPAD8 0x68 */
4726 "kp-9", /* VK_NUMPAD9 0x69 */
4727 "kp-multiply", /* VK_MULTIPLY 0x6A */
4728 "kp-add", /* VK_ADD 0x6B */
4729 "kp-separator", /* VK_SEPARATOR 0x6C */
4730 "kp-subtract", /* VK_SUBTRACT 0x6D */
4731 "kp-decimal", /* VK_DECIMAL 0x6E */
4732 "kp-divide", /* VK_DIVIDE 0x6F */
4733 "f1", /* VK_F1 0x70 */
4734 "f2", /* VK_F2 0x71 */
4735 "f3", /* VK_F3 0x72 */
4736 "f4", /* VK_F4 0x73 */
4737 "f5", /* VK_F5 0x74 */
4738 "f6", /* VK_F6 0x75 */
4739 "f7", /* VK_F7 0x76 */
4740 "f8", /* VK_F8 0x77 */
4741 "f9", /* VK_F9 0x78 */
4742 "f10", /* VK_F10 0x79 */
4743 "f11", /* VK_F11 0x7A */
4744 "f12", /* VK_F12 0x7B */
4745 "f13", /* VK_F13 0x7C */
4746 "f14", /* VK_F14 0x7D */
4747 "f15", /* VK_F15 0x7E */
4748 "f16", /* VK_F16 0x7F */
4749 "f17", /* VK_F17 0x80 */
4750 "f18", /* VK_F18 0x81 */
4751 "f19", /* VK_F19 0x82 */
4752 "f20", /* VK_F20 0x83 */
4753 "f21", /* VK_F21 0x84 */
4754 "f22", /* VK_F22 0x85 */
4755 "f23", /* VK_F23 0x86 */
4756 "f24", /* VK_F24 0x87 */
4758 0, 0, 0, 0, /* 0x88 .. 0x8B */
4759 0, 0, 0, 0, /* 0x8C .. 0x8F */
4761 "kp-numlock", /* VK_NUMLOCK 0x90 */
4762 "scroll", /* VK_SCROLL 0x91 */
4763 /* Not sure where the following block comes from.
4764 Windows headers have NEC and Fujitsu specific keys in
4765 this block, but nothing generic. */
4766 "kp-space", /* VK_NUMPAD_CLEAR 0x92 */
4767 "kp-enter", /* VK_NUMPAD_ENTER 0x93 */
4768 "kp-prior", /* VK_NUMPAD_PRIOR 0x94 */
4769 "kp-next", /* VK_NUMPAD_NEXT 0x95 */
4770 "kp-end", /* VK_NUMPAD_END 0x96 */
4771 "kp-home", /* VK_NUMPAD_HOME 0x97 */
4772 "kp-left", /* VK_NUMPAD_LEFT 0x98 */
4773 "kp-up", /* VK_NUMPAD_UP 0x99 */
4774 "kp-right", /* VK_NUMPAD_RIGHT 0x9A */
4775 "kp-down", /* VK_NUMPAD_DOWN 0x9B */
4776 "kp-insert", /* VK_NUMPAD_INSERT 0x9C */
4777 "kp-delete", /* VK_NUMPAD_DELETE 0x9D */
4779 0, 0, /* 0x9E .. 0x9F */
4782 * VK_L* & VK_R* - left and right Alt, Ctrl and Shift virtual keys.
4783 * Used only as parameters to GetAsyncKeyState and GetKeyState.
4784 * No other API or message will distinguish left and right keys this way.
4789 /* Multimedia keys. These are handled as WM_APPCOMMAND, which allows us
4790 to enable them selectively, and gives access to a few more functions.
4791 See lispy_multimedia_keys below. */
4792 0, 0, 0, 0, 0, 0, 0, /* 0xA6 .. 0xAC Browser */
4793 0, 0, 0, /* 0xAD .. 0xAF Volume */
4794 0, 0, 0, 0, /* 0xB0 .. 0xB3 Media */
4795 0, 0, 0, 0, /* 0xB4 .. 0xB7 Apps */
4797 /* 0xB8 .. 0xC0 "OEM" keys - all seem to be punctuation. */
4798 0, 0, 0, 0, 0, 0, 0, 0, 0,
4800 /* 0xC1 - 0xDA unallocated, 0xDB-0xDF more OEM keys */
4801 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4802 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4805 "ax", /* VK_OEM_AX 0xE1 */
4806 0, /* VK_OEM_102 0xE2 */
4807 "ico-help", /* VK_ICO_HELP 0xE3 */
4808 "ico-00", /* VK_ICO_00 0xE4 */
4809 0, /* VK_PROCESSKEY 0xE5 - used by IME */
4810 "ico-clear", /* VK_ICO_CLEAR 0xE6 */
4811 0, /* VK_PACKET 0xE7 - used to pass Unicode chars */
4813 "reset", /* VK_OEM_RESET 0xE9 */
4814 "jump", /* VK_OEM_JUMP 0xEA */
4815 "oem-pa1", /* VK_OEM_PA1 0xEB */
4816 "oem-pa2", /* VK_OEM_PA2 0xEC */
4817 "oem-pa3", /* VK_OEM_PA3 0xED */
4818 "wsctrl", /* VK_OEM_WSCTRL 0xEE */
4819 "cusel", /* VK_OEM_CUSEL 0xEF */
4820 "oem-attn", /* VK_OEM_ATTN 0xF0 */
4821 "finish", /* VK_OEM_FINISH 0xF1 */
4822 "copy", /* VK_OEM_COPY 0xF2 */
4823 "auto", /* VK_OEM_AUTO 0xF3 */
4824 "enlw", /* VK_OEM_ENLW 0xF4 */
4825 "backtab", /* VK_OEM_BACKTAB 0xF5 */
4826 "attn", /* VK_ATTN 0xF6 */
4827 "crsel", /* VK_CRSEL 0xF7 */
4828 "exsel", /* VK_EXSEL 0xF8 */
4829 "ereof", /* VK_EREOF 0xF9 */
4830 "play", /* VK_PLAY 0xFA */
4831 "zoom", /* VK_ZOOM 0xFB */
4832 "noname", /* VK_NONAME 0xFC */
4833 "pa1", /* VK_PA1 0xFD */
4834 "oem_clear", /* VK_OEM_CLEAR 0xFE */
4838 /* Some of these duplicate the "Media keys" on newer keyboards,
4839 but they are delivered to the application in a different way. */
4840 static const char *const lispy_multimedia_keys
[] =
4848 "browser-favorites",
4885 "toggle-dictate-command",
4891 "media-fast-forward",
4894 "media-channel-down"
4897 #else /* not HAVE_NTGUI */
4899 /* This should be dealt with in XTread_socket now, and that doesn't
4900 depend on the client system having the Kana syms defined. See also
4901 the XK_kana_A case below. */
4904 static const char *const lispy_kana_keys
[] =
4906 /* X Keysym value */
4907 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x400 .. 0x40f */
4908 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x410 .. 0x41f */
4909 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x420 .. 0x42f */
4910 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x430 .. 0x43f */
4911 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x440 .. 0x44f */
4912 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x450 .. 0x45f */
4913 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x460 .. 0x46f */
4914 0,0,0,0,0,0,0,0,0,0,0,0,0,0,"overline",0,
4915 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x480 .. 0x48f */
4916 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x490 .. 0x49f */
4917 0, "kana-fullstop", "kana-openingbracket", "kana-closingbracket",
4918 "kana-comma", "kana-conjunctive", "kana-WO", "kana-a",
4919 "kana-i", "kana-u", "kana-e", "kana-o",
4920 "kana-ya", "kana-yu", "kana-yo", "kana-tsu",
4921 "prolongedsound", "kana-A", "kana-I", "kana-U",
4922 "kana-E", "kana-O", "kana-KA", "kana-KI",
4923 "kana-KU", "kana-KE", "kana-KO", "kana-SA",
4924 "kana-SHI", "kana-SU", "kana-SE", "kana-SO",
4925 "kana-TA", "kana-CHI", "kana-TSU", "kana-TE",
4926 "kana-TO", "kana-NA", "kana-NI", "kana-NU",
4927 "kana-NE", "kana-NO", "kana-HA", "kana-HI",
4928 "kana-FU", "kana-HE", "kana-HO", "kana-MA",
4929 "kana-MI", "kana-MU", "kana-ME", "kana-MO",
4930 "kana-YA", "kana-YU", "kana-YO", "kana-RA",
4931 "kana-RI", "kana-RU", "kana-RE", "kana-RO",
4932 "kana-WA", "kana-N", "voicedsound", "semivoicedsound",
4933 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4e0 .. 0x4ef */
4934 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4f0 .. 0x4ff */
4936 #endif /* XK_kana_A */
4939 #define FUNCTION_KEY_OFFSET 0xff00
4941 /* You'll notice that this table is arranged to be conveniently
4942 indexed by X Windows keysym values. */
4943 static const char *const lispy_function_keys
[] =
4945 /* X Keysym value */
4947 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff00...0f */
4948 "backspace", "tab", "linefeed", "clear",
4950 0, 0, 0, "pause", /* 0xff10...1f */
4951 0, 0, 0, 0, 0, 0, 0, "escape",
4953 0, "kanji", "muhenkan", "henkan", /* 0xff20...2f */
4954 "romaji", "hiragana", "katakana", "hiragana-katakana",
4955 "zenkaku", "hankaku", "zenkaku-hankaku", "touroku",
4956 "massyo", "kana-lock", "kana-shift", "eisu-shift",
4957 "eisu-toggle", /* 0xff30...3f */
4958 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4959 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff40...4f */
4961 "home", "left", "up", "right", /* 0xff50 */ /* IsCursorKey */
4962 "down", "prior", "next", "end",
4963 "begin", 0, 0, 0, 0, 0, 0, 0,
4964 "select", /* 0xff60 */ /* IsMiscFunctionKey */
4975 "break", /* 0xff6b */
4978 0, 0, 0, 0, "backtab", 0, 0, 0, /* 0xff70... */
4979 0, 0, 0, 0, 0, 0, 0, "kp-numlock", /* 0xff78... */
4980 "kp-space", /* 0xff80 */ /* IsKeypadKey */
4981 0, 0, 0, 0, 0, 0, 0, 0,
4982 "kp-tab", /* 0xff89 */
4984 "kp-enter", /* 0xff8d */
4986 "kp-f1", /* 0xff91 */
4990 "kp-home", /* 0xff95 */
4995 "kp-prior", /* kp-page-up */
4996 "kp-next", /* kp-page-down */
5002 0, 0, 0, 0, 0, 0, 0, 0, 0,
5003 "kp-multiply", /* 0xffaa */
5008 "kp-divide", /* 0xffaf */
5009 "kp-0", /* 0xffb0 */
5010 "kp-1", "kp-2", "kp-3", "kp-4", "kp-5", "kp-6", "kp-7", "kp-8", "kp-9",
5013 "kp-equal", /* 0xffbd */
5014 "f1", /* 0xffbe */ /* IsFunctionKey */
5016 "f3", "f4", "f5", "f6", "f7", "f8", "f9", "f10", /* 0xffc0 */
5017 "f11", "f12", "f13", "f14", "f15", "f16", "f17", "f18",
5018 "f19", "f20", "f21", "f22", "f23", "f24", "f25", "f26", /* 0xffd0 */
5019 "f27", "f28", "f29", "f30", "f31", "f32", "f33", "f34",
5020 "f35", 0, 0, 0, 0, 0, 0, 0, /* 0xffe0 */
5021 0, 0, 0, 0, 0, 0, 0, 0,
5022 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfff0 */
5023 0, 0, 0, 0, 0, 0, 0, "delete"
5026 /* ISO 9995 Function and Modifier Keys; the first byte is 0xFE. */
5027 #define ISO_FUNCTION_KEY_OFFSET 0xfe00
5029 static const char *const iso_lispy_function_keys
[] =
5031 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe00 */
5032 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe08 */
5033 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe10 */
5034 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe18 */
5035 "iso-lefttab", /* 0xfe20 */
5036 "iso-move-line-up", "iso-move-line-down",
5037 "iso-partial-line-up", "iso-partial-line-down",
5038 "iso-partial-space-left", "iso-partial-space-right",
5039 "iso-set-margin-left", "iso-set-margin-right", /* 0xffe27, 28 */
5040 "iso-release-margin-left", "iso-release-margin-right",
5041 "iso-release-both-margins",
5042 "iso-fast-cursor-left", "iso-fast-cursor-right",
5043 "iso-fast-cursor-up", "iso-fast-cursor-down",
5044 "iso-continuous-underline", "iso-discontinuous-underline", /* 0xfe30, 31 */
5045 "iso-emphasize", "iso-center-object", "iso-enter", /* ... 0xfe34 */
5048 #endif /* not HAVE_NTGUI */
5050 static Lisp_Object Vlispy_mouse_stem
;
5052 static const char *const lispy_wheel_names
[] =
5054 "wheel-up", "wheel-down", "wheel-left", "wheel-right"
5057 /* drag-n-drop events are generated when a set of selected files are
5058 dragged from another application and dropped onto an Emacs window. */
5059 static const char *const lispy_drag_n_drop_names
[] =
5064 /* An array of symbol indexes of scroll bar parts, indexed by an enum
5065 scroll_bar_part value. Note that Qnil corresponds to
5066 scroll_bar_nowhere and should not appear in Lisp events. */
5067 static short const scroll_bar_parts
[] = {
5068 SYMBOL_INDEX (Qnil
), SYMBOL_INDEX (Qabove_handle
), SYMBOL_INDEX (Qhandle
),
5069 SYMBOL_INDEX (Qbelow_handle
), SYMBOL_INDEX (Qup
), SYMBOL_INDEX (Qdown
),
5070 SYMBOL_INDEX (Qtop
), SYMBOL_INDEX (Qbottom
), SYMBOL_INDEX (Qend_scroll
),
5071 SYMBOL_INDEX (Qratio
), SYMBOL_INDEX (Qbefore_handle
),
5072 SYMBOL_INDEX (Qhorizontal_handle
), SYMBOL_INDEX (Qafter_handle
),
5073 SYMBOL_INDEX (Qleft
), SYMBOL_INDEX (Qright
), SYMBOL_INDEX (Qleftmost
),
5074 SYMBOL_INDEX (Qrightmost
), SYMBOL_INDEX (Qend_scroll
), SYMBOL_INDEX (Qratio
)
5077 /* A vector, indexed by button number, giving the down-going location
5078 of currently depressed buttons, both scroll bar and non-scroll bar.
5080 The elements have the form
5081 (BUTTON-NUMBER MODIFIER-MASK . REST)
5082 where REST is the cdr of a position as it would be reported in the event.
5084 The make_lispy_event function stores positions here to tell the
5085 difference between click and drag events, and to store the starting
5086 location to be included in drag events. */
5088 static Lisp_Object button_down_location
;
5090 /* Information about the most recent up-going button event: Which
5091 button, what location, and what time. */
5093 static int last_mouse_button
;
5094 static int last_mouse_x
;
5095 static int last_mouse_y
;
5096 static Time button_down_time
;
5098 /* The number of clicks in this multiple-click. */
5100 static int double_click_count
;
5102 /* X and Y are frame-relative coordinates for a click or wheel event.
5103 Return a Lisp-style event list. */
5106 make_lispy_position (struct frame
*f
, Lisp_Object x
, Lisp_Object y
,
5109 enum window_part part
;
5110 Lisp_Object posn
= Qnil
;
5111 Lisp_Object extra_info
= Qnil
;
5112 /* Coordinate pixel positions to return. */
5113 int xret
= 0, yret
= 0;
5114 /* The window under frame pixel coordinates (x,y) */
5115 Lisp_Object window
= f
5116 ? window_from_coordinates (f
, XINT (x
), XINT (y
), &part
, 0)
5119 if (WINDOWP (window
))
5121 /* It's a click in window WINDOW at frame coordinates (X,Y) */
5122 struct window
*w
= XWINDOW (window
);
5123 Lisp_Object string_info
= Qnil
;
5124 ptrdiff_t textpos
= 0;
5125 int col
= -1, row
= -1;
5126 int dx
= -1, dy
= -1;
5127 int width
= -1, height
= -1;
5128 Lisp_Object object
= Qnil
;
5130 /* Pixel coordinates relative to the window corner. */
5131 int wx
= XINT (x
) - WINDOW_LEFT_EDGE_X (w
);
5132 int wy
= XINT (y
) - WINDOW_TOP_EDGE_Y (w
);
5134 /* For text area clicks, return X, Y relative to the corner of
5135 this text area. Note that dX, dY etc are set below, by
5136 buffer_posn_from_coords. */
5137 if (part
== ON_TEXT
)
5139 xret
= XINT (x
) - window_box_left (w
, TEXT_AREA
);
5140 yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5142 /* For mode line and header line clicks, return X, Y relative to
5143 the left window edge. Use mode_line_string to look for a
5144 string on the click position. */
5145 else if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
)
5150 posn
= (part
== ON_MODE_LINE
) ? Qmode_line
: Qheader_line
;
5151 /* Note that mode_line_string takes COL, ROW as pixels and
5152 converts them to characters. */
5155 string
= mode_line_string (w
, part
, &col
, &row
, &charpos
,
5156 &object
, &dx
, &dy
, &width
, &height
);
5157 if (STRINGP (string
))
5158 string_info
= Fcons (string
, make_number (charpos
));
5164 /* For fringes and margins, Y is relative to the area's (and the
5165 window's) top edge, while X is meaningless. */
5166 else if (part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
5171 posn
= (part
== ON_LEFT_MARGIN
) ? Qleft_margin
: Qright_margin
;
5174 string
= marginal_area_string (w
, part
, &col
, &row
, &charpos
,
5175 &object
, &dx
, &dy
, &width
, &height
);
5176 if (STRINGP (string
))
5177 string_info
= Fcons (string
, make_number (charpos
));
5179 yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5181 else if (part
== ON_LEFT_FRINGE
)
5183 posn
= Qleft_fringe
;
5187 - (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5188 ? 0 : window_box_width (w
, LEFT_MARGIN_AREA
));
5189 dy
= yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5191 else if (part
== ON_RIGHT_FRINGE
)
5193 posn
= Qright_fringe
;
5197 - window_box_width (w
, LEFT_MARGIN_AREA
)
5198 - window_box_width (w
, TEXT_AREA
)
5199 - (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5200 ? window_box_width (w
, RIGHT_MARGIN_AREA
)
5202 dy
= yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5204 else if (part
== ON_VERTICAL_BORDER
)
5206 posn
= Qvertical_line
;
5212 else if (part
== ON_VERTICAL_SCROLL_BAR
)
5214 posn
= Qvertical_scroll_bar
;
5215 width
= WINDOW_SCROLL_BAR_AREA_WIDTH (w
);
5219 else if (part
== ON_HORIZONTAL_SCROLL_BAR
)
5221 posn
= Qhorizontal_scroll_bar
;
5222 width
= WINDOW_SCROLL_BAR_AREA_HEIGHT (w
);
5226 else if (part
== ON_RIGHT_DIVIDER
)
5228 posn
= Qright_divider
;
5229 width
= WINDOW_RIGHT_DIVIDER_WIDTH (w
);
5233 else if (part
== ON_BOTTOM_DIVIDER
)
5235 posn
= Qbottom_divider
;
5236 width
= WINDOW_BOTTOM_DIVIDER_WIDTH (w
);
5241 /* For clicks in the text area, fringes, margins, or vertical
5242 scroll bar, call buffer_posn_from_coords to extract TEXTPOS,
5243 the buffer position nearest to the click. */
5246 Lisp_Object string2
, object2
= Qnil
;
5247 struct display_pos p
;
5249 int width2
, height2
;
5250 /* The pixel X coordinate passed to buffer_posn_from_coords
5251 is the X coordinate relative to the text area for clicks
5252 in text-area, right-margin/fringe and right-side vertical
5253 scroll bar, zero otherwise. */
5255 = (part
== ON_TEXT
) ? xret
5256 : (part
== ON_RIGHT_FRINGE
|| part
== ON_RIGHT_MARGIN
5257 || (part
== ON_VERTICAL_SCROLL_BAR
5258 && WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_RIGHT (w
)))
5259 ? (XINT (x
) - window_box_left (w
, TEXT_AREA
))
5263 string2
= buffer_posn_from_coords (w
, &x2
, &y2
, &p
,
5264 &object2
, &dx2
, &dy2
,
5266 textpos
= CHARPOS (p
.pos
);
5267 if (col
< 0) col
= x2
;
5268 if (row
< 0) row
= y2
;
5269 if (dx
< 0) dx
= dx2
;
5270 if (dy
< 0) dy
= dy2
;
5271 if (width
< 0) width
= width2
;
5272 if (height
< 0) height
= height2
;
5276 posn
= make_number (textpos
);
5277 if (STRINGP (string2
))
5278 string_info
= Fcons (string2
,
5279 make_number (CHARPOS (p
.string_pos
)));
5285 #ifdef HAVE_WINDOW_SYSTEM
5286 if (IMAGEP (object
))
5288 Lisp_Object image_map
, hotspot
;
5289 if ((image_map
= Fplist_get (XCDR (object
), QCmap
),
5291 && (hotspot
= find_hot_spot (image_map
, dx
, dy
),
5293 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
5294 posn
= XCAR (hotspot
);
5301 Fcons (make_number (dx
), make_number (dy
)),
5302 Fcons (make_number (width
), make_number (height
)));
5305 extra_info
= Fcons (string_info
,
5306 Fcons (textpos
< 0 ? Qnil
: make_number (textpos
),
5307 Fcons (Fcons (make_number (col
),
5313 /* Return mouse pixel coordinates here. */
5314 XSETFRAME (window
, f
);
5321 return Fcons (window
,
5323 Fcons (Fcons (make_number (xret
),
5324 make_number (yret
)),
5325 Fcons (make_number (t
),
5329 /* Return non-zero if F is a GUI frame that uses some toolkit-managed
5330 menu bar. This really means that Emacs draws and manages the menu
5331 bar as part of its normal display, and therefore can compute its
5334 toolkit_menubar_in_use (struct frame
*f
)
5336 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS) || defined (HAVE_NTGUI)
5337 return !(!FRAME_WINDOW_P (f
));
5343 /* Build the part of Lisp event which represents scroll bar state from
5344 EV. TYPE is one of Qvertical_scroll_bar or Qhorizontal_scroll_bar. */
5347 make_scroll_bar_position (struct input_event
*ev
, Lisp_Object type
)
5349 return list5 (ev
->frame_or_window
, type
, Fcons (ev
->x
, ev
->y
),
5350 make_number (ev
->timestamp
),
5351 builtin_lisp_symbol (scroll_bar_parts
[ev
->part
]));
5354 /* Given a struct input_event, build the lisp event which represents
5355 it. If EVENT is 0, build a mouse movement event from the mouse
5356 movement buffer, which should have a movement event in it.
5358 Note that events must be passed to this function in the order they
5359 are received; this function stores the location of button presses
5360 in order to build drag events when the button is released. */
5363 make_lispy_event (struct input_event
*event
)
5367 switch (event
->kind
)
5369 /* A simple keystroke. */
5370 case ASCII_KEYSTROKE_EVENT
:
5371 case MULTIBYTE_CHAR_KEYSTROKE_EVENT
:
5373 Lisp_Object lispy_c
;
5374 EMACS_INT c
= event
->code
;
5375 if (event
->kind
== ASCII_KEYSTROKE_EVENT
)
5378 eassert (c
== event
->code
);
5379 /* Turn ASCII characters into control characters
5381 if (event
->modifiers
& ctrl_modifier
)
5383 c
= make_ctrl_char (c
);
5384 event
->modifiers
&= ~ctrl_modifier
;
5388 /* Add in the other modifier bits. The shift key was taken care
5389 of by the X code. */
5390 c
|= (event
->modifiers
5391 & (meta_modifier
| alt_modifier
5392 | hyper_modifier
| super_modifier
| ctrl_modifier
));
5393 /* Distinguish Shift-SPC from SPC. */
5394 if ((event
->code
) == 040
5395 && event
->modifiers
& shift_modifier
)
5396 c
|= shift_modifier
;
5397 button_down_time
= 0;
5398 XSETFASTINT (lispy_c
, c
);
5403 /* NS_NONKEY_EVENTs are just like NON_ASCII_KEYSTROKE_EVENTs,
5404 except that they are non-key events (last-nonmenu-event is nil). */
5405 case NS_NONKEY_EVENT
:
5408 /* A function key. The symbol may need to have modifier prefixes
5410 case NON_ASCII_KEYSTROKE_EVENT
:
5411 button_down_time
= 0;
5413 for (i
= 0; i
< ARRAYELTS (lispy_accent_codes
); i
++)
5414 if (event
->code
== lispy_accent_codes
[i
])
5415 return modify_event_symbol (i
,
5417 Qfunction_key
, Qnil
,
5418 lispy_accent_keys
, &accent_key_syms
,
5419 ARRAYELTS (lispy_accent_keys
));
5423 if (event
->code
>= 0x400 && event
->code
< 0x500)
5424 return modify_event_symbol (event
->code
- 0x400,
5425 event
->modifiers
& ~shift_modifier
,
5426 Qfunction_key
, Qnil
,
5427 lispy_kana_keys
, &func_key_syms
,
5428 ARRAYELTS (lispy_kana_keys
));
5429 #endif /* XK_kana_A */
5432 #ifdef ISO_FUNCTION_KEY_OFFSET
5433 if (event
->code
< FUNCTION_KEY_OFFSET
5434 && event
->code
>= ISO_FUNCTION_KEY_OFFSET
)
5435 return modify_event_symbol (event
->code
- ISO_FUNCTION_KEY_OFFSET
,
5437 Qfunction_key
, Qnil
,
5438 iso_lispy_function_keys
, &func_key_syms
,
5439 ARRAYELTS (iso_lispy_function_keys
));
5442 if ((FUNCTION_KEY_OFFSET
<= event
->code
5444 < FUNCTION_KEY_OFFSET
+ ARRAYELTS (lispy_function_keys
)))
5445 && lispy_function_keys
[event
->code
- FUNCTION_KEY_OFFSET
])
5446 return modify_event_symbol (event
->code
- FUNCTION_KEY_OFFSET
,
5448 Qfunction_key
, Qnil
,
5449 lispy_function_keys
, &func_key_syms
,
5450 ARRAYELTS (lispy_function_keys
));
5452 /* Handle system-specific or unknown keysyms.
5453 We need to use an alist rather than a vector as the cache
5454 since we can't make a vector long enough. */
5455 if (NILP (KVAR (current_kboard
, system_key_syms
)))
5456 kset_system_key_syms (current_kboard
, Fcons (Qnil
, Qnil
));
5457 return modify_event_symbol (event
->code
,
5460 KVAR (current_kboard
, Vsystem_key_alist
),
5461 0, &KVAR (current_kboard
, system_key_syms
),
5465 case MULTIMEDIA_KEY_EVENT
:
5466 if (event
->code
< ARRAYELTS (lispy_multimedia_keys
)
5467 && event
->code
> 0 && lispy_multimedia_keys
[event
->code
])
5469 return modify_event_symbol (event
->code
, event
->modifiers
,
5470 Qfunction_key
, Qnil
,
5471 lispy_multimedia_keys
, &func_key_syms
,
5472 ARRAYELTS (lispy_multimedia_keys
));
5477 /* A mouse click. Figure out where it is, decide whether it's
5478 a press, click or drag, and build the appropriate structure. */
5479 case MOUSE_CLICK_EVENT
:
5481 case GPM_CLICK_EVENT
:
5483 #ifndef USE_TOOLKIT_SCROLL_BARS
5484 case SCROLL_BAR_CLICK_EVENT
:
5485 case HORIZONTAL_SCROLL_BAR_CLICK_EVENT
:
5488 int button
= event
->code
;
5490 Lisp_Object position
;
5491 Lisp_Object
*start_pos_ptr
;
5492 Lisp_Object start_pos
;
5496 /* Build the position as appropriate for this mouse click. */
5497 if (event
->kind
== MOUSE_CLICK_EVENT
5499 || event
->kind
== GPM_CLICK_EVENT
5503 struct frame
*f
= XFRAME (event
->frame_or_window
);
5506 /* Ignore mouse events that were made on frame that
5507 have been deleted. */
5508 if (! FRAME_LIVE_P (f
))
5511 /* EVENT->x and EVENT->y are frame-relative pixel
5512 coordinates at this place. Under old redisplay, COLUMN
5513 and ROW are set to frame relative glyph coordinates
5514 which are then used to determine whether this click is
5515 in a menu (non-toolkit version). */
5516 if (!toolkit_menubar_in_use (f
))
5518 pixel_to_glyph_coords (f
, XINT (event
->x
), XINT (event
->y
),
5519 &column
, &row
, NULL
, 1);
5521 /* In the non-toolkit version, clicks on the menu bar
5522 are ordinary button events in the event buffer.
5523 Distinguish them, and invoke the menu.
5525 (In the toolkit version, the toolkit handles the
5526 menu bar and Emacs doesn't know about it until
5527 after the user makes a selection.) */
5528 if (row
>= 0 && row
< FRAME_MENU_BAR_LINES (f
)
5529 && (event
->modifiers
& down_modifier
))
5531 Lisp_Object items
, item
;
5533 /* Find the menu bar item under `column'. */
5535 items
= FRAME_MENU_BAR_ITEMS (f
);
5536 for (i
= 0; i
< ASIZE (items
); i
+= 4)
5538 Lisp_Object pos
, string
;
5539 string
= AREF (items
, i
+ 1);
5540 pos
= AREF (items
, i
+ 3);
5543 if (column
>= XINT (pos
)
5544 && column
< XINT (pos
) + SCHARS (string
))
5546 item
= AREF (items
, i
);
5551 /* ELisp manual 2.4b says (x y) are window
5552 relative but code says they are
5554 position
= list4 (event
->frame_or_window
,
5556 Fcons (event
->x
, event
->y
),
5557 make_number (event
->timestamp
));
5559 return list2 (item
, position
);
5563 position
= make_lispy_position (f
, event
->x
, event
->y
,
5566 #ifndef USE_TOOLKIT_SCROLL_BARS
5568 /* It's a scrollbar click. */
5569 position
= make_scroll_bar_position (event
, Qvertical_scroll_bar
);
5570 #endif /* not USE_TOOLKIT_SCROLL_BARS */
5572 if (button
>= ASIZE (button_down_location
))
5574 ptrdiff_t incr
= button
- ASIZE (button_down_location
) + 1;
5575 button_down_location
= larger_vector (button_down_location
,
5577 mouse_syms
= larger_vector (mouse_syms
, incr
, -1);
5580 start_pos_ptr
= aref_addr (button_down_location
, button
);
5581 start_pos
= *start_pos_ptr
;
5582 *start_pos_ptr
= Qnil
;
5585 /* On window-system frames, use the value of
5586 double-click-fuzz as is. On other frames, interpret it
5587 as a multiple of 1/8 characters. */
5591 if (WINDOWP (event
->frame_or_window
))
5592 f
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5593 else if (FRAMEP (event
->frame_or_window
))
5594 f
= XFRAME (event
->frame_or_window
);
5598 if (FRAME_WINDOW_P (f
))
5599 fuzz
= double_click_fuzz
;
5601 fuzz
= double_click_fuzz
/ 8;
5603 is_double
= (button
== last_mouse_button
5604 && (eabs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5605 && (eabs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5606 && button_down_time
!= 0
5607 && (EQ (Vdouble_click_time
, Qt
)
5608 || (NATNUMP (Vdouble_click_time
)
5609 && (event
->timestamp
- button_down_time
5610 < XFASTINT (Vdouble_click_time
)))));
5613 last_mouse_button
= button
;
5614 last_mouse_x
= XINT (event
->x
);
5615 last_mouse_y
= XINT (event
->y
);
5617 /* If this is a button press, squirrel away the location, so
5618 we can decide later whether it was a click or a drag. */
5619 if (event
->modifiers
& down_modifier
)
5623 double_click_count
++;
5624 event
->modifiers
|= ((double_click_count
> 2)
5629 double_click_count
= 1;
5630 button_down_time
= event
->timestamp
;
5631 *start_pos_ptr
= Fcopy_alist (position
);
5632 ignore_mouse_drag_p
= 0;
5635 /* Now we're releasing a button - check the co-ordinates to
5636 see if this was a click or a drag. */
5637 else if (event
->modifiers
& up_modifier
)
5639 /* If we did not see a down before this up, ignore the up.
5640 Probably this happened because the down event chose a
5641 menu item. It would be an annoyance to treat the
5642 release of the button that chose the menu item as a
5645 if (!CONSP (start_pos
))
5648 event
->modifiers
&= ~up_modifier
;
5651 Lisp_Object new_down
, down
;
5652 EMACS_INT xdiff
= double_click_fuzz
, ydiff
= double_click_fuzz
;
5654 /* The third element of every position
5655 should be the (x,y) pair. */
5656 down
= Fcar (Fcdr (Fcdr (start_pos
)));
5657 new_down
= Fcar (Fcdr (Fcdr (position
)));
5660 && INTEGERP (XCAR (down
)) && INTEGERP (XCDR (down
)))
5662 xdiff
= XINT (XCAR (new_down
)) - XINT (XCAR (down
));
5663 ydiff
= XINT (XCDR (new_down
)) - XINT (XCDR (down
));
5666 if (ignore_mouse_drag_p
)
5668 event
->modifiers
|= click_modifier
;
5669 ignore_mouse_drag_p
= 0;
5671 else if (xdiff
< double_click_fuzz
&& xdiff
> - double_click_fuzz
5672 && ydiff
< double_click_fuzz
&& ydiff
> - double_click_fuzz
5673 /* Maybe the mouse has moved a lot, caused scrolling, and
5674 eventually ended up at the same screen position (but
5675 not buffer position) in which case it is a drag, not
5677 /* FIXME: OTOH if the buffer position has changed
5678 because of a timer or process filter rather than
5679 because of mouse movement, it should be considered as
5680 a click. But mouse-drag-region completely ignores
5681 this case and it hasn't caused any real problem, so
5682 it's probably OK to ignore it as well. */
5683 && EQ (Fcar (Fcdr (start_pos
)), Fcar (Fcdr (position
))))
5684 /* Mouse hasn't moved (much). */
5685 event
->modifiers
|= click_modifier
;
5688 button_down_time
= 0;
5689 event
->modifiers
|= drag_modifier
;
5692 /* Don't check is_double; treat this as multiple
5693 if the down-event was multiple. */
5694 if (double_click_count
> 1)
5695 event
->modifiers
|= ((double_click_count
> 2)
5701 /* Every mouse event should either have the down_modifier or
5702 the up_modifier set. */
5706 /* Get the symbol we should use for the mouse click. */
5709 head
= modify_event_symbol (button
,
5711 Qmouse_click
, Vlispy_mouse_stem
,
5714 ASIZE (mouse_syms
));
5715 if (event
->modifiers
& drag_modifier
)
5716 return list3 (head
, start_pos
, position
);
5717 else if (event
->modifiers
& (double_modifier
| triple_modifier
))
5718 return list3 (head
, position
, make_number (double_click_count
));
5720 return list2 (head
, position
);
5725 case HORIZ_WHEEL_EVENT
:
5727 Lisp_Object position
;
5730 /* Build the position as appropriate for this mouse click. */
5731 struct frame
*f
= XFRAME (event
->frame_or_window
);
5733 /* Ignore wheel events that were made on frame that have been
5735 if (! FRAME_LIVE_P (f
))
5738 position
= make_lispy_position (f
, event
->x
, event
->y
,
5741 /* Set double or triple modifiers to indicate the wheel speed. */
5743 /* On window-system frames, use the value of
5744 double-click-fuzz as is. On other frames, interpret it
5745 as a multiple of 1/8 characters. */
5751 if (WINDOWP (event
->frame_or_window
))
5752 fr
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5753 else if (FRAMEP (event
->frame_or_window
))
5754 fr
= XFRAME (event
->frame_or_window
);
5758 fuzz
= FRAME_WINDOW_P (fr
)
5759 ? double_click_fuzz
: double_click_fuzz
/ 8;
5761 if (event
->modifiers
& up_modifier
)
5763 /* Emit a wheel-up event. */
5764 event
->modifiers
&= ~up_modifier
;
5767 else if (event
->modifiers
& down_modifier
)
5769 /* Emit a wheel-down event. */
5770 event
->modifiers
&= ~down_modifier
;
5774 /* Every wheel event should either have the down_modifier or
5775 the up_modifier set. */
5778 if (event
->kind
== HORIZ_WHEEL_EVENT
)
5781 is_double
= (last_mouse_button
== - (1 + symbol_num
)
5782 && (eabs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5783 && (eabs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5784 && button_down_time
!= 0
5785 && (EQ (Vdouble_click_time
, Qt
)
5786 || (NATNUMP (Vdouble_click_time
)
5787 && (event
->timestamp
- button_down_time
5788 < XFASTINT (Vdouble_click_time
)))));
5791 double_click_count
++;
5792 event
->modifiers
|= ((double_click_count
> 2)
5798 double_click_count
= 1;
5799 event
->modifiers
|= click_modifier
;
5802 button_down_time
= event
->timestamp
;
5803 /* Use a negative value to distinguish wheel from mouse button. */
5804 last_mouse_button
= - (1 + symbol_num
);
5805 last_mouse_x
= XINT (event
->x
);
5806 last_mouse_y
= XINT (event
->y
);
5808 /* Get the symbol we should use for the wheel event. */
5809 head
= modify_event_symbol (symbol_num
,
5815 ASIZE (wheel_syms
));
5818 if (event
->modifiers
& (double_modifier
| triple_modifier
))
5819 return list3 (head
, position
, make_number (double_click_count
));
5821 return list2 (head
, position
);
5825 #ifdef USE_TOOLKIT_SCROLL_BARS
5827 /* We don't have down and up events if using toolkit scroll bars,
5828 so make this always a click event. Store in the `part' of
5829 the Lisp event a symbol which maps to the following actions:
5831 `above_handle' page up
5832 `below_handle' page down
5836 `bottom' bottom of buffer
5837 `handle' thumb has been dragged.
5838 `end-scroll' end of interaction with scroll bar
5840 The incoming input_event contains in its `part' member an
5841 index of type `enum scroll_bar_part' which we can use as an
5842 index in scroll_bar_parts to get the appropriate symbol. */
5844 case SCROLL_BAR_CLICK_EVENT
:
5846 Lisp_Object position
, head
;
5848 position
= make_scroll_bar_position (event
, Qvertical_scroll_bar
);
5850 /* Always treat scroll bar events as clicks. */
5851 event
->modifiers
|= click_modifier
;
5852 event
->modifiers
&= ~up_modifier
;
5854 if (event
->code
>= ASIZE (mouse_syms
))
5855 mouse_syms
= larger_vector (mouse_syms
,
5856 event
->code
- ASIZE (mouse_syms
) + 1,
5859 /* Get the symbol we should use for the mouse click. */
5860 head
= modify_event_symbol (event
->code
,
5865 ASIZE (mouse_syms
));
5866 return list2 (head
, position
);
5869 case HORIZONTAL_SCROLL_BAR_CLICK_EVENT
:
5871 Lisp_Object position
, head
;
5873 position
= make_scroll_bar_position (event
, Qhorizontal_scroll_bar
);
5875 /* Always treat scroll bar events as clicks. */
5876 event
->modifiers
|= click_modifier
;
5877 event
->modifiers
&= ~up_modifier
;
5879 if (event
->code
>= ASIZE (mouse_syms
))
5880 mouse_syms
= larger_vector (mouse_syms
,
5881 event
->code
- ASIZE (mouse_syms
) + 1,
5884 /* Get the symbol we should use for the mouse click. */
5885 head
= modify_event_symbol (event
->code
,
5890 ASIZE (mouse_syms
));
5891 return list2 (head
, position
);
5894 #endif /* USE_TOOLKIT_SCROLL_BARS */
5896 case DRAG_N_DROP_EVENT
:
5899 Lisp_Object head
, position
;
5902 f
= XFRAME (event
->frame_or_window
);
5905 /* Ignore mouse events that were made on frames that
5906 have been deleted. */
5907 if (! FRAME_LIVE_P (f
))
5910 position
= make_lispy_position (f
, event
->x
, event
->y
,
5913 head
= modify_event_symbol (0, event
->modifiers
,
5915 lispy_drag_n_drop_names
,
5916 &drag_n_drop_syms
, 1);
5917 return list3 (head
, position
, files
);
5920 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
5921 || defined (HAVE_NS) || defined (USE_GTK)
5922 case MENU_BAR_EVENT
:
5923 if (EQ (event
->arg
, event
->frame_or_window
))
5924 /* This is the prefix key. We translate this to
5925 `(menu_bar)' because the code in keyboard.c for menu
5926 events, which we use, relies on this. */
5927 return list1 (Qmenu_bar
);
5931 case SELECT_WINDOW_EVENT
:
5932 /* Make an event (select-window (WINDOW)). */
5933 return list2 (Qselect_window
, list1 (event
->frame_or_window
));
5935 case TOOL_BAR_EVENT
:
5936 if (EQ (event
->arg
, event
->frame_or_window
))
5937 /* This is the prefix key. We translate this to
5938 `(tool_bar)' because the code in keyboard.c for tool bar
5939 events, which we use, relies on this. */
5940 return list1 (Qtool_bar
);
5941 else if (SYMBOLP (event
->arg
))
5942 return apply_modifiers (event
->modifiers
, event
->arg
);
5945 case USER_SIGNAL_EVENT
:
5946 /* A user signal. */
5948 char *name
= find_user_signal_name (event
->code
);
5951 return intern (name
);
5954 case SAVE_SESSION_EVENT
:
5955 return Qsave_session
;
5960 return Fcons (Qdbus_event
, event
->arg
);
5962 #endif /* HAVE_DBUS */
5964 #ifdef HAVE_XWIDGETS
5967 return Fcons (Qxwidget_event
, event
->arg
);
5972 #if defined HAVE_INOTIFY || defined HAVE_KQUEUE || defined HAVE_GFILENOTIFY
5973 case FILE_NOTIFY_EVENT
:
5975 return Fcons (Qfile_notify
, event
->arg
);
5977 #endif /* HAVE_INOTIFY || HAVE_KQUEUE || HAVE_GFILENOTIFY */
5979 case CONFIG_CHANGED_EVENT
:
5980 return list3 (Qconfig_changed_event
,
5981 event
->arg
, event
->frame_or_window
);
5983 /* The 'kind' field of the event is something we don't recognize. */
5990 make_lispy_movement (struct frame
*frame
, Lisp_Object bar_window
, enum scroll_bar_part part
,
5991 Lisp_Object x
, Lisp_Object y
, Time t
)
5993 /* Is it a scroll bar movement? */
5994 if (frame
&& ! NILP (bar_window
))
5996 Lisp_Object part_sym
;
5998 part_sym
= builtin_lisp_symbol (scroll_bar_parts
[part
]);
5999 return list2 (Qscroll_bar_movement
,
6001 Qvertical_scroll_bar
,
6006 /* Or is it an ordinary mouse movement? */
6009 Lisp_Object position
;
6010 position
= make_lispy_position (frame
, x
, y
, t
);
6011 return list2 (Qmouse_movement
, position
);
6015 /* Construct a switch frame event. */
6017 make_lispy_switch_frame (Lisp_Object frame
)
6019 return list2 (Qswitch_frame
, frame
);
6023 make_lispy_focus_in (Lisp_Object frame
)
6025 return list2 (Qfocus_in
, frame
);
6028 #ifdef HAVE_WINDOW_SYSTEM
6031 make_lispy_focus_out (Lisp_Object frame
)
6033 return list2 (Qfocus_out
, frame
);
6036 #endif /* HAVE_WINDOW_SYSTEM */
6038 /* Manipulating modifiers. */
6040 /* Parse the name of SYMBOL, and return the set of modifiers it contains.
6042 If MODIFIER_END is non-zero, set *MODIFIER_END to the position in
6043 SYMBOL's name of the end of the modifiers; the string from this
6044 position is the unmodified symbol name.
6046 This doesn't use any caches. */
6049 parse_modifiers_uncached (Lisp_Object symbol
, ptrdiff_t *modifier_end
)
6055 CHECK_SYMBOL (symbol
);
6058 name
= SYMBOL_NAME (symbol
);
6060 for (i
= 0; i
< SBYTES (name
) - 1; )
6062 ptrdiff_t this_mod_end
= 0;
6065 /* See if the name continues with a modifier word.
6066 Check that the word appears, but don't check what follows it.
6067 Set this_mod and this_mod_end to record what we find. */
6069 switch (SREF (name
, i
))
6071 #define SINGLE_LETTER_MOD(BIT) \
6072 (this_mod_end = i + 1, this_mod = BIT)
6075 SINGLE_LETTER_MOD (alt_modifier
);
6079 SINGLE_LETTER_MOD (ctrl_modifier
);
6083 SINGLE_LETTER_MOD (hyper_modifier
);
6087 SINGLE_LETTER_MOD (meta_modifier
);
6091 SINGLE_LETTER_MOD (shift_modifier
);
6095 SINGLE_LETTER_MOD (super_modifier
);
6098 #undef SINGLE_LETTER_MOD
6100 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6101 if (i + LEN + 1 <= SBYTES (name) \
6102 && ! memcmp (SDATA (name) + i, NAME, LEN)) \
6104 this_mod_end = i + LEN; \
6109 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
6110 MULTI_LETTER_MOD (down_modifier
, "down", 4);
6111 MULTI_LETTER_MOD (double_modifier
, "double", 6);
6115 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
6119 MULTI_LETTER_MOD (up_modifier
, "up", 2);
6121 #undef MULTI_LETTER_MOD
6125 /* If we found no modifier, stop looking for them. */
6126 if (this_mod_end
== 0)
6129 /* Check there is a dash after the modifier, so that it
6130 really is a modifier. */
6131 if (this_mod_end
>= SBYTES (name
)
6132 || SREF (name
, this_mod_end
) != '-')
6135 /* This modifier is real; look for another. */
6136 modifiers
|= this_mod
;
6137 i
= this_mod_end
+ 1;
6140 /* Should we include the `click' modifier? */
6141 if (! (modifiers
& (down_modifier
| drag_modifier
6142 | double_modifier
| triple_modifier
))
6143 && i
+ 7 == SBYTES (name
)
6144 && memcmp (SDATA (name
) + i
, "mouse-", 6) == 0
6145 && ('0' <= SREF (name
, i
+ 6) && SREF (name
, i
+ 6) <= '9'))
6146 modifiers
|= click_modifier
;
6148 if (! (modifiers
& (double_modifier
| triple_modifier
))
6149 && i
+ 6 < SBYTES (name
)
6150 && memcmp (SDATA (name
) + i
, "wheel-", 6) == 0)
6151 modifiers
|= click_modifier
;
6159 /* Return a symbol whose name is the modifier prefixes for MODIFIERS
6160 prepended to the string BASE[0..BASE_LEN-1].
6161 This doesn't use any caches. */
6163 apply_modifiers_uncached (int modifiers
, char *base
, int base_len
, int base_len_byte
)
6165 /* Since BASE could contain nulls, we can't use intern here; we have
6166 to use Fintern, which expects a genuine Lisp_String, and keeps a
6168 char new_mods
[sizeof "A-C-H-M-S-s-up-down-drag-double-triple-"];
6174 /* Mouse events should not exhibit the `up' modifier once they
6175 leave the event queue only accessible to C code; `up' will
6176 always be turned into a click or drag event before being
6177 presented to lisp code. But since lisp events can be
6178 synthesized bypassing the event queue and pushed into
6179 `unread-command-events' or its companions, it's better to just
6180 deal with unexpected modifier combinations. */
6182 if (modifiers
& alt_modifier
) { *p
++ = 'A'; *p
++ = '-'; }
6183 if (modifiers
& ctrl_modifier
) { *p
++ = 'C'; *p
++ = '-'; }
6184 if (modifiers
& hyper_modifier
) { *p
++ = 'H'; *p
++ = '-'; }
6185 if (modifiers
& meta_modifier
) { *p
++ = 'M'; *p
++ = '-'; }
6186 if (modifiers
& shift_modifier
) { *p
++ = 'S'; *p
++ = '-'; }
6187 if (modifiers
& super_modifier
) { *p
++ = 's'; *p
++ = '-'; }
6188 if (modifiers
& double_modifier
) p
= stpcpy (p
, "double-");
6189 if (modifiers
& triple_modifier
) p
= stpcpy (p
, "triple-");
6190 if (modifiers
& up_modifier
) p
= stpcpy (p
, "up-");
6191 if (modifiers
& down_modifier
) p
= stpcpy (p
, "down-");
6192 if (modifiers
& drag_modifier
) p
= stpcpy (p
, "drag-");
6193 /* The click modifier is denoted by the absence of other modifiers. */
6197 mod_len
= p
- new_mods
;
6201 Lisp_Object new_name
;
6203 new_name
= make_uninit_multibyte_string (mod_len
+ base_len
,
6204 mod_len
+ base_len_byte
);
6205 memcpy (SDATA (new_name
), new_mods
, mod_len
);
6206 memcpy (SDATA (new_name
) + mod_len
, base
, base_len_byte
);
6208 return Fintern (new_name
, Qnil
);
6213 static const char *const modifier_names
[] =
6215 "up", "down", "drag", "click", "double", "triple", 0, 0,
6216 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
6217 0, 0, "alt", "super", "hyper", "shift", "control", "meta"
6219 #define NUM_MOD_NAMES ARRAYELTS (modifier_names)
6221 static Lisp_Object modifier_symbols
;
6223 /* Return the list of modifier symbols corresponding to the mask MODIFIERS. */
6225 lispy_modifier_list (int modifiers
)
6227 Lisp_Object modifier_list
;
6230 modifier_list
= Qnil
;
6231 for (i
= 0; (1<<i
) <= modifiers
&& i
< NUM_MOD_NAMES
; i
++)
6232 if (modifiers
& (1<<i
))
6233 modifier_list
= Fcons (AREF (modifier_symbols
, i
),
6236 return modifier_list
;
6240 /* Parse the modifiers on SYMBOL, and return a list like (UNMODIFIED MASK),
6241 where UNMODIFIED is the unmodified form of SYMBOL,
6242 MASK is the set of modifiers present in SYMBOL's name.
6243 This is similar to parse_modifiers_uncached, but uses the cache in
6244 SYMBOL's Qevent_symbol_element_mask property, and maintains the
6245 Qevent_symbol_elements property. */
6247 #define KEY_TO_CHAR(k) (XINT (k) & ((1 << CHARACTERBITS) - 1))
6250 parse_modifiers (Lisp_Object symbol
)
6252 Lisp_Object elements
;
6254 if (INTEGERP (symbol
))
6255 return list2i (KEY_TO_CHAR (symbol
), XINT (symbol
) & CHAR_MODIFIER_MASK
);
6256 else if (!SYMBOLP (symbol
))
6259 elements
= Fget (symbol
, Qevent_symbol_element_mask
);
6260 if (CONSP (elements
))
6265 int modifiers
= parse_modifiers_uncached (symbol
, &end
);
6266 Lisp_Object unmodified
;
6269 unmodified
= Fintern (make_string (SSDATA (SYMBOL_NAME (symbol
)) + end
,
6270 SBYTES (SYMBOL_NAME (symbol
)) - end
),
6273 if (modifiers
& ~INTMASK
)
6275 XSETFASTINT (mask
, modifiers
);
6276 elements
= list2 (unmodified
, mask
);
6278 /* Cache the parsing results on SYMBOL. */
6279 Fput (symbol
, Qevent_symbol_element_mask
,
6281 Fput (symbol
, Qevent_symbol_elements
,
6282 Fcons (unmodified
, lispy_modifier_list (modifiers
)));
6284 /* Since we know that SYMBOL is modifiers applied to unmodified,
6285 it would be nice to put that in unmodified's cache.
6286 But we can't, since we're not sure that parse_modifiers is
6293 DEFUN ("internal-event-symbol-parse-modifiers", Fevent_symbol_parse_modifiers
,
6294 Sevent_symbol_parse_modifiers
, 1, 1, 0,
6295 doc
: /* Parse the event symbol. For internal use. */)
6296 (Lisp_Object symbol
)
6298 /* Fill the cache if needed. */
6299 parse_modifiers (symbol
);
6300 /* Ignore the result (which is stored on Qevent_symbol_element_mask)
6301 and use the Lispier representation stored on Qevent_symbol_elements
6303 return Fget (symbol
, Qevent_symbol_elements
);
6306 /* Apply the modifiers MODIFIERS to the symbol BASE.
6307 BASE must be unmodified.
6309 This is like apply_modifiers_uncached, but uses BASE's
6310 Qmodifier_cache property, if present.
6312 apply_modifiers copies the value of BASE's Qevent_kind property to
6313 the modified symbol. */
6315 apply_modifiers (int modifiers
, Lisp_Object base
)
6317 Lisp_Object cache
, idx
, entry
, new_symbol
;
6319 /* Mask out upper bits. We don't know where this value's been. */
6320 modifiers
&= INTMASK
;
6322 if (INTEGERP (base
))
6323 return make_number (XINT (base
) | modifiers
);
6325 /* The click modifier never figures into cache indices. */
6326 cache
= Fget (base
, Qmodifier_cache
);
6327 XSETFASTINT (idx
, (modifiers
& ~click_modifier
));
6328 entry
= assq_no_quit (idx
, cache
);
6331 new_symbol
= XCDR (entry
);
6334 /* We have to create the symbol ourselves. */
6335 new_symbol
= apply_modifiers_uncached (modifiers
,
6336 SSDATA (SYMBOL_NAME (base
)),
6337 SCHARS (SYMBOL_NAME (base
)),
6338 SBYTES (SYMBOL_NAME (base
)));
6340 /* Add the new symbol to the base's cache. */
6341 entry
= Fcons (idx
, new_symbol
);
6342 Fput (base
, Qmodifier_cache
, Fcons (entry
, cache
));
6344 /* We have the parsing info now for free, so we could add it to
6346 XSETFASTINT (idx, modifiers);
6347 Fput (new_symbol, Qevent_symbol_element_mask,
6349 Fput (new_symbol, Qevent_symbol_elements,
6350 Fcons (base, lispy_modifier_list (modifiers)));
6351 Sadly, this is only correct if `base' is indeed a base event,
6352 which is not necessarily the case. -stef */
6355 /* Make sure this symbol is of the same kind as BASE.
6357 You'd think we could just set this once and for all when we
6358 intern the symbol above, but reorder_modifiers may call us when
6359 BASE's property isn't set right; we can't assume that just
6360 because it has a Qmodifier_cache property it must have its
6361 Qevent_kind set right as well. */
6362 if (NILP (Fget (new_symbol
, Qevent_kind
)))
6366 kind
= Fget (base
, Qevent_kind
);
6368 Fput (new_symbol
, Qevent_kind
, kind
);
6375 /* Given a symbol whose name begins with modifiers ("C-", "M-", etc),
6376 return a symbol with the modifiers placed in the canonical order.
6377 Canonical order is alphabetical, except for down and drag, which
6378 always come last. The 'click' modifier is never written out.
6380 Fdefine_key calls this to make sure that (for example) C-M-foo
6381 and M-C-foo end up being equivalent in the keymap. */
6384 reorder_modifiers (Lisp_Object symbol
)
6386 /* It's hopefully okay to write the code this way, since everything
6387 will soon be in caches, and no consing will be done at all. */
6390 parsed
= parse_modifiers (symbol
);
6391 return apply_modifiers (XFASTINT (XCAR (XCDR (parsed
))),
6396 /* For handling events, we often want to produce a symbol whose name
6397 is a series of modifier key prefixes ("M-", "C-", etcetera) attached
6398 to some base, like the name of a function key or mouse button.
6399 modify_event_symbol produces symbols of this sort.
6401 NAME_TABLE should point to an array of strings, such that NAME_TABLE[i]
6402 is the name of the i'th symbol. TABLE_SIZE is the number of elements
6405 Alternatively, NAME_ALIST_OR_STEM is either an alist mapping codes
6406 into symbol names, or a string specifying a name stem used to
6407 construct a symbol name or the form `STEM-N', where N is the decimal
6408 representation of SYMBOL_NUM. NAME_ALIST_OR_STEM is used if it is
6409 non-nil; otherwise NAME_TABLE is used.
6411 SYMBOL_TABLE should be a pointer to a Lisp_Object whose value will
6412 persist between calls to modify_event_symbol that it can use to
6413 store a cache of the symbols it's generated for this NAME_TABLE
6414 before. The object stored there may be a vector or an alist.
6416 SYMBOL_NUM is the number of the base name we want from NAME_TABLE.
6418 MODIFIERS is a set of modifier bits (as given in struct input_events)
6419 whose prefixes should be applied to the symbol name.
6421 SYMBOL_KIND is the value to be placed in the event_kind property of
6422 the returned symbol.
6424 The symbols we create are supposed to have an
6425 `event-symbol-elements' property, which lists the modifiers present
6426 in the symbol's name. */
6429 modify_event_symbol (ptrdiff_t symbol_num
, int modifiers
, Lisp_Object symbol_kind
,
6430 Lisp_Object name_alist_or_stem
, const char *const *name_table
,
6431 Lisp_Object
*symbol_table
, ptrdiff_t table_size
)
6434 Lisp_Object symbol_int
;
6436 /* Get rid of the "vendor-specific" bit here. */
6437 XSETINT (symbol_int
, symbol_num
& 0xffffff);
6439 /* Is this a request for a valid symbol? */
6440 if (symbol_num
< 0 || symbol_num
>= table_size
)
6443 if (CONSP (*symbol_table
))
6444 value
= Fcdr (assq_no_quit (symbol_int
, *symbol_table
));
6446 /* If *symbol_table doesn't seem to be initialized properly, fix that.
6447 *symbol_table should be a lisp vector TABLE_SIZE elements long,
6448 where the Nth element is the symbol for NAME_TABLE[N], or nil if
6449 we've never used that symbol before. */
6452 if (! VECTORP (*symbol_table
)
6453 || ASIZE (*symbol_table
) != table_size
)
6457 XSETFASTINT (size
, table_size
);
6458 *symbol_table
= Fmake_vector (size
, Qnil
);
6461 value
= AREF (*symbol_table
, symbol_num
);
6464 /* Have we already used this symbol before? */
6467 /* No; let's create it. */
6468 if (CONSP (name_alist_or_stem
))
6469 value
= Fcdr_safe (Fassq (symbol_int
, name_alist_or_stem
));
6470 else if (STRINGP (name_alist_or_stem
))
6473 ptrdiff_t len
= (SBYTES (name_alist_or_stem
)
6474 + sizeof "-" + INT_STRLEN_BOUND (EMACS_INT
));
6476 buf
= SAFE_ALLOCA (len
);
6477 esprintf (buf
, "%s-%"pI
"d", SDATA (name_alist_or_stem
),
6478 XINT (symbol_int
) + 1);
6479 value
= intern (buf
);
6482 else if (name_table
!= 0 && name_table
[symbol_num
])
6483 value
= intern (name_table
[symbol_num
]);
6485 #ifdef HAVE_WINDOW_SYSTEM
6488 char *name
= x_get_keysym_name (symbol_num
);
6490 value
= intern (name
);
6496 char buf
[sizeof "key-" + INT_STRLEN_BOUND (EMACS_INT
)];
6497 sprintf (buf
, "key-%"pD
"d", symbol_num
);
6498 value
= intern (buf
);
6501 if (CONSP (*symbol_table
))
6502 *symbol_table
= Fcons (Fcons (symbol_int
, value
), *symbol_table
);
6504 ASET (*symbol_table
, symbol_num
, value
);
6506 /* Fill in the cache entries for this symbol; this also
6507 builds the Qevent_symbol_elements property, which the user
6509 apply_modifiers (modifiers
& click_modifier
, value
);
6510 Fput (value
, Qevent_kind
, symbol_kind
);
6513 /* Apply modifiers to that symbol. */
6514 return apply_modifiers (modifiers
, value
);
6517 /* Convert a list that represents an event type,
6518 such as (ctrl meta backspace), into the usual representation of that
6519 event type as a number or a symbol. */
6521 DEFUN ("event-convert-list", Fevent_convert_list
, Sevent_convert_list
, 1, 1, 0,
6522 doc
: /* Convert the event description list EVENT-DESC to an event type.
6523 EVENT-DESC should contain one base event type (a character or symbol)
6524 and zero or more modifier names (control, meta, hyper, super, shift, alt,
6525 drag, down, double or triple). The base must be last.
6526 The return value is an event type (a character or symbol) which
6527 has the same base event type and all the specified modifiers. */)
6528 (Lisp_Object event_desc
)
6536 while (CONSP (rest
))
6544 /* Given a symbol, see if it is a modifier name. */
6545 if (SYMBOLP (elt
) && CONSP (rest
))
6546 this = parse_solitary_modifier (elt
);
6550 else if (!NILP (base
))
6551 error ("Two bases given in one event");
6557 /* Let the symbol A refer to the character A. */
6558 if (SYMBOLP (base
) && SCHARS (SYMBOL_NAME (base
)) == 1)
6559 XSETINT (base
, SREF (SYMBOL_NAME (base
), 0));
6561 if (INTEGERP (base
))
6563 /* Turn (shift a) into A. */
6564 if ((modifiers
& shift_modifier
) != 0
6565 && (XINT (base
) >= 'a' && XINT (base
) <= 'z'))
6567 XSETINT (base
, XINT (base
) - ('a' - 'A'));
6568 modifiers
&= ~shift_modifier
;
6571 /* Turn (control a) into C-a. */
6572 if (modifiers
& ctrl_modifier
)
6573 return make_number ((modifiers
& ~ctrl_modifier
)
6574 | make_ctrl_char (XINT (base
)));
6576 return make_number (modifiers
| XINT (base
));
6578 else if (SYMBOLP (base
))
6579 return apply_modifiers (modifiers
, base
);
6581 error ("Invalid base event");
6584 /* Try to recognize SYMBOL as a modifier name.
6585 Return the modifier flag bit, or 0 if not recognized. */
6588 parse_solitary_modifier (Lisp_Object symbol
)
6590 Lisp_Object name
= SYMBOL_NAME (symbol
);
6592 switch (SREF (name
, 0))
6594 #define SINGLE_LETTER_MOD(BIT) \
6595 if (SBYTES (name) == 1) \
6598 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6599 if (LEN == SBYTES (name) \
6600 && ! memcmp (SDATA (name), NAME, LEN)) \
6604 SINGLE_LETTER_MOD (alt_modifier
);
6608 MULTI_LETTER_MOD (alt_modifier
, "alt", 3);
6612 SINGLE_LETTER_MOD (ctrl_modifier
);
6616 MULTI_LETTER_MOD (ctrl_modifier
, "ctrl", 4);
6617 MULTI_LETTER_MOD (ctrl_modifier
, "control", 7);
6621 SINGLE_LETTER_MOD (hyper_modifier
);
6625 MULTI_LETTER_MOD (hyper_modifier
, "hyper", 5);
6629 SINGLE_LETTER_MOD (meta_modifier
);
6633 MULTI_LETTER_MOD (meta_modifier
, "meta", 4);
6637 SINGLE_LETTER_MOD (shift_modifier
);
6641 MULTI_LETTER_MOD (shift_modifier
, "shift", 5);
6642 MULTI_LETTER_MOD (super_modifier
, "super", 5);
6643 SINGLE_LETTER_MOD (super_modifier
);
6647 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
6648 MULTI_LETTER_MOD (down_modifier
, "down", 4);
6649 MULTI_LETTER_MOD (double_modifier
, "double", 6);
6653 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
6657 MULTI_LETTER_MOD (up_modifier
, "up", 2);
6660 #undef SINGLE_LETTER_MOD
6661 #undef MULTI_LETTER_MOD
6667 /* Return true if EVENT is a list whose elements are all integers or symbols.
6668 Such a list is not valid as an event,
6669 but it can be a Lucid-style event type list. */
6672 lucid_event_type_list_p (Lisp_Object object
)
6676 if (! CONSP (object
))
6679 if (EQ (XCAR (object
), Qhelp_echo
)
6680 || EQ (XCAR (object
), Qvertical_line
)
6681 || EQ (XCAR (object
), Qmode_line
)
6682 || EQ (XCAR (object
), Qheader_line
))
6685 for (tail
= object
; CONSP (tail
); tail
= XCDR (tail
))
6689 if (! (INTEGERP (elt
) || SYMBOLP (elt
)))
6696 /* Return true if terminal input chars are available.
6697 Also, store the return value into INPUT_PENDING.
6699 Serves the purpose of ioctl (0, FIONREAD, ...)
6700 but works even if FIONREAD does not exist.
6701 (In fact, this may actually read some input.)
6703 If READABLE_EVENTS_DO_TIMERS_NOW is set in FLAGS, actually run
6704 timer events that are ripe.
6705 If READABLE_EVENTS_FILTER_EVENTS is set in FLAGS, ignore internal
6706 events (FOCUS_IN_EVENT).
6707 If READABLE_EVENTS_IGNORE_SQUEEZABLES is set in FLAGS, ignore mouse
6708 movements and toolkit scroll bar thumb drags. */
6711 get_input_pending (int flags
)
6713 /* First of all, have we already counted some input? */
6714 input_pending
= (!NILP (Vquit_flag
) || readable_events (flags
));
6716 /* If input is being read as it arrives, and we have none, there is none. */
6717 if (!input_pending
&& (!interrupt_input
|| interrupts_deferred
))
6719 /* Try to read some input and see how much we get. */
6721 input_pending
= (!NILP (Vquit_flag
) || readable_events (flags
));
6724 return input_pending
;
6727 /* Put a BUFFER_SWITCH_EVENT in the buffer
6728 so that read_key_sequence will notice the new current buffer. */
6731 record_asynch_buffer_change (void)
6733 /* We don't need a buffer-switch event unless Emacs is waiting for input.
6734 The purpose of the event is to make read_key_sequence look up the
6735 keymaps again. If we aren't in read_key_sequence, we don't need one,
6736 and the event could cause trouble by messing up (input-pending-p).
6737 Note: Fwaiting_for_user_input_p always returns nil when async
6738 subprocesses aren't supported. */
6739 if (!NILP (Fwaiting_for_user_input_p ()))
6741 struct input_event event
;
6744 event
.kind
= BUFFER_SWITCH_EVENT
;
6745 event
.frame_or_window
= Qnil
;
6748 /* Make sure no interrupt happens while storing the event. */
6750 if (interrupt_input
)
6751 kbd_buffer_store_event (&event
);
6756 kbd_buffer_store_event (&event
);
6762 /* Read any terminal input already buffered up by the system
6763 into the kbd_buffer, but do not wait.
6765 Return the number of keyboard chars read, or -1 meaning
6766 this is a bad time to try to read input. */
6775 /* Store pending user signal events, if any. */
6776 store_user_signal_events ();
6778 /* Loop through the available terminals, and call their input hooks. */
6782 struct terminal
*next
= t
->next_terminal
;
6784 if (t
->read_socket_hook
)
6787 struct input_event hold_quit
;
6789 if (input_blocked_p ())
6791 pending_signals
= true;
6795 EVENT_INIT (hold_quit
);
6796 hold_quit
.kind
= NO_EVENT
;
6798 /* No need for FIONREAD or fcntl; just say don't wait. */
6799 while ((nr
= (*t
->read_socket_hook
) (t
, &hold_quit
)) > 0)
6802 if (nr
== -1) /* Not OK to read input now. */
6806 else if (nr
== -2) /* Non-transient error. */
6808 /* The terminal device terminated; it should be closed. */
6810 /* Kill Emacs if this was our last terminal. */
6811 if (!terminal_list
->next_terminal
)
6812 /* Formerly simply reported no input, but that
6813 sometimes led to a failure of Emacs to terminate.
6814 SIGHUP seems appropriate if we can't reach the
6816 /* ??? Is it really right to send the signal just to
6817 this process rather than to the whole process
6818 group? Perhaps on systems with FIONREAD Emacs is
6819 alone in its group. */
6820 terminate_due_to_signal (SIGHUP
, 10);
6822 /* XXX Is calling delete_terminal safe here? It calls delete_frame. */
6825 XSETTERMINAL (tmp
, t
);
6826 Fdelete_terminal (tmp
, Qnoelisp
);
6830 /* If there was no error, make sure the pointer
6831 is visible for all frames on this terminal. */
6834 Lisp_Object tail
, frame
;
6836 FOR_EACH_FRAME (tail
, frame
)
6838 struct frame
*f
= XFRAME (frame
);
6839 if (FRAME_TERMINAL (f
) == t
)
6840 frame_make_pointer_visible (f
);
6844 if (hold_quit
.kind
!= NO_EVENT
)
6845 kbd_buffer_store_event (&hold_quit
);
6857 /* This is the tty way of reading available input.
6859 Note that each terminal device has its own `struct terminal' object,
6860 and so this function is called once for each individual termcap
6861 terminal. The first parameter indicates which terminal to read from. */
6864 tty_read_avail_input (struct terminal
*terminal
,
6865 struct input_event
*hold_quit
)
6867 /* Using KBD_BUFFER_SIZE - 1 here avoids reading more than
6868 the kbd_buffer can really hold. That may prevent loss
6869 of characters on some systems when input is stuffed at us. */
6870 unsigned char cbuf
[KBD_BUFFER_SIZE
- 1];
6872 struct tty_display_info
*tty
= terminal
->display_info
.tty
;
6875 int buffer_free
= KBD_BUFFER_SIZE
- kbd_buffer_nr_stored () - 1;
6877 if (kbd_on_hold_p () || buffer_free
<= 0)
6879 #endif /* subprocesses */
6881 if (!terminal
->name
) /* Don't read from a dead terminal. */
6884 if (terminal
->type
!= output_termcap
6885 && terminal
->type
!= output_msdos_raw
)
6888 /* XXX I think the following code should be moved to separate hook
6889 functions in system-dependent files. */
6891 /* FIXME: AFAIK, tty_read_avail_input is not used under w32 since the non-GUI
6892 code sets read_socket_hook to w32_console_read_socket instead! */
6894 #else /* not WINDOWSNT */
6895 if (! tty
->term_initted
) /* In case we get called during bootstrap. */
6899 return 0; /* The terminal is suspended. */
6902 n_to_read
= dos_keysns ();
6906 cbuf
[0] = dos_keyread ();
6909 #else /* not MSDOS */
6914 struct input_event gpm_hold_quit
;
6915 int gpm
, fd
= gpm_fd
;
6917 EVENT_INIT (gpm_hold_quit
);
6918 gpm_hold_quit
.kind
= NO_EVENT
;
6920 /* gpm==1 if event received.
6921 gpm==0 if the GPM daemon has closed the connection, in which case
6922 Gpm_GetEvent closes gpm_fd and clears it to -1, which is why
6923 we save it in `fd' so close_gpm can remove it from the
6925 gpm==-1 if a protocol error or EWOULDBLOCK; the latter is normal. */
6926 while (gpm
= Gpm_GetEvent (&event
), gpm
== 1) {
6927 nread
+= handle_one_term_event (tty
, &event
, &gpm_hold_quit
);
6930 /* Presumably the GPM daemon has closed the connection. */
6932 if (gpm_hold_quit
.kind
!= NO_EVENT
)
6933 kbd_buffer_store_event (&gpm_hold_quit
);
6937 #endif /* HAVE_GPM */
6939 /* Determine how many characters we should *try* to read. */
6940 #ifdef USABLE_FIONREAD
6941 /* Find out how much input is available. */
6942 if (ioctl (fileno (tty
->input
), FIONREAD
, &n_to_read
) < 0)
6944 if (! noninteractive
)
6945 return -2; /* Close this terminal. */
6951 if (n_to_read
> sizeof cbuf
)
6952 n_to_read
= sizeof cbuf
;
6953 #elif defined USG || defined CYGWIN
6954 /* Read some input if available, but don't wait. */
6955 n_to_read
= sizeof cbuf
;
6956 fcntl (fileno (tty
->input
), F_SETFL
, O_NONBLOCK
);
6958 # error "Cannot read without possibly delaying"
6962 /* Don't read more than we can store. */
6963 if (n_to_read
> buffer_free
)
6964 n_to_read
= buffer_free
;
6965 #endif /* subprocesses */
6967 /* Now read; for one reason or another, this will not block.
6968 NREAD is set to the number of chars read. */
6971 nread
= emacs_read (fileno (tty
->input
), (char *) cbuf
, n_to_read
);
6972 /* POSIX infers that processes which are not in the session leader's
6973 process group won't get SIGHUPs at logout time. BSDI adheres to
6974 this part standard and returns -1 from read (0) with errno==EIO
6975 when the control tty is taken away.
6976 Jeffrey Honig <jch@bsdi.com> says this is generally safe. */
6977 if (nread
== -1 && errno
== EIO
)
6978 return -2; /* Close this terminal. */
6979 #if defined (AIX) && defined (_BSD)
6980 /* The kernel sometimes fails to deliver SIGHUP for ptys.
6981 This looks incorrect, but it isn't, because _BSD causes
6982 O_NDELAY to be defined in fcntl.h as O_NONBLOCK,
6983 and that causes a value other than 0 when there is no input. */
6985 return -2; /* Close this terminal. */
6989 /* We used to retry the read if it was interrupted.
6990 But this does the wrong thing when O_NONBLOCK causes
6991 an EAGAIN error. Does anybody know of a situation
6992 where a retry is actually needed? */
6994 nread
< 0 && (errno
== EAGAIN
|| errno
== EFAULT
7004 #ifndef USABLE_FIONREAD
7005 #if defined (USG) || defined (CYGWIN)
7006 fcntl (fileno (tty
->input
), F_SETFL
, 0);
7007 #endif /* USG or CYGWIN */
7008 #endif /* no FIONREAD */
7013 #endif /* not MSDOS */
7014 #endif /* not WINDOWSNT */
7016 for (i
= 0; i
< nread
; i
++)
7018 struct input_event buf
;
7020 buf
.kind
= ASCII_KEYSTROKE_EVENT
;
7022 if (tty
->meta_key
== 1 && (cbuf
[i
] & 0x80))
7023 buf
.modifiers
= meta_modifier
;
7024 if (tty
->meta_key
!= 2)
7028 /* Set the frame corresponding to the active tty. Note that the
7029 value of selected_frame is not reliable here, redisplay tends
7030 to temporarily change it. */
7031 buf
.frame_or_window
= tty
->top_frame
;
7034 kbd_buffer_store_event (&buf
);
7035 /* Don't look at input that follows a C-g too closely.
7036 This reduces lossage due to autorepeat on C-g. */
7037 if (buf
.kind
== ASCII_KEYSTROKE_EVENT
7038 && buf
.code
== quit_char
)
7046 handle_async_input (void)
7051 int nread
= gobble_input ();
7052 /* -1 means it's not ok to read the input now.
7053 UNBLOCK_INPUT will read it later; now, avoid infinite loop.
7054 0 means there was no keyboard input available. */
7062 process_pending_signals (void)
7064 pending_signals
= false;
7065 handle_async_input ();
7066 do_pending_atimers ();
7069 /* Undo any number of BLOCK_INPUT calls down to level LEVEL,
7070 and reinvoke any pending signal if the level is now 0 and
7071 a fatal error is not already in progress. */
7074 unblock_input_to (int level
)
7076 interrupt_input_blocked
= level
;
7079 if (pending_signals
&& !fatal_error_in_progress
)
7080 process_pending_signals ();
7086 /* End critical section.
7088 If doing signal-driven input, and a signal came in when input was
7089 blocked, reinvoke the signal handler now to deal with it.
7091 It will also process queued input, if it was not read before.
7092 When a longer code sequence does not use block/unblock input
7093 at all, the whole input gathered up to the next call to
7094 unblock_input will be processed inside that call. */
7097 unblock_input (void)
7099 unblock_input_to (interrupt_input_blocked
- 1);
7102 /* Undo any number of BLOCK_INPUT calls,
7103 and also reinvoke any pending signal. */
7106 totally_unblock_input (void)
7108 unblock_input_to (0);
7114 handle_input_available_signal (int sig
)
7116 pending_signals
= true;
7118 if (input_available_clear_time
)
7119 *input_available_clear_time
= make_timespec (0, 0);
7123 deliver_input_available_signal (int sig
)
7125 deliver_process_signal (sig
, handle_input_available_signal
);
7127 #endif /* USABLE_SIGIO */
7130 /* User signal events. */
7132 struct user_signal_info
7134 /* Signal number. */
7137 /* Name of the signal. */
7140 /* Number of pending signals. */
7143 struct user_signal_info
*next
;
7146 /* List of user signals. */
7147 static struct user_signal_info
*user_signals
= NULL
;
7150 add_user_signal (int sig
, const char *name
)
7152 struct sigaction action
;
7153 struct user_signal_info
*p
;
7155 for (p
= user_signals
; p
; p
= p
->next
)
7157 /* Already added. */
7160 p
= xmalloc (sizeof *p
);
7162 p
->name
= xstrdup (name
);
7164 p
->next
= user_signals
;
7167 emacs_sigaction_init (&action
, deliver_user_signal
);
7168 sigaction (sig
, &action
, 0);
7172 handle_user_signal (int sig
)
7174 struct user_signal_info
*p
;
7175 const char *special_event_name
= NULL
;
7177 if (SYMBOLP (Vdebug_on_event
))
7178 special_event_name
= SSDATA (SYMBOL_NAME (Vdebug_on_event
));
7180 for (p
= user_signals
; p
; p
= p
->next
)
7183 if (special_event_name
7184 && strcmp (special_event_name
, p
->name
) == 0)
7186 /* Enter the debugger in many ways. */
7187 debug_on_next_call
= true;
7188 debug_on_quit
= true;
7190 Vinhibit_quit
= Qnil
;
7192 /* Eat the event. */
7198 if (interrupt_input
)
7199 handle_input_available_signal (sig
);
7203 /* Tell wait_reading_process_output that it needs to wake
7204 up and look around. */
7205 if (input_available_clear_time
)
7206 *input_available_clear_time
= make_timespec (0, 0);
7213 deliver_user_signal (int sig
)
7215 deliver_process_signal (sig
, handle_user_signal
);
7219 find_user_signal_name (int sig
)
7221 struct user_signal_info
*p
;
7223 for (p
= user_signals
; p
; p
= p
->next
)
7231 store_user_signal_events (void)
7233 struct user_signal_info
*p
;
7234 struct input_event buf
;
7235 bool buf_initialized
= false;
7237 for (p
= user_signals
; p
; p
= p
->next
)
7238 if (p
->npending
> 0)
7240 if (! buf_initialized
)
7242 memset (&buf
, 0, sizeof buf
);
7243 buf
.kind
= USER_SIGNAL_EVENT
;
7244 buf
.frame_or_window
= selected_frame
;
7245 buf_initialized
= true;
7251 kbd_buffer_store_event (&buf
);
7254 while (p
->npending
> 0);
7259 static void menu_bar_item (Lisp_Object
, Lisp_Object
, Lisp_Object
, void *);
7260 static Lisp_Object menu_bar_one_keymap_changed_items
;
7262 /* These variables hold the vector under construction within
7263 menu_bar_items and its subroutines, and the current index
7264 for storing into that vector. */
7265 static Lisp_Object menu_bar_items_vector
;
7266 static int menu_bar_items_index
;
7269 static const char *separator_names
[] = {
7274 "single-dashed-line",
7275 "double-dashed-line",
7277 "shadow-etched-out",
7278 "shadow-etched-in-dash",
7279 "shadow-etched-out-dash",
7280 "shadow-double-etched-in",
7281 "shadow-double-etched-out",
7282 "shadow-double-etched-in-dash",
7283 "shadow-double-etched-out-dash",
7287 /* Return true if LABEL specifies a separator. */
7290 menu_separator_name_p (const char *label
)
7294 else if (strlen (label
) > 3
7295 && memcmp (label
, "--", 2) == 0
7300 for (i
= 0; separator_names
[i
]; ++i
)
7301 if (strcmp (label
, separator_names
[i
]) == 0)
7306 /* It's a separator if it contains only dashes. */
7307 while (*label
== '-')
7309 return (*label
== 0);
7316 /* Return a vector of menu items for a menu bar, appropriate
7317 to the current buffer. Each item has three elements in the vector:
7320 OLD is an old vector we can optionally reuse, or nil. */
7323 menu_bar_items (Lisp_Object old
)
7325 /* The number of keymaps we're scanning right now, and the number of
7326 keymaps we have allocated space for. */
7329 /* maps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
7330 in the current keymaps, or nil where it is not a prefix. */
7333 Lisp_Object mapsbuf
[3];
7334 Lisp_Object def
, tail
;
7341 /* In order to build the menus, we need to call the keymap
7342 accessors. They all call QUIT. But this function is called
7343 during redisplay, during which a quit is fatal. So inhibit
7344 quitting while building the menus.
7345 We do this instead of specbind because (1) errors will clear it anyway
7346 and (2) this avoids risk of specpdl overflow. */
7347 oquit
= Vinhibit_quit
;
7351 menu_bar_items_vector
= old
;
7353 menu_bar_items_vector
= Fmake_vector (make_number (24), Qnil
);
7354 menu_bar_items_index
= 0;
7356 /* Build our list of keymaps.
7357 If we recognize a function key and replace its escape sequence in
7358 keybuf with its symbol, or if the sequence starts with a mouse
7359 click and we need to switch buffers, we jump back here to rebuild
7360 the initial keymaps from the current buffer. */
7364 /* Should overriding-terminal-local-map and overriding-local-map apply? */
7365 if (!NILP (Voverriding_local_map_menu_flag
)
7366 && !NILP (Voverriding_local_map
))
7368 /* Yes, use them (if non-nil) as well as the global map. */
7371 if (!NILP (KVAR (current_kboard
, Voverriding_terminal_local_map
)))
7372 maps
[nmaps
++] = KVAR (current_kboard
, Voverriding_terminal_local_map
);
7373 if (!NILP (Voverriding_local_map
))
7374 maps
[nmaps
++] = Voverriding_local_map
;
7378 /* No, so use major and minor mode keymaps and keymap property.
7379 Note that menu-bar bindings in the local-map and keymap
7380 properties may not work reliable, as they are only
7381 recognized when the menu-bar (or mode-line) is updated,
7382 which does not normally happen after every command. */
7383 ptrdiff_t nminor
= current_minor_maps (NULL
, &tmaps
);
7384 SAFE_NALLOCA (maps
, 1, nminor
+ 4);
7386 Lisp_Object tem
= KVAR (current_kboard
, Voverriding_terminal_local_map
);
7387 if (!NILP (tem
) && !NILP (Voverriding_local_map_menu_flag
))
7388 maps
[nmaps
++] = tem
;
7389 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
7390 maps
[nmaps
++] = tem
;
7393 memcpy (maps
+ nmaps
, tmaps
, nminor
* sizeof (maps
[0]));
7396 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
7398 maps
[nmaps
++] = current_global_map
;
7401 /* Look up in each map the dummy prefix key `menu-bar'. */
7403 for (mapno
= nmaps
- 1; mapno
>= 0; mapno
--)
7404 if (!NILP (maps
[mapno
]))
7406 def
= get_keymap (access_keymap (maps
[mapno
], Qmenu_bar
, 1, 0, 1),
7410 menu_bar_one_keymap_changed_items
= Qnil
;
7411 map_keymap_canonical (def
, menu_bar_item
, Qnil
, NULL
);
7415 /* Move to the end those items that should be at the end. */
7417 for (tail
= Vmenu_bar_final_items
; CONSP (tail
); tail
= XCDR (tail
))
7420 int end
= menu_bar_items_index
;
7422 for (i
= 0; i
< end
; i
+= 4)
7423 if (EQ (XCAR (tail
), AREF (menu_bar_items_vector
, i
)))
7425 Lisp_Object tem0
, tem1
, tem2
, tem3
;
7426 /* Move the item at index I to the end,
7427 shifting all the others forward. */
7428 tem0
= AREF (menu_bar_items_vector
, i
+ 0);
7429 tem1
= AREF (menu_bar_items_vector
, i
+ 1);
7430 tem2
= AREF (menu_bar_items_vector
, i
+ 2);
7431 tem3
= AREF (menu_bar_items_vector
, i
+ 3);
7433 memmove (aref_addr (menu_bar_items_vector
, i
),
7434 aref_addr (menu_bar_items_vector
, i
+ 4),
7435 (end
- i
- 4) * word_size
);
7436 ASET (menu_bar_items_vector
, end
- 4, tem0
);
7437 ASET (menu_bar_items_vector
, end
- 3, tem1
);
7438 ASET (menu_bar_items_vector
, end
- 2, tem2
);
7439 ASET (menu_bar_items_vector
, end
- 1, tem3
);
7444 /* Add nil, nil, nil, nil at the end. */
7446 int i
= menu_bar_items_index
;
7447 if (i
+ 4 > ASIZE (menu_bar_items_vector
))
7448 menu_bar_items_vector
7449 = larger_vector (menu_bar_items_vector
, 4, -1);
7450 /* Add this item. */
7451 ASET (menu_bar_items_vector
, i
, Qnil
); i
++;
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 menu_bar_items_index
= i
;
7458 Vinhibit_quit
= oquit
;
7460 return menu_bar_items_vector
;
7463 /* Add one item to menu_bar_items_vector, for KEY, ITEM_STRING and DEF.
7464 If there's already an item for KEY, add this DEF to it. */
7466 Lisp_Object item_properties
;
7469 menu_bar_item (Lisp_Object key
, Lisp_Object item
, Lisp_Object dummy1
, void *dummy2
)
7475 if (EQ (item
, Qundefined
))
7477 /* If a map has an explicit `undefined' as definition,
7478 discard any previously made menu bar item. */
7480 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7481 if (EQ (key
, AREF (menu_bar_items_vector
, i
)))
7483 if (menu_bar_items_index
> i
+ 4)
7484 memmove (aref_addr (menu_bar_items_vector
, i
),
7485 aref_addr (menu_bar_items_vector
, i
+ 4),
7486 (menu_bar_items_index
- i
- 4) * word_size
);
7487 menu_bar_items_index
-= 4;
7491 /* If this keymap has already contributed to this KEY,
7492 don't contribute to it a second time. */
7493 tem
= Fmemq (key
, menu_bar_one_keymap_changed_items
);
7494 if (!NILP (tem
) || NILP (item
))
7497 menu_bar_one_keymap_changed_items
7498 = Fcons (key
, menu_bar_one_keymap_changed_items
);
7500 /* We add to menu_bar_one_keymap_changed_items before doing the
7501 parse_menu_item, so that if it turns out it wasn't a menu item,
7502 it still correctly hides any further menu item. */
7503 parsed
= parse_menu_item (item
, 1);
7507 item
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7509 /* Find any existing item for this KEY. */
7510 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7511 if (EQ (key
, AREF (menu_bar_items_vector
, i
)))
7514 /* If we did not find this KEY, add it at the end. */
7515 if (i
== menu_bar_items_index
)
7517 /* If vector is too small, get a bigger one. */
7518 if (i
+ 4 > ASIZE (menu_bar_items_vector
))
7519 menu_bar_items_vector
= larger_vector (menu_bar_items_vector
, 4, -1);
7520 /* Add this item. */
7521 ASET (menu_bar_items_vector
, i
, key
); i
++;
7522 ASET (menu_bar_items_vector
, i
,
7523 AREF (item_properties
, ITEM_PROPERTY_NAME
)); i
++;
7524 ASET (menu_bar_items_vector
, i
, list1 (item
)); i
++;
7525 ASET (menu_bar_items_vector
, i
, make_number (0)); i
++;
7526 menu_bar_items_index
= i
;
7528 /* We did find an item for this KEY. Add ITEM to its list of maps. */
7532 old
= AREF (menu_bar_items_vector
, i
+ 2);
7533 /* If the new and the old items are not both keymaps,
7534 the lookup will only find `item'. */
7535 item
= Fcons (item
, KEYMAPP (item
) && KEYMAPP (XCAR (old
)) ? old
: Qnil
);
7536 ASET (menu_bar_items_vector
, i
+ 2, item
);
7540 /* This is used as the handler when calling menu_item_eval_property. */
7542 menu_item_eval_property_1 (Lisp_Object arg
)
7544 /* If we got a quit from within the menu computation,
7545 quit all the way out of it. This takes care of C-] in the debugger. */
7546 if (CONSP (arg
) && EQ (XCAR (arg
), Qquit
))
7547 Fsignal (Qquit
, Qnil
);
7553 eval_dyn (Lisp_Object form
)
7555 return Feval (form
, Qnil
);
7558 /* Evaluate an expression and return the result (or nil if something
7559 went wrong). Used to evaluate dynamic parts of menu items. */
7561 menu_item_eval_property (Lisp_Object sexpr
)
7563 ptrdiff_t count
= SPECPDL_INDEX ();
7565 specbind (Qinhibit_redisplay
, Qt
);
7566 val
= internal_condition_case_1 (eval_dyn
, sexpr
, Qerror
,
7567 menu_item_eval_property_1
);
7568 return unbind_to (count
, val
);
7571 /* This function parses a menu item and leaves the result in the
7572 vector item_properties.
7573 ITEM is a key binding, a possible menu item.
7574 INMENUBAR is > 0 when this is considered for an entry in a menu bar
7576 INMENUBAR is < 0 when this is considered for an entry in a keyboard menu.
7577 parse_menu_item returns true if the item is a menu item and false
7581 parse_menu_item (Lisp_Object item
, int inmenubar
)
7583 Lisp_Object def
, tem
, item_string
, start
;
7585 Lisp_Object keyhint
;
7594 /* Create item_properties vector if necessary. */
7595 if (NILP (item_properties
))
7597 = Fmake_vector (make_number (ITEM_PROPERTY_ENABLE
+ 1), Qnil
);
7599 /* Initialize optional entries. */
7600 for (i
= ITEM_PROPERTY_DEF
; i
< ITEM_PROPERTY_ENABLE
; i
++)
7601 ASET (item_properties
, i
, Qnil
);
7602 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7604 /* Save the item here to protect it from GC. */
7605 ASET (item_properties
, ITEM_PROPERTY_ITEM
, item
);
7607 item_string
= XCAR (item
);
7611 if (STRINGP (item_string
))
7613 /* Old format menu item. */
7614 ASET (item_properties
, ITEM_PROPERTY_NAME
, item_string
);
7616 /* Maybe help string. */
7617 if (CONSP (item
) && STRINGP (XCAR (item
)))
7619 ASET (item_properties
, ITEM_PROPERTY_HELP
,
7620 Fsubstitute_command_keys (XCAR (item
)));
7625 /* Maybe an obsolete key binding cache. */
7626 if (CONSP (item
) && CONSP (XCAR (item
))
7627 && (NILP (XCAR (XCAR (item
)))
7628 || VECTORP (XCAR (XCAR (item
)))))
7631 /* This is the real definition--the function to run. */
7632 ASET (item_properties
, ITEM_PROPERTY_DEF
, item
);
7634 /* Get enable property, if any. */
7637 tem
= Fget (item
, Qmenu_enable
);
7638 if (!NILP (Venable_disabled_menus_and_buttons
))
7639 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7640 else if (!NILP (tem
))
7641 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, tem
);
7644 else if (EQ (item_string
, Qmenu_item
) && CONSP (item
))
7646 /* New format menu item. */
7647 ASET (item_properties
, ITEM_PROPERTY_NAME
, XCAR (item
));
7648 start
= XCDR (item
);
7651 /* We have a real binding. */
7652 ASET (item_properties
, ITEM_PROPERTY_DEF
, XCAR (start
));
7654 item
= XCDR (start
);
7655 /* Is there an obsolete cache list with key equivalences. */
7656 if (CONSP (item
) && CONSP (XCAR (item
)))
7659 /* Parse properties. */
7660 while (CONSP (item
) && CONSP (XCDR (item
)))
7665 if (EQ (tem
, QCenable
))
7667 if (!NILP (Venable_disabled_menus_and_buttons
))
7668 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7670 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, XCAR (item
));
7672 else if (EQ (tem
, QCvisible
))
7674 /* If got a visible property and that evaluates to nil
7675 then ignore this item. */
7676 tem
= menu_item_eval_property (XCAR (item
));
7680 else if (EQ (tem
, QChelp
))
7682 Lisp_Object help
= XCAR (item
);
7684 help
= Fsubstitute_command_keys (help
);
7685 ASET (item_properties
, ITEM_PROPERTY_HELP
, help
);
7687 else if (EQ (tem
, QCfilter
))
7689 else if (EQ (tem
, QCkey_sequence
))
7692 if (SYMBOLP (tem
) || STRINGP (tem
) || VECTORP (tem
))
7693 /* Be GC protected. Set keyhint to item instead of tem. */
7696 else if (EQ (tem
, QCkeys
))
7699 if (CONSP (tem
) || STRINGP (tem
))
7700 ASET (item_properties
, ITEM_PROPERTY_KEYEQ
, tem
);
7702 else if (EQ (tem
, QCbutton
) && CONSP (XCAR (item
)))
7707 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
7709 ASET (item_properties
, ITEM_PROPERTY_SELECTED
,
7711 ASET (item_properties
, ITEM_PROPERTY_TYPE
, type
);
7717 else if (inmenubar
|| !NILP (start
))
7721 return 0; /* not a menu item */
7723 /* If item string is not a string, evaluate it to get string.
7724 If we don't get a string, skip this item. */
7725 item_string
= AREF (item_properties
, ITEM_PROPERTY_NAME
);
7726 if (!(STRINGP (item_string
)))
7728 item_string
= menu_item_eval_property (item_string
);
7729 if (!STRINGP (item_string
))
7731 ASET (item_properties
, ITEM_PROPERTY_NAME
, item_string
);
7734 /* If got a filter apply it on definition. */
7735 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7738 def
= menu_item_eval_property (list2 (XCAR (filter
),
7739 list2 (Qquote
, def
)));
7741 ASET (item_properties
, ITEM_PROPERTY_DEF
, def
);
7744 /* Enable or disable selection of item. */
7745 tem
= AREF (item_properties
, ITEM_PROPERTY_ENABLE
);
7748 tem
= menu_item_eval_property (tem
);
7749 if (inmenubar
&& NILP (tem
))
7750 return 0; /* Ignore disabled items in menu bar. */
7751 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, tem
);
7754 /* If we got no definition, this item is just unselectable text which
7755 is OK in a submenu but not in the menubar. */
7757 return (!inmenubar
);
7759 /* See if this is a separate pane or a submenu. */
7760 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7761 tem
= get_keymap (def
, 0, 1);
7762 /* For a subkeymap, just record its details and exit. */
7765 ASET (item_properties
, ITEM_PROPERTY_MAP
, tem
);
7766 ASET (item_properties
, ITEM_PROPERTY_DEF
, tem
);
7770 /* At the top level in the menu bar, do likewise for commands also.
7771 The menu bar does not display equivalent key bindings anyway.
7772 ITEM_PROPERTY_DEF is already set up properly. */
7776 { /* This is a command. See if there is an equivalent key binding. */
7777 Lisp_Object keyeq
= AREF (item_properties
, ITEM_PROPERTY_KEYEQ
);
7778 AUTO_STRING (space_space
, " ");
7780 /* The previous code preferred :key-sequence to :keys, so we
7781 preserve this behavior. */
7782 if (STRINGP (keyeq
) && !CONSP (keyhint
))
7783 keyeq
= concat2 (space_space
, Fsubstitute_command_keys (keyeq
));
7786 Lisp_Object prefix
= keyeq
;
7787 Lisp_Object keys
= Qnil
;
7791 def
= XCAR (prefix
);
7792 prefix
= XCDR (prefix
);
7795 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7797 if (CONSP (keyhint
) && !NILP (XCAR (keyhint
)))
7799 keys
= XCAR (keyhint
);
7800 tem
= Fkey_binding (keys
, Qnil
, Qnil
, Qnil
);
7802 /* We have a suggested key. Is it bound to the command? */
7805 /* If the command is an alias for another
7806 (such as lmenu.el set it up), check if the
7807 original command matches the cached command. */
7809 && EQ (tem
, XSYMBOL (def
)->function
))))
7814 keys
= Fwhere_is_internal (def
, Qnil
, Qt
, Qnil
, Qnil
);
7818 tem
= Fkey_description (keys
, Qnil
);
7821 if (STRINGP (XCAR (prefix
)))
7822 tem
= concat2 (XCAR (prefix
), tem
);
7823 if (STRINGP (XCDR (prefix
)))
7824 tem
= concat2 (tem
, XCDR (prefix
));
7826 keyeq
= concat2 (space_space
, tem
);
7832 /* If we have an equivalent key binding, use that. */
7833 ASET (item_properties
, ITEM_PROPERTY_KEYEQ
, keyeq
);
7836 /* Include this when menu help is implemented.
7837 tem = XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP];
7838 if (!(NILP (tem) || STRINGP (tem)))
7840 tem = menu_item_eval_property (tem);
7843 XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP] = tem;
7847 /* Handle radio buttons or toggle boxes. */
7848 tem
= AREF (item_properties
, ITEM_PROPERTY_SELECTED
);
7850 ASET (item_properties
, ITEM_PROPERTY_SELECTED
,
7851 menu_item_eval_property (tem
));
7858 /***********************************************************************
7860 ***********************************************************************/
7862 /* A vector holding tool bar items while they are parsed in function
7863 tool_bar_items. Each item occupies TOOL_BAR_ITEM_NSCLOTS elements
7866 static Lisp_Object tool_bar_items_vector
;
7868 /* A vector holding the result of parse_tool_bar_item. Layout is like
7869 the one for a single item in tool_bar_items_vector. */
7871 static Lisp_Object tool_bar_item_properties
;
7873 /* Next free index in tool_bar_items_vector. */
7875 static int ntool_bar_items
;
7877 /* Function prototypes. */
7879 static void init_tool_bar_items (Lisp_Object
);
7880 static void process_tool_bar_item (Lisp_Object
, Lisp_Object
, Lisp_Object
,
7882 static bool parse_tool_bar_item (Lisp_Object
, Lisp_Object
);
7883 static void append_tool_bar_item (void);
7886 /* Return a vector of tool bar items for keymaps currently in effect.
7887 Reuse vector REUSE if non-nil. Return in *NITEMS the number of
7888 tool bar items found. */
7891 tool_bar_items (Lisp_Object reuse
, int *nitems
)
7894 Lisp_Object mapsbuf
[3];
7902 /* In order to build the menus, we need to call the keymap
7903 accessors. They all call QUIT. But this function is called
7904 during redisplay, during which a quit is fatal. So inhibit
7905 quitting while building the menus. We do this instead of
7906 specbind because (1) errors will clear it anyway and (2) this
7907 avoids risk of specpdl overflow. */
7908 oquit
= Vinhibit_quit
;
7911 /* Initialize tool_bar_items_vector and protect it from GC. */
7912 init_tool_bar_items (reuse
);
7914 /* Build list of keymaps in maps. Set nmaps to the number of maps
7917 /* Should overriding-terminal-local-map and overriding-local-map apply? */
7918 if (!NILP (Voverriding_local_map_menu_flag
)
7919 && !NILP (Voverriding_local_map
))
7921 /* Yes, use them (if non-nil) as well as the global map. */
7924 if (!NILP (KVAR (current_kboard
, Voverriding_terminal_local_map
)))
7925 maps
[nmaps
++] = KVAR (current_kboard
, Voverriding_terminal_local_map
);
7926 if (!NILP (Voverriding_local_map
))
7927 maps
[nmaps
++] = Voverriding_local_map
;
7931 /* No, so use major and minor mode keymaps and keymap property.
7932 Note that tool-bar bindings in the local-map and keymap
7933 properties may not work reliable, as they are only
7934 recognized when the tool-bar (or mode-line) is updated,
7935 which does not normally happen after every command. */
7936 ptrdiff_t nminor
= current_minor_maps (NULL
, &tmaps
);
7937 SAFE_NALLOCA (maps
, 1, nminor
+ 4);
7939 Lisp_Object tem
= KVAR (current_kboard
, Voverriding_terminal_local_map
);
7940 if (!NILP (tem
) && !NILP (Voverriding_local_map_menu_flag
))
7941 maps
[nmaps
++] = tem
;
7942 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
7943 maps
[nmaps
++] = tem
;
7946 memcpy (maps
+ nmaps
, tmaps
, nminor
* sizeof (maps
[0]));
7949 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
7952 /* Add global keymap at the end. */
7953 maps
[nmaps
++] = current_global_map
;
7955 /* Process maps in reverse order and look up in each map the prefix
7957 for (i
= nmaps
- 1; i
>= 0; --i
)
7958 if (!NILP (maps
[i
]))
7962 keymap
= get_keymap (access_keymap (maps
[i
], Qtool_bar
, 1, 0, 1), 0, 1);
7964 map_keymap (keymap
, process_tool_bar_item
, Qnil
, NULL
, 1);
7967 Vinhibit_quit
= oquit
;
7968 *nitems
= ntool_bar_items
/ TOOL_BAR_ITEM_NSLOTS
;
7970 return tool_bar_items_vector
;
7974 /* Process the definition of KEY which is DEF. */
7977 process_tool_bar_item (Lisp_Object key
, Lisp_Object def
, Lisp_Object data
, void *args
)
7981 if (EQ (def
, Qundefined
))
7983 /* If a map has an explicit `undefined' as definition,
7984 discard any previously made item. */
7985 for (i
= 0; i
< ntool_bar_items
; i
+= TOOL_BAR_ITEM_NSLOTS
)
7987 Lisp_Object
*v
= XVECTOR (tool_bar_items_vector
)->contents
+ i
;
7989 if (EQ (key
, v
[TOOL_BAR_ITEM_KEY
]))
7991 if (ntool_bar_items
> i
+ TOOL_BAR_ITEM_NSLOTS
)
7992 memmove (v
, v
+ TOOL_BAR_ITEM_NSLOTS
,
7993 ((ntool_bar_items
- i
- TOOL_BAR_ITEM_NSLOTS
)
7995 ntool_bar_items
-= TOOL_BAR_ITEM_NSLOTS
;
8000 else if (parse_tool_bar_item (key
, def
))
8001 /* Append a new tool bar item to tool_bar_items_vector. Accept
8002 more than one definition for the same key. */
8003 append_tool_bar_item ();
8006 /* Access slot with index IDX of vector tool_bar_item_properties. */
8007 #define PROP(IDX) AREF (tool_bar_item_properties, (IDX))
8009 set_prop (ptrdiff_t idx
, Lisp_Object val
)
8011 ASET (tool_bar_item_properties
, idx
, val
);
8015 /* Parse a tool bar item specification ITEM for key KEY and return the
8016 result in tool_bar_item_properties. Value is false if ITEM is
8019 ITEM is a list `(menu-item CAPTION BINDING PROPS...)'.
8021 CAPTION is the caption of the item, If it's not a string, it is
8022 evaluated to get a string.
8024 BINDING is the tool bar item's binding. Tool-bar items with keymaps
8025 as binding are currently ignored.
8027 The following properties are recognized:
8031 FORM is evaluated and specifies whether the tool bar item is
8032 enabled or disabled.
8036 FORM is evaluated and specifies whether the tool bar item is visible.
8038 - `:filter FUNCTION'
8040 FUNCTION is invoked with one parameter `(quote BINDING)'. Its
8041 result is stored as the new binding.
8043 - `:button (TYPE SELECTED)'
8045 TYPE must be one of `:radio' or `:toggle'. SELECTED is evaluated
8046 and specifies whether the button is selected (pressed) or not.
8050 IMAGES is either a single image specification or a vector of four
8051 image specifications. See enum tool_bar_item_images.
8053 - `:help HELP-STRING'.
8055 Gives a help string to display for the tool bar item.
8057 - `:label LABEL-STRING'.
8059 A text label to show with the tool bar button if labels are enabled. */
8062 parse_tool_bar_item (Lisp_Object key
, Lisp_Object item
)
8064 Lisp_Object filter
= Qnil
;
8065 Lisp_Object caption
;
8067 bool have_label
= false;
8069 /* Definition looks like `(menu-item CAPTION BINDING PROPS...)'.
8070 Rule out items that aren't lists, don't start with
8071 `menu-item' or whose rest following `tool-bar-item' is not a
8076 /* As an exception, allow old-style menu separators. */
8077 if (STRINGP (XCAR (item
)))
8078 item
= list1 (XCAR (item
));
8079 else if (!EQ (XCAR (item
), Qmenu_item
)
8080 || (item
= XCDR (item
), !CONSP (item
)))
8083 /* Create tool_bar_item_properties vector if necessary. Reset it to
8085 if (VECTORP (tool_bar_item_properties
))
8087 for (i
= 0; i
< TOOL_BAR_ITEM_NSLOTS
; ++i
)
8091 tool_bar_item_properties
8092 = Fmake_vector (make_number (TOOL_BAR_ITEM_NSLOTS
), Qnil
);
8095 set_prop (TOOL_BAR_ITEM_KEY
, key
);
8096 set_prop (TOOL_BAR_ITEM_ENABLED_P
, Qt
);
8098 /* Get the caption of the item. If the caption is not a string,
8099 evaluate it to get a string. If we don't get a string, skip this
8101 caption
= XCAR (item
);
8102 if (!STRINGP (caption
))
8104 caption
= menu_item_eval_property (caption
);
8105 if (!STRINGP (caption
))
8108 set_prop (TOOL_BAR_ITEM_CAPTION
, caption
);
8110 /* If the rest following the caption is not a list, the menu item is
8111 either a separator, or invalid. */
8115 if (menu_separator_name_p (SSDATA (caption
)))
8117 set_prop (TOOL_BAR_ITEM_TYPE
, Qt
);
8118 #if !defined (USE_GTK) && !defined (HAVE_NS)
8119 /* If we use build_desired_tool_bar_string to render the
8120 tool bar, the separator is rendered as an image. */
8121 set_prop (TOOL_BAR_ITEM_IMAGES
,
8122 (menu_item_eval_property
8123 (Vtool_bar_separator_image_expression
)));
8124 set_prop (TOOL_BAR_ITEM_ENABLED_P
, Qnil
);
8125 set_prop (TOOL_BAR_ITEM_SELECTED_P
, Qnil
);
8126 set_prop (TOOL_BAR_ITEM_CAPTION
, Qnil
);
8133 /* Store the binding. */
8134 set_prop (TOOL_BAR_ITEM_BINDING
, XCAR (item
));
8137 /* Ignore cached key binding, if any. */
8138 if (CONSP (item
) && CONSP (XCAR (item
)))
8141 /* Process the rest of the properties. */
8142 for (; CONSP (item
) && CONSP (XCDR (item
)); item
= XCDR (XCDR (item
)))
8144 Lisp_Object ikey
, value
;
8147 value
= XCAR (XCDR (item
));
8149 if (EQ (ikey
, QCenable
))
8151 /* `:enable FORM'. */
8152 if (!NILP (Venable_disabled_menus_and_buttons
))
8153 set_prop (TOOL_BAR_ITEM_ENABLED_P
, Qt
);
8155 set_prop (TOOL_BAR_ITEM_ENABLED_P
, value
);
8157 else if (EQ (ikey
, QCvisible
))
8159 /* `:visible FORM'. If got a visible property and that
8160 evaluates to nil then ignore this item. */
8161 if (NILP (menu_item_eval_property (value
)))
8164 else if (EQ (ikey
, QChelp
))
8165 /* `:help HELP-STRING'. */
8166 set_prop (TOOL_BAR_ITEM_HELP
, value
);
8167 else if (EQ (ikey
, QCvert_only
))
8168 /* `:vert-only t/nil'. */
8169 set_prop (TOOL_BAR_ITEM_VERT_ONLY
, value
);
8170 else if (EQ (ikey
, QClabel
))
8172 const char *bad_label
= "!!?GARBLED ITEM?!!";
8173 /* `:label LABEL-STRING'. */
8174 set_prop (TOOL_BAR_ITEM_LABEL
,
8175 STRINGP (value
) ? value
: build_string (bad_label
));
8178 else if (EQ (ikey
, QCfilter
))
8179 /* ':filter FORM'. */
8181 else if (EQ (ikey
, QCbutton
) && CONSP (value
))
8183 /* `:button (TYPE . SELECTED)'. */
8184 Lisp_Object type
, selected
;
8186 type
= XCAR (value
);
8187 selected
= XCDR (value
);
8188 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
8190 set_prop (TOOL_BAR_ITEM_SELECTED_P
, selected
);
8191 set_prop (TOOL_BAR_ITEM_TYPE
, type
);
8194 else if (EQ (ikey
, QCimage
)
8196 || (VECTORP (value
) && ASIZE (value
) == 4)))
8197 /* Value is either a single image specification or a vector
8198 of 4 such specifications for the different button states. */
8199 set_prop (TOOL_BAR_ITEM_IMAGES
, value
);
8200 else if (EQ (ikey
, QCrtl
))
8202 set_prop (TOOL_BAR_ITEM_RTL_IMAGE
, value
);
8208 /* Try to make one from caption and key. */
8209 Lisp_Object tkey
= PROP (TOOL_BAR_ITEM_KEY
);
8210 Lisp_Object tcapt
= PROP (TOOL_BAR_ITEM_CAPTION
);
8211 const char *label
= SYMBOLP (tkey
) ? SSDATA (SYMBOL_NAME (tkey
)) : "";
8212 const char *capt
= STRINGP (tcapt
) ? SSDATA (tcapt
) : "";
8214 2 * max (0, min (tool_bar_max_label_size
, STRING_BYTES_BOUND
/ 2));
8215 char *buf
= xmalloc (max_lbl
+ 1);
8216 Lisp_Object new_lbl
;
8217 ptrdiff_t caption_len
= strlen (capt
);
8219 if (caption_len
<= max_lbl
&& capt
[0] != '\0')
8222 while (caption_len
> 0 && buf
[caption_len
- 1] == '.')
8224 buf
[caption_len
] = '\0';
8228 if (strlen (label
) <= max_lbl
&& label
[0] != '\0')
8232 strcpy (buf
, label
);
8234 for (j
= 0; buf
[j
] != '\0'; ++j
)
8242 new_lbl
= Fupcase_initials (build_string (label
));
8243 if (SCHARS (new_lbl
) <= tool_bar_max_label_size
)
8244 set_prop (TOOL_BAR_ITEM_LABEL
, new_lbl
);
8246 set_prop (TOOL_BAR_ITEM_LABEL
, empty_unibyte_string
);
8250 /* If got a filter apply it on binding. */
8252 set_prop (TOOL_BAR_ITEM_BINDING
,
8253 (menu_item_eval_property
8256 PROP (TOOL_BAR_ITEM_BINDING
))))));
8258 /* See if the binding is a keymap. Give up if it is. */
8259 if (CONSP (get_keymap (PROP (TOOL_BAR_ITEM_BINDING
), 0, 1)))
8262 /* Enable or disable selection of item. */
8263 if (!EQ (PROP (TOOL_BAR_ITEM_ENABLED_P
), Qt
))
8264 set_prop (TOOL_BAR_ITEM_ENABLED_P
,
8265 menu_item_eval_property (PROP (TOOL_BAR_ITEM_ENABLED_P
)));
8267 /* Handle radio buttons or toggle boxes. */
8268 if (!NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
)))
8269 set_prop (TOOL_BAR_ITEM_SELECTED_P
,
8270 menu_item_eval_property (PROP (TOOL_BAR_ITEM_SELECTED_P
)));
8278 /* Initialize tool_bar_items_vector. REUSE, if non-nil, is a vector
8279 that can be reused. */
8282 init_tool_bar_items (Lisp_Object reuse
)
8284 if (VECTORP (reuse
))
8285 tool_bar_items_vector
= reuse
;
8287 tool_bar_items_vector
= Fmake_vector (make_number (64), Qnil
);
8288 ntool_bar_items
= 0;
8292 /* Append parsed tool bar item properties from
8293 tool_bar_item_properties */
8296 append_tool_bar_item (void)
8300 - (ASIZE (tool_bar_items_vector
) - TOOL_BAR_ITEM_NSLOTS
));
8302 /* Enlarge tool_bar_items_vector if necessary. */
8304 tool_bar_items_vector
= larger_vector (tool_bar_items_vector
, incr
, -1);
8306 /* Append entries from tool_bar_item_properties to the end of
8307 tool_bar_items_vector. */
8308 vcopy (tool_bar_items_vector
, ntool_bar_items
,
8309 XVECTOR (tool_bar_item_properties
)->contents
, TOOL_BAR_ITEM_NSLOTS
);
8310 ntool_bar_items
+= TOOL_BAR_ITEM_NSLOTS
;
8317 /* Read a character using menus based on the keymap MAP.
8318 Return nil if there are no menus in the maps.
8319 Return t if we displayed a menu but the user rejected it.
8321 PREV_EVENT is the previous input event, or nil if we are reading
8322 the first event of a key sequence.
8324 If USED_MOUSE_MENU is non-null, set *USED_MOUSE_MENU to true
8325 if we used a mouse menu to read the input, or false otherwise. If
8326 USED_MOUSE_MENU is null, don't dereference it.
8328 The prompting is done based on the prompt-string of the map
8329 and the strings associated with various map elements.
8331 This can be done with X menus or with menus put in the minibuf.
8332 These are done in different ways, depending on how the input will be read.
8333 Menus using X are done after auto-saving in read-char, getting the input
8334 event from Fx_popup_menu; menus using the minibuf use read_char recursively
8335 and do auto-saving in the inner call of read_char. */
8338 read_char_x_menu_prompt (Lisp_Object map
,
8339 Lisp_Object prev_event
, bool *used_mouse_menu
)
8341 if (used_mouse_menu
)
8342 *used_mouse_menu
= false;
8344 /* Use local over global Menu maps. */
8346 if (! menu_prompting
)
8349 /* If we got to this point via a mouse click,
8350 use a real menu for mouse selection. */
8351 if (EVENT_HAS_PARAMETERS (prev_event
)
8352 && !EQ (XCAR (prev_event
), Qmenu_bar
)
8353 && !EQ (XCAR (prev_event
), Qtool_bar
))
8355 /* Display the menu and get the selection. */
8358 value
= Fx_popup_menu (prev_event
, get_keymap (map
, 0, 1));
8363 record_menu_key (XCAR (value
));
8365 /* If we got multiple events, unread all but
8367 There is no way to prevent those unread events
8368 from showing up later in last_nonmenu_event.
8369 So turn symbol and integer events into lists,
8370 to indicate that they came from a mouse menu,
8371 so that when present in last_nonmenu_event
8372 they won't confuse things. */
8373 for (tem
= XCDR (value
); CONSP (tem
); tem
= XCDR (tem
))
8375 record_menu_key (XCAR (tem
));
8376 if (SYMBOLP (XCAR (tem
))
8377 || INTEGERP (XCAR (tem
)))
8378 XSETCAR (tem
, Fcons (XCAR (tem
), Qdisabled
));
8381 /* If we got more than one event, put all but the first
8382 onto this list to be read later.
8383 Return just the first event now. */
8384 Vunread_command_events
8385 = nconc2 (XCDR (value
), Vunread_command_events
);
8386 value
= XCAR (value
);
8388 else if (NILP (value
))
8390 if (used_mouse_menu
)
8391 *used_mouse_menu
= true;
8398 read_char_minibuf_menu_prompt (int commandflag
,
8403 /* FIXME: Use the minibuffer's frame width. */
8404 ptrdiff_t width
= FRAME_COLS (SELECTED_FRAME ()) - 4;
8406 bool nobindings
= true;
8407 Lisp_Object rest
, vector
;
8408 Lisp_Object prompt_strings
= Qnil
;
8412 if (! menu_prompting
)
8415 map
= get_keymap (map
, 0, 1);
8416 name
= Fkeymap_prompt (map
);
8418 /* If we don't have any menus, just read a character normally. */
8419 if (!STRINGP (name
))
8422 #define PUSH_C_STR(str, listvar) \
8423 listvar = Fcons (build_unibyte_string (str), listvar)
8425 /* Prompt string always starts with map's prompt, and a space. */
8426 prompt_strings
= Fcons (name
, prompt_strings
);
8427 PUSH_C_STR (": ", prompt_strings
);
8428 nlength
= SCHARS (name
) + 2;
8432 /* Present the documented bindings, a line at a time. */
8435 bool notfirst
= false;
8436 Lisp_Object menu_strings
= prompt_strings
;
8437 ptrdiff_t i
= nlength
;
8439 Lisp_Object orig_defn_macro
;
8441 /* Loop over elements of map. */
8446 /* FIXME: Use map_keymap to handle new keymap formats. */
8448 /* At end of map, wrap around if just starting,
8449 or end this line if already have something on it. */
8452 if (notfirst
|| nobindings
)
8458 /* Look at the next element of the map. */
8460 elt
= AREF (vector
, idx
);
8462 elt
= Fcar_safe (rest
);
8464 if (idx
< 0 && VECTORP (elt
))
8466 /* If we found a dense table in the keymap,
8467 advanced past it, but start scanning its contents. */
8468 rest
= Fcdr_safe (rest
);
8474 /* An ordinary element. */
8475 Lisp_Object event
, tem
;
8479 event
= Fcar_safe (elt
); /* alist */
8480 elt
= Fcdr_safe (elt
);
8484 XSETINT (event
, idx
); /* vector */
8487 /* Ignore the element if it has no prompt string. */
8488 if (INTEGERP (event
) && parse_menu_item (elt
, -1))
8490 /* True if the char to type matches the string. */
8492 Lisp_Object upcased_event
, downcased_event
;
8493 Lisp_Object desc
= Qnil
;
8495 = AREF (item_properties
, ITEM_PROPERTY_NAME
);
8497 upcased_event
= Fupcase (event
);
8498 downcased_event
= Fdowncase (event
);
8499 char_matches
= (XINT (upcased_event
) == SREF (s
, 0)
8500 || XINT (downcased_event
) == SREF (s
, 0));
8502 desc
= Fsingle_key_description (event
, Qnil
);
8504 #if 0 /* It is redundant to list the equivalent key bindings because
8505 the prefix is what the user has already typed. */
8507 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_KEYEQ
];
8509 /* Insert equivalent keybinding. */
8510 s
= concat2 (s
, tem
);
8513 = AREF (item_properties
, ITEM_PROPERTY_TYPE
);
8514 if (EQ (tem
, QCradio
) || EQ (tem
, QCtoggle
))
8516 /* Insert button prefix. */
8517 Lisp_Object selected
8518 = AREF (item_properties
, ITEM_PROPERTY_SELECTED
);
8519 AUTO_STRING (radio_yes
, "(*) ");
8520 AUTO_STRING (radio_no
, "( ) ");
8521 AUTO_STRING (check_yes
, "[X] ");
8522 AUTO_STRING (check_no
, "[ ] ");
8523 if (EQ (tem
, QCradio
))
8524 tem
= NILP (selected
) ? radio_yes
: radio_no
;
8526 tem
= NILP (selected
) ? check_yes
: check_no
;
8527 s
= concat2 (tem
, s
);
8531 /* If we have room for the prompt string, add it to this line.
8532 If this is the first on the line, always add it. */
8533 if ((SCHARS (s
) + i
+ 2
8534 + (char_matches
? 0 : SCHARS (desc
) + 3))
8538 ptrdiff_t thiswidth
;
8540 /* Punctuate between strings. */
8543 PUSH_C_STR (", ", menu_strings
);
8549 /* If the char to type doesn't match the string's
8550 first char, explicitly show what char to type. */
8553 /* Add as much of string as fits. */
8554 thiswidth
= min (SCHARS (desc
), width
- i
);
8556 = Fcons (Fsubstring (desc
, make_number (0),
8557 make_number (thiswidth
)),
8560 PUSH_C_STR (" = ", menu_strings
);
8564 /* Add as much of string as fits. */
8565 thiswidth
= min (SCHARS (s
), width
- i
);
8567 = Fcons (Fsubstring (s
, make_number (0),
8568 make_number (thiswidth
)),
8574 /* If this element does not fit, end the line now,
8575 and save the element for the next line. */
8576 PUSH_C_STR ("...", menu_strings
);
8581 /* Move past this element. */
8582 if (idx
>= 0 && idx
+ 1 >= ASIZE (vector
))
8583 /* Handle reaching end of dense table. */
8588 rest
= Fcdr_safe (rest
);
8592 /* Prompt with that and read response. */
8593 message3_nolog (apply1 (intern ("concat"), Fnreverse (menu_strings
)));
8595 /* Make believe it's not a keyboard macro in case the help char
8596 is pressed. Help characters are not recorded because menu prompting
8597 is not used on replay. */
8598 orig_defn_macro
= KVAR (current_kboard
, defining_kbd_macro
);
8599 kset_defining_kbd_macro (current_kboard
, Qnil
);
8601 obj
= read_char (commandflag
, Qnil
, Qt
, 0, NULL
);
8602 while (BUFFERP (obj
));
8603 kset_defining_kbd_macro (current_kboard
, orig_defn_macro
);
8605 if (!INTEGERP (obj
) || XINT (obj
) == -2
8606 || (! EQ (obj
, menu_prompt_more_char
)
8607 && (!INTEGERP (menu_prompt_more_char
)
8608 || ! EQ (obj
, make_number (Ctl (XINT (menu_prompt_more_char
)))))))
8610 if (!NILP (KVAR (current_kboard
, defining_kbd_macro
)))
8611 store_kbd_macro_char (obj
);
8614 /* Help char - go round again. */
8618 /* Reading key sequences. */
8621 follow_key (Lisp_Object keymap
, Lisp_Object key
)
8623 return access_keymap (get_keymap (keymap
, 0, 1),
8628 active_maps (Lisp_Object first_event
)
8630 Lisp_Object position
8631 = CONSP (first_event
) ? CAR_SAFE (XCDR (first_event
)) : Qnil
;
8632 return Fcons (Qkeymap
, Fcurrent_active_maps (Qt
, position
));
8635 /* Structure used to keep track of partial application of key remapping
8636 such as Vfunction_key_map and Vkey_translation_map. */
8637 typedef struct keyremap
8639 /* This is the map originally specified for this use. */
8641 /* This is a submap reached by looking up, in PARENT,
8642 the events from START to END. */
8644 /* Positions [START, END) in the key sequence buffer
8645 are the key that we have scanned so far.
8646 Those events are the ones that we will replace
8647 if PARENT maps them into a key sequence. */
8651 /* Lookup KEY in MAP.
8652 MAP is a keymap mapping keys to key vectors or functions.
8653 If the mapping is a function and DO_FUNCALL is true,
8654 the function is called with PROMPT as parameter and its return
8655 value is used as the return value of this function (after checking
8656 that it is indeed a vector). */
8659 access_keymap_keyremap (Lisp_Object map
, Lisp_Object key
, Lisp_Object prompt
,
8664 next
= access_keymap (map
, key
, 1, 0, 1);
8666 /* Handle a symbol whose function definition is a keymap
8668 if (SYMBOLP (next
) && !NILP (Ffboundp (next
))
8669 && (ARRAYP (XSYMBOL (next
)->function
)
8670 || KEYMAPP (XSYMBOL (next
)->function
)))
8671 next
= Fautoload_do_load (XSYMBOL (next
)->function
, next
, Qnil
);
8673 /* If the keymap gives a function, not an
8674 array, then call the function with one arg and use
8675 its value instead. */
8676 if (do_funcall
&& FUNCTIONP (next
))
8681 next
= call1 (next
, prompt
);
8682 /* If the function returned something invalid,
8683 barf--don't ignore it. */
8684 if (! (NILP (next
) || VECTORP (next
) || STRINGP (next
)))
8685 error ("Function %s returns invalid key sequence",
8686 SSDATA (SYMBOL_NAME (tem
)));
8691 /* Do one step of the key remapping used for function-key-map and
8692 key-translation-map:
8693 KEYBUF is the buffer holding the input events.
8694 BUFSIZE is its maximum size.
8695 FKEY is a pointer to the keyremap structure to use.
8696 INPUT is the index of the last element in KEYBUF.
8697 DOIT if true says that the remapping can actually take place.
8698 DIFF is used to return the number of keys added/removed by the remapping.
8699 PARENT is the root of the keymap.
8700 PROMPT is the prompt to use if the remapping happens through a function.
8701 Return true if the remapping actually took place. */
8704 keyremap_step (Lisp_Object
*keybuf
, int bufsize
, volatile keyremap
*fkey
,
8705 int input
, bool doit
, int *diff
, Lisp_Object prompt
)
8707 Lisp_Object next
, key
;
8709 key
= keybuf
[fkey
->end
++];
8711 if (KEYMAPP (fkey
->parent
))
8712 next
= access_keymap_keyremap (fkey
->map
, key
, prompt
, doit
);
8716 /* If keybuf[fkey->start..fkey->end] is bound in the
8717 map and we're in a position to do the key remapping, replace it with
8718 the binding and restart with fkey->start at the end. */
8719 if ((VECTORP (next
) || STRINGP (next
)) && doit
)
8721 int len
= XFASTINT (Flength (next
));
8724 *diff
= len
- (fkey
->end
- fkey
->start
);
8726 if (bufsize
- input
<= *diff
)
8727 error ("Key sequence too long");
8729 /* Shift the keys that follow fkey->end. */
8731 for (i
= fkey
->end
; i
< input
; i
++)
8732 keybuf
[i
+ *diff
] = keybuf
[i
];
8734 for (i
= input
- 1; i
>= fkey
->end
; i
--)
8735 keybuf
[i
+ *diff
] = keybuf
[i
];
8736 /* Overwrite the old keys with the new ones. */
8737 for (i
= 0; i
< len
; i
++)
8738 keybuf
[fkey
->start
+ i
]
8739 = Faref (next
, make_number (i
));
8741 fkey
->start
= fkey
->end
+= *diff
;
8742 fkey
->map
= fkey
->parent
;
8747 fkey
->map
= get_keymap (next
, 0, 1);
8749 /* If we no longer have a bound suffix, try a new position for
8751 if (!CONSP (fkey
->map
))
8753 fkey
->end
= ++fkey
->start
;
8754 fkey
->map
= fkey
->parent
;
8760 test_undefined (Lisp_Object binding
)
8762 return (NILP (binding
)
8763 || EQ (binding
, Qundefined
)
8764 || (SYMBOLP (binding
)
8765 && EQ (Fcommand_remapping (binding
, Qnil
, Qnil
), Qundefined
)));
8768 /* Read a sequence of keys that ends with a non prefix character,
8769 storing it in KEYBUF, a buffer of size BUFSIZE.
8771 Return the length of the key sequence stored.
8772 Return -1 if the user rejected a command menu.
8774 Echo starting immediately unless `prompt' is 0.
8776 If PREVENT_REDISPLAY is non-zero, avoid redisplay by calling
8777 read_char with a suitable COMMANDFLAG argument.
8779 Where a key sequence ends depends on the currently active keymaps.
8780 These include any minor mode keymaps active in the current buffer,
8781 the current buffer's local map, and the global map.
8783 If a key sequence has no other bindings, we check Vfunction_key_map
8784 to see if some trailing subsequence might be the beginning of a
8785 function key's sequence. If so, we try to read the whole function
8786 key, and substitute its symbolic name into the key sequence.
8788 We ignore unbound `down-' mouse clicks. We turn unbound `drag-' and
8789 `double-' events into similar click events, if that would make them
8790 bound. We try to turn `triple-' events first into `double-' events,
8793 If we get a mouse click in a mode line, vertical divider, or other
8794 non-text area, we treat the click as if it were prefixed by the
8795 symbol denoting that area - `mode-line', `vertical-line', or
8798 If the sequence starts with a mouse click, we read the key sequence
8799 with respect to the buffer clicked on, not the current buffer.
8801 If the user switches frames in the midst of a key sequence, we put
8802 off the switch-frame event until later; the next call to
8803 read_char will return it.
8805 If FIX_CURRENT_BUFFER, we restore current_buffer
8806 from the selected window's buffer. */
8809 read_key_sequence (Lisp_Object
*keybuf
, int bufsize
, Lisp_Object prompt
,
8810 bool dont_downcase_last
, bool can_return_switch_frame
,
8811 bool fix_current_buffer
, bool prevent_redisplay
)
8813 ptrdiff_t count
= SPECPDL_INDEX ();
8815 /* How many keys there are in the current key sequence. */
8818 /* The length of the echo buffer when we started reading, and
8819 the length of this_command_keys when we started reading. */
8820 ptrdiff_t echo_start
IF_LINT (= 0);
8821 ptrdiff_t keys_start
;
8823 Lisp_Object current_binding
= Qnil
;
8824 Lisp_Object first_event
= Qnil
;
8826 /* Index of the first key that has no binding.
8827 It is useless to try fkey.start larger than that. */
8830 /* If t < mock_input, then KEYBUF[t] should be read as the next
8833 We use this to recover after recognizing a function key. Once we
8834 realize that a suffix of the current key sequence is actually a
8835 function key's escape sequence, we replace the suffix with the
8836 function key's binding from Vfunction_key_map. Now keybuf
8837 contains a new and different key sequence, so the echo area,
8838 this_command_keys, and the submaps and defs arrays are wrong. In
8839 this situation, we set mock_input to t, set t to 0, and jump to
8840 restart_sequence; the loop will read keys from keybuf up until
8841 mock_input, thus rebuilding the state; and then it will resume
8842 reading characters from the keyboard. */
8845 /* If the sequence is unbound in submaps[], then
8846 keybuf[fkey.start..fkey.end-1] is a prefix in Vfunction_key_map,
8847 and fkey.map is its binding.
8849 These might be > t, indicating that all function key scanning
8850 should hold off until t reaches them. We do this when we've just
8851 recognized a function key, to avoid searching for the function
8852 key's again in Vfunction_key_map. */
8855 /* Likewise, for key_translation_map and input-decode-map. */
8856 keyremap keytran
, indec
;
8858 /* True if we are trying to map a key by changing an upper-case
8859 letter to lower case, or a shifted function key to an unshifted
8861 bool shift_translated
= false;
8863 /* If we receive a `switch-frame' or `select-window' event in the middle of
8864 a key sequence, we put it off for later.
8865 While we're reading, we keep the event here. */
8866 Lisp_Object delayed_switch_frame
;
8868 Lisp_Object original_uppercase
IF_LINT (= Qnil
);
8869 int original_uppercase_position
= -1;
8871 /* Gets around Microsoft compiler limitations. */
8872 bool dummyflag
= false;
8874 struct buffer
*starting_buffer
;
8876 /* List of events for which a fake prefix key has been generated. */
8877 Lisp_Object fake_prefixed_keys
= Qnil
;
8879 raw_keybuf_count
= 0;
8881 last_nonmenu_event
= Qnil
;
8883 delayed_switch_frame
= Qnil
;
8889 /* Install the string PROMPT as the beginning of the string
8890 of echoing, so that it serves as a prompt for the next
8892 kset_echo_prompt (current_kboard
, prompt
);
8893 current_kboard
->immediate_echo
= false;
8896 else if (cursor_in_echo_area
8897 && echo_keystrokes_p ())
8898 /* This doesn't put in a dash if the echo buffer is empty, so
8899 you don't always see a dash hanging out in the minibuffer. */
8903 /* Record the initial state of the echo area and this_command_keys;
8904 we will need to restore them if we replay a key sequence. */
8906 echo_start
= echo_length ();
8907 keys_start
= this_command_key_count
;
8908 this_single_command_key_start
= keys_start
;
8910 /* We jump here when we need to reinitialize fkey and keytran; this
8911 happens if we switch keyboards between rescans. */
8912 replay_entire_sequence
:
8914 indec
.map
= indec
.parent
= KVAR (current_kboard
, Vinput_decode_map
);
8915 fkey
.map
= fkey
.parent
= KVAR (current_kboard
, Vlocal_function_key_map
);
8916 keytran
.map
= keytran
.parent
= Vkey_translation_map
;
8917 indec
.start
= indec
.end
= 0;
8918 fkey
.start
= fkey
.end
= 0;
8919 keytran
.start
= keytran
.end
= 0;
8921 /* We jump here when the key sequence has been thoroughly changed, and
8922 we need to rescan it starting from the beginning. When we jump here,
8923 keybuf[0..mock_input] holds the sequence we should reread. */
8926 starting_buffer
= current_buffer
;
8927 first_unbound
= bufsize
+ 1;
8929 /* Build our list of keymaps.
8930 If we recognize a function key and replace its escape sequence in
8931 keybuf with its symbol, or if the sequence starts with a mouse
8932 click and we need to switch buffers, we jump back here to rebuild
8933 the initial keymaps from the current buffer. */
8934 current_binding
= active_maps (first_event
);
8936 /* Start from the beginning in keybuf. */
8939 /* These are no-ops the first time through, but if we restart, they
8940 revert the echo area and this_command_keys to their original state. */
8941 this_command_key_count
= keys_start
;
8942 if (INTERACTIVE
&& t
< mock_input
)
8943 echo_truncate (echo_start
);
8945 /* If the best binding for the current key sequence is a keymap, or
8946 we may be looking at a function key's escape sequence, keep on
8948 while (!NILP (current_binding
)
8949 /* Keep reading as long as there's a prefix binding. */
8950 ? KEYMAPP (current_binding
)
8951 /* Don't return in the middle of a possible function key sequence,
8952 if the only bindings we found were via case conversion.
8953 Thus, if ESC O a has a function-key-map translation
8954 and ESC o has a binding, don't return after ESC O,
8955 so that we can translate ESC O plus the next character. */
8956 : (/* indec.start < t || fkey.start < t || */ keytran
.start
< t
))
8959 bool used_mouse_menu
= false;
8961 /* Where the last real key started. If we need to throw away a
8962 key that has expanded into more than one element of keybuf
8963 (say, a mouse click on the mode line which is being treated
8964 as [mode-line (mouse-...)], then we backtrack to this point
8966 int last_real_key_start
;
8968 /* These variables are analogous to echo_start and keys_start;
8969 while those allow us to restart the entire key sequence,
8970 echo_local_start and keys_local_start allow us to throw away
8972 ptrdiff_t echo_local_start
IF_LINT (= 0);
8973 int keys_local_start
;
8974 Lisp_Object new_binding
;
8976 eassert (indec
.end
== t
|| (indec
.end
> t
&& indec
.end
<= mock_input
));
8977 eassert (indec
.start
<= indec
.end
);
8978 eassert (fkey
.start
<= fkey
.end
);
8979 eassert (keytran
.start
<= keytran
.end
);
8980 /* key-translation-map is applied *after* function-key-map
8981 which is itself applied *after* input-decode-map. */
8982 eassert (fkey
.end
<= indec
.start
);
8983 eassert (keytran
.end
<= fkey
.start
);
8985 if (/* first_unbound < indec.start && first_unbound < fkey.start && */
8986 first_unbound
< keytran
.start
)
8987 { /* The prefix upto first_unbound has no binding and has
8988 no translation left to do either, so we know it's unbound.
8989 If we don't stop now, we risk staying here indefinitely
8990 (if the user keeps entering fkey or keytran prefixes
8991 like C-c ESC ESC ESC ESC ...) */
8993 for (i
= first_unbound
+ 1; i
< t
; i
++)
8994 keybuf
[i
- first_unbound
- 1] = keybuf
[i
];
8995 mock_input
= t
- first_unbound
- 1;
8996 indec
.end
= indec
.start
-= first_unbound
+ 1;
8997 indec
.map
= indec
.parent
;
8998 fkey
.end
= fkey
.start
-= first_unbound
+ 1;
8999 fkey
.map
= fkey
.parent
;
9000 keytran
.end
= keytran
.start
-= first_unbound
+ 1;
9001 keytran
.map
= keytran
.parent
;
9002 goto replay_sequence
;
9006 error ("Key sequence too long");
9009 echo_local_start
= echo_length ();
9010 keys_local_start
= this_command_key_count
;
9013 /* These are no-ops, unless we throw away a keystroke below and
9014 jumped back up to replay_key; in that case, these restore the
9015 variables to their original state, allowing us to replay the
9017 if (INTERACTIVE
&& t
< mock_input
)
9018 echo_truncate (echo_local_start
);
9019 this_command_key_count
= keys_local_start
;
9021 /* By default, assume each event is "real". */
9022 last_real_key_start
= t
;
9024 /* Does mock_input indicate that we are re-reading a key sequence? */
9028 add_command_key (key
);
9029 if (current_kboard
->immediate_echo
)
9031 /* Set immediate_echo to false so as to force echo_now to
9032 redisplay (it will set immediate_echo right back to true). */
9033 current_kboard
->immediate_echo
= false;
9038 /* If not, we should actually read a character. */
9042 KBOARD
*interrupted_kboard
= current_kboard
;
9043 struct frame
*interrupted_frame
= SELECTED_FRAME ();
9044 /* Calling read_char with COMMANDFLAG = -2 avoids
9045 redisplay in read_char and its subroutines. */
9046 key
= read_char (prevent_redisplay
? -2 : NILP (prompt
),
9047 current_binding
, last_nonmenu_event
,
9048 &used_mouse_menu
, NULL
);
9049 if ((INTEGERP (key
) && XINT (key
) == -2) /* wrong_kboard_jmpbuf */
9050 /* When switching to a new tty (with a new keyboard),
9051 read_char returns the new buffer, rather than -2
9052 (Bug#5095). This is because `terminal-init-xterm'
9053 calls read-char, which eats the wrong_kboard_jmpbuf
9054 return. Any better way to fix this? -- cyd */
9055 || (interrupted_kboard
!= current_kboard
))
9060 for (k
= all_kboards
; k
; k
= k
->next_kboard
)
9061 if (k
== interrupted_kboard
)
9066 /* Don't touch interrupted_kboard when it's been
9068 delayed_switch_frame
= Qnil
;
9069 goto replay_entire_sequence
;
9072 if (!NILP (delayed_switch_frame
))
9075 (interrupted_kboard
,
9076 Fcons (delayed_switch_frame
,
9077 KVAR (interrupted_kboard
, kbd_queue
)));
9078 delayed_switch_frame
= Qnil
;
9083 (interrupted_kboard
,
9084 Fcons (keybuf
[--t
], KVAR (interrupted_kboard
, kbd_queue
)));
9086 /* If the side queue is non-empty, ensure it begins with a
9087 switch-frame, so we'll replay it in the right context. */
9088 if (CONSP (KVAR (interrupted_kboard
, kbd_queue
))
9089 && (key
= XCAR (KVAR (interrupted_kboard
, kbd_queue
)),
9090 !(EVENT_HAS_PARAMETERS (key
)
9091 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)),
9095 XSETFRAME (frame
, interrupted_frame
);
9097 (interrupted_kboard
,
9098 Fcons (make_lispy_switch_frame (frame
),
9099 KVAR (interrupted_kboard
, kbd_queue
)));
9102 goto replay_entire_sequence
;
9106 /* read_char returns t when it shows a menu and the user rejects it.
9110 unbind_to (count
, Qnil
);
9114 /* read_char returns -1 at the end of a macro.
9115 Emacs 18 handles this by returning immediately with a
9116 zero, so that's what we'll do. */
9117 if (INTEGERP (key
) && XINT (key
) == -1)
9120 /* The Microsoft C compiler can't handle the goto that
9126 /* If the current buffer has been changed from under us, the
9127 keymap may have changed, so replay the sequence. */
9130 timer_resume_idle ();
9133 /* Reset the current buffer from the selected window
9134 in case something changed the former and not the latter.
9135 This is to be more consistent with the behavior
9136 of the command_loop_1. */
9137 if (fix_current_buffer
)
9139 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
9141 if (XBUFFER (XWINDOW (selected_window
)->contents
)
9143 Fset_buffer (XWINDOW (selected_window
)->contents
);
9146 goto replay_sequence
;
9149 /* If we have a quit that was typed in another frame, and
9150 quit_throw_to_read_char switched buffers,
9151 replay to get the right keymap. */
9153 && XINT (key
) == quit_char
9154 && current_buffer
!= starting_buffer
)
9157 ASET (raw_keybuf
, raw_keybuf_count
, key
);
9162 goto replay_sequence
;
9167 if (EVENT_HAS_PARAMETERS (key
)
9168 /* Either a `switch-frame' or a `select-window' event. */
9169 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)), Qswitch_frame
))
9171 /* If we're at the beginning of a key sequence, and the caller
9172 says it's okay, go ahead and return this event. If we're
9173 in the midst of a key sequence, delay it until the end. */
9174 if (t
> 0 || !can_return_switch_frame
)
9176 delayed_switch_frame
= key
;
9181 if (NILP (first_event
))
9184 /* Even if first_event does not specify a particular
9185 window/position, it's important to recompute the maps here
9186 since a long time might have passed since we entered
9187 read_key_sequence, and a timer (or process-filter or
9188 special-event-map, ...) might have switched the current buffer
9189 or the selected window from under us in the mean time. */
9190 if (fix_current_buffer
9191 && (XBUFFER (XWINDOW (selected_window
)->contents
)
9193 Fset_buffer (XWINDOW (selected_window
)->contents
);
9194 current_binding
= active_maps (first_event
);
9198 ASET (raw_keybuf
, raw_keybuf_count
, key
);
9202 /* Clicks in non-text areas get prefixed by the symbol
9203 in their CHAR-ADDRESS field. For example, a click on
9204 the mode line is prefixed by the symbol `mode-line'.
9206 Furthermore, key sequences beginning with mouse clicks
9207 are read using the keymaps of the buffer clicked on, not
9208 the current buffer. So we may have to switch the buffer
9211 When we turn one event into two events, we must make sure
9212 that neither of the two looks like the original--so that,
9213 if we replay the events, they won't be expanded again.
9214 If not for this, such reexpansion could happen either here
9215 or when user programs play with this-command-keys. */
9216 if (EVENT_HAS_PARAMETERS (key
))
9218 Lisp_Object kind
= EVENT_HEAD_KIND (EVENT_HEAD (key
));
9219 if (EQ (kind
, Qmouse_click
))
9221 Lisp_Object window
= POSN_WINDOW (EVENT_START (key
));
9222 Lisp_Object posn
= POSN_POSN (EVENT_START (key
));
9225 || (!NILP (fake_prefixed_keys
)
9226 && !NILP (Fmemq (key
, fake_prefixed_keys
))))
9228 /* We're looking a second time at an event for which
9229 we generated a fake prefix key. Set
9230 last_real_key_start appropriately. */
9232 last_real_key_start
= t
- 1;
9235 if (last_real_key_start
== 0)
9237 /* Key sequences beginning with mouse clicks are
9238 read using the keymaps in the buffer clicked on,
9239 not the current buffer. If we're at the
9240 beginning of a key sequence, switch buffers. */
9241 if (WINDOWP (window
)
9242 && BUFFERP (XWINDOW (window
)->contents
)
9243 && XBUFFER (XWINDOW (window
)->contents
) != current_buffer
)
9245 ASET (raw_keybuf
, raw_keybuf_count
, key
);
9250 /* Arrange to go back to the original buffer once we're
9251 done reading the key sequence. Note that we can't
9252 use save_excursion_{save,restore} here, because they
9253 save point as well as the current buffer; we don't
9254 want to save point, because redisplay may change it,
9255 to accommodate a Fset_window_start or something. We
9256 don't want to do this at the top of the function,
9257 because we may get input from a subprocess which
9258 wants to change the selected window and stuff (say,
9260 record_unwind_current_buffer ();
9262 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
9264 set_buffer_internal (XBUFFER (XWINDOW (window
)->contents
));
9265 goto replay_sequence
;
9269 /* Expand mode-line and scroll-bar events into two events:
9270 use posn as a fake prefix key. */
9272 && (NILP (fake_prefixed_keys
)
9273 || NILP (Fmemq (key
, fake_prefixed_keys
))))
9275 if (bufsize
- t
<= 1)
9276 error ("Key sequence too long");
9279 keybuf
[t
+ 1] = key
;
9282 /* Record that a fake prefix key has been generated
9283 for KEY. Don't modify the event; this would
9284 prevent proper action when the event is pushed
9285 back into unread-command-events. */
9286 fake_prefixed_keys
= Fcons (key
, fake_prefixed_keys
);
9290 else if (CONSP (XCDR (key
))
9291 && CONSP (EVENT_START (key
))
9292 && CONSP (XCDR (EVENT_START (key
))))
9296 posn
= POSN_POSN (EVENT_START (key
));
9297 /* Handle menu-bar events:
9298 insert the dummy prefix event `menu-bar'. */
9299 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
9301 if (bufsize
- t
<= 1)
9302 error ("Key sequence too long");
9304 keybuf
[t
+ 1] = key
;
9306 /* Zap the position in key, so we know that we've
9307 expanded it, and don't try to do so again. */
9308 POSN_SET_POSN (EVENT_START (key
), list1 (posn
));
9311 goto replay_sequence
;
9313 else if (CONSP (posn
))
9315 /* We're looking at the second event of a
9316 sequence which we expanded before. Set
9317 last_real_key_start appropriately. */
9318 if (last_real_key_start
== t
&& t
> 0)
9319 last_real_key_start
= t
- 1;
9324 /* We have finally decided that KEY is something we might want
9326 new_binding
= follow_key (current_binding
, key
);
9328 /* If KEY wasn't bound, we'll try some fallbacks. */
9329 if (!NILP (new_binding
))
9330 /* This is needed for the following scenario:
9331 event 0: a down-event that gets dropped by calling replay_key.
9332 event 1: some normal prefix like C-h.
9333 After event 0, first_unbound is 0, after event 1 indec.start,
9334 fkey.start, and keytran.start are all 1, so when we see that
9335 C-h is bound, we need to update first_unbound. */
9336 first_unbound
= max (t
+ 1, first_unbound
);
9341 /* Remember the position to put an upper bound on indec.start. */
9342 first_unbound
= min (t
, first_unbound
);
9344 head
= EVENT_HEAD (key
);
9348 Lisp_Object breakdown
;
9351 breakdown
= parse_modifiers (head
);
9352 modifiers
= XINT (XCAR (XCDR (breakdown
)));
9353 /* Attempt to reduce an unbound mouse event to a simpler
9354 event that is bound:
9355 Drags reduce to clicks.
9356 Double-clicks reduce to clicks.
9357 Triple-clicks reduce to double-clicks, then to clicks.
9358 Up/Down-clicks are eliminated.
9359 Double-downs reduce to downs, then are eliminated.
9360 Triple-downs reduce to double-downs, then to downs,
9361 then are eliminated. */
9362 if (modifiers
& (up_modifier
| down_modifier
9364 | double_modifier
| triple_modifier
))
9366 while (modifiers
& (up_modifier
| down_modifier
9368 | double_modifier
| triple_modifier
))
9370 Lisp_Object new_head
, new_click
;
9371 if (modifiers
& triple_modifier
)
9372 modifiers
^= (double_modifier
| triple_modifier
);
9373 else if (modifiers
& double_modifier
)
9374 modifiers
&= ~double_modifier
;
9375 else if (modifiers
& drag_modifier
)
9376 modifiers
&= ~drag_modifier
;
9379 /* Dispose of this `up/down' event by simply jumping
9380 back to replay_key, to get another event.
9382 Note that if this event came from mock input,
9383 then just jumping back to replay_key will just
9384 hand it to us again. So we have to wipe out any
9387 We could delete keybuf[t] and shift everything
9388 after that to the left by one spot, but we'd also
9389 have to fix up any variable that points into
9390 keybuf, and shifting isn't really necessary
9393 Adding prefixes for non-textual mouse clicks
9394 creates two characters of mock input, and both
9395 must be thrown away. If we're only looking at
9396 the prefix now, we can just jump back to
9397 replay_key. On the other hand, if we've already
9398 processed the prefix, and now the actual click
9399 itself is giving us trouble, then we've lost the
9400 state of the keymaps we want to backtrack to, and
9401 we need to replay the whole sequence to rebuild
9404 Beyond that, only function key expansion could
9405 create more than two keys, but that should never
9406 generate mouse events, so it's okay to zero
9407 mock_input in that case too.
9409 FIXME: The above paragraph seems just plain
9410 wrong, if you consider things like
9411 xterm-mouse-mode. -stef
9413 Isn't this just the most wonderful code ever? */
9415 /* If mock_input > t + 1, the above simplification
9416 will actually end up dropping keys on the floor.
9417 This is probably OK for now, but even
9418 if mock_input <= t + 1, we need to adjust indec,
9420 Typical case [header-line down-mouse-N]:
9421 mock_input = 2, t = 1, fkey.end = 1,
9422 last_real_key_start = 0. */
9423 if (indec
.end
> last_real_key_start
)
9425 indec
.end
= indec
.start
9426 = min (last_real_key_start
, indec
.start
);
9427 indec
.map
= indec
.parent
;
9428 if (fkey
.end
> last_real_key_start
)
9430 fkey
.end
= fkey
.start
9431 = min (last_real_key_start
, fkey
.start
);
9432 fkey
.map
= fkey
.parent
;
9433 if (keytran
.end
> last_real_key_start
)
9435 keytran
.end
= keytran
.start
9436 = min (last_real_key_start
, keytran
.start
);
9437 keytran
.map
= keytran
.parent
;
9441 if (t
== last_real_key_start
)
9448 mock_input
= last_real_key_start
;
9449 goto replay_sequence
;
9454 = apply_modifiers (modifiers
, XCAR (breakdown
));
9455 new_click
= list2 (new_head
, EVENT_START (key
));
9457 /* Look for a binding for this new key. */
9458 new_binding
= follow_key (current_binding
, new_click
);
9460 /* If that click is bound, go for it. */
9461 if (!NILP (new_binding
))
9463 current_binding
= new_binding
;
9467 /* Otherwise, we'll leave key set to the drag event. */
9472 current_binding
= new_binding
;
9475 /* Normally, last_nonmenu_event gets the previous key we read.
9476 But when a mouse popup menu is being used,
9477 we don't update last_nonmenu_event; it continues to hold the mouse
9478 event that preceded the first level of menu. */
9479 if (!used_mouse_menu
)
9480 last_nonmenu_event
= key
;
9482 /* Record what part of this_command_keys is the current key sequence. */
9483 this_single_command_key_start
= this_command_key_count
- t
;
9484 /* When 'input-method-function' called above causes events to be
9485 put on 'unread-post-input-method-events', and as result
9486 'reread' is set to 'true', the value of 't' can become larger
9487 than 'this_command_key_count', because 'add_command_key' is
9488 not called to update 'this_command_key_count'. If this
9489 happens, 'this_single_command_key_start' will become negative
9490 above, and any call to 'this-single-command-keys' will return
9491 a garbled vector. See bug #20223 for one such situation.
9492 Here we force 'this_single_command_key_start' to never become
9493 negative, to avoid that. */
9494 if (this_single_command_key_start
< 0)
9495 this_single_command_key_start
= 0;
9497 /* Look for this sequence in input-decode-map.
9498 Scan from indec.end until we find a bound suffix. */
9499 while (indec
.end
< t
)
9504 done
= keyremap_step (keybuf
, bufsize
, &indec
, max (t
, mock_input
),
9508 mock_input
= diff
+ max (t
, mock_input
);
9509 goto replay_sequence
;
9513 if (!KEYMAPP (current_binding
)
9514 && !test_undefined (current_binding
)
9515 && indec
.start
>= t
)
9516 /* There is a binding and it's not a prefix.
9517 (and it doesn't have any input-decode-map translation pending).
9518 There is thus no function-key in this sequence.
9519 Moving fkey.start is important in this case to allow keytran.start
9520 to go over the sequence before we return (since we keep the
9521 invariant that keytran.end <= fkey.start). */
9524 (fkey
.start
= fkey
.end
= t
, fkey
.map
= fkey
.parent
);
9527 /* If the sequence is unbound, see if we can hang a function key
9528 off the end of it. */
9529 /* Continue scan from fkey.end until we find a bound suffix. */
9530 while (fkey
.end
< indec
.start
)
9535 done
= keyremap_step (keybuf
, bufsize
, &fkey
,
9536 max (t
, mock_input
),
9537 /* If there's a binding (i.e.
9538 first_binding >= nmaps) we don't want
9539 to apply this function-key-mapping. */
9541 && (test_undefined (current_binding
)),
9545 mock_input
= diff
+ max (t
, mock_input
);
9546 /* Adjust the input-decode-map counters. */
9548 indec
.start
+= diff
;
9550 goto replay_sequence
;
9554 /* Look for this sequence in key-translation-map.
9555 Scan from keytran.end until we find a bound suffix. */
9556 while (keytran
.end
< fkey
.start
)
9561 done
= keyremap_step (keybuf
, bufsize
, &keytran
, max (t
, mock_input
),
9565 mock_input
= diff
+ max (t
, mock_input
);
9566 /* Adjust the function-key-map and input-decode-map counters. */
9568 indec
.start
+= diff
;
9572 goto replay_sequence
;
9576 /* If KEY is not defined in any of the keymaps,
9577 and cannot be part of a function key or translation,
9578 and is an upper case letter
9579 use the corresponding lower-case letter instead. */
9580 if (NILP (current_binding
)
9581 && /* indec.start >= t && fkey.start >= t && */ keytran
.start
>= t
9583 && ((CHARACTERP (make_number (XINT (key
) & ~CHAR_MODIFIER_MASK
))
9584 && uppercasep (XINT (key
) & ~CHAR_MODIFIER_MASK
))
9585 || (XINT (key
) & shift_modifier
)))
9587 Lisp_Object new_key
;
9589 original_uppercase
= key
;
9590 original_uppercase_position
= t
- 1;
9592 if (XINT (key
) & shift_modifier
)
9593 XSETINT (new_key
, XINT (key
) & ~shift_modifier
);
9595 XSETINT (new_key
, (downcase (XINT (key
) & ~CHAR_MODIFIER_MASK
)
9596 | (XINT (key
) & CHAR_MODIFIER_MASK
)));
9598 /* We have to do this unconditionally, regardless of whether
9599 the lower-case char is defined in the keymaps, because they
9600 might get translated through function-key-map. */
9601 keybuf
[t
- 1] = new_key
;
9602 mock_input
= max (t
, mock_input
);
9603 shift_translated
= true;
9605 goto replay_sequence
;
9608 if (NILP (current_binding
)
9609 && help_char_p (EVENT_HEAD (key
)) && t
> 1)
9611 read_key_sequence_cmd
= Vprefix_help_command
;
9612 /* The Microsoft C compiler can't handle the goto that
9618 /* If KEY is not defined in any of the keymaps,
9619 and cannot be part of a function key or translation,
9620 and is a shifted function key,
9621 use the corresponding unshifted function key instead. */
9622 if (NILP (current_binding
)
9623 && /* indec.start >= t && fkey.start >= t && */ keytran
.start
>= t
)
9625 Lisp_Object breakdown
= parse_modifiers (key
);
9627 = CONSP (breakdown
) ? (XINT (XCAR (XCDR (breakdown
)))) : 0;
9629 if (modifiers
& shift_modifier
9630 /* Treat uppercase keys as shifted. */
9632 && (KEY_TO_CHAR (key
)
9633 < XCHAR_TABLE (BVAR (current_buffer
, downcase_table
))->header
.size
)
9634 && uppercasep (KEY_TO_CHAR (key
))))
9637 = (modifiers
& shift_modifier
9638 ? apply_modifiers (modifiers
& ~shift_modifier
,
9640 : make_number (downcase (KEY_TO_CHAR (key
)) | modifiers
));
9642 original_uppercase
= key
;
9643 original_uppercase_position
= t
- 1;
9645 /* We have to do this unconditionally, regardless of whether
9646 the lower-case char is defined in the keymaps, because they
9647 might get translated through function-key-map. */
9648 keybuf
[t
- 1] = new_key
;
9649 mock_input
= max (t
, mock_input
);
9650 /* Reset fkey (and consequently keytran) to apply
9651 function-key-map on the result, so that S-backspace is
9652 correctly mapped to DEL (via backspace). OTOH,
9653 input-decode-map doesn't need to go through it again. */
9654 fkey
.start
= fkey
.end
= 0;
9655 keytran
.start
= keytran
.end
= 0;
9656 shift_translated
= true;
9658 goto replay_sequence
;
9663 read_key_sequence_cmd
= current_binding
;
9664 read_key_sequence_remapped
9665 /* Remap command through active keymaps.
9666 Do the remapping here, before the unbind_to so it uses the keymaps
9667 of the appropriate buffer. */
9668 = SYMBOLP (read_key_sequence_cmd
)
9669 ? Fcommand_remapping (read_key_sequence_cmd
, Qnil
, Qnil
)
9672 unread_switch_frame
= delayed_switch_frame
;
9673 unbind_to (count
, Qnil
);
9675 /* Don't downcase the last character if the caller says don't.
9676 Don't downcase it if the result is undefined, either. */
9677 if ((dont_downcase_last
|| NILP (current_binding
))
9679 && t
- 1 == original_uppercase_position
)
9681 keybuf
[t
- 1] = original_uppercase
;
9682 shift_translated
= false;
9685 if (shift_translated
)
9686 Vthis_command_keys_shift_translated
= Qt
;
9688 /* Occasionally we fabricate events, perhaps by expanding something
9689 according to function-key-map, or by adding a prefix symbol to a
9690 mouse click in the scroll bar or modeline. In this cases, return
9691 the entire generated key sequence, even if we hit an unbound
9692 prefix or a definition before the end. This means that you will
9693 be able to push back the event properly, and also means that
9694 read-key-sequence will always return a logical unit.
9697 for (; t
< mock_input
; t
++)
9698 add_command_key (keybuf
[t
]);
9705 read_key_sequence_vs (Lisp_Object prompt
, Lisp_Object continue_echo
,
9706 Lisp_Object dont_downcase_last
,
9707 Lisp_Object can_return_switch_frame
,
9708 Lisp_Object cmd_loop
, bool allow_string
)
9710 Lisp_Object keybuf
[30];
9712 ptrdiff_t count
= SPECPDL_INDEX ();
9715 CHECK_STRING (prompt
);
9718 specbind (Qinput_method_exit_on_first_char
,
9719 (NILP (cmd_loop
) ? Qt
: Qnil
));
9720 specbind (Qinput_method_use_echo_area
,
9721 (NILP (cmd_loop
) ? Qt
: Qnil
));
9723 if (NILP (continue_echo
))
9725 this_command_key_count
= 0;
9726 this_single_command_key_start
= 0;
9729 #ifdef HAVE_WINDOW_SYSTEM
9730 if (display_hourglass_p
)
9731 cancel_hourglass ();
9734 i
= read_key_sequence (keybuf
, ARRAYELTS (keybuf
),
9735 prompt
, ! NILP (dont_downcase_last
),
9736 ! NILP (can_return_switch_frame
), 0, 0);
9738 #if 0 /* The following is fine for code reading a key sequence and
9739 then proceeding with a lengthy computation, but it's not good
9740 for code reading keys in a loop, like an input method. */
9741 #ifdef HAVE_WINDOW_SYSTEM
9742 if (display_hourglass_p
)
9753 return unbind_to (count
,
9754 ((allow_string
? make_event_array
: Fvector
)
9758 DEFUN ("read-key-sequence", Fread_key_sequence
, Sread_key_sequence
, 1, 5, 0,
9759 doc
: /* Read a sequence of keystrokes and return as a string or vector.
9760 The sequence is sufficient to specify a non-prefix command in the
9761 current local and global maps.
9763 First arg PROMPT is a prompt string. If nil, do not prompt specially.
9764 Second (optional) arg CONTINUE-ECHO, if non-nil, means this key echos
9765 as a continuation of the previous key.
9767 The third (optional) arg DONT-DOWNCASE-LAST, if non-nil, means do not
9768 convert the last event to lower case. (Normally any upper case event
9769 is converted to lower case if the original event is undefined and the lower
9770 case equivalent is defined.) A non-nil value is appropriate for reading
9771 a key sequence to be defined.
9773 A C-g typed while in this function is treated like any other character,
9774 and `quit-flag' is not set.
9776 If the key sequence starts with a mouse click, then the sequence is read
9777 using the keymaps of the buffer of the window clicked in, not the buffer
9778 of the selected window as normal.
9780 `read-key-sequence' drops unbound button-down events, since you normally
9781 only care about the click or drag events which follow them. If a drag
9782 or multi-click event is unbound, but the corresponding click event would
9783 be bound, `read-key-sequence' turns the event into a click event at the
9784 drag's starting position. This means that you don't have to distinguish
9785 between click and drag, double, or triple events unless you want to.
9787 `read-key-sequence' prefixes mouse events on mode lines, the vertical
9788 lines separating windows, and scroll bars with imaginary keys
9789 `mode-line', `vertical-line', and `vertical-scroll-bar'.
9791 Optional fourth argument CAN-RETURN-SWITCH-FRAME non-nil means that this
9792 function will process a switch-frame event if the user switches frames
9793 before typing anything. If the user switches frames in the middle of a
9794 key sequence, or at the start of the sequence but CAN-RETURN-SWITCH-FRAME
9795 is nil, then the event will be put off until after the current key sequence.
9797 `read-key-sequence' checks `function-key-map' for function key
9798 sequences, where they wouldn't conflict with ordinary bindings. See
9799 `function-key-map' for more details.
9801 The optional fifth argument CMD-LOOP, if non-nil, means
9802 that this key sequence is being read by something that will
9803 read commands one after another. It should be nil if the caller
9804 will read just one key sequence. */)
9805 (Lisp_Object prompt
, Lisp_Object continue_echo
, Lisp_Object dont_downcase_last
, Lisp_Object can_return_switch_frame
, Lisp_Object cmd_loop
)
9807 return read_key_sequence_vs (prompt
, continue_echo
, dont_downcase_last
,
9808 can_return_switch_frame
, cmd_loop
, true);
9811 DEFUN ("read-key-sequence-vector", Fread_key_sequence_vector
,
9812 Sread_key_sequence_vector
, 1, 5, 0,
9813 doc
: /* Like `read-key-sequence' but always return a vector. */)
9814 (Lisp_Object prompt
, Lisp_Object continue_echo
, Lisp_Object dont_downcase_last
, Lisp_Object can_return_switch_frame
, Lisp_Object cmd_loop
)
9816 return read_key_sequence_vs (prompt
, continue_echo
, dont_downcase_last
,
9817 can_return_switch_frame
, cmd_loop
, false);
9820 /* Return true if input events are pending. */
9823 detect_input_pending (void)
9825 return input_pending
|| get_input_pending (0);
9828 /* Return true if input events other than mouse movements are
9832 detect_input_pending_ignore_squeezables (void)
9834 return input_pending
|| get_input_pending (READABLE_EVENTS_IGNORE_SQUEEZABLES
);
9837 /* Return true if input events are pending, and run any pending timers. */
9840 detect_input_pending_run_timers (bool do_display
)
9842 unsigned old_timers_run
= timers_run
;
9845 get_input_pending (READABLE_EVENTS_DO_TIMERS_NOW
);
9847 if (old_timers_run
!= timers_run
&& do_display
)
9848 redisplay_preserve_echo_area (8);
9850 return input_pending
;
9853 /* This is called in some cases before a possible quit.
9854 It cases the next call to detect_input_pending to recompute input_pending.
9855 So calling this function unnecessarily can't do any harm. */
9858 clear_input_pending (void)
9860 input_pending
= false;
9863 /* Return true if there are pending requeued events.
9864 This isn't used yet. The hope is to make wait_reading_process_output
9865 call it, and return if it runs Lisp code that unreads something.
9866 The problem is, kbd_buffer_get_event needs to be fixed to know what
9867 to do in that case. It isn't trivial. */
9870 requeued_events_pending_p (void)
9872 return (!NILP (Vunread_command_events
));
9875 DEFUN ("input-pending-p", Finput_pending_p
, Sinput_pending_p
, 0, 1, 0,
9876 doc
: /* Return t if command input is currently available with no wait.
9877 Actually, the value is nil only if we can be sure that no input is available;
9878 if there is a doubt, the value is t.
9880 If CHECK-TIMERS is non-nil, timers that are ready to run will do so. */)
9881 (Lisp_Object check_timers
)
9883 if (!NILP (Vunread_command_events
)
9884 || !NILP (Vunread_post_input_method_events
)
9885 || !NILP (Vunread_input_method_events
))
9888 /* Process non-user-visible events (Bug#10195). */
9889 process_special_events ();
9891 return (get_input_pending ((NILP (check_timers
)
9892 ? 0 : READABLE_EVENTS_DO_TIMERS_NOW
)
9893 | READABLE_EVENTS_FILTER_EVENTS
)
9897 DEFUN ("recent-keys", Frecent_keys
, Srecent_keys
, 0, 1, 0,
9898 doc
: /* Return vector of last few events, not counting those from keyboard macros.
9899 If INCLUDE-CMDS is non-nil, include the commands that were run,
9900 represented as events of the form (nil . COMMAND). */)
9901 (Lisp_Object include_cmds
)
9903 bool cmds
= !NILP (include_cmds
);
9906 || (cmds
&& total_keys
< NUM_RECENT_KEYS
))
9907 return Fvector (total_keys
,
9908 XVECTOR (recent_keys
)->contents
);
9911 Lisp_Object es
= Qnil
;
9912 int i
= (total_keys
< NUM_RECENT_KEYS
9913 ? 0 : recent_keys_index
);
9914 eassert (recent_keys_index
< NUM_RECENT_KEYS
);
9917 Lisp_Object e
= AREF (recent_keys
, i
);
9918 if (cmds
|| !CONSP (e
) || !NILP (XCAR (e
)))
9920 if (++i
>= NUM_RECENT_KEYS
)
9922 } while (i
!= recent_keys_index
);
9923 es
= Fnreverse (es
);
9924 return Fvconcat (1, &es
);
9928 DEFUN ("this-command-keys", Fthis_command_keys
, Sthis_command_keys
, 0, 0, 0,
9929 doc
: /* Return the key sequence that invoked this command.
9930 However, if the command has called `read-key-sequence', it returns
9931 the last key sequence that has been read.
9932 The value is a string or a vector.
9934 See also `this-command-keys-vector'. */)
9937 return make_event_array (this_command_key_count
,
9938 XVECTOR (this_command_keys
)->contents
);
9941 DEFUN ("this-command-keys-vector", Fthis_command_keys_vector
, Sthis_command_keys_vector
, 0, 0, 0,
9942 doc
: /* Return the key sequence that invoked this command, as a vector.
9943 However, if the command has called `read-key-sequence', it returns
9944 the last key sequence that has been read.
9946 See also `this-command-keys'. */)
9949 return Fvector (this_command_key_count
,
9950 XVECTOR (this_command_keys
)->contents
);
9953 DEFUN ("this-single-command-keys", Fthis_single_command_keys
,
9954 Sthis_single_command_keys
, 0, 0, 0,
9955 doc
: /* Return the key sequence that invoked this command.
9956 More generally, it returns the last key sequence read, either by
9957 the command loop or by `read-key-sequence'.
9958 Unlike `this-command-keys', this function's value
9959 does not include prefix arguments.
9960 The value is always a vector. */)
9963 return Fvector (this_command_key_count
9964 - this_single_command_key_start
,
9965 (XVECTOR (this_command_keys
)->contents
9966 + this_single_command_key_start
));
9969 DEFUN ("this-single-command-raw-keys", Fthis_single_command_raw_keys
,
9970 Sthis_single_command_raw_keys
, 0, 0, 0,
9971 doc
: /* Return the raw events that were read for this command.
9972 More generally, it returns the last key sequence read, either by
9973 the command loop or by `read-key-sequence'.
9974 Unlike `this-single-command-keys', this function's value
9975 shows the events before all translations (except for input methods).
9976 The value is always a vector. */)
9979 return Fvector (raw_keybuf_count
, XVECTOR (raw_keybuf
)->contents
);
9982 DEFUN ("clear-this-command-keys", Fclear_this_command_keys
,
9983 Sclear_this_command_keys
, 0, 1, 0,
9984 doc
: /* Clear out the vector that `this-command-keys' returns.
9985 Also clear the record of the last 100 events, unless optional arg
9986 KEEP-RECORD is non-nil. */)
9987 (Lisp_Object keep_record
)
9991 this_command_key_count
= 0;
9993 if (NILP (keep_record
))
9995 for (i
= 0; i
< ASIZE (recent_keys
); ++i
)
9996 ASET (recent_keys
, i
, Qnil
);
9998 recent_keys_index
= 0;
10003 DEFUN ("recursion-depth", Frecursion_depth
, Srecursion_depth
, 0, 0, 0,
10004 doc
: /* Return the current depth in recursive edits. */)
10008 /* Wrap around reliably on integer overflow. */
10009 EMACS_INT sum
= (command_loop_level
& INTMASK
) + (minibuf_level
& INTMASK
);
10010 XSETINT (temp
, sum
);
10014 DEFUN ("open-dribble-file", Fopen_dribble_file
, Sopen_dribble_file
, 1, 1,
10015 "FOpen dribble file: ",
10016 doc
: /* Start writing all keyboard characters to a dribble file called FILE.
10017 If FILE is nil, close any open dribble file.
10018 The file will be closed when Emacs exits.
10020 Be aware that this records ALL characters you type!
10021 This may include sensitive information such as passwords. */)
10034 Lisp_Object encfile
;
10036 file
= Fexpand_file_name (file
, Qnil
);
10037 encfile
= ENCODE_FILE (file
);
10038 fd
= emacs_open (SSDATA (encfile
), O_WRONLY
| O_CREAT
| O_EXCL
, 0600);
10039 if (fd
< 0 && errno
== EEXIST
&& unlink (SSDATA (encfile
)) == 0)
10040 fd
= emacs_open (SSDATA (encfile
), O_WRONLY
| O_CREAT
| O_EXCL
, 0600);
10041 dribble
= fd
< 0 ? 0 : fdopen (fd
, "w");
10043 report_file_error ("Opening dribble", file
);
10048 DEFUN ("discard-input", Fdiscard_input
, Sdiscard_input
, 0, 0, 0,
10049 doc
: /* Discard the contents of the terminal input buffer.
10050 Also end any kbd macro being defined. */)
10053 if (!NILP (KVAR (current_kboard
, defining_kbd_macro
)))
10055 /* Discard the last command from the macro. */
10056 Fcancel_kbd_macro_events ();
10060 Vunread_command_events
= Qnil
;
10062 discard_tty_input ();
10064 kbd_fetch_ptr
= kbd_store_ptr
;
10065 input_pending
= false;
10070 DEFUN ("suspend-emacs", Fsuspend_emacs
, Ssuspend_emacs
, 0, 1, "",
10071 doc
: /* Stop Emacs and return to superior process. You can resume later.
10072 If `cannot-suspend' is non-nil, or if the system doesn't support job
10073 control, run a subshell instead.
10075 If optional arg STUFFSTRING is non-nil, its characters are stuffed
10076 to be read as terminal input by Emacs's parent, after suspension.
10078 Before suspending, run the normal hook `suspend-hook'.
10079 After resumption run the normal hook `suspend-resume-hook'.
10081 Some operating systems cannot stop the Emacs process and resume it later.
10082 On such systems, Emacs starts a subshell instead of suspending. */)
10083 (Lisp_Object stuffstring
)
10085 ptrdiff_t count
= SPECPDL_INDEX ();
10086 int old_height
, old_width
;
10089 if (tty_list
&& tty_list
->next
)
10090 error ("There are other tty frames open; close them before suspending Emacs");
10092 if (!NILP (stuffstring
))
10093 CHECK_STRING (stuffstring
);
10095 run_hook (intern ("suspend-hook"));
10097 get_tty_size (fileno (CURTTY ()->input
), &old_width
, &old_height
);
10098 reset_all_sys_modes ();
10099 /* sys_suspend can get an error if it tries to fork a subshell
10100 and the system resources aren't available for that. */
10101 record_unwind_protect_void (init_all_sys_modes
);
10102 stuff_buffered_input (stuffstring
);
10103 if (cannot_suspend
)
10107 unbind_to (count
, Qnil
);
10109 /* Check if terminal/window size has changed.
10110 Note that this is not useful when we are running directly
10111 with a window system; but suspend should be disabled in that case. */
10112 get_tty_size (fileno (CURTTY ()->input
), &width
, &height
);
10113 if (width
!= old_width
|| height
!= old_height
)
10114 change_frame_size (SELECTED_FRAME (), width
,
10115 height
- FRAME_MENU_BAR_LINES (SELECTED_FRAME ()),
10118 run_hook (intern ("suspend-resume-hook"));
10123 /* If STUFFSTRING is a string, stuff its contents as pending terminal input.
10124 Then in any case stuff anything Emacs has read ahead and not used. */
10127 stuff_buffered_input (Lisp_Object stuffstring
)
10129 #ifdef SIGTSTP /* stuff_char is defined if SIGTSTP. */
10130 register unsigned char *p
;
10132 if (STRINGP (stuffstring
))
10134 register ptrdiff_t count
;
10136 p
= SDATA (stuffstring
);
10137 count
= SBYTES (stuffstring
);
10138 while (count
-- > 0)
10143 /* Anything we have read ahead, put back for the shell to read. */
10144 /* ?? What should this do when we have multiple keyboards??
10145 Should we ignore anything that was typed in at the "wrong" kboard?
10147 rms: we should stuff everything back into the kboard
10149 for (; kbd_fetch_ptr
!= kbd_store_ptr
; kbd_fetch_ptr
++)
10152 if (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
10153 kbd_fetch_ptr
= kbd_buffer
;
10154 if (kbd_fetch_ptr
->kind
== ASCII_KEYSTROKE_EVENT
)
10155 stuff_char (kbd_fetch_ptr
->ie
.code
);
10157 clear_event (kbd_fetch_ptr
);
10160 input_pending
= false;
10161 #endif /* SIGTSTP */
10165 set_waiting_for_input (struct timespec
*time_to_clear
)
10167 input_available_clear_time
= time_to_clear
;
10169 /* Tell handle_interrupt to throw back to read_char, */
10170 waiting_for_input
= true;
10172 /* If handle_interrupt was called before and buffered a C-g,
10173 make it run again now, to avoid timing error. */
10174 if (!NILP (Vquit_flag
))
10175 quit_throw_to_read_char (0);
10179 clear_waiting_for_input (void)
10181 /* Tell handle_interrupt not to throw back to read_char, */
10182 waiting_for_input
= false;
10183 input_available_clear_time
= 0;
10186 /* The SIGINT handler.
10188 If we have a frame on the controlling tty, we assume that the
10189 SIGINT was generated by C-g, so we call handle_interrupt.
10190 Otherwise, tell QUIT to kill Emacs. */
10193 handle_interrupt_signal (int sig
)
10195 /* See if we have an active terminal on our controlling tty. */
10196 struct terminal
*terminal
= get_named_terminal ("/dev/tty");
10199 /* If there are no frames there, let's pretend that we are a
10200 well-behaving UN*X program and quit. We must not call Lisp
10201 in a signal handler, so tell QUIT to exit when it is
10203 Vquit_flag
= Qkill_emacs
;
10207 /* Otherwise, the SIGINT was probably generated by C-g. */
10209 /* Set internal_last_event_frame to the top frame of the
10210 controlling tty, if we have a frame there. We disable the
10211 interrupt key on secondary ttys, so the SIGINT must have come
10212 from the controlling tty. */
10213 internal_last_event_frame
= terminal
->display_info
.tty
->top_frame
;
10215 handle_interrupt (1);
10220 deliver_interrupt_signal (int sig
)
10222 deliver_process_signal (sig
, handle_interrupt_signal
);
10225 /* Output MSG directly to standard output, without buffering. Ignore
10226 failures. This is safe in a signal handler. */
10228 write_stdout (char const *msg
)
10230 ignore_value (write (STDOUT_FILENO
, msg
, strlen (msg
)));
10233 /* Read a byte from stdin, without buffering. Safe in signal handlers. */
10238 return read (STDIN_FILENO
, &c
, 1) == 1 ? c
: EOF
;
10241 /* If Emacs is stuck because `inhibit-quit' is true, then keep track
10242 of the number of times C-g has been requested. If C-g is pressed
10243 enough times, then quit anyway. See bug#6585. */
10244 static int volatile force_quit_count
;
10246 /* This routine is called at interrupt level in response to C-g.
10248 It is called from the SIGINT handler or kbd_buffer_store_event.
10250 If `waiting_for_input' is non zero, then unless `echoing' is
10251 nonzero, immediately throw back to read_char.
10253 Otherwise it sets the Lisp variable quit-flag not-nil. This causes
10254 eval to throw, when it gets a chance. If quit-flag is already
10255 non-nil, it stops the job right away. */
10258 handle_interrupt (bool in_signal_handler
)
10264 /* XXX This code needs to be revised for multi-tty support. */
10265 if (!NILP (Vquit_flag
) && get_named_terminal ("/dev/tty"))
10267 if (! in_signal_handler
)
10269 /* If SIGINT isn't blocked, don't let us be interrupted by
10270 a SIGINT. It might be harmful due to non-reentrancy
10271 in I/O functions. */
10273 sigemptyset (&blocked
);
10274 sigaddset (&blocked
, SIGINT
);
10275 pthread_sigmask (SIG_BLOCK
, &blocked
, 0);
10279 reset_all_sys_modes ();
10283 * On systems which can suspend the current process and return to the original
10284 * shell, this command causes the user to end up back at the shell.
10285 * The "Auto-save" and "Abort" questions are not asked until
10286 * the user elects to return to emacs, at which point he can save the current
10287 * job and either dump core or continue.
10291 /* Perhaps should really fork an inferior shell?
10292 But that would not provide any way to get back
10293 to the original shell, ever. */
10294 write_stdout ("No support for stopping a process"
10295 " on this operating system;\n"
10296 "you can continue or abort.\n");
10297 #endif /* not SIGTSTP */
10299 /* We must remain inside the screen area when the internal terminal
10300 is used. Note that [Enter] is not echoed by dos. */
10301 cursor_to (SELECTED_FRAME (), 0, 0);
10303 /* It doesn't work to autosave while GC is in progress;
10304 the code used for auto-saving doesn't cope with the mark bit. */
10305 if (!gc_in_progress
)
10307 write_stdout ("Auto-save? (y or n) ");
10309 if (c
== 'y' || c
== 'Y')
10311 Fdo_auto_save (Qt
, Qnil
);
10313 write_stdout ("\r\nAuto-save done");
10315 write_stdout ("Auto-save done\n");
10323 /* During GC, it must be safe to reenable quitting again. */
10324 Vinhibit_quit
= Qnil
;
10330 "Garbage collection in progress; cannot auto-save now\r\n"
10331 "but will instead do a real quit"
10332 " after garbage collection ends\r\n");
10336 write_stdout ("\r\nAbort? (y or n) ");
10338 write_stdout ("Abort (and dump core)? (y or n) ");
10341 if (c
== 'y' || c
== 'Y')
10346 write_stdout ("\r\nContinuing...\r\n");
10347 #else /* not MSDOS */
10348 write_stdout ("Continuing...\n");
10349 #endif /* not MSDOS */
10350 init_all_sys_modes ();
10354 /* If executing a function that wants to be interrupted out of
10355 and the user has not deferred quitting by binding `inhibit-quit'
10356 then quit right away. */
10357 if (immediate_quit
&& NILP (Vinhibit_quit
))
10359 struct gl_state_s saved
;
10361 immediate_quit
= false;
10362 pthread_sigmask (SIG_SETMASK
, &empty_mask
, 0);
10364 Fsignal (Qquit
, Qnil
);
10368 { /* Else request quit when it's safe. */
10369 int count
= NILP (Vquit_flag
) ? 1 : force_quit_count
+ 1;
10370 force_quit_count
= count
;
10373 immediate_quit
= true;
10374 Vinhibit_quit
= Qnil
;
10380 pthread_sigmask (SIG_SETMASK
, &empty_mask
, 0);
10382 /* TODO: The longjmp in this call throws the NS event loop integration off,
10383 and it seems to do fine without this. Probably some attention
10384 needs to be paid to the setting of waiting_for_input in
10385 wait_reading_process_output() under HAVE_NS because of the call
10386 to ns_select there (needed because otherwise events aren't picked up
10387 outside of polling since we don't get SIGIO like X and we don't have a
10388 separate event loop thread like W32. */
10390 if (waiting_for_input
&& !echoing
)
10391 quit_throw_to_read_char (in_signal_handler
);
10395 /* Handle a C-g by making read_char return C-g. */
10398 quit_throw_to_read_char (bool from_signal
)
10400 /* When not called from a signal handler it is safe to call
10402 if (!from_signal
&& EQ (Vquit_flag
, Qkill_emacs
))
10403 Fkill_emacs (Qnil
);
10405 /* Prevent another signal from doing this before we finish. */
10406 clear_waiting_for_input ();
10407 input_pending
= false;
10409 Vunread_command_events
= Qnil
;
10411 if (FRAMEP (internal_last_event_frame
)
10412 && !EQ (internal_last_event_frame
, selected_frame
))
10413 do_switch_frame (make_lispy_switch_frame (internal_last_event_frame
),
10416 sys_longjmp (getcjmp
, 1);
10419 DEFUN ("set-input-interrupt-mode", Fset_input_interrupt_mode
,
10420 Sset_input_interrupt_mode
, 1, 1, 0,
10421 doc
: /* Set interrupt mode of reading keyboard input.
10422 If INTERRUPT is non-nil, Emacs will use input interrupts;
10423 otherwise Emacs uses CBREAK mode.
10425 See also `current-input-mode'. */)
10426 (Lisp_Object interrupt
)
10428 bool new_interrupt_input
;
10429 #ifdef USABLE_SIGIO
10430 #ifdef HAVE_X_WINDOWS
10431 if (x_display_list
!= NULL
)
10433 /* When using X, don't give the user a real choice,
10434 because we haven't implemented the mechanisms to support it. */
10435 new_interrupt_input
= true;
10438 #endif /* HAVE_X_WINDOWS */
10439 new_interrupt_input
= !NILP (interrupt
);
10440 #else /* not USABLE_SIGIO */
10441 new_interrupt_input
= false;
10442 #endif /* not USABLE_SIGIO */
10444 if (new_interrupt_input
!= interrupt_input
)
10446 #ifdef POLL_FOR_INPUT
10450 /* this causes startup screen to be restored and messes with the mouse */
10451 reset_all_sys_modes ();
10452 interrupt_input
= new_interrupt_input
;
10453 init_all_sys_modes ();
10455 interrupt_input
= new_interrupt_input
;
10458 #ifdef POLL_FOR_INPUT
10459 poll_suppress_count
= 1;
10466 DEFUN ("set-output-flow-control", Fset_output_flow_control
, Sset_output_flow_control
, 1, 2, 0,
10467 doc
: /* Enable or disable ^S/^Q flow control for output to TERMINAL.
10468 If FLOW is non-nil, flow control is enabled and you cannot use C-s or
10469 C-q in key sequences.
10471 This setting only has an effect on tty terminals and only when
10472 Emacs reads input in CBREAK mode; see `set-input-interrupt-mode'.
10474 See also `current-input-mode'. */)
10475 (Lisp_Object flow
, Lisp_Object terminal
)
10477 struct terminal
*t
= decode_tty_terminal (terminal
);
10478 struct tty_display_info
*tty
;
10482 tty
= t
->display_info
.tty
;
10484 if (tty
->flow_control
!= !NILP (flow
))
10487 /* This causes startup screen to be restored and messes with the mouse. */
10488 reset_sys_modes (tty
);
10491 tty
->flow_control
= !NILP (flow
);
10494 init_sys_modes (tty
);
10500 DEFUN ("set-input-meta-mode", Fset_input_meta_mode
, Sset_input_meta_mode
, 1, 2, 0,
10501 doc
: /* Enable or disable 8-bit input on TERMINAL.
10502 If META is t, Emacs will accept 8-bit input, and interpret the 8th
10503 bit as the Meta modifier.
10505 If META is nil, Emacs will ignore the top bit, on the assumption it is
10508 Otherwise, Emacs will accept and pass through 8-bit input without
10509 specially interpreting the top bit.
10511 This setting only has an effect on tty terminal devices.
10513 Optional parameter TERMINAL specifies the tty terminal device to use.
10514 It may be a terminal object, a frame, or nil for the terminal used by
10515 the currently selected frame.
10517 See also `current-input-mode'. */)
10518 (Lisp_Object meta
, Lisp_Object terminal
)
10520 struct terminal
*t
= decode_tty_terminal (terminal
);
10521 struct tty_display_info
*tty
;
10526 tty
= t
->display_info
.tty
;
10530 else if (EQ (meta
, Qt
))
10535 if (tty
->meta_key
!= new_meta
)
10538 /* this causes startup screen to be restored and messes with the mouse */
10539 reset_sys_modes (tty
);
10542 tty
->meta_key
= new_meta
;
10545 init_sys_modes (tty
);
10551 DEFUN ("set-quit-char", Fset_quit_char
, Sset_quit_char
, 1, 1, 0,
10552 doc
: /* Specify character used for quitting.
10553 QUIT must be an ASCII character.
10555 This function only has an effect on the controlling tty of the Emacs
10558 See also `current-input-mode'. */)
10561 struct terminal
*t
= get_named_terminal ("/dev/tty");
10562 struct tty_display_info
*tty
;
10566 tty
= t
->display_info
.tty
;
10568 if (NILP (quit
) || !INTEGERP (quit
) || XINT (quit
) < 0 || XINT (quit
) > 0400)
10569 error ("QUIT must be an ASCII character");
10572 /* this causes startup screen to be restored and messes with the mouse */
10573 reset_sys_modes (tty
);
10576 /* Don't let this value be out of range. */
10577 quit_char
= XINT (quit
) & (tty
->meta_key
== 0 ? 0177 : 0377);
10580 init_sys_modes (tty
);
10586 DEFUN ("set-input-mode", Fset_input_mode
, Sset_input_mode
, 3, 4, 0,
10587 doc
: /* Set mode of reading keyboard input.
10588 First arg INTERRUPT non-nil means use input interrupts;
10589 nil means use CBREAK mode.
10590 Second arg FLOW non-nil means use ^S/^Q flow control for output to terminal
10591 (no effect except in CBREAK mode).
10592 Third arg META t means accept 8-bit input (for a Meta key).
10593 META nil means ignore the top bit, on the assumption it is parity.
10594 Otherwise, accept 8-bit input and don't use the top bit for Meta.
10595 Optional fourth arg QUIT if non-nil specifies character to use for quitting.
10596 See also `current-input-mode'. */)
10597 (Lisp_Object interrupt
, Lisp_Object flow
, Lisp_Object meta
, Lisp_Object quit
)
10599 Fset_input_interrupt_mode (interrupt
);
10600 Fset_output_flow_control (flow
, Qnil
);
10601 Fset_input_meta_mode (meta
, Qnil
);
10603 Fset_quit_char (quit
);
10607 DEFUN ("current-input-mode", Fcurrent_input_mode
, Scurrent_input_mode
, 0, 0, 0,
10608 doc
: /* Return information about the way Emacs currently reads keyboard input.
10609 The value is a list of the form (INTERRUPT FLOW META QUIT), where
10610 INTERRUPT is non-nil if Emacs is using interrupt-driven input; if
10611 nil, Emacs is using CBREAK mode.
10612 FLOW is non-nil if Emacs uses ^S/^Q flow control for output to the
10613 terminal; this does not apply if Emacs uses interrupt-driven input.
10614 META is t if accepting 8-bit input with 8th bit as Meta flag.
10615 META nil means ignoring the top bit, on the assumption it is parity.
10616 META is neither t nor nil if accepting 8-bit input and using
10617 all 8 bits as the character code.
10618 QUIT is the character Emacs currently uses to quit.
10619 The elements of this list correspond to the arguments of
10620 `set-input-mode'. */)
10623 struct frame
*sf
= XFRAME (selected_frame
);
10625 Lisp_Object interrupt
= interrupt_input
? Qt
: Qnil
;
10626 Lisp_Object flow
, meta
;
10627 if (FRAME_TERMCAP_P (sf
) || FRAME_MSDOS_P (sf
))
10629 flow
= FRAME_TTY (sf
)->flow_control
? Qt
: Qnil
;
10630 meta
= (FRAME_TTY (sf
)->meta_key
== 2
10632 : (CURTTY ()->meta_key
== 1 ? Qt
: Qnil
));
10639 Lisp_Object quit
= make_number (quit_char
);
10641 return list4 (interrupt
, flow
, meta
, quit
);
10644 DEFUN ("posn-at-x-y", Fposn_at_x_y
, Sposn_at_x_y
, 2, 4, 0,
10645 doc
: /* Return position information for pixel coordinates X and Y.
10646 By default, X and Y are relative to text area of the selected window.
10647 Optional third arg FRAME-OR-WINDOW non-nil specifies frame or window.
10648 If optional fourth arg WHOLE is non-nil, X is relative to the left
10649 edge of the window.
10651 The return value is similar to a mouse click position:
10652 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
10653 IMAGE (DX . DY) (WIDTH . HEIGHT))
10654 The `posn-' functions access elements of such lists. */)
10655 (Lisp_Object x
, Lisp_Object y
, Lisp_Object frame_or_window
, Lisp_Object whole
)
10658 /* We allow X of -1, for the newline in a R2L line that overflowed
10659 into the left fringe. */
10660 if (XINT (x
) != -1)
10664 if (NILP (frame_or_window
))
10665 frame_or_window
= selected_window
;
10667 if (WINDOWP (frame_or_window
))
10669 struct window
*w
= decode_live_window (frame_or_window
);
10671 XSETINT (x
, (XINT (x
)
10672 + WINDOW_LEFT_EDGE_X (w
)
10674 ? window_box_left_offset (w
, TEXT_AREA
)
10676 XSETINT (y
, WINDOW_TO_FRAME_PIXEL_Y (w
, XINT (y
)));
10677 frame_or_window
= w
->frame
;
10680 CHECK_LIVE_FRAME (frame_or_window
);
10682 return make_lispy_position (XFRAME (frame_or_window
), x
, y
, 0);
10685 DEFUN ("posn-at-point", Fposn_at_point
, Sposn_at_point
, 0, 2, 0,
10686 doc
: /* Return position information for buffer POS in WINDOW.
10687 POS defaults to point in WINDOW; WINDOW defaults to the selected window.
10689 Return nil if position is not visible in window. Otherwise,
10690 the return value is similar to that returned by `event-start' for
10691 a mouse click at the upper left corner of the glyph corresponding
10692 to the given buffer position:
10693 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
10694 IMAGE (DX . DY) (WIDTH . HEIGHT))
10695 The `posn-' functions access elements of such lists. */)
10696 (Lisp_Object pos
, Lisp_Object window
)
10701 window
= selected_window
;
10703 tem
= Fpos_visible_in_window_p (pos
, window
, Qt
);
10706 Lisp_Object x
= XCAR (tem
);
10707 Lisp_Object y
= XCAR (XCDR (tem
));
10709 /* Point invisible due to hscrolling? X can be -1 when a
10710 newline in a R2L line overflows into the left fringe. */
10713 tem
= Fposn_at_x_y (x
, y
, window
, Qnil
);
10719 /* Set up a new kboard object with reasonable initial values.
10720 TYPE is a window system for which this keyboard is used. */
10723 init_kboard (KBOARD
*kb
, Lisp_Object type
)
10725 kset_overriding_terminal_local_map (kb
, Qnil
);
10726 kset_last_command (kb
, Qnil
);
10727 kset_real_last_command (kb
, Qnil
);
10728 kset_keyboard_translate_table (kb
, Qnil
);
10729 kset_last_repeatable_command (kb
, Qnil
);
10730 kset_prefix_arg (kb
, Qnil
);
10731 kset_last_prefix_arg (kb
, Qnil
);
10732 kset_kbd_queue (kb
, Qnil
);
10733 kb
->kbd_queue_has_data
= false;
10734 kb
->immediate_echo
= false;
10735 kset_echo_string (kb
, Qnil
);
10736 kset_echo_prompt (kb
, Qnil
);
10737 kb
->kbd_macro_buffer
= 0;
10738 kb
->kbd_macro_bufsize
= 0;
10739 kset_defining_kbd_macro (kb
, Qnil
);
10740 kset_last_kbd_macro (kb
, Qnil
);
10741 kb
->reference_count
= 0;
10742 kset_system_key_alist (kb
, Qnil
);
10743 kset_system_key_syms (kb
, Qnil
);
10744 kset_window_system (kb
, type
);
10745 kset_input_decode_map (kb
, Fmake_sparse_keymap (Qnil
));
10746 kset_local_function_key_map (kb
, Fmake_sparse_keymap (Qnil
));
10747 Fset_keymap_parent (KVAR (kb
, Vlocal_function_key_map
), Vfunction_key_map
);
10748 kset_default_minibuffer_frame (kb
, Qnil
);
10751 /* Allocate and basically initialize keyboard
10752 object to use with window system TYPE. */
10755 allocate_kboard (Lisp_Object type
)
10757 KBOARD
*kb
= xmalloc (sizeof *kb
);
10759 init_kboard (kb
, type
);
10760 kb
->next_kboard
= all_kboards
;
10766 * Destroy the contents of a kboard object, but not the object itself.
10767 * We use this just before deleting it, or if we're going to initialize
10768 * it a second time.
10771 wipe_kboard (KBOARD
*kb
)
10773 xfree (kb
->kbd_macro_buffer
);
10776 /* Free KB and memory referenced from it. */
10779 delete_kboard (KBOARD
*kb
)
10783 for (kbp
= &all_kboards
; *kbp
!= kb
; kbp
= &(*kbp
)->next_kboard
)
10786 *kbp
= kb
->next_kboard
;
10788 /* Prevent a dangling reference to KB. */
10789 if (kb
== current_kboard
10790 && FRAMEP (selected_frame
)
10791 && FRAME_LIVE_P (XFRAME (selected_frame
)))
10793 current_kboard
= FRAME_KBOARD (XFRAME (selected_frame
));
10794 single_kboard
= false;
10795 if (current_kboard
== kb
)
10804 init_keyboard (void)
10806 /* This is correct before outermost invocation of the editor loop. */
10807 command_loop_level
= -1;
10808 immediate_quit
= false;
10809 quit_char
= Ctl ('g');
10810 Vunread_command_events
= Qnil
;
10811 timer_idleness_start_time
= invalid_timespec ();
10813 recent_keys_index
= 0;
10814 kbd_fetch_ptr
= kbd_buffer
;
10815 kbd_store_ptr
= kbd_buffer
;
10816 do_mouse_tracking
= Qnil
;
10817 input_pending
= false;
10818 interrupt_input_blocked
= 0;
10819 pending_signals
= false;
10821 /* This means that command_loop_1 won't try to select anything the first
10823 internal_last_event_frame
= Qnil
;
10824 Vlast_event_frame
= internal_last_event_frame
;
10826 current_kboard
= initial_kboard
;
10827 /* Re-initialize the keyboard again. */
10828 wipe_kboard (current_kboard
);
10829 /* A value of nil for Vwindow_system normally means a tty, but we also use
10830 it for the initial terminal since there is no window system there. */
10831 init_kboard (current_kboard
, Qnil
);
10833 if (!noninteractive
)
10835 /* Before multi-tty support, these handlers used to be installed
10836 only if the current session was a tty session. Now an Emacs
10837 session may have multiple display types, so we always handle
10838 SIGINT. There is special code in handle_interrupt_signal to exit
10839 Emacs on SIGINT when there are no termcap frames on the
10840 controlling terminal. */
10841 struct sigaction action
;
10842 emacs_sigaction_init (&action
, deliver_interrupt_signal
);
10843 sigaction (SIGINT
, &action
, 0);
10845 /* For systems with SysV TERMIO, C-g is set up for both SIGINT and
10846 SIGQUIT and we can't tell which one it will give us. */
10847 sigaction (SIGQUIT
, &action
, 0);
10848 #endif /* not DOS_NT */
10850 #ifdef USABLE_SIGIO
10851 if (!noninteractive
)
10853 struct sigaction action
;
10854 emacs_sigaction_init (&action
, deliver_input_available_signal
);
10855 sigaction (SIGIO
, &action
, 0);
10859 /* Use interrupt input by default, if it works and noninterrupt input
10860 has deficiencies. */
10862 #ifdef INTERRUPT_INPUT
10863 interrupt_input
= 1;
10865 interrupt_input
= 0;
10868 pthread_sigmask (SIG_SETMASK
, &empty_mask
, 0);
10871 if (keyboard_init_hook
)
10872 (*keyboard_init_hook
) ();
10874 #ifdef POLL_FOR_INPUT
10876 poll_suppress_count
= 1;
10881 /* This type's only use is in syms_of_keyboard, to put properties on the
10882 event header symbols. */
10889 static const struct event_head head_table
[] = {
10890 {SYMBOL_INDEX (Qmouse_movement
), SYMBOL_INDEX (Qmouse_movement
)},
10891 {SYMBOL_INDEX (Qscroll_bar_movement
), SYMBOL_INDEX (Qmouse_movement
)},
10893 /* Some of the event heads. */
10894 {SYMBOL_INDEX (Qswitch_frame
), SYMBOL_INDEX (Qswitch_frame
)},
10896 {SYMBOL_INDEX (Qfocus_in
), SYMBOL_INDEX (Qfocus_in
)},
10897 {SYMBOL_INDEX (Qfocus_out
), SYMBOL_INDEX (Qfocus_out
)},
10898 {SYMBOL_INDEX (Qdelete_frame
), SYMBOL_INDEX (Qdelete_frame
)},
10899 {SYMBOL_INDEX (Qiconify_frame
), SYMBOL_INDEX (Qiconify_frame
)},
10900 {SYMBOL_INDEX (Qmake_frame_visible
), SYMBOL_INDEX (Qmake_frame_visible
)},
10901 /* `select-window' should be handled just like `switch-frame'
10902 in read_key_sequence. */
10903 {SYMBOL_INDEX (Qselect_window
), SYMBOL_INDEX (Qswitch_frame
)}
10907 syms_of_keyboard (void)
10909 pending_funcalls
= Qnil
;
10910 staticpro (&pending_funcalls
);
10912 Vlispy_mouse_stem
= build_pure_c_string ("mouse");
10913 staticpro (&Vlispy_mouse_stem
);
10915 regular_top_level_message
= build_pure_c_string ("Back to top level");
10916 #ifdef HAVE_STACK_OVERFLOW_HANDLING
10917 recover_top_level_message
10918 = build_pure_c_string ("Re-entering top level after C stack overflow");
10920 DEFVAR_LISP ("internal--top-level-message", Vinternal__top_level_message
,
10921 doc
: /* Message displayed by `normal-top-level'. */);
10922 Vinternal__top_level_message
= regular_top_level_message
;
10925 DEFSYM (QCimage
, ":image");
10926 DEFSYM (Qhelp_echo
, "help-echo");
10927 DEFSYM (QCrtl
, ":rtl");
10929 staticpro (&item_properties
);
10930 item_properties
= Qnil
;
10932 staticpro (&tool_bar_item_properties
);
10933 tool_bar_item_properties
= Qnil
;
10934 staticpro (&tool_bar_items_vector
);
10935 tool_bar_items_vector
= Qnil
;
10937 DEFSYM (Qtimer_event_handler
, "timer-event-handler");
10939 /* Non-nil disable property on a command means do not execute it;
10940 call disabled-command-function's value instead. */
10941 DEFSYM (Qdisabled
, "disabled");
10943 DEFSYM (Qundefined
, "undefined");
10945 /* Hooks to run before and after each command. */
10946 DEFSYM (Qpre_command_hook
, "pre-command-hook");
10947 DEFSYM (Qpost_command_hook
, "post-command-hook");
10949 DEFSYM (Qundo_auto__add_boundary
, "undo-auto--add-boundary");
10951 DEFSYM (Qdeferred_action_function
, "deferred-action-function");
10952 DEFSYM (Qdelayed_warnings_hook
, "delayed-warnings-hook");
10953 DEFSYM (Qfunction_key
, "function-key");
10955 /* The values of Qevent_kind properties. */
10956 DEFSYM (Qmouse_click
, "mouse-click");
10958 DEFSYM (Qdrag_n_drop
, "drag-n-drop");
10959 DEFSYM (Qsave_session
, "save-session");
10960 DEFSYM (Qconfig_changed_event
, "config-changed-event");
10962 /* Menu and tool bar item parts. */
10963 DEFSYM (Qmenu_enable
, "menu-enable");
10966 DEFSYM (Qlanguage_change
, "language-change");
10970 DEFSYM (Qdbus_event
, "dbus-event");
10973 #ifdef HAVE_XWIDGETS
10974 DEFSYM (Qxwidget_event
, "xwidget-event");
10977 #ifdef USE_FILE_NOTIFY
10978 DEFSYM (Qfile_notify
, "file-notify");
10979 #endif /* USE_FILE_NOTIFY */
10981 /* Menu and tool bar item parts. */
10982 DEFSYM (QCenable
, ":enable");
10983 DEFSYM (QCvisible
, ":visible");
10984 DEFSYM (QChelp
, ":help");
10985 DEFSYM (QCfilter
, ":filter");
10986 DEFSYM (QCbutton
, ":button");
10987 DEFSYM (QCkeys
, ":keys");
10988 DEFSYM (QCkey_sequence
, ":key-sequence");
10990 /* Non-nil disable property on a command means
10991 do not execute it; call disabled-command-function's value instead. */
10992 DEFSYM (QCtoggle
, ":toggle");
10993 DEFSYM (QCradio
, ":radio");
10994 DEFSYM (QClabel
, ":label");
10995 DEFSYM (QCvert_only
, ":vert-only");
10997 /* Symbols to use for parts of windows. */
10998 DEFSYM (Qvertical_line
, "vertical-line");
10999 DEFSYM (Qright_divider
, "right-divider");
11000 DEFSYM (Qbottom_divider
, "bottom-divider");
11002 DEFSYM (Qmouse_fixup_help_message
, "mouse-fixup-help-message");
11004 DEFSYM (Qabove_handle
, "above-handle");
11005 DEFSYM (Qhandle
, "handle");
11006 DEFSYM (Qbelow_handle
, "below-handle");
11007 DEFSYM (Qup
, "up");
11008 DEFSYM (Qdown
, "down");
11009 DEFSYM (Qtop
, "top");
11010 DEFSYM (Qbottom
, "bottom");
11011 DEFSYM (Qend_scroll
, "end-scroll");
11012 DEFSYM (Qratio
, "ratio");
11013 DEFSYM (Qbefore_handle
, "before-handle");
11014 DEFSYM (Qhorizontal_handle
, "horizontal-handle");
11015 DEFSYM (Qafter_handle
, "after-handle");
11016 DEFSYM (Qleft
, "left");
11017 DEFSYM (Qright
, "right");
11018 DEFSYM (Qleftmost
, "leftmost");
11019 DEFSYM (Qrightmost
, "rightmost");
11021 /* Properties of event headers. */
11022 DEFSYM (Qevent_kind
, "event-kind");
11023 DEFSYM (Qevent_symbol_elements
, "event-symbol-elements");
11025 /* An event header symbol HEAD may have a property named
11026 Qevent_symbol_element_mask, which is of the form (BASE MODIFIERS);
11027 BASE is the base, unmodified version of HEAD, and MODIFIERS is the
11028 mask of modifiers applied to it. If present, this is used to help
11029 speed up parse_modifiers. */
11030 DEFSYM (Qevent_symbol_element_mask
, "event-symbol-element-mask");
11032 /* An unmodified event header BASE may have a property named
11033 Qmodifier_cache, which is an alist mapping modifier masks onto
11034 modified versions of BASE. If present, this helps speed up
11035 apply_modifiers. */
11036 DEFSYM (Qmodifier_cache
, "modifier-cache");
11038 DEFSYM (Qrecompute_lucid_menubar
, "recompute-lucid-menubar");
11039 DEFSYM (Qactivate_menubar_hook
, "activate-menubar-hook");
11041 DEFSYM (Qpolling_period
, "polling-period");
11043 DEFSYM (Qgui_set_selection
, "gui-set-selection");
11045 /* The primary selection. */
11046 DEFSYM (QPRIMARY
, "PRIMARY");
11048 DEFSYM (Qhandle_switch_frame
, "handle-switch-frame");
11049 DEFSYM (Qhandle_select_window
, "handle-select-window");
11051 DEFSYM (Qinput_method_exit_on_first_char
, "input-method-exit-on-first-char");
11052 DEFSYM (Qinput_method_use_echo_area
, "input-method-use-echo-area");
11054 DEFSYM (Qhelp_form_show
, "help-form-show");
11056 DEFSYM (Qecho_keystrokes
, "echo-keystrokes");
11058 Fset (Qinput_method_exit_on_first_char
, Qnil
);
11059 Fset (Qinput_method_use_echo_area
, Qnil
);
11061 /* Symbols to head events. */
11062 DEFSYM (Qmouse_movement
, "mouse-movement");
11063 DEFSYM (Qscroll_bar_movement
, "scroll-bar-movement");
11064 DEFSYM (Qswitch_frame
, "switch-frame");
11065 DEFSYM (Qfocus_in
, "focus-in");
11066 DEFSYM (Qfocus_out
, "focus-out");
11067 DEFSYM (Qdelete_frame
, "delete-frame");
11068 DEFSYM (Qiconify_frame
, "iconify-frame");
11069 DEFSYM (Qmake_frame_visible
, "make-frame-visible");
11070 DEFSYM (Qselect_window
, "select-window");
11074 for (i
= 0; i
< ARRAYELTS (head_table
); i
++)
11076 const struct event_head
*p
= &head_table
[i
];
11077 Lisp_Object var
= builtin_lisp_symbol (p
->var
);
11078 Lisp_Object kind
= builtin_lisp_symbol (p
->kind
);
11079 Fput (var
, Qevent_kind
, kind
);
11080 Fput (var
, Qevent_symbol_elements
, list1 (var
));
11084 button_down_location
= Fmake_vector (make_number (5), Qnil
);
11085 staticpro (&button_down_location
);
11086 mouse_syms
= Fmake_vector (make_number (5), Qnil
);
11087 staticpro (&mouse_syms
);
11088 wheel_syms
= Fmake_vector (make_number (ARRAYELTS (lispy_wheel_names
)),
11090 staticpro (&wheel_syms
);
11094 int len
= ARRAYELTS (modifier_names
);
11096 modifier_symbols
= Fmake_vector (make_number (len
), Qnil
);
11097 for (i
= 0; i
< len
; i
++)
11098 if (modifier_names
[i
])
11099 ASET (modifier_symbols
, i
, intern_c_string (modifier_names
[i
]));
11100 staticpro (&modifier_symbols
);
11103 recent_keys
= Fmake_vector (make_number (NUM_RECENT_KEYS
), Qnil
);
11104 staticpro (&recent_keys
);
11106 this_command_keys
= Fmake_vector (make_number (40), Qnil
);
11107 staticpro (&this_command_keys
);
11109 raw_keybuf
= Fmake_vector (make_number (30), Qnil
);
11110 staticpro (&raw_keybuf
);
11112 DEFSYM (Qcommand_execute
, "command-execute");
11113 DEFSYM (Qinternal_echo_keystrokes_prefix
, "internal-echo-keystrokes-prefix");
11115 accent_key_syms
= Qnil
;
11116 staticpro (&accent_key_syms
);
11118 func_key_syms
= Qnil
;
11119 staticpro (&func_key_syms
);
11121 drag_n_drop_syms
= Qnil
;
11122 staticpro (&drag_n_drop_syms
);
11124 unread_switch_frame
= Qnil
;
11125 staticpro (&unread_switch_frame
);
11127 internal_last_event_frame
= Qnil
;
11128 staticpro (&internal_last_event_frame
);
11130 read_key_sequence_cmd
= Qnil
;
11131 staticpro (&read_key_sequence_cmd
);
11132 read_key_sequence_remapped
= Qnil
;
11133 staticpro (&read_key_sequence_remapped
);
11135 menu_bar_one_keymap_changed_items
= Qnil
;
11136 staticpro (&menu_bar_one_keymap_changed_items
);
11138 menu_bar_items_vector
= Qnil
;
11139 staticpro (&menu_bar_items_vector
);
11141 help_form_saved_window_configs
= Qnil
;
11142 staticpro (&help_form_saved_window_configs
);
11144 defsubr (&Scurrent_idle_time
);
11145 defsubr (&Sevent_symbol_parse_modifiers
);
11146 defsubr (&Sevent_convert_list
);
11147 defsubr (&Sread_key_sequence
);
11148 defsubr (&Sread_key_sequence_vector
);
11149 defsubr (&Srecursive_edit
);
11150 defsubr (&Strack_mouse
);
11151 defsubr (&Sinput_pending_p
);
11152 defsubr (&Srecent_keys
);
11153 defsubr (&Sthis_command_keys
);
11154 defsubr (&Sthis_command_keys_vector
);
11155 defsubr (&Sthis_single_command_keys
);
11156 defsubr (&Sthis_single_command_raw_keys
);
11157 defsubr (&Sclear_this_command_keys
);
11158 defsubr (&Ssuspend_emacs
);
11159 defsubr (&Sabort_recursive_edit
);
11160 defsubr (&Sexit_recursive_edit
);
11161 defsubr (&Srecursion_depth
);
11162 defsubr (&Scommand_error_default_function
);
11163 defsubr (&Stop_level
);
11164 defsubr (&Sdiscard_input
);
11165 defsubr (&Sopen_dribble_file
);
11166 defsubr (&Sset_input_interrupt_mode
);
11167 defsubr (&Sset_output_flow_control
);
11168 defsubr (&Sset_input_meta_mode
);
11169 defsubr (&Sset_quit_char
);
11170 defsubr (&Sset_input_mode
);
11171 defsubr (&Scurrent_input_mode
);
11172 defsubr (&Sposn_at_point
);
11173 defsubr (&Sposn_at_x_y
);
11175 DEFVAR_LISP ("last-command-event", last_command_event
,
11176 doc
: /* Last input event that was part of a command. */);
11178 DEFVAR_LISP ("last-nonmenu-event", last_nonmenu_event
,
11179 doc
: /* Last input event in a command, except for mouse menu events.
11180 Mouse menus give back keys that don't look like mouse events;
11181 this variable holds the actual mouse event that led to the menu,
11182 so that you can determine whether the command was run by mouse or not. */);
11184 DEFVAR_LISP ("last-input-event", last_input_event
,
11185 doc
: /* Last input event. */);
11187 DEFVAR_LISP ("unread-command-events", Vunread_command_events
,
11188 doc
: /* List of events to be read as the command input.
11189 These events are processed first, before actual keyboard input.
11190 Events read from this list are not normally added to `this-command-keys',
11191 as they will already have been added once as they were read for the first time.
11192 An element of the form (t . EVENT) forces EVENT to be added to that list. */);
11193 Vunread_command_events
= Qnil
;
11195 DEFVAR_LISP ("unread-post-input-method-events", Vunread_post_input_method_events
,
11196 doc
: /* List of events to be processed as input by input methods.
11197 These events are processed before `unread-command-events'
11198 and actual keyboard input, but are not given to `input-method-function'. */);
11199 Vunread_post_input_method_events
= Qnil
;
11201 DEFVAR_LISP ("unread-input-method-events", Vunread_input_method_events
,
11202 doc
: /* List of events to be processed as input by input methods.
11203 These events are processed after `unread-command-events', but
11204 before actual keyboard input.
11205 If there's an active input method, the events are given to
11206 `input-method-function'. */);
11207 Vunread_input_method_events
= Qnil
;
11209 DEFVAR_LISP ("meta-prefix-char", meta_prefix_char
,
11210 doc
: /* Meta-prefix character code.
11211 Meta-foo as command input turns into this character followed by foo. */);
11212 XSETINT (meta_prefix_char
, 033);
11214 DEFVAR_KBOARD ("last-command", Vlast_command
,
11215 doc
: /* The last command executed.
11216 Normally a symbol with a function definition, but can be whatever was found
11217 in the keymap, or whatever the variable `this-command' was set to by that
11220 The value `mode-exit' is special; it means that the previous command
11221 read an event that told it to exit, and it did so and unread that event.
11222 In other words, the present command is the event that made the previous
11225 The value `kill-region' is special; it means that the previous command
11226 was a kill command.
11228 `last-command' has a separate binding for each terminal device.
11229 See Info node `(elisp)Multiple Terminals'. */);
11231 DEFVAR_KBOARD ("real-last-command", Vreal_last_command
,
11232 doc
: /* Same as `last-command', but never altered by Lisp code.
11233 Taken from the previous value of `real-this-command'. */);
11235 DEFVAR_KBOARD ("last-repeatable-command", Vlast_repeatable_command
,
11236 doc
: /* Last command that may be repeated.
11237 The last command executed that was not bound to an input event.
11238 This is the command `repeat' will try to repeat.
11239 Taken from a previous value of `real-this-command'. */);
11241 DEFVAR_LISP ("this-command", Vthis_command
,
11242 doc
: /* The command now being executed.
11243 The command can set this variable; whatever is put here
11244 will be in `last-command' during the following command. */);
11245 Vthis_command
= Qnil
;
11247 DEFVAR_LISP ("real-this-command", Vreal_this_command
,
11248 doc
: /* This is like `this-command', except that commands should never modify it. */);
11249 Vreal_this_command
= Qnil
;
11251 DEFVAR_LISP ("this-command-keys-shift-translated",
11252 Vthis_command_keys_shift_translated
,
11253 doc
: /* Non-nil if the key sequence activating this command was shift-translated.
11254 Shift-translation occurs when there is no binding for the key sequence
11255 as entered, but a binding was found by changing an upper-case letter
11256 to lower-case, or a shifted function key to an unshifted one. */);
11257 Vthis_command_keys_shift_translated
= Qnil
;
11259 DEFVAR_LISP ("this-original-command", Vthis_original_command
,
11260 doc
: /* The command bound to the current key sequence before remapping.
11261 It equals `this-command' if the original command was not remapped through
11262 any of the active keymaps. Otherwise, the value of `this-command' is the
11263 result of looking up the original command in the active keymaps. */);
11264 Vthis_original_command
= Qnil
;
11266 DEFVAR_INT ("auto-save-interval", auto_save_interval
,
11267 doc
: /* Number of input events between auto-saves.
11268 Zero means disable autosaving due to number of characters typed. */);
11269 auto_save_interval
= 300;
11271 DEFVAR_LISP ("auto-save-timeout", Vauto_save_timeout
,
11272 doc
: /* Number of seconds idle time before auto-save.
11273 Zero or nil means disable auto-saving due to idleness.
11274 After auto-saving due to this many seconds of idle time,
11275 Emacs also does a garbage collection if that seems to be warranted. */);
11276 XSETFASTINT (Vauto_save_timeout
, 30);
11278 DEFVAR_LISP ("echo-keystrokes", Vecho_keystrokes
,
11279 doc
: /* Nonzero means echo unfinished commands after this many seconds of pause.
11280 The value may be integer or floating point.
11281 If the value is zero, don't echo at all. */);
11282 Vecho_keystrokes
= make_number (1);
11284 DEFVAR_INT ("polling-period", polling_period
,
11285 doc
: /* Interval between polling for input during Lisp execution.
11286 The reason for polling is to make C-g work to stop a running program.
11287 Polling is needed only when using X windows and SIGIO does not work.
11288 Polling is automatically disabled in all other cases. */);
11289 polling_period
= 2;
11291 DEFVAR_LISP ("double-click-time", Vdouble_click_time
,
11292 doc
: /* Maximum time between mouse clicks to make a double-click.
11293 Measured in milliseconds. The value nil means disable double-click
11294 recognition; t means double-clicks have no time limit and are detected
11295 by position only. */);
11296 Vdouble_click_time
= make_number (500);
11298 DEFVAR_INT ("double-click-fuzz", double_click_fuzz
,
11299 doc
: /* Maximum mouse movement between clicks to make a double-click.
11300 On window-system frames, value is the number of pixels the mouse may have
11301 moved horizontally or vertically between two clicks to make a double-click.
11302 On non window-system frames, value is interpreted in units of 1/8 characters
11305 This variable is also the threshold for motion of the mouse
11306 to count as a drag. */);
11307 double_click_fuzz
= 3;
11309 DEFVAR_INT ("num-input-keys", num_input_keys
,
11310 doc
: /* Number of complete key sequences read as input so far.
11311 This includes key sequences read from keyboard macros.
11312 The number is effectively the number of interactive command invocations. */);
11313 num_input_keys
= 0;
11315 DEFVAR_INT ("num-nonmacro-input-events", num_nonmacro_input_events
,
11316 doc
: /* Number of input events read from the keyboard so far.
11317 This does not include events generated by keyboard macros. */);
11318 num_nonmacro_input_events
= 0;
11320 DEFVAR_LISP ("last-event-frame", Vlast_event_frame
,
11321 doc
: /* The frame in which the most recently read event occurred.
11322 If the last event came from a keyboard macro, this is set to `macro'. */);
11323 Vlast_event_frame
= Qnil
;
11325 /* This variable is set up in sysdep.c. */
11326 DEFVAR_LISP ("tty-erase-char", Vtty_erase_char
,
11327 doc
: /* The ERASE character as set by the user with stty. */);
11329 DEFVAR_LISP ("help-char", Vhelp_char
,
11330 doc
: /* Character to recognize as meaning Help.
11331 When it is read, do `(eval help-form)', and display result if it's a string.
11332 If the value of `help-form' is nil, this char can be read normally. */);
11333 XSETINT (Vhelp_char
, Ctl ('H'));
11335 DEFVAR_LISP ("help-event-list", Vhelp_event_list
,
11336 doc
: /* List of input events to recognize as meaning Help.
11337 These work just like the value of `help-char' (see that). */);
11338 Vhelp_event_list
= Qnil
;
11340 DEFVAR_LISP ("help-form", Vhelp_form
,
11341 doc
: /* Form to execute when character `help-char' is read.
11342 If the form returns a string, that string is displayed.
11343 If `help-form' is nil, the help char is not recognized. */);
11346 DEFVAR_LISP ("prefix-help-command", Vprefix_help_command
,
11347 doc
: /* Command to run when `help-char' character follows a prefix key.
11348 This command is used only when there is no actual binding
11349 for that character after that prefix key. */);
11350 Vprefix_help_command
= Qnil
;
11352 DEFVAR_LISP ("top-level", Vtop_level
,
11353 doc
: /* Form to evaluate when Emacs starts up.
11354 Useful to set before you dump a modified Emacs. */);
11356 XSYMBOL (Qtop_level
)->declared_special
= false;
11358 DEFVAR_KBOARD ("keyboard-translate-table", Vkeyboard_translate_table
,
11359 doc
: /* Translate table for local keyboard input, or nil.
11360 If non-nil, the value should be a char-table. Each character read
11361 from the keyboard is looked up in this char-table. If the value found
11362 there is non-nil, then it is used instead of the actual input character.
11364 The value can also be a string or vector, but this is considered obsolete.
11365 If it is a string or vector of length N, character codes N and up are left
11366 untranslated. In a vector, an element which is nil means "no translation".
11368 This is applied to the characters supplied to input methods, not their
11369 output. See also `translation-table-for-input'.
11371 This variable has a separate binding for each terminal.
11372 See Info node `(elisp)Multiple Terminals'. */);
11374 DEFVAR_BOOL ("cannot-suspend", cannot_suspend
,
11375 doc
: /* Non-nil means to always spawn a subshell instead of suspending.
11376 (Even if the operating system has support for stopping a process.) */);
11377 cannot_suspend
= false;
11379 DEFVAR_BOOL ("menu-prompting", menu_prompting
,
11380 doc
: /* Non-nil means prompt with menus when appropriate.
11381 This is done when reading from a keymap that has a prompt string,
11382 for elements that have prompt strings.
11383 The menu is displayed on the screen
11384 if X menus were enabled at configuration
11385 time and the previous event was a mouse click prefix key.
11386 Otherwise, menu prompting uses the echo area. */);
11387 menu_prompting
= true;
11389 DEFVAR_LISP ("menu-prompt-more-char", menu_prompt_more_char
,
11390 doc
: /* Character to see next line of menu prompt.
11391 Type this character while in a menu prompt to rotate around the lines of it. */);
11392 XSETINT (menu_prompt_more_char
, ' ');
11394 DEFVAR_INT ("extra-keyboard-modifiers", extra_keyboard_modifiers
,
11395 doc
: /* A mask of additional modifier keys to use with every keyboard character.
11396 Emacs applies the modifiers of the character stored here to each keyboard
11397 character it reads. For example, after evaluating the expression
11398 (setq extra-keyboard-modifiers ?\\C-x)
11399 all input characters will have the control modifier applied to them.
11401 Note that the character ?\\C-@, equivalent to the integer zero, does
11402 not count as a control character; rather, it counts as a character
11403 with no modifiers; thus, setting `extra-keyboard-modifiers' to zero
11404 cancels any modification. */);
11405 extra_keyboard_modifiers
= 0;
11407 DEFSYM (Qdeactivate_mark
, "deactivate-mark");
11408 DEFVAR_LISP ("deactivate-mark", Vdeactivate_mark
,
11409 doc
: /* If an editing command sets this to t, deactivate the mark afterward.
11410 The command loop sets this to nil before each command,
11411 and tests the value when the command returns.
11412 Buffer modification stores t in this variable. */);
11413 Vdeactivate_mark
= Qnil
;
11414 Fmake_variable_buffer_local (Qdeactivate_mark
);
11416 DEFVAR_LISP ("pre-command-hook", Vpre_command_hook
,
11417 doc
: /* Normal hook run before each command is executed.
11418 If an unhandled error happens in running this hook,
11419 the function in which the error occurred is unconditionally removed, since
11420 otherwise the error might happen repeatedly and make Emacs nonfunctional.
11422 See also `post-command-hook'. */);
11423 Vpre_command_hook
= Qnil
;
11425 DEFVAR_LISP ("post-command-hook", Vpost_command_hook
,
11426 doc
: /* Normal hook run after each command is executed.
11427 If an unhandled error happens in running this hook,
11428 the function in which the error occurred is unconditionally removed, since
11429 otherwise the error might happen repeatedly and make Emacs nonfunctional.
11431 It is a bad idea to use this hook for expensive processing. If
11432 unavoidable, wrap your code in `(while-no-input (redisplay) CODE)' to
11433 avoid making Emacs unresponsive while the user types.
11435 See also `pre-command-hook'. */);
11436 Vpost_command_hook
= Qnil
;
11439 DEFVAR_LISP ("echo-area-clear-hook", ...,
11440 doc
: /* Normal hook run when clearing the echo area. */);
11442 DEFSYM (Qecho_area_clear_hook
, "echo-area-clear-hook");
11443 Fset (Qecho_area_clear_hook
, Qnil
);
11445 DEFVAR_LISP ("lucid-menu-bar-dirty-flag", Vlucid_menu_bar_dirty_flag
,
11446 doc
: /* Non-nil means menu bar, specified Lucid style, needs to be recomputed. */);
11447 Vlucid_menu_bar_dirty_flag
= Qnil
;
11449 DEFVAR_LISP ("menu-bar-final-items", Vmenu_bar_final_items
,
11450 doc
: /* List of menu bar items to move to the end of the menu bar.
11451 The elements of the list are event types that may have menu bar bindings. */);
11452 Vmenu_bar_final_items
= Qnil
;
11454 DEFVAR_LISP ("tool-bar-separator-image-expression", Vtool_bar_separator_image_expression
,
11455 doc
: /* Expression evaluating to the image spec for a tool-bar separator.
11456 This is used internally by graphical displays that do not render
11457 tool-bar separators natively. Otherwise it is unused (e.g. on GTK). */);
11458 Vtool_bar_separator_image_expression
= Qnil
;
11460 DEFVAR_KBOARD ("overriding-terminal-local-map",
11461 Voverriding_terminal_local_map
,
11462 doc
: /* Per-terminal keymap that takes precedence over all other keymaps.
11463 This variable is intended to let commands such as `universal-argument'
11464 set up a different keymap for reading the next command.
11466 `overriding-terminal-local-map' has a separate binding for each
11467 terminal device. See Info node `(elisp)Multiple Terminals'. */);
11469 DEFVAR_LISP ("overriding-local-map", Voverriding_local_map
,
11470 doc
: /* Keymap that replaces (overrides) local keymaps.
11471 If this variable is non-nil, Emacs looks up key bindings in this
11472 keymap INSTEAD OF the keymap char property, minor mode maps, and the
11473 buffer's local map. Hence, the only active keymaps would be
11474 `overriding-terminal-local-map', this keymap, and `global-keymap', in
11475 order of precedence. */);
11476 Voverriding_local_map
= Qnil
;
11478 DEFVAR_LISP ("overriding-local-map-menu-flag", Voverriding_local_map_menu_flag
,
11479 doc
: /* Non-nil means `overriding-local-map' applies to the menu bar.
11480 Otherwise, the menu bar continues to reflect the buffer's local map
11481 and the minor mode maps regardless of `overriding-local-map'. */);
11482 Voverriding_local_map_menu_flag
= Qnil
;
11484 DEFVAR_LISP ("special-event-map", Vspecial_event_map
,
11485 doc
: /* Keymap defining bindings for special events to execute at low level. */);
11486 Vspecial_event_map
= list1 (Qkeymap
);
11488 DEFVAR_LISP ("track-mouse", do_mouse_tracking
,
11489 doc
: /* Non-nil means generate motion events for mouse motion. */);
11491 DEFVAR_KBOARD ("system-key-alist", Vsystem_key_alist
,
11492 doc
: /* Alist of system-specific X windows key symbols.
11493 Each element should have the form (N . SYMBOL) where N is the
11494 numeric keysym code (sans the \"system-specific\" bit 1<<28)
11495 and SYMBOL is its name.
11497 `system-key-alist' has a separate binding for each terminal device.
11498 See Info node `(elisp)Multiple Terminals'. */);
11500 DEFVAR_KBOARD ("local-function-key-map", Vlocal_function_key_map
,
11501 doc
: /* Keymap that translates key sequences to key sequences during input.
11502 This is used mainly for mapping key sequences into some preferred
11503 key events (symbols).
11505 The `read-key-sequence' function replaces any subsequence bound by
11506 `local-function-key-map' with its binding. More precisely, when the
11507 active keymaps have no binding for the current key sequence but
11508 `local-function-key-map' binds a suffix of the sequence to a vector or
11509 string, `read-key-sequence' replaces the matching suffix with its
11510 binding, and continues with the new sequence.
11512 If the binding is a function, it is called with one argument (the prompt)
11513 and its return value (a key sequence) is used.
11515 The events that come from bindings in `local-function-key-map' are not
11516 themselves looked up in `local-function-key-map'.
11518 For example, suppose `local-function-key-map' binds `ESC O P' to [f1].
11519 Typing `ESC O P' to `read-key-sequence' would return [f1]. Typing
11520 `C-x ESC O P' would return [?\\C-x f1]. If [f1] were a prefix key,
11521 typing `ESC O P x' would return [f1 x].
11523 `local-function-key-map' has a separate binding for each terminal
11524 device. See Info node `(elisp)Multiple Terminals'. If you need to
11525 define a binding on all terminals, change `function-key-map'
11526 instead. Initially, `local-function-key-map' is an empty keymap that
11527 has `function-key-map' as its parent on all terminal devices. */);
11529 DEFVAR_KBOARD ("input-decode-map", Vinput_decode_map
,
11530 doc
: /* Keymap that decodes input escape sequences.
11531 This is used mainly for mapping ASCII function key sequences into
11532 real Emacs function key events (symbols).
11534 The `read-key-sequence' function replaces any subsequence bound by
11535 `input-decode-map' with its binding. Contrary to `function-key-map',
11536 this map applies its rebinding regardless of the presence of an ordinary
11537 binding. So it is more like `key-translation-map' except that it applies
11538 before `function-key-map' rather than after.
11540 If the binding is a function, it is called with one argument (the prompt)
11541 and its return value (a key sequence) is used.
11543 The events that come from bindings in `input-decode-map' are not
11544 themselves looked up in `input-decode-map'. */);
11546 DEFVAR_LISP ("function-key-map", Vfunction_key_map
,
11547 doc
: /* The parent keymap of all `local-function-key-map' instances.
11548 Function key definitions that apply to all terminal devices should go
11549 here. If a mapping is defined in both the current
11550 `local-function-key-map' binding and this variable, then the local
11551 definition will take precedence. */);
11552 Vfunction_key_map
= Fmake_sparse_keymap (Qnil
);
11554 DEFVAR_LISP ("key-translation-map", Vkey_translation_map
,
11555 doc
: /* Keymap of key translations that can override keymaps.
11556 This keymap works like `input-decode-map', but comes after `function-key-map'.
11557 Another difference is that it is global rather than terminal-local. */);
11558 Vkey_translation_map
= Fmake_sparse_keymap (Qnil
);
11560 DEFVAR_LISP ("deferred-action-list", Vdeferred_action_list
,
11561 doc
: /* List of deferred actions to be performed at a later time.
11562 The precise format isn't relevant here; we just check whether it is nil. */);
11563 Vdeferred_action_list
= Qnil
;
11565 DEFVAR_LISP ("deferred-action-function", Vdeferred_action_function
,
11566 doc
: /* Function to call to handle deferred actions, after each command.
11567 This function is called with no arguments after each command
11568 whenever `deferred-action-list' is non-nil. */);
11569 Vdeferred_action_function
= Qnil
;
11571 DEFVAR_LISP ("delayed-warnings-list", Vdelayed_warnings_list
,
11572 doc
: /* List of warnings to be displayed after this command.
11573 Each element must be a list (TYPE MESSAGE [LEVEL [BUFFER-NAME]]),
11574 as per the args of `display-warning' (which see).
11575 If this variable is non-nil, `delayed-warnings-hook' will be run
11576 immediately after running `post-command-hook'. */);
11577 Vdelayed_warnings_list
= Qnil
;
11579 DEFVAR_LISP ("timer-list", Vtimer_list
,
11580 doc
: /* List of active absolute time timers in order of increasing time. */);
11581 Vtimer_list
= Qnil
;
11583 DEFVAR_LISP ("timer-idle-list", Vtimer_idle_list
,
11584 doc
: /* List of active idle-time timers in order of increasing time. */);
11585 Vtimer_idle_list
= Qnil
;
11587 DEFVAR_LISP ("input-method-function", Vinput_method_function
,
11588 doc
: /* If non-nil, the function that implements the current input method.
11589 It's called with one argument, a printing character that was just read.
11590 (That means a character with code 040...0176.)
11591 Typically this function uses `read-event' to read additional events.
11592 When it does so, it should first bind `input-method-function' to nil
11593 so it will not be called recursively.
11595 The function should return a list of zero or more events
11596 to be used as input. If it wants to put back some events
11597 to be reconsidered, separately, by the input method,
11598 it can add them to the beginning of `unread-command-events'.
11600 The input method function can find in `input-method-previous-message'
11601 the previous echo area message.
11603 The input method function should refer to the variables
11604 `input-method-use-echo-area' and `input-method-exit-on-first-char'
11605 for guidance on what to do. */);
11606 Vinput_method_function
= Qlist
;
11608 DEFVAR_LISP ("input-method-previous-message",
11609 Vinput_method_previous_message
,
11610 doc
: /* When `input-method-function' is called, hold the previous echo area message.
11611 This variable exists because `read-event' clears the echo area
11612 before running the input method. It is nil if there was no message. */);
11613 Vinput_method_previous_message
= Qnil
;
11615 DEFVAR_LISP ("show-help-function", Vshow_help_function
,
11616 doc
: /* If non-nil, the function that implements the display of help.
11617 It's called with one argument, the help string to display. */);
11618 Vshow_help_function
= Qnil
;
11620 DEFVAR_LISP ("disable-point-adjustment", Vdisable_point_adjustment
,
11621 doc
: /* If non-nil, suppress point adjustment after executing a command.
11623 After a command is executed, if point moved into a region that has
11624 special properties (e.g. composition, display), Emacs adjusts point to
11625 the boundary of the region. But when a command leaves this variable at
11626 a non-nil value (e.g., with a setq), this point adjustment is suppressed.
11628 This variable is set to nil before reading a command, and is checked
11629 just after executing the command. */);
11630 Vdisable_point_adjustment
= Qnil
;
11632 DEFVAR_LISP ("global-disable-point-adjustment",
11633 Vglobal_disable_point_adjustment
,
11634 doc
: /* If non-nil, always suppress point adjustments.
11636 The default value is nil, in which case point adjustments are
11637 suppressed only after special commands that leave
11638 `disable-point-adjustment' (which see) at a non-nil value. */);
11639 Vglobal_disable_point_adjustment
= Qnil
;
11641 DEFVAR_LISP ("minibuffer-message-timeout", Vminibuffer_message_timeout
,
11642 doc
: /* How long to display an echo-area message when the minibuffer is active.
11643 If the value is not a number, such messages don't time out. */);
11644 Vminibuffer_message_timeout
= make_number (2);
11646 DEFVAR_LISP ("throw-on-input", Vthrow_on_input
,
11647 doc
: /* If non-nil, any keyboard input throws to this symbol.
11648 The value of that variable is passed to `quit-flag' and later causes a
11649 peculiar kind of quitting. */);
11650 Vthrow_on_input
= Qnil
;
11652 DEFVAR_LISP ("command-error-function", Vcommand_error_function
,
11653 doc
: /* Function to output error messages.
11654 Called with three arguments:
11655 - the error data, a list of the form (SIGNALED-CONDITION . SIGNAL-DATA)
11656 such as what `condition-case' would bind its variable to,
11657 - the context (a string which normally goes at the start of the message),
11658 - the Lisp function within which the error was signaled. */);
11659 Vcommand_error_function
= intern ("command-error-default-function");
11661 DEFVAR_LISP ("enable-disabled-menus-and-buttons",
11662 Venable_disabled_menus_and_buttons
,
11663 doc
: /* If non-nil, don't ignore events produced by disabled menu items and tool-bar.
11665 Help functions bind this to allow help on disabled menu items
11666 and tool-bar buttons. */);
11667 Venable_disabled_menus_and_buttons
= Qnil
;
11669 DEFVAR_LISP ("select-active-regions",
11670 Vselect_active_regions
,
11671 doc
: /* If non-nil, an active region automatically sets the primary selection.
11672 If the value is `only', only temporarily active regions (usually made
11673 by mouse-dragging or shift-selection) set the window selection.
11675 This takes effect only when Transient Mark mode is enabled. */);
11676 Vselect_active_regions
= Qt
;
11678 DEFVAR_LISP ("saved-region-selection",
11679 Vsaved_region_selection
,
11680 doc
: /* Contents of active region prior to buffer modification.
11681 If `select-active-regions' is non-nil, Emacs sets this to the
11682 text in the region before modifying the buffer. The next call to
11683 the function `deactivate-mark' uses this to set the window selection. */);
11684 Vsaved_region_selection
= Qnil
;
11686 DEFVAR_LISP ("selection-inhibit-update-commands",
11687 Vselection_inhibit_update_commands
,
11688 doc
: /* List of commands which should not update the selection.
11689 Normally, if `select-active-regions' is non-nil and the mark remains
11690 active after a command (i.e. the mark was not deactivated), the Emacs
11691 command loop sets the selection to the text in the region. However,
11692 if the command is in this list, the selection is not updated. */);
11693 Vselection_inhibit_update_commands
11694 = list2 (Qhandle_switch_frame
, Qhandle_select_window
);
11696 DEFVAR_LISP ("debug-on-event",
11698 doc
: /* Enter debugger on this event. When Emacs
11699 receives the special event specified by this variable, it will try to
11700 break into the debugger as soon as possible instead of processing the
11701 event normally through `special-event-map'.
11703 Currently, the only supported values for this
11704 variable are `sigusr1' and `sigusr2'. */);
11705 Vdebug_on_event
= intern_c_string ("sigusr2");
11707 /* Create the initial keyboard. Qt means 'unset'. */
11708 initial_kboard
= allocate_kboard (Qt
);
11712 keys_of_keyboard (void)
11714 initial_define_key (global_map
, Ctl ('Z'), "suspend-emacs");
11715 initial_define_key (control_x_map
, Ctl ('Z'), "suspend-emacs");
11716 initial_define_key (meta_map
, Ctl ('C'), "exit-recursive-edit");
11717 initial_define_key (global_map
, Ctl (']'), "abort-recursive-edit");
11718 initial_define_key (meta_map
, 'x', "execute-extended-command");
11720 initial_define_lispy_key (Vspecial_event_map
, "delete-frame",
11721 "handle-delete-frame");
11722 initial_define_lispy_key (Vspecial_event_map
, "ns-put-working-text",
11723 "ns-put-working-text");
11724 initial_define_lispy_key (Vspecial_event_map
, "ns-unput-working-text",
11725 "ns-unput-working-text");
11726 /* Here we used to use `ignore-event' which would simple set prefix-arg to
11727 current-prefix-arg, as is done in `handle-switch-frame'.
11728 But `handle-switch-frame is not run from the special-map.
11729 Commands from that map are run in a special way that automatically
11730 preserves the prefix-arg. Restoring the prefix arg here is not just
11731 redundant but harmful:
11733 - current-prefix-arg is set to non-nil, prefix-arg is set to nil.
11734 - after the first prompt, the exit-minibuffer-hook is run which may
11735 iconify a frame and thus push a `iconify-frame' event.
11736 - after running exit-minibuffer-hook, current-prefix-arg is
11737 restored to the non-nil value it had before the prompt.
11738 - we enter the second prompt.
11739 current-prefix-arg is non-nil, prefix-arg is nil.
11740 - before running the first real event, we run the special iconify-frame
11741 event, but we pass the `special' arg to command-execute so
11742 current-prefix-arg and prefix-arg are left untouched.
11743 - here we foolishly copy the non-nil current-prefix-arg to prefix-arg.
11744 - the next key event will have a spuriously non-nil current-prefix-arg. */
11745 initial_define_lispy_key (Vspecial_event_map
, "iconify-frame",
11747 initial_define_lispy_key (Vspecial_event_map
, "make-frame-visible",
11749 /* Handling it at such a low-level causes read_key_sequence to get
11750 * confused because it doesn't realize that the current_buffer was
11751 * changed by read_char.
11753 * initial_define_lispy_key (Vspecial_event_map, "select-window",
11754 * "handle-select-window"); */
11755 initial_define_lispy_key (Vspecial_event_map
, "save-session",
11756 "handle-save-session");
11759 /* Define a special event which is raised for dbus callback
11761 initial_define_lispy_key (Vspecial_event_map
, "dbus-event",
11762 "dbus-handle-event");
11765 #ifdef USE_FILE_NOTIFY
11766 /* Define a special event which is raised for notification callback
11768 initial_define_lispy_key (Vspecial_event_map
, "file-notify",
11769 "file-notify-handle-event");
11770 #endif /* USE_FILE_NOTIFY */
11772 initial_define_lispy_key (Vspecial_event_map
, "config-changed-event",
11774 #if defined (WINDOWSNT)
11775 initial_define_lispy_key (Vspecial_event_map
, "language-change",
11778 initial_define_lispy_key (Vspecial_event_map
, "focus-in",
11779 "handle-focus-in");
11780 initial_define_lispy_key (Vspecial_event_map
, "focus-out",
11781 "handle-focus-out");
11784 /* Mark the pointers in the kboard objects.
11785 Called by Fgarbage_collect. */
11787 mark_kboards (void)
11791 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
11793 if (kb
->kbd_macro_buffer
)
11794 for (p
= kb
->kbd_macro_buffer
; p
< kb
->kbd_macro_ptr
; p
++)
11796 mark_object (KVAR (kb
, Voverriding_terminal_local_map
));
11797 mark_object (KVAR (kb
, Vlast_command
));
11798 mark_object (KVAR (kb
, Vreal_last_command
));
11799 mark_object (KVAR (kb
, Vkeyboard_translate_table
));
11800 mark_object (KVAR (kb
, Vlast_repeatable_command
));
11801 mark_object (KVAR (kb
, Vprefix_arg
));
11802 mark_object (KVAR (kb
, Vlast_prefix_arg
));
11803 mark_object (KVAR (kb
, kbd_queue
));
11804 mark_object (KVAR (kb
, defining_kbd_macro
));
11805 mark_object (KVAR (kb
, Vlast_kbd_macro
));
11806 mark_object (KVAR (kb
, Vsystem_key_alist
));
11807 mark_object (KVAR (kb
, system_key_syms
));
11808 mark_object (KVAR (kb
, Vwindow_system
));
11809 mark_object (KVAR (kb
, Vinput_decode_map
));
11810 mark_object (KVAR (kb
, Vlocal_function_key_map
));
11811 mark_object (KVAR (kb
, Vdefault_minibuffer_frame
));
11812 mark_object (KVAR (kb
, echo_string
));
11813 mark_object (KVAR (kb
, echo_prompt
));
11816 union buffered_input_event
*event
;
11817 for (event
= kbd_fetch_ptr
; event
!= kbd_store_ptr
; event
++)
11819 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
11820 event
= kbd_buffer
;
11821 /* These two special event types has no Lisp_Objects to mark. */
11822 if (event
->kind
!= SELECTION_REQUEST_EVENT
11823 && event
->kind
!= SELECTION_CLEAR_EVENT
)
11825 mark_object (event
->ie
.x
);
11826 mark_object (event
->ie
.y
);
11827 mark_object (event
->ie
.frame_or_window
);
11828 mark_object (event
->ie
.arg
);