1 /* Keyboard and mouse input; editor command loop.
3 Copyright (C) 1985-1989, 1993-1997, 1999-2015 Free Software Foundation,
6 This file is part of GNU Emacs.
8 GNU Emacs is free software: you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation, either version 3 of the License, or
11 (at your option) any later version.
13 GNU Emacs is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
30 #include "termhooks.h"
35 #include "character.h"
38 #include "dispextern.h"
40 #include "intervals.h"
42 #include "blockinput.h"
56 #include <sys/ioctl.h>
57 #endif /* not MSDOS */
59 #if defined USABLE_FIONREAD && defined USG5_4
60 # include <sys/filio.h>
63 #include "syssignal.h"
65 #include <sys/types.h>
69 #ifdef HAVE_WINDOW_SYSTEM
71 #endif /* HAVE_WINDOW_SYSTEM */
73 /* Variables for blockinput.h: */
75 /* Positive if interrupt input is blocked right now. */
76 volatile int interrupt_input_blocked
;
78 /* True means an input interrupt or alarm signal has arrived.
79 The QUIT macro checks this. */
80 volatile bool pending_signals
;
82 #define KBD_BUFFER_SIZE 4096
84 KBOARD
*initial_kboard
;
85 KBOARD
*current_kboard
;
86 static KBOARD
*all_kboards
;
88 /* True in the single-kboard state, false in the any-kboard state. */
89 static bool single_kboard
;
91 #define NUM_RECENT_KEYS (300)
93 /* Index for storing next element into recent_keys. */
94 static int recent_keys_index
;
96 /* Total number of elements stored into recent_keys. */
97 static int total_keys
;
99 /* This vector holds the last NUM_RECENT_KEYS keystrokes. */
100 static Lisp_Object recent_keys
;
102 /* Vector holding the key sequence that invoked the current command.
103 It is reused for each command, and it may be longer than the current
104 sequence; this_command_key_count indicates how many elements
105 actually mean something.
106 It's easier to staticpro a single Lisp_Object than an array. */
107 Lisp_Object this_command_keys
;
108 ptrdiff_t this_command_key_count
;
110 /* 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 /* Total number of times read_char has returned, modulo UINTMAX_MAX + 1. */
201 uintmax_t num_input_events
;
203 /* Value of num_nonmacro_input_events as of last auto save. */
205 static EMACS_INT last_auto_save
;
207 /* The value of point when the last command was started. */
208 static ptrdiff_t last_point_position
;
210 /* The frame in which the last input event occurred, or Qmacro if the
211 last event came from a macro. We use this to determine when to
212 generate switch-frame events. This may be cleared by functions
213 like Fselect_frame, to make sure that a switch-frame event is
214 generated by the next character.
216 FIXME: This is modified by a signal handler so it should be volatile.
217 It's exported to Lisp, though, so it can't simply be marked
219 Lisp_Object internal_last_event_frame
;
221 /* `read_key_sequence' stores here the command definition of the
222 key sequence that it reads. */
223 static Lisp_Object read_key_sequence_cmd
;
224 static Lisp_Object read_key_sequence_remapped
;
226 /* File in which we write all commands we read. */
227 static FILE *dribble
;
229 /* True if input is available. */
232 /* True if more input was available last time we read an event.
234 Since redisplay can take a significant amount of time and is not
235 indispensable to perform the user's commands, when input arrives
236 "too fast", Emacs skips redisplay. More specifically, if the next
237 command has already been input when we finish the previous command,
238 we skip the intermediate redisplay.
240 This is useful to try and make sure Emacs keeps up with fast input
241 rates, such as auto-repeating keys. But in some cases, this proves
242 too conservative: we may end up disabling redisplay for the whole
243 duration of a key repetition, even though we could afford to
244 redisplay every once in a while.
246 So we "sample" the input_pending flag before running a command and
247 use *that* value after running the command to decide whether to
248 skip redisplay or not. This way, we only skip redisplay if we
249 really can't keep up with the repeat rate.
251 This only makes a difference if the next input arrives while running the
252 command, which is very unlikely if the command is executed quickly.
253 IOW this tends to avoid skipping redisplay after a long running command
254 (which is a case where skipping redisplay is not very useful since the
255 redisplay time is small compared to the time it took to run the command).
257 A typical use case is when scrolling. Scrolling time can be split into:
258 - Time to do jit-lock on the newly displayed portion of buffer.
259 - Time to run the actual scroll command.
260 - Time to perform the redisplay.
261 Jit-lock can happen either during the command or during the redisplay.
262 In the most painful cases, the jit-lock time is the one that dominates.
263 Also jit-lock can be tweaked (via jit-lock-defer) to delay its job, at the
264 cost of temporary inaccuracy in display and scrolling.
265 So without input_was_pending, what typically happens is the following:
266 - when the command starts, there's no pending input (yet).
267 - the scroll command triggers jit-lock.
268 - during the long jit-lock time the next input arrives.
269 - at the end of the command, we check input_pending and hence decide to
271 - we read the next input and start over.
272 End result: all the hard work of jit-locking is "wasted" since redisplay
273 doesn't actually happens (at least not before the input rate slows down).
274 With input_was_pending redisplay is still skipped if Emacs can't keep up
275 with the input rate, but if it can keep up just enough that there's no
276 input_pending when we begin the command, then redisplay is not skipped
277 which results in better feedback to the user. */
278 static bool input_was_pending
;
280 /* Circular buffer for pre-read keyboard input. */
282 static union buffered_input_event kbd_buffer
[KBD_BUFFER_SIZE
];
284 /* Pointer to next available character in kbd_buffer.
285 If kbd_fetch_ptr == kbd_store_ptr, the buffer is empty.
286 This may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the
287 next available char is in kbd_buffer[0]. */
288 static union buffered_input_event
*kbd_fetch_ptr
;
290 /* Pointer to next place to store character in kbd_buffer. This
291 may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the next
292 character should go in kbd_buffer[0]. */
293 static union buffered_input_event
*volatile kbd_store_ptr
;
295 /* The above pair of variables forms a "queue empty" flag. When we
296 enqueue a non-hook event, we increment kbd_store_ptr. When we
297 dequeue a non-hook event, we increment kbd_fetch_ptr. We say that
298 there is input available if the two pointers are not equal.
300 Why not just have a flag set and cleared by the enqueuing and
301 dequeuing functions? Such a flag could be screwed up by interrupts
302 at inopportune times. */
304 static void recursive_edit_unwind (Lisp_Object buffer
);
305 static Lisp_Object
command_loop (void);
307 static void echo_now (void);
308 static ptrdiff_t echo_length (void);
310 /* Incremented whenever a timer is run. */
313 /* Address (if not 0) of struct timespec to zero out if a SIGIO interrupt
315 struct timespec
*input_available_clear_time
;
317 /* True means use SIGIO interrupts; false means use CBREAK mode.
318 Default is true if INTERRUPT_INPUT is defined. */
319 bool interrupt_input
;
321 /* Nonzero while interrupts are temporarily deferred during redisplay. */
322 bool interrupts_deferred
;
324 /* The time when Emacs started being idle. */
326 static struct timespec timer_idleness_start_time
;
328 /* After Emacs stops being idle, this saves the last value
329 of timer_idleness_start_time from when it was idle. */
331 static struct timespec timer_last_idleness_start_time
;
334 /* Global variable declarations. */
336 /* Flags for readable_events. */
337 #define READABLE_EVENTS_DO_TIMERS_NOW (1 << 0)
338 #define READABLE_EVENTS_FILTER_EVENTS (1 << 1)
339 #define READABLE_EVENTS_IGNORE_SQUEEZABLES (1 << 2)
341 /* Function for init_keyboard to call with no args (if nonzero). */
342 static void (*keyboard_init_hook
) (void);
344 static bool get_input_pending (int);
345 static bool readable_events (int);
346 static Lisp_Object
read_char_x_menu_prompt (Lisp_Object
,
347 Lisp_Object
, bool *);
348 static Lisp_Object
read_char_minibuf_menu_prompt (int, Lisp_Object
);
349 static Lisp_Object
make_lispy_event (struct input_event
*);
350 static Lisp_Object
make_lispy_movement (struct frame
*, Lisp_Object
,
351 enum scroll_bar_part
,
352 Lisp_Object
, Lisp_Object
,
354 static Lisp_Object
modify_event_symbol (ptrdiff_t, int, Lisp_Object
,
355 Lisp_Object
, const char *const *,
356 Lisp_Object
*, ptrdiff_t);
357 static Lisp_Object
make_lispy_switch_frame (Lisp_Object
);
358 static Lisp_Object
make_lispy_focus_in (Lisp_Object
);
359 #ifdef HAVE_WINDOW_SYSTEM
360 static Lisp_Object
make_lispy_focus_out (Lisp_Object
);
361 #endif /* HAVE_WINDOW_SYSTEM */
362 static bool help_char_p (Lisp_Object
);
363 static void save_getcjmp (sys_jmp_buf
);
364 static void restore_getcjmp (sys_jmp_buf
);
365 static Lisp_Object
apply_modifiers (int, Lisp_Object
);
366 static void restore_kboard_configuration (int);
367 static void handle_interrupt (bool);
368 static _Noreturn
void quit_throw_to_read_char (bool);
369 static void timer_start_idle (void);
370 static void timer_stop_idle (void);
371 static void timer_resume_idle (void);
372 static void deliver_user_signal (int);
373 static char *find_user_signal_name (int);
374 static void store_user_signal_events (void);
376 /* These setters are used only in this file, so they can be private. */
378 kset_echo_string (struct kboard
*kb
, Lisp_Object val
)
380 kb
->echo_string_
= val
;
383 kset_kbd_queue (struct kboard
*kb
, Lisp_Object val
)
385 kb
->kbd_queue_
= val
;
388 kset_keyboard_translate_table (struct kboard
*kb
, Lisp_Object val
)
390 kb
->Vkeyboard_translate_table_
= val
;
393 kset_last_prefix_arg (struct kboard
*kb
, Lisp_Object val
)
395 kb
->Vlast_prefix_arg_
= val
;
398 kset_last_repeatable_command (struct kboard
*kb
, Lisp_Object val
)
400 kb
->Vlast_repeatable_command_
= val
;
403 kset_local_function_key_map (struct kboard
*kb
, Lisp_Object val
)
405 kb
->Vlocal_function_key_map_
= val
;
408 kset_overriding_terminal_local_map (struct kboard
*kb
, Lisp_Object val
)
410 kb
->Voverriding_terminal_local_map_
= val
;
413 kset_real_last_command (struct kboard
*kb
, Lisp_Object val
)
415 kb
->Vreal_last_command_
= val
;
418 kset_system_key_syms (struct kboard
*kb
, Lisp_Object val
)
420 kb
->system_key_syms_
= val
;
424 /* Add C to the echo string, without echoing it immediately. C can be
425 a character, which is pretty-printed, or a symbol, whose name is
429 echo_add_key (Lisp_Object c
)
431 char initbuf
[KEY_DESCRIPTION_SIZE
+ 100];
432 ptrdiff_t size
= sizeof initbuf
;
433 char *buffer
= initbuf
;
435 Lisp_Object echo_string
= KVAR (current_kboard
, echo_string
);
438 if (STRINGP (echo_string
) && SCHARS (echo_string
) > 0)
439 /* Add a space at the end as a separator between keys. */
442 /* If someone has passed us a composite event, use its head symbol. */
446 ptr
= push_key_description (XINT (c
), ptr
);
447 else if (SYMBOLP (c
))
449 Lisp_Object name
= SYMBOL_NAME (c
);
450 ptrdiff_t nbytes
= SBYTES (name
);
452 if (size
- (ptr
- buffer
) < nbytes
)
454 ptrdiff_t offset
= ptr
- buffer
;
455 size
= max (2 * size
, size
+ nbytes
);
456 buffer
= SAFE_ALLOCA (size
);
457 ptr
= buffer
+ offset
;
460 ptr
+= copy_text (SDATA (name
), (unsigned char *) ptr
, nbytes
,
461 STRING_MULTIBYTE (name
), 1);
464 if ((NILP (echo_string
) || SCHARS (echo_string
) == 0)
467 static const char text
[] = " (Type ? for further options)";
468 int len
= sizeof text
- 1;
470 if (size
- (ptr
- buffer
) < len
)
472 ptrdiff_t offset
= ptr
- buffer
;
474 buffer
= SAFE_ALLOCA (size
);
475 ptr
= buffer
+ offset
;
478 memcpy (ptr
, text
, len
);
484 concat2 (echo_string
, make_string (buffer
, ptr
- buffer
)));
488 /* Temporarily add a dash to the end of the echo string if it's not
489 empty, so that it serves as a mini-prompt for the very next
495 /* Do nothing if not echoing at all. */
496 if (NILP (KVAR (current_kboard
, echo_string
)))
499 if (!current_kboard
->immediate_echo
500 && SCHARS (KVAR (current_kboard
, echo_string
)) == 0)
503 /* Do nothing if we just printed a prompt. */
504 if (current_kboard
->echo_after_prompt
505 == SCHARS (KVAR (current_kboard
, echo_string
)))
508 /* Do nothing if we have already put a dash at the end. */
509 if (SCHARS (KVAR (current_kboard
, echo_string
)) > 1)
511 Lisp_Object last_char
, prev_char
, idx
;
513 idx
= make_number (SCHARS (KVAR (current_kboard
, echo_string
)) - 2);
514 prev_char
= Faref (KVAR (current_kboard
, echo_string
), idx
);
516 idx
= make_number (SCHARS (KVAR (current_kboard
, echo_string
)) - 1);
517 last_char
= Faref (KVAR (current_kboard
, echo_string
), idx
);
519 if (XINT (last_char
) == '-' && XINT (prev_char
) != ' ')
523 /* Put a dash at the end of the buffer temporarily,
524 but make it go away when the next character is added. */
525 AUTO_STRING (dash
, "-");
526 kset_echo_string (current_kboard
,
527 concat2 (KVAR (current_kboard
, echo_string
), dash
));
534 if (current_kboard
->immediate_echo
)
537 kset_echo_string (current_kboard
,
538 call0 (Qinternal_echo_keystrokes_prefix
));
540 for (i
= 0; i
< this_command_key_count
; i
++)
544 c
= AREF (this_command_keys
, i
);
545 if (! (EVENT_HAS_PARAMETERS (c
)
546 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
554 /* Display the current echo string, and begin echoing if not already
560 if (!current_kboard
->immediate_echo
)
562 current_kboard
->immediate_echo
= true;
564 /* Put a dash at the end to invite the user to type more. */
569 /* FIXME: Use call (Qmessage) so it can be advised (e.g. emacspeak). */
570 message3_nolog (KVAR (current_kboard
, echo_string
));
573 /* Record in what buffer we echoed, and from which kboard. */
574 echo_message_buffer
= echo_area_buffer
[0];
575 echo_kboard
= current_kboard
;
577 if (waiting_for_input
&& !NILP (Vquit_flag
))
578 quit_throw_to_read_char (0);
581 /* Turn off echoing, for the start of a new command. */
584 cancel_echoing (void)
586 current_kboard
->immediate_echo
= false;
587 current_kboard
->echo_after_prompt
= -1;
588 kset_echo_string (current_kboard
, Qnil
);
589 ok_to_echo_at_next_pause
= NULL
;
591 echo_message_buffer
= Qnil
;
594 /* Return the length of the current echo string. */
599 return (STRINGP (KVAR (current_kboard
, echo_string
))
600 ? SCHARS (KVAR (current_kboard
, echo_string
))
604 /* Truncate the current echo message to its first LEN chars.
605 This and echo_char get used by read_key_sequence when the user
606 switches frames while entering a key sequence. */
609 echo_truncate (ptrdiff_t nchars
)
611 if (STRINGP (KVAR (current_kboard
, echo_string
)))
612 kset_echo_string (current_kboard
,
613 Fsubstring (KVAR (current_kboard
, echo_string
),
614 make_number (0), make_number (nchars
)));
615 truncate_echo_area (nchars
);
619 /* Functions for manipulating this_command_keys. */
621 add_command_key (Lisp_Object key
)
623 if (this_command_key_count
>= ASIZE (this_command_keys
))
624 this_command_keys
= larger_vector (this_command_keys
, 1, -1);
626 ASET (this_command_keys
, this_command_key_count
, key
);
627 ++this_command_key_count
;
632 recursive_edit_1 (void)
634 ptrdiff_t count
= SPECPDL_INDEX ();
637 if (command_loop_level
> 0)
639 specbind (Qstandard_output
, Qt
);
640 specbind (Qstandard_input
, Qt
);
643 #ifdef HAVE_WINDOW_SYSTEM
644 /* The command loop has started an hourglass timer, so we have to
645 cancel it here, otherwise it will fire because the recursive edit
646 can take some time. Do not check for display_hourglass_p here,
647 because it could already be nil. */
651 /* This function may have been called from a debugger called from
652 within redisplay, for instance by Edebugging a function called
653 from fontification-functions. We want to allow redisplay in
654 the debugging session.
656 The recursive edit is left with a `(throw exit ...)'. The `exit'
657 tag is not caught anywhere in redisplay, i.e. when we leave the
658 recursive edit, the original redisplay leading to the recursive
659 edit will be unwound. The outcome should therefore be safe. */
660 specbind (Qinhibit_redisplay
, Qnil
);
663 val
= command_loop ();
665 Fsignal (Qquit
, Qnil
);
666 /* Handle throw from read_minibuf when using minibuffer
667 while it's active but we're in another window. */
669 xsignal1 (Qerror
, val
);
671 return unbind_to (count
, Qnil
);
674 /* When an auto-save happens, record the "time", and don't do again soon. */
677 record_auto_save (void)
679 last_auto_save
= num_nonmacro_input_events
;
682 /* Make an auto save happen as soon as possible at command level. */
686 force_auto_save_soon (void)
688 last_auto_save
= - auto_save_interval
- 1;
690 record_asynch_buffer_change ();
694 DEFUN ("recursive-edit", Frecursive_edit
, Srecursive_edit
, 0, 0, "",
695 doc
: /* Invoke the editor command loop recursively.
696 To get out of the recursive edit, a command can throw to ‘exit’ -- for
697 instance ‘(throw \\='exit nil)’.
698 If you throw a value other than t, ‘recursive-edit’ returns normally
699 to the function that called it. Throwing a t value causes
700 ‘recursive-edit’ to quit, so that control returns to the command loop
703 This function is called by the editor initialization to begin editing. */)
706 ptrdiff_t count
= SPECPDL_INDEX ();
709 /* If we enter while input is blocked, don't lock up here.
710 This may happen through the debugger during redisplay. */
711 if (input_blocked_p ())
714 if (command_loop_level
>= 0
715 && current_buffer
!= XBUFFER (XWINDOW (selected_window
)->contents
))
716 buffer
= Fcurrent_buffer ();
720 /* Don't do anything interesting between the increment and the
721 record_unwind_protect! Otherwise, we could get distracted and
722 never decrement the counter again. */
723 command_loop_level
++;
724 update_mode_lines
= 17;
725 record_unwind_protect (recursive_edit_unwind
, buffer
);
727 /* If we leave recursive_edit_1 below with a `throw' for instance,
728 like it is done in the splash screen display, we have to
729 make sure that we restore single_kboard as command_loop_1
730 would have done if it were left normally. */
731 if (command_loop_level
> 0)
732 temporarily_switch_to_single_kboard (SELECTED_FRAME ());
735 return unbind_to (count
, Qnil
);
739 recursive_edit_unwind (Lisp_Object buffer
)
741 if (BUFFERP (buffer
))
742 Fset_buffer (buffer
);
744 command_loop_level
--;
745 update_mode_lines
= 18;
749 #if 0 /* These two functions are now replaced with
750 temporarily_switch_to_single_kboard. */
754 #if 0 /* Theory: if there's anything in Vunread_command_events,
755 it will right away be read by read_key_sequence,
756 and then if we do switch KBOARDS, it will go into the side
757 queue then. So we don't need to do anything special here -- rms. */
758 if (CONSP (Vunread_command_events
))
760 current_kboard
->kbd_queue
761 = nconc2 (Vunread_command_events
, current_kboard
->kbd_queue
);
762 current_kboard
->kbd_queue_has_data
= true;
764 Vunread_command_events
= Qnil
;
766 single_kboard
= false;
769 /* Switch to the single-kboard state, making current_kboard
770 the only KBOARD from which further input is accepted. */
773 single_kboard_state ()
775 single_kboard
= true;
779 /* If we're in single_kboard state for kboard KBOARD,
783 not_single_kboard_state (KBOARD
*kboard
)
785 if (kboard
== current_kboard
)
786 single_kboard
= false;
789 /* Maintain a stack of kboards, so other parts of Emacs
790 can switch temporarily to the kboard of a given frame
791 and then revert to the previous status. */
796 struct kboard_stack
*next
;
799 static struct kboard_stack
*kboard_stack
;
802 push_kboard (struct kboard
*k
)
804 struct kboard_stack
*p
= xmalloc (sizeof *p
);
806 p
->next
= kboard_stack
;
807 p
->kboard
= current_kboard
;
817 struct kboard_stack
*p
= kboard_stack
;
819 for (t
= terminal_list
; t
; t
= t
->next_terminal
)
821 if (t
->kboard
== p
->kboard
)
823 current_kboard
= p
->kboard
;
830 /* The terminal we remembered has been deleted. */
831 current_kboard
= FRAME_KBOARD (SELECTED_FRAME ());
832 single_kboard
= false;
834 kboard_stack
= p
->next
;
838 /* Switch to single_kboard mode, making current_kboard the only KBOARD
839 from which further input is accepted. If F is non-nil, set its
840 KBOARD as the current keyboard.
842 This function uses record_unwind_protect_int to return to the previous
845 If Emacs is already in single_kboard mode, and F's keyboard is
846 locked, then this function will throw an error. */
849 temporarily_switch_to_single_kboard (struct frame
*f
)
851 bool was_locked
= single_kboard
;
854 if (f
!= NULL
&& FRAME_KBOARD (f
) != current_kboard
)
855 /* We can not switch keyboards while in single_kboard mode.
856 In rare cases, Lisp code may call `recursive-edit' (or
857 `read-minibuffer' or `y-or-n-p') after it switched to a
858 locked frame. For example, this is likely to happen
859 when server.el connects to a new terminal while Emacs is in
860 single_kboard mode. It is best to throw an error instead
861 of presenting the user with a frozen screen. */
862 error ("Terminal %d is locked, cannot read from it",
863 FRAME_TERMINAL (f
)->id
);
865 /* This call is unnecessary, but helps
866 `restore_kboard_configuration' discover if somebody changed
867 `current_kboard' behind our back. */
868 push_kboard (current_kboard
);
871 current_kboard
= FRAME_KBOARD (f
);
872 single_kboard
= true;
873 record_unwind_protect_int (restore_kboard_configuration
, was_locked
);
876 #if 0 /* This function is not needed anymore. */
878 record_single_kboard_state ()
881 push_kboard (current_kboard
);
882 record_unwind_protect_int (restore_kboard_configuration
, single_kboard
);
887 restore_kboard_configuration (int was_locked
)
889 single_kboard
= was_locked
;
892 struct kboard
*prev
= current_kboard
;
894 /* The pop should not change the kboard. */
895 if (single_kboard
&& current_kboard
!= prev
)
901 /* Handle errors that are not handled at inner levels
902 by printing an error message and returning to the editor command loop. */
905 cmd_error (Lisp_Object data
)
907 Lisp_Object old_level
, old_length
;
908 char macroerror
[sizeof "After..kbd macro iterations: "
909 + INT_STRLEN_BOUND (EMACS_INT
)];
911 #ifdef HAVE_WINDOW_SYSTEM
912 if (display_hourglass_p
)
916 if (!NILP (executing_kbd_macro
))
918 if (executing_kbd_macro_iterations
== 1)
919 sprintf (macroerror
, "After 1 kbd macro iteration: ");
921 sprintf (macroerror
, "After %"pI
"d kbd macro iterations: ",
922 executing_kbd_macro_iterations
);
927 Vstandard_output
= Qt
;
928 Vstandard_input
= Qt
;
929 Vexecuting_kbd_macro
= Qnil
;
930 executing_kbd_macro
= Qnil
;
931 kset_prefix_arg (current_kboard
, Qnil
);
932 kset_last_prefix_arg (current_kboard
, Qnil
);
935 /* Avoid unquittable loop if data contains a circular list. */
936 old_level
= Vprint_level
;
937 old_length
= Vprint_length
;
938 XSETFASTINT (Vprint_level
, 10);
939 XSETFASTINT (Vprint_length
, 10);
940 cmd_error_internal (data
, macroerror
);
941 Vprint_level
= old_level
;
942 Vprint_length
= old_length
;
945 Vinhibit_quit
= Qnil
;
947 return make_number (0);
950 /* Take actions on handling an error. DATA is the data that describes
953 CONTEXT is a C-string containing ASCII characters only which
954 describes the context in which the error happened. If we need to
955 generalize CONTEXT to allow multibyte characters, make it a Lisp
959 cmd_error_internal (Lisp_Object data
, const char *context
)
961 /* The immediate context is not interesting for Quits,
962 since they are asynchronous. */
963 if (EQ (XCAR (data
), Qquit
))
964 Vsignaling_function
= Qnil
;
969 /* Use user's specified output function if any. */
970 if (!NILP (Vcommand_error_function
))
971 call3 (Vcommand_error_function
, data
,
972 context
? build_string (context
) : empty_unibyte_string
,
973 Vsignaling_function
);
975 Vsignaling_function
= Qnil
;
978 DEFUN ("command-error-default-function", Fcommand_error_default_function
,
979 Scommand_error_default_function
, 3, 3, 0,
980 doc
: /* Produce default output for unhandled error message.
981 Default value of `command-error-function'. */)
982 (Lisp_Object data
, Lisp_Object context
, Lisp_Object signal
)
984 struct frame
*sf
= SELECTED_FRAME ();
986 CHECK_STRING (context
);
988 /* If the window system or terminal frame hasn't been initialized
989 yet, or we're not interactive, write the message to stderr and exit. */
990 if (!sf
->glyphs_initialized_p
991 /* The initial frame is a special non-displaying frame. It
992 will be current in daemon mode when there are no frames
993 to display, and in non-daemon mode before the real frame
994 has finished initializing. If an error is thrown in the
995 latter case while creating the frame, then the frame
996 will never be displayed, so the safest thing to do is
997 write to stderr and quit. In daemon mode, there are
998 many other potential errors that do not prevent frames
999 from being created, so continuing as normal is better in
1001 || (!IS_DAEMON
&& FRAME_INITIAL_P (sf
))
1004 print_error_message (data
, Qexternal_debugging_output
,
1005 SSDATA (context
), signal
);
1006 Fterpri (Qexternal_debugging_output
, Qnil
);
1007 Fkill_emacs (make_number (-1));
1011 clear_message (1, 0);
1013 message_log_maybe_newline ();
1016 print_error_message (data
, Qt
, SSDATA (context
), signal
);
1021 static Lisp_Object
command_loop_2 (Lisp_Object
);
1022 static Lisp_Object
top_level_1 (Lisp_Object
);
1024 /* Entry to editor-command-loop.
1025 This level has the catches for exiting/returning to editor command loop.
1026 It returns nil to exit recursive edit, t to abort it. */
1031 #ifdef HAVE_STACK_OVERFLOW_HANDLING
1032 /* At least on GNU/Linux, saving signal mask is important here. */
1033 if (sigsetjmp (return_to_command_loop
, 1) != 0)
1035 /* Comes here from handle_sigsegv (see sysdep.c) and
1036 stack_overflow_handler (see w32fns.c). */
1038 w32_reset_stack_overflow_guard ();
1041 Vinternal__top_level_message
= recover_top_level_message
;
1044 Vinternal__top_level_message
= regular_top_level_message
;
1045 #endif /* HAVE_STACK_OVERFLOW_HANDLING */
1046 if (command_loop_level
> 0 || minibuf_level
> 0)
1049 val
= internal_catch (Qexit
, command_loop_2
, Qnil
);
1050 executing_kbd_macro
= Qnil
;
1056 internal_catch (Qtop_level
, top_level_1
, Qnil
);
1057 internal_catch (Qtop_level
, command_loop_2
, Qnil
);
1058 executing_kbd_macro
= Qnil
;
1060 /* End of file in -batch run causes exit here. */
1066 /* Here we catch errors in execution of commands within the
1067 editing loop, and reenter the editing loop.
1068 When there is an error, cmd_error runs and returns a non-nil
1069 value to us. A value of nil means that command_loop_1 itself
1070 returned due to end of file (or end of kbd macro). */
1073 command_loop_2 (Lisp_Object ignore
)
1075 register Lisp_Object val
;
1078 val
= internal_condition_case (command_loop_1
, Qerror
, cmd_error
);
1079 while (!NILP (val
));
1087 return Feval (Vtop_level
, Qnil
);
1091 top_level_1 (Lisp_Object ignore
)
1093 /* On entry to the outer level, run the startup file. */
1094 if (!NILP (Vtop_level
))
1095 internal_condition_case (top_level_2
, Qerror
, cmd_error
);
1096 else if (!NILP (Vpurify_flag
))
1097 message1 ("Bare impure Emacs (standard Lisp code not loaded)");
1099 message1 ("Bare Emacs (standard Lisp code not loaded)");
1103 DEFUN ("top-level", Ftop_level
, Stop_level
, 0, 0, "",
1104 doc
: /* Exit all recursive editing levels.
1105 This also exits all active minibuffers. */
1106 attributes
: noreturn
)
1109 #ifdef HAVE_WINDOW_SYSTEM
1110 if (display_hourglass_p
)
1111 cancel_hourglass ();
1114 /* Unblock input if we enter with input blocked. This may happen if
1115 redisplay traps e.g. during tool-bar update with input blocked. */
1116 totally_unblock_input ();
1118 Fthrow (Qtop_level
, Qnil
);
1121 static _Noreturn
void
1122 user_error (const char *msg
)
1124 xsignal1 (Quser_error
, build_string (msg
));
1127 /* _Noreturn will be added to prototype by make-docfile. */
1128 DEFUN ("exit-recursive-edit", Fexit_recursive_edit
, Sexit_recursive_edit
, 0, 0, "",
1129 doc
: /* Exit from the innermost recursive edit or minibuffer. */
1130 attributes
: noreturn
)
1133 if (command_loop_level
> 0 || minibuf_level
> 0)
1134 Fthrow (Qexit
, Qnil
);
1136 user_error ("No recursive edit is in progress");
1139 /* _Noreturn will be added to prototype by make-docfile. */
1140 DEFUN ("abort-recursive-edit", Fabort_recursive_edit
, Sabort_recursive_edit
, 0, 0, "",
1141 doc
: /* Abort the command that requested this recursive edit or minibuffer input. */
1142 attributes
: noreturn
)
1145 if (command_loop_level
> 0 || minibuf_level
> 0)
1148 user_error ("No recursive edit is in progress");
1151 /* Restore mouse tracking enablement. See Ftrack_mouse for the only use
1152 of this function. */
1155 tracking_off (Lisp_Object old_value
)
1157 do_mouse_tracking
= old_value
;
1158 if (NILP (old_value
))
1160 /* Redisplay may have been preempted because there was input
1161 available, and it assumes it will be called again after the
1162 input has been processed. If the only input available was
1163 the sort that we have just disabled, then we need to call
1165 if (!readable_events (READABLE_EVENTS_DO_TIMERS_NOW
))
1167 redisplay_preserve_echo_area (6);
1168 get_input_pending (READABLE_EVENTS_DO_TIMERS_NOW
);
1173 DEFUN ("internal--track-mouse", Ftrack_mouse
, Strack_mouse
, 1, 1, 0,
1174 doc
: /* Call BODYFUN with mouse movement events enabled. */)
1175 (Lisp_Object bodyfun
)
1177 ptrdiff_t count
= SPECPDL_INDEX ();
1180 record_unwind_protect (tracking_off
, do_mouse_tracking
);
1182 do_mouse_tracking
= Qt
;
1184 val
= call0 (bodyfun
);
1185 return unbind_to (count
, val
);
1188 /* If mouse has moved on some frame, return one of those frames.
1192 If ignore_mouse_drag_p is non-zero, ignore (implicit) mouse movement
1193 after resizing the tool-bar window. */
1195 bool ignore_mouse_drag_p
;
1197 static struct frame
*
1198 some_mouse_moved (void)
1200 Lisp_Object tail
, frame
;
1202 if (ignore_mouse_drag_p
)
1204 /* ignore_mouse_drag_p = 0; */
1208 FOR_EACH_FRAME (tail
, frame
)
1210 if (XFRAME (frame
)->mouse_moved
)
1211 return XFRAME (frame
);
1218 /* This is the actual command reading loop,
1219 sans error-handling encapsulation. */
1221 static int read_key_sequence (Lisp_Object
*, int, Lisp_Object
,
1222 bool, bool, bool, bool);
1223 static void adjust_point_for_property (ptrdiff_t, bool);
1225 /* The last boundary auto-added to buffer-undo-list. */
1226 Lisp_Object last_undo_boundary
;
1229 command_loop_1 (void)
1232 Lisp_Object keybuf
[30];
1234 EMACS_INT prev_modiff
= 0;
1235 struct buffer
*prev_buffer
= NULL
;
1236 bool already_adjusted
= 0;
1238 kset_prefix_arg (current_kboard
, Qnil
);
1239 kset_last_prefix_arg (current_kboard
, Qnil
);
1240 Vdeactivate_mark
= Qnil
;
1241 waiting_for_input
= false;
1244 this_command_key_count
= 0;
1245 this_single_command_key_start
= 0;
1247 if (NILP (Vmemory_full
))
1249 /* Make sure this hook runs after commands that get errors and
1250 throw to top level. */
1251 /* Note that the value cell will never directly contain nil
1252 if the symbol is a local variable. */
1253 if (!NILP (Vpost_command_hook
) && !NILP (Vrun_hooks
))
1254 safe_run_hooks (Qpost_command_hook
);
1256 /* If displaying a message, resize the echo area window to fit
1257 that message's size exactly. */
1258 if (!NILP (echo_area_buffer
[0]))
1259 resize_echo_area_exactly ();
1261 /* If there are warnings waiting, process them. */
1262 if (!NILP (Vdelayed_warnings_list
))
1263 safe_run_hooks (Qdelayed_warnings_hook
);
1265 if (!NILP (Vdeferred_action_list
))
1266 safe_run_hooks (Qdeferred_action_function
);
1269 /* Do this after running Vpost_command_hook, for consistency. */
1270 kset_last_command (current_kboard
, Vthis_command
);
1271 kset_real_last_command (current_kboard
, Vreal_this_command
);
1272 if (!CONSP (last_command_event
))
1273 kset_last_repeatable_command (current_kboard
, Vreal_this_command
);
1277 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1280 /* Make sure the current window's buffer is selected. */
1281 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->contents
));
1283 /* Display any malloc warning that just came out. Use while because
1284 displaying one warning can cause another. */
1286 while (pending_malloc_warning
)
1287 display_malloc_warning ();
1289 Vdeactivate_mark
= Qnil
;
1291 /* Don't ignore mouse movements for more than a single command
1292 loop. (This flag is set in xdisp.c whenever the tool bar is
1293 resized, because the resize moves text up or down, and would
1294 generate false mouse drag events if we don't ignore them.) */
1295 ignore_mouse_drag_p
= 0;
1297 /* If minibuffer on and echo area in use,
1298 wait a short time and redraw minibuffer. */
1301 && !NILP (echo_area_buffer
[0])
1302 && EQ (minibuf_window
, echo_area_window
)
1303 && NUMBERP (Vminibuffer_message_timeout
))
1305 /* Bind inhibit-quit to t so that C-g gets read in
1306 rather than quitting back to the minibuffer. */
1307 ptrdiff_t count
= SPECPDL_INDEX ();
1308 specbind (Qinhibit_quit
, Qt
);
1310 sit_for (Vminibuffer_message_timeout
, 0, 2);
1312 /* Clear the echo area. */
1314 safe_run_hooks (Qecho_area_clear_hook
);
1316 unbind_to (count
, Qnil
);
1318 /* If a C-g came in before, treat it as input now. */
1319 if (!NILP (Vquit_flag
))
1322 Vunread_command_events
= list1 (make_number (quit_char
));
1326 /* If it has changed current-menubar from previous value,
1327 really recompute the menubar from the value. */
1328 if (! NILP (Vlucid_menu_bar_dirty_flag
)
1329 && !NILP (Ffboundp (Qrecompute_lucid_menubar
)))
1330 call0 (Qrecompute_lucid_menubar
);
1332 Vthis_command
= Qnil
;
1333 Vreal_this_command
= Qnil
;
1334 Vthis_original_command
= Qnil
;
1335 Vthis_command_keys_shift_translated
= Qnil
;
1337 /* Read next key sequence; i gets its length. */
1338 i
= read_key_sequence (keybuf
, ARRAYELTS (keybuf
),
1341 /* A filter may have run while we were reading the input. */
1342 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1344 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->contents
));
1348 /* Now we have read a key sequence of length I,
1349 or else I is 0 and we found end of file. */
1351 if (i
== 0) /* End of file -- happens only in */
1352 return Qnil
; /* a kbd macro, at the end. */
1353 /* -1 means read_key_sequence got a menu that was rejected.
1354 Just loop around and read another command. */
1358 this_command_key_count
= 0;
1359 this_single_command_key_start
= 0;
1363 last_command_event
= keybuf
[i
- 1];
1365 /* If the previous command tried to force a specific window-start,
1366 forget about that, in case this command moves point far away
1367 from that position. But also throw away beg_unchanged and
1368 end_unchanged information in that case, so that redisplay will
1369 update the whole window properly. */
1370 if (XWINDOW (selected_window
)->force_start
)
1373 XWINDOW (selected_window
)->force_start
= 0;
1374 b
= XBUFFER (XWINDOW (selected_window
)->contents
);
1375 BUF_BEG_UNCHANGED (b
) = BUF_END_UNCHANGED (b
) = 0;
1378 cmd
= read_key_sequence_cmd
;
1379 if (!NILP (Vexecuting_kbd_macro
))
1381 if (!NILP (Vquit_flag
))
1383 Vexecuting_kbd_macro
= Qt
;
1384 QUIT
; /* Make some noise. */
1385 /* Will return since macro now empty. */
1389 /* Do redisplay processing after this command except in special
1390 cases identified below. */
1391 prev_buffer
= current_buffer
;
1392 prev_modiff
= MODIFF
;
1393 last_point_position
= PT
;
1395 /* By default, we adjust point to a boundary of a region that
1396 has such a property that should be treated intangible
1397 (e.g. composition, display). But, some commands will set
1398 this variable differently. */
1399 Vdisable_point_adjustment
= Qnil
;
1401 /* Process filters and timers may have messed with deactivate-mark.
1402 reset it before we execute the command. */
1403 Vdeactivate_mark
= Qnil
;
1405 /* Remap command through active keymaps. */
1406 Vthis_original_command
= cmd
;
1407 if (!NILP (read_key_sequence_remapped
))
1408 cmd
= read_key_sequence_remapped
;
1410 /* Execute the command. */
1413 total_keys
+= total_keys
< NUM_RECENT_KEYS
;
1414 ASET (recent_keys
, recent_keys_index
,
1416 if (++recent_keys_index
>= NUM_RECENT_KEYS
)
1417 recent_keys_index
= 0;
1419 Vthis_command
= cmd
;
1420 Vreal_this_command
= cmd
;
1421 safe_run_hooks (Qpre_command_hook
);
1423 already_adjusted
= 0;
1425 if (NILP (Vthis_command
))
1426 /* nil means key is undefined. */
1430 /* Here for a command that isn't executed directly. */
1432 #ifdef HAVE_WINDOW_SYSTEM
1433 ptrdiff_t scount
= SPECPDL_INDEX ();
1435 if (display_hourglass_p
1436 && NILP (Vexecuting_kbd_macro
))
1438 record_unwind_protect_void (cancel_hourglass
);
1444 Lisp_Object undo
= BVAR (current_buffer
, undo_list
);
1447 = (EQ (undo
, BVAR (current_buffer
, undo_list
))
1448 ? Qnil
: BVAR (current_buffer
, undo_list
));
1450 call1 (Qcommand_execute
, Vthis_command
);
1452 #ifdef HAVE_WINDOW_SYSTEM
1453 /* Do not check display_hourglass_p here, because
1454 `command-execute' could change it, but we should cancel
1455 hourglass cursor anyway.
1456 But don't cancel the hourglass within a macro
1457 just because a command in the macro finishes. */
1458 if (NILP (Vexecuting_kbd_macro
))
1459 unbind_to (scount
, Qnil
);
1462 kset_last_prefix_arg (current_kboard
, Vcurrent_prefix_arg
);
1464 safe_run_hooks (Qpost_command_hook
);
1466 /* If displaying a message, resize the echo area window to fit
1467 that message's size exactly. */
1468 if (!NILP (echo_area_buffer
[0]))
1469 resize_echo_area_exactly ();
1471 /* If there are warnings waiting, process them. */
1472 if (!NILP (Vdelayed_warnings_list
))
1473 safe_run_hooks (Qdelayed_warnings_hook
);
1475 safe_run_hooks (Qdeferred_action_function
);
1477 kset_last_command (current_kboard
, Vthis_command
);
1478 kset_real_last_command (current_kboard
, Vreal_this_command
);
1479 if (!CONSP (last_command_event
))
1480 kset_last_repeatable_command (current_kboard
, Vreal_this_command
);
1482 this_command_key_count
= 0;
1483 this_single_command_key_start
= 0;
1485 if (current_kboard
->immediate_echo
1486 && !NILP (call0 (Qinternal_echo_keystrokes_prefix
)))
1488 current_kboard
->immediate_echo
= false;
1489 /* Refresh the echo message. */
1495 if (!NILP (BVAR (current_buffer
, mark_active
))
1496 && !NILP (Vrun_hooks
))
1498 /* In Emacs 22, setting transient-mark-mode to `only' was a
1499 way of turning it on for just one command. This usage is
1500 obsolete, but support it anyway. */
1501 if (EQ (Vtransient_mark_mode
, Qidentity
))
1502 Vtransient_mark_mode
= Qnil
;
1503 else if (EQ (Vtransient_mark_mode
, Qonly
))
1504 Vtransient_mark_mode
= Qidentity
;
1506 if (!NILP (Vdeactivate_mark
))
1507 /* If `select-active-regions' is non-nil, this call to
1508 `deactivate-mark' also sets the PRIMARY selection. */
1509 call0 (Qdeactivate_mark
);
1512 /* Even if not deactivating the mark, set PRIMARY if
1513 `select-active-regions' is non-nil. */
1514 if (!NILP (Fwindow_system (Qnil
))
1515 /* Even if mark_active is non-nil, the actual buffer
1516 marker may not have been set yet (Bug#7044). */
1517 && XMARKER (BVAR (current_buffer
, mark
))->buffer
1518 && (EQ (Vselect_active_regions
, Qonly
)
1519 ? EQ (CAR_SAFE (Vtransient_mark_mode
), Qonly
)
1520 : (!NILP (Vselect_active_regions
)
1521 && !NILP (Vtransient_mark_mode
)))
1522 && NILP (Fmemq (Vthis_command
,
1523 Vselection_inhibit_update_commands
)))
1526 = call1 (Fsymbol_value (Qregion_extract_function
), Qnil
);
1527 if (XINT (Flength (txt
)) > 0)
1528 /* Don't set empty selections. */
1529 call2 (Qgui_set_selection
, QPRIMARY
, txt
);
1532 if (current_buffer
!= prev_buffer
|| MODIFF
!= prev_modiff
)
1533 run_hook (intern ("activate-mark-hook"));
1536 Vsaved_region_selection
= Qnil
;
1541 if (current_buffer
== prev_buffer
1542 && XBUFFER (XWINDOW (selected_window
)->contents
) == current_buffer
1543 && last_point_position
!= PT
1544 && NILP (Vdisable_point_adjustment
)
1545 && NILP (Vglobal_disable_point_adjustment
))
1547 if (last_point_position
> BEGV
1548 && last_point_position
< ZV
1549 && (composition_adjust_point (last_point_position
,
1550 last_point_position
)
1551 != last_point_position
))
1552 /* The last point was temporarily set within a grapheme
1553 cluster to prevent automatic composition. To recover
1554 the automatic composition, we must update the
1556 windows_or_buffers_changed
= 21;
1557 if (!already_adjusted
)
1558 adjust_point_for_property (last_point_position
,
1559 MODIFF
!= prev_modiff
);
1562 /* Install chars successfully executed in kbd macro. */
1564 if (!NILP (KVAR (current_kboard
, defining_kbd_macro
))
1565 && NILP (KVAR (current_kboard
, Vprefix_arg
)))
1566 finalize_kbd_macro_chars ();
1571 read_menu_command (void)
1573 Lisp_Object keybuf
[30];
1574 ptrdiff_t count
= SPECPDL_INDEX ();
1577 /* We don't want to echo the keystrokes while navigating the
1579 specbind (Qecho_keystrokes
, make_number (0));
1581 i
= read_key_sequence (keybuf
, ARRAYELTS (keybuf
),
1584 unbind_to (count
, Qnil
);
1586 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1588 if (i
== 0 || i
== -1)
1591 return read_key_sequence_cmd
;
1594 /* Adjust point to a boundary of a region that has such a property
1595 that should be treated intangible. For the moment, we check
1596 `composition', `display' and `invisible' properties.
1597 LAST_PT is the last position of point. */
1600 adjust_point_for_property (ptrdiff_t last_pt
, bool modified
)
1603 Lisp_Object val
, overlay
, tmp
;
1604 /* When called after buffer modification, we should temporarily
1605 suppress the point adjustment for automatic composition so that a
1606 user can keep inserting another character at point or keep
1607 deleting characters around point. */
1608 bool check_composition
= ! modified
;
1609 bool check_display
= true, check_invisible
= true;
1610 ptrdiff_t orig_pt
= PT
;
1612 eassert (XBUFFER (XWINDOW (selected_window
)->contents
) == current_buffer
);
1614 /* FIXME: cycling is probably not necessary because these properties
1615 can't be usefully combined anyway. */
1616 while (check_composition
|| check_display
|| check_invisible
)
1618 /* FIXME: check `intangible'. */
1619 if (check_composition
1620 && PT
> BEGV
&& PT
< ZV
1621 && (beg
= composition_adjust_point (last_pt
, PT
)) != PT
)
1624 check_display
= check_invisible
= true;
1626 check_composition
= false;
1628 && PT
> BEGV
&& PT
< ZV
1629 && !NILP (val
= get_char_property_and_overlay
1630 (make_number (PT
), Qdisplay
, selected_window
,
1632 && display_prop_intangible_p (val
, overlay
, PT
, PT_BYTE
)
1633 && (!OVERLAYP (overlay
)
1634 ? get_property_and_range (PT
, Qdisplay
, &val
, &beg
, &end
, Qnil
)
1635 : (beg
= OVERLAY_POSITION (OVERLAY_START (overlay
)),
1636 end
= OVERLAY_POSITION (OVERLAY_END (overlay
))))
1637 && (beg
< PT
/* && end > PT <- It's always the case. */
1638 || (beg
<= PT
&& STRINGP (val
) && SCHARS (val
) == 0)))
1641 SET_PT (PT
< last_pt
1642 ? (STRINGP (val
) && SCHARS (val
) == 0
1643 ? max (beg
- 1, BEGV
)
1646 check_composition
= check_invisible
= true;
1648 check_display
= false;
1649 if (check_invisible
&& PT
> BEGV
&& PT
< ZV
)
1652 bool ellipsis
= false;
1655 /* Find boundaries `beg' and `end' of the invisible area, if any. */
1658 /* FIXME: We should stop if we find a spot between
1659 two runs of `invisible' where inserted text would
1660 be visible. This is important when we have two
1661 invisible boundaries that enclose an area: if the
1662 area is empty, we need this test in order to make
1663 it possible to place point in the middle rather
1664 than skip both boundaries. However, this code
1665 also stops anywhere in a non-sticky text-property,
1666 which breaks (e.g.) Org mode. */
1667 && (val
= Fget_pos_property (make_number (end
),
1669 TEXT_PROP_MEANS_INVISIBLE (val
))
1671 && !NILP (val
= get_char_property_and_overlay
1672 (make_number (end
), Qinvisible
, Qnil
, &overlay
))
1673 && (inv
= TEXT_PROP_MEANS_INVISIBLE (val
)))
1675 ellipsis
= ellipsis
|| inv
> 1
1676 || (OVERLAYP (overlay
)
1677 && (!NILP (Foverlay_get (overlay
, Qafter_string
))
1678 || !NILP (Foverlay_get (overlay
, Qbefore_string
))));
1679 tmp
= Fnext_single_char_property_change
1680 (make_number (end
), Qinvisible
, Qnil
, Qnil
);
1681 end
= NATNUMP (tmp
) ? XFASTINT (tmp
) : ZV
;
1685 && (val
= Fget_pos_property (make_number (beg
),
1687 TEXT_PROP_MEANS_INVISIBLE (val
))
1689 && !NILP (val
= get_char_property_and_overlay
1690 (make_number (beg
- 1), Qinvisible
, Qnil
, &overlay
))
1691 && (inv
= TEXT_PROP_MEANS_INVISIBLE (val
)))
1693 ellipsis
= ellipsis
|| inv
> 1
1694 || (OVERLAYP (overlay
)
1695 && (!NILP (Foverlay_get (overlay
, Qafter_string
))
1696 || !NILP (Foverlay_get (overlay
, Qbefore_string
))));
1697 tmp
= Fprevious_single_char_property_change
1698 (make_number (beg
), Qinvisible
, Qnil
, Qnil
);
1699 beg
= NATNUMP (tmp
) ? XFASTINT (tmp
) : BEGV
;
1702 /* Move away from the inside area. */
1703 if (beg
< PT
&& end
> PT
)
1705 SET_PT ((orig_pt
== PT
&& (last_pt
< beg
|| last_pt
> end
))
1706 /* We haven't moved yet (so we don't need to fear
1707 infinite-looping) and we were outside the range
1708 before (so either end of the range still corresponds
1709 to a move in the right direction): pretend we moved
1710 less than we actually did, so that we still have
1711 more freedom below in choosing which end of the range
1713 ? (orig_pt
= -1, PT
< last_pt
? end
: beg
)
1714 /* We either have moved already or the last point
1715 was already in the range: we don't get to choose
1716 which end of the range we have to go to. */
1717 : (PT
< last_pt
? beg
: end
));
1718 check_composition
= check_display
= true;
1720 #if 0 /* This assertion isn't correct, because SET_PT may end up setting
1721 the point to something other than its argument, due to
1722 point-motion hooks, intangibility, etc. */
1723 eassert (PT
== beg
|| PT
== end
);
1726 /* Pretend the area doesn't exist if the buffer is not
1728 if (!modified
&& !ellipsis
&& beg
< end
)
1730 if (last_pt
== beg
&& PT
== end
&& end
< ZV
)
1731 (check_composition
= check_display
= true, SET_PT (end
+ 1));
1732 else if (last_pt
== end
&& PT
== beg
&& beg
> BEGV
)
1733 (check_composition
= check_display
= true, SET_PT (beg
- 1));
1734 else if (PT
== ((PT
< last_pt
) ? beg
: end
))
1735 /* We've already moved as far as we can. Trying to go
1736 to the other end would mean moving backwards and thus
1737 could lead to an infinite loop. */
1739 else if (val
= Fget_pos_property (make_number (PT
),
1741 TEXT_PROP_MEANS_INVISIBLE (val
)
1742 && (val
= (Fget_pos_property
1743 (make_number (PT
== beg
? end
: beg
),
1745 !TEXT_PROP_MEANS_INVISIBLE (val
)))
1746 (check_composition
= check_display
= true,
1747 SET_PT (PT
== beg
? end
: beg
));
1750 check_invisible
= false;
1754 /* Subroutine for safe_run_hooks: run the hook, which is ARGS[1]. */
1757 safe_run_hooks_1 (ptrdiff_t nargs
, Lisp_Object
*args
)
1759 eassert (nargs
== 2);
1760 return call0 (args
[1]);
1763 /* Subroutine for safe_run_hooks: handle an error by clearing out the function
1767 safe_run_hooks_error (Lisp_Object error
, ptrdiff_t nargs
, Lisp_Object
*args
)
1769 eassert (nargs
== 2);
1770 AUTO_STRING (format
, "Error in %s (%S): %S");
1771 Lisp_Object hook
= args
[0];
1772 Lisp_Object fun
= args
[1];
1773 CALLN (Fmessage
, format
, hook
, fun
, error
);
1779 Lisp_Object newval
= Qnil
;
1780 for (val
= find_symbol_value (hook
); CONSP (val
); val
= XCDR (val
))
1781 if (EQ (fun
, XCAR (val
)))
1784 newval
= Fcons (XCAR (val
), newval
);
1786 return Fset (hook
, Fnreverse (newval
));
1787 /* Not found in the local part of the hook. Let's look at the global
1790 for (val
= (NILP (Fdefault_boundp (hook
)) ? Qnil
1791 : Fdefault_value (hook
));
1792 CONSP (val
); val
= XCDR (val
))
1793 if (EQ (fun
, XCAR (val
)))
1796 newval
= Fcons (XCAR (val
), newval
);
1798 return Fset_default (hook
, Fnreverse (newval
));
1804 safe_run_hook_funcall (ptrdiff_t nargs
, Lisp_Object
*args
)
1806 eassert (nargs
== 2);
1807 /* Yes, run_hook_with_args works with args in the other order. */
1808 internal_condition_case_n (safe_run_hooks_1
,
1809 2, ((Lisp_Object
[]) {args
[1], args
[0]}),
1810 Qt
, safe_run_hooks_error
);
1814 /* If we get an error while running the hook, cause the hook variable
1815 to be nil. Also inhibit quits, so that C-g won't cause the hook
1816 to mysteriously evaporate. */
1819 safe_run_hooks (Lisp_Object hook
)
1821 ptrdiff_t count
= SPECPDL_INDEX ();
1823 specbind (Qinhibit_quit
, Qt
);
1824 run_hook_with_args (2, ((Lisp_Object
[]) {hook
, hook
}), safe_run_hook_funcall
);
1825 unbind_to (count
, Qnil
);
1829 /* Nonzero means polling for input is temporarily suppressed. */
1831 int poll_suppress_count
;
1834 #ifdef POLL_FOR_INPUT
1836 /* Asynchronous timer for polling. */
1838 static struct atimer
*poll_timer
;
1840 /* Poll for input, so that we catch a C-g if it comes in. */
1842 poll_for_input_1 (void)
1844 if (! input_blocked_p ()
1845 && !waiting_for_input
)
1849 /* Timer callback function for poll_timer. TIMER is equal to
1853 poll_for_input (struct atimer
*timer
)
1855 if (poll_suppress_count
== 0)
1856 pending_signals
= true;
1859 #endif /* POLL_FOR_INPUT */
1861 /* Begin signals to poll for input, if they are appropriate.
1862 This function is called unconditionally from various places. */
1865 start_polling (void)
1867 #ifdef POLL_FOR_INPUT
1868 /* XXX This condition was (read_socket_hook && !interrupt_input),
1869 but read_socket_hook is not global anymore. Let's pretend that
1871 if (!interrupt_input
)
1873 /* Turn alarm handling on unconditionally. It might have
1874 been turned off in process.c. */
1875 turn_on_atimers (1);
1877 /* If poll timer doesn't exist, or we need one with
1878 a different interval, start a new one. */
1879 if (poll_timer
== NULL
1880 || poll_timer
->interval
.tv_sec
!= polling_period
)
1882 time_t period
= max (1, min (polling_period
, TYPE_MAXIMUM (time_t)));
1883 struct timespec interval
= make_timespec (period
, 0);
1886 cancel_atimer (poll_timer
);
1888 poll_timer
= start_atimer (ATIMER_CONTINUOUS
, interval
,
1889 poll_for_input
, NULL
);
1892 /* Let the timer's callback function poll for input
1893 if this becomes zero. */
1894 --poll_suppress_count
;
1899 /* True if we are using polling to handle input asynchronously. */
1902 input_polling_used (void)
1904 #ifdef POLL_FOR_INPUT
1905 /* XXX This condition was (read_socket_hook && !interrupt_input),
1906 but read_socket_hook is not global anymore. Let's pretend that
1908 return !interrupt_input
;
1914 /* Turn off polling. */
1919 #ifdef POLL_FOR_INPUT
1920 /* XXX This condition was (read_socket_hook && !interrupt_input),
1921 but read_socket_hook is not global anymore. Let's pretend that
1923 if (!interrupt_input
)
1924 ++poll_suppress_count
;
1928 /* Set the value of poll_suppress_count to COUNT
1929 and start or stop polling accordingly. */
1932 set_poll_suppress_count (int count
)
1934 #ifdef POLL_FOR_INPUT
1935 if (count
== 0 && poll_suppress_count
!= 0)
1937 poll_suppress_count
= 1;
1940 else if (count
!= 0 && poll_suppress_count
== 0)
1944 poll_suppress_count
= count
;
1948 /* Bind polling_period to a value at least N.
1949 But don't decrease it. */
1952 bind_polling_period (int n
)
1954 #ifdef POLL_FOR_INPUT
1955 EMACS_INT
new = polling_period
;
1960 stop_other_atimers (poll_timer
);
1962 specbind (Qpolling_period
, make_number (new));
1963 /* Start a new alarm with the new period. */
1968 /* Apply the control modifier to CHARACTER. */
1971 make_ctrl_char (int c
)
1973 /* Save the upper bits here. */
1974 int upper
= c
& ~0177;
1976 if (! ASCII_CHAR_P (c
))
1977 return c
|= ctrl_modifier
;
1981 /* Everything in the columns containing the upper-case letters
1982 denotes a control character. */
1983 if (c
>= 0100 && c
< 0140)
1987 /* Set the shift modifier for a control char
1988 made from a shifted letter. But only for letters! */
1989 if (oc
>= 'A' && oc
<= 'Z')
1990 c
|= shift_modifier
;
1993 /* The lower-case letters denote control characters too. */
1994 else if (c
>= 'a' && c
<= 'z')
1997 /* Include the bits for control and shift
1998 only if the basic ASCII code can't indicate them. */
2002 /* Replace the high bits. */
2003 c
|= (upper
& ~ctrl_modifier
);
2008 /* Display the help-echo property of the character after the mouse pointer.
2009 Either show it in the echo area, or call show-help-function to display
2010 it by other means (maybe in a tooltip).
2012 If HELP is nil, that means clear the previous help echo.
2014 If HELP is a string, display that string. If HELP is a function,
2015 call it with OBJECT and POS as arguments; the function should
2016 return a help string or nil for none. For all other types of HELP,
2017 evaluate it to obtain a string.
2019 WINDOW is the window in which the help was generated, if any.
2020 It is nil if not in a window.
2022 If OBJECT is a buffer, POS is the position in the buffer where the
2023 `help-echo' text property was found.
2025 If OBJECT is an overlay, that overlay has a `help-echo' property,
2026 and POS is the position in the overlay's buffer under the mouse.
2028 If OBJECT is a string (an overlay string or a string displayed with
2029 the `display' property). POS is the position in that string under
2032 Note: this function may only be called with HELP nil or a string
2033 from X code running asynchronously. */
2036 show_help_echo (Lisp_Object help
, Lisp_Object window
, Lisp_Object object
,
2039 if (!NILP (help
) && !STRINGP (help
))
2041 if (FUNCTIONP (help
))
2042 help
= safe_call (4, help
, window
, object
, pos
);
2044 help
= safe_eval (help
);
2046 if (!STRINGP (help
))
2050 if (!noninteractive
&& STRINGP (help
))
2052 /* The mouse-fixup-help-message Lisp function can call
2053 mouse_position_hook, which resets the mouse_moved flags.
2054 This causes trouble if we are trying to read a mouse motion
2055 event (i.e., if we are inside a `track-mouse' form), so we
2056 restore the mouse_moved flag. */
2057 struct frame
*f
= NILP (do_mouse_tracking
) ? NULL
: some_mouse_moved ();
2058 help
= call1 (Qmouse_fixup_help_message
, help
);
2060 f
->mouse_moved
= true;
2063 if (STRINGP (help
) || NILP (help
))
2065 if (!NILP (Vshow_help_function
))
2066 call1 (Vshow_help_function
, Fsubstitute_command_keys (help
));
2067 help_echo_showing_p
= STRINGP (help
);
2073 /* Input of single characters from keyboard. */
2075 static Lisp_Object
kbd_buffer_get_event (KBOARD
**kbp
, bool *used_mouse_menu
,
2076 struct timespec
*end_time
);
2077 static void record_char (Lisp_Object c
);
2079 static Lisp_Object help_form_saved_window_configs
;
2081 read_char_help_form_unwind (void)
2083 Lisp_Object window_config
= XCAR (help_form_saved_window_configs
);
2084 help_form_saved_window_configs
= XCDR (help_form_saved_window_configs
);
2085 if (!NILP (window_config
))
2086 Fset_window_configuration (window_config
);
2089 #define STOP_POLLING \
2090 do { if (! polling_stopped_here) stop_polling (); \
2091 polling_stopped_here = true; } while (0)
2093 #define RESUME_POLLING \
2094 do { if (polling_stopped_here) start_polling (); \
2095 polling_stopped_here = false; } while (0)
2098 read_event_from_main_queue (struct timespec
*end_time
,
2099 sys_jmp_buf local_getcjmp
,
2100 bool *used_mouse_menu
)
2102 Lisp_Object c
= Qnil
;
2103 sys_jmp_buf save_jump
;
2104 KBOARD
*kb
IF_LINT (= NULL
);
2108 /* Read from the main queue, and if that gives us something we can't use yet,
2109 we put it on the appropriate side queue and try again. */
2111 if (end_time
&& timespec_cmp (*end_time
, current_timespec ()) <= 0)
2114 /* Actually read a character, waiting if necessary. */
2115 save_getcjmp (save_jump
);
2116 restore_getcjmp (local_getcjmp
);
2118 timer_start_idle ();
2119 c
= kbd_buffer_get_event (&kb
, used_mouse_menu
, end_time
);
2120 restore_getcjmp (save_jump
);
2122 if (! NILP (c
) && (kb
!= current_kboard
))
2124 Lisp_Object last
= KVAR (kb
, kbd_queue
);
2127 while (CONSP (XCDR (last
)))
2129 if (!NILP (XCDR (last
)))
2133 kset_kbd_queue (kb
, list1 (c
));
2135 XSETCDR (last
, list1 (c
));
2136 kb
->kbd_queue_has_data
= true;
2140 current_kboard
= kb
;
2141 return make_number (-2);
2144 /* Terminate Emacs in batch mode if at eof. */
2145 if (noninteractive
&& INTEGERP (c
) && XINT (c
) < 0)
2146 Fkill_emacs (make_number (1));
2150 /* Add in any extra modifiers, where appropriate. */
2151 if ((extra_keyboard_modifiers
& CHAR_CTL
)
2152 || ((extra_keyboard_modifiers
& 0177) < ' '
2153 && (extra_keyboard_modifiers
& 0177) != 0))
2154 XSETINT (c
, make_ctrl_char (XINT (c
)));
2156 /* Transfer any other modifier bits directly from
2157 extra_keyboard_modifiers to c. Ignore the actual character code
2158 in the low 16 bits of extra_keyboard_modifiers. */
2159 XSETINT (c
, XINT (c
) | (extra_keyboard_modifiers
& ~0xff7f & ~CHAR_CTL
));
2167 /* Like `read_event_from_main_queue' but applies keyboard-coding-system
2170 read_decoded_event_from_main_queue (struct timespec
*end_time
,
2171 sys_jmp_buf local_getcjmp
,
2172 Lisp_Object prev_event
,
2173 bool *used_mouse_menu
)
2175 #define MAX_ENCODED_BYTES 16
2177 Lisp_Object events
[MAX_ENCODED_BYTES
];
2183 = read_event_from_main_queue (end_time
, local_getcjmp
,
2186 /* w32_console already returns decoded events. It either reads
2187 Unicode characters from the Windows keyboard input, or
2188 converts characters encoded in the current codepage into
2189 Unicode. See w32inevt.c:key_event, near its end. */
2192 struct frame
*frame
= XFRAME (selected_frame
);
2193 struct terminal
*terminal
= frame
->terminal
;
2194 if (!((FRAME_TERMCAP_P (frame
) || FRAME_MSDOS_P (frame
))
2195 /* Don't apply decoding if we're just reading a raw event
2196 (e.g. reading bytes sent by the xterm to specify the position
2197 of a mouse click). */
2198 && (!EQ (prev_event
, Qt
))
2199 && (TERMINAL_KEYBOARD_CODING (terminal
)->common_flags
2200 & CODING_REQUIRE_DECODING_MASK
)))
2201 return nextevt
; /* No decoding needed. */
2204 int meta_key
= terminal
->display_info
.tty
->meta_key
;
2205 eassert (n
< MAX_ENCODED_BYTES
);
2206 events
[n
++] = nextevt
;
2207 if (NATNUMP (nextevt
)
2208 && XINT (nextevt
) < (meta_key
== 1 ? 0x80 : 0x100))
2209 { /* An encoded byte sequence, let's try to decode it. */
2210 struct coding_system
*coding
2211 = TERMINAL_KEYBOARD_CODING (terminal
);
2213 if (raw_text_coding_system_p (coding
))
2217 for (i
= 0; i
< n
; i
++)
2218 events
[i
] = make_number (XINT (events
[i
]) & ~0x80);
2222 unsigned char src
[MAX_ENCODED_BYTES
];
2223 unsigned char dest
[MAX_ENCODED_BYTES
* MAX_MULTIBYTE_LENGTH
];
2225 for (i
= 0; i
< n
; i
++)
2226 src
[i
] = XINT (events
[i
]);
2228 for (i
= 0; i
< n
; i
++)
2230 coding
->destination
= dest
;
2231 coding
->dst_bytes
= sizeof dest
;
2232 decode_coding_c_string (coding
, src
, n
, Qnil
);
2233 eassert (coding
->produced_char
<= n
);
2234 if (coding
->produced_char
== 0)
2235 { /* The encoded sequence is incomplete. */
2236 if (n
< MAX_ENCODED_BYTES
) /* Avoid buffer overflow. */
2237 continue; /* Read on! */
2241 const unsigned char *p
= coding
->destination
;
2242 eassert (coding
->carryover_bytes
== 0);
2244 while (n
< coding
->produced_char
)
2245 events
[n
++] = make_number (STRING_CHAR_ADVANCE (p
));
2249 /* Now `events' should hold decoded events.
2250 Normally, n should be equal to 1, but better not rely on it.
2251 We can only return one event here, so return the first we
2252 had and keep the others (if any) for later. */
2254 Vunread_command_events
2255 = Fcons (events
[--n
], Vunread_command_events
);
2263 echo_keystrokes_p (void)
2265 return (FLOATP (Vecho_keystrokes
) ? XFLOAT_DATA (Vecho_keystrokes
) > 0.0
2266 : INTEGERP (Vecho_keystrokes
) ? XINT (Vecho_keystrokes
) > 0 : false);
2269 /* Read a character from the keyboard; call the redisplay if needed. */
2270 /* commandflag 0 means do not autosave, but do redisplay.
2271 -1 means do not redisplay, but do autosave.
2272 -2 means do neither.
2275 The argument MAP is a keymap for menu prompting.
2277 PREV_EVENT is the previous input event, or nil if we are reading
2278 the first event of a key sequence (or not reading a key sequence).
2279 If PREV_EVENT is t, that is a "magic" value that says
2280 not to run input methods, but in other respects to act as if
2281 not reading a key sequence.
2283 If USED_MOUSE_MENU is non-null, then set *USED_MOUSE_MENU to true
2284 if we used a mouse menu to read the input, or false otherwise. If
2285 USED_MOUSE_MENU is null, don't dereference it.
2287 Value is -2 when we find input on another keyboard. A second call
2288 to read_char will read it.
2290 If END_TIME is non-null, it is a pointer to a struct timespec
2291 specifying the maximum time to wait until. If no input arrives by
2292 that time, stop waiting and return nil.
2294 Value is t if we showed a menu and the user rejected it. */
2297 read_char (int commandflag
, Lisp_Object map
,
2298 Lisp_Object prev_event
,
2299 bool *used_mouse_menu
, struct timespec
*end_time
)
2303 sys_jmp_buf local_getcjmp
;
2304 sys_jmp_buf save_jump
;
2305 Lisp_Object tem
, save
;
2306 volatile Lisp_Object previous_echo_area_message
;
2307 volatile Lisp_Object also_record
;
2308 volatile bool reread
, recorded
;
2309 bool volatile polling_stopped_here
= false;
2310 struct kboard
*orig_kboard
= current_kboard
;
2315 previous_echo_area_message
= Qnil
;
2321 if (CONSP (Vunread_post_input_method_events
))
2323 c
= XCAR (Vunread_post_input_method_events
);
2324 Vunread_post_input_method_events
2325 = XCDR (Vunread_post_input_method_events
);
2327 /* Undo what read_char_x_menu_prompt did when it unread
2328 additional keys returned by Fx_popup_menu. */
2330 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2341 if (CONSP (Vunread_command_events
))
2343 bool was_disabled
= false;
2345 c
= XCAR (Vunread_command_events
);
2346 Vunread_command_events
= XCDR (Vunread_command_events
);
2348 /* Undo what sit-for did when it unread additional keys
2349 inside universal-argument. */
2351 if (CONSP (c
) && EQ (XCAR (c
), Qt
))
2356 /* Undo what read_char_x_menu_prompt did when it unread
2357 additional keys returned by Fx_popup_menu. */
2359 && EQ (XCDR (c
), Qdisabled
)
2360 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
))))
2362 was_disabled
= true;
2366 /* If the queued event is something that used the mouse,
2367 set used_mouse_menu accordingly. */
2369 /* Also check was_disabled so last-nonmenu-event won't return
2370 a bad value when submenus are involved. (Bug#447) */
2371 && (EQ (c
, Qtool_bar
) || EQ (c
, Qmenu_bar
) || was_disabled
))
2372 *used_mouse_menu
= true;
2374 goto reread_for_input_method
;
2377 if (CONSP (Vunread_input_method_events
))
2379 c
= XCAR (Vunread_input_method_events
);
2380 Vunread_input_method_events
= XCDR (Vunread_input_method_events
);
2382 /* Undo what read_char_x_menu_prompt did when it unread
2383 additional keys returned by Fx_popup_menu. */
2385 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2389 goto reread_for_input_method
;
2392 if (!NILP (Vexecuting_kbd_macro
))
2394 /* We set this to Qmacro; since that's not a frame, nobody will
2395 try to switch frames on us, and the selected window will
2398 Since this event came from a macro, it would be misleading to
2399 leave internal_last_event_frame set to wherever the last
2400 real event came from. Normally, a switch-frame event selects
2401 internal_last_event_frame after each command is read, but
2402 events read from a macro should never cause a new frame to be
2404 Vlast_event_frame
= internal_last_event_frame
= Qmacro
;
2406 /* Exit the macro if we are at the end.
2407 Also, some things replace the macro with t
2408 to force an early exit. */
2409 if (EQ (Vexecuting_kbd_macro
, Qt
)
2410 || executing_kbd_macro_index
>= XFASTINT (Flength (Vexecuting_kbd_macro
)))
2416 c
= Faref (Vexecuting_kbd_macro
, make_number (executing_kbd_macro_index
));
2417 if (STRINGP (Vexecuting_kbd_macro
)
2418 && (XFASTINT (c
) & 0x80) && (XFASTINT (c
) <= 0xff))
2419 XSETFASTINT (c
, CHAR_META
| (XFASTINT (c
) & ~0x80));
2421 executing_kbd_macro_index
++;
2426 if (!NILP (unread_switch_frame
))
2428 c
= unread_switch_frame
;
2429 unread_switch_frame
= Qnil
;
2431 /* This event should make it into this_command_keys, and get echoed
2432 again, so we do not set `reread'. */
2436 /* If redisplay was requested. */
2437 if (commandflag
>= 0)
2439 bool echo_current
= EQ (echo_message_buffer
, echo_area_buffer
[0]);
2441 /* If there is pending input, process any events which are not
2442 user-visible, such as X selection_request events. */
2444 || detect_input_pending_run_timers (0))
2445 swallow_events (false); /* May clear input_pending. */
2447 /* Redisplay if no pending input. */
2448 while (!(input_pending
2449 && (input_was_pending
|| !redisplay_dont_pause
)))
2451 input_was_pending
= input_pending
;
2452 if (help_echo_showing_p
&& !EQ (selected_window
, minibuf_window
))
2453 redisplay_preserve_echo_area (5);
2458 /* Normal case: no input arrived during redisplay. */
2461 /* Input arrived and pre-empted redisplay.
2462 Process any events which are not user-visible. */
2463 swallow_events (false);
2464 /* If that cleared input_pending, try again to redisplay. */
2467 /* Prevent the redisplay we just did
2468 from messing up echoing of the input after the prompt. */
2469 if (commandflag
== 0 && echo_current
)
2470 echo_message_buffer
= echo_area_buffer
[0];
2474 /* Message turns off echoing unless more keystrokes turn it on again.
2476 The code in 20.x for the condition was
2478 1. echo_area_glyphs && *echo_area_glyphs
2479 2. && echo_area_glyphs != current_kboard->echobuf
2480 3. && ok_to_echo_at_next_pause != echo_area_glyphs
2482 (1) means there's a current message displayed
2484 (2) means it's not the message from echoing from the current
2487 (3) There's only one place in 20.x where ok_to_echo_at_next_pause
2488 is set to a non-null value. This is done in read_char and it is
2489 set to echo_area_glyphs. That means
2490 ok_to_echo_at_next_pause is either null or
2491 current_kboard->echobuf with the appropriate current_kboard at
2494 So, condition (3) means in clear text ok_to_echo_at_next_pause
2495 must be either null, or the current message isn't from echoing at
2496 all, or it's from echoing from a different kboard than the
2499 if (/* There currently is something in the echo area. */
2500 !NILP (echo_area_buffer
[0])
2501 && (/* It's an echo from a different kboard. */
2502 echo_kboard
!= current_kboard
2503 /* Or we explicitly allow overwriting whatever there is. */
2504 || ok_to_echo_at_next_pause
== NULL
))
2509 /* Try reading a character via menu prompting in the minibuf.
2510 Try this before the sit-for, because the sit-for
2511 would do the wrong thing if we are supposed to do
2512 menu prompting. If EVENT_HAS_PARAMETERS then we are reading
2513 after a mouse event so don't try a minibuf menu. */
2515 if (KEYMAPP (map
) && INTERACTIVE
2516 && !NILP (prev_event
) && ! EVENT_HAS_PARAMETERS (prev_event
)
2517 /* Don't bring up a menu if we already have another event. */
2518 && NILP (Vunread_command_events
)
2519 && !detect_input_pending_run_timers (0))
2521 c
= read_char_minibuf_menu_prompt (commandflag
, map
);
2523 if (INTEGERP (c
) && XINT (c
) == -2)
2524 return c
; /* wrong_kboard_jmpbuf */
2530 /* Make a longjmp point for quits to use, but don't alter getcjmp just yet.
2531 We will do that below, temporarily for short sections of code,
2532 when appropriate. local_getcjmp must be in effect
2533 around any call to sit_for or kbd_buffer_get_event;
2534 it *must not* be in effect when we call redisplay. */
2536 jmpcount
= SPECPDL_INDEX ();
2537 if (sys_setjmp (local_getcjmp
))
2539 /* Handle quits while reading the keyboard. */
2540 /* We must have saved the outer value of getcjmp here,
2541 so restore it now. */
2542 restore_getcjmp (save_jump
);
2543 pthread_sigmask (SIG_SETMASK
, &empty_mask
, 0);
2544 unbind_to (jmpcount
, Qnil
);
2545 XSETINT (c
, quit_char
);
2546 internal_last_event_frame
= selected_frame
;
2547 Vlast_event_frame
= internal_last_event_frame
;
2548 /* If we report the quit char as an event,
2549 don't do so more than once. */
2550 if (!NILP (Vinhibit_quit
))
2554 KBOARD
*kb
= FRAME_KBOARD (XFRAME (selected_frame
));
2555 if (kb
!= current_kboard
)
2557 Lisp_Object last
= KVAR (kb
, kbd_queue
);
2558 /* We shouldn't get here if we were in single-kboard mode! */
2563 while (CONSP (XCDR (last
)))
2565 if (!NILP (XCDR (last
)))
2569 kset_kbd_queue (kb
, list1 (c
));
2571 XSETCDR (last
, list1 (c
));
2572 kb
->kbd_queue_has_data
= true;
2573 current_kboard
= kb
;
2574 return make_number (-2); /* wrong_kboard_jmpbuf */
2580 /* Start idle timers if no time limit is supplied. We don't do it
2581 if a time limit is supplied to avoid an infinite recursion in the
2582 situation where an idle timer calls `sit-for'. */
2585 timer_start_idle ();
2587 /* If in middle of key sequence and minibuffer not active,
2588 start echoing if enough time elapses. */
2590 if (minibuf_level
== 0
2592 && !current_kboard
->immediate_echo
2593 && (this_command_key_count
> 0
2594 || !NILP (call0 (Qinternal_echo_keystrokes_prefix
)))
2596 && echo_keystrokes_p ()
2597 && (/* No message. */
2598 NILP (echo_area_buffer
[0])
2599 /* Or empty message. */
2600 || (BUF_BEG (XBUFFER (echo_area_buffer
[0]))
2601 == BUF_Z (XBUFFER (echo_area_buffer
[0])))
2602 /* Or already echoing from same kboard. */
2603 || (echo_kboard
&& ok_to_echo_at_next_pause
== echo_kboard
)
2604 /* Or not echoing before and echoing allowed. */
2605 || (!echo_kboard
&& ok_to_echo_at_next_pause
)))
2607 /* After a mouse event, start echoing right away.
2608 This is because we are probably about to display a menu,
2609 and we don't want to delay before doing so. */
2610 if (EVENT_HAS_PARAMETERS (prev_event
))
2616 save_getcjmp (save_jump
);
2617 restore_getcjmp (local_getcjmp
);
2618 tem0
= sit_for (Vecho_keystrokes
, 1, 1);
2619 restore_getcjmp (save_jump
);
2621 && ! CONSP (Vunread_command_events
))
2626 /* Maybe auto save due to number of keystrokes. */
2628 if (commandflag
!= 0 && commandflag
!= -2
2629 && auto_save_interval
> 0
2630 && num_nonmacro_input_events
- last_auto_save
> max (auto_save_interval
, 20)
2631 && !detect_input_pending_run_timers (0))
2633 Fdo_auto_save (Qnil
, Qnil
);
2634 /* Hooks can actually change some buffers in auto save. */
2638 /* Try reading using an X menu.
2639 This is never confused with reading using the minibuf
2640 because the recursive call of read_char in read_char_minibuf_menu_prompt
2641 does not pass on any keymaps. */
2643 if (KEYMAPP (map
) && INTERACTIVE
2644 && !NILP (prev_event
)
2645 && EVENT_HAS_PARAMETERS (prev_event
)
2646 && !EQ (XCAR (prev_event
), Qmenu_bar
)
2647 && !EQ (XCAR (prev_event
), Qtool_bar
)
2648 /* Don't bring up a menu if we already have another event. */
2649 && NILP (Vunread_command_events
))
2651 c
= read_char_x_menu_prompt (map
, prev_event
, used_mouse_menu
);
2653 /* Now that we have read an event, Emacs is not idle. */
2660 /* Maybe autosave and/or garbage collect due to idleness. */
2662 if (INTERACTIVE
&& NILP (c
))
2665 ptrdiff_t buffer_size
;
2667 /* Slow down auto saves logarithmically in size of current buffer,
2668 and garbage collect while we're at it. */
2669 if (! MINI_WINDOW_P (XWINDOW (selected_window
)))
2670 last_non_minibuf_size
= Z
- BEG
;
2671 buffer_size
= (last_non_minibuf_size
>> 8) + 1;
2673 while (buffer_size
> 64)
2674 delay_level
++, buffer_size
-= buffer_size
>> 2;
2675 if (delay_level
< 4) delay_level
= 4;
2676 /* delay_level is 4 for files under around 50k, 7 at 100k,
2677 9 at 200k, 11 at 300k, and 12 at 500k. It is 15 at 1 meg. */
2679 /* Auto save if enough time goes by without input. */
2680 if (commandflag
!= 0 && commandflag
!= -2
2681 && num_nonmacro_input_events
> last_auto_save
2682 && INTEGERP (Vauto_save_timeout
)
2683 && XINT (Vauto_save_timeout
) > 0)
2686 EMACS_INT timeout
= XFASTINT (Vauto_save_timeout
);
2688 timeout
= min (timeout
, MOST_POSITIVE_FIXNUM
/ delay_level
* 4);
2689 timeout
= delay_level
* timeout
/ 4;
2690 save_getcjmp (save_jump
);
2691 restore_getcjmp (local_getcjmp
);
2692 tem0
= sit_for (make_number (timeout
), 1, 1);
2693 restore_getcjmp (save_jump
);
2696 && ! CONSP (Vunread_command_events
))
2698 Fdo_auto_save (Qnil
, Qnil
);
2703 /* If there is still no input available, ask for GC. */
2704 if (!detect_input_pending_run_timers (0))
2708 /* Notify the caller if an autosave hook, or a timer, sentinel or
2709 filter in the sit_for calls above have changed the current
2710 kboard. This could happen if they use the minibuffer or start a
2711 recursive edit, like the fancy splash screen in server.el's
2712 filter. If this longjmp wasn't here, read_key_sequence would
2713 interpret the next key sequence using the wrong translation
2714 tables and function keymaps. */
2715 if (NILP (c
) && current_kboard
!= orig_kboard
)
2716 return make_number (-2); /* wrong_kboard_jmpbuf */
2718 /* If this has become non-nil here, it has been set by a timer
2719 or sentinel or filter. */
2720 if (CONSP (Vunread_command_events
))
2722 c
= XCAR (Vunread_command_events
);
2723 Vunread_command_events
= XCDR (Vunread_command_events
);
2725 if (CONSP (c
) && EQ (XCAR (c
), Qt
))
2731 /* Read something from current KBOARD's side queue, if possible. */
2735 if (current_kboard
->kbd_queue_has_data
)
2737 if (!CONSP (KVAR (current_kboard
, kbd_queue
)))
2739 c
= XCAR (KVAR (current_kboard
, kbd_queue
));
2740 kset_kbd_queue (current_kboard
,
2741 XCDR (KVAR (current_kboard
, kbd_queue
)));
2742 if (NILP (KVAR (current_kboard
, kbd_queue
)))
2743 current_kboard
->kbd_queue_has_data
= false;
2744 input_pending
= readable_events (0);
2745 if (EVENT_HAS_PARAMETERS (c
)
2746 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qswitch_frame
))
2747 internal_last_event_frame
= XCAR (XCDR (c
));
2748 Vlast_event_frame
= internal_last_event_frame
;
2752 /* If current_kboard's side queue is empty check the other kboards.
2753 If one of them has data that we have not yet seen here,
2754 switch to it and process the data waiting for it.
2756 Note: if the events queued up for another kboard
2757 have already been seen here, and therefore are not a complete command,
2758 the kbd_queue_has_data field is 0, so we skip that kboard here.
2759 That's to avoid an infinite loop switching between kboards here. */
2760 if (NILP (c
) && !single_kboard
)
2763 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
2764 if (kb
->kbd_queue_has_data
)
2766 current_kboard
= kb
;
2767 return make_number (-2); /* wrong_kboard_jmpbuf */
2777 c
= read_decoded_event_from_main_queue (end_time
, local_getcjmp
,
2778 prev_event
, used_mouse_menu
);
2779 if (NILP (c
) && end_time
2780 && timespec_cmp (*end_time
, current_timespec ()) <= 0)
2785 if (EQ (c
, make_number (-2)))
2797 if (commandflag
>= 0
2798 && !input_pending
&& !detect_input_pending_run_timers (0))
2804 /* Buffer switch events are only for internal wakeups
2805 so don't show them to the user.
2806 Also, don't record a key if we already did. */
2810 /* Process special events within read_char
2811 and loop around to read another event. */
2814 tem
= access_keymap (get_keymap (Vspecial_event_map
, 0, 1), c
, 0, 0, 1);
2819 struct buffer
*prev_buffer
= current_buffer
;
2820 last_input_event
= c
;
2821 call4 (Qcommand_execute
, tem
, Qnil
, Fvector (1, &last_input_event
), Qt
);
2823 if (CONSP (c
) && EQ (XCAR (c
), Qselect_window
) && !end_time
)
2824 /* We stopped being idle for this event; undo that. This
2825 prevents automatic window selection (under
2826 mouse_autoselect_window from acting as a real input event, for
2827 example banishing the mouse under mouse-avoidance-mode. */
2828 timer_resume_idle ();
2830 if (current_buffer
!= prev_buffer
)
2832 /* The command may have changed the keymaps. Pretend there
2833 is input in another keyboard and return. This will
2834 recalculate keymaps. */
2835 c
= make_number (-2);
2842 /* Handle things that only apply to characters. */
2845 /* If kbd_buffer_get_event gave us an EOF, return that. */
2849 if ((STRINGP (KVAR (current_kboard
, Vkeyboard_translate_table
))
2850 && UNSIGNED_CMP (XFASTINT (c
), <,
2851 SCHARS (KVAR (current_kboard
,
2852 Vkeyboard_translate_table
))))
2853 || (VECTORP (KVAR (current_kboard
, Vkeyboard_translate_table
))
2854 && UNSIGNED_CMP (XFASTINT (c
), <,
2855 ASIZE (KVAR (current_kboard
,
2856 Vkeyboard_translate_table
))))
2857 || (CHAR_TABLE_P (KVAR (current_kboard
, Vkeyboard_translate_table
))
2861 d
= Faref (KVAR (current_kboard
, Vkeyboard_translate_table
), c
);
2862 /* nil in keyboard-translate-table means no translation. */
2868 /* If this event is a mouse click in the menu bar,
2869 return just menu-bar for now. Modify the mouse click event
2870 so we won't do this twice, then queue it up. */
2871 if (EVENT_HAS_PARAMETERS (c
)
2873 && CONSP (EVENT_START (c
))
2874 && CONSP (XCDR (EVENT_START (c
))))
2878 posn
= POSN_POSN (EVENT_START (c
));
2879 /* Handle menu-bar events:
2880 insert the dummy prefix event `menu-bar'. */
2881 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
2883 /* Change menu-bar to (menu-bar) as the event "position". */
2884 POSN_SET_POSN (EVENT_START (c
), list1 (posn
));
2887 Vunread_command_events
= Fcons (c
, Vunread_command_events
);
2892 /* Store these characters into recent_keys, the dribble file if any,
2893 and the keyboard macro being defined, if any. */
2896 if (! NILP (also_record
))
2897 record_char (also_record
);
2899 /* Wipe the echo area.
2900 But first, if we are about to use an input method,
2901 save the echo area contents for it to refer to. */
2903 && ! NILP (Vinput_method_function
)
2904 && ' ' <= XINT (c
) && XINT (c
) < 256 && XINT (c
) != 127)
2906 previous_echo_area_message
= Fcurrent_message ();
2907 Vinput_method_previous_message
= previous_echo_area_message
;
2910 /* Now wipe the echo area, except for help events which do their
2911 own stuff with the echo area. */
2913 || (!(EQ (Qhelp_echo
, XCAR (c
)))
2914 && !(EQ (Qswitch_frame
, XCAR (c
)))
2915 /* Don't wipe echo area for select window events: These might
2916 get delayed via `mouse-autoselect-window' (Bug#11304). */
2917 && !(EQ (Qselect_window
, XCAR (c
)))))
2919 if (!NILP (echo_area_buffer
[0]))
2921 safe_run_hooks (Qecho_area_clear_hook
);
2922 clear_message (1, 0);
2926 reread_for_input_method
:
2928 /* Pass this to the input method, if appropriate. */
2930 && ! NILP (Vinput_method_function
)
2931 /* Don't run the input method within a key sequence,
2932 after the first event of the key sequence. */
2933 && NILP (prev_event
)
2934 && ' ' <= XINT (c
) && XINT (c
) < 256 && XINT (c
) != 127)
2937 ptrdiff_t key_count
;
2938 ptrdiff_t command_key_start
;
2939 ptrdiff_t count
= SPECPDL_INDEX ();
2941 /* Save the echo status. */
2942 bool saved_immediate_echo
= current_kboard
->immediate_echo
;
2943 struct kboard
*saved_ok_to_echo
= ok_to_echo_at_next_pause
;
2944 Lisp_Object saved_echo_string
= KVAR (current_kboard
, echo_string
);
2945 ptrdiff_t saved_echo_after_prompt
= current_kboard
->echo_after_prompt
;
2947 /* Save the this_command_keys status. */
2948 key_count
= this_command_key_count
;
2949 command_key_start
= this_single_command_key_start
;
2952 keys
= Fcopy_sequence (this_command_keys
);
2956 /* Clear out this_command_keys. */
2957 this_command_key_count
= 0;
2958 this_single_command_key_start
= 0;
2960 /* Now wipe the echo area. */
2961 if (!NILP (echo_area_buffer
[0]))
2962 safe_run_hooks (Qecho_area_clear_hook
);
2963 clear_message (1, 0);
2966 /* If we are not reading a key sequence,
2967 never use the echo area. */
2970 specbind (Qinput_method_use_echo_area
, Qt
);
2973 /* Call the input method. */
2974 tem
= call1 (Vinput_method_function
, c
);
2976 tem
= unbind_to (count
, tem
);
2978 /* Restore the saved echoing state
2979 and this_command_keys state. */
2980 this_command_key_count
= key_count
;
2981 this_single_command_key_start
= command_key_start
;
2983 this_command_keys
= keys
;
2986 ok_to_echo_at_next_pause
= saved_ok_to_echo
;
2987 /* Do not restore the echo area string when the user is
2988 introducing a prefix argument. Otherwise we end with
2989 repetitions of the partially introduced prefix
2990 argument. (bug#19875) */
2991 if (NILP (intern ("prefix-arg")))
2993 kset_echo_string (current_kboard
, saved_echo_string
);
2995 current_kboard
->echo_after_prompt
= saved_echo_after_prompt
;
2996 if (saved_immediate_echo
)
2999 /* The input method can return no events. */
3002 /* Bring back the previous message, if any. */
3003 if (! NILP (previous_echo_area_message
))
3004 message_with_string ("%s", previous_echo_area_message
, 0);
3007 /* It returned one event or more. */
3009 Vunread_post_input_method_events
3010 = nconc2 (XCDR (tem
), Vunread_post_input_method_events
);
3012 /* When we consume events from the various unread-*-events lists, we
3013 bypass the code that records input, so record these events now if
3014 they were not recorded already. */
3023 /* Display help if not echoing. */
3024 if (CONSP (c
) && EQ (XCAR (c
), Qhelp_echo
))
3026 /* (help-echo FRAME HELP WINDOW OBJECT POS). */
3027 Lisp_Object help
, object
, position
, window
, htem
;
3029 htem
= Fcdr (XCDR (c
));
3032 window
= Fcar (htem
);
3034 object
= Fcar (htem
);
3036 position
= Fcar (htem
);
3038 show_help_echo (help
, window
, object
, position
);
3040 /* We stopped being idle for this event; undo that. */
3042 timer_resume_idle ();
3046 if ((! reread
|| this_command_key_count
== 0)
3050 /* Don't echo mouse motion events. */
3051 if (! (EVENT_HAS_PARAMETERS (c
)
3052 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
3053 /* Once we reread a character, echoing can happen
3054 the next time we pause to read a new one. */
3055 ok_to_echo_at_next_pause
= current_kboard
;
3057 /* Record this character as part of the current key. */
3058 add_command_key (c
);
3059 if (! NILP (also_record
))
3060 add_command_key (also_record
);
3065 last_input_event
= c
;
3068 /* Process the help character specially if enabled. */
3069 if (!NILP (Vhelp_form
) && help_char_p (c
))
3071 ptrdiff_t count
= SPECPDL_INDEX ();
3073 help_form_saved_window_configs
3074 = Fcons (Fcurrent_window_configuration (Qnil
),
3075 help_form_saved_window_configs
);
3076 record_unwind_protect_void (read_char_help_form_unwind
);
3077 call0 (Qhelp_form_show
);
3082 c
= read_char (0, Qnil
, Qnil
, 0, NULL
);
3083 if (EVENT_HAS_PARAMETERS (c
)
3084 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_click
))
3085 XSETCAR (help_form_saved_window_configs
, Qnil
);
3087 while (BUFFERP (c
));
3088 /* Remove the help from the frame. */
3089 unbind_to (count
, Qnil
);
3092 if (EQ (c
, make_number (040)))
3096 c
= read_char (0, Qnil
, Qnil
, 0, NULL
);
3097 while (BUFFERP (c
));
3103 input_was_pending
= input_pending
;
3107 /* Record a key that came from a mouse menu.
3108 Record it for echoing, for this-command-keys, and so on. */
3111 record_menu_key (Lisp_Object c
)
3113 /* Wipe the echo area. */
3114 clear_message (1, 0);
3118 /* Once we reread a character, echoing can happen
3119 the next time we pause to read a new one. */
3120 ok_to_echo_at_next_pause
= NULL
;
3122 /* Record this character as part of the current key. */
3123 add_command_key (c
);
3126 /* Re-reading in the middle of a command. */
3127 last_input_event
= c
;
3131 /* Return true if should recognize C as "the help character". */
3134 help_char_p (Lisp_Object c
)
3138 if (EQ (c
, Vhelp_char
))
3140 for (tail
= Vhelp_event_list
; CONSP (tail
); tail
= XCDR (tail
))
3141 if (EQ (c
, XCAR (tail
)))
3146 /* Record the input event C in various ways. */
3149 record_char (Lisp_Object c
)
3153 if (CONSP (c
) && (EQ (XCAR (c
), Qhelp_echo
) || EQ (XCAR (c
), Qmouse_movement
)))
3155 /* To avoid filling recent_keys with help-echo and mouse-movement
3156 events, we filter out repeated help-echo events, only store the
3157 first and last in a series of mouse-movement events, and don't
3158 store repeated help-echo events which are only separated by
3159 mouse-movement events. */
3161 Lisp_Object ev1
, ev2
, ev3
;
3164 if ((ix1
= recent_keys_index
- 1) < 0)
3165 ix1
= NUM_RECENT_KEYS
- 1;
3166 ev1
= AREF (recent_keys
, ix1
);
3168 if ((ix2
= ix1
- 1) < 0)
3169 ix2
= NUM_RECENT_KEYS
- 1;
3170 ev2
= AREF (recent_keys
, ix2
);
3172 if ((ix3
= ix2
- 1) < 0)
3173 ix3
= NUM_RECENT_KEYS
- 1;
3174 ev3
= AREF (recent_keys
, ix3
);
3176 if (EQ (XCAR (c
), Qhelp_echo
))
3178 /* Don't record `help-echo' in recent_keys unless it shows some help
3179 message, and a different help than the previously recorded
3181 Lisp_Object help
, last_help
;
3183 help
= Fcar_safe (Fcdr_safe (XCDR (c
)));
3184 if (!STRINGP (help
))
3186 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qhelp_echo
)
3187 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev1
))), EQ (last_help
, help
)))
3189 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3190 && CONSP (ev2
) && EQ (XCAR (ev2
), Qhelp_echo
)
3191 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev2
))), EQ (last_help
, help
)))
3193 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3194 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3195 && CONSP (ev3
) && EQ (XCAR (ev3
), Qhelp_echo
)
3196 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev3
))), EQ (last_help
, help
)))
3199 else if (EQ (XCAR (c
), Qmouse_movement
))
3201 /* Only record one pair of `mouse-movement' on a window in recent_keys.
3202 So additional mouse movement events replace the last element. */
3203 Lisp_Object last_window
, window
;
3205 window
= Fcar_safe (Fcar_safe (XCDR (c
)));
3206 if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3207 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev1
))), EQ (last_window
, window
))
3208 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3209 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev2
))), EQ (last_window
, window
)))
3211 ASET (recent_keys
, ix1
, c
);
3217 store_kbd_macro_char (c
);
3221 total_keys
+= total_keys
< NUM_RECENT_KEYS
;
3222 ASET (recent_keys
, recent_keys_index
, c
);
3223 if (++recent_keys_index
>= NUM_RECENT_KEYS
)
3224 recent_keys_index
= 0;
3226 else if (recorded
< 0)
3228 /* We need to remove one or two events from recent_keys.
3229 To do this, we simply put nil at those events and move the
3230 recent_keys_index backwards over those events. Usually,
3231 users will never see those nil events, as they will be
3232 overwritten by the command keys entered to see recent_keys
3235 while (recorded
++ < 0 && total_keys
> 0)
3237 if (total_keys
< NUM_RECENT_KEYS
)
3239 if (--recent_keys_index
< 0)
3240 recent_keys_index
= NUM_RECENT_KEYS
- 1;
3241 ASET (recent_keys
, recent_keys_index
, Qnil
);
3245 num_nonmacro_input_events
++;
3247 /* Write c to the dribble file. If c is a lispy event, write
3248 the event's symbol to the dribble file, in <brackets>. Bleaugh.
3249 If you, dear reader, have a better idea, you've got the source. :-) */
3255 if (XUINT (c
) < 0x100)
3256 putc (XUINT (c
), dribble
);
3258 fprintf (dribble
, " 0x%"pI
"x", XUINT (c
));
3262 Lisp_Object dribblee
;
3264 /* If it's a structured event, take the event header. */
3265 dribblee
= EVENT_HEAD (c
);
3267 if (SYMBOLP (dribblee
))
3269 putc ('<', dribble
);
3270 fwrite (SDATA (SYMBOL_NAME (dribblee
)), sizeof (char),
3271 SBYTES (SYMBOL_NAME (dribblee
)),
3273 putc ('>', dribble
);
3282 /* Copy out or in the info on where C-g should throw to.
3283 This is used when running Lisp code from within get_char,
3284 in case get_char is called recursively.
3285 See read_process_output. */
3288 save_getcjmp (sys_jmp_buf temp
)
3290 memcpy (temp
, getcjmp
, sizeof getcjmp
);
3294 restore_getcjmp (sys_jmp_buf temp
)
3296 memcpy (getcjmp
, temp
, sizeof getcjmp
);
3299 /* Low level keyboard/mouse input.
3300 kbd_buffer_store_event places events in kbd_buffer, and
3301 kbd_buffer_get_event retrieves them. */
3303 /* Return true if there are any events in the queue that read-char
3304 would return. If this returns false, a read-char would block. */
3306 readable_events (int flags
)
3308 if (flags
& READABLE_EVENTS_DO_TIMERS_NOW
)
3311 /* If the buffer contains only FOCUS_IN_EVENT events, and
3312 READABLE_EVENTS_FILTER_EVENTS is set, report it as empty. */
3313 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3315 if (flags
& (READABLE_EVENTS_FILTER_EVENTS
3316 #ifdef USE_TOOLKIT_SCROLL_BARS
3317 | READABLE_EVENTS_IGNORE_SQUEEZABLES
3321 union buffered_input_event
*event
;
3323 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
3330 #ifdef USE_TOOLKIT_SCROLL_BARS
3331 (flags
& READABLE_EVENTS_FILTER_EVENTS
) &&
3333 event
->kind
== FOCUS_IN_EVENT
)
3334 #ifdef USE_TOOLKIT_SCROLL_BARS
3335 && !((flags
& READABLE_EVENTS_IGNORE_SQUEEZABLES
)
3336 && (event
->kind
== SCROLL_BAR_CLICK_EVENT
3337 || event
->kind
== HORIZONTAL_SCROLL_BAR_CLICK_EVENT
)
3338 && event
->ie
.part
== scroll_bar_handle
3339 && event
->ie
.modifiers
== 0)
3341 && !((flags
& READABLE_EVENTS_FILTER_EVENTS
)
3342 && event
->kind
== BUFFER_SWITCH_EVENT
))
3345 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3348 while (event
!= kbd_store_ptr
);
3354 if (!(flags
& READABLE_EVENTS_IGNORE_SQUEEZABLES
)
3355 && !NILP (do_mouse_tracking
) && some_mouse_moved ())
3359 if (current_kboard
->kbd_queue_has_data
)
3365 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
3366 if (kb
->kbd_queue_has_data
)
3372 /* Set this for debugging, to have a way to get out */
3373 int stop_character EXTERNALLY_VISIBLE
;
3376 event_to_kboard (struct input_event
*event
)
3378 /* Not applicable for these special events. */
3379 if (event
->kind
== SELECTION_REQUEST_EVENT
3380 || event
->kind
== SELECTION_CLEAR_EVENT
)
3384 Lisp_Object obj
= event
->frame_or_window
;
3385 /* There are some events that set this field to nil or string. */
3387 obj
= WINDOW_FRAME (XWINDOW (obj
));
3388 /* Also ignore dead frames here. */
3389 return ((FRAMEP (obj
) && FRAME_LIVE_P (XFRAME (obj
)))
3390 ? FRAME_KBOARD (XFRAME (obj
)) : NULL
);
3395 /* Return the number of slots occupied in kbd_buffer. */
3398 kbd_buffer_nr_stored (void)
3400 return kbd_fetch_ptr
== kbd_store_ptr
3402 : (kbd_fetch_ptr
< kbd_store_ptr
3403 ? kbd_store_ptr
- kbd_fetch_ptr
3404 : ((kbd_buffer
+ KBD_BUFFER_SIZE
) - kbd_fetch_ptr
3405 + (kbd_store_ptr
- kbd_buffer
)));
3407 #endif /* Store an event obtained at interrupt level into kbd_buffer, fifo */
3410 kbd_buffer_store_event (register struct input_event
*event
)
3412 kbd_buffer_store_event_hold (event
, 0);
3415 /* Store EVENT obtained at interrupt level into kbd_buffer, fifo.
3417 If HOLD_QUIT is 0, just stuff EVENT into the fifo.
3418 Else, if HOLD_QUIT.kind != NO_EVENT, discard EVENT.
3419 Else, if EVENT is a quit event, store the quit event
3420 in HOLD_QUIT, and return (thus ignoring further events).
3422 This is used to postpone the processing of the quit event until all
3423 subsequent input events have been parsed (and discarded). */
3426 kbd_buffer_store_buffered_event (union buffered_input_event
*event
,
3427 struct input_event
*hold_quit
)
3429 if (event
->kind
== NO_EVENT
)
3432 if (hold_quit
&& hold_quit
->kind
!= NO_EVENT
)
3435 if (event
->kind
== ASCII_KEYSTROKE_EVENT
)
3437 int c
= event
->ie
.code
& 0377;
3439 if (event
->ie
.modifiers
& ctrl_modifier
)
3440 c
= make_ctrl_char (c
);
3442 c
|= (event
->ie
.modifiers
3443 & (meta_modifier
| alt_modifier
3444 | hyper_modifier
| super_modifier
));
3448 KBOARD
*kb
= FRAME_KBOARD (XFRAME (event
->ie
.frame_or_window
));
3450 if (single_kboard
&& kb
!= current_kboard
)
3453 (kb
, list2 (make_lispy_switch_frame (event
->ie
.frame_or_window
),
3455 kb
->kbd_queue_has_data
= true;
3456 union buffered_input_event
*sp
;
3457 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3459 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3462 if (event_to_kboard (&sp
->ie
) == kb
)
3464 sp
->ie
.kind
= NO_EVENT
;
3465 sp
->ie
.frame_or_window
= Qnil
;
3474 *hold_quit
= event
->ie
;
3478 /* If this results in a quit_char being returned to Emacs as
3479 input, set Vlast_event_frame properly. If this doesn't
3480 get returned to Emacs as an event, the next event read
3481 will set Vlast_event_frame again, so this is safe to do. */
3485 focus
= FRAME_FOCUS_FRAME (XFRAME (event
->ie
.frame_or_window
));
3487 focus
= event
->ie
.frame_or_window
;
3488 internal_last_event_frame
= focus
;
3489 Vlast_event_frame
= focus
;
3492 handle_interrupt (0);
3496 if (c
&& c
== stop_character
)
3502 /* Don't insert two BUFFER_SWITCH_EVENT's in a row.
3503 Just ignore the second one. */
3504 else if (event
->kind
== BUFFER_SWITCH_EVENT
3505 && kbd_fetch_ptr
!= kbd_store_ptr
3506 && ((kbd_store_ptr
== kbd_buffer
3507 ? kbd_buffer
+ KBD_BUFFER_SIZE
- 1
3508 : kbd_store_ptr
- 1)->kind
) == BUFFER_SWITCH_EVENT
)
3511 if (kbd_store_ptr
- kbd_buffer
== KBD_BUFFER_SIZE
)
3512 kbd_store_ptr
= kbd_buffer
;
3514 /* Don't let the very last slot in the buffer become full,
3515 since that would make the two pointers equal,
3516 and that is indistinguishable from an empty buffer.
3517 Discard the event if it would fill the last slot. */
3518 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
3520 *kbd_store_ptr
= *event
;
3523 if (kbd_buffer_nr_stored () > KBD_BUFFER_SIZE
/ 2
3524 && ! kbd_on_hold_p ())
3526 /* Don't read keyboard input until we have processed kbd_buffer.
3527 This happens when pasting text longer than KBD_BUFFER_SIZE/2. */
3528 hold_keyboard_input ();
3532 #endif /* subprocesses */
3535 /* If we're inside while-no-input, and this event qualifies
3536 as input, set quit-flag to cause an interrupt. */
3537 if (!NILP (Vthrow_on_input
)
3538 && event
->kind
!= FOCUS_IN_EVENT
3539 && event
->kind
!= FOCUS_OUT_EVENT
3540 && event
->kind
!= HELP_EVENT
3541 && event
->kind
!= ICONIFY_EVENT
3542 && event
->kind
!= DEICONIFY_EVENT
)
3544 Vquit_flag
= Vthrow_on_input
;
3545 /* If we're inside a function that wants immediate quits,
3547 if (immediate_quit
&& NILP (Vinhibit_quit
))
3549 immediate_quit
= false;
3558 /* Put a selection input event back in the head of the event queue. */
3561 kbd_buffer_unget_event (struct selection_input_event
*event
)
3563 if (kbd_fetch_ptr
== kbd_buffer
)
3564 kbd_fetch_ptr
= kbd_buffer
+ KBD_BUFFER_SIZE
;
3566 /* Don't let the very last slot in the buffer become full, */
3567 union buffered_input_event
*kp
= kbd_fetch_ptr
- 1;
3568 if (kp
!= kbd_store_ptr
)
3577 /* Limit help event positions to this range, to avoid overflow problems. */
3578 #define INPUT_EVENT_POS_MAX \
3579 ((ptrdiff_t) min (PTRDIFF_MAX, min (TYPE_MAXIMUM (Time) / 2, \
3580 MOST_POSITIVE_FIXNUM)))
3581 #define INPUT_EVENT_POS_MIN (-1 - INPUT_EVENT_POS_MAX)
3583 /* Return a Time that encodes position POS. POS must be in range. */
3586 position_to_Time (ptrdiff_t pos
)
3588 eassert (INPUT_EVENT_POS_MIN
<= pos
&& pos
<= INPUT_EVENT_POS_MAX
);
3592 /* Return the position that ENCODED_POS encodes.
3593 Avoid signed integer overflow. */
3596 Time_to_position (Time encoded_pos
)
3598 if (encoded_pos
<= INPUT_EVENT_POS_MAX
)
3600 Time encoded_pos_min
= INPUT_EVENT_POS_MIN
;
3601 eassert (encoded_pos_min
<= encoded_pos
);
3602 ptrdiff_t notpos
= -1 - encoded_pos
;
3606 /* Generate a HELP_EVENT input_event and store it in the keyboard
3609 HELP is the help form.
3611 FRAME and WINDOW are the frame and window where the help is
3612 generated. OBJECT is the Lisp object where the help was found (a
3613 buffer, a string, an overlay, or nil if neither from a string nor
3614 from a buffer). POS is the position within OBJECT where the help
3618 gen_help_event (Lisp_Object help
, Lisp_Object frame
, Lisp_Object window
,
3619 Lisp_Object object
, ptrdiff_t pos
)
3621 struct input_event event
;
3623 event
.kind
= HELP_EVENT
;
3624 event
.frame_or_window
= frame
;
3626 event
.x
= WINDOWP (window
) ? window
: frame
;
3628 event
.timestamp
= position_to_Time (pos
);
3629 kbd_buffer_store_event (&event
);
3633 /* Store HELP_EVENTs for HELP on FRAME in the input queue. */
3636 kbd_buffer_store_help_event (Lisp_Object frame
, Lisp_Object help
)
3638 struct input_event event
;
3640 event
.kind
= HELP_EVENT
;
3641 event
.frame_or_window
= frame
;
3645 event
.timestamp
= 0;
3646 kbd_buffer_store_event (&event
);
3650 /* Discard any mouse events in the event buffer by setting them to
3653 discard_mouse_events (void)
3655 union buffered_input_event
*sp
;
3656 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3658 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3661 if (sp
->kind
== MOUSE_CLICK_EVENT
3662 || sp
->kind
== WHEEL_EVENT
3663 || sp
->kind
== HORIZ_WHEEL_EVENT
3665 || sp
->kind
== GPM_CLICK_EVENT
3667 || sp
->kind
== SCROLL_BAR_CLICK_EVENT
3668 || sp
->kind
== HORIZONTAL_SCROLL_BAR_CLICK_EVENT
)
3670 sp
->kind
= NO_EVENT
;
3676 /* Return true if there are any real events waiting in the event
3677 buffer, not counting `NO_EVENT's.
3679 Discard NO_EVENT events at the front of the input queue, possibly
3680 leaving the input queue empty if there are no real input events. */
3683 kbd_buffer_events_waiting (void)
3685 union buffered_input_event
*sp
;
3687 for (sp
= kbd_fetch_ptr
;
3688 sp
!= kbd_store_ptr
&& sp
->kind
== NO_EVENT
;
3691 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3696 return sp
!= kbd_store_ptr
&& sp
->kind
!= NO_EVENT
;
3700 /* Clear input event EVENT. */
3703 clear_event (union buffered_input_event
*event
)
3705 event
->kind
= NO_EVENT
;
3709 /* Read one event from the event buffer, waiting if necessary.
3710 The value is a Lisp object representing the event.
3711 The value is nil for an event that should be ignored,
3712 or that was handled here.
3713 We always read and discard one event. */
3716 kbd_buffer_get_event (KBOARD
**kbp
,
3717 bool *used_mouse_menu
,
3718 struct timespec
*end_time
)
3723 if (kbd_on_hold_p () && kbd_buffer_nr_stored () < KBD_BUFFER_SIZE
/ 4)
3725 /* Start reading input again because we have processed enough to
3726 be able to accept new events again. */
3727 unhold_keyboard_input ();
3731 #endif /* subprocesses */
3733 #if !defined HAVE_DBUS && !defined USE_FILE_NOTIFY
3735 /* In case we are running as a daemon, only do this before
3736 detaching from the terminal. */
3737 || (IS_DAEMON
&& DAEMON_RUNNING
))
3741 *kbp
= current_kboard
;
3744 #endif /* !defined HAVE_DBUS && !defined USE_FILE_NOTIFY */
3746 /* Wait until there is input available. */
3749 /* Break loop if there's an unread command event. Needed in
3750 moused window autoselection which uses a timer to insert such
3752 if (CONSP (Vunread_command_events
))
3755 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3757 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3760 /* If the quit flag is set, then read_char will return
3761 quit_char, so that counts as "available input." */
3762 if (!NILP (Vquit_flag
))
3763 quit_throw_to_read_char (0);
3765 /* One way or another, wait until input is available; then, if
3766 interrupt handlers have not read it, read it now. */
3771 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3773 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3777 struct timespec now
= current_timespec ();
3778 if (timespec_cmp (*end_time
, now
) <= 0)
3779 return Qnil
; /* Finished waiting. */
3782 struct timespec duration
= timespec_sub (*end_time
, now
);
3783 wait_reading_process_output (min (duration
.tv_sec
,
3786 -1, 1, Qnil
, NULL
, 0);
3791 bool do_display
= true;
3793 if (FRAME_TERMCAP_P (SELECTED_FRAME ()))
3795 struct tty_display_info
*tty
= CURTTY ();
3797 /* When this TTY is displaying a menu, we must prevent
3798 any redisplay, because we modify the frame's glyph
3799 matrix behind the back of the display engine. */
3800 if (tty
->showing_menu
)
3804 wait_reading_process_output (0, 0, -1, do_display
, Qnil
, NULL
, 0);
3807 if (!interrupt_input
&& kbd_fetch_ptr
== kbd_store_ptr
)
3811 if (CONSP (Vunread_command_events
))
3814 first
= XCAR (Vunread_command_events
);
3815 Vunread_command_events
= XCDR (Vunread_command_events
);
3816 *kbp
= current_kboard
;
3820 /* At this point, we know that there is a readable event available
3821 somewhere. If the event queue is empty, then there must be a
3822 mouse movement enabled and available. */
3823 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3825 union buffered_input_event
*event
;
3827 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
3831 *kbp
= event_to_kboard (&event
->ie
);
3833 *kbp
= current_kboard
; /* Better than returning null ptr? */
3837 /* These two kinds of events get special handling
3838 and don't actually appear to the command loop.
3839 We return nil for them. */
3840 if (event
->kind
== SELECTION_REQUEST_EVENT
3841 || event
->kind
== SELECTION_CLEAR_EVENT
)
3844 /* Remove it from the buffer before processing it,
3845 since otherwise swallow_events will see it
3846 and process it again. */
3847 struct selection_input_event copy
= event
->sie
;
3848 kbd_fetch_ptr
= event
+ 1;
3849 input_pending
= readable_events (0);
3850 x_handle_selection_event (©
);
3852 /* We're getting selection request events, but we don't have
3858 #if defined (HAVE_NS)
3859 else if (event
->kind
== NS_TEXT_EVENT
)
3861 if (event
->ie
.code
== KEY_NS_PUT_WORKING_TEXT
)
3862 obj
= list1 (intern ("ns-put-working-text"));
3864 obj
= list1 (intern ("ns-unput-working-text"));
3865 kbd_fetch_ptr
= event
+ 1;
3866 if (used_mouse_menu
)
3867 *used_mouse_menu
= true;
3871 #if defined (HAVE_X11) || defined (HAVE_NTGUI) \
3872 || defined (HAVE_NS)
3873 else if (event
->kind
== DELETE_WINDOW_EVENT
)
3875 /* Make an event (delete-frame (FRAME)). */
3876 obj
= list2 (Qdelete_frame
, list1 (event
->ie
.frame_or_window
));
3877 kbd_fetch_ptr
= event
+ 1;
3880 #if defined (HAVE_X11) || defined (HAVE_NTGUI) \
3881 || defined (HAVE_NS)
3882 else if (event
->kind
== ICONIFY_EVENT
)
3884 /* Make an event (iconify-frame (FRAME)). */
3885 obj
= list2 (Qiconify_frame
, list1 (event
->ie
.frame_or_window
));
3886 kbd_fetch_ptr
= event
+ 1;
3888 else if (event
->kind
== DEICONIFY_EVENT
)
3890 /* Make an event (make-frame-visible (FRAME)). */
3891 obj
= list2 (Qmake_frame_visible
, list1 (event
->ie
.frame_or_window
));
3892 kbd_fetch_ptr
= event
+ 1;
3895 else if (event
->kind
== BUFFER_SWITCH_EVENT
)
3897 /* The value doesn't matter here; only the type is tested. */
3898 XSETBUFFER (obj
, current_buffer
);
3899 kbd_fetch_ptr
= event
+ 1;
3901 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
3902 || defined (HAVE_NS) || defined (USE_GTK)
3903 else if (event
->kind
== MENU_BAR_ACTIVATE_EVENT
)
3905 kbd_fetch_ptr
= event
+ 1;
3906 input_pending
= readable_events (0);
3907 if (FRAME_LIVE_P (XFRAME (event
->ie
.frame_or_window
)))
3908 x_activate_menubar (XFRAME (event
->ie
.frame_or_window
));
3912 else if (event
->kind
== LANGUAGE_CHANGE_EVENT
)
3914 /* Make an event (language-change FRAME CODEPAGE LANGUAGE-ID). */
3915 obj
= list4 (Qlanguage_change
,
3916 event
->ie
.frame_or_window
,
3917 make_number (event
->ie
.code
),
3918 make_number (event
->ie
.modifiers
));
3919 kbd_fetch_ptr
= event
+ 1;
3922 #ifdef USE_FILE_NOTIFY
3923 else if (event
->kind
== FILE_NOTIFY_EVENT
)
3925 #ifdef HAVE_W32NOTIFY
3926 /* Make an event (file-notify (DESCRIPTOR ACTION FILE) CALLBACK). */
3927 obj
= list3 (Qfile_notify
, event
->ie
.arg
, event
->ie
.frame_or_window
);
3929 obj
= make_lispy_event (&event
->ie
);
3931 kbd_fetch_ptr
= event
+ 1;
3933 #endif /* USE_FILE_NOTIFY */
3934 else if (event
->kind
== SAVE_SESSION_EVENT
)
3936 obj
= list2 (Qsave_session
, event
->ie
.arg
);
3937 kbd_fetch_ptr
= event
+ 1;
3939 /* Just discard these, by returning nil.
3940 With MULTI_KBOARD, these events are used as placeholders
3941 when we need to randomly delete events from the queue.
3942 (They shouldn't otherwise be found in the buffer,
3943 but on some machines it appears they do show up
3944 even without MULTI_KBOARD.) */
3945 /* On Windows NT/9X, NO_EVENT is used to delete extraneous
3946 mouse events during a popup-menu call. */
3947 else if (event
->kind
== NO_EVENT
)
3948 kbd_fetch_ptr
= event
+ 1;
3949 else if (event
->kind
== HELP_EVENT
)
3951 Lisp_Object object
, position
, help
, frame
, window
;
3953 frame
= event
->ie
.frame_or_window
;
3954 object
= event
->ie
.arg
;
3955 position
= make_number (Time_to_position (event
->ie
.timestamp
));
3956 window
= event
->ie
.x
;
3958 clear_event (event
);
3960 kbd_fetch_ptr
= event
+ 1;
3961 if (!WINDOWP (window
))
3963 obj
= Fcons (Qhelp_echo
,
3964 list5 (frame
, help
, window
, object
, position
));
3966 else if (event
->kind
== FOCUS_IN_EVENT
)
3968 /* Notification of a FocusIn event. The frame receiving the
3969 focus is in event->frame_or_window. Generate a
3970 switch-frame event if necessary. */
3971 Lisp_Object frame
, focus
;
3973 frame
= event
->ie
.frame_or_window
;
3974 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
3980 ! NILP (event
->ie
.arg
)
3983 !EQ (frame
, internal_last_event_frame
)
3984 && !EQ (frame
, selected_frame
))
3985 obj
= make_lispy_switch_frame (frame
);
3987 obj
= make_lispy_focus_in (frame
);
3989 internal_last_event_frame
= frame
;
3990 kbd_fetch_ptr
= event
+ 1;
3992 else if (event
->kind
== FOCUS_OUT_EVENT
)
3994 #ifdef HAVE_WINDOW_SYSTEM
3997 Lisp_Object frame
= event
->ie
.frame_or_window
;
3998 bool focused
= false;
4000 for (di
= x_display_list
; di
&& ! focused
; di
= di
->next
)
4001 focused
= di
->x_highlight_frame
!= 0;
4004 obj
= make_lispy_focus_out (frame
);
4006 #endif /* HAVE_WINDOW_SYSTEM */
4008 kbd_fetch_ptr
= event
+ 1;
4011 else if (event
->kind
== DBUS_EVENT
)
4013 obj
= make_lispy_event (&event
->ie
);
4014 kbd_fetch_ptr
= event
+ 1;
4017 else if (event
->kind
== CONFIG_CHANGED_EVENT
)
4019 obj
= make_lispy_event (&event
->ie
);
4020 kbd_fetch_ptr
= event
+ 1;
4024 /* If this event is on a different frame, return a switch-frame this
4025 time, and leave the event in the queue for next time. */
4029 frame
= event
->ie
.frame_or_window
;
4031 frame
= XCAR (frame
);
4032 else if (WINDOWP (frame
))
4033 frame
= WINDOW_FRAME (XWINDOW (frame
));
4035 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
4039 if (! EQ (frame
, internal_last_event_frame
)
4040 && !EQ (frame
, selected_frame
))
4041 obj
= make_lispy_switch_frame (frame
);
4042 internal_last_event_frame
= frame
;
4044 /* If we didn't decide to make a switch-frame event, go ahead
4045 and build a real event from the queue entry. */
4049 obj
= make_lispy_event (&event
->ie
);
4051 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
4052 || defined (HAVE_NS) || defined (USE_GTK)
4053 /* If this was a menu selection, then set the flag to inhibit
4054 writing to last_nonmenu_event. Don't do this if the event
4055 we're returning is (menu-bar), though; that indicates the
4056 beginning of the menu sequence, and we might as well leave
4057 that as the `event with parameters' for this selection. */
4059 && !EQ (event
->ie
.frame_or_window
, event
->ie
.arg
)
4060 && (event
->kind
== MENU_BAR_EVENT
4061 || event
->kind
== TOOL_BAR_EVENT
))
4062 *used_mouse_menu
= true;
4065 /* Certain system events are non-key events. */
4067 && event
->kind
== NS_NONKEY_EVENT
)
4068 *used_mouse_menu
= true;
4071 /* Wipe out this event, to catch bugs. */
4072 clear_event (event
);
4073 kbd_fetch_ptr
= event
+ 1;
4077 /* Try generating a mouse motion event. */
4078 else if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
4080 struct frame
*f
= some_mouse_moved ();
4081 Lisp_Object bar_window
;
4082 enum scroll_bar_part part
;
4086 *kbp
= current_kboard
;
4087 /* Note that this uses F to determine which terminal to look at.
4088 If there is no valid info, it does not store anything
4089 so x remains nil. */
4092 /* XXX Can f or mouse_position_hook be NULL here? */
4093 if (f
&& FRAME_TERMINAL (f
)->mouse_position_hook
)
4094 (*FRAME_TERMINAL (f
)->mouse_position_hook
) (&f
, 0, &bar_window
,
4099 /* Decide if we should generate a switch-frame event. Don't
4100 generate switch-frame events for motion outside of all Emacs
4106 frame
= FRAME_FOCUS_FRAME (f
);
4108 XSETFRAME (frame
, f
);
4110 if (! EQ (frame
, internal_last_event_frame
)
4111 && !EQ (frame
, selected_frame
))
4112 obj
= make_lispy_switch_frame (frame
);
4113 internal_last_event_frame
= frame
;
4116 /* If we didn't decide to make a switch-frame event, go ahead and
4117 return a mouse-motion event. */
4118 if (!NILP (x
) && NILP (obj
))
4119 obj
= make_lispy_movement (f
, bar_window
, part
, x
, y
, t
);
4122 /* We were promised by the above while loop that there was
4123 something for us to read! */
4126 input_pending
= readable_events (0);
4128 Vlast_event_frame
= internal_last_event_frame
;
4133 /* Process any non-user-visible events (currently X selection events),
4134 without reading any user-visible events. */
4137 process_special_events (void)
4139 union buffered_input_event
*event
;
4141 for (event
= kbd_fetch_ptr
; event
!= kbd_store_ptr
; ++event
)
4143 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
4146 if (event
== kbd_store_ptr
)
4150 /* If we find a stored X selection request, handle it now. */
4151 if (event
->kind
== SELECTION_REQUEST_EVENT
4152 || event
->kind
== SELECTION_CLEAR_EVENT
)
4156 /* Remove the event from the fifo buffer before processing;
4157 otherwise swallow_events called recursively could see it
4158 and process it again. To do this, we move the events
4159 between kbd_fetch_ptr and EVENT one slot to the right,
4162 struct selection_input_event copy
= event
->sie
;
4163 union buffered_input_event
*beg
4164 = (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
4165 ? kbd_buffer
: kbd_fetch_ptr
;
4168 memmove (beg
+ 1, beg
, (event
- beg
) * sizeof *beg
);
4169 else if (event
< beg
)
4171 if (event
> kbd_buffer
)
4172 memmove (kbd_buffer
+ 1, kbd_buffer
,
4173 (event
- kbd_buffer
) * sizeof *kbd_buffer
);
4174 *kbd_buffer
= *(kbd_buffer
+ KBD_BUFFER_SIZE
- 1);
4175 if (beg
< kbd_buffer
+ KBD_BUFFER_SIZE
- 1)
4176 memmove (beg
+ 1, beg
,
4177 (kbd_buffer
+ KBD_BUFFER_SIZE
- 1 - beg
) * sizeof *beg
);
4180 if (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
4181 kbd_fetch_ptr
= kbd_buffer
+ 1;
4185 input_pending
= readable_events (0);
4186 x_handle_selection_event (©
);
4188 /* We're getting selection request events, but we don't have
4196 /* Process any events that are not user-visible, run timer events that
4197 are ripe, and return, without reading any user-visible events. */
4200 swallow_events (bool do_display
)
4202 unsigned old_timers_run
;
4204 process_special_events ();
4206 old_timers_run
= timers_run
;
4207 get_input_pending (READABLE_EVENTS_DO_TIMERS_NOW
);
4209 if (!input_pending
&& timers_run
!= old_timers_run
&& do_display
)
4210 redisplay_preserve_echo_area (7);
4213 /* Record the start of when Emacs is idle,
4214 for the sake of running idle-time timers. */
4217 timer_start_idle (void)
4219 /* If we are already in the idle state, do nothing. */
4220 if (timespec_valid_p (timer_idleness_start_time
))
4223 timer_idleness_start_time
= current_timespec ();
4224 timer_last_idleness_start_time
= timer_idleness_start_time
;
4226 /* Mark all idle-time timers as once again candidates for running. */
4227 call0 (intern ("internal-timer-start-idle"));
4230 /* Record that Emacs is no longer idle, so stop running idle-time timers. */
4233 timer_stop_idle (void)
4235 timer_idleness_start_time
= invalid_timespec ();
4238 /* Resume idle timer from last idle start time. */
4241 timer_resume_idle (void)
4243 if (timespec_valid_p (timer_idleness_start_time
))
4246 timer_idleness_start_time
= timer_last_idleness_start_time
;
4249 /* List of elisp functions to call, delayed because they were generated in
4250 a context where Elisp could not be safely run (e.g. redisplay, signal,
4251 ...). Each element has the form (FUN . ARGS). */
4252 Lisp_Object pending_funcalls
;
4254 /* Return true if TIMER is a valid timer, placing its value into *RESULT. */
4256 decode_timer (Lisp_Object timer
, struct timespec
*result
)
4260 if (! (VECTORP (timer
) && ASIZE (timer
) == 9))
4262 vec
= XVECTOR (timer
)->contents
;
4263 if (! NILP (vec
[0]))
4265 if (! INTEGERP (vec
[2]))
4269 if (decode_time_components (vec
[1], vec
[2], vec
[3], vec
[8], &t
, 0) <= 0)
4271 *result
= lisp_to_timespec (t
);
4272 return timespec_valid_p (*result
);
4276 /* Check whether a timer has fired. To prevent larger problems we simply
4277 disregard elements that are not proper timers. Do not make a circular
4278 timer list for the time being.
4280 Returns the time to wait until the next timer fires. If a
4281 timer is triggering now, return zero.
4282 If no timer is active, return -1.
4284 If a timer is ripe, we run it, with quitting turned off.
4285 In that case we return 0 to indicate that a new timer_check_2 call
4288 static struct timespec
4289 timer_check_2 (Lisp_Object timers
, Lisp_Object idle_timers
)
4291 struct timespec nexttime
;
4292 struct timespec now
;
4293 struct timespec idleness_now
;
4294 Lisp_Object chosen_timer
;
4296 nexttime
= invalid_timespec ();
4298 chosen_timer
= Qnil
;
4300 /* First run the code that was delayed. */
4301 while (CONSP (pending_funcalls
))
4303 Lisp_Object funcall
= XCAR (pending_funcalls
);
4304 pending_funcalls
= XCDR (pending_funcalls
);
4305 safe_call2 (Qapply
, XCAR (funcall
), XCDR (funcall
));
4308 if (CONSP (timers
) || CONSP (idle_timers
))
4310 now
= current_timespec ();
4311 idleness_now
= (timespec_valid_p (timer_idleness_start_time
)
4312 ? timespec_sub (now
, timer_idleness_start_time
)
4313 : make_timespec (0, 0));
4316 while (CONSP (timers
) || CONSP (idle_timers
))
4318 Lisp_Object timer
= Qnil
, idle_timer
= Qnil
;
4319 struct timespec timer_time
, idle_timer_time
;
4320 struct timespec difference
;
4321 struct timespec timer_difference
= invalid_timespec ();
4322 struct timespec idle_timer_difference
= invalid_timespec ();
4323 bool ripe
, timer_ripe
= 0, idle_timer_ripe
= 0;
4325 /* Set TIMER and TIMER_DIFFERENCE
4326 based on the next ordinary timer.
4327 TIMER_DIFFERENCE is the distance in time from NOW to when
4328 this timer becomes ripe.
4329 Skip past invalid timers and timers already handled. */
4332 timer
= XCAR (timers
);
4333 if (! decode_timer (timer
, &timer_time
))
4335 timers
= XCDR (timers
);
4339 timer_ripe
= timespec_cmp (timer_time
, now
) <= 0;
4340 timer_difference
= (timer_ripe
4341 ? timespec_sub (now
, timer_time
)
4342 : timespec_sub (timer_time
, now
));
4345 /* Likewise for IDLE_TIMER and IDLE_TIMER_DIFFERENCE
4346 based on the next idle timer. */
4347 if (CONSP (idle_timers
))
4349 idle_timer
= XCAR (idle_timers
);
4350 if (! decode_timer (idle_timer
, &idle_timer_time
))
4352 idle_timers
= XCDR (idle_timers
);
4356 idle_timer_ripe
= timespec_cmp (idle_timer_time
, idleness_now
) <= 0;
4357 idle_timer_difference
4359 ? timespec_sub (idleness_now
, idle_timer_time
)
4360 : timespec_sub (idle_timer_time
, idleness_now
));
4363 /* Decide which timer is the next timer,
4364 and set CHOSEN_TIMER, DIFFERENCE, and RIPE accordingly.
4365 Also step down the list where we found that timer. */
4367 if (timespec_valid_p (timer_difference
)
4368 && (! timespec_valid_p (idle_timer_difference
)
4369 || idle_timer_ripe
< timer_ripe
4370 || (idle_timer_ripe
== timer_ripe
4372 ? timespec_cmp (idle_timer_difference
,
4374 : timespec_cmp (timer_difference
,
4375 idle_timer_difference
))
4378 chosen_timer
= timer
;
4379 timers
= XCDR (timers
);
4380 difference
= timer_difference
;
4385 chosen_timer
= idle_timer
;
4386 idle_timers
= XCDR (idle_timers
);
4387 difference
= idle_timer_difference
;
4388 ripe
= idle_timer_ripe
;
4391 /* If timer is ripe, run it if it hasn't been run. */
4394 if (NILP (AREF (chosen_timer
, 0)))
4396 ptrdiff_t count
= SPECPDL_INDEX ();
4397 Lisp_Object old_deactivate_mark
= Vdeactivate_mark
;
4399 /* Mark the timer as triggered to prevent problems if the lisp
4400 code fails to reschedule it right. */
4401 ASET (chosen_timer
, 0, Qt
);
4403 specbind (Qinhibit_quit
, Qt
);
4405 call1 (Qtimer_event_handler
, chosen_timer
);
4406 Vdeactivate_mark
= old_deactivate_mark
;
4408 unbind_to (count
, Qnil
);
4410 /* Since we have handled the event,
4411 we don't need to tell the caller to wake up and do it. */
4412 /* But the caller must still wait for the next timer, so
4413 return 0 to indicate that. */
4416 nexttime
= make_timespec (0, 0);
4420 /* When we encounter a timer that is still waiting,
4421 return the amount of time to wait before it is ripe. */
4427 /* No timers are pending in the future. */
4428 /* Return 0 if we generated an event, and -1 if not. */
4433 /* Check whether a timer has fired. To prevent larger problems we simply
4434 disregard elements that are not proper timers. Do not make a circular
4435 timer list for the time being.
4437 Returns the time to wait until the next timer fires.
4438 If no timer is active, return an invalid value.
4440 As long as any timer is ripe, we run it. */
4445 struct timespec nexttime
;
4446 Lisp_Object timers
, idle_timers
;
4448 Lisp_Object tem
= Vinhibit_quit
;
4451 /* We use copies of the timers' lists to allow a timer to add itself
4452 again, without locking up Emacs if the newly added timer is
4453 already ripe when added. */
4455 /* Always consider the ordinary timers. */
4456 timers
= Fcopy_sequence (Vtimer_list
);
4457 /* Consider the idle timers only if Emacs is idle. */
4458 if (timespec_valid_p (timer_idleness_start_time
))
4459 idle_timers
= Fcopy_sequence (Vtimer_idle_list
);
4463 Vinhibit_quit
= tem
;
4467 nexttime
= timer_check_2 (timers
, idle_timers
);
4469 while (nexttime
.tv_sec
== 0 && nexttime
.tv_nsec
== 0);
4474 DEFUN ("current-idle-time", Fcurrent_idle_time
, Scurrent_idle_time
, 0, 0, 0,
4475 doc
: /* Return the current length of Emacs idleness, or nil.
4476 The value when Emacs is idle is a list of four integers (HIGH LOW USEC PSEC)
4477 in the same style as (current-time).
4479 The value when Emacs is not idle is nil.
4481 PSEC is a multiple of the system clock resolution. */)
4484 if (timespec_valid_p (timer_idleness_start_time
))
4485 return make_lisp_time (timespec_sub (current_timespec (),
4486 timer_idleness_start_time
));
4491 /* Caches for modify_event_symbol. */
4492 static Lisp_Object accent_key_syms
;
4493 static Lisp_Object func_key_syms
;
4494 static Lisp_Object mouse_syms
;
4495 static Lisp_Object wheel_syms
;
4496 static Lisp_Object drag_n_drop_syms
;
4498 /* This is a list of keysym codes for special "accent" characters.
4499 It parallels lispy_accent_keys. */
4501 static const int lispy_accent_codes
[] =
4503 #ifdef XK_dead_circumflex
4508 #ifdef XK_dead_grave
4513 #ifdef XK_dead_tilde
4518 #ifdef XK_dead_diaeresis
4523 #ifdef XK_dead_macron
4528 #ifdef XK_dead_degree
4533 #ifdef XK_dead_acute
4538 #ifdef XK_dead_cedilla
4543 #ifdef XK_dead_breve
4548 #ifdef XK_dead_ogonek
4553 #ifdef XK_dead_caron
4558 #ifdef XK_dead_doubleacute
4559 XK_dead_doubleacute
,
4563 #ifdef XK_dead_abovedot
4568 #ifdef XK_dead_abovering
4578 #ifdef XK_dead_belowdot
4583 #ifdef XK_dead_voiced_sound
4584 XK_dead_voiced_sound
,
4588 #ifdef XK_dead_semivoiced_sound
4589 XK_dead_semivoiced_sound
,
4605 /* This is a list of Lisp names for special "accent" characters.
4606 It parallels lispy_accent_codes. */
4608 static const char *const lispy_accent_keys
[] =
4626 "dead-voiced-sound",
4627 "dead-semivoiced-sound",
4633 #define FUNCTION_KEY_OFFSET 0x0
4635 const char *const lispy_function_keys
[] =
4639 0, /* VK_LBUTTON 0x01 */
4640 0, /* VK_RBUTTON 0x02 */
4641 "cancel", /* VK_CANCEL 0x03 */
4642 0, /* VK_MBUTTON 0x04 */
4644 0, 0, 0, /* 0x05 .. 0x07 */
4646 "backspace", /* VK_BACK 0x08 */
4647 "tab", /* VK_TAB 0x09 */
4649 0, 0, /* 0x0A .. 0x0B */
4651 "clear", /* VK_CLEAR 0x0C */
4652 "return", /* VK_RETURN 0x0D */
4654 0, 0, /* 0x0E .. 0x0F */
4656 0, /* VK_SHIFT 0x10 */
4657 0, /* VK_CONTROL 0x11 */
4658 0, /* VK_MENU 0x12 */
4659 "pause", /* VK_PAUSE 0x13 */
4660 "capslock", /* VK_CAPITAL 0x14 */
4661 "kana", /* VK_KANA/VK_HANGUL 0x15 */
4663 "junja", /* VK_JUNJA 0x17 */
4664 "final", /* VK_FINAL 0x18 */
4665 "kanji", /* VK_KANJI/VK_HANJA 0x19 */
4667 "escape", /* VK_ESCAPE 0x1B */
4668 "convert", /* VK_CONVERT 0x1C */
4669 "non-convert", /* VK_NONCONVERT 0x1D */
4670 "accept", /* VK_ACCEPT 0x1E */
4671 "mode-change", /* VK_MODECHANGE 0x1F */
4672 0, /* VK_SPACE 0x20 */
4673 "prior", /* VK_PRIOR 0x21 */
4674 "next", /* VK_NEXT 0x22 */
4675 "end", /* VK_END 0x23 */
4676 "home", /* VK_HOME 0x24 */
4677 "left", /* VK_LEFT 0x25 */
4678 "up", /* VK_UP 0x26 */
4679 "right", /* VK_RIGHT 0x27 */
4680 "down", /* VK_DOWN 0x28 */
4681 "select", /* VK_SELECT 0x29 */
4682 "print", /* VK_PRINT 0x2A */
4683 "execute", /* VK_EXECUTE 0x2B */
4684 "snapshot", /* VK_SNAPSHOT 0x2C */
4685 "insert", /* VK_INSERT 0x2D */
4686 "delete", /* VK_DELETE 0x2E */
4687 "help", /* VK_HELP 0x2F */
4689 /* VK_0 thru VK_9 are the same as ASCII '0' thru '9' (0x30 - 0x39) */
4691 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4693 0, 0, 0, 0, 0, 0, 0, /* 0x3A .. 0x40 */
4695 /* VK_A thru VK_Z are the same as ASCII 'A' thru 'Z' (0x41 - 0x5A) */
4697 0, 0, 0, 0, 0, 0, 0, 0, 0,
4698 0, 0, 0, 0, 0, 0, 0, 0, 0,
4699 0, 0, 0, 0, 0, 0, 0, 0,
4701 "lwindow", /* VK_LWIN 0x5B */
4702 "rwindow", /* VK_RWIN 0x5C */
4703 "apps", /* VK_APPS 0x5D */
4706 "kp-0", /* VK_NUMPAD0 0x60 */
4707 "kp-1", /* VK_NUMPAD1 0x61 */
4708 "kp-2", /* VK_NUMPAD2 0x62 */
4709 "kp-3", /* VK_NUMPAD3 0x63 */
4710 "kp-4", /* VK_NUMPAD4 0x64 */
4711 "kp-5", /* VK_NUMPAD5 0x65 */
4712 "kp-6", /* VK_NUMPAD6 0x66 */
4713 "kp-7", /* VK_NUMPAD7 0x67 */
4714 "kp-8", /* VK_NUMPAD8 0x68 */
4715 "kp-9", /* VK_NUMPAD9 0x69 */
4716 "kp-multiply", /* VK_MULTIPLY 0x6A */
4717 "kp-add", /* VK_ADD 0x6B */
4718 "kp-separator", /* VK_SEPARATOR 0x6C */
4719 "kp-subtract", /* VK_SUBTRACT 0x6D */
4720 "kp-decimal", /* VK_DECIMAL 0x6E */
4721 "kp-divide", /* VK_DIVIDE 0x6F */
4722 "f1", /* VK_F1 0x70 */
4723 "f2", /* VK_F2 0x71 */
4724 "f3", /* VK_F3 0x72 */
4725 "f4", /* VK_F4 0x73 */
4726 "f5", /* VK_F5 0x74 */
4727 "f6", /* VK_F6 0x75 */
4728 "f7", /* VK_F7 0x76 */
4729 "f8", /* VK_F8 0x77 */
4730 "f9", /* VK_F9 0x78 */
4731 "f10", /* VK_F10 0x79 */
4732 "f11", /* VK_F11 0x7A */
4733 "f12", /* VK_F12 0x7B */
4734 "f13", /* VK_F13 0x7C */
4735 "f14", /* VK_F14 0x7D */
4736 "f15", /* VK_F15 0x7E */
4737 "f16", /* VK_F16 0x7F */
4738 "f17", /* VK_F17 0x80 */
4739 "f18", /* VK_F18 0x81 */
4740 "f19", /* VK_F19 0x82 */
4741 "f20", /* VK_F20 0x83 */
4742 "f21", /* VK_F21 0x84 */
4743 "f22", /* VK_F22 0x85 */
4744 "f23", /* VK_F23 0x86 */
4745 "f24", /* VK_F24 0x87 */
4747 0, 0, 0, 0, /* 0x88 .. 0x8B */
4748 0, 0, 0, 0, /* 0x8C .. 0x8F */
4750 "kp-numlock", /* VK_NUMLOCK 0x90 */
4751 "scroll", /* VK_SCROLL 0x91 */
4752 /* Not sure where the following block comes from.
4753 Windows headers have NEC and Fujitsu specific keys in
4754 this block, but nothing generic. */
4755 "kp-space", /* VK_NUMPAD_CLEAR 0x92 */
4756 "kp-enter", /* VK_NUMPAD_ENTER 0x93 */
4757 "kp-prior", /* VK_NUMPAD_PRIOR 0x94 */
4758 "kp-next", /* VK_NUMPAD_NEXT 0x95 */
4759 "kp-end", /* VK_NUMPAD_END 0x96 */
4760 "kp-home", /* VK_NUMPAD_HOME 0x97 */
4761 "kp-left", /* VK_NUMPAD_LEFT 0x98 */
4762 "kp-up", /* VK_NUMPAD_UP 0x99 */
4763 "kp-right", /* VK_NUMPAD_RIGHT 0x9A */
4764 "kp-down", /* VK_NUMPAD_DOWN 0x9B */
4765 "kp-insert", /* VK_NUMPAD_INSERT 0x9C */
4766 "kp-delete", /* VK_NUMPAD_DELETE 0x9D */
4768 0, 0, /* 0x9E .. 0x9F */
4771 * VK_L* & VK_R* - left and right Alt, Ctrl and Shift virtual keys.
4772 * Used only as parameters to GetAsyncKeyState and GetKeyState.
4773 * No other API or message will distinguish left and right keys this way.
4778 /* Multimedia keys. These are handled as WM_APPCOMMAND, which allows us
4779 to enable them selectively, and gives access to a few more functions.
4780 See lispy_multimedia_keys below. */
4781 0, 0, 0, 0, 0, 0, 0, /* 0xA6 .. 0xAC Browser */
4782 0, 0, 0, /* 0xAD .. 0xAF Volume */
4783 0, 0, 0, 0, /* 0xB0 .. 0xB3 Media */
4784 0, 0, 0, 0, /* 0xB4 .. 0xB7 Apps */
4786 /* 0xB8 .. 0xC0 "OEM" keys - all seem to be punctuation. */
4787 0, 0, 0, 0, 0, 0, 0, 0, 0,
4789 /* 0xC1 - 0xDA unallocated, 0xDB-0xDF more OEM keys */
4790 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4791 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4794 "ax", /* VK_OEM_AX 0xE1 */
4795 0, /* VK_OEM_102 0xE2 */
4796 "ico-help", /* VK_ICO_HELP 0xE3 */
4797 "ico-00", /* VK_ICO_00 0xE4 */
4798 0, /* VK_PROCESSKEY 0xE5 - used by IME */
4799 "ico-clear", /* VK_ICO_CLEAR 0xE6 */
4800 0, /* VK_PACKET 0xE7 - used to pass Unicode chars */
4802 "reset", /* VK_OEM_RESET 0xE9 */
4803 "jump", /* VK_OEM_JUMP 0xEA */
4804 "oem-pa1", /* VK_OEM_PA1 0xEB */
4805 "oem-pa2", /* VK_OEM_PA2 0xEC */
4806 "oem-pa3", /* VK_OEM_PA3 0xED */
4807 "wsctrl", /* VK_OEM_WSCTRL 0xEE */
4808 "cusel", /* VK_OEM_CUSEL 0xEF */
4809 "oem-attn", /* VK_OEM_ATTN 0xF0 */
4810 "finish", /* VK_OEM_FINISH 0xF1 */
4811 "copy", /* VK_OEM_COPY 0xF2 */
4812 "auto", /* VK_OEM_AUTO 0xF3 */
4813 "enlw", /* VK_OEM_ENLW 0xF4 */
4814 "backtab", /* VK_OEM_BACKTAB 0xF5 */
4815 "attn", /* VK_ATTN 0xF6 */
4816 "crsel", /* VK_CRSEL 0xF7 */
4817 "exsel", /* VK_EXSEL 0xF8 */
4818 "ereof", /* VK_EREOF 0xF9 */
4819 "play", /* VK_PLAY 0xFA */
4820 "zoom", /* VK_ZOOM 0xFB */
4821 "noname", /* VK_NONAME 0xFC */
4822 "pa1", /* VK_PA1 0xFD */
4823 "oem_clear", /* VK_OEM_CLEAR 0xFE */
4827 /* Some of these duplicate the "Media keys" on newer keyboards,
4828 but they are delivered to the application in a different way. */
4829 static const char *const lispy_multimedia_keys
[] =
4837 "browser-favorites",
4874 "toggle-dictate-command",
4880 "media-fast-forward",
4883 "media-channel-down"
4886 #else /* not HAVE_NTGUI */
4888 /* This should be dealt with in XTread_socket now, and that doesn't
4889 depend on the client system having the Kana syms defined. See also
4890 the XK_kana_A case below. */
4893 static const char *const lispy_kana_keys
[] =
4895 /* X Keysym value */
4896 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x400 .. 0x40f */
4897 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x410 .. 0x41f */
4898 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x420 .. 0x42f */
4899 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x430 .. 0x43f */
4900 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x440 .. 0x44f */
4901 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x450 .. 0x45f */
4902 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x460 .. 0x46f */
4903 0,0,0,0,0,0,0,0,0,0,0,0,0,0,"overline",0,
4904 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x480 .. 0x48f */
4905 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x490 .. 0x49f */
4906 0, "kana-fullstop", "kana-openingbracket", "kana-closingbracket",
4907 "kana-comma", "kana-conjunctive", "kana-WO", "kana-a",
4908 "kana-i", "kana-u", "kana-e", "kana-o",
4909 "kana-ya", "kana-yu", "kana-yo", "kana-tsu",
4910 "prolongedsound", "kana-A", "kana-I", "kana-U",
4911 "kana-E", "kana-O", "kana-KA", "kana-KI",
4912 "kana-KU", "kana-KE", "kana-KO", "kana-SA",
4913 "kana-SHI", "kana-SU", "kana-SE", "kana-SO",
4914 "kana-TA", "kana-CHI", "kana-TSU", "kana-TE",
4915 "kana-TO", "kana-NA", "kana-NI", "kana-NU",
4916 "kana-NE", "kana-NO", "kana-HA", "kana-HI",
4917 "kana-FU", "kana-HE", "kana-HO", "kana-MA",
4918 "kana-MI", "kana-MU", "kana-ME", "kana-MO",
4919 "kana-YA", "kana-YU", "kana-YO", "kana-RA",
4920 "kana-RI", "kana-RU", "kana-RE", "kana-RO",
4921 "kana-WA", "kana-N", "voicedsound", "semivoicedsound",
4922 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4e0 .. 0x4ef */
4923 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4f0 .. 0x4ff */
4925 #endif /* XK_kana_A */
4928 #define FUNCTION_KEY_OFFSET 0xff00
4930 /* You'll notice that this table is arranged to be conveniently
4931 indexed by X Windows keysym values. */
4932 static const char *const lispy_function_keys
[] =
4934 /* X Keysym value */
4936 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff00...0f */
4937 "backspace", "tab", "linefeed", "clear",
4939 0, 0, 0, "pause", /* 0xff10...1f */
4940 0, 0, 0, 0, 0, 0, 0, "escape",
4942 0, "kanji", "muhenkan", "henkan", /* 0xff20...2f */
4943 "romaji", "hiragana", "katakana", "hiragana-katakana",
4944 "zenkaku", "hankaku", "zenkaku-hankaku", "touroku",
4945 "massyo", "kana-lock", "kana-shift", "eisu-shift",
4946 "eisu-toggle", /* 0xff30...3f */
4947 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4948 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff40...4f */
4950 "home", "left", "up", "right", /* 0xff50 */ /* IsCursorKey */
4951 "down", "prior", "next", "end",
4952 "begin", 0, 0, 0, 0, 0, 0, 0,
4953 "select", /* 0xff60 */ /* IsMiscFunctionKey */
4964 "break", /* 0xff6b */
4967 0, 0, 0, 0, "backtab", 0, 0, 0, /* 0xff70... */
4968 0, 0, 0, 0, 0, 0, 0, "kp-numlock", /* 0xff78... */
4969 "kp-space", /* 0xff80 */ /* IsKeypadKey */
4970 0, 0, 0, 0, 0, 0, 0, 0,
4971 "kp-tab", /* 0xff89 */
4973 "kp-enter", /* 0xff8d */
4975 "kp-f1", /* 0xff91 */
4979 "kp-home", /* 0xff95 */
4984 "kp-prior", /* kp-page-up */
4985 "kp-next", /* kp-page-down */
4991 0, 0, 0, 0, 0, 0, 0, 0, 0,
4992 "kp-multiply", /* 0xffaa */
4997 "kp-divide", /* 0xffaf */
4998 "kp-0", /* 0xffb0 */
4999 "kp-1", "kp-2", "kp-3", "kp-4", "kp-5", "kp-6", "kp-7", "kp-8", "kp-9",
5002 "kp-equal", /* 0xffbd */
5003 "f1", /* 0xffbe */ /* IsFunctionKey */
5005 "f3", "f4", "f5", "f6", "f7", "f8", "f9", "f10", /* 0xffc0 */
5006 "f11", "f12", "f13", "f14", "f15", "f16", "f17", "f18",
5007 "f19", "f20", "f21", "f22", "f23", "f24", "f25", "f26", /* 0xffd0 */
5008 "f27", "f28", "f29", "f30", "f31", "f32", "f33", "f34",
5009 "f35", 0, 0, 0, 0, 0, 0, 0, /* 0xffe0 */
5010 0, 0, 0, 0, 0, 0, 0, 0,
5011 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfff0 */
5012 0, 0, 0, 0, 0, 0, 0, "delete"
5015 /* ISO 9995 Function and Modifier Keys; the first byte is 0xFE. */
5016 #define ISO_FUNCTION_KEY_OFFSET 0xfe00
5018 static const char *const iso_lispy_function_keys
[] =
5020 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe00 */
5021 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe08 */
5022 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe10 */
5023 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe18 */
5024 "iso-lefttab", /* 0xfe20 */
5025 "iso-move-line-up", "iso-move-line-down",
5026 "iso-partial-line-up", "iso-partial-line-down",
5027 "iso-partial-space-left", "iso-partial-space-right",
5028 "iso-set-margin-left", "iso-set-margin-right", /* 0xffe27, 28 */
5029 "iso-release-margin-left", "iso-release-margin-right",
5030 "iso-release-both-margins",
5031 "iso-fast-cursor-left", "iso-fast-cursor-right",
5032 "iso-fast-cursor-up", "iso-fast-cursor-down",
5033 "iso-continuous-underline", "iso-discontinuous-underline", /* 0xfe30, 31 */
5034 "iso-emphasize", "iso-center-object", "iso-enter", /* ... 0xfe34 */
5037 #endif /* not HAVE_NTGUI */
5039 static Lisp_Object Vlispy_mouse_stem
;
5041 static const char *const lispy_wheel_names
[] =
5043 "wheel-up", "wheel-down", "wheel-left", "wheel-right"
5046 /* drag-n-drop events are generated when a set of selected files are
5047 dragged from another application and dropped onto an Emacs window. */
5048 static const char *const lispy_drag_n_drop_names
[] =
5053 /* An array of symbol indexes of scroll bar parts, indexed by an enum
5054 scroll_bar_part value. Note that Qnil corresponds to
5055 scroll_bar_nowhere and should not appear in Lisp events. */
5056 static short const scroll_bar_parts
[] = {
5057 SYMBOL_INDEX (Qnil
), SYMBOL_INDEX (Qabove_handle
), SYMBOL_INDEX (Qhandle
),
5058 SYMBOL_INDEX (Qbelow_handle
), SYMBOL_INDEX (Qup
), SYMBOL_INDEX (Qdown
),
5059 SYMBOL_INDEX (Qtop
), SYMBOL_INDEX (Qbottom
), SYMBOL_INDEX (Qend_scroll
),
5060 SYMBOL_INDEX (Qratio
), SYMBOL_INDEX (Qbefore_handle
),
5061 SYMBOL_INDEX (Qhorizontal_handle
), SYMBOL_INDEX (Qafter_handle
),
5062 SYMBOL_INDEX (Qleft
), SYMBOL_INDEX (Qright
), SYMBOL_INDEX (Qleftmost
),
5063 SYMBOL_INDEX (Qrightmost
), SYMBOL_INDEX (Qend_scroll
), SYMBOL_INDEX (Qratio
)
5066 /* A vector, indexed by button number, giving the down-going location
5067 of currently depressed buttons, both scroll bar and non-scroll bar.
5069 The elements have the form
5070 (BUTTON-NUMBER MODIFIER-MASK . REST)
5071 where REST is the cdr of a position as it would be reported in the event.
5073 The make_lispy_event function stores positions here to tell the
5074 difference between click and drag events, and to store the starting
5075 location to be included in drag events. */
5077 static Lisp_Object button_down_location
;
5079 /* Information about the most recent up-going button event: Which
5080 button, what location, and what time. */
5082 static int last_mouse_button
;
5083 static int last_mouse_x
;
5084 static int last_mouse_y
;
5085 static Time button_down_time
;
5087 /* The number of clicks in this multiple-click. */
5089 static int double_click_count
;
5091 /* X and Y are frame-relative coordinates for a click or wheel event.
5092 Return a Lisp-style event list. */
5095 make_lispy_position (struct frame
*f
, Lisp_Object x
, Lisp_Object y
,
5098 enum window_part part
;
5099 Lisp_Object posn
= Qnil
;
5100 Lisp_Object extra_info
= Qnil
;
5101 /* Coordinate pixel positions to return. */
5102 int xret
= 0, yret
= 0;
5103 /* The window under frame pixel coordinates (x,y) */
5104 Lisp_Object window
= f
5105 ? window_from_coordinates (f
, XINT (x
), XINT (y
), &part
, 0)
5108 if (WINDOWP (window
))
5110 /* It's a click in window WINDOW at frame coordinates (X,Y) */
5111 struct window
*w
= XWINDOW (window
);
5112 Lisp_Object string_info
= Qnil
;
5113 ptrdiff_t textpos
= 0;
5114 int col
= -1, row
= -1;
5115 int dx
= -1, dy
= -1;
5116 int width
= -1, height
= -1;
5117 Lisp_Object object
= Qnil
;
5119 /* Pixel coordinates relative to the window corner. */
5120 int wx
= XINT (x
) - WINDOW_LEFT_EDGE_X (w
);
5121 int wy
= XINT (y
) - WINDOW_TOP_EDGE_Y (w
);
5123 /* For text area clicks, return X, Y relative to the corner of
5124 this text area. Note that dX, dY etc are set below, by
5125 buffer_posn_from_coords. */
5126 if (part
== ON_TEXT
)
5128 xret
= XINT (x
) - window_box_left (w
, TEXT_AREA
);
5129 yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5131 /* For mode line and header line clicks, return X, Y relative to
5132 the left window edge. Use mode_line_string to look for a
5133 string on the click position. */
5134 else if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
)
5139 posn
= (part
== ON_MODE_LINE
) ? Qmode_line
: Qheader_line
;
5140 /* Note that mode_line_string takes COL, ROW as pixels and
5141 converts them to characters. */
5144 string
= mode_line_string (w
, part
, &col
, &row
, &charpos
,
5145 &object
, &dx
, &dy
, &width
, &height
);
5146 if (STRINGP (string
))
5147 string_info
= Fcons (string
, make_number (charpos
));
5153 /* For fringes and margins, Y is relative to the area's (and the
5154 window's) top edge, while X is meaningless. */
5155 else if (part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
5160 posn
= (part
== ON_LEFT_MARGIN
) ? Qleft_margin
: Qright_margin
;
5163 string
= marginal_area_string (w
, part
, &col
, &row
, &charpos
,
5164 &object
, &dx
, &dy
, &width
, &height
);
5165 if (STRINGP (string
))
5166 string_info
= Fcons (string
, make_number (charpos
));
5168 yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5170 else if (part
== ON_LEFT_FRINGE
)
5172 posn
= Qleft_fringe
;
5176 - (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5177 ? 0 : window_box_width (w
, LEFT_MARGIN_AREA
));
5178 dy
= yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5180 else if (part
== ON_RIGHT_FRINGE
)
5182 posn
= Qright_fringe
;
5186 - window_box_width (w
, LEFT_MARGIN_AREA
)
5187 - window_box_width (w
, TEXT_AREA
)
5188 - (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5189 ? window_box_width (w
, RIGHT_MARGIN_AREA
)
5191 dy
= yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5193 else if (part
== ON_VERTICAL_BORDER
)
5195 posn
= Qvertical_line
;
5201 else if (part
== ON_VERTICAL_SCROLL_BAR
)
5203 posn
= Qvertical_scroll_bar
;
5204 width
= WINDOW_SCROLL_BAR_AREA_WIDTH (w
);
5208 else if (part
== ON_HORIZONTAL_SCROLL_BAR
)
5210 posn
= Qhorizontal_scroll_bar
;
5211 width
= WINDOW_SCROLL_BAR_AREA_HEIGHT (w
);
5215 else if (part
== ON_RIGHT_DIVIDER
)
5217 posn
= Qright_divider
;
5218 width
= WINDOW_RIGHT_DIVIDER_WIDTH (w
);
5222 else if (part
== ON_BOTTOM_DIVIDER
)
5224 posn
= Qbottom_divider
;
5225 width
= WINDOW_BOTTOM_DIVIDER_WIDTH (w
);
5230 /* For clicks in the text area, fringes, margins, or vertical
5231 scroll bar, call buffer_posn_from_coords to extract TEXTPOS,
5232 the buffer position nearest to the click. */
5235 Lisp_Object string2
, object2
= Qnil
;
5236 struct display_pos p
;
5238 int width2
, height2
;
5239 /* The pixel X coordinate passed to buffer_posn_from_coords
5240 is the X coordinate relative to the text area for clicks
5241 in text-area, right-margin/fringe and right-side vertical
5242 scroll bar, zero otherwise. */
5244 = (part
== ON_TEXT
) ? xret
5245 : (part
== ON_RIGHT_FRINGE
|| part
== ON_RIGHT_MARGIN
5246 || (part
== ON_VERTICAL_SCROLL_BAR
5247 && WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_RIGHT (w
)))
5248 ? (XINT (x
) - window_box_left (w
, TEXT_AREA
))
5252 string2
= buffer_posn_from_coords (w
, &x2
, &y2
, &p
,
5253 &object2
, &dx2
, &dy2
,
5255 textpos
= CHARPOS (p
.pos
);
5256 if (col
< 0) col
= x2
;
5257 if (row
< 0) row
= y2
;
5258 if (dx
< 0) dx
= dx2
;
5259 if (dy
< 0) dy
= dy2
;
5260 if (width
< 0) width
= width2
;
5261 if (height
< 0) height
= height2
;
5265 posn
= make_number (textpos
);
5266 if (STRINGP (string2
))
5267 string_info
= Fcons (string2
,
5268 make_number (CHARPOS (p
.string_pos
)));
5274 #ifdef HAVE_WINDOW_SYSTEM
5275 if (IMAGEP (object
))
5277 Lisp_Object image_map
, hotspot
;
5278 if ((image_map
= Fplist_get (XCDR (object
), QCmap
),
5280 && (hotspot
= find_hot_spot (image_map
, dx
, dy
),
5282 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
5283 posn
= XCAR (hotspot
);
5290 Fcons (make_number (dx
), make_number (dy
)),
5291 Fcons (make_number (width
), make_number (height
)));
5294 extra_info
= Fcons (string_info
,
5295 Fcons (textpos
< 0 ? Qnil
: make_number (textpos
),
5296 Fcons (Fcons (make_number (col
),
5302 /* Return mouse pixel coordinates here. */
5303 XSETFRAME (window
, f
);
5310 return Fcons (window
,
5312 Fcons (Fcons (make_number (xret
),
5313 make_number (yret
)),
5314 Fcons (make_number (t
),
5318 /* Return non-zero if F is a GUI frame that uses some toolkit-managed
5319 menu bar. This really means that Emacs draws and manages the menu
5320 bar as part of its normal display, and therefore can compute its
5323 toolkit_menubar_in_use (struct frame
*f
)
5325 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS) || defined (HAVE_NTGUI)
5326 return !(!FRAME_WINDOW_P (f
));
5332 /* Build the part of Lisp event which represents scroll bar state from
5333 EV. TYPE is one of Qvertical_scroll_bar or Qhorizontal_scroll_bar. */
5336 make_scroll_bar_position (struct input_event
*ev
, Lisp_Object type
)
5338 return list5 (ev
->frame_or_window
, type
, Fcons (ev
->x
, ev
->y
),
5339 make_number (ev
->timestamp
),
5340 builtin_lisp_symbol (scroll_bar_parts
[ev
->part
]));
5343 /* Given a struct input_event, build the lisp event which represents
5344 it. If EVENT is 0, build a mouse movement event from the mouse
5345 movement buffer, which should have a movement event in it.
5347 Note that events must be passed to this function in the order they
5348 are received; this function stores the location of button presses
5349 in order to build drag events when the button is released. */
5352 make_lispy_event (struct input_event
*event
)
5356 switch (event
->kind
)
5358 /* A simple keystroke. */
5359 case ASCII_KEYSTROKE_EVENT
:
5360 case MULTIBYTE_CHAR_KEYSTROKE_EVENT
:
5362 Lisp_Object lispy_c
;
5363 EMACS_INT c
= event
->code
;
5364 if (event
->kind
== ASCII_KEYSTROKE_EVENT
)
5367 eassert (c
== event
->code
);
5368 /* Turn ASCII characters into control characters
5370 if (event
->modifiers
& ctrl_modifier
)
5372 c
= make_ctrl_char (c
);
5373 event
->modifiers
&= ~ctrl_modifier
;
5377 /* Add in the other modifier bits. The shift key was taken care
5378 of by the X code. */
5379 c
|= (event
->modifiers
5380 & (meta_modifier
| alt_modifier
5381 | hyper_modifier
| super_modifier
| ctrl_modifier
));
5382 /* Distinguish Shift-SPC from SPC. */
5383 if ((event
->code
) == 040
5384 && event
->modifiers
& shift_modifier
)
5385 c
|= shift_modifier
;
5386 button_down_time
= 0;
5387 XSETFASTINT (lispy_c
, c
);
5392 /* NS_NONKEY_EVENTs are just like NON_ASCII_KEYSTROKE_EVENTs,
5393 except that they are non-key events (last-nonmenu-event is nil). */
5394 case NS_NONKEY_EVENT
:
5397 /* A function key. The symbol may need to have modifier prefixes
5399 case NON_ASCII_KEYSTROKE_EVENT
:
5400 button_down_time
= 0;
5402 for (i
= 0; i
< ARRAYELTS (lispy_accent_codes
); i
++)
5403 if (event
->code
== lispy_accent_codes
[i
])
5404 return modify_event_symbol (i
,
5406 Qfunction_key
, Qnil
,
5407 lispy_accent_keys
, &accent_key_syms
,
5408 ARRAYELTS (lispy_accent_keys
));
5412 if (event
->code
>= 0x400 && event
->code
< 0x500)
5413 return modify_event_symbol (event
->code
- 0x400,
5414 event
->modifiers
& ~shift_modifier
,
5415 Qfunction_key
, Qnil
,
5416 lispy_kana_keys
, &func_key_syms
,
5417 ARRAYELTS (lispy_kana_keys
));
5418 #endif /* XK_kana_A */
5421 #ifdef ISO_FUNCTION_KEY_OFFSET
5422 if (event
->code
< FUNCTION_KEY_OFFSET
5423 && event
->code
>= ISO_FUNCTION_KEY_OFFSET
)
5424 return modify_event_symbol (event
->code
- ISO_FUNCTION_KEY_OFFSET
,
5426 Qfunction_key
, Qnil
,
5427 iso_lispy_function_keys
, &func_key_syms
,
5428 ARRAYELTS (iso_lispy_function_keys
));
5431 if ((FUNCTION_KEY_OFFSET
<= event
->code
5433 < FUNCTION_KEY_OFFSET
+ ARRAYELTS (lispy_function_keys
)))
5434 && lispy_function_keys
[event
->code
- FUNCTION_KEY_OFFSET
])
5435 return modify_event_symbol (event
->code
- FUNCTION_KEY_OFFSET
,
5437 Qfunction_key
, Qnil
,
5438 lispy_function_keys
, &func_key_syms
,
5439 ARRAYELTS (lispy_function_keys
));
5441 /* Handle system-specific or unknown keysyms.
5442 We need to use an alist rather than a vector as the cache
5443 since we can't make a vector long enough. */
5444 if (NILP (KVAR (current_kboard
, system_key_syms
)))
5445 kset_system_key_syms (current_kboard
, Fcons (Qnil
, Qnil
));
5446 return modify_event_symbol (event
->code
,
5449 KVAR (current_kboard
, Vsystem_key_alist
),
5450 0, &KVAR (current_kboard
, system_key_syms
),
5454 case MULTIMEDIA_KEY_EVENT
:
5455 if (event
->code
< ARRAYELTS (lispy_multimedia_keys
)
5456 && event
->code
> 0 && lispy_multimedia_keys
[event
->code
])
5458 return modify_event_symbol (event
->code
, event
->modifiers
,
5459 Qfunction_key
, Qnil
,
5460 lispy_multimedia_keys
, &func_key_syms
,
5461 ARRAYELTS (lispy_multimedia_keys
));
5466 /* A mouse click. Figure out where it is, decide whether it's
5467 a press, click or drag, and build the appropriate structure. */
5468 case MOUSE_CLICK_EVENT
:
5470 case GPM_CLICK_EVENT
:
5472 #ifndef USE_TOOLKIT_SCROLL_BARS
5473 case SCROLL_BAR_CLICK_EVENT
:
5474 case HORIZONTAL_SCROLL_BAR_CLICK_EVENT
:
5477 int button
= event
->code
;
5479 Lisp_Object position
;
5480 Lisp_Object
*start_pos_ptr
;
5481 Lisp_Object start_pos
;
5485 /* Build the position as appropriate for this mouse click. */
5486 if (event
->kind
== MOUSE_CLICK_EVENT
5488 || event
->kind
== GPM_CLICK_EVENT
5492 struct frame
*f
= XFRAME (event
->frame_or_window
);
5495 /* Ignore mouse events that were made on frame that
5496 have been deleted. */
5497 if (! FRAME_LIVE_P (f
))
5500 /* EVENT->x and EVENT->y are frame-relative pixel
5501 coordinates at this place. Under old redisplay, COLUMN
5502 and ROW are set to frame relative glyph coordinates
5503 which are then used to determine whether this click is
5504 in a menu (non-toolkit version). */
5505 if (!toolkit_menubar_in_use (f
))
5507 pixel_to_glyph_coords (f
, XINT (event
->x
), XINT (event
->y
),
5508 &column
, &row
, NULL
, 1);
5510 /* In the non-toolkit version, clicks on the menu bar
5511 are ordinary button events in the event buffer.
5512 Distinguish them, and invoke the menu.
5514 (In the toolkit version, the toolkit handles the
5515 menu bar and Emacs doesn't know about it until
5516 after the user makes a selection.) */
5517 if (row
>= 0 && row
< FRAME_MENU_BAR_LINES (f
)
5518 && (event
->modifiers
& down_modifier
))
5520 Lisp_Object items
, item
;
5522 /* Find the menu bar item under `column'. */
5524 items
= FRAME_MENU_BAR_ITEMS (f
);
5525 for (i
= 0; i
< ASIZE (items
); i
+= 4)
5527 Lisp_Object pos
, string
;
5528 string
= AREF (items
, i
+ 1);
5529 pos
= AREF (items
, i
+ 3);
5532 if (column
>= XINT (pos
)
5533 && column
< XINT (pos
) + SCHARS (string
))
5535 item
= AREF (items
, i
);
5540 /* ELisp manual 2.4b says (x y) are window
5541 relative but code says they are
5543 position
= list4 (event
->frame_or_window
,
5545 Fcons (event
->x
, event
->y
),
5546 make_number (event
->timestamp
));
5548 return list2 (item
, position
);
5552 position
= make_lispy_position (f
, event
->x
, event
->y
,
5555 #ifndef USE_TOOLKIT_SCROLL_BARS
5557 /* It's a scrollbar click. */
5558 position
= make_scroll_bar_position (event
, Qvertical_scroll_bar
);
5559 #endif /* not USE_TOOLKIT_SCROLL_BARS */
5561 if (button
>= ASIZE (button_down_location
))
5563 ptrdiff_t incr
= button
- ASIZE (button_down_location
) + 1;
5564 button_down_location
= larger_vector (button_down_location
,
5566 mouse_syms
= larger_vector (mouse_syms
, incr
, -1);
5569 start_pos_ptr
= aref_addr (button_down_location
, button
);
5570 start_pos
= *start_pos_ptr
;
5571 *start_pos_ptr
= Qnil
;
5574 /* On window-system frames, use the value of
5575 double-click-fuzz as is. On other frames, interpret it
5576 as a multiple of 1/8 characters. */
5580 if (WINDOWP (event
->frame_or_window
))
5581 f
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5582 else if (FRAMEP (event
->frame_or_window
))
5583 f
= XFRAME (event
->frame_or_window
);
5587 if (FRAME_WINDOW_P (f
))
5588 fuzz
= double_click_fuzz
;
5590 fuzz
= double_click_fuzz
/ 8;
5592 is_double
= (button
== last_mouse_button
5593 && (eabs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5594 && (eabs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5595 && button_down_time
!= 0
5596 && (EQ (Vdouble_click_time
, Qt
)
5597 || (NATNUMP (Vdouble_click_time
)
5598 && (event
->timestamp
- button_down_time
5599 < XFASTINT (Vdouble_click_time
)))));
5602 last_mouse_button
= button
;
5603 last_mouse_x
= XINT (event
->x
);
5604 last_mouse_y
= XINT (event
->y
);
5606 /* If this is a button press, squirrel away the location, so
5607 we can decide later whether it was a click or a drag. */
5608 if (event
->modifiers
& down_modifier
)
5612 double_click_count
++;
5613 event
->modifiers
|= ((double_click_count
> 2)
5618 double_click_count
= 1;
5619 button_down_time
= event
->timestamp
;
5620 *start_pos_ptr
= Fcopy_alist (position
);
5621 ignore_mouse_drag_p
= 0;
5624 /* Now we're releasing a button - check the co-ordinates to
5625 see if this was a click or a drag. */
5626 else if (event
->modifiers
& up_modifier
)
5628 /* If we did not see a down before this up, ignore the up.
5629 Probably this happened because the down event chose a
5630 menu item. It would be an annoyance to treat the
5631 release of the button that chose the menu item as a
5634 if (!CONSP (start_pos
))
5637 event
->modifiers
&= ~up_modifier
;
5640 Lisp_Object new_down
, down
;
5641 EMACS_INT xdiff
= double_click_fuzz
, ydiff
= double_click_fuzz
;
5643 /* The third element of every position
5644 should be the (x,y) pair. */
5645 down
= Fcar (Fcdr (Fcdr (start_pos
)));
5646 new_down
= Fcar (Fcdr (Fcdr (position
)));
5649 && INTEGERP (XCAR (down
)) && INTEGERP (XCDR (down
)))
5651 xdiff
= XINT (XCAR (new_down
)) - XINT (XCAR (down
));
5652 ydiff
= XINT (XCDR (new_down
)) - XINT (XCDR (down
));
5655 if (ignore_mouse_drag_p
)
5657 event
->modifiers
|= click_modifier
;
5658 ignore_mouse_drag_p
= 0;
5660 else if (xdiff
< double_click_fuzz
&& xdiff
> - double_click_fuzz
5661 && ydiff
< double_click_fuzz
&& ydiff
> - double_click_fuzz
5662 /* Maybe the mouse has moved a lot, caused scrolling, and
5663 eventually ended up at the same screen position (but
5664 not buffer position) in which case it is a drag, not
5666 /* FIXME: OTOH if the buffer position has changed
5667 because of a timer or process filter rather than
5668 because of mouse movement, it should be considered as
5669 a click. But mouse-drag-region completely ignores
5670 this case and it hasn't caused any real problem, so
5671 it's probably OK to ignore it as well. */
5672 && EQ (Fcar (Fcdr (start_pos
)), Fcar (Fcdr (position
))))
5673 /* Mouse hasn't moved (much). */
5674 event
->modifiers
|= click_modifier
;
5677 button_down_time
= 0;
5678 event
->modifiers
|= drag_modifier
;
5681 /* Don't check is_double; treat this as multiple
5682 if the down-event was multiple. */
5683 if (double_click_count
> 1)
5684 event
->modifiers
|= ((double_click_count
> 2)
5690 /* Every mouse event should either have the down_modifier or
5691 the up_modifier set. */
5695 /* Get the symbol we should use for the mouse click. */
5698 head
= modify_event_symbol (button
,
5700 Qmouse_click
, Vlispy_mouse_stem
,
5703 ASIZE (mouse_syms
));
5704 if (event
->modifiers
& drag_modifier
)
5705 return list3 (head
, start_pos
, position
);
5706 else if (event
->modifiers
& (double_modifier
| triple_modifier
))
5707 return list3 (head
, position
, make_number (double_click_count
));
5709 return list2 (head
, position
);
5714 case HORIZ_WHEEL_EVENT
:
5716 Lisp_Object position
;
5719 /* Build the position as appropriate for this mouse click. */
5720 struct frame
*f
= XFRAME (event
->frame_or_window
);
5722 /* Ignore wheel events that were made on frame that have been
5724 if (! FRAME_LIVE_P (f
))
5727 position
= make_lispy_position (f
, event
->x
, event
->y
,
5730 /* Set double or triple modifiers to indicate the wheel speed. */
5732 /* On window-system frames, use the value of
5733 double-click-fuzz as is. On other frames, interpret it
5734 as a multiple of 1/8 characters. */
5740 if (WINDOWP (event
->frame_or_window
))
5741 fr
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5742 else if (FRAMEP (event
->frame_or_window
))
5743 fr
= XFRAME (event
->frame_or_window
);
5747 fuzz
= FRAME_WINDOW_P (fr
)
5748 ? double_click_fuzz
: double_click_fuzz
/ 8;
5750 if (event
->modifiers
& up_modifier
)
5752 /* Emit a wheel-up event. */
5753 event
->modifiers
&= ~up_modifier
;
5756 else if (event
->modifiers
& down_modifier
)
5758 /* Emit a wheel-down event. */
5759 event
->modifiers
&= ~down_modifier
;
5763 /* Every wheel event should either have the down_modifier or
5764 the up_modifier set. */
5767 if (event
->kind
== HORIZ_WHEEL_EVENT
)
5770 is_double
= (last_mouse_button
== - (1 + symbol_num
)
5771 && (eabs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5772 && (eabs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5773 && button_down_time
!= 0
5774 && (EQ (Vdouble_click_time
, Qt
)
5775 || (NATNUMP (Vdouble_click_time
)
5776 && (event
->timestamp
- button_down_time
5777 < XFASTINT (Vdouble_click_time
)))));
5780 double_click_count
++;
5781 event
->modifiers
|= ((double_click_count
> 2)
5787 double_click_count
= 1;
5788 event
->modifiers
|= click_modifier
;
5791 button_down_time
= event
->timestamp
;
5792 /* Use a negative value to distinguish wheel from mouse button. */
5793 last_mouse_button
= - (1 + symbol_num
);
5794 last_mouse_x
= XINT (event
->x
);
5795 last_mouse_y
= XINT (event
->y
);
5797 /* Get the symbol we should use for the wheel event. */
5798 head
= modify_event_symbol (symbol_num
,
5804 ASIZE (wheel_syms
));
5807 if (event
->modifiers
& (double_modifier
| triple_modifier
))
5808 return list3 (head
, position
, make_number (double_click_count
));
5810 return list2 (head
, position
);
5814 #ifdef USE_TOOLKIT_SCROLL_BARS
5816 /* We don't have down and up events if using toolkit scroll bars,
5817 so make this always a click event. Store in the `part' of
5818 the Lisp event a symbol which maps to the following actions:
5820 `above_handle' page up
5821 `below_handle' page down
5825 `bottom' bottom of buffer
5826 `handle' thumb has been dragged.
5827 `end-scroll' end of interaction with scroll bar
5829 The incoming input_event contains in its `part' member an
5830 index of type `enum scroll_bar_part' which we can use as an
5831 index in scroll_bar_parts to get the appropriate symbol. */
5833 case SCROLL_BAR_CLICK_EVENT
:
5835 Lisp_Object position
, head
;
5837 position
= make_scroll_bar_position (event
, Qvertical_scroll_bar
);
5839 /* Always treat scroll bar events as clicks. */
5840 event
->modifiers
|= click_modifier
;
5841 event
->modifiers
&= ~up_modifier
;
5843 if (event
->code
>= ASIZE (mouse_syms
))
5844 mouse_syms
= larger_vector (mouse_syms
,
5845 event
->code
- ASIZE (mouse_syms
) + 1,
5848 /* Get the symbol we should use for the mouse click. */
5849 head
= modify_event_symbol (event
->code
,
5854 ASIZE (mouse_syms
));
5855 return list2 (head
, position
);
5858 case HORIZONTAL_SCROLL_BAR_CLICK_EVENT
:
5860 Lisp_Object position
, head
;
5862 position
= make_scroll_bar_position (event
, Qhorizontal_scroll_bar
);
5864 /* Always treat scroll bar events as clicks. */
5865 event
->modifiers
|= click_modifier
;
5866 event
->modifiers
&= ~up_modifier
;
5868 if (event
->code
>= ASIZE (mouse_syms
))
5869 mouse_syms
= larger_vector (mouse_syms
,
5870 event
->code
- ASIZE (mouse_syms
) + 1,
5873 /* Get the symbol we should use for the mouse click. */
5874 head
= modify_event_symbol (event
->code
,
5879 ASIZE (mouse_syms
));
5880 return list2 (head
, position
);
5883 #endif /* USE_TOOLKIT_SCROLL_BARS */
5885 case DRAG_N_DROP_EVENT
:
5888 Lisp_Object head
, position
;
5891 f
= XFRAME (event
->frame_or_window
);
5894 /* Ignore mouse events that were made on frames that
5895 have been deleted. */
5896 if (! FRAME_LIVE_P (f
))
5899 position
= make_lispy_position (f
, event
->x
, event
->y
,
5902 head
= modify_event_symbol (0, event
->modifiers
,
5904 lispy_drag_n_drop_names
,
5905 &drag_n_drop_syms
, 1);
5906 return list3 (head
, position
, files
);
5909 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
5910 || defined (HAVE_NS) || defined (USE_GTK)
5911 case MENU_BAR_EVENT
:
5912 if (EQ (event
->arg
, event
->frame_or_window
))
5913 /* This is the prefix key. We translate this to
5914 `(menu_bar)' because the code in keyboard.c for menu
5915 events, which we use, relies on this. */
5916 return list1 (Qmenu_bar
);
5920 case SELECT_WINDOW_EVENT
:
5921 /* Make an event (select-window (WINDOW)). */
5922 return list2 (Qselect_window
, list1 (event
->frame_or_window
));
5924 case TOOL_BAR_EVENT
:
5925 if (EQ (event
->arg
, event
->frame_or_window
))
5926 /* This is the prefix key. We translate this to
5927 `(tool_bar)' because the code in keyboard.c for tool bar
5928 events, which we use, relies on this. */
5929 return list1 (Qtool_bar
);
5930 else if (SYMBOLP (event
->arg
))
5931 return apply_modifiers (event
->modifiers
, event
->arg
);
5934 case USER_SIGNAL_EVENT
:
5935 /* A user signal. */
5937 char *name
= find_user_signal_name (event
->code
);
5940 return intern (name
);
5943 case SAVE_SESSION_EVENT
:
5944 return Qsave_session
;
5949 return Fcons (Qdbus_event
, event
->arg
);
5951 #endif /* HAVE_DBUS */
5953 #if defined HAVE_GFILENOTIFY || defined HAVE_INOTIFY
5954 case FILE_NOTIFY_EVENT
:
5956 return Fcons (Qfile_notify
, event
->arg
);
5958 #endif /* defined HAVE_GFILENOTIFY || defined HAVE_INOTIFY */
5960 case CONFIG_CHANGED_EVENT
:
5961 return list3 (Qconfig_changed_event
,
5962 event
->arg
, event
->frame_or_window
);
5964 /* The 'kind' field of the event is something we don't recognize. */
5971 make_lispy_movement (struct frame
*frame
, Lisp_Object bar_window
, enum scroll_bar_part part
,
5972 Lisp_Object x
, Lisp_Object y
, Time t
)
5974 /* Is it a scroll bar movement? */
5975 if (frame
&& ! NILP (bar_window
))
5977 Lisp_Object part_sym
;
5979 part_sym
= builtin_lisp_symbol (scroll_bar_parts
[part
]);
5980 return list2 (Qscroll_bar_movement
,
5982 Qvertical_scroll_bar
,
5987 /* Or is it an ordinary mouse movement? */
5990 Lisp_Object position
;
5991 position
= make_lispy_position (frame
, x
, y
, t
);
5992 return list2 (Qmouse_movement
, position
);
5996 /* Construct a switch frame event. */
5998 make_lispy_switch_frame (Lisp_Object frame
)
6000 return list2 (Qswitch_frame
, frame
);
6004 make_lispy_focus_in (Lisp_Object frame
)
6006 return list2 (Qfocus_in
, frame
);
6009 #ifdef HAVE_WINDOW_SYSTEM
6012 make_lispy_focus_out (Lisp_Object frame
)
6014 return list2 (Qfocus_out
, frame
);
6017 #endif /* HAVE_WINDOW_SYSTEM */
6019 /* Manipulating modifiers. */
6021 /* Parse the name of SYMBOL, and return the set of modifiers it contains.
6023 If MODIFIER_END is non-zero, set *MODIFIER_END to the position in
6024 SYMBOL's name of the end of the modifiers; the string from this
6025 position is the unmodified symbol name.
6027 This doesn't use any caches. */
6030 parse_modifiers_uncached (Lisp_Object symbol
, ptrdiff_t *modifier_end
)
6036 CHECK_SYMBOL (symbol
);
6039 name
= SYMBOL_NAME (symbol
);
6041 for (i
= 0; i
< SBYTES (name
) - 1; )
6043 ptrdiff_t this_mod_end
= 0;
6046 /* See if the name continues with a modifier word.
6047 Check that the word appears, but don't check what follows it.
6048 Set this_mod and this_mod_end to record what we find. */
6050 switch (SREF (name
, i
))
6052 #define SINGLE_LETTER_MOD(BIT) \
6053 (this_mod_end = i + 1, this_mod = BIT)
6056 SINGLE_LETTER_MOD (alt_modifier
);
6060 SINGLE_LETTER_MOD (ctrl_modifier
);
6064 SINGLE_LETTER_MOD (hyper_modifier
);
6068 SINGLE_LETTER_MOD (meta_modifier
);
6072 SINGLE_LETTER_MOD (shift_modifier
);
6076 SINGLE_LETTER_MOD (super_modifier
);
6079 #undef SINGLE_LETTER_MOD
6081 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6082 if (i + LEN + 1 <= SBYTES (name) \
6083 && ! memcmp (SDATA (name) + i, NAME, LEN)) \
6085 this_mod_end = i + LEN; \
6090 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
6091 MULTI_LETTER_MOD (down_modifier
, "down", 4);
6092 MULTI_LETTER_MOD (double_modifier
, "double", 6);
6096 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
6100 MULTI_LETTER_MOD (up_modifier
, "up", 2);
6102 #undef MULTI_LETTER_MOD
6106 /* If we found no modifier, stop looking for them. */
6107 if (this_mod_end
== 0)
6110 /* Check there is a dash after the modifier, so that it
6111 really is a modifier. */
6112 if (this_mod_end
>= SBYTES (name
)
6113 || SREF (name
, this_mod_end
) != '-')
6116 /* This modifier is real; look for another. */
6117 modifiers
|= this_mod
;
6118 i
= this_mod_end
+ 1;
6121 /* Should we include the `click' modifier? */
6122 if (! (modifiers
& (down_modifier
| drag_modifier
6123 | double_modifier
| triple_modifier
))
6124 && i
+ 7 == SBYTES (name
)
6125 && memcmp (SDATA (name
) + i
, "mouse-", 6) == 0
6126 && ('0' <= SREF (name
, i
+ 6) && SREF (name
, i
+ 6) <= '9'))
6127 modifiers
|= click_modifier
;
6129 if (! (modifiers
& (double_modifier
| triple_modifier
))
6130 && i
+ 6 < SBYTES (name
)
6131 && memcmp (SDATA (name
) + i
, "wheel-", 6) == 0)
6132 modifiers
|= click_modifier
;
6140 /* Return a symbol whose name is the modifier prefixes for MODIFIERS
6141 prepended to the string BASE[0..BASE_LEN-1].
6142 This doesn't use any caches. */
6144 apply_modifiers_uncached (int modifiers
, char *base
, int base_len
, int base_len_byte
)
6146 /* Since BASE could contain nulls, we can't use intern here; we have
6147 to use Fintern, which expects a genuine Lisp_String, and keeps a
6149 char new_mods
[sizeof "A-C-H-M-S-s-up-down-drag-double-triple-"];
6155 /* Mouse events should not exhibit the `up' modifier once they
6156 leave the event queue only accessible to C code; `up' will
6157 always be turned into a click or drag event before being
6158 presented to lisp code. But since lisp events can be
6159 synthesized bypassing the event queue and pushed into
6160 `unread-command-events' or its companions, it's better to just
6161 deal with unexpected modifier combinations. */
6163 if (modifiers
& alt_modifier
) { *p
++ = 'A'; *p
++ = '-'; }
6164 if (modifiers
& ctrl_modifier
) { *p
++ = 'C'; *p
++ = '-'; }
6165 if (modifiers
& hyper_modifier
) { *p
++ = 'H'; *p
++ = '-'; }
6166 if (modifiers
& meta_modifier
) { *p
++ = 'M'; *p
++ = '-'; }
6167 if (modifiers
& shift_modifier
) { *p
++ = 'S'; *p
++ = '-'; }
6168 if (modifiers
& super_modifier
) { *p
++ = 's'; *p
++ = '-'; }
6169 if (modifiers
& double_modifier
) p
= stpcpy (p
, "double-");
6170 if (modifiers
& triple_modifier
) p
= stpcpy (p
, "triple-");
6171 if (modifiers
& up_modifier
) p
= stpcpy (p
, "up-");
6172 if (modifiers
& down_modifier
) p
= stpcpy (p
, "down-");
6173 if (modifiers
& drag_modifier
) p
= stpcpy (p
, "drag-");
6174 /* The click modifier is denoted by the absence of other modifiers. */
6178 mod_len
= p
- new_mods
;
6182 Lisp_Object new_name
;
6184 new_name
= make_uninit_multibyte_string (mod_len
+ base_len
,
6185 mod_len
+ base_len_byte
);
6186 memcpy (SDATA (new_name
), new_mods
, mod_len
);
6187 memcpy (SDATA (new_name
) + mod_len
, base
, base_len_byte
);
6189 return Fintern (new_name
, Qnil
);
6194 static const char *const modifier_names
[] =
6196 "up", "down", "drag", "click", "double", "triple", 0, 0,
6197 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
6198 0, 0, "alt", "super", "hyper", "shift", "control", "meta"
6200 #define NUM_MOD_NAMES ARRAYELTS (modifier_names)
6202 static Lisp_Object modifier_symbols
;
6204 /* Return the list of modifier symbols corresponding to the mask MODIFIERS. */
6206 lispy_modifier_list (int modifiers
)
6208 Lisp_Object modifier_list
;
6211 modifier_list
= Qnil
;
6212 for (i
= 0; (1<<i
) <= modifiers
&& i
< NUM_MOD_NAMES
; i
++)
6213 if (modifiers
& (1<<i
))
6214 modifier_list
= Fcons (AREF (modifier_symbols
, i
),
6217 return modifier_list
;
6221 /* Parse the modifiers on SYMBOL, and return a list like (UNMODIFIED MASK),
6222 where UNMODIFIED is the unmodified form of SYMBOL,
6223 MASK is the set of modifiers present in SYMBOL's name.
6224 This is similar to parse_modifiers_uncached, but uses the cache in
6225 SYMBOL's Qevent_symbol_element_mask property, and maintains the
6226 Qevent_symbol_elements property. */
6228 #define KEY_TO_CHAR(k) (XINT (k) & ((1 << CHARACTERBITS) - 1))
6231 parse_modifiers (Lisp_Object symbol
)
6233 Lisp_Object elements
;
6235 if (INTEGERP (symbol
))
6236 return list2i (KEY_TO_CHAR (symbol
), XINT (symbol
) & CHAR_MODIFIER_MASK
);
6237 else if (!SYMBOLP (symbol
))
6240 elements
= Fget (symbol
, Qevent_symbol_element_mask
);
6241 if (CONSP (elements
))
6246 int modifiers
= parse_modifiers_uncached (symbol
, &end
);
6247 Lisp_Object unmodified
;
6250 unmodified
= Fintern (make_string (SSDATA (SYMBOL_NAME (symbol
)) + end
,
6251 SBYTES (SYMBOL_NAME (symbol
)) - end
),
6254 if (modifiers
& ~INTMASK
)
6256 XSETFASTINT (mask
, modifiers
);
6257 elements
= list2 (unmodified
, mask
);
6259 /* Cache the parsing results on SYMBOL. */
6260 Fput (symbol
, Qevent_symbol_element_mask
,
6262 Fput (symbol
, Qevent_symbol_elements
,
6263 Fcons (unmodified
, lispy_modifier_list (modifiers
)));
6265 /* Since we know that SYMBOL is modifiers applied to unmodified,
6266 it would be nice to put that in unmodified's cache.
6267 But we can't, since we're not sure that parse_modifiers is
6274 DEFUN ("internal-event-symbol-parse-modifiers", Fevent_symbol_parse_modifiers
,
6275 Sevent_symbol_parse_modifiers
, 1, 1, 0,
6276 doc
: /* Parse the event symbol. For internal use. */)
6277 (Lisp_Object symbol
)
6279 /* Fill the cache if needed. */
6280 parse_modifiers (symbol
);
6281 /* Ignore the result (which is stored on Qevent_symbol_element_mask)
6282 and use the Lispier representation stored on Qevent_symbol_elements
6284 return Fget (symbol
, Qevent_symbol_elements
);
6287 /* Apply the modifiers MODIFIERS to the symbol BASE.
6288 BASE must be unmodified.
6290 This is like apply_modifiers_uncached, but uses BASE's
6291 Qmodifier_cache property, if present.
6293 apply_modifiers copies the value of BASE's Qevent_kind property to
6294 the modified symbol. */
6296 apply_modifiers (int modifiers
, Lisp_Object base
)
6298 Lisp_Object cache
, idx
, entry
, new_symbol
;
6300 /* Mask out upper bits. We don't know where this value's been. */
6301 modifiers
&= INTMASK
;
6303 if (INTEGERP (base
))
6304 return make_number (XINT (base
) | modifiers
);
6306 /* The click modifier never figures into cache indices. */
6307 cache
= Fget (base
, Qmodifier_cache
);
6308 XSETFASTINT (idx
, (modifiers
& ~click_modifier
));
6309 entry
= assq_no_quit (idx
, cache
);
6312 new_symbol
= XCDR (entry
);
6315 /* We have to create the symbol ourselves. */
6316 new_symbol
= apply_modifiers_uncached (modifiers
,
6317 SSDATA (SYMBOL_NAME (base
)),
6318 SCHARS (SYMBOL_NAME (base
)),
6319 SBYTES (SYMBOL_NAME (base
)));
6321 /* Add the new symbol to the base's cache. */
6322 entry
= Fcons (idx
, new_symbol
);
6323 Fput (base
, Qmodifier_cache
, Fcons (entry
, cache
));
6325 /* We have the parsing info now for free, so we could add it to
6327 XSETFASTINT (idx, modifiers);
6328 Fput (new_symbol, Qevent_symbol_element_mask,
6330 Fput (new_symbol, Qevent_symbol_elements,
6331 Fcons (base, lispy_modifier_list (modifiers)));
6332 Sadly, this is only correct if `base' is indeed a base event,
6333 which is not necessarily the case. -stef */
6336 /* Make sure this symbol is of the same kind as BASE.
6338 You'd think we could just set this once and for all when we
6339 intern the symbol above, but reorder_modifiers may call us when
6340 BASE's property isn't set right; we can't assume that just
6341 because it has a Qmodifier_cache property it must have its
6342 Qevent_kind set right as well. */
6343 if (NILP (Fget (new_symbol
, Qevent_kind
)))
6347 kind
= Fget (base
, Qevent_kind
);
6349 Fput (new_symbol
, Qevent_kind
, kind
);
6356 /* Given a symbol whose name begins with modifiers ("C-", "M-", etc),
6357 return a symbol with the modifiers placed in the canonical order.
6358 Canonical order is alphabetical, except for down and drag, which
6359 always come last. The 'click' modifier is never written out.
6361 Fdefine_key calls this to make sure that (for example) C-M-foo
6362 and M-C-foo end up being equivalent in the keymap. */
6365 reorder_modifiers (Lisp_Object symbol
)
6367 /* It's hopefully okay to write the code this way, since everything
6368 will soon be in caches, and no consing will be done at all. */
6371 parsed
= parse_modifiers (symbol
);
6372 return apply_modifiers (XFASTINT (XCAR (XCDR (parsed
))),
6377 /* For handling events, we often want to produce a symbol whose name
6378 is a series of modifier key prefixes ("M-", "C-", etcetera) attached
6379 to some base, like the name of a function key or mouse button.
6380 modify_event_symbol produces symbols of this sort.
6382 NAME_TABLE should point to an array of strings, such that NAME_TABLE[i]
6383 is the name of the i'th symbol. TABLE_SIZE is the number of elements
6386 Alternatively, NAME_ALIST_OR_STEM is either an alist mapping codes
6387 into symbol names, or a string specifying a name stem used to
6388 construct a symbol name or the form `STEM-N', where N is the decimal
6389 representation of SYMBOL_NUM. NAME_ALIST_OR_STEM is used if it is
6390 non-nil; otherwise NAME_TABLE is used.
6392 SYMBOL_TABLE should be a pointer to a Lisp_Object whose value will
6393 persist between calls to modify_event_symbol that it can use to
6394 store a cache of the symbols it's generated for this NAME_TABLE
6395 before. The object stored there may be a vector or an alist.
6397 SYMBOL_NUM is the number of the base name we want from NAME_TABLE.
6399 MODIFIERS is a set of modifier bits (as given in struct input_events)
6400 whose prefixes should be applied to the symbol name.
6402 SYMBOL_KIND is the value to be placed in the event_kind property of
6403 the returned symbol.
6405 The symbols we create are supposed to have an
6406 `event-symbol-elements' property, which lists the modifiers present
6407 in the symbol's name. */
6410 modify_event_symbol (ptrdiff_t symbol_num
, int modifiers
, Lisp_Object symbol_kind
,
6411 Lisp_Object name_alist_or_stem
, const char *const *name_table
,
6412 Lisp_Object
*symbol_table
, ptrdiff_t table_size
)
6415 Lisp_Object symbol_int
;
6417 /* Get rid of the "vendor-specific" bit here. */
6418 XSETINT (symbol_int
, symbol_num
& 0xffffff);
6420 /* Is this a request for a valid symbol? */
6421 if (symbol_num
< 0 || symbol_num
>= table_size
)
6424 if (CONSP (*symbol_table
))
6425 value
= Fcdr (assq_no_quit (symbol_int
, *symbol_table
));
6427 /* If *symbol_table doesn't seem to be initialized properly, fix that.
6428 *symbol_table should be a lisp vector TABLE_SIZE elements long,
6429 where the Nth element is the symbol for NAME_TABLE[N], or nil if
6430 we've never used that symbol before. */
6433 if (! VECTORP (*symbol_table
)
6434 || ASIZE (*symbol_table
) != table_size
)
6438 XSETFASTINT (size
, table_size
);
6439 *symbol_table
= Fmake_vector (size
, Qnil
);
6442 value
= AREF (*symbol_table
, symbol_num
);
6445 /* Have we already used this symbol before? */
6448 /* No; let's create it. */
6449 if (CONSP (name_alist_or_stem
))
6450 value
= Fcdr_safe (Fassq (symbol_int
, name_alist_or_stem
));
6451 else if (STRINGP (name_alist_or_stem
))
6454 ptrdiff_t len
= (SBYTES (name_alist_or_stem
)
6455 + sizeof "-" + INT_STRLEN_BOUND (EMACS_INT
));
6457 buf
= SAFE_ALLOCA (len
);
6458 esprintf (buf
, "%s-%"pI
"d", SDATA (name_alist_or_stem
),
6459 XINT (symbol_int
) + 1);
6460 value
= intern (buf
);
6463 else if (name_table
!= 0 && name_table
[symbol_num
])
6464 value
= intern (name_table
[symbol_num
]);
6466 #ifdef HAVE_WINDOW_SYSTEM
6469 char *name
= x_get_keysym_name (symbol_num
);
6471 value
= intern (name
);
6477 char buf
[sizeof "key-" + INT_STRLEN_BOUND (EMACS_INT
)];
6478 sprintf (buf
, "key-%"pD
"d", symbol_num
);
6479 value
= intern (buf
);
6482 if (CONSP (*symbol_table
))
6483 *symbol_table
= Fcons (Fcons (symbol_int
, value
), *symbol_table
);
6485 ASET (*symbol_table
, symbol_num
, value
);
6487 /* Fill in the cache entries for this symbol; this also
6488 builds the Qevent_symbol_elements property, which the user
6490 apply_modifiers (modifiers
& click_modifier
, value
);
6491 Fput (value
, Qevent_kind
, symbol_kind
);
6494 /* Apply modifiers to that symbol. */
6495 return apply_modifiers (modifiers
, value
);
6498 /* Convert a list that represents an event type,
6499 such as (ctrl meta backspace), into the usual representation of that
6500 event type as a number or a symbol. */
6502 DEFUN ("event-convert-list", Fevent_convert_list
, Sevent_convert_list
, 1, 1, 0,
6503 doc
: /* Convert the event description list EVENT-DESC to an event type.
6504 EVENT-DESC should contain one base event type (a character or symbol)
6505 and zero or more modifier names (control, meta, hyper, super, shift, alt,
6506 drag, down, double or triple). The base must be last.
6507 The return value is an event type (a character or symbol) which
6508 has the same base event type and all the specified modifiers. */)
6509 (Lisp_Object event_desc
)
6517 while (CONSP (rest
))
6525 /* Given a symbol, see if it is a modifier name. */
6526 if (SYMBOLP (elt
) && CONSP (rest
))
6527 this = parse_solitary_modifier (elt
);
6531 else if (!NILP (base
))
6532 error ("Two bases given in one event");
6538 /* Let the symbol A refer to the character A. */
6539 if (SYMBOLP (base
) && SCHARS (SYMBOL_NAME (base
)) == 1)
6540 XSETINT (base
, SREF (SYMBOL_NAME (base
), 0));
6542 if (INTEGERP (base
))
6544 /* Turn (shift a) into A. */
6545 if ((modifiers
& shift_modifier
) != 0
6546 && (XINT (base
) >= 'a' && XINT (base
) <= 'z'))
6548 XSETINT (base
, XINT (base
) - ('a' - 'A'));
6549 modifiers
&= ~shift_modifier
;
6552 /* Turn (control a) into C-a. */
6553 if (modifiers
& ctrl_modifier
)
6554 return make_number ((modifiers
& ~ctrl_modifier
)
6555 | make_ctrl_char (XINT (base
)));
6557 return make_number (modifiers
| XINT (base
));
6559 else if (SYMBOLP (base
))
6560 return apply_modifiers (modifiers
, base
);
6562 error ("Invalid base event");
6565 /* Try to recognize SYMBOL as a modifier name.
6566 Return the modifier flag bit, or 0 if not recognized. */
6569 parse_solitary_modifier (Lisp_Object symbol
)
6571 Lisp_Object name
= SYMBOL_NAME (symbol
);
6573 switch (SREF (name
, 0))
6575 #define SINGLE_LETTER_MOD(BIT) \
6576 if (SBYTES (name) == 1) \
6579 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6580 if (LEN == SBYTES (name) \
6581 && ! memcmp (SDATA (name), NAME, LEN)) \
6585 SINGLE_LETTER_MOD (alt_modifier
);
6589 MULTI_LETTER_MOD (alt_modifier
, "alt", 3);
6593 SINGLE_LETTER_MOD (ctrl_modifier
);
6597 MULTI_LETTER_MOD (ctrl_modifier
, "ctrl", 4);
6598 MULTI_LETTER_MOD (ctrl_modifier
, "control", 7);
6602 SINGLE_LETTER_MOD (hyper_modifier
);
6606 MULTI_LETTER_MOD (hyper_modifier
, "hyper", 5);
6610 SINGLE_LETTER_MOD (meta_modifier
);
6614 MULTI_LETTER_MOD (meta_modifier
, "meta", 4);
6618 SINGLE_LETTER_MOD (shift_modifier
);
6622 MULTI_LETTER_MOD (shift_modifier
, "shift", 5);
6623 MULTI_LETTER_MOD (super_modifier
, "super", 5);
6624 SINGLE_LETTER_MOD (super_modifier
);
6628 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
6629 MULTI_LETTER_MOD (down_modifier
, "down", 4);
6630 MULTI_LETTER_MOD (double_modifier
, "double", 6);
6634 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
6638 MULTI_LETTER_MOD (up_modifier
, "up", 2);
6641 #undef SINGLE_LETTER_MOD
6642 #undef MULTI_LETTER_MOD
6648 /* Return true if EVENT is a list whose elements are all integers or symbols.
6649 Such a list is not valid as an event,
6650 but it can be a Lucid-style event type list. */
6653 lucid_event_type_list_p (Lisp_Object object
)
6657 if (! CONSP (object
))
6660 if (EQ (XCAR (object
), Qhelp_echo
)
6661 || EQ (XCAR (object
), Qvertical_line
)
6662 || EQ (XCAR (object
), Qmode_line
)
6663 || EQ (XCAR (object
), Qheader_line
))
6666 for (tail
= object
; CONSP (tail
); tail
= XCDR (tail
))
6670 if (! (INTEGERP (elt
) || SYMBOLP (elt
)))
6677 /* Return true if terminal input chars are available.
6678 Also, store the return value into INPUT_PENDING.
6680 Serves the purpose of ioctl (0, FIONREAD, ...)
6681 but works even if FIONREAD does not exist.
6682 (In fact, this may actually read some input.)
6684 If READABLE_EVENTS_DO_TIMERS_NOW is set in FLAGS, actually run
6685 timer events that are ripe.
6686 If READABLE_EVENTS_FILTER_EVENTS is set in FLAGS, ignore internal
6687 events (FOCUS_IN_EVENT).
6688 If READABLE_EVENTS_IGNORE_SQUEEZABLES is set in FLAGS, ignore mouse
6689 movements and toolkit scroll bar thumb drags. */
6692 get_input_pending (int flags
)
6694 /* First of all, have we already counted some input? */
6695 input_pending
= (!NILP (Vquit_flag
) || readable_events (flags
));
6697 /* If input is being read as it arrives, and we have none, there is none. */
6698 if (!input_pending
&& (!interrupt_input
|| interrupts_deferred
))
6700 /* Try to read some input and see how much we get. */
6702 input_pending
= (!NILP (Vquit_flag
) || readable_events (flags
));
6705 return input_pending
;
6708 /* Put a BUFFER_SWITCH_EVENT in the buffer
6709 so that read_key_sequence will notice the new current buffer. */
6712 record_asynch_buffer_change (void)
6714 /* We don't need a buffer-switch event unless Emacs is waiting for input.
6715 The purpose of the event is to make read_key_sequence look up the
6716 keymaps again. If we aren't in read_key_sequence, we don't need one,
6717 and the event could cause trouble by messing up (input-pending-p).
6718 Note: Fwaiting_for_user_input_p always returns nil when async
6719 subprocesses aren't supported. */
6720 if (!NILP (Fwaiting_for_user_input_p ()))
6722 struct input_event event
;
6725 event
.kind
= BUFFER_SWITCH_EVENT
;
6726 event
.frame_or_window
= Qnil
;
6729 /* Make sure no interrupt happens while storing the event. */
6731 if (interrupt_input
)
6732 kbd_buffer_store_event (&event
);
6737 kbd_buffer_store_event (&event
);
6743 /* Read any terminal input already buffered up by the system
6744 into the kbd_buffer, but do not wait.
6746 Return the number of keyboard chars read, or -1 meaning
6747 this is a bad time to try to read input. */
6756 /* Store pending user signal events, if any. */
6757 store_user_signal_events ();
6759 /* Loop through the available terminals, and call their input hooks. */
6763 struct terminal
*next
= t
->next_terminal
;
6765 if (t
->read_socket_hook
)
6768 struct input_event hold_quit
;
6770 if (input_blocked_p ())
6772 pending_signals
= true;
6776 EVENT_INIT (hold_quit
);
6777 hold_quit
.kind
= NO_EVENT
;
6779 /* No need for FIONREAD or fcntl; just say don't wait. */
6780 while ((nr
= (*t
->read_socket_hook
) (t
, &hold_quit
)) > 0)
6783 if (nr
== -1) /* Not OK to read input now. */
6787 else if (nr
== -2) /* Non-transient error. */
6789 /* The terminal device terminated; it should be closed. */
6791 /* Kill Emacs if this was our last terminal. */
6792 if (!terminal_list
->next_terminal
)
6793 /* Formerly simply reported no input, but that
6794 sometimes led to a failure of Emacs to terminate.
6795 SIGHUP seems appropriate if we can't reach the
6797 /* ??? Is it really right to send the signal just to
6798 this process rather than to the whole process
6799 group? Perhaps on systems with FIONREAD Emacs is
6800 alone in its group. */
6801 terminate_due_to_signal (SIGHUP
, 10);
6803 /* XXX Is calling delete_terminal safe here? It calls delete_frame. */
6806 XSETTERMINAL (tmp
, t
);
6807 Fdelete_terminal (tmp
, Qnoelisp
);
6811 /* If there was no error, make sure the pointer
6812 is visible for all frames on this terminal. */
6815 Lisp_Object tail
, frame
;
6817 FOR_EACH_FRAME (tail
, frame
)
6819 struct frame
*f
= XFRAME (frame
);
6820 if (FRAME_TERMINAL (f
) == t
)
6821 frame_make_pointer_visible (f
);
6825 if (hold_quit
.kind
!= NO_EVENT
)
6826 kbd_buffer_store_event (&hold_quit
);
6838 /* This is the tty way of reading available input.
6840 Note that each terminal device has its own `struct terminal' object,
6841 and so this function is called once for each individual termcap
6842 terminal. The first parameter indicates which terminal to read from. */
6845 tty_read_avail_input (struct terminal
*terminal
,
6846 struct input_event
*hold_quit
)
6848 /* Using KBD_BUFFER_SIZE - 1 here avoids reading more than
6849 the kbd_buffer can really hold. That may prevent loss
6850 of characters on some systems when input is stuffed at us. */
6851 unsigned char cbuf
[KBD_BUFFER_SIZE
- 1];
6853 struct tty_display_info
*tty
= terminal
->display_info
.tty
;
6856 int buffer_free
= KBD_BUFFER_SIZE
- kbd_buffer_nr_stored () - 1;
6858 if (kbd_on_hold_p () || buffer_free
<= 0)
6860 #endif /* subprocesses */
6862 if (!terminal
->name
) /* Don't read from a dead terminal. */
6865 if (terminal
->type
!= output_termcap
6866 && terminal
->type
!= output_msdos_raw
)
6869 /* XXX I think the following code should be moved to separate hook
6870 functions in system-dependent files. */
6872 /* FIXME: AFAIK, tty_read_avail_input is not used under w32 since the non-GUI
6873 code sets read_socket_hook to w32_console_read_socket instead! */
6875 #else /* not WINDOWSNT */
6876 if (! tty
->term_initted
) /* In case we get called during bootstrap. */
6880 return 0; /* The terminal is suspended. */
6883 n_to_read
= dos_keysns ();
6887 cbuf
[0] = dos_keyread ();
6890 #else /* not MSDOS */
6895 struct input_event gpm_hold_quit
;
6896 int gpm
, fd
= gpm_fd
;
6898 EVENT_INIT (gpm_hold_quit
);
6899 gpm_hold_quit
.kind
= NO_EVENT
;
6901 /* gpm==1 if event received.
6902 gpm==0 if the GPM daemon has closed the connection, in which case
6903 Gpm_GetEvent closes gpm_fd and clears it to -1, which is why
6904 we save it in `fd' so close_gpm can remove it from the
6906 gpm==-1 if a protocol error or EWOULDBLOCK; the latter is normal. */
6907 while (gpm
= Gpm_GetEvent (&event
), gpm
== 1) {
6908 nread
+= handle_one_term_event (tty
, &event
, &gpm_hold_quit
);
6911 /* Presumably the GPM daemon has closed the connection. */
6913 if (gpm_hold_quit
.kind
!= NO_EVENT
)
6914 kbd_buffer_store_event (&gpm_hold_quit
);
6918 #endif /* HAVE_GPM */
6920 /* Determine how many characters we should *try* to read. */
6921 #ifdef USABLE_FIONREAD
6922 /* Find out how much input is available. */
6923 if (ioctl (fileno (tty
->input
), FIONREAD
, &n_to_read
) < 0)
6925 if (! noninteractive
)
6926 return -2; /* Close this terminal. */
6932 if (n_to_read
> sizeof cbuf
)
6933 n_to_read
= sizeof cbuf
;
6934 #elif defined USG || defined CYGWIN
6935 /* Read some input if available, but don't wait. */
6936 n_to_read
= sizeof cbuf
;
6937 fcntl (fileno (tty
->input
), F_SETFL
, O_NONBLOCK
);
6939 # error "Cannot read without possibly delaying"
6943 /* Don't read more than we can store. */
6944 if (n_to_read
> buffer_free
)
6945 n_to_read
= buffer_free
;
6946 #endif /* subprocesses */
6948 /* Now read; for one reason or another, this will not block.
6949 NREAD is set to the number of chars read. */
6952 nread
= emacs_read (fileno (tty
->input
), (char *) cbuf
, n_to_read
);
6953 /* POSIX infers that processes which are not in the session leader's
6954 process group won't get SIGHUPs at logout time. BSDI adheres to
6955 this part standard and returns -1 from read (0) with errno==EIO
6956 when the control tty is taken away.
6957 Jeffrey Honig <jch@bsdi.com> says this is generally safe. */
6958 if (nread
== -1 && errno
== EIO
)
6959 return -2; /* Close this terminal. */
6960 #if defined (AIX) && defined (_BSD)
6961 /* The kernel sometimes fails to deliver SIGHUP for ptys.
6962 This looks incorrect, but it isn't, because _BSD causes
6963 O_NDELAY to be defined in fcntl.h as O_NONBLOCK,
6964 and that causes a value other than 0 when there is no input. */
6966 return -2; /* Close this terminal. */
6970 /* We used to retry the read if it was interrupted.
6971 But this does the wrong thing when O_NONBLOCK causes
6972 an EAGAIN error. Does anybody know of a situation
6973 where a retry is actually needed? */
6975 nread
< 0 && (errno
== EAGAIN
|| errno
== EFAULT
6985 #ifndef USABLE_FIONREAD
6986 #if defined (USG) || defined (CYGWIN)
6987 fcntl (fileno (tty
->input
), F_SETFL
, 0);
6988 #endif /* USG or CYGWIN */
6989 #endif /* no FIONREAD */
6994 #endif /* not MSDOS */
6995 #endif /* not WINDOWSNT */
6997 for (i
= 0; i
< nread
; i
++)
6999 struct input_event buf
;
7001 buf
.kind
= ASCII_KEYSTROKE_EVENT
;
7003 if (tty
->meta_key
== 1 && (cbuf
[i
] & 0x80))
7004 buf
.modifiers
= meta_modifier
;
7005 if (tty
->meta_key
!= 2)
7009 /* Set the frame corresponding to the active tty. Note that the
7010 value of selected_frame is not reliable here, redisplay tends
7011 to temporarily change it. */
7012 buf
.frame_or_window
= tty
->top_frame
;
7015 kbd_buffer_store_event (&buf
);
7016 /* Don't look at input that follows a C-g too closely.
7017 This reduces lossage due to autorepeat on C-g. */
7018 if (buf
.kind
== ASCII_KEYSTROKE_EVENT
7019 && buf
.code
== quit_char
)
7027 handle_async_input (void)
7032 int nread
= gobble_input ();
7033 /* -1 means it's not ok to read the input now.
7034 UNBLOCK_INPUT will read it later; now, avoid infinite loop.
7035 0 means there was no keyboard input available. */
7043 process_pending_signals (void)
7045 pending_signals
= false;
7046 handle_async_input ();
7047 do_pending_atimers ();
7050 /* Undo any number of BLOCK_INPUT calls down to level LEVEL,
7051 and reinvoke any pending signal if the level is now 0 and
7052 a fatal error is not already in progress. */
7055 unblock_input_to (int level
)
7057 interrupt_input_blocked
= level
;
7060 if (pending_signals
&& !fatal_error_in_progress
)
7061 process_pending_signals ();
7067 /* End critical section.
7069 If doing signal-driven input, and a signal came in when input was
7070 blocked, reinvoke the signal handler now to deal with it.
7072 It will also process queued input, if it was not read before.
7073 When a longer code sequence does not use block/unblock input
7074 at all, the whole input gathered up to the next call to
7075 unblock_input will be processed inside that call. */
7078 unblock_input (void)
7080 unblock_input_to (interrupt_input_blocked
- 1);
7083 /* Undo any number of BLOCK_INPUT calls,
7084 and also reinvoke any pending signal. */
7087 totally_unblock_input (void)
7089 unblock_input_to (0);
7095 handle_input_available_signal (int sig
)
7097 pending_signals
= true;
7099 if (input_available_clear_time
)
7100 *input_available_clear_time
= make_timespec (0, 0);
7104 deliver_input_available_signal (int sig
)
7106 deliver_process_signal (sig
, handle_input_available_signal
);
7108 #endif /* USABLE_SIGIO */
7111 /* User signal events. */
7113 struct user_signal_info
7115 /* Signal number. */
7118 /* Name of the signal. */
7121 /* Number of pending signals. */
7124 struct user_signal_info
*next
;
7127 /* List of user signals. */
7128 static struct user_signal_info
*user_signals
= NULL
;
7131 add_user_signal (int sig
, const char *name
)
7133 struct sigaction action
;
7134 struct user_signal_info
*p
;
7136 for (p
= user_signals
; p
; p
= p
->next
)
7138 /* Already added. */
7141 p
= xmalloc (sizeof *p
);
7143 p
->name
= xstrdup (name
);
7145 p
->next
= user_signals
;
7148 emacs_sigaction_init (&action
, deliver_user_signal
);
7149 sigaction (sig
, &action
, 0);
7153 handle_user_signal (int sig
)
7155 struct user_signal_info
*p
;
7156 const char *special_event_name
= NULL
;
7158 if (SYMBOLP (Vdebug_on_event
))
7159 special_event_name
= SSDATA (SYMBOL_NAME (Vdebug_on_event
));
7161 for (p
= user_signals
; p
; p
= p
->next
)
7164 if (special_event_name
7165 && strcmp (special_event_name
, p
->name
) == 0)
7167 /* Enter the debugger in many ways. */
7168 debug_on_next_call
= true;
7169 debug_on_quit
= true;
7171 Vinhibit_quit
= Qnil
;
7173 /* Eat the event. */
7179 if (interrupt_input
)
7180 handle_input_available_signal (sig
);
7184 /* Tell wait_reading_process_output that it needs to wake
7185 up and look around. */
7186 if (input_available_clear_time
)
7187 *input_available_clear_time
= make_timespec (0, 0);
7194 deliver_user_signal (int sig
)
7196 deliver_process_signal (sig
, handle_user_signal
);
7200 find_user_signal_name (int sig
)
7202 struct user_signal_info
*p
;
7204 for (p
= user_signals
; p
; p
= p
->next
)
7212 store_user_signal_events (void)
7214 struct user_signal_info
*p
;
7215 struct input_event buf
;
7216 bool buf_initialized
= false;
7218 for (p
= user_signals
; p
; p
= p
->next
)
7219 if (p
->npending
> 0)
7221 if (! buf_initialized
)
7223 memset (&buf
, 0, sizeof buf
);
7224 buf
.kind
= USER_SIGNAL_EVENT
;
7225 buf
.frame_or_window
= selected_frame
;
7226 buf_initialized
= true;
7232 kbd_buffer_store_event (&buf
);
7235 while (p
->npending
> 0);
7240 static void menu_bar_item (Lisp_Object
, Lisp_Object
, Lisp_Object
, void *);
7241 static Lisp_Object menu_bar_one_keymap_changed_items
;
7243 /* These variables hold the vector under construction within
7244 menu_bar_items and its subroutines, and the current index
7245 for storing into that vector. */
7246 static Lisp_Object menu_bar_items_vector
;
7247 static int menu_bar_items_index
;
7250 static const char *separator_names
[] = {
7255 "single-dashed-line",
7256 "double-dashed-line",
7258 "shadow-etched-out",
7259 "shadow-etched-in-dash",
7260 "shadow-etched-out-dash",
7261 "shadow-double-etched-in",
7262 "shadow-double-etched-out",
7263 "shadow-double-etched-in-dash",
7264 "shadow-double-etched-out-dash",
7268 /* Return true if LABEL specifies a separator. */
7271 menu_separator_name_p (const char *label
)
7275 else if (strlen (label
) > 3
7276 && memcmp (label
, "--", 2) == 0
7281 for (i
= 0; separator_names
[i
]; ++i
)
7282 if (strcmp (label
, separator_names
[i
]) == 0)
7287 /* It's a separator if it contains only dashes. */
7288 while (*label
== '-')
7290 return (*label
== 0);
7297 /* Return a vector of menu items for a menu bar, appropriate
7298 to the current buffer. Each item has three elements in the vector:
7301 OLD is an old vector we can optionally reuse, or nil. */
7304 menu_bar_items (Lisp_Object old
)
7306 /* The number of keymaps we're scanning right now, and the number of
7307 keymaps we have allocated space for. */
7310 /* maps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
7311 in the current keymaps, or nil where it is not a prefix. */
7314 Lisp_Object mapsbuf
[3];
7315 Lisp_Object def
, tail
;
7322 /* In order to build the menus, we need to call the keymap
7323 accessors. They all call QUIT. But this function is called
7324 during redisplay, during which a quit is fatal. So inhibit
7325 quitting while building the menus.
7326 We do this instead of specbind because (1) errors will clear it anyway
7327 and (2) this avoids risk of specpdl overflow. */
7328 oquit
= Vinhibit_quit
;
7332 menu_bar_items_vector
= old
;
7334 menu_bar_items_vector
= Fmake_vector (make_number (24), Qnil
);
7335 menu_bar_items_index
= 0;
7337 /* Build our list of keymaps.
7338 If we recognize a function key and replace its escape sequence in
7339 keybuf with its symbol, or if the sequence starts with a mouse
7340 click and we need to switch buffers, we jump back here to rebuild
7341 the initial keymaps from the current buffer. */
7345 /* Should overriding-terminal-local-map and overriding-local-map apply? */
7346 if (!NILP (Voverriding_local_map_menu_flag
)
7347 && !NILP (Voverriding_local_map
))
7349 /* Yes, use them (if non-nil) as well as the global map. */
7352 if (!NILP (KVAR (current_kboard
, Voverriding_terminal_local_map
)))
7353 maps
[nmaps
++] = KVAR (current_kboard
, Voverriding_terminal_local_map
);
7354 if (!NILP (Voverriding_local_map
))
7355 maps
[nmaps
++] = Voverriding_local_map
;
7359 /* No, so use major and minor mode keymaps and keymap property.
7360 Note that menu-bar bindings in the local-map and keymap
7361 properties may not work reliable, as they are only
7362 recognized when the menu-bar (or mode-line) is updated,
7363 which does not normally happen after every command. */
7364 ptrdiff_t nminor
= current_minor_maps (NULL
, &tmaps
);
7365 SAFE_NALLOCA (maps
, 1, nminor
+ 4);
7367 Lisp_Object tem
= KVAR (current_kboard
, Voverriding_terminal_local_map
);
7368 if (!NILP (tem
) && !NILP (Voverriding_local_map_menu_flag
))
7369 maps
[nmaps
++] = tem
;
7370 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
7371 maps
[nmaps
++] = tem
;
7374 memcpy (maps
+ nmaps
, tmaps
, nminor
* sizeof (maps
[0]));
7377 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
7379 maps
[nmaps
++] = current_global_map
;
7382 /* Look up in each map the dummy prefix key `menu-bar'. */
7384 for (mapno
= nmaps
- 1; mapno
>= 0; mapno
--)
7385 if (!NILP (maps
[mapno
]))
7387 def
= get_keymap (access_keymap (maps
[mapno
], Qmenu_bar
, 1, 0, 1),
7391 menu_bar_one_keymap_changed_items
= Qnil
;
7392 map_keymap_canonical (def
, menu_bar_item
, Qnil
, NULL
);
7396 /* Move to the end those items that should be at the end. */
7398 for (tail
= Vmenu_bar_final_items
; CONSP (tail
); tail
= XCDR (tail
))
7401 int end
= menu_bar_items_index
;
7403 for (i
= 0; i
< end
; i
+= 4)
7404 if (EQ (XCAR (tail
), AREF (menu_bar_items_vector
, i
)))
7406 Lisp_Object tem0
, tem1
, tem2
, tem3
;
7407 /* Move the item at index I to the end,
7408 shifting all the others forward. */
7409 tem0
= AREF (menu_bar_items_vector
, i
+ 0);
7410 tem1
= AREF (menu_bar_items_vector
, i
+ 1);
7411 tem2
= AREF (menu_bar_items_vector
, i
+ 2);
7412 tem3
= AREF (menu_bar_items_vector
, i
+ 3);
7414 memmove (aref_addr (menu_bar_items_vector
, i
),
7415 aref_addr (menu_bar_items_vector
, i
+ 4),
7416 (end
- i
- 4) * word_size
);
7417 ASET (menu_bar_items_vector
, end
- 4, tem0
);
7418 ASET (menu_bar_items_vector
, end
- 3, tem1
);
7419 ASET (menu_bar_items_vector
, end
- 2, tem2
);
7420 ASET (menu_bar_items_vector
, end
- 1, tem3
);
7425 /* Add nil, nil, nil, nil at the end. */
7427 int i
= menu_bar_items_index
;
7428 if (i
+ 4 > ASIZE (menu_bar_items_vector
))
7429 menu_bar_items_vector
7430 = larger_vector (menu_bar_items_vector
, 4, -1);
7431 /* Add this item. */
7432 ASET (menu_bar_items_vector
, i
, Qnil
); i
++;
7433 ASET (menu_bar_items_vector
, i
, Qnil
); i
++;
7434 ASET (menu_bar_items_vector
, i
, Qnil
); i
++;
7435 ASET (menu_bar_items_vector
, i
, Qnil
); i
++;
7436 menu_bar_items_index
= i
;
7439 Vinhibit_quit
= oquit
;
7441 return menu_bar_items_vector
;
7444 /* Add one item to menu_bar_items_vector, for KEY, ITEM_STRING and DEF.
7445 If there's already an item for KEY, add this DEF to it. */
7447 Lisp_Object item_properties
;
7450 menu_bar_item (Lisp_Object key
, Lisp_Object item
, Lisp_Object dummy1
, void *dummy2
)
7456 if (EQ (item
, Qundefined
))
7458 /* If a map has an explicit `undefined' as definition,
7459 discard any previously made menu bar item. */
7461 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7462 if (EQ (key
, AREF (menu_bar_items_vector
, i
)))
7464 if (menu_bar_items_index
> i
+ 4)
7465 memmove (aref_addr (menu_bar_items_vector
, i
),
7466 aref_addr (menu_bar_items_vector
, i
+ 4),
7467 (menu_bar_items_index
- i
- 4) * word_size
);
7468 menu_bar_items_index
-= 4;
7472 /* If this keymap has already contributed to this KEY,
7473 don't contribute to it a second time. */
7474 tem
= Fmemq (key
, menu_bar_one_keymap_changed_items
);
7475 if (!NILP (tem
) || NILP (item
))
7478 menu_bar_one_keymap_changed_items
7479 = Fcons (key
, menu_bar_one_keymap_changed_items
);
7481 /* We add to menu_bar_one_keymap_changed_items before doing the
7482 parse_menu_item, so that if it turns out it wasn't a menu item,
7483 it still correctly hides any further menu item. */
7484 parsed
= parse_menu_item (item
, 1);
7488 item
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7490 /* Find any existing item for this KEY. */
7491 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7492 if (EQ (key
, AREF (menu_bar_items_vector
, i
)))
7495 /* If we did not find this KEY, add it at the end. */
7496 if (i
== menu_bar_items_index
)
7498 /* If vector is too small, get a bigger one. */
7499 if (i
+ 4 > ASIZE (menu_bar_items_vector
))
7500 menu_bar_items_vector
= larger_vector (menu_bar_items_vector
, 4, -1);
7501 /* Add this item. */
7502 ASET (menu_bar_items_vector
, i
, key
); i
++;
7503 ASET (menu_bar_items_vector
, i
,
7504 AREF (item_properties
, ITEM_PROPERTY_NAME
)); i
++;
7505 ASET (menu_bar_items_vector
, i
, list1 (item
)); i
++;
7506 ASET (menu_bar_items_vector
, i
, make_number (0)); i
++;
7507 menu_bar_items_index
= i
;
7509 /* We did find an item for this KEY. Add ITEM to its list of maps. */
7513 old
= AREF (menu_bar_items_vector
, i
+ 2);
7514 /* If the new and the old items are not both keymaps,
7515 the lookup will only find `item'. */
7516 item
= Fcons (item
, KEYMAPP (item
) && KEYMAPP (XCAR (old
)) ? old
: Qnil
);
7517 ASET (menu_bar_items_vector
, i
+ 2, item
);
7521 /* This is used as the handler when calling menu_item_eval_property. */
7523 menu_item_eval_property_1 (Lisp_Object arg
)
7525 /* If we got a quit from within the menu computation,
7526 quit all the way out of it. This takes care of C-] in the debugger. */
7527 if (CONSP (arg
) && EQ (XCAR (arg
), Qquit
))
7528 Fsignal (Qquit
, Qnil
);
7534 eval_dyn (Lisp_Object form
)
7536 return Feval (form
, Qnil
);
7539 /* Evaluate an expression and return the result (or nil if something
7540 went wrong). Used to evaluate dynamic parts of menu items. */
7542 menu_item_eval_property (Lisp_Object sexpr
)
7544 ptrdiff_t count
= SPECPDL_INDEX ();
7546 specbind (Qinhibit_redisplay
, Qt
);
7547 val
= internal_condition_case_1 (eval_dyn
, sexpr
, Qerror
,
7548 menu_item_eval_property_1
);
7549 return unbind_to (count
, val
);
7552 /* This function parses a menu item and leaves the result in the
7553 vector item_properties.
7554 ITEM is a key binding, a possible menu item.
7555 INMENUBAR is > 0 when this is considered for an entry in a menu bar
7557 INMENUBAR is < 0 when this is considered for an entry in a keyboard menu.
7558 parse_menu_item returns true if the item is a menu item and false
7562 parse_menu_item (Lisp_Object item
, int inmenubar
)
7564 Lisp_Object def
, tem
, item_string
, start
;
7566 Lisp_Object keyhint
;
7575 /* Create item_properties vector if necessary. */
7576 if (NILP (item_properties
))
7578 = Fmake_vector (make_number (ITEM_PROPERTY_ENABLE
+ 1), Qnil
);
7580 /* Initialize optional entries. */
7581 for (i
= ITEM_PROPERTY_DEF
; i
< ITEM_PROPERTY_ENABLE
; i
++)
7582 ASET (item_properties
, i
, Qnil
);
7583 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7585 /* Save the item here to protect it from GC. */
7586 ASET (item_properties
, ITEM_PROPERTY_ITEM
, item
);
7588 item_string
= XCAR (item
);
7592 if (STRINGP (item_string
))
7594 /* Old format menu item. */
7595 ASET (item_properties
, ITEM_PROPERTY_NAME
, item_string
);
7597 /* Maybe help string. */
7598 if (CONSP (item
) && STRINGP (XCAR (item
)))
7600 ASET (item_properties
, ITEM_PROPERTY_HELP
,
7601 Fsubstitute_command_keys (XCAR (item
)));
7606 /* Maybe an obsolete key binding cache. */
7607 if (CONSP (item
) && CONSP (XCAR (item
))
7608 && (NILP (XCAR (XCAR (item
)))
7609 || VECTORP (XCAR (XCAR (item
)))))
7612 /* This is the real definition--the function to run. */
7613 ASET (item_properties
, ITEM_PROPERTY_DEF
, item
);
7615 /* Get enable property, if any. */
7618 tem
= Fget (item
, Qmenu_enable
);
7619 if (!NILP (Venable_disabled_menus_and_buttons
))
7620 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7621 else if (!NILP (tem
))
7622 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, tem
);
7625 else if (EQ (item_string
, Qmenu_item
) && CONSP (item
))
7627 /* New format menu item. */
7628 ASET (item_properties
, ITEM_PROPERTY_NAME
, XCAR (item
));
7629 start
= XCDR (item
);
7632 /* We have a real binding. */
7633 ASET (item_properties
, ITEM_PROPERTY_DEF
, XCAR (start
));
7635 item
= XCDR (start
);
7636 /* Is there an obsolete cache list with key equivalences. */
7637 if (CONSP (item
) && CONSP (XCAR (item
)))
7640 /* Parse properties. */
7641 while (CONSP (item
) && CONSP (XCDR (item
)))
7646 if (EQ (tem
, QCenable
))
7648 if (!NILP (Venable_disabled_menus_and_buttons
))
7649 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7651 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, XCAR (item
));
7653 else if (EQ (tem
, QCvisible
))
7655 /* If got a visible property and that evaluates to nil
7656 then ignore this item. */
7657 tem
= menu_item_eval_property (XCAR (item
));
7661 else if (EQ (tem
, QChelp
))
7663 Lisp_Object help
= XCAR (item
);
7665 help
= Fsubstitute_command_keys (help
);
7666 ASET (item_properties
, ITEM_PROPERTY_HELP
, help
);
7668 else if (EQ (tem
, QCfilter
))
7670 else if (EQ (tem
, QCkey_sequence
))
7673 if (SYMBOLP (tem
) || STRINGP (tem
) || VECTORP (tem
))
7674 /* Be GC protected. Set keyhint to item instead of tem. */
7677 else if (EQ (tem
, QCkeys
))
7680 if (CONSP (tem
) || STRINGP (tem
))
7681 ASET (item_properties
, ITEM_PROPERTY_KEYEQ
, tem
);
7683 else if (EQ (tem
, QCbutton
) && CONSP (XCAR (item
)))
7688 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
7690 ASET (item_properties
, ITEM_PROPERTY_SELECTED
,
7692 ASET (item_properties
, ITEM_PROPERTY_TYPE
, type
);
7698 else if (inmenubar
|| !NILP (start
))
7702 return 0; /* not a menu item */
7704 /* If item string is not a string, evaluate it to get string.
7705 If we don't get a string, skip this item. */
7706 item_string
= AREF (item_properties
, ITEM_PROPERTY_NAME
);
7707 if (!(STRINGP (item_string
)))
7709 item_string
= menu_item_eval_property (item_string
);
7710 if (!STRINGP (item_string
))
7712 ASET (item_properties
, ITEM_PROPERTY_NAME
, item_string
);
7715 /* If got a filter apply it on definition. */
7716 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7719 def
= menu_item_eval_property (list2 (XCAR (filter
),
7720 list2 (Qquote
, def
)));
7722 ASET (item_properties
, ITEM_PROPERTY_DEF
, def
);
7725 /* Enable or disable selection of item. */
7726 tem
= AREF (item_properties
, ITEM_PROPERTY_ENABLE
);
7729 tem
= menu_item_eval_property (tem
);
7730 if (inmenubar
&& NILP (tem
))
7731 return 0; /* Ignore disabled items in menu bar. */
7732 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, tem
);
7735 /* If we got no definition, this item is just unselectable text which
7736 is OK in a submenu but not in the menubar. */
7738 return (!inmenubar
);
7740 /* See if this is a separate pane or a submenu. */
7741 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7742 tem
= get_keymap (def
, 0, 1);
7743 /* For a subkeymap, just record its details and exit. */
7746 ASET (item_properties
, ITEM_PROPERTY_MAP
, tem
);
7747 ASET (item_properties
, ITEM_PROPERTY_DEF
, tem
);
7751 /* At the top level in the menu bar, do likewise for commands also.
7752 The menu bar does not display equivalent key bindings anyway.
7753 ITEM_PROPERTY_DEF is already set up properly. */
7757 { /* This is a command. See if there is an equivalent key binding. */
7758 Lisp_Object keyeq
= AREF (item_properties
, ITEM_PROPERTY_KEYEQ
);
7759 AUTO_STRING (space_space
, " ");
7761 /* The previous code preferred :key-sequence to :keys, so we
7762 preserve this behavior. */
7763 if (STRINGP (keyeq
) && !CONSP (keyhint
))
7764 keyeq
= concat2 (space_space
, Fsubstitute_command_keys (keyeq
));
7767 Lisp_Object prefix
= keyeq
;
7768 Lisp_Object keys
= Qnil
;
7772 def
= XCAR (prefix
);
7773 prefix
= XCDR (prefix
);
7776 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7778 if (CONSP (keyhint
) && !NILP (XCAR (keyhint
)))
7780 keys
= XCAR (keyhint
);
7781 tem
= Fkey_binding (keys
, Qnil
, Qnil
, Qnil
);
7783 /* We have a suggested key. Is it bound to the command? */
7786 /* If the command is an alias for another
7787 (such as lmenu.el set it up), check if the
7788 original command matches the cached command. */
7790 && EQ (tem
, XSYMBOL (def
)->function
))))
7795 keys
= Fwhere_is_internal (def
, Qnil
, Qt
, Qnil
, Qnil
);
7799 tem
= Fkey_description (keys
, Qnil
);
7802 if (STRINGP (XCAR (prefix
)))
7803 tem
= concat2 (XCAR (prefix
), tem
);
7804 if (STRINGP (XCDR (prefix
)))
7805 tem
= concat2 (tem
, XCDR (prefix
));
7807 keyeq
= concat2 (space_space
, tem
);
7813 /* If we have an equivalent key binding, use that. */
7814 ASET (item_properties
, ITEM_PROPERTY_KEYEQ
, keyeq
);
7817 /* Include this when menu help is implemented.
7818 tem = XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP];
7819 if (!(NILP (tem) || STRINGP (tem)))
7821 tem = menu_item_eval_property (tem);
7824 XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP] = tem;
7828 /* Handle radio buttons or toggle boxes. */
7829 tem
= AREF (item_properties
, ITEM_PROPERTY_SELECTED
);
7831 ASET (item_properties
, ITEM_PROPERTY_SELECTED
,
7832 menu_item_eval_property (tem
));
7839 /***********************************************************************
7841 ***********************************************************************/
7843 /* A vector holding tool bar items while they are parsed in function
7844 tool_bar_items. Each item occupies TOOL_BAR_ITEM_NSCLOTS elements
7847 static Lisp_Object tool_bar_items_vector
;
7849 /* A vector holding the result of parse_tool_bar_item. Layout is like
7850 the one for a single item in tool_bar_items_vector. */
7852 static Lisp_Object tool_bar_item_properties
;
7854 /* Next free index in tool_bar_items_vector. */
7856 static int ntool_bar_items
;
7858 /* Function prototypes. */
7860 static void init_tool_bar_items (Lisp_Object
);
7861 static void process_tool_bar_item (Lisp_Object
, Lisp_Object
, Lisp_Object
,
7863 static bool parse_tool_bar_item (Lisp_Object
, Lisp_Object
);
7864 static void append_tool_bar_item (void);
7867 /* Return a vector of tool bar items for keymaps currently in effect.
7868 Reuse vector REUSE if non-nil. Return in *NITEMS the number of
7869 tool bar items found. */
7872 tool_bar_items (Lisp_Object reuse
, int *nitems
)
7875 Lisp_Object mapsbuf
[3];
7883 /* In order to build the menus, we need to call the keymap
7884 accessors. They all call QUIT. But this function is called
7885 during redisplay, during which a quit is fatal. So inhibit
7886 quitting while building the menus. We do this instead of
7887 specbind because (1) errors will clear it anyway and (2) this
7888 avoids risk of specpdl overflow. */
7889 oquit
= Vinhibit_quit
;
7892 /* Initialize tool_bar_items_vector and protect it from GC. */
7893 init_tool_bar_items (reuse
);
7895 /* Build list of keymaps in maps. Set nmaps to the number of maps
7898 /* Should overriding-terminal-local-map and overriding-local-map apply? */
7899 if (!NILP (Voverriding_local_map_menu_flag
)
7900 && !NILP (Voverriding_local_map
))
7902 /* Yes, use them (if non-nil) as well as the global map. */
7905 if (!NILP (KVAR (current_kboard
, Voverriding_terminal_local_map
)))
7906 maps
[nmaps
++] = KVAR (current_kboard
, Voverriding_terminal_local_map
);
7907 if (!NILP (Voverriding_local_map
))
7908 maps
[nmaps
++] = Voverriding_local_map
;
7912 /* No, so use major and minor mode keymaps and keymap property.
7913 Note that tool-bar bindings in the local-map and keymap
7914 properties may not work reliable, as they are only
7915 recognized when the tool-bar (or mode-line) is updated,
7916 which does not normally happen after every command. */
7917 ptrdiff_t nminor
= current_minor_maps (NULL
, &tmaps
);
7918 SAFE_NALLOCA (maps
, 1, nminor
+ 4);
7920 Lisp_Object tem
= KVAR (current_kboard
, Voverriding_terminal_local_map
);
7921 if (!NILP (tem
) && !NILP (Voverriding_local_map_menu_flag
))
7922 maps
[nmaps
++] = tem
;
7923 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
7924 maps
[nmaps
++] = tem
;
7927 memcpy (maps
+ nmaps
, tmaps
, nminor
* sizeof (maps
[0]));
7930 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
7933 /* Add global keymap at the end. */
7934 maps
[nmaps
++] = current_global_map
;
7936 /* Process maps in reverse order and look up in each map the prefix
7938 for (i
= nmaps
- 1; i
>= 0; --i
)
7939 if (!NILP (maps
[i
]))
7943 keymap
= get_keymap (access_keymap (maps
[i
], Qtool_bar
, 1, 0, 1), 0, 1);
7945 map_keymap (keymap
, process_tool_bar_item
, Qnil
, NULL
, 1);
7948 Vinhibit_quit
= oquit
;
7949 *nitems
= ntool_bar_items
/ TOOL_BAR_ITEM_NSLOTS
;
7951 return tool_bar_items_vector
;
7955 /* Process the definition of KEY which is DEF. */
7958 process_tool_bar_item (Lisp_Object key
, Lisp_Object def
, Lisp_Object data
, void *args
)
7962 if (EQ (def
, Qundefined
))
7964 /* If a map has an explicit `undefined' as definition,
7965 discard any previously made item. */
7966 for (i
= 0; i
< ntool_bar_items
; i
+= TOOL_BAR_ITEM_NSLOTS
)
7968 Lisp_Object
*v
= XVECTOR (tool_bar_items_vector
)->contents
+ i
;
7970 if (EQ (key
, v
[TOOL_BAR_ITEM_KEY
]))
7972 if (ntool_bar_items
> i
+ TOOL_BAR_ITEM_NSLOTS
)
7973 memmove (v
, v
+ TOOL_BAR_ITEM_NSLOTS
,
7974 ((ntool_bar_items
- i
- TOOL_BAR_ITEM_NSLOTS
)
7976 ntool_bar_items
-= TOOL_BAR_ITEM_NSLOTS
;
7981 else if (parse_tool_bar_item (key
, def
))
7982 /* Append a new tool bar item to tool_bar_items_vector. Accept
7983 more than one definition for the same key. */
7984 append_tool_bar_item ();
7987 /* Access slot with index IDX of vector tool_bar_item_properties. */
7988 #define PROP(IDX) AREF (tool_bar_item_properties, (IDX))
7990 set_prop (ptrdiff_t idx
, Lisp_Object val
)
7992 ASET (tool_bar_item_properties
, idx
, val
);
7996 /* Parse a tool bar item specification ITEM for key KEY and return the
7997 result in tool_bar_item_properties. Value is false if ITEM is
8000 ITEM is a list `(menu-item CAPTION BINDING PROPS...)'.
8002 CAPTION is the caption of the item, If it's not a string, it is
8003 evaluated to get a string.
8005 BINDING is the tool bar item's binding. Tool-bar items with keymaps
8006 as binding are currently ignored.
8008 The following properties are recognized:
8012 FORM is evaluated and specifies whether the tool bar item is
8013 enabled or disabled.
8017 FORM is evaluated and specifies whether the tool bar item is visible.
8019 - `:filter FUNCTION'
8021 FUNCTION is invoked with one parameter `(quote BINDING)'. Its
8022 result is stored as the new binding.
8024 - `:button (TYPE SELECTED)'
8026 TYPE must be one of `:radio' or `:toggle'. SELECTED is evaluated
8027 and specifies whether the button is selected (pressed) or not.
8031 IMAGES is either a single image specification or a vector of four
8032 image specifications. See enum tool_bar_item_images.
8034 - `:help HELP-STRING'.
8036 Gives a help string to display for the tool bar item.
8038 - `:label LABEL-STRING'.
8040 A text label to show with the tool bar button if labels are enabled. */
8043 parse_tool_bar_item (Lisp_Object key
, Lisp_Object item
)
8045 Lisp_Object filter
= Qnil
;
8046 Lisp_Object caption
;
8048 bool have_label
= false;
8050 /* Definition looks like `(menu-item CAPTION BINDING PROPS...)'.
8051 Rule out items that aren't lists, don't start with
8052 `menu-item' or whose rest following `tool-bar-item' is not a
8057 /* As an exception, allow old-style menu separators. */
8058 if (STRINGP (XCAR (item
)))
8059 item
= list1 (XCAR (item
));
8060 else if (!EQ (XCAR (item
), Qmenu_item
)
8061 || (item
= XCDR (item
), !CONSP (item
)))
8064 /* Create tool_bar_item_properties vector if necessary. Reset it to
8066 if (VECTORP (tool_bar_item_properties
))
8068 for (i
= 0; i
< TOOL_BAR_ITEM_NSLOTS
; ++i
)
8072 tool_bar_item_properties
8073 = Fmake_vector (make_number (TOOL_BAR_ITEM_NSLOTS
), Qnil
);
8076 set_prop (TOOL_BAR_ITEM_KEY
, key
);
8077 set_prop (TOOL_BAR_ITEM_ENABLED_P
, Qt
);
8079 /* Get the caption of the item. If the caption is not a string,
8080 evaluate it to get a string. If we don't get a string, skip this
8082 caption
= XCAR (item
);
8083 if (!STRINGP (caption
))
8085 caption
= menu_item_eval_property (caption
);
8086 if (!STRINGP (caption
))
8089 set_prop (TOOL_BAR_ITEM_CAPTION
, caption
);
8091 /* If the rest following the caption is not a list, the menu item is
8092 either a separator, or invalid. */
8096 if (menu_separator_name_p (SSDATA (caption
)))
8098 set_prop (TOOL_BAR_ITEM_TYPE
, Qt
);
8099 #if !defined (USE_GTK) && !defined (HAVE_NS)
8100 /* If we use build_desired_tool_bar_string to render the
8101 tool bar, the separator is rendered as an image. */
8102 set_prop (TOOL_BAR_ITEM_IMAGES
,
8103 (menu_item_eval_property
8104 (Vtool_bar_separator_image_expression
)));
8105 set_prop (TOOL_BAR_ITEM_ENABLED_P
, Qnil
);
8106 set_prop (TOOL_BAR_ITEM_SELECTED_P
, Qnil
);
8107 set_prop (TOOL_BAR_ITEM_CAPTION
, Qnil
);
8114 /* Store the binding. */
8115 set_prop (TOOL_BAR_ITEM_BINDING
, XCAR (item
));
8118 /* Ignore cached key binding, if any. */
8119 if (CONSP (item
) && CONSP (XCAR (item
)))
8122 /* Process the rest of the properties. */
8123 for (; CONSP (item
) && CONSP (XCDR (item
)); item
= XCDR (XCDR (item
)))
8125 Lisp_Object ikey
, value
;
8128 value
= XCAR (XCDR (item
));
8130 if (EQ (ikey
, QCenable
))
8132 /* `:enable FORM'. */
8133 if (!NILP (Venable_disabled_menus_and_buttons
))
8134 set_prop (TOOL_BAR_ITEM_ENABLED_P
, Qt
);
8136 set_prop (TOOL_BAR_ITEM_ENABLED_P
, value
);
8138 else if (EQ (ikey
, QCvisible
))
8140 /* `:visible FORM'. If got a visible property and that
8141 evaluates to nil then ignore this item. */
8142 if (NILP (menu_item_eval_property (value
)))
8145 else if (EQ (ikey
, QChelp
))
8146 /* `:help HELP-STRING'. */
8147 set_prop (TOOL_BAR_ITEM_HELP
, value
);
8148 else if (EQ (ikey
, QCvert_only
))
8149 /* `:vert-only t/nil'. */
8150 set_prop (TOOL_BAR_ITEM_VERT_ONLY
, value
);
8151 else if (EQ (ikey
, QClabel
))
8153 const char *bad_label
= "!!?GARBLED ITEM?!!";
8154 /* `:label LABEL-STRING'. */
8155 set_prop (TOOL_BAR_ITEM_LABEL
,
8156 STRINGP (value
) ? value
: build_string (bad_label
));
8159 else if (EQ (ikey
, QCfilter
))
8160 /* ':filter FORM'. */
8162 else if (EQ (ikey
, QCbutton
) && CONSP (value
))
8164 /* `:button (TYPE . SELECTED)'. */
8165 Lisp_Object type
, selected
;
8167 type
= XCAR (value
);
8168 selected
= XCDR (value
);
8169 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
8171 set_prop (TOOL_BAR_ITEM_SELECTED_P
, selected
);
8172 set_prop (TOOL_BAR_ITEM_TYPE
, type
);
8175 else if (EQ (ikey
, QCimage
)
8177 || (VECTORP (value
) && ASIZE (value
) == 4)))
8178 /* Value is either a single image specification or a vector
8179 of 4 such specifications for the different button states. */
8180 set_prop (TOOL_BAR_ITEM_IMAGES
, value
);
8181 else if (EQ (ikey
, QCrtl
))
8183 set_prop (TOOL_BAR_ITEM_RTL_IMAGE
, value
);
8189 /* Try to make one from caption and key. */
8190 Lisp_Object tkey
= PROP (TOOL_BAR_ITEM_KEY
);
8191 Lisp_Object tcapt
= PROP (TOOL_BAR_ITEM_CAPTION
);
8192 const char *label
= SYMBOLP (tkey
) ? SSDATA (SYMBOL_NAME (tkey
)) : "";
8193 const char *capt
= STRINGP (tcapt
) ? SSDATA (tcapt
) : "";
8195 2 * max (0, min (tool_bar_max_label_size
, STRING_BYTES_BOUND
/ 2));
8196 char *buf
= xmalloc (max_lbl
+ 1);
8197 Lisp_Object new_lbl
;
8198 ptrdiff_t caption_len
= strlen (capt
);
8200 if (caption_len
<= max_lbl
&& capt
[0] != '\0')
8203 while (caption_len
> 0 && buf
[caption_len
- 1] == '.')
8205 buf
[caption_len
] = '\0';
8209 if (strlen (label
) <= max_lbl
&& label
[0] != '\0')
8213 strcpy (buf
, label
);
8215 for (j
= 0; buf
[j
] != '\0'; ++j
)
8223 new_lbl
= Fupcase_initials (build_string (label
));
8224 if (SCHARS (new_lbl
) <= tool_bar_max_label_size
)
8225 set_prop (TOOL_BAR_ITEM_LABEL
, new_lbl
);
8227 set_prop (TOOL_BAR_ITEM_LABEL
, empty_unibyte_string
);
8231 /* If got a filter apply it on binding. */
8233 set_prop (TOOL_BAR_ITEM_BINDING
,
8234 (menu_item_eval_property
8237 PROP (TOOL_BAR_ITEM_BINDING
))))));
8239 /* See if the binding is a keymap. Give up if it is. */
8240 if (CONSP (get_keymap (PROP (TOOL_BAR_ITEM_BINDING
), 0, 1)))
8243 /* Enable or disable selection of item. */
8244 if (!EQ (PROP (TOOL_BAR_ITEM_ENABLED_P
), Qt
))
8245 set_prop (TOOL_BAR_ITEM_ENABLED_P
,
8246 menu_item_eval_property (PROP (TOOL_BAR_ITEM_ENABLED_P
)));
8248 /* Handle radio buttons or toggle boxes. */
8249 if (!NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
)))
8250 set_prop (TOOL_BAR_ITEM_SELECTED_P
,
8251 menu_item_eval_property (PROP (TOOL_BAR_ITEM_SELECTED_P
)));
8259 /* Initialize tool_bar_items_vector. REUSE, if non-nil, is a vector
8260 that can be reused. */
8263 init_tool_bar_items (Lisp_Object reuse
)
8265 if (VECTORP (reuse
))
8266 tool_bar_items_vector
= reuse
;
8268 tool_bar_items_vector
= Fmake_vector (make_number (64), Qnil
);
8269 ntool_bar_items
= 0;
8273 /* Append parsed tool bar item properties from
8274 tool_bar_item_properties */
8277 append_tool_bar_item (void)
8281 - (ASIZE (tool_bar_items_vector
) - TOOL_BAR_ITEM_NSLOTS
));
8283 /* Enlarge tool_bar_items_vector if necessary. */
8285 tool_bar_items_vector
= larger_vector (tool_bar_items_vector
, incr
, -1);
8287 /* Append entries from tool_bar_item_properties to the end of
8288 tool_bar_items_vector. */
8289 vcopy (tool_bar_items_vector
, ntool_bar_items
,
8290 XVECTOR (tool_bar_item_properties
)->contents
, TOOL_BAR_ITEM_NSLOTS
);
8291 ntool_bar_items
+= TOOL_BAR_ITEM_NSLOTS
;
8298 /* Read a character using menus based on the keymap MAP.
8299 Return nil if there are no menus in the maps.
8300 Return t if we displayed a menu but the user rejected it.
8302 PREV_EVENT is the previous input event, or nil if we are reading
8303 the first event of a key sequence.
8305 If USED_MOUSE_MENU is non-null, set *USED_MOUSE_MENU to true
8306 if we used a mouse menu to read the input, or false otherwise. If
8307 USED_MOUSE_MENU is null, don't dereference it.
8309 The prompting is done based on the prompt-string of the map
8310 and the strings associated with various map elements.
8312 This can be done with X menus or with menus put in the minibuf.
8313 These are done in different ways, depending on how the input will be read.
8314 Menus using X are done after auto-saving in read-char, getting the input
8315 event from Fx_popup_menu; menus using the minibuf use read_char recursively
8316 and do auto-saving in the inner call of read_char. */
8319 read_char_x_menu_prompt (Lisp_Object map
,
8320 Lisp_Object prev_event
, bool *used_mouse_menu
)
8322 if (used_mouse_menu
)
8323 *used_mouse_menu
= false;
8325 /* Use local over global Menu maps. */
8327 if (! menu_prompting
)
8330 /* If we got to this point via a mouse click,
8331 use a real menu for mouse selection. */
8332 if (EVENT_HAS_PARAMETERS (prev_event
)
8333 && !EQ (XCAR (prev_event
), Qmenu_bar
)
8334 && !EQ (XCAR (prev_event
), Qtool_bar
))
8336 /* Display the menu and get the selection. */
8339 value
= Fx_popup_menu (prev_event
, get_keymap (map
, 0, 1));
8344 record_menu_key (XCAR (value
));
8346 /* If we got multiple events, unread all but
8348 There is no way to prevent those unread events
8349 from showing up later in last_nonmenu_event.
8350 So turn symbol and integer events into lists,
8351 to indicate that they came from a mouse menu,
8352 so that when present in last_nonmenu_event
8353 they won't confuse things. */
8354 for (tem
= XCDR (value
); CONSP (tem
); tem
= XCDR (tem
))
8356 record_menu_key (XCAR (tem
));
8357 if (SYMBOLP (XCAR (tem
))
8358 || INTEGERP (XCAR (tem
)))
8359 XSETCAR (tem
, Fcons (XCAR (tem
), Qdisabled
));
8362 /* If we got more than one event, put all but the first
8363 onto this list to be read later.
8364 Return just the first event now. */
8365 Vunread_command_events
8366 = nconc2 (XCDR (value
), Vunread_command_events
);
8367 value
= XCAR (value
);
8369 else if (NILP (value
))
8371 if (used_mouse_menu
)
8372 *used_mouse_menu
= true;
8379 read_char_minibuf_menu_prompt (int commandflag
,
8384 /* FIXME: Use the minibuffer's frame width. */
8385 ptrdiff_t width
= FRAME_COLS (SELECTED_FRAME ()) - 4;
8387 bool nobindings
= true;
8388 Lisp_Object rest
, vector
;
8389 Lisp_Object prompt_strings
= Qnil
;
8393 if (! menu_prompting
)
8396 map
= get_keymap (map
, 0, 1);
8397 name
= Fkeymap_prompt (map
);
8399 /* If we don't have any menus, just read a character normally. */
8400 if (!STRINGP (name
))
8403 #define PUSH_C_STR(str, listvar) \
8404 listvar = Fcons (build_unibyte_string (str), listvar)
8406 /* Prompt string always starts with map's prompt, and a space. */
8407 prompt_strings
= Fcons (name
, prompt_strings
);
8408 PUSH_C_STR (": ", prompt_strings
);
8409 nlength
= SCHARS (name
) + 2;
8413 /* Present the documented bindings, a line at a time. */
8416 bool notfirst
= false;
8417 Lisp_Object menu_strings
= prompt_strings
;
8418 ptrdiff_t i
= nlength
;
8420 Lisp_Object orig_defn_macro
;
8422 /* Loop over elements of map. */
8427 /* FIXME: Use map_keymap to handle new keymap formats. */
8429 /* At end of map, wrap around if just starting,
8430 or end this line if already have something on it. */
8433 if (notfirst
|| nobindings
)
8439 /* Look at the next element of the map. */
8441 elt
= AREF (vector
, idx
);
8443 elt
= Fcar_safe (rest
);
8445 if (idx
< 0 && VECTORP (elt
))
8447 /* If we found a dense table in the keymap,
8448 advanced past it, but start scanning its contents. */
8449 rest
= Fcdr_safe (rest
);
8455 /* An ordinary element. */
8456 Lisp_Object event
, tem
;
8460 event
= Fcar_safe (elt
); /* alist */
8461 elt
= Fcdr_safe (elt
);
8465 XSETINT (event
, idx
); /* vector */
8468 /* Ignore the element if it has no prompt string. */
8469 if (INTEGERP (event
) && parse_menu_item (elt
, -1))
8471 /* True if the char to type matches the string. */
8473 Lisp_Object upcased_event
, downcased_event
;
8474 Lisp_Object desc
= Qnil
;
8476 = AREF (item_properties
, ITEM_PROPERTY_NAME
);
8478 upcased_event
= Fupcase (event
);
8479 downcased_event
= Fdowncase (event
);
8480 char_matches
= (XINT (upcased_event
) == SREF (s
, 0)
8481 || XINT (downcased_event
) == SREF (s
, 0));
8483 desc
= Fsingle_key_description (event
, Qnil
);
8485 #if 0 /* It is redundant to list the equivalent key bindings because
8486 the prefix is what the user has already typed. */
8488 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_KEYEQ
];
8490 /* Insert equivalent keybinding. */
8491 s
= concat2 (s
, tem
);
8494 = AREF (item_properties
, ITEM_PROPERTY_TYPE
);
8495 if (EQ (tem
, QCradio
) || EQ (tem
, QCtoggle
))
8497 /* Insert button prefix. */
8498 Lisp_Object selected
8499 = AREF (item_properties
, ITEM_PROPERTY_SELECTED
);
8500 AUTO_STRING (radio_yes
, "(*) ");
8501 AUTO_STRING (radio_no
, "( ) ");
8502 AUTO_STRING (check_yes
, "[X] ");
8503 AUTO_STRING (check_no
, "[ ] ");
8504 if (EQ (tem
, QCradio
))
8505 tem
= NILP (selected
) ? radio_yes
: radio_no
;
8507 tem
= NILP (selected
) ? check_yes
: check_no
;
8508 s
= concat2 (tem
, s
);
8512 /* If we have room for the prompt string, add it to this line.
8513 If this is the first on the line, always add it. */
8514 if ((SCHARS (s
) + i
+ 2
8515 + (char_matches
? 0 : SCHARS (desc
) + 3))
8519 ptrdiff_t thiswidth
;
8521 /* Punctuate between strings. */
8524 PUSH_C_STR (", ", menu_strings
);
8530 /* If the char to type doesn't match the string's
8531 first char, explicitly show what char to type. */
8534 /* Add as much of string as fits. */
8535 thiswidth
= min (SCHARS (desc
), width
- i
);
8537 = Fcons (Fsubstring (desc
, make_number (0),
8538 make_number (thiswidth
)),
8541 PUSH_C_STR (" = ", menu_strings
);
8545 /* Add as much of string as fits. */
8546 thiswidth
= min (SCHARS (s
), width
- i
);
8548 = Fcons (Fsubstring (s
, make_number (0),
8549 make_number (thiswidth
)),
8555 /* If this element does not fit, end the line now,
8556 and save the element for the next line. */
8557 PUSH_C_STR ("...", menu_strings
);
8562 /* Move past this element. */
8563 if (idx
>= 0 && idx
+ 1 >= ASIZE (vector
))
8564 /* Handle reaching end of dense table. */
8569 rest
= Fcdr_safe (rest
);
8573 /* Prompt with that and read response. */
8574 message3_nolog (apply1 (intern ("concat"), Fnreverse (menu_strings
)));
8576 /* Make believe it's not a keyboard macro in case the help char
8577 is pressed. Help characters are not recorded because menu prompting
8578 is not used on replay. */
8579 orig_defn_macro
= KVAR (current_kboard
, defining_kbd_macro
);
8580 kset_defining_kbd_macro (current_kboard
, Qnil
);
8582 obj
= read_char (commandflag
, Qnil
, Qt
, 0, NULL
);
8583 while (BUFFERP (obj
));
8584 kset_defining_kbd_macro (current_kboard
, orig_defn_macro
);
8586 if (!INTEGERP (obj
) || XINT (obj
) == -2
8587 || (! EQ (obj
, menu_prompt_more_char
)
8588 && (!INTEGERP (menu_prompt_more_char
)
8589 || ! EQ (obj
, make_number (Ctl (XINT (menu_prompt_more_char
)))))))
8591 if (!NILP (KVAR (current_kboard
, defining_kbd_macro
)))
8592 store_kbd_macro_char (obj
);
8595 /* Help char - go round again. */
8599 /* Reading key sequences. */
8602 follow_key (Lisp_Object keymap
, Lisp_Object key
)
8604 return access_keymap (get_keymap (keymap
, 0, 1),
8609 active_maps (Lisp_Object first_event
)
8611 Lisp_Object position
8612 = CONSP (first_event
) ? CAR_SAFE (XCDR (first_event
)) : Qnil
;
8613 return Fcons (Qkeymap
, Fcurrent_active_maps (Qt
, position
));
8616 /* Structure used to keep track of partial application of key remapping
8617 such as Vfunction_key_map and Vkey_translation_map. */
8618 typedef struct keyremap
8620 /* This is the map originally specified for this use. */
8622 /* This is a submap reached by looking up, in PARENT,
8623 the events from START to END. */
8625 /* Positions [START, END) in the key sequence buffer
8626 are the key that we have scanned so far.
8627 Those events are the ones that we will replace
8628 if PARENT maps them into a key sequence. */
8632 /* Lookup KEY in MAP.
8633 MAP is a keymap mapping keys to key vectors or functions.
8634 If the mapping is a function and DO_FUNCALL is true,
8635 the function is called with PROMPT as parameter and its return
8636 value is used as the return value of this function (after checking
8637 that it is indeed a vector). */
8640 access_keymap_keyremap (Lisp_Object map
, Lisp_Object key
, Lisp_Object prompt
,
8645 next
= access_keymap (map
, key
, 1, 0, 1);
8647 /* Handle a symbol whose function definition is a keymap
8649 if (SYMBOLP (next
) && !NILP (Ffboundp (next
))
8650 && (ARRAYP (XSYMBOL (next
)->function
)
8651 || KEYMAPP (XSYMBOL (next
)->function
)))
8652 next
= Fautoload_do_load (XSYMBOL (next
)->function
, next
, Qnil
);
8654 /* If the keymap gives a function, not an
8655 array, then call the function with one arg and use
8656 its value instead. */
8657 if (do_funcall
&& FUNCTIONP (next
))
8662 next
= call1 (next
, prompt
);
8663 /* If the function returned something invalid,
8664 barf--don't ignore it. */
8665 if (! (NILP (next
) || VECTORP (next
) || STRINGP (next
)))
8666 error ("Function %s returns invalid key sequence",
8667 SSDATA (SYMBOL_NAME (tem
)));
8672 /* Do one step of the key remapping used for function-key-map and
8673 key-translation-map:
8674 KEYBUF is the buffer holding the input events.
8675 BUFSIZE is its maximum size.
8676 FKEY is a pointer to the keyremap structure to use.
8677 INPUT is the index of the last element in KEYBUF.
8678 DOIT if true says that the remapping can actually take place.
8679 DIFF is used to return the number of keys added/removed by the remapping.
8680 PARENT is the root of the keymap.
8681 PROMPT is the prompt to use if the remapping happens through a function.
8682 Return true if the remapping actually took place. */
8685 keyremap_step (Lisp_Object
*keybuf
, int bufsize
, volatile keyremap
*fkey
,
8686 int input
, bool doit
, int *diff
, Lisp_Object prompt
)
8688 Lisp_Object next
, key
;
8690 key
= keybuf
[fkey
->end
++];
8692 if (KEYMAPP (fkey
->parent
))
8693 next
= access_keymap_keyremap (fkey
->map
, key
, prompt
, doit
);
8697 /* If keybuf[fkey->start..fkey->end] is bound in the
8698 map and we're in a position to do the key remapping, replace it with
8699 the binding and restart with fkey->start at the end. */
8700 if ((VECTORP (next
) || STRINGP (next
)) && doit
)
8702 int len
= XFASTINT (Flength (next
));
8705 *diff
= len
- (fkey
->end
- fkey
->start
);
8707 if (bufsize
- input
<= *diff
)
8708 error ("Key sequence too long");
8710 /* Shift the keys that follow fkey->end. */
8712 for (i
= fkey
->end
; i
< input
; i
++)
8713 keybuf
[i
+ *diff
] = keybuf
[i
];
8715 for (i
= input
- 1; i
>= fkey
->end
; i
--)
8716 keybuf
[i
+ *diff
] = keybuf
[i
];
8717 /* Overwrite the old keys with the new ones. */
8718 for (i
= 0; i
< len
; i
++)
8719 keybuf
[fkey
->start
+ i
]
8720 = Faref (next
, make_number (i
));
8722 fkey
->start
= fkey
->end
+= *diff
;
8723 fkey
->map
= fkey
->parent
;
8728 fkey
->map
= get_keymap (next
, 0, 1);
8730 /* If we no longer have a bound suffix, try a new position for
8732 if (!CONSP (fkey
->map
))
8734 fkey
->end
= ++fkey
->start
;
8735 fkey
->map
= fkey
->parent
;
8741 test_undefined (Lisp_Object binding
)
8743 return (NILP (binding
)
8744 || EQ (binding
, Qundefined
)
8745 || (SYMBOLP (binding
)
8746 && EQ (Fcommand_remapping (binding
, Qnil
, Qnil
), Qundefined
)));
8749 /* Read a sequence of keys that ends with a non prefix character,
8750 storing it in KEYBUF, a buffer of size BUFSIZE.
8752 Return the length of the key sequence stored.
8753 Return -1 if the user rejected a command menu.
8755 Echo starting immediately unless `prompt' is 0.
8757 If PREVENT_REDISPLAY is non-zero, avoid redisplay by calling
8758 read_char with a suitable COMMANDFLAG argument.
8760 Where a key sequence ends depends on the currently active keymaps.
8761 These include any minor mode keymaps active in the current buffer,
8762 the current buffer's local map, and the global map.
8764 If a key sequence has no other bindings, we check Vfunction_key_map
8765 to see if some trailing subsequence might be the beginning of a
8766 function key's sequence. If so, we try to read the whole function
8767 key, and substitute its symbolic name into the key sequence.
8769 We ignore unbound `down-' mouse clicks. We turn unbound `drag-' and
8770 `double-' events into similar click events, if that would make them
8771 bound. We try to turn `triple-' events first into `double-' events,
8774 If we get a mouse click in a mode line, vertical divider, or other
8775 non-text area, we treat the click as if it were prefixed by the
8776 symbol denoting that area - `mode-line', `vertical-line', or
8779 If the sequence starts with a mouse click, we read the key sequence
8780 with respect to the buffer clicked on, not the current buffer.
8782 If the user switches frames in the midst of a key sequence, we put
8783 off the switch-frame event until later; the next call to
8784 read_char will return it.
8786 If FIX_CURRENT_BUFFER, we restore current_buffer
8787 from the selected window's buffer. */
8790 read_key_sequence (Lisp_Object
*keybuf
, int bufsize
, Lisp_Object prompt
,
8791 bool dont_downcase_last
, bool can_return_switch_frame
,
8792 bool fix_current_buffer
, bool prevent_redisplay
)
8794 ptrdiff_t count
= SPECPDL_INDEX ();
8796 /* How many keys there are in the current key sequence. */
8799 /* The length of the echo buffer when we started reading, and
8800 the length of this_command_keys when we started reading. */
8801 ptrdiff_t echo_start
IF_LINT (= 0);
8802 ptrdiff_t keys_start
;
8804 Lisp_Object current_binding
= Qnil
;
8805 Lisp_Object first_event
= Qnil
;
8807 /* Index of the first key that has no binding.
8808 It is useless to try fkey.start larger than that. */
8811 /* If t < mock_input, then KEYBUF[t] should be read as the next
8814 We use this to recover after recognizing a function key. Once we
8815 realize that a suffix of the current key sequence is actually a
8816 function key's escape sequence, we replace the suffix with the
8817 function key's binding from Vfunction_key_map. Now keybuf
8818 contains a new and different key sequence, so the echo area,
8819 this_command_keys, and the submaps and defs arrays are wrong. In
8820 this situation, we set mock_input to t, set t to 0, and jump to
8821 restart_sequence; the loop will read keys from keybuf up until
8822 mock_input, thus rebuilding the state; and then it will resume
8823 reading characters from the keyboard. */
8826 /* If the sequence is unbound in submaps[], then
8827 keybuf[fkey.start..fkey.end-1] is a prefix in Vfunction_key_map,
8828 and fkey.map is its binding.
8830 These might be > t, indicating that all function key scanning
8831 should hold off until t reaches them. We do this when we've just
8832 recognized a function key, to avoid searching for the function
8833 key's again in Vfunction_key_map. */
8836 /* Likewise, for key_translation_map and input-decode-map. */
8837 keyremap keytran
, indec
;
8839 /* True if we are trying to map a key by changing an upper-case
8840 letter to lower case, or a shifted function key to an unshifted
8842 bool shift_translated
= false;
8844 /* If we receive a `switch-frame' or `select-window' event in the middle of
8845 a key sequence, we put it off for later.
8846 While we're reading, we keep the event here. */
8847 Lisp_Object delayed_switch_frame
;
8849 Lisp_Object original_uppercase
IF_LINT (= Qnil
);
8850 int original_uppercase_position
= -1;
8852 /* Gets around Microsoft compiler limitations. */
8853 bool dummyflag
= false;
8855 struct buffer
*starting_buffer
;
8857 /* List of events for which a fake prefix key has been generated. */
8858 Lisp_Object fake_prefixed_keys
= Qnil
;
8860 raw_keybuf_count
= 0;
8862 last_nonmenu_event
= Qnil
;
8864 delayed_switch_frame
= Qnil
;
8870 /* Install the string PROMPT as the beginning of the string
8871 of echoing, so that it serves as a prompt for the next
8873 kset_echo_string (current_kboard
, prompt
);
8874 current_kboard
->echo_after_prompt
= SCHARS (prompt
);
8877 else if (cursor_in_echo_area
8878 && echo_keystrokes_p ())
8879 /* This doesn't put in a dash if the echo buffer is empty, so
8880 you don't always see a dash hanging out in the minibuffer. */
8884 /* Record the initial state of the echo area and this_command_keys;
8885 we will need to restore them if we replay a key sequence. */
8887 echo_start
= echo_length ();
8888 keys_start
= this_command_key_count
;
8889 this_single_command_key_start
= keys_start
;
8891 /* We jump here when we need to reinitialize fkey and keytran; this
8892 happens if we switch keyboards between rescans. */
8893 replay_entire_sequence
:
8895 indec
.map
= indec
.parent
= KVAR (current_kboard
, Vinput_decode_map
);
8896 fkey
.map
= fkey
.parent
= KVAR (current_kboard
, Vlocal_function_key_map
);
8897 keytran
.map
= keytran
.parent
= Vkey_translation_map
;
8898 indec
.start
= indec
.end
= 0;
8899 fkey
.start
= fkey
.end
= 0;
8900 keytran
.start
= keytran
.end
= 0;
8902 /* We jump here when the key sequence has been thoroughly changed, and
8903 we need to rescan it starting from the beginning. When we jump here,
8904 keybuf[0..mock_input] holds the sequence we should reread. */
8907 starting_buffer
= current_buffer
;
8908 first_unbound
= bufsize
+ 1;
8910 /* Build our list of keymaps.
8911 If we recognize a function key and replace its escape sequence in
8912 keybuf with its symbol, or if the sequence starts with a mouse
8913 click and we need to switch buffers, we jump back here to rebuild
8914 the initial keymaps from the current buffer. */
8915 current_binding
= active_maps (first_event
);
8917 /* Start from the beginning in keybuf. */
8920 /* These are no-ops the first time through, but if we restart, they
8921 revert the echo area and this_command_keys to their original state. */
8922 this_command_key_count
= keys_start
;
8923 if (INTERACTIVE
&& t
< mock_input
)
8924 echo_truncate (echo_start
);
8926 /* If the best binding for the current key sequence is a keymap, or
8927 we may be looking at a function key's escape sequence, keep on
8929 while (!NILP (current_binding
)
8930 /* Keep reading as long as there's a prefix binding. */
8931 ? KEYMAPP (current_binding
)
8932 /* Don't return in the middle of a possible function key sequence,
8933 if the only bindings we found were via case conversion.
8934 Thus, if ESC O a has a function-key-map translation
8935 and ESC o has a binding, don't return after ESC O,
8936 so that we can translate ESC O plus the next character. */
8937 : (/* indec.start < t || fkey.start < t || */ keytran
.start
< t
))
8940 bool used_mouse_menu
= false;
8942 /* Where the last real key started. If we need to throw away a
8943 key that has expanded into more than one element of keybuf
8944 (say, a mouse click on the mode line which is being treated
8945 as [mode-line (mouse-...)], then we backtrack to this point
8947 int last_real_key_start
;
8949 /* These variables are analogous to echo_start and keys_start;
8950 while those allow us to restart the entire key sequence,
8951 echo_local_start and keys_local_start allow us to throw away
8953 ptrdiff_t echo_local_start
IF_LINT (= 0);
8954 int keys_local_start
;
8955 Lisp_Object new_binding
;
8957 eassert (indec
.end
== t
|| (indec
.end
> t
&& indec
.end
<= mock_input
));
8958 eassert (indec
.start
<= indec
.end
);
8959 eassert (fkey
.start
<= fkey
.end
);
8960 eassert (keytran
.start
<= keytran
.end
);
8961 /* key-translation-map is applied *after* function-key-map
8962 which is itself applied *after* input-decode-map. */
8963 eassert (fkey
.end
<= indec
.start
);
8964 eassert (keytran
.end
<= fkey
.start
);
8966 if (/* first_unbound < indec.start && first_unbound < fkey.start && */
8967 first_unbound
< keytran
.start
)
8968 { /* The prefix upto first_unbound has no binding and has
8969 no translation left to do either, so we know it's unbound.
8970 If we don't stop now, we risk staying here indefinitely
8971 (if the user keeps entering fkey or keytran prefixes
8972 like C-c ESC ESC ESC ESC ...) */
8974 for (i
= first_unbound
+ 1; i
< t
; i
++)
8975 keybuf
[i
- first_unbound
- 1] = keybuf
[i
];
8976 mock_input
= t
- first_unbound
- 1;
8977 indec
.end
= indec
.start
-= first_unbound
+ 1;
8978 indec
.map
= indec
.parent
;
8979 fkey
.end
= fkey
.start
-= first_unbound
+ 1;
8980 fkey
.map
= fkey
.parent
;
8981 keytran
.end
= keytran
.start
-= first_unbound
+ 1;
8982 keytran
.map
= keytran
.parent
;
8983 goto replay_sequence
;
8987 error ("Key sequence too long");
8990 echo_local_start
= echo_length ();
8991 keys_local_start
= this_command_key_count
;
8994 /* These are no-ops, unless we throw away a keystroke below and
8995 jumped back up to replay_key; in that case, these restore the
8996 variables to their original state, allowing us to replay the
8998 if (INTERACTIVE
&& t
< mock_input
)
8999 echo_truncate (echo_local_start
);
9000 this_command_key_count
= keys_local_start
;
9002 /* By default, assume each event is "real". */
9003 last_real_key_start
= t
;
9005 /* Does mock_input indicate that we are re-reading a key sequence? */
9009 add_command_key (key
);
9010 if (current_kboard
->immediate_echo
)
9012 /* Set immediate_echo to false so as to force echo_now to
9013 redisplay (it will set immediate_echo right back to true). */
9014 current_kboard
->immediate_echo
= false;
9019 /* If not, we should actually read a character. */
9023 KBOARD
*interrupted_kboard
= current_kboard
;
9024 struct frame
*interrupted_frame
= SELECTED_FRAME ();
9025 /* Calling read_char with COMMANDFLAG = -2 avoids
9026 redisplay in read_char and its subroutines. */
9027 key
= read_char (prevent_redisplay
? -2 : NILP (prompt
),
9028 current_binding
, last_nonmenu_event
,
9029 &used_mouse_menu
, NULL
);
9030 if ((INTEGERP (key
) && XINT (key
) == -2) /* wrong_kboard_jmpbuf */
9031 /* When switching to a new tty (with a new keyboard),
9032 read_char returns the new buffer, rather than -2
9033 (Bug#5095). This is because `terminal-init-xterm'
9034 calls read-char, which eats the wrong_kboard_jmpbuf
9035 return. Any better way to fix this? -- cyd */
9036 || (interrupted_kboard
!= current_kboard
))
9041 for (k
= all_kboards
; k
; k
= k
->next_kboard
)
9042 if (k
== interrupted_kboard
)
9047 /* Don't touch interrupted_kboard when it's been
9049 delayed_switch_frame
= Qnil
;
9050 goto replay_entire_sequence
;
9053 if (!NILP (delayed_switch_frame
))
9056 (interrupted_kboard
,
9057 Fcons (delayed_switch_frame
,
9058 KVAR (interrupted_kboard
, kbd_queue
)));
9059 delayed_switch_frame
= Qnil
;
9064 (interrupted_kboard
,
9065 Fcons (keybuf
[--t
], KVAR (interrupted_kboard
, kbd_queue
)));
9067 /* If the side queue is non-empty, ensure it begins with a
9068 switch-frame, so we'll replay it in the right context. */
9069 if (CONSP (KVAR (interrupted_kboard
, kbd_queue
))
9070 && (key
= XCAR (KVAR (interrupted_kboard
, kbd_queue
)),
9071 !(EVENT_HAS_PARAMETERS (key
)
9072 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)),
9076 XSETFRAME (frame
, interrupted_frame
);
9078 (interrupted_kboard
,
9079 Fcons (make_lispy_switch_frame (frame
),
9080 KVAR (interrupted_kboard
, kbd_queue
)));
9083 goto replay_entire_sequence
;
9087 /* read_char returns t when it shows a menu and the user rejects it.
9091 unbind_to (count
, Qnil
);
9095 /* read_char returns -1 at the end of a macro.
9096 Emacs 18 handles this by returning immediately with a
9097 zero, so that's what we'll do. */
9098 if (INTEGERP (key
) && XINT (key
) == -1)
9101 /* The Microsoft C compiler can't handle the goto that
9107 /* If the current buffer has been changed from under us, the
9108 keymap may have changed, so replay the sequence. */
9111 timer_resume_idle ();
9114 /* Reset the current buffer from the selected window
9115 in case something changed the former and not the latter.
9116 This is to be more consistent with the behavior
9117 of the command_loop_1. */
9118 if (fix_current_buffer
)
9120 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
9122 if (XBUFFER (XWINDOW (selected_window
)->contents
)
9124 Fset_buffer (XWINDOW (selected_window
)->contents
);
9127 goto replay_sequence
;
9130 /* If we have a quit that was typed in another frame, and
9131 quit_throw_to_read_char switched buffers,
9132 replay to get the right keymap. */
9134 && XINT (key
) == quit_char
9135 && current_buffer
!= starting_buffer
)
9138 ASET (raw_keybuf
, raw_keybuf_count
, key
);
9143 goto replay_sequence
;
9148 if (EVENT_HAS_PARAMETERS (key
)
9149 /* Either a `switch-frame' or a `select-window' event. */
9150 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)), Qswitch_frame
))
9152 /* If we're at the beginning of a key sequence, and the caller
9153 says it's okay, go ahead and return this event. If we're
9154 in the midst of a key sequence, delay it until the end. */
9155 if (t
> 0 || !can_return_switch_frame
)
9157 delayed_switch_frame
= key
;
9162 if (NILP (first_event
))
9165 /* Even if first_event does not specify a particular
9166 window/position, it's important to recompute the maps here
9167 since a long time might have passed since we entered
9168 read_key_sequence, and a timer (or process-filter or
9169 special-event-map, ...) might have switched the current buffer
9170 or the selected window from under us in the mean time. */
9171 if (fix_current_buffer
9172 && (XBUFFER (XWINDOW (selected_window
)->contents
)
9174 Fset_buffer (XWINDOW (selected_window
)->contents
);
9175 current_binding
= active_maps (first_event
);
9179 ASET (raw_keybuf
, raw_keybuf_count
, key
);
9183 /* Clicks in non-text areas get prefixed by the symbol
9184 in their CHAR-ADDRESS field. For example, a click on
9185 the mode line is prefixed by the symbol `mode-line'.
9187 Furthermore, key sequences beginning with mouse clicks
9188 are read using the keymaps of the buffer clicked on, not
9189 the current buffer. So we may have to switch the buffer
9192 When we turn one event into two events, we must make sure
9193 that neither of the two looks like the original--so that,
9194 if we replay the events, they won't be expanded again.
9195 If not for this, such reexpansion could happen either here
9196 or when user programs play with this-command-keys. */
9197 if (EVENT_HAS_PARAMETERS (key
))
9199 Lisp_Object kind
= EVENT_HEAD_KIND (EVENT_HEAD (key
));
9200 if (EQ (kind
, Qmouse_click
))
9202 Lisp_Object window
= POSN_WINDOW (EVENT_START (key
));
9203 Lisp_Object posn
= POSN_POSN (EVENT_START (key
));
9206 || (!NILP (fake_prefixed_keys
)
9207 && !NILP (Fmemq (key
, fake_prefixed_keys
))))
9209 /* We're looking a second time at an event for which
9210 we generated a fake prefix key. Set
9211 last_real_key_start appropriately. */
9213 last_real_key_start
= t
- 1;
9216 if (last_real_key_start
== 0)
9218 /* Key sequences beginning with mouse clicks are
9219 read using the keymaps in the buffer clicked on,
9220 not the current buffer. If we're at the
9221 beginning of a key sequence, switch buffers. */
9222 if (WINDOWP (window
)
9223 && BUFFERP (XWINDOW (window
)->contents
)
9224 && XBUFFER (XWINDOW (window
)->contents
) != current_buffer
)
9226 ASET (raw_keybuf
, raw_keybuf_count
, key
);
9231 /* Arrange to go back to the original buffer once we're
9232 done reading the key sequence. Note that we can't
9233 use save_excursion_{save,restore} here, because they
9234 save point as well as the current buffer; we don't
9235 want to save point, because redisplay may change it,
9236 to accommodate a Fset_window_start or something. We
9237 don't want to do this at the top of the function,
9238 because we may get input from a subprocess which
9239 wants to change the selected window and stuff (say,
9241 record_unwind_current_buffer ();
9243 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
9245 set_buffer_internal (XBUFFER (XWINDOW (window
)->contents
));
9246 goto replay_sequence
;
9250 /* Expand mode-line and scroll-bar events into two events:
9251 use posn as a fake prefix key. */
9253 && (NILP (fake_prefixed_keys
)
9254 || NILP (Fmemq (key
, fake_prefixed_keys
))))
9256 if (bufsize
- t
<= 1)
9257 error ("Key sequence too long");
9260 keybuf
[t
+ 1] = key
;
9263 /* Record that a fake prefix key has been generated
9264 for KEY. Don't modify the event; this would
9265 prevent proper action when the event is pushed
9266 back into unread-command-events. */
9267 fake_prefixed_keys
= Fcons (key
, fake_prefixed_keys
);
9271 else if (CONSP (XCDR (key
))
9272 && CONSP (EVENT_START (key
))
9273 && CONSP (XCDR (EVENT_START (key
))))
9277 posn
= POSN_POSN (EVENT_START (key
));
9278 /* Handle menu-bar events:
9279 insert the dummy prefix event `menu-bar'. */
9280 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
9282 if (bufsize
- t
<= 1)
9283 error ("Key sequence too long");
9285 keybuf
[t
+ 1] = key
;
9287 /* Zap the position in key, so we know that we've
9288 expanded it, and don't try to do so again. */
9289 POSN_SET_POSN (EVENT_START (key
), list1 (posn
));
9292 goto replay_sequence
;
9294 else if (CONSP (posn
))
9296 /* We're looking at the second event of a
9297 sequence which we expanded before. Set
9298 last_real_key_start appropriately. */
9299 if (last_real_key_start
== t
&& t
> 0)
9300 last_real_key_start
= t
- 1;
9305 /* We have finally decided that KEY is something we might want
9307 new_binding
= follow_key (current_binding
, key
);
9309 /* If KEY wasn't bound, we'll try some fallbacks. */
9310 if (!NILP (new_binding
))
9311 /* This is needed for the following scenario:
9312 event 0: a down-event that gets dropped by calling replay_key.
9313 event 1: some normal prefix like C-h.
9314 After event 0, first_unbound is 0, after event 1 indec.start,
9315 fkey.start, and keytran.start are all 1, so when we see that
9316 C-h is bound, we need to update first_unbound. */
9317 first_unbound
= max (t
+ 1, first_unbound
);
9322 /* Remember the position to put an upper bound on indec.start. */
9323 first_unbound
= min (t
, first_unbound
);
9325 head
= EVENT_HEAD (key
);
9329 Lisp_Object breakdown
;
9332 breakdown
= parse_modifiers (head
);
9333 modifiers
= XINT (XCAR (XCDR (breakdown
)));
9334 /* Attempt to reduce an unbound mouse event to a simpler
9335 event that is bound:
9336 Drags reduce to clicks.
9337 Double-clicks reduce to clicks.
9338 Triple-clicks reduce to double-clicks, then to clicks.
9339 Up/Down-clicks are eliminated.
9340 Double-downs reduce to downs, then are eliminated.
9341 Triple-downs reduce to double-downs, then to downs,
9342 then are eliminated. */
9343 if (modifiers
& (up_modifier
| down_modifier
9345 | double_modifier
| triple_modifier
))
9347 while (modifiers
& (up_modifier
| down_modifier
9349 | double_modifier
| triple_modifier
))
9351 Lisp_Object new_head
, new_click
;
9352 if (modifiers
& triple_modifier
)
9353 modifiers
^= (double_modifier
| triple_modifier
);
9354 else if (modifiers
& double_modifier
)
9355 modifiers
&= ~double_modifier
;
9356 else if (modifiers
& drag_modifier
)
9357 modifiers
&= ~drag_modifier
;
9360 /* Dispose of this `up/down' event by simply jumping
9361 back to replay_key, to get another event.
9363 Note that if this event came from mock input,
9364 then just jumping back to replay_key will just
9365 hand it to us again. So we have to wipe out any
9368 We could delete keybuf[t] and shift everything
9369 after that to the left by one spot, but we'd also
9370 have to fix up any variable that points into
9371 keybuf, and shifting isn't really necessary
9374 Adding prefixes for non-textual mouse clicks
9375 creates two characters of mock input, and both
9376 must be thrown away. If we're only looking at
9377 the prefix now, we can just jump back to
9378 replay_key. On the other hand, if we've already
9379 processed the prefix, and now the actual click
9380 itself is giving us trouble, then we've lost the
9381 state of the keymaps we want to backtrack to, and
9382 we need to replay the whole sequence to rebuild
9385 Beyond that, only function key expansion could
9386 create more than two keys, but that should never
9387 generate mouse events, so it's okay to zero
9388 mock_input in that case too.
9390 FIXME: The above paragraph seems just plain
9391 wrong, if you consider things like
9392 xterm-mouse-mode. -stef
9394 Isn't this just the most wonderful code ever? */
9396 /* If mock_input > t + 1, the above simplification
9397 will actually end up dropping keys on the floor.
9398 This is probably OK for now, but even
9399 if mock_input <= t + 1, we need to adjust indec,
9401 Typical case [header-line down-mouse-N]:
9402 mock_input = 2, t = 1, fkey.end = 1,
9403 last_real_key_start = 0. */
9404 if (indec
.end
> last_real_key_start
)
9406 indec
.end
= indec
.start
9407 = min (last_real_key_start
, indec
.start
);
9408 indec
.map
= indec
.parent
;
9409 if (fkey
.end
> last_real_key_start
)
9411 fkey
.end
= fkey
.start
9412 = min (last_real_key_start
, fkey
.start
);
9413 fkey
.map
= fkey
.parent
;
9414 if (keytran
.end
> last_real_key_start
)
9416 keytran
.end
= keytran
.start
9417 = min (last_real_key_start
, keytran
.start
);
9418 keytran
.map
= keytran
.parent
;
9422 if (t
== last_real_key_start
)
9429 mock_input
= last_real_key_start
;
9430 goto replay_sequence
;
9435 = apply_modifiers (modifiers
, XCAR (breakdown
));
9436 new_click
= list2 (new_head
, EVENT_START (key
));
9438 /* Look for a binding for this new key. */
9439 new_binding
= follow_key (current_binding
, new_click
);
9441 /* If that click is bound, go for it. */
9442 if (!NILP (new_binding
))
9444 current_binding
= new_binding
;
9448 /* Otherwise, we'll leave key set to the drag event. */
9453 current_binding
= new_binding
;
9456 /* Normally, last_nonmenu_event gets the previous key we read.
9457 But when a mouse popup menu is being used,
9458 we don't update last_nonmenu_event; it continues to hold the mouse
9459 event that preceded the first level of menu. */
9460 if (!used_mouse_menu
)
9461 last_nonmenu_event
= key
;
9463 /* Record what part of this_command_keys is the current key sequence. */
9464 this_single_command_key_start
= this_command_key_count
- t
;
9465 /* When 'input-method-function' called above causes events to be
9466 put on 'unread-post-input-method-events', and as result
9467 'reread' is set to 'true', the value of 't' can become larger
9468 than 'this_command_key_count', because 'add_command_key' is
9469 not called to update 'this_command_key_count'. If this
9470 happens, 'this_single_command_key_start' will become negative
9471 above, and any call to 'this-single-command-keys' will return
9472 a garbled vector. See bug #20223 for one such situation.
9473 Here we force 'this_single_command_key_start' to never become
9474 negative, to avoid that. */
9475 if (this_single_command_key_start
< 0)
9476 this_single_command_key_start
= 0;
9478 /* Look for this sequence in input-decode-map.
9479 Scan from indec.end until we find a bound suffix. */
9480 while (indec
.end
< t
)
9485 done
= keyremap_step (keybuf
, bufsize
, &indec
, max (t
, mock_input
),
9489 mock_input
= diff
+ max (t
, mock_input
);
9490 goto replay_sequence
;
9494 if (!KEYMAPP (current_binding
)
9495 && !test_undefined (current_binding
)
9496 && indec
.start
>= t
)
9497 /* There is a binding and it's not a prefix.
9498 (and it doesn't have any input-decode-map translation pending).
9499 There is thus no function-key in this sequence.
9500 Moving fkey.start is important in this case to allow keytran.start
9501 to go over the sequence before we return (since we keep the
9502 invariant that keytran.end <= fkey.start). */
9505 (fkey
.start
= fkey
.end
= t
, fkey
.map
= fkey
.parent
);
9508 /* If the sequence is unbound, see if we can hang a function key
9509 off the end of it. */
9510 /* Continue scan from fkey.end until we find a bound suffix. */
9511 while (fkey
.end
< indec
.start
)
9516 done
= keyremap_step (keybuf
, bufsize
, &fkey
,
9517 max (t
, mock_input
),
9518 /* If there's a binding (i.e.
9519 first_binding >= nmaps) we don't want
9520 to apply this function-key-mapping. */
9522 && (test_undefined (current_binding
)),
9526 mock_input
= diff
+ max (t
, mock_input
);
9527 /* Adjust the input-decode-map counters. */
9529 indec
.start
+= diff
;
9531 goto replay_sequence
;
9535 /* Look for this sequence in key-translation-map.
9536 Scan from keytran.end until we find a bound suffix. */
9537 while (keytran
.end
< fkey
.start
)
9542 done
= keyremap_step (keybuf
, bufsize
, &keytran
, max (t
, mock_input
),
9546 mock_input
= diff
+ max (t
, mock_input
);
9547 /* Adjust the function-key-map and input-decode-map counters. */
9549 indec
.start
+= diff
;
9553 goto replay_sequence
;
9557 /* If KEY is not defined in any of the keymaps,
9558 and cannot be part of a function key or translation,
9559 and is an upper case letter
9560 use the corresponding lower-case letter instead. */
9561 if (NILP (current_binding
)
9562 && /* indec.start >= t && fkey.start >= t && */ keytran
.start
>= t
9564 && ((CHARACTERP (make_number (XINT (key
) & ~CHAR_MODIFIER_MASK
))
9565 && uppercasep (XINT (key
) & ~CHAR_MODIFIER_MASK
))
9566 || (XINT (key
) & shift_modifier
)))
9568 Lisp_Object new_key
;
9570 original_uppercase
= key
;
9571 original_uppercase_position
= t
- 1;
9573 if (XINT (key
) & shift_modifier
)
9574 XSETINT (new_key
, XINT (key
) & ~shift_modifier
);
9576 XSETINT (new_key
, (downcase (XINT (key
) & ~CHAR_MODIFIER_MASK
)
9577 | (XINT (key
) & CHAR_MODIFIER_MASK
)));
9579 /* We have to do this unconditionally, regardless of whether
9580 the lower-case char is defined in the keymaps, because they
9581 might get translated through function-key-map. */
9582 keybuf
[t
- 1] = new_key
;
9583 mock_input
= max (t
, mock_input
);
9584 shift_translated
= true;
9586 goto replay_sequence
;
9589 if (NILP (current_binding
)
9590 && help_char_p (EVENT_HEAD (key
)) && t
> 1)
9592 read_key_sequence_cmd
= Vprefix_help_command
;
9593 /* The Microsoft C compiler can't handle the goto that
9599 /* If KEY is not defined in any of the keymaps,
9600 and cannot be part of a function key or translation,
9601 and is a shifted function key,
9602 use the corresponding unshifted function key instead. */
9603 if (NILP (current_binding
)
9604 && /* indec.start >= t && fkey.start >= t && */ keytran
.start
>= t
)
9606 Lisp_Object breakdown
= parse_modifiers (key
);
9608 = CONSP (breakdown
) ? (XINT (XCAR (XCDR (breakdown
)))) : 0;
9610 if (modifiers
& shift_modifier
9611 /* Treat uppercase keys as shifted. */
9613 && (KEY_TO_CHAR (key
)
9614 < XCHAR_TABLE (BVAR (current_buffer
, downcase_table
))->header
.size
)
9615 && uppercasep (KEY_TO_CHAR (key
))))
9618 = (modifiers
& shift_modifier
9619 ? apply_modifiers (modifiers
& ~shift_modifier
,
9621 : make_number (downcase (KEY_TO_CHAR (key
)) | modifiers
));
9623 original_uppercase
= key
;
9624 original_uppercase_position
= t
- 1;
9626 /* We have to do this unconditionally, regardless of whether
9627 the lower-case char is defined in the keymaps, because they
9628 might get translated through function-key-map. */
9629 keybuf
[t
- 1] = new_key
;
9630 mock_input
= max (t
, mock_input
);
9631 /* Reset fkey (and consequently keytran) to apply
9632 function-key-map on the result, so that S-backspace is
9633 correctly mapped to DEL (via backspace). OTOH,
9634 input-decode-map doesn't need to go through it again. */
9635 fkey
.start
= fkey
.end
= 0;
9636 keytran
.start
= keytran
.end
= 0;
9637 shift_translated
= true;
9639 goto replay_sequence
;
9644 read_key_sequence_cmd
= current_binding
;
9645 read_key_sequence_remapped
9646 /* Remap command through active keymaps.
9647 Do the remapping here, before the unbind_to so it uses the keymaps
9648 of the appropriate buffer. */
9649 = SYMBOLP (read_key_sequence_cmd
)
9650 ? Fcommand_remapping (read_key_sequence_cmd
, Qnil
, Qnil
)
9653 unread_switch_frame
= delayed_switch_frame
;
9654 unbind_to (count
, Qnil
);
9656 /* Don't downcase the last character if the caller says don't.
9657 Don't downcase it if the result is undefined, either. */
9658 if ((dont_downcase_last
|| NILP (current_binding
))
9660 && t
- 1 == original_uppercase_position
)
9662 keybuf
[t
- 1] = original_uppercase
;
9663 shift_translated
= false;
9666 if (shift_translated
)
9667 Vthis_command_keys_shift_translated
= Qt
;
9669 /* Occasionally we fabricate events, perhaps by expanding something
9670 according to function-key-map, or by adding a prefix symbol to a
9671 mouse click in the scroll bar or modeline. In this cases, return
9672 the entire generated key sequence, even if we hit an unbound
9673 prefix or a definition before the end. This means that you will
9674 be able to push back the event properly, and also means that
9675 read-key-sequence will always return a logical unit.
9678 for (; t
< mock_input
; t
++)
9679 add_command_key (keybuf
[t
]);
9686 read_key_sequence_vs (Lisp_Object prompt
, Lisp_Object continue_echo
,
9687 Lisp_Object dont_downcase_last
,
9688 Lisp_Object can_return_switch_frame
,
9689 Lisp_Object cmd_loop
, bool allow_string
)
9691 Lisp_Object keybuf
[30];
9693 ptrdiff_t count
= SPECPDL_INDEX ();
9696 CHECK_STRING (prompt
);
9699 specbind (Qinput_method_exit_on_first_char
,
9700 (NILP (cmd_loop
) ? Qt
: Qnil
));
9701 specbind (Qinput_method_use_echo_area
,
9702 (NILP (cmd_loop
) ? Qt
: Qnil
));
9704 if (NILP (continue_echo
))
9706 this_command_key_count
= 0;
9707 this_single_command_key_start
= 0;
9710 #ifdef HAVE_WINDOW_SYSTEM
9711 if (display_hourglass_p
)
9712 cancel_hourglass ();
9715 i
= read_key_sequence (keybuf
, ARRAYELTS (keybuf
),
9716 prompt
, ! NILP (dont_downcase_last
),
9717 ! NILP (can_return_switch_frame
), 0, 0);
9719 #if 0 /* The following is fine for code reading a key sequence and
9720 then proceeding with a lengthy computation, but it's not good
9721 for code reading keys in a loop, like an input method. */
9722 #ifdef HAVE_WINDOW_SYSTEM
9723 if (display_hourglass_p
)
9734 return unbind_to (count
,
9735 ((allow_string
? make_event_array
: Fvector
)
9739 DEFUN ("read-key-sequence", Fread_key_sequence
, Sread_key_sequence
, 1, 5, 0,
9740 doc
: /* Read a sequence of keystrokes and return as a string or vector.
9741 The sequence is sufficient to specify a non-prefix command in the
9742 current local and global maps.
9744 First arg PROMPT is a prompt string. If nil, do not prompt specially.
9745 Second (optional) arg CONTINUE-ECHO, if non-nil, means this key echos
9746 as a continuation of the previous key.
9748 The third (optional) arg DONT-DOWNCASE-LAST, if non-nil, means do not
9749 convert the last event to lower case. (Normally any upper case event
9750 is converted to lower case if the original event is undefined and the lower
9751 case equivalent is defined.) A non-nil value is appropriate for reading
9752 a key sequence to be defined.
9754 A C-g typed while in this function is treated like any other character,
9755 and `quit-flag' is not set.
9757 If the key sequence starts with a mouse click, then the sequence is read
9758 using the keymaps of the buffer of the window clicked in, not the buffer
9759 of the selected window as normal.
9761 `read-key-sequence' drops unbound button-down events, since you normally
9762 only care about the click or drag events which follow them. If a drag
9763 or multi-click event is unbound, but the corresponding click event would
9764 be bound, `read-key-sequence' turns the event into a click event at the
9765 drag's starting position. This means that you don't have to distinguish
9766 between click and drag, double, or triple events unless you want to.
9768 `read-key-sequence' prefixes mouse events on mode lines, the vertical
9769 lines separating windows, and scroll bars with imaginary keys
9770 `mode-line', `vertical-line', and `vertical-scroll-bar'.
9772 Optional fourth argument CAN-RETURN-SWITCH-FRAME non-nil means that this
9773 function will process a switch-frame event if the user switches frames
9774 before typing anything. If the user switches frames in the middle of a
9775 key sequence, or at the start of the sequence but CAN-RETURN-SWITCH-FRAME
9776 is nil, then the event will be put off until after the current key sequence.
9778 `read-key-sequence' checks `function-key-map' for function key
9779 sequences, where they wouldn't conflict with ordinary bindings. See
9780 `function-key-map' for more details.
9782 The optional fifth argument CMD-LOOP, if non-nil, means
9783 that this key sequence is being read by something that will
9784 read commands one after another. It should be nil if the caller
9785 will read just one key sequence. */)
9786 (Lisp_Object prompt
, Lisp_Object continue_echo
, Lisp_Object dont_downcase_last
, Lisp_Object can_return_switch_frame
, Lisp_Object cmd_loop
)
9788 return read_key_sequence_vs (prompt
, continue_echo
, dont_downcase_last
,
9789 can_return_switch_frame
, cmd_loop
, true);
9792 DEFUN ("read-key-sequence-vector", Fread_key_sequence_vector
,
9793 Sread_key_sequence_vector
, 1, 5, 0,
9794 doc
: /* Like `read-key-sequence' but always return a vector. */)
9795 (Lisp_Object prompt
, Lisp_Object continue_echo
, Lisp_Object dont_downcase_last
, Lisp_Object can_return_switch_frame
, Lisp_Object cmd_loop
)
9797 return read_key_sequence_vs (prompt
, continue_echo
, dont_downcase_last
,
9798 can_return_switch_frame
, cmd_loop
, false);
9801 /* Return true if input events are pending. */
9804 detect_input_pending (void)
9806 return input_pending
|| get_input_pending (0);
9809 /* Return true if input events other than mouse movements are
9813 detect_input_pending_ignore_squeezables (void)
9815 return input_pending
|| get_input_pending (READABLE_EVENTS_IGNORE_SQUEEZABLES
);
9818 /* Return true if input events are pending, and run any pending timers. */
9821 detect_input_pending_run_timers (bool do_display
)
9823 unsigned old_timers_run
= timers_run
;
9826 get_input_pending (READABLE_EVENTS_DO_TIMERS_NOW
);
9828 if (old_timers_run
!= timers_run
&& do_display
)
9829 redisplay_preserve_echo_area (8);
9831 return input_pending
;
9834 /* This is called in some cases before a possible quit.
9835 It cases the next call to detect_input_pending to recompute input_pending.
9836 So calling this function unnecessarily can't do any harm. */
9839 clear_input_pending (void)
9841 input_pending
= false;
9844 /* Return true if there are pending requeued events.
9845 This isn't used yet. The hope is to make wait_reading_process_output
9846 call it, and return if it runs Lisp code that unreads something.
9847 The problem is, kbd_buffer_get_event needs to be fixed to know what
9848 to do in that case. It isn't trivial. */
9851 requeued_events_pending_p (void)
9853 return (!NILP (Vunread_command_events
));
9856 DEFUN ("input-pending-p", Finput_pending_p
, Sinput_pending_p
, 0, 1, 0,
9857 doc
: /* Return t if command input is currently available with no wait.
9858 Actually, the value is nil only if we can be sure that no input is available;
9859 if there is a doubt, the value is t.
9861 If CHECK-TIMERS is non-nil, timers that are ready to run will do so. */)
9862 (Lisp_Object check_timers
)
9864 if (!NILP (Vunread_command_events
)
9865 || !NILP (Vunread_post_input_method_events
)
9866 || !NILP (Vunread_input_method_events
))
9869 /* Process non-user-visible events (Bug#10195). */
9870 process_special_events ();
9872 return (get_input_pending ((NILP (check_timers
)
9873 ? 0 : READABLE_EVENTS_DO_TIMERS_NOW
)
9874 | READABLE_EVENTS_FILTER_EVENTS
)
9878 DEFUN ("recent-keys", Frecent_keys
, Srecent_keys
, 0, 1, 0,
9879 doc
: /* Return vector of last few events, not counting those from keyboard macros.
9880 If INCLUDE-CMDS is non-nil, include the commands that were run,
9881 represented as events of the form (nil . COMMAND). */)
9882 (Lisp_Object include_cmds
)
9884 bool cmds
= !NILP (include_cmds
);
9887 || (cmds
&& total_keys
< NUM_RECENT_KEYS
))
9888 return Fvector (total_keys
,
9889 XVECTOR (recent_keys
)->contents
);
9892 Lisp_Object es
= Qnil
;
9893 int i
= (total_keys
< NUM_RECENT_KEYS
9894 ? 0 : recent_keys_index
);
9895 eassert (recent_keys_index
< NUM_RECENT_KEYS
);
9898 Lisp_Object e
= AREF (recent_keys
, i
);
9899 if (cmds
|| !CONSP (e
) || !NILP (XCAR (e
)))
9901 if (++i
>= NUM_RECENT_KEYS
)
9903 } while (i
!= recent_keys_index
);
9904 es
= Fnreverse (es
);
9905 return Fvconcat (1, &es
);
9909 DEFUN ("this-command-keys", Fthis_command_keys
, Sthis_command_keys
, 0, 0, 0,
9910 doc
: /* Return the key sequence that invoked this command.
9911 However, if the command has called `read-key-sequence', it returns
9912 the last key sequence that has been read.
9913 The value is a string or a vector.
9915 See also `this-command-keys-vector'. */)
9918 return make_event_array (this_command_key_count
,
9919 XVECTOR (this_command_keys
)->contents
);
9922 DEFUN ("this-command-keys-vector", Fthis_command_keys_vector
, Sthis_command_keys_vector
, 0, 0, 0,
9923 doc
: /* Return the key sequence that invoked this command, as a vector.
9924 However, if the command has called `read-key-sequence', it returns
9925 the last key sequence that has been read.
9927 See also `this-command-keys'. */)
9930 return Fvector (this_command_key_count
,
9931 XVECTOR (this_command_keys
)->contents
);
9934 DEFUN ("this-single-command-keys", Fthis_single_command_keys
,
9935 Sthis_single_command_keys
, 0, 0, 0,
9936 doc
: /* Return the key sequence that invoked this command.
9937 More generally, it returns the last key sequence read, either by
9938 the command loop or by `read-key-sequence'.
9939 Unlike `this-command-keys', this function's value
9940 does not include prefix arguments.
9941 The value is always a vector. */)
9944 return Fvector (this_command_key_count
9945 - this_single_command_key_start
,
9946 (XVECTOR (this_command_keys
)->contents
9947 + this_single_command_key_start
));
9950 DEFUN ("this-single-command-raw-keys", Fthis_single_command_raw_keys
,
9951 Sthis_single_command_raw_keys
, 0, 0, 0,
9952 doc
: /* Return the raw events that were read for this command.
9953 More generally, it returns the last key sequence read, either by
9954 the command loop or by `read-key-sequence'.
9955 Unlike `this-single-command-keys', this function's value
9956 shows the events before all translations (except for input methods).
9957 The value is always a vector. */)
9960 return Fvector (raw_keybuf_count
, XVECTOR (raw_keybuf
)->contents
);
9963 DEFUN ("clear-this-command-keys", Fclear_this_command_keys
,
9964 Sclear_this_command_keys
, 0, 1, 0,
9965 doc
: /* Clear out the vector that `this-command-keys' returns.
9966 Also clear the record of the last 100 events, unless optional arg
9967 KEEP-RECORD is non-nil. */)
9968 (Lisp_Object keep_record
)
9972 this_command_key_count
= 0;
9974 if (NILP (keep_record
))
9976 for (i
= 0; i
< ASIZE (recent_keys
); ++i
)
9977 ASET (recent_keys
, i
, Qnil
);
9979 recent_keys_index
= 0;
9984 DEFUN ("recursion-depth", Frecursion_depth
, Srecursion_depth
, 0, 0, 0,
9985 doc
: /* Return the current depth in recursive edits. */)
9989 /* Wrap around reliably on integer overflow. */
9990 EMACS_INT sum
= (command_loop_level
& INTMASK
) + (minibuf_level
& INTMASK
);
9991 XSETINT (temp
, sum
);
9995 DEFUN ("open-dribble-file", Fopen_dribble_file
, Sopen_dribble_file
, 1, 1,
9996 "FOpen dribble file: ",
9997 doc
: /* Start writing all keyboard characters to a dribble file called FILE.
9998 If FILE is nil, close any open dribble file.
9999 The file will be closed when Emacs exits.
10001 Be aware that this records ALL characters you type!
10002 This may include sensitive information such as passwords. */)
10015 Lisp_Object encfile
;
10017 file
= Fexpand_file_name (file
, Qnil
);
10018 encfile
= ENCODE_FILE (file
);
10019 fd
= emacs_open (SSDATA (encfile
), O_WRONLY
| O_CREAT
| O_EXCL
, 0600);
10020 if (fd
< 0 && errno
== EEXIST
&& unlink (SSDATA (encfile
)) == 0)
10021 fd
= emacs_open (SSDATA (encfile
), O_WRONLY
| O_CREAT
| O_EXCL
, 0600);
10022 dribble
= fd
< 0 ? 0 : fdopen (fd
, "w");
10024 report_file_error ("Opening dribble", file
);
10029 DEFUN ("discard-input", Fdiscard_input
, Sdiscard_input
, 0, 0, 0,
10030 doc
: /* Discard the contents of the terminal input buffer.
10031 Also end any kbd macro being defined. */)
10034 if (!NILP (KVAR (current_kboard
, defining_kbd_macro
)))
10036 /* Discard the last command from the macro. */
10037 Fcancel_kbd_macro_events ();
10041 Vunread_command_events
= Qnil
;
10043 discard_tty_input ();
10045 kbd_fetch_ptr
= kbd_store_ptr
;
10046 input_pending
= false;
10051 DEFUN ("suspend-emacs", Fsuspend_emacs
, Ssuspend_emacs
, 0, 1, "",
10052 doc
: /* Stop Emacs and return to superior process. You can resume later.
10053 If `cannot-suspend' is non-nil, or if the system doesn't support job
10054 control, run a subshell instead.
10056 If optional arg STUFFSTRING is non-nil, its characters are stuffed
10057 to be read as terminal input by Emacs's parent, after suspension.
10059 Before suspending, run the normal hook `suspend-hook'.
10060 After resumption run the normal hook `suspend-resume-hook'.
10062 Some operating systems cannot stop the Emacs process and resume it later.
10063 On such systems, Emacs starts a subshell instead of suspending. */)
10064 (Lisp_Object stuffstring
)
10066 ptrdiff_t count
= SPECPDL_INDEX ();
10067 int old_height
, old_width
;
10070 if (tty_list
&& tty_list
->next
)
10071 error ("There are other tty frames open; close them before suspending Emacs");
10073 if (!NILP (stuffstring
))
10074 CHECK_STRING (stuffstring
);
10076 run_hook (intern ("suspend-hook"));
10078 get_tty_size (fileno (CURTTY ()->input
), &old_width
, &old_height
);
10079 reset_all_sys_modes ();
10080 /* sys_suspend can get an error if it tries to fork a subshell
10081 and the system resources aren't available for that. */
10082 record_unwind_protect_void (init_all_sys_modes
);
10083 stuff_buffered_input (stuffstring
);
10084 if (cannot_suspend
)
10088 unbind_to (count
, Qnil
);
10090 /* Check if terminal/window size has changed.
10091 Note that this is not useful when we are running directly
10092 with a window system; but suspend should be disabled in that case. */
10093 get_tty_size (fileno (CURTTY ()->input
), &width
, &height
);
10094 if (width
!= old_width
|| height
!= old_height
)
10095 change_frame_size (SELECTED_FRAME (), width
,
10096 height
- FRAME_MENU_BAR_LINES (SELECTED_FRAME ()),
10099 run_hook (intern ("suspend-resume-hook"));
10104 /* If STUFFSTRING is a string, stuff its contents as pending terminal input.
10105 Then in any case stuff anything Emacs has read ahead and not used. */
10108 stuff_buffered_input (Lisp_Object stuffstring
)
10110 #ifdef SIGTSTP /* stuff_char is defined if SIGTSTP. */
10111 register unsigned char *p
;
10113 if (STRINGP (stuffstring
))
10115 register ptrdiff_t count
;
10117 p
= SDATA (stuffstring
);
10118 count
= SBYTES (stuffstring
);
10119 while (count
-- > 0)
10124 /* Anything we have read ahead, put back for the shell to read. */
10125 /* ?? What should this do when we have multiple keyboards??
10126 Should we ignore anything that was typed in at the "wrong" kboard?
10128 rms: we should stuff everything back into the kboard
10130 for (; kbd_fetch_ptr
!= kbd_store_ptr
; kbd_fetch_ptr
++)
10133 if (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
10134 kbd_fetch_ptr
= kbd_buffer
;
10135 if (kbd_fetch_ptr
->kind
== ASCII_KEYSTROKE_EVENT
)
10136 stuff_char (kbd_fetch_ptr
->ie
.code
);
10138 clear_event (kbd_fetch_ptr
);
10141 input_pending
= false;
10142 #endif /* SIGTSTP */
10146 set_waiting_for_input (struct timespec
*time_to_clear
)
10148 input_available_clear_time
= time_to_clear
;
10150 /* Tell handle_interrupt to throw back to read_char, */
10151 waiting_for_input
= true;
10153 /* If handle_interrupt was called before and buffered a C-g,
10154 make it run again now, to avoid timing error. */
10155 if (!NILP (Vquit_flag
))
10156 quit_throw_to_read_char (0);
10160 clear_waiting_for_input (void)
10162 /* Tell handle_interrupt not to throw back to read_char, */
10163 waiting_for_input
= false;
10164 input_available_clear_time
= 0;
10167 /* The SIGINT handler.
10169 If we have a frame on the controlling tty, we assume that the
10170 SIGINT was generated by C-g, so we call handle_interrupt.
10171 Otherwise, tell QUIT to kill Emacs. */
10174 handle_interrupt_signal (int sig
)
10176 /* See if we have an active terminal on our controlling tty. */
10177 struct terminal
*terminal
= get_named_terminal ("/dev/tty");
10180 /* If there are no frames there, let's pretend that we are a
10181 well-behaving UN*X program and quit. We must not call Lisp
10182 in a signal handler, so tell QUIT to exit when it is
10184 Vquit_flag
= Qkill_emacs
;
10188 /* Otherwise, the SIGINT was probably generated by C-g. */
10190 /* Set internal_last_event_frame to the top frame of the
10191 controlling tty, if we have a frame there. We disable the
10192 interrupt key on secondary ttys, so the SIGINT must have come
10193 from the controlling tty. */
10194 internal_last_event_frame
= terminal
->display_info
.tty
->top_frame
;
10196 handle_interrupt (1);
10201 deliver_interrupt_signal (int sig
)
10203 deliver_process_signal (sig
, handle_interrupt_signal
);
10207 /* If Emacs is stuck because `inhibit-quit' is true, then keep track
10208 of the number of times C-g has been requested. If C-g is pressed
10209 enough times, then quit anyway. See bug#6585. */
10210 static int volatile force_quit_count
;
10212 /* This routine is called at interrupt level in response to C-g.
10214 It is called from the SIGINT handler or kbd_buffer_store_event.
10216 If `waiting_for_input' is non zero, then unless `echoing' is
10217 nonzero, immediately throw back to read_char.
10219 Otherwise it sets the Lisp variable quit-flag not-nil. This causes
10220 eval to throw, when it gets a chance. If quit-flag is already
10221 non-nil, it stops the job right away. */
10224 handle_interrupt (bool in_signal_handler
)
10230 /* XXX This code needs to be revised for multi-tty support. */
10231 if (!NILP (Vquit_flag
) && get_named_terminal ("/dev/tty"))
10233 if (! in_signal_handler
)
10235 /* If SIGINT isn't blocked, don't let us be interrupted by
10236 a SIGINT. It might be harmful due to non-reentrancy
10237 in I/O functions. */
10239 sigemptyset (&blocked
);
10240 sigaddset (&blocked
, SIGINT
);
10241 pthread_sigmask (SIG_BLOCK
, &blocked
, 0);
10245 reset_all_sys_modes ();
10249 * On systems which can suspend the current process and return to the original
10250 * shell, this command causes the user to end up back at the shell.
10251 * The "Auto-save" and "Abort" questions are not asked until
10252 * the user elects to return to emacs, at which point he can save the current
10253 * job and either dump core or continue.
10257 /* Perhaps should really fork an inferior shell?
10258 But that would not provide any way to get back
10259 to the original shell, ever. */
10260 printf ("No support for stopping a process on this operating system;\n");
10261 printf ("you can continue or abort.\n");
10262 #endif /* not SIGTSTP */
10264 /* We must remain inside the screen area when the internal terminal
10265 is used. Note that [Enter] is not echoed by dos. */
10266 cursor_to (SELECTED_FRAME (), 0, 0);
10268 /* It doesn't work to autosave while GC is in progress;
10269 the code used for auto-saving doesn't cope with the mark bit. */
10270 if (!gc_in_progress
)
10272 printf ("Auto-save? (y or n) ");
10274 if (((c
= getchar ()) & ~040) == 'Y')
10276 Fdo_auto_save (Qt
, Qnil
);
10278 printf ("\r\nAuto-save done");
10279 #else /* not MSDOS */
10280 printf ("Auto-save done\n");
10281 #endif /* not MSDOS */
10283 while (c
!= '\n') c
= getchar ();
10287 /* During GC, it must be safe to reenable quitting again. */
10288 Vinhibit_quit
= Qnil
;
10291 #endif /* not MSDOS */
10292 printf ("Garbage collection in progress; cannot auto-save now\r\n");
10293 printf ("but will instead do a real quit after garbage collection ends\r\n");
10298 printf ("\r\nAbort? (y or n) ");
10299 #else /* not MSDOS */
10300 printf ("Abort (and dump core)? (y or n) ");
10301 #endif /* not MSDOS */
10303 if (((c
= getchar ()) & ~040) == 'Y')
10305 while (c
!= '\n') c
= getchar ();
10307 printf ("\r\nContinuing...\r\n");
10308 #else /* not MSDOS */
10309 printf ("Continuing...\n");
10310 #endif /* not MSDOS */
10312 init_all_sys_modes ();
10316 /* If executing a function that wants to be interrupted out of
10317 and the user has not deferred quitting by binding `inhibit-quit'
10318 then quit right away. */
10319 if (immediate_quit
&& NILP (Vinhibit_quit
))
10321 struct gl_state_s saved
;
10323 immediate_quit
= false;
10324 pthread_sigmask (SIG_SETMASK
, &empty_mask
, 0);
10326 Fsignal (Qquit
, Qnil
);
10330 { /* Else request quit when it's safe. */
10331 int count
= NILP (Vquit_flag
) ? 1 : force_quit_count
+ 1;
10332 force_quit_count
= count
;
10335 immediate_quit
= true;
10336 Vinhibit_quit
= Qnil
;
10342 pthread_sigmask (SIG_SETMASK
, &empty_mask
, 0);
10344 /* TODO: The longjmp in this call throws the NS event loop integration off,
10345 and it seems to do fine without this. Probably some attention
10346 needs to be paid to the setting of waiting_for_input in
10347 wait_reading_process_output() under HAVE_NS because of the call
10348 to ns_select there (needed because otherwise events aren't picked up
10349 outside of polling since we don't get SIGIO like X and we don't have a
10350 separate event loop thread like W32. */
10352 if (waiting_for_input
&& !echoing
)
10353 quit_throw_to_read_char (in_signal_handler
);
10357 /* Handle a C-g by making read_char return C-g. */
10360 quit_throw_to_read_char (bool from_signal
)
10362 /* When not called from a signal handler it is safe to call
10364 if (!from_signal
&& EQ (Vquit_flag
, Qkill_emacs
))
10365 Fkill_emacs (Qnil
);
10367 /* Prevent another signal from doing this before we finish. */
10368 clear_waiting_for_input ();
10369 input_pending
= false;
10371 Vunread_command_events
= Qnil
;
10373 if (FRAMEP (internal_last_event_frame
)
10374 && !EQ (internal_last_event_frame
, selected_frame
))
10375 do_switch_frame (make_lispy_switch_frame (internal_last_event_frame
),
10378 sys_longjmp (getcjmp
, 1);
10381 DEFUN ("set-input-interrupt-mode", Fset_input_interrupt_mode
,
10382 Sset_input_interrupt_mode
, 1, 1, 0,
10383 doc
: /* Set interrupt mode of reading keyboard input.
10384 If INTERRUPT is non-nil, Emacs will use input interrupts;
10385 otherwise Emacs uses CBREAK mode.
10387 See also `current-input-mode'. */)
10388 (Lisp_Object interrupt
)
10390 bool new_interrupt_input
;
10391 #ifdef USABLE_SIGIO
10392 #ifdef HAVE_X_WINDOWS
10393 if (x_display_list
!= NULL
)
10395 /* When using X, don't give the user a real choice,
10396 because we haven't implemented the mechanisms to support it. */
10397 new_interrupt_input
= true;
10400 #endif /* HAVE_X_WINDOWS */
10401 new_interrupt_input
= !NILP (interrupt
);
10402 #else /* not USABLE_SIGIO */
10403 new_interrupt_input
= false;
10404 #endif /* not USABLE_SIGIO */
10406 if (new_interrupt_input
!= interrupt_input
)
10408 #ifdef POLL_FOR_INPUT
10412 /* this causes startup screen to be restored and messes with the mouse */
10413 reset_all_sys_modes ();
10414 interrupt_input
= new_interrupt_input
;
10415 init_all_sys_modes ();
10417 interrupt_input
= new_interrupt_input
;
10420 #ifdef POLL_FOR_INPUT
10421 poll_suppress_count
= 1;
10428 DEFUN ("set-output-flow-control", Fset_output_flow_control
, Sset_output_flow_control
, 1, 2, 0,
10429 doc
: /* Enable or disable ^S/^Q flow control for output to TERMINAL.
10430 If FLOW is non-nil, flow control is enabled and you cannot use C-s or
10431 C-q in key sequences.
10433 This setting only has an effect on tty terminals and only when
10434 Emacs reads input in CBREAK mode; see `set-input-interrupt-mode'.
10436 See also `current-input-mode'. */)
10437 (Lisp_Object flow
, Lisp_Object terminal
)
10439 struct terminal
*t
= decode_tty_terminal (terminal
);
10440 struct tty_display_info
*tty
;
10444 tty
= t
->display_info
.tty
;
10446 if (tty
->flow_control
!= !NILP (flow
))
10449 /* This causes startup screen to be restored and messes with the mouse. */
10450 reset_sys_modes (tty
);
10453 tty
->flow_control
= !NILP (flow
);
10456 init_sys_modes (tty
);
10462 DEFUN ("set-input-meta-mode", Fset_input_meta_mode
, Sset_input_meta_mode
, 1, 2, 0,
10463 doc
: /* Enable or disable 8-bit input on TERMINAL.
10464 If META is t, Emacs will accept 8-bit input, and interpret the 8th
10465 bit as the Meta modifier.
10467 If META is nil, Emacs will ignore the top bit, on the assumption it is
10470 Otherwise, Emacs will accept and pass through 8-bit input without
10471 specially interpreting the top bit.
10473 This setting only has an effect on tty terminal devices.
10475 Optional parameter TERMINAL specifies the tty terminal device to use.
10476 It may be a terminal object, a frame, or nil for the terminal used by
10477 the currently selected frame.
10479 See also `current-input-mode'. */)
10480 (Lisp_Object meta
, Lisp_Object terminal
)
10482 struct terminal
*t
= decode_tty_terminal (terminal
);
10483 struct tty_display_info
*tty
;
10488 tty
= t
->display_info
.tty
;
10492 else if (EQ (meta
, Qt
))
10497 if (tty
->meta_key
!= new_meta
)
10500 /* this causes startup screen to be restored and messes with the mouse */
10501 reset_sys_modes (tty
);
10504 tty
->meta_key
= new_meta
;
10507 init_sys_modes (tty
);
10513 DEFUN ("set-quit-char", Fset_quit_char
, Sset_quit_char
, 1, 1, 0,
10514 doc
: /* Specify character used for quitting.
10515 QUIT must be an ASCII character.
10517 This function only has an effect on the controlling tty of the Emacs
10520 See also `current-input-mode'. */)
10523 struct terminal
*t
= get_named_terminal ("/dev/tty");
10524 struct tty_display_info
*tty
;
10528 tty
= t
->display_info
.tty
;
10530 if (NILP (quit
) || !INTEGERP (quit
) || XINT (quit
) < 0 || XINT (quit
) > 0400)
10531 error ("QUIT must be an ASCII character");
10534 /* this causes startup screen to be restored and messes with the mouse */
10535 reset_sys_modes (tty
);
10538 /* Don't let this value be out of range. */
10539 quit_char
= XINT (quit
) & (tty
->meta_key
== 0 ? 0177 : 0377);
10542 init_sys_modes (tty
);
10548 DEFUN ("set-input-mode", Fset_input_mode
, Sset_input_mode
, 3, 4, 0,
10549 doc
: /* Set mode of reading keyboard input.
10550 First arg INTERRUPT non-nil means use input interrupts;
10551 nil means use CBREAK mode.
10552 Second arg FLOW non-nil means use ^S/^Q flow control for output to terminal
10553 (no effect except in CBREAK mode).
10554 Third arg META t means accept 8-bit input (for a Meta key).
10555 META nil means ignore the top bit, on the assumption it is parity.
10556 Otherwise, accept 8-bit input and don't use the top bit for Meta.
10557 Optional fourth arg QUIT if non-nil specifies character to use for quitting.
10558 See also `current-input-mode'. */)
10559 (Lisp_Object interrupt
, Lisp_Object flow
, Lisp_Object meta
, Lisp_Object quit
)
10561 Fset_input_interrupt_mode (interrupt
);
10562 Fset_output_flow_control (flow
, Qnil
);
10563 Fset_input_meta_mode (meta
, Qnil
);
10565 Fset_quit_char (quit
);
10569 DEFUN ("current-input-mode", Fcurrent_input_mode
, Scurrent_input_mode
, 0, 0, 0,
10570 doc
: /* Return information about the way Emacs currently reads keyboard input.
10571 The value is a list of the form (INTERRUPT FLOW META QUIT), where
10572 INTERRUPT is non-nil if Emacs is using interrupt-driven input; if
10573 nil, Emacs is using CBREAK mode.
10574 FLOW is non-nil if Emacs uses ^S/^Q flow control for output to the
10575 terminal; this does not apply if Emacs uses interrupt-driven input.
10576 META is t if accepting 8-bit input with 8th bit as Meta flag.
10577 META nil means ignoring the top bit, on the assumption it is parity.
10578 META is neither t nor nil if accepting 8-bit input and using
10579 all 8 bits as the character code.
10580 QUIT is the character Emacs currently uses to quit.
10581 The elements of this list correspond to the arguments of
10582 `set-input-mode'. */)
10585 struct frame
*sf
= XFRAME (selected_frame
);
10587 Lisp_Object interrupt
= interrupt_input
? Qt
: Qnil
;
10588 Lisp_Object flow
, meta
;
10589 if (FRAME_TERMCAP_P (sf
) || FRAME_MSDOS_P (sf
))
10591 flow
= FRAME_TTY (sf
)->flow_control
? Qt
: Qnil
;
10592 meta
= (FRAME_TTY (sf
)->meta_key
== 2
10594 : (CURTTY ()->meta_key
== 1 ? Qt
: Qnil
));
10601 Lisp_Object quit
= make_number (quit_char
);
10603 return list4 (interrupt
, flow
, meta
, quit
);
10606 DEFUN ("posn-at-x-y", Fposn_at_x_y
, Sposn_at_x_y
, 2, 4, 0,
10607 doc
: /* Return position information for pixel coordinates X and Y.
10608 By default, X and Y are relative to text area of the selected window.
10609 Optional third arg FRAME-OR-WINDOW non-nil specifies frame or window.
10610 If optional fourth arg WHOLE is non-nil, X is relative to the left
10611 edge of the window.
10613 The return value is similar to a mouse click position:
10614 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
10615 IMAGE (DX . DY) (WIDTH . HEIGHT))
10616 The `posn-' functions access elements of such lists. */)
10617 (Lisp_Object x
, Lisp_Object y
, Lisp_Object frame_or_window
, Lisp_Object whole
)
10620 /* We allow X of -1, for the newline in a R2L line that overflowed
10621 into the left fringe. */
10622 if (XINT (x
) != -1)
10626 if (NILP (frame_or_window
))
10627 frame_or_window
= selected_window
;
10629 if (WINDOWP (frame_or_window
))
10631 struct window
*w
= decode_live_window (frame_or_window
);
10633 XSETINT (x
, (XINT (x
)
10634 + WINDOW_LEFT_EDGE_X (w
)
10636 ? window_box_left_offset (w
, TEXT_AREA
)
10638 XSETINT (y
, WINDOW_TO_FRAME_PIXEL_Y (w
, XINT (y
)));
10639 frame_or_window
= w
->frame
;
10642 CHECK_LIVE_FRAME (frame_or_window
);
10644 return make_lispy_position (XFRAME (frame_or_window
), x
, y
, 0);
10647 DEFUN ("posn-at-point", Fposn_at_point
, Sposn_at_point
, 0, 2, 0,
10648 doc
: /* Return position information for buffer POS in WINDOW.
10649 POS defaults to point in WINDOW; WINDOW defaults to the selected window.
10651 Return nil if position is not visible in window. Otherwise,
10652 the return value is similar to that returned by `event-start' for
10653 a mouse click at the upper left corner of the glyph corresponding
10654 to the given buffer position:
10655 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
10656 IMAGE (DX . DY) (WIDTH . HEIGHT))
10657 The `posn-' functions access elements of such lists. */)
10658 (Lisp_Object pos
, Lisp_Object window
)
10663 window
= selected_window
;
10665 tem
= Fpos_visible_in_window_p (pos
, window
, Qt
);
10668 Lisp_Object x
= XCAR (tem
);
10669 Lisp_Object y
= XCAR (XCDR (tem
));
10671 /* Point invisible due to hscrolling? X can be -1 when a
10672 newline in a R2L line overflows into the left fringe. */
10675 tem
= Fposn_at_x_y (x
, y
, window
, Qnil
);
10681 /* Set up a new kboard object with reasonable initial values.
10682 TYPE is a window system for which this keyboard is used. */
10685 init_kboard (KBOARD
*kb
, Lisp_Object type
)
10687 kset_overriding_terminal_local_map (kb
, Qnil
);
10688 kset_last_command (kb
, Qnil
);
10689 kset_real_last_command (kb
, Qnil
);
10690 kset_keyboard_translate_table (kb
, Qnil
);
10691 kset_last_repeatable_command (kb
, Qnil
);
10692 kset_prefix_arg (kb
, Qnil
);
10693 kset_last_prefix_arg (kb
, Qnil
);
10694 kset_kbd_queue (kb
, Qnil
);
10695 kb
->kbd_queue_has_data
= false;
10696 kb
->immediate_echo
= false;
10697 kset_echo_string (kb
, Qnil
);
10698 kb
->echo_after_prompt
= -1;
10699 kb
->kbd_macro_buffer
= 0;
10700 kb
->kbd_macro_bufsize
= 0;
10701 kset_defining_kbd_macro (kb
, Qnil
);
10702 kset_last_kbd_macro (kb
, Qnil
);
10703 kb
->reference_count
= 0;
10704 kset_system_key_alist (kb
, Qnil
);
10705 kset_system_key_syms (kb
, Qnil
);
10706 kset_window_system (kb
, type
);
10707 kset_input_decode_map (kb
, Fmake_sparse_keymap (Qnil
));
10708 kset_local_function_key_map (kb
, Fmake_sparse_keymap (Qnil
));
10709 Fset_keymap_parent (KVAR (kb
, Vlocal_function_key_map
), Vfunction_key_map
);
10710 kset_default_minibuffer_frame (kb
, Qnil
);
10713 /* Allocate and basically initialize keyboard
10714 object to use with window system TYPE. */
10717 allocate_kboard (Lisp_Object type
)
10719 KBOARD
*kb
= xmalloc (sizeof *kb
);
10721 init_kboard (kb
, type
);
10722 kb
->next_kboard
= all_kboards
;
10728 * Destroy the contents of a kboard object, but not the object itself.
10729 * We use this just before deleting it, or if we're going to initialize
10730 * it a second time.
10733 wipe_kboard (KBOARD
*kb
)
10735 xfree (kb
->kbd_macro_buffer
);
10738 /* Free KB and memory referenced from it. */
10741 delete_kboard (KBOARD
*kb
)
10745 for (kbp
= &all_kboards
; *kbp
!= kb
; kbp
= &(*kbp
)->next_kboard
)
10748 *kbp
= kb
->next_kboard
;
10750 /* Prevent a dangling reference to KB. */
10751 if (kb
== current_kboard
10752 && FRAMEP (selected_frame
)
10753 && FRAME_LIVE_P (XFRAME (selected_frame
)))
10755 current_kboard
= FRAME_KBOARD (XFRAME (selected_frame
));
10756 single_kboard
= false;
10757 if (current_kboard
== kb
)
10766 init_keyboard (void)
10768 /* This is correct before outermost invocation of the editor loop. */
10769 command_loop_level
= -1;
10770 immediate_quit
= false;
10771 quit_char
= Ctl ('g');
10772 Vunread_command_events
= Qnil
;
10773 timer_idleness_start_time
= invalid_timespec ();
10775 recent_keys_index
= 0;
10776 kbd_fetch_ptr
= kbd_buffer
;
10777 kbd_store_ptr
= kbd_buffer
;
10778 do_mouse_tracking
= Qnil
;
10779 input_pending
= false;
10780 interrupt_input_blocked
= 0;
10781 pending_signals
= false;
10783 /* This means that command_loop_1 won't try to select anything the first
10785 internal_last_event_frame
= Qnil
;
10786 Vlast_event_frame
= internal_last_event_frame
;
10788 current_kboard
= initial_kboard
;
10789 /* Re-initialize the keyboard again. */
10790 wipe_kboard (current_kboard
);
10791 /* A value of nil for Vwindow_system normally means a tty, but we also use
10792 it for the initial terminal since there is no window system there. */
10793 init_kboard (current_kboard
, Qnil
);
10795 if (!noninteractive
)
10797 /* Before multi-tty support, these handlers used to be installed
10798 only if the current session was a tty session. Now an Emacs
10799 session may have multiple display types, so we always handle
10800 SIGINT. There is special code in handle_interrupt_signal to exit
10801 Emacs on SIGINT when there are no termcap frames on the
10802 controlling terminal. */
10803 struct sigaction action
;
10804 emacs_sigaction_init (&action
, deliver_interrupt_signal
);
10805 sigaction (SIGINT
, &action
, 0);
10807 /* For systems with SysV TERMIO, C-g is set up for both SIGINT and
10808 SIGQUIT and we can't tell which one it will give us. */
10809 sigaction (SIGQUIT
, &action
, 0);
10810 #endif /* not DOS_NT */
10812 #ifdef USABLE_SIGIO
10813 if (!noninteractive
)
10815 struct sigaction action
;
10816 emacs_sigaction_init (&action
, deliver_input_available_signal
);
10817 sigaction (SIGIO
, &action
, 0);
10821 /* Use interrupt input by default, if it works and noninterrupt input
10822 has deficiencies. */
10824 #ifdef INTERRUPT_INPUT
10825 interrupt_input
= 1;
10827 interrupt_input
= 0;
10830 pthread_sigmask (SIG_SETMASK
, &empty_mask
, 0);
10833 if (keyboard_init_hook
)
10834 (*keyboard_init_hook
) ();
10836 #ifdef POLL_FOR_INPUT
10838 poll_suppress_count
= 1;
10843 /* This type's only use is in syms_of_keyboard, to put properties on the
10844 event header symbols. */
10851 static const struct event_head head_table
[] = {
10852 {SYMBOL_INDEX (Qmouse_movement
), SYMBOL_INDEX (Qmouse_movement
)},
10853 {SYMBOL_INDEX (Qscroll_bar_movement
), SYMBOL_INDEX (Qmouse_movement
)},
10855 /* Some of the event heads. */
10856 {SYMBOL_INDEX (Qswitch_frame
), SYMBOL_INDEX (Qswitch_frame
)},
10858 {SYMBOL_INDEX (Qfocus_in
), SYMBOL_INDEX (Qfocus_in
)},
10859 {SYMBOL_INDEX (Qfocus_out
), SYMBOL_INDEX (Qfocus_out
)},
10860 {SYMBOL_INDEX (Qdelete_frame
), SYMBOL_INDEX (Qdelete_frame
)},
10861 {SYMBOL_INDEX (Qiconify_frame
), SYMBOL_INDEX (Qiconify_frame
)},
10862 {SYMBOL_INDEX (Qmake_frame_visible
), SYMBOL_INDEX (Qmake_frame_visible
)},
10863 /* `select-window' should be handled just like `switch-frame'
10864 in read_key_sequence. */
10865 {SYMBOL_INDEX (Qselect_window
), SYMBOL_INDEX (Qswitch_frame
)}
10869 syms_of_keyboard (void)
10871 pending_funcalls
= Qnil
;
10872 staticpro (&pending_funcalls
);
10874 Vlispy_mouse_stem
= build_pure_c_string ("mouse");
10875 staticpro (&Vlispy_mouse_stem
);
10877 regular_top_level_message
= build_pure_c_string ("Back to top level");
10878 #ifdef HAVE_STACK_OVERFLOW_HANDLING
10879 recover_top_level_message
10880 = build_pure_c_string ("Re-entering top level after C stack overflow");
10882 DEFVAR_LISP ("internal--top-level-message", Vinternal__top_level_message
,
10883 doc
: /* Message displayed by `normal-top-level'. */);
10884 Vinternal__top_level_message
= regular_top_level_message
;
10887 DEFSYM (QCimage
, ":image");
10888 DEFSYM (Qhelp_echo
, "help-echo");
10889 DEFSYM (QCrtl
, ":rtl");
10891 staticpro (&item_properties
);
10892 item_properties
= Qnil
;
10894 staticpro (&tool_bar_item_properties
);
10895 tool_bar_item_properties
= Qnil
;
10896 staticpro (&tool_bar_items_vector
);
10897 tool_bar_items_vector
= Qnil
;
10899 DEFSYM (Qtimer_event_handler
, "timer-event-handler");
10901 /* Non-nil disable property on a command means do not execute it;
10902 call disabled-command-function's value instead. */
10903 DEFSYM (Qdisabled
, "disabled");
10905 DEFSYM (Qundefined
, "undefined");
10907 /* Hooks to run before and after each command. */
10908 DEFSYM (Qpre_command_hook
, "pre-command-hook");
10909 DEFSYM (Qpost_command_hook
, "post-command-hook");
10911 DEFSYM (Qdeferred_action_function
, "deferred-action-function");
10912 DEFSYM (Qdelayed_warnings_hook
, "delayed-warnings-hook");
10913 DEFSYM (Qfunction_key
, "function-key");
10915 /* The values of Qevent_kind properties. */
10916 DEFSYM (Qmouse_click
, "mouse-click");
10918 DEFSYM (Qdrag_n_drop
, "drag-n-drop");
10919 DEFSYM (Qsave_session
, "save-session");
10920 DEFSYM (Qconfig_changed_event
, "config-changed-event");
10922 /* Menu and tool bar item parts. */
10923 DEFSYM (Qmenu_enable
, "menu-enable");
10926 DEFSYM (Qlanguage_change
, "language-change");
10930 DEFSYM (Qdbus_event
, "dbus-event");
10933 #ifdef USE_FILE_NOTIFY
10934 DEFSYM (Qfile_notify
, "file-notify");
10935 #endif /* USE_FILE_NOTIFY */
10937 /* Menu and tool bar item parts. */
10938 DEFSYM (QCenable
, ":enable");
10939 DEFSYM (QCvisible
, ":visible");
10940 DEFSYM (QChelp
, ":help");
10941 DEFSYM (QCfilter
, ":filter");
10942 DEFSYM (QCbutton
, ":button");
10943 DEFSYM (QCkeys
, ":keys");
10944 DEFSYM (QCkey_sequence
, ":key-sequence");
10946 /* Non-nil disable property on a command means
10947 do not execute it; call disabled-command-function's value instead. */
10948 DEFSYM (QCtoggle
, ":toggle");
10949 DEFSYM (QCradio
, ":radio");
10950 DEFSYM (QClabel
, ":label");
10951 DEFSYM (QCvert_only
, ":vert-only");
10953 /* Symbols to use for parts of windows. */
10954 DEFSYM (Qvertical_line
, "vertical-line");
10955 DEFSYM (Qright_divider
, "right-divider");
10956 DEFSYM (Qbottom_divider
, "bottom-divider");
10958 DEFSYM (Qmouse_fixup_help_message
, "mouse-fixup-help-message");
10960 DEFSYM (Qabove_handle
, "above-handle");
10961 DEFSYM (Qhandle
, "handle");
10962 DEFSYM (Qbelow_handle
, "below-handle");
10963 DEFSYM (Qup
, "up");
10964 DEFSYM (Qdown
, "down");
10965 DEFSYM (Qtop
, "top");
10966 DEFSYM (Qbottom
, "bottom");
10967 DEFSYM (Qend_scroll
, "end-scroll");
10968 DEFSYM (Qratio
, "ratio");
10969 DEFSYM (Qbefore_handle
, "before-handle");
10970 DEFSYM (Qhorizontal_handle
, "horizontal-handle");
10971 DEFSYM (Qafter_handle
, "after-handle");
10972 DEFSYM (Qleft
, "left");
10973 DEFSYM (Qright
, "right");
10974 DEFSYM (Qleftmost
, "leftmost");
10975 DEFSYM (Qrightmost
, "rightmost");
10977 /* Properties of event headers. */
10978 DEFSYM (Qevent_kind
, "event-kind");
10979 DEFSYM (Qevent_symbol_elements
, "event-symbol-elements");
10981 /* An event header symbol HEAD may have a property named
10982 Qevent_symbol_element_mask, which is of the form (BASE MODIFIERS);
10983 BASE is the base, unmodified version of HEAD, and MODIFIERS is the
10984 mask of modifiers applied to it. If present, this is used to help
10985 speed up parse_modifiers. */
10986 DEFSYM (Qevent_symbol_element_mask
, "event-symbol-element-mask");
10988 /* An unmodified event header BASE may have a property named
10989 Qmodifier_cache, which is an alist mapping modifier masks onto
10990 modified versions of BASE. If present, this helps speed up
10991 apply_modifiers. */
10992 DEFSYM (Qmodifier_cache
, "modifier-cache");
10994 DEFSYM (Qrecompute_lucid_menubar
, "recompute-lucid-menubar");
10995 DEFSYM (Qactivate_menubar_hook
, "activate-menubar-hook");
10997 DEFSYM (Qpolling_period
, "polling-period");
10999 DEFSYM (Qgui_set_selection
, "gui-set-selection");
11001 /* The primary selection. */
11002 DEFSYM (QPRIMARY
, "PRIMARY");
11004 DEFSYM (Qhandle_switch_frame
, "handle-switch-frame");
11005 DEFSYM (Qhandle_select_window
, "handle-select-window");
11007 DEFSYM (Qinput_method_exit_on_first_char
, "input-method-exit-on-first-char");
11008 DEFSYM (Qinput_method_use_echo_area
, "input-method-use-echo-area");
11010 DEFSYM (Qhelp_form_show
, "help-form-show");
11012 DEFSYM (Qecho_keystrokes
, "echo-keystrokes");
11014 Fset (Qinput_method_exit_on_first_char
, Qnil
);
11015 Fset (Qinput_method_use_echo_area
, Qnil
);
11017 /* Symbols to head events. */
11018 DEFSYM (Qmouse_movement
, "mouse-movement");
11019 DEFSYM (Qscroll_bar_movement
, "scroll-bar-movement");
11020 DEFSYM (Qswitch_frame
, "switch-frame");
11021 DEFSYM (Qfocus_in
, "focus-in");
11022 DEFSYM (Qfocus_out
, "focus-out");
11023 DEFSYM (Qdelete_frame
, "delete-frame");
11024 DEFSYM (Qiconify_frame
, "iconify-frame");
11025 DEFSYM (Qmake_frame_visible
, "make-frame-visible");
11026 DEFSYM (Qselect_window
, "select-window");
11030 for (i
= 0; i
< ARRAYELTS (head_table
); i
++)
11032 const struct event_head
*p
= &head_table
[i
];
11033 Lisp_Object var
= builtin_lisp_symbol (p
->var
);
11034 Lisp_Object kind
= builtin_lisp_symbol (p
->kind
);
11035 Fput (var
, Qevent_kind
, kind
);
11036 Fput (var
, Qevent_symbol_elements
, list1 (var
));
11040 button_down_location
= Fmake_vector (make_number (5), Qnil
);
11041 staticpro (&button_down_location
);
11042 mouse_syms
= Fmake_vector (make_number (5), Qnil
);
11043 staticpro (&mouse_syms
);
11044 wheel_syms
= Fmake_vector (make_number (ARRAYELTS (lispy_wheel_names
)),
11046 staticpro (&wheel_syms
);
11050 int len
= ARRAYELTS (modifier_names
);
11052 modifier_symbols
= Fmake_vector (make_number (len
), Qnil
);
11053 for (i
= 0; i
< len
; i
++)
11054 if (modifier_names
[i
])
11055 ASET (modifier_symbols
, i
, intern_c_string (modifier_names
[i
]));
11056 staticpro (&modifier_symbols
);
11059 recent_keys
= Fmake_vector (make_number (NUM_RECENT_KEYS
), Qnil
);
11060 staticpro (&recent_keys
);
11062 this_command_keys
= Fmake_vector (make_number (40), Qnil
);
11063 staticpro (&this_command_keys
);
11065 raw_keybuf
= Fmake_vector (make_number (30), Qnil
);
11066 staticpro (&raw_keybuf
);
11068 DEFSYM (Qcommand_execute
, "command-execute");
11069 DEFSYM (Qinternal_echo_keystrokes_prefix
, "internal-echo-keystrokes-prefix");
11071 accent_key_syms
= Qnil
;
11072 staticpro (&accent_key_syms
);
11074 func_key_syms
= Qnil
;
11075 staticpro (&func_key_syms
);
11077 drag_n_drop_syms
= Qnil
;
11078 staticpro (&drag_n_drop_syms
);
11080 unread_switch_frame
= Qnil
;
11081 staticpro (&unread_switch_frame
);
11083 internal_last_event_frame
= Qnil
;
11084 staticpro (&internal_last_event_frame
);
11086 read_key_sequence_cmd
= Qnil
;
11087 staticpro (&read_key_sequence_cmd
);
11088 read_key_sequence_remapped
= Qnil
;
11089 staticpro (&read_key_sequence_remapped
);
11091 menu_bar_one_keymap_changed_items
= Qnil
;
11092 staticpro (&menu_bar_one_keymap_changed_items
);
11094 menu_bar_items_vector
= Qnil
;
11095 staticpro (&menu_bar_items_vector
);
11097 help_form_saved_window_configs
= Qnil
;
11098 staticpro (&help_form_saved_window_configs
);
11100 defsubr (&Scurrent_idle_time
);
11101 defsubr (&Sevent_symbol_parse_modifiers
);
11102 defsubr (&Sevent_convert_list
);
11103 defsubr (&Sread_key_sequence
);
11104 defsubr (&Sread_key_sequence_vector
);
11105 defsubr (&Srecursive_edit
);
11106 defsubr (&Strack_mouse
);
11107 defsubr (&Sinput_pending_p
);
11108 defsubr (&Srecent_keys
);
11109 defsubr (&Sthis_command_keys
);
11110 defsubr (&Sthis_command_keys_vector
);
11111 defsubr (&Sthis_single_command_keys
);
11112 defsubr (&Sthis_single_command_raw_keys
);
11113 defsubr (&Sclear_this_command_keys
);
11114 defsubr (&Ssuspend_emacs
);
11115 defsubr (&Sabort_recursive_edit
);
11116 defsubr (&Sexit_recursive_edit
);
11117 defsubr (&Srecursion_depth
);
11118 defsubr (&Scommand_error_default_function
);
11119 defsubr (&Stop_level
);
11120 defsubr (&Sdiscard_input
);
11121 defsubr (&Sopen_dribble_file
);
11122 defsubr (&Sset_input_interrupt_mode
);
11123 defsubr (&Sset_output_flow_control
);
11124 defsubr (&Sset_input_meta_mode
);
11125 defsubr (&Sset_quit_char
);
11126 defsubr (&Sset_input_mode
);
11127 defsubr (&Scurrent_input_mode
);
11128 defsubr (&Sposn_at_point
);
11129 defsubr (&Sposn_at_x_y
);
11131 DEFVAR_LISP ("last-command-event", last_command_event
,
11132 doc
: /* Last input event that was part of a command. */);
11134 DEFVAR_LISP ("last-nonmenu-event", last_nonmenu_event
,
11135 doc
: /* Last input event in a command, except for mouse menu events.
11136 Mouse menus give back keys that don't look like mouse events;
11137 this variable holds the actual mouse event that led to the menu,
11138 so that you can determine whether the command was run by mouse or not. */);
11140 DEFVAR_LISP ("last-input-event", last_input_event
,
11141 doc
: /* Last input event. */);
11143 DEFVAR_LISP ("unread-command-events", Vunread_command_events
,
11144 doc
: /* List of events to be read as the command input.
11145 These events are processed first, before actual keyboard input.
11146 Events read from this list are not normally added to `this-command-keys',
11147 as they will already have been added once as they were read for the first time.
11148 An element of the form (t . EVENT) forces EVENT to be added to that list. */);
11149 Vunread_command_events
= Qnil
;
11151 DEFVAR_LISP ("unread-post-input-method-events", Vunread_post_input_method_events
,
11152 doc
: /* List of events to be processed as input by input methods.
11153 These events are processed before `unread-command-events'
11154 and actual keyboard input, but are not given to `input-method-function'. */);
11155 Vunread_post_input_method_events
= Qnil
;
11157 DEFVAR_LISP ("unread-input-method-events", Vunread_input_method_events
,
11158 doc
: /* List of events to be processed as input by input methods.
11159 These events are processed after `unread-command-events', but
11160 before actual keyboard input.
11161 If there's an active input method, the events are given to
11162 `input-method-function'. */);
11163 Vunread_input_method_events
= Qnil
;
11165 DEFVAR_LISP ("meta-prefix-char", meta_prefix_char
,
11166 doc
: /* Meta-prefix character code.
11167 Meta-foo as command input turns into this character followed by foo. */);
11168 XSETINT (meta_prefix_char
, 033);
11170 DEFVAR_KBOARD ("last-command", Vlast_command
,
11171 doc
: /* The last command executed.
11172 Normally a symbol with a function definition, but can be whatever was found
11173 in the keymap, or whatever the variable `this-command' was set to by that
11176 The value `mode-exit' is special; it means that the previous command
11177 read an event that told it to exit, and it did so and unread that event.
11178 In other words, the present command is the event that made the previous
11181 The value `kill-region' is special; it means that the previous command
11182 was a kill command.
11184 `last-command' has a separate binding for each terminal device.
11185 See Info node `(elisp)Multiple Terminals'. */);
11187 DEFVAR_KBOARD ("real-last-command", Vreal_last_command
,
11188 doc
: /* Same as `last-command', but never altered by Lisp code.
11189 Taken from the previous value of `real-this-command'. */);
11191 DEFVAR_KBOARD ("last-repeatable-command", Vlast_repeatable_command
,
11192 doc
: /* Last command that may be repeated.
11193 The last command executed that was not bound to an input event.
11194 This is the command `repeat' will try to repeat.
11195 Taken from a previous value of `real-this-command'. */);
11197 DEFVAR_LISP ("this-command", Vthis_command
,
11198 doc
: /* The command now being executed.
11199 The command can set this variable; whatever is put here
11200 will be in `last-command' during the following command. */);
11201 Vthis_command
= Qnil
;
11203 DEFVAR_LISP ("real-this-command", Vreal_this_command
,
11204 doc
: /* This is like `this-command', except that commands should never modify it. */);
11205 Vreal_this_command
= Qnil
;
11207 DEFVAR_LISP ("this-command-keys-shift-translated",
11208 Vthis_command_keys_shift_translated
,
11209 doc
: /* Non-nil if the key sequence activating this command was shift-translated.
11210 Shift-translation occurs when there is no binding for the key sequence
11211 as entered, but a binding was found by changing an upper-case letter
11212 to lower-case, or a shifted function key to an unshifted one. */);
11213 Vthis_command_keys_shift_translated
= Qnil
;
11215 DEFVAR_LISP ("this-original-command", Vthis_original_command
,
11216 doc
: /* The command bound to the current key sequence before remapping.
11217 It equals `this-command' if the original command was not remapped through
11218 any of the active keymaps. Otherwise, the value of `this-command' is the
11219 result of looking up the original command in the active keymaps. */);
11220 Vthis_original_command
= Qnil
;
11222 DEFVAR_INT ("auto-save-interval", auto_save_interval
,
11223 doc
: /* Number of input events between auto-saves.
11224 Zero means disable autosaving due to number of characters typed. */);
11225 auto_save_interval
= 300;
11227 DEFVAR_LISP ("auto-save-timeout", Vauto_save_timeout
,
11228 doc
: /* Number of seconds idle time before auto-save.
11229 Zero or nil means disable auto-saving due to idleness.
11230 After auto-saving due to this many seconds of idle time,
11231 Emacs also does a garbage collection if that seems to be warranted. */);
11232 XSETFASTINT (Vauto_save_timeout
, 30);
11234 DEFVAR_LISP ("echo-keystrokes", Vecho_keystrokes
,
11235 doc
: /* Nonzero means echo unfinished commands after this many seconds of pause.
11236 The value may be integer or floating point.
11237 If the value is zero, don't echo at all. */);
11238 Vecho_keystrokes
= make_number (1);
11240 DEFVAR_INT ("polling-period", polling_period
,
11241 doc
: /* Interval between polling for input during Lisp execution.
11242 The reason for polling is to make C-g work to stop a running program.
11243 Polling is needed only when using X windows and SIGIO does not work.
11244 Polling is automatically disabled in all other cases. */);
11245 polling_period
= 2;
11247 DEFVAR_LISP ("double-click-time", Vdouble_click_time
,
11248 doc
: /* Maximum time between mouse clicks to make a double-click.
11249 Measured in milliseconds. The value nil means disable double-click
11250 recognition; t means double-clicks have no time limit and are detected
11251 by position only. */);
11252 Vdouble_click_time
= make_number (500);
11254 DEFVAR_INT ("double-click-fuzz", double_click_fuzz
,
11255 doc
: /* Maximum mouse movement between clicks to make a double-click.
11256 On window-system frames, value is the number of pixels the mouse may have
11257 moved horizontally or vertically between two clicks to make a double-click.
11258 On non window-system frames, value is interpreted in units of 1/8 characters
11261 This variable is also the threshold for motion of the mouse
11262 to count as a drag. */);
11263 double_click_fuzz
= 3;
11265 DEFVAR_INT ("num-input-keys", num_input_keys
,
11266 doc
: /* Number of complete key sequences read as input so far.
11267 This includes key sequences read from keyboard macros.
11268 The number is effectively the number of interactive command invocations. */);
11269 num_input_keys
= 0;
11271 DEFVAR_INT ("num-nonmacro-input-events", num_nonmacro_input_events
,
11272 doc
: /* Number of input events read from the keyboard so far.
11273 This does not include events generated by keyboard macros. */);
11274 num_nonmacro_input_events
= 0;
11276 DEFVAR_LISP ("last-event-frame", Vlast_event_frame
,
11277 doc
: /* The frame in which the most recently read event occurred.
11278 If the last event came from a keyboard macro, this is set to `macro'. */);
11279 Vlast_event_frame
= Qnil
;
11281 /* This variable is set up in sysdep.c. */
11282 DEFVAR_LISP ("tty-erase-char", Vtty_erase_char
,
11283 doc
: /* The ERASE character as set by the user with stty. */);
11285 DEFVAR_LISP ("help-char", Vhelp_char
,
11286 doc
: /* Character to recognize as meaning Help.
11287 When it is read, do `(eval help-form)', and display result if it's a string.
11288 If the value of `help-form' is nil, this char can be read normally. */);
11289 XSETINT (Vhelp_char
, Ctl ('H'));
11291 DEFVAR_LISP ("help-event-list", Vhelp_event_list
,
11292 doc
: /* List of input events to recognize as meaning Help.
11293 These work just like the value of `help-char' (see that). */);
11294 Vhelp_event_list
= Qnil
;
11296 DEFVAR_LISP ("help-form", Vhelp_form
,
11297 doc
: /* Form to execute when character `help-char' is read.
11298 If the form returns a string, that string is displayed.
11299 If `help-form' is nil, the help char is not recognized. */);
11302 DEFVAR_LISP ("prefix-help-command", Vprefix_help_command
,
11303 doc
: /* Command to run when `help-char' character follows a prefix key.
11304 This command is used only when there is no actual binding
11305 for that character after that prefix key. */);
11306 Vprefix_help_command
= Qnil
;
11308 DEFVAR_LISP ("top-level", Vtop_level
,
11309 doc
: /* Form to evaluate when Emacs starts up.
11310 Useful to set before you dump a modified Emacs. */);
11312 XSYMBOL (Qtop_level
)->declared_special
= false;
11314 DEFVAR_KBOARD ("keyboard-translate-table", Vkeyboard_translate_table
,
11315 doc
: /* Translate table for local keyboard input, or nil.
11316 If non-nil, the value should be a char-table. Each character read
11317 from the keyboard is looked up in this char-table. If the value found
11318 there is non-nil, then it is used instead of the actual input character.
11320 The value can also be a string or vector, but this is considered obsolete.
11321 If it is a string or vector of length N, character codes N and up are left
11322 untranslated. In a vector, an element which is nil means "no translation".
11324 This is applied to the characters supplied to input methods, not their
11325 output. See also `translation-table-for-input'.
11327 This variable has a separate binding for each terminal.
11328 See Info node `(elisp)Multiple Terminals'. */);
11330 DEFVAR_BOOL ("cannot-suspend", cannot_suspend
,
11331 doc
: /* Non-nil means to always spawn a subshell instead of suspending.
11332 \(Even if the operating system has support for stopping a process.\) */);
11333 cannot_suspend
= false;
11335 DEFVAR_BOOL ("menu-prompting", menu_prompting
,
11336 doc
: /* Non-nil means prompt with menus when appropriate.
11337 This is done when reading from a keymap that has a prompt string,
11338 for elements that have prompt strings.
11339 The menu is displayed on the screen
11340 if X menus were enabled at configuration
11341 time and the previous event was a mouse click prefix key.
11342 Otherwise, menu prompting uses the echo area. */);
11343 menu_prompting
= true;
11345 DEFVAR_LISP ("menu-prompt-more-char", menu_prompt_more_char
,
11346 doc
: /* Character to see next line of menu prompt.
11347 Type this character while in a menu prompt to rotate around the lines of it. */);
11348 XSETINT (menu_prompt_more_char
, ' ');
11350 DEFVAR_INT ("extra-keyboard-modifiers", extra_keyboard_modifiers
,
11351 doc
: /* A mask of additional modifier keys to use with every keyboard character.
11352 Emacs applies the modifiers of the character stored here to each keyboard
11353 character it reads. For example, after evaluating the expression
11354 (setq extra-keyboard-modifiers ?\\C-x)
11355 all input characters will have the control modifier applied to them.
11357 Note that the character ?\\C-@, equivalent to the integer zero, does
11358 not count as a control character; rather, it counts as a character
11359 with no modifiers; thus, setting `extra-keyboard-modifiers' to zero
11360 cancels any modification. */);
11361 extra_keyboard_modifiers
= 0;
11363 DEFSYM (Qdeactivate_mark
, "deactivate-mark");
11364 DEFVAR_LISP ("deactivate-mark", Vdeactivate_mark
,
11365 doc
: /* If an editing command sets this to t, deactivate the mark afterward.
11366 The command loop sets this to nil before each command,
11367 and tests the value when the command returns.
11368 Buffer modification stores t in this variable. */);
11369 Vdeactivate_mark
= Qnil
;
11370 Fmake_variable_buffer_local (Qdeactivate_mark
);
11372 DEFVAR_LISP ("pre-command-hook", Vpre_command_hook
,
11373 doc
: /* Normal hook run before each command is executed.
11374 If an unhandled error happens in running this hook,
11375 the function in which the error occurred is unconditionally removed, since
11376 otherwise the error might happen repeatedly and make Emacs nonfunctional. */);
11377 Vpre_command_hook
= Qnil
;
11379 DEFVAR_LISP ("post-command-hook", Vpost_command_hook
,
11380 doc
: /* Normal hook run after each command is executed.
11381 If an unhandled error happens in running this hook,
11382 the function in which the error occurred is unconditionally removed, since
11383 otherwise the error might happen repeatedly and make Emacs nonfunctional. */);
11384 Vpost_command_hook
= Qnil
;
11387 DEFVAR_LISP ("echo-area-clear-hook", ...,
11388 doc
: /* Normal hook run when clearing the echo area. */);
11390 DEFSYM (Qecho_area_clear_hook
, "echo-area-clear-hook");
11391 Fset (Qecho_area_clear_hook
, Qnil
);
11393 DEFVAR_LISP ("lucid-menu-bar-dirty-flag", Vlucid_menu_bar_dirty_flag
,
11394 doc
: /* Non-nil means menu bar, specified Lucid style, needs to be recomputed. */);
11395 Vlucid_menu_bar_dirty_flag
= Qnil
;
11397 DEFVAR_LISP ("menu-bar-final-items", Vmenu_bar_final_items
,
11398 doc
: /* List of menu bar items to move to the end of the menu bar.
11399 The elements of the list are event types that may have menu bar bindings. */);
11400 Vmenu_bar_final_items
= Qnil
;
11402 DEFVAR_LISP ("tool-bar-separator-image-expression", Vtool_bar_separator_image_expression
,
11403 doc
: /* Expression evaluating to the image spec for a tool-bar separator.
11404 This is used internally by graphical displays that do not render
11405 tool-bar separators natively. Otherwise it is unused (e.g. on GTK). */);
11406 Vtool_bar_separator_image_expression
= Qnil
;
11408 DEFVAR_KBOARD ("overriding-terminal-local-map",
11409 Voverriding_terminal_local_map
,
11410 doc
: /* Per-terminal keymap that takes precedence over all other keymaps.
11411 This variable is intended to let commands such as `universal-argument'
11412 set up a different keymap for reading the next command.
11414 `overriding-terminal-local-map' has a separate binding for each
11415 terminal device. See Info node `(elisp)Multiple Terminals'. */);
11417 DEFVAR_LISP ("overriding-local-map", Voverriding_local_map
,
11418 doc
: /* Keymap that replaces (overrides) local keymaps.
11419 If this variable is non-nil, Emacs looks up key bindings in this
11420 keymap INSTEAD OF the keymap char property, minor mode maps, and the
11421 buffer's local map. Hence, the only active keymaps would be
11422 `overriding-terminal-local-map', this keymap, and `global-keymap', in
11423 order of precedence. */);
11424 Voverriding_local_map
= Qnil
;
11426 DEFVAR_LISP ("overriding-local-map-menu-flag", Voverriding_local_map_menu_flag
,
11427 doc
: /* Non-nil means `overriding-local-map' applies to the menu bar.
11428 Otherwise, the menu bar continues to reflect the buffer's local map
11429 and the minor mode maps regardless of `overriding-local-map'. */);
11430 Voverriding_local_map_menu_flag
= Qnil
;
11432 DEFVAR_LISP ("special-event-map", Vspecial_event_map
,
11433 doc
: /* Keymap defining bindings for special events to execute at low level. */);
11434 Vspecial_event_map
= list1 (Qkeymap
);
11436 DEFVAR_LISP ("track-mouse", do_mouse_tracking
,
11437 doc
: /* Non-nil means generate motion events for mouse motion. */);
11439 DEFVAR_KBOARD ("system-key-alist", Vsystem_key_alist
,
11440 doc
: /* Alist of system-specific X windows key symbols.
11441 Each element should have the form (N . SYMBOL) where N is the
11442 numeric keysym code (sans the \"system-specific\" bit 1<<28)
11443 and SYMBOL is its name.
11445 `system-key-alist' has a separate binding for each terminal device.
11446 See Info node `(elisp)Multiple Terminals'. */);
11448 DEFVAR_KBOARD ("local-function-key-map", Vlocal_function_key_map
,
11449 doc
: /* Keymap that translates key sequences to key sequences during input.
11450 This is used mainly for mapping key sequences into some preferred
11451 key events (symbols).
11453 The `read-key-sequence' function replaces any subsequence bound by
11454 `local-function-key-map' with its binding. More precisely, when the
11455 active keymaps have no binding for the current key sequence but
11456 `local-function-key-map' binds a suffix of the sequence to a vector or
11457 string, `read-key-sequence' replaces the matching suffix with its
11458 binding, and continues with the new sequence.
11460 If the binding is a function, it is called with one argument (the prompt)
11461 and its return value (a key sequence) is used.
11463 The events that come from bindings in `local-function-key-map' are not
11464 themselves looked up in `local-function-key-map'.
11466 For example, suppose `local-function-key-map' binds `ESC O P' to [f1].
11467 Typing `ESC O P' to `read-key-sequence' would return [f1]. Typing
11468 `C-x ESC O P' would return [?\\C-x f1]. If [f1] were a prefix key,
11469 typing `ESC O P x' would return [f1 x].
11471 `local-function-key-map' has a separate binding for each terminal
11472 device. See Info node `(elisp)Multiple Terminals'. If you need to
11473 define a binding on all terminals, change `function-key-map'
11474 instead. Initially, `local-function-key-map' is an empty keymap that
11475 has `function-key-map' as its parent on all terminal devices. */);
11477 DEFVAR_KBOARD ("input-decode-map", Vinput_decode_map
,
11478 doc
: /* Keymap that decodes input escape sequences.
11479 This is used mainly for mapping ASCII function key sequences into
11480 real Emacs function key events (symbols).
11482 The `read-key-sequence' function replaces any subsequence bound by
11483 `input-decode-map' with its binding. Contrary to `function-key-map',
11484 this map applies its rebinding regardless of the presence of an ordinary
11485 binding. So it is more like `key-translation-map' except that it applies
11486 before `function-key-map' rather than after.
11488 If the binding is a function, it is called with one argument (the prompt)
11489 and its return value (a key sequence) is used.
11491 The events that come from bindings in `input-decode-map' are not
11492 themselves looked up in `input-decode-map'. */);
11494 DEFVAR_LISP ("function-key-map", Vfunction_key_map
,
11495 doc
: /* The parent keymap of all `local-function-key-map' instances.
11496 Function key definitions that apply to all terminal devices should go
11497 here. If a mapping is defined in both the current
11498 `local-function-key-map' binding and this variable, then the local
11499 definition will take precedence. */);
11500 Vfunction_key_map
= Fmake_sparse_keymap (Qnil
);
11502 DEFVAR_LISP ("key-translation-map", Vkey_translation_map
,
11503 doc
: /* Keymap of key translations that can override keymaps.
11504 This keymap works like `input-decode-map', but comes after `function-key-map'.
11505 Another difference is that it is global rather than terminal-local. */);
11506 Vkey_translation_map
= Fmake_sparse_keymap (Qnil
);
11508 DEFVAR_LISP ("deferred-action-list", Vdeferred_action_list
,
11509 doc
: /* List of deferred actions to be performed at a later time.
11510 The precise format isn't relevant here; we just check whether it is nil. */);
11511 Vdeferred_action_list
= Qnil
;
11513 DEFVAR_LISP ("deferred-action-function", Vdeferred_action_function
,
11514 doc
: /* Function to call to handle deferred actions, after each command.
11515 This function is called with no arguments after each command
11516 whenever `deferred-action-list' is non-nil. */);
11517 Vdeferred_action_function
= Qnil
;
11519 DEFVAR_LISP ("delayed-warnings-list", Vdelayed_warnings_list
,
11520 doc
: /* List of warnings to be displayed after this command.
11521 Each element must be a list (TYPE MESSAGE [LEVEL [BUFFER-NAME]]),
11522 as per the args of `display-warning' (which see).
11523 If this variable is non-nil, `delayed-warnings-hook' will be run
11524 immediately after running `post-command-hook'. */);
11525 Vdelayed_warnings_list
= Qnil
;
11527 DEFVAR_LISP ("timer-list", Vtimer_list
,
11528 doc
: /* List of active absolute time timers in order of increasing time. */);
11529 Vtimer_list
= Qnil
;
11531 DEFVAR_LISP ("timer-idle-list", Vtimer_idle_list
,
11532 doc
: /* List of active idle-time timers in order of increasing time. */);
11533 Vtimer_idle_list
= Qnil
;
11535 DEFVAR_LISP ("input-method-function", Vinput_method_function
,
11536 doc
: /* If non-nil, the function that implements the current input method.
11537 It's called with one argument, a printing character that was just read.
11538 \(That means a character with code 040...0176.)
11539 Typically this function uses `read-event' to read additional events.
11540 When it does so, it should first bind `input-method-function' to nil
11541 so it will not be called recursively.
11543 The function should return a list of zero or more events
11544 to be used as input. If it wants to put back some events
11545 to be reconsidered, separately, by the input method,
11546 it can add them to the beginning of `unread-command-events'.
11548 The input method function can find in `input-method-previous-message'
11549 the previous echo area message.
11551 The input method function should refer to the variables
11552 `input-method-use-echo-area' and `input-method-exit-on-first-char'
11553 for guidance on what to do. */);
11554 Vinput_method_function
= Qlist
;
11556 DEFVAR_LISP ("input-method-previous-message",
11557 Vinput_method_previous_message
,
11558 doc
: /* When `input-method-function' is called, hold the previous echo area message.
11559 This variable exists because `read-event' clears the echo area
11560 before running the input method. It is nil if there was no message. */);
11561 Vinput_method_previous_message
= Qnil
;
11563 DEFVAR_LISP ("show-help-function", Vshow_help_function
,
11564 doc
: /* If non-nil, the function that implements the display of help.
11565 It's called with one argument, the help string to display. */);
11566 Vshow_help_function
= Qnil
;
11568 DEFVAR_LISP ("disable-point-adjustment", Vdisable_point_adjustment
,
11569 doc
: /* If non-nil, suppress point adjustment after executing a command.
11571 After a command is executed, if point is moved into a region that has
11572 special properties (e.g. composition, display), we adjust point to
11573 the boundary of the region. But, when a command sets this variable to
11574 non-nil, we suppress the point adjustment.
11576 This variable is set to nil before reading a command, and is checked
11577 just after executing the command. */);
11578 Vdisable_point_adjustment
= Qnil
;
11580 DEFVAR_LISP ("global-disable-point-adjustment",
11581 Vglobal_disable_point_adjustment
,
11582 doc
: /* If non-nil, always suppress point adjustment.
11584 The default value is nil, in which case, point adjustment are
11585 suppressed only after special commands that set
11586 `disable-point-adjustment' (which see) to non-nil. */);
11587 Vglobal_disable_point_adjustment
= Qnil
;
11589 DEFVAR_LISP ("minibuffer-message-timeout", Vminibuffer_message_timeout
,
11590 doc
: /* How long to display an echo-area message when the minibuffer is active.
11591 If the value is not a number, such messages don't time out. */);
11592 Vminibuffer_message_timeout
= make_number (2);
11594 DEFVAR_LISP ("throw-on-input", Vthrow_on_input
,
11595 doc
: /* If non-nil, any keyboard input throws to this symbol.
11596 The value of that variable is passed to `quit-flag' and later causes a
11597 peculiar kind of quitting. */);
11598 Vthrow_on_input
= Qnil
;
11600 DEFVAR_LISP ("command-error-function", Vcommand_error_function
,
11601 doc
: /* Function to output error messages.
11602 Called with three arguments:
11603 - the error data, a list of the form (SIGNALED-CONDITION . SIGNAL-DATA)
11604 such as what `condition-case' would bind its variable to,
11605 - the context (a string which normally goes at the start of the message),
11606 - the Lisp function within which the error was signaled. */);
11607 Vcommand_error_function
= intern ("command-error-default-function");
11609 DEFVAR_LISP ("enable-disabled-menus-and-buttons",
11610 Venable_disabled_menus_and_buttons
,
11611 doc
: /* If non-nil, don't ignore events produced by disabled menu items and tool-bar.
11613 Help functions bind this to allow help on disabled menu items
11614 and tool-bar buttons. */);
11615 Venable_disabled_menus_and_buttons
= Qnil
;
11617 DEFVAR_LISP ("select-active-regions",
11618 Vselect_active_regions
,
11619 doc
: /* If non-nil, an active region automatically sets the primary selection.
11620 If the value is `only', only temporarily active regions (usually made
11621 by mouse-dragging or shift-selection) set the window selection.
11623 This takes effect only when Transient Mark mode is enabled. */);
11624 Vselect_active_regions
= Qt
;
11626 DEFVAR_LISP ("saved-region-selection",
11627 Vsaved_region_selection
,
11628 doc
: /* Contents of active region prior to buffer modification.
11629 If `select-active-regions' is non-nil, Emacs sets this to the
11630 text in the region before modifying the buffer. The next call to
11631 the function `deactivate-mark' uses this to set the window selection. */);
11632 Vsaved_region_selection
= Qnil
;
11634 DEFVAR_LISP ("selection-inhibit-update-commands",
11635 Vselection_inhibit_update_commands
,
11636 doc
: /* List of commands which should not update the selection.
11637 Normally, if `select-active-regions' is non-nil and the mark remains
11638 active after a command (i.e. the mark was not deactivated), the Emacs
11639 command loop sets the selection to the text in the region. However,
11640 if the command is in this list, the selection is not updated. */);
11641 Vselection_inhibit_update_commands
11642 = list2 (Qhandle_switch_frame
, Qhandle_select_window
);
11644 DEFVAR_LISP ("debug-on-event",
11646 doc
: /* Enter debugger on this event. When Emacs
11647 receives the special event specified by this variable, it will try to
11648 break into the debugger as soon as possible instead of processing the
11649 event normally through `special-event-map'.
11651 Currently, the only supported values for this
11652 variable are `sigusr1' and `sigusr2'. */);
11653 Vdebug_on_event
= intern_c_string ("sigusr2");
11655 /* Create the initial keyboard. Qt means 'unset'. */
11656 initial_kboard
= allocate_kboard (Qt
);
11660 keys_of_keyboard (void)
11662 initial_define_key (global_map
, Ctl ('Z'), "suspend-emacs");
11663 initial_define_key (control_x_map
, Ctl ('Z'), "suspend-emacs");
11664 initial_define_key (meta_map
, Ctl ('C'), "exit-recursive-edit");
11665 initial_define_key (global_map
, Ctl (']'), "abort-recursive-edit");
11666 initial_define_key (meta_map
, 'x', "execute-extended-command");
11668 initial_define_lispy_key (Vspecial_event_map
, "delete-frame",
11669 "handle-delete-frame");
11670 initial_define_lispy_key (Vspecial_event_map
, "ns-put-working-text",
11671 "ns-put-working-text");
11672 initial_define_lispy_key (Vspecial_event_map
, "ns-unput-working-text",
11673 "ns-unput-working-text");
11674 /* Here we used to use `ignore-event' which would simple set prefix-arg to
11675 current-prefix-arg, as is done in `handle-switch-frame'.
11676 But `handle-switch-frame is not run from the special-map.
11677 Commands from that map are run in a special way that automatically
11678 preserves the prefix-arg. Restoring the prefix arg here is not just
11679 redundant but harmful:
11681 - current-prefix-arg is set to non-nil, prefix-arg is set to nil.
11682 - after the first prompt, the exit-minibuffer-hook is run which may
11683 iconify a frame and thus push a `iconify-frame' event.
11684 - after running exit-minibuffer-hook, current-prefix-arg is
11685 restored to the non-nil value it had before the prompt.
11686 - we enter the second prompt.
11687 current-prefix-arg is non-nil, prefix-arg is nil.
11688 - before running the first real event, we run the special iconify-frame
11689 event, but we pass the `special' arg to command-execute so
11690 current-prefix-arg and prefix-arg are left untouched.
11691 - here we foolishly copy the non-nil current-prefix-arg to prefix-arg.
11692 - the next key event will have a spuriously non-nil current-prefix-arg. */
11693 initial_define_lispy_key (Vspecial_event_map
, "iconify-frame",
11695 initial_define_lispy_key (Vspecial_event_map
, "make-frame-visible",
11697 /* Handling it at such a low-level causes read_key_sequence to get
11698 * confused because it doesn't realize that the current_buffer was
11699 * changed by read_char.
11701 * initial_define_lispy_key (Vspecial_event_map, "select-window",
11702 * "handle-select-window"); */
11703 initial_define_lispy_key (Vspecial_event_map
, "save-session",
11704 "handle-save-session");
11707 /* Define a special event which is raised for dbus callback
11709 initial_define_lispy_key (Vspecial_event_map
, "dbus-event",
11710 "dbus-handle-event");
11713 #ifdef USE_FILE_NOTIFY
11714 /* Define a special event which is raised for notification callback
11716 initial_define_lispy_key (Vspecial_event_map
, "file-notify",
11717 "file-notify-handle-event");
11718 #endif /* USE_FILE_NOTIFY */
11720 initial_define_lispy_key (Vspecial_event_map
, "config-changed-event",
11722 #if defined (WINDOWSNT)
11723 initial_define_lispy_key (Vspecial_event_map
, "language-change",
11726 initial_define_lispy_key (Vspecial_event_map
, "focus-in",
11727 "handle-focus-in");
11728 initial_define_lispy_key (Vspecial_event_map
, "focus-out",
11729 "handle-focus-out");
11732 /* Mark the pointers in the kboard objects.
11733 Called by Fgarbage_collect. */
11735 mark_kboards (void)
11739 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
11741 if (kb
->kbd_macro_buffer
)
11742 for (p
= kb
->kbd_macro_buffer
; p
< kb
->kbd_macro_ptr
; p
++)
11744 mark_object (KVAR (kb
, Voverriding_terminal_local_map
));
11745 mark_object (KVAR (kb
, Vlast_command
));
11746 mark_object (KVAR (kb
, Vreal_last_command
));
11747 mark_object (KVAR (kb
, Vkeyboard_translate_table
));
11748 mark_object (KVAR (kb
, Vlast_repeatable_command
));
11749 mark_object (KVAR (kb
, Vprefix_arg
));
11750 mark_object (KVAR (kb
, Vlast_prefix_arg
));
11751 mark_object (KVAR (kb
, kbd_queue
));
11752 mark_object (KVAR (kb
, defining_kbd_macro
));
11753 mark_object (KVAR (kb
, Vlast_kbd_macro
));
11754 mark_object (KVAR (kb
, Vsystem_key_alist
));
11755 mark_object (KVAR (kb
, system_key_syms
));
11756 mark_object (KVAR (kb
, Vwindow_system
));
11757 mark_object (KVAR (kb
, Vinput_decode_map
));
11758 mark_object (KVAR (kb
, Vlocal_function_key_map
));
11759 mark_object (KVAR (kb
, Vdefault_minibuffer_frame
));
11760 mark_object (KVAR (kb
, echo_string
));
11763 union buffered_input_event
*event
;
11764 for (event
= kbd_fetch_ptr
; event
!= kbd_store_ptr
; event
++)
11766 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
11767 event
= kbd_buffer
;
11768 /* These two special event types has no Lisp_Objects to mark. */
11769 if (event
->kind
!= SELECTION_REQUEST_EVENT
11770 && event
->kind
!= SELECTION_CLEAR_EVENT
)
11772 mark_object (event
->ie
.x
);
11773 mark_object (event
->ie
.y
);
11774 mark_object (event
->ie
.frame_or_window
);
11775 mark_object (event
->ie
.arg
);