1 /* Keyboard and mouse input; editor command loop.
3 Copyright (C) 1985-1989, 1993-1997, 1999-2014 Free Software Foundation, Inc.
5 This file is part of GNU Emacs.
7 GNU Emacs is free software: you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation, either version 3 of the License, or
10 (at your option) any later version.
12 GNU Emacs is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
29 #include "termhooks.h"
34 #include "character.h"
37 #include "dispextern.h"
39 #include "intervals.h"
41 #include "blockinput.h"
55 #include <sys/ioctl.h>
56 #endif /* not MSDOS */
58 #if defined USABLE_FIONREAD && defined USG5_4
59 # include <sys/filio.h>
62 #include "syssignal.h"
64 #include <sys/types.h>
68 #ifdef HAVE_WINDOW_SYSTEM
70 #endif /* HAVE_WINDOW_SYSTEM */
72 /* Variables for blockinput.h: */
74 /* Positive if interrupt input is blocked right now. */
75 volatile int interrupt_input_blocked
;
77 /* True means an input interrupt or alarm signal has arrived.
78 The QUIT macro checks this. */
79 volatile bool pending_signals
;
81 #define KBD_BUFFER_SIZE 4096
83 KBOARD
*initial_kboard
;
84 KBOARD
*current_kboard
;
85 static KBOARD
*all_kboards
;
87 /* True in the single-kboard state, false in the any-kboard state. */
88 static bool single_kboard
;
90 /* Non-nil disable property on a command means
91 do not execute it; call disabled-command-function's value instead. */
92 Lisp_Object Qdisabled
;
93 static Lisp_Object Qdisabled_command_function
;
95 #define NUM_RECENT_KEYS (300)
97 /* Index for storing next element into recent_keys. */
98 static int recent_keys_index
;
100 /* Total number of elements stored into recent_keys. */
101 static int total_keys
;
103 /* This vector holds the last NUM_RECENT_KEYS keystrokes. */
104 static Lisp_Object recent_keys
;
106 /* Vector holding the key sequence that invoked the current command.
107 It is reused for each command, and it may be longer than the current
108 sequence; this_command_key_count indicates how many elements
109 actually mean something.
110 It's easier to staticpro a single Lisp_Object than an array. */
111 Lisp_Object this_command_keys
;
112 ptrdiff_t this_command_key_count
;
114 /* True after calling Freset_this_command_lengths.
115 Usually it is false. */
116 static bool this_command_key_count_reset
;
118 /* This vector is used as a buffer to record the events that were actually read
119 by read_key_sequence. */
120 static Lisp_Object raw_keybuf
;
121 static int raw_keybuf_count
;
123 #define GROW_RAW_KEYBUF \
124 if (raw_keybuf_count == ASIZE (raw_keybuf)) \
125 raw_keybuf = larger_vector (raw_keybuf, 1, -1)
127 /* Number of elements of this_command_keys
128 that precede this key sequence. */
129 static ptrdiff_t this_single_command_key_start
;
131 /* Record values of this_command_key_count and echo_length ()
132 before this command was read. */
133 static ptrdiff_t before_command_key_count
;
134 static ptrdiff_t before_command_echo_length
;
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 static Lisp_Object Qx_set_selection
, Qhandle_switch_frame
;
222 static Lisp_Object Qhandle_select_window
;
223 Lisp_Object QPRIMARY
;
225 static Lisp_Object Qself_insert_command
;
226 static Lisp_Object Qforward_char
;
227 static Lisp_Object Qbackward_char
;
228 Lisp_Object Qundefined
;
229 static Lisp_Object Qtimer_event_handler
;
231 /* `read_key_sequence' stores here the command definition of the
232 key sequence that it reads. */
233 static Lisp_Object read_key_sequence_cmd
;
234 static Lisp_Object read_key_sequence_remapped
;
236 static Lisp_Object Qinput_method_function
;
238 static Lisp_Object Qdeactivate_mark
;
240 Lisp_Object Qrecompute_lucid_menubar
, Qactivate_menubar_hook
;
242 static Lisp_Object Qecho_area_clear_hook
;
244 /* Hooks to run before and after each command. */
245 static Lisp_Object Qpre_command_hook
;
246 static Lisp_Object Qpost_command_hook
;
248 static Lisp_Object Qdeferred_action_function
;
250 static Lisp_Object Qdelayed_warnings_hook
;
252 static Lisp_Object Qinput_method_exit_on_first_char
;
253 static Lisp_Object Qinput_method_use_echo_area
;
255 static Lisp_Object Qhelp_form_show
;
257 /* File in which we write all commands we read. */
258 static FILE *dribble
;
260 /* Nonzero if input is available. */
263 /* Circular buffer for pre-read keyboard input. */
265 static struct input_event kbd_buffer
[KBD_BUFFER_SIZE
];
267 /* Pointer to next available character in kbd_buffer.
268 If kbd_fetch_ptr == kbd_store_ptr, the buffer is empty.
269 This may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the
270 next available char is in kbd_buffer[0]. */
271 static struct input_event
*kbd_fetch_ptr
;
273 /* Pointer to next place to store character in kbd_buffer. This
274 may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the next
275 character should go in kbd_buffer[0]. */
276 static struct input_event
* volatile kbd_store_ptr
;
278 /* The above pair of variables forms a "queue empty" flag. When we
279 enqueue a non-hook event, we increment kbd_store_ptr. When we
280 dequeue a non-hook event, we increment kbd_fetch_ptr. We say that
281 there is input available if the two pointers are not equal.
283 Why not just have a flag set and cleared by the enqueuing and
284 dequeuing functions? Such a flag could be screwed up by interrupts
285 at inopportune times. */
287 /* Symbols to head events. */
288 static Lisp_Object Qmouse_movement
;
289 static Lisp_Object Qscroll_bar_movement
;
290 Lisp_Object Qswitch_frame
;
291 static Lisp_Object Qfocus_in
, Qfocus_out
;
292 static Lisp_Object Qdelete_frame
;
293 static Lisp_Object Qiconify_frame
;
294 static Lisp_Object Qmake_frame_visible
;
295 static Lisp_Object Qselect_window
;
296 Lisp_Object Qhelp_echo
;
298 static Lisp_Object Qmouse_fixup_help_message
;
300 /* Symbols to denote kinds of events. */
301 static Lisp_Object Qfunction_key
;
302 Lisp_Object Qmouse_click
;
304 Lisp_Object Qlanguage_change
;
306 static Lisp_Object Qdrag_n_drop
;
307 static Lisp_Object Qsave_session
;
309 static Lisp_Object Qdbus_event
;
311 #ifdef USE_FILE_NOTIFY
312 static Lisp_Object Qfile_notify
;
313 #endif /* USE_FILE_NOTIFY */
314 static Lisp_Object Qconfig_changed_event
;
316 /* Lisp_Object Qmouse_movement; - also an event header */
318 /* Properties of event headers. */
319 Lisp_Object Qevent_kind
;
320 static Lisp_Object Qevent_symbol_elements
;
322 /* Menu and tool bar item parts. */
323 static Lisp_Object Qmenu_enable
;
324 static Lisp_Object QCenable
, QCvisible
, QChelp
, QCkeys
, QCkey_sequence
;
325 Lisp_Object QCfilter
;
327 /* Non-nil disable property on a command means
328 do not execute it; call disabled-command-function's value instead. */
329 Lisp_Object QCtoggle
, QCradio
;
330 static Lisp_Object QCbutton
, QClabel
;
332 static Lisp_Object QCvert_only
;
334 /* An event header symbol HEAD may have a property named
335 Qevent_symbol_element_mask, which is of the form (BASE MODIFIERS);
336 BASE is the base, unmodified version of HEAD, and MODIFIERS is the
337 mask of modifiers applied to it. If present, this is used to help
338 speed up parse_modifiers. */
339 Lisp_Object Qevent_symbol_element_mask
;
341 /* An unmodified event header BASE may have a property named
342 Qmodifier_cache, which is an alist mapping modifier masks onto
343 modified versions of BASE. If present, this helps speed up
345 static Lisp_Object Qmodifier_cache
;
347 /* Symbols to use for parts of windows. */
348 Lisp_Object Qmode_line
;
349 Lisp_Object Qvertical_line
;
350 Lisp_Object Qright_divider
, Qbottom_divider
;
351 Lisp_Object Qmenu_bar
;
353 static Lisp_Object Qecho_keystrokes
;
355 static void recursive_edit_unwind (Lisp_Object buffer
);
356 static Lisp_Object
command_loop (void);
357 static Lisp_Object Qcommand_execute
;
359 static void echo_now (void);
360 static ptrdiff_t echo_length (void);
362 static Lisp_Object Qpolling_period
;
364 /* Incremented whenever a timer is run. */
367 /* Address (if not 0) of struct timespec to zero out if a SIGIO interrupt
369 struct timespec
*input_available_clear_time
;
371 /* True means use SIGIO interrupts; false means use CBREAK mode.
372 Default is true if INTERRUPT_INPUT is defined. */
373 bool interrupt_input
;
375 /* Nonzero while interrupts are temporarily deferred during redisplay. */
376 bool interrupts_deferred
;
378 /* The time when Emacs started being idle. */
380 static struct timespec timer_idleness_start_time
;
382 /* After Emacs stops being idle, this saves the last value
383 of timer_idleness_start_time from when it was idle. */
385 static struct timespec timer_last_idleness_start_time
;
388 /* Global variable declarations. */
390 /* Flags for readable_events. */
391 #define READABLE_EVENTS_DO_TIMERS_NOW (1 << 0)
392 #define READABLE_EVENTS_FILTER_EVENTS (1 << 1)
393 #define READABLE_EVENTS_IGNORE_SQUEEZABLES (1 << 2)
395 /* Function for init_keyboard to call with no args (if nonzero). */
396 static void (*keyboard_init_hook
) (void);
398 static bool get_input_pending (int);
399 static bool readable_events (int);
400 static Lisp_Object
read_char_x_menu_prompt (Lisp_Object
,
401 Lisp_Object
, bool *);
402 static Lisp_Object
read_char_minibuf_menu_prompt (int, Lisp_Object
);
403 static Lisp_Object
make_lispy_event (struct input_event
*);
404 static Lisp_Object
make_lispy_movement (struct frame
*, Lisp_Object
,
405 enum scroll_bar_part
,
406 Lisp_Object
, Lisp_Object
,
408 static Lisp_Object
modify_event_symbol (ptrdiff_t, int, Lisp_Object
,
409 Lisp_Object
, const char *const *,
410 Lisp_Object
*, ptrdiff_t);
411 static Lisp_Object
make_lispy_switch_frame (Lisp_Object
);
412 static Lisp_Object
make_lispy_focus_in (Lisp_Object
);
413 #ifdef HAVE_WINDOW_SYSTEM
414 static Lisp_Object
make_lispy_focus_out (Lisp_Object
);
415 #endif /* HAVE_WINDOW_SYSTEM */
416 static bool help_char_p (Lisp_Object
);
417 static void save_getcjmp (sys_jmp_buf
);
418 static void restore_getcjmp (sys_jmp_buf
);
419 static Lisp_Object
apply_modifiers (int, Lisp_Object
);
420 static void clear_event (struct input_event
*);
421 static void restore_kboard_configuration (int);
423 static void deliver_input_available_signal (int signo
);
425 static void handle_interrupt (bool);
426 static _Noreturn
void quit_throw_to_read_char (bool);
427 static void process_special_events (void);
428 static void timer_start_idle (void);
429 static void timer_stop_idle (void);
430 static void timer_resume_idle (void);
431 static void deliver_user_signal (int);
432 static char *find_user_signal_name (int);
433 static void store_user_signal_events (void);
435 /* These setters are used only in this file, so they can be private. */
437 kset_echo_string (struct kboard
*kb
, Lisp_Object val
)
439 kb
->INTERNAL_FIELD (echo_string
) = val
;
442 kset_kbd_queue (struct kboard
*kb
, Lisp_Object val
)
444 kb
->INTERNAL_FIELD (kbd_queue
) = val
;
447 kset_keyboard_translate_table (struct kboard
*kb
, Lisp_Object val
)
449 kb
->INTERNAL_FIELD (Vkeyboard_translate_table
) = val
;
452 kset_last_prefix_arg (struct kboard
*kb
, Lisp_Object val
)
454 kb
->INTERNAL_FIELD (Vlast_prefix_arg
) = val
;
457 kset_last_repeatable_command (struct kboard
*kb
, Lisp_Object val
)
459 kb
->INTERNAL_FIELD (Vlast_repeatable_command
) = val
;
462 kset_local_function_key_map (struct kboard
*kb
, Lisp_Object val
)
464 kb
->INTERNAL_FIELD (Vlocal_function_key_map
) = val
;
467 kset_overriding_terminal_local_map (struct kboard
*kb
, Lisp_Object val
)
469 kb
->INTERNAL_FIELD (Voverriding_terminal_local_map
) = val
;
472 kset_real_last_command (struct kboard
*kb
, Lisp_Object val
)
474 kb
->INTERNAL_FIELD (Vreal_last_command
) = val
;
477 kset_system_key_syms (struct kboard
*kb
, Lisp_Object val
)
479 kb
->INTERNAL_FIELD (system_key_syms
) = val
;
483 /* Add C to the echo string, without echoing it immediately. C can be
484 a character, which is pretty-printed, or a symbol, whose name is
488 echo_add_key (Lisp_Object c
)
490 int size
= KEY_DESCRIPTION_SIZE
+ 100;
491 char *buffer
= alloca (size
);
493 Lisp_Object echo_string
;
495 echo_string
= KVAR (current_kboard
, echo_string
);
497 /* If someone has passed us a composite event, use its head symbol. */
501 ptr
= push_key_description (XINT (c
), ptr
);
502 else if (SYMBOLP (c
))
504 Lisp_Object name
= SYMBOL_NAME (c
);
505 int nbytes
= SBYTES (name
);
507 if (size
- (ptr
- buffer
) < nbytes
)
509 int offset
= ptr
- buffer
;
510 size
= max (2 * size
, size
+ nbytes
);
511 buffer
= alloca (size
);
512 ptr
= buffer
+ offset
;
515 ptr
+= copy_text (SDATA (name
), (unsigned char *) ptr
, nbytes
,
516 STRING_MULTIBYTE (name
), 1);
519 if ((NILP (echo_string
) || SCHARS (echo_string
) == 0)
522 const char *text
= " (Type ? for further options)";
523 int len
= strlen (text
);
525 if (size
- (ptr
- buffer
) < len
)
527 int offset
= ptr
- buffer
;
529 buffer
= alloca (size
);
530 ptr
= buffer
+ offset
;
533 memcpy (ptr
, text
, len
);
537 /* Replace a dash from echo_dash with a space, otherwise add a space
538 at the end as a separator between keys. */
539 if (STRINGP (echo_string
) && SCHARS (echo_string
) > 1)
541 Lisp_Object last_char
, prev_char
, idx
;
543 idx
= make_number (SCHARS (echo_string
) - 2);
544 prev_char
= Faref (echo_string
, idx
);
546 idx
= make_number (SCHARS (echo_string
) - 1);
547 last_char
= Faref (echo_string
, idx
);
549 /* We test PREV_CHAR to make sure this isn't the echoing of a
551 if (XINT (last_char
) == '-' && XINT (prev_char
) != ' ')
552 Faset (echo_string
, idx
, make_number (' '));
554 echo_string
= concat2 (echo_string
, build_string (" "));
556 else if (STRINGP (echo_string
) && SCHARS (echo_string
) > 0)
557 echo_string
= concat2 (echo_string
, build_string (" "));
561 concat2 (echo_string
, make_string (buffer
, ptr
- buffer
)));
564 /* Add C to the echo string, if echoing is going on. C can be a
565 character or a symbol. */
568 echo_char (Lisp_Object c
)
570 if (current_kboard
->immediate_echo
)
577 /* Temporarily add a dash to the end of the echo string if it's not
578 empty, so that it serves as a mini-prompt for the very next
584 /* Do nothing if not echoing at all. */
585 if (NILP (KVAR (current_kboard
, echo_string
)))
588 if (this_command_key_count
== 0)
591 if (!current_kboard
->immediate_echo
592 && SCHARS (KVAR (current_kboard
, echo_string
)) == 0)
595 /* Do nothing if we just printed a prompt. */
596 if (current_kboard
->echo_after_prompt
597 == SCHARS (KVAR (current_kboard
, echo_string
)))
600 /* Do nothing if we have already put a dash at the end. */
601 if (SCHARS (KVAR (current_kboard
, echo_string
)) > 1)
603 Lisp_Object last_char
, prev_char
, idx
;
605 idx
= make_number (SCHARS (KVAR (current_kboard
, echo_string
)) - 2);
606 prev_char
= Faref (KVAR (current_kboard
, echo_string
), idx
);
608 idx
= make_number (SCHARS (KVAR (current_kboard
, echo_string
)) - 1);
609 last_char
= Faref (KVAR (current_kboard
, echo_string
), idx
);
611 if (XINT (last_char
) == '-' && XINT (prev_char
) != ' ')
615 /* Put a dash at the end of the buffer temporarily,
616 but make it go away when the next character is added. */
619 concat2 (KVAR (current_kboard
, echo_string
), build_string ("-")));
623 /* Display the current echo string, and begin echoing if not already
629 if (!current_kboard
->immediate_echo
)
632 current_kboard
->immediate_echo
= 1;
634 for (i
= 0; i
< this_command_key_count
; i
++)
638 /* Set before_command_echo_length to the value that would
639 have been saved before the start of this subcommand in
640 command_loop_1, if we had already been echoing then. */
641 if (i
== this_single_command_key_start
)
642 before_command_echo_length
= echo_length ();
644 c
= AREF (this_command_keys
, i
);
645 if (! (EVENT_HAS_PARAMETERS (c
)
646 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
650 /* Set before_command_echo_length to the value that would
651 have been saved before the start of this subcommand in
652 command_loop_1, if we had already been echoing then. */
653 if (this_command_key_count
== this_single_command_key_start
)
654 before_command_echo_length
= echo_length ();
656 /* Put a dash at the end to invite the user to type more. */
661 /* FIXME: Use call (Qmessage) so it can be advised (e.g. emacspeak). */
662 message3_nolog (KVAR (current_kboard
, echo_string
));
665 /* Record in what buffer we echoed, and from which kboard. */
666 echo_message_buffer
= echo_area_buffer
[0];
667 echo_kboard
= current_kboard
;
669 if (waiting_for_input
&& !NILP (Vquit_flag
))
670 quit_throw_to_read_char (0);
673 /* Turn off echoing, for the start of a new command. */
676 cancel_echoing (void)
678 current_kboard
->immediate_echo
= 0;
679 current_kboard
->echo_after_prompt
= -1;
680 kset_echo_string (current_kboard
, Qnil
);
681 ok_to_echo_at_next_pause
= NULL
;
683 echo_message_buffer
= Qnil
;
686 /* Return the length of the current echo string. */
691 return (STRINGP (KVAR (current_kboard
, echo_string
))
692 ? SCHARS (KVAR (current_kboard
, echo_string
))
696 /* Truncate the current echo message to its first LEN chars.
697 This and echo_char get used by read_key_sequence when the user
698 switches frames while entering a key sequence. */
701 echo_truncate (ptrdiff_t nchars
)
703 if (STRINGP (KVAR (current_kboard
, echo_string
)))
704 kset_echo_string (current_kboard
,
705 Fsubstring (KVAR (current_kboard
, echo_string
),
706 make_number (0), make_number (nchars
)));
707 truncate_echo_area (nchars
);
711 /* Functions for manipulating this_command_keys. */
713 add_command_key (Lisp_Object key
)
715 #if 0 /* Not needed after we made Freset_this_command_lengths
716 do the job immediately. */
717 /* If reset-this-command-length was called recently, obey it now.
718 See the doc string of that function for an explanation of why. */
719 if (before_command_restore_flag
)
721 this_command_key_count
= before_command_key_count_1
;
722 if (this_command_key_count
< this_single_command_key_start
)
723 this_single_command_key_start
= this_command_key_count
;
724 echo_truncate (before_command_echo_length_1
);
725 before_command_restore_flag
= 0;
729 if (this_command_key_count
>= ASIZE (this_command_keys
))
730 this_command_keys
= larger_vector (this_command_keys
, 1, -1);
732 ASET (this_command_keys
, this_command_key_count
, key
);
733 ++this_command_key_count
;
738 recursive_edit_1 (void)
740 ptrdiff_t count
= SPECPDL_INDEX ();
743 if (command_loop_level
> 0)
745 specbind (Qstandard_output
, Qt
);
746 specbind (Qstandard_input
, Qt
);
749 #ifdef HAVE_WINDOW_SYSTEM
750 /* The command loop has started an hourglass timer, so we have to
751 cancel it here, otherwise it will fire because the recursive edit
752 can take some time. Do not check for display_hourglass_p here,
753 because it could already be nil. */
757 /* This function may have been called from a debugger called from
758 within redisplay, for instance by Edebugging a function called
759 from fontification-functions. We want to allow redisplay in
760 the debugging session.
762 The recursive edit is left with a `(throw exit ...)'. The `exit'
763 tag is not caught anywhere in redisplay, i.e. when we leave the
764 recursive edit, the original redisplay leading to the recursive
765 edit will be unwound. The outcome should therefore be safe. */
766 specbind (Qinhibit_redisplay
, Qnil
);
769 val
= command_loop ();
771 Fsignal (Qquit
, Qnil
);
772 /* Handle throw from read_minibuf when using minibuffer
773 while it's active but we're in another window. */
775 xsignal1 (Qerror
, val
);
777 return unbind_to (count
, Qnil
);
780 /* When an auto-save happens, record the "time", and don't do again soon. */
783 record_auto_save (void)
785 last_auto_save
= num_nonmacro_input_events
;
788 /* Make an auto save happen as soon as possible at command level. */
792 force_auto_save_soon (void)
794 last_auto_save
= - auto_save_interval
- 1;
796 record_asynch_buffer_change ();
800 DEFUN ("recursive-edit", Frecursive_edit
, Srecursive_edit
, 0, 0, "",
801 doc
: /* Invoke the editor command loop recursively.
802 To get out of the recursive edit, a command can throw to `exit' -- for
803 instance `(throw 'exit nil)'.
804 If you throw a value other than t, `recursive-edit' returns normally
805 to the function that called it. Throwing a t value causes
806 `recursive-edit' to quit, so that control returns to the command loop
809 This function is called by the editor initialization to begin editing. */)
812 ptrdiff_t count
= SPECPDL_INDEX ();
815 /* If we enter while input is blocked, don't lock up here.
816 This may happen through the debugger during redisplay. */
817 if (input_blocked_p ())
820 if (command_loop_level
>= 0
821 && current_buffer
!= XBUFFER (XWINDOW (selected_window
)->contents
))
822 buffer
= Fcurrent_buffer ();
826 /* Don't do anything interesting between the increment and the
827 record_unwind_protect! Otherwise, we could get distracted and
828 never decrement the counter again. */
829 command_loop_level
++;
830 update_mode_lines
= 17;
831 record_unwind_protect (recursive_edit_unwind
, buffer
);
833 /* If we leave recursive_edit_1 below with a `throw' for instance,
834 like it is done in the splash screen display, we have to
835 make sure that we restore single_kboard as command_loop_1
836 would have done if it were left normally. */
837 if (command_loop_level
> 0)
838 temporarily_switch_to_single_kboard (SELECTED_FRAME ());
841 return unbind_to (count
, Qnil
);
845 recursive_edit_unwind (Lisp_Object buffer
)
847 if (BUFFERP (buffer
))
848 Fset_buffer (buffer
);
850 command_loop_level
--;
851 update_mode_lines
= 18;
855 #if 0 /* These two functions are now replaced with
856 temporarily_switch_to_single_kboard. */
860 #if 0 /* Theory: if there's anything in Vunread_command_events,
861 it will right away be read by read_key_sequence,
862 and then if we do switch KBOARDS, it will go into the side
863 queue then. So we don't need to do anything special here -- rms. */
864 if (CONSP (Vunread_command_events
))
866 current_kboard
->kbd_queue
867 = nconc2 (Vunread_command_events
, current_kboard
->kbd_queue
);
868 current_kboard
->kbd_queue_has_data
= 1;
870 Vunread_command_events
= Qnil
;
875 /* Switch to the single-kboard state, making current_kboard
876 the only KBOARD from which further input is accepted. */
879 single_kboard_state ()
885 /* If we're in single_kboard state for kboard KBOARD,
889 not_single_kboard_state (KBOARD
*kboard
)
891 if (kboard
== current_kboard
)
895 /* Maintain a stack of kboards, so other parts of Emacs
896 can switch temporarily to the kboard of a given frame
897 and then revert to the previous status. */
902 struct kboard_stack
*next
;
905 static struct kboard_stack
*kboard_stack
;
908 push_kboard (struct kboard
*k
)
910 struct kboard_stack
*p
= xmalloc (sizeof *p
);
912 p
->next
= kboard_stack
;
913 p
->kboard
= current_kboard
;
923 struct kboard_stack
*p
= kboard_stack
;
925 for (t
= terminal_list
; t
; t
= t
->next_terminal
)
927 if (t
->kboard
== p
->kboard
)
929 current_kboard
= p
->kboard
;
936 /* The terminal we remembered has been deleted. */
937 current_kboard
= FRAME_KBOARD (SELECTED_FRAME ());
940 kboard_stack
= p
->next
;
944 /* Switch to single_kboard mode, making current_kboard the only KBOARD
945 from which further input is accepted. If F is non-nil, set its
946 KBOARD as the current keyboard.
948 This function uses record_unwind_protect_int to return to the previous
951 If Emacs is already in single_kboard mode, and F's keyboard is
952 locked, then this function will throw an error. */
955 temporarily_switch_to_single_kboard (struct frame
*f
)
957 bool was_locked
= single_kboard
;
960 if (f
!= NULL
&& FRAME_KBOARD (f
) != current_kboard
)
961 /* We can not switch keyboards while in single_kboard mode.
962 In rare cases, Lisp code may call `recursive-edit' (or
963 `read-minibuffer' or `y-or-n-p') after it switched to a
964 locked frame. For example, this is likely to happen
965 when server.el connects to a new terminal while Emacs is in
966 single_kboard mode. It is best to throw an error instead
967 of presenting the user with a frozen screen. */
968 error ("Terminal %d is locked, cannot read from it",
969 FRAME_TERMINAL (f
)->id
);
971 /* This call is unnecessary, but helps
972 `restore_kboard_configuration' discover if somebody changed
973 `current_kboard' behind our back. */
974 push_kboard (current_kboard
);
977 current_kboard
= FRAME_KBOARD (f
);
979 record_unwind_protect_int (restore_kboard_configuration
, was_locked
);
982 #if 0 /* This function is not needed anymore. */
984 record_single_kboard_state ()
987 push_kboard (current_kboard
);
988 record_unwind_protect_int (restore_kboard_configuration
, single_kboard
);
993 restore_kboard_configuration (int was_locked
)
995 single_kboard
= was_locked
;
998 struct kboard
*prev
= current_kboard
;
1000 /* The pop should not change the kboard. */
1001 if (single_kboard
&& current_kboard
!= prev
)
1007 /* Handle errors that are not handled at inner levels
1008 by printing an error message and returning to the editor command loop. */
1011 cmd_error (Lisp_Object data
)
1013 Lisp_Object old_level
, old_length
;
1014 char macroerror
[sizeof "After..kbd macro iterations: "
1015 + INT_STRLEN_BOUND (EMACS_INT
)];
1017 #ifdef HAVE_WINDOW_SYSTEM
1018 if (display_hourglass_p
)
1019 cancel_hourglass ();
1022 if (!NILP (executing_kbd_macro
))
1024 if (executing_kbd_macro_iterations
== 1)
1025 sprintf (macroerror
, "After 1 kbd macro iteration: ");
1027 sprintf (macroerror
, "After %"pI
"d kbd macro iterations: ",
1028 executing_kbd_macro_iterations
);
1033 Vstandard_output
= Qt
;
1034 Vstandard_input
= Qt
;
1035 Vexecuting_kbd_macro
= Qnil
;
1036 executing_kbd_macro
= Qnil
;
1037 kset_prefix_arg (current_kboard
, Qnil
);
1038 kset_last_prefix_arg (current_kboard
, Qnil
);
1041 /* Avoid unquittable loop if data contains a circular list. */
1042 old_level
= Vprint_level
;
1043 old_length
= Vprint_length
;
1044 XSETFASTINT (Vprint_level
, 10);
1045 XSETFASTINT (Vprint_length
, 10);
1046 cmd_error_internal (data
, macroerror
);
1047 Vprint_level
= old_level
;
1048 Vprint_length
= old_length
;
1051 Vinhibit_quit
= Qnil
;
1053 return make_number (0);
1056 /* Take actions on handling an error. DATA is the data that describes
1059 CONTEXT is a C-string containing ASCII characters only which
1060 describes the context in which the error happened. If we need to
1061 generalize CONTEXT to allow multibyte characters, make it a Lisp
1065 cmd_error_internal (Lisp_Object data
, const char *context
)
1067 /* The immediate context is not interesting for Quits,
1068 since they are asynchronous. */
1069 if (EQ (XCAR (data
), Qquit
))
1070 Vsignaling_function
= Qnil
;
1075 /* Use user's specified output function if any. */
1076 if (!NILP (Vcommand_error_function
))
1077 call3 (Vcommand_error_function
, data
,
1078 context
? build_string (context
) : empty_unibyte_string
,
1079 Vsignaling_function
);
1081 Vsignaling_function
= Qnil
;
1084 DEFUN ("command-error-default-function", Fcommand_error_default_function
,
1085 Scommand_error_default_function
, 3, 3, 0,
1086 doc
: /* Produce default output for unhandled error message.
1087 Default value of `command-error-function'. */)
1088 (Lisp_Object data
, Lisp_Object context
, Lisp_Object signal
)
1090 struct frame
*sf
= SELECTED_FRAME ();
1092 CHECK_STRING (context
);
1094 /* If the window system or terminal frame hasn't been initialized
1095 yet, or we're not interactive, write the message to stderr and exit. */
1096 if (!sf
->glyphs_initialized_p
1097 /* The initial frame is a special non-displaying frame. It
1098 will be current in daemon mode when there are no frames
1099 to display, and in non-daemon mode before the real frame
1100 has finished initializing. If an error is thrown in the
1101 latter case while creating the frame, then the frame
1102 will never be displayed, so the safest thing to do is
1103 write to stderr and quit. In daemon mode, there are
1104 many other potential errors that do not prevent frames
1105 from being created, so continuing as normal is better in
1107 || (!IS_DAEMON
&& FRAME_INITIAL_P (sf
))
1110 print_error_message (data
, Qexternal_debugging_output
,
1111 SSDATA (context
), signal
);
1112 Fterpri (Qexternal_debugging_output
);
1113 Fkill_emacs (make_number (-1));
1117 clear_message (1, 0);
1119 message_log_maybe_newline ();
1122 print_error_message (data
, Qt
, SSDATA (context
), signal
);
1127 static Lisp_Object
command_loop_2 (Lisp_Object
);
1128 static Lisp_Object
top_level_1 (Lisp_Object
);
1130 /* Entry to editor-command-loop.
1131 This level has the catches for exiting/returning to editor command loop.
1132 It returns nil to exit recursive edit, t to abort it. */
1137 if (command_loop_level
> 0 || minibuf_level
> 0)
1140 val
= internal_catch (Qexit
, command_loop_2
, Qnil
);
1141 executing_kbd_macro
= Qnil
;
1147 internal_catch (Qtop_level
, top_level_1
, Qnil
);
1148 internal_catch (Qtop_level
, command_loop_2
, Qnil
);
1149 executing_kbd_macro
= Qnil
;
1151 /* End of file in -batch run causes exit here. */
1157 /* Here we catch errors in execution of commands within the
1158 editing loop, and reenter the editing loop.
1159 When there is an error, cmd_error runs and returns a non-nil
1160 value to us. A value of nil means that command_loop_1 itself
1161 returned due to end of file (or end of kbd macro). */
1164 command_loop_2 (Lisp_Object ignore
)
1166 register Lisp_Object val
;
1169 val
= internal_condition_case (command_loop_1
, Qerror
, cmd_error
);
1170 while (!NILP (val
));
1178 return Feval (Vtop_level
, Qnil
);
1182 top_level_1 (Lisp_Object ignore
)
1184 /* On entry to the outer level, run the startup file. */
1185 if (!NILP (Vtop_level
))
1186 internal_condition_case (top_level_2
, Qerror
, cmd_error
);
1187 else if (!NILP (Vpurify_flag
))
1188 message1 ("Bare impure Emacs (standard Lisp code not loaded)");
1190 message1 ("Bare Emacs (standard Lisp code not loaded)");
1194 DEFUN ("top-level", Ftop_level
, Stop_level
, 0, 0, "",
1195 doc
: /* Exit all recursive editing levels.
1196 This also exits all active minibuffers. */)
1199 #ifdef HAVE_WINDOW_SYSTEM
1200 if (display_hourglass_p
)
1201 cancel_hourglass ();
1204 /* Unblock input if we enter with input blocked. This may happen if
1205 redisplay traps e.g. during tool-bar update with input blocked. */
1206 totally_unblock_input ();
1208 Fthrow (Qtop_level
, Qnil
);
1211 static _Noreturn
void
1212 user_error (const char *msg
)
1214 xsignal1 (Quser_error
, build_string (msg
));
1217 /* _Noreturn will be added to prototype by make-docfile. */
1218 DEFUN ("exit-recursive-edit", Fexit_recursive_edit
, Sexit_recursive_edit
, 0, 0, "",
1219 doc
: /* Exit from the innermost recursive edit or minibuffer. */)
1222 if (command_loop_level
> 0 || minibuf_level
> 0)
1223 Fthrow (Qexit
, Qnil
);
1225 user_error ("No recursive edit is in progress");
1228 /* _Noreturn will be added to prototype by make-docfile. */
1229 DEFUN ("abort-recursive-edit", Fabort_recursive_edit
, Sabort_recursive_edit
, 0, 0, "",
1230 doc
: /* Abort the command that requested this recursive edit or minibuffer input. */)
1233 if (command_loop_level
> 0 || minibuf_level
> 0)
1236 user_error ("No recursive edit is in progress");
1239 /* Restore mouse tracking enablement. See Ftrack_mouse for the only use
1240 of this function. */
1243 tracking_off (Lisp_Object old_value
)
1245 do_mouse_tracking
= old_value
;
1246 if (NILP (old_value
))
1248 /* Redisplay may have been preempted because there was input
1249 available, and it assumes it will be called again after the
1250 input has been processed. If the only input available was
1251 the sort that we have just disabled, then we need to call
1253 if (!readable_events (READABLE_EVENTS_DO_TIMERS_NOW
))
1255 redisplay_preserve_echo_area (6);
1256 get_input_pending (READABLE_EVENTS_DO_TIMERS_NOW
);
1261 DEFUN ("track-mouse", Ftrack_mouse
, Strack_mouse
, 0, UNEVALLED
, 0,
1262 doc
: /* Evaluate BODY with mouse movement events enabled.
1263 Within a `track-mouse' form, mouse motion generates input events that
1264 you can read with `read-event'.
1265 Normally, mouse motion is ignored.
1266 usage: (track-mouse BODY...) */)
1269 ptrdiff_t count
= SPECPDL_INDEX ();
1272 record_unwind_protect (tracking_off
, do_mouse_tracking
);
1274 do_mouse_tracking
= Qt
;
1276 val
= Fprogn (args
);
1277 return unbind_to (count
, val
);
1280 /* If mouse has moved on some frame, return one of those frames.
1284 If ignore_mouse_drag_p is non-zero, ignore (implicit) mouse movement
1285 after resizing the tool-bar window. */
1287 bool ignore_mouse_drag_p
;
1289 static struct frame
*
1290 some_mouse_moved (void)
1292 Lisp_Object tail
, frame
;
1294 if (ignore_mouse_drag_p
)
1296 /* ignore_mouse_drag_p = 0; */
1300 FOR_EACH_FRAME (tail
, frame
)
1302 if (XFRAME (frame
)->mouse_moved
)
1303 return XFRAME (frame
);
1310 /* This is the actual command reading loop,
1311 sans error-handling encapsulation. */
1313 static int read_key_sequence (Lisp_Object
*, int, Lisp_Object
,
1314 bool, bool, bool, bool);
1315 static void adjust_point_for_property (ptrdiff_t, bool);
1317 /* The last boundary auto-added to buffer-undo-list. */
1318 Lisp_Object last_undo_boundary
;
1320 /* FIXME: This is wrong rather than test window-system, we should call
1321 a new set-selection, which will then dispatch to x-set-selection, or
1322 tty-set-selection, or w32-set-selection, ... */
1325 command_loop_1 (void)
1328 Lisp_Object keybuf
[30];
1330 EMACS_INT prev_modiff
= 0;
1331 struct buffer
*prev_buffer
= NULL
;
1332 bool already_adjusted
= 0;
1334 kset_prefix_arg (current_kboard
, Qnil
);
1335 kset_last_prefix_arg (current_kboard
, Qnil
);
1336 Vdeactivate_mark
= Qnil
;
1337 waiting_for_input
= 0;
1340 this_command_key_count
= 0;
1341 this_command_key_count_reset
= 0;
1342 this_single_command_key_start
= 0;
1344 if (NILP (Vmemory_full
))
1346 /* Make sure this hook runs after commands that get errors and
1347 throw to top level. */
1348 /* Note that the value cell will never directly contain nil
1349 if the symbol is a local variable. */
1350 if (!NILP (Vpost_command_hook
) && !NILP (Vrun_hooks
))
1351 safe_run_hooks (Qpost_command_hook
);
1353 /* If displaying a message, resize the echo area window to fit
1354 that message's size exactly. */
1355 if (!NILP (echo_area_buffer
[0]))
1356 resize_echo_area_exactly ();
1358 /* If there are warnings waiting, process them. */
1359 if (!NILP (Vdelayed_warnings_list
))
1360 safe_run_hooks (Qdelayed_warnings_hook
);
1362 if (!NILP (Vdeferred_action_list
))
1363 safe_run_hooks (Qdeferred_action_function
);
1366 /* Do this after running Vpost_command_hook, for consistency. */
1367 kset_last_command (current_kboard
, Vthis_command
);
1368 kset_real_last_command (current_kboard
, Vreal_this_command
);
1369 if (!CONSP (last_command_event
))
1370 kset_last_repeatable_command (current_kboard
, Vreal_this_command
);
1374 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1377 /* Make sure the current window's buffer is selected. */
1378 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->contents
));
1380 /* Display any malloc warning that just came out. Use while because
1381 displaying one warning can cause another. */
1383 while (pending_malloc_warning
)
1384 display_malloc_warning ();
1386 Vdeactivate_mark
= Qnil
;
1388 /* Don't ignore mouse movements for more than a single command
1389 loop. (This flag is set in xdisp.c whenever the tool bar is
1390 resized, because the resize moves text up or down, and would
1391 generate false mouse drag events if we don't ignore them.) */
1392 ignore_mouse_drag_p
= 0;
1394 /* If minibuffer on and echo area in use,
1395 wait a short time and redraw minibuffer. */
1398 && !NILP (echo_area_buffer
[0])
1399 && EQ (minibuf_window
, echo_area_window
)
1400 && NUMBERP (Vminibuffer_message_timeout
))
1402 /* Bind inhibit-quit to t so that C-g gets read in
1403 rather than quitting back to the minibuffer. */
1404 ptrdiff_t count
= SPECPDL_INDEX ();
1405 specbind (Qinhibit_quit
, Qt
);
1407 sit_for (Vminibuffer_message_timeout
, 0, 2);
1409 /* Clear the echo area. */
1411 safe_run_hooks (Qecho_area_clear_hook
);
1413 unbind_to (count
, Qnil
);
1415 /* If a C-g came in before, treat it as input now. */
1416 if (!NILP (Vquit_flag
))
1419 Vunread_command_events
= list1 (make_number (quit_char
));
1423 /* If it has changed current-menubar from previous value,
1424 really recompute the menubar from the value. */
1425 if (! NILP (Vlucid_menu_bar_dirty_flag
)
1426 && !NILP (Ffboundp (Qrecompute_lucid_menubar
)))
1427 call0 (Qrecompute_lucid_menubar
);
1429 before_command_key_count
= this_command_key_count
;
1430 before_command_echo_length
= echo_length ();
1432 Vthis_command
= Qnil
;
1433 Vreal_this_command
= Qnil
;
1434 Vthis_original_command
= Qnil
;
1435 Vthis_command_keys_shift_translated
= Qnil
;
1437 /* Read next key sequence; i gets its length. */
1438 i
= read_key_sequence (keybuf
, ARRAYELTS (keybuf
),
1441 /* A filter may have run while we were reading the input. */
1442 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1444 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->contents
));
1448 /* Now we have read a key sequence of length I,
1449 or else I is 0 and we found end of file. */
1451 if (i
== 0) /* End of file -- happens only in */
1452 return Qnil
; /* a kbd macro, at the end. */
1453 /* -1 means read_key_sequence got a menu that was rejected.
1454 Just loop around and read another command. */
1458 this_command_key_count
= 0;
1459 this_command_key_count_reset
= 0;
1460 this_single_command_key_start
= 0;
1464 last_command_event
= keybuf
[i
- 1];
1466 /* If the previous command tried to force a specific window-start,
1467 forget about that, in case this command moves point far away
1468 from that position. But also throw away beg_unchanged and
1469 end_unchanged information in that case, so that redisplay will
1470 update the whole window properly. */
1471 if (XWINDOW (selected_window
)->force_start
)
1474 XWINDOW (selected_window
)->force_start
= 0;
1475 b
= XBUFFER (XWINDOW (selected_window
)->contents
);
1476 BUF_BEG_UNCHANGED (b
) = BUF_END_UNCHANGED (b
) = 0;
1479 cmd
= read_key_sequence_cmd
;
1480 if (!NILP (Vexecuting_kbd_macro
))
1482 if (!NILP (Vquit_flag
))
1484 Vexecuting_kbd_macro
= Qt
;
1485 QUIT
; /* Make some noise. */
1486 /* Will return since macro now empty. */
1490 /* Do redisplay processing after this command except in special
1491 cases identified below. */
1492 prev_buffer
= current_buffer
;
1493 prev_modiff
= MODIFF
;
1494 last_point_position
= PT
;
1496 /* By default, we adjust point to a boundary of a region that
1497 has such a property that should be treated intangible
1498 (e.g. composition, display). But, some commands will set
1499 this variable differently. */
1500 Vdisable_point_adjustment
= Qnil
;
1502 /* Process filters and timers may have messed with deactivate-mark.
1503 reset it before we execute the command. */
1504 Vdeactivate_mark
= Qnil
;
1506 /* Remap command through active keymaps. */
1507 Vthis_original_command
= cmd
;
1508 if (!NILP (read_key_sequence_remapped
))
1509 cmd
= read_key_sequence_remapped
;
1511 /* Execute the command. */
1513 Vthis_command
= cmd
;
1514 Vreal_this_command
= cmd
;
1515 safe_run_hooks (Qpre_command_hook
);
1517 already_adjusted
= 0;
1519 if (NILP (Vthis_command
))
1520 /* nil means key is undefined. */
1524 /* Here for a command that isn't executed directly. */
1526 #ifdef HAVE_WINDOW_SYSTEM
1527 ptrdiff_t scount
= SPECPDL_INDEX ();
1529 if (display_hourglass_p
1530 && NILP (Vexecuting_kbd_macro
))
1532 record_unwind_protect_void (cancel_hourglass
);
1537 if (NILP (KVAR (current_kboard
, Vprefix_arg
))) /* FIXME: Why? --Stef */
1539 Lisp_Object undo
= BVAR (current_buffer
, undo_list
);
1542 = (EQ (undo
, BVAR (current_buffer
, undo_list
))
1543 ? Qnil
: BVAR (current_buffer
, undo_list
));
1545 call1 (Qcommand_execute
, Vthis_command
);
1547 #ifdef HAVE_WINDOW_SYSTEM
1548 /* Do not check display_hourglass_p here, because
1549 `command-execute' could change it, but we should cancel
1550 hourglass cursor anyway.
1551 But don't cancel the hourglass within a macro
1552 just because a command in the macro finishes. */
1553 if (NILP (Vexecuting_kbd_macro
))
1554 unbind_to (scount
, Qnil
);
1557 kset_last_prefix_arg (current_kboard
, Vcurrent_prefix_arg
);
1559 safe_run_hooks (Qpost_command_hook
);
1561 /* If displaying a message, resize the echo area window to fit
1562 that message's size exactly. */
1563 if (!NILP (echo_area_buffer
[0]))
1564 resize_echo_area_exactly ();
1566 /* If there are warnings waiting, process them. */
1567 if (!NILP (Vdelayed_warnings_list
))
1568 safe_run_hooks (Qdelayed_warnings_hook
);
1570 safe_run_hooks (Qdeferred_action_function
);
1572 /* If there is a prefix argument,
1573 1) We don't want Vlast_command to be ``universal-argument''
1574 (that would be dumb), so don't set Vlast_command,
1575 2) we want to leave echoing on so that the prefix will be
1576 echoed as part of this key sequence, so don't call
1578 3) we want to leave this_command_key_count non-zero, so that
1579 read_char will realize that it is re-reading a character, and
1580 not echo it a second time.
1582 If the command didn't actually create a prefix arg,
1583 but is merely a frame event that is transparent to prefix args,
1584 then the above doesn't apply. */
1585 if (NILP (KVAR (current_kboard
, Vprefix_arg
))
1586 || CONSP (last_command_event
))
1588 kset_last_command (current_kboard
, Vthis_command
);
1589 kset_real_last_command (current_kboard
, Vreal_this_command
);
1590 if (!CONSP (last_command_event
))
1591 kset_last_repeatable_command (current_kboard
, Vreal_this_command
);
1593 this_command_key_count
= 0;
1594 this_command_key_count_reset
= 0;
1595 this_single_command_key_start
= 0;
1598 if (!NILP (BVAR (current_buffer
, mark_active
))
1599 && !NILP (Vrun_hooks
))
1601 /* In Emacs 22, setting transient-mark-mode to `only' was a
1602 way of turning it on for just one command. This usage is
1603 obsolete, but support it anyway. */
1604 if (EQ (Vtransient_mark_mode
, Qidentity
))
1605 Vtransient_mark_mode
= Qnil
;
1606 else if (EQ (Vtransient_mark_mode
, Qonly
))
1607 Vtransient_mark_mode
= Qidentity
;
1609 if (!NILP (Vdeactivate_mark
))
1610 /* If `select-active-regions' is non-nil, this call to
1611 `deactivate-mark' also sets the PRIMARY selection. */
1612 call0 (Qdeactivate_mark
);
1615 /* Even if not deactivating the mark, set PRIMARY if
1616 `select-active-regions' is non-nil. */
1617 if (!NILP (Fwindow_system (Qnil
))
1618 /* Even if mark_active is non-nil, the actual buffer
1619 marker may not have been set yet (Bug#7044). */
1620 && XMARKER (BVAR (current_buffer
, mark
))->buffer
1621 && (EQ (Vselect_active_regions
, Qonly
)
1622 ? EQ (CAR_SAFE (Vtransient_mark_mode
), Qonly
)
1623 : (!NILP (Vselect_active_regions
)
1624 && !NILP (Vtransient_mark_mode
)))
1625 && NILP (Fmemq (Vthis_command
,
1626 Vselection_inhibit_update_commands
)))
1629 = call1 (Fsymbol_value (Qregion_extract_function
), Qnil
);
1630 if (XINT (Flength (txt
)) > 0)
1631 /* Don't set empty selections. */
1632 call2 (Qx_set_selection
, QPRIMARY
, txt
);
1635 if (current_buffer
!= prev_buffer
|| MODIFF
!= prev_modiff
)
1637 Lisp_Object hook
= intern ("activate-mark-hook");
1638 Frun_hooks (1, &hook
);
1642 Vsaved_region_selection
= Qnil
;
1647 if (current_buffer
== prev_buffer
1648 && last_point_position
!= PT
1649 && NILP (Vdisable_point_adjustment
)
1650 && NILP (Vglobal_disable_point_adjustment
))
1652 if (last_point_position
> BEGV
1653 && last_point_position
< ZV
1654 && (composition_adjust_point (last_point_position
,
1655 last_point_position
)
1656 != last_point_position
))
1657 /* The last point was temporarily set within a grapheme
1658 cluster to prevent automatic composition. To recover
1659 the automatic composition, we must update the
1661 windows_or_buffers_changed
= 21;
1662 if (!already_adjusted
)
1663 adjust_point_for_property (last_point_position
,
1664 MODIFF
!= prev_modiff
);
1667 /* Install chars successfully executed in kbd macro. */
1669 if (!NILP (KVAR (current_kboard
, defining_kbd_macro
))
1670 && NILP (KVAR (current_kboard
, Vprefix_arg
)))
1671 finalize_kbd_macro_chars ();
1676 read_menu_command (void)
1678 Lisp_Object keybuf
[30];
1679 ptrdiff_t count
= SPECPDL_INDEX ();
1682 /* We don't want to echo the keystrokes while navigating the
1684 specbind (Qecho_keystrokes
, make_number (0));
1686 i
= read_key_sequence (keybuf
, ARRAYELTS (keybuf
),
1689 unbind_to (count
, Qnil
);
1691 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1693 if (i
== 0 || i
== -1)
1696 return read_key_sequence_cmd
;
1699 /* Adjust point to a boundary of a region that has such a property
1700 that should be treated intangible. For the moment, we check
1701 `composition', `display' and `invisible' properties.
1702 LAST_PT is the last position of point. */
1705 adjust_point_for_property (ptrdiff_t last_pt
, bool modified
)
1708 Lisp_Object val
, overlay
, tmp
;
1709 /* When called after buffer modification, we should temporarily
1710 suppress the point adjustment for automatic composition so that a
1711 user can keep inserting another character at point or keep
1712 deleting characters around point. */
1713 bool check_composition
= ! modified
, check_display
= 1, check_invisible
= 1;
1714 ptrdiff_t orig_pt
= PT
;
1716 /* FIXME: cycling is probably not necessary because these properties
1717 can't be usefully combined anyway. */
1718 while (check_composition
|| check_display
|| check_invisible
)
1720 /* FIXME: check `intangible'. */
1721 if (check_composition
1722 && PT
> BEGV
&& PT
< ZV
1723 && (beg
= composition_adjust_point (last_pt
, PT
)) != PT
)
1726 check_display
= check_invisible
= 1;
1728 check_composition
= 0;
1730 && PT
> BEGV
&& PT
< ZV
1731 && !NILP (val
= get_char_property_and_overlay
1732 (make_number (PT
), Qdisplay
, Qnil
, &overlay
))
1733 && display_prop_intangible_p (val
, overlay
, PT
, PT_BYTE
)
1734 && (!OVERLAYP (overlay
)
1735 ? get_property_and_range (PT
, Qdisplay
, &val
, &beg
, &end
, Qnil
)
1736 : (beg
= OVERLAY_POSITION (OVERLAY_START (overlay
)),
1737 end
= OVERLAY_POSITION (OVERLAY_END (overlay
))))
1738 && (beg
< PT
/* && end > PT <- It's always the case. */
1739 || (beg
<= PT
&& STRINGP (val
) && SCHARS (val
) == 0)))
1742 SET_PT (PT
< last_pt
1743 ? (STRINGP (val
) && SCHARS (val
) == 0
1744 ? max (beg
- 1, BEGV
)
1747 check_composition
= check_invisible
= 1;
1750 if (check_invisible
&& PT
> BEGV
&& PT
< ZV
)
1756 /* Find boundaries `beg' and `end' of the invisible area, if any. */
1759 /* FIXME: We should stop if we find a spot between
1760 two runs of `invisible' where inserted text would
1761 be visible. This is important when we have two
1762 invisible boundaries that enclose an area: if the
1763 area is empty, we need this test in order to make
1764 it possible to place point in the middle rather
1765 than skip both boundaries. However, this code
1766 also stops anywhere in a non-sticky text-property,
1767 which breaks (e.g.) Org mode. */
1768 && (val
= Fget_pos_property (make_number (end
),
1770 TEXT_PROP_MEANS_INVISIBLE (val
))
1772 && !NILP (val
= get_char_property_and_overlay
1773 (make_number (end
), Qinvisible
, Qnil
, &overlay
))
1774 && (inv
= TEXT_PROP_MEANS_INVISIBLE (val
)))
1776 ellipsis
= ellipsis
|| inv
> 1
1777 || (OVERLAYP (overlay
)
1778 && (!NILP (Foverlay_get (overlay
, Qafter_string
))
1779 || !NILP (Foverlay_get (overlay
, Qbefore_string
))));
1780 tmp
= Fnext_single_char_property_change
1781 (make_number (end
), Qinvisible
, Qnil
, Qnil
);
1782 end
= NATNUMP (tmp
) ? XFASTINT (tmp
) : ZV
;
1786 && (val
= Fget_pos_property (make_number (beg
),
1788 TEXT_PROP_MEANS_INVISIBLE (val
))
1790 && !NILP (val
= get_char_property_and_overlay
1791 (make_number (beg
- 1), Qinvisible
, Qnil
, &overlay
))
1792 && (inv
= TEXT_PROP_MEANS_INVISIBLE (val
)))
1794 ellipsis
= ellipsis
|| inv
> 1
1795 || (OVERLAYP (overlay
)
1796 && (!NILP (Foverlay_get (overlay
, Qafter_string
))
1797 || !NILP (Foverlay_get (overlay
, Qbefore_string
))));
1798 tmp
= Fprevious_single_char_property_change
1799 (make_number (beg
), Qinvisible
, Qnil
, Qnil
);
1800 beg
= NATNUMP (tmp
) ? XFASTINT (tmp
) : BEGV
;
1803 /* Move away from the inside area. */
1804 if (beg
< PT
&& end
> PT
)
1806 SET_PT ((orig_pt
== PT
&& (last_pt
< beg
|| last_pt
> end
))
1807 /* We haven't moved yet (so we don't need to fear
1808 infinite-looping) and we were outside the range
1809 before (so either end of the range still corresponds
1810 to a move in the right direction): pretend we moved
1811 less than we actually did, so that we still have
1812 more freedom below in choosing which end of the range
1814 ? (orig_pt
= -1, PT
< last_pt
? end
: beg
)
1815 /* We either have moved already or the last point
1816 was already in the range: we don't get to choose
1817 which end of the range we have to go to. */
1818 : (PT
< last_pt
? beg
: end
));
1819 check_composition
= check_display
= 1;
1821 #if 0 /* This assertion isn't correct, because SET_PT may end up setting
1822 the point to something other than its argument, due to
1823 point-motion hooks, intangibility, etc. */
1824 eassert (PT
== beg
|| PT
== end
);
1827 /* Pretend the area doesn't exist if the buffer is not
1829 if (!modified
&& !ellipsis
&& beg
< end
)
1831 if (last_pt
== beg
&& PT
== end
&& end
< ZV
)
1832 (check_composition
= check_display
= 1, SET_PT (end
+ 1));
1833 else if (last_pt
== end
&& PT
== beg
&& beg
> BEGV
)
1834 (check_composition
= check_display
= 1, SET_PT (beg
- 1));
1835 else if (PT
== ((PT
< last_pt
) ? beg
: end
))
1836 /* We've already moved as far as we can. Trying to go
1837 to the other end would mean moving backwards and thus
1838 could lead to an infinite loop. */
1840 else if (val
= Fget_pos_property (make_number (PT
),
1842 TEXT_PROP_MEANS_INVISIBLE (val
)
1843 && (val
= (Fget_pos_property
1844 (make_number (PT
== beg
? end
: beg
),
1846 !TEXT_PROP_MEANS_INVISIBLE (val
)))
1847 (check_composition
= check_display
= 1,
1848 SET_PT (PT
== beg
? end
: beg
));
1851 check_invisible
= 0;
1855 /* Subroutine for safe_run_hooks: run the hook HOOK. */
1858 safe_run_hooks_1 (void)
1860 eassert (CONSP (Vinhibit_quit
));
1861 return call0 (XCDR (Vinhibit_quit
));
1864 /* Subroutine for safe_run_hooks: handle an error by clearing out the function
1868 safe_run_hooks_error (Lisp_Object error_data
)
1871 = CONSP (Vinhibit_quit
) ? XCAR (Vinhibit_quit
) : Vinhibit_quit
;
1872 Lisp_Object fun
= CONSP (Vinhibit_quit
) ? XCDR (Vinhibit_quit
) : Qnil
;
1873 Lisp_Object args
[4];
1874 args
[0] = build_string ("Error in %s (%S): %S");
1877 args
[3] = error_data
;
1883 Lisp_Object newval
= Qnil
;
1884 for (val
= find_symbol_value (hook
); CONSP (val
); val
= XCDR (val
))
1885 if (EQ (fun
, XCAR (val
)))
1888 newval
= Fcons (XCAR (val
), newval
);
1890 return Fset (hook
, Fnreverse (newval
));
1891 /* Not found in the local part of the hook. Let's look at the global
1894 for (val
= (NILP (Fdefault_boundp (hook
)) ? Qnil
1895 : Fdefault_value (hook
));
1896 CONSP (val
); val
= XCDR (val
))
1897 if (EQ (fun
, XCAR (val
)))
1900 newval
= Fcons (XCAR (val
), newval
);
1902 return Fset_default (hook
, Fnreverse (newval
));
1908 safe_run_hook_funcall (ptrdiff_t nargs
, Lisp_Object
*args
)
1910 eassert (nargs
== 1);
1911 if (CONSP (Vinhibit_quit
))
1912 XSETCDR (Vinhibit_quit
, args
[0]);
1914 Vinhibit_quit
= Fcons (Vinhibit_quit
, args
[0]);
1916 internal_condition_case (safe_run_hooks_1
, Qt
, safe_run_hooks_error
);
1920 /* If we get an error while running the hook, cause the hook variable
1921 to be nil. Also inhibit quits, so that C-g won't cause the hook
1922 to mysteriously evaporate. */
1925 safe_run_hooks (Lisp_Object hook
)
1927 /* FIXME: our `internal_condition_case' does not provide any way to pass data
1928 to its body or to its handlers other than via globals such as
1929 dynamically-bound variables ;-) */
1930 ptrdiff_t count
= SPECPDL_INDEX ();
1931 specbind (Qinhibit_quit
, hook
);
1933 run_hook_with_args (1, &hook
, safe_run_hook_funcall
);
1935 unbind_to (count
, Qnil
);
1939 /* Nonzero means polling for input is temporarily suppressed. */
1941 int poll_suppress_count
;
1944 #ifdef POLL_FOR_INPUT
1946 /* Asynchronous timer for polling. */
1948 static struct atimer
*poll_timer
;
1950 /* Poll for input, so that we catch a C-g if it comes in. */
1952 poll_for_input_1 (void)
1954 if (! input_blocked_p ()
1955 && !waiting_for_input
)
1959 /* Timer callback function for poll_timer. TIMER is equal to
1963 poll_for_input (struct atimer
*timer
)
1965 if (poll_suppress_count
== 0)
1966 pending_signals
= 1;
1969 #endif /* POLL_FOR_INPUT */
1971 /* Begin signals to poll for input, if they are appropriate.
1972 This function is called unconditionally from various places. */
1975 start_polling (void)
1977 #ifdef POLL_FOR_INPUT
1978 /* XXX This condition was (read_socket_hook && !interrupt_input),
1979 but read_socket_hook is not global anymore. Let's pretend that
1981 if (!interrupt_input
)
1983 /* Turn alarm handling on unconditionally. It might have
1984 been turned off in process.c. */
1985 turn_on_atimers (1);
1987 /* If poll timer doesn't exist, or we need one with
1988 a different interval, start a new one. */
1989 if (poll_timer
== NULL
1990 || poll_timer
->interval
.tv_sec
!= polling_period
)
1992 time_t period
= max (1, min (polling_period
, TYPE_MAXIMUM (time_t)));
1993 struct timespec interval
= make_timespec (period
, 0);
1996 cancel_atimer (poll_timer
);
1998 poll_timer
= start_atimer (ATIMER_CONTINUOUS
, interval
,
1999 poll_for_input
, NULL
);
2002 /* Let the timer's callback function poll for input
2003 if this becomes zero. */
2004 --poll_suppress_count
;
2009 /* True if we are using polling to handle input asynchronously. */
2012 input_polling_used (void)
2014 #ifdef POLL_FOR_INPUT
2015 /* XXX This condition was (read_socket_hook && !interrupt_input),
2016 but read_socket_hook is not global anymore. Let's pretend that
2018 return !interrupt_input
;
2024 /* Turn off polling. */
2029 #ifdef POLL_FOR_INPUT
2030 /* XXX This condition was (read_socket_hook && !interrupt_input),
2031 but read_socket_hook is not global anymore. Let's pretend that
2033 if (!interrupt_input
)
2034 ++poll_suppress_count
;
2038 /* Set the value of poll_suppress_count to COUNT
2039 and start or stop polling accordingly. */
2042 set_poll_suppress_count (int count
)
2044 #ifdef POLL_FOR_INPUT
2045 if (count
== 0 && poll_suppress_count
!= 0)
2047 poll_suppress_count
= 1;
2050 else if (count
!= 0 && poll_suppress_count
== 0)
2054 poll_suppress_count
= count
;
2058 /* Bind polling_period to a value at least N.
2059 But don't decrease it. */
2062 bind_polling_period (int n
)
2064 #ifdef POLL_FOR_INPUT
2065 EMACS_INT
new = polling_period
;
2070 stop_other_atimers (poll_timer
);
2072 specbind (Qpolling_period
, make_number (new));
2073 /* Start a new alarm with the new period. */
2078 /* Apply the control modifier to CHARACTER. */
2081 make_ctrl_char (int c
)
2083 /* Save the upper bits here. */
2084 int upper
= c
& ~0177;
2086 if (! ASCII_CHAR_P (c
))
2087 return c
|= ctrl_modifier
;
2091 /* Everything in the columns containing the upper-case letters
2092 denotes a control character. */
2093 if (c
>= 0100 && c
< 0140)
2097 /* Set the shift modifier for a control char
2098 made from a shifted letter. But only for letters! */
2099 if (oc
>= 'A' && oc
<= 'Z')
2100 c
|= shift_modifier
;
2103 /* The lower-case letters denote control characters too. */
2104 else if (c
>= 'a' && c
<= 'z')
2107 /* Include the bits for control and shift
2108 only if the basic ASCII code can't indicate them. */
2112 /* Replace the high bits. */
2113 c
|= (upper
& ~ctrl_modifier
);
2118 /* Display the help-echo property of the character after the mouse pointer.
2119 Either show it in the echo area, or call show-help-function to display
2120 it by other means (maybe in a tooltip).
2122 If HELP is nil, that means clear the previous help echo.
2124 If HELP is a string, display that string. If HELP is a function,
2125 call it with OBJECT and POS as arguments; the function should
2126 return a help string or nil for none. For all other types of HELP,
2127 evaluate it to obtain a string.
2129 WINDOW is the window in which the help was generated, if any.
2130 It is nil if not in a window.
2132 If OBJECT is a buffer, POS is the position in the buffer where the
2133 `help-echo' text property was found.
2135 If OBJECT is an overlay, that overlay has a `help-echo' property,
2136 and POS is the position in the overlay's buffer under the mouse.
2138 If OBJECT is a string (an overlay string or a string displayed with
2139 the `display' property). POS is the position in that string under
2142 Note: this function may only be called with HELP nil or a string
2143 from X code running asynchronously. */
2146 show_help_echo (Lisp_Object help
, Lisp_Object window
, Lisp_Object object
,
2149 if (!NILP (help
) && !STRINGP (help
))
2151 if (FUNCTIONP (help
))
2152 help
= safe_call (4, help
, window
, object
, pos
);
2154 help
= safe_eval (help
);
2156 if (!STRINGP (help
))
2160 if (!noninteractive
&& STRINGP (help
))
2162 /* The mouse-fixup-help-message Lisp function can call
2163 mouse_position_hook, which resets the mouse_moved flags.
2164 This causes trouble if we are trying to read a mouse motion
2165 event (i.e., if we are inside a `track-mouse' form), so we
2166 restore the mouse_moved flag. */
2167 struct frame
*f
= NILP (do_mouse_tracking
) ? NULL
: some_mouse_moved ();
2168 help
= call1 (Qmouse_fixup_help_message
, help
);
2173 if (STRINGP (help
) || NILP (help
))
2175 if (!NILP (Vshow_help_function
))
2176 call1 (Vshow_help_function
, help
);
2177 help_echo_showing_p
= STRINGP (help
);
2183 /* Input of single characters from keyboard. */
2185 static Lisp_Object
kbd_buffer_get_event (KBOARD
**kbp
, bool *used_mouse_menu
,
2186 struct timespec
*end_time
);
2187 static void record_char (Lisp_Object c
);
2189 static Lisp_Object help_form_saved_window_configs
;
2191 read_char_help_form_unwind (void)
2193 Lisp_Object window_config
= XCAR (help_form_saved_window_configs
);
2194 help_form_saved_window_configs
= XCDR (help_form_saved_window_configs
);
2195 if (!NILP (window_config
))
2196 Fset_window_configuration (window_config
);
2199 #define STOP_POLLING \
2200 do { if (! polling_stopped_here) stop_polling (); \
2201 polling_stopped_here = 1; } while (0)
2203 #define RESUME_POLLING \
2204 do { if (polling_stopped_here) start_polling (); \
2205 polling_stopped_here = 0; } while (0)
2208 read_event_from_main_queue (struct timespec
*end_time
,
2209 sys_jmp_buf local_getcjmp
,
2210 bool *used_mouse_menu
)
2212 Lisp_Object c
= Qnil
;
2213 sys_jmp_buf save_jump
;
2214 KBOARD
*kb
IF_LINT (= NULL
);
2218 /* Read from the main queue, and if that gives us something we can't use yet,
2219 we put it on the appropriate side queue and try again. */
2221 if (end_time
&& timespec_cmp (*end_time
, current_timespec ()) <= 0)
2224 /* Actually read a character, waiting if necessary. */
2225 save_getcjmp (save_jump
);
2226 restore_getcjmp (local_getcjmp
);
2228 timer_start_idle ();
2229 c
= kbd_buffer_get_event (&kb
, used_mouse_menu
, end_time
);
2230 restore_getcjmp (save_jump
);
2232 if (! NILP (c
) && (kb
!= current_kboard
))
2234 Lisp_Object last
= KVAR (kb
, kbd_queue
);
2237 while (CONSP (XCDR (last
)))
2239 if (!NILP (XCDR (last
)))
2243 kset_kbd_queue (kb
, list1 (c
));
2245 XSETCDR (last
, list1 (c
));
2246 kb
->kbd_queue_has_data
= 1;
2250 current_kboard
= kb
;
2251 /* This is going to exit from read_char
2252 so we had better get rid of this frame's stuff. */
2253 return make_number (-2);
2256 /* Terminate Emacs in batch mode if at eof. */
2257 if (noninteractive
&& INTEGERP (c
) && XINT (c
) < 0)
2258 Fkill_emacs (make_number (1));
2262 /* Add in any extra modifiers, where appropriate. */
2263 if ((extra_keyboard_modifiers
& CHAR_CTL
)
2264 || ((extra_keyboard_modifiers
& 0177) < ' '
2265 && (extra_keyboard_modifiers
& 0177) != 0))
2266 XSETINT (c
, make_ctrl_char (XINT (c
)));
2268 /* Transfer any other modifier bits directly from
2269 extra_keyboard_modifiers to c. Ignore the actual character code
2270 in the low 16 bits of extra_keyboard_modifiers. */
2271 XSETINT (c
, XINT (c
) | (extra_keyboard_modifiers
& ~0xff7f & ~CHAR_CTL
));
2279 /* Like `read_event_from_main_queue' but applies keyboard-coding-system
2282 read_decoded_event_from_main_queue (struct timespec
*end_time
,
2283 sys_jmp_buf local_getcjmp
,
2284 Lisp_Object prev_event
,
2285 bool *used_mouse_menu
)
2287 #define MAX_ENCODED_BYTES 16
2289 Lisp_Object events
[MAX_ENCODED_BYTES
];
2295 = read_event_from_main_queue (end_time
, local_getcjmp
,
2298 /* w32_console already returns decoded events. It either reads
2299 Unicode characters from the Windows keyboard input, or
2300 converts characters encoded in the current codepage into
2301 Unicode. See w32inevt.c:key_event, near its end. */
2304 struct frame
*frame
= XFRAME (selected_frame
);
2305 struct terminal
*terminal
= frame
->terminal
;
2306 if (!((FRAME_TERMCAP_P (frame
) || FRAME_MSDOS_P (frame
))
2307 /* Don't apply decoding if we're just reading a raw event
2308 (e.g. reading bytes sent by the xterm to specify the position
2309 of a mouse click). */
2310 && (!EQ (prev_event
, Qt
))
2311 && (TERMINAL_KEYBOARD_CODING (terminal
)->common_flags
2312 & CODING_REQUIRE_DECODING_MASK
)))
2313 return nextevt
; /* No decoding needed. */
2316 int meta_key
= terminal
->display_info
.tty
->meta_key
;
2317 eassert (n
< MAX_ENCODED_BYTES
);
2318 events
[n
++] = nextevt
;
2319 if (NATNUMP (nextevt
)
2320 && XINT (nextevt
) < (meta_key
== 1 ? 0x80 : 0x100))
2321 { /* An encoded byte sequence, let's try to decode it. */
2322 struct coding_system
*coding
2323 = TERMINAL_KEYBOARD_CODING (terminal
);
2324 unsigned char *src
= alloca (n
);
2326 for (i
= 0; i
< n
; i
++)
2327 src
[i
] = XINT (events
[i
]);
2329 for (i
= 0; i
< n
; i
++)
2331 coding
->destination
= alloca (n
* 4);
2332 coding
->dst_bytes
= n
* 4;
2333 decode_coding_c_string (coding
, src
, n
, Qnil
);
2334 eassert (coding
->produced_char
<= n
);
2335 if (coding
->produced_char
== 0)
2336 { /* The encoded sequence is incomplete. */
2337 if (n
< MAX_ENCODED_BYTES
) /* Avoid buffer overflow. */
2338 continue; /* Read on! */
2342 const unsigned char *p
= coding
->destination
;
2343 eassert (coding
->carryover_bytes
== 0);
2345 while (n
< coding
->produced_char
)
2346 events
[n
++] = make_number (STRING_CHAR_ADVANCE (p
));
2349 /* Now `events' should hold decoded events.
2350 Normally, n should be equal to 1, but better not rely on it.
2351 We can only return one event here, so return the first we
2352 had and keep the others (if any) for later. */
2354 Vunread_command_events
2355 = Fcons (events
[--n
], Vunread_command_events
);
2363 echo_keystrokes_p (void)
2365 return (FLOATP (Vecho_keystrokes
) ? XFLOAT_DATA (Vecho_keystrokes
) > 0.0
2366 : INTEGERP (Vecho_keystrokes
) ? XINT (Vecho_keystrokes
) > 0 : false);
2369 /* Read a character from the keyboard; call the redisplay if needed. */
2370 /* commandflag 0 means do not autosave, but do redisplay.
2371 -1 means do not redisplay, but do autosave.
2372 -2 means do neither.
2375 /* The argument MAP is a keymap for menu prompting.
2377 PREV_EVENT is the previous input event, or nil if we are reading
2378 the first event of a key sequence (or not reading a key sequence).
2379 If PREV_EVENT is t, that is a "magic" value that says
2380 not to run input methods, but in other respects to act as if
2381 not reading a key sequence.
2383 If USED_MOUSE_MENU is non-null, then set *USED_MOUSE_MENU to true
2384 if we used a mouse menu to read the input, or false otherwise. If
2385 USED_MOUSE_MENU is null, don't dereference it.
2387 Value is -2 when we find input on another keyboard. A second call
2388 to read_char will read it.
2390 If END_TIME is non-null, it is a pointer to a struct timespec
2391 specifying the maximum time to wait until. If no input arrives by
2392 that time, stop waiting and return nil.
2394 Value is t if we showed a menu and the user rejected it. */
2397 read_char (int commandflag
, Lisp_Object map
,
2398 Lisp_Object prev_event
,
2399 bool *used_mouse_menu
, struct timespec
*end_time
)
2403 sys_jmp_buf local_getcjmp
;
2404 sys_jmp_buf save_jump
;
2405 Lisp_Object tem
, save
;
2406 volatile Lisp_Object previous_echo_area_message
;
2407 volatile Lisp_Object also_record
;
2408 volatile bool reread
;
2409 struct gcpro gcpro1
, gcpro2
;
2410 bool volatile polling_stopped_here
= 0;
2411 struct kboard
*orig_kboard
= current_kboard
;
2415 #if 0 /* This was commented out as part of fixing echo for C-u left. */
2416 before_command_key_count
= this_command_key_count
;
2417 before_command_echo_length
= echo_length ();
2420 previous_echo_area_message
= Qnil
;
2422 GCPRO2 (c
, previous_echo_area_message
);
2426 if (CONSP (Vunread_post_input_method_events
))
2428 c
= XCAR (Vunread_post_input_method_events
);
2429 Vunread_post_input_method_events
2430 = XCDR (Vunread_post_input_method_events
);
2432 /* Undo what read_char_x_menu_prompt did when it unread
2433 additional keys returned by Fx_popup_menu. */
2435 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2446 if (CONSP (Vunread_command_events
))
2448 bool was_disabled
= 0;
2450 c
= XCAR (Vunread_command_events
);
2451 Vunread_command_events
= XCDR (Vunread_command_events
);
2453 /* Undo what sit-for did when it unread additional keys
2454 inside universal-argument. */
2456 if (CONSP (c
) && EQ (XCAR (c
), Qt
))
2461 /* Undo what read_char_x_menu_prompt did when it unread
2462 additional keys returned by Fx_popup_menu. */
2464 && EQ (XCDR (c
), Qdisabled
)
2465 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
))))
2471 /* If the queued event is something that used the mouse,
2472 set used_mouse_menu accordingly. */
2474 /* Also check was_disabled so last-nonmenu-event won't return
2475 a bad value when submenus are involved. (Bug#447) */
2476 && (EQ (c
, Qtool_bar
) || EQ (c
, Qmenu_bar
) || was_disabled
))
2477 *used_mouse_menu
= 1;
2479 goto reread_for_input_method
;
2482 if (CONSP (Vunread_input_method_events
))
2484 c
= XCAR (Vunread_input_method_events
);
2485 Vunread_input_method_events
= XCDR (Vunread_input_method_events
);
2487 /* Undo what read_char_x_menu_prompt did when it unread
2488 additional keys returned by Fx_popup_menu. */
2490 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2494 goto reread_for_input_method
;
2497 this_command_key_count_reset
= 0;
2499 if (!NILP (Vexecuting_kbd_macro
))
2501 /* We set this to Qmacro; since that's not a frame, nobody will
2502 try to switch frames on us, and the selected window will
2505 Since this event came from a macro, it would be misleading to
2506 leave internal_last_event_frame set to wherever the last
2507 real event came from. Normally, a switch-frame event selects
2508 internal_last_event_frame after each command is read, but
2509 events read from a macro should never cause a new frame to be
2511 Vlast_event_frame
= internal_last_event_frame
= Qmacro
;
2513 /* Exit the macro if we are at the end.
2514 Also, some things replace the macro with t
2515 to force an early exit. */
2516 if (EQ (Vexecuting_kbd_macro
, Qt
)
2517 || executing_kbd_macro_index
>= XFASTINT (Flength (Vexecuting_kbd_macro
)))
2523 c
= Faref (Vexecuting_kbd_macro
, make_number (executing_kbd_macro_index
));
2524 if (STRINGP (Vexecuting_kbd_macro
)
2525 && (XFASTINT (c
) & 0x80) && (XFASTINT (c
) <= 0xff))
2526 XSETFASTINT (c
, CHAR_META
| (XFASTINT (c
) & ~0x80));
2528 executing_kbd_macro_index
++;
2533 if (!NILP (unread_switch_frame
))
2535 c
= unread_switch_frame
;
2536 unread_switch_frame
= Qnil
;
2538 /* This event should make it into this_command_keys, and get echoed
2539 again, so we do not set `reread'. */
2543 /* If redisplay was requested. */
2544 if (commandflag
>= 0)
2546 bool echo_current
= EQ (echo_message_buffer
, echo_area_buffer
[0]);
2548 /* If there is pending input, process any events which are not
2549 user-visible, such as X selection_request events. */
2551 || detect_input_pending_run_timers (0))
2552 swallow_events (0); /* May clear input_pending. */
2554 /* Redisplay if no pending input. */
2555 while (!input_pending
)
2557 if (help_echo_showing_p
&& !EQ (selected_window
, minibuf_window
))
2558 redisplay_preserve_echo_area (5);
2563 /* Normal case: no input arrived during redisplay. */
2566 /* Input arrived and pre-empted redisplay.
2567 Process any events which are not user-visible. */
2569 /* If that cleared input_pending, try again to redisplay. */
2572 /* Prevent the redisplay we just did
2573 from messing up echoing of the input after the prompt. */
2574 if (commandflag
== 0 && echo_current
)
2575 echo_message_buffer
= echo_area_buffer
[0];
2579 /* Message turns off echoing unless more keystrokes turn it on again.
2581 The code in 20.x for the condition was
2583 1. echo_area_glyphs && *echo_area_glyphs
2584 2. && echo_area_glyphs != current_kboard->echobuf
2585 3. && ok_to_echo_at_next_pause != echo_area_glyphs
2587 (1) means there's a current message displayed
2589 (2) means it's not the message from echoing from the current
2592 (3) There's only one place in 20.x where ok_to_echo_at_next_pause
2593 is set to a non-null value. This is done in read_char and it is
2594 set to echo_area_glyphs after a call to echo_char. That means
2595 ok_to_echo_at_next_pause is either null or
2596 current_kboard->echobuf with the appropriate current_kboard at
2599 So, condition (3) means in clear text ok_to_echo_at_next_pause
2600 must be either null, or the current message isn't from echoing at
2601 all, or it's from echoing from a different kboard than the
2604 if (/* There currently is something in the echo area. */
2605 !NILP (echo_area_buffer
[0])
2606 && (/* It's an echo from a different kboard. */
2607 echo_kboard
!= current_kboard
2608 /* Or we explicitly allow overwriting whatever there is. */
2609 || ok_to_echo_at_next_pause
== NULL
))
2614 /* Try reading a character via menu prompting in the minibuf.
2615 Try this before the sit-for, because the sit-for
2616 would do the wrong thing if we are supposed to do
2617 menu prompting. If EVENT_HAS_PARAMETERS then we are reading
2618 after a mouse event so don't try a minibuf menu. */
2620 if (KEYMAPP (map
) && INTERACTIVE
2621 && !NILP (prev_event
) && ! EVENT_HAS_PARAMETERS (prev_event
)
2622 /* Don't bring up a menu if we already have another event. */
2623 && NILP (Vunread_command_events
)
2624 && !detect_input_pending_run_timers (0))
2626 c
= read_char_minibuf_menu_prompt (commandflag
, map
);
2628 if (INTEGERP (c
) && XINT (c
) == -2)
2629 return c
; /* wrong_kboard_jmpbuf */
2635 /* Make a longjmp point for quits to use, but don't alter getcjmp just yet.
2636 We will do that below, temporarily for short sections of code,
2637 when appropriate. local_getcjmp must be in effect
2638 around any call to sit_for or kbd_buffer_get_event;
2639 it *must not* be in effect when we call redisplay. */
2641 jmpcount
= SPECPDL_INDEX ();
2642 if (sys_setjmp (local_getcjmp
))
2644 /* Handle quits while reading the keyboard. */
2645 /* We must have saved the outer value of getcjmp here,
2646 so restore it now. */
2647 restore_getcjmp (save_jump
);
2648 pthread_sigmask (SIG_SETMASK
, &empty_mask
, 0);
2649 unbind_to (jmpcount
, Qnil
);
2650 XSETINT (c
, quit_char
);
2651 internal_last_event_frame
= selected_frame
;
2652 Vlast_event_frame
= internal_last_event_frame
;
2653 /* If we report the quit char as an event,
2654 don't do so more than once. */
2655 if (!NILP (Vinhibit_quit
))
2659 KBOARD
*kb
= FRAME_KBOARD (XFRAME (selected_frame
));
2660 if (kb
!= current_kboard
)
2662 Lisp_Object last
= KVAR (kb
, kbd_queue
);
2663 /* We shouldn't get here if we were in single-kboard mode! */
2668 while (CONSP (XCDR (last
)))
2670 if (!NILP (XCDR (last
)))
2674 kset_kbd_queue (kb
, list1 (c
));
2676 XSETCDR (last
, list1 (c
));
2677 kb
->kbd_queue_has_data
= 1;
2678 current_kboard
= kb
;
2679 /* This is going to exit from read_char
2680 so we had better get rid of this frame's stuff. */
2682 return make_number (-2); /* wrong_kboard_jmpbuf */
2688 /* Start idle timers if no time limit is supplied. We don't do it
2689 if a time limit is supplied to avoid an infinite recursion in the
2690 situation where an idle timer calls `sit-for'. */
2693 timer_start_idle ();
2695 /* If in middle of key sequence and minibuffer not active,
2696 start echoing if enough time elapses. */
2698 if (minibuf_level
== 0
2700 && !current_kboard
->immediate_echo
2701 && this_command_key_count
> 0
2703 && echo_keystrokes_p ()
2704 && (/* No message. */
2705 NILP (echo_area_buffer
[0])
2706 /* Or empty message. */
2707 || (BUF_BEG (XBUFFER (echo_area_buffer
[0]))
2708 == BUF_Z (XBUFFER (echo_area_buffer
[0])))
2709 /* Or already echoing from same kboard. */
2710 || (echo_kboard
&& ok_to_echo_at_next_pause
== echo_kboard
)
2711 /* Or not echoing before and echoing allowed. */
2712 || (!echo_kboard
&& ok_to_echo_at_next_pause
)))
2714 /* After a mouse event, start echoing right away.
2715 This is because we are probably about to display a menu,
2716 and we don't want to delay before doing so. */
2717 if (EVENT_HAS_PARAMETERS (prev_event
))
2723 save_getcjmp (save_jump
);
2724 restore_getcjmp (local_getcjmp
);
2725 tem0
= sit_for (Vecho_keystrokes
, 1, 1);
2726 restore_getcjmp (save_jump
);
2728 && ! CONSP (Vunread_command_events
))
2733 /* Maybe auto save due to number of keystrokes. */
2735 if (commandflag
!= 0 && commandflag
!= -2
2736 && auto_save_interval
> 0
2737 && num_nonmacro_input_events
- last_auto_save
> max (auto_save_interval
, 20)
2738 && !detect_input_pending_run_timers (0))
2740 Fdo_auto_save (Qnil
, Qnil
);
2741 /* Hooks can actually change some buffers in auto save. */
2745 /* Try reading using an X menu.
2746 This is never confused with reading using the minibuf
2747 because the recursive call of read_char in read_char_minibuf_menu_prompt
2748 does not pass on any keymaps. */
2750 if (KEYMAPP (map
) && INTERACTIVE
2751 && !NILP (prev_event
)
2752 && EVENT_HAS_PARAMETERS (prev_event
)
2753 && !EQ (XCAR (prev_event
), Qmenu_bar
)
2754 && !EQ (XCAR (prev_event
), Qtool_bar
)
2755 /* Don't bring up a menu if we already have another event. */
2756 && NILP (Vunread_command_events
))
2758 c
= read_char_x_menu_prompt (map
, prev_event
, used_mouse_menu
);
2760 /* Now that we have read an event, Emacs is not idle. */
2767 /* Maybe autosave and/or garbage collect due to idleness. */
2769 if (INTERACTIVE
&& NILP (c
))
2772 ptrdiff_t buffer_size
;
2774 /* Slow down auto saves logarithmically in size of current buffer,
2775 and garbage collect while we're at it. */
2776 if (! MINI_WINDOW_P (XWINDOW (selected_window
)))
2777 last_non_minibuf_size
= Z
- BEG
;
2778 buffer_size
= (last_non_minibuf_size
>> 8) + 1;
2780 while (buffer_size
> 64)
2781 delay_level
++, buffer_size
-= buffer_size
>> 2;
2782 if (delay_level
< 4) delay_level
= 4;
2783 /* delay_level is 4 for files under around 50k, 7 at 100k,
2784 9 at 200k, 11 at 300k, and 12 at 500k. It is 15 at 1 meg. */
2786 /* Auto save if enough time goes by without input. */
2787 if (commandflag
!= 0 && commandflag
!= -2
2788 && num_nonmacro_input_events
> last_auto_save
2789 && INTEGERP (Vauto_save_timeout
)
2790 && XINT (Vauto_save_timeout
) > 0)
2793 EMACS_INT timeout
= XFASTINT (Vauto_save_timeout
);
2795 timeout
= min (timeout
, MOST_POSITIVE_FIXNUM
/ delay_level
* 4);
2796 timeout
= delay_level
* timeout
/ 4;
2797 save_getcjmp (save_jump
);
2798 restore_getcjmp (local_getcjmp
);
2799 tem0
= sit_for (make_number (timeout
), 1, 1);
2800 restore_getcjmp (save_jump
);
2803 && ! CONSP (Vunread_command_events
))
2805 Fdo_auto_save (Qnil
, Qnil
);
2810 /* If there is still no input available, ask for GC. */
2811 if (!detect_input_pending_run_timers (0))
2815 /* Notify the caller if an autosave hook, or a timer, sentinel or
2816 filter in the sit_for calls above have changed the current
2817 kboard. This could happen if they use the minibuffer or start a
2818 recursive edit, like the fancy splash screen in server.el's
2819 filter. If this longjmp wasn't here, read_key_sequence would
2820 interpret the next key sequence using the wrong translation
2821 tables and function keymaps. */
2822 if (NILP (c
) && current_kboard
!= orig_kboard
)
2825 return make_number (-2); /* wrong_kboard_jmpbuf */
2828 /* If this has become non-nil here, it has been set by a timer
2829 or sentinel or filter. */
2830 if (CONSP (Vunread_command_events
))
2832 c
= XCAR (Vunread_command_events
);
2833 Vunread_command_events
= XCDR (Vunread_command_events
);
2835 if (CONSP (c
) && EQ (XCAR (c
), Qt
))
2841 /* Read something from current KBOARD's side queue, if possible. */
2845 if (current_kboard
->kbd_queue_has_data
)
2847 if (!CONSP (KVAR (current_kboard
, kbd_queue
)))
2849 c
= XCAR (KVAR (current_kboard
, kbd_queue
));
2850 kset_kbd_queue (current_kboard
,
2851 XCDR (KVAR (current_kboard
, kbd_queue
)));
2852 if (NILP (KVAR (current_kboard
, kbd_queue
)))
2853 current_kboard
->kbd_queue_has_data
= 0;
2854 input_pending
= readable_events (0);
2855 if (EVENT_HAS_PARAMETERS (c
)
2856 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qswitch_frame
))
2857 internal_last_event_frame
= XCAR (XCDR (c
));
2858 Vlast_event_frame
= internal_last_event_frame
;
2862 /* If current_kboard's side queue is empty check the other kboards.
2863 If one of them has data that we have not yet seen here,
2864 switch to it and process the data waiting for it.
2866 Note: if the events queued up for another kboard
2867 have already been seen here, and therefore are not a complete command,
2868 the kbd_queue_has_data field is 0, so we skip that kboard here.
2869 That's to avoid an infinite loop switching between kboards here. */
2870 if (NILP (c
) && !single_kboard
)
2873 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
2874 if (kb
->kbd_queue_has_data
)
2876 current_kboard
= kb
;
2877 /* This is going to exit from read_char
2878 so we had better get rid of this frame's stuff. */
2880 return make_number (-2); /* wrong_kboard_jmpbuf */
2890 c
= read_decoded_event_from_main_queue (end_time
, local_getcjmp
,
2891 prev_event
, used_mouse_menu
);
2892 if (NILP (c
) && end_time
2893 && timespec_cmp (*end_time
, current_timespec ()) <= 0)
2898 if (EQ (c
, make_number (-2)))
2900 /* This is going to exit from read_char
2901 so we had better get rid of this frame's stuff. */
2915 if (commandflag
>= 0
2916 && !input_pending
&& !detect_input_pending_run_timers (0))
2922 /* Buffer switch events are only for internal wakeups
2923 so don't show them to the user.
2924 Also, don't record a key if we already did. */
2928 /* Process special events within read_char
2929 and loop around to read another event. */
2932 tem
= access_keymap (get_keymap (Vspecial_event_map
, 0, 1), c
, 0, 0, 1);
2937 struct buffer
*prev_buffer
= current_buffer
;
2938 last_input_event
= c
;
2939 call4 (Qcommand_execute
, tem
, Qnil
, Fvector (1, &last_input_event
), Qt
);
2941 if (CONSP (c
) && EQ (XCAR (c
), Qselect_window
) && !end_time
)
2942 /* We stopped being idle for this event; undo that. This
2943 prevents automatic window selection (under
2944 mouse_autoselect_window from acting as a real input event, for
2945 example banishing the mouse under mouse-avoidance-mode. */
2946 timer_resume_idle ();
2948 if (current_buffer
!= prev_buffer
)
2950 /* The command may have changed the keymaps. Pretend there
2951 is input in another keyboard and return. This will
2952 recalculate keymaps. */
2953 c
= make_number (-2);
2960 /* Handle things that only apply to characters. */
2963 /* If kbd_buffer_get_event gave us an EOF, return that. */
2967 if ((STRINGP (KVAR (current_kboard
, Vkeyboard_translate_table
))
2968 && UNSIGNED_CMP (XFASTINT (c
), <,
2969 SCHARS (KVAR (current_kboard
,
2970 Vkeyboard_translate_table
))))
2971 || (VECTORP (KVAR (current_kboard
, Vkeyboard_translate_table
))
2972 && UNSIGNED_CMP (XFASTINT (c
), <,
2973 ASIZE (KVAR (current_kboard
,
2974 Vkeyboard_translate_table
))))
2975 || (CHAR_TABLE_P (KVAR (current_kboard
, Vkeyboard_translate_table
))
2979 d
= Faref (KVAR (current_kboard
, Vkeyboard_translate_table
), c
);
2980 /* nil in keyboard-translate-table means no translation. */
2986 /* If this event is a mouse click in the menu bar,
2987 return just menu-bar for now. Modify the mouse click event
2988 so we won't do this twice, then queue it up. */
2989 if (EVENT_HAS_PARAMETERS (c
)
2991 && CONSP (EVENT_START (c
))
2992 && CONSP (XCDR (EVENT_START (c
))))
2996 posn
= POSN_POSN (EVENT_START (c
));
2997 /* Handle menu-bar events:
2998 insert the dummy prefix event `menu-bar'. */
2999 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
3001 /* Change menu-bar to (menu-bar) as the event "position". */
3002 POSN_SET_POSN (EVENT_START (c
), list1 (posn
));
3005 Vunread_command_events
= Fcons (c
, Vunread_command_events
);
3010 /* Store these characters into recent_keys, the dribble file if any,
3011 and the keyboard macro being defined, if any. */
3013 if (! NILP (also_record
))
3014 record_char (also_record
);
3016 /* Wipe the echo area.
3017 But first, if we are about to use an input method,
3018 save the echo area contents for it to refer to. */
3020 && ! NILP (Vinput_method_function
)
3021 && ' ' <= XINT (c
) && XINT (c
) < 256 && XINT (c
) != 127)
3023 previous_echo_area_message
= Fcurrent_message ();
3024 Vinput_method_previous_message
= previous_echo_area_message
;
3027 /* Now wipe the echo area, except for help events which do their
3028 own stuff with the echo area. */
3030 || (!(EQ (Qhelp_echo
, XCAR (c
)))
3031 && !(EQ (Qswitch_frame
, XCAR (c
)))
3032 /* Don't wipe echo area for select window events: These might
3033 get delayed via `mouse-autoselect-window' (Bug#11304). */
3034 && !(EQ (Qselect_window
, XCAR (c
)))))
3036 if (!NILP (echo_area_buffer
[0]))
3038 safe_run_hooks (Qecho_area_clear_hook
);
3039 clear_message (1, 0);
3043 reread_for_input_method
:
3045 /* Pass this to the input method, if appropriate. */
3047 && ! NILP (Vinput_method_function
)
3048 /* Don't run the input method within a key sequence,
3049 after the first event of the key sequence. */
3050 && NILP (prev_event
)
3051 && ' ' <= XINT (c
) && XINT (c
) < 256 && XINT (c
) != 127)
3054 ptrdiff_t key_count
;
3055 bool key_count_reset
;
3056 struct gcpro gcpro1
;
3057 ptrdiff_t count
= SPECPDL_INDEX ();
3059 /* Save the echo status. */
3060 bool saved_immediate_echo
= current_kboard
->immediate_echo
;
3061 struct kboard
*saved_ok_to_echo
= ok_to_echo_at_next_pause
;
3062 Lisp_Object saved_echo_string
= KVAR (current_kboard
, echo_string
);
3063 ptrdiff_t saved_echo_after_prompt
= current_kboard
->echo_after_prompt
;
3066 if (before_command_restore_flag
)
3068 this_command_key_count
= before_command_key_count_1
;
3069 if (this_command_key_count
< this_single_command_key_start
)
3070 this_single_command_key_start
= this_command_key_count
;
3071 echo_truncate (before_command_echo_length_1
);
3072 before_command_restore_flag
= 0;
3076 /* Save the this_command_keys status. */
3077 key_count
= this_command_key_count
;
3078 key_count_reset
= this_command_key_count_reset
;
3081 keys
= Fcopy_sequence (this_command_keys
);
3086 /* Clear out this_command_keys. */
3087 this_command_key_count
= 0;
3088 this_command_key_count_reset
= 0;
3090 /* Now wipe the echo area. */
3091 if (!NILP (echo_area_buffer
[0]))
3092 safe_run_hooks (Qecho_area_clear_hook
);
3093 clear_message (1, 0);
3096 /* If we are not reading a key sequence,
3097 never use the echo area. */
3100 specbind (Qinput_method_use_echo_area
, Qt
);
3103 /* Call the input method. */
3104 tem
= call1 (Vinput_method_function
, c
);
3106 tem
= unbind_to (count
, tem
);
3108 /* Restore the saved echoing state
3109 and this_command_keys state. */
3110 this_command_key_count
= key_count
;
3111 this_command_key_count_reset
= key_count_reset
;
3113 this_command_keys
= keys
;
3116 ok_to_echo_at_next_pause
= saved_ok_to_echo
;
3117 kset_echo_string (current_kboard
, saved_echo_string
);
3118 current_kboard
->echo_after_prompt
= saved_echo_after_prompt
;
3119 if (saved_immediate_echo
)
3124 /* The input method can return no events. */
3127 /* Bring back the previous message, if any. */
3128 if (! NILP (previous_echo_area_message
))
3129 message_with_string ("%s", previous_echo_area_message
, 0);
3132 /* It returned one event or more. */
3134 Vunread_post_input_method_events
3135 = nconc2 (XCDR (tem
), Vunread_post_input_method_events
);
3140 /* Display help if not echoing. */
3141 if (CONSP (c
) && EQ (XCAR (c
), Qhelp_echo
))
3143 /* (help-echo FRAME HELP WINDOW OBJECT POS). */
3144 Lisp_Object help
, object
, position
, window
, htem
;
3146 htem
= Fcdr (XCDR (c
));
3149 window
= Fcar (htem
);
3151 object
= Fcar (htem
);
3153 position
= Fcar (htem
);
3155 show_help_echo (help
, window
, object
, position
);
3157 /* We stopped being idle for this event; undo that. */
3159 timer_resume_idle ();
3163 if ((! reread
|| this_command_key_count
== 0
3164 || this_command_key_count_reset
)
3168 /* Don't echo mouse motion events. */
3169 if (echo_keystrokes_p ()
3170 && ! (EVENT_HAS_PARAMETERS (c
)
3171 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
3174 if (! NILP (also_record
))
3175 echo_char (also_record
);
3176 /* Once we reread a character, echoing can happen
3177 the next time we pause to read a new one. */
3178 ok_to_echo_at_next_pause
= current_kboard
;
3181 /* Record this character as part of the current key. */
3182 add_command_key (c
);
3183 if (! NILP (also_record
))
3184 add_command_key (also_record
);
3187 last_input_event
= c
;
3190 /* Process the help character specially if enabled. */
3191 if (!NILP (Vhelp_form
) && help_char_p (c
))
3193 ptrdiff_t count
= SPECPDL_INDEX ();
3195 help_form_saved_window_configs
3196 = Fcons (Fcurrent_window_configuration (Qnil
),
3197 help_form_saved_window_configs
);
3198 record_unwind_protect_void (read_char_help_form_unwind
);
3199 call0 (Qhelp_form_show
);
3204 c
= read_char (0, Qnil
, Qnil
, 0, NULL
);
3205 if (EVENT_HAS_PARAMETERS (c
)
3206 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_click
))
3207 XSETCAR (help_form_saved_window_configs
, Qnil
);
3209 while (BUFFERP (c
));
3210 /* Remove the help from the frame. */
3211 unbind_to (count
, Qnil
);
3214 if (EQ (c
, make_number (040)))
3218 c
= read_char (0, Qnil
, Qnil
, 0, NULL
);
3219 while (BUFFERP (c
));
3228 /* Record a key that came from a mouse menu.
3229 Record it for echoing, for this-command-keys, and so on. */
3232 record_menu_key (Lisp_Object c
)
3234 /* Wipe the echo area. */
3235 clear_message (1, 0);
3240 before_command_key_count
= this_command_key_count
;
3241 before_command_echo_length
= echo_length ();
3244 /* Don't echo mouse motion events. */
3245 if (echo_keystrokes_p ())
3249 /* Once we reread a character, echoing can happen
3250 the next time we pause to read a new one. */
3251 ok_to_echo_at_next_pause
= 0;
3254 /* Record this character as part of the current key. */
3255 add_command_key (c
);
3257 /* Re-reading in the middle of a command. */
3258 last_input_event
= c
;
3262 /* Return true if should recognize C as "the help character". */
3265 help_char_p (Lisp_Object c
)
3269 if (EQ (c
, Vhelp_char
))
3271 for (tail
= Vhelp_event_list
; CONSP (tail
); tail
= XCDR (tail
))
3272 if (EQ (c
, XCAR (tail
)))
3277 /* Record the input event C in various ways. */
3280 record_char (Lisp_Object c
)
3284 if (CONSP (c
) && (EQ (XCAR (c
), Qhelp_echo
) || EQ (XCAR (c
), Qmouse_movement
)))
3286 /* To avoid filling recent_keys with help-echo and mouse-movement
3287 events, we filter out repeated help-echo events, only store the
3288 first and last in a series of mouse-movement events, and don't
3289 store repeated help-echo events which are only separated by
3290 mouse-movement events. */
3292 Lisp_Object ev1
, ev2
, ev3
;
3295 if ((ix1
= recent_keys_index
- 1) < 0)
3296 ix1
= NUM_RECENT_KEYS
- 1;
3297 ev1
= AREF (recent_keys
, ix1
);
3299 if ((ix2
= ix1
- 1) < 0)
3300 ix2
= NUM_RECENT_KEYS
- 1;
3301 ev2
= AREF (recent_keys
, ix2
);
3303 if ((ix3
= ix2
- 1) < 0)
3304 ix3
= NUM_RECENT_KEYS
- 1;
3305 ev3
= AREF (recent_keys
, ix3
);
3307 if (EQ (XCAR (c
), Qhelp_echo
))
3309 /* Don't record `help-echo' in recent_keys unless it shows some help
3310 message, and a different help than the previously recorded
3312 Lisp_Object help
, last_help
;
3314 help
= Fcar_safe (Fcdr_safe (XCDR (c
)));
3315 if (!STRINGP (help
))
3317 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qhelp_echo
)
3318 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev1
))), EQ (last_help
, help
)))
3320 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3321 && CONSP (ev2
) && EQ (XCAR (ev2
), Qhelp_echo
)
3322 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev2
))), EQ (last_help
, help
)))
3324 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3325 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3326 && CONSP (ev3
) && EQ (XCAR (ev3
), Qhelp_echo
)
3327 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev3
))), EQ (last_help
, help
)))
3330 else if (EQ (XCAR (c
), Qmouse_movement
))
3332 /* Only record one pair of `mouse-movement' on a window in recent_keys.
3333 So additional mouse movement events replace the last element. */
3334 Lisp_Object last_window
, window
;
3336 window
= Fcar_safe (Fcar_safe (XCDR (c
)));
3337 if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3338 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev1
))), EQ (last_window
, window
))
3339 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3340 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev2
))), EQ (last_window
, window
)))
3342 ASET (recent_keys
, ix1
, c
);
3348 store_kbd_macro_char (c
);
3352 total_keys
+= total_keys
< NUM_RECENT_KEYS
;
3353 ASET (recent_keys
, recent_keys_index
, c
);
3354 if (++recent_keys_index
>= NUM_RECENT_KEYS
)
3355 recent_keys_index
= 0;
3357 else if (recorded
< 0)
3359 /* We need to remove one or two events from recent_keys.
3360 To do this, we simply put nil at those events and move the
3361 recent_keys_index backwards over those events. Usually,
3362 users will never see those nil events, as they will be
3363 overwritten by the command keys entered to see recent_keys
3366 while (recorded
++ < 0 && total_keys
> 0)
3368 if (total_keys
< NUM_RECENT_KEYS
)
3370 if (--recent_keys_index
< 0)
3371 recent_keys_index
= NUM_RECENT_KEYS
- 1;
3372 ASET (recent_keys
, recent_keys_index
, Qnil
);
3376 num_nonmacro_input_events
++;
3378 /* Write c to the dribble file. If c is a lispy event, write
3379 the event's symbol to the dribble file, in <brackets>. Bleaugh.
3380 If you, dear reader, have a better idea, you've got the source. :-) */
3386 if (XUINT (c
) < 0x100)
3387 putc (XUINT (c
), dribble
);
3389 fprintf (dribble
, " 0x%"pI
"x", XUINT (c
));
3393 Lisp_Object dribblee
;
3395 /* If it's a structured event, take the event header. */
3396 dribblee
= EVENT_HEAD (c
);
3398 if (SYMBOLP (dribblee
))
3400 putc ('<', dribble
);
3401 fwrite (SDATA (SYMBOL_NAME (dribblee
)), sizeof (char),
3402 SBYTES (SYMBOL_NAME (dribblee
)),
3404 putc ('>', dribble
);
3413 /* Copy out or in the info on where C-g should throw to.
3414 This is used when running Lisp code from within get_char,
3415 in case get_char is called recursively.
3416 See read_process_output. */
3419 save_getcjmp (sys_jmp_buf temp
)
3421 memcpy (temp
, getcjmp
, sizeof getcjmp
);
3425 restore_getcjmp (sys_jmp_buf temp
)
3427 memcpy (getcjmp
, temp
, sizeof getcjmp
);
3430 /* Low level keyboard/mouse input.
3431 kbd_buffer_store_event places events in kbd_buffer, and
3432 kbd_buffer_get_event retrieves them. */
3434 /* Return true if there are any events in the queue that read-char
3435 would return. If this returns false, a read-char would block. */
3437 readable_events (int flags
)
3439 if (flags
& READABLE_EVENTS_DO_TIMERS_NOW
)
3442 /* If the buffer contains only FOCUS_IN_EVENT events, and
3443 READABLE_EVENTS_FILTER_EVENTS is set, report it as empty. */
3444 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3446 if (flags
& (READABLE_EVENTS_FILTER_EVENTS
3447 #ifdef USE_TOOLKIT_SCROLL_BARS
3448 | READABLE_EVENTS_IGNORE_SQUEEZABLES
3452 struct input_event
*event
;
3454 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
3461 #ifdef USE_TOOLKIT_SCROLL_BARS
3462 (flags
& READABLE_EVENTS_FILTER_EVENTS
) &&
3464 event
->kind
== FOCUS_IN_EVENT
)
3465 #ifdef USE_TOOLKIT_SCROLL_BARS
3466 && !((flags
& READABLE_EVENTS_IGNORE_SQUEEZABLES
)
3467 && (event
->kind
== SCROLL_BAR_CLICK_EVENT
3468 || event
->kind
== HORIZONTAL_SCROLL_BAR_CLICK_EVENT
)
3469 && event
->part
== scroll_bar_handle
3470 && event
->modifiers
== 0)
3475 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3478 while (event
!= kbd_store_ptr
);
3484 if (!(flags
& READABLE_EVENTS_IGNORE_SQUEEZABLES
)
3485 && !NILP (do_mouse_tracking
) && some_mouse_moved ())
3489 if (current_kboard
->kbd_queue_has_data
)
3495 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
3496 if (kb
->kbd_queue_has_data
)
3502 /* Set this for debugging, to have a way to get out */
3503 int stop_character EXTERNALLY_VISIBLE
;
3506 event_to_kboard (struct input_event
*event
)
3508 /* Not applicable for these special events. */
3509 if (event
->kind
== SELECTION_REQUEST_EVENT
3510 || event
->kind
== SELECTION_CLEAR_EVENT
)
3514 Lisp_Object obj
= event
->frame_or_window
;
3515 /* There are some events that set this field to nil or string. */
3517 obj
= WINDOW_FRAME (XWINDOW (obj
));
3518 /* Also ignore dead frames here. */
3519 return ((FRAMEP (obj
) && FRAME_LIVE_P (XFRAME (obj
)))
3520 ? FRAME_KBOARD (XFRAME (obj
)) : NULL
);
3525 /* Return the number of slots occupied in kbd_buffer. */
3528 kbd_buffer_nr_stored (void)
3530 return kbd_fetch_ptr
== kbd_store_ptr
3532 : (kbd_fetch_ptr
< kbd_store_ptr
3533 ? kbd_store_ptr
- kbd_fetch_ptr
3534 : ((kbd_buffer
+ KBD_BUFFER_SIZE
) - kbd_fetch_ptr
3535 + (kbd_store_ptr
- kbd_buffer
)));
3537 #endif /* Store an event obtained at interrupt level into kbd_buffer, fifo */
3540 kbd_buffer_store_event (register struct input_event
*event
)
3542 kbd_buffer_store_event_hold (event
, 0);
3545 /* Store EVENT obtained at interrupt level into kbd_buffer, fifo.
3547 If HOLD_QUIT is 0, just stuff EVENT into the fifo.
3548 Else, if HOLD_QUIT.kind != NO_EVENT, discard EVENT.
3549 Else, if EVENT is a quit event, store the quit event
3550 in HOLD_QUIT, and return (thus ignoring further events).
3552 This is used to postpone the processing of the quit event until all
3553 subsequent input events have been parsed (and discarded). */
3556 kbd_buffer_store_event_hold (register struct input_event
*event
,
3557 struct input_event
*hold_quit
)
3559 if (event
->kind
== NO_EVENT
)
3562 if (hold_quit
&& hold_quit
->kind
!= NO_EVENT
)
3565 if (event
->kind
== ASCII_KEYSTROKE_EVENT
)
3567 register int c
= event
->code
& 0377;
3569 if (event
->modifiers
& ctrl_modifier
)
3570 c
= make_ctrl_char (c
);
3572 c
|= (event
->modifiers
3573 & (meta_modifier
| alt_modifier
3574 | hyper_modifier
| super_modifier
));
3578 KBOARD
*kb
= FRAME_KBOARD (XFRAME (event
->frame_or_window
));
3579 struct input_event
*sp
;
3581 if (single_kboard
&& kb
!= current_kboard
)
3584 (kb
, list2 (make_lispy_switch_frame (event
->frame_or_window
),
3586 kb
->kbd_queue_has_data
= 1;
3587 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3589 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3592 if (event_to_kboard (sp
) == kb
)
3594 sp
->kind
= NO_EVENT
;
3595 sp
->frame_or_window
= Qnil
;
3604 *hold_quit
= *event
;
3608 /* If this results in a quit_char being returned to Emacs as
3609 input, set Vlast_event_frame properly. If this doesn't
3610 get returned to Emacs as an event, the next event read
3611 will set Vlast_event_frame again, so this is safe to do. */
3615 focus
= FRAME_FOCUS_FRAME (XFRAME (event
->frame_or_window
));
3617 focus
= event
->frame_or_window
;
3618 internal_last_event_frame
= focus
;
3619 Vlast_event_frame
= focus
;
3622 handle_interrupt (0);
3626 if (c
&& c
== stop_character
)
3632 /* Don't insert two BUFFER_SWITCH_EVENT's in a row.
3633 Just ignore the second one. */
3634 else if (event
->kind
== BUFFER_SWITCH_EVENT
3635 && kbd_fetch_ptr
!= kbd_store_ptr
3636 && ((kbd_store_ptr
== kbd_buffer
3637 ? kbd_buffer
+ KBD_BUFFER_SIZE
- 1
3638 : kbd_store_ptr
- 1)->kind
) == BUFFER_SWITCH_EVENT
)
3641 if (kbd_store_ptr
- kbd_buffer
== KBD_BUFFER_SIZE
)
3642 kbd_store_ptr
= kbd_buffer
;
3644 /* Don't let the very last slot in the buffer become full,
3645 since that would make the two pointers equal,
3646 and that is indistinguishable from an empty buffer.
3647 Discard the event if it would fill the last slot. */
3648 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
3650 *kbd_store_ptr
= *event
;
3653 if (kbd_buffer_nr_stored () > KBD_BUFFER_SIZE
/ 2
3654 && ! kbd_on_hold_p ())
3656 /* Don't read keyboard input until we have processed kbd_buffer.
3657 This happens when pasting text longer than KBD_BUFFER_SIZE/2. */
3658 hold_keyboard_input ();
3659 if (!noninteractive
)
3663 #endif /* subprocesses */
3666 /* If we're inside while-no-input, and this event qualifies
3667 as input, set quit-flag to cause an interrupt. */
3668 if (!NILP (Vthrow_on_input
)
3669 && event
->kind
!= FOCUS_IN_EVENT
3670 && event
->kind
!= HELP_EVENT
3671 && event
->kind
!= DEICONIFY_EVENT
)
3673 Vquit_flag
= Vthrow_on_input
;
3674 /* If we're inside a function that wants immediate quits,
3676 if (immediate_quit
&& NILP (Vinhibit_quit
))
3685 /* Put an input event back in the head of the event queue. */
3688 kbd_buffer_unget_event (register struct input_event
*event
)
3690 if (kbd_fetch_ptr
== kbd_buffer
)
3691 kbd_fetch_ptr
= kbd_buffer
+ KBD_BUFFER_SIZE
;
3693 /* Don't let the very last slot in the buffer become full, */
3694 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
3697 *kbd_fetch_ptr
= *event
;
3702 /* Generate a HELP_EVENT input_event and store it in the keyboard
3705 HELP is the help form.
3707 FRAME and WINDOW are the frame and window where the help is
3708 generated. OBJECT is the Lisp object where the help was found (a
3709 buffer, a string, an overlay, or nil if neither from a string nor
3710 from a buffer). POS is the position within OBJECT where the help
3714 gen_help_event (Lisp_Object help
, Lisp_Object frame
, Lisp_Object window
,
3715 Lisp_Object object
, ptrdiff_t pos
)
3717 struct input_event event
;
3721 event
.kind
= HELP_EVENT
;
3722 event
.frame_or_window
= frame
;
3724 event
.x
= WINDOWP (window
) ? window
: frame
;
3727 kbd_buffer_store_event (&event
);
3731 /* Store HELP_EVENTs for HELP on FRAME in the input queue. */
3734 kbd_buffer_store_help_event (Lisp_Object frame
, Lisp_Object help
)
3736 struct input_event event
;
3738 event
.kind
= HELP_EVENT
;
3739 event
.frame_or_window
= frame
;
3744 kbd_buffer_store_event (&event
);
3748 /* Discard any mouse events in the event buffer by setting them to
3751 discard_mouse_events (void)
3753 struct input_event
*sp
;
3754 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3756 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3759 if (sp
->kind
== MOUSE_CLICK_EVENT
3760 || sp
->kind
== WHEEL_EVENT
3761 || sp
->kind
== HORIZ_WHEEL_EVENT
3763 || sp
->kind
== GPM_CLICK_EVENT
3765 || sp
->kind
== SCROLL_BAR_CLICK_EVENT
3766 || sp
->kind
== HORIZONTAL_SCROLL_BAR_CLICK_EVENT
)
3768 sp
->kind
= NO_EVENT
;
3774 /* Return true if there are any real events waiting in the event
3775 buffer, not counting `NO_EVENT's.
3777 Discard NO_EVENT events at the front of the input queue, possibly
3778 leaving the input queue empty if there are no real input events. */
3781 kbd_buffer_events_waiting (void)
3783 struct input_event
*sp
;
3785 for (sp
= kbd_fetch_ptr
;
3786 sp
!= kbd_store_ptr
&& sp
->kind
== NO_EVENT
;
3789 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3794 return sp
!= kbd_store_ptr
&& sp
->kind
!= NO_EVENT
;
3798 /* Clear input event EVENT. */
3801 clear_event (struct input_event
*event
)
3803 event
->kind
= NO_EVENT
;
3807 /* Read one event from the event buffer, waiting if necessary.
3808 The value is a Lisp object representing the event.
3809 The value is nil for an event that should be ignored,
3810 or that was handled here.
3811 We always read and discard one event. */
3814 kbd_buffer_get_event (KBOARD
**kbp
,
3815 bool *used_mouse_menu
,
3816 struct timespec
*end_time
)
3821 if (kbd_on_hold_p () && kbd_buffer_nr_stored () < KBD_BUFFER_SIZE
/4)
3823 /* Start reading input again because we have processed enough to
3824 be able to accept new events again. */
3825 unhold_keyboard_input ();
3828 #endif /* subprocesses */
3830 #if !defined HAVE_DBUS && !defined USE_FILE_NOTIFY
3832 /* In case we are running as a daemon, only do this before
3833 detaching from the terminal. */
3834 || (IS_DAEMON
&& daemon_pipe
[1] >= 0))
3838 *kbp
= current_kboard
;
3841 #endif /* !defined HAVE_DBUS && !defined USE_FILE_NOTIFY */
3843 /* Wait until there is input available. */
3846 /* Break loop if there's an unread command event. Needed in
3847 moused window autoselection which uses a timer to insert such
3849 if (CONSP (Vunread_command_events
))
3852 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3854 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3857 /* If the quit flag is set, then read_char will return
3858 quit_char, so that counts as "available input." */
3859 if (!NILP (Vquit_flag
))
3860 quit_throw_to_read_char (0);
3862 /* One way or another, wait until input is available; then, if
3863 interrupt handlers have not read it, read it now. */
3868 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3870 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3874 struct timespec now
= current_timespec ();
3875 if (timespec_cmp (*end_time
, now
) <= 0)
3876 return Qnil
; /* Finished waiting. */
3879 struct timespec duration
= timespec_sub (*end_time
, now
);
3880 wait_reading_process_output (min (duration
.tv_sec
,
3883 -1, 1, Qnil
, NULL
, 0);
3888 bool do_display
= true;
3890 if (FRAME_TERMCAP_P (SELECTED_FRAME ()))
3892 struct tty_display_info
*tty
= CURTTY ();
3894 /* When this TTY is displaying a menu, we must prevent
3895 any redisplay, because we modify the frame's glyph
3896 matrix behind the back of the display engine. */
3897 if (tty
->showing_menu
)
3901 wait_reading_process_output (0, 0, -1, do_display
, Qnil
, NULL
, 0);
3904 if (!interrupt_input
&& kbd_fetch_ptr
== kbd_store_ptr
)
3908 if (CONSP (Vunread_command_events
))
3911 first
= XCAR (Vunread_command_events
);
3912 Vunread_command_events
= XCDR (Vunread_command_events
);
3913 *kbp
= current_kboard
;
3917 /* At this point, we know that there is a readable event available
3918 somewhere. If the event queue is empty, then there must be a
3919 mouse movement enabled and available. */
3920 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3922 struct input_event
*event
;
3924 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
3928 *kbp
= event_to_kboard (event
);
3930 *kbp
= current_kboard
; /* Better than returning null ptr? */
3934 /* These two kinds of events get special handling
3935 and don't actually appear to the command loop.
3936 We return nil for them. */
3937 if (event
->kind
== SELECTION_REQUEST_EVENT
3938 || event
->kind
== SELECTION_CLEAR_EVENT
)
3941 struct input_event copy
;
3943 /* Remove it from the buffer before processing it,
3944 since otherwise swallow_events will see it
3945 and process it again. */
3947 kbd_fetch_ptr
= event
+ 1;
3948 input_pending
= readable_events (0);
3949 x_handle_selection_event (©
);
3951 /* We're getting selection request events, but we don't have
3957 #if defined (HAVE_NS)
3958 else if (event
->kind
== NS_TEXT_EVENT
)
3960 if (event
->code
== KEY_NS_PUT_WORKING_TEXT
)
3961 obj
= list1 (intern ("ns-put-working-text"));
3963 obj
= list1 (intern ("ns-unput-working-text"));
3964 kbd_fetch_ptr
= event
+ 1;
3965 if (used_mouse_menu
)
3966 *used_mouse_menu
= 1;
3970 #if defined (HAVE_X11) || defined (HAVE_NTGUI) \
3971 || defined (HAVE_NS)
3972 else if (event
->kind
== DELETE_WINDOW_EVENT
)
3974 /* Make an event (delete-frame (FRAME)). */
3975 obj
= list2 (Qdelete_frame
, list1 (event
->frame_or_window
));
3976 kbd_fetch_ptr
= event
+ 1;
3979 #if defined (HAVE_X11) || defined (HAVE_NTGUI) \
3980 || defined (HAVE_NS)
3981 else if (event
->kind
== ICONIFY_EVENT
)
3983 /* Make an event (iconify-frame (FRAME)). */
3984 obj
= list2 (Qiconify_frame
, list1 (event
->frame_or_window
));
3985 kbd_fetch_ptr
= event
+ 1;
3987 else if (event
->kind
== DEICONIFY_EVENT
)
3989 /* Make an event (make-frame-visible (FRAME)). */
3990 obj
= list2 (Qmake_frame_visible
, list1 (event
->frame_or_window
));
3991 kbd_fetch_ptr
= event
+ 1;
3994 else if (event
->kind
== BUFFER_SWITCH_EVENT
)
3996 /* The value doesn't matter here; only the type is tested. */
3997 XSETBUFFER (obj
, current_buffer
);
3998 kbd_fetch_ptr
= event
+ 1;
4000 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
4001 || defined (HAVE_NS) || defined (USE_GTK)
4002 else if (event
->kind
== MENU_BAR_ACTIVATE_EVENT
)
4004 kbd_fetch_ptr
= event
+ 1;
4005 input_pending
= readable_events (0);
4006 if (FRAME_LIVE_P (XFRAME (event
->frame_or_window
)))
4007 x_activate_menubar (XFRAME (event
->frame_or_window
));
4011 else if (event
->kind
== LANGUAGE_CHANGE_EVENT
)
4013 /* Make an event (language-change FRAME CODEPAGE LANGUAGE-ID). */
4014 obj
= list4 (Qlanguage_change
,
4015 event
->frame_or_window
,
4016 make_number (event
->code
),
4017 make_number (event
->modifiers
));
4018 kbd_fetch_ptr
= event
+ 1;
4021 #ifdef USE_FILE_NOTIFY
4022 else if (event
->kind
== FILE_NOTIFY_EVENT
)
4024 #ifdef HAVE_W32NOTIFY
4025 /* Make an event (file-notify (DESCRIPTOR ACTION FILE) CALLBACK). */
4026 obj
= list3 (Qfile_notify
,
4027 list3 (make_number (event
->code
),
4030 event
->frame_or_window
);
4032 obj
= make_lispy_event (event
);
4034 kbd_fetch_ptr
= event
+ 1;
4036 #endif /* USE_FILE_NOTIFY */
4037 else if (event
->kind
== SAVE_SESSION_EVENT
)
4039 obj
= list2 (Qsave_session
, event
->arg
);
4040 kbd_fetch_ptr
= event
+ 1;
4042 /* Just discard these, by returning nil.
4043 With MULTI_KBOARD, these events are used as placeholders
4044 when we need to randomly delete events from the queue.
4045 (They shouldn't otherwise be found in the buffer,
4046 but on some machines it appears they do show up
4047 even without MULTI_KBOARD.) */
4048 /* On Windows NT/9X, NO_EVENT is used to delete extraneous
4049 mouse events during a popup-menu call. */
4050 else if (event
->kind
== NO_EVENT
)
4051 kbd_fetch_ptr
= event
+ 1;
4052 else if (event
->kind
== HELP_EVENT
)
4054 Lisp_Object object
, position
, help
, frame
, window
;
4056 frame
= event
->frame_or_window
;
4057 object
= event
->arg
;
4058 position
= make_number (event
->code
);
4061 clear_event (event
);
4063 kbd_fetch_ptr
= event
+ 1;
4064 if (!WINDOWP (window
))
4066 obj
= Fcons (Qhelp_echo
,
4067 list5 (frame
, help
, window
, object
, position
));
4069 else if (event
->kind
== FOCUS_IN_EVENT
)
4071 /* Notification of a FocusIn event. The frame receiving the
4072 focus is in event->frame_or_window. Generate a
4073 switch-frame event if necessary. */
4074 Lisp_Object frame
, focus
;
4076 frame
= event
->frame_or_window
;
4077 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
4086 !EQ (frame
, internal_last_event_frame
)
4087 && !EQ (frame
, selected_frame
))
4088 obj
= make_lispy_switch_frame (frame
);
4090 obj
= make_lispy_focus_in (frame
);
4092 internal_last_event_frame
= frame
;
4093 kbd_fetch_ptr
= event
+ 1;
4095 else if (event
->kind
== FOCUS_OUT_EVENT
)
4097 #ifdef HAVE_WINDOW_SYSTEM
4100 Lisp_Object frame
= event
->frame_or_window
;
4101 bool focused
= false;
4103 for (di
= x_display_list
; di
&& ! focused
; di
= di
->next
)
4104 focused
= di
->x_highlight_frame
!= 0;
4107 obj
= make_lispy_focus_out (frame
);
4109 #endif /* HAVE_WINDOW_SYSTEM */
4111 kbd_fetch_ptr
= event
+ 1;
4114 else if (event
->kind
== DBUS_EVENT
)
4116 obj
= make_lispy_event (event
);
4117 kbd_fetch_ptr
= event
+ 1;
4120 else if (event
->kind
== CONFIG_CHANGED_EVENT
)
4122 obj
= make_lispy_event (event
);
4123 kbd_fetch_ptr
= event
+ 1;
4127 /* If this event is on a different frame, return a switch-frame this
4128 time, and leave the event in the queue for next time. */
4132 frame
= event
->frame_or_window
;
4134 frame
= XCAR (frame
);
4135 else if (WINDOWP (frame
))
4136 frame
= WINDOW_FRAME (XWINDOW (frame
));
4138 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
4142 if (! EQ (frame
, internal_last_event_frame
)
4143 && !EQ (frame
, selected_frame
))
4144 obj
= make_lispy_switch_frame (frame
);
4145 internal_last_event_frame
= frame
;
4147 /* If we didn't decide to make a switch-frame event, go ahead
4148 and build a real event from the queue entry. */
4152 obj
= make_lispy_event (event
);
4154 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
4155 || defined (HAVE_NS) || defined (USE_GTK)
4156 /* If this was a menu selection, then set the flag to inhibit
4157 writing to last_nonmenu_event. Don't do this if the event
4158 we're returning is (menu-bar), though; that indicates the
4159 beginning of the menu sequence, and we might as well leave
4160 that as the `event with parameters' for this selection. */
4162 && !EQ (event
->frame_or_window
, event
->arg
)
4163 && (event
->kind
== MENU_BAR_EVENT
4164 || event
->kind
== TOOL_BAR_EVENT
))
4165 *used_mouse_menu
= 1;
4168 /* Certain system events are non-key events. */
4170 && event
->kind
== NS_NONKEY_EVENT
)
4171 *used_mouse_menu
= 1;
4174 /* Wipe out this event, to catch bugs. */
4175 clear_event (event
);
4176 kbd_fetch_ptr
= event
+ 1;
4180 /* Try generating a mouse motion event. */
4181 else if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
4183 struct frame
*f
= some_mouse_moved ();
4184 Lisp_Object bar_window
;
4185 enum scroll_bar_part part
;
4189 *kbp
= current_kboard
;
4190 /* Note that this uses F to determine which terminal to look at.
4191 If there is no valid info, it does not store anything
4192 so x remains nil. */
4195 /* XXX Can f or mouse_position_hook be NULL here? */
4196 if (f
&& FRAME_TERMINAL (f
)->mouse_position_hook
)
4197 (*FRAME_TERMINAL (f
)->mouse_position_hook
) (&f
, 0, &bar_window
,
4202 /* Decide if we should generate a switch-frame event. Don't
4203 generate switch-frame events for motion outside of all Emacs
4209 frame
= FRAME_FOCUS_FRAME (f
);
4211 XSETFRAME (frame
, f
);
4213 if (! EQ (frame
, internal_last_event_frame
)
4214 && !EQ (frame
, selected_frame
))
4215 obj
= make_lispy_switch_frame (frame
);
4216 internal_last_event_frame
= frame
;
4219 /* If we didn't decide to make a switch-frame event, go ahead and
4220 return a mouse-motion event. */
4221 if (!NILP (x
) && NILP (obj
))
4222 obj
= make_lispy_movement (f
, bar_window
, part
, x
, y
, t
);
4225 /* We were promised by the above while loop that there was
4226 something for us to read! */
4229 input_pending
= readable_events (0);
4231 Vlast_event_frame
= internal_last_event_frame
;
4236 /* Process any non-user-visible events (currently X selection events),
4237 without reading any user-visible events. */
4240 process_special_events (void)
4242 struct input_event
*event
;
4244 for (event
= kbd_fetch_ptr
; event
!= kbd_store_ptr
; ++event
)
4246 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
4249 if (event
== kbd_store_ptr
)
4253 /* If we find a stored X selection request, handle it now. */
4254 if (event
->kind
== SELECTION_REQUEST_EVENT
4255 || event
->kind
== SELECTION_CLEAR_EVENT
)
4259 /* Remove the event from the fifo buffer before processing;
4260 otherwise swallow_events called recursively could see it
4261 and process it again. To do this, we move the events
4262 between kbd_fetch_ptr and EVENT one slot to the right,
4265 struct input_event copy
= *event
;
4266 struct input_event
*beg
4267 = (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
4268 ? kbd_buffer
: kbd_fetch_ptr
;
4271 memmove (beg
+ 1, beg
, (event
- beg
) * sizeof (struct input_event
));
4272 else if (event
< beg
)
4274 if (event
> kbd_buffer
)
4275 memmove (kbd_buffer
+ 1, kbd_buffer
,
4276 (event
- kbd_buffer
) * sizeof (struct input_event
));
4277 *kbd_buffer
= *(kbd_buffer
+ KBD_BUFFER_SIZE
- 1);
4278 if (beg
< kbd_buffer
+ KBD_BUFFER_SIZE
- 1)
4279 memmove (beg
+ 1, beg
,
4280 (kbd_buffer
+ KBD_BUFFER_SIZE
- 1 - beg
)
4281 * sizeof (struct input_event
));
4284 if (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
4285 kbd_fetch_ptr
= kbd_buffer
+ 1;
4289 input_pending
= readable_events (0);
4290 x_handle_selection_event (©
);
4292 /* We're getting selection request events, but we don't have
4300 /* Process any events that are not user-visible, run timer events that
4301 are ripe, and return, without reading any user-visible events. */
4304 swallow_events (bool do_display
)
4306 unsigned old_timers_run
;
4308 process_special_events ();
4310 old_timers_run
= timers_run
;
4311 get_input_pending (READABLE_EVENTS_DO_TIMERS_NOW
);
4313 if (timers_run
!= old_timers_run
&& do_display
)
4314 redisplay_preserve_echo_area (7);
4317 /* Record the start of when Emacs is idle,
4318 for the sake of running idle-time timers. */
4321 timer_start_idle (void)
4323 /* If we are already in the idle state, do nothing. */
4324 if (timespec_valid_p (timer_idleness_start_time
))
4327 timer_idleness_start_time
= current_timespec ();
4328 timer_last_idleness_start_time
= timer_idleness_start_time
;
4330 /* Mark all idle-time timers as once again candidates for running. */
4331 call0 (intern ("internal-timer-start-idle"));
4334 /* Record that Emacs is no longer idle, so stop running idle-time timers. */
4337 timer_stop_idle (void)
4339 timer_idleness_start_time
= invalid_timespec ();
4342 /* Resume idle timer from last idle start time. */
4345 timer_resume_idle (void)
4347 if (timespec_valid_p (timer_idleness_start_time
))
4350 timer_idleness_start_time
= timer_last_idleness_start_time
;
4353 /* This is only for debugging. */
4354 struct input_event last_timer_event EXTERNALLY_VISIBLE
;
4356 /* List of elisp functions to call, delayed because they were generated in
4357 a context where Elisp could not be safely run (e.g. redisplay, signal,
4358 ...). Each element has the form (FUN . ARGS). */
4359 Lisp_Object pending_funcalls
;
4361 /* Return true if TIMER is a valid timer, placing its value into *RESULT. */
4363 decode_timer (Lisp_Object timer
, struct timespec
*result
)
4365 Lisp_Object
*vector
;
4367 if (! (VECTORP (timer
) && ASIZE (timer
) == 9))
4369 vector
= XVECTOR (timer
)->contents
;
4370 if (! NILP (vector
[0]))
4373 return decode_time_components (vector
[1], vector
[2], vector
[3], vector
[8],
4378 /* Check whether a timer has fired. To prevent larger problems we simply
4379 disregard elements that are not proper timers. Do not make a circular
4380 timer list for the time being.
4382 Returns the time to wait until the next timer fires. If a
4383 timer is triggering now, return zero.
4384 If no timer is active, return -1.
4386 If a timer is ripe, we run it, with quitting turned off.
4387 In that case we return 0 to indicate that a new timer_check_2 call
4390 static struct timespec
4391 timer_check_2 (Lisp_Object timers
, Lisp_Object idle_timers
)
4393 struct timespec nexttime
;
4394 struct timespec now
;
4395 struct timespec idleness_now
;
4396 Lisp_Object chosen_timer
;
4397 struct gcpro gcpro1
;
4399 nexttime
= invalid_timespec ();
4401 chosen_timer
= Qnil
;
4402 GCPRO1 (chosen_timer
);
4404 /* First run the code that was delayed. */
4405 while (CONSP (pending_funcalls
))
4407 Lisp_Object funcall
= XCAR (pending_funcalls
);
4408 pending_funcalls
= XCDR (pending_funcalls
);
4409 safe_call2 (Qapply
, XCAR (funcall
), XCDR (funcall
));
4412 if (CONSP (timers
) || CONSP (idle_timers
))
4414 now
= current_timespec ();
4415 idleness_now
= (timespec_valid_p (timer_idleness_start_time
)
4416 ? timespec_sub (now
, timer_idleness_start_time
)
4417 : make_timespec (0, 0));
4420 while (CONSP (timers
) || CONSP (idle_timers
))
4422 Lisp_Object timer
= Qnil
, idle_timer
= Qnil
;
4423 struct timespec timer_time
, idle_timer_time
;
4424 struct timespec difference
;
4425 struct timespec timer_difference
= invalid_timespec ();
4426 struct timespec idle_timer_difference
= invalid_timespec ();
4427 bool ripe
, timer_ripe
= 0, idle_timer_ripe
= 0;
4429 /* Set TIMER and TIMER_DIFFERENCE
4430 based on the next ordinary timer.
4431 TIMER_DIFFERENCE is the distance in time from NOW to when
4432 this timer becomes ripe (negative if it's already ripe).
4433 Skip past invalid timers and timers already handled. */
4436 timer
= XCAR (timers
);
4437 if (! decode_timer (timer
, &timer_time
))
4439 timers
= XCDR (timers
);
4443 timer_ripe
= timespec_cmp (timer_time
, now
) <= 0;
4444 timer_difference
= (timer_ripe
4445 ? timespec_sub (now
, timer_time
)
4446 : timespec_sub (timer_time
, now
));
4449 /* Likewise for IDLE_TIMER and IDLE_TIMER_DIFFERENCE
4450 based on the next idle timer. */
4451 if (CONSP (idle_timers
))
4453 idle_timer
= XCAR (idle_timers
);
4454 if (! decode_timer (idle_timer
, &idle_timer_time
))
4456 idle_timers
= XCDR (idle_timers
);
4460 idle_timer_ripe
= timespec_cmp (idle_timer_time
, idleness_now
) <= 0;
4461 idle_timer_difference
4463 ? timespec_sub (idleness_now
, idle_timer_time
)
4464 : timespec_sub (idle_timer_time
, idleness_now
));
4467 /* Decide which timer is the next timer,
4468 and set CHOSEN_TIMER, DIFFERENCE, and RIPE accordingly.
4469 Also step down the list where we found that timer. */
4471 if (timespec_valid_p (timer_difference
)
4472 && (! timespec_valid_p (idle_timer_difference
)
4473 || idle_timer_ripe
< timer_ripe
4474 || (idle_timer_ripe
== timer_ripe
4476 ? timespec_cmp (idle_timer_difference
,
4478 : timespec_cmp (timer_difference
,
4479 idle_timer_difference
))
4482 chosen_timer
= timer
;
4483 timers
= XCDR (timers
);
4484 difference
= timer_difference
;
4489 chosen_timer
= idle_timer
;
4490 idle_timers
= XCDR (idle_timers
);
4491 difference
= idle_timer_difference
;
4492 ripe
= idle_timer_ripe
;
4495 /* If timer is ripe, run it if it hasn't been run. */
4498 if (NILP (AREF (chosen_timer
, 0)))
4500 ptrdiff_t count
= SPECPDL_INDEX ();
4501 Lisp_Object old_deactivate_mark
= Vdeactivate_mark
;
4503 /* Mark the timer as triggered to prevent problems if the lisp
4504 code fails to reschedule it right. */
4505 ASET (chosen_timer
, 0, Qt
);
4507 specbind (Qinhibit_quit
, Qt
);
4509 call1 (Qtimer_event_handler
, chosen_timer
);
4510 Vdeactivate_mark
= old_deactivate_mark
;
4512 unbind_to (count
, Qnil
);
4514 /* Since we have handled the event,
4515 we don't need to tell the caller to wake up and do it. */
4516 /* But the caller must still wait for the next timer, so
4517 return 0 to indicate that. */
4520 nexttime
= make_timespec (0, 0);
4524 /* When we encounter a timer that is still waiting,
4525 return the amount of time to wait before it is ripe. */
4532 /* No timers are pending in the future. */
4533 /* Return 0 if we generated an event, and -1 if not. */
4539 /* Check whether a timer has fired. To prevent larger problems we simply
4540 disregard elements that are not proper timers. Do not make a circular
4541 timer list for the time being.
4543 Returns the time to wait until the next timer fires.
4544 If no timer is active, return an invalid value.
4546 As long as any timer is ripe, we run it. */
4551 struct timespec nexttime
;
4552 Lisp_Object timers
, idle_timers
;
4553 struct gcpro gcpro1
, gcpro2
;
4555 Lisp_Object tem
= Vinhibit_quit
;
4558 /* We use copies of the timers' lists to allow a timer to add itself
4559 again, without locking up Emacs if the newly added timer is
4560 already ripe when added. */
4562 /* Always consider the ordinary timers. */
4563 timers
= Fcopy_sequence (Vtimer_list
);
4564 /* Consider the idle timers only if Emacs is idle. */
4565 if (timespec_valid_p (timer_idleness_start_time
))
4566 idle_timers
= Fcopy_sequence (Vtimer_idle_list
);
4570 Vinhibit_quit
= tem
;
4572 GCPRO2 (timers
, idle_timers
);
4576 nexttime
= timer_check_2 (timers
, idle_timers
);
4578 while (nexttime
.tv_sec
== 0 && nexttime
.tv_nsec
== 0);
4584 DEFUN ("current-idle-time", Fcurrent_idle_time
, Scurrent_idle_time
, 0, 0, 0,
4585 doc
: /* Return the current length of Emacs idleness, or nil.
4586 The value when Emacs is idle is a list of four integers (HIGH LOW USEC PSEC)
4587 in the same style as (current-time).
4589 The value when Emacs is not idle is nil.
4591 PSEC is a multiple of the system clock resolution. */)
4594 if (timespec_valid_p (timer_idleness_start_time
))
4595 return make_lisp_time (timespec_sub (current_timespec (),
4596 timer_idleness_start_time
));
4601 /* Caches for modify_event_symbol. */
4602 static Lisp_Object accent_key_syms
;
4603 static Lisp_Object func_key_syms
;
4604 static Lisp_Object mouse_syms
;
4605 static Lisp_Object wheel_syms
;
4606 static Lisp_Object drag_n_drop_syms
;
4608 /* This is a list of keysym codes for special "accent" characters.
4609 It parallels lispy_accent_keys. */
4611 static const int lispy_accent_codes
[] =
4613 #ifdef XK_dead_circumflex
4618 #ifdef XK_dead_grave
4623 #ifdef XK_dead_tilde
4628 #ifdef XK_dead_diaeresis
4633 #ifdef XK_dead_macron
4638 #ifdef XK_dead_degree
4643 #ifdef XK_dead_acute
4648 #ifdef XK_dead_cedilla
4653 #ifdef XK_dead_breve
4658 #ifdef XK_dead_ogonek
4663 #ifdef XK_dead_caron
4668 #ifdef XK_dead_doubleacute
4669 XK_dead_doubleacute
,
4673 #ifdef XK_dead_abovedot
4678 #ifdef XK_dead_abovering
4688 #ifdef XK_dead_belowdot
4693 #ifdef XK_dead_voiced_sound
4694 XK_dead_voiced_sound
,
4698 #ifdef XK_dead_semivoiced_sound
4699 XK_dead_semivoiced_sound
,
4715 /* This is a list of Lisp names for special "accent" characters.
4716 It parallels lispy_accent_codes. */
4718 static const char *const lispy_accent_keys
[] =
4736 "dead-voiced-sound",
4737 "dead-semivoiced-sound",
4743 #define FUNCTION_KEY_OFFSET 0x0
4745 const char *const lispy_function_keys
[] =
4749 0, /* VK_LBUTTON 0x01 */
4750 0, /* VK_RBUTTON 0x02 */
4751 "cancel", /* VK_CANCEL 0x03 */
4752 0, /* VK_MBUTTON 0x04 */
4754 0, 0, 0, /* 0x05 .. 0x07 */
4756 "backspace", /* VK_BACK 0x08 */
4757 "tab", /* VK_TAB 0x09 */
4759 0, 0, /* 0x0A .. 0x0B */
4761 "clear", /* VK_CLEAR 0x0C */
4762 "return", /* VK_RETURN 0x0D */
4764 0, 0, /* 0x0E .. 0x0F */
4766 0, /* VK_SHIFT 0x10 */
4767 0, /* VK_CONTROL 0x11 */
4768 0, /* VK_MENU 0x12 */
4769 "pause", /* VK_PAUSE 0x13 */
4770 "capslock", /* VK_CAPITAL 0x14 */
4771 "kana", /* VK_KANA/VK_HANGUL 0x15 */
4773 "junja", /* VK_JUNJA 0x17 */
4774 "final", /* VK_FINAL 0x18 */
4775 "kanji", /* VK_KANJI/VK_HANJA 0x19 */
4777 "escape", /* VK_ESCAPE 0x1B */
4778 "convert", /* VK_CONVERT 0x1C */
4779 "non-convert", /* VK_NONCONVERT 0x1D */
4780 "accept", /* VK_ACCEPT 0x1E */
4781 "mode-change", /* VK_MODECHANGE 0x1F */
4782 0, /* VK_SPACE 0x20 */
4783 "prior", /* VK_PRIOR 0x21 */
4784 "next", /* VK_NEXT 0x22 */
4785 "end", /* VK_END 0x23 */
4786 "home", /* VK_HOME 0x24 */
4787 "left", /* VK_LEFT 0x25 */
4788 "up", /* VK_UP 0x26 */
4789 "right", /* VK_RIGHT 0x27 */
4790 "down", /* VK_DOWN 0x28 */
4791 "select", /* VK_SELECT 0x29 */
4792 "print", /* VK_PRINT 0x2A */
4793 "execute", /* VK_EXECUTE 0x2B */
4794 "snapshot", /* VK_SNAPSHOT 0x2C */
4795 "insert", /* VK_INSERT 0x2D */
4796 "delete", /* VK_DELETE 0x2E */
4797 "help", /* VK_HELP 0x2F */
4799 /* VK_0 thru VK_9 are the same as ASCII '0' thru '9' (0x30 - 0x39) */
4801 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4803 0, 0, 0, 0, 0, 0, 0, /* 0x3A .. 0x40 */
4805 /* VK_A thru VK_Z are the same as ASCII 'A' thru 'Z' (0x41 - 0x5A) */
4807 0, 0, 0, 0, 0, 0, 0, 0, 0,
4808 0, 0, 0, 0, 0, 0, 0, 0, 0,
4809 0, 0, 0, 0, 0, 0, 0, 0,
4811 "lwindow", /* VK_LWIN 0x5B */
4812 "rwindow", /* VK_RWIN 0x5C */
4813 "apps", /* VK_APPS 0x5D */
4816 "kp-0", /* VK_NUMPAD0 0x60 */
4817 "kp-1", /* VK_NUMPAD1 0x61 */
4818 "kp-2", /* VK_NUMPAD2 0x62 */
4819 "kp-3", /* VK_NUMPAD3 0x63 */
4820 "kp-4", /* VK_NUMPAD4 0x64 */
4821 "kp-5", /* VK_NUMPAD5 0x65 */
4822 "kp-6", /* VK_NUMPAD6 0x66 */
4823 "kp-7", /* VK_NUMPAD7 0x67 */
4824 "kp-8", /* VK_NUMPAD8 0x68 */
4825 "kp-9", /* VK_NUMPAD9 0x69 */
4826 "kp-multiply", /* VK_MULTIPLY 0x6A */
4827 "kp-add", /* VK_ADD 0x6B */
4828 "kp-separator", /* VK_SEPARATOR 0x6C */
4829 "kp-subtract", /* VK_SUBTRACT 0x6D */
4830 "kp-decimal", /* VK_DECIMAL 0x6E */
4831 "kp-divide", /* VK_DIVIDE 0x6F */
4832 "f1", /* VK_F1 0x70 */
4833 "f2", /* VK_F2 0x71 */
4834 "f3", /* VK_F3 0x72 */
4835 "f4", /* VK_F4 0x73 */
4836 "f5", /* VK_F5 0x74 */
4837 "f6", /* VK_F6 0x75 */
4838 "f7", /* VK_F7 0x76 */
4839 "f8", /* VK_F8 0x77 */
4840 "f9", /* VK_F9 0x78 */
4841 "f10", /* VK_F10 0x79 */
4842 "f11", /* VK_F11 0x7A */
4843 "f12", /* VK_F12 0x7B */
4844 "f13", /* VK_F13 0x7C */
4845 "f14", /* VK_F14 0x7D */
4846 "f15", /* VK_F15 0x7E */
4847 "f16", /* VK_F16 0x7F */
4848 "f17", /* VK_F17 0x80 */
4849 "f18", /* VK_F18 0x81 */
4850 "f19", /* VK_F19 0x82 */
4851 "f20", /* VK_F20 0x83 */
4852 "f21", /* VK_F21 0x84 */
4853 "f22", /* VK_F22 0x85 */
4854 "f23", /* VK_F23 0x86 */
4855 "f24", /* VK_F24 0x87 */
4857 0, 0, 0, 0, /* 0x88 .. 0x8B */
4858 0, 0, 0, 0, /* 0x8C .. 0x8F */
4860 "kp-numlock", /* VK_NUMLOCK 0x90 */
4861 "scroll", /* VK_SCROLL 0x91 */
4862 /* Not sure where the following block comes from.
4863 Windows headers have NEC and Fujitsu specific keys in
4864 this block, but nothing generic. */
4865 "kp-space", /* VK_NUMPAD_CLEAR 0x92 */
4866 "kp-enter", /* VK_NUMPAD_ENTER 0x93 */
4867 "kp-prior", /* VK_NUMPAD_PRIOR 0x94 */
4868 "kp-next", /* VK_NUMPAD_NEXT 0x95 */
4869 "kp-end", /* VK_NUMPAD_END 0x96 */
4870 "kp-home", /* VK_NUMPAD_HOME 0x97 */
4871 "kp-left", /* VK_NUMPAD_LEFT 0x98 */
4872 "kp-up", /* VK_NUMPAD_UP 0x99 */
4873 "kp-right", /* VK_NUMPAD_RIGHT 0x9A */
4874 "kp-down", /* VK_NUMPAD_DOWN 0x9B */
4875 "kp-insert", /* VK_NUMPAD_INSERT 0x9C */
4876 "kp-delete", /* VK_NUMPAD_DELETE 0x9D */
4878 0, 0, /* 0x9E .. 0x9F */
4881 * VK_L* & VK_R* - left and right Alt, Ctrl and Shift virtual keys.
4882 * Used only as parameters to GetAsyncKeyState and GetKeyState.
4883 * No other API or message will distinguish left and right keys this way.
4888 /* Multimedia keys. These are handled as WM_APPCOMMAND, which allows us
4889 to enable them selectively, and gives access to a few more functions.
4890 See lispy_multimedia_keys below. */
4891 0, 0, 0, 0, 0, 0, 0, /* 0xA6 .. 0xAC Browser */
4892 0, 0, 0, /* 0xAD .. 0xAF Volume */
4893 0, 0, 0, 0, /* 0xB0 .. 0xB3 Media */
4894 0, 0, 0, 0, /* 0xB4 .. 0xB7 Apps */
4896 /* 0xB8 .. 0xC0 "OEM" keys - all seem to be punctuation. */
4897 0, 0, 0, 0, 0, 0, 0, 0, 0,
4899 /* 0xC1 - 0xDA unallocated, 0xDB-0xDF more OEM keys */
4900 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4901 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4904 "ax", /* VK_OEM_AX 0xE1 */
4905 0, /* VK_OEM_102 0xE2 */
4906 "ico-help", /* VK_ICO_HELP 0xE3 */
4907 "ico-00", /* VK_ICO_00 0xE4 */
4908 0, /* VK_PROCESSKEY 0xE5 - used by IME */
4909 "ico-clear", /* VK_ICO_CLEAR 0xE6 */
4910 0, /* VK_PACKET 0xE7 - used to pass Unicode chars */
4912 "reset", /* VK_OEM_RESET 0xE9 */
4913 "jump", /* VK_OEM_JUMP 0xEA */
4914 "oem-pa1", /* VK_OEM_PA1 0xEB */
4915 "oem-pa2", /* VK_OEM_PA2 0xEC */
4916 "oem-pa3", /* VK_OEM_PA3 0xED */
4917 "wsctrl", /* VK_OEM_WSCTRL 0xEE */
4918 "cusel", /* VK_OEM_CUSEL 0xEF */
4919 "oem-attn", /* VK_OEM_ATTN 0xF0 */
4920 "finish", /* VK_OEM_FINISH 0xF1 */
4921 "copy", /* VK_OEM_COPY 0xF2 */
4922 "auto", /* VK_OEM_AUTO 0xF3 */
4923 "enlw", /* VK_OEM_ENLW 0xF4 */
4924 "backtab", /* VK_OEM_BACKTAB 0xF5 */
4925 "attn", /* VK_ATTN 0xF6 */
4926 "crsel", /* VK_CRSEL 0xF7 */
4927 "exsel", /* VK_EXSEL 0xF8 */
4928 "ereof", /* VK_EREOF 0xF9 */
4929 "play", /* VK_PLAY 0xFA */
4930 "zoom", /* VK_ZOOM 0xFB */
4931 "noname", /* VK_NONAME 0xFC */
4932 "pa1", /* VK_PA1 0xFD */
4933 "oem_clear", /* VK_OEM_CLEAR 0xFE */
4937 /* Some of these duplicate the "Media keys" on newer keyboards,
4938 but they are delivered to the application in a different way. */
4939 static const char *const lispy_multimedia_keys
[] =
4947 "browser-favorites",
4984 "toggle-dictate-command",
4990 "media-fast-forward",
4993 "media-channel-down"
4996 #else /* not HAVE_NTGUI */
4998 /* This should be dealt with in XTread_socket now, and that doesn't
4999 depend on the client system having the Kana syms defined. See also
5000 the XK_kana_A case below. */
5003 static const char *const lispy_kana_keys
[] =
5005 /* X Keysym value */
5006 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x400 .. 0x40f */
5007 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x410 .. 0x41f */
5008 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x420 .. 0x42f */
5009 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x430 .. 0x43f */
5010 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x440 .. 0x44f */
5011 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x450 .. 0x45f */
5012 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x460 .. 0x46f */
5013 0,0,0,0,0,0,0,0,0,0,0,0,0,0,"overline",0,
5014 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x480 .. 0x48f */
5015 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x490 .. 0x49f */
5016 0, "kana-fullstop", "kana-openingbracket", "kana-closingbracket",
5017 "kana-comma", "kana-conjunctive", "kana-WO", "kana-a",
5018 "kana-i", "kana-u", "kana-e", "kana-o",
5019 "kana-ya", "kana-yu", "kana-yo", "kana-tsu",
5020 "prolongedsound", "kana-A", "kana-I", "kana-U",
5021 "kana-E", "kana-O", "kana-KA", "kana-KI",
5022 "kana-KU", "kana-KE", "kana-KO", "kana-SA",
5023 "kana-SHI", "kana-SU", "kana-SE", "kana-SO",
5024 "kana-TA", "kana-CHI", "kana-TSU", "kana-TE",
5025 "kana-TO", "kana-NA", "kana-NI", "kana-NU",
5026 "kana-NE", "kana-NO", "kana-HA", "kana-HI",
5027 "kana-FU", "kana-HE", "kana-HO", "kana-MA",
5028 "kana-MI", "kana-MU", "kana-ME", "kana-MO",
5029 "kana-YA", "kana-YU", "kana-YO", "kana-RA",
5030 "kana-RI", "kana-RU", "kana-RE", "kana-RO",
5031 "kana-WA", "kana-N", "voicedsound", "semivoicedsound",
5032 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4e0 .. 0x4ef */
5033 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4f0 .. 0x4ff */
5035 #endif /* XK_kana_A */
5038 #define FUNCTION_KEY_OFFSET 0xff00
5040 /* You'll notice that this table is arranged to be conveniently
5041 indexed by X Windows keysym values. */
5042 static const char *const lispy_function_keys
[] =
5044 /* X Keysym value */
5046 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff00...0f */
5047 "backspace", "tab", "linefeed", "clear",
5049 0, 0, 0, "pause", /* 0xff10...1f */
5050 0, 0, 0, 0, 0, 0, 0, "escape",
5052 0, "kanji", "muhenkan", "henkan", /* 0xff20...2f */
5053 "romaji", "hiragana", "katakana", "hiragana-katakana",
5054 "zenkaku", "hankaku", "zenkaku-hankaku", "touroku",
5055 "massyo", "kana-lock", "kana-shift", "eisu-shift",
5056 "eisu-toggle", /* 0xff30...3f */
5057 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
5058 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff40...4f */
5060 "home", "left", "up", "right", /* 0xff50 */ /* IsCursorKey */
5061 "down", "prior", "next", "end",
5062 "begin", 0, 0, 0, 0, 0, 0, 0,
5063 "select", /* 0xff60 */ /* IsMiscFunctionKey */
5074 "break", /* 0xff6b */
5077 0, 0, 0, 0, "backtab", 0, 0, 0, /* 0xff70... */
5078 0, 0, 0, 0, 0, 0, 0, "kp-numlock", /* 0xff78... */
5079 "kp-space", /* 0xff80 */ /* IsKeypadKey */
5080 0, 0, 0, 0, 0, 0, 0, 0,
5081 "kp-tab", /* 0xff89 */
5083 "kp-enter", /* 0xff8d */
5085 "kp-f1", /* 0xff91 */
5089 "kp-home", /* 0xff95 */
5094 "kp-prior", /* kp-page-up */
5095 "kp-next", /* kp-page-down */
5101 0, 0, 0, 0, 0, 0, 0, 0, 0,
5102 "kp-multiply", /* 0xffaa */
5107 "kp-divide", /* 0xffaf */
5108 "kp-0", /* 0xffb0 */
5109 "kp-1", "kp-2", "kp-3", "kp-4", "kp-5", "kp-6", "kp-7", "kp-8", "kp-9",
5112 "kp-equal", /* 0xffbd */
5113 "f1", /* 0xffbe */ /* IsFunctionKey */
5115 "f3", "f4", "f5", "f6", "f7", "f8", "f9", "f10", /* 0xffc0 */
5116 "f11", "f12", "f13", "f14", "f15", "f16", "f17", "f18",
5117 "f19", "f20", "f21", "f22", "f23", "f24", "f25", "f26", /* 0xffd0 */
5118 "f27", "f28", "f29", "f30", "f31", "f32", "f33", "f34",
5119 "f35", 0, 0, 0, 0, 0, 0, 0, /* 0xffe0 */
5120 0, 0, 0, 0, 0, 0, 0, 0,
5121 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfff0 */
5122 0, 0, 0, 0, 0, 0, 0, "delete"
5125 /* ISO 9995 Function and Modifier Keys; the first byte is 0xFE. */
5126 #define ISO_FUNCTION_KEY_OFFSET 0xfe00
5128 static const char *const iso_lispy_function_keys
[] =
5130 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe00 */
5131 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe08 */
5132 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe10 */
5133 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe18 */
5134 "iso-lefttab", /* 0xfe20 */
5135 "iso-move-line-up", "iso-move-line-down",
5136 "iso-partial-line-up", "iso-partial-line-down",
5137 "iso-partial-space-left", "iso-partial-space-right",
5138 "iso-set-margin-left", "iso-set-margin-right", /* 0xffe27, 28 */
5139 "iso-release-margin-left", "iso-release-margin-right",
5140 "iso-release-both-margins",
5141 "iso-fast-cursor-left", "iso-fast-cursor-right",
5142 "iso-fast-cursor-up", "iso-fast-cursor-down",
5143 "iso-continuous-underline", "iso-discontinuous-underline", /* 0xfe30, 31 */
5144 "iso-emphasize", "iso-center-object", "iso-enter", /* ... 0xfe34 */
5147 #endif /* not HAVE_NTGUI */
5149 static Lisp_Object Vlispy_mouse_stem
;
5151 static const char *const lispy_wheel_names
[] =
5153 "wheel-up", "wheel-down", "wheel-left", "wheel-right"
5156 /* drag-n-drop events are generated when a set of selected files are
5157 dragged from another application and dropped onto an Emacs window. */
5158 static const char *const lispy_drag_n_drop_names
[] =
5163 /* Scroll bar parts. */
5164 static Lisp_Object Qabove_handle
, Qhandle
, Qbelow_handle
;
5165 static Lisp_Object Qbefore_handle
, Qhorizontal_handle
, Qafter_handle
;
5166 Lisp_Object Qup
, Qdown
, Qtop
, Qbottom
;
5167 Lisp_Object Qleft
, Qright
, Qleftmost
, Qrightmost
;
5168 static Lisp_Object Qend_scroll
;
5169 static Lisp_Object Qratio
;
5171 /* An array of scroll bar parts, indexed by an enum scroll_bar_part value. */
5172 static Lisp_Object
*const scroll_bar_parts
[] = {
5173 &Qabove_handle
, &Qhandle
, &Qbelow_handle
,
5174 &Qup
, &Qdown
, &Qtop
, &Qbottom
, &Qend_scroll
, &Qratio
,
5175 &Qbefore_handle
, &Qhorizontal_handle
, &Qafter_handle
,
5176 &Qleft
, &Qright
, &Qleftmost
, &Qrightmost
, &Qend_scroll
, &Qratio
5179 /* A vector, indexed by button number, giving the down-going location
5180 of currently depressed buttons, both scroll bar and non-scroll bar.
5182 The elements have the form
5183 (BUTTON-NUMBER MODIFIER-MASK . REST)
5184 where REST is the cdr of a position as it would be reported in the event.
5186 The make_lispy_event function stores positions here to tell the
5187 difference between click and drag events, and to store the starting
5188 location to be included in drag events. */
5190 static Lisp_Object button_down_location
;
5192 /* Information about the most recent up-going button event: Which
5193 button, what location, and what time. */
5195 static int last_mouse_button
;
5196 static int last_mouse_x
;
5197 static int last_mouse_y
;
5198 static Time button_down_time
;
5200 /* The number of clicks in this multiple-click. */
5202 static int double_click_count
;
5204 /* X and Y are frame-relative coordinates for a click or wheel event.
5205 Return a Lisp-style event list. */
5208 make_lispy_position (struct frame
*f
, Lisp_Object x
, Lisp_Object y
,
5211 enum window_part part
;
5212 Lisp_Object posn
= Qnil
;
5213 Lisp_Object extra_info
= Qnil
;
5214 /* Coordinate pixel positions to return. */
5215 int xret
= 0, yret
= 0;
5216 /* The window under frame pixel coordinates (x,y) */
5217 Lisp_Object window
= f
5218 ? window_from_coordinates (f
, XINT (x
), XINT (y
), &part
, 0)
5221 if (WINDOWP (window
))
5223 /* It's a click in window WINDOW at frame coordinates (X,Y) */
5224 struct window
*w
= XWINDOW (window
);
5225 Lisp_Object string_info
= Qnil
;
5226 ptrdiff_t textpos
= 0;
5227 int col
= -1, row
= -1;
5228 int dx
= -1, dy
= -1;
5229 int width
= -1, height
= -1;
5230 Lisp_Object object
= Qnil
;
5232 /* Pixel coordinates relative to the window corner. */
5233 int wx
= XINT (x
) - WINDOW_LEFT_EDGE_X (w
);
5234 int wy
= XINT (y
) - WINDOW_TOP_EDGE_Y (w
);
5236 /* For text area clicks, return X, Y relative to the corner of
5237 this text area. Note that dX, dY etc are set below, by
5238 buffer_posn_from_coords. */
5239 if (part
== ON_TEXT
)
5241 xret
= XINT (x
) - window_box_left (w
, TEXT_AREA
);
5242 yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5244 /* For mode line and header line clicks, return X, Y relative to
5245 the left window edge. Use mode_line_string to look for a
5246 string on the click position. */
5247 else if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
)
5252 posn
= (part
== ON_MODE_LINE
) ? Qmode_line
: Qheader_line
;
5253 /* Note that mode_line_string takes COL, ROW as pixels and
5254 converts them to characters. */
5257 string
= mode_line_string (w
, part
, &col
, &row
, &charpos
,
5258 &object
, &dx
, &dy
, &width
, &height
);
5259 if (STRINGP (string
))
5260 string_info
= Fcons (string
, make_number (charpos
));
5266 /* For fringes and margins, Y is relative to the area's (and the
5267 window's) top edge, while X is meaningless. */
5268 else if (part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
5273 posn
= (part
== ON_LEFT_MARGIN
) ? Qleft_margin
: Qright_margin
;
5276 string
= marginal_area_string (w
, part
, &col
, &row
, &charpos
,
5277 &object
, &dx
, &dy
, &width
, &height
);
5278 if (STRINGP (string
))
5279 string_info
= Fcons (string
, make_number (charpos
));
5280 yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5282 else if (part
== ON_LEFT_FRINGE
)
5284 posn
= Qleft_fringe
;
5287 - (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5288 ? 0 : window_box_width (w
, LEFT_MARGIN_AREA
));
5289 dy
= yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5291 else if (part
== ON_RIGHT_FRINGE
)
5293 posn
= Qright_fringe
;
5296 - window_box_width (w
, LEFT_MARGIN_AREA
)
5297 - window_box_width (w
, TEXT_AREA
)
5298 - (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5299 ? window_box_width (w
, RIGHT_MARGIN_AREA
)
5301 dy
= yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5303 else if (part
== ON_VERTICAL_BORDER
)
5305 posn
= Qvertical_line
;
5310 /* Nothing special for part == ON_SCROLL_BAR. */
5311 else if (part
== ON_RIGHT_DIVIDER
)
5313 posn
= Qright_divider
;
5314 width
= WINDOW_RIGHT_DIVIDER_WIDTH (w
);
5318 else if (part
== ON_BOTTOM_DIVIDER
)
5320 posn
= Qbottom_divider
;
5321 width
= WINDOW_BOTTOM_DIVIDER_WIDTH (w
);
5326 /* For clicks in the text area, fringes, or margins, call
5327 buffer_posn_from_coords to extract TEXTPOS, the buffer
5328 position nearest to the click. */
5331 Lisp_Object string2
, object2
= Qnil
;
5332 struct display_pos p
;
5334 int width2
, height2
;
5335 /* The pixel X coordinate passed to buffer_posn_from_coords
5336 is the X coordinate relative to the text area for
5337 text-area and right-margin clicks, zero otherwise. */
5339 = (part
== ON_TEXT
) ? xret
5340 : (part
== ON_RIGHT_FRINGE
|| part
== ON_RIGHT_MARGIN
)
5341 ? (XINT (x
) - window_box_left (w
, TEXT_AREA
))
5345 string2
= buffer_posn_from_coords (w
, &x2
, &y2
, &p
,
5346 &object2
, &dx2
, &dy2
,
5348 textpos
= CHARPOS (p
.pos
);
5349 if (col
< 0) col
= x2
;
5350 if (row
< 0) row
= y2
;
5351 if (dx
< 0) dx
= dx2
;
5352 if (dy
< 0) dy
= dy2
;
5353 if (width
< 0) width
= width2
;
5354 if (height
< 0) height
= height2
;
5358 posn
= make_number (textpos
);
5359 if (STRINGP (string2
))
5360 string_info
= Fcons (string2
,
5361 make_number (CHARPOS (p
.string_pos
)));
5367 #ifdef HAVE_WINDOW_SYSTEM
5368 if (IMAGEP (object
))
5370 Lisp_Object image_map
, hotspot
;
5371 if ((image_map
= Fplist_get (XCDR (object
), QCmap
),
5373 && (hotspot
= find_hot_spot (image_map
, dx
, dy
),
5375 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
5376 posn
= XCAR (hotspot
);
5383 Fcons (make_number (dx
), make_number (dy
)),
5384 Fcons (make_number (width
), make_number (height
)));
5387 extra_info
= Fcons (string_info
,
5388 Fcons (textpos
< 0 ? Qnil
: make_number (textpos
),
5389 Fcons (Fcons (make_number (col
),
5394 XSETFRAME (window
, f
);
5398 return Fcons (window
,
5400 Fcons (Fcons (make_number (xret
),
5401 make_number (yret
)),
5402 Fcons (make_number (t
),
5406 /* Return non-zero if F is a GUI frame that uses some toolkit-managed
5407 menu bar. This really means that Emacs draws and manages the menu
5408 bar as part of its normal display, and therefore can compute its
5411 toolkit_menubar_in_use (struct frame
*f
)
5413 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS) || defined (HAVE_NTGUI)
5414 return !(!FRAME_WINDOW_P (f
));
5420 /* Given a struct input_event, build the lisp event which represents
5421 it. If EVENT is 0, build a mouse movement event from the mouse
5422 movement buffer, which should have a movement event in it.
5424 Note that events must be passed to this function in the order they
5425 are received; this function stores the location of button presses
5426 in order to build drag events when the button is released. */
5429 make_lispy_event (struct input_event
*event
)
5433 switch (event
->kind
)
5435 /* A simple keystroke. */
5436 case ASCII_KEYSTROKE_EVENT
:
5437 case MULTIBYTE_CHAR_KEYSTROKE_EVENT
:
5439 Lisp_Object lispy_c
;
5440 EMACS_INT c
= event
->code
;
5441 if (event
->kind
== ASCII_KEYSTROKE_EVENT
)
5444 eassert (c
== event
->code
);
5445 /* Turn ASCII characters into control characters
5447 if (event
->modifiers
& ctrl_modifier
)
5449 c
= make_ctrl_char (c
);
5450 event
->modifiers
&= ~ctrl_modifier
;
5454 /* Add in the other modifier bits. The shift key was taken care
5455 of by the X code. */
5456 c
|= (event
->modifiers
5457 & (meta_modifier
| alt_modifier
5458 | hyper_modifier
| super_modifier
| ctrl_modifier
));
5459 /* Distinguish Shift-SPC from SPC. */
5460 if ((event
->code
) == 040
5461 && event
->modifiers
& shift_modifier
)
5462 c
|= shift_modifier
;
5463 button_down_time
= 0;
5464 XSETFASTINT (lispy_c
, c
);
5469 /* NS_NONKEY_EVENTs are just like NON_ASCII_KEYSTROKE_EVENTs,
5470 except that they are non-key events (last-nonmenu-event is nil). */
5471 case NS_NONKEY_EVENT
:
5474 /* A function key. The symbol may need to have modifier prefixes
5476 case NON_ASCII_KEYSTROKE_EVENT
:
5477 button_down_time
= 0;
5479 for (i
= 0; i
< ARRAYELTS (lispy_accent_codes
); i
++)
5480 if (event
->code
== lispy_accent_codes
[i
])
5481 return modify_event_symbol (i
,
5483 Qfunction_key
, Qnil
,
5484 lispy_accent_keys
, &accent_key_syms
,
5485 ARRAYELTS (lispy_accent_keys
));
5489 if (event
->code
>= 0x400 && event
->code
< 0x500)
5490 return modify_event_symbol (event
->code
- 0x400,
5491 event
->modifiers
& ~shift_modifier
,
5492 Qfunction_key
, Qnil
,
5493 lispy_kana_keys
, &func_key_syms
,
5494 ARRAYELTS (lispy_kana_keys
));
5495 #endif /* XK_kana_A */
5498 #ifdef ISO_FUNCTION_KEY_OFFSET
5499 if (event
->code
< FUNCTION_KEY_OFFSET
5500 && event
->code
>= ISO_FUNCTION_KEY_OFFSET
)
5501 return modify_event_symbol (event
->code
- ISO_FUNCTION_KEY_OFFSET
,
5503 Qfunction_key
, Qnil
,
5504 iso_lispy_function_keys
, &func_key_syms
,
5505 ARRAYELTS (iso_lispy_function_keys
));
5508 /* Handle system-specific or unknown keysyms. */
5509 if (event
->code
& (1 << 28)
5510 || event
->code
- FUNCTION_KEY_OFFSET
< 0
5511 || (event
->code
- FUNCTION_KEY_OFFSET
5512 >= ARRAYELTS (lispy_function_keys
))
5513 || !lispy_function_keys
[event
->code
- FUNCTION_KEY_OFFSET
])
5515 /* We need to use an alist rather than a vector as the cache
5516 since we can't make a vector long enough. */
5517 if (NILP (KVAR (current_kboard
, system_key_syms
)))
5518 kset_system_key_syms (current_kboard
, Fcons (Qnil
, Qnil
));
5519 return modify_event_symbol (event
->code
,
5522 KVAR (current_kboard
, Vsystem_key_alist
),
5523 0, &KVAR (current_kboard
, system_key_syms
),
5527 return modify_event_symbol (event
->code
- FUNCTION_KEY_OFFSET
,
5529 Qfunction_key
, Qnil
,
5530 lispy_function_keys
, &func_key_syms
,
5531 ARRAYELTS (lispy_function_keys
));
5534 case MULTIMEDIA_KEY_EVENT
:
5535 if (event
->code
< ARRAYELTS (lispy_multimedia_keys
)
5536 && event
->code
> 0 && lispy_multimedia_keys
[event
->code
])
5538 return modify_event_symbol (event
->code
, event
->modifiers
,
5539 Qfunction_key
, Qnil
,
5540 lispy_multimedia_keys
, &func_key_syms
,
5541 ARRAYELTS (lispy_multimedia_keys
));
5546 /* A mouse click. Figure out where it is, decide whether it's
5547 a press, click or drag, and build the appropriate structure. */
5548 case MOUSE_CLICK_EVENT
:
5550 case GPM_CLICK_EVENT
:
5552 #ifndef USE_TOOLKIT_SCROLL_BARS
5553 case SCROLL_BAR_CLICK_EVENT
:
5554 case HORIZONTAL_SCROLL_BAR_CLICK_EVENT
:
5557 int button
= event
->code
;
5559 Lisp_Object position
;
5560 Lisp_Object
*start_pos_ptr
;
5561 Lisp_Object start_pos
;
5565 /* Build the position as appropriate for this mouse click. */
5566 if (event
->kind
== MOUSE_CLICK_EVENT
5568 || event
->kind
== GPM_CLICK_EVENT
5572 struct frame
*f
= XFRAME (event
->frame_or_window
);
5575 /* Ignore mouse events that were made on frame that
5576 have been deleted. */
5577 if (! FRAME_LIVE_P (f
))
5580 /* EVENT->x and EVENT->y are frame-relative pixel
5581 coordinates at this place. Under old redisplay, COLUMN
5582 and ROW are set to frame relative glyph coordinates
5583 which are then used to determine whether this click is
5584 in a menu (non-toolkit version). */
5585 if (!toolkit_menubar_in_use (f
))
5587 pixel_to_glyph_coords (f
, XINT (event
->x
), XINT (event
->y
),
5588 &column
, &row
, NULL
, 1);
5590 /* In the non-toolkit version, clicks on the menu bar
5591 are ordinary button events in the event buffer.
5592 Distinguish them, and invoke the menu.
5594 (In the toolkit version, the toolkit handles the
5595 menu bar and Emacs doesn't know about it until
5596 after the user makes a selection.) */
5597 if (row
>= 0 && row
< FRAME_MENU_BAR_LINES (f
)
5598 && (event
->modifiers
& down_modifier
))
5600 Lisp_Object items
, item
;
5602 /* Find the menu bar item under `column'. */
5604 items
= FRAME_MENU_BAR_ITEMS (f
);
5605 for (i
= 0; i
< ASIZE (items
); i
+= 4)
5607 Lisp_Object pos
, string
;
5608 string
= AREF (items
, i
+ 1);
5609 pos
= AREF (items
, i
+ 3);
5612 if (column
>= XINT (pos
)
5613 && column
< XINT (pos
) + SCHARS (string
))
5615 item
= AREF (items
, i
);
5620 /* ELisp manual 2.4b says (x y) are window
5621 relative but code says they are
5623 position
= list4 (event
->frame_or_window
,
5625 Fcons (event
->x
, event
->y
),
5626 make_number (event
->timestamp
));
5628 return list2 (item
, position
);
5632 position
= make_lispy_position (f
, event
->x
, event
->y
,
5635 #ifndef USE_TOOLKIT_SCROLL_BARS
5638 /* It's a scrollbar click. */
5640 Lisp_Object portion_whole
;
5643 window
= event
->frame_or_window
;
5644 portion_whole
= Fcons (event
->x
, event
->y
);
5645 part
= *scroll_bar_parts
[(int) event
->part
];
5647 position
= list5 (window
, Qvertical_scroll_bar
,
5648 portion_whole
, make_number (event
->timestamp
),
5651 #endif /* not USE_TOOLKIT_SCROLL_BARS */
5653 if (button
>= ASIZE (button_down_location
))
5655 ptrdiff_t incr
= button
- ASIZE (button_down_location
) + 1;
5656 button_down_location
= larger_vector (button_down_location
,
5658 mouse_syms
= larger_vector (mouse_syms
, incr
, -1);
5661 start_pos_ptr
= aref_addr (button_down_location
, button
);
5662 start_pos
= *start_pos_ptr
;
5663 *start_pos_ptr
= Qnil
;
5666 /* On window-system frames, use the value of
5667 double-click-fuzz as is. On other frames, interpret it
5668 as a multiple of 1/8 characters. */
5672 if (WINDOWP (event
->frame_or_window
))
5673 f
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5674 else if (FRAMEP (event
->frame_or_window
))
5675 f
= XFRAME (event
->frame_or_window
);
5679 if (FRAME_WINDOW_P (f
))
5680 fuzz
= double_click_fuzz
;
5682 fuzz
= double_click_fuzz
/ 8;
5684 is_double
= (button
== last_mouse_button
5685 && (eabs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5686 && (eabs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5687 && button_down_time
!= 0
5688 && (EQ (Vdouble_click_time
, Qt
)
5689 || (NATNUMP (Vdouble_click_time
)
5690 && (event
->timestamp
- button_down_time
5691 < XFASTINT (Vdouble_click_time
)))));
5694 last_mouse_button
= button
;
5695 last_mouse_x
= XINT (event
->x
);
5696 last_mouse_y
= XINT (event
->y
);
5698 /* If this is a button press, squirrel away the location, so
5699 we can decide later whether it was a click or a drag. */
5700 if (event
->modifiers
& down_modifier
)
5704 double_click_count
++;
5705 event
->modifiers
|= ((double_click_count
> 2)
5710 double_click_count
= 1;
5711 button_down_time
= event
->timestamp
;
5712 *start_pos_ptr
= Fcopy_alist (position
);
5713 ignore_mouse_drag_p
= 0;
5716 /* Now we're releasing a button - check the co-ordinates to
5717 see if this was a click or a drag. */
5718 else if (event
->modifiers
& up_modifier
)
5720 /* If we did not see a down before this up, ignore the up.
5721 Probably this happened because the down event chose a
5722 menu item. It would be an annoyance to treat the
5723 release of the button that chose the menu item as a
5726 if (!CONSP (start_pos
))
5729 event
->modifiers
&= ~up_modifier
;
5732 Lisp_Object new_down
, down
;
5733 EMACS_INT xdiff
= double_click_fuzz
, ydiff
= double_click_fuzz
;
5735 /* The third element of every position
5736 should be the (x,y) pair. */
5737 down
= Fcar (Fcdr (Fcdr (start_pos
)));
5738 new_down
= Fcar (Fcdr (Fcdr (position
)));
5741 && INTEGERP (XCAR (down
)) && INTEGERP (XCDR (down
)))
5743 xdiff
= XINT (XCAR (new_down
)) - XINT (XCAR (down
));
5744 ydiff
= XINT (XCDR (new_down
)) - XINT (XCDR (down
));
5747 if (ignore_mouse_drag_p
)
5749 event
->modifiers
|= click_modifier
;
5750 ignore_mouse_drag_p
= 0;
5752 else if (xdiff
< double_click_fuzz
&& xdiff
> - double_click_fuzz
5753 && ydiff
< double_click_fuzz
&& ydiff
> - double_click_fuzz
5754 /* Maybe the mouse has moved a lot, caused scrolling, and
5755 eventually ended up at the same screen position (but
5756 not buffer position) in which case it is a drag, not
5758 /* FIXME: OTOH if the buffer position has changed
5759 because of a timer or process filter rather than
5760 because of mouse movement, it should be considered as
5761 a click. But mouse-drag-region completely ignores
5762 this case and it hasn't caused any real problem, so
5763 it's probably OK to ignore it as well. */
5764 && EQ (Fcar (Fcdr (start_pos
)), Fcar (Fcdr (position
))))
5765 /* Mouse hasn't moved (much). */
5766 event
->modifiers
|= click_modifier
;
5769 button_down_time
= 0;
5770 event
->modifiers
|= drag_modifier
;
5773 /* Don't check is_double; treat this as multiple
5774 if the down-event was multiple. */
5775 if (double_click_count
> 1)
5776 event
->modifiers
|= ((double_click_count
> 2)
5782 /* Every mouse event should either have the down_modifier or
5783 the up_modifier set. */
5787 /* Get the symbol we should use for the mouse click. */
5790 head
= modify_event_symbol (button
,
5792 Qmouse_click
, Vlispy_mouse_stem
,
5795 ASIZE (mouse_syms
));
5796 if (event
->modifiers
& drag_modifier
)
5797 return list3 (head
, start_pos
, position
);
5798 else if (event
->modifiers
& (double_modifier
| triple_modifier
))
5799 return list3 (head
, position
, make_number (double_click_count
));
5801 return list2 (head
, position
);
5806 case HORIZ_WHEEL_EVENT
:
5808 Lisp_Object position
;
5811 /* Build the position as appropriate for this mouse click. */
5812 struct frame
*f
= XFRAME (event
->frame_or_window
);
5814 /* Ignore wheel events that were made on frame that have been
5816 if (! FRAME_LIVE_P (f
))
5819 position
= make_lispy_position (f
, event
->x
, event
->y
,
5822 /* Set double or triple modifiers to indicate the wheel speed. */
5824 /* On window-system frames, use the value of
5825 double-click-fuzz as is. On other frames, interpret it
5826 as a multiple of 1/8 characters. */
5832 if (WINDOWP (event
->frame_or_window
))
5833 fr
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5834 else if (FRAMEP (event
->frame_or_window
))
5835 fr
= XFRAME (event
->frame_or_window
);
5839 fuzz
= FRAME_WINDOW_P (fr
)
5840 ? double_click_fuzz
: double_click_fuzz
/ 8;
5842 if (event
->modifiers
& up_modifier
)
5844 /* Emit a wheel-up event. */
5845 event
->modifiers
&= ~up_modifier
;
5848 else if (event
->modifiers
& down_modifier
)
5850 /* Emit a wheel-down event. */
5851 event
->modifiers
&= ~down_modifier
;
5855 /* Every wheel event should either have the down_modifier or
5856 the up_modifier set. */
5859 if (event
->kind
== HORIZ_WHEEL_EVENT
)
5862 is_double
= (last_mouse_button
== - (1 + symbol_num
)
5863 && (eabs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5864 && (eabs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5865 && button_down_time
!= 0
5866 && (EQ (Vdouble_click_time
, Qt
)
5867 || (NATNUMP (Vdouble_click_time
)
5868 && (event
->timestamp
- button_down_time
5869 < XFASTINT (Vdouble_click_time
)))));
5872 double_click_count
++;
5873 event
->modifiers
|= ((double_click_count
> 2)
5879 double_click_count
= 1;
5880 event
->modifiers
|= click_modifier
;
5883 button_down_time
= event
->timestamp
;
5884 /* Use a negative value to distinguish wheel from mouse button. */
5885 last_mouse_button
= - (1 + symbol_num
);
5886 last_mouse_x
= XINT (event
->x
);
5887 last_mouse_y
= XINT (event
->y
);
5889 /* Get the symbol we should use for the wheel event. */
5890 head
= modify_event_symbol (symbol_num
,
5896 ASIZE (wheel_syms
));
5899 if (event
->modifiers
& (double_modifier
| triple_modifier
))
5900 return list3 (head
, position
, make_number (double_click_count
));
5902 return list2 (head
, position
);
5906 #ifdef USE_TOOLKIT_SCROLL_BARS
5908 /* We don't have down and up events if using toolkit scroll bars,
5909 so make this always a click event. Store in the `part' of
5910 the Lisp event a symbol which maps to the following actions:
5912 `above_handle' page up
5913 `below_handle' page down
5917 `bottom' bottom of buffer
5918 `handle' thumb has been dragged.
5919 `end-scroll' end of interaction with scroll bar
5921 The incoming input_event contains in its `part' member an
5922 index of type `enum scroll_bar_part' which we can use as an
5923 index in scroll_bar_parts to get the appropriate symbol. */
5925 case SCROLL_BAR_CLICK_EVENT
:
5927 Lisp_Object position
, head
, window
, portion_whole
, part
;
5929 window
= event
->frame_or_window
;
5930 portion_whole
= Fcons (event
->x
, event
->y
);
5931 part
= *scroll_bar_parts
[(int) event
->part
];
5933 position
= list5 (window
, Qvertical_scroll_bar
, portion_whole
,
5934 make_number (event
->timestamp
), part
);
5936 /* Always treat scroll bar events as clicks. */
5937 event
->modifiers
|= click_modifier
;
5938 event
->modifiers
&= ~up_modifier
;
5940 if (event
->code
>= ASIZE (mouse_syms
))
5941 mouse_syms
= larger_vector (mouse_syms
,
5942 event
->code
- ASIZE (mouse_syms
) + 1,
5945 /* Get the symbol we should use for the mouse click. */
5946 head
= modify_event_symbol (event
->code
,
5951 ASIZE (mouse_syms
));
5952 return list2 (head
, position
);
5955 case HORIZONTAL_SCROLL_BAR_CLICK_EVENT
:
5957 Lisp_Object position
, head
, window
, portion_whole
, part
;
5959 window
= event
->frame_or_window
;
5960 portion_whole
= Fcons (event
->x
, event
->y
);
5961 part
= *scroll_bar_parts
[(int) event
->part
];
5963 position
= list5 (window
, Qhorizontal_scroll_bar
, portion_whole
,
5964 make_number (event
->timestamp
), part
);
5966 /* Always treat scroll bar events as clicks. */
5967 event
->modifiers
|= click_modifier
;
5968 event
->modifiers
&= ~up_modifier
;
5970 if (event
->code
>= ASIZE (mouse_syms
))
5971 mouse_syms
= larger_vector (mouse_syms
,
5972 event
->code
- ASIZE (mouse_syms
) + 1,
5975 /* Get the symbol we should use for the mouse click. */
5976 head
= modify_event_symbol (event
->code
,
5981 ASIZE (mouse_syms
));
5982 return list2 (head
, position
);
5985 #endif /* USE_TOOLKIT_SCROLL_BARS */
5987 case DRAG_N_DROP_EVENT
:
5990 Lisp_Object head
, position
;
5993 f
= XFRAME (event
->frame_or_window
);
5996 /* Ignore mouse events that were made on frames that
5997 have been deleted. */
5998 if (! FRAME_LIVE_P (f
))
6001 position
= make_lispy_position (f
, event
->x
, event
->y
,
6004 head
= modify_event_symbol (0, event
->modifiers
,
6006 lispy_drag_n_drop_names
,
6007 &drag_n_drop_syms
, 1);
6008 return list3 (head
, position
, files
);
6011 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
6012 || defined (HAVE_NS) || defined (USE_GTK)
6013 case MENU_BAR_EVENT
:
6014 if (EQ (event
->arg
, event
->frame_or_window
))
6015 /* This is the prefix key. We translate this to
6016 `(menu_bar)' because the code in keyboard.c for menu
6017 events, which we use, relies on this. */
6018 return list1 (Qmenu_bar
);
6022 case SELECT_WINDOW_EVENT
:
6023 /* Make an event (select-window (WINDOW)). */
6024 return list2 (Qselect_window
, list1 (event
->frame_or_window
));
6026 case TOOL_BAR_EVENT
:
6027 if (EQ (event
->arg
, event
->frame_or_window
))
6028 /* This is the prefix key. We translate this to
6029 `(tool_bar)' because the code in keyboard.c for tool bar
6030 events, which we use, relies on this. */
6031 return list1 (Qtool_bar
);
6032 else if (SYMBOLP (event
->arg
))
6033 return apply_modifiers (event
->modifiers
, event
->arg
);
6036 case USER_SIGNAL_EVENT
:
6037 /* A user signal. */
6039 char *name
= find_user_signal_name (event
->code
);
6042 return intern (name
);
6045 case SAVE_SESSION_EVENT
:
6046 return Qsave_session
;
6051 return Fcons (Qdbus_event
, event
->arg
);
6053 #endif /* HAVE_DBUS */
6055 #if defined HAVE_GFILENOTIFY || defined HAVE_INOTIFY
6056 case FILE_NOTIFY_EVENT
:
6058 return Fcons (Qfile_notify
, event
->arg
);
6060 #endif /* defined HAVE_GFILENOTIFY || defined HAVE_INOTIFY */
6062 case CONFIG_CHANGED_EVENT
:
6063 return list3 (Qconfig_changed_event
,
6064 event
->arg
, event
->frame_or_window
);
6066 /* The 'kind' field of the event is something we don't recognize. */
6073 make_lispy_movement (struct frame
*frame
, Lisp_Object bar_window
, enum scroll_bar_part part
,
6074 Lisp_Object x
, Lisp_Object y
, Time t
)
6076 /* Is it a scroll bar movement? */
6077 if (frame
&& ! NILP (bar_window
))
6079 Lisp_Object part_sym
;
6081 part_sym
= *scroll_bar_parts
[(int) part
];
6082 return list2 (Qscroll_bar_movement
,
6084 Qvertical_scroll_bar
,
6089 /* Or is it an ordinary mouse movement? */
6092 Lisp_Object position
;
6093 position
= make_lispy_position (frame
, x
, y
, t
);
6094 return list2 (Qmouse_movement
, position
);
6098 /* Construct a switch frame event. */
6100 make_lispy_switch_frame (Lisp_Object frame
)
6102 return list2 (Qswitch_frame
, frame
);
6106 make_lispy_focus_in (Lisp_Object frame
)
6108 return list2 (Qfocus_in
, frame
);
6111 #ifdef HAVE_WINDOW_SYSTEM
6114 make_lispy_focus_out (Lisp_Object frame
)
6116 return list2 (Qfocus_out
, frame
);
6119 #endif /* HAVE_WINDOW_SYSTEM */
6121 /* Manipulating modifiers. */
6123 /* Parse the name of SYMBOL, and return the set of modifiers it contains.
6125 If MODIFIER_END is non-zero, set *MODIFIER_END to the position in
6126 SYMBOL's name of the end of the modifiers; the string from this
6127 position is the unmodified symbol name.
6129 This doesn't use any caches. */
6132 parse_modifiers_uncached (Lisp_Object symbol
, ptrdiff_t *modifier_end
)
6138 CHECK_SYMBOL (symbol
);
6141 name
= SYMBOL_NAME (symbol
);
6143 for (i
= 0; i
< SBYTES (name
) - 1; )
6145 ptrdiff_t this_mod_end
= 0;
6148 /* See if the name continues with a modifier word.
6149 Check that the word appears, but don't check what follows it.
6150 Set this_mod and this_mod_end to record what we find. */
6152 switch (SREF (name
, i
))
6154 #define SINGLE_LETTER_MOD(BIT) \
6155 (this_mod_end = i + 1, this_mod = BIT)
6158 SINGLE_LETTER_MOD (alt_modifier
);
6162 SINGLE_LETTER_MOD (ctrl_modifier
);
6166 SINGLE_LETTER_MOD (hyper_modifier
);
6170 SINGLE_LETTER_MOD (meta_modifier
);
6174 SINGLE_LETTER_MOD (shift_modifier
);
6178 SINGLE_LETTER_MOD (super_modifier
);
6181 #undef SINGLE_LETTER_MOD
6183 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6184 if (i + LEN + 1 <= SBYTES (name) \
6185 && ! memcmp (SDATA (name) + i, NAME, LEN)) \
6187 this_mod_end = i + LEN; \
6192 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
6193 MULTI_LETTER_MOD (down_modifier
, "down", 4);
6194 MULTI_LETTER_MOD (double_modifier
, "double", 6);
6198 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
6200 #undef MULTI_LETTER_MOD
6204 /* If we found no modifier, stop looking for them. */
6205 if (this_mod_end
== 0)
6208 /* Check there is a dash after the modifier, so that it
6209 really is a modifier. */
6210 if (this_mod_end
>= SBYTES (name
)
6211 || SREF (name
, this_mod_end
) != '-')
6214 /* This modifier is real; look for another. */
6215 modifiers
|= this_mod
;
6216 i
= this_mod_end
+ 1;
6219 /* Should we include the `click' modifier? */
6220 if (! (modifiers
& (down_modifier
| drag_modifier
6221 | double_modifier
| triple_modifier
))
6222 && i
+ 7 == SBYTES (name
)
6223 && memcmp (SDATA (name
) + i
, "mouse-", 6) == 0
6224 && ('0' <= SREF (name
, i
+ 6) && SREF (name
, i
+ 6) <= '9'))
6225 modifiers
|= click_modifier
;
6227 if (! (modifiers
& (double_modifier
| triple_modifier
))
6228 && i
+ 6 < SBYTES (name
)
6229 && memcmp (SDATA (name
) + i
, "wheel-", 6) == 0)
6230 modifiers
|= click_modifier
;
6238 /* Return a symbol whose name is the modifier prefixes for MODIFIERS
6239 prepended to the string BASE[0..BASE_LEN-1].
6240 This doesn't use any caches. */
6242 apply_modifiers_uncached (int modifiers
, char *base
, int base_len
, int base_len_byte
)
6244 /* Since BASE could contain nulls, we can't use intern here; we have
6245 to use Fintern, which expects a genuine Lisp_String, and keeps a
6247 char new_mods
[sizeof "A-C-H-M-S-s-down-drag-double-triple-"];
6253 /* Only the event queue may use the `up' modifier; it should always
6254 be turned into a click or drag event before presented to lisp code. */
6255 if (modifiers
& up_modifier
)
6258 if (modifiers
& alt_modifier
) { *p
++ = 'A'; *p
++ = '-'; }
6259 if (modifiers
& ctrl_modifier
) { *p
++ = 'C'; *p
++ = '-'; }
6260 if (modifiers
& hyper_modifier
) { *p
++ = 'H'; *p
++ = '-'; }
6261 if (modifiers
& meta_modifier
) { *p
++ = 'M'; *p
++ = '-'; }
6262 if (modifiers
& shift_modifier
) { *p
++ = 'S'; *p
++ = '-'; }
6263 if (modifiers
& super_modifier
) { *p
++ = 's'; *p
++ = '-'; }
6264 if (modifiers
& double_modifier
) { strcpy (p
, "double-"); p
+= 7; }
6265 if (modifiers
& triple_modifier
) { strcpy (p
, "triple-"); p
+= 7; }
6266 if (modifiers
& down_modifier
) { strcpy (p
, "down-"); p
+= 5; }
6267 if (modifiers
& drag_modifier
) { strcpy (p
, "drag-"); p
+= 5; }
6268 /* The click modifier is denoted by the absence of other modifiers. */
6272 mod_len
= p
- new_mods
;
6276 Lisp_Object new_name
;
6278 new_name
= make_uninit_multibyte_string (mod_len
+ base_len
,
6279 mod_len
+ base_len_byte
);
6280 memcpy (SDATA (new_name
), new_mods
, mod_len
);
6281 memcpy (SDATA (new_name
) + mod_len
, base
, base_len_byte
);
6283 return Fintern (new_name
, Qnil
);
6288 static const char *const modifier_names
[] =
6290 "up", "down", "drag", "click", "double", "triple", 0, 0,
6291 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
6292 0, 0, "alt", "super", "hyper", "shift", "control", "meta"
6294 #define NUM_MOD_NAMES ARRAYELTS (modifier_names)
6296 static Lisp_Object modifier_symbols
;
6298 /* Return the list of modifier symbols corresponding to the mask MODIFIERS. */
6300 lispy_modifier_list (int modifiers
)
6302 Lisp_Object modifier_list
;
6305 modifier_list
= Qnil
;
6306 for (i
= 0; (1<<i
) <= modifiers
&& i
< NUM_MOD_NAMES
; i
++)
6307 if (modifiers
& (1<<i
))
6308 modifier_list
= Fcons (AREF (modifier_symbols
, i
),
6311 return modifier_list
;
6315 /* Parse the modifiers on SYMBOL, and return a list like (UNMODIFIED MASK),
6316 where UNMODIFIED is the unmodified form of SYMBOL,
6317 MASK is the set of modifiers present in SYMBOL's name.
6318 This is similar to parse_modifiers_uncached, but uses the cache in
6319 SYMBOL's Qevent_symbol_element_mask property, and maintains the
6320 Qevent_symbol_elements property. */
6322 #define KEY_TO_CHAR(k) (XINT (k) & ((1 << CHARACTERBITS) - 1))
6325 parse_modifiers (Lisp_Object symbol
)
6327 Lisp_Object elements
;
6329 if (INTEGERP (symbol
))
6330 return list2i (KEY_TO_CHAR (symbol
), XINT (symbol
) & CHAR_MODIFIER_MASK
);
6331 else if (!SYMBOLP (symbol
))
6334 elements
= Fget (symbol
, Qevent_symbol_element_mask
);
6335 if (CONSP (elements
))
6340 int modifiers
= parse_modifiers_uncached (symbol
, &end
);
6341 Lisp_Object unmodified
;
6344 unmodified
= Fintern (make_string (SSDATA (SYMBOL_NAME (symbol
)) + end
,
6345 SBYTES (SYMBOL_NAME (symbol
)) - end
),
6348 if (modifiers
& ~INTMASK
)
6350 XSETFASTINT (mask
, modifiers
);
6351 elements
= list2 (unmodified
, mask
);
6353 /* Cache the parsing results on SYMBOL. */
6354 Fput (symbol
, Qevent_symbol_element_mask
,
6356 Fput (symbol
, Qevent_symbol_elements
,
6357 Fcons (unmodified
, lispy_modifier_list (modifiers
)));
6359 /* Since we know that SYMBOL is modifiers applied to unmodified,
6360 it would be nice to put that in unmodified's cache.
6361 But we can't, since we're not sure that parse_modifiers is
6368 DEFUN ("internal-event-symbol-parse-modifiers", Fevent_symbol_parse_modifiers
,
6369 Sevent_symbol_parse_modifiers
, 1, 1, 0,
6370 doc
: /* Parse the event symbol. For internal use. */)
6371 (Lisp_Object symbol
)
6373 /* Fill the cache if needed. */
6374 parse_modifiers (symbol
);
6375 /* Ignore the result (which is stored on Qevent_symbol_element_mask)
6376 and use the Lispier representation stored on Qevent_symbol_elements
6378 return Fget (symbol
, Qevent_symbol_elements
);
6381 /* Apply the modifiers MODIFIERS to the symbol BASE.
6382 BASE must be unmodified.
6384 This is like apply_modifiers_uncached, but uses BASE's
6385 Qmodifier_cache property, if present. It also builds
6386 Qevent_symbol_elements properties, since it has that info anyway.
6388 apply_modifiers copies the value of BASE's Qevent_kind property to
6389 the modified symbol. */
6391 apply_modifiers (int modifiers
, Lisp_Object base
)
6393 Lisp_Object cache
, idx
, entry
, new_symbol
;
6395 /* Mask out upper bits. We don't know where this value's been. */
6396 modifiers
&= INTMASK
;
6398 if (INTEGERP (base
))
6399 return make_number (XINT (base
) | modifiers
);
6401 /* The click modifier never figures into cache indices. */
6402 cache
= Fget (base
, Qmodifier_cache
);
6403 XSETFASTINT (idx
, (modifiers
& ~click_modifier
));
6404 entry
= assq_no_quit (idx
, cache
);
6407 new_symbol
= XCDR (entry
);
6410 /* We have to create the symbol ourselves. */
6411 new_symbol
= apply_modifiers_uncached (modifiers
,
6412 SSDATA (SYMBOL_NAME (base
)),
6413 SCHARS (SYMBOL_NAME (base
)),
6414 SBYTES (SYMBOL_NAME (base
)));
6416 /* Add the new symbol to the base's cache. */
6417 entry
= Fcons (idx
, new_symbol
);
6418 Fput (base
, Qmodifier_cache
, Fcons (entry
, cache
));
6420 /* We have the parsing info now for free, so we could add it to
6422 XSETFASTINT (idx, modifiers);
6423 Fput (new_symbol, Qevent_symbol_element_mask,
6425 Fput (new_symbol, Qevent_symbol_elements,
6426 Fcons (base, lispy_modifier_list (modifiers)));
6427 Sadly, this is only correct if `base' is indeed a base event,
6428 which is not necessarily the case. -stef */
6431 /* Make sure this symbol is of the same kind as BASE.
6433 You'd think we could just set this once and for all when we
6434 intern the symbol above, but reorder_modifiers may call us when
6435 BASE's property isn't set right; we can't assume that just
6436 because it has a Qmodifier_cache property it must have its
6437 Qevent_kind set right as well. */
6438 if (NILP (Fget (new_symbol
, Qevent_kind
)))
6442 kind
= Fget (base
, Qevent_kind
);
6444 Fput (new_symbol
, Qevent_kind
, kind
);
6451 /* Given a symbol whose name begins with modifiers ("C-", "M-", etc),
6452 return a symbol with the modifiers placed in the canonical order.
6453 Canonical order is alphabetical, except for down and drag, which
6454 always come last. The 'click' modifier is never written out.
6456 Fdefine_key calls this to make sure that (for example) C-M-foo
6457 and M-C-foo end up being equivalent in the keymap. */
6460 reorder_modifiers (Lisp_Object symbol
)
6462 /* It's hopefully okay to write the code this way, since everything
6463 will soon be in caches, and no consing will be done at all. */
6466 parsed
= parse_modifiers (symbol
);
6467 return apply_modifiers (XFASTINT (XCAR (XCDR (parsed
))),
6472 /* For handling events, we often want to produce a symbol whose name
6473 is a series of modifier key prefixes ("M-", "C-", etcetera) attached
6474 to some base, like the name of a function key or mouse button.
6475 modify_event_symbol produces symbols of this sort.
6477 NAME_TABLE should point to an array of strings, such that NAME_TABLE[i]
6478 is the name of the i'th symbol. TABLE_SIZE is the number of elements
6481 Alternatively, NAME_ALIST_OR_STEM is either an alist mapping codes
6482 into symbol names, or a string specifying a name stem used to
6483 construct a symbol name or the form `STEM-N', where N is the decimal
6484 representation of SYMBOL_NUM. NAME_ALIST_OR_STEM is used if it is
6485 non-nil; otherwise NAME_TABLE is used.
6487 SYMBOL_TABLE should be a pointer to a Lisp_Object whose value will
6488 persist between calls to modify_event_symbol that it can use to
6489 store a cache of the symbols it's generated for this NAME_TABLE
6490 before. The object stored there may be a vector or an alist.
6492 SYMBOL_NUM is the number of the base name we want from NAME_TABLE.
6494 MODIFIERS is a set of modifier bits (as given in struct input_events)
6495 whose prefixes should be applied to the symbol name.
6497 SYMBOL_KIND is the value to be placed in the event_kind property of
6498 the returned symbol.
6500 The symbols we create are supposed to have an
6501 `event-symbol-elements' property, which lists the modifiers present
6502 in the symbol's name. */
6505 modify_event_symbol (ptrdiff_t symbol_num
, int modifiers
, Lisp_Object symbol_kind
,
6506 Lisp_Object name_alist_or_stem
, const char *const *name_table
,
6507 Lisp_Object
*symbol_table
, ptrdiff_t table_size
)
6510 Lisp_Object symbol_int
;
6512 /* Get rid of the "vendor-specific" bit here. */
6513 XSETINT (symbol_int
, symbol_num
& 0xffffff);
6515 /* Is this a request for a valid symbol? */
6516 if (symbol_num
< 0 || symbol_num
>= table_size
)
6519 if (CONSP (*symbol_table
))
6520 value
= Fcdr (assq_no_quit (symbol_int
, *symbol_table
));
6522 /* If *symbol_table doesn't seem to be initialized properly, fix that.
6523 *symbol_table should be a lisp vector TABLE_SIZE elements long,
6524 where the Nth element is the symbol for NAME_TABLE[N], or nil if
6525 we've never used that symbol before. */
6528 if (! VECTORP (*symbol_table
)
6529 || ASIZE (*symbol_table
) != table_size
)
6533 XSETFASTINT (size
, table_size
);
6534 *symbol_table
= Fmake_vector (size
, Qnil
);
6537 value
= AREF (*symbol_table
, symbol_num
);
6540 /* Have we already used this symbol before? */
6543 /* No; let's create it. */
6544 if (CONSP (name_alist_or_stem
))
6545 value
= Fcdr_safe (Fassq (symbol_int
, name_alist_or_stem
));
6546 else if (STRINGP (name_alist_or_stem
))
6549 ptrdiff_t len
= (SBYTES (name_alist_or_stem
)
6550 + sizeof "-" + INT_STRLEN_BOUND (EMACS_INT
));
6552 buf
= SAFE_ALLOCA (len
);
6553 esprintf (buf
, "%s-%"pI
"d", SDATA (name_alist_or_stem
),
6554 XINT (symbol_int
) + 1);
6555 value
= intern (buf
);
6558 else if (name_table
!= 0 && name_table
[symbol_num
])
6559 value
= intern (name_table
[symbol_num
]);
6561 #ifdef HAVE_WINDOW_SYSTEM
6564 char *name
= x_get_keysym_name (symbol_num
);
6566 value
= intern (name
);
6572 char buf
[sizeof "key-" + INT_STRLEN_BOUND (EMACS_INT
)];
6573 sprintf (buf
, "key-%"pD
"d", symbol_num
);
6574 value
= intern (buf
);
6577 if (CONSP (*symbol_table
))
6578 *symbol_table
= Fcons (Fcons (symbol_int
, value
), *symbol_table
);
6580 ASET (*symbol_table
, symbol_num
, value
);
6582 /* Fill in the cache entries for this symbol; this also
6583 builds the Qevent_symbol_elements property, which the user
6585 apply_modifiers (modifiers
& click_modifier
, value
);
6586 Fput (value
, Qevent_kind
, symbol_kind
);
6589 /* Apply modifiers to that symbol. */
6590 return apply_modifiers (modifiers
, value
);
6593 /* Convert a list that represents an event type,
6594 such as (ctrl meta backspace), into the usual representation of that
6595 event type as a number or a symbol. */
6597 DEFUN ("event-convert-list", Fevent_convert_list
, Sevent_convert_list
, 1, 1, 0,
6598 doc
: /* Convert the event description list EVENT-DESC to an event type.
6599 EVENT-DESC should contain one base event type (a character or symbol)
6600 and zero or more modifier names (control, meta, hyper, super, shift, alt,
6601 drag, down, double or triple). The base must be last.
6602 The return value is an event type (a character or symbol) which
6603 has the same base event type and all the specified modifiers. */)
6604 (Lisp_Object event_desc
)
6612 while (CONSP (rest
))
6620 /* Given a symbol, see if it is a modifier name. */
6621 if (SYMBOLP (elt
) && CONSP (rest
))
6622 this = parse_solitary_modifier (elt
);
6626 else if (!NILP (base
))
6627 error ("Two bases given in one event");
6633 /* Let the symbol A refer to the character A. */
6634 if (SYMBOLP (base
) && SCHARS (SYMBOL_NAME (base
)) == 1)
6635 XSETINT (base
, SREF (SYMBOL_NAME (base
), 0));
6637 if (INTEGERP (base
))
6639 /* Turn (shift a) into A. */
6640 if ((modifiers
& shift_modifier
) != 0
6641 && (XINT (base
) >= 'a' && XINT (base
) <= 'z'))
6643 XSETINT (base
, XINT (base
) - ('a' - 'A'));
6644 modifiers
&= ~shift_modifier
;
6647 /* Turn (control a) into C-a. */
6648 if (modifiers
& ctrl_modifier
)
6649 return make_number ((modifiers
& ~ctrl_modifier
)
6650 | make_ctrl_char (XINT (base
)));
6652 return make_number (modifiers
| XINT (base
));
6654 else if (SYMBOLP (base
))
6655 return apply_modifiers (modifiers
, base
);
6657 error ("Invalid base event");
6660 /* Try to recognize SYMBOL as a modifier name.
6661 Return the modifier flag bit, or 0 if not recognized. */
6664 parse_solitary_modifier (Lisp_Object symbol
)
6666 Lisp_Object name
= SYMBOL_NAME (symbol
);
6668 switch (SREF (name
, 0))
6670 #define SINGLE_LETTER_MOD(BIT) \
6671 if (SBYTES (name) == 1) \
6674 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6675 if (LEN == SBYTES (name) \
6676 && ! memcmp (SDATA (name), NAME, LEN)) \
6680 SINGLE_LETTER_MOD (alt_modifier
);
6684 MULTI_LETTER_MOD (alt_modifier
, "alt", 3);
6688 SINGLE_LETTER_MOD (ctrl_modifier
);
6692 MULTI_LETTER_MOD (ctrl_modifier
, "ctrl", 4);
6693 MULTI_LETTER_MOD (ctrl_modifier
, "control", 7);
6697 SINGLE_LETTER_MOD (hyper_modifier
);
6701 MULTI_LETTER_MOD (hyper_modifier
, "hyper", 5);
6705 SINGLE_LETTER_MOD (meta_modifier
);
6709 MULTI_LETTER_MOD (meta_modifier
, "meta", 4);
6713 SINGLE_LETTER_MOD (shift_modifier
);
6717 MULTI_LETTER_MOD (shift_modifier
, "shift", 5);
6718 MULTI_LETTER_MOD (super_modifier
, "super", 5);
6719 SINGLE_LETTER_MOD (super_modifier
);
6723 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
6724 MULTI_LETTER_MOD (down_modifier
, "down", 4);
6725 MULTI_LETTER_MOD (double_modifier
, "double", 6);
6729 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
6732 #undef SINGLE_LETTER_MOD
6733 #undef MULTI_LETTER_MOD
6739 /* Return true if EVENT is a list whose elements are all integers or symbols.
6740 Such a list is not valid as an event,
6741 but it can be a Lucid-style event type list. */
6744 lucid_event_type_list_p (Lisp_Object object
)
6748 if (! CONSP (object
))
6751 if (EQ (XCAR (object
), Qhelp_echo
)
6752 || EQ (XCAR (object
), Qvertical_line
)
6753 || EQ (XCAR (object
), Qmode_line
)
6754 || EQ (XCAR (object
), Qheader_line
))
6757 for (tail
= object
; CONSP (tail
); tail
= XCDR (tail
))
6761 if (! (INTEGERP (elt
) || SYMBOLP (elt
)))
6768 /* Return true if terminal input chars are available.
6769 Also, store the return value into INPUT_PENDING.
6771 Serves the purpose of ioctl (0, FIONREAD, ...)
6772 but works even if FIONREAD does not exist.
6773 (In fact, this may actually read some input.)
6775 If READABLE_EVENTS_DO_TIMERS_NOW is set in FLAGS, actually run
6776 timer events that are ripe.
6777 If READABLE_EVENTS_FILTER_EVENTS is set in FLAGS, ignore internal
6778 events (FOCUS_IN_EVENT).
6779 If READABLE_EVENTS_IGNORE_SQUEEZABLES is set in FLAGS, ignore mouse
6780 movements and toolkit scroll bar thumb drags. */
6783 get_input_pending (int flags
)
6785 /* First of all, have we already counted some input? */
6786 input_pending
= (!NILP (Vquit_flag
) || readable_events (flags
));
6788 /* If input is being read as it arrives, and we have none, there is none. */
6789 if (!input_pending
&& (!interrupt_input
|| interrupts_deferred
))
6791 /* Try to read some input and see how much we get. */
6793 input_pending
= (!NILP (Vquit_flag
) || readable_events (flags
));
6796 return input_pending
;
6799 /* Put a BUFFER_SWITCH_EVENT in the buffer
6800 so that read_key_sequence will notice the new current buffer. */
6803 record_asynch_buffer_change (void)
6805 /* We don't need a buffer-switch event unless Emacs is waiting for input.
6806 The purpose of the event is to make read_key_sequence look up the
6807 keymaps again. If we aren't in read_key_sequence, we don't need one,
6808 and the event could cause trouble by messing up (input-pending-p).
6809 Note: Fwaiting_for_user_input_p always returns nil when async
6810 subprocesses aren't supported. */
6811 if (!NILP (Fwaiting_for_user_input_p ()))
6813 struct input_event event
;
6816 event
.kind
= BUFFER_SWITCH_EVENT
;
6817 event
.frame_or_window
= Qnil
;
6820 /* Make sure no interrupt happens while storing the event. */
6822 if (interrupt_input
)
6823 kbd_buffer_store_event (&event
);
6828 kbd_buffer_store_event (&event
);
6834 /* Read any terminal input already buffered up by the system
6835 into the kbd_buffer, but do not wait.
6837 Return the number of keyboard chars read, or -1 meaning
6838 this is a bad time to try to read input. */
6847 /* Store pending user signal events, if any. */
6848 store_user_signal_events ();
6850 /* Loop through the available terminals, and call their input hooks. */
6854 struct terminal
*next
= t
->next_terminal
;
6856 if (t
->read_socket_hook
)
6859 struct input_event hold_quit
;
6861 if (input_blocked_p ())
6863 pending_signals
= 1;
6867 EVENT_INIT (hold_quit
);
6868 hold_quit
.kind
= NO_EVENT
;
6870 /* No need for FIONREAD or fcntl; just say don't wait. */
6871 while ((nr
= (*t
->read_socket_hook
) (t
, &hold_quit
)) > 0)
6874 if (nr
== -1) /* Not OK to read input now. */
6878 else if (nr
== -2) /* Non-transient error. */
6880 /* The terminal device terminated; it should be closed. */
6882 /* Kill Emacs if this was our last terminal. */
6883 if (!terminal_list
->next_terminal
)
6884 /* Formerly simply reported no input, but that
6885 sometimes led to a failure of Emacs to terminate.
6886 SIGHUP seems appropriate if we can't reach the
6888 /* ??? Is it really right to send the signal just to
6889 this process rather than to the whole process
6890 group? Perhaps on systems with FIONREAD Emacs is
6891 alone in its group. */
6892 terminate_due_to_signal (SIGHUP
, 10);
6894 /* XXX Is calling delete_terminal safe here? It calls delete_frame. */
6897 XSETTERMINAL (tmp
, t
);
6898 Fdelete_terminal (tmp
, Qnoelisp
);
6902 /* If there was no error, make sure the pointer
6903 is visible for all frames on this terminal. */
6906 Lisp_Object tail
, frame
;
6908 FOR_EACH_FRAME (tail
, frame
)
6910 struct frame
*f
= XFRAME (frame
);
6911 if (FRAME_TERMINAL (f
) == t
)
6912 frame_make_pointer_visible (f
);
6916 if (hold_quit
.kind
!= NO_EVENT
)
6917 kbd_buffer_store_event (&hold_quit
);
6929 /* This is the tty way of reading available input.
6931 Note that each terminal device has its own `struct terminal' object,
6932 and so this function is called once for each individual termcap
6933 terminal. The first parameter indicates which terminal to read from. */
6936 tty_read_avail_input (struct terminal
*terminal
,
6937 struct input_event
*hold_quit
)
6939 /* Using KBD_BUFFER_SIZE - 1 here avoids reading more than
6940 the kbd_buffer can really hold. That may prevent loss
6941 of characters on some systems when input is stuffed at us. */
6942 unsigned char cbuf
[KBD_BUFFER_SIZE
- 1];
6944 struct tty_display_info
*tty
= terminal
->display_info
.tty
;
6947 int buffer_free
= KBD_BUFFER_SIZE
- kbd_buffer_nr_stored () - 1;
6949 if (kbd_on_hold_p () || buffer_free
<= 0)
6951 #endif /* subprocesses */
6953 if (!terminal
->name
) /* Don't read from a dead terminal. */
6956 if (terminal
->type
!= output_termcap
6957 && terminal
->type
!= output_msdos_raw
)
6960 /* XXX I think the following code should be moved to separate hook
6961 functions in system-dependent files. */
6963 /* FIXME: AFAIK, tty_read_avail_input is not used under w32 since the non-GUI
6964 code sets read_socket_hook to w32_console_read_socket instead! */
6966 #else /* not WINDOWSNT */
6967 if (! tty
->term_initted
) /* In case we get called during bootstrap. */
6971 return 0; /* The terminal is suspended. */
6974 n_to_read
= dos_keysns ();
6978 cbuf
[0] = dos_keyread ();
6981 #else /* not MSDOS */
6986 struct input_event gpm_hold_quit
;
6987 int gpm
, fd
= gpm_fd
;
6989 EVENT_INIT (gpm_hold_quit
);
6990 gpm_hold_quit
.kind
= NO_EVENT
;
6992 /* gpm==1 if event received.
6993 gpm==0 if the GPM daemon has closed the connection, in which case
6994 Gpm_GetEvent closes gpm_fd and clears it to -1, which is why
6995 we save it in `fd' so close_gpm can remove it from the
6997 gpm==-1 if a protocol error or EWOULDBLOCK; the latter is normal. */
6998 while (gpm
= Gpm_GetEvent (&event
), gpm
== 1) {
6999 nread
+= handle_one_term_event (tty
, &event
, &gpm_hold_quit
);
7002 /* Presumably the GPM daemon has closed the connection. */
7004 if (gpm_hold_quit
.kind
!= NO_EVENT
)
7005 kbd_buffer_store_event (&gpm_hold_quit
);
7009 #endif /* HAVE_GPM */
7011 /* Determine how many characters we should *try* to read. */
7012 #ifdef USABLE_FIONREAD
7013 /* Find out how much input is available. */
7014 if (ioctl (fileno (tty
->input
), FIONREAD
, &n_to_read
) < 0)
7016 if (! noninteractive
)
7017 return -2; /* Close this terminal. */
7023 if (n_to_read
> sizeof cbuf
)
7024 n_to_read
= sizeof cbuf
;
7025 #elif defined USG || defined CYGWIN
7026 /* Read some input if available, but don't wait. */
7027 n_to_read
= sizeof cbuf
;
7028 fcntl (fileno (tty
->input
), F_SETFL
, O_NONBLOCK
);
7030 # error "Cannot read without possibly delaying"
7034 /* Don't read more than we can store. */
7035 if (n_to_read
> buffer_free
)
7036 n_to_read
= buffer_free
;
7037 #endif /* subprocesses */
7039 /* Now read; for one reason or another, this will not block.
7040 NREAD is set to the number of chars read. */
7043 nread
= emacs_read (fileno (tty
->input
), (char *) cbuf
, n_to_read
);
7044 /* POSIX infers that processes which are not in the session leader's
7045 process group won't get SIGHUPs at logout time. BSDI adheres to
7046 this part standard and returns -1 from read (0) with errno==EIO
7047 when the control tty is taken away.
7048 Jeffrey Honig <jch@bsdi.com> says this is generally safe. */
7049 if (nread
== -1 && errno
== EIO
)
7050 return -2; /* Close this terminal. */
7051 #if defined (AIX) && defined (_BSD)
7052 /* The kernel sometimes fails to deliver SIGHUP for ptys.
7053 This looks incorrect, but it isn't, because _BSD causes
7054 O_NDELAY to be defined in fcntl.h as O_NONBLOCK,
7055 and that causes a value other than 0 when there is no input. */
7057 return -2; /* Close this terminal. */
7061 /* We used to retry the read if it was interrupted.
7062 But this does the wrong thing when O_NONBLOCK causes
7063 an EAGAIN error. Does anybody know of a situation
7064 where a retry is actually needed? */
7066 nread
< 0 && (errno
== EAGAIN
|| errno
== EFAULT
7076 #ifndef USABLE_FIONREAD
7077 #if defined (USG) || defined (CYGWIN)
7078 fcntl (fileno (tty
->input
), F_SETFL
, 0);
7079 #endif /* USG or CYGWIN */
7080 #endif /* no FIONREAD */
7085 #endif /* not MSDOS */
7086 #endif /* not WINDOWSNT */
7088 for (i
= 0; i
< nread
; i
++)
7090 struct input_event buf
;
7092 buf
.kind
= ASCII_KEYSTROKE_EVENT
;
7094 if (tty
->meta_key
== 1 && (cbuf
[i
] & 0x80))
7095 buf
.modifiers
= meta_modifier
;
7096 if (tty
->meta_key
!= 2)
7100 /* Set the frame corresponding to the active tty. Note that the
7101 value of selected_frame is not reliable here, redisplay tends
7102 to temporarily change it. */
7103 buf
.frame_or_window
= tty
->top_frame
;
7106 kbd_buffer_store_event (&buf
);
7107 /* Don't look at input that follows a C-g too closely.
7108 This reduces lossage due to autorepeat on C-g. */
7109 if (buf
.kind
== ASCII_KEYSTROKE_EVENT
7110 && buf
.code
== quit_char
)
7118 handle_async_input (void)
7123 int nread
= gobble_input ();
7124 /* -1 means it's not ok to read the input now.
7125 UNBLOCK_INPUT will read it later; now, avoid infinite loop.
7126 0 means there was no keyboard input available. */
7134 process_pending_signals (void)
7136 pending_signals
= 0;
7137 handle_async_input ();
7138 do_pending_atimers ();
7141 /* Undo any number of BLOCK_INPUT calls down to level LEVEL,
7142 and reinvoke any pending signal if the level is now 0 and
7143 a fatal error is not already in progress. */
7146 unblock_input_to (int level
)
7148 interrupt_input_blocked
= level
;
7151 if (pending_signals
&& !fatal_error_in_progress
)
7152 process_pending_signals ();
7158 /* End critical section.
7160 If doing signal-driven input, and a signal came in when input was
7161 blocked, reinvoke the signal handler now to deal with it.
7163 It will also process queued input, if it was not read before.
7164 When a longer code sequence does not use block/unblock input
7165 at all, the whole input gathered up to the next call to
7166 unblock_input will be processed inside that call. */
7169 unblock_input (void)
7171 unblock_input_to (interrupt_input_blocked
- 1);
7174 /* Undo any number of BLOCK_INPUT calls,
7175 and also reinvoke any pending signal. */
7178 totally_unblock_input (void)
7180 unblock_input_to (0);
7186 handle_input_available_signal (int sig
)
7188 pending_signals
= 1;
7190 if (input_available_clear_time
)
7191 *input_available_clear_time
= make_timespec (0, 0);
7195 deliver_input_available_signal (int sig
)
7197 deliver_process_signal (sig
, handle_input_available_signal
);
7199 #endif /* USABLE_SIGIO */
7202 /* User signal events. */
7204 struct user_signal_info
7206 /* Signal number. */
7209 /* Name of the signal. */
7212 /* Number of pending signals. */
7215 struct user_signal_info
*next
;
7218 /* List of user signals. */
7219 static struct user_signal_info
*user_signals
= NULL
;
7222 add_user_signal (int sig
, const char *name
)
7224 struct sigaction action
;
7225 struct user_signal_info
*p
;
7227 for (p
= user_signals
; p
; p
= p
->next
)
7229 /* Already added. */
7232 p
= xmalloc (sizeof *p
);
7234 p
->name
= xstrdup (name
);
7236 p
->next
= user_signals
;
7239 emacs_sigaction_init (&action
, deliver_user_signal
);
7240 sigaction (sig
, &action
, 0);
7244 handle_user_signal (int sig
)
7246 struct user_signal_info
*p
;
7247 const char *special_event_name
= NULL
;
7249 if (SYMBOLP (Vdebug_on_event
))
7250 special_event_name
= SSDATA (SYMBOL_NAME (Vdebug_on_event
));
7252 for (p
= user_signals
; p
; p
= p
->next
)
7255 if (special_event_name
7256 && strcmp (special_event_name
, p
->name
) == 0)
7258 /* Enter the debugger in many ways. */
7259 debug_on_next_call
= 1;
7262 Vinhibit_quit
= Qnil
;
7264 /* Eat the event. */
7270 if (interrupt_input
)
7271 handle_input_available_signal (sig
);
7275 /* Tell wait_reading_process_output that it needs to wake
7276 up and look around. */
7277 if (input_available_clear_time
)
7278 *input_available_clear_time
= make_timespec (0, 0);
7285 deliver_user_signal (int sig
)
7287 deliver_process_signal (sig
, handle_user_signal
);
7291 find_user_signal_name (int sig
)
7293 struct user_signal_info
*p
;
7295 for (p
= user_signals
; p
; p
= p
->next
)
7303 store_user_signal_events (void)
7305 struct user_signal_info
*p
;
7306 struct input_event buf
;
7307 bool buf_initialized
= 0;
7309 for (p
= user_signals
; p
; p
= p
->next
)
7310 if (p
->npending
> 0)
7312 if (! buf_initialized
)
7314 memset (&buf
, 0, sizeof buf
);
7315 buf
.kind
= USER_SIGNAL_EVENT
;
7316 buf
.frame_or_window
= selected_frame
;
7317 buf_initialized
= 1;
7323 kbd_buffer_store_event (&buf
);
7326 while (p
->npending
> 0);
7331 static void menu_bar_item (Lisp_Object
, Lisp_Object
, Lisp_Object
, void *);
7332 static Lisp_Object menu_bar_one_keymap_changed_items
;
7334 /* These variables hold the vector under construction within
7335 menu_bar_items and its subroutines, and the current index
7336 for storing into that vector. */
7337 static Lisp_Object menu_bar_items_vector
;
7338 static int menu_bar_items_index
;
7341 static const char *separator_names
[] = {
7346 "single-dashed-line",
7347 "double-dashed-line",
7349 "shadow-etched-out",
7350 "shadow-etched-in-dash",
7351 "shadow-etched-out-dash",
7352 "shadow-double-etched-in",
7353 "shadow-double-etched-out",
7354 "shadow-double-etched-in-dash",
7355 "shadow-double-etched-out-dash",
7359 /* Return true if LABEL specifies a separator. */
7362 menu_separator_name_p (const char *label
)
7366 else if (strlen (label
) > 3
7367 && memcmp (label
, "--", 2) == 0
7372 for (i
= 0; separator_names
[i
]; ++i
)
7373 if (strcmp (label
, separator_names
[i
]) == 0)
7378 /* It's a separator if it contains only dashes. */
7379 while (*label
== '-')
7381 return (*label
== 0);
7388 /* Return a vector of menu items for a menu bar, appropriate
7389 to the current buffer. Each item has three elements in the vector:
7392 OLD is an old vector we can optionally reuse, or nil. */
7395 menu_bar_items (Lisp_Object old
)
7397 /* The number of keymaps we're scanning right now, and the number of
7398 keymaps we have allocated space for. */
7401 /* maps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
7402 in the current keymaps, or nil where it is not a prefix. */
7405 Lisp_Object def
, tail
;
7410 /* In order to build the menus, we need to call the keymap
7411 accessors. They all call QUIT. But this function is called
7412 during redisplay, during which a quit is fatal. So inhibit
7413 quitting while building the menus.
7414 We do this instead of specbind because (1) errors will clear it anyway
7415 and (2) this avoids risk of specpdl overflow. */
7416 oquit
= Vinhibit_quit
;
7420 menu_bar_items_vector
= old
;
7422 menu_bar_items_vector
= Fmake_vector (make_number (24), Qnil
);
7423 menu_bar_items_index
= 0;
7425 /* Build our list of keymaps.
7426 If we recognize a function key and replace its escape sequence in
7427 keybuf with its symbol, or if the sequence starts with a mouse
7428 click and we need to switch buffers, we jump back here to rebuild
7429 the initial keymaps from the current buffer. */
7433 /* Should overriding-terminal-local-map and overriding-local-map apply? */
7434 if (!NILP (Voverriding_local_map_menu_flag
)
7435 && !NILP (Voverriding_local_map
))
7437 /* Yes, use them (if non-nil) as well as the global map. */
7438 maps
= alloca (3 * sizeof (maps
[0]));
7440 if (!NILP (KVAR (current_kboard
, Voverriding_terminal_local_map
)))
7441 maps
[nmaps
++] = KVAR (current_kboard
, Voverriding_terminal_local_map
);
7442 if (!NILP (Voverriding_local_map
))
7443 maps
[nmaps
++] = Voverriding_local_map
;
7447 /* No, so use major and minor mode keymaps and keymap property.
7448 Note that menu-bar bindings in the local-map and keymap
7449 properties may not work reliable, as they are only
7450 recognized when the menu-bar (or mode-line) is updated,
7451 which does not normally happen after every command. */
7454 nminor
= current_minor_maps (NULL
, &tmaps
);
7455 maps
= alloca ((nminor
+ 4) * sizeof *maps
);
7457 tem
= KVAR (current_kboard
, Voverriding_terminal_local_map
);
7458 if (!NILP (tem
) && !NILP (Voverriding_local_map_menu_flag
))
7459 maps
[nmaps
++] = tem
;
7460 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
7461 maps
[nmaps
++] = tem
;
7462 memcpy (maps
+ nmaps
, tmaps
, nminor
* sizeof (maps
[0]));
7464 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
7466 maps
[nmaps
++] = current_global_map
;
7469 /* Look up in each map the dummy prefix key `menu-bar'. */
7471 for (mapno
= nmaps
- 1; mapno
>= 0; mapno
--)
7472 if (!NILP (maps
[mapno
]))
7474 def
= get_keymap (access_keymap (maps
[mapno
], Qmenu_bar
, 1, 0, 1),
7478 menu_bar_one_keymap_changed_items
= Qnil
;
7479 map_keymap_canonical (def
, menu_bar_item
, Qnil
, NULL
);
7483 /* Move to the end those items that should be at the end. */
7485 for (tail
= Vmenu_bar_final_items
; CONSP (tail
); tail
= XCDR (tail
))
7488 int end
= menu_bar_items_index
;
7490 for (i
= 0; i
< end
; i
+= 4)
7491 if (EQ (XCAR (tail
), AREF (menu_bar_items_vector
, i
)))
7493 Lisp_Object tem0
, tem1
, tem2
, tem3
;
7494 /* Move the item at index I to the end,
7495 shifting all the others forward. */
7496 tem0
= AREF (menu_bar_items_vector
, i
+ 0);
7497 tem1
= AREF (menu_bar_items_vector
, i
+ 1);
7498 tem2
= AREF (menu_bar_items_vector
, i
+ 2);
7499 tem3
= AREF (menu_bar_items_vector
, i
+ 3);
7501 memmove (aref_addr (menu_bar_items_vector
, i
),
7502 aref_addr (menu_bar_items_vector
, i
+ 4),
7503 (end
- i
- 4) * word_size
);
7504 ASET (menu_bar_items_vector
, end
- 4, tem0
);
7505 ASET (menu_bar_items_vector
, end
- 3, tem1
);
7506 ASET (menu_bar_items_vector
, end
- 2, tem2
);
7507 ASET (menu_bar_items_vector
, end
- 1, tem3
);
7512 /* Add nil, nil, nil, nil at the end. */
7514 int i
= menu_bar_items_index
;
7515 if (i
+ 4 > ASIZE (menu_bar_items_vector
))
7516 menu_bar_items_vector
7517 = larger_vector (menu_bar_items_vector
, 4, -1);
7518 /* Add this item. */
7519 ASET (menu_bar_items_vector
, i
, Qnil
); i
++;
7520 ASET (menu_bar_items_vector
, i
, Qnil
); i
++;
7521 ASET (menu_bar_items_vector
, i
, Qnil
); i
++;
7522 ASET (menu_bar_items_vector
, i
, Qnil
); i
++;
7523 menu_bar_items_index
= i
;
7526 Vinhibit_quit
= oquit
;
7527 return menu_bar_items_vector
;
7530 /* Add one item to menu_bar_items_vector, for KEY, ITEM_STRING and DEF.
7531 If there's already an item for KEY, add this DEF to it. */
7533 Lisp_Object item_properties
;
7536 menu_bar_item (Lisp_Object key
, Lisp_Object item
, Lisp_Object dummy1
, void *dummy2
)
7538 struct gcpro gcpro1
;
7543 if (EQ (item
, Qundefined
))
7545 /* If a map has an explicit `undefined' as definition,
7546 discard any previously made menu bar item. */
7548 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7549 if (EQ (key
, AREF (menu_bar_items_vector
, i
)))
7551 if (menu_bar_items_index
> i
+ 4)
7552 memmove (aref_addr (menu_bar_items_vector
, i
),
7553 aref_addr (menu_bar_items_vector
, i
+ 4),
7554 (menu_bar_items_index
- i
- 4) * word_size
);
7555 menu_bar_items_index
-= 4;
7559 /* If this keymap has already contributed to this KEY,
7560 don't contribute to it a second time. */
7561 tem
= Fmemq (key
, menu_bar_one_keymap_changed_items
);
7562 if (!NILP (tem
) || NILP (item
))
7565 menu_bar_one_keymap_changed_items
7566 = Fcons (key
, menu_bar_one_keymap_changed_items
);
7568 /* We add to menu_bar_one_keymap_changed_items before doing the
7569 parse_menu_item, so that if it turns out it wasn't a menu item,
7570 it still correctly hides any further menu item. */
7572 parsed
= parse_menu_item (item
, 1);
7577 item
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7579 /* Find any existing item for this KEY. */
7580 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7581 if (EQ (key
, AREF (menu_bar_items_vector
, i
)))
7584 /* If we did not find this KEY, add it at the end. */
7585 if (i
== menu_bar_items_index
)
7587 /* If vector is too small, get a bigger one. */
7588 if (i
+ 4 > ASIZE (menu_bar_items_vector
))
7589 menu_bar_items_vector
= larger_vector (menu_bar_items_vector
, 4, -1);
7590 /* Add this item. */
7591 ASET (menu_bar_items_vector
, i
, key
); i
++;
7592 ASET (menu_bar_items_vector
, i
,
7593 AREF (item_properties
, ITEM_PROPERTY_NAME
)); i
++;
7594 ASET (menu_bar_items_vector
, i
, list1 (item
)); i
++;
7595 ASET (menu_bar_items_vector
, i
, make_number (0)); i
++;
7596 menu_bar_items_index
= i
;
7598 /* We did find an item for this KEY. Add ITEM to its list of maps. */
7602 old
= AREF (menu_bar_items_vector
, i
+ 2);
7603 /* If the new and the old items are not both keymaps,
7604 the lookup will only find `item'. */
7605 item
= Fcons (item
, KEYMAPP (item
) && KEYMAPP (XCAR (old
)) ? old
: Qnil
);
7606 ASET (menu_bar_items_vector
, i
+ 2, item
);
7610 /* This is used as the handler when calling menu_item_eval_property. */
7612 menu_item_eval_property_1 (Lisp_Object arg
)
7614 /* If we got a quit from within the menu computation,
7615 quit all the way out of it. This takes care of C-] in the debugger. */
7616 if (CONSP (arg
) && EQ (XCAR (arg
), Qquit
))
7617 Fsignal (Qquit
, Qnil
);
7623 eval_dyn (Lisp_Object form
)
7625 return Feval (form
, Qnil
);
7628 /* Evaluate an expression and return the result (or nil if something
7629 went wrong). Used to evaluate dynamic parts of menu items. */
7631 menu_item_eval_property (Lisp_Object sexpr
)
7633 ptrdiff_t count
= SPECPDL_INDEX ();
7635 specbind (Qinhibit_redisplay
, Qt
);
7636 val
= internal_condition_case_1 (eval_dyn
, sexpr
, Qerror
,
7637 menu_item_eval_property_1
);
7638 return unbind_to (count
, val
);
7641 /* This function parses a menu item and leaves the result in the
7642 vector item_properties.
7643 ITEM is a key binding, a possible menu item.
7644 INMENUBAR is > 0 when this is considered for an entry in a menu bar
7646 INMENUBAR is < 0 when this is considered for an entry in a keyboard menu.
7647 parse_menu_item returns true if the item is a menu item and false
7651 parse_menu_item (Lisp_Object item
, int inmenubar
)
7653 Lisp_Object def
, tem
, item_string
, start
;
7655 Lisp_Object keyhint
;
7664 /* Create item_properties vector if necessary. */
7665 if (NILP (item_properties
))
7667 = Fmake_vector (make_number (ITEM_PROPERTY_ENABLE
+ 1), Qnil
);
7669 /* Initialize optional entries. */
7670 for (i
= ITEM_PROPERTY_DEF
; i
< ITEM_PROPERTY_ENABLE
; i
++)
7671 ASET (item_properties
, i
, Qnil
);
7672 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7674 /* Save the item here to protect it from GC. */
7675 ASET (item_properties
, ITEM_PROPERTY_ITEM
, item
);
7677 item_string
= XCAR (item
);
7681 if (STRINGP (item_string
))
7683 /* Old format menu item. */
7684 ASET (item_properties
, ITEM_PROPERTY_NAME
, item_string
);
7686 /* Maybe help string. */
7687 if (CONSP (item
) && STRINGP (XCAR (item
)))
7689 ASET (item_properties
, ITEM_PROPERTY_HELP
, XCAR (item
));
7694 /* Maybe an obsolete key binding cache. */
7695 if (CONSP (item
) && CONSP (XCAR (item
))
7696 && (NILP (XCAR (XCAR (item
)))
7697 || VECTORP (XCAR (XCAR (item
)))))
7700 /* This is the real definition--the function to run. */
7701 ASET (item_properties
, ITEM_PROPERTY_DEF
, item
);
7703 /* Get enable property, if any. */
7706 tem
= Fget (item
, Qmenu_enable
);
7707 if (!NILP (Venable_disabled_menus_and_buttons
))
7708 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7709 else if (!NILP (tem
))
7710 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, tem
);
7713 else if (EQ (item_string
, Qmenu_item
) && CONSP (item
))
7715 /* New format menu item. */
7716 ASET (item_properties
, ITEM_PROPERTY_NAME
, XCAR (item
));
7717 start
= XCDR (item
);
7720 /* We have a real binding. */
7721 ASET (item_properties
, ITEM_PROPERTY_DEF
, XCAR (start
));
7723 item
= XCDR (start
);
7724 /* Is there an obsolete cache list with key equivalences. */
7725 if (CONSP (item
) && CONSP (XCAR (item
)))
7728 /* Parse properties. */
7729 while (CONSP (item
) && CONSP (XCDR (item
)))
7734 if (EQ (tem
, QCenable
))
7736 if (!NILP (Venable_disabled_menus_and_buttons
))
7737 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7739 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, XCAR (item
));
7741 else if (EQ (tem
, QCvisible
))
7743 /* If got a visible property and that evaluates to nil
7744 then ignore this item. */
7745 tem
= menu_item_eval_property (XCAR (item
));
7749 else if (EQ (tem
, QChelp
))
7750 ASET (item_properties
, ITEM_PROPERTY_HELP
, XCAR (item
));
7751 else if (EQ (tem
, QCfilter
))
7753 else if (EQ (tem
, QCkey_sequence
))
7756 if (SYMBOLP (tem
) || STRINGP (tem
) || VECTORP (tem
))
7757 /* Be GC protected. Set keyhint to item instead of tem. */
7760 else if (EQ (tem
, QCkeys
))
7763 if (CONSP (tem
) || STRINGP (tem
))
7764 ASET (item_properties
, ITEM_PROPERTY_KEYEQ
, tem
);
7766 else if (EQ (tem
, QCbutton
) && CONSP (XCAR (item
)))
7771 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
7773 ASET (item_properties
, ITEM_PROPERTY_SELECTED
,
7775 ASET (item_properties
, ITEM_PROPERTY_TYPE
, type
);
7781 else if (inmenubar
|| !NILP (start
))
7785 return 0; /* not a menu item */
7787 /* If item string is not a string, evaluate it to get string.
7788 If we don't get a string, skip this item. */
7789 item_string
= AREF (item_properties
, ITEM_PROPERTY_NAME
);
7790 if (!(STRINGP (item_string
)))
7792 item_string
= menu_item_eval_property (item_string
);
7793 if (!STRINGP (item_string
))
7795 ASET (item_properties
, ITEM_PROPERTY_NAME
, item_string
);
7798 /* If got a filter apply it on definition. */
7799 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7802 def
= menu_item_eval_property (list2 (XCAR (filter
),
7803 list2 (Qquote
, def
)));
7805 ASET (item_properties
, ITEM_PROPERTY_DEF
, def
);
7808 /* Enable or disable selection of item. */
7809 tem
= AREF (item_properties
, ITEM_PROPERTY_ENABLE
);
7812 tem
= menu_item_eval_property (tem
);
7813 if (inmenubar
&& NILP (tem
))
7814 return 0; /* Ignore disabled items in menu bar. */
7815 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, tem
);
7818 /* If we got no definition, this item is just unselectable text which
7819 is OK in a submenu but not in the menubar. */
7821 return (!inmenubar
);
7823 /* See if this is a separate pane or a submenu. */
7824 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7825 tem
= get_keymap (def
, 0, 1);
7826 /* For a subkeymap, just record its details and exit. */
7829 ASET (item_properties
, ITEM_PROPERTY_MAP
, tem
);
7830 ASET (item_properties
, ITEM_PROPERTY_DEF
, tem
);
7834 /* At the top level in the menu bar, do likewise for commands also.
7835 The menu bar does not display equivalent key bindings anyway.
7836 ITEM_PROPERTY_DEF is already set up properly. */
7840 { /* This is a command. See if there is an equivalent key binding. */
7841 Lisp_Object keyeq
= AREF (item_properties
, ITEM_PROPERTY_KEYEQ
);
7843 /* The previous code preferred :key-sequence to :keys, so we
7844 preserve this behavior. */
7845 if (STRINGP (keyeq
) && !CONSP (keyhint
))
7846 keyeq
= concat2 (build_string (" "), Fsubstitute_command_keys (keyeq
));
7849 Lisp_Object prefix
= keyeq
;
7850 Lisp_Object keys
= Qnil
;
7854 def
= XCAR (prefix
);
7855 prefix
= XCDR (prefix
);
7858 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7860 if (CONSP (keyhint
) && !NILP (XCAR (keyhint
)))
7862 keys
= XCAR (keyhint
);
7863 tem
= Fkey_binding (keys
, Qnil
, Qnil
, Qnil
);
7865 /* We have a suggested key. Is it bound to the command? */
7868 /* If the command is an alias for another
7869 (such as lmenu.el set it up), check if the
7870 original command matches the cached command. */
7872 && EQ (tem
, XSYMBOL (def
)->function
))))
7877 keys
= Fwhere_is_internal (def
, Qnil
, Qt
, Qnil
, Qnil
);
7881 tem
= Fkey_description (keys
, Qnil
);
7884 if (STRINGP (XCAR (prefix
)))
7885 tem
= concat2 (XCAR (prefix
), tem
);
7886 if (STRINGP (XCDR (prefix
)))
7887 tem
= concat2 (tem
, XCDR (prefix
));
7889 keyeq
= concat2 (build_string (" "), tem
);
7890 /* keyeq = concat3(build_string(" ("),tem,build_string(")")); */
7896 /* If we have an equivalent key binding, use that. */
7897 ASET (item_properties
, ITEM_PROPERTY_KEYEQ
, keyeq
);
7900 /* Include this when menu help is implemented.
7901 tem = XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP];
7902 if (!(NILP (tem) || STRINGP (tem)))
7904 tem = menu_item_eval_property (tem);
7907 XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP] = tem;
7911 /* Handle radio buttons or toggle boxes. */
7912 tem
= AREF (item_properties
, ITEM_PROPERTY_SELECTED
);
7914 ASET (item_properties
, ITEM_PROPERTY_SELECTED
,
7915 menu_item_eval_property (tem
));
7922 /***********************************************************************
7924 ***********************************************************************/
7926 /* A vector holding tool bar items while they are parsed in function
7927 tool_bar_items. Each item occupies TOOL_BAR_ITEM_NSCLOTS elements
7930 static Lisp_Object tool_bar_items_vector
;
7932 /* A vector holding the result of parse_tool_bar_item. Layout is like
7933 the one for a single item in tool_bar_items_vector. */
7935 static Lisp_Object tool_bar_item_properties
;
7937 /* Next free index in tool_bar_items_vector. */
7939 static int ntool_bar_items
;
7941 /* The symbols `:image' and `:rtl'. */
7943 static Lisp_Object QCimage
;
7944 static Lisp_Object QCrtl
;
7946 /* Function prototypes. */
7948 static void init_tool_bar_items (Lisp_Object
);
7949 static void process_tool_bar_item (Lisp_Object
, Lisp_Object
, Lisp_Object
,
7951 static bool parse_tool_bar_item (Lisp_Object
, Lisp_Object
);
7952 static void append_tool_bar_item (void);
7955 /* Return a vector of tool bar items for keymaps currently in effect.
7956 Reuse vector REUSE if non-nil. Return in *NITEMS the number of
7957 tool bar items found. */
7960 tool_bar_items (Lisp_Object reuse
, int *nitems
)
7969 /* In order to build the menus, we need to call the keymap
7970 accessors. They all call QUIT. But this function is called
7971 during redisplay, during which a quit is fatal. So inhibit
7972 quitting while building the menus. We do this instead of
7973 specbind because (1) errors will clear it anyway and (2) this
7974 avoids risk of specpdl overflow. */
7975 oquit
= Vinhibit_quit
;
7978 /* Initialize tool_bar_items_vector and protect it from GC. */
7979 init_tool_bar_items (reuse
);
7981 /* Build list of keymaps in maps. Set nmaps to the number of maps
7984 /* Should overriding-terminal-local-map and overriding-local-map apply? */
7985 if (!NILP (Voverriding_local_map_menu_flag
)
7986 && !NILP (Voverriding_local_map
))
7988 /* Yes, use them (if non-nil) as well as the global map. */
7989 maps
= alloca (3 * sizeof *maps
);
7991 if (!NILP (KVAR (current_kboard
, Voverriding_terminal_local_map
)))
7992 maps
[nmaps
++] = KVAR (current_kboard
, Voverriding_terminal_local_map
);
7993 if (!NILP (Voverriding_local_map
))
7994 maps
[nmaps
++] = Voverriding_local_map
;
7998 /* No, so use major and minor mode keymaps and keymap property.
7999 Note that tool-bar bindings in the local-map and keymap
8000 properties may not work reliable, as they are only
8001 recognized when the tool-bar (or mode-line) is updated,
8002 which does not normally happen after every command. */
8005 nminor
= current_minor_maps (NULL
, &tmaps
);
8006 maps
= alloca ((nminor
+ 4) * sizeof *maps
);
8008 tem
= KVAR (current_kboard
, Voverriding_terminal_local_map
);
8009 if (!NILP (tem
) && !NILP (Voverriding_local_map_menu_flag
))
8010 maps
[nmaps
++] = tem
;
8011 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
8012 maps
[nmaps
++] = tem
;
8013 memcpy (maps
+ nmaps
, tmaps
, nminor
* sizeof (maps
[0]));
8015 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
8018 /* Add global keymap at the end. */
8019 maps
[nmaps
++] = current_global_map
;
8021 /* Process maps in reverse order and look up in each map the prefix
8023 for (i
= nmaps
- 1; i
>= 0; --i
)
8024 if (!NILP (maps
[i
]))
8028 keymap
= get_keymap (access_keymap (maps
[i
], Qtool_bar
, 1, 0, 1), 0, 1);
8030 map_keymap (keymap
, process_tool_bar_item
, Qnil
, NULL
, 1);
8033 Vinhibit_quit
= oquit
;
8034 *nitems
= ntool_bar_items
/ TOOL_BAR_ITEM_NSLOTS
;
8035 return tool_bar_items_vector
;
8039 /* Process the definition of KEY which is DEF. */
8042 process_tool_bar_item (Lisp_Object key
, Lisp_Object def
, Lisp_Object data
, void *args
)
8045 struct gcpro gcpro1
, gcpro2
;
8047 /* Protect KEY and DEF from GC because parse_tool_bar_item may call
8051 if (EQ (def
, Qundefined
))
8053 /* If a map has an explicit `undefined' as definition,
8054 discard any previously made item. */
8055 for (i
= 0; i
< ntool_bar_items
; i
+= TOOL_BAR_ITEM_NSLOTS
)
8057 Lisp_Object
*v
= XVECTOR (tool_bar_items_vector
)->contents
+ i
;
8059 if (EQ (key
, v
[TOOL_BAR_ITEM_KEY
]))
8061 if (ntool_bar_items
> i
+ TOOL_BAR_ITEM_NSLOTS
)
8062 memmove (v
, v
+ TOOL_BAR_ITEM_NSLOTS
,
8063 ((ntool_bar_items
- i
- TOOL_BAR_ITEM_NSLOTS
)
8065 ntool_bar_items
-= TOOL_BAR_ITEM_NSLOTS
;
8070 else if (parse_tool_bar_item (key
, def
))
8071 /* Append a new tool bar item to tool_bar_items_vector. Accept
8072 more than one definition for the same key. */
8073 append_tool_bar_item ();
8078 /* Access slot with index IDX of vector tool_bar_item_properties. */
8079 #define PROP(IDX) AREF (tool_bar_item_properties, (IDX))
8081 set_prop (ptrdiff_t idx
, Lisp_Object val
)
8083 ASET (tool_bar_item_properties
, idx
, val
);
8087 /* Parse a tool bar item specification ITEM for key KEY and return the
8088 result in tool_bar_item_properties. Value is false if ITEM is
8091 ITEM is a list `(menu-item CAPTION BINDING PROPS...)'.
8093 CAPTION is the caption of the item, If it's not a string, it is
8094 evaluated to get a string.
8096 BINDING is the tool bar item's binding. Tool-bar items with keymaps
8097 as binding are currently ignored.
8099 The following properties are recognized:
8103 FORM is evaluated and specifies whether the tool bar item is
8104 enabled or disabled.
8108 FORM is evaluated and specifies whether the tool bar item is visible.
8110 - `:filter FUNCTION'
8112 FUNCTION is invoked with one parameter `(quote BINDING)'. Its
8113 result is stored as the new binding.
8115 - `:button (TYPE SELECTED)'
8117 TYPE must be one of `:radio' or `:toggle'. SELECTED is evaluated
8118 and specifies whether the button is selected (pressed) or not.
8122 IMAGES is either a single image specification or a vector of four
8123 image specifications. See enum tool_bar_item_images.
8125 - `:help HELP-STRING'.
8127 Gives a help string to display for the tool bar item.
8129 - `:label LABEL-STRING'.
8131 A text label to show with the tool bar button if labels are enabled. */
8134 parse_tool_bar_item (Lisp_Object key
, Lisp_Object item
)
8136 Lisp_Object filter
= Qnil
;
8137 Lisp_Object caption
;
8139 bool have_label
= 0;
8141 /* Definition looks like `(menu-item CAPTION BINDING PROPS...)'.
8142 Rule out items that aren't lists, don't start with
8143 `menu-item' or whose rest following `tool-bar-item' is not a
8148 /* As an exception, allow old-style menu separators. */
8149 if (STRINGP (XCAR (item
)))
8150 item
= list1 (XCAR (item
));
8151 else if (!EQ (XCAR (item
), Qmenu_item
)
8152 || (item
= XCDR (item
), !CONSP (item
)))
8155 /* Create tool_bar_item_properties vector if necessary. Reset it to
8157 if (VECTORP (tool_bar_item_properties
))
8159 for (i
= 0; i
< TOOL_BAR_ITEM_NSLOTS
; ++i
)
8163 tool_bar_item_properties
8164 = Fmake_vector (make_number (TOOL_BAR_ITEM_NSLOTS
), Qnil
);
8167 set_prop (TOOL_BAR_ITEM_KEY
, key
);
8168 set_prop (TOOL_BAR_ITEM_ENABLED_P
, Qt
);
8170 /* Get the caption of the item. If the caption is not a string,
8171 evaluate it to get a string. If we don't get a string, skip this
8173 caption
= XCAR (item
);
8174 if (!STRINGP (caption
))
8176 caption
= menu_item_eval_property (caption
);
8177 if (!STRINGP (caption
))
8180 set_prop (TOOL_BAR_ITEM_CAPTION
, caption
);
8182 /* If the rest following the caption is not a list, the menu item is
8183 either a separator, or invalid. */
8187 if (menu_separator_name_p (SSDATA (caption
)))
8189 set_prop (TOOL_BAR_ITEM_TYPE
, Qt
);
8190 #if !defined (USE_GTK) && !defined (HAVE_NS)
8191 /* If we use build_desired_tool_bar_string to render the
8192 tool bar, the separator is rendered as an image. */
8193 set_prop (TOOL_BAR_ITEM_IMAGES
,
8194 (menu_item_eval_property
8195 (Vtool_bar_separator_image_expression
)));
8196 set_prop (TOOL_BAR_ITEM_ENABLED_P
, Qnil
);
8197 set_prop (TOOL_BAR_ITEM_SELECTED_P
, Qnil
);
8198 set_prop (TOOL_BAR_ITEM_CAPTION
, Qnil
);
8205 /* Store the binding. */
8206 set_prop (TOOL_BAR_ITEM_BINDING
, XCAR (item
));
8209 /* Ignore cached key binding, if any. */
8210 if (CONSP (item
) && CONSP (XCAR (item
)))
8213 /* Process the rest of the properties. */
8214 for (; CONSP (item
) && CONSP (XCDR (item
)); item
= XCDR (XCDR (item
)))
8216 Lisp_Object ikey
, value
;
8219 value
= XCAR (XCDR (item
));
8221 if (EQ (ikey
, QCenable
))
8223 /* `:enable FORM'. */
8224 if (!NILP (Venable_disabled_menus_and_buttons
))
8225 set_prop (TOOL_BAR_ITEM_ENABLED_P
, Qt
);
8227 set_prop (TOOL_BAR_ITEM_ENABLED_P
, value
);
8229 else if (EQ (ikey
, QCvisible
))
8231 /* `:visible FORM'. If got a visible property and that
8232 evaluates to nil then ignore this item. */
8233 if (NILP (menu_item_eval_property (value
)))
8236 else if (EQ (ikey
, QChelp
))
8237 /* `:help HELP-STRING'. */
8238 set_prop (TOOL_BAR_ITEM_HELP
, value
);
8239 else if (EQ (ikey
, QCvert_only
))
8240 /* `:vert-only t/nil'. */
8241 set_prop (TOOL_BAR_ITEM_VERT_ONLY
, value
);
8242 else if (EQ (ikey
, QClabel
))
8244 const char *bad_label
= "!!?GARBLED ITEM?!!";
8245 /* `:label LABEL-STRING'. */
8246 set_prop (TOOL_BAR_ITEM_LABEL
,
8247 STRINGP (value
) ? value
: build_string (bad_label
));
8250 else if (EQ (ikey
, QCfilter
))
8251 /* ':filter FORM'. */
8253 else if (EQ (ikey
, QCbutton
) && CONSP (value
))
8255 /* `:button (TYPE . SELECTED)'. */
8256 Lisp_Object type
, selected
;
8258 type
= XCAR (value
);
8259 selected
= XCDR (value
);
8260 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
8262 set_prop (TOOL_BAR_ITEM_SELECTED_P
, selected
);
8263 set_prop (TOOL_BAR_ITEM_TYPE
, type
);
8266 else if (EQ (ikey
, QCimage
)
8268 || (VECTORP (value
) && ASIZE (value
) == 4)))
8269 /* Value is either a single image specification or a vector
8270 of 4 such specifications for the different button states. */
8271 set_prop (TOOL_BAR_ITEM_IMAGES
, value
);
8272 else if (EQ (ikey
, QCrtl
))
8274 set_prop (TOOL_BAR_ITEM_RTL_IMAGE
, value
);
8280 /* Try to make one from caption and key. */
8281 Lisp_Object tkey
= PROP (TOOL_BAR_ITEM_KEY
);
8282 Lisp_Object tcapt
= PROP (TOOL_BAR_ITEM_CAPTION
);
8283 const char *label
= SYMBOLP (tkey
) ? SSDATA (SYMBOL_NAME (tkey
)) : "";
8284 const char *capt
= STRINGP (tcapt
) ? SSDATA (tcapt
) : "";
8286 2 * max (0, min (tool_bar_max_label_size
, STRING_BYTES_BOUND
/ 2));
8287 char *buf
= xmalloc (max_lbl
+ 1);
8288 Lisp_Object new_lbl
;
8289 ptrdiff_t caption_len
= strlen (capt
);
8291 if (caption_len
<= max_lbl
&& capt
[0] != '\0')
8294 while (caption_len
> 0 && buf
[caption_len
- 1] == '.')
8296 buf
[caption_len
] = '\0';
8300 if (strlen (label
) <= max_lbl
&& label
[0] != '\0')
8304 strcpy (buf
, label
);
8306 for (j
= 0; buf
[j
] != '\0'; ++j
)
8314 new_lbl
= Fupcase_initials (build_string (label
));
8315 if (SCHARS (new_lbl
) <= tool_bar_max_label_size
)
8316 set_prop (TOOL_BAR_ITEM_LABEL
, new_lbl
);
8318 set_prop (TOOL_BAR_ITEM_LABEL
, empty_unibyte_string
);
8322 /* If got a filter apply it on binding. */
8324 set_prop (TOOL_BAR_ITEM_BINDING
,
8325 (menu_item_eval_property
8328 PROP (TOOL_BAR_ITEM_BINDING
))))));
8330 /* See if the binding is a keymap. Give up if it is. */
8331 if (CONSP (get_keymap (PROP (TOOL_BAR_ITEM_BINDING
), 0, 1)))
8334 /* Enable or disable selection of item. */
8335 if (!EQ (PROP (TOOL_BAR_ITEM_ENABLED_P
), Qt
))
8336 set_prop (TOOL_BAR_ITEM_ENABLED_P
,
8337 menu_item_eval_property (PROP (TOOL_BAR_ITEM_ENABLED_P
)));
8339 /* Handle radio buttons or toggle boxes. */
8340 if (!NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
)))
8341 set_prop (TOOL_BAR_ITEM_SELECTED_P
,
8342 menu_item_eval_property (PROP (TOOL_BAR_ITEM_SELECTED_P
)));
8350 /* Initialize tool_bar_items_vector. REUSE, if non-nil, is a vector
8351 that can be reused. */
8354 init_tool_bar_items (Lisp_Object reuse
)
8356 if (VECTORP (reuse
))
8357 tool_bar_items_vector
= reuse
;
8359 tool_bar_items_vector
= Fmake_vector (make_number (64), Qnil
);
8360 ntool_bar_items
= 0;
8364 /* Append parsed tool bar item properties from
8365 tool_bar_item_properties */
8368 append_tool_bar_item (void)
8372 - (ASIZE (tool_bar_items_vector
) - TOOL_BAR_ITEM_NSLOTS
));
8374 /* Enlarge tool_bar_items_vector if necessary. */
8376 tool_bar_items_vector
= larger_vector (tool_bar_items_vector
, incr
, -1);
8378 /* Append entries from tool_bar_item_properties to the end of
8379 tool_bar_items_vector. */
8380 vcopy (tool_bar_items_vector
, ntool_bar_items
,
8381 XVECTOR (tool_bar_item_properties
)->contents
, TOOL_BAR_ITEM_NSLOTS
);
8382 ntool_bar_items
+= TOOL_BAR_ITEM_NSLOTS
;
8389 /* Read a character using menus based on the keymap MAP.
8390 Return nil if there are no menus in the maps.
8391 Return t if we displayed a menu but the user rejected it.
8393 PREV_EVENT is the previous input event, or nil if we are reading
8394 the first event of a key sequence.
8396 If USED_MOUSE_MENU is non-null, set *USED_MOUSE_MENU to true
8397 if we used a mouse menu to read the input, or false otherwise. If
8398 USED_MOUSE_MENU is null, don't dereference it.
8400 The prompting is done based on the prompt-string of the map
8401 and the strings associated with various map elements.
8403 This can be done with X menus or with menus put in the minibuf.
8404 These are done in different ways, depending on how the input will be read.
8405 Menus using X are done after auto-saving in read-char, getting the input
8406 event from Fx_popup_menu; menus using the minibuf use read_char recursively
8407 and do auto-saving in the inner call of read_char. */
8410 read_char_x_menu_prompt (Lisp_Object map
,
8411 Lisp_Object prev_event
, bool *used_mouse_menu
)
8413 if (used_mouse_menu
)
8414 *used_mouse_menu
= 0;
8416 /* Use local over global Menu maps. */
8418 if (! menu_prompting
)
8421 /* If we got to this point via a mouse click,
8422 use a real menu for mouse selection. */
8423 if (EVENT_HAS_PARAMETERS (prev_event
)
8424 && !EQ (XCAR (prev_event
), Qmenu_bar
)
8425 && !EQ (XCAR (prev_event
), Qtool_bar
))
8427 /* Display the menu and get the selection. */
8430 value
= Fx_popup_menu (prev_event
, get_keymap (map
, 0, 1));
8435 record_menu_key (XCAR (value
));
8437 /* If we got multiple events, unread all but
8439 There is no way to prevent those unread events
8440 from showing up later in last_nonmenu_event.
8441 So turn symbol and integer events into lists,
8442 to indicate that they came from a mouse menu,
8443 so that when present in last_nonmenu_event
8444 they won't confuse things. */
8445 for (tem
= XCDR (value
); CONSP (tem
); tem
= XCDR (tem
))
8447 record_menu_key (XCAR (tem
));
8448 if (SYMBOLP (XCAR (tem
))
8449 || INTEGERP (XCAR (tem
)))
8450 XSETCAR (tem
, Fcons (XCAR (tem
), Qdisabled
));
8453 /* If we got more than one event, put all but the first
8454 onto this list to be read later.
8455 Return just the first event now. */
8456 Vunread_command_events
8457 = nconc2 (XCDR (value
), Vunread_command_events
);
8458 value
= XCAR (value
);
8460 else if (NILP (value
))
8462 if (used_mouse_menu
)
8463 *used_mouse_menu
= 1;
8470 read_char_minibuf_menu_prompt (int commandflag
,
8473 register Lisp_Object name
;
8475 /* FIXME: Use the minibuffer's frame width. */
8476 ptrdiff_t width
= FRAME_COLS (SELECTED_FRAME ()) - 4;
8478 bool nobindings
= 1;
8479 Lisp_Object rest
, vector
;
8480 Lisp_Object prompt_strings
= Qnil
;
8484 if (! menu_prompting
)
8487 map
= get_keymap (map
, 0, 1);
8488 name
= Fkeymap_prompt (map
);
8490 /* If we don't have any menus, just read a character normally. */
8491 if (!STRINGP (name
))
8494 #define PUSH_C_STR(str, listvar) \
8495 listvar = Fcons (build_unibyte_string (str), listvar)
8497 /* Prompt string always starts with map's prompt, and a space. */
8498 prompt_strings
= Fcons (name
, prompt_strings
);
8499 PUSH_C_STR (": ", prompt_strings
);
8500 nlength
= SCHARS (name
) + 2;
8504 /* Present the documented bindings, a line at a time. */
8508 Lisp_Object menu_strings
= prompt_strings
;
8509 ptrdiff_t i
= nlength
;
8511 Lisp_Object orig_defn_macro
;
8513 /* Loop over elements of map. */
8518 /* FIXME: Use map_keymap to handle new keymap formats. */
8520 /* At end of map, wrap around if just starting,
8521 or end this line if already have something on it. */
8524 if (notfirst
|| nobindings
)
8530 /* Look at the next element of the map. */
8532 elt
= AREF (vector
, idx
);
8534 elt
= Fcar_safe (rest
);
8536 if (idx
< 0 && VECTORP (elt
))
8538 /* If we found a dense table in the keymap,
8539 advanced past it, but start scanning its contents. */
8540 rest
= Fcdr_safe (rest
);
8546 /* An ordinary element. */
8547 Lisp_Object event
, tem
;
8551 event
= Fcar_safe (elt
); /* alist */
8552 elt
= Fcdr_safe (elt
);
8556 XSETINT (event
, idx
); /* vector */
8559 /* Ignore the element if it has no prompt string. */
8560 if (INTEGERP (event
) && parse_menu_item (elt
, -1))
8562 /* True if the char to type matches the string. */
8564 Lisp_Object upcased_event
, downcased_event
;
8565 Lisp_Object desc
= Qnil
;
8567 = AREF (item_properties
, ITEM_PROPERTY_NAME
);
8569 upcased_event
= Fupcase (event
);
8570 downcased_event
= Fdowncase (event
);
8571 char_matches
= (XINT (upcased_event
) == SREF (s
, 0)
8572 || XINT (downcased_event
) == SREF (s
, 0));
8574 desc
= Fsingle_key_description (event
, Qnil
);
8576 #if 0 /* It is redundant to list the equivalent key bindings because
8577 the prefix is what the user has already typed. */
8579 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_KEYEQ
];
8581 /* Insert equivalent keybinding. */
8582 s
= concat2 (s
, tem
);
8585 = AREF (item_properties
, ITEM_PROPERTY_TYPE
);
8586 if (EQ (tem
, QCradio
) || EQ (tem
, QCtoggle
))
8588 /* Insert button prefix. */
8589 Lisp_Object selected
8590 = AREF (item_properties
, ITEM_PROPERTY_SELECTED
);
8591 if (EQ (tem
, QCradio
))
8592 tem
= build_string (NILP (selected
) ? "(*) " : "( ) ");
8594 tem
= build_string (NILP (selected
) ? "[X] " : "[ ] ");
8595 s
= concat2 (tem
, s
);
8599 /* If we have room for the prompt string, add it to this line.
8600 If this is the first on the line, always add it. */
8601 if ((SCHARS (s
) + i
+ 2
8602 + (char_matches
? 0 : SCHARS (desc
) + 3))
8606 ptrdiff_t thiswidth
;
8608 /* Punctuate between strings. */
8611 PUSH_C_STR (", ", menu_strings
);
8617 /* If the char to type doesn't match the string's
8618 first char, explicitly show what char to type. */
8621 /* Add as much of string as fits. */
8622 thiswidth
= min (SCHARS (desc
), width
- i
);
8624 = Fcons (Fsubstring (desc
, make_number (0),
8625 make_number (thiswidth
)),
8628 PUSH_C_STR (" = ", menu_strings
);
8632 /* Add as much of string as fits. */
8633 thiswidth
= min (SCHARS (s
), width
- i
);
8635 = Fcons (Fsubstring (s
, make_number (0),
8636 make_number (thiswidth
)),
8642 /* If this element does not fit, end the line now,
8643 and save the element for the next line. */
8644 PUSH_C_STR ("...", menu_strings
);
8649 /* Move past this element. */
8650 if (idx
>= 0 && idx
+ 1 >= ASIZE (vector
))
8651 /* Handle reaching end of dense table. */
8656 rest
= Fcdr_safe (rest
);
8660 /* Prompt with that and read response. */
8661 message3_nolog (apply1 (intern ("concat"), Fnreverse (menu_strings
)));
8663 /* Make believe it's not a keyboard macro in case the help char
8664 is pressed. Help characters are not recorded because menu prompting
8665 is not used on replay. */
8666 orig_defn_macro
= KVAR (current_kboard
, defining_kbd_macro
);
8667 kset_defining_kbd_macro (current_kboard
, Qnil
);
8669 obj
= read_char (commandflag
, Qnil
, Qt
, 0, NULL
);
8670 while (BUFFERP (obj
));
8671 kset_defining_kbd_macro (current_kboard
, orig_defn_macro
);
8673 if (!INTEGERP (obj
) || XINT (obj
) == -2)
8676 if (! EQ (obj
, menu_prompt_more_char
)
8677 && (!INTEGERP (menu_prompt_more_char
)
8678 || ! EQ (obj
, make_number (Ctl (XINT (menu_prompt_more_char
))))))
8680 if (!NILP (KVAR (current_kboard
, defining_kbd_macro
)))
8681 store_kbd_macro_char (obj
);
8684 /* Help char - go round again. */
8688 /* Reading key sequences. */
8691 follow_key (Lisp_Object keymap
, Lisp_Object key
)
8693 return access_keymap (get_keymap (keymap
, 0, 1),
8698 active_maps (Lisp_Object first_event
)
8700 Lisp_Object position
8701 = CONSP (first_event
) ? CAR_SAFE (XCDR (first_event
)) : Qnil
;
8702 return Fcons (Qkeymap
, Fcurrent_active_maps (Qt
, position
));
8705 /* Structure used to keep track of partial application of key remapping
8706 such as Vfunction_key_map and Vkey_translation_map. */
8707 typedef struct keyremap
8709 /* This is the map originally specified for this use. */
8711 /* This is a submap reached by looking up, in PARENT,
8712 the events from START to END. */
8714 /* Positions [START, END) in the key sequence buffer
8715 are the key that we have scanned so far.
8716 Those events are the ones that we will replace
8717 if PARENT maps them into a key sequence. */
8721 /* Lookup KEY in MAP.
8722 MAP is a keymap mapping keys to key vectors or functions.
8723 If the mapping is a function and DO_FUNCALL is true,
8724 the function is called with PROMPT as parameter and its return
8725 value is used as the return value of this function (after checking
8726 that it is indeed a vector). */
8729 access_keymap_keyremap (Lisp_Object map
, Lisp_Object key
, Lisp_Object prompt
,
8734 next
= access_keymap (map
, key
, 1, 0, 1);
8736 /* Handle a symbol whose function definition is a keymap
8738 if (SYMBOLP (next
) && !NILP (Ffboundp (next
))
8739 && (ARRAYP (XSYMBOL (next
)->function
)
8740 || KEYMAPP (XSYMBOL (next
)->function
)))
8741 next
= Fautoload_do_load (XSYMBOL (next
)->function
, next
, Qnil
);
8743 /* If the keymap gives a function, not an
8744 array, then call the function with one arg and use
8745 its value instead. */
8746 if (do_funcall
&& FUNCTIONP (next
))
8751 next
= call1 (next
, prompt
);
8752 /* If the function returned something invalid,
8753 barf--don't ignore it.
8754 (To ignore it safely, we would need to gcpro a bunch of
8755 other variables.) */
8756 if (! (NILP (next
) || VECTORP (next
) || STRINGP (next
)))
8757 error ("Function %s returns invalid key sequence",
8758 SSDATA (SYMBOL_NAME (tem
)));
8763 /* Do one step of the key remapping used for function-key-map and
8764 key-translation-map:
8765 KEYBUF is the buffer holding the input events.
8766 BUFSIZE is its maximum size.
8767 FKEY is a pointer to the keyremap structure to use.
8768 INPUT is the index of the last element in KEYBUF.
8769 DOIT if true says that the remapping can actually take place.
8770 DIFF is used to return the number of keys added/removed by the remapping.
8771 PARENT is the root of the keymap.
8772 PROMPT is the prompt to use if the remapping happens through a function.
8773 Return true if the remapping actually took place. */
8776 keyremap_step (Lisp_Object
*keybuf
, int bufsize
, volatile keyremap
*fkey
,
8777 int input
, bool doit
, int *diff
, Lisp_Object prompt
)
8779 Lisp_Object next
, key
;
8781 key
= keybuf
[fkey
->end
++];
8783 if (KEYMAPP (fkey
->parent
))
8784 next
= access_keymap_keyremap (fkey
->map
, key
, prompt
, doit
);
8788 /* If keybuf[fkey->start..fkey->end] is bound in the
8789 map and we're in a position to do the key remapping, replace it with
8790 the binding and restart with fkey->start at the end. */
8791 if ((VECTORP (next
) || STRINGP (next
)) && doit
)
8793 int len
= XFASTINT (Flength (next
));
8796 *diff
= len
- (fkey
->end
- fkey
->start
);
8798 if (bufsize
- input
<= *diff
)
8799 error ("Key sequence too long");
8801 /* Shift the keys that follow fkey->end. */
8803 for (i
= fkey
->end
; i
< input
; i
++)
8804 keybuf
[i
+ *diff
] = keybuf
[i
];
8806 for (i
= input
- 1; i
>= fkey
->end
; i
--)
8807 keybuf
[i
+ *diff
] = keybuf
[i
];
8808 /* Overwrite the old keys with the new ones. */
8809 for (i
= 0; i
< len
; i
++)
8810 keybuf
[fkey
->start
+ i
]
8811 = Faref (next
, make_number (i
));
8813 fkey
->start
= fkey
->end
+= *diff
;
8814 fkey
->map
= fkey
->parent
;
8819 fkey
->map
= get_keymap (next
, 0, 1);
8821 /* If we no longer have a bound suffix, try a new position for
8823 if (!CONSP (fkey
->map
))
8825 fkey
->end
= ++fkey
->start
;
8826 fkey
->map
= fkey
->parent
;
8832 test_undefined (Lisp_Object binding
)
8834 return (NILP (binding
)
8835 || EQ (binding
, Qundefined
)
8836 || (SYMBOLP (binding
)
8837 && EQ (Fcommand_remapping (binding
, Qnil
, Qnil
), Qundefined
)));
8840 /* Read a sequence of keys that ends with a non prefix character,
8841 storing it in KEYBUF, a buffer of size BUFSIZE.
8843 Return the length of the key sequence stored.
8844 Return -1 if the user rejected a command menu.
8846 Echo starting immediately unless `prompt' is 0.
8848 If PREVENT_REDISPLAY is non-zero, avoid redisplay by calling
8849 read_char with a suitable COMMANDFLAG argument.
8851 Where a key sequence ends depends on the currently active keymaps.
8852 These include any minor mode keymaps active in the current buffer,
8853 the current buffer's local map, and the global map.
8855 If a key sequence has no other bindings, we check Vfunction_key_map
8856 to see if some trailing subsequence might be the beginning of a
8857 function key's sequence. If so, we try to read the whole function
8858 key, and substitute its symbolic name into the key sequence.
8860 We ignore unbound `down-' mouse clicks. We turn unbound `drag-' and
8861 `double-' events into similar click events, if that would make them
8862 bound. We try to turn `triple-' events first into `double-' events,
8865 If we get a mouse click in a mode line, vertical divider, or other
8866 non-text area, we treat the click as if it were prefixed by the
8867 symbol denoting that area - `mode-line', `vertical-line', or
8870 If the sequence starts with a mouse click, we read the key sequence
8871 with respect to the buffer clicked on, not the current buffer.
8873 If the user switches frames in the midst of a key sequence, we put
8874 off the switch-frame event until later; the next call to
8875 read_char will return it.
8877 If FIX_CURRENT_BUFFER, we restore current_buffer
8878 from the selected window's buffer. */
8881 read_key_sequence (Lisp_Object
*keybuf
, int bufsize
, Lisp_Object prompt
,
8882 bool dont_downcase_last
, bool can_return_switch_frame
,
8883 bool fix_current_buffer
, bool prevent_redisplay
)
8885 ptrdiff_t count
= SPECPDL_INDEX ();
8887 /* How many keys there are in the current key sequence. */
8890 /* The length of the echo buffer when we started reading, and
8891 the length of this_command_keys when we started reading. */
8892 ptrdiff_t echo_start
IF_LINT (= 0);
8893 ptrdiff_t keys_start
;
8895 Lisp_Object current_binding
= Qnil
;
8896 Lisp_Object first_event
= Qnil
;
8898 /* Index of the first key that has no binding.
8899 It is useless to try fkey.start larger than that. */
8902 /* If t < mock_input, then KEYBUF[t] should be read as the next
8905 We use this to recover after recognizing a function key. Once we
8906 realize that a suffix of the current key sequence is actually a
8907 function key's escape sequence, we replace the suffix with the
8908 function key's binding from Vfunction_key_map. Now keybuf
8909 contains a new and different key sequence, so the echo area,
8910 this_command_keys, and the submaps and defs arrays are wrong. In
8911 this situation, we set mock_input to t, set t to 0, and jump to
8912 restart_sequence; the loop will read keys from keybuf up until
8913 mock_input, thus rebuilding the state; and then it will resume
8914 reading characters from the keyboard. */
8917 /* If the sequence is unbound in submaps[], then
8918 keybuf[fkey.start..fkey.end-1] is a prefix in Vfunction_key_map,
8919 and fkey.map is its binding.
8921 These might be > t, indicating that all function key scanning
8922 should hold off until t reaches them. We do this when we've just
8923 recognized a function key, to avoid searching for the function
8924 key's again in Vfunction_key_map. */
8927 /* Likewise, for key_translation_map and input-decode-map. */
8928 keyremap keytran
, indec
;
8930 /* True if we are trying to map a key by changing an upper-case
8931 letter to lower case, or a shifted function key to an unshifted
8933 bool shift_translated
= 0;
8935 /* If we receive a `switch-frame' or `select-window' event in the middle of
8936 a key sequence, we put it off for later.
8937 While we're reading, we keep the event here. */
8938 Lisp_Object delayed_switch_frame
;
8940 Lisp_Object original_uppercase
IF_LINT (= Qnil
);
8941 int original_uppercase_position
= -1;
8943 /* Gets around Microsoft compiler limitations. */
8946 struct buffer
*starting_buffer
;
8948 /* List of events for which a fake prefix key has been generated. */
8949 Lisp_Object fake_prefixed_keys
= Qnil
;
8951 struct gcpro gcpro1
;
8953 GCPRO1 (fake_prefixed_keys
);
8954 raw_keybuf_count
= 0;
8956 last_nonmenu_event
= Qnil
;
8958 delayed_switch_frame
= Qnil
;
8964 /* Install the string PROMPT as the beginning of the string
8965 of echoing, so that it serves as a prompt for the next
8967 kset_echo_string (current_kboard
, prompt
);
8968 current_kboard
->echo_after_prompt
= SCHARS (prompt
);
8971 else if (cursor_in_echo_area
8972 && echo_keystrokes_p ())
8973 /* This doesn't put in a dash if the echo buffer is empty, so
8974 you don't always see a dash hanging out in the minibuffer. */
8978 /* Record the initial state of the echo area and this_command_keys;
8979 we will need to restore them if we replay a key sequence. */
8981 echo_start
= echo_length ();
8982 keys_start
= this_command_key_count
;
8983 this_single_command_key_start
= keys_start
;
8985 /* We jump here when we need to reinitialize fkey and keytran; this
8986 happens if we switch keyboards between rescans. */
8987 replay_entire_sequence
:
8989 indec
.map
= indec
.parent
= KVAR (current_kboard
, Vinput_decode_map
);
8990 fkey
.map
= fkey
.parent
= KVAR (current_kboard
, Vlocal_function_key_map
);
8991 keytran
.map
= keytran
.parent
= Vkey_translation_map
;
8992 indec
.start
= indec
.end
= 0;
8993 fkey
.start
= fkey
.end
= 0;
8994 keytran
.start
= keytran
.end
= 0;
8996 /* We jump here when the key sequence has been thoroughly changed, and
8997 we need to rescan it starting from the beginning. When we jump here,
8998 keybuf[0..mock_input] holds the sequence we should reread. */
9001 starting_buffer
= current_buffer
;
9002 first_unbound
= bufsize
+ 1;
9004 /* Build our list of keymaps.
9005 If we recognize a function key and replace its escape sequence in
9006 keybuf with its symbol, or if the sequence starts with a mouse
9007 click and we need to switch buffers, we jump back here to rebuild
9008 the initial keymaps from the current buffer. */
9009 current_binding
= active_maps (first_event
);
9011 /* Start from the beginning in keybuf. */
9014 /* These are no-ops the first time through, but if we restart, they
9015 revert the echo area and this_command_keys to their original state. */
9016 this_command_key_count
= keys_start
;
9017 if (INTERACTIVE
&& t
< mock_input
)
9018 echo_truncate (echo_start
);
9020 /* If the best binding for the current key sequence is a keymap, or
9021 we may be looking at a function key's escape sequence, keep on
9023 while (!NILP (current_binding
)
9024 /* Keep reading as long as there's a prefix binding. */
9025 ? KEYMAPP (current_binding
)
9026 /* Don't return in the middle of a possible function key sequence,
9027 if the only bindings we found were via case conversion.
9028 Thus, if ESC O a has a function-key-map translation
9029 and ESC o has a binding, don't return after ESC O,
9030 so that we can translate ESC O plus the next character. */
9031 : (/* indec.start < t || fkey.start < t || */ keytran
.start
< t
))
9034 bool used_mouse_menu
= 0;
9036 /* Where the last real key started. If we need to throw away a
9037 key that has expanded into more than one element of keybuf
9038 (say, a mouse click on the mode line which is being treated
9039 as [mode-line (mouse-...)], then we backtrack to this point
9041 int last_real_key_start
;
9043 /* These variables are analogous to echo_start and keys_start;
9044 while those allow us to restart the entire key sequence,
9045 echo_local_start and keys_local_start allow us to throw away
9047 ptrdiff_t echo_local_start
IF_LINT (= 0);
9048 int keys_local_start
;
9049 Lisp_Object new_binding
;
9051 eassert (indec
.end
== t
|| (indec
.end
> t
&& indec
.end
<= mock_input
));
9052 eassert (indec
.start
<= indec
.end
);
9053 eassert (fkey
.start
<= fkey
.end
);
9054 eassert (keytran
.start
<= keytran
.end
);
9055 /* key-translation-map is applied *after* function-key-map
9056 which is itself applied *after* input-decode-map. */
9057 eassert (fkey
.end
<= indec
.start
);
9058 eassert (keytran
.end
<= fkey
.start
);
9060 if (/* first_unbound < indec.start && first_unbound < fkey.start && */
9061 first_unbound
< keytran
.start
)
9062 { /* The prefix upto first_unbound has no binding and has
9063 no translation left to do either, so we know it's unbound.
9064 If we don't stop now, we risk staying here indefinitely
9065 (if the user keeps entering fkey or keytran prefixes
9066 like C-c ESC ESC ESC ESC ...) */
9068 for (i
= first_unbound
+ 1; i
< t
; i
++)
9069 keybuf
[i
- first_unbound
- 1] = keybuf
[i
];
9070 mock_input
= t
- first_unbound
- 1;
9071 indec
.end
= indec
.start
-= first_unbound
+ 1;
9072 indec
.map
= indec
.parent
;
9073 fkey
.end
= fkey
.start
-= first_unbound
+ 1;
9074 fkey
.map
= fkey
.parent
;
9075 keytran
.end
= keytran
.start
-= first_unbound
+ 1;
9076 keytran
.map
= keytran
.parent
;
9077 goto replay_sequence
;
9081 error ("Key sequence too long");
9084 echo_local_start
= echo_length ();
9085 keys_local_start
= this_command_key_count
;
9088 /* These are no-ops, unless we throw away a keystroke below and
9089 jumped back up to replay_key; in that case, these restore the
9090 variables to their original state, allowing us to replay the
9092 if (INTERACTIVE
&& t
< mock_input
)
9093 echo_truncate (echo_local_start
);
9094 this_command_key_count
= keys_local_start
;
9096 /* By default, assume each event is "real". */
9097 last_real_key_start
= t
;
9099 /* Does mock_input indicate that we are re-reading a key sequence? */
9103 add_command_key (key
);
9104 if (echo_keystrokes_p ()
9105 && current_kboard
->immediate_echo
)
9112 /* If not, we should actually read a character. */
9116 KBOARD
*interrupted_kboard
= current_kboard
;
9117 struct frame
*interrupted_frame
= SELECTED_FRAME ();
9118 /* Calling read_char with COMMANDFLAG = -2 avoids
9119 redisplay in read_char and its subroutines. */
9120 key
= read_char (prevent_redisplay
? -2 : NILP (prompt
),
9121 current_binding
, last_nonmenu_event
,
9122 &used_mouse_menu
, NULL
);
9123 if ((INTEGERP (key
) && XINT (key
) == -2) /* wrong_kboard_jmpbuf */
9124 /* When switching to a new tty (with a new keyboard),
9125 read_char returns the new buffer, rather than -2
9126 (Bug#5095). This is because `terminal-init-xterm'
9127 calls read-char, which eats the wrong_kboard_jmpbuf
9128 return. Any better way to fix this? -- cyd */
9129 || (interrupted_kboard
!= current_kboard
))
9134 for (k
= all_kboards
; k
; k
= k
->next_kboard
)
9135 if (k
== interrupted_kboard
)
9140 /* Don't touch interrupted_kboard when it's been
9142 delayed_switch_frame
= Qnil
;
9143 goto replay_entire_sequence
;
9146 if (!NILP (delayed_switch_frame
))
9149 (interrupted_kboard
,
9150 Fcons (delayed_switch_frame
,
9151 KVAR (interrupted_kboard
, kbd_queue
)));
9152 delayed_switch_frame
= Qnil
;
9157 (interrupted_kboard
,
9158 Fcons (keybuf
[--t
], KVAR (interrupted_kboard
, kbd_queue
)));
9160 /* If the side queue is non-empty, ensure it begins with a
9161 switch-frame, so we'll replay it in the right context. */
9162 if (CONSP (KVAR (interrupted_kboard
, kbd_queue
))
9163 && (key
= XCAR (KVAR (interrupted_kboard
, kbd_queue
)),
9164 !(EVENT_HAS_PARAMETERS (key
)
9165 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)),
9169 XSETFRAME (frame
, interrupted_frame
);
9171 (interrupted_kboard
,
9172 Fcons (make_lispy_switch_frame (frame
),
9173 KVAR (interrupted_kboard
, kbd_queue
)));
9176 goto replay_entire_sequence
;
9180 /* read_char returns t when it shows a menu and the user rejects it.
9184 unbind_to (count
, Qnil
);
9189 /* read_char returns -1 at the end of a macro.
9190 Emacs 18 handles this by returning immediately with a
9191 zero, so that's what we'll do. */
9192 if (INTEGERP (key
) && XINT (key
) == -1)
9195 /* The Microsoft C compiler can't handle the goto that
9201 /* If the current buffer has been changed from under us, the
9202 keymap may have changed, so replay the sequence. */
9205 timer_resume_idle ();
9208 /* Reset the current buffer from the selected window
9209 in case something changed the former and not the latter.
9210 This is to be more consistent with the behavior
9211 of the command_loop_1. */
9212 if (fix_current_buffer
)
9214 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
9216 if (XBUFFER (XWINDOW (selected_window
)->contents
)
9218 Fset_buffer (XWINDOW (selected_window
)->contents
);
9221 goto replay_sequence
;
9224 /* If we have a quit that was typed in another frame, and
9225 quit_throw_to_read_char switched buffers,
9226 replay to get the right keymap. */
9228 && XINT (key
) == quit_char
9229 && current_buffer
!= starting_buffer
)
9232 ASET (raw_keybuf
, raw_keybuf_count
, key
);
9237 goto replay_sequence
;
9242 if (EVENT_HAS_PARAMETERS (key
)
9243 /* Either a `switch-frame' or a `select-window' event. */
9244 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)), Qswitch_frame
))
9246 /* If we're at the beginning of a key sequence, and the caller
9247 says it's okay, go ahead and return this event. If we're
9248 in the midst of a key sequence, delay it until the end. */
9249 if (t
> 0 || !can_return_switch_frame
)
9251 delayed_switch_frame
= key
;
9256 if (NILP (first_event
))
9259 /* Even if first_event does not specify a particular
9260 window/position, it's important to recompute the maps here
9261 since a long time might have passed since we entered
9262 read_key_sequence, and a timer (or process-filter or
9263 special-event-map, ...) might have switched the current buffer
9264 or the selected window from under us in the mean time. */
9265 if (fix_current_buffer
9266 && (XBUFFER (XWINDOW (selected_window
)->contents
)
9268 Fset_buffer (XWINDOW (selected_window
)->contents
);
9269 current_binding
= active_maps (first_event
);
9273 ASET (raw_keybuf
, raw_keybuf_count
, key
);
9277 /* Clicks in non-text areas get prefixed by the symbol
9278 in their CHAR-ADDRESS field. For example, a click on
9279 the mode line is prefixed by the symbol `mode-line'.
9281 Furthermore, key sequences beginning with mouse clicks
9282 are read using the keymaps of the buffer clicked on, not
9283 the current buffer. So we may have to switch the buffer
9286 When we turn one event into two events, we must make sure
9287 that neither of the two looks like the original--so that,
9288 if we replay the events, they won't be expanded again.
9289 If not for this, such reexpansion could happen either here
9290 or when user programs play with this-command-keys. */
9291 if (EVENT_HAS_PARAMETERS (key
))
9293 Lisp_Object kind
= EVENT_HEAD_KIND (EVENT_HEAD (key
));
9294 if (EQ (kind
, Qmouse_click
))
9296 Lisp_Object window
= POSN_WINDOW (EVENT_START (key
));
9297 Lisp_Object posn
= POSN_POSN (EVENT_START (key
));
9300 || (!NILP (fake_prefixed_keys
)
9301 && !NILP (Fmemq (key
, fake_prefixed_keys
))))
9303 /* We're looking a second time at an event for which
9304 we generated a fake prefix key. Set
9305 last_real_key_start appropriately. */
9307 last_real_key_start
= t
- 1;
9310 if (last_real_key_start
== 0)
9312 /* Key sequences beginning with mouse clicks are
9313 read using the keymaps in the buffer clicked on,
9314 not the current buffer. If we're at the
9315 beginning of a key sequence, switch buffers. */
9316 if (WINDOWP (window
)
9317 && BUFFERP (XWINDOW (window
)->contents
)
9318 && XBUFFER (XWINDOW (window
)->contents
) != current_buffer
)
9320 ASET (raw_keybuf
, raw_keybuf_count
, key
);
9325 /* Arrange to go back to the original buffer once we're
9326 done reading the key sequence. Note that we can't
9327 use save_excursion_{save,restore} here, because they
9328 save point as well as the current buffer; we don't
9329 want to save point, because redisplay may change it,
9330 to accommodate a Fset_window_start or something. We
9331 don't want to do this at the top of the function,
9332 because we may get input from a subprocess which
9333 wants to change the selected window and stuff (say,
9335 record_unwind_current_buffer ();
9337 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
9339 set_buffer_internal (XBUFFER (XWINDOW (window
)->contents
));
9340 goto replay_sequence
;
9344 /* Expand mode-line and scroll-bar events into two events:
9345 use posn as a fake prefix key. */
9347 && (NILP (fake_prefixed_keys
)
9348 || NILP (Fmemq (key
, fake_prefixed_keys
))))
9350 if (bufsize
- t
<= 1)
9351 error ("Key sequence too long");
9354 keybuf
[t
+ 1] = key
;
9357 /* Record that a fake prefix key has been generated
9358 for KEY. Don't modify the event; this would
9359 prevent proper action when the event is pushed
9360 back into unread-command-events. */
9361 fake_prefixed_keys
= Fcons (key
, fake_prefixed_keys
);
9365 else if (CONSP (XCDR (key
))
9366 && CONSP (EVENT_START (key
))
9367 && CONSP (XCDR (EVENT_START (key
))))
9371 posn
= POSN_POSN (EVENT_START (key
));
9372 /* Handle menu-bar events:
9373 insert the dummy prefix event `menu-bar'. */
9374 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
9376 if (bufsize
- t
<= 1)
9377 error ("Key sequence too long");
9379 keybuf
[t
+ 1] = key
;
9381 /* Zap the position in key, so we know that we've
9382 expanded it, and don't try to do so again. */
9383 POSN_SET_POSN (EVENT_START (key
), list1 (posn
));
9386 goto replay_sequence
;
9388 else if (CONSP (posn
))
9390 /* We're looking at the second event of a
9391 sequence which we expanded before. Set
9392 last_real_key_start appropriately. */
9393 if (last_real_key_start
== t
&& t
> 0)
9394 last_real_key_start
= t
- 1;
9399 /* We have finally decided that KEY is something we might want
9401 new_binding
= follow_key (current_binding
, key
);
9403 /* If KEY wasn't bound, we'll try some fallbacks. */
9404 if (!NILP (new_binding
))
9405 /* This is needed for the following scenario:
9406 event 0: a down-event that gets dropped by calling replay_key.
9407 event 1: some normal prefix like C-h.
9408 After event 0, first_unbound is 0, after event 1 indec.start,
9409 fkey.start, and keytran.start are all 1, so when we see that
9410 C-h is bound, we need to update first_unbound. */
9411 first_unbound
= max (t
+ 1, first_unbound
);
9416 /* Remember the position to put an upper bound on indec.start. */
9417 first_unbound
= min (t
, first_unbound
);
9419 head
= EVENT_HEAD (key
);
9423 Lisp_Object breakdown
;
9426 breakdown
= parse_modifiers (head
);
9427 modifiers
= XINT (XCAR (XCDR (breakdown
)));
9428 /* Attempt to reduce an unbound mouse event to a simpler
9429 event that is bound:
9430 Drags reduce to clicks.
9431 Double-clicks reduce to clicks.
9432 Triple-clicks reduce to double-clicks, then to clicks.
9433 Down-clicks are eliminated.
9434 Double-downs reduce to downs, then are eliminated.
9435 Triple-downs reduce to double-downs, then to downs,
9436 then are eliminated. */
9437 if (modifiers
& (down_modifier
| drag_modifier
9438 | double_modifier
| triple_modifier
))
9440 while (modifiers
& (down_modifier
| drag_modifier
9441 | double_modifier
| triple_modifier
))
9443 Lisp_Object new_head
, new_click
;
9444 if (modifiers
& triple_modifier
)
9445 modifiers
^= (double_modifier
| triple_modifier
);
9446 else if (modifiers
& double_modifier
)
9447 modifiers
&= ~double_modifier
;
9448 else if (modifiers
& drag_modifier
)
9449 modifiers
&= ~drag_modifier
;
9452 /* Dispose of this `down' event by simply jumping
9453 back to replay_key, to get another event.
9455 Note that if this event came from mock input,
9456 then just jumping back to replay_key will just
9457 hand it to us again. So we have to wipe out any
9460 We could delete keybuf[t] and shift everything
9461 after that to the left by one spot, but we'd also
9462 have to fix up any variable that points into
9463 keybuf, and shifting isn't really necessary
9466 Adding prefixes for non-textual mouse clicks
9467 creates two characters of mock input, and both
9468 must be thrown away. If we're only looking at
9469 the prefix now, we can just jump back to
9470 replay_key. On the other hand, if we've already
9471 processed the prefix, and now the actual click
9472 itself is giving us trouble, then we've lost the
9473 state of the keymaps we want to backtrack to, and
9474 we need to replay the whole sequence to rebuild
9477 Beyond that, only function key expansion could
9478 create more than two keys, but that should never
9479 generate mouse events, so it's okay to zero
9480 mock_input in that case too.
9482 FIXME: The above paragraph seems just plain
9483 wrong, if you consider things like
9484 xterm-mouse-mode. -stef
9486 Isn't this just the most wonderful code ever? */
9488 /* If mock_input > t + 1, the above simplification
9489 will actually end up dropping keys on the floor.
9490 This is probably OK for now, but even
9491 if mock_input <= t + 1, we need to adjust indec,
9493 Typical case [header-line down-mouse-N]:
9494 mock_input = 2, t = 1, fkey.end = 1,
9495 last_real_key_start = 0. */
9496 if (indec
.end
> last_real_key_start
)
9498 indec
.end
= indec
.start
9499 = min (last_real_key_start
, indec
.start
);
9500 indec
.map
= indec
.parent
;
9501 if (fkey
.end
> last_real_key_start
)
9503 fkey
.end
= fkey
.start
9504 = min (last_real_key_start
, fkey
.start
);
9505 fkey
.map
= fkey
.parent
;
9506 if (keytran
.end
> last_real_key_start
)
9508 keytran
.end
= keytran
.start
9509 = min (last_real_key_start
, keytran
.start
);
9510 keytran
.map
= keytran
.parent
;
9514 if (t
== last_real_key_start
)
9521 mock_input
= last_real_key_start
;
9522 goto replay_sequence
;
9527 = apply_modifiers (modifiers
, XCAR (breakdown
));
9528 new_click
= list2 (new_head
, EVENT_START (key
));
9530 /* Look for a binding for this new key. */
9531 new_binding
= follow_key (current_binding
, new_click
);
9533 /* If that click is bound, go for it. */
9534 if (!NILP (new_binding
))
9536 current_binding
= new_binding
;
9540 /* Otherwise, we'll leave key set to the drag event. */
9545 current_binding
= new_binding
;
9548 /* Normally, last_nonmenu_event gets the previous key we read.
9549 But when a mouse popup menu is being used,
9550 we don't update last_nonmenu_event; it continues to hold the mouse
9551 event that preceded the first level of menu. */
9552 if (!used_mouse_menu
)
9553 last_nonmenu_event
= key
;
9555 /* Record what part of this_command_keys is the current key sequence. */
9556 this_single_command_key_start
= this_command_key_count
- t
;
9558 /* Look for this sequence in input-decode-map.
9559 Scan from indec.end until we find a bound suffix. */
9560 while (indec
.end
< t
)
9562 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9566 GCPRO4 (indec
.map
, fkey
.map
, keytran
.map
, delayed_switch_frame
);
9567 done
= keyremap_step (keybuf
, bufsize
, &indec
, max (t
, mock_input
),
9572 mock_input
= diff
+ max (t
, mock_input
);
9573 goto replay_sequence
;
9577 if (!KEYMAPP (current_binding
)
9578 && !test_undefined (current_binding
)
9579 && indec
.start
>= t
)
9580 /* There is a binding and it's not a prefix.
9581 (and it doesn't have any input-decode-map translation pending).
9582 There is thus no function-key in this sequence.
9583 Moving fkey.start is important in this case to allow keytran.start
9584 to go over the sequence before we return (since we keep the
9585 invariant that keytran.end <= fkey.start). */
9588 (fkey
.start
= fkey
.end
= t
, fkey
.map
= fkey
.parent
);
9591 /* If the sequence is unbound, see if we can hang a function key
9592 off the end of it. */
9593 /* Continue scan from fkey.end until we find a bound suffix. */
9594 while (fkey
.end
< indec
.start
)
9596 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9600 GCPRO4 (indec
.map
, fkey
.map
, keytran
.map
, delayed_switch_frame
);
9601 done
= keyremap_step (keybuf
, bufsize
, &fkey
,
9602 max (t
, mock_input
),
9603 /* If there's a binding (i.e.
9604 first_binding >= nmaps) we don't want
9605 to apply this function-key-mapping. */
9607 && (test_undefined (current_binding
)),
9612 mock_input
= diff
+ max (t
, mock_input
);
9613 /* Adjust the input-decode-map counters. */
9615 indec
.start
+= diff
;
9617 goto replay_sequence
;
9621 /* Look for this sequence in key-translation-map.
9622 Scan from keytran.end until we find a bound suffix. */
9623 while (keytran
.end
< fkey
.start
)
9625 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9629 GCPRO4 (indec
.map
, fkey
.map
, keytran
.map
, delayed_switch_frame
);
9630 done
= keyremap_step (keybuf
, bufsize
, &keytran
, max (t
, mock_input
),
9635 mock_input
= diff
+ max (t
, mock_input
);
9636 /* Adjust the function-key-map and input-decode-map counters. */
9638 indec
.start
+= diff
;
9642 goto replay_sequence
;
9646 /* If KEY is not defined in any of the keymaps,
9647 and cannot be part of a function key or translation,
9648 and is an upper case letter
9649 use the corresponding lower-case letter instead. */
9650 if (NILP (current_binding
)
9651 && /* indec.start >= t && fkey.start >= t && */ keytran
.start
>= t
9653 && ((CHARACTERP (make_number (XINT (key
) & ~CHAR_MODIFIER_MASK
))
9654 && uppercasep (XINT (key
) & ~CHAR_MODIFIER_MASK
))
9655 || (XINT (key
) & shift_modifier
)))
9657 Lisp_Object new_key
;
9659 original_uppercase
= key
;
9660 original_uppercase_position
= t
- 1;
9662 if (XINT (key
) & shift_modifier
)
9663 XSETINT (new_key
, XINT (key
) & ~shift_modifier
);
9665 XSETINT (new_key
, (downcase (XINT (key
) & ~CHAR_MODIFIER_MASK
)
9666 | (XINT (key
) & CHAR_MODIFIER_MASK
)));
9668 /* We have to do this unconditionally, regardless of whether
9669 the lower-case char is defined in the keymaps, because they
9670 might get translated through function-key-map. */
9671 keybuf
[t
- 1] = new_key
;
9672 mock_input
= max (t
, mock_input
);
9673 shift_translated
= 1;
9675 goto replay_sequence
;
9678 if (NILP (current_binding
)
9679 && help_char_p (EVENT_HEAD (key
)) && t
> 1)
9681 read_key_sequence_cmd
= Vprefix_help_command
;
9682 /* The Microsoft C compiler can't handle the goto that
9688 /* If KEY is not defined in any of the keymaps,
9689 and cannot be part of a function key or translation,
9690 and is a shifted function key,
9691 use the corresponding unshifted function key instead. */
9692 if (NILP (current_binding
)
9693 && /* indec.start >= t && fkey.start >= t && */ keytran
.start
>= t
)
9695 Lisp_Object breakdown
= parse_modifiers (key
);
9697 = CONSP (breakdown
) ? (XINT (XCAR (XCDR (breakdown
)))) : 0;
9699 if (modifiers
& shift_modifier
9700 /* Treat uppercase keys as shifted. */
9702 && (KEY_TO_CHAR (key
)
9703 < XCHAR_TABLE (BVAR (current_buffer
, downcase_table
))->header
.size
)
9704 && uppercasep (KEY_TO_CHAR (key
))))
9707 = (modifiers
& shift_modifier
9708 ? apply_modifiers (modifiers
& ~shift_modifier
,
9710 : make_number (downcase (KEY_TO_CHAR (key
)) | modifiers
));
9712 original_uppercase
= key
;
9713 original_uppercase_position
= t
- 1;
9715 /* We have to do this unconditionally, regardless of whether
9716 the lower-case char is defined in the keymaps, because they
9717 might get translated through function-key-map. */
9718 keybuf
[t
- 1] = new_key
;
9719 mock_input
= max (t
, mock_input
);
9720 /* Reset fkey (and consequently keytran) to apply
9721 function-key-map on the result, so that S-backspace is
9722 correctly mapped to DEL (via backspace). OTOH,
9723 input-decode-map doesn't need to go through it again. */
9724 fkey
.start
= fkey
.end
= 0;
9725 keytran
.start
= keytran
.end
= 0;
9726 shift_translated
= 1;
9728 goto replay_sequence
;
9733 read_key_sequence_cmd
= current_binding
;
9734 read_key_sequence_remapped
9735 /* Remap command through active keymaps.
9736 Do the remapping here, before the unbind_to so it uses the keymaps
9737 of the appropriate buffer. */
9738 = SYMBOLP (read_key_sequence_cmd
)
9739 ? Fcommand_remapping (read_key_sequence_cmd
, Qnil
, Qnil
)
9742 unread_switch_frame
= delayed_switch_frame
;
9743 unbind_to (count
, Qnil
);
9745 /* Don't downcase the last character if the caller says don't.
9746 Don't downcase it if the result is undefined, either. */
9747 if ((dont_downcase_last
|| NILP (current_binding
))
9749 && t
- 1 == original_uppercase_position
)
9751 keybuf
[t
- 1] = original_uppercase
;
9752 shift_translated
= 0;
9755 if (shift_translated
)
9756 Vthis_command_keys_shift_translated
= Qt
;
9758 /* Occasionally we fabricate events, perhaps by expanding something
9759 according to function-key-map, or by adding a prefix symbol to a
9760 mouse click in the scroll bar or modeline. In this cases, return
9761 the entire generated key sequence, even if we hit an unbound
9762 prefix or a definition before the end. This means that you will
9763 be able to push back the event properly, and also means that
9764 read-key-sequence will always return a logical unit.
9767 for (; t
< mock_input
; t
++)
9769 if (echo_keystrokes_p ())
9770 echo_char (keybuf
[t
]);
9771 add_command_key (keybuf
[t
]);
9779 read_key_sequence_vs (Lisp_Object prompt
, Lisp_Object continue_echo
,
9780 Lisp_Object dont_downcase_last
,
9781 Lisp_Object can_return_switch_frame
,
9782 Lisp_Object cmd_loop
, bool allow_string
)
9784 Lisp_Object keybuf
[30];
9786 struct gcpro gcpro1
;
9787 ptrdiff_t count
= SPECPDL_INDEX ();
9790 CHECK_STRING (prompt
);
9793 specbind (Qinput_method_exit_on_first_char
,
9794 (NILP (cmd_loop
) ? Qt
: Qnil
));
9795 specbind (Qinput_method_use_echo_area
,
9796 (NILP (cmd_loop
) ? Qt
: Qnil
));
9798 memset (keybuf
, 0, sizeof keybuf
);
9800 gcpro1
.nvars
= ARRAYELTS (keybuf
);
9802 if (NILP (continue_echo
))
9804 this_command_key_count
= 0;
9805 this_command_key_count_reset
= 0;
9806 this_single_command_key_start
= 0;
9809 #ifdef HAVE_WINDOW_SYSTEM
9810 if (display_hourglass_p
)
9811 cancel_hourglass ();
9814 i
= read_key_sequence (keybuf
, ARRAYELTS (keybuf
),
9815 prompt
, ! NILP (dont_downcase_last
),
9816 ! NILP (can_return_switch_frame
), 0, 0);
9818 #if 0 /* The following is fine for code reading a key sequence and
9819 then proceeding with a lengthy computation, but it's not good
9820 for code reading keys in a loop, like an input method. */
9821 #ifdef HAVE_WINDOW_SYSTEM
9822 if (display_hourglass_p
)
9833 return unbind_to (count
,
9834 ((allow_string
? make_event_array
: Fvector
)
9838 DEFUN ("read-key-sequence", Fread_key_sequence
, Sread_key_sequence
, 1, 5, 0,
9839 doc
: /* Read a sequence of keystrokes and return as a string or vector.
9840 The sequence is sufficient to specify a non-prefix command in the
9841 current local and global maps.
9843 First arg PROMPT is a prompt string. If nil, do not prompt specially.
9844 Second (optional) arg CONTINUE-ECHO, if non-nil, means this key echos
9845 as a continuation of the previous key.
9847 The third (optional) arg DONT-DOWNCASE-LAST, if non-nil, means do not
9848 convert the last event to lower case. (Normally any upper case event
9849 is converted to lower case if the original event is undefined and the lower
9850 case equivalent is defined.) A non-nil value is appropriate for reading
9851 a key sequence to be defined.
9853 A C-g typed while in this function is treated like any other character,
9854 and `quit-flag' is not set.
9856 If the key sequence starts with a mouse click, then the sequence is read
9857 using the keymaps of the buffer of the window clicked in, not the buffer
9858 of the selected window as normal.
9860 `read-key-sequence' drops unbound button-down events, since you normally
9861 only care about the click or drag events which follow them. If a drag
9862 or multi-click event is unbound, but the corresponding click event would
9863 be bound, `read-key-sequence' turns the event into a click event at the
9864 drag's starting position. This means that you don't have to distinguish
9865 between click and drag, double, or triple events unless you want to.
9867 `read-key-sequence' prefixes mouse events on mode lines, the vertical
9868 lines separating windows, and scroll bars with imaginary keys
9869 `mode-line', `vertical-line', and `vertical-scroll-bar'.
9871 Optional fourth argument CAN-RETURN-SWITCH-FRAME non-nil means that this
9872 function will process a switch-frame event if the user switches frames
9873 before typing anything. If the user switches frames in the middle of a
9874 key sequence, or at the start of the sequence but CAN-RETURN-SWITCH-FRAME
9875 is nil, then the event will be put off until after the current key sequence.
9877 `read-key-sequence' checks `function-key-map' for function key
9878 sequences, where they wouldn't conflict with ordinary bindings. See
9879 `function-key-map' for more details.
9881 The optional fifth argument CMD-LOOP, if non-nil, means
9882 that this key sequence is being read by something that will
9883 read commands one after another. It should be nil if the caller
9884 will read just one key sequence. */)
9885 (Lisp_Object prompt
, Lisp_Object continue_echo
, Lisp_Object dont_downcase_last
, Lisp_Object can_return_switch_frame
, Lisp_Object cmd_loop
)
9887 return read_key_sequence_vs (prompt
, continue_echo
, dont_downcase_last
,
9888 can_return_switch_frame
, cmd_loop
, true);
9891 DEFUN ("read-key-sequence-vector", Fread_key_sequence_vector
,
9892 Sread_key_sequence_vector
, 1, 5, 0,
9893 doc
: /* Like `read-key-sequence' but always return a vector. */)
9894 (Lisp_Object prompt
, Lisp_Object continue_echo
, Lisp_Object dont_downcase_last
, Lisp_Object can_return_switch_frame
, Lisp_Object cmd_loop
)
9896 return read_key_sequence_vs (prompt
, continue_echo
, dont_downcase_last
,
9897 can_return_switch_frame
, cmd_loop
, false);
9900 /* Return true if input events are pending. */
9903 detect_input_pending (void)
9905 return input_pending
|| get_input_pending (0);
9908 /* Return true if input events other than mouse movements are
9912 detect_input_pending_ignore_squeezables (void)
9914 return input_pending
|| get_input_pending (READABLE_EVENTS_IGNORE_SQUEEZABLES
);
9917 /* Return true if input events are pending, and run any pending timers. */
9920 detect_input_pending_run_timers (bool do_display
)
9922 unsigned old_timers_run
= timers_run
;
9925 get_input_pending (READABLE_EVENTS_DO_TIMERS_NOW
);
9927 if (old_timers_run
!= timers_run
&& do_display
)
9928 redisplay_preserve_echo_area (8);
9930 return input_pending
;
9933 /* This is called in some cases before a possible quit.
9934 It cases the next call to detect_input_pending to recompute input_pending.
9935 So calling this function unnecessarily can't do any harm. */
9938 clear_input_pending (void)
9943 /* Return true if there are pending requeued events.
9944 This isn't used yet. The hope is to make wait_reading_process_output
9945 call it, and return if it runs Lisp code that unreads something.
9946 The problem is, kbd_buffer_get_event needs to be fixed to know what
9947 to do in that case. It isn't trivial. */
9950 requeued_events_pending_p (void)
9952 return (!NILP (Vunread_command_events
));
9955 DEFUN ("input-pending-p", Finput_pending_p
, Sinput_pending_p
, 0, 1, 0,
9956 doc
: /* Return t if command input is currently available with no wait.
9957 Actually, the value is nil only if we can be sure that no input is available;
9958 if there is a doubt, the value is t.
9960 If CHECK-TIMERS is non-nil, timers that are ready to run will do so. */)
9961 (Lisp_Object check_timers
)
9963 if (!NILP (Vunread_command_events
)
9964 || !NILP (Vunread_post_input_method_events
)
9965 || !NILP (Vunread_input_method_events
))
9968 /* Process non-user-visible events (Bug#10195). */
9969 process_special_events ();
9971 return (get_input_pending ((NILP (check_timers
)
9972 ? 0 : READABLE_EVENTS_DO_TIMERS_NOW
)
9973 | READABLE_EVENTS_FILTER_EVENTS
)
9977 DEFUN ("recent-keys", Frecent_keys
, Srecent_keys
, 0, 0, 0,
9978 doc
: /* Return vector of last 300 events, not counting those from keyboard macros. */)
9981 Lisp_Object
*keys
= XVECTOR (recent_keys
)->contents
;
9984 if (total_keys
< NUM_RECENT_KEYS
)
9985 return Fvector (total_keys
, keys
);
9988 val
= Fvector (NUM_RECENT_KEYS
, keys
);
9989 vcopy (val
, 0, keys
+ recent_keys_index
,
9990 NUM_RECENT_KEYS
- recent_keys_index
);
9991 vcopy (val
, NUM_RECENT_KEYS
- recent_keys_index
,
9992 keys
, recent_keys_index
);
9997 DEFUN ("this-command-keys", Fthis_command_keys
, Sthis_command_keys
, 0, 0, 0,
9998 doc
: /* Return the key sequence that invoked this command.
9999 However, if the command has called `read-key-sequence', it returns
10000 the last key sequence that has been read.
10001 The value is a string or a vector.
10003 See also `this-command-keys-vector'. */)
10006 return make_event_array (this_command_key_count
,
10007 XVECTOR (this_command_keys
)->contents
);
10010 DEFUN ("this-command-keys-vector", Fthis_command_keys_vector
, Sthis_command_keys_vector
, 0, 0, 0,
10011 doc
: /* Return the key sequence that invoked this command, as a vector.
10012 However, if the command has called `read-key-sequence', it returns
10013 the last key sequence that has been read.
10015 See also `this-command-keys'. */)
10018 return Fvector (this_command_key_count
,
10019 XVECTOR (this_command_keys
)->contents
);
10022 DEFUN ("this-single-command-keys", Fthis_single_command_keys
,
10023 Sthis_single_command_keys
, 0, 0, 0,
10024 doc
: /* Return the key sequence that invoked this command.
10025 More generally, it returns the last key sequence read, either by
10026 the command loop or by `read-key-sequence'.
10027 Unlike `this-command-keys', this function's value
10028 does not include prefix arguments.
10029 The value is always a vector. */)
10032 return Fvector (this_command_key_count
10033 - this_single_command_key_start
,
10034 (XVECTOR (this_command_keys
)->contents
10035 + this_single_command_key_start
));
10038 DEFUN ("this-single-command-raw-keys", Fthis_single_command_raw_keys
,
10039 Sthis_single_command_raw_keys
, 0, 0, 0,
10040 doc
: /* Return the raw events that were read for this command.
10041 More generally, it returns the last key sequence read, either by
10042 the command loop or by `read-key-sequence'.
10043 Unlike `this-single-command-keys', this function's value
10044 shows the events before all translations (except for input methods).
10045 The value is always a vector. */)
10048 return Fvector (raw_keybuf_count
, XVECTOR (raw_keybuf
)->contents
);
10051 DEFUN ("reset-this-command-lengths", Freset_this_command_lengths
,
10052 Sreset_this_command_lengths
, 0, 0, 0,
10053 doc
: /* Make the unread events replace the last command and echo.
10054 Used in `universal-argument-other-key'.
10056 `universal-argument-other-key' rereads the event just typed.
10057 It then gets translated through `function-key-map'.
10058 The translated event has to replace the real events,
10059 both in the value of (this-command-keys) and in echoing.
10060 To achieve this, `universal-argument-other-key' calls
10061 `reset-this-command-lengths', which discards the record of reading
10062 these events the first time. */)
10065 this_command_key_count
= before_command_key_count
;
10066 if (this_command_key_count
< this_single_command_key_start
)
10067 this_single_command_key_start
= this_command_key_count
;
10069 echo_truncate (before_command_echo_length
);
10071 /* Cause whatever we put into unread-command-events
10072 to echo as if it were being freshly read from the keyboard. */
10073 this_command_key_count_reset
= 1;
10078 DEFUN ("clear-this-command-keys", Fclear_this_command_keys
,
10079 Sclear_this_command_keys
, 0, 1, 0,
10080 doc
: /* Clear out the vector that `this-command-keys' returns.
10081 Also clear the record of the last 100 events, unless optional arg
10082 KEEP-RECORD is non-nil. */)
10083 (Lisp_Object keep_record
)
10087 this_command_key_count
= 0;
10088 this_command_key_count_reset
= 0;
10090 if (NILP (keep_record
))
10092 for (i
= 0; i
< ASIZE (recent_keys
); ++i
)
10093 ASET (recent_keys
, i
, Qnil
);
10095 recent_keys_index
= 0;
10100 DEFUN ("recursion-depth", Frecursion_depth
, Srecursion_depth
, 0, 0, 0,
10101 doc
: /* Return the current depth in recursive edits. */)
10105 /* Wrap around reliably on integer overflow. */
10106 EMACS_INT sum
= (command_loop_level
& INTMASK
) + (minibuf_level
& INTMASK
);
10107 XSETINT (temp
, sum
);
10111 DEFUN ("open-dribble-file", Fopen_dribble_file
, Sopen_dribble_file
, 1, 1,
10112 "FOpen dribble file: ",
10113 doc
: /* Start writing all keyboard characters to a dribble file called FILE.
10114 If FILE is nil, close any open dribble file.
10115 The file will be closed when Emacs exits.
10117 Be aware that this records ALL characters you type!
10118 This may include sensitive information such as passwords. */)
10131 Lisp_Object encfile
;
10133 file
= Fexpand_file_name (file
, Qnil
);
10134 encfile
= ENCODE_FILE (file
);
10135 fd
= emacs_open (SSDATA (encfile
), O_WRONLY
| O_CREAT
| O_EXCL
, 0600);
10136 if (fd
< 0 && errno
== EEXIST
&& unlink (SSDATA (encfile
)) == 0)
10137 fd
= emacs_open (SSDATA (encfile
), O_WRONLY
| O_CREAT
| O_EXCL
, 0600);
10138 dribble
= fd
< 0 ? 0 : fdopen (fd
, "w");
10140 report_file_error ("Opening dribble", file
);
10145 DEFUN ("discard-input", Fdiscard_input
, Sdiscard_input
, 0, 0, 0,
10146 doc
: /* Discard the contents of the terminal input buffer.
10147 Also end any kbd macro being defined. */)
10150 if (!NILP (KVAR (current_kboard
, defining_kbd_macro
)))
10152 /* Discard the last command from the macro. */
10153 Fcancel_kbd_macro_events ();
10157 Vunread_command_events
= Qnil
;
10159 discard_tty_input ();
10161 kbd_fetch_ptr
= kbd_store_ptr
;
10167 DEFUN ("suspend-emacs", Fsuspend_emacs
, Ssuspend_emacs
, 0, 1, "",
10168 doc
: /* Stop Emacs and return to superior process. You can resume later.
10169 If `cannot-suspend' is non-nil, or if the system doesn't support job
10170 control, run a subshell instead.
10172 If optional arg STUFFSTRING is non-nil, its characters are stuffed
10173 to be read as terminal input by Emacs's parent, after suspension.
10175 Before suspending, run the normal hook `suspend-hook'.
10176 After resumption run the normal hook `suspend-resume-hook'.
10178 Some operating systems cannot stop the Emacs process and resume it later.
10179 On such systems, Emacs starts a subshell instead of suspending. */)
10180 (Lisp_Object stuffstring
)
10182 ptrdiff_t count
= SPECPDL_INDEX ();
10183 int old_height
, old_width
;
10185 struct gcpro gcpro1
;
10188 if (tty_list
&& tty_list
->next
)
10189 error ("There are other tty frames open; close them before suspending Emacs");
10191 if (!NILP (stuffstring
))
10192 CHECK_STRING (stuffstring
);
10194 /* Run the functions in suspend-hook. */
10195 hook
= intern ("suspend-hook");
10196 Frun_hooks (1, &hook
);
10198 GCPRO1 (stuffstring
);
10199 get_tty_size (fileno (CURTTY ()->input
), &old_width
, &old_height
);
10200 reset_all_sys_modes ();
10201 /* sys_suspend can get an error if it tries to fork a subshell
10202 and the system resources aren't available for that. */
10203 record_unwind_protect_void (init_all_sys_modes
);
10204 stuff_buffered_input (stuffstring
);
10205 if (cannot_suspend
)
10209 unbind_to (count
, Qnil
);
10211 /* Check if terminal/window size has changed.
10212 Note that this is not useful when we are running directly
10213 with a window system; but suspend should be disabled in that case. */
10214 get_tty_size (fileno (CURTTY ()->input
), &width
, &height
);
10215 if (width
!= old_width
|| height
!= old_height
)
10216 change_frame_size (SELECTED_FRAME (), width
, height
10217 - FRAME_MENU_BAR_LINES (SELECTED_FRAME ()), 0, 0, 0, 0);
10219 /* Run suspend-resume-hook. */
10220 hook
= intern ("suspend-resume-hook");
10221 Frun_hooks (1, &hook
);
10227 /* If STUFFSTRING is a string, stuff its contents as pending terminal input.
10228 Then in any case stuff anything Emacs has read ahead and not used. */
10231 stuff_buffered_input (Lisp_Object stuffstring
)
10233 #ifdef SIGTSTP /* stuff_char is defined if SIGTSTP. */
10234 register unsigned char *p
;
10236 if (STRINGP (stuffstring
))
10238 register ptrdiff_t count
;
10240 p
= SDATA (stuffstring
);
10241 count
= SBYTES (stuffstring
);
10242 while (count
-- > 0)
10247 /* Anything we have read ahead, put back for the shell to read. */
10248 /* ?? What should this do when we have multiple keyboards??
10249 Should we ignore anything that was typed in at the "wrong" kboard?
10251 rms: we should stuff everything back into the kboard
10253 for (; kbd_fetch_ptr
!= kbd_store_ptr
; kbd_fetch_ptr
++)
10256 if (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
10257 kbd_fetch_ptr
= kbd_buffer
;
10258 if (kbd_fetch_ptr
->kind
== ASCII_KEYSTROKE_EVENT
)
10259 stuff_char (kbd_fetch_ptr
->code
);
10261 clear_event (kbd_fetch_ptr
);
10265 #endif /* SIGTSTP */
10269 set_waiting_for_input (struct timespec
*time_to_clear
)
10271 input_available_clear_time
= time_to_clear
;
10273 /* Tell handle_interrupt to throw back to read_char, */
10274 waiting_for_input
= 1;
10276 /* If handle_interrupt was called before and buffered a C-g,
10277 make it run again now, to avoid timing error. */
10278 if (!NILP (Vquit_flag
))
10279 quit_throw_to_read_char (0);
10283 clear_waiting_for_input (void)
10285 /* Tell handle_interrupt not to throw back to read_char, */
10286 waiting_for_input
= 0;
10287 input_available_clear_time
= 0;
10290 /* The SIGINT handler.
10292 If we have a frame on the controlling tty, we assume that the
10293 SIGINT was generated by C-g, so we call handle_interrupt.
10294 Otherwise, tell QUIT to kill Emacs. */
10297 handle_interrupt_signal (int sig
)
10299 /* See if we have an active terminal on our controlling tty. */
10300 struct terminal
*terminal
= get_named_tty ("/dev/tty");
10303 /* If there are no frames there, let's pretend that we are a
10304 well-behaving UN*X program and quit. We must not call Lisp
10305 in a signal handler, so tell QUIT to exit when it is
10307 Vquit_flag
= Qkill_emacs
;
10311 /* Otherwise, the SIGINT was probably generated by C-g. */
10313 /* Set internal_last_event_frame to the top frame of the
10314 controlling tty, if we have a frame there. We disable the
10315 interrupt key on secondary ttys, so the SIGINT must have come
10316 from the controlling tty. */
10317 internal_last_event_frame
= terminal
->display_info
.tty
->top_frame
;
10319 handle_interrupt (1);
10324 deliver_interrupt_signal (int sig
)
10326 deliver_process_signal (sig
, handle_interrupt_signal
);
10330 /* If Emacs is stuck because `inhibit-quit' is true, then keep track
10331 of the number of times C-g has been requested. If C-g is pressed
10332 enough times, then quit anyway. See bug#6585. */
10333 static int volatile force_quit_count
;
10335 /* This routine is called at interrupt level in response to C-g.
10337 It is called from the SIGINT handler or kbd_buffer_store_event.
10339 If `waiting_for_input' is non zero, then unless `echoing' is
10340 nonzero, immediately throw back to read_char.
10342 Otherwise it sets the Lisp variable quit-flag not-nil. This causes
10343 eval to throw, when it gets a chance. If quit-flag is already
10344 non-nil, it stops the job right away. */
10347 handle_interrupt (bool in_signal_handler
)
10353 /* XXX This code needs to be revised for multi-tty support. */
10354 if (!NILP (Vquit_flag
) && get_named_tty ("/dev/tty"))
10356 if (! in_signal_handler
)
10358 /* If SIGINT isn't blocked, don't let us be interrupted by
10359 a SIGINT. It might be harmful due to non-reentrancy
10360 in I/O functions. */
10362 sigemptyset (&blocked
);
10363 sigaddset (&blocked
, SIGINT
);
10364 pthread_sigmask (SIG_BLOCK
, &blocked
, 0);
10368 reset_all_sys_modes ();
10372 * On systems which can suspend the current process and return to the original
10373 * shell, this command causes the user to end up back at the shell.
10374 * The "Auto-save" and "Abort" questions are not asked until
10375 * the user elects to return to emacs, at which point he can save the current
10376 * job and either dump core or continue.
10380 /* Perhaps should really fork an inferior shell?
10381 But that would not provide any way to get back
10382 to the original shell, ever. */
10383 printf ("No support for stopping a process on this operating system;\n");
10384 printf ("you can continue or abort.\n");
10385 #endif /* not SIGTSTP */
10387 /* We must remain inside the screen area when the internal terminal
10388 is used. Note that [Enter] is not echoed by dos. */
10389 cursor_to (SELECTED_FRAME (), 0, 0);
10391 /* It doesn't work to autosave while GC is in progress;
10392 the code used for auto-saving doesn't cope with the mark bit. */
10393 if (!gc_in_progress
)
10395 printf ("Auto-save? (y or n) ");
10397 if (((c
= getchar ()) & ~040) == 'Y')
10399 Fdo_auto_save (Qt
, Qnil
);
10401 printf ("\r\nAuto-save done");
10402 #else /* not MSDOS */
10403 printf ("Auto-save done\n");
10404 #endif /* not MSDOS */
10406 while (c
!= '\n') c
= getchar ();
10410 /* During GC, it must be safe to reenable quitting again. */
10411 Vinhibit_quit
= Qnil
;
10414 #endif /* not MSDOS */
10415 printf ("Garbage collection in progress; cannot auto-save now\r\n");
10416 printf ("but will instead do a real quit after garbage collection ends\r\n");
10421 printf ("\r\nAbort? (y or n) ");
10422 #else /* not MSDOS */
10423 printf ("Abort (and dump core)? (y or n) ");
10424 #endif /* not MSDOS */
10426 if (((c
= getchar ()) & ~040) == 'Y')
10428 while (c
!= '\n') c
= getchar ();
10430 printf ("\r\nContinuing...\r\n");
10431 #else /* not MSDOS */
10432 printf ("Continuing...\n");
10433 #endif /* not MSDOS */
10435 init_all_sys_modes ();
10439 /* If executing a function that wants to be interrupted out of
10440 and the user has not deferred quitting by binding `inhibit-quit'
10441 then quit right away. */
10442 if (immediate_quit
&& NILP (Vinhibit_quit
))
10444 struct gl_state_s saved
;
10445 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
10447 immediate_quit
= 0;
10448 pthread_sigmask (SIG_SETMASK
, &empty_mask
, 0);
10450 GCPRO4 (saved
.object
, saved
.global_code
,
10451 saved
.current_syntax_table
, saved
.old_prop
);
10452 Fsignal (Qquit
, Qnil
);
10457 { /* Else request quit when it's safe. */
10458 int count
= NILP (Vquit_flag
) ? 1 : force_quit_count
+ 1;
10459 force_quit_count
= count
;
10462 immediate_quit
= 1;
10463 Vinhibit_quit
= Qnil
;
10469 pthread_sigmask (SIG_SETMASK
, &empty_mask
, 0);
10471 /* TODO: The longjmp in this call throws the NS event loop integration off,
10472 and it seems to do fine without this. Probably some attention
10473 needs to be paid to the setting of waiting_for_input in
10474 wait_reading_process_output() under HAVE_NS because of the call
10475 to ns_select there (needed because otherwise events aren't picked up
10476 outside of polling since we don't get SIGIO like X and we don't have a
10477 separate event loop thread like W32. */
10479 if (waiting_for_input
&& !echoing
)
10480 quit_throw_to_read_char (in_signal_handler
);
10484 /* Handle a C-g by making read_char return C-g. */
10487 quit_throw_to_read_char (bool from_signal
)
10489 /* When not called from a signal handler it is safe to call
10491 if (!from_signal
&& EQ (Vquit_flag
, Qkill_emacs
))
10492 Fkill_emacs (Qnil
);
10494 /* Prevent another signal from doing this before we finish. */
10495 clear_waiting_for_input ();
10498 Vunread_command_events
= Qnil
;
10500 if (FRAMEP (internal_last_event_frame
)
10501 && !EQ (internal_last_event_frame
, selected_frame
))
10502 do_switch_frame (make_lispy_switch_frame (internal_last_event_frame
),
10505 sys_longjmp (getcjmp
, 1);
10508 DEFUN ("set-input-interrupt-mode", Fset_input_interrupt_mode
,
10509 Sset_input_interrupt_mode
, 1, 1, 0,
10510 doc
: /* Set interrupt mode of reading keyboard input.
10511 If INTERRUPT is non-nil, Emacs will use input interrupts;
10512 otherwise Emacs uses CBREAK mode.
10514 See also `current-input-mode'. */)
10515 (Lisp_Object interrupt
)
10517 bool new_interrupt_input
;
10518 #ifdef USABLE_SIGIO
10519 #ifdef HAVE_X_WINDOWS
10520 if (x_display_list
!= NULL
)
10522 /* When using X, don't give the user a real choice,
10523 because we haven't implemented the mechanisms to support it. */
10524 new_interrupt_input
= 1;
10527 #endif /* HAVE_X_WINDOWS */
10528 new_interrupt_input
= !NILP (interrupt
);
10529 #else /* not USABLE_SIGIO */
10530 new_interrupt_input
= 0;
10531 #endif /* not USABLE_SIGIO */
10533 if (new_interrupt_input
!= interrupt_input
)
10535 #ifdef POLL_FOR_INPUT
10539 /* this causes startup screen to be restored and messes with the mouse */
10540 reset_all_sys_modes ();
10541 interrupt_input
= new_interrupt_input
;
10542 init_all_sys_modes ();
10544 interrupt_input
= new_interrupt_input
;
10547 #ifdef POLL_FOR_INPUT
10548 poll_suppress_count
= 1;
10555 DEFUN ("set-output-flow-control", Fset_output_flow_control
, Sset_output_flow_control
, 1, 2, 0,
10556 doc
: /* Enable or disable ^S/^Q flow control for output to TERMINAL.
10557 If FLOW is non-nil, flow control is enabled and you cannot use C-s or
10558 C-q in key sequences.
10560 This setting only has an effect on tty terminals and only when
10561 Emacs reads input in CBREAK mode; see `set-input-interrupt-mode'.
10563 See also `current-input-mode'. */)
10564 (Lisp_Object flow
, Lisp_Object terminal
)
10566 struct terminal
*t
= get_terminal (terminal
, 1);
10567 struct tty_display_info
*tty
;
10568 if (t
== NULL
|| (t
->type
!= output_termcap
&& t
->type
!= output_msdos_raw
))
10570 tty
= t
->display_info
.tty
;
10572 if (tty
->flow_control
!= !NILP (flow
))
10575 /* This causes startup screen to be restored and messes with the mouse. */
10576 reset_sys_modes (tty
);
10579 tty
->flow_control
= !NILP (flow
);
10582 init_sys_modes (tty
);
10588 DEFUN ("set-input-meta-mode", Fset_input_meta_mode
, Sset_input_meta_mode
, 1, 2, 0,
10589 doc
: /* Enable or disable 8-bit input on TERMINAL.
10590 If META is t, Emacs will accept 8-bit input, and interpret the 8th
10591 bit as the Meta modifier.
10593 If META is nil, Emacs will ignore the top bit, on the assumption it is
10596 Otherwise, Emacs will accept and pass through 8-bit input without
10597 specially interpreting the top bit.
10599 This setting only has an effect on tty terminal devices.
10601 Optional parameter TERMINAL specifies the tty terminal device to use.
10602 It may be a terminal object, a frame, or nil for the terminal used by
10603 the currently selected frame.
10605 See also `current-input-mode'. */)
10606 (Lisp_Object meta
, Lisp_Object terminal
)
10608 struct terminal
*t
= get_terminal (terminal
, 1);
10609 struct tty_display_info
*tty
;
10612 if (t
== NULL
|| (t
->type
!= output_termcap
&& t
->type
!= output_msdos_raw
))
10614 tty
= t
->display_info
.tty
;
10618 else if (EQ (meta
, Qt
))
10623 if (tty
->meta_key
!= new_meta
)
10626 /* this causes startup screen to be restored and messes with the mouse */
10627 reset_sys_modes (tty
);
10630 tty
->meta_key
= new_meta
;
10633 init_sys_modes (tty
);
10639 DEFUN ("set-quit-char", Fset_quit_char
, Sset_quit_char
, 1, 1, 0,
10640 doc
: /* Specify character used for quitting.
10641 QUIT must be an ASCII character.
10643 This function only has an effect on the controlling tty of the Emacs
10646 See also `current-input-mode'. */)
10649 struct terminal
*t
= get_named_tty ("/dev/tty");
10650 struct tty_display_info
*tty
;
10651 if (t
== NULL
|| (t
->type
!= output_termcap
&& t
->type
!= output_msdos_raw
))
10653 tty
= t
->display_info
.tty
;
10655 if (NILP (quit
) || !INTEGERP (quit
) || XINT (quit
) < 0 || XINT (quit
) > 0400)
10656 error ("QUIT must be an ASCII character");
10659 /* this causes startup screen to be restored and messes with the mouse */
10660 reset_sys_modes (tty
);
10663 /* Don't let this value be out of range. */
10664 quit_char
= XINT (quit
) & (tty
->meta_key
== 0 ? 0177 : 0377);
10667 init_sys_modes (tty
);
10673 DEFUN ("set-input-mode", Fset_input_mode
, Sset_input_mode
, 3, 4, 0,
10674 doc
: /* Set mode of reading keyboard input.
10675 First arg INTERRUPT non-nil means use input interrupts;
10676 nil means use CBREAK mode.
10677 Second arg FLOW non-nil means use ^S/^Q flow control for output to terminal
10678 (no effect except in CBREAK mode).
10679 Third arg META t means accept 8-bit input (for a Meta key).
10680 META nil means ignore the top bit, on the assumption it is parity.
10681 Otherwise, accept 8-bit input and don't use the top bit for Meta.
10682 Optional fourth arg QUIT if non-nil specifies character to use for quitting.
10683 See also `current-input-mode'. */)
10684 (Lisp_Object interrupt
, Lisp_Object flow
, Lisp_Object meta
, Lisp_Object quit
)
10686 Fset_input_interrupt_mode (interrupt
);
10687 Fset_output_flow_control (flow
, Qnil
);
10688 Fset_input_meta_mode (meta
, Qnil
);
10690 Fset_quit_char (quit
);
10694 DEFUN ("current-input-mode", Fcurrent_input_mode
, Scurrent_input_mode
, 0, 0, 0,
10695 doc
: /* Return information about the way Emacs currently reads keyboard input.
10696 The value is a list of the form (INTERRUPT FLOW META QUIT), where
10697 INTERRUPT is non-nil if Emacs is using interrupt-driven input; if
10698 nil, Emacs is using CBREAK mode.
10699 FLOW is non-nil if Emacs uses ^S/^Q flow control for output to the
10700 terminal; this does not apply if Emacs uses interrupt-driven input.
10701 META is t if accepting 8-bit input with 8th bit as Meta flag.
10702 META nil means ignoring the top bit, on the assumption it is parity.
10703 META is neither t nor nil if accepting 8-bit input and using
10704 all 8 bits as the character code.
10705 QUIT is the character Emacs currently uses to quit.
10706 The elements of this list correspond to the arguments of
10707 `set-input-mode'. */)
10710 Lisp_Object val
[4];
10711 struct frame
*sf
= XFRAME (selected_frame
);
10713 val
[0] = interrupt_input
? Qt
: Qnil
;
10714 if (FRAME_TERMCAP_P (sf
) || FRAME_MSDOS_P (sf
))
10716 val
[1] = FRAME_TTY (sf
)->flow_control
? Qt
: Qnil
;
10717 val
[2] = (FRAME_TTY (sf
)->meta_key
== 2
10719 : (CURTTY ()->meta_key
== 1 ? Qt
: Qnil
));
10726 XSETFASTINT (val
[3], quit_char
);
10728 return Flist (ARRAYELTS (val
), val
);
10731 DEFUN ("posn-at-x-y", Fposn_at_x_y
, Sposn_at_x_y
, 2, 4, 0,
10732 doc
: /* Return position information for pixel coordinates X and Y.
10733 By default, X and Y are relative to text area of the selected window.
10734 Optional third arg FRAME-OR-WINDOW non-nil specifies frame or window.
10735 If optional fourth arg WHOLE is non-nil, X is relative to the left
10736 edge of the window.
10738 The return value is similar to a mouse click position:
10739 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
10740 IMAGE (DX . DY) (WIDTH . HEIGHT))
10741 The `posn-' functions access elements of such lists. */)
10742 (Lisp_Object x
, Lisp_Object y
, Lisp_Object frame_or_window
, Lisp_Object whole
)
10747 if (NILP (frame_or_window
))
10748 frame_or_window
= selected_window
;
10750 if (WINDOWP (frame_or_window
))
10752 struct window
*w
= decode_live_window (frame_or_window
);
10754 XSETINT (x
, (XINT (x
)
10755 + WINDOW_LEFT_EDGE_X (w
)
10757 ? window_box_left_offset (w
, TEXT_AREA
)
10759 XSETINT (y
, WINDOW_TO_FRAME_PIXEL_Y (w
, XINT (y
)));
10760 frame_or_window
= w
->frame
;
10763 CHECK_LIVE_FRAME (frame_or_window
);
10765 return make_lispy_position (XFRAME (frame_or_window
), x
, y
, 0);
10768 DEFUN ("posn-at-point", Fposn_at_point
, Sposn_at_point
, 0, 2, 0,
10769 doc
: /* Return position information for buffer POS in WINDOW.
10770 POS defaults to point in WINDOW; WINDOW defaults to the selected window.
10772 Return nil if position is not visible in window. Otherwise,
10773 the return value is similar to that returned by `event-start' for
10774 a mouse click at the upper left corner of the glyph corresponding
10775 to the given buffer position:
10776 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
10777 IMAGE (DX . DY) (WIDTH . HEIGHT))
10778 The `posn-' functions access elements of such lists. */)
10779 (Lisp_Object pos
, Lisp_Object window
)
10784 window
= selected_window
;
10786 tem
= Fpos_visible_in_window_p (pos
, window
, Qt
);
10789 Lisp_Object x
= XCAR (tem
);
10790 Lisp_Object y
= XCAR (XCDR (tem
));
10792 /* Point invisible due to hscrolling? */
10795 tem
= Fposn_at_x_y (x
, y
, window
, Qnil
);
10801 /* Set up a new kboard object with reasonable initial values.
10802 TYPE is a window system for which this keyboard is used. */
10805 init_kboard (KBOARD
*kb
, Lisp_Object type
)
10807 kset_overriding_terminal_local_map (kb
, Qnil
);
10808 kset_last_command (kb
, Qnil
);
10809 kset_real_last_command (kb
, Qnil
);
10810 kset_keyboard_translate_table (kb
, Qnil
);
10811 kset_last_repeatable_command (kb
, Qnil
);
10812 kset_prefix_arg (kb
, Qnil
);
10813 kset_last_prefix_arg (kb
, Qnil
);
10814 kset_kbd_queue (kb
, Qnil
);
10815 kb
->kbd_queue_has_data
= 0;
10816 kb
->immediate_echo
= 0;
10817 kset_echo_string (kb
, Qnil
);
10818 kb
->echo_after_prompt
= -1;
10819 kb
->kbd_macro_buffer
= 0;
10820 kb
->kbd_macro_bufsize
= 0;
10821 kset_defining_kbd_macro (kb
, Qnil
);
10822 kset_last_kbd_macro (kb
, Qnil
);
10823 kb
->reference_count
= 0;
10824 kset_system_key_alist (kb
, Qnil
);
10825 kset_system_key_syms (kb
, Qnil
);
10826 kset_window_system (kb
, type
);
10827 kset_input_decode_map (kb
, Fmake_sparse_keymap (Qnil
));
10828 kset_local_function_key_map (kb
, Fmake_sparse_keymap (Qnil
));
10829 Fset_keymap_parent (KVAR (kb
, Vlocal_function_key_map
), Vfunction_key_map
);
10830 kset_default_minibuffer_frame (kb
, Qnil
);
10833 /* Allocate and basically initialize keyboard
10834 object to use with window system TYPE. */
10837 allocate_kboard (Lisp_Object type
)
10839 KBOARD
*kb
= xmalloc (sizeof *kb
);
10841 init_kboard (kb
, type
);
10842 kb
->next_kboard
= all_kboards
;
10848 * Destroy the contents of a kboard object, but not the object itself.
10849 * We use this just before deleting it, or if we're going to initialize
10850 * it a second time.
10853 wipe_kboard (KBOARD
*kb
)
10855 xfree (kb
->kbd_macro_buffer
);
10858 /* Free KB and memory referenced from it. */
10861 delete_kboard (KBOARD
*kb
)
10865 for (kbp
= &all_kboards
; *kbp
!= kb
; kbp
= &(*kbp
)->next_kboard
)
10868 *kbp
= kb
->next_kboard
;
10870 /* Prevent a dangling reference to KB. */
10871 if (kb
== current_kboard
10872 && FRAMEP (selected_frame
)
10873 && FRAME_LIVE_P (XFRAME (selected_frame
)))
10875 current_kboard
= FRAME_KBOARD (XFRAME (selected_frame
));
10877 if (current_kboard
== kb
)
10886 init_keyboard (void)
10888 /* This is correct before outermost invocation of the editor loop. */
10889 command_loop_level
= -1;
10890 immediate_quit
= 0;
10891 quit_char
= Ctl ('g');
10892 Vunread_command_events
= Qnil
;
10893 timer_idleness_start_time
= invalid_timespec ();
10895 recent_keys_index
= 0;
10896 kbd_fetch_ptr
= kbd_buffer
;
10897 kbd_store_ptr
= kbd_buffer
;
10898 do_mouse_tracking
= Qnil
;
10900 interrupt_input_blocked
= 0;
10901 pending_signals
= 0;
10903 /* This means that command_loop_1 won't try to select anything the first
10905 internal_last_event_frame
= Qnil
;
10906 Vlast_event_frame
= internal_last_event_frame
;
10908 current_kboard
= initial_kboard
;
10909 /* Re-initialize the keyboard again. */
10910 wipe_kboard (current_kboard
);
10911 /* A value of nil for Vwindow_system normally means a tty, but we also use
10912 it for the initial terminal since there is no window system there. */
10913 init_kboard (current_kboard
, Qnil
);
10915 if (!noninteractive
)
10917 /* Before multi-tty support, these handlers used to be installed
10918 only if the current session was a tty session. Now an Emacs
10919 session may have multiple display types, so we always handle
10920 SIGINT. There is special code in handle_interrupt_signal to exit
10921 Emacs on SIGINT when there are no termcap frames on the
10922 controlling terminal. */
10923 struct sigaction action
;
10924 emacs_sigaction_init (&action
, deliver_interrupt_signal
);
10925 sigaction (SIGINT
, &action
, 0);
10927 /* For systems with SysV TERMIO, C-g is set up for both SIGINT and
10928 SIGQUIT and we can't tell which one it will give us. */
10929 sigaction (SIGQUIT
, &action
, 0);
10930 #endif /* not DOS_NT */
10932 #ifdef USABLE_SIGIO
10933 if (!noninteractive
)
10935 struct sigaction action
;
10936 emacs_sigaction_init (&action
, deliver_input_available_signal
);
10937 sigaction (SIGIO
, &action
, 0);
10941 /* Use interrupt input by default, if it works and noninterrupt input
10942 has deficiencies. */
10944 #ifdef INTERRUPT_INPUT
10945 interrupt_input
= 1;
10947 interrupt_input
= 0;
10950 pthread_sigmask (SIG_SETMASK
, &empty_mask
, 0);
10953 if (keyboard_init_hook
)
10954 (*keyboard_init_hook
) ();
10956 #ifdef POLL_FOR_INPUT
10958 poll_suppress_count
= 1;
10963 /* This type's only use is in syms_of_keyboard, to initialize the
10964 event header symbols and put properties on them. */
10965 struct event_head
{
10971 static const struct event_head head_table
[] = {
10972 {&Qmouse_movement
, "mouse-movement", &Qmouse_movement
},
10973 {&Qscroll_bar_movement
, "scroll-bar-movement", &Qmouse_movement
},
10974 {&Qswitch_frame
, "switch-frame", &Qswitch_frame
},
10975 {&Qfocus_in
, "focus-in", &Qfocus_in
},
10976 {&Qfocus_out
, "focus-out", &Qfocus_out
},
10977 {&Qdelete_frame
, "delete-frame", &Qdelete_frame
},
10978 {&Qiconify_frame
, "iconify-frame", &Qiconify_frame
},
10979 {&Qmake_frame_visible
, "make-frame-visible", &Qmake_frame_visible
},
10980 /* `select-window' should be handled just like `switch-frame'
10981 in read_key_sequence. */
10982 {&Qselect_window
, "select-window", &Qswitch_frame
}
10986 syms_of_keyboard (void)
10988 pending_funcalls
= Qnil
;
10989 staticpro (&pending_funcalls
);
10991 Vlispy_mouse_stem
= build_pure_c_string ("mouse");
10992 staticpro (&Vlispy_mouse_stem
);
10995 DEFSYM (QCimage
, ":image");
10996 DEFSYM (Qhelp_echo
, "help-echo");
10997 DEFSYM (QCrtl
, ":rtl");
10999 staticpro (&item_properties
);
11000 item_properties
= Qnil
;
11002 staticpro (&tool_bar_item_properties
);
11003 tool_bar_item_properties
= Qnil
;
11004 staticpro (&tool_bar_items_vector
);
11005 tool_bar_items_vector
= Qnil
;
11007 DEFSYM (Qtimer_event_handler
, "timer-event-handler");
11008 DEFSYM (Qdisabled_command_function
, "disabled-command-function");
11009 DEFSYM (Qself_insert_command
, "self-insert-command");
11010 DEFSYM (Qforward_char
, "forward-char");
11011 DEFSYM (Qbackward_char
, "backward-char");
11012 DEFSYM (Qdisabled
, "disabled");
11013 DEFSYM (Qundefined
, "undefined");
11014 DEFSYM (Qpre_command_hook
, "pre-command-hook");
11015 DEFSYM (Qpost_command_hook
, "post-command-hook");
11016 DEFSYM (Qdeferred_action_function
, "deferred-action-function");
11017 DEFSYM (Qdelayed_warnings_hook
, "delayed-warnings-hook");
11018 DEFSYM (Qfunction_key
, "function-key");
11019 DEFSYM (Qmouse_click
, "mouse-click");
11020 DEFSYM (Qdrag_n_drop
, "drag-n-drop");
11021 DEFSYM (Qsave_session
, "save-session");
11022 DEFSYM (Qconfig_changed_event
, "config-changed-event");
11023 DEFSYM (Qmenu_enable
, "menu-enable");
11026 DEFSYM (Qlanguage_change
, "language-change");
11030 DEFSYM (Qdbus_event
, "dbus-event");
11033 #ifdef USE_FILE_NOTIFY
11034 DEFSYM (Qfile_notify
, "file-notify");
11035 #endif /* USE_FILE_NOTIFY */
11037 DEFSYM (QCenable
, ":enable");
11038 DEFSYM (QCvisible
, ":visible");
11039 DEFSYM (QChelp
, ":help");
11040 DEFSYM (QCfilter
, ":filter");
11041 DEFSYM (QCbutton
, ":button");
11042 DEFSYM (QCkeys
, ":keys");
11043 DEFSYM (QCkey_sequence
, ":key-sequence");
11044 DEFSYM (QCtoggle
, ":toggle");
11045 DEFSYM (QCradio
, ":radio");
11046 DEFSYM (QClabel
, ":label");
11047 DEFSYM (QCvert_only
, ":vert-only");
11049 DEFSYM (Qmode_line
, "mode-line");
11050 DEFSYM (Qvertical_line
, "vertical-line");
11051 DEFSYM (Qmenu_bar
, "menu-bar");
11052 DEFSYM (Qright_divider
, "right-divider");
11053 DEFSYM (Qbottom_divider
, "bottom-divider");
11055 DEFSYM (Qmouse_fixup_help_message
, "mouse-fixup-help-message");
11057 DEFSYM (Qabove_handle
, "above-handle");
11058 DEFSYM (Qhandle
, "handle");
11059 DEFSYM (Qbelow_handle
, "below-handle");
11060 DEFSYM (Qup
, "up");
11061 DEFSYM (Qdown
, "down");
11062 DEFSYM (Qtop
, "top");
11063 DEFSYM (Qbottom
, "bottom");
11064 DEFSYM (Qend_scroll
, "end-scroll");
11065 DEFSYM (Qratio
, "ratio");
11066 DEFSYM (Qbefore_handle
, "before-handle");
11067 DEFSYM (Qhorizontal_handle
, "horizontal-handle");
11068 DEFSYM (Qafter_handle
, "after-handle");
11069 DEFSYM (Qleft
, "left");
11070 DEFSYM (Qright
, "right");
11071 DEFSYM (Qleftmost
, "leftmost");
11072 DEFSYM (Qrightmost
, "rightmost");
11074 DEFSYM (Qevent_kind
, "event-kind");
11075 DEFSYM (Qevent_symbol_elements
, "event-symbol-elements");
11076 DEFSYM (Qevent_symbol_element_mask
, "event-symbol-element-mask");
11077 DEFSYM (Qmodifier_cache
, "modifier-cache");
11079 DEFSYM (Qrecompute_lucid_menubar
, "recompute-lucid-menubar");
11080 DEFSYM (Qactivate_menubar_hook
, "activate-menubar-hook");
11082 DEFSYM (Qpolling_period
, "polling-period");
11084 DEFSYM (Qx_set_selection
, "x-set-selection");
11085 DEFSYM (QPRIMARY
, "PRIMARY");
11086 DEFSYM (Qhandle_switch_frame
, "handle-switch-frame");
11087 DEFSYM (Qhandle_select_window
, "handle-select-window");
11089 DEFSYM (Qinput_method_function
, "input-method-function");
11090 DEFSYM (Qinput_method_exit_on_first_char
, "input-method-exit-on-first-char");
11091 DEFSYM (Qinput_method_use_echo_area
, "input-method-use-echo-area");
11093 DEFSYM (Qhelp_form_show
, "help-form-show");
11095 DEFSYM (Qecho_keystrokes
, "echo-keystrokes");
11097 Fset (Qinput_method_exit_on_first_char
, Qnil
);
11098 Fset (Qinput_method_use_echo_area
, Qnil
);
11102 int len
= ARRAYELTS (head_table
);
11104 for (i
= 0; i
< len
; i
++)
11106 const struct event_head
*p
= &head_table
[i
];
11107 *p
->var
= intern_c_string (p
->name
);
11108 staticpro (p
->var
);
11109 Fput (*p
->var
, Qevent_kind
, *p
->kind
);
11110 Fput (*p
->var
, Qevent_symbol_elements
, list1 (*p
->var
));
11114 button_down_location
= Fmake_vector (make_number (5), Qnil
);
11115 staticpro (&button_down_location
);
11116 mouse_syms
= Fmake_vector (make_number (5), Qnil
);
11117 staticpro (&mouse_syms
);
11118 wheel_syms
= Fmake_vector (make_number (ARRAYELTS (lispy_wheel_names
)),
11120 staticpro (&wheel_syms
);
11124 int len
= ARRAYELTS (modifier_names
);
11126 modifier_symbols
= Fmake_vector (make_number (len
), Qnil
);
11127 for (i
= 0; i
< len
; i
++)
11128 if (modifier_names
[i
])
11129 ASET (modifier_symbols
, i
, intern_c_string (modifier_names
[i
]));
11130 staticpro (&modifier_symbols
);
11133 recent_keys
= Fmake_vector (make_number (NUM_RECENT_KEYS
), Qnil
);
11134 staticpro (&recent_keys
);
11136 this_command_keys
= Fmake_vector (make_number (40), Qnil
);
11137 staticpro (&this_command_keys
);
11139 raw_keybuf
= Fmake_vector (make_number (30), Qnil
);
11140 staticpro (&raw_keybuf
);
11142 DEFSYM (Qcommand_execute
, "command-execute");
11144 accent_key_syms
= Qnil
;
11145 staticpro (&accent_key_syms
);
11147 func_key_syms
= Qnil
;
11148 staticpro (&func_key_syms
);
11150 drag_n_drop_syms
= Qnil
;
11151 staticpro (&drag_n_drop_syms
);
11153 unread_switch_frame
= Qnil
;
11154 staticpro (&unread_switch_frame
);
11156 internal_last_event_frame
= Qnil
;
11157 staticpro (&internal_last_event_frame
);
11159 read_key_sequence_cmd
= Qnil
;
11160 staticpro (&read_key_sequence_cmd
);
11161 read_key_sequence_remapped
= Qnil
;
11162 staticpro (&read_key_sequence_remapped
);
11164 menu_bar_one_keymap_changed_items
= Qnil
;
11165 staticpro (&menu_bar_one_keymap_changed_items
);
11167 menu_bar_items_vector
= Qnil
;
11168 staticpro (&menu_bar_items_vector
);
11170 help_form_saved_window_configs
= Qnil
;
11171 staticpro (&help_form_saved_window_configs
);
11173 defsubr (&Scurrent_idle_time
);
11174 defsubr (&Sevent_symbol_parse_modifiers
);
11175 defsubr (&Sevent_convert_list
);
11176 defsubr (&Sread_key_sequence
);
11177 defsubr (&Sread_key_sequence_vector
);
11178 defsubr (&Srecursive_edit
);
11179 defsubr (&Strack_mouse
);
11180 defsubr (&Sinput_pending_p
);
11181 defsubr (&Srecent_keys
);
11182 defsubr (&Sthis_command_keys
);
11183 defsubr (&Sthis_command_keys_vector
);
11184 defsubr (&Sthis_single_command_keys
);
11185 defsubr (&Sthis_single_command_raw_keys
);
11186 defsubr (&Sreset_this_command_lengths
);
11187 defsubr (&Sclear_this_command_keys
);
11188 defsubr (&Ssuspend_emacs
);
11189 defsubr (&Sabort_recursive_edit
);
11190 defsubr (&Sexit_recursive_edit
);
11191 defsubr (&Srecursion_depth
);
11192 defsubr (&Scommand_error_default_function
);
11193 defsubr (&Stop_level
);
11194 defsubr (&Sdiscard_input
);
11195 defsubr (&Sopen_dribble_file
);
11196 defsubr (&Sset_input_interrupt_mode
);
11197 defsubr (&Sset_output_flow_control
);
11198 defsubr (&Sset_input_meta_mode
);
11199 defsubr (&Sset_quit_char
);
11200 defsubr (&Sset_input_mode
);
11201 defsubr (&Scurrent_input_mode
);
11202 defsubr (&Sposn_at_point
);
11203 defsubr (&Sposn_at_x_y
);
11205 DEFVAR_LISP ("last-command-event", last_command_event
,
11206 doc
: /* Last input event that was part of a command. */);
11208 DEFVAR_LISP ("last-nonmenu-event", last_nonmenu_event
,
11209 doc
: /* Last input event in a command, except for mouse menu events.
11210 Mouse menus give back keys that don't look like mouse events;
11211 this variable holds the actual mouse event that led to the menu,
11212 so that you can determine whether the command was run by mouse or not. */);
11214 DEFVAR_LISP ("last-input-event", last_input_event
,
11215 doc
: /* Last input event. */);
11217 DEFVAR_LISP ("unread-command-events", Vunread_command_events
,
11218 doc
: /* List of events to be read as the command input.
11219 These events are processed first, before actual keyboard input.
11220 Events read from this list are not normally added to `this-command-keys',
11221 as they will already have been added once as they were read for the first time.
11222 An element of the form (t . EVENT) forces EVENT to be added to that list. */);
11223 Vunread_command_events
= Qnil
;
11225 DEFVAR_LISP ("unread-post-input-method-events", Vunread_post_input_method_events
,
11226 doc
: /* List of events to be processed as input by input methods.
11227 These events are processed before `unread-command-events'
11228 and actual keyboard input, but are not given to `input-method-function'. */);
11229 Vunread_post_input_method_events
= Qnil
;
11231 DEFVAR_LISP ("unread-input-method-events", Vunread_input_method_events
,
11232 doc
: /* List of events to be processed as input by input methods.
11233 These events are processed after `unread-command-events', but
11234 before actual keyboard input.
11235 If there's an active input method, the events are given to
11236 `input-method-function'. */);
11237 Vunread_input_method_events
= Qnil
;
11239 DEFVAR_LISP ("meta-prefix-char", meta_prefix_char
,
11240 doc
: /* Meta-prefix character code.
11241 Meta-foo as command input turns into this character followed by foo. */);
11242 XSETINT (meta_prefix_char
, 033);
11244 DEFVAR_KBOARD ("last-command", Vlast_command
,
11245 doc
: /* The last command executed.
11246 Normally a symbol with a function definition, but can be whatever was found
11247 in the keymap, or whatever the variable `this-command' was set to by that
11250 The value `mode-exit' is special; it means that the previous command
11251 read an event that told it to exit, and it did so and unread that event.
11252 In other words, the present command is the event that made the previous
11255 The value `kill-region' is special; it means that the previous command
11256 was a kill command.
11258 `last-command' has a separate binding for each terminal device.
11259 See Info node `(elisp)Multiple Terminals'. */);
11261 DEFVAR_KBOARD ("real-last-command", Vreal_last_command
,
11262 doc
: /* Same as `last-command', but never altered by Lisp code.
11263 Taken from the previous value of `real-this-command'. */);
11265 DEFVAR_KBOARD ("last-repeatable-command", Vlast_repeatable_command
,
11266 doc
: /* Last command that may be repeated.
11267 The last command executed that was not bound to an input event.
11268 This is the command `repeat' will try to repeat.
11269 Taken from a previous value of `real-this-command'. */);
11271 DEFVAR_LISP ("this-command", Vthis_command
,
11272 doc
: /* The command now being executed.
11273 The command can set this variable; whatever is put here
11274 will be in `last-command' during the following command. */);
11275 Vthis_command
= Qnil
;
11277 DEFVAR_LISP ("real-this-command", Vreal_this_command
,
11278 doc
: /* This is like `this-command', except that commands should never modify it. */);
11279 Vreal_this_command
= Qnil
;
11281 DEFVAR_LISP ("this-command-keys-shift-translated",
11282 Vthis_command_keys_shift_translated
,
11283 doc
: /* Non-nil if the key sequence activating this command was shift-translated.
11284 Shift-translation occurs when there is no binding for the key sequence
11285 as entered, but a binding was found by changing an upper-case letter
11286 to lower-case, or a shifted function key to an unshifted one. */);
11287 Vthis_command_keys_shift_translated
= Qnil
;
11289 DEFVAR_LISP ("this-original-command", Vthis_original_command
,
11290 doc
: /* The command bound to the current key sequence before remapping.
11291 It equals `this-command' if the original command was not remapped through
11292 any of the active keymaps. Otherwise, the value of `this-command' is the
11293 result of looking up the original command in the active keymaps. */);
11294 Vthis_original_command
= Qnil
;
11296 DEFVAR_INT ("auto-save-interval", auto_save_interval
,
11297 doc
: /* Number of input events between auto-saves.
11298 Zero means disable autosaving due to number of characters typed. */);
11299 auto_save_interval
= 300;
11301 DEFVAR_LISP ("auto-save-timeout", Vauto_save_timeout
,
11302 doc
: /* Number of seconds idle time before auto-save.
11303 Zero or nil means disable auto-saving due to idleness.
11304 After auto-saving due to this many seconds of idle time,
11305 Emacs also does a garbage collection if that seems to be warranted. */);
11306 XSETFASTINT (Vauto_save_timeout
, 30);
11308 DEFVAR_LISP ("echo-keystrokes", Vecho_keystrokes
,
11309 doc
: /* Nonzero means echo unfinished commands after this many seconds of pause.
11310 The value may be integer or floating point.
11311 If the value is zero, don't echo at all. */);
11312 Vecho_keystrokes
= make_number (1);
11314 DEFVAR_INT ("polling-period", polling_period
,
11315 doc
: /* Interval between polling for input during Lisp execution.
11316 The reason for polling is to make C-g work to stop a running program.
11317 Polling is needed only when using X windows and SIGIO does not work.
11318 Polling is automatically disabled in all other cases. */);
11319 polling_period
= 2;
11321 DEFVAR_LISP ("double-click-time", Vdouble_click_time
,
11322 doc
: /* Maximum time between mouse clicks to make a double-click.
11323 Measured in milliseconds. The value nil means disable double-click
11324 recognition; t means double-clicks have no time limit and are detected
11325 by position only. */);
11326 Vdouble_click_time
= make_number (500);
11328 DEFVAR_INT ("double-click-fuzz", double_click_fuzz
,
11329 doc
: /* Maximum mouse movement between clicks to make a double-click.
11330 On window-system frames, value is the number of pixels the mouse may have
11331 moved horizontally or vertically between two clicks to make a double-click.
11332 On non window-system frames, value is interpreted in units of 1/8 characters
11335 This variable is also the threshold for motion of the mouse
11336 to count as a drag. */);
11337 double_click_fuzz
= 3;
11339 DEFVAR_INT ("num-input-keys", num_input_keys
,
11340 doc
: /* Number of complete key sequences read as input so far.
11341 This includes key sequences read from keyboard macros.
11342 The number is effectively the number of interactive command invocations. */);
11343 num_input_keys
= 0;
11345 DEFVAR_INT ("num-nonmacro-input-events", num_nonmacro_input_events
,
11346 doc
: /* Number of input events read from the keyboard so far.
11347 This does not include events generated by keyboard macros. */);
11348 num_nonmacro_input_events
= 0;
11350 DEFVAR_LISP ("last-event-frame", Vlast_event_frame
,
11351 doc
: /* The frame in which the most recently read event occurred.
11352 If the last event came from a keyboard macro, this is set to `macro'. */);
11353 Vlast_event_frame
= Qnil
;
11355 /* This variable is set up in sysdep.c. */
11356 DEFVAR_LISP ("tty-erase-char", Vtty_erase_char
,
11357 doc
: /* The ERASE character as set by the user with stty. */);
11359 DEFVAR_LISP ("help-char", Vhelp_char
,
11360 doc
: /* Character to recognize as meaning Help.
11361 When it is read, do `(eval help-form)', and display result if it's a string.
11362 If the value of `help-form' is nil, this char can be read normally. */);
11363 XSETINT (Vhelp_char
, Ctl ('H'));
11365 DEFVAR_LISP ("help-event-list", Vhelp_event_list
,
11366 doc
: /* List of input events to recognize as meaning Help.
11367 These work just like the value of `help-char' (see that). */);
11368 Vhelp_event_list
= Qnil
;
11370 DEFVAR_LISP ("help-form", Vhelp_form
,
11371 doc
: /* Form to execute when character `help-char' is read.
11372 If the form returns a string, that string is displayed.
11373 If `help-form' is nil, the help char is not recognized. */);
11376 DEFVAR_LISP ("prefix-help-command", Vprefix_help_command
,
11377 doc
: /* Command to run when `help-char' character follows a prefix key.
11378 This command is used only when there is no actual binding
11379 for that character after that prefix key. */);
11380 Vprefix_help_command
= Qnil
;
11382 DEFVAR_LISP ("top-level", Vtop_level
,
11383 doc
: /* Form to evaluate when Emacs starts up.
11384 Useful to set before you dump a modified Emacs. */);
11387 DEFVAR_KBOARD ("keyboard-translate-table", Vkeyboard_translate_table
,
11388 doc
: /* Translate table for local keyboard input, or nil.
11389 If non-nil, the value should be a char-table. Each character read
11390 from the keyboard is looked up in this char-table. If the value found
11391 there is non-nil, then it is used instead of the actual input character.
11393 The value can also be a string or vector, but this is considered obsolete.
11394 If it is a string or vector of length N, character codes N and up are left
11395 untranslated. In a vector, an element which is nil means "no translation".
11397 This is applied to the characters supplied to input methods, not their
11398 output. See also `translation-table-for-input'.
11400 This variable has a separate binding for each terminal.
11401 See Info node `(elisp)Multiple Terminals'. */);
11403 DEFVAR_BOOL ("cannot-suspend", cannot_suspend
,
11404 doc
: /* Non-nil means to always spawn a subshell instead of suspending.
11405 \(Even if the operating system has support for stopping a process.\) */);
11406 cannot_suspend
= 0;
11408 DEFVAR_BOOL ("menu-prompting", menu_prompting
,
11409 doc
: /* Non-nil means prompt with menus when appropriate.
11410 This is done when reading from a keymap that has a prompt string,
11411 for elements that have prompt strings.
11412 The menu is displayed on the screen
11413 if X menus were enabled at configuration
11414 time and the previous event was a mouse click prefix key.
11415 Otherwise, menu prompting uses the echo area. */);
11416 menu_prompting
= 1;
11418 DEFVAR_LISP ("menu-prompt-more-char", menu_prompt_more_char
,
11419 doc
: /* Character to see next line of menu prompt.
11420 Type this character while in a menu prompt to rotate around the lines of it. */);
11421 XSETINT (menu_prompt_more_char
, ' ');
11423 DEFVAR_INT ("extra-keyboard-modifiers", extra_keyboard_modifiers
,
11424 doc
: /* A mask of additional modifier keys to use with every keyboard character.
11425 Emacs applies the modifiers of the character stored here to each keyboard
11426 character it reads. For example, after evaluating the expression
11427 (setq extra-keyboard-modifiers ?\\C-x)
11428 all input characters will have the control modifier applied to them.
11430 Note that the character ?\\C-@, equivalent to the integer zero, does
11431 not count as a control character; rather, it counts as a character
11432 with no modifiers; thus, setting `extra-keyboard-modifiers' to zero
11433 cancels any modification. */);
11434 extra_keyboard_modifiers
= 0;
11436 DEFVAR_LISP ("deactivate-mark", Vdeactivate_mark
,
11437 doc
: /* If an editing command sets this to t, deactivate the mark afterward.
11438 The command loop sets this to nil before each command,
11439 and tests the value when the command returns.
11440 Buffer modification stores t in this variable. */);
11441 Vdeactivate_mark
= Qnil
;
11442 DEFSYM (Qdeactivate_mark
, "deactivate-mark");
11443 Fmake_variable_buffer_local (Qdeactivate_mark
);
11445 DEFVAR_LISP ("pre-command-hook", Vpre_command_hook
,
11446 doc
: /* Normal hook run before each command is executed.
11447 If an unhandled error happens in running this hook,
11448 the function in which the error occurred is unconditionally removed, since
11449 otherwise the error might happen repeatedly and make Emacs nonfunctional. */);
11450 Vpre_command_hook
= Qnil
;
11452 DEFVAR_LISP ("post-command-hook", Vpost_command_hook
,
11453 doc
: /* Normal hook run after each command is executed.
11454 If an unhandled error happens in running this hook,
11455 the function in which the error occurred is unconditionally removed, since
11456 otherwise the error might happen repeatedly and make Emacs nonfunctional. */);
11457 Vpost_command_hook
= Qnil
;
11460 DEFVAR_LISP ("echo-area-clear-hook", ...,
11461 doc
: /* Normal hook run when clearing the echo area. */);
11463 DEFSYM (Qecho_area_clear_hook
, "echo-area-clear-hook");
11464 Fset (Qecho_area_clear_hook
, Qnil
);
11466 DEFVAR_LISP ("lucid-menu-bar-dirty-flag", Vlucid_menu_bar_dirty_flag
,
11467 doc
: /* Non-nil means menu bar, specified Lucid style, needs to be recomputed. */);
11468 Vlucid_menu_bar_dirty_flag
= Qnil
;
11470 DEFVAR_LISP ("menu-bar-final-items", Vmenu_bar_final_items
,
11471 doc
: /* List of menu bar items to move to the end of the menu bar.
11472 The elements of the list are event types that may have menu bar bindings. */);
11473 Vmenu_bar_final_items
= Qnil
;
11475 DEFVAR_LISP ("tool-bar-separator-image-expression", Vtool_bar_separator_image_expression
,
11476 doc
: /* Expression evaluating to the image spec for a tool-bar separator.
11477 This is used internally by graphical displays that do not render
11478 tool-bar separators natively. Otherwise it is unused (e.g. on GTK). */);
11479 Vtool_bar_separator_image_expression
= Qnil
;
11481 DEFVAR_KBOARD ("overriding-terminal-local-map",
11482 Voverriding_terminal_local_map
,
11483 doc
: /* Per-terminal keymap that takes precedence over all other keymaps.
11484 This variable is intended to let commands such as `universal-argument'
11485 set up a different keymap for reading the next command.
11487 `overriding-terminal-local-map' has a separate binding for each
11488 terminal device. See Info node `(elisp)Multiple Terminals'. */);
11490 DEFVAR_LISP ("overriding-local-map", Voverriding_local_map
,
11491 doc
: /* Keymap that replaces (overrides) local keymaps.
11492 If this variable is non-nil, Emacs looks up key bindings in this
11493 keymap INSTEAD OF the keymap char property, minor mode maps, and the
11494 buffer's local map. Hence, the only active keymaps would be
11495 `overriding-terminal-local-map', this keymap, and `global-keymap', in
11496 order of precedence. */);
11497 Voverriding_local_map
= Qnil
;
11499 DEFVAR_LISP ("overriding-local-map-menu-flag", Voverriding_local_map_menu_flag
,
11500 doc
: /* Non-nil means `overriding-local-map' applies to the menu bar.
11501 Otherwise, the menu bar continues to reflect the buffer's local map
11502 and the minor mode maps regardless of `overriding-local-map'. */);
11503 Voverriding_local_map_menu_flag
= Qnil
;
11505 DEFVAR_LISP ("special-event-map", Vspecial_event_map
,
11506 doc
: /* Keymap defining bindings for special events to execute at low level. */);
11507 Vspecial_event_map
= list1 (intern_c_string ("keymap"));
11509 DEFVAR_LISP ("track-mouse", do_mouse_tracking
,
11510 doc
: /* Non-nil means generate motion events for mouse motion. */);
11512 DEFVAR_KBOARD ("system-key-alist", Vsystem_key_alist
,
11513 doc
: /* Alist of system-specific X windows key symbols.
11514 Each element should have the form (N . SYMBOL) where N is the
11515 numeric keysym code (sans the \"system-specific\" bit 1<<28)
11516 and SYMBOL is its name.
11518 `system-key-alist' has a separate binding for each terminal device.
11519 See Info node `(elisp)Multiple Terminals'. */);
11521 DEFVAR_KBOARD ("local-function-key-map", Vlocal_function_key_map
,
11522 doc
: /* Keymap that translates key sequences to key sequences during input.
11523 This is used mainly for mapping key sequences into some preferred
11524 key events (symbols).
11526 The `read-key-sequence' function replaces any subsequence bound by
11527 `local-function-key-map' with its binding. More precisely, when the
11528 active keymaps have no binding for the current key sequence but
11529 `local-function-key-map' binds a suffix of the sequence to a vector or
11530 string, `read-key-sequence' replaces the matching suffix with its
11531 binding, and continues with the new sequence.
11533 If the binding is a function, it is called with one argument (the prompt)
11534 and its return value (a key sequence) is used.
11536 The events that come from bindings in `local-function-key-map' are not
11537 themselves looked up in `local-function-key-map'.
11539 For example, suppose `local-function-key-map' binds `ESC O P' to [f1].
11540 Typing `ESC O P' to `read-key-sequence' would return [f1]. Typing
11541 `C-x ESC O P' would return [?\\C-x f1]. If [f1] were a prefix key,
11542 typing `ESC O P x' would return [f1 x].
11544 `local-function-key-map' has a separate binding for each terminal
11545 device. See Info node `(elisp)Multiple Terminals'. If you need to
11546 define a binding on all terminals, change `function-key-map'
11547 instead. Initially, `local-function-key-map' is an empty keymap that
11548 has `function-key-map' as its parent on all terminal devices. */);
11550 DEFVAR_KBOARD ("input-decode-map", Vinput_decode_map
,
11551 doc
: /* Keymap that decodes input escape sequences.
11552 This is used mainly for mapping ASCII function key sequences into
11553 real Emacs function key events (symbols).
11555 The `read-key-sequence' function replaces any subsequence bound by
11556 `input-decode-map' with its binding. Contrary to `function-key-map',
11557 this map applies its rebinding regardless of the presence of an ordinary
11558 binding. So it is more like `key-translation-map' except that it applies
11559 before `function-key-map' rather than after.
11561 If the binding is a function, it is called with one argument (the prompt)
11562 and its return value (a key sequence) is used.
11564 The events that come from bindings in `input-decode-map' are not
11565 themselves looked up in `input-decode-map'. */);
11567 DEFVAR_LISP ("function-key-map", Vfunction_key_map
,
11568 doc
: /* The parent keymap of all `local-function-key-map' instances.
11569 Function key definitions that apply to all terminal devices should go
11570 here. If a mapping is defined in both the current
11571 `local-function-key-map' binding and this variable, then the local
11572 definition will take precedence. */);
11573 Vfunction_key_map
= Fmake_sparse_keymap (Qnil
);
11575 DEFVAR_LISP ("key-translation-map", Vkey_translation_map
,
11576 doc
: /* Keymap of key translations that can override keymaps.
11577 This keymap works like `input-decode-map', but comes after `function-key-map'.
11578 Another difference is that it is global rather than terminal-local. */);
11579 Vkey_translation_map
= Fmake_sparse_keymap (Qnil
);
11581 DEFVAR_LISP ("deferred-action-list", Vdeferred_action_list
,
11582 doc
: /* List of deferred actions to be performed at a later time.
11583 The precise format isn't relevant here; we just check whether it is nil. */);
11584 Vdeferred_action_list
= Qnil
;
11586 DEFVAR_LISP ("deferred-action-function", Vdeferred_action_function
,
11587 doc
: /* Function to call to handle deferred actions, after each command.
11588 This function is called with no arguments after each command
11589 whenever `deferred-action-list' is non-nil. */);
11590 Vdeferred_action_function
= Qnil
;
11592 DEFVAR_LISP ("delayed-warnings-list", Vdelayed_warnings_list
,
11593 doc
: /* List of warnings to be displayed after this command.
11594 Each element must be a list (TYPE MESSAGE [LEVEL [BUFFER-NAME]]),
11595 as per the args of `display-warning' (which see).
11596 If this variable is non-nil, `delayed-warnings-hook' will be run
11597 immediately after running `post-command-hook'. */);
11598 Vdelayed_warnings_list
= Qnil
;
11600 DEFVAR_LISP ("timer-list", Vtimer_list
,
11601 doc
: /* List of active absolute time timers in order of increasing time. */);
11602 Vtimer_list
= Qnil
;
11604 DEFVAR_LISP ("timer-idle-list", Vtimer_idle_list
,
11605 doc
: /* List of active idle-time timers in order of increasing time. */);
11606 Vtimer_idle_list
= Qnil
;
11608 DEFVAR_LISP ("input-method-function", Vinput_method_function
,
11609 doc
: /* If non-nil, the function that implements the current input method.
11610 It's called with one argument, a printing character that was just read.
11611 \(That means a character with code 040...0176.)
11612 Typically this function uses `read-event' to read additional events.
11613 When it does so, it should first bind `input-method-function' to nil
11614 so it will not be called recursively.
11616 The function should return a list of zero or more events
11617 to be used as input. If it wants to put back some events
11618 to be reconsidered, separately, by the input method,
11619 it can add them to the beginning of `unread-command-events'.
11621 The input method function can find in `input-method-previous-message'
11622 the previous echo area message.
11624 The input method function should refer to the variables
11625 `input-method-use-echo-area' and `input-method-exit-on-first-char'
11626 for guidance on what to do. */);
11627 Vinput_method_function
= Qnil
;
11629 DEFVAR_LISP ("input-method-previous-message",
11630 Vinput_method_previous_message
,
11631 doc
: /* When `input-method-function' is called, hold the previous echo area message.
11632 This variable exists because `read-event' clears the echo area
11633 before running the input method. It is nil if there was no message. */);
11634 Vinput_method_previous_message
= Qnil
;
11636 DEFVAR_LISP ("show-help-function", Vshow_help_function
,
11637 doc
: /* If non-nil, the function that implements the display of help.
11638 It's called with one argument, the help string to display. */);
11639 Vshow_help_function
= Qnil
;
11641 DEFVAR_LISP ("disable-point-adjustment", Vdisable_point_adjustment
,
11642 doc
: /* If non-nil, suppress point adjustment after executing a command.
11644 After a command is executed, if point is moved into a region that has
11645 special properties (e.g. composition, display), we adjust point to
11646 the boundary of the region. But, when a command sets this variable to
11647 non-nil, we suppress the point adjustment.
11649 This variable is set to nil before reading a command, and is checked
11650 just after executing the command. */);
11651 Vdisable_point_adjustment
= Qnil
;
11653 DEFVAR_LISP ("global-disable-point-adjustment",
11654 Vglobal_disable_point_adjustment
,
11655 doc
: /* If non-nil, always suppress point adjustment.
11657 The default value is nil, in which case, point adjustment are
11658 suppressed only after special commands that set
11659 `disable-point-adjustment' (which see) to non-nil. */);
11660 Vglobal_disable_point_adjustment
= Qnil
;
11662 DEFVAR_LISP ("minibuffer-message-timeout", Vminibuffer_message_timeout
,
11663 doc
: /* How long to display an echo-area message when the minibuffer is active.
11664 If the value is not a number, such messages don't time out. */);
11665 Vminibuffer_message_timeout
= make_number (2);
11667 DEFVAR_LISP ("throw-on-input", Vthrow_on_input
,
11668 doc
: /* If non-nil, any keyboard input throws to this symbol.
11669 The value of that variable is passed to `quit-flag' and later causes a
11670 peculiar kind of quitting. */);
11671 Vthrow_on_input
= Qnil
;
11673 DEFVAR_LISP ("command-error-function", Vcommand_error_function
,
11674 doc
: /* Function to output error messages.
11675 Called with three arguments:
11676 - the error data, a list of the form (SIGNALED-CONDITION . SIGNAL-DATA)
11677 such as what `condition-case' would bind its variable to,
11678 - the context (a string which normally goes at the start of the message),
11679 - the Lisp function within which the error was signaled. */);
11680 Vcommand_error_function
= intern ("command-error-default-function");
11682 DEFVAR_LISP ("enable-disabled-menus-and-buttons",
11683 Venable_disabled_menus_and_buttons
,
11684 doc
: /* If non-nil, don't ignore events produced by disabled menu items and tool-bar.
11686 Help functions bind this to allow help on disabled menu items
11687 and tool-bar buttons. */);
11688 Venable_disabled_menus_and_buttons
= Qnil
;
11690 DEFVAR_LISP ("select-active-regions",
11691 Vselect_active_regions
,
11692 doc
: /* If non-nil, an active region automatically sets the primary selection.
11693 If the value is `only', only temporarily active regions (usually made
11694 by mouse-dragging or shift-selection) set the window selection.
11696 This takes effect only when Transient Mark mode is enabled. */);
11697 Vselect_active_regions
= Qt
;
11699 DEFVAR_LISP ("saved-region-selection",
11700 Vsaved_region_selection
,
11701 doc
: /* Contents of active region prior to buffer modification.
11702 If `select-active-regions' is non-nil, Emacs sets this to the
11703 text in the region before modifying the buffer. The next call to
11704 the function `deactivate-mark' uses this to set the window selection. */);
11705 Vsaved_region_selection
= Qnil
;
11707 DEFVAR_LISP ("selection-inhibit-update-commands",
11708 Vselection_inhibit_update_commands
,
11709 doc
: /* List of commands which should not update the selection.
11710 Normally, if `select-active-regions' is non-nil and the mark remains
11711 active after a command (i.e. the mark was not deactivated), the Emacs
11712 command loop sets the selection to the text in the region. However,
11713 if the command is in this list, the selection is not updated. */);
11714 Vselection_inhibit_update_commands
11715 = list2 (Qhandle_switch_frame
, Qhandle_select_window
);
11717 DEFVAR_LISP ("debug-on-event",
11719 doc
: /* Enter debugger on this event. When Emacs
11720 receives the special event specified by this variable, it will try to
11721 break into the debugger as soon as possible instead of processing the
11722 event normally through `special-event-map'.
11724 Currently, the only supported values for this
11725 variable are `sigusr1' and `sigusr2'. */);
11726 Vdebug_on_event
= intern_c_string ("sigusr2");
11728 /* Create the initial keyboard. Qt means 'unset'. */
11729 initial_kboard
= allocate_kboard (Qt
);
11733 keys_of_keyboard (void)
11735 initial_define_key (global_map
, Ctl ('Z'), "suspend-emacs");
11736 initial_define_key (control_x_map
, Ctl ('Z'), "suspend-emacs");
11737 initial_define_key (meta_map
, Ctl ('C'), "exit-recursive-edit");
11738 initial_define_key (global_map
, Ctl (']'), "abort-recursive-edit");
11739 initial_define_key (meta_map
, 'x', "execute-extended-command");
11741 initial_define_lispy_key (Vspecial_event_map
, "delete-frame",
11742 "handle-delete-frame");
11743 initial_define_lispy_key (Vspecial_event_map
, "ns-put-working-text",
11744 "ns-put-working-text");
11745 initial_define_lispy_key (Vspecial_event_map
, "ns-unput-working-text",
11746 "ns-unput-working-text");
11747 /* Here we used to use `ignore-event' which would simple set prefix-arg to
11748 current-prefix-arg, as is done in `handle-switch-frame'.
11749 But `handle-switch-frame is not run from the special-map.
11750 Commands from that map are run in a special way that automatically
11751 preserves the prefix-arg. Restoring the prefix arg here is not just
11752 redundant but harmful:
11754 - current-prefix-arg is set to non-nil, prefix-arg is set to nil.
11755 - after the first prompt, the exit-minibuffer-hook is run which may
11756 iconify a frame and thus push a `iconify-frame' event.
11757 - after running exit-minibuffer-hook, current-prefix-arg is
11758 restored to the non-nil value it had before the prompt.
11759 - we enter the second prompt.
11760 current-prefix-arg is non-nil, prefix-arg is nil.
11761 - before running the first real event, we run the special iconify-frame
11762 event, but we pass the `special' arg to execute-command so
11763 current-prefix-arg and prefix-arg are left untouched.
11764 - here we foolishly copy the non-nil current-prefix-arg to prefix-arg.
11765 - the next key event will have a spuriously non-nil current-prefix-arg. */
11766 initial_define_lispy_key (Vspecial_event_map
, "iconify-frame",
11768 initial_define_lispy_key (Vspecial_event_map
, "make-frame-visible",
11770 /* Handling it at such a low-level causes read_key_sequence to get
11771 * confused because it doesn't realize that the current_buffer was
11772 * changed by read_char.
11774 * initial_define_lispy_key (Vspecial_event_map, "select-window",
11775 * "handle-select-window"); */
11776 initial_define_lispy_key (Vspecial_event_map
, "save-session",
11777 "handle-save-session");
11780 /* Define a special event which is raised for dbus callback
11782 initial_define_lispy_key (Vspecial_event_map
, "dbus-event",
11783 "dbus-handle-event");
11786 #ifdef USE_FILE_NOTIFY
11787 /* Define a special event which is raised for notification callback
11789 initial_define_lispy_key (Vspecial_event_map
, "file-notify",
11790 "file-notify-handle-event");
11791 #endif /* USE_FILE_NOTIFY */
11793 initial_define_lispy_key (Vspecial_event_map
, "config-changed-event",
11795 #if defined (WINDOWSNT)
11796 initial_define_lispy_key (Vspecial_event_map
, "language-change",
11799 initial_define_lispy_key (Vspecial_event_map
, "focus-in",
11800 "handle-focus-in");
11801 initial_define_lispy_key (Vspecial_event_map
, "focus-out",
11802 "handle-focus-out");
11805 /* Mark the pointers in the kboard objects.
11806 Called by Fgarbage_collect. */
11808 mark_kboards (void)
11812 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
11814 if (kb
->kbd_macro_buffer
)
11815 for (p
= kb
->kbd_macro_buffer
; p
< kb
->kbd_macro_ptr
; p
++)
11817 mark_object (KVAR (kb
, Voverriding_terminal_local_map
));
11818 mark_object (KVAR (kb
, Vlast_command
));
11819 mark_object (KVAR (kb
, Vreal_last_command
));
11820 mark_object (KVAR (kb
, Vkeyboard_translate_table
));
11821 mark_object (KVAR (kb
, Vlast_repeatable_command
));
11822 mark_object (KVAR (kb
, Vprefix_arg
));
11823 mark_object (KVAR (kb
, Vlast_prefix_arg
));
11824 mark_object (KVAR (kb
, kbd_queue
));
11825 mark_object (KVAR (kb
, defining_kbd_macro
));
11826 mark_object (KVAR (kb
, Vlast_kbd_macro
));
11827 mark_object (KVAR (kb
, Vsystem_key_alist
));
11828 mark_object (KVAR (kb
, system_key_syms
));
11829 mark_object (KVAR (kb
, Vwindow_system
));
11830 mark_object (KVAR (kb
, Vinput_decode_map
));
11831 mark_object (KVAR (kb
, Vlocal_function_key_map
));
11832 mark_object (KVAR (kb
, Vdefault_minibuffer_frame
));
11833 mark_object (KVAR (kb
, echo_string
));
11836 struct input_event
*event
;
11837 for (event
= kbd_fetch_ptr
; event
!= kbd_store_ptr
; event
++)
11839 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
11840 event
= kbd_buffer
;
11841 /* These two special event types has no Lisp_Objects to mark. */
11842 if (event
->kind
!= SELECTION_REQUEST_EVENT
11843 && event
->kind
!= SELECTION_CLEAR_EVENT
)
11845 mark_object (event
->x
);
11846 mark_object (event
->y
);
11847 mark_object (event
->frame_or_window
);
11848 mark_object (event
->arg
);